Merge pull request #47 from edx/cdyer/multijail

Restructure codejail to allow more flexible jailing

Author: Cliff Dyer

AUTHORS

@@ -6,3 +6,4 @@ James Tauber <[email protected]>
 Piotr Mitros <[email protected]>
 Feanil Patel <[email protected]>
 Dave St.Germain <[email protected]>
+Cliff Dyer <[email protected]>

NOTICE.txt

@@ -1,6 +1,6 @@
 CodeJail
 
-Copyright 2013-2015, edX
+Copyright 2013-2016, edX
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this work except in compliance with the License.

README.rst

@@ -61,10 +61,7 @@ To secure Python execution, you'll be creating a new virtualenv.  This means
 you'll have two: the main virtualenv for your project, and the new one for
 sandboxed Python code.
 
-Choose a place for the new virtualenv, call it **<SANDENV>**.  It will be
-automatically detected and used if you put it right alongside your existing
-virtualenv, but with `-sandbox` appended.  So if your existing virtualenv is in
-`/home/chris/ve/myproj`, make **<SANDENV>** be `/home/chris/ve/myproj-sandbox`.
+Choose a place for the new virtualenv, call it **<SANDENV>**.  
 
 The user running the LMS is **<SANDBOX_CALLER>**, for example, you on
 your dev machine, or `www-data` on a server.

codejail/__init__.py

@@ -0,0 +1,21 @@
+"""
+Primary codejail exports.
+
+    import codejail
+    codejail.configure('python78', '/path/to/python3', user='root', lang=codejail.python3)
+    try:
+        jail = codejail.get_codejail('python78')
+    except JailError:
+        raise
+    try:
+        jail.safe_exec("print('foo')", {'print': print}, slug='hotcode')
+    except codejail.CodeJailException:
+        # raises a JailError if the jail can't handle safe_exec.
+        # raises a SafeExecException if the code fails.
+        raise
+    jail.jail_code("print('foo')", slug='hotcode')
+"""
+
+from .exceptions import CodeJailException, JailError, SafeExecException
+from .jail import configure, is_configured, get_codejail
+from .languages import python2, python3, other

codejail/django_integration.py

@@ -7,7 +7,7 @@
 from django.core.exceptions import MiddlewareNotUsed
 from django.conf import settings
 
-import codejail.jail_code
+import codejail.limits
 
 
 class ConfigureCodeJailMiddleware(object):
@@ -27,6 +27,6 @@ def __init__(self):
 
         limits = settings.CODE_JAIL.get('limits', {})
         for name, value in limits.items():
-            codejail.jail_code.set_limit(name, value)
+            codejail.limits.set_limit(name, value)
 
         raise MiddlewareNotUsed

codejail/exceptions.py

@@ -0,0 +1,28 @@
+"""
+Codejail exceptions.
+"""
+
+
+class CodeJailException(Exception):
+    """
+    Top of the hierarchy of codejail exceptions
+    """
+    pass
+
+
+class JailError(CodeJailException):
+    """
+    There was a problem configuring a codejail or accessing a configured codejail.
+    """
+    pass
+
+
+class SafeExecException(CodeJailException):
+    """
+    Python code running in the sandbox has failed.
+
+    The message will be the stdout of the sandboxed process, which will usually
+    contain the original exception message.
+
+    """
+    pass