Package org.attribyte.snook.auth

Class HMACCookieLoginAuthenticator<T>

java.lang.Object

org.attribyte.snook.auth.HMACCookieAuthenticator<T>

org.attribyte.snook.auth.HMACCookieLoginAuthenticator<T>

All Implemented Interfaces:

Authenticator<T>, LoginAuthenticator<T>

public abstract class HMACCookieLoginAuthenticator<T>
extends HMACCookieAuthenticator<T>
implements LoginAuthenticator<T>

An authenticator that validates an HMACToken sent as a cookie value.

Field Summary

Fields inherited from class org.attribyte.snook.auth.HMACCookieAuthenticator

cookieKey, hmacFunctions

Fields inherited from interface org.attribyte.snook.auth.Authenticator

base64Encoding, credentialHasher

Constructor Summary

Constructors

Constructor	Description
HMACCookieLoginAuthenticator(Cookies.CookieKey cookieKey, Function<String,com.google.common.hash.HashFunction> hmacFunctions, BiFunction<String,String,Boolean> checkPasswordFunction, Function<String,String> hmacKeyFunction)	Creates an authenticator.
HMACCookieLoginAuthenticator(Cookies.CookieKey cookieKey, Function<String,com.google.common.hash.HashFunction> hmacFunctions, BiFunction<String,String,Boolean> checkPasswordFunction, Function<String,String> hmacKeyFunction, EnumSet<Cookies.Option> cookieOptions)	Creates an authenticator.

Method Summary

Modifier and Type	Method	Description
static HMACCookieLoginAuthenticator<Boolean>	booleanAuthenticator(Cookies.CookieKey cookieKey, Function<String,com.google.common.hash.HashFunction> hmacFunctions, BiFunction<String,String,Boolean> checkPasswordFunction, Function<String,String> hmacKeyFunction)
static HMACCookieLoginAuthenticator<Boolean>	booleanAuthenticator(Cookies.CookieKey cookieKey, Function<String,com.google.common.hash.HashFunction> hmacFunctions, BiFunction<String,String,Boolean> checkPasswordFunction, Function<String,String> hmacKeyFunction, EnumSet<Cookies.Option> cookieOptions)
T	doLogin(String username, String password, int tokenLifetimeSeconds, jakarta.servlet.http.HttpServletResponse resp)	Performs a login.
void	doLogout(jakarta.servlet.http.HttpServletResponse resp)	Performs a logout, if possible.
abstract T	invalidCredentials(String username)	Supplies credentials for an invalid login.
abstract T	validCredentials(String username)	Supplies credentials for a valid login.

Methods inherited from class org.attribyte.snook.auth.HMACCookieAuthenticator

authorized, authorizedUsername, booleanAuthenticator, credentials, schemeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.attribyte.snook.auth.Authenticator

authorized, authorizedUsername, credentials, schemeName

Constructor Details

HMACCookieLoginAuthenticator

public HMACCookieLoginAuthenticator(Cookies.CookieKey cookieKey,
 Function<String,com.google.common.hash.HashFunction> hmacFunctions,
 BiFunction<String,String,Boolean> checkPasswordFunction,
 Function<String,String> hmacKeyFunction)

Creates an authenticator.

Parameters:

hmacFunctions - A map of HMAC function vs key id.

checkPasswordFunction - A function to check username/password.

hmacKeyFunction - A function that returns the key id for a username.

HMACCookieLoginAuthenticator

public HMACCookieLoginAuthenticator(Cookies.CookieKey cookieKey,
 Function<String,com.google.common.hash.HashFunction> hmacFunctions,
 BiFunction<String,String,Boolean> checkPasswordFunction,
 Function<String,String> hmacKeyFunction,
 EnumSet<Cookies.Option> cookieOptions)

Creates an authenticator.

Parameters:

hmacFunctions - A map of HMAC function vs key id.

checkPasswordFunction - A function to check username/password.

hmacKeyFunction - A function that returns the key id for a username.

cookieOptions - The cookie options.

Method Details

booleanAuthenticator

public static HMACCookieLoginAuthenticator<Boolean> booleanAuthenticator(Cookies.CookieKey cookieKey,
 Function<String,com.google.common.hash.HashFunction> hmacFunctions,
 BiFunction<String,String,Boolean> checkPasswordFunction,
 Function<String,String> hmacKeyFunction)

See Also:

• HMACCookieLoginAuthenticator(Cookies.CookieKey, Function, BiFunction, Function)

booleanAuthenticator

public static HMACCookieLoginAuthenticator<Boolean> booleanAuthenticator(Cookies.CookieKey cookieKey,
 Function<String,com.google.common.hash.HashFunction> hmacFunctions,
 BiFunction<String,String,Boolean> checkPasswordFunction,
 Function<String,String> hmacKeyFunction,
 EnumSet<Cookies.Option> cookieOptions)

See Also:

• HMACCookieLoginAuthenticator(Cookies.CookieKey, Function, BiFunction, Function, EnumSet)

doLogin

public T doLogin(String username,
 String password,
 int tokenLifetimeSeconds,
 jakarta.servlet.http.HttpServletResponse resp)

Description copied from interface: LoginAuthenticator

Performs a login.

If username + password is valid, sets a header or a cookie on the response and returns true. Otherwise, does nothing and returns false.

Specified by:

doLogin in interface LoginAuthenticator<T>

Parameters:

username - The username.

password - The password.

tokenLifetimeSeconds - The authentication token lifetime in seconds.

resp - The response.

Returns:

Was the password valid and token saved and set as a cookie?

doLogout

public void doLogout(jakarta.servlet.http.HttpServletResponse resp)

Description copied from interface: LoginAuthenticator

Performs a logout, if possible.

Specified by:

doLogout in interface LoginAuthenticator<T>

Parameters:

resp - The response.

validCredentials

public abstract T validCredentials(String username)

Supplies credentials for a valid login.

Specified by:

validCredentials in class HMACCookieAuthenticator<T>

Parameters:

username - The username.

Returns:

The credentials.

invalidCredentials

public abstract T invalidCredentials(String username)

Supplies credentials for an invalid login.

Specified by:

invalidCredentials in class HMACCookieAuthenticator<T>

Parameters:

username - The username.

Returns:

The credentials.