org.eclipse.jetty.security.authentication

Class SpnegoAuthenticator

java.lang.Object

org.eclipse.jetty.security.authentication.LoginAuthenticator

org.eclipse.jetty.security.authentication.SpnegoAuthenticator

All Implemented Interfaces:

Authenticator

public class SpnegoAuthenticator
extends LoginAuthenticator

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.security.Authenticator

Authenticator.AuthConfiguration, Authenticator.Factory

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	_authMethod
private static Logger	LOG

Fields inherited from class org.eclipse.jetty.security.authentication.LoginAuthenticator

_identityService, _loginService

Constructor Summary

Constructors

Constructor and Description
SpnegoAuthenticator()
SpnegoAuthenticator(java.lang.String authMethod) Allow for a custom authMethod value to be set for instances where SPENGO may not be appropriate

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthMethod()
(package private) java.lang.String	getAuthSchemeFromHeader(java.lang.String header) Extracts the auth_scheme from the HTTP Authorization header, Authorization: <auth_scheme> <token>.
(package private) boolean	isAuthSchemeNegotiate(java.lang.String authScheme) Determines if provided auth scheme text from the Authorization header is case-insensitively equal to negotiate.
boolean	secureResponse(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, boolean mandatory, Authentication.User validatedUser) is response secure
Authentication	validateRequest(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, boolean mandatory) Validate a request

Methods inherited from class org.eclipse.jetty.security.authentication.LoginAuthenticator

getLoginService, login, prepareRequest, renewSession, setConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logger LOG

_authMethod

private java.lang.String _authMethod

Constructor Detail

SpnegoAuthenticator

public SpnegoAuthenticator()

SpnegoAuthenticator

public SpnegoAuthenticator(java.lang.String authMethod)

Allow for a custom authMethod value to be set for instances where SPENGO may not be appropriate

Parameters:

authMethod - the auth method

Method Detail

getAuthMethod

public java.lang.String getAuthMethod()

Returns:

The name of the authentication method

validateRequest

public Authentication validateRequest(javax.servlet.ServletRequest request,
                                      javax.servlet.ServletResponse response,
                                      boolean mandatory)
                               throws ServerAuthException

Description copied from interface: Authenticator

Validate a request

Parameters:

request - The request

response - The response

mandatory - True if authentication is mandatory.

Returns:

An Authentication. If Authentication is successful, this will be a Authentication.User. If a response has been sent by the Authenticator (which can be done for both successful and unsuccessful authentications), then the result will implement Authentication.ResponseSent. If Authentication is not manditory, then a Authentication.Deferred may be returned.

Throws:

ServerAuthException - if unable to validate request

getAuthSchemeFromHeader

java.lang.String getAuthSchemeFromHeader(java.lang.String header)

Extracts the auth_scheme from the HTTP Authorization header, Authorization: <auth_scheme> <token>.

Parameters:

header - The HTTP Authorization header or null.

Returns:

The parsed auth scheme from the header, or the empty string.

isAuthSchemeNegotiate

boolean isAuthSchemeNegotiate(java.lang.String authScheme)

Determines if provided auth scheme text from the Authorization header is case-insensitively equal to negotiate.

Parameters:

authScheme - The auth scheme component of the Authorization header

Returns:

True if the auth scheme component is case-insensitively equal to negotiate, False otherwise.

secureResponse

public boolean secureResponse(javax.servlet.ServletRequest request,
                              javax.servlet.ServletResponse response,
                              boolean mandatory,
                              Authentication.User validatedUser)
                       throws ServerAuthException

Description copied from interface: Authenticator

is response secure

Parameters:

request - the request

response - the response

mandatory - if security is mandator

validatedUser - the user that was validated

Returns:

true if response is secure

Throws:

ServerAuthException - if unable to test response