-
Notifications
You must be signed in to change notification settings - Fork 138
/
ConnectorCallbackHandler.java
303 lines (248 loc) · 12.3 KB
/
ConnectorCallbackHandler.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
/*
* Copyright (c) 2022 Contributors to the Eclipse Foundation
* Copyright (c) 1997, 2020 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.connectors.work.context;
import static com.sun.enterprise.util.Utility.isEmpty;
import static java.util.logging.Level.FINEST;
import static java.util.logging.Level.WARNING;
import java.io.IOException;
import java.security.Principal;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
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 org.glassfish.logging.annotation.LogMessageInfo;
import org.glassfish.security.common.Group;
import org.glassfish.security.common.UserNameAndPassword;
import org.glassfish.epicyro.config.helper.Caller;
import org.glassfish.epicyro.config.helper.CallerPrincipal;
import com.sun.enterprise.connectors.work.LogFacade;
import com.sun.enterprise.security.SecurityContext;
import jakarta.security.auth.message.callback.CallerPrincipalCallback;
import jakarta.security.auth.message.callback.GroupPrincipalCallback;
import jakarta.security.auth.message.callback.PasswordValidationCallback;
/**
* Connector callback handler to intercept the callbacks provided by the work instance in order to map the security
* credentials between container and EIS domain
*
* @author Jagadish Ramu
* @since GlassFish v3
*/
//TODO V3 need contract based handlers for individual callbacks ?
public class ConnectorCallbackHandler implements CallbackHandler {
private static final Logger logger = LogFacade.getLogger();
private static final List<String> supportedCallbacks = List.of(
GroupPrincipalCallback.class.getName(),
CallerPrincipalCallback.class.getName());
@LogMessageInfo(
message = "Unsupported callback {0} during credential mapping.",
comment = "Unsupported callback class.",
level = "WARNING",
cause = "Resource adapter has used a callback that is not supported by application server.",
action = "Check whether the callback in question is supported by application server.",
publish = true)
private static final String RAR_UNSUPPORT_CALLBACK = "AS-RAR-05012";
private final CallbackHandler handler;
private boolean needMapping;
// Warning: Mixes groups and users
private final Map<Principal, Principal> securityMap;
private final Subject executionSubject;
public ConnectorCallbackHandler(Subject executionSubject, CallbackHandler handler, Map<Principal, Principal> securityMap) {
this.handler = handler;
if (!isEmpty(securityMap)) {
needMapping = true;
logger.finest("translation required for security info ");
} else {
logger.finest("no translation required for security info ");
}
this.executionSubject = executionSubject;
this.securityMap = securityMap;
}
@Override
public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException {
Callback[] mappedCallbacks = callbacks;
if (callbacks != null) {
List<Callback> asCallbacks = new ArrayList<>();
boolean hasCallerPrincipalCallback = hasCallerPrincipalCallback(callbacks);
if (needMapping) {
for (Callback callback : callbacks) {
boolean callbackSupported = false;
for (String supportedCallback : supportedCallbacks) {
try {
// TODO V3 what if there is a callback impl that implements multiple callbacks ?
if (Class.forName(supportedCallback).isAssignableFrom(callback.getClass())) {
callbackSupported = true;
asCallbacks.add(handleSupportedCallback(callback));
}
} catch (ClassNotFoundException cnfe) {
logger.log(FINEST, "class not found", cnfe);
}
}
if (!callbackSupported) {
UnsupportedCallbackException uce = new UnsupportedCallbackException(callback);
logger.log(WARNING, RAR_UNSUPPORT_CALLBACK, new Object[] { callback.getClass().getName(), uce });
throw uce;
}
}
mappedCallbacks = new Callback[asCallbacks.size()];
for (int i = 0; i < asCallbacks.size(); i++) {
mappedCallbacks[i] = asCallbacks.get(i);
}
}
// TODO V3 what happens to multiple callbacks?
handler.handle(mappedCallbacks);
processResults(mappedCallbacks, hasCallerPrincipalCallback);
}
}
private boolean hasCallerPrincipalCallback(Callback[] callbacks) {
if (callbacks != null) {
for (Callback callback : callbacks) {
if (callback instanceof CallerPrincipalCallback) {
return true;
}
}
}
return false;
}
private void processResults(Callback[] mappedCallbacks, boolean hasCallerPrincipalCallback) {
if (mappedCallbacks != null) {
Subject subject = new Subject();
// Handle Single Principal as the caller identity
if (!hasCallerPrincipalCallback) {
Set<Principal> principals = executionSubject.getPrincipals();
if (principals != null && principals.size() == 1) {
// Process if there is only one principal
for (Principal principal : principals) {
Principal mappedPrincipal = null;
if (needMapping) {
mappedPrincipal = getMappedPrincipal(principal, null);
} else {
mappedPrincipal = principal;
}
if (mappedPrincipal != null) {
subject.getPrincipals().add(mappedPrincipal);
}
}
subject.getPublicCredentials().addAll(executionSubject.getPublicCredentials());
subject.getPrivateCredentials().addAll(executionSubject.getPrivateCredentials());
}
}
// TODO V3 what happens for Public/Private Credentials of Mapped case (Case II)
for (Callback callback : mappedCallbacks) {
if (callback instanceof CallerPrincipalCallback) {
CallerPrincipalCallback callerPrincipalCallback = (CallerPrincipalCallback) callback;
Caller caller = getCaller(callerPrincipalCallback.getSubject());
if (caller != null) {
Principal glassFishCallerPrincipal = getGlassFishCallerPrincipal(caller);
subject.getPrincipals().add(glassFishCallerPrincipal);
for (String group : caller.getGroups()) {
subject.getPrincipals().add(new Group(group));
}
}
copySubject(subject, callerPrincipalCallback.getSubject());
} else if (callback instanceof GroupPrincipalCallback) {
GroupPrincipalCallback groupPrincipalCallback = (GroupPrincipalCallback) callback;
copySubject(subject, groupPrincipalCallback.getSubject());
} else if (callback instanceof PasswordValidationCallback) {
PasswordValidationCallback passwordValidationCallback = (PasswordValidationCallback) callback;
copySubject(subject, passwordValidationCallback.getSubject());
}
}
SecurityContext.setCurrent(new SecurityContext(subject));
}
}
private Caller getCaller(Subject subject) {
Set<Caller> callers = subject.getPrincipals(Caller.class);
if (callers.isEmpty()) {
return null;
}
return callers.iterator().next();
}
private Principal getGlassFishCallerPrincipal(Caller caller) {
Principal callerPrincipal = caller.getCallerPrincipal();
// Check custom principal
if (callerPrincipal instanceof CallerPrincipal == false) {
return callerPrincipal;
}
// Check anonymous principal
if (callerPrincipal.getName() == null) {
return SecurityContext.getDefaultCallerPrincipal();
}
return new UserNameAndPassword(callerPrincipal.getName());
}
private void copySubject(Subject target, Subject source) {
target.getPrincipals().addAll(source.getPrincipals());
target.getPublicCredentials().addAll(source.getPublicCredentials());
target.getPrivateCredentials().addAll(source.getPrivateCredentials());
}
private Callback handleSupportedCallback(Callback callback) throws UnsupportedCallbackException {
// TODO V3 need to merge the principals/maps after calling all the callbacks and then TODO V3 set the security context ?
if (callback instanceof CallerPrincipalCallback) {
return handleCallerPrincipalCallbackWithMapping((CallerPrincipalCallback) callback);
}
if (callback instanceof GroupPrincipalCallback) {
return handleGroupPrincipalCallbackWithMapping((GroupPrincipalCallback) callback);
}
throw new UnsupportedCallbackException(callback);
}
private Callback handleCallerPrincipalCallbackWithMapping(CallerPrincipalCallback callerPrincipalCallback) {
return new CallerPrincipalCallback(
callerPrincipalCallback.getSubject(),
getMappedPrincipal(
callerPrincipalCallback.getPrincipal(),
callerPrincipalCallback.getName()));
}
private Callback handleGroupPrincipalCallbackWithMapping(GroupPrincipalCallback groupPrincipalCallback) {
String[] groups = groupPrincipalCallback.getGroups();
List<String> asGroupNames = new ArrayList<>();
for (String groupName : groups) {
Group mappedGroup = (Group) securityMap.get(new Group(groupName));
if (mappedGroup != null) {
if (logger.isLoggable(FINEST)) {
logger.finest("got mapped group as [" + groupName + "] for eis-group [" + mappedGroup.getName() + "]");
}
asGroupNames.add(mappedGroup.getName());
}
}
String[] asGroupsString = new String[asGroupNames.size()];
for (int i = 0; i < asGroupNames.size(); i++) {
asGroupsString[i] = asGroupNames.get(i);
}
return new GroupPrincipalCallback(groupPrincipalCallback.getSubject(), asGroupsString);
}
private Principal getMappedPrincipal(Principal eisPrincipal, String eisName) {
final Principal asPrincipal;
if (eisPrincipal != null) {
asPrincipal = securityMap.get(eisPrincipal);
if (logger.isLoggable(FINEST)) {
logger.finest("got mapped principal as [" + asPrincipal + "] for eis-group [" + eisPrincipal.getName() + "]");
}
} else if (eisName != null) {
asPrincipal = securityMap.get(new UserNameAndPassword(eisName));
if (logger.isLoggable(FINEST)) {
logger.finest("got mapped principal as [" + asPrincipal + "] for eis-group [" + eisName + "]");
}
} else {
asPrincipal = null;
}
return asPrincipal;
}
}