org.picketlink.identity.federation.web.handlers.saml2

Class SAML2AuthenticationHandler

java.lang.Object

org.picketlink.identity.federation.web.handlers.saml2.BaseSAML2Handler

org.picketlink.identity.federation.web.handlers.saml2.SAML2AuthenticationHandler

All Implemented Interfaces:

SAML2Handler

public class SAML2AuthenticationHandler
extends BaseSAML2Handler

Handles for dealing with SAML2 Authentication

Configuration Options:

Since:

Oct 8, 2009

Author:

Anil.Saldhana@redhat.com

See Also:

a milisecond value sets a skew for checking the validity of assertion (SP Setting), Setting a value will disable the generation of an AuthnStatement (IDP Setting), Setting any value will disable the generation and return of roles to SP (IDP Setting), Setting any value will have an attribute statement with multiple values (IDP Setting), Setting to true will disable picking IDP attribute statements (SP Setting), a csv list of strings that represent the roles coming from IDP (SP Setting), Setting to a value will provide the nameid format to be sent to IDP (SP Setting), the url to be used for assertionConsumerURL (SP Setting)

Nested Class Summary

Nested classes/interfaces inherited from interface org.picketlink.identity.federation.core.saml.v2.interfaces.SAML2Handler

SAML2Handler.HANDLER_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORCE_AUTHN
static String	SINGLE_ATTRIBUTE_STATEMENT

Fields inherited from class org.picketlink.identity.federation.web.handlers.saml2.BaseSAML2Handler

handlerChainConfig, handlerConfig, logger

Fields inherited from interface org.picketlink.identity.federation.core.saml.v2.interfaces.SAML2Handler

ASSERTION_CONSUMER_URL, CLOCK_SKEW_MILIS, DISABLE_AUTHN_STATEMENT, DISABLE_ROLE_PICKING, DISABLE_SENDING_ROLES, ROLE_KEY, USE_MULTI_VALUED_ROLES

Constructor Summary

Constructors

Constructor and Description
SAML2AuthenticationHandler()

Method Summary

Modifier and Type	Method and Description
void	generateSAMLRequest(SAML2HandlerRequest request, SAML2HandlerResponse response) Generate a SAML Request to be sent to the IDP if the handler is invoked at the SP and vice-versa
protected List<AttributeStatementType>	getAttributeStatements(SAML2HandlerRequest request) This method is invoked during the process of issuing an assertion by the IdP.
void	handleRequestType(SAML2HandlerRequest request, SAML2HandlerResponse response) Handle a SAML2 RequestAbstractType
void	handleStatusResponseType(SAML2HandlerRequest request, SAML2HandlerResponse response) Handle a SAML2 Status Response Type
protected void	onAssertionCreated(SAML2HandlerRequest request, AssertionType assertion) This method is invoked right after the AssertionType is created.

Methods inherited from class org.picketlink.identity.federation.web.handlers.saml2.BaseSAML2Handler

checkDestination, checkDestination, getHttpRequest, getHttpSession, getProviderconfig, getType, initChainConfig, initHandlerConfig, reset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SINGLE_ATTRIBUTE_STATEMENT

public static final String SINGLE_ATTRIBUTE_STATEMENT

See Also:

Constant Field Values

FORCE_AUTHN

public static final String FORCE_AUTHN

See Also:

Constant Field Values

Constructor Detail

SAML2AuthenticationHandler

public SAML2AuthenticationHandler()

Method Detail

handleRequestType

public void handleRequestType(SAML2HandlerRequest request,
                              SAML2HandlerResponse response)
                       throws ProcessingException

Description copied from interface: SAML2Handler

Handle a SAML2 RequestAbstractType

Throws:

ProcessingException

handleStatusResponseType

public void handleStatusResponseType(SAML2HandlerRequest request,
                                     SAML2HandlerResponse response)
                              throws ProcessingException

Description copied from interface: SAML2Handler

Handle a SAML2 Status Response Type

Specified by:

handleStatusResponseType in interface SAML2Handler

Overrides:

handleStatusResponseType in class BaseSAML2Handler

Throws:

ProcessingException

See Also:

SAML2Handler#handleStatusResponseType(SAML2HandlerRequest, SAML2HandlerResponse)}

generateSAMLRequest

public void generateSAMLRequest(SAML2HandlerRequest request,
                                SAML2HandlerResponse response)
                         throws ProcessingException

Description copied from interface: SAML2Handler

Generate a SAML Request to be sent to the IDP if the handler is invoked at the SP and vice-versa

Specified by:

generateSAMLRequest in interface SAML2Handler

Overrides:

generateSAMLRequest in class BaseSAML2Handler

Throws:

ProcessingException

See Also:

SAML2Handler.generateSAMLRequest(SAML2HandlerRequest, SAML2HandlerResponse)

onAssertionCreated

protected void onAssertionCreated(SAML2HandlerRequest request,
                                  AssertionType assertion)

This method is invoked right after the AssertionType is created.

Subclasses may override this method to perform any processing to the newly created assertion.

Parameters:

request -

assertion -

getAttributeStatements

protected List<AttributeStatementType> getAttributeStatements(SAML2HandlerRequest request)

This method is invoked during the process of issuing an assertion by the IdP. It returns a list of AttributeStatementType that are going to be added to the assertion.

Subclasses may override this method to customize the attributes sent by the IdP to relying parties.

Before overriden this method, developers must consider using a SAML2AttributeManager. This method provides more access to the invocation context, which can be access from the given SAML2HandlerRequest.

Parameters:

request -

Returns: