/*
* 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 com.sun.enterprise.security.cli;
import com.sun.enterprise.config.serverbeans.AdminService;
import java.util.List;
import java.util.ArrayList;
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 org.jvnet.hk2.annotations.Scoped;
import org.jvnet.hk2.annotations.Inject;
import org.jvnet.hk2.component.PerLookup;
import org.jvnet.hk2.config.types.Property;
import com.sun.enterprise.config.serverbeans.Config;
import com.sun.enterprise.util.LocalStringManagerImpl;
import com.sun.enterprise.config.serverbeans.AuthRealm;
import com.sun.enterprise.config.serverbeans.Configs;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.config.serverbeans.SecureAdmin;
import com.sun.enterprise.security.auth.realm.file.FileRealm;
import com.sun.enterprise.security.auth.realm.Realm;
import com.sun.enterprise.config.serverbeans.SecurityService;
import com.sun.enterprise.config.serverbeans.Server;
import com.sun.enterprise.security.auth.realm.BadRealmException;
import com.sun.enterprise.security.auth.realm.RealmsManager;
import com.sun.enterprise.util.SystemPropertyConstants;
import java.beans.PropertyVetoException;
import java.io.File;
import org.glassfish.api.admin.AdminCommand;
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;
import org.jvnet.hk2.config.ConfigSupport;
import org.jvnet.hk2.config.SingleConfigCode;
import org.jvnet.hk2.config.TransactionFailure;
/**
* Create File User Command
* Usage: create-file-user [--terse=false] [--echo=false] [--interactive=true]
* [--host localhost] [--port 4848|4849] [--secure | -s]
* [--user admin_user] [--userpassword admin_passwd]
* [--passwordfile file_name] [--groups user_groups[:user_groups]*]
* [--authrealmname authrealm_name] [--target target(Default server)]
* username
*
* @author Nandini Ektare
*/
@Service(name="create-file-user")
@Scoped(PerLookup.class)
@I18n("create.file.user")
@ExecuteOn({RuntimeType.DAS, RuntimeType.INSTANCE})
@TargetType({CommandTarget.DAS,CommandTarget.STANDALONE_INSTANCE,CommandTarget.CLUSTER, CommandTarget.CONFIG})
public class CreateFileUser implements /*UndoableCommand*/ AdminCommand {
final private static LocalStringManagerImpl localStrings =
new LocalStringManagerImpl(CreateFileUser.class);
@Param(name="groups", optional=true, separator=':')
private List<String> groups = new ArrayList<String>(0); //by default, an empty list is better than a null
//TODO: this is still a String, need to convert to char[]
@Param(name="userpassword", password=true)
private String userpassword;
@Param(name="authrealmname", optional=true)
private String authRealmName;
@Param(name = "target", optional = true, defaultValue =
SystemPropertyConstants.DEFAULT_SERVER_INSTANCE_NAME)
private String target;
@Param(name="username", primary=true)
private String userName;
@Inject(name = ServerEnvironment.DEFAULT_INSTANCE_NAME)
private Config config;
@Inject
Configs configs;
@Inject
private Domain domain;
@Inject
private RealmsManager realmsManager;
@Inject
private AdminService adminService;
@Inject
private ServerEnvironment se;
private SecureAdmin secureAdmin = null;
/**
* Executes the command with the command parameters passed as Properties
* where the keys are the paramter names and the values the parameter values
*
* @param context information
*/
public void execute(AdminCommandContext context) {
final ActionReport report = context.getActionReport();
Config tmp = null;
try {
tmp = configs.getConfigByName(target);
} catch (Exception ex) {
}
if (tmp != null) {
config = tmp;
}
if (tmp == null) {
Server targetServer = domain.getServerNamed(target);
if (targetServer != null) {
config = domain.getConfigNamed(targetServer.getConfigRef());
}
com.sun.enterprise.config.serverbeans.Cluster cluster = domain.getClusterNamed(target);
if (cluster != null) {
config = domain.getConfigNamed(cluster.getConfigRef());
}
}
final SecurityService securityService = config.getSecurityService();
// ensure we have the file authrealm
AuthRealm fileAuthRealm = null;
if (authRealmName == null)
authRealmName = securityService.getDefaultRealm();
for (AuthRealm authRealm : securityService.getAuthRealm()) {
if (authRealm.getName().equals(authRealmName)) {
fileAuthRealm = authRealm;
break;
}
}
if (fileAuthRealm == null) {
report.setMessage(localStrings.getLocalString(
"create.file.user.filerealmnotfound",
"File realm {0} does not exist",
authRealmName));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
// Get FileRealm class name, match it with what is expected.
String fileRealmClassName = fileAuthRealm.getClassname();
// Report error if provided impl is not the one expected
if (fileRealmClassName != null &&
!fileRealmClassName.equals(
"com.sun.enterprise.security.auth.realm.file.FileRealm")) {
report.setMessage(
localStrings.getLocalString(
"create.file.user.realmnotsupported",
"Configured file realm {0} is not supported.",
fileRealmClassName));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
// ensure we have the file associated with the authrealm
String keyFile = null;
for (Property fileProp : fileAuthRealm.getProperty()) {
if (fileProp.getName().equals("file"))
keyFile = fileProp.getValue();
}
final String kf = keyFile;
if (keyFile == null) {
report.setMessage(
localStrings.getLocalString("create.file.user.keyfilenotfound",
"There is no physical file associated with this file realm {0} ",
authRealmName));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
boolean exists = (new File(kf)).exists();
if (!exists) {
report.setMessage(
localStrings.getLocalString("file.realm.keyfilenonexistent",
"The specified physical file {0} associated with the file realm {1} does not exist.",
new Object[]{kf, authRealmName}));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
// Now get all inputs ready. userid and groups are straightforward but
// password is tricky. It is stored in the file passwordfile passed
// through the CLI options. It is stored under the name
// AS_ADMIN_USERPASSWORD. Fetch it from there.
final String password = userpassword; // fetchPassword(report);
if (password == null) {
report.setMessage(localStrings.getLocalString(
"create.file.user.keyfilenotreadable", "Password for user {0} " +
"has to be specified in --userpassword option or supplied " +
"through AS_ADMIN_USERPASSWORD property in the file specified " +
"in --passwordfile option", userName));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
//Issue 17525 Fix - Check for null passwords for admin-realm if secureadmin is enabled
secureAdmin = domain.getSecureAdmin();
if ((SecureAdmin.Util.isEnabled(secureAdmin))
&& (authRealmName.equals(adminService.getAuthRealmName()))) {
if ((password == null) || (password.isEmpty())) {
report.setMessage(localStrings.getLocalString(
"null_empty_password","The admin user password is null or empty"));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
}
// now adding user
try {
//even though create-file-user is not an update to the security-service
//do we need to make it transactional by referncing the securityservice
//hypothetically ?.
ConfigSupport.apply(new SingleConfigCode<SecurityService>() {
public Object run(SecurityService param)
throws PropertyVetoException, TransactionFailure {
try {
realmsManager.createRealms(config);
//If the (shared) keyfile is updated by an external process, load the users first
refreshRealm(config.getName(),authRealmName);
final FileRealm fr = (FileRealm) realmsManager.getFromLoadedRealms(config.getName(),authRealmName);
CreateFileUser.handleAdminGroup(authRealmName, groups);
String[] groups1 = groups.toArray(new String[groups.size()]);
try {
fr.addUser(userName, password.toCharArray(), groups1);
}catch(BadRealmException br) {
//Check if the server environment is DAS. If is not DAS (user creation was
//successful on DAS), then the error is caused in the instances because of shared keyfile between
// DAS and cluster instances - ignore the exception for instances.
if(se != null && se.isDas()) {
throw new BadRealmException(br);
}
}
fr.persist();
report.setActionExitCode(ActionReport.ExitCode.SUCCESS);
} catch (Exception e) {
String localalizedErrorMsg = (e.getLocalizedMessage() == null)?"":e.getLocalizedMessage();
report.setMessage(
localStrings.getLocalString("create.file.user.useraddfailed",
"Adding User {0} to the file realm {1} failed",
userName, authRealmName) + " " + localalizedErrorMsg);
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setFailureCause(e);
}
return null;
}
}, securityService);
} catch (Exception e) {
report.setMessage(
localStrings.getLocalString("create.file.user.useraddfailed",
"Adding User {0} to the file realm {1} failed",
userName, authRealmName) + " " + e.getLocalizedMessage());
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setFailureCause(e);
}
}
/* private String fetchPassword(ActionReport report) {
String password = null;
if (userpassword != null && passwordFile != null)
return password;
if (userpassword != null)
password = userpassword;
if (passwordFile != null) {
File passwdFile = new File(passwordFile);
InputStream is = null;
try {
is = new BufferedInputStream(new FileInputStream(passwdFile));
Properties prop = new Properties();
prop.load(is);
for (Enumeration e=prop.propertyNames(); e.hasMoreElements();) {
String entry = (String)e.nextElement();
if (entry.equals("AS_ADMIN_USERPASSWORD")) {
password = prop.getProperty(entry);
break;
}
}
} catch(Exception e) {
report.setFailureCause(e);
} finally {
try {
if (is != null)
is.close();
} catch(final Exception ignore){}
}
}
return password;
} */
public static void refreshRealm(String configName, String realmName) {
if (realmName != null && realmName.length() > 0) {
try {
Realm realm = Realm.getInstance(configName, realmName);
if (realm != null) {
realm.refresh(configName);
}
} catch (com.sun.enterprise.security.auth.realm.NoSuchRealmException nre) {
// _logger.fine("Realm: "+realmName+" is not configured");
} catch (com.sun.enterprise.security.auth.realm.BadRealmException bre) {
// _logger.fine("Realm: "+realmName+" is not configured");
}
}
}
static void handleAdminGroup(String lr, List<String> lg) {
String fr = "admin-realm"; //this should be a constant defined at a central place -- the name of realm for admin
String fg = "asadmin"; //this should be a constant defined at a central place -- fixed name of admin group
if (fr.equals(lr) && lg != null) {
lg.clear(); //basically, we are ignoring the group specified on command line when it's admin realm
lg.add(fg);
}
}
// @Override
// public ActionReport prepare(ParameterMap parameters) {
// //TODO: is there a way to check if in a Cluster some
// //instances are down
//// com.sun.enterprise.config.serverbeans.Cluster cluster = domain.getClusterNamed(target);
//// if (cluster!=null) {
//// List<Server> servers = cluster.getInstances();
//// }
// final ActionReport report = new ActionReport();
// }
//
// @Override
// public void undo(ParameterMap parameters) {
// throw new UnsupportedOperationException("Not supported yet.");
// }
}