-
Notifications
You must be signed in to change notification settings - Fork 138
/
SMGlobalPolicyUtil.java
411 lines (326 loc) · 14.1 KB
/
SMGlobalPolicyUtil.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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
/*
* Copyright (c) 2021, 2022 Contributors to the Eclipse Foundation
* Copyright (c) 2013, 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.ee.perms;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.net.URISyntaxException;
import java.net.URL;
import java.security.AllPermission;
import java.security.CodeSource;
import java.security.NoSuchAlgorithmException;
import java.security.Permission;
import java.security.PermissionCollection;
import java.security.Policy;
import java.security.URIParameter;
import java.security.cert.Certificate;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.sun.logging.LogDomains;
/**
* Utility class to load the EE permissions, EE restrictions, and check restrictions for a given permission set
*/
public class SMGlobalPolicyUtil {
static Logger logger = Logger.getLogger(LogDomains.SECURITY_LOGGER);
/**
* Jakarta EE Component type supporting the use of declared permissions
*/
public enum CommponentType {
ear, ejb, war, rar, car
}
private enum PolicyType {
/**
* Configured EE permissions in the domain
*/
EEGranted,
/**
* Configured EE restriction list in the domain
*/
EERestricted,
/**
* Configured domain allowed list
*/
ServerAllowed
}
/**
* This is the file storing the default permissions granted to each component type
*/
public static final String EE_GRANT_FILE = "javaee.server.policy";
/**
* This is the file storing the restricted permissions for each component type; Any permissions declared in this list
* can not be used by the application
*/
public static final String EE_RESTRICTED_FILE = "restrict.server.policy";
/**
* This is the file storing the allowed permissions for each component type A permission listed in this file may not be
* used but the application, but any application declared permission must exist in this list;
*/
public static final String SERVER_ALLOWED_FILE = "restrict.server.policy";
protected static final String SYS_PROP_JAVA_SEC_POLICY = "java.security.policy";
/**
* Code source URL representing Ejb type
*/
public static final String EJB_TYPE_CODESOURCE = "file:/module/Ejb";
/**
* Code source URL representing Web type
*/
public static final String WEB_TYPE_CODESOURCE = "file:/module/Web";
/**
* Code source URL representing Rar type
*/
public static final String RAR_TYPE_CODESOURCE = "file:/module/Rar";
/**
* Code source URL representing App client type
*/
public static final String CLIENT_TYPE_CODESOURCE = "file:/module/Car";
/**
* Code source URL representing Ear type
*/
public static final String EAR_TYPE_CODESOURCE = "file:/module/Ear";
public static final String EAR_CLASS_LOADER = "org.glassfish.javaee.full.deployment.EarClassLoader";
// map recording the 'Jakarta EE component type' to its EE granted permissions
private static final Map<CommponentType, PermissionCollection> compTypeToEEGarntsMap = new HashMap<>();
// map recording the 'Jakarta EE component type' to its EE restricted permissions
private static final Map<CommponentType, PermissionCollection> compTypeToEERestrictedMap = new HashMap<>();
// map recording the 'Jakarta EE component type' to its allowed permissions
private static final Map<CommponentType, PermissionCollection> compTypeToServAllowedMap = new HashMap<>();
private static boolean eeGrantedPolicyInitDone = false;
protected static final String domainCfgFolder = getJavaPolicyFolder() + File.separator;
private static final AllPermission ALL_PERM = new AllPermission();
// JDK-8173082: JDK required permissions needed by applications using java.desktop module
private static final List<String> JDK_REQUIRED_PERMISSIONS = Stream.of("accessClassInPackage.com.sun.beans",
"accessClassInPackage.com.sun.beans.*", "accessClassInPackage.com.sun.java.swing.plaf.*", "accessClassInPackage.com.apple.*")
.collect(Collectors.toList());
// convert a string type to the CommponentType
public static CommponentType convertComponentType(String type) {
return Enum.valueOf(CommponentType.class, type);
}
/**
* Get the default granted permissions of a specified component type
*
* @param type Jakarta EE component type
* @return the permission set granted to the specified component
*/
public static PermissionCollection getEECompGrantededPerms(CommponentType type) {
initDefPolicy();
return compTypeToEEGarntsMap.get(type);
}
/**
* Get the default granted permissions of a specified component type
*
* @param type Jakarta EE component type such as ejb, war, rar, car, ear
* @return
*/
public static PermissionCollection getEECompGrantededPerms(String type) {
CommponentType compType = convertComponentType(type);
return getEECompGrantededPerms(compType);
}
/**
* Get the restricted permission set of a specified component type on the server
*
* @param type Jakarta EE component type
* @return the restricted permission set of the specified component type on the server
*/
public static PermissionCollection getCompRestrictedPerms(CommponentType type) {
initDefPolicy();
return compTypeToEERestrictedMap.get(type);
}
public static PermissionCollection getCompRestrictedPerms(String type) {
CommponentType compType = convertComponentType(type);
return getCompRestrictedPerms(compType);
}
private synchronized static void initDefPolicy() {
try {
if (logger.isLoggable(Level.FINE)) {
logger.fine("defGrantedPolicyInitDone= " + eeGrantedPolicyInitDone);
}
if (eeGrantedPolicyInitDone) {
return;
}
eeGrantedPolicyInitDone = true;
loadServerPolicy(PolicyType.EEGranted);
loadServerPolicy(PolicyType.EERestricted);
loadServerPolicy(PolicyType.ServerAllowed);
checkDomainRestrictionsForDefaultPermissions();
} catch (FileNotFoundException e) {
// ignore: the permissions files not exist
} catch (IOException | NoSuchAlgorithmException | URISyntaxException e) {
logger.warning(e.getMessage());
throw new RuntimeException(e);
}
}
private static String getJavaPolicyFolder() {
String policyPath = System.getProperty(SYS_PROP_JAVA_SEC_POLICY);
if (policyPath == null) {
return null;
}
File pf = new File(policyPath);
return pf.getParent();
}
private static void loadServerPolicy(PolicyType policyType) throws IOException, NoSuchAlgorithmException, URISyntaxException {
if (policyType == null) {
return;
}
if (logger.isLoggable(Level.FINE)) {
logger.fine("PolicyType= " + policyType);
}
String policyFilename = null;
Map<CommponentType, PermissionCollection> policyMap = null;
switch (policyType) {
case EEGranted:
policyFilename = domainCfgFolder + EE_GRANT_FILE;
policyMap = compTypeToEEGarntsMap;
break;
case EERestricted:
policyFilename = domainCfgFolder + EE_RESTRICTED_FILE;
policyMap = compTypeToEERestrictedMap;
break;
case ServerAllowed:
policyFilename = domainCfgFolder + SERVER_ALLOWED_FILE;
policyMap = compTypeToServAllowedMap;
break;
}
if (policyFilename == null || policyMap == null) {
throw new IllegalArgumentException("Unrecognized policy type: " + policyType);
}
if (logger.isLoggable(Level.FINE)) {
logger.fine("policyFilename= " + policyFilename);
}
if (!new File(policyFilename).exists()) {
return;
}
URL furl = new URL("file:" + policyFilename);
if (logger.isLoggable(Level.FINE)) {
logger.fine("Loading policy from " + furl);
}
Policy pf = Policy.getInstance("JavaPolicy", new URIParameter(furl.toURI()));
CodeSource cs = new CodeSource(new URL(EJB_TYPE_CODESOURCE), (Certificate[]) null);
PermissionCollection pc = pf.getPermissions(cs);
policyMap.put(CommponentType.ejb, pc);
if (logger.isLoggable(Level.FINE)) {
logger.fine("Loaded EJB policy = " + pc);
}
cs = new CodeSource(new URL(WEB_TYPE_CODESOURCE), (Certificate[]) null);
pc = pf.getPermissions(cs);
policyMap.put(CommponentType.war, pc);
if (logger.isLoggable(Level.FINE)) {
logger.fine("Loaded WEB policy =" + pc);
}
cs = new CodeSource(new URL(RAR_TYPE_CODESOURCE), (Certificate[]) null);
pc = pf.getPermissions(cs);
policyMap.put(CommponentType.rar, pc);
if (logger.isLoggable(Level.FINE)) {
logger.fine("Loaded rar policy =" + pc);
}
cs = new CodeSource(new URL(CLIENT_TYPE_CODESOURCE), (Certificate[]) null);
pc = pf.getPermissions(cs);
policyMap.put(CommponentType.car, pc);
if (logger.isLoggable(Level.FINE)) {
logger.fine("Loaded car policy =" + pc);
}
cs = new CodeSource(new URL(EAR_TYPE_CODESOURCE), (Certificate[]) null);
pc = pf.getPermissions(cs);
policyMap.put(CommponentType.ear, pc);
if (logger.isLoggable(Level.FINE)) {
logger.fine("Loaded ear policy =" + pc);
}
}
// this checks default permissions against restrictions
private static void checkDomainRestrictionsForDefaultPermissions() throws SecurityException {
checkEETypePermsAgainstServerRestiction(CommponentType.ejb);
checkEETypePermsAgainstServerRestiction(CommponentType.war);
checkEETypePermsAgainstServerRestiction(CommponentType.rar);
checkEETypePermsAgainstServerRestiction(CommponentType.car);
checkEETypePermsAgainstServerRestiction(CommponentType.ear);
}
private static void checkEETypePermsAgainstServerRestiction(CommponentType type) throws SecurityException {
checkRestriction(compTypeToEEGarntsMap.get(type), compTypeToEERestrictedMap.get(type));
}
public static void checkRestriction(CommponentType type, PermissionCollection declaredPC) throws SecurityException {
checkRestriction(declaredPC, getCompRestrictedPerms(type));
}
/**
* Checks a permissions set against a restriction set
*
* @param declaredPC
* @param restrictedPC
* @return true for passed
* @throws SecurityException is thrown if violation detected
*/
public static void checkRestriction(PermissionCollection declaredPC, PermissionCollection restrictedPC) throws SecurityException {
if (restrictedPC == null || declaredPC == null) {
return;
}
// check declared does not contain restricted
checkContains(declaredPC, restrictedPC);
// check restricted does not contain declared
checkContains(restrictedPC, declaredPC);
}
// check if permissionCollection toBeCheckedPC is contained/implied by containPC
private static void checkContains(PermissionCollection containPC, PermissionCollection toBeCheckedPC) throws SecurityException {
if (containPC == null || toBeCheckedPC == null) {
return;
}
Enumeration<Permission> checkEnum = toBeCheckedPC.elements();
while (checkEnum.hasMoreElements()) {
Permission p = checkEnum.nextElement();
if (!JDK_REQUIRED_PERMISSIONS.contains(p.getName()) && containPC.implies(p)) {
throw new SecurityException("Restricted permission " + p + " is declared or implied in the " + containPC);
}
}
}
/**
* Check a permission set against a restriction of a component type
*
* @param declaredPC
* @param type
* @return
* @throws SecurityException
*/
public static void checkRestrictionOfComponentType(PermissionCollection declaredPC, CommponentType type) throws SecurityException {
if (CommponentType.ear == type) {
checkRestrictionOfEar(declaredPC);
}
PermissionCollection restrictedPC = compTypeToEERestrictedMap.get(type);
checkRestriction(declaredPC, restrictedPC);
}
// for ear type, check evrything
public static void checkRestrictionOfEar(PermissionCollection declaredPC) throws SecurityException {
PermissionCollection pc = compTypeToEERestrictedMap.get(CommponentType.ejb);
if (pc != null) {
SMGlobalPolicyUtil.checkRestriction(declaredPC, pc);
}
pc = compTypeToEERestrictedMap.get(CommponentType.war);
if (pc != null) {
SMGlobalPolicyUtil.checkRestriction(declaredPC, pc);
}
pc = compTypeToEERestrictedMap.get(CommponentType.rar);
if (pc != null) {
SMGlobalPolicyUtil.checkRestriction(declaredPC, pc);
}
pc = compTypeToEERestrictedMap.get(CommponentType.car);
if (pc != null) {
SMGlobalPolicyUtil.checkRestriction(declaredPC, pc);
}
}
}