-
Notifications
You must be signed in to change notification settings - Fork 164
/
SandboxInterceptor.java
476 lines (451 loc) · 23.2 KB
/
SandboxInterceptor.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
/*
* The MIT License
*
* Copyright 2014 CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.jenkinsci.plugins.scriptsecurity.sandbox.groovy;
import groovy.lang.GroovyRuntimeException;
import groovy.lang.MetaMethod;
import groovy.lang.MissingMethodException;
import groovy.lang.MissingPropertyException;
import groovy.lang.Script;
import hudson.Functions;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import org.codehaus.groovy.runtime.DateGroovyMethods;
import org.codehaus.groovy.runtime.DefaultGroovyMethods;
import org.codehaus.groovy.runtime.EncodingGroovyMethods;
import org.codehaus.groovy.runtime.ProcessGroovyMethods;
import org.codehaus.groovy.runtime.SqlGroovyMethods;
import org.codehaus.groovy.runtime.SwingGroovyMethods;
import org.codehaus.groovy.runtime.XmlGroovyMethods;
import org.codehaus.groovy.runtime.metaclass.ClosureMetaMethod;
import org.codehaus.groovy.tools.DgmConverter;
import org.jenkinsci.plugins.scriptsecurity.sandbox.RejectedAccessException;
import org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist;
import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist;
import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.StaticWhitelist;
import org.kohsuke.groovy.sandbox.GroovyInterceptor;
@SuppressWarnings("rawtypes")
final class SandboxInterceptor extends GroovyInterceptor {
private static final Logger LOGGER = Logger.getLogger(SandboxInterceptor.class.getName());
private final Whitelist whitelist;
SandboxInterceptor(Whitelist whitelist) {
this.whitelist = whitelist;
}
/** should be synchronized with {@link DgmConverter} */
private static final Class<?>[] DGM_CLASSES = {
DefaultGroovyMethods.class,
SwingGroovyMethods.class,
SqlGroovyMethods.class,
XmlGroovyMethods.class,
EncodingGroovyMethods.class,
DateGroovyMethods.class,
ProcessGroovyMethods.class,
};
@Override public Object onMethodCall(GroovyInterceptor.Invoker invoker, Object receiver, String method, Object... args) throws Throwable {
Method m = GroovyCallSiteSelector.method(receiver, method, args);
if (m == null) {
if (receiver instanceof Number || (receiver instanceof String && method.equals("plus"))) {
// Synthetic methods like Integer.plus(Integer).
return super.onMethodCall(invoker, receiver, method, args);
}
// look for GDK methods
Object[] selfArgs = new Object[args.length + 1];
selfArgs[0] = receiver;
System.arraycopy(args, 0, selfArgs, 1, args.length);
for (Class<?> dgmClass : DGM_CLASSES) {
Method dgmMethod = GroovyCallSiteSelector.staticMethod(dgmClass, method, selfArgs);
if (dgmMethod != null) {
if (whitelist.permitsStaticMethod(dgmMethod, selfArgs)) {
return super.onMethodCall(invoker, receiver, method, args);
} else {
throw StaticWhitelist.rejectStaticMethod(dgmMethod);
}
}
}
// if no matching method, look for catchAll "invokeMethod"
try {
receiver.getClass().getMethod("invokeMethod", String.class, Object.class);
return onMethodCall(invoker,receiver,"invokeMethod",method,args);
} catch (NoSuchMethodException e) {
// fall through
}
MetaMethod metaMethod = findMetaMethod(receiver, method, args);
if (metaMethod instanceof ClosureMetaMethod) {
return super.onMethodCall(invoker, receiver, method, args);
}
// no such method exists
throw new MissingMethodException(method, receiver.getClass(), args);
} else if (whitelist.permitsMethod(m, receiver, args)) {
return super.onMethodCall(invoker, receiver, method, args);
} else if (method.equals("invokeMethod") && args.length == 2 && args[0] instanceof String && args[1] instanceof Object[]) {
throw StaticWhitelist.rejectMethod(m, EnumeratingWhitelist.getName(receiver.getClass()) + " " + args[0] + printArgumentTypes((Object[]) args[1]));
} else {
throw StaticWhitelist.rejectMethod(m);
}
}
@Override public Object onNewInstance(GroovyInterceptor.Invoker invoker, Class receiver, Object... args) throws Throwable {
Constructor<?> c = GroovyCallSiteSelector.constructor(receiver, args);
if (c == null) {
throw new RejectedAccessException("unclassified new " + EnumeratingWhitelist.getName(receiver) + printArgumentTypes(args));
} else if (whitelist.permitsConstructor(c, args)) {
return super.onNewInstance(invoker, receiver, args);
} else {
throw StaticWhitelist.rejectNew(c);
}
}
@Override public Object onStaticCall(GroovyInterceptor.Invoker invoker, Class receiver, String method, Object... args) throws Throwable {
Method m = GroovyCallSiteSelector.staticMethod(receiver, method, args);
if (m == null) {
// TODO consider DefaultGroovyStaticMethods
throw new RejectedAccessException("unclassified staticMethod " + EnumeratingWhitelist.getName(receiver) + " " + method + printArgumentTypes(args));
} else if (whitelist.permitsStaticMethod(m, args)) {
return super.onStaticCall(invoker, receiver, method, args);
} else {
throw StaticWhitelist.rejectStaticMethod(m);
}
}
@Override public Object onSetProperty(GroovyInterceptor.Invoker invoker, final Object receiver, final String property, Object value) throws Throwable {
if (receiver instanceof Script && !property.equals("binding") && !property.equals("metaClass")) {
return super.onSetProperty(invoker, receiver, property, value);
}
Rejector rejector = null; // avoid creating exception objects unless and until thrown
// https://github.com/kohsuke/groovy-sandbox/issues/7 need to explicitly check for getters and setters:
Object[] valueArg = new Object[] {value};
String setter = "set" + Functions.capitalize(property);
final Method setterMethod = GroovyCallSiteSelector.method(receiver, setter, valueArg);
if (setterMethod != null) {
if (whitelist.permitsMethod(setterMethod, receiver, valueArg)) {
return super.onSetProperty(invoker, receiver, property, value);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectMethod(setterMethod);
}
};
}
}
Object[] propertyValueArgs = new Object[] {property, value};
final Method setPropertyMethod = GroovyCallSiteSelector.method(receiver, "setProperty", propertyValueArgs);
if (setPropertyMethod != null) {
if (whitelist.permitsMethod(setPropertyMethod, receiver, propertyValueArgs)) {
return super.onSetProperty(invoker, receiver, property, value);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectMethod(setPropertyMethod, receiver.getClass().getName() + "." + property);
}
};
}
}
final Field instanceField = GroovyCallSiteSelector.field(receiver, property);
if (instanceField != null) {
if (whitelist.permitsFieldSet(instanceField, receiver, value)) {
return super.onSetProperty(invoker, receiver, property, value);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectField(instanceField);
}
};
}
}
if (receiver instanceof Class) {
final Method staticSetterMethod = GroovyCallSiteSelector.staticMethod((Class) receiver, setter, valueArg);
if (staticSetterMethod != null) {
if (whitelist.permitsStaticMethod(staticSetterMethod, valueArg)) {
return super.onSetProperty(invoker, receiver, property, value);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectStaticMethod(staticSetterMethod);
}
};
}
}
final Field staticField = GroovyCallSiteSelector.staticField((Class) receiver, property);
if (staticField != null) {
if (whitelist.permitsStaticFieldSet(staticField, value)) {
return super.onSetProperty(invoker, receiver, property, value);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectStaticField(staticField);
}
};
}
}
}
throw rejector != null ? rejector.reject() : unclassifiedField(receiver, property);
}
@Override public Object onGetProperty(GroovyInterceptor.Invoker invoker, final Object receiver, final String property) throws Throwable {
MissingPropertyException mpe = null;
if (receiver instanceof Script) { // SimpleTemplateEngine "out" variable, and anything else added in a binding
try {
((Script) receiver).getBinding().getVariable(property); // do not let it go to Script.super.getProperty
return super.onGetProperty(invoker, receiver, property);
} catch (MissingPropertyException x) {
mpe = x; // throw only if we are not whitelisted
}
}
if (property.equals("length") && receiver.getClass().isArray()) {
return super.onGetProperty(invoker, receiver, property);
}
Rejector rejector = null;
Object[] noArgs = new Object[] {};
String getter = "get" + Functions.capitalize(property);
final Method getterMethod = GroovyCallSiteSelector.method(receiver, getter, noArgs);
if (getterMethod != null) {
if (whitelist.permitsMethod(getterMethod, receiver, noArgs)) {
return super.onGetProperty(invoker, receiver, property);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectMethod(getterMethod);
}
};
}
}
String booleanGetter = "is" + Functions.capitalize(property);
final Method booleanGetterMethod = GroovyCallSiteSelector.method(receiver, booleanGetter, noArgs);
if (booleanGetterMethod != null && booleanGetterMethod.getReturnType() == boolean.class) {
if (whitelist.permitsMethod(booleanGetterMethod, receiver, noArgs)) {
return super.onGetProperty(invoker, receiver, property);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectMethod(booleanGetterMethod);
}
};
}
}
// look for GDK methods
Object[] selfArgs = new Object[] {receiver};
for (Class<?> dgmClass : DGM_CLASSES) {
final Method dgmGetterMethod = GroovyCallSiteSelector.staticMethod(dgmClass, getter, selfArgs);
if (dgmGetterMethod != null) {
if (whitelist.permitsStaticMethod(dgmGetterMethod, selfArgs)) {
return super.onGetProperty(invoker, receiver, property);
} else if (rejector == null) {
rejector = new Rejector() {
@Override
public RejectedAccessException reject() {
return StaticWhitelist.rejectStaticMethod(dgmGetterMethod);
}
};
}
}
final Method dgmBooleanGetterMethod = GroovyCallSiteSelector.staticMethod(dgmClass, booleanGetter, selfArgs);
if (dgmBooleanGetterMethod != null && dgmBooleanGetterMethod.getReturnType() == boolean.class) {
if (whitelist.permitsStaticMethod(dgmBooleanGetterMethod, selfArgs)) {
return super.onGetProperty(invoker, receiver, property);
} else if (rejector == null) {
rejector = new Rejector() {
@Override
public RejectedAccessException reject() {
return StaticWhitelist.rejectStaticMethod(dgmBooleanGetterMethod);
}
};
}
}
}
final Field instanceField = GroovyCallSiteSelector.field(receiver, property);
if (instanceField != null) {
if (whitelist.permitsFieldGet(instanceField, receiver)) {
return super.onGetProperty(invoker, receiver, property);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectField(instanceField);
}
};
}
}
// GroovyObject property access
Object[] propertyArg = new Object[] {property};
final Method getPropertyMethod = GroovyCallSiteSelector.method(receiver, "getProperty", propertyArg);
if (getPropertyMethod != null) {
if (whitelist.permitsMethod(getPropertyMethod, receiver, propertyArg)) {
return super.onGetProperty(invoker, receiver, property);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectMethod(getPropertyMethod, receiver.getClass().getName() + "." + property);
}
};
}
}
MetaMethod metaMethod = findMetaMethod(receiver, getter, noArgs);
if (metaMethod instanceof ClosureMetaMethod) {
return super.onGetProperty(invoker, receiver, property);
}
// TODO similar metaclass handling for isXXX, static methods (if possible?), setters
if (receiver instanceof Class) {
final Method staticGetterMethod = GroovyCallSiteSelector.staticMethod((Class) receiver, getter, noArgs);
if (staticGetterMethod != null) {
if (whitelist.permitsStaticMethod(staticGetterMethod, noArgs)) {
return super.onGetProperty(invoker, receiver, property);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectStaticMethod(staticGetterMethod);
}
};
}
}
final Method staticBooleanGetterMethod = GroovyCallSiteSelector.staticMethod((Class) receiver, booleanGetter, noArgs);
if (staticBooleanGetterMethod != null && staticBooleanGetterMethod.getReturnType() == boolean.class) {
if (whitelist.permitsStaticMethod(staticBooleanGetterMethod, noArgs)) {
return super.onGetProperty(invoker, receiver, property);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectStaticMethod(staticBooleanGetterMethod);
}
};
}
}
final Field staticField = GroovyCallSiteSelector.staticField((Class) receiver, property);
if (staticField != null) {
if (whitelist.permitsStaticFieldGet(staticField)) {
return super.onGetProperty(invoker, receiver, property);
} else if (rejector == null) {
rejector = new Rejector() {
@Override public RejectedAccessException reject() {
return StaticWhitelist.rejectStaticField(staticField);
}
};
}
}
}
if (mpe != null) {
throw mpe;
}
throw rejector != null ? rejector.reject() : unclassifiedField(receiver, property);
}
private static RejectedAccessException unclassifiedField(Object receiver, String property) {
return new RejectedAccessException("unclassified field " + EnumeratingWhitelist.getName(receiver.getClass()) + " " + property);
}
// TODO Java 8: @FunctionalInterface
private interface Rejector {
@Nonnull RejectedAccessException reject();
}
@Override public Object onGetAttribute(Invoker invoker, Object receiver, String attribute) throws Throwable {
Field field = GroovyCallSiteSelector.field(receiver, attribute);
if (field == null) {
throw unclassifiedField(receiver, attribute);
} else if (whitelist.permitsFieldGet(field, receiver)) {
return super.onGetAttribute(invoker, receiver, attribute);
} else {
throw StaticWhitelist.rejectField(field);
}
}
@Override public Object onSetAttribute(Invoker invoker, Object receiver, String attribute, Object value) throws Throwable {
Field field = GroovyCallSiteSelector.field(receiver, attribute);
if (field == null) {
throw unclassifiedField(receiver, attribute);
} else if (whitelist.permitsFieldSet(field, receiver, value)) {
return super.onSetAttribute(invoker, receiver, attribute, value);
} else {
throw StaticWhitelist.rejectField(field);
}
}
@Override public Object onGetArray(Invoker invoker, Object receiver, Object index) throws Throwable {
if (receiver.getClass().isArray() && index instanceof Integer) {
return super.onGetArray(invoker, receiver, index);
}
Object[] args = new Object[] {index};
Method method = GroovyCallSiteSelector.method(receiver, "getAt", args);
if (method != null) {
if (whitelist.permitsMethod(method, receiver, args)) {
return super.onGetArray(invoker, receiver, index);
} else {
throw StaticWhitelist.rejectMethod(method);
}
}
args = new Object[] {receiver, index};
for (Class<?> dgm : DGM_CLASSES) {
method = GroovyCallSiteSelector.staticMethod(dgm, "getAt", args);
if (method != null) {
if (whitelist.permitsStaticMethod(method, args)) {
return super.onGetArray(invoker, receiver, index);
} else {
throw StaticWhitelist.rejectStaticMethod(method);
}
}
}
throw new RejectedAccessException("unclassified getAt method " + EnumeratingWhitelist.getName(receiver) + "[" + EnumeratingWhitelist.getName(index) + "]");
}
@Override public Object onSetArray(Invoker invoker, Object receiver, Object index, Object value) throws Throwable {
if (receiver.getClass().isArray() && index instanceof Integer) {
return super.onSetArray(invoker, receiver, index, value);
}
Object[] args = new Object[] {index, value};
Method method = GroovyCallSiteSelector.method(receiver, "putAt", args);
if (method != null) {
if (whitelist.permitsMethod(method, receiver, args)) {
return super.onSetArray(invoker, receiver, index, value);
} else {
throw StaticWhitelist.rejectMethod(method);
}
}
args = new Object[] {receiver, index, value};
for (Class<?> dgm : DGM_CLASSES) {
method = GroovyCallSiteSelector.staticMethod(dgm, "putAt", args);
if (method != null) {
if (whitelist.permitsStaticMethod(method, args)) {
return super.onSetArray(invoker, receiver, index, value);
} else {
throw StaticWhitelist.rejectStaticMethod(method);
}
}
}
throw new RejectedAccessException("unclassified putAt method " + EnumeratingWhitelist.getName(receiver) + "[" + EnumeratingWhitelist.getName(index) + "]=" + EnumeratingWhitelist.getName(value));
}
private static String printArgumentTypes(Object[] args) {
StringBuilder b = new StringBuilder();
for (Object arg : args) {
b.append(' ');
b.append(EnumeratingWhitelist.getName(arg));
}
return b.toString();
}
private static @CheckForNull MetaMethod findMetaMethod(@Nonnull Object receiver, @Nonnull String method, @Nonnull Object[] args) {
Class<?>[] types = new Class[args.length];
for (int i = 0; i < types.length; i++) {
Object arg = args[i];
types[i] = arg == null ? /* is this right? */void.class : arg.getClass();
}
try {
return DefaultGroovyMethods.getMetaClass(receiver).pickMethod(method, types);
} catch (GroovyRuntimeException x) { // ambiguous call, supposedly
LOGGER.log(Level.FINE, "could not find metamethod for " + receiver.getClass() + "." + method + Arrays.toString(types), x);
return null;
}
}
}