Package org.pac4j.saml.credentials.authenticator

Class SAML2Authenticator

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.profile.definition.ProfileDefinitionAware

org.pac4j.saml.credentials.authenticator.SAML2Authenticator

All Implemented Interfaces:

org.pac4j.core.credentials.authenticator.Authenticator

public class SAML2Authenticator
extends org.pac4j.core.profile.definition.ProfileDefinitionAware
implements org.pac4j.core.credentials.authenticator.Authenticator

Authenticator for SAML 2.0

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHN_CONTEXT	Constant AUTHN_CONTEXT="authnContext"
static final String	AUTHN_CONTEXT_AUTHORITIES	Constant AUTHN_CONTEXT_AUTHORITIES="authnContextAuthorities"
static final String	ISSUER_ID	Constant ISSUER_ID="issuerId"
protected final org.slf4j.Logger	logger
static final String	SAML_CONDITION_NOT_BEFORE_ATTRIBUTE	Constant SAML_CONDITION_NOT_BEFORE_ATTRIBUTE="notBefore"
static final String	SAML_CONDITION_NOT_ON_OR_AFTER_ATTRIBUTE	Constant SAML_CONDITION_NOT_ON_OR_AFTER_ATTRIBUTE="notOnOrAfter"
static final String	SAML_NAME_ID_FORMAT	Constant SAML_NAME_ID_FORMAT="samlNameIdFormat"
static final String	SAML_NAME_ID_NAME_QUALIFIER	Constant SAML_NAME_ID_NAME_QUALIFIER="samlNameIdNameQualifier"
static final String	SAML_NAME_ID_SP_NAME_QUALIFIER	Constant SAML_NAME_ID_SP_NAME_QUALIFIER="samlNameIdSpNameQualifier"
static final String	SAML_NAME_ID_SP_PROVIDED_ID	Constant SAML_NAME_ID_SP_PROVIDED_ID="samlNameIdSpProvidedId"
static final String	SESSION_INDEX	Constant SESSION_INDEX="sessionindex"

Fields inherited from interface org.pac4j.core.credentials.authenticator.Authenticator

ALWAYS_VALIDATE, NEVER_VALIDATE

Constructor Summary

Constructors

Constructor	Description
SAML2Authenticator(SAML2ResponseValidator loginValidator, SAML2LogoutValidator logoutValidator, String attributeAsId)	Constructor for SAML2Authenticator.
SAML2Authenticator(SAML2ResponseValidator loginValidator, SAML2LogoutValidator logoutValidator, String attributeAsId, Map<String,String> mappedAttributes)	Constructor for SAML2Authenticator.

Method Summary

Modifier and Type	Method	Description
protected void	buildProfile(SAML2AuthenticationCredentials credentials)	buildProfile.
protected void	internalInit(boolean forceReinit)
Optional<org.pac4j.core.credentials.Credentials>	validate(org.pac4j.core.context.CallContext ctx, org.pac4j.core.credentials.Credentials extractedCredentials)

Methods inherited from class org.pac4j.core.profile.definition.ProfileDefinitionAware

getProfileDefinition, setProfileDefinition, setProfileDefinitionIfUndefined

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

afterInternalInit, beforeInternalInit, getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize, toString

Methods inherited from class java.lang.Object

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

Field Details

SAML_CONDITION_NOT_BEFORE_ATTRIBUTE

public static final String SAML_CONDITION_NOT_BEFORE_ATTRIBUTE

Constant SAML_CONDITION_NOT_BEFORE_ATTRIBUTE="notBefore"

See Also:

• Constant Field Values

SAML_CONDITION_NOT_ON_OR_AFTER_ATTRIBUTE

public static final String SAML_CONDITION_NOT_ON_OR_AFTER_ATTRIBUTE

Constant SAML_CONDITION_NOT_ON_OR_AFTER_ATTRIBUTE="notOnOrAfter"

See Also:

• Constant Field Values

SESSION_INDEX

public static final String SESSION_INDEX

Constant SESSION_INDEX="sessionindex"

See Also:

• Constant Field Values

ISSUER_ID

public static final String ISSUER_ID

Constant ISSUER_ID="issuerId"

See Also:

• Constant Field Values

AUTHN_CONTEXT

public static final String AUTHN_CONTEXT

Constant AUTHN_CONTEXT="authnContext"

See Also:

• Constant Field Values

AUTHN_CONTEXT_AUTHORITIES

public static final String AUTHN_CONTEXT_AUTHORITIES

Constant AUTHN_CONTEXT_AUTHORITIES="authnContextAuthorities"

See Also:

• Constant Field Values

SAML_NAME_ID_FORMAT

public static final String SAML_NAME_ID_FORMAT

Constant SAML_NAME_ID_FORMAT="samlNameIdFormat"

See Also:

• Constant Field Values

SAML_NAME_ID_NAME_QUALIFIER

public static final String SAML_NAME_ID_NAME_QUALIFIER

Constant SAML_NAME_ID_NAME_QUALIFIER="samlNameIdNameQualifier"

See Also:

• Constant Field Values

SAML_NAME_ID_SP_NAME_QUALIFIER

public static final String SAML_NAME_ID_SP_NAME_QUALIFIER

Constant SAML_NAME_ID_SP_NAME_QUALIFIER="samlNameIdSpNameQualifier"

See Also:

• Constant Field Values

SAML_NAME_ID_SP_PROVIDED_ID

public static final String SAML_NAME_ID_SP_PROVIDED_ID

Constant SAML_NAME_ID_SP_PROVIDED_ID="samlNameIdSpProvidedId"

See Also:

• Constant Field Values

logger

protected final org.slf4j.Logger logger

Constructor Details

SAML2Authenticator

public SAML2Authenticator(SAML2ResponseValidator loginValidator,
 SAML2LogoutValidator logoutValidator,
 String attributeAsId,
 Map<String,String> mappedAttributes)

Constructor for SAML2Authenticator.

Parameters:

loginValidator - a SAML2ResponseValidator object

logoutValidator - a SAML2LogoutValidator object

attributeAsId - a String object

mappedAttributes - a Map object

SAML2Authenticator

public SAML2Authenticator(SAML2ResponseValidator loginValidator,
 SAML2LogoutValidator logoutValidator,
 String attributeAsId)

Constructor for SAML2Authenticator.

Parameters:

loginValidator - a SAML2ResponseValidator object

logoutValidator - a SAML2LogoutValidator object

attributeAsId - a String object

Method Details

internalInit

protected void internalInit(boolean forceReinit)

Specified by:

internalInit in class org.pac4j.core.util.InitializableObject

validate

public Optional<org.pac4j.core.credentials.Credentials> validate(org.pac4j.core.context.CallContext ctx,
 org.pac4j.core.credentials.Credentials extractedCredentials)

Specified by:

validate in interface org.pac4j.core.credentials.authenticator.Authenticator

buildProfile

protected void buildProfile(SAML2AuthenticationCredentials credentials)

buildProfile.

Parameters:

credentials - a SAML2AuthenticationCredentials object