opensaml-3.2.1
opensaml::saml2p::SAML2MessageDecoder Class Reference

Base class for SAML 2.0 MessageDecoders. More...

#include <saml/saml2/binding/SAML2MessageDecoder.h>

Inheritance diagram for opensaml::saml2p::SAML2MessageDecoder:
opensaml::MessageDecoder

Public Member Functions

const XMLCh * getProtocolFamily () const
 Returns identifier for the protocol family associated with the decoder. More...
 
void extractMessageDetails (const xmltooling::XMLObject &message, const xmltooling::GenericRequest &genericRequest, const XMLCh *protocol, SecurityPolicy &policy) const
 Extracts policy-relevant message details. More...
 
- Public Member Functions inherited from opensaml::MessageDecoder
virtual bool isUserAgentPresent () const
 Indicates whether a web browser or similar user agent delivered the message. More...
 
void setArtifactResolver (const ArtifactResolver *artifactResolver)
 Provides an ArtifactResolver implementation for the MessageDecoder to use. More...
 
virtual xmltooling::XMLObject * decode (std::string &relayState, const xmltooling::GenericRequest &genericRequest, SecurityPolicy &policy) const
 
virtual xmltooling::XMLObject * decode (std::string &relayState, const xmltooling::GenericRequest &genericRequest, xmltooling::GenericResponse *genericResponse, SecurityPolicy &policy) const
 Decodes a transport request into a SAML protocol message, and evaluates it against a supplied SecurityPolicy. More...
 

Protected Member Functions

void extractCorrelationID (const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse *response, const std::string &relayState, SecurityPolicy &policy) const
 If relay state is provided, the previous request ID is extracted from a correlation cookie and supplied to the policy. More...
 

Additional Inherited Members

- Protected Attributes inherited from opensaml::MessageDecoder
const ArtifactResolverm_artifactResolver
 Pointer to an ArtifactResolver implementation. More...
 

Detailed Description

Base class for SAML 2.0 MessageDecoders.

Member Function Documentation

◆ extractCorrelationID()

void opensaml::saml2p::SAML2MessageDecoder::extractCorrelationID ( const xmltooling::HTTPRequest &  request,
xmltooling::HTTPResponse *  response,
const std::string &  relayState,
SecurityPolicy policy 
) const
protected

If relay state is provided, the previous request ID is extracted from a correlation cookie and supplied to the policy.

Parameters
requestHTTP request
responseoptional HTTP response
relayStatethe RelayState token
policythe SecurityPolicy to attach the ID to

◆ extractMessageDetails()

void opensaml::saml2p::SAML2MessageDecoder::extractMessageDetails ( const xmltooling::XMLObject &  message,
const xmltooling::GenericRequest &  request,
const XMLCh *  protocol,
SecurityPolicy policy 
) const
virtual

Extracts policy-relevant message details.

Parameters
messagethe incoming message
requestthe protocol request
protocolthe protocol family in use
policySecurityPolicy to provide various components and track message data

Implements opensaml::MessageDecoder.

◆ getProtocolFamily()

const XMLCh* opensaml::saml2p::SAML2MessageDecoder::getProtocolFamily ( ) const
virtual

Returns identifier for the protocol family associated with the decoder.

Returns
a protocol family identifier, or nullptr

Reimplemented from opensaml::MessageDecoder.


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