org.pac4j.saml.client

Class Saml2Client

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient<Saml2Credentials,Saml2Profile>

org.pac4j.saml.client.Saml2Client

All Implemented Interfaces:

Cloneable, Client<Saml2Credentials,Saml2Profile>

public class Saml2Client
extends BaseClient<Saml2Credentials,Saml2Profile>

This class is the client to authenticate users with a SAML2 Identity Provider. This implementation relies on the Web Browser SSO profile with HTTP-POST binding. (http://docs.oasis-open.org/security/saml/v2.0/saml-profiles-2.0-os.pdf).

Since:

1.5.0

Author:

Michael Remond

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
static String	SAML_METADATA_KEY_INFO_GENERATOR
static String	SAML_RELAY_STATE_ATTRIBUTE

Fields inherited from class org.pac4j.core.client.BaseClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
Saml2Client()

Method Summary

Methods

Modifier and Type	Method and Description
String	getComparisonType()
String	getDestinationBindingType()
protected String	getIdpEntityId(org.opensaml.xml.XMLObject md)
Mechanism	getMechanism()
protected String	getStateParameter(WebContext webContext)
protected org.opensaml.xml.XMLObject	getXmlObject(org.opensaml.saml2.metadata.provider.AbstractMetadataProvider idpMetadataProvider)
protected org.opensaml.saml2.metadata.provider.AbstractMetadataProvider	idpMetadataProvider(org.opensaml.xml.parse.ParserPool parserPool)
protected void	internalInit()
protected boolean	isDirectRedirection()
boolean	isForceAuth()
protected BaseClient<Saml2Credentials,Saml2Profile>	newClient()
protected org.opensaml.xml.parse.StaticBasicParserPool	newStaticBasicParserPool()
String	printClientMetadata()
protected Saml2Credentials	retrieveCredentials(WebContext wc)
protected RedirectAction	retrieveRedirectAction(WebContext wc)
protected Saml2Profile	retrieveUserProfile(Saml2Credentials credentials, WebContext context)
void	setComparisonType(String comparisonType)
void	setDestinationBindingType(String destinationBindingType)
void	setForceAuth(boolean forceAuth)
void	setIdpEntityId(String idpEntityId)
void	setIdpMetadata(String idpMetadata)
void	setIdpMetadataPath(String idpMetadataPath)
void	setKeystorePassword(String keystorePassword)
void	setKeystorePath(String keystorePath)
void	setMaximumAuthenticationLifetime(Integer maximumAuthenticationLifetime)
void	setPrivateKeyPassword(String privateKeyPassword)
void	setSpEntityId(String spEntityId)

Methods inherited from class org.pac4j.core.client.BaseClient

addAuthorizationGenerator, clone, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getRedirectAction, getRedirectionUrl, getUserProfile, isEnableContextualRedirects, prependHostToUrlIfNotPresent, redirect, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setName, toString

Methods inherited from class org.pac4j.core.util.InitializableObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

SAML_METADATA_KEY_INFO_GENERATOR

public static final String SAML_METADATA_KEY_INFO_GENERATOR

See Also:

Constant Field Values

SAML_RELAY_STATE_ATTRIBUTE

public static final String SAML_RELAY_STATE_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

Saml2Client

public Saml2Client()

Method Detail

internalInit

protected void internalInit()

Specified by:

internalInit in class InitializableObject

newClient

protected BaseClient<Saml2Credentials,Saml2Profile> newClient()

Specified by:

newClient in class BaseClient<Saml2Credentials,Saml2Profile>

isDirectRedirection

protected boolean isDirectRedirection()

Specified by:

isDirectRedirection in class BaseClient<Saml2Credentials,Saml2Profile>

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext wc)

Specified by:

retrieveRedirectAction in class BaseClient<Saml2Credentials,Saml2Profile>

retrieveCredentials

protected Saml2Credentials retrieveCredentials(WebContext wc)
                                        throws RequiresHttpAction

Specified by:

retrieveCredentials in class BaseClient<Saml2Credentials,Saml2Profile>

Throws:

RequiresHttpAction

newStaticBasicParserPool

protected org.opensaml.xml.parse.StaticBasicParserPool newStaticBasicParserPool()

idpMetadataProvider

protected org.opensaml.saml2.metadata.provider.AbstractMetadataProvider idpMetadataProvider(org.opensaml.xml.parse.ParserPool parserPool)

getXmlObject

protected org.opensaml.xml.XMLObject getXmlObject(org.opensaml.saml2.metadata.provider.AbstractMetadataProvider idpMetadataProvider)

getIdpEntityId

protected String getIdpEntityId(org.opensaml.xml.XMLObject md)

retrieveUserProfile

protected Saml2Profile retrieveUserProfile(Saml2Credentials credentials,
                               WebContext context)

Specified by:

retrieveUserProfile in class BaseClient<Saml2Credentials,Saml2Profile>

getStateParameter

protected String getStateParameter(WebContext webContext)

Overrides:

getStateParameter in class BaseClient<Saml2Credentials,Saml2Profile>

getMechanism

public Mechanism getMechanism()

Specified by:

getMechanism in class BaseClient<Saml2Credentials,Saml2Profile>

setIdpMetadata

public void setIdpMetadata(String idpMetadata)

setIdpMetadataPath

public void setIdpMetadataPath(String idpMetadataPath)

setIdpEntityId

public void setIdpEntityId(String idpEntityId)

setSpEntityId

public void setSpEntityId(String spEntityId)

setKeystorePath

public void setKeystorePath(String keystorePath)

setKeystorePassword

public void setKeystorePassword(String keystorePassword)

setPrivateKeyPassword

public void setPrivateKeyPassword(String privateKeyPassword)

setMaximumAuthenticationLifetime

public void setMaximumAuthenticationLifetime(Integer maximumAuthenticationLifetime)

printClientMetadata

public String printClientMetadata()

isForceAuth

public boolean isForceAuth()

Returns:

the forceAuth

setForceAuth

public void setForceAuth(boolean forceAuth)

Parameters:

forceAuth - the forceAuth to set

getComparisonType

public String getComparisonType()

Returns:

the comparisonType

setComparisonType

public void setComparisonType(String comparisonType)

Parameters:

comparisonType - the comparisonType to set

getDestinationBindingType

public String getDestinationBindingType()

Returns:

the destinationBindingType

setDestinationBindingType

public void setDestinationBindingType(String destinationBindingType)

Parameters:

destinationBindingType - the destinationBindingType to set