-
Notifications
You must be signed in to change notification settings - Fork 138
/
UpdateFileUser.java
272 lines (241 loc) · 11.4 KB
/
UpdateFileUser.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/*
* Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation
* Copyright (c) 1997, 2021 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.security.cli;
import java.io.File;
import java.util.List;
import org.glassfish.api.ActionReport;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.admin.AccessRequired;
import org.glassfish.api.admin.AdminCommand;
import org.glassfish.api.admin.AdminCommandContext;
import org.glassfish.api.admin.AdminCommandSecurity;
import org.glassfish.api.admin.ExecuteOn;
import org.glassfish.api.admin.RestEndpoint;
import org.glassfish.api.admin.RestEndpoints;
import org.glassfish.api.admin.RestParam;
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.glassfish.hk2.api.PerLookup;
import org.jvnet.hk2.annotations.Service;
import org.jvnet.hk2.config.types.Property;
import com.sun.enterprise.config.serverbeans.AdminService;
import com.sun.enterprise.config.serverbeans.AuthRealm;
import com.sun.enterprise.config.serverbeans.Config;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.config.serverbeans.SecureAdmin;
import com.sun.enterprise.config.serverbeans.SecurityService;
import com.sun.enterprise.security.auth.realm.NoSuchRealmException;
import com.sun.enterprise.security.auth.realm.RealmsManager;
import com.sun.enterprise.security.auth.realm.file.FileRealm;
import com.sun.enterprise.util.LocalStringManagerImpl;
import com.sun.enterprise.util.SystemPropertyConstants;
import jakarta.inject.Inject;
import jakarta.inject.Named;
/**
* Update File User Command
*
* Usage: update-file-user [--terse=false] [--echo=false] [--interactive=true] [--host localhost] [--port 4848|4849] [--secure |
* -s] [--user admin_user] [--passwordfile file_name] [--userpassword admin_passwd] [--groups user_groups[:user_groups]*]
* [--authrealmname authrealm_name] [--target target(Default server)] username
*
* @author Nandini Ektare
*/
@Service(name = "update-file-user")
@PerLookup
@I18n("update.file.user")
@ExecuteOn({ RuntimeType.DAS, RuntimeType.INSTANCE })
@TargetType({ CommandTarget.DAS, CommandTarget.STANDALONE_INSTANCE, CommandTarget.CLUSTER, CommandTarget.CONFIG })
@RestEndpoints({
@RestEndpoint(configBean = AuthRealm.class, opType = RestEndpoint.OpType.POST, path = "update-user", description = "Update Users", params = {
@RestParam(name = "authrealmname", value = "$parent") }) })
public class UpdateFileUser implements AdminCommand, AdminCommandSecurity.Preauthorization {
final private static LocalStringManagerImpl localStrings = new LocalStringManagerImpl(UpdateFileUser.class);
@Param(name = "groups", optional = true, separator = ':')
private List<String> groups = null;
// @Param(name="userpasswordfile", optional=true)
// String passwordFile;
@Param(name = "userpassword", optional = true, 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
@Named(ServerEnvironment.DEFAULT_INSTANCE_NAME)
private Config config;
@Inject
private Domain domain;
@Inject
private RealmsManager realmsManager;
@Inject
private AdminService adminService;
private SecureAdmin secureAdmin = null;
@AccessRequired.To("update")
private AuthRealm fileAuthRealm;
private SecurityService securityService;
@Override
public boolean preAuthorization(AdminCommandContext context) {
config = CLIUtil.chooseConfig(domain, target, context.getActionReport());
if (config == null) {
return false;
}
securityService = config.getSecurityService();
fileAuthRealm = CLIUtil.findRealm(securityService, authRealmName);
if (fileAuthRealm == null) {
final ActionReport report = context.getActionReport();
report.setMessage(
localStrings.getLocalString("update.file.user.filerealmnotfound", "File realm {0} does not exist", authRealmName));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return false;
}
/*
* The realm might have been defaulted, so capture the actual name.
*/
authRealmName = fileAuthRealm.getName();
return true;
}
/**
* 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
*/
@Override
public void execute(AdminCommandContext context) {
final ActionReport report = context.getActionReport();
// 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("update.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();
}
if (keyFile == null) {
report.setMessage(localStrings.getLocalString("update.file.user.keyfilenotfound",
"There is no physical file associated with file realm {0}", authRealmName));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
boolean exists = (new File(keyFile)).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[] { keyFile, 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.
String password = userpassword; // fetchPassword(report);
if (password == null && groups == null) {
report.setMessage(localStrings.getLocalString("update.file.user.keyfilenotreadable",
"None of password or groups have been specified for update, " + "Password for user {0} has to be specified "
+ "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
if (password != null) {
secureAdmin = domain.getSecureAdmin();
if ((SecureAdmin.isEnabled(secureAdmin)) && (adminService.getAuthRealmName().equals(authRealmName))) {
if ((password.isEmpty())) {
report.setMessage(localStrings.getLocalString("null_empty_password", "The admin user password is empty"));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
}
}
//even though update-file-user is not an update to the security-service
//do we need to make it transactional by referncing the securityservice
//hypothetically ?.
//TODO: check and enclose the code below inside ConfigSupport.apply(...)
FileRealm fr = null;
try {
realmsManager.createRealms(config);
fr = (FileRealm) realmsManager.getFromLoadedRealms(config.getName(), authRealmName);
if (fr == null) {
throw new NoSuchRealmException(authRealmName);
}
} catch (NoSuchRealmException e) {
report.setMessage(localStrings.getLocalString("update.file.user.realmnotsupported", "Configured file realm {0} does not exist.",
authRealmName) + " " + e.getLocalizedMessage());
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setFailureCause(e);
return;
}
//now updating user
try {
CreateFileUser.handleAdminGroup(authRealmName, groups);
String[] groups1 = (groups == null) ? null : groups.toArray(new String[groups.size()]);
fr.updateUser(userName, userName, password, groups1);
fr.persist();
report.setActionExitCode(ActionReport.ExitCode.SUCCESS);
} catch (Exception e) {
report.setMessage(localStrings.getLocalString("update.file.user.userupdatefailed", "Updating user {0} in 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;
} */
}