com.sun.enterprise.security.jauth.ServerAuthModule Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at glassfish/bootstrap/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
*/
package com.sun.enterprise.security.jauth;
import java.util.Map;
import javax.security.auth.Subject;
import javax.security.auth.login.Configuration;
import javax.security.auth.callback.CallbackHandler;
/**
* This interface describes a module that can be configured
* for a ServerAuthContext. The main purpose of this module
* is to validate client requests and to secure responses back to the client.
*
* A module implementation must assume it may be shared
* across different requests from different clients.
* It is the module implementation's responsibility to properly
* store and restore any state necessary to associate new requests
* with previous responses. A module that does not need to do so
* may remain completely stateless.
*
*
Modules are passed a shared state Map that can be used
* to save state across a sequence of calls from validateRequest
* to secureResponse to disposeSubject.
* The same Map instance is guaranteed to be passed to all methods
* in the call sequence. Furthermore, it should be assumed that
* each call sequence is passed its own unique shared state Map instance.
*
* @version %I%, %G%
*/
public interface ServerAuthModule {
/**
* Initialize this module with a policy to enforce,
* a CallbackHandler, and administrative options.
*
*
Either the the request policy or the response policy (or both)
* must be non-null.
*
* @param requestPolicy the request policy this module is to enforce,
* which may be null.
*
* @param responsePolicy the response policy this module is to enforce,
* which may be null.
*
* @param handler CallbackHandler used to request information
* from the caller.
*
* @param options administrative options.
*/
void initialize(AuthPolicy requestPolicy,
AuthPolicy responsePolicy,
CallbackHandler handler,
Map options);
/**
* Authenticate a client request.
*
*
The AuthParam input parameter encapsulates the client request and
* server response objects. This ServerAuthModule validates the client
* request object (decrypts content and verifies a signature, for example).
*
* @param param an authentication parameter that encapsulates the
* client request and server response objects.
*
* @param subject the subject may be used by configured modules
* to store and Principals and credentials validated
* in the request.
*
* @param sharedState a Map for modules to save state across
* a sequence of calls from validateRequest
* to secureResponse to disposeSubject.
*
* @exception PendingException if the operation is pending
* (for example, when a module issues a challenge).
* The module must have updated the response object
* in the AuthParam.
*
* @exception FailureException if the authentication failed.
* The module must have updated the response object
* in the AuthParam.
*
* @exception AuthException if the operation failed.
*/
void validateRequest(AuthParam param,
Subject subject,
Map sharedState)
throws AuthException;
/**
* Secure the response to the client
* (sign and encrypt the response, for example).
*
* @param param an authentication parameter that encapsulates the
* client request and server response objects.
*
* @param subject the subject may be used by configured modules
* to obtain credentials needed to secure the response, or null.
* If null, the module may use a CallbackHandler to obtain
* the necessary information.
*
* @param sharedState a Map for modules to save state across
* a sequence of calls from validateRequest
* to secureResponse to disposeSubject.
*
* @exception AuthException if the operation failed.
*/
void secureResponse(AuthParam param,
Subject subject,
Map sharedState)
throws AuthException;
/**
* Dispose of the Subject.
*
*
Remove Principals or credentials from the Subject object
* that were stored during validateRequest.
*
* @param subject the Subject instance to be disposed.
*
* @param sharedState a Map for modules to save state across
* a sequence of calls from validateRequest
* to secureResponse to disposeSubject.
*
* @exception AuthException if the operation failed.
*/
void disposeSubject(Subject subject, Map sharedState)
throws AuthException;
}