All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.glassfish.internal.api.AdminAccessController Maven / Gradle / Ivy

There is a newer version: 8.0.0-JDK17-M9
Show newest version
/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.internal.api;

import javax.security.auth.Subject;
import javax.security.auth.login.LoginException;
import org.glassfish.grizzly.http.server.Request;
import org.jvnet.hk2.annotations.Contract;

/** 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 केदार ([email protected])
 */
@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 *
  • READONLY - the connection should be permitted read but not write access *
  • 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, READONLY, FORBIDDEN, NONE; public boolean isOK() { return this == FULL || this == READONLY; } } /** 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 the credentials do not authenticate * @throws RemoteAdminAccessException if the request is remote but remote access is disabled * @return Subject for an admin user */ Subject 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 request The Grizzly request containing the admin request * @throws LoginException if the credentials do not authenticate * @throws RemoteAdminAccessException if the request is remote but remote access is disabled * @return Subject for an admin user */ Subject loginAsAdmin( Request request) 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 request The Grizzly request containing the admin request * @param hostname the originating host * @throws LoginException if the credentials do not authenticate * @throws RemoteAdminAccessException if the request is remote but remote access is disabled * @return Subject for an admin user */ Subject loginAsAdmin( Request request, String hostname) throws LoginException; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy