SAML2\Configuration\ServiceProvider Class Reference

Basic Configuration Wrapper. More...

Inheritance diagram for SAML2\Configuration\ServiceProvider:

Collaboration diagram for SAML2\Configuration\ServiceProvider:

Public Member Functions
	getKeys ()
	Returns an array or \Traversable of keys, where each element represents a configured key. More...
	getCertificateData ()
	Returns the contents of an X509 pem certificate, without the '--—BEGIN CERTIFICATE--—' and '--—END CERTIFICATE--—'. More...
	getCertificateFile ()
	Returns the full path to the (local) file that contains the X509 pem certificate. More...
	getCertificateFingerprints ()
	getEntityId ()
	isAssertionEncryptionRequired ()
	getSharedKey ()
	getPrivateKey ($name, $required=false)
	getBlacklistedAlgorithms ()
Public Member Functions inherited from SAML2\Configuration\ArrayAdapter
	__construct (array $configuration)
	get ($key, $defaultValue=null)
	Query to get the value in the configuration for the given key. More...
	has ($key)
	Query for whether or not the configuration has a value for the key. More...
	has ($key)
	Query for whether or not the configuration has a value for the key. More...
	get ($key, $default=null)
	Query to get the value in the configuration for the given key. More...
	getKeys ()
	Returns an array or \Traversable of keys, where each element represents a configured key. More...
	getCertificateData ()
	Returns the contents of an X509 pem certificate, without the '--—BEGIN CERTIFICATE--—' and '--—END CERTIFICATE--—'. More...
	getCertificateFile ()
	Returns the full path to the (local) file that contains the X509 pem certificate. More...
	getCertificateFingerprints ()
	Returns an array or \Traversable where each element represents a certificate fingerprint. More...
	isAssertionEncryptionRequired ()
	getSharedKey ()
	getPrivateKey ($name, $required=false)
	getBlacklistedAlgorithms ()
	getEntityId ()

Detailed Description

Basic Configuration Wrapper.

Definition at line 10 of file ServiceProvider.php.

Member Function Documentation

getBlacklistedAlgorithms()

SAML2\Configuration\ServiceProvider::getBlacklistedAlgorithms

(

)

Returns

array

Implements SAML2\Configuration\DecryptionProvider.

Definition at line 77 of file ServiceProvider.php.

    {
        return $this->get('blacklistedEncryptionAlgorithms', array(XMLSecurityKey::RSA_1_5));
    }

References RobRichards\XMLSecLibs\XMLSecurityKey\RSA_1_5.

getCertificateData()

SAML2\Configuration\ServiceProvider::getCertificateData

(

)

Returns the contents of an X509 pem certificate, without the '--—BEGIN CERTIFICATE--—' and '--—END CERTIFICATE--—'.

Returns

null|string

Implements SAML2\Configuration\CertificateProvider.

Definition at line 20 of file ServiceProvider.php.

    {
        return $this->get('certificateData');
    }

getCertificateFile()

SAML2\Configuration\ServiceProvider::getCertificateFile

(

)

Returns the full path to the (local) file that contains the X509 pem certificate.

Returns

null|string

Implements SAML2\Configuration\CertificateProvider.

Definition at line 25 of file ServiceProvider.php.

    {
        return $this->get('certificateFile');
    }

getCertificateFingerprints()

SAML2\Configuration\ServiceProvider::getCertificateFingerprints

(

)

Deprecated:

Please use getCertificateData() or getCertificateFile().

Implements SAML2\Configuration\CertificateProvider.

Definition at line 33 of file ServiceProvider.php.

    {
        return $this->get('certificateFingerprints');
    }

getEntityId()

SAML2\Configuration\ServiceProvider::getEntityId

(

)

Returns

null|string

Implements SAML2\Configuration\EntityIdProvider.

Definition at line 38 of file ServiceProvider.php.

    {
        return $this->get('entityId');
    }

getKeys()

SAML2\Configuration\ServiceProvider::getKeys

(

)

Returns an array or \Traversable of keys, where each element represents a configured key.

A configured key itself is an array or object implementing ArrayAccess where the array key/property is the configuration key and the value is the configured value.

Returns

null|array|\Traversable

Implements SAML2\Configuration\CertificateProvider.

Definition at line 15 of file ServiceProvider.php.

    {
        return $this->get('keys');
    }

getPrivateKey()

SAML2\Configuration\ServiceProvider::getPrivateKey	(		$name,
			$required = false
	)

Parameters

string	$name	the name of the private key
boolean	$required	whether or not the private key must exist

Returns

mixed

Implements SAML2\Configuration\DecryptionProvider.

Definition at line 53 of file ServiceProvider.php.

    {
        $privateKeys = $this->get('privateKeys');
        $key         = array_filter($privateKeys, function (PrivateKey $key) use ($name) {
            return $key->getName() === $name;
        });
 
        $keyCount = count($key);
        if ($keyCount !== 1 && $required) {
            throw new \RuntimeException(sprintf(
                'Attempted to get privateKey by name "%s", found "%d" keys, where only one was expected. Please '
                . 'verify that your configuration is correct',
                $name,
                $keyCount
            ));
        }
 
        if (!$keyCount) {
            return null;
        }
 
        return array_pop($key);
    }

References $key, $name, and sprintf.

getSharedKey()

SAML2\Configuration\ServiceProvider::getSharedKey

(

)

Returns

null|string

Implements SAML2\Configuration\DecryptionProvider.

Definition at line 48 of file ServiceProvider.php.

    {
        return $this->get('sharedKey');
    }

isAssertionEncryptionRequired()

SAML2\Configuration\ServiceProvider::isAssertionEncryptionRequired

(

)

Returns

null|bool

Implements SAML2\Configuration\DecryptionProvider.

Definition at line 43 of file ServiceProvider.php.

    {
        return $this->get('assertionEncryptionEnabled');
    }

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/Configuration/ServiceProvider.php