SAML2\Assertion\Decrypter Class Reference

Collaboration diagram for SAML2\Assertion\Decrypter:

Public Member Functions
	__construct (LoggerInterface $logger, IdentityProvider $identityProvider, ServiceProvider $serviceProvider, PrivateKeyLoader $privateKeyLoader)
	isEncryptionRequired ()
	Allows for checking whether either the SP or the IdP requires assertion encryption. More...
	decrypt (EncryptedAssertion $assertion)

Private Attributes
	$identityProvider
	$serviceProvider
	$privateKeyLoader
	$logger

Detailed Description

Definition at line 12 of file Decrypter.php.

Constructor & Destructor Documentation

__construct()

SAML2\Assertion\Decrypter::__construct	(	LoggerInterface	$logger,
		IdentityProvider	$identityProvider,
		ServiceProvider	$serviceProvider,
		PrivateKeyLoader	$privateKeyLoader
	)

Definition at line 34 of file Decrypter.php.

      {
        $this->logger = $logger;
        $this->identityProvider = $identityProvider;
        $this->serviceProvider = $serviceProvider;
        $this->privateKeyLoader = $privateKeyLoader;
    }

References SAML2\Assertion\Decrypter\$identityProvider, SAML2\Assertion\Decrypter\$logger, SAML2\Assertion\Decrypter\$privateKeyLoader, and SAML2\Assertion\Decrypter\$serviceProvider.

Member Function Documentation

decrypt()

SAML2\Assertion\Decrypter::decrypt

(

EncryptedAssertion

$assertion

)

Parameters

\SAML2\EncryptedAssertion

$assertion

Returns

\SAML2\Assertion

Definition at line 60 of file Decrypter.php.

    {
        $decryptionKeys = $this->privateKeyLoader->loadDecryptionKeys($this->identityProvider, $this->serviceProvider);
        $blacklistedKeys = $this->identityProvider->getBlacklistedAlgorithms();
        if (is_null($blacklistedKeys)) {
            $blacklistedKeys = $this->serviceProvider->getBlacklistedAlgorithms();
        }
 
        // reflects the simplesamlphp behaviour for BC, see
        // https://github.com/simplesamlphp/simplesamlphp/blob/3d735912342767d391297cc5e13272a76730aca0/modules/saml/lib/Message.php#L369
        foreach ($decryptionKeys as $index => $key) {
            try {
                $decryptedAssertion = $assertion->getAssertion($key, $blacklistedKeys);
                $this->logger->debug(sprintf('Decrypted Assertion with key "#%d"', $index));
 
                return $decryptedAssertion;
            } catch (\Exception $e) {
                $this->logger->debug(sprintf(
                    'Could not decrypt assertion with key "#%d", "%s" thrown: "%s"',
                    $index,
                    get_class($e),
                    $e->getMessage()
                ));
            }
        }
 
        throw new NotDecryptedException(sprintf(
            'Could not decrypt the assertion, tried with "%d" keys. See the debug log for more information',
            count($decryptionKeys)
        ));
    }

References $index, $key, and SAML2\EncryptedAssertion\getAssertion().

Here is the call graph for this function:

isEncryptionRequired()

SAML2\Assertion\Decrypter::isEncryptionRequired

(

)

Allows for checking whether either the SP or the IdP requires assertion encryption.

Definition at line 49 of file Decrypter.php.

    {
        return $this->identityProvider->isAssertionEncryptionRequired()
            || $this->serviceProvider->isAssertionEncryptionRequired();
    }

Field Documentation

$identityProvider

SAML2\Assertion\Decrypter::$identityProvider

private

Definition at line 17 of file Decrypter.php.

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

$logger

SAML2\Assertion\Decrypter::$logger

private

Definition at line 32 of file Decrypter.php.

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

$privateKeyLoader

SAML2\Assertion\Decrypter::$privateKeyLoader

private

Definition at line 27 of file Decrypter.php.

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

$serviceProvider

SAML2\Assertion\Decrypter::$serviceProvider

private

Definition at line 22 of file Decrypter.php.

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

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/Assertion/Decrypter.php