org.forgerock.jaspi.modules.iwa

Class IWAModule

java.lang.Object

org.forgerock.jaspi.modules.iwa.IWAModule

All Implemented Interfaces:

AsyncServerAuthModule

public class IWAModule
extends Object
implements AsyncServerAuthModule

Authentication module that uses IWA for authentication.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
IWAModule()

Method Summary

Modifier and Type	Method and Description
Promise<Void,AuthenticationException>	cleanSubject(MessageInfoContext messageInfo, Subject subject) Removes any method specific principals and credentials from the client subject.
String	getModuleId() Gets the ID of the module to be used in creating authentication audit logs to uniquely identify the authentication module and its outcome when processing a request message.
Collection<Class<?>>	getSupportedMessageTypes() Gets the Collection of Class objects of the message types supported by the module.
Promise<Void,AuthenticationException>	initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler handler, Map<String,Object> options) Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module specific configuration properties.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Always returns AuthStatus.SEND_SUCCESS.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Validates the request by checking the Authorization header in the request for a IWA token and processes that for authentication.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.caf.authentication.api.AsyncServerAuthModule

toString

Constructor Detail

IWAModule

public IWAModule()

Method Detail

getModuleId

public String getModuleId()

Description copied from interface: AsyncServerAuthModule

Gets the ID of the module to be used in creating authentication audit logs to uniquely identify the authentication module and its outcome when processing a request message.

Specified by:

getModuleId in interface AsyncServerAuthModule

Returns:

The ID of the module.

initialize

public Promise<Void,AuthenticationException> initialize(javax.security.auth.message.MessagePolicy requestPolicy,
                                                        javax.security.auth.message.MessagePolicy responsePolicy,
                                                        CallbackHandler handler,
                                                        Map<String,Object> options)

Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module specific configuration properties.

The request policy and the response policy must not both be null.

Specified by:

initialize in interface AsyncServerAuthModule

Parameters:

requestPolicy - The request policy this module must enforce, or null.

responsePolicy - The response policy this module must enforce, or null.

handler - CallbackHandler used to request information.

options - A Map of module-specific configuration properties.

Returns:

A Promise that will be completed, as some point in the future, with either a successful value or a failure value. A successfully completed Promise will contain no value and a failed completed Promise will contain an AuthenticationException if module initialization fails, including for the case where the options argument contains elements that are not supported by the module.

getSupportedMessageTypes

public Collection<Class<?>> getSupportedMessageTypes()

Gets the Collection of Class objects of the message types supported by the module.

Specified by:

getSupportedMessageTypes in interface AsyncServerAuthModule

Returns:

A Collection of Class objects, with at least on element defining the message type(s) supported by the module.

validateRequest

public Promise<javax.security.auth.message.AuthStatus,AuthenticationException> validateRequest(MessageInfoContext messageInfo,
                                                                                               Subject clientSubject,
                                                                                               Subject serviceSubject)

Validates the request by checking the Authorization header in the request for a IWA token and processes that for authentication.

Specified by:

validateRequest in interface AsyncServerAuthModule

Parameters:

messageInfo - The message context info for this request.

clientSubject - A Subject that represents the subject of this request.

serviceSubject - A Subject that represents the subject for the server or null. It may be used to secure the message response.

Returns:

A Promise that will be completed, as some point in the future, with either a successful value or a failure value.

A successfully completed Promise will contain an AuthStatus representing the completion status of the message processing. See ServerAuth.validateRequest( javax.security.auth.message.MessageInfo, Subject, Subject) for the allowed AuthStatus values.

A failed completed Promise will contain an AuthenticationException when the message processing failed without establishing a failure response message in the MessageContextInfo.

Throws:

javax.security.auth.message.AuthException

See Also:

AuthStatus, ServerAuth.validateRequest( javax.security.auth.message.MessageInfo, Subject, Subject)

secureResponse

public Promise<javax.security.auth.message.AuthStatus,AuthenticationException> secureResponse(MessageInfoContext messageInfo,
                                                                                              Subject serviceSubject)

Always returns AuthStatus.SEND_SUCCESS.

Specified by:

secureResponse in interface AsyncServerAuthModule

Parameters:

messageInfo - The message context info for this request.

serviceSubject - A Subject that represents the subject for the server or null. It may be used to secure the message response.

Returns:

A Promise that will be completed, as some point in the future, with either a successful value or a failure value.

A successfully completed Promise will contain an AuthStatus representing the completion status of the processing. See ServerAuth.secureResponse( javax.security.auth.message.MessageInfo, Subject) for the allowed AuthStatus values. Note AuthStatus.SEND_CONTINUE is not supported by this interface

A failed completed Promise will contain an AuthenticationException when the message processing failed without establishing a failure response message in the MessageContextInfo.

See Also:

AuthStatus, ServerAuth.secureResponse( javax.security.auth.message.MessageInfo, Subject)

cleanSubject

public Promise<Void,AuthenticationException> cleanSubject(MessageInfoContext messageInfo,
                                                          Subject subject)

Removes any method specific principals and credentials from the client subject.

Specified by:

cleanSubject in interface AsyncServerAuthModule

Parameters:

messageInfo - The message context info for this request.

subject - A Subject that represents the subject of this request.

Returns:

A Promise that will be completed, as some point in the future, with either a successful value or a failure value. A successfully completed Promise will contain no value and a failed completed Promise will contain an AuthenticationException if an error occurs during the Subject processing.

See Also:

ServerAuth.cleanSubject( javax.security.auth.message.MessageInfo, Subject)