sandbox-runtime

An implementation of a sandboxed environment for running untrusted code with limited security permissions. Additionally, it shows how custom permissions can be implemented that provided finer grained security that the standard permissions available in Java.

Credit for many of the ideas for running sandboxed code goes to Will Sargent's Sandbox Experiment in Scala.

Building and Running

To build the project run:

mvn package

To execute the examples run:

java -jar simple-runtime-bootstrap/target/simple-runtime-bootstrap-1.0-SNAPSHOT.jar

The Sandbox

The sandbox works by using the Java SecurityManager along with a custom ClassLoader and Policy. The policy determines the permissions of the running code by the associated code source or class loader for each class. One caveat to this is that code that is to run with limited permissions must be loaded from a separate jar at runtime.

The permissions for sandboxed code is determined by the RuntimePolicy class and the UserClassLoader. The UserClassLoader explains how dynamic permissions could be given to different sandboxed jars.

Fine-grained Permissions

One of the problems with using the SecurityManager is that some of the permissions provided by Java are somewhat broader than you would want. For instance, many libraries require reflection, but there are only 2 permissions around reflection.

• ReflectPermission("suppressAccessChecks")
• ReflectPermission("newProxyInPackage.{package name}")

Enabling the suppressAccessChecks for sandboxed code effectively defeats the security provided by the sandbox. The sandboxed code can use this permission to access private fields and methods on all code, including Java classes and your own runtime environment classes, and disable the security manager or access methods that bypass normal security checks. By leaving this permission disabled many widely used libraries will not function in the sandbox environment.

It would be nice to be able to selectively enable the suppressAccessChecks permission; to allow it as long as the object that is being accessed (callee) and the object performing the access (caller) are from the same code source. In other words, allow the sandboxed code to perform reflections on itself, but not on the Java classes or classes of your own runtime environment.

This is possible to accomplish using byte-buddy to replace the methods of Java classes that perform the security check with a custom implementation and security permission.

For example, the suppressAccessChecks permission is checked by the AccessibleObject class in the setAccessible method. By replacing this method we can check the class loader instance of the callee and the caller, and if they match perform a security check using a custom permission UserSetAccessiblePermission. If the callee and caller do not match, then instead if checks the standard suppressAccessChecks permission.

Example Runners

There are several example runners in the simple-runtime-examples module. The AllowedRunner and DeniedRunner are enabled by default in the Bootstrap Main class. The NeverEndingRunner and IterativeNeverEndingRunner can be enabled by uncommented their corresponding lines in the main class.

• AllowedRunner

  This is an example of a runner that is using reflection to access a private method of another class in the same protection domain (Foo). This runner will succeed in it's execution.

• DeniedRunner This is an example of a runner that is trying to use reflection on a Java class (String). A SecurityException will be through when it attempts to make the private field accessible.

• NeverEndingRunner This is an example of a runner that tries to keep running indefinitely. This is to show that even though permissions can be used to lock down what untrusted code has access to, there isn't a way to force untrusted code to stop once it has started. This class catches ThreadDeath exceptions recursively and while it does avoid exiting due to the ThreadDeath exceptions, it will eventually have a stack overflow and exit due to that.

• IterativeNeverEndingRunner This example, like the DeniedRunner above is to show that permissions are not helpful in stopping runaway code that does not want to finish or exit. This example uses as iterative approach with a recursive try/catch around that in case the iterative ThreadDeatch catch is exited (which it usually does in 60-1400 calls to Thread.stop). Due to the additional recursion, this may also eventually have a stack overflow. In my experience it is somewhat sporadic, sometimes successfully being stopped and others completely locking up the JVM around 14,000 to 20,000 calls to Thread.stop.

Shortcomings of the SecurityManager

While the SecurityManager can definitely be used for running untrusted scope with limited access to system resources (File system, Network, etc) and to other parts of the running application, it still has many shortcomings.

As seen from the examples above, once untrusted code begins executing there is no guarantee that it will finish. If untrusted code is called on the same thread as your own code, the method may never return. If, on the other hand, the untrusted code is run on a separate thread, there is no guarantee that the thread will reach a TERMINATED state. Even using the unrecommended and deprecated Thread.stop method does not guarantee the thread will exit.

Another potential problem that the SecurityManager can't protect against is runaway allocations. The untrusted code has no limitations on the amount of objects it can allocated. This means it can crash the JVM with an OutOfMemoryError. I haven't provided an example of this, but it should be trivial to create.

As far as I know there isn't a good workaround or alternative to avoid runaway threads. For the allocation problem, however, it may be possible to avoid this by using a library like allocation-instrumenter. Through use of a library like this allocations per untrusted user could be tracked and limits could be put in place.

License

Copyright 2016 John Leacox

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.