com.sun.enterprise.security.cli.CreateMessageSecurityProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 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.
*/
// Portions Copyright [2021] Payara Foundation and/or affiliates
package com.sun.enterprise.security.cli;
import org.jvnet.hk2.config.types.Property;
import com.sun.enterprise.config.serverbeans.RequestPolicy;
import java.util.List;
import java.util.Properties;
import org.glassfish.api.admin.AdminCommand;
import org.glassfish.api.admin.AdminCommandContext;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.ActionReport;
import org.jvnet.hk2.annotations.Service;
import jakarta.inject.Inject;
import jakarta.inject.Named;
import org.glassfish.hk2.api.PerLookup;
import org.jvnet.hk2.config.ConfigSupport;
import org.jvnet.hk2.config.SingleConfigCode;
import org.jvnet.hk2.config.TransactionFailure;
import com.sun.enterprise.config.serverbeans.SecurityService;
import com.sun.enterprise.config.serverbeans.MessageSecurityConfig;
import com.sun.enterprise.config.serverbeans.ProviderConfig;
import com.sun.enterprise.config.serverbeans.ResponsePolicy;
import com.sun.enterprise.config.serverbeans.Config;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.util.LocalStringManagerImpl;
import com.sun.enterprise.util.SystemPropertyConstants;
import java.beans.PropertyVetoException;
import org.glassfish.api.admin.AccessRequired;
import org.glassfish.api.admin.AdminCommandSecurity;
import org.glassfish.api.admin.ExecuteOn;
import org.glassfish.api.admin.RuntimeType;
import org.glassfish.api.admin.ServerEnvironment;
import org.glassfish.config.support.CommandTarget;
import org.glassfish.config.support.TargetType;
/**
* Create Message Security Provider Command
*
* Usage: create-message-security-provider [--terse=false] [--echo=false]
* [--interactive=true] [--host localhost] [--port 4848|4849]
* [--secure | -s] [--user admin_user] [--passwordfile file_name]
* [--target target(Default server)] [--layer message_layer=SOAP]
* [--providertype provider_type] [--requestauthsource request_auth_source]
* [--requestauthrecipient request_auth_recipient]
* [--responseauthsource response_auth_source]
* [--responseauthrecipient response_auth_recipient] [--isdefaultprovider]
* [--property (name=value)[:name=value]*] --classname provider_class
* provider_name
*
* domain.xml element example
*
*
*
*
*
*
*
* @author Nandini Ektare
*/
@Service(name="create-message-security-provider")
@PerLookup
@I18n("create.message.security.provider")
@ExecuteOn({RuntimeType.DAS, RuntimeType.INSTANCE})
@TargetType({CommandTarget.DAS,CommandTarget.STANDALONE_INSTANCE,CommandTarget.CLUSTER,CommandTarget.CONFIG})
public class CreateMessageSecurityProvider implements AdminCommand, AdminCommandSecurity.Preauthorization {
final private static LocalStringManagerImpl localStrings =
new LocalStringManagerImpl(CreateMessageSecurityProvider.class);
private static final String SERVER = "server";
private static final String CLIENT = "client";
private static final String CLIENT_SERVER = "client-server";
// auth-layer can only be SOAP | HttpServlet
@Param(name="layer", acceptableValues="SOAP,HttpServlet",
defaultValue="SOAP")
String authLayer;
// provider-type can only be - client | server | 'client-server'
@Param(name="providertype", acceptableValues="client,server,client-server",
optional=true, defaultValue="client-server")
String providerType;
// auth-source can only be - sender | content
@Param(name="requestauthsource", optional=true)
String requestAuthSource;
// auth-recipient can only be - before-content | after-content
@Param(name="requestauthrecipient", optional=true)
String requestAuthRecipient;
// auth-source can only be - sender | content
@Param(name="responseauthsource", optional=true)
String responseAuthSource;
// auth-recipient can only be - before-content | after-content
@Param(name="responseauthrecipient", optional=true)
String responseAuthRecipient;
// isdefaultprovider can only be - client | server | 'client-server'
@Param(name="isdefaultprovider", optional=true, defaultValue="false")
Boolean isDefaultProvider;
@Param(optional=true, name="property", separator=':')
Properties properties;
@Param(name="classname")
String providerClass;
@Param(name="providername", primary=true)
String providerId;
@Param(name = "target", optional = true, defaultValue =
SystemPropertyConstants.DEFAULT_SERVER_INSTANCE_NAME)
private String target;
@Inject @Named(ServerEnvironment.DEFAULT_INSTANCE_NAME)
private Config config;
@Inject
private Domain domain;
@AccessRequired.NewChild(type=MessageSecurityConfig.class)
private SecurityService secService;
@Override
public boolean preAuthorization(AdminCommandContext context) {
config = CLIUtil.chooseConfig(domain, target, context.getActionReport());
if (config == null) {
return false;
}
secService = config.getSecurityService();
return true;
}
/**
* Executes the command with the command parameters passed as Properties
* where the keys are parameter names and the values the parameter values
*
* @param context information
*/
@Override
public void execute(AdminCommandContext context) {
final ActionReport report = context.getActionReport();
List mscs = secService.getMessageSecurityConfig();
// Let's find the correct MessageSecurityConfig. As of now,
// there can be only two of them - one for SOAP and one for
// HttpServlet
MessageSecurityConfig msgSecCfg = null;
for (MessageSecurityConfig msc : mscs) {
if (msc.getAuthLayer().equals(authLayer)) {
msgSecCfg = msc;
}
}
// If there is message security config for this type of layer
// then, add a new provider config under it provided it is not duplicate
if (msgSecCfg != null) {
// check if there exists a provider config by the
// specified provider name; if so return failure.
List pcs = msgSecCfg.getProviderConfig();
for (ProviderConfig pc : pcs) {
if (pc.getProviderId().equals(providerId)) {
report.setMessage(localStrings.getLocalString(
"create.message.security.provider.duplicatefound",
"Message security provider named {0} exists. " +
"Cannot add duplicate.", providerId));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
}
// No duplicate message security providers found. So add one.
try {
ConfigSupport.apply(new SingleConfigCode() {
public Object run(MessageSecurityConfig param)
throws PropertyVetoException, TransactionFailure {
ProviderConfig newPC = param.createChild(ProviderConfig.class);
populateProviderConfigElement(newPC);
param.getProviderConfig().add(newPC);
// Depending on the providerType of the new provider
// the isDefaultProvider=true results in creation of
// either default-provider attribute or
// default-client-provider or BOTH in the message
// security config object
if (isDefaultProvider) {
if (providerType.equals(SERVER) || providerType.equals(CLIENT_SERVER) ) {
param.setDefaultProvider(providerId);
}
if (providerType.equals(CLIENT) || providerType.equals(CLIENT_SERVER) ) {
param.setDefaultClientProvider(providerId);
}
}
return newPC;
}
}, msgSecCfg);
} catch(TransactionFailure e) {
report.setMessage(localStrings.getLocalString(
"create.message.security.provider.fail",
"Creation of message security provider named {0} failed",
providerId));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setFailureCause(e);
return;
}
report.setActionExitCode(ActionReport.ExitCode.SUCCESS);
report.setMessage(localStrings.getLocalString(
"create.message.security.provider.success",
"Creation of message security provider named {0} completed " +
"successfully", providerId));
}
// Now if there is NO message security config for this type of layer
// then, first add a message security config for the layer and then
// add a provider config under this message security config
else {
try {
ConfigSupport.apply(new SingleConfigCode() {
public Object run(SecurityService param)
throws PropertyVetoException, TransactionFailure {
MessageSecurityConfig newMSC = param.createChild(MessageSecurityConfig.class);
newMSC.setAuthLayer(authLayer);
param.getMessageSecurityConfig().add(newMSC);
ProviderConfig newPC = newMSC.createChild(ProviderConfig.class);
populateProviderConfigElement(newPC);
newMSC.getProviderConfig().add(newPC);
// Depending on the providerType of the new provider
// the isDefaultProvider=true results in creation of
// either default-provider attribute or
// default-client-provider or BOTH in the message
// security config object
if (isDefaultProvider) {
if (providerType.equals(SERVER) || providerType.equals(CLIENT_SERVER) ) {
newMSC.setDefaultProvider(providerId);
}
if (providerType.equals(CLIENT) || providerType.equals(CLIENT_SERVER) ) {
newMSC.setDefaultClientProvider(providerId);
}
}
return newMSC;
}
}, secService);
} catch(TransactionFailure e) {
report.setMessage(localStrings.getLocalString(
"create.message.security.provider.fail",
"Creation of message security provider named {0} failed",
providerId));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setFailureCause(e);
return;
}
report.setActionExitCode(ActionReport.ExitCode.SUCCESS);
/* report.setMessage(localStrings.getLocalString(
"create.message.security.provider.success",
"Creation of message security provider named {0} completed " +
"successfully", providerId)); */
}
}
private void populateProviderConfigElement(ProviderConfig newProviderConfig)
throws PropertyVetoException, TransactionFailure {
newProviderConfig.setClassName(providerClass);
newProviderConfig.setProviderId(providerId);
newProviderConfig.setProviderType(providerType);
// create a new RequestPolicy config and add as child of this
// new Provider Config
RequestPolicy reqPolicy = newProviderConfig.createChild(RequestPolicy.class);
reqPolicy.setAuthSource(requestAuthSource);
reqPolicy.setAuthRecipient(requestAuthRecipient);
newProviderConfig.setRequestPolicy(reqPolicy);
// create a new ResponsePolicy config and add as child of this
// new Provider Config
ResponsePolicy respPolicy = newProviderConfig.createChild(ResponsePolicy.class);
respPolicy.setAuthSource(responseAuthSource);
respPolicy.setAuthRecipient(responseAuthRecipient);
newProviderConfig.setResponsePolicy(respPolicy);
// add properties
if (properties != null) {
for (Object propname: properties.keySet()) {
Property newprop = newProviderConfig.createChild(Property.class);
newprop.setName((String) propname);
newprop.setValue(properties.getProperty((String) propname));
newProviderConfig.getProperty().add(newprop);
}
}
}
}