Class SPNEGOAuthenticator
- All Implemented Interfaces:
Authenticator
A LoginAuthenticator that uses SPNEGO and the GSS API to authenticate requests.
A successful authentication from a client is cached for a configurable
duration
using the HTTP session; this avoids
that the client is asked to authenticate for every request.
- See Also:
-
Nested Class Summary
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
-
Field Summary
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
ConstructorsConstructorDescriptionSPNEGOAuthenticator
(String type) Allow for a custom name value to be set for instances where SPNEGO may not be appropriate -
Method Summary
Modifier and TypeMethodDescriptionGet the authentication duration.Only renew the session id if the user has been fully authenticated, don't renew the session for any of the intermediate request/response handshakes.void
setAuthenticationDuration
(Duration authenticationDuration) Sets the duration of the authentication.validateRequest
(Request req, Response res, Callback callback) Attempts to validate the authentication state of the given request.Methods inherited from class org.eclipse.jetty.security.authentication.LoginAuthenticator
getLoginService, logout, setConfiguration, setLoginService, updateSession
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.jetty.security.Authenticator
getConstraintAuthentication, prepareRequest
-
Constructor Details
-
SPNEGOAuthenticator
public SPNEGOAuthenticator() -
SPNEGOAuthenticator
Allow for a custom name value to be set for instances where SPNEGO may not be appropriate- Parameters:
type
- the authenticator name
-
-
Method Details
-
getAuthenticationType
- Returns:
- The name of the authentication type
-
getAuthenticationDuration
Get the authentication duration.- Returns:
- the authentication duration
-
setAuthenticationDuration
Sets the duration of the authentication.
A negative duration means that the authentication is only valid for the current request.
A zero duration means that the authentication is valid forever.
A positive value means that the authentication is valid for the specified duration.
- Parameters:
authenticationDuration
- the authentication duration
-
login
Only renew the session id if the user has been fully authenticated, don't renew the session for any of the intermediate request/response handshakes.- Overrides:
login
in classLoginAuthenticator
- Parameters:
username
- the username of the client to be authenticatedpassword
- the user's credentialrequest
- the inbound request that needs authentication
-
validateRequest
public AuthenticationState validateRequest(Request req, Response res, 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.- Parameters:
req
- the request to validate.res
- 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.
-