Class EthereumAuthenticator

java.lang.Object

org.eclipse.jetty.security.authentication.LoginAuthenticator

org.eclipse.jetty.security.siwe.EthereumAuthenticator

All Implemented Interfaces:

Authenticator, Dumpable

public class EthereumAuthenticator
extends LoginAuthenticator
implements Dumpable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EthereumAuthenticator.FixedSizeSet<T>
static final record	EthereumAuthenticator.SignedMessage

Nested classes/interfaces inherited from class LoginAuthenticator

LoginAuthenticator.LoggedOutAuthentication, LoginAuthenticator.UserAuthenticationSent, LoginAuthenticator.UserAuthenticationSucceeded

Nested classes/interfaces inherited from interface Authenticator

Authenticator.Configuration, Authenticator.Factory, Authenticator.NoOp

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer, Dumpable.DumpAppendable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHENTICATE_NEW_USERS_PARAM
static final String	AUTHENTICATION_PATH_PARAM
static final String	CHAIN_IDS_PARAM
static final String	DISPATCH_PARAM
static final String	DOMAINS_PARAM
static final String	ERROR_PARAMETER
static final String	ERROR_PATH_PARAM
static final String	LOGIN_PATH_PARAM
static final String	LOGOUT_REDIRECT_PARAM
static final String	MAX_MESSAGE_SIZE_PARAM
static final String	NONCE_PATH_PARAM

Fields inherited from class LoginAuthenticator

_identityService, _loginService

Fields inherited from interface Authenticator

BASIC_AUTH, CERT_AUTH, CERT_AUTH2, DIGEST_AUTH, FORM_AUTH, MULTI_AUTH, NEGOTIATE_AUTH, OPENID_AUTH, SIWE_AUTH, SPNEGO_AUTH

Fields inherited from interface Dumpable

LEGEND

Constructor Summary

Constructors

Constructor	Description
EthereumAuthenticator()

Method Summary

Modifier and Type	Method	Description
protected String	createNonce(Session session)
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
String	getAuthenticationType()
Constraint.Authorization	getConstraintAuthentication(String pathInContext, Constraint.Authorization existing, Function<Boolean,Session> getSession)	Get an Constraint.Authorization applicable to the path for this authenticator.
protected Fields	getParameters(Request request)
protected AuthenticationState	handleNonceRequest(Request request, Response response, Callback callback)
void	includeChainIds(String... chainIds)
void	includeDomains(String... domains)
boolean	isAuthenticateNewUsers()
boolean	isAuthenticationRequest(String uri)
boolean	isErrorPage(String pathInContext)
boolean	isLoginPage(String uri)
boolean	isNonceRequest(String uri)
UserIdentity	login(String username, Object credentials, Request request, Response response)	If the UserIdentity returned from LoginService.login(String, Object, Request, Function) is not null, it is assumed that the user is fully authenticated and we need to change the session id to prevent session fixation vulnerability.
void	logout(Request request, Response response)
protected EthereumAuthenticator.SignedMessage	parseMessage(Request request, Response response, Callback callback)
Request	prepareRequest(Request request, AuthenticationState authenticationState)	Called after Authenticator.validateRequest(Request, Response, Callback) and before calling Request.Handler.handle(Request, Response, Callback) of the nested handler.
protected String	readMessage(InputStream in)
protected boolean	redeemNonce(Session session, String nonce)
void	setAuthenticateNewUsers(boolean authenticateNewUsers)	Configures the behavior for authenticating users not found by a wrapped LoginService.
void	setAuthenticationPath(String authenticationPath)
void	setConfiguration(Authenticator.Configuration authConfig)	Configure the Authenticator
void	setDispatch(boolean dispatch)
void	setErrorPage(String path)
void	setLoginPath(String loginPath)
void	setLogoutRedirectPath(String logoutRedirectPath)
void	setMaxMessageSize(int maxMessageSize)
void	setNoncePath(String noncePath)
AuthenticationState	validateRequest(Request request, Response response, Callback callback)	Attempts to validate the authentication state of the given request.

Methods inherited from class LoginAuthenticator

getAuthorizationHeader, getChallengeHeader, getLoginService, getUnauthorizedStatusCode, isProxyMode, setLoginService, setProxyMode, updateSession

Methods inherited from class Object

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

Methods inherited from interface Dumpable

dump, dumpSelf

Field Details

LOGIN_PATH_PARAM

public static final String LOGIN_PATH_PARAM

See Also:

• Constant Field Values

AUTHENTICATION_PATH_PARAM

public static final String AUTHENTICATION_PATH_PARAM

See Also:

• Constant Field Values

NONCE_PATH_PARAM

public static final String NONCE_PATH_PARAM

See Also:

• Constant Field Values

LOGOUT_REDIRECT_PARAM

public static final String LOGOUT_REDIRECT_PARAM

See Also:

• Constant Field Values

ERROR_PATH_PARAM

public static final String ERROR_PATH_PARAM

See Also:

• Constant Field Values

ERROR_PARAMETER

public static final String ERROR_PARAMETER

See Also:

• Constant Field Values

MAX_MESSAGE_SIZE_PARAM

public static final String MAX_MESSAGE_SIZE_PARAM

See Also:

• Constant Field Values

DISPATCH_PARAM

public static final String DISPATCH_PARAM

See Also:

• Constant Field Values

AUTHENTICATE_NEW_USERS_PARAM

public static final String AUTHENTICATE_NEW_USERS_PARAM

See Also:

• Constant Field Values

CHAIN_IDS_PARAM

public static final String CHAIN_IDS_PARAM

See Also:

• Constant Field Values

DOMAINS_PARAM

public static final String DOMAINS_PARAM

See Also:

• Constant Field Values

Constructor Details

EthereumAuthenticator

public EthereumAuthenticator()

Method Details

includeDomains

public void includeDomains(String... domains)

includeChainIds

public void includeChainIds(String... chainIds)

setConfiguration

public void setConfiguration(Authenticator.Configuration authConfig)

Description copied from interface: Authenticator

Configure the Authenticator

Specified by:

setConfiguration in interface Authenticator

Overrides:

setConfiguration in class LoginAuthenticator

Parameters:

authConfig - the configuration

getAuthenticationType

public String getAuthenticationType()

Specified by:

getAuthenticationType in interface Authenticator

Returns:

The name of the authentication type

isAuthenticateNewUsers

public boolean isAuthenticateNewUsers()

setAuthenticateNewUsers

public void setAuthenticateNewUsers(boolean authenticateNewUsers)

Configures the behavior for authenticating users not found by a wrapped LoginService.

This setting is only meaningful if a wrapped LoginService has been set.

If set to true, users not found by a wrapped LoginService will authenticated with no roles. If set to false, only users found by a wrapped LoginService will be authenticated.

Parameters:

authenticateNewUsers - whether to authenticate users not found by the wrapped LoginService

setLoginPath

public void setLoginPath(String loginPath)

setAuthenticationPath

public void setAuthenticationPath(String authenticationPath)

setNoncePath

public void setNoncePath(String noncePath)

setMaxMessageSize

public void setMaxMessageSize(int maxMessageSize)

setDispatch

public void setDispatch(boolean dispatch)

setLogoutRedirectPath

public void setLogoutRedirectPath(String logoutRedirectPath)

setErrorPage

public void setErrorPage(String path)

login

public UserIdentity login(String username,
 Object credentials,
 Request request,
 Response response)

Description copied from class: LoginAuthenticator

If the UserIdentity returned from LoginService.login(String, Object, Request, Function) is not null, it is assumed that the user is fully authenticated and we need to change the session id to prevent session fixation vulnerability. If the UserIdentity is not necessarily fully authenticated, then subclasses must override this method and determine when the UserIdentity IS fully authenticated and renew the session id.

Overrides:

login in class LoginAuthenticator

Parameters:

username - the username of the client to be authenticated

credentials - the user's credential

request - the inbound request that needs authentication

logout

public void logout(Request request,
 Response response)

Overrides:

logout in class LoginAuthenticator

prepareRequest

public Request prepareRequest(Request request,
 AuthenticationState authenticationState)

Description copied from interface: Authenticator

Called after Authenticator.validateRequest(Request, Response, Callback) and before calling Request.Handler.handle(Request, Response, Callback) of the nested handler. This may be used by an Authenticator to restore method or content from a previous request that was challenged.

Specified by:

prepareRequest in interface Authenticator

Parameters:

request - the request to prepare for handling

authenticationState - The authentication for the request

getConstraintAuthentication

public Constraint.Authorization getConstraintAuthentication(String pathInContext,
 Constraint.Authorization existing,
 Function<Boolean,Session> getSession)

Description copied from interface: Authenticator

Get an Constraint.Authorization applicable to the path for this authenticator. This is typically used to vary protection on special URIs known to a specific Authenticator (e.g. /j_security_check for the FormAuthenticator.

Specified by:

getConstraintAuthentication in interface Authenticator

Parameters:

pathInContext - The pathInContext to potentially constrain.

existing - The existing authentication constraint for the pathInContext determined independently of Authenticator

getSession - Function to get or create a Session.

Returns:

The Constraint.Authorization to apply.

readMessage

protected String readMessage(InputStream in)
                      throws IOException

Throws:

IOException

parseMessage

protected EthereumAuthenticator.SignedMessage parseMessage(Request request,
 Response response,
 Callback callback)

handleNonceRequest

protected AuthenticationState handleNonceRequest(Request request,
 Response response,
 Callback callback)

validateRequest

public AuthenticationState validateRequest(Request request,
 Response response,
 Callback callback)
                                    throws ServerAuthException

Description copied from interface: Authenticator

Attempts to validate the authentication state of the given request.

If authentication is successful, an AuthenticationState.Succeeded is returned. If the authenticator has already committed a response (for either success or failure), the returned value will implement AuthenticationState.ResponseSent, and the provided Callback will be eventually be completed, otherwise the caller is responsible for completing the Callback.

A null return value indicates that no authentication state could be established, possibly because the response has already been committed.

Specified by:

validateRequest in interface Authenticator

Parameters:

request - the request to validate.

response - the response associated with the request.

callback - the callback to use for writing a response.

Returns:

an AuthenticationState, or null if authentication could not be resolved.

Throws:

ServerAuthException - if unable to validate request.

getParameters

protected Fields getParameters(Request request)

isLoginPage

public boolean isLoginPage(String uri)

isAuthenticationRequest

public boolean isAuthenticationRequest(String uri)

isNonceRequest

public boolean isNonceRequest(String uri)

isErrorPage

public boolean isErrorPage(String pathInContext)

createNonce

protected String createNonce(Session session)

redeemNonce

protected boolean redeemNonce(Session session,
 String nonce)

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable