com.sun.enterprise.security.jauth.AuthConfig Maven / Gradle / Ivy
Show all versions of payara-embedded-web Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, 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/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.security.jauth;
import javax.security.auth.callback.CallbackHandler;
/**
* This class manages the configuration AuthModules.
*
* An AuthModule represents a pluggable component for
* performing security-related request and response processing,
* and can be configured for a particular interception point
* and provider ID. The provider ID is an administrator-defined value.
* The standard interception points include:
*
*
* - HTTP
*
- EJB
*
- SOAP
*
*
* Information may be associated with a configured module,
* including its fully qualified class name (so it can be instantiated),
* and module options (which help tune the behavior of the module).
* It is the responsibility of the AuthConfig implementation to
* load any required module information.
*
*
Callers do not operate on AuthModules directly.
* Instead they rely on a ClientAuthContext or ServerAuthContext
* to manage the invocation of modules. A caller obtains an instance
* of ClientAuthContext or ServerAuthContext by calling the
* getClientAuthContext or getServerAuthContext
* method, respectively. Each method takes as arguments
* an intercept, an id, a requestPolicy,
* and a responsePolicy.
*
*
An AuthConfig implementation determines the modules
* to be invoked via the intercept and id values.
* It then encapsulates those modules in a ClientAuthContext
* or ServerAuthContext instance, and returns that instance.
* The returned object is responsible for instantiating, initializing,
* and invoking the configured modules (when called upon).
*
*
The module initializion step involves calling each configured
* module's AuthModule.initialize method. The received
* requestPolicy and responsePolicy are passed
* to this method. It is then the modules' responsibility, when invoked,
* to enforce these policies.
*
*
A system-wide AuthConfig instance can be retrieved
* by invoking getConfig. A default implementation
* is provided, and can be replaced by setting the
* value of the "authconfig.provider" security property (in the Java
* security properties file) to the fully qualified name of
* the desired implementation class.
* The Java security properties file is located in the file named
* <JAVA_HOME>/lib/security/java.security, where <JAVA_HOME>
* refers to the directory where the JDK was installed.
*
* @version %I%, %G%
* @see ClientAuthContext
* @see ServerAuthContext
*/
public abstract class AuthConfig {
/**
* HTTP interception point.
*/
public static final String HTTP = "HTTP";
/**
* EJB interception point.
*/
public static final String EJB = "EJB";
/**
* SOAP interception point.
*/
public static final String SOAP = "SOAP";
// security property to replace default AuthConfig implementation
private static final String AUTHCONFIG_PROPERTY = "authconfig.provider";
// class name of default AuthConfig implementation
private static final String DEFAULT_CLASS =
"com.sun.enterprise.security.jauth.ConfigFile";
private static AuthConfig config;
// package private for ConfigFile
static ClassLoader getClassLoader() {
final ClassLoader rvalue;
rvalue = (ClassLoader) java.security.AccessController.doPrivileged
(new java.security.PrivilegedAction() {
public Object run() {
return Thread.currentThread().getContextClassLoader();
}
});
return rvalue;
};
/**
* Sole constructor. (For invocation by subclass constructors, typically
* implicit.)
*/
protected AuthConfig() { }
/**
* Get a system-wide module configuration.
*
*
If an AuthConfig object was set via the
* setAuthConfig method, then that object is returned.
* Otherwise, an instance of the AuthConfig object configured in the
* authconfig.provider security property is returned.
* If that property is not set, a default implementation is returned.
*
* @return a system-wide AuthConfig instance.
*
* @exception SecurityException if the caller does not have permission
* to retrieve the configuration.
*/
public static synchronized AuthConfig getAuthConfig() {
/**
XXX security check?
SecurityManager sm = System.getSecurityManager();
if (sm != null)
sm.checkPermission(new AuthPermission("getAuthConfig"));
*/
if (config == null) {
String config_class = null;
config_class = (String)
java.security.AccessController.doPrivileged
(new java.security.PrivilegedAction() {
public Object run() {
return java.security.Security.getProperty
(AUTHCONFIG_PROPERTY);
}
});
if (config_class == null) {
config_class = DEFAULT_CLASS;
}
try {
final String finalClass = config_class;
config = (AuthConfig)
java.security.AccessController.doPrivileged
(new java.security.PrivilegedExceptionAction() {
public Object run() throws ClassNotFoundException,
InstantiationException,
IllegalAccessException {
return Class.forName
(finalClass,
true,
getClassLoader()).newInstance();
}
});
} catch (java.security.PrivilegedActionException e) {
throw (SecurityException)
new SecurityException().initCause(e.getException());
}
}
return config;
}
/**
* Set a system-wide module configuration.
*
* @param config the new configuration.
*
* @exception SecurityException if the caller does not have
* permission to set the configuration.
*/
public static void setAuthConfig(AuthConfig config) {
/**
XXX security check?
SecurityManager sm = System.getSecurityManager();
if (sm != null) {
sm.checkPermission(new AuthPermission("setAuthConfig"));
}
*/
AuthConfig.config = config;
}
/**
* Get a ClientAuthContext.
*
*
The modules configured for the returned ClientAuthContext
* are determined by the intercept and provider id
* input parameters. The returned ClientAuthContext may be null,
* which signifies that there are no modules configured.
*
*
The returned ClientAuthContext encapsulates both the
* configured modules, as well as the module invocation semantics
* (for example the order modules are to be invoked,
* and whether certain modules must succeed).
* Individual ClientAuthContext implementations may enforce
* custom module invocation semantics.
*
* @param intercept the interception point used to determine the modules
* configured for the returned ClientAuthContext.
* Standard values include:
*
* - HTTP
*
- EJB
*
- SOAP
*
*
* @param id the provider id used to determine the modules
* configured for the returned ClientAuthContext, or null.
* If null, a default ID may be used.
*
* @param requestPolicy the application request policy
* to be enfored by the modules, or null.
* If null, a default request policy may be used.
*
* @param responsePolicy the application response policy
* to be enfored by the modules, or null.
* If null, a default response policy may be used.
*
* @param handler the CallbackHandler to associate with the
* returned ClientAuthContext for use
* by configured modules to request information
* from the caller, or null.
* If null, a default handler may be used.
*
* @return a ClientAuthContext, or null.
*/
public abstract ClientAuthContext getClientAuthContext(String intercept,
String id,
AuthPolicy requestPolicy,
AuthPolicy responsePolicy,
CallbackHandler handler)
throws AuthException;
/**
* Get a ServerAuthContext.
*
* The modules configured for the returned ServerAuthContext
* are determined by the intercept and provider id,
* input parameters. The returned ServerAuthContext may be null,
* which signifies that there are no modules configured.
*
*
The returned ServerAuthContext encapsulates both the
* configured modules, as well as the module invocation semantics
* (for example the order modules are to be invoked,
* and whether certain modules must succeed).
* Individual ServerAuthContext implementations may enforce
* custom module invocation semantics.
*
* @param intercept the interception point used to determine the modules
* configured for the returned ServerAuthContext.
* Standard values include:
*
* - HTTP
*
- EJB
*
- SOAP
*
*
* @param id the provider id used to determine the modules
* configured for the returned ClientAuthContext, or null.
* If null, a default id may be used.
*
* @param requestPolicy the application request policy
* to be enfored by the modules, or null.
* If null, a default request policy may be used.
*
* @param responsePolicy the application response policy
* to be enfored by the modules, or null.
* If null, a default response policy may be used.
*
* @param handler the CallbackHandler to associate with the
* returned ClientAuthContext, which can be used
* by configured modules to request information
* from the caller, or null.
* If null, a default handler may be used.
*
* @return a ServerAuthContext, or null.
*/
public abstract ServerAuthContext getServerAuthContext(String intercept,
String id,
AuthPolicy requestPolicy,
AuthPolicy responsePolicy,
CallbackHandler handler)
throws AuthException;
/**
* Refresh the internal representation of the active configuration
* by re-reading the provider configs.
*/
public abstract void refresh() throws AuthException;
}