com.sun.enterprise.deployment.EjbIORConfigurationDescriptor Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 * 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 com.sun.enterprise.deployment;

import com.sun.enterprise.deployment.util.DOLUtils;

import java.util.logging.Level;
import java.util.logging.Logger;

import org.glassfish.deployment.common.Descriptor;

/**
 * This descriptor holds the security configuration of an EJB IOR.
 */
public class EjbIORConfigurationDescriptor extends Descriptor {
    private static final long serialVersionUID = 1L;
    private static final Logger LOG = DOLUtils.getDefaultLogger();

    // For backward compatiblity with CTS, equalsIgnoreCase should be used
    // for comparison with NONE, SUPPORTED, REQUIRED.
    public static final String NONE = "NONE";
    public static final String SUPPORTED = "SUPPORTED";
    public static final String REQUIRED = "REQUIRED";

    public static final String USERNAME_PASSWORD = "username_password";
    public static final String DEFAULT_REALM = "default";

    private String integrity = SUPPORTED;
    private String confidentiality = SUPPORTED;
    private String establishTrustInTarget = SUPPORTED;
    private String establishTrustInClient = SUPPORTED;
    private String authenticationMethod = USERNAME_PASSWORD;
    private String realmName = DEFAULT_REALM;
    private String callerPropagation = SUPPORTED;
    private boolean required;


    /**
     * Default constructor.
     */
    public EjbIORConfigurationDescriptor() {
        try {
            if (Boolean.getBoolean("interop.ssl.required")) {
                integrity = REQUIRED;
                confidentiality = REQUIRED;
                establishTrustInClient = REQUIRED;
                establishTrustInTarget = SUPPORTED;
            }

            if (Boolean.getBoolean("interop.authRequired.enabled")) {
                required = true;
                authenticationMethod = USERNAME_PASSWORD;
            }
        } catch (Throwable ioe) {
            LOG.log(Level.WARNING, "enterprise.deployment_ioexcp", ioe);

            // ignore
        }
    }

    public EjbIORConfigurationDescriptor(boolean enableUsernamePassword) {
        if (enableUsernamePassword) {
            required = true;
            authenticationMethod = USERNAME_PASSWORD;
        }
    }

    /**
     * Get the value of the integrity element. Default value is "supported".
     * @return the value (one of supported, required, none).
     */
    public String getIntegrity() {
        return integrity;
    }

    /**
     * Set the value of the integrity element to the specified value.
     * @param val the value (one of supported, required, none).
     */
    public void setIntegrity(String val) {
        if (!val.equalsIgnoreCase(NONE) && !val.equalsIgnoreCase(SUPPORTED) && !val.equalsIgnoreCase(REQUIRED)) {
            throw new RuntimeException("Incorrect value for integrity:" + val);
        }

        integrity = val;
    }

    /**
     * Get the value of the confidentiality element.
     * Default value is "supported".
     * @return the value (one of supported, required, none).
     */
    public String getConfidentiality() {
        return confidentiality;
    }

    /**
     * Set the value of the confidentiality element to the specified value.
     * @param val the value (one of supported, required, none).
     */
    public void setConfidentiality(String val) {
        if (!val.equalsIgnoreCase(NONE) && !val.equalsIgnoreCase(SUPPORTED) && !val.equalsIgnoreCase(REQUIRED)) {
            throw new RuntimeException("Incorrect value for confidentiality:" + val);
        }
        confidentiality = val;
    }

    /**
     * Get the value of establishTrustInTarget in the transport layer.
     * The default value is "supported".
     * @return the value (required, supported, or none)
     */
    public String getEstablishTrustInTarget() {
        return establishTrustInTarget;
    }

    /**
     * Set the value of establishTrustInTarget in the transport layer.
     * @param val the value (required, supported, or none)
     */
    public void setEstablishTrustInTarget(String val) {
        if (!val.equalsIgnoreCase(NONE) && !val.equalsIgnoreCase(SUPPORTED)) {
            throw new RuntimeException("Incorrect value for establishTrustInTarget:" + val);
        }

        establishTrustInTarget = val;
    }

    /**
     * Get the value of establishTrustInClient in the transport layer.
     * The default value is "supported".
     * @return the value (required, supported, or none)
     */
    public String getEstablishTrustInClient() {
        return establishTrustInClient;
    }

    /**
     * Set the value of establishTrustInClient in the transport layer.
     *
     * @param val the value (required, supported, or none)
     */
    public void setEstablishTrustInClient(String val) {
        if (!val.equalsIgnoreCase(NONE) && !val.equalsIgnoreCase(SUPPORTED) && !val.equalsIgnoreCase(REQUIRED)) {
            throw new RuntimeException("Incorrect value for establishTrustInClient: " + val);
        }
        establishTrustInClient = val;
    }

    /**
     * Return the authentication method used to authenticate clients.
     * The default value is "username_password".
     * @return the authentication method.
     */
    public String getAuthenticationMethod() {
        return authenticationMethod;
    }

    /**
     * Set the authentication method used to authenticate clients.
     *
     * @param val the authentication method.
     */
    public void setAuthenticationMethod(String val) {
        if (!val.equalsIgnoreCase(USERNAME_PASSWORD) && !val.equalsIgnoreCase(NONE)) {
            throw new RuntimeException("Incorrect value for authentication method: " + val);
        }
        authenticationMethod = val;
    }

    /**
     * Return the realm name to authenticate the caller in.
     * The default value is "default".
     * @return the realm name.
     */
    public String getRealmName() {
        return realmName;
    }

    /**
     * Set the realm name to authenticate the caller in.
     * @param val the realm name.
     */
    public void setRealmName(String val) {
        realmName = val;
    }

    /**
     * Return the value of identity assertion in the SAS_Context layer.
     * @return the value (one of none, required or supported).
     */
    public String getCallerPropagation() {
        return callerPropagation;
    }

    /**
     * Set the value of identity assertion in the SAS_Context layer.
     * @param val the value (one of none, required or supported).
     */
    public void setCallerPropagation(String val) {
        if (!val.equalsIgnoreCase(NONE) && !val.equalsIgnoreCase(SUPPORTED) && !val.equalsIgnoreCase(REQUIRED)) {
            throw new RuntimeException("Incorrect value for callerPropagation: " + val);
        }
        callerPropagation = val;
    }

    /**
     * Get whether the establishTrustInClient element is required
     * in the AS_context.
     * @return the value (true or false).
     */
    public boolean isAuthMethodRequired() {
        return required;
    }

    /**
     * Set whether the establishTrustInClient element should be required
     * in the AS_context.
     * @param val the value (true or false).
     */
    public void setAuthMethodRequired(boolean val) {
        required = val;
    }


    /**
     * Set whether the establishTrustInClient element should be required
     * in the AS_context.
     * @param val the value (true or false).
     */
    public void setAuthMethodRequired(String val) {
        required = Boolean.valueOf(val).booleanValue();
    }

    /**
    * Returns a formatted String of the attributes of this object.
    */
    @Override
    public void print(StringBuffer toStringBuffer) {
        toStringBuffer.append("\n integrity ").append(integrity);
        toStringBuffer.append( "\n confidentiality " ).append( confidentiality);
        toStringBuffer.append( "\n establishTrustInTarget ").append(establishTrustInTarget);
        toStringBuffer.append( "\n establishTrustInClient ").append(establishTrustInClient);
        toStringBuffer.append( "\n callerPropagation ").append(callerPropagation);
        toStringBuffer.append( "\n realm ").append(realmName);
        toStringBuffer.append( "\n authenticationMethod ").append(authenticationMethod).append("\n");
    }
}