Package org.eclipse.jetty.security.jaspi.modules

Class BaseAuthModule

java.lang.Object

org.eclipse.jetty.security.jaspi.modules.BaseAuthModule

All Implemented Interfaces:

jakarta.security.auth.message.config.ServerAuthContext, jakarta.security.auth.message.module.ServerAuthModule, jakarta.security.auth.message.ServerAuth

Direct Known Subclasses:

BasicAuthenticationAuthModule

public abstract class BaseAuthModule
extends Object
implements jakarta.security.auth.message.module.ServerAuthModule, jakarta.security.auth.message.config.ServerAuthContext

Simple abstract module implementing a Jakarta Authentication ServerAuthModule and ServerAuthContext. To be used as a building block for building more sophisticated auth modules.

Field Summary

Fields

Modifier and Type	Field	Description
protected CallbackHandler	callbackHandler
protected static final String	LOGIN_SERVICE_KEY

Constructor Summary

Constructors

Constructor	Description
BaseAuthModule()
BaseAuthModule(CallbackHandler callbackHandler)

Method Summary

Modifier and Type	Method	Description
void	cleanSubject(jakarta.security.auth.message.MessageInfo messageInfo, Subject subject)
Class[]	getSupportedMessageTypes()
void	initialize(jakarta.security.auth.message.MessagePolicy requestPolicy, jakarta.security.auth.message.MessagePolicy responsePolicy, CallbackHandler handler, Map options)
protected boolean	isMandatory(jakarta.security.auth.message.MessageInfo messageInfo)
protected boolean	login(Subject clientSubject, String credentials, String authMethod, jakarta.security.auth.message.MessageInfo messageInfo)
protected boolean	login(Subject clientSubject, String username, Credential credential, String authMethod, jakarta.security.auth.message.MessageInfo messageInfo)
jakarta.security.auth.message.AuthStatus	secureResponse(jakarta.security.auth.message.MessageInfo messageInfo, Subject serviceSubject)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.security.auth.message.ServerAuth

validateRequest

Field Details

LOGIN_SERVICE_KEY

protected static final String LOGIN_SERVICE_KEY

See Also:

• Constant Field Values

callbackHandler

protected CallbackHandler callbackHandler

Constructor Details

BaseAuthModule

public BaseAuthModule()

BaseAuthModule

public BaseAuthModule(CallbackHandler callbackHandler)

Method Details

getSupportedMessageTypes

public Class[] getSupportedMessageTypes()

Specified by:

getSupportedMessageTypes in interface jakarta.security.auth.message.module.ServerAuthModule

initialize

public void initialize(jakarta.security.auth.message.MessagePolicy requestPolicy,
 jakarta.security.auth.message.MessagePolicy responsePolicy,
 CallbackHandler handler,
 Map options)
                throws jakarta.security.auth.message.AuthException

Specified by:

initialize in interface jakarta.security.auth.message.module.ServerAuthModule

Throws:

jakarta.security.auth.message.AuthException

cleanSubject

public void cleanSubject(jakarta.security.auth.message.MessageInfo messageInfo,
 Subject subject)
                  throws jakarta.security.auth.message.AuthException

Specified by:

cleanSubject in interface jakarta.security.auth.message.ServerAuth

Throws:

jakarta.security.auth.message.AuthException

secureResponse

public jakarta.security.auth.message.AuthStatus secureResponse(jakarta.security.auth.message.MessageInfo messageInfo,
 Subject serviceSubject)
                                                        throws jakarta.security.auth.message.AuthException

Specified by:

secureResponse in interface jakarta.security.auth.message.ServerAuth

Throws:

jakarta.security.auth.message.AuthException

isMandatory

protected boolean isMandatory(jakarta.security.auth.message.MessageInfo messageInfo)

Parameters:

messageInfo - message info to examine for mandatory flag

Returns:

whether authentication is mandatory or optional

login

protected boolean login(Subject clientSubject,
 String credentials,
 String authMethod,
 jakarta.security.auth.message.MessageInfo messageInfo)
                 throws IOException,
UnsupportedCallbackException

Throws:

IOException

UnsupportedCallbackException

login

protected boolean login(Subject clientSubject,
 String username,
 Credential credential,
 String authMethod,
 jakarta.security.auth.message.MessageInfo messageInfo)
                 throws IOException,
UnsupportedCallbackException

Throws:

IOException

UnsupportedCallbackException