Package com.axelor.auth.pac4j.local

Class AxelorApiKeyAuthenticator

java.lang.Object

com.axelor.auth.pac4j.local.AxelorApiKeyAuthenticator

All Implemented Interfaces:

org.pac4j.core.credentials.authenticator.Authenticator

public class AxelorApiKeyAuthenticator
extends Object
implements org.pac4j.core.credentials.authenticator.Authenticator

Authenticator implementation for API key-based authentication.

The authenticator performs the following validations:

• Verifies the API key is present and has the correct format
• Validates the token against the stored digest
• Checks if the token has not expired
• Confirms the associated user account is active

When authentication is successful, the authenticator updates the "last used" date of the token.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	AxelorApiKeyAuthenticator.ApiKey	The two parts composing an API key.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVALID_API_KEY
static final String	MISSING_API_KEY
static final String	UNSUPPORTED_CREDENTIALS
static final String	USER_DISABLED

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

ALWAYS_VALIDATE, NEVER_VALIDATE

Constructor Summary

Constructors

Constructor	Description
AxelorApiKeyAuthenticator()

Method Summary

Modifier and Type	Method	Description
protected AxelorApiKeyAuthenticator.ApiKey	extractApiKey(org.pac4j.core.credentials.TokenCredentials tokenCredentials)	Extracts the key and the token composing the API key of the given credentials.
void	setUserTokenLastUsed(UserToken userToken)
Optional<org.pac4j.core.credentials.Credentials>	validate(org.pac4j.core.context.CallContext ctx, org.pac4j.core.credentials.Credentials credentials)
protected UserToken	validateUser(AxelorApiKeyAuthenticator.ApiKey apiKey)	Finds the user token matching the given API key.

Methods inherited from class java.lang.Object

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

Field Details

UNSUPPORTED_CREDENTIALS

public static final String UNSUPPORTED_CREDENTIALS

See Also:

• Constant Field Values

MISSING_API_KEY

public static final String MISSING_API_KEY

See Also:

• Constant Field Values

INVALID_API_KEY

public static final String INVALID_API_KEY

See Also:

• Constant Field Values

USER_DISABLED

public static final String USER_DISABLED

See Also:

• Constant Field Values

Constructor Details

AxelorApiKeyAuthenticator

public AxelorApiKeyAuthenticator()

Method Details

validate

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

Specified by:

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

extractApiKey

protected AxelorApiKeyAuthenticator.ApiKey extractApiKey(org.pac4j.core.credentials.TokenCredentials tokenCredentials)

Extracts the key and the token composing the API key of the given credentials.

Parameters:

tokenCredentials - the credentials holding the API key

Returns:

the key and the token extracted from the API key

Throws:

org.pac4j.core.exception.BadCredentialsException - if the API key is missing or malformed

validateUser

protected UserToken validateUser(AxelorApiKeyAuthenticator.ApiKey apiKey)

Finds the user token matching the given API key.

Parameters:

apiKey - the key and the token extracted from the API key

Returns:

the matching user token, owned by an active user

Throws:

org.pac4j.core.exception.AccountNotFoundException - if the API key is invalid or expired, or if its owner is disabled

setUserTokenLastUsed

public void setUserTokenLastUsed(UserToken userToken)