org.pac4j.jwt.credentials.authenticator

Class JwtAuthenticator

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.profile.definition.ProfileDefinitionAware<JwtProfile>

org.pac4j.jwt.credentials.authenticator.JwtAuthenticator

All Implemented Interfaces:

Authenticator<TokenCredentials>

public class JwtAuthenticator
extends ProfileDefinitionAware<JwtProfile>
implements Authenticator<TokenCredentials>

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 and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and 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 and Description
void	addEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
void	addSignatureConfiguration(SignatureConfiguration signatureConfiguration)
protected void	createJwtProfile(TokenCredentials credentials, com.nimbusds.jwt.JWT jwt)
List<EncryptionConfiguration>	getEncryptionConfigurations()
List<SignatureConfiguration>	getSignatureConfigurations()
protected void	internalInit(WebContext context) Internal initialization of the object.
void	setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
void	setEncryptionConfigurations(List<EncryptionConfiguration> encryptionConfigurations)
void	setSignatureConfiguration(SignatureConfiguration signatureConfiguration)
void	setSignatureConfigurations(List<SignatureConfiguration> signatureConfigurations)
String	toString()
void	validate(TokenCredentials credentials, WebContext context) Validate the credentials.
CommonProfile	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.InitializableWebObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

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 Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Specified by:

internalInit in class InitializableWebObject

Parameters:

context - the web context

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 CommonProfile 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(TokenCredentials credentials,
                     WebContext context)
              throws HttpAction,
                     CredentialsException

Description copied from interface: Authenticator

Validate the credentials. It should throw a CredentialsException in case of failure.

Specified by:

validate in interface Authenticator<TokenCredentials>

Parameters:

credentials - the given credentials

context - the web context

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid

createJwtProfile

protected void createJwtProfile(TokenCredentials credentials,
                                com.nimbusds.jwt.JWT jwt)
                         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)

toString

public String toString()

Overrides:

toString in class Object