/*
* 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 org.glassfish.internal.api;
import java.security.Principal;
import java.util.Map;
import org.jvnet.hk2.annotations.Contract;
import javax.security.auth.login.LoginException;
/** Determines the behavior of administrative access to GlassFish v3. It should be enhanced to take into account
* Role-based Access Control. As of GlassFish v3, this takes care of authentication alone.
* @author केदार (km@dev.java.net)
*/
@Contract
public interface AdminAccessController {
/**
* Represents the possible types of access granted as the result of
* logging in as an admin user.
*
*
* - FULL - the connection should be permitted full admin access, including
* the ability to change the configuration
*
- FORBIDDEN - the connection is rejected because it is remote, secure admin
* is not enabled, and the connection is not from the DAS to an instance
*
- NONE - no access permitted
*
* The calling logic is responsible for enforcing any restrictions as to
* what access should be allowed vs. prohibited based on the returned Access value.
*
* Some parts of the authentication logic throw an exception if the user cannot
* be authenticated but there are some places where it just returns.
* Hence the NONE case.
*/
public static enum Access {
FULL,
FORBIDDEN,
NONE
}
/** Authenticates the admin user by delegating to the underlying realm. The implementing classes
* should use the GlassFish security infrastructure constructs like LoginContextDriver. This method assumes that
* the realm infrastructure is available in both the configuration and runtime of the server.
*
* Like the name suggests the method also ensures that the admin group membership is satisfied.
* @param user String representing the user name of the user doing an admin opearation
* @param password String representing clear-text password of the user doing an admin operation
* @param realm String representing the name of the admin realm for given server
* @param originHost the host from which the request was sent
* @throws LoginException if there is any error in underlying implementation
* @return level of access to be granted
*/
AdminAccessController.Access loginAsAdmin(String user, String password,
String realm, String originHost) throws LoginException;
/** Authenticates the admin user by delegating to the underlying realm. The implementing classes
* should use the GlassFish security infrastructure constructs like LoginContextDriver. This method assumes that
* the realm infrastructure is available in both the configuration and runtime of the server.
*
* This variant also logs the requester in as an admin if the specified Principal
* matches the Principal from the certificate in the truststore associated with
* the alias configured in the domain configuration.
*
* Typically, methods invoking
* this variant should pass the Principal associated with the request as
* reported by the secure transport and the value from the X-GlassFish-admin header
* (null if no such header exists).
* @param user String representing the user name of the user doing an admin opearation
* @param password String representing clear-text password of the user doing an admin operation
* @param realm String representing the name of the admin realm for given server
* @param originHost the host from which the request was sent
* @param authRelatedHeaders authentication-related headers from the incoming admin request
* @param requestPrincipal Principal associated with the incoming admin request (can be null)
* @throws LoginException if there is any error in underlying implementation
* @return true if authentication succeeds, false otherwise
*/
AdminAccessController.Access loginAsAdmin(String user, String password, String realm,
String originHost, Map authRelatedHeaders,
Principal requestPrincipal) throws LoginException;
}