Class EthereumAuthenticator
- All Implemented Interfaces:
Authenticator
,Dumpable
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static final record
Nested classes/interfaces inherited from class org.eclipse.jetty.security.authentication.LoginAuthenticator
LoginAuthenticator.LoggedOutAuthentication, LoginAuthenticator.UserAuthenticationSent, LoginAuthenticator.UserAuthenticationSucceeded
Nested classes/interfaces inherited from interface org.eclipse.jetty.security.Authenticator
Authenticator.Configuration, Authenticator.Factory, Authenticator.NoOp
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
Dumpable.DumpableContainer, Dumpable.DumpAppendable
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
Fields inherited from class org.eclipse.jetty.security.authentication.LoginAuthenticator
_identityService, _loginService
Fields inherited from interface org.eclipse.jetty.security.Authenticator
BASIC_AUTH, CERT_AUTH, CERT_AUTH2, DIGEST_AUTH, FORM_AUTH, MULTI_AUTH, NEGOTIATE_AUTH, OPENID_AUTH, SIWE_AUTH, SPNEGO_AUTH
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected 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.getConstraintAuthentication
(String pathInContext, Constraint.Authorization existing, Function<Boolean, Session> getSession) Get anConstraint.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
boolean
boolean
isErrorPage
(String pathInContext) boolean
isLoginPage
(String uri) boolean
isNonceRequest
(String uri) If the UserIdentity returned fromLoginService.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
protected EthereumAuthenticator.SignedMessage
parseMessage
(Request request, Response response, Callback callback) prepareRequest
(Request request, AuthenticationState authenticationState) Called afterAuthenticator.validateRequest(Request, Response, Callback)
and before callingRequest.Handler.handle(Request, Response, Callback)
of the nested handler.protected String
protected boolean
redeemNonce
(Session session, String nonce) void
setAuthenticateNewUsers
(boolean authenticateNewUsers) Configures the behavior for authenticating users not found by a wrappedLoginService
.void
setAuthenticationPath
(String authenticationPath) void
setConfiguration
(Authenticator.Configuration authConfig) Configure the Authenticatorvoid
setDispatch
(boolean dispatch) void
setErrorPage
(String path) void
setLoginPath
(String loginPath) void
setLogoutRedirectPath
(String logoutRedirectPath) void
setMaxMessageSize
(int maxMessageSize) void
setNoncePath
(String noncePath) validateRequest
(Request request, Response response, Callback callback) Attempts to validate the authentication state of the given request.Methods inherited from class org.eclipse.jetty.security.authentication.LoginAuthenticator
getLoginService, setLoginService, updateSession
-
Field Details
-
LOGIN_PATH_PARAM
- See Also:
-
AUTHENTICATION_PATH_PARAM
- See Also:
-
NONCE_PATH_PARAM
- See Also:
-
LOGOUT_REDIRECT_PARAM
- See Also:
-
ERROR_PATH_PARAM
- See Also:
-
ERROR_PARAMETER
- See Also:
-
MAX_MESSAGE_SIZE_PARAM
- See Also:
-
DISPATCH_PARAM
- See Also:
-
AUTHENTICATE_NEW_USERS_PARAM
- See Also:
-
CHAIN_IDS_PARAM
- See Also:
-
DOMAINS_PARAM
- See Also:
-
-
Constructor Details
-
EthereumAuthenticator
public EthereumAuthenticator()
-
-
Method Details
-
includeDomains
-
includeChainIds
-
setConfiguration
Description copied from interface:Authenticator
Configure the Authenticator- Specified by:
setConfiguration
in interfaceAuthenticator
- Overrides:
setConfiguration
in classLoginAuthenticator
- Parameters:
authConfig
- the configuration
-
getAuthenticationType
- Specified by:
getAuthenticationType
in interfaceAuthenticator
- 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 wrappedLoginService
.This setting is only meaningful if a wrapped
LoginService
has been set.If set to
true
, users not found by a wrappedLoginService
will authenticated with no roles. If set tofalse
, only users found by a wrappedLoginService
will be authenticated.- Parameters:
authenticateNewUsers
- whether to authenticate users not found by the wrappedLoginService
-
setLoginPath
-
setAuthenticationPath
-
setNoncePath
-
setMaxMessageSize
public void setMaxMessageSize(int maxMessageSize) -
setDispatch
public void setDispatch(boolean dispatch) -
setLogoutRedirectPath
-
setErrorPage
-
login
Description copied from class:LoginAuthenticator
If the UserIdentity returned fromLoginService.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 classLoginAuthenticator
- Parameters:
username
- the username of the client to be authenticatedcredentials
- the user's credentialrequest
- the inbound request that needs authentication
-
logout
- Overrides:
logout
in classLoginAuthenticator
-
prepareRequest
Description copied from interface:Authenticator
Called afterAuthenticator.validateRequest(Request, Response, Callback)
and before callingRequest.Handler.handle(Request, Response, Callback)
of the nested handler. This may be used by anAuthenticator
to restore method or content from a previous request that was challenged.- Specified by:
prepareRequest
in interfaceAuthenticator
- Parameters:
request
- the request to prepare for handlingauthenticationState
- 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 anConstraint.Authorization
applicable to the path for this authenticator. This is typically used to vary protection on special URIs known to a specificAuthenticator
(e.g. /j_security_check for theFormAuthenticator
.- Specified by:
getConstraintAuthentication
in interfaceAuthenticator
- Parameters:
pathInContext
- The pathInContext to potentially constrain.existing
- The existing authentication constraint for the pathInContext determined independently ofAuthenticator
getSession
- Function to get or create aSession
.- Returns:
- The
Constraint.Authorization
to apply.
-
readMessage
- 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 implementAuthenticationState.ResponseSent
, and the providedCallback
will be eventually be completed, otherwise the caller is responsible for completing theCallback
.A
null
return value indicates that no authentication state could be established, possibly because the response has already been committed.- Specified by:
validateRequest
in interfaceAuthenticator
- 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
, ornull
if authentication could not be resolved. - Throws:
ServerAuthException
- if unable to validate request.
-
getParameters
-
isLoginPage
-
isAuthenticationRequest
-
isNonceRequest
-
isErrorPage
-
createNonce
-
redeemNonce
-
dump
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 interfaceDumpable
- Parameters:
out
- The appendable to dump toindent
- The indent to apply after any new lines.- Throws:
IOException
- if unable to write to Appendable
-