SAML2\Signature\PublicKeyValidator Class Reference

Inheritance diagram for SAML2\Signature\PublicKeyValidator:

Collaboration diagram for SAML2\Signature\PublicKeyValidator:

Public Member Functions
	__construct (LoggerInterface $logger, KeyLoader $keyLoader)
	canValidate (SignedElement $signedElement, CertificateProvider $configuration)
	hasValidSignature (SignedElement $signedElement, CertificateProvider $configuration)
Public Member Functions inherited from SAML2\Signature\AbstractChainedValidator
	__construct (LoggerInterface $logger)

Private Attributes
	$configuredKeys
	$keyLoader

Additional Inherited Members
Protected Member Functions inherited from SAML2\Signature\AbstractChainedValidator
	validateElementWithKeys (SignedElement $element, $pemCandidates)
	BC compatible version of the signature check. More...
Protected Attributes inherited from SAML2\Signature\AbstractChainedValidator
	$logger

Detailed Description

Definition at line 12 of file PublicKeyValidator.php.

Constructor & Destructor Documentation

__construct()

SAML2\Signature\PublicKeyValidator::__construct	(	LoggerInterface	$logger,
		KeyLoader	$keyLoader
	)

Definition at line 24 of file PublicKeyValidator.php.

References SAML2\Signature\PublicKeyValidator\$keyLoader.

    {
        $this->keyLoader = $keyLoader;

        parent::__construct($logger);
    }

Member Function Documentation

canValidate()

SAML2\Signature\PublicKeyValidator::canValidate	(	SignedElement	$signedElement,
		CertificateProvider	$configuration
	)

Parameters

\SAML2\SignedElement	$signedElement
\SAML2\Configuration\CertificateProvider	$configuration

Returns

bool

Implements SAML2\Signature\ChainedValidator.

Definition at line 37 of file PublicKeyValidator.php.

      {
        $this->configuredKeys = $this->keyLoader->extractPublicKeys($configuration);

        return !!count($this->configuredKeys);
    }

hasValidSignature()

SAML2\Signature\PublicKeyValidator::hasValidSignature	(	SignedElement	$signedElement,
		CertificateProvider	$configuration
	)

Parameters

\SAML2\SignedElement	$signedElement
\SAML2\Configuration\CertificateProvider	$configuration

Returns

bool

Implements SAML2\Signature\ValidatorInterface.

Definition at line 52 of file PublicKeyValidator.php.

References $key, SAML2\Signature\AbstractChainedValidator\$logger, and SAML2\Signature\AbstractChainedValidator\validateElementWithKeys().

      {
        $logger = $this->logger;
        $pemCandidates = $this->configuredKeys->filter(function (Key $key) use ($logger) {
            if (!$key instanceof X509) {
                $logger->debug(sprintf('Skipping unknown key type: "%s"', $key['type']));
                return false;
            }
            return true;
        });

        if (!count($pemCandidates)) {
            $this->logger->debug('No configured X509 certificate found to verify the signature with');

            return false;
        }

        return $this->validateElementWithKeys($signedElement, $pemCandidates);
    }

Here is the call graph for this function:

Field Documentation

$configuredKeys

SAML2\Signature\PublicKeyValidator::$configuredKeys

private

Definition at line 17 of file PublicKeyValidator.php.

$keyLoader

SAML2\Signature\PublicKeyValidator::$keyLoader

private

Definition at line 22 of file PublicKeyValidator.php.

Referenced by SAML2\Signature\PublicKeyValidator\__construct().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/Signature/PublicKeyValidator.php