Package org.pac4j.jwt.credentials.authenticator

Class JwtAuthenticator

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.profile.definition.ProfileDefinitionAware

org.pac4j.jwt.credentials.authenticator.JwtAuthenticator

All Implemented Interfaces:

org.pac4j.core.credentials.authenticator.Authenticator

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

Authenticator for JWT. It creates the user profile and stores it in the credentials for the AuthenticatorProfileCreator.

Since:

1.8.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger

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

ALWAYS_VALIDATE

Constructor Summary

Constructors

Constructor	Description
JwtAuthenticator()
JwtAuthenticator(List<SignatureConfiguration> signatureConfigurations)
JwtAuthenticator(List<SignatureConfiguration> signatureConfigurations, List<EncryptionConfiguration> encryptionConfigurations)
JwtAuthenticator(SignatureConfiguration signatureConfiguration)
JwtAuthenticator(SignatureConfiguration signatureConfiguration, EncryptionConfiguration encryptionConfiguration)

Method Summary

Modifier and Type	Method	Description
void	addEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
void	addSignatureConfiguration(SignatureConfiguration signatureConfiguration)
protected void	createJwtProfile(org.pac4j.core.credentials.TokenCredentials credentials, com.nimbusds.jwt.JWT jwt, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)
List<EncryptionConfiguration>	getEncryptionConfigurations()
Date	getExpirationTime()
org.pac4j.core.util.generator.ValueGenerator	getIdentifierGenerator()
String	getRealmName()
List<SignatureConfiguration>	getSignatureConfigurations()
protected void	internalInit(boolean forceReinit)
void	setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
void	setEncryptionConfigurations(List<EncryptionConfiguration> encryptionConfigurations)
void	setExpirationTime(Date expirationTime)
void	setIdentifierGenerator(org.pac4j.core.util.generator.ValueGenerator identifierGenerator)
void	setRealmName(String realmName)
void	setSignatureConfiguration(SignatureConfiguration signatureConfiguration)
void	setSignatureConfigurations(List<SignatureConfiguration> signatureConfigurations)
String	toString()
void	validate(org.pac4j.core.credentials.Credentials cred, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)
org.pac4j.core.profile.UserProfile	validateToken(String token)	Validates the token and returns the corresponding user profile.
Map<String,Object>	validateTokenAndGetClaims(String token)	Validates the token and returns the corresponding user profile.

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

defaultProfileDefinition, getProfileDefinition, setProfileDefinition

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

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

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.slf4j.Logger logger

Constructor Details

JwtAuthenticator

public JwtAuthenticator()

JwtAuthenticator

public JwtAuthenticator(List<SignatureConfiguration> signatureConfigurations)

JwtAuthenticator

public JwtAuthenticator(List<SignatureConfiguration> signatureConfigurations,
 List<EncryptionConfiguration> encryptionConfigurations)

JwtAuthenticator

public JwtAuthenticator(SignatureConfiguration signatureConfiguration)

JwtAuthenticator

public JwtAuthenticator(SignatureConfiguration signatureConfiguration,
 EncryptionConfiguration encryptionConfiguration)

Method Details

internalInit

protected void internalInit(boolean forceReinit)

Specified by:

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

validateTokenAndGetClaims

public Map<String,Object> validateTokenAndGetClaims(String token)

Validates the token and returns the corresponding user profile.

Parameters:

token - the JWT

Returns:

the corresponding user profile

validateToken

public org.pac4j.core.profile.UserProfile validateToken(String token)

Validates the token and returns the corresponding user profile.

Parameters:

token - the JWT

Returns:

the corresponding user profile

validate

public void validate(org.pac4j.core.credentials.Credentials cred,
 org.pac4j.core.context.WebContext context,
 org.pac4j.core.context.session.SessionStore sessionStore)

Specified by:

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

createJwtProfile

protected void createJwtProfile(org.pac4j.core.credentials.TokenCredentials credentials,
 com.nimbusds.jwt.JWT jwt,
 org.pac4j.core.context.WebContext context,
 org.pac4j.core.context.session.SessionStore sessionStore)
                         throws ParseException

Throws:

ParseException

getSignatureConfigurations

public List<SignatureConfiguration> getSignatureConfigurations()

setSignatureConfiguration

public void setSignatureConfiguration(SignatureConfiguration signatureConfiguration)

addSignatureConfiguration

public void addSignatureConfiguration(SignatureConfiguration signatureConfiguration)

setSignatureConfigurations

public void setSignatureConfigurations(List<SignatureConfiguration> signatureConfigurations)

getEncryptionConfigurations

public List<EncryptionConfiguration> getEncryptionConfigurations()

setEncryptionConfiguration

public void setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

addEncryptionConfiguration

public void addEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

setEncryptionConfigurations

public void setEncryptionConfigurations(List<EncryptionConfiguration> encryptionConfigurations)

getRealmName

public String getRealmName()

setRealmName

public void setRealmName(String realmName)

setExpirationTime

public void setExpirationTime(Date expirationTime)

getExpirationTime

public Date getExpirationTime()

getIdentifierGenerator

public org.pac4j.core.util.generator.ValueGenerator getIdentifierGenerator()

setIdentifierGenerator

public void setIdentifierGenerator(org.pac4j.core.util.generator.ValueGenerator identifierGenerator)

toString

public String toString()

Overrides:

toString in class Object