-
Notifications
You must be signed in to change notification settings - Fork 138
/
ConfigFile.java
578 lines (475 loc) · 20.6 KB
/
ConfigFile.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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
/*
* Copyright (c) 2022 Contributors to the Eclipse Foundation
* Copyright (c) 1997, 2018 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.jauth;
import java.io.IOException;
import java.lang.reflect.Method;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.security.auth.Subject;
import javax.security.auth.callback.Callback;
import javax.security.auth.callback.CallbackHandler;
import javax.security.auth.callback.UnsupportedCallbackException;
import javax.security.auth.login.AppConfigurationEntry;
import org.omnifaces.eleos.config.factory.ConfigParser;
import org.omnifaces.eleos.data.AuthModuleConfig;
import org.omnifaces.eleos.data.AuthModulesLayerConfig;
import com.sun.logging.LogDomains;
/**
* This is a default file-based AuthConfig implementation.
*
* @version %I%, %G%
*/
class ConfigFile extends AuthConfig {
// indicates the age of the configuration approximately in
// terms of the number of times refresh has been called
private int epoch;
// parser class name
private String parserClassName;
// parser
private org.omnifaces.eleos.config.factory.ConfigParser parser;
// package private for ConfigFileParser
static final String CLIENT = "client";
static final String SERVER = "server";
private static final String DEFAULT_HANDLER_CLASS = "com.sun.enterprise.security.jmac.ContainerCallbackHandler";
private static final String DEFAULT_PARSER_CLASS = "com.sun.enterprise.security.jmac.ConfigDomainParser";
private static final Logger logger = LogDomains.getLogger(ConfigFile.class, LogDomains.SECURITY_LOGGER);
ConfigFile() throws IOException {
String propertyValue = System.getProperty("config.parser");
if (propertyValue == null) {
parserClassName = DEFAULT_PARSER_CLASS;
} else {
parserClassName = propertyValue;
}
this.epoch = 1;
parser = ConfigFile.loadParser(parserClassName);
parser.initialize(null);
}
/**
* Get a default ClientAuthContext.
*
* @return an instance of ConfigClient.
*/
@Override
public ClientAuthContext getClientAuthContext(String intercept, String id, AuthPolicy requestPolicy, AuthPolicy responsePolicy,
CallbackHandler handler) throws AuthException {
ConfigFile.Entry[] entries = getEntries(intercept, id, requestPolicy, responsePolicy, CLIENT);
if (entries == null || entries.length == 0) {
return null;
}
// instantiate and initialize modules up front as well
if (handler == null) {
handler = ConfigFile.loadDefaultCallbackHandler();
} else if (handler instanceof DependentCallbackHandler) {
handler = new DelegatingHandler(handler);
}
for (int i = 0; i < entries.length; i++) {
entries[i].module = ConfigFile.createModule(entries[i], handler);
}
return new ConfigClient(entries);
}
/**
* Get a default ServerAuthContext.
*
* @return an instance of ConfigServer.
*/
@Override
public ServerAuthContext getServerAuthContext(String intercept, String id, AuthPolicy requestPolicy, AuthPolicy responsePolicy,
CallbackHandler handler) throws AuthException {
ConfigFile.Entry[] entries = getEntries(intercept, id, requestPolicy, responsePolicy, SERVER);
if (entries == null || entries.length == 0) {
return null;
}
// instantiate and initialize modules up front as well
if (handler == null) {
handler = ConfigFile.loadDefaultCallbackHandler();
} else if (handler instanceof DependentCallbackHandler) {
handler = new DelegatingHandler(handler);
}
for (int i = 0; i < entries.length; i++) {
entries[i].module = ConfigFile.createModule(entries[i], handler);
}
return new ConfigServer(entries);
}
@Override
public void refresh() throws AuthException {
synchronized (this) {
ConfigParser nextParser;
int next = this.epoch + 1;
try {
nextParser = ConfigFile.loadParser(parserClassName);
} catch (IOException ioe) {
throw new AuthException(ioe.toString());
}
this.epoch = next == 0 ? 1 : next;
parser = nextParser;
}
}
private ConfigFile.Entry[] getEntries(String intercept, String id, AuthPolicy requestPolicy, AuthPolicy responsePolicy, String type) {
// get the parsed module config and DD information
Map configMap;
synchronized (parser) {
configMap = parser.getAuthModuleLayers();
}
if (configMap == null) {
return null;
}
// get the module config info for this intercept
AuthModulesLayerConfig intEntry = (AuthModulesLayerConfig) configMap.get(intercept);
if (intEntry == null || intEntry.getAuthModules() == null) {
if (logger != null && logger.isLoggable(Level.FINE)) {
logger.fine("module config has no IDs configured for [" + intercept + "]");
}
return null;
}
// look up the DD's provider ID in the module config
AuthModuleConfig idEntry = null;
if (id == null || (idEntry = intEntry.getAuthModules().get(id)) == null) {
// either the DD did not specify a provider ID,
// or the DD-specified provider ID was not found
// in the module config.
//
// in either case, look for a default ID in the module config
if (logger != null && logger.isLoggable(Level.FINE)) {
logger.fine("DD did not specify ID, " + "or DD-specified ID for [" + intercept + "] not found in config -- "
+ "attempting to look for default ID");
}
String defaultID;
if (CLIENT.equals(type)) {
defaultID = intEntry.getDefaultClientModuleId();
} else {
defaultID = intEntry.getDefaultServerModuleId();
}
idEntry = intEntry.getAuthModules().get(defaultID);
if (idEntry == null) {
// did not find a default provider ID
if (logger != null && logger.isLoggable(Level.FINE)) {
logger.fine("no default config ID for [" + intercept + "]");
}
return null;
}
}
// we found the DD provider ID in the module config
// or we found a default module config
// check provider-type
if (idEntry.getType().indexOf(type) < 0) {
if (logger != null && logger.isLoggable(Level.FINE)) {
logger.fine("request type [" + type + "] does not match config type [" + idEntry.getType() + "]");
}
return null;
}
// check whether a policy is set
AuthPolicy reqP, respP;
if (requestPolicy != null || responsePolicy != null) {
reqP = requestPolicy;
respP = responsePolicy;
} else if (idEntry.getRequestPolicy() != null || idEntry.getResponsePolicy() != null) {
// default
reqP = new AuthPolicy(idEntry.getRequestPolicy());
respP = new AuthPolicy(idEntry.getResponsePolicy());
} else {
// optimization: if policy was not set, return null
if (logger != null && logger.isLoggable(Level.FINE)) {
logger.fine("no policy applies");
}
return null;
}
// return the configured modules with the correct policies
// ConfigFile.Entry[] entries = new Entry[idEntry.modules.size()];
ConfigFile.Entry[] entries = new Entry[1];
for (int i = 0; i < entries.length; i++) {
// Login Bridge profile?
// AppConfigurationEntry aEntry =
// (AppConfigurationEntry)idEntry.modules.get(i);
entries[i] = new ConfigFile.Entry(reqP, respP, idEntry.getModuleClassName(),
AppConfigurationEntry.LoginModuleControlFlag.REQUIRED, idEntry.getOptions());
}
if (logger != null && logger.isLoggable(Level.FINE)) {
logger.fine("getEntries found " + entries.length + " entries for: " + intercept + " -- " + id);
for (int i = 0; i < entries.length; i++) {
logger.fine("Entry " + (i + 1) + ":" + "\n module class: " + entries[i].getLoginModuleName() + "\n flag: "
+ entries[i].getControlFlag() + "\n options: " + entries[i].getOptions() + "\n request policy: "
+ entries[i].requestPolicy + "\n response policy: " + entries[i].responsePolicy);
}
}
return entries;
}
/**
* get a custom config file parser
*
* XXX custom file that can be used in place of [domain|sun-acc].xml
*/
private static org.omnifaces.eleos.config.factory.ConfigParser loadParser(String className) throws IOException {
try {
final String finalClassName = className;
final ClassLoader finalLoader = AuthConfig.getClassLoader();
return java.security.AccessController.doPrivileged(new java.security.PrivilegedExceptionAction<org.omnifaces.eleos.config.factory.ConfigParser>() {
@Override
public org.omnifaces.eleos.config.factory.ConfigParser run() throws Exception {
return (org.omnifaces.eleos.config.factory.ConfigParser) Class.forName(finalClassName, true, finalLoader).newInstance();
}
});
} catch (java.security.PrivilegedActionException pae) {
IOException iex = new IOException(pae.getException().toString());
iex.initCause(pae.getException());
throw iex;
}
}
/**
* get the default callback handler
*/
private static CallbackHandler loadDefaultCallbackHandler() throws AuthException {
// get the default handler class
try {
final ClassLoader finalLoader = AuthConfig.getClassLoader();
return (CallbackHandler) java.security.AccessController.doPrivileged(new java.security.PrivilegedExceptionAction() {
@Override
public Object run() throws Exception {
String className = DEFAULT_HANDLER_CLASS;
Class c = Class.forName(className, true, finalLoader);
return c.newInstance();
}
});
} catch (java.security.PrivilegedActionException pae) {
AuthException aex = new AuthException(pae.getException().toString());
aex.initCause(pae.getException());
throw aex;
}
}
/**
* Instantiate+initialize module class
*/
private static Object createModule(ConfigFile.Entry entry, CallbackHandler handler) throws AuthException {
try {
// instantiate module using no-arg constructor
Object newModule = entry.newInstance();
// initialize module
Object[] initArgs = { entry.getRequestPolicy(), entry.getResponsePolicy(), handler, entry.getOptions() };
try {
Method initMethod = newModule.getClass().getMethod(AuthContextImpl.INIT, AuthPolicy.class, AuthPolicy.class,
CallbackHandler.class, Map.class);
initMethod.invoke(newModule, initArgs);
// return the new module
return newModule;
} catch (Exception ex) {
throw new SecurityException(
"could not invoke " + AuthContextImpl.INIT + " method in module: " + newModule.getClass().getName() + " " + ex, ex);
}
} catch (Exception e) {
if (e instanceof AuthException) {
throw (AuthException) e;
}
AuthException ae = new AuthException();
ae.initCause(e);
throw ae;
}
}
/**
* Class representing a single AuthModule entry configured for an ID, interception point, and stack.
*
* <p>
* An instance of this class contains the same information as its superclass, AppConfigurationEntry. It additionally
* stores the request and response policy assigned to this module.
*
* <p>
* This class also provides a way for a caller to obtain an instance of the module listed in the entry by invoking the
* <code>newInstance</code> method.
*/
static class Entry extends javax.security.auth.login.AppConfigurationEntry {
// for loading modules
private static final Class[] PARAMS = {};
private static final Object[] ARGS = {};
private AuthPolicy requestPolicy;
private AuthPolicy responsePolicy;
// convenience location to store instance -
// package private for AuthContextImpl
Object module;
/**
* Construct a ConfigFile entry.
*
* <p>
* An entry encapsulates a single module and its related information.
*
* @param requestPolicy the request policy assigned to the module listed in this entry, which may be null.
*
* @param responsePolicy the response policy assigned to the module listed in this entry, which may be null.
*
* @param moduleClass the fully qualified class name of the module.
*
* @param flag the module control flag. This value must either be REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL.
*
* @param options the options configured for this module.
*/
Entry(AuthPolicy requestPolicy, AuthPolicy responsePolicy, String moduleClass, AppConfigurationEntry.LoginModuleControlFlag flag,
Map options) {
super(moduleClass, flag, options);
this.requestPolicy = requestPolicy;
this.responsePolicy = responsePolicy;
}
/**
* Return the request policy assigned to this module.
*
* @return the policy, which may be null.
*/
AuthPolicy getRequestPolicy() {
return requestPolicy;
}
/**
* Return the response policy assigned to this module.
*
* @return the policy, which may be null.
*/
AuthPolicy getResponsePolicy() {
return responsePolicy;
}
/**
* Return a new instance of the module contained in this entry.
*
* <p>
* The default implementation of this method attempts to invoke the default no-args constructor of the module class.
* This method may be overridden if a different constructor should be invoked.
*
* @return a new instance of the module contained in this entry.
*
* @exception AuthException if the instantiation failed.
*/
Object newInstance() throws AuthException {
try {
final ClassLoader finalLoader = AuthConfig.getClassLoader();
String clazz = getLoginModuleName();
Class c = Class.forName(clazz, true, finalLoader);
java.lang.reflect.Constructor constructor = c.getConstructor(PARAMS);
return constructor.newInstance(ARGS);
} catch (Exception e) {
AuthException ae = new AuthException();
ae.initCause(e);
throw ae;
}
}
}
/**
* Default implementation of ClientAuthContext.
*/
private static class ConfigClient implements ClientAuthContext {
// class that does all the work
private AuthContextImpl context;
ConfigClient(Entry[] entries) throws AuthException {
context = new AuthContextImpl(entries, logger);
}
@Override
public void secureRequest(AuthParam param, Subject subject, Map sharedState) throws AuthException {
// invoke modules
Object[] args = { param, subject, sharedState };
context.invoke(AuthContextImpl.SECURE_REQUEST, args);
}
@Override
public void validateResponse(AuthParam param, Subject subject, Map sharedState) throws AuthException {
// invoke modules
Object[] args = { param, subject, sharedState };
context.invoke(AuthContextImpl.VALIDATE_RESPONSE, args);
}
@Override
public void disposeSubject(Subject subject, Map sharedState) throws AuthException {
// invoke modules
Object[] args = { subject, sharedState };
context.invoke(AuthContextImpl.DISPOSE_SUBJECT, args);
}
}
/**
* Default implementation of ServerAuthContext.
*/
private static class ConfigServer implements ServerAuthContext {
// class that does all the work
private AuthContextImpl context;
ConfigServer(Entry[] entries) throws AuthException {
context = new AuthContextImpl(entries, logger);
}
@Override
public void validateRequest(AuthParam param, Subject subject, Map sharedState) throws AuthException {
// invoke modules
Object[] args = { param, subject, sharedState };
context.invoke(AuthContextImpl.VALIDATE_REQUEST, args);
}
@Override
public void secureResponse(AuthParam param, Subject subject, Map sharedState) throws AuthException {
// invoke modules
Object[] args = { param, subject, sharedState };
context.invoke(AuthContextImpl.SECURE_RESPONSE, args);
}
@Override
public void disposeSubject(Subject subject, Map sharedState) throws AuthException {
// invoke modules
Object[] args = { subject, sharedState };
context.invoke(AuthContextImpl.DISPOSE_SUBJECT, args);
}
@Override
public boolean managesSessions(Map sharedState) throws AuthException {
// invoke modules
Object[] args = { sharedState };
Object[] rValues = null;
try {
rValues = context.invoke(AuthContextImpl.MANAGES_SESSIONS, args);
} catch (AuthException ae) {
// this new method may not be implemeneted
// by old modules
if (!(ae.getCause() instanceof NoSuchMethodException)) {
throw ae;
}
}
boolean rvalue = false;
for (int i = 0; rValues != null && i < rValues.length; i++) {
if (rValues[i] != null) {
boolean thisValue = (Boolean) rValues[i];
rvalue = rvalue | thisValue;
}
}
return rvalue;
}
}
private static class DelegatingHandler implements CallbackHandler {
CallbackHandler handler;
CallbackHandler defaultHandler;
private DelegatingHandler(CallbackHandler cbh) {
handler = cbh;
try {
defaultHandler = ConfigFile.loadDefaultCallbackHandler();
} catch (Exception e) {
defaultHandler = null;
}
}
@Override
public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException {
if (defaultHandler == null) {
handler.handle(callbacks);
} else {
Callback[] oneCallback = new Callback[1];
for (Callback callback : callbacks) {
boolean tryDefault = false;
oneCallback[0] = callback;
try {
handler.handle(oneCallback);
} catch (UnsupportedCallbackException uce) {
tryDefault = true;
}
if (tryDefault) {
defaultHandler.handle(oneCallback);
}
}
}
}
}
}