SAML2\EncryptedAssertion Class Reference

Collaboration diagram for SAML2\EncryptedAssertion:

Public Member Functions
	__construct (\DOMElement $xml=null)
	Constructor for SAML 2 encrypted assertions. More...
	setAssertion (Assertion $assertion, XMLSecurityKey $key)
	Set the assertion. More...
	getAssertion (XMLSecurityKey $inputKey, array $blacklist=array())
	Retrieve the assertion. More...
	toXML (\DOMNode $parentElement=null)
	Convert this encrypted assertion to an XML element. More...

Private Attributes
	$encryptedData

Detailed Description

Definition at line 13 of file EncryptedAssertion.php.

Constructor & Destructor Documentation

__construct()

SAML2\EncryptedAssertion::__construct

(

\DOMElement

$xml = null

)

Constructor for SAML 2 encrypted assertions.

Parameters

\DOMElement | null

$xml

The encrypted assertion XML element.

Exceptions

Definition at line 28 of file EncryptedAssertion.php.

References $data, and $xml.

    {
        if ($xml === null) {
            return;
        }

        $data = Utils::xpQuery($xml, './xenc:EncryptedData');
        if (count($data) === 0) {
            throw new \Exception('Missing encrypted data in <saml:EncryptedAssertion>.');
        } elseif (count($data) > 1) {
            throw new \Exception('More than one encrypted data element in <saml:EncryptedAssertion>.');
        }
        $this->encryptedData = $data[0];
    }

Member Function Documentation

getAssertion()

SAML2\EncryptedAssertion::getAssertion	(	XMLSecurityKey	$inputKey,
		array	$blacklist = array()
	)

Retrieve the assertion.

Parameters

XMLSecurityKey	$inputKey	The key we should use to decrypt the assertion.
array	$blacklist	Blacklisted decryption algorithms.

Returns

The decrypted assertion.

Definition at line 91 of file EncryptedAssertion.php.

Referenced by SAML2\Assertion\Decrypter\decrypt().

    {
        $assertionXML = Utils::decryptElement($this->encryptedData, $inputKey, $blacklist);

        Utils::getContainer()->debugMessage($assertionXML, 'decrypt');

        return new Assertion($assertionXML);
    }

Here is the caller graph for this function:

setAssertion()

SAML2\EncryptedAssertion::setAssertion	(	Assertion	$assertion,
		XMLSecurityKey	$key
	)

Set the assertion.

Parameters

\SAML2\Assertion	$assertion	The assertion.
XMLSecurityKey	$key	The key we should use to encrypt the assertion.

Exceptions

Definition at line 50 of file EncryptedAssertion.php.

References $key, $xml, and SAML2\Assertion\toXML().

    {
        $xml = $assertion->toXML();

        Utils::getContainer()->debugMessage($xml, 'encrypt');

        $enc = new XMLSecEnc();
        $enc->setNode($xml);
        $enc->type = XMLSecEnc::Element;

        switch ($key->type) {
            case XMLSecurityKey::TRIPLEDES_CBC:
            case XMLSecurityKey::AES128_CBC:
            case XMLSecurityKey::AES192_CBC:
            case XMLSecurityKey::AES256_CBC:
                $symmetricKey = $key;
                break;

            case XMLSecurityKey::RSA_1_5:
            case XMLSecurityKey::RSA_OAEP_MGF1P:
                $symmetricKey = new XMLSecurityKey(XMLSecurityKey::AES128_CBC);
                $symmetricKey->generateSessionKey();

                $enc->encryptKey($key, $symmetricKey);

                break;

            default:
                throw new \Exception('Unknown key type for encryption: ' . $key->type);
        }

        $this->encryptedData = $enc->encryptNode($symmetricKey);
    }

Here is the call graph for this function:

toXML()

SAML2\EncryptedAssertion::toXML

(

\DOMNode

$parentElement = null

)

Convert this encrypted assertion to an XML element.

Parameters

\DOMNode | null

$parentElement

The DOM node the assertion should be created in.

Returns

This encrypted assertion.

Definition at line 106 of file EncryptedAssertion.php.

    {
        if ($parentElement === null) {
            $document = DOMDocumentFactory::create();
            $parentElement = $document;
        } else {
            $document = $parentElement->ownerDocument;
        }

        $root = $document->createElementNS(Constants::NS_SAML, 'saml:' . 'EncryptedAssertion');
        $parentElement->appendChild($root);

        $root->appendChild($document->importNode($this->encryptedData, true));

        return $root;
    }

Field Documentation

$encryptedData

SAML2\EncryptedAssertion::$encryptedData

private

Definition at line 20 of file EncryptedAssertion.php.

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/EncryptedAssertion.php