Package org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists

Class StaticWhitelist

java.lang.Object

org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist

org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist

org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.StaticWhitelist

All Implemented Interfaces:

ExtensionPoint

public final class StaticWhitelist
extends EnumeratingWhitelist

Whitelist based on a static file.

Nested Class Summary

Nested classes/interfaces inherited from class org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist

EnumeratingWhitelist.FieldSignature, EnumeratingWhitelist.MethodSignature, EnumeratingWhitelist.NewSignature, EnumeratingWhitelist.Signature

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
StaticWhitelist(Reader definition)
StaticWhitelist(String... lines)
StaticWhitelist(Collection<? extends String> lines)

Method Summary

Modifier and Type	Method	Description
protected List<EnumeratingWhitelist.FieldSignature>	fieldSignatures()
static StaticWhitelist	from(URL definition)
static boolean	isBlacklisted(String signature)
static boolean	isPermanentlyBlacklisted(String signature)	Checks if the signature is permanently blacklisted, and so shouldn't show up in the pending approval list.
static boolean	isPermanentlyBlacklistedConstructor(Constructor c)	Returns true if the given constructor is permanently blacklisted in PERMANENTLY_BLACKLISTED_CONSTRUCTORS
static boolean	isPermanentlyBlacklistedMethod(Method m)	Returns true if the given method is permanently blacklisted in PERMANENTLY_BLACKLISTED_METHODS
static boolean	isPermanentlyBlacklistedStaticMethod(Method m)	Returns true if the given method is permanently blacklisted in PERMANENTLY_BLACKLISTED_STATIC_METHODS
protected List<EnumeratingWhitelist.MethodSignature>	methodSignatures()
protected List<EnumeratingWhitelist.NewSignature>	newSignatures()
static EnumeratingWhitelist.Signature	parse(String line)	Parse a signature line into a EnumeratingWhitelist.Signature.
static RejectedAccessException	rejectField(Field f)
static RejectedAccessException	rejectMethod(Method m)
static RejectedAccessException	rejectMethod(Method m, String info)
static RejectedAccessException	rejectNew(Constructor<?> c)
static RejectedAccessException	rejectStaticField(Field f)
static RejectedAccessException	rejectStaticMethod(Method m)
protected List<EnumeratingWhitelist.FieldSignature>	staticFieldSignatures()
protected List<EnumeratingWhitelist.MethodSignature>	staticMethodSignatures()

Methods inherited from class org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.EnumeratingWhitelist

getName, getName, permitsConstructor, permitsFieldGet, permitsFieldSet, permitsMethod, permitsStaticFieldGet, permitsStaticFieldSet, permitsStaticMethod

Methods inherited from class org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist

all

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticWhitelist

public StaticWhitelist(Reader definition)
                throws IOException

Throws:

IOException

StaticWhitelist

public StaticWhitelist(Collection<? extends String> lines)
                throws IOException

Throws:

IOException

StaticWhitelist

public StaticWhitelist(String... lines)
                throws IOException

Throws:

IOException

Method Detail

isPermanentlyBlacklistedMethod

public static boolean isPermanentlyBlacklistedMethod(@NonNull
                                                     Method m)

Returns true if the given method is permanently blacklisted in PERMANENTLY_BLACKLISTED_METHODS

isPermanentlyBlacklistedStaticMethod

public static boolean isPermanentlyBlacklistedStaticMethod(@NonNull
                                                           Method m)

Returns true if the given method is permanently blacklisted in PERMANENTLY_BLACKLISTED_STATIC_METHODS

isPermanentlyBlacklistedConstructor

public static boolean isPermanentlyBlacklistedConstructor(@NonNull
                                                          Constructor c)

Returns true if the given constructor is permanently blacklisted in PERMANENTLY_BLACKLISTED_CONSTRUCTORS

parse

public static EnumeratingWhitelist.Signature parse(@NonNull
                                                   String line)
                                            throws IOException

Parse a signature line into a EnumeratingWhitelist.Signature.

Parameters:

line - The signature string

Returns:

the equivalent EnumeratingWhitelist.Signature

Throws:

IOException - if the signature string could not be parsed.

isPermanentlyBlacklisted

public static boolean isPermanentlyBlacklisted(String signature)

Checks if the signature is permanently blacklisted, and so shouldn't show up in the pending approval list.

Parameters:

signature - the signature to check

Returns:

true if the signature is permanently blacklisted, false otherwise.

from

public static StaticWhitelist from(URL definition)
                            throws IOException

Throws:

IOException

methodSignatures

protected List<EnumeratingWhitelist.MethodSignature> methodSignatures()

Specified by:

methodSignatures in class EnumeratingWhitelist

newSignatures

protected List<EnumeratingWhitelist.NewSignature> newSignatures()

Specified by:

newSignatures in class EnumeratingWhitelist

staticMethodSignatures

protected List<EnumeratingWhitelist.MethodSignature> staticMethodSignatures()

Specified by:

staticMethodSignatures in class EnumeratingWhitelist

fieldSignatures

protected List<EnumeratingWhitelist.FieldSignature> fieldSignatures()

Specified by:

fieldSignatures in class EnumeratingWhitelist

staticFieldSignatures

protected List<EnumeratingWhitelist.FieldSignature> staticFieldSignatures()

Specified by:

staticFieldSignatures in class EnumeratingWhitelist

rejectMethod

public static RejectedAccessException rejectMethod(@NonNull
                                                   Method m)

rejectMethod

public static RejectedAccessException rejectMethod(@NonNull
                                                   Method m,
                                                   String info)

rejectNew

public static RejectedAccessException rejectNew(@NonNull
                                                Constructor<?> c)

rejectStaticMethod

public static RejectedAccessException rejectStaticMethod(@NonNull
                                                         Method m)

rejectField

public static RejectedAccessException rejectField(@NonNull
                                                  Field f)

rejectStaticField

public static RejectedAccessException rejectStaticField(@NonNull
                                                        Field f)

isBlacklisted

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static boolean isBlacklisted(String signature)