SAML2\Response\Processor Class Reference

@SuppressWarnings(PHPMD.CouplingBetweenObjects) - due to specific exceptions More...

Collaboration diagram for SAML2\Response\Processor:

Public Member Functions
	__construct (LoggerInterface $logger)
	process (ServiceProvider $serviceProviderConfiguration, IdentityProvider $identityProviderConfiguration, Destination $currentDestination, Response $response)

Private Member Functions
	enforcePreconditions (Response $response)
	Checks the preconditions that must be valid in order for the response to be processed. More...
	verifySignature (Response $response, IdentityProvider $identityProviderConfiguration)
	processAssertions (Response $response)

Private Attributes
	$logger
	$preconditionValidator
	$signatureValidator
	$assertionProcessor
	$responseIsSigned = false

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects) - due to specific exceptions

Definition at line 21 of file Processor.php.

Constructor & Destructor Documentation

__construct()

SAML2\Response\Processor::__construct

(

LoggerInterface

$logger

)

Parameters

\Psr\Log\LoggerInterface

$logger

Definition at line 55 of file Processor.php.

    {
        $this->logger = $logger;
 
        $this->signatureValidator = new Validator($logger);
    }

References SAML2\Response\Processor\$logger.

Member Function Documentation

enforcePreconditions()

SAML2\Response\Processor::enforcePreconditions ( Response  $response )

private

Checks the preconditions that must be valid in order for the response to be processed.

Parameters

\SAML2\Response

$response

Definition at line 96 of file Processor.php.

    {
        $result = $this->preconditionValidator->validate($response);
 
        if (!$result->isValid()) {
            throw PreconditionNotMetException::createFromValidationResult($result);
        }
    }

References $response, $result, and SAML2\Response\Exception\PreconditionNotMetException\createFromValidationResult().

Referenced by SAML2\Response\Processor\process().

Here is the call graph for this function:

Here is the caller graph for this function:

process()

SAML2\Response\Processor::process	(	ServiceProvider	$serviceProviderConfiguration,
		IdentityProvider	$identityProviderConfiguration,
		Destination	$currentDestination,
		Response	$response
	)

Parameters

\SAML2\Configuration\ServiceProvider	$serviceProviderConfiguration
\SAML2\Configuration\IdentityProvider	$identityProviderConfiguration
\SAML2\Configuration\Destination	$currentDestination
\SAML2\Response	$response

Returns

\SAML2\Assertion[] Collection (\SAML2\Utilities\ArrayCollection) of \SAML2\Assertion objects

Definition at line 70 of file Processor.php.

      {
        $this->preconditionValidator = new PreconditionValidator($currentDestination);
        $this->assertionProcessor = ProcessorBuilder::build(
            $this->logger,
            $this->signatureValidator,
            $currentDestination,
            $identityProviderConfiguration,
            $serviceProviderConfiguration,
            $response
        );
 
        $this->enforcePreconditions($response);
        $this->verifySignature($response, $identityProviderConfiguration);
        return $this->processAssertions($response);
    }

References $response, SAML2\Assertion\ProcessorBuilder\build(), SAML2\Response\Processor\enforcePreconditions(), SAML2\Response\Processor\processAssertions(), and SAML2\Response\Processor\verifySignature().

Here is the call graph for this function:

processAssertions()

SAML2\Response\Processor::processAssertions ( Response  $response )

private

Parameters

\SAML2\Response

$response

Returns

\SAML2\Assertion[]

Definition at line 140 of file Processor.php.

    {
        $assertions = $response->getAssertions();
        if (empty($assertions)) {
            throw new NoAssertionsFoundException('No assertions found in response from IdP.');
        }
 
        if (!$this->responseIsSigned) {
            foreach ($assertions as $assertion) {
                if (!$assertion->getWasSignedAtConstruction()) {
                    throw new UnsignedResponseException(
                        'Both the response and the assertion it contains are not signed.'
                    );
                }
            }
        }
 
        return $this->assertionProcessor->processAssertions($assertions);
    }

References SAML2\Response\$assertions, and $response.

Referenced by SAML2\Response\Processor\process().

Here is the caller graph for this function:

verifySignature()

SAML2\Response\Processor::verifySignature ( Response  $response, IdentityProvider  $identityProviderConfiguration  )

private

Parameters

\SAML2\Response	$response
\SAML2\Configuration\IdentityProvider	$identityProviderConfiguration

Definition at line 109 of file Processor.php.

      {
        if (!$response->isMessageConstructedWithSignature()) {
            $this->logger->info(sprintf(
                'SAMLResponse with id "%s" was not signed at root level, not attempting to verify the signature of the'
                . ' reponse itself',
                $response->getId()
            ));
 
            return;
        }
 
        $this->logger->info(sprintf(
            'Attempting to verify the signature of SAMLResponse with id "%s"',
            $response->getId()
        ));
 
        $this->responseIsSigned = true;
 
        if (!$this->signatureValidator->hasValidSignature($response, $identityProviderConfiguration)) {
            throw new InvalidResponseException();
        }
    }

References $response, and sprintf.

Referenced by SAML2\Response\Processor\process().

Here is the caller graph for this function:

Field Documentation

$assertionProcessor

SAML2\Response\Processor::$assertionProcessor

private

Definition at line 41 of file Processor.php.

$logger

SAML2\Response\Processor::$logger

private

Definition at line 26 of file Processor.php.

Referenced by SAML2\Response\Processor\__construct().

$preconditionValidator

SAML2\Response\Processor::$preconditionValidator

private

Definition at line 31 of file Processor.php.

$responseIsSigned

SAML2\Response\Processor::$responseIsSigned = false

private

Definition at line 49 of file Processor.php.

$signatureValidator

SAML2\Response\Processor::$signatureValidator

private

Definition at line 36 of file Processor.php.

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/Response/Processor.php