org.jenkinsci.plugins.scriptsecurity.sandbox.groovy

Class GroovySandbox

java.lang.Object

org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.GroovySandbox

public class GroovySandbox
extends Object

Allows Groovy scripts (including Groovy Templates) to be run inside a sandbox.

Method Summary

Methods

Modifier and Type	Method and Description
static org.codehaus.groovy.control.CompilerConfiguration	createSecureCompilerConfiguration() Prepares a compiler configuration the sandbox.
static void	runInSandbox(Runnable r, Whitelist whitelist) Runs a block such as GroovyShell.evaluate(String) in the sandbox.
static void	runInSandbox(groovy.lang.Script script, Whitelist whitelist) Runs a script in the sandbox.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createSecureCompilerConfiguration

@Nonnull
public static org.codehaus.groovy.control.CompilerConfiguration createSecureCompilerConfiguration()

Prepares a compiler configuration the sandbox.

Returns:

a compiler configuration set up to use the sandbox

runInSandbox

public static void runInSandbox(@Nonnull
                Runnable r,
                @Nonnull
                Whitelist whitelist)
                         throws RejectedAccessException

Runs a block such as GroovyShell.evaluate(String) in the sandbox. You must have used createSecureCompilerConfiguration() to prepare the Groovy shell.

Parameters:

r - a block of code during whose execution all calls are intercepted

whitelist - the whitelist to use, such as Whitelist.all()

Throws:

RejectedAccessException - in case an attempted call was not whitelisted

runInSandbox

public static void runInSandbox(@Nonnull
                groovy.lang.Script script,
                @Nonnull
                Whitelist whitelist)
                         throws RejectedAccessException

Runs a script in the sandbox. You must have used createSecureCompilerConfiguration() to prepare the Groovy shell.

Parameters:

script - a script ready to Script.run()

whitelist - the whitelist to use, such as Whitelist.all()

Throws:

RejectedAccessException - in case an attempted call was not whitelisted