SAML2\Certificate\PrivateKey Class Reference

Inheritance diagram for SAML2\Certificate\PrivateKey:

Collaboration diagram for SAML2\Certificate\PrivateKey:

Public Member Functions
	getKeyAsString ()
	getPassphrase ()
Public Member Functions inherited from SAML2\Certificate\Key
	__construct (array $keyData)
	canBeUsedFor ($usage)
	Whether or not the key is configured to be used for usage given. More...
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)

Static Public Member Functions
static	create ($keyContents, $passphrase=null)
Static Public Member Functions inherited from SAML2\Certificate\Key
static	getValidKeyUsages ()
	Returns the list of valid key usage options. More...

Additional Inherited Members
Data Fields inherited from SAML2\Certificate\Key
const	USAGE_SIGNING = 'signing'
const	USAGE_ENCRYPTION = 'encryption'
Protected Member Functions inherited from SAML2\Certificate\Key
	assertIsString ($test)
	Asserts that the parameter is of type string. More...
Protected Attributes inherited from SAML2\Certificate\Key
	$keyData = array()

Detailed Description

Definition at line 7 of file PrivateKey.php.

Member Function Documentation

create()

static SAML2\Certificate\PrivateKey::create (   $keyContents,   $passphrase = null  )

static

Definition at line 9 of file PrivateKey.php.

    {
        if (!is_string($keyContents)) {
            throw InvalidArgumentException::invalidType('string', $keyContents);
        }
 
        if ($passphrase && !is_string($passphrase)) {
            throw InvalidArgumentException::invalidType('string', $passphrase);
        }
 
        $keyData = array('PEM' => $keyContents, self::USAGE_ENCRYPTION => true);
        if ($passphrase) {
            $keyData['passphrase'] = $passphrase;
        }
 
        return new self($keyData);
    }

References SAML2\Certificate\Key\$keyData, and SAML2\Exception\InvalidArgumentException\invalidType().

Referenced by SAML2\Certificate\PrivateKeyLoader\loadPrivateKey().

Here is the call graph for this function:

Here is the caller graph for this function:

getKeyAsString()

SAML2\Certificate\PrivateKey::getKeyAsString

(

)

Definition at line 27 of file PrivateKey.php.

    {
        return $this->keyData['PEM'];
    }

Referenced by SAML2\Certificate\PrivateKeyLoader\convertPrivateKeyToRsaKey().

Here is the caller graph for this function:

getPassphrase()

SAML2\Certificate\PrivateKey::getPassphrase

(

)

Definition at line 32 of file PrivateKey.php.

    {
        return isset($this->keyData['passphrase']) ? $this->keyData['passphrase'] : null;
    }

Referenced by SAML2\Certificate\PrivateKeyLoader\convertPrivateKeyToRsaKey().

Here is the caller graph for this function:

---

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

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