Package org.jenkinsci.plugins.scriptsecurity.sandbox

Class Whitelist

java.lang.Object

org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist

Direct Known Subclasses:

ClassLoaderWhitelist, EnumeratingWhitelist, PermitAllWhitelist

public abstract class Whitelist
extends Object

Determines which methods and similar members which scripts may call.

Constructor Summary

Constructors

Constructor	Description
Whitelist()

Method Summary

Modifier and Type	Method	Description
boolean	isAllowedGetEnvSystemMethod(Method m, Object[] args)	Return true if the given method is allowed System.getEnv()
abstract boolean	permitsConstructor(Constructor<?> constructor, Object[] args)
abstract boolean	permitsFieldGet(Field field, Object receiver)
abstract boolean	permitsFieldSet(Field field, Object receiver, Object value)
abstract boolean	permitsMethod(Method method, Object receiver, Object[] args)	Checks whether a given virtual method may be invoked.
abstract boolean	permitsStaticFieldGet(Field field)
abstract boolean	permitsStaticFieldSet(Field field, Object value)
abstract boolean	permitsStaticMethod(Method method, Object[] args)
void	setGetEnvWhitelistRegex(List<String> getEnvWhitelistRegex)	Set a list of regex of environment variables name that is allowed to be called

Methods inherited from class java.lang.Object

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

Constructor Details

Whitelist

public Whitelist()

Method Details

setGetEnvWhitelistRegex

public void setGetEnvWhitelistRegex(List<String> getEnvWhitelistRegex)

Set a list of regex of environment variables name that is allowed to be called

Parameters:

getEnvWhitelistRegex - the regex list

isAllowedGetEnvSystemMethod

public boolean isAllowedGetEnvSystemMethod(@Nonnull
 Method m,
 @Nonnull
 Object[] args)

Return true if the given method is allowed System.getEnv()

Parameters:

m - the method

args - the method arguments

Returns:

true if allowed, false otherwise

permitsMethod

public abstract boolean permitsMethod(@Nonnull
 Method method,
 @Nonnull
 Object receiver,
 @Nonnull
 Object[] args)

Checks whether a given virtual method may be invoked.

Note that method should not be implementing or overriding a method in a supertype; in such a case the caller must pass that supertype method instead. In other words, call site selection is the responsibility of the caller (such as GroovySandbox), not the whitelist.

Parameters:

method - a method defined in the JVM

receiver - this, the receiver of the method call

args - zero or more arguments

Returns:

true to allow the method to be called, false to reject it

permitsConstructor

public abstract boolean permitsConstructor(@Nonnull
 Constructor<?> constructor,
 @Nonnull
 Object[] args)

permitsStaticMethod

public abstract boolean permitsStaticMethod(@Nonnull
 Method method,
 @Nonnull
 Object[] args)

permitsFieldGet

public abstract boolean permitsFieldGet(@Nonnull
 Field field,
 @Nonnull
 Object receiver)

permitsFieldSet

public abstract boolean permitsFieldSet(@Nonnull
 Field field,
 @Nonnull
 Object receiver,
 @CheckForNull
 Object value)

permitsStaticFieldGet

public abstract boolean permitsStaticFieldGet(@Nonnull
 Field field)

permitsStaticFieldSet

public abstract boolean permitsStaticFieldSet(@Nonnull
 Field field,
 @CheckForNull
 Object value)