org.glassfish.security.services.commands.CreateSecurityService 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) 2012-2013 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 [2016-2021] [Payara Foundation]
package org.glassfish.security.services.commands;
import java.beans.PropertyVetoException;
import java.util.Properties;
import jakarta.inject.Inject;
import org.glassfish.security.services.config.SecurityConfiguration;
import org.jvnet.hk2.annotations.Service;
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 org.glassfish.api.ActionReport;
import org.glassfish.api.Param;
import org.glassfish.api.admin.AdminCommand;
import org.glassfish.api.admin.AdminCommandContext;
import org.glassfish.api.admin.ExecuteOn;
import org.glassfish.api.admin.RuntimeType;
import org.glassfish.config.support.CommandTarget;
import org.glassfish.config.support.TargetType;
import org.glassfish.security.services.config.AuthenticationService;
import org.glassfish.security.services.config.SecurityConfigurations;
import com.sun.enterprise.config.serverbeans.Domain;
import org.glassfish.api.admin.AccessRequired;
import org.glassfish.api.admin.AdminCommandSecurity;
/**
* General create security service command.
*/
@Service(name="_create-security-service")
@PerLookup
@ExecuteOn(RuntimeType.DAS)
@TargetType(CommandTarget.DAS)
public class CreateSecurityService implements AdminCommand, AdminCommandSecurity.Preauthorization {
private static final String AUTHENTICATION = "authentication";
@Param(optional = false)
private String serviceType;
@Param(defaultValue = "false", optional = true)
private Boolean enableDefault;
@Param(optional = true, separator = ':')
private Properties configuration;
@Param(primary = true)
private String serviceName;
@Inject
private Domain domain;
// Service configuration type and handler
private Class clazzServiceType;
private ServiceConfigHandler serviceConfigHandler;
@AccessRequired.To("create")
private SecurityConfigurations secConfigs;
@Override
public boolean preAuthorization(AdminCommandContext context) {
final ActionReport report = context.getActionReport();
secConfigs = getSecurityConfigurations(report);
return secConfigs != null;
}
/**
* Execute the create-security-service admin command.
*/
@Override
public void execute(AdminCommandContext context) {
final ActionReport report = context.getActionReport();
// Setup the service type and configuration handler
if (AUTHENTICATION.equalsIgnoreCase(serviceType)) {
clazzServiceType = AuthenticationService.class;
serviceConfigHandler = new AuthenticationConfigHandler();
}
else {
report.setMessage("Invalid security service type specified: " + serviceType);
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
// Add service configuration to the security configurations
// TODO - Add validation logic required for base service configuration
SecurityConfiguration config = null;
try {
config = (SecurityConfiguration) ConfigSupport.apply(new SingleConfigCode() {
@Override
public Object run(SecurityConfigurations param) throws PropertyVetoException, TransactionFailure {
SecurityConfiguration svcConfig = param.createChild(clazzServiceType);
svcConfig.setName(serviceName);
svcConfig.setDefault(enableDefault.toString());
param.getSecurityServices().add(svcConfig);
return svcConfig;
}
}, secConfigs);
} catch (TransactionFailure transactionFailure) {
report.setMessage("Unable to create security service: " + transactionFailure.getMessage());
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setFailureCause(transactionFailure);
return;
}
// Configure the specific service type settings
// TODO - Add validation logic required for specific service configuration
if ((config != null) && (configuration != null) && (!configuration.isEmpty())) {
serviceConfigHandler.setupConfiguration(report, config);
}
}
/**
* Base class for service type configuration handling
*/
private abstract class ServiceConfigHandler {
abstract T setupConfiguration(ActionReport report, SecurityConfiguration securityServiceConfig);
}
/**
* Handle the authentication service configuration
*/
private class AuthenticationConfigHandler extends ServiceConfigHandler {
@Override
public AuthenticationService setupConfiguration(ActionReport report, SecurityConfiguration securityServiceConfig) {
// TODO - Additional type checking needed?
AuthenticationService config = (AuthenticationService) securityServiceConfig;
try {
config = (AuthenticationService) ConfigSupport.apply(new SingleConfigCode() {
@Override
public Object run(AuthenticationService param) throws PropertyVetoException, TransactionFailure {
// Look at the use password credential setting
Boolean usePassCred = Boolean.valueOf(configuration.getProperty("use-password-credential"));
param.setUsePasswordCredential(usePassCred.toString());
return param;
}
}, config);
} catch (TransactionFailure transactionFailure) {
report.setMessage("Unable to configure authentication service: " + transactionFailure.getMessage());
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setFailureCause(transactionFailure);
return null;
}
// Return the updated configuration object
return config;
}
}
private SecurityConfigurations getSecurityConfigurations(final ActionReport report) {
// Lookup or Create the security configurations
SecurityConfigurations result = domain.getExtensionByType(SecurityConfigurations.class);
if (result == null) {
try {
result = (SecurityConfigurations) ConfigSupport.apply(new SingleConfigCode() {
@Override
public Object run(Domain wDomain) throws PropertyVetoException, TransactionFailure {
SecurityConfigurations s = wDomain.createChild(SecurityConfigurations.class);
wDomain.getExtensions().add(s);
return s;
}
}, domain);
} catch (TransactionFailure transactionFailure) {
report.setMessage("Unable to create security configurations: " + transactionFailure.getMessage());
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setFailureCause(transactionFailure);
}
}
return result;
}
}