Skip to main content

Overview

RestrictedPython provides a restricted_compile function that works like the built-in compile function, except that it allows the controlled and restricted execution of code:

>>> src = '''
... def hello_world():
...     return "Hello World!"
... '''
>>> from RestrictedPython import compile_restricted
>>> code = compile_restricted(src, '<string>', 'exec')

The resulting code can be executed using the exec built-in:

>>> exec(code)

As a result, the hello_world function is now available in the global namespace:

>>> hello_world()
'Hello World!'

Implementing a policy

RestrictedPython only provides the raw material for restricted execution. To actually enforce any restrictions, you need to supply a policy implementation by providing restricted versions of print, getattr, setattr, import, etc. These restricted implementations are hooked up by providing a set of specially named objects in the global dict that you use for execution of code. Specifically:

  1. _print_ is a callable object that returns a handler for print statements. This handler must have a write() method that accepts a single string argument, and must return a string when called. RestrictedPython.PrintCollector.PrintCollector is a suitable implementation.

  2. _write_ is a guard function taking a single argument. If the object passed to it may be written to, it should be returned, otherwise the guard function should raise an exception. _write is typically called on an object before a setattr operation.

  3. _getattr_ and _getitem_ are guard functions, each of which takes two arguments. The first is the base object to be accessed, while the second is the attribute name or item index that will be read. The guard function should return the attribute or subitem, or raise an exception.

  4. __import__ is the normal Python import hook, and should be used to control access to Python packages and modules.

  5. __builtins__ is the normal Python builtins dictionary, which should be weeded down to a set that cannot be used to get around your restrictions. A usable “safe” set is RestrictedPython.Guards.safe_builtins.

To help illustrate how this works under the covers, here’s an example function:

def f(x):
    x.foo = x.foo + x[0]
    print x
    return printed

and (sort of) how it looks after restricted compilation:

def f(x):
    # Make local variables from globals.
    _print = _print_()
    _write = _write_
    _getattr = _getattr_
    _getitem = _getitem_

    # Translation of f(x) above
    _write(x).foo = _getattr(x, 'foo') + _getitem(x, 0)
    print >>_print, x
    return _print()

Examples

print

To support the print statement in restricted code, we supply a _print_ object (note that it’s a factory, e.g. a class or a callable, from which the restricted machinery will create the object):

>>> from RestrictedPython.PrintCollector import PrintCollector
>>> _print_ = PrintCollector
>>> src = '''
... print "Hello World!"
... '''
>>> code = compile_restricted(src, '<string>', 'exec')
>>> exec(code)

As you can see, the text doesn’t appear on stdout. The print collector collects it. We can have access to the text using the printed variable, though:

>>> src = '''
... print "Hello World!"
... result = printed
... '''
>>> code = compile_restricted(src, '<string>', 'exec')
>>> exec(code)
>>> result
'Hello World!\n'

Built-ins

By supplying a different __builtins__ dictionary, we can rule out unsafe operations, such as opening files:

>>> from RestrictedPython.Guards import safe_builtins
>>> restricted_globals = dict(__builtins__ = safe_builtins)
>>> src = '''
... open('/etc/passwd')
... '''
>>> code = compile_restricted(src, '<string>', 'exec')
>>> exec(code) in restricted_globals
Traceback (most recent call last):
  ...
NameError: name 'open' is not defined

Guards

Here’s an example of a write guard that never lets restricted code modify (assign, delete an attribute or item) except dictionaries and lists:

>>> from RestrictedPython.Guards import full_write_guard
>>> _write_ = full_write_guard
>>> _getattr_ = getattr
>>> class BikeShed(object):
...     colour = 'green'
...
>>> shed = BikeShed()

Normally accessing attriutes works as expected, because we’re using the standard getattr function for the _getattr_ guard:

>>> src = '''
... print shed.colour
... result = printed
... '''
>>> code = compile_restricted(src, '<string>', 'exec')
>>> exec(code)
>>> result
'green\n'

However, changing an attribute doesn’t work:

>>> src = '''
... shed.colour = 'red'
... '''
>>> code = compile_restricted(src, '<string>', 'exec')
>>> exec(code)
Traceback (most recent call last):
  ...
TypeError: attribute-less object (assign or del)

As said, this particular write guard (full_write_guard) will allow restricted code to modify lists and dictionaries:

>>> fibonacci = [1, 1, 2, 3, 4]
>>> transl = dict(one=1, two=2, tres=3)
>>> src = '''
... # correct mistake in list
... fibonacci[-1] = 5
... # one item doesn't belong
... del transl['tres']
... '''
>>> code = compile_restricted(src, '<string>', 'exec')
>>> exec(code)
>>> fibonacci
[1, 1, 2, 3, 5]
>>> sorted(transl.keys())
['one', 'two']

Changes

3.4.2 (2007/07/28)

  • Changed homepage URL to the CheeseShop site

  • Greatly improved README.txt

3.4.1 (2007/06/23)

  • Fixed Collector/#2295 (Zope 2, PythonScripts)

3.4.0 (2007/06/04)

  • RestrictedPython now has its own release cycle as a separate egg.

  • Synchronized with RestrictedPython from Zope 2 tree.

3.2.0 (2006/01/05)

  • Corresponds to the verison of the RestrictedPython package shipped as part of the Zope 3.2.0 release.

  • No changes from 3.1.0.

3.1.0 (2005/10/03)

  • Corresponds to the verison of the RestrictedPython package shipped as part of the Zope 3.1.0 release.

  • Removed unused fossil module, ‘SafeMapping’.

  • Replaced use of deprecated ‘whrandom’ module with ‘random’ (aliased to ‘whrandom’ for backward compatibility).

3.0.0 (2004/11/07)

  • Corresponds to the verison of the RestrictedPython package shipped as part of the Zope X3.0.0 release.

Release files for RestrictedPython 3.4.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for RestrictedPython 3.4.2
File Size Uploaded
RestrictedPython-3.4.2.tar.gz 32.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for RestrictedPython 3.4.2
File Interpreter ABI Platform
RestrictedPython-3.4.2-py2.4.egg Legacy Egg format - - Details

Total release size:112.7 kB

Release files / RestrictedPython-3.4.2.tar.gz

Download URL RestrictedPython-3.4.2.tar.gz
Size 32.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3b6af39652ab12b04e4a3c798d5d47a08268bb3c1ccf01a8f7393526f84e3dc6
BLAKE2b-256 checksum
How to use checksums
0a7e801c02a6f90a14ee511c19e39bb56be47e62e40f5e351e381fd42fda5e62
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / RestrictedPython-3.4.2-py2.4.egg

Download URL RestrictedPython-3.4.2-py2.4.egg
Size 80.1 kB
Tags Egg
SHA-256 checksum
How to use checksums
84606bfbfbb03ed20c63c1625aee611b459c0012bd0cffe54eb132164a0650e5
BLAKE2b-256 checksum
How to use checksums
c643a0dabac04782ed0237c9ee676f4282f01d32a33d27d4696099a1e406fabc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

8.5

2 release files

8.4

2 release files

8.3

2 release files

8.2

2 release files

8.1

2 release files

8.0

2 release files

7.4

2 release files

7.3

2 release files

7.2

2 release files

7.1

2 release files

7.0

2 release files

6.2

2 release files

6.1

2 release files

6.0

2 release files

5.4

2 release files

5.3

2 release files

5.2

2 release files

5.1

2 release files

5.0

2 release files

4.0

2 release files

4.0a1

1 release file

3.6.0

1 release file

3.5.2

1 release file

3.5.1

1 release file

3.5.0

1 release file

3.4.3

1 release file

This release

3.4.2 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page