Package org.eclipse.jetty.security.jaspi

Class JaspiAuthenticator

java.lang.Object

org.eclipse.jetty.security.authentication.LoginAuthenticator

org.eclipse.jetty.security.jaspi.JaspiAuthenticator

All Implemented Interfaces:

Authenticator

public class JaspiAuthenticator
extends LoginAuthenticator

Implementation of Jetty LoginAuthenticator that is a bridge from Jakarta Authentication to Jetty Security.

Nested Class Summary

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

Authenticator.AuthConfiguration, Authenticator.Factory

Field Summary

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

_loginService

Constructor Summary

Constructors

Constructor	Description
JaspiAuthenticator(jakarta.security.auth.message.config.ServerAuthConfig authConfig, Map authProperties, ServletCallbackHandler callbackHandler, Subject serviceSubject, boolean allowLazyAuthentication, IdentityService identityService)	Deprecated.
JaspiAuthenticator(Subject serviceSubject, String appContext, boolean allowLazyAuthentication)

Method Summary

Modifier and Type	Method	Description
String	getAuthMethod()
UserIdentity	login(String username, Object password, jakarta.servlet.ServletRequest request)	If the UserIdentity is not null after this method calls LoginService.login(String, Object, ServletRequest), it is assumed that the user is fully authenticated and we need to change the session id to prevent session fixation vulnerability.
boolean	secureResponse(jakarta.servlet.ServletRequest req, jakarta.servlet.ServletResponse res, boolean mandatory, Authentication.User validatedUser)	is response secure
boolean	secureResponse(JaspiMessageInfo messageInfo, Authentication validatedUser)
void	setConfiguration(Authenticator.AuthConfiguration configuration)	Configure the Authenticator
Authentication	validateRequest(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, boolean mandatory)	Validate a request
Authentication	validateRequest(JaspiMessageInfo messageInfo)

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

getLoginService, logout, prepareRequest, renewSession

Methods inherited from class java.lang.Object

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

Constructor Details

JaspiAuthenticator

public JaspiAuthenticator(Subject serviceSubject,
 String appContext,
 boolean allowLazyAuthentication)

JaspiAuthenticator

@Deprecated
public JaspiAuthenticator(jakarta.security.auth.message.config.ServerAuthConfig authConfig,
 Map authProperties,
 ServletCallbackHandler callbackHandler,
 Subject serviceSubject,
 boolean allowLazyAuthentication,
 IdentityService identityService)

Deprecated.

Method Details

setConfiguration

public void setConfiguration(Authenticator.AuthConfiguration configuration)

Description copied from interface: Authenticator

Configure the Authenticator

Specified by:

setConfiguration in interface Authenticator

Overrides:

setConfiguration in class LoginAuthenticator

Parameters:

configuration - the configuration

getAuthMethod

public String getAuthMethod()

Returns:

The name of the authentication method

login

public UserIdentity login(String username,
 Object password,
 jakarta.servlet.ServletRequest request)

Description copied from class: LoginAuthenticator

If the UserIdentity is not null after this method calls LoginService.login(String, Object, ServletRequest), 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

password - the user's credential

request - the inbound request that needs authentication

validateRequest

public Authentication validateRequest(jakarta.servlet.ServletRequest request,
 jakarta.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 mandatory, then a Authentication.Deferred may be returned.

Throws:

ServerAuthException - if unable to validate request

validateRequest

public Authentication validateRequest(JaspiMessageInfo messageInfo)
                               throws ServerAuthException

Throws:

ServerAuthException

secureResponse

public boolean secureResponse(jakarta.servlet.ServletRequest req,
 jakarta.servlet.ServletResponse res,
 boolean mandatory,
 Authentication.User validatedUser)
                       throws ServerAuthException

Description copied from interface: Authenticator

is response secure

Parameters:

req - the request

res - 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

secureResponse

public boolean secureResponse(JaspiMessageInfo messageInfo,
 Authentication validatedUser)
                       throws ServerAuthException

Throws:

ServerAuthException