org.forgerock.caf.authn.test.modules

Class AuditingSessionAuthModule

java.lang.Object

org.forgerock.caf.authn.test.modules.AuditingSessionAuthModule

All Implemented Interfaces:

AsyncServerAuthModule

public class AuditingSessionAuthModule
extends Object
implements AsyncServerAuthModule

A test auth module in which the validateRequest(MessageInfoContext, Subject, Subject) adds additional audit information and the secureResponse(MessageInfoContext, Subject) audits a session id.

Since:

1.5.0

Constructor Summary

Constructors

Constructor and Description
AuditingSessionAuthModule()

Method Summary

Modifier and Type	Method and Description
Promise<Void,AuthenticationException>	cleanSubject(MessageInfoContext messageInfo, Subject clientSubject) Does nothing.
String	getModuleId() Returns the class's short name.
Collection<Class<?>>	getSupportedMessageTypes() Returns the Request and Response classes.
Promise<Void,AuthenticationException>	initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler callbackHandler, Map config) Does nothing.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Attempts to add to the module audit info, which should not be added, and sets the session id to be audited.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Adds module audit info and sets the principal.

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

AuditingSessionAuthModule

public AuditingSessionAuthModule()

Method Detail

getModuleId

public String getModuleId()

Returns the class's short name.

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 callbackHandler,
                                                        Map config)

Does nothing.

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.

callbackHandler - CallbackHandler used to request information.

config - 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()

Returns the Request and Response classes.

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)

Adds module audit info and sets the principal.

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.

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)

Attempts to add to the module audit info, which should not be added, and sets the session id to be audited.

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 clientSubject)

Does nothing.

Specified by:

cleanSubject in interface AsyncServerAuthModule

Parameters:

messageInfo - The message context info for this request.

clientSubject - 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)