/
NashornSandbox.java
320 lines (287 loc) · 9.83 KB
/
NashornSandbox.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
package delight.nashornsandbox;
import delight.nashornsandbox.exceptions.ScriptCPUAbuseException;
import javax.script.Bindings;
import javax.script.CompiledScript;
import javax.script.Invocable;
import javax.script.ScriptContext;
import javax.script.ScriptException;
import java.io.StringWriter;
import java.io.Writer;
import java.util.concurrent.ExecutorService;
/**
* The Nashorn sandbox interface.
*
* <p>Created on 2015-08-06</p>
*
* @author <a href="mailto:mxro@nowhere.com">mxro</a>
* @author <a href="mailto:dev@youness.org">Youness SAHOUANE</a>
* @author <a href="mailto:eduveks@gmail.com">Eduardo Velasques</a>
* @author <a href="mailto:philip.borgstrom@gmail.com">philipborg</a>
* @author <a href="mailto:marcin.golebski@verbis.pl">Marcin Golebski</a>
* @version $Id$
*/
public interface NashornSandbox {
/**
* Add a new class to the list of allowed classes.
*/
void allow(Class<?> clazz);
/**
* Remove a class from the list of allowed classes.
*/
void disallow(Class<?> clazz);
/**
* Check if a class is in the list of allowed classes.
*/
boolean isAllowed(Class<?> clazz);
/**
* Remove all classes from the list of allowed classes.
*/
void disallowAllClasses();
/**
* Will add a global variable available to all scripts executed with this sandbox.
*
* @param variableName the name of the variable
* @param object the value, can be <code>null</code>
*/
void inject(String variableName, Object object);
/**
* Sets the maximum CPU time in milliseconds allowed for script execution.
* <p>
* Note, {@link ExecutorService} should be also set when time is set greater
* than 0.
* </p>
*
* @param limit time limit in milliseconds
* @see #setExecutor(ExecutorService)
*/
void setMaxCPUTime(long limit);
/**
* <p>
* Sets the maximum memory in Bytes which JS executor thread can allocate.
* </p>
* <p>
* Note, thread memory usage is only approximation.
* </p>
* <p>
* Note, {@link ExecutorService} should be also set when memory limit is set
* greater than 0. Nashorn takes some memory at start, be generous and give
* at least 1MB. If bindings are used, Nashorn allocates additional memory
* for the bindings which might be a multiple of the memory theoretically
* required by the data types used. For details, see <a href='https://github.com/javadelight/delight-nashorn-sandbox/issues/86'>issue 86</a>.
* </p>
* <p>
* Current implementation of this limit works only on Sun/Oracle JVM.
* </p>
*
* @param limit limit in bytes
* @see com.sun.management.ThreadMXBean#getThreadAllocatedBytes(long)
*/
void setMaxMemory(long limit);
/**
* Sets the writer, when want to have output from writer function called in
* JS script
*
* @param writer the writer, eg. {@link StringWriter}
*/
void setWriter(Writer writer);
/**
* Specifies the executor service which is used to run scripts when a CPU time
* limit is specified.
*
* @param executor the executor service
* @see #setMaxCPUTime(long)
*/
void setExecutor(ExecutorService executor);
/**
* Gets the current executor service.
*
* @return current executor service
*/
ExecutorService getExecutor();
/**
* Evaluates the JavaScript string.
*
* @param js the JavaScript script to be evaluated
* @throws ScriptCPUAbuseException when execution time exceeded (when greater
* than 0 is set
* @throws ScriptException when script syntax error occurs
* @see #setMaxCPUTime(long)
*/
Object eval(String js) throws ScriptCPUAbuseException, ScriptException;
/**
* Evaluates the JavaScript string.
*
* @param js the JavaScript script to be evaluated
* @param bindings the Bindings to use for evaluation
* @throws ScriptCPUAbuseException when execution time exceeded (when greater
* than 0 is set
* @throws ScriptException when script syntax error occurs
* @see #setMaxCPUTime(long)
*/
Object eval(String js, Bindings bindings) throws ScriptCPUAbuseException, ScriptException;
/**
* Evaluates the JavaScript string for a given script context
*
* @param js the JavaScript script to be evaluated
* @param scriptContext the ScriptContext exposing sets of attributes in different scopes.
* @throws ScriptCPUAbuseException when execution time exceeded (when greater
* than 0 is set
* @throws ScriptException when script syntax error occurs
* @see #setMaxCPUTime(long)
*/
Object eval(String js, SandboxScriptContext scriptContext) throws ScriptCPUAbuseException, ScriptException;
/**
* Evaluates the JavaScript string for a given script context
*
* @param js the JavaScript script to be evaluated
* @param bindings the Bindings to use for evaluation
* @param scriptContext the ScriptContext exposing sets of attributes in different scopes.
* @throws ScriptCPUAbuseException when execution time exceeded (when greater
* than 0 is set
* @throws ScriptException when script syntax error occurs
* @see #setMaxCPUTime(long)
*/
Object eval(String js, SandboxScriptContext scriptContext,Bindings bindings) throws ScriptCPUAbuseException, ScriptException;
/**
* Obtains the value of the specified JavaScript variable.
*/
Object get(String variableName);
/**
* Allow Nashorn print and echo functions.
* <p>
* Only before first {@link #eval(String)} call cause effect.
* </p>
*/
void allowPrintFunctions(boolean v);
/**
* Allow Nashorn readLine and readFully functions.
* <p>
* Only before first {@link #eval(String)} call cause effect.
* </p>
*/
void allowReadFunctions(boolean v);
/**
* Allow Nashorn load and loadWithNewGlobal functions.
* <p>
* Only before first {@link #eval(String)} call cause effect.
* </p>
*/
void allowLoadFunctions(boolean v);
/**
* Allow Nashorn quit and exit functions.
* <p>
* Only before first {@link #eval(String)} call cause effect.
* </p>
*/
void allowExitFunctions(boolean v);
/**
* Allow Nashorn globals object $ARG, $ENV, $EXEC, $OPTIONS, $OUT, $ERR and $EXIT.
* <p>
* Only before first {@link #eval(String)} call cause effect.
* </p>
*/
void allowGlobalsObjects(boolean v);
/**
* Force, to check if all blocks are enclosed with curly braces "{}".
* <p>
* <b>Warning</b> This option is useful to identify potential abuse but is
* also prone to identify false positives. Please use with caution. Alternatively
* you can use <code>setMaxCPUTime</code> to prevent abusive script execution.
* </p>
* <p>
* Explanation: all loops (for, do-while, while, and if-else, and functions
* should use braces, because poison_pill() function will be inserted after
* each open brace "{", to ensure interruption checking. Otherwise simple
* code like:
* <pre>
* while(true) while(true) {
* // do nothing
* }
* </pre>
* or even:
* <pre>
* while(true)
* </pre>
* cause unbreakable loop, which force this sandbox to use {@link Thread#stop()}
* which make JVM unstable.
* </p>
* <p>
* Properly written code (even in bad intention) like:
* <pre>
* while(true) { while(true) {
* // do nothing
* }}
* </pre>
* will be changed into:
* <pre>
* while(true) {poison_pill();
* while(true) {poison_pill();
* // do nothing
* }
* }
* </pre>
* which finish nicely when interrupted.
* <p>
* For legacy code, this check can be turned off, but with no guarantee, the
* JS thread will gracefully finish when interrupted.
* </p>
*
* @param v <code>true</code> when sandbox should check if all required braces
* are placed into JS code, <code>false</code> when no check should be
* performed
*/
void allowNoBraces(boolean v);
/**
* The size of prepared statements LRU cache. Default 0 (disabled).
* <p>
* Each statements when {@link #setMaxCPUTime(long)} is set is prepared to
* quit itself when time exceeded. To execute only once this procedure per
* statement set this value.
* </p>
* <p>
* When {@link #setMaxCPUTime(long)} is set 0, this value is ignored.
* </p>
*
* @param max the maximum number of statements in the LRU cache
*/
void setMaxPreparedStatements(int max);
/**
* Create new bindings used to replace the state of the current script engine
* <p>
* This can be typically used to override ECMAScript "global" properties
* </p>
*
* @return
*/
Bindings createBindings();
/**
* Returns an {@link Invocable} instance, so that method invocations are also sandboxed.
* @return
*/
Invocable getSandboxedInvocable();
/**
* Overwrites the cache for pre-processed javascript. Must be called before the first invocation of {@link #eval(String)}
* and its overloads.
* @param cache the new cache to use
*/
void setScriptCache(SecuredJsCache cache);
/**
* Compile the JavaScript string
*
* @param js the JavaScript script to be compiled
* @return a CompiledScript object
* @throws ScriptException
*/
CompiledScript compile(final String js) throws ScriptException;
/**
* Run a pre-compiled JavaScript
*/
Object eval(CompiledScript compiledScript) throws ScriptCPUAbuseException, ScriptException;
Object eval(CompiledScript compiledScript, Bindings bindings) throws ScriptCPUAbuseException, ScriptException;
Object eval(CompiledScript compiledScript, ScriptContext scriptContext) throws ScriptCPUAbuseException, ScriptException;
Object eval(CompiledScript compiledScript, ScriptContext scriptContext, Bindings bindings) throws ScriptCPUAbuseException, ScriptException;
/**
* Create a new secured script context
*/
SandboxScriptContext createScriptContext();
}