SAML2\Certificate\KeyLoader Class Reference

KeyLoader. More...

Collaboration diagram for SAML2\Certificate\KeyLoader:

Public Member Functions
	__construct ()
	loadKeysFromConfiguration (CertificateProvider $config, $usage=null, $required=false)
	loadKeys (array $configuredKeys, $usage)
	Loads the keys given, optionally excluding keys when a usage is given and they are not configured to be used with the usage given. More...
	loadCertificateData ($certificateData)
	Attempts to load a key based on the given certificateData. More...
	loadCertificateFile ($certificateFile)
	Loads the certificate in the file given. More...
	getKeys ()
	hasKeys ()

Static Public Member Functions
static	extractPublicKeys (CertificateProvider $config, $usage=null, $required=false)
	Extracts the public keys given by the configuration. More...

Private Attributes
	$loadedKeys

Detailed Description

KeyLoader.

Definition at line 15 of file KeyLoader.php.

Constructor & Destructor Documentation

__construct()

SAML2\Certificate\KeyLoader::__construct

(

)

Definition at line 22 of file KeyLoader.php.

    {
        $this->loadedKeys = new KeyCollection();
    }

Member Function Documentation

extractPublicKeys()

static SAML2\Certificate\KeyLoader::extractPublicKeys ( CertificateProvider  $config,   $usage = null,   $required = false  )

static

Extracts the public keys given by the configuration.

Mainly exists for BC purposes. Prioritisation order is keys > certData > certificate

Parameters

\SAML2\Configuration\CertificateProvider	$config
null	$usage
bool	$required

Returns

Definition at line 37 of file KeyLoader.php.

      {
        $keyLoader = new self();

        return $keyLoader->loadKeysFromConfiguration($config, $usage, $required);
    }

getKeys()

SAML2\Certificate\KeyLoader::getKeys

(

)

Returns

Definition at line 143 of file KeyLoader.php.

References SAML2\Certificate\KeyLoader\$loadedKeys.

Referenced by SAML2\Certificate\KeyLoader\loadKeysFromConfiguration().

    {
        return $this->loadedKeys;
    }

Here is the caller graph for this function:

hasKeys()

SAML2\Certificate\KeyLoader::hasKeys

(

)

Returns

bool

Definition at line 151 of file KeyLoader.php.

Referenced by SAML2\Certificate\KeyLoader\loadKeysFromConfiguration().

    {
        return !!count($this->loadedKeys);
    }

Here is the caller graph for this function:

loadCertificateData()

SAML2\Certificate\KeyLoader::loadCertificateData

(

$certificateData

)

Attempts to load a key based on the given certificateData.

Parameters

string

$certificateData

Definition at line 110 of file KeyLoader.php.

References SAML2\Certificate\X509\createFromCertificateData(), and SAML2\Exception\InvalidArgumentException\invalidType().

Referenced by SAML2\Certificate\KeyLoader\loadKeysFromConfiguration().

    {
        if (!is_string($certificateData)) {
            throw InvalidArgumentException::invalidType('string', $certificateData);
        }

        $this->loadedKeys->add(X509::createFromCertificateData($certificateData));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadCertificateFile()

SAML2\Certificate\KeyLoader::loadCertificateFile

(

$certificateFile

)

Loads the certificate in the file given.

Parameters

string

$certificateFile

the full path to the cert file.

Definition at line 124 of file KeyLoader.php.

References $certificate, SAML2\Utilities\Certificate\CERTIFICATE_PATTERN, SAML2\Certificate\X509\createFromCertificateData(), SAML2\Utilities\File\getFileContents(), and SAML2\Utilities\Certificate\hasValidStructure().

Referenced by SAML2\Certificate\KeyLoader\loadKeysFromConfiguration().

    {
        $certificate = File::getFileContents($certificateFile);

        if (!Certificate::hasValidStructure($certificate)) {
            throw new InvalidCertificateStructureException(sprintf(
                'Could not find PEM encoded certificate in "%s"',
                $certificateFile
            ));
        }

        // capture the certificate contents without the delimiters
        preg_match(Certificate::CERTIFICATE_PATTERN, $certificate, $matches);
        $this->loadedKeys->add(X509::createFromCertificateData($matches[1]));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadKeys()

SAML2\Certificate\KeyLoader::loadKeys	(	array	$configuredKeys,
			$usage
	)

Loads the keys given, optionally excluding keys when a usage is given and they are not configured to be used with the usage given.

Parameters

array	$configuredKeys
	$usage

Definition at line 88 of file KeyLoader.php.

References $key.

Referenced by SAML2\Certificate\KeyLoader\loadKeysFromConfiguration().

    {
        foreach ($configuredKeys as $keyData) {
            if (isset($keyData['X509Certificate'])) {
                $key = new X509($keyData);
            } else {
                $key = new Key($keyData);
            }

            if ($usage && !$key->canBeUsedFor($usage)) {
                continue;
            }

            $this->loadedKeys->add($key);
        }
    }

Here is the caller graph for this function:

loadKeysFromConfiguration()

SAML2\Certificate\KeyLoader::loadKeysFromConfiguration	(	CertificateProvider	$config,
			$usage = null,
			$required = false
	)

Parameters

\SAML2\Configuration\CertificateProvider	$config
null | string	$usage
bool	$required

Returns

Definition at line 54 of file KeyLoader.php.

References $keys, SAML2\Configuration\CertificateProvider\getCertificateData(), SAML2\Configuration\CertificateProvider\getCertificateFile(), SAML2\Configuration\CertificateProvider\getKeys(), SAML2\Certificate\KeyLoader\getKeys(), SAML2\Certificate\KeyLoader\hasKeys(), SAML2\Certificate\KeyLoader\loadCertificateData(), SAML2\Certificate\KeyLoader\loadCertificateFile(), and SAML2\Certificate\KeyLoader\loadKeys().

      {
        $keys = $config->getKeys();
        $certificateData = $config->getCertificateData();
        $certificateFile = $config->getCertificateFile();

        if ($keys !== null) {
            $this->loadKeys($keys, $usage);
        } elseif ($certificateData !== null) {
            $this->loadCertificateData($certificateData);
        } elseif ($certificateFile !== null) {
            $this->loadCertificateFile($certificateFile);
        }

        if ($required && !$this->hasKeys()) {
            throw new NoKeysFoundException(
                'No keys found in configured metadata, please ensure that either the "keys", "certData" or '
                . '"certificate" entries is available.'
            );
        }

        return $this->getKeys();
    }

Here is the call graph for this function:

Field Documentation

$loadedKeys

SAML2\Certificate\KeyLoader::$loadedKeys

private

Definition at line 20 of file KeyLoader.php.

Referenced by SAML2\Certificate\KeyLoader\getKeys().

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/Certificate/KeyLoader.php