SimpleSAML\XML\Signer Class Reference

Collaboration diagram for SimpleSAML\XML\Signer:

Public Member Functions
	__construct ($options=array())
	Constructor for the metadata signer. More...
	loadPrivateKeyArray ($privatekey)
	Set the private key from an array. More...
	loadPrivateKey ($file, $pass=null, $full_path=false)
	Set the private key. More...
	loadPublicKeyArray ($publickey)
	Set the public key / certificate we should include in the signature. More...
	loadCertificate ($file, $full_path=false)
	Set the certificate we should include in the signature. More...
	setIDAttribute ($idAttrName)
	Set the attribute name for the ID value. More...
	addCertificate ($file, $full_path=false)
	Add an extra certificate to the certificate chain in the signature. More...
	sign ($node, $insertInto, $insertBefore=null)
	Signs the given DOMElement and inserts the signature at the given position. More...

Private Attributes
	$idAttrName
	$privateKey
	$certificate
	$extraCertificates

Detailed Description

Definition at line 18 of file Signer.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\XML\Signer::__construct

(

$options = array()

)

Constructor for the metadata signer.

You can pass an list of options as key-value pairs in the array. This allows you to initialize a metadata signer in one call.

The following keys are recognized:

• privatekey The file with the private key, relative to the cert-directory.
• privatekey_pass The passphrase for the private key.
• certificate The file with the certificate, relative to the cert-directory.
• privatekey_array The private key, as an array returned from SimpleSAML_Utilities::loadPrivateKey.
• publickey_array The public key, as an array returned from SimpleSAML_Utilities::loadPublicKey.
• id The name of the ID attribute.

Parameters

array

$options

Associative array with options for the constructor. Defaults to an empty array.

Definition at line 60 of file Signer.php.

    {
        assert('is_array($options)');
 
        $this->idAttrName = false;
        $this->privateKey = false;
        $this->certificate = false;
        $this->extraCertificates = array();
 
        if (array_key_exists('privatekey', $options)) {
            $pass = null;
            if (array_key_exists('privatekey_pass', $options)) {
                $pass = $options['privatekey_pass'];
            }
 
            $this->loadPrivateKey($options['privatekey'], $pass);
        }
 
        if (array_key_exists('certificate', $options)) {
            $this->loadCertificate($options['certificate']);
        }
 
        if (array_key_exists('privatekey_array', $options)) {
            $this->loadPrivateKeyArray($options['privatekey_array']);
        }
 
        if (array_key_exists('publickey_array', $options)) {
            $this->loadPublicKeyArray($options['publickey_array']);
        }
 
        if (array_key_exists('id', $options)) {
            $this->setIdAttribute($options['id']);
        }
    }

References $options, $pass, SimpleSAML\XML\Signer\loadCertificate(), SimpleSAML\XML\Signer\loadPrivateKey(), SimpleSAML\XML\Signer\loadPrivateKeyArray(), and SimpleSAML\XML\Signer\loadPublicKeyArray().

Here is the call graph for this function:

Member Function Documentation

addCertificate()

SimpleSAML\XML\Signer::addCertificate	(		$file,
			$full_path = false
	)

Add an extra certificate to the certificate chain in the signature.

Extra certificates will be added to the certificate chain in the order they are added.

Parameters

string	$file	The file which contains the certificate, relative to the cert-directory.
bool	$full_path	Whether the filename found in the configuration contains the full path to the private key or not. Default to false.

Exceptions

Exception

Definition at line 239 of file Signer.php.

    {
        assert('is_string($file)');
        assert('is_bool($full_path)');
 
        if (!$full_path) {
            $certFile = Config::getCertPath($file);
        } else {
            $certFile = $file;
        }
 
        if (!file_exists($certFile)) {
            throw new \Exception('Could not find extra certificate file "' . $certFile . '".');
        }
 
        $certificate = file_get_contents($certFile);
        if ($certificate === false) {
            throw new \Exception('Unable to read extra certificate file "' . $certFile . '".');
        }
 
        $this->extraCertificates[] = $certificate;
    }

References SimpleSAML\XML\Signer\$certificate, $file, and SimpleSAML\Utils\Config\getCertPath().

Here is the call graph for this function:

loadCertificate()

SimpleSAML\XML\Signer::loadCertificate	(		$file,
			$full_path = false
	)

Set the certificate we should include in the signature.

If this function isn't called, no certificate will be included. Will throw an exception if unable to load the certificate.

Parameters

string	$file	The file which contains the certificate. The path is assumed to be relative to the cert-directory.
bool	$full_path	Whether the filename found in the configuration contains the full path to the private key or not. Default to false.

Exceptions

Exception

Definition at line 193 of file Signer.php.

    {
        assert('is_string($file)');
        assert('is_bool($full_path)');
 
        if (!$full_path) {
            $certFile = Config::getCertPath($file);
        } else {
            $certFile = $file;
        }
 
        if (!file_exists($certFile)) {
            throw new \Exception('Could not find certificate file "' . $certFile . '".');
        }
 
        $this->certificate = file_get_contents($certFile);
        if ($this->certificate === false) {
            throw new \Exception('Unable to read certificate file "' . $certFile . '".');
        }
    }

References $file, and SimpleSAML\Utils\Config\getCertPath().

Referenced by SimpleSAML\XML\Signer\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

loadPrivateKey()

SimpleSAML\XML\Signer::loadPrivateKey	(		$file,
			$pass = null,
			$full_path = false
	)

Set the private key.

Will throw an exception if unable to load the private key.

Parameters

string	$file	The file which contains the private key. The path is assumed to be relative to the cert-directory.
string | null	$pass	The passphrase on the private key. Pass no value or NULL if the private key is unencrypted.
bool	$full_path	Whether the filename found in the configuration contains the full path to the private key or not. Default to false.

Exceptions

Exception

Definition at line 130 of file Signer.php.

    {
        assert('is_string($file)');
        assert('is_string($pass) || is_null($pass)');
        assert('is_bool($full_path)');
 
        if (!$full_path) {
            $keyFile = Config::getCertPath($file);
        } else {
            $keyFile = $file;
        }
 
        if (!file_exists($keyFile)) {
            throw new \Exception('Could not find private key file "' . $keyFile . '".');
        }
        $keyData = file_get_contents($keyFile);
        if ($keyData === false) {
            throw new \Exception('Unable to read private key file "' . $keyFile . '".');
        }
 
        $privatekey = array('PEM' => $keyData);
        if ($pass !== null) {
            $privatekey['password'] = $pass;
        }
        $this->loadPrivateKeyArray($privatekey);
    }

References $file, $pass, SimpleSAML\Utils\Config\getCertPath(), and SimpleSAML\XML\Signer\loadPrivateKeyArray().

Referenced by SimpleSAML\XML\Signer\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

loadPrivateKeyArray()

SimpleSAML\XML\Signer::loadPrivateKeyArray

(

$privatekey

)

Set the private key from an array.

This function loads the private key from an array matching what is returned by SimpleSAML_Utilities::loadPrivateKey(...).

Parameters

array

$privatekey

The private key.

Definition at line 104 of file Signer.php.

    {
        assert('is_array($privatekey)');
        assert('array_key_exists("PEM", $privatekey)');
 
        $this->privateKey = new XMLSecurityKey(XMLSecurityKey::RSA_SHA1, array('type' => 'private'));
        if (array_key_exists('password', $privatekey)) {
            $this->privateKey->passphrase = $privatekey['password'];
        }
        $this->privateKey->loadKey($privatekey['PEM'], false);
    }

References RobRichards\XMLSecLibs\XMLSecurityKey\RSA_SHA1.

Referenced by SimpleSAML\XML\Signer\__construct(), and SimpleSAML\XML\Signer\loadPrivateKey().

Here is the caller graph for this function:

loadPublicKeyArray()

SimpleSAML\XML\Signer::loadPublicKeyArray

(

$publickey

)

Set the public key / certificate we should include in the signature.

This function loads the public key from an array matching what is returned by SimpleSAML_Utilities::loadPublicKey(...).

Parameters

array

$publickey

The public key.

Exceptions

Exception

Definition at line 167 of file Signer.php.

    {
        assert('is_array($publickey)');
 
        if (!array_key_exists('PEM', $publickey)) {
            // We have a public key with only a fingerprint
            throw new \Exception('Tried to add a certificate fingerprint in a signature.');
        }
 
        // For now, we only assume that the public key is an X509 certificate
        $this->certificate = $publickey['PEM'];
    }

Referenced by SimpleSAML\XML\Signer\__construct().

Here is the caller graph for this function:

setIDAttribute()

SimpleSAML\XML\Signer::setIDAttribute

(

$idAttrName

)

Set the attribute name for the ID value.

Parameters

string

$idAttrName

The name of the attribute which contains the id.

Definition at line 220 of file Signer.php.

    {
        assert('is_string($idAttrName)');
 
        $this->idAttrName = $idAttrName;
    }

References SimpleSAML\XML\Signer\$idAttrName.

sign()

SimpleSAML\XML\Signer::sign	(		$node,
			$insertInto,
			$insertBefore = null
	)

Signs the given DOMElement and inserts the signature at the given position.

The private key must be set before calling this function.

Parameters

\DOMElement	$node	The DOMElement we should generate a signature for.
\DOMElement	$insertInto	The DOMElement we should insert the signature element into.
\DOMElement	$insertBefore	The element we should insert the signature element before. Defaults to NULL, in which case the signature will be appended to the element spesified in $insertInto.

Exceptions

Exception

Definition at line 275 of file Signer.php.

    {
        assert('$node instanceof DOMElement');
        assert('$insertInto instanceof DOMElement');
        assert('is_null($insertBefore) || $insertBefore instanceof DOMElement ' .
            '|| $insertBefore instanceof DOMComment || $insertBefore instanceof DOMText');
 
        if ($this->privateKey === false) {
            throw new \Exception('Private key not set.');
        }
 
 
        $objXMLSecDSig = new XMLSecurityDSig();
        $objXMLSecDSig->setCanonicalMethod(XMLSecurityDSig::EXC_C14N);
 
        $options = array();
        if ($this->idAttrName !== false) {
            $options['id_name'] = $this->idAttrName;
        }
 
        $objXMLSecDSig->addReferenceList(
            array($node),
            XMLSecurityDSig::SHA1,
            array('http://www.w3.org/2000/09/xmldsig#enveloped-signature', XMLSecurityDSig::EXC_C14N),
            $options
        );
 
        $objXMLSecDSig->sign($this->privateKey);
 
 
        if ($this->certificate !== false) {
            // Add the certificate to the signature
            $objXMLSecDSig->add509Cert($this->certificate, true);
        }
 
        // Add extra certificates
        foreach ($this->extraCertificates as $certificate) {
            $objXMLSecDSig->add509Cert($certificate, true);
        }
 
        $objXMLSecDSig->insertSignature($insertInto, $insertBefore);
    }

References SimpleSAML\XML\Signer\$certificate, SimpleSAML\XML\Signer\$idAttrName, $options, RobRichards\XMLSecLibs\XMLSecurityDSig\EXC_C14N, and RobRichards\XMLSecLibs\XMLSecurityDSig\SHA1.

Field Documentation

$certificate

SimpleSAML\XML\Signer::$certificate

private

Definition at line 35 of file Signer.php.

Referenced by SimpleSAML\XML\Signer\addCertificate(), and SimpleSAML\XML\Signer\sign().

$extraCertificates

SimpleSAML\XML\Signer::$extraCertificates

private

Definition at line 41 of file Signer.php.

$idAttrName

SimpleSAML\XML\Signer::$idAttrName

private

Definition at line 25 of file Signer.php.

Referenced by SimpleSAML\XML\Signer\setIDAttribute(), and SimpleSAML\XML\Signer\sign().

$privateKey

SimpleSAML\XML\Signer::$privateKey

private

Definition at line 30 of file Signer.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/XML/Signer.php