org.forgerock.openam.scripting.sandbox

Class RhinoSandboxClassShutter

java.lang.Object

org.forgerock.openam.scripting.sandbox.RhinoSandboxClassShutter

All Implemented Interfaces:

org.mozilla.javascript.ClassShutter

public final class RhinoSandboxClassShutter
extends Object
implements org.mozilla.javascript.ClassShutter

Rhino class-shutter implementation that provides sandboxing via class white- and black-listing. Each class that is loaded or accessed by a script must match at least one pattern in the white-list and no patterns in the black-list to be allowed, otherwise it is forbidden. If a security manager is specified then each class must additionally be approved by a call to SecurityManager.checkPackageAccess(String).

Constructor Summary

Constructors

Constructor and Description
RhinoSandboxClassShutter(SecurityManager securityManager, List<Pattern> whiteList, List<Pattern> blackList) Constructs the sandboxed class-shutter with the given configuration options.

Method Summary

Modifier and Type	Method and Description
boolean	visibleToScripts(String fullClassName) This implementation first checks whether the class/package is allowed by the configured security manager (if one is set).

Methods inherited from class java.lang.Object

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

Constructor Detail

RhinoSandboxClassShutter

public RhinoSandboxClassShutter(SecurityManager securityManager,
                                List<Pattern> whiteList,
                                List<Pattern> blackList)

Constructs the sandboxed class-shutter with the given configuration options.

Parameters:

securityManager - the security manager to use for package access checks. May be null to disable.

whiteList - the class-name white-list. May not be null.

blackList - the class-name black-list. May not be null.

Method Detail

visibleToScripts

public boolean visibleToScripts(String fullClassName)

This implementation first checks whether the class/package is allowed by the configured security manager (if one is set). Then it checks that the class name matches at least one white-list pattern. Finally, it checks that the class name does not match any of the black-list patterns. Only if all three checks pass is the class made visible to the script, otherwise it is denied.

Specified by:

visibleToScripts in interface org.mozilla.javascript.ClassShutter