https://github.com/zopefoundation/restrictedpython

A restricted execution environment for Python to run untrusted code.
https://github.com/zopefoundation/restrictedpython

code hacktoberfest plone python restrictions untrusted zope

Last synced: about 7 hours ago
JSON representation

A restricted execution environment for Python to run untrusted code.

• Host: GitHub
• URL: https://github.com/zopefoundation/restrictedpython
• Owner: zopefoundation
• License: other
• Created: 2013-02-28T14:29:45.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2025-01-28T07:19:20.000Z (5 days ago)
• Last Synced: 2025-02-02T06:01:43.183Z (about 8 hours ago)
• Topics: code, hacktoberfest, plone, python, restrictions, untrusted, zope
• Language: Python
• Homepage: http://restrictedpython.readthedocs.io/
• Size: 1.68 MB
• Stars: 507
• Watchers: 76
• Forks: 38
• Open Issues: 21
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Roadmap: docs/roadmap/index.rst

Awesome Lists containing this project

README

        
.. image:: https://github.com/zopefoundation/RestrictedPython/actions/workflows/tests.yml/badge.svg

    :target: https://github.com/zopefoundation/RestrictedPython/actions/workflows/tests.yml

.. image:: https://coveralls.io/repos/github/zopefoundation/RestrictedPython/badge.svg?branch=master

    :target: https://coveralls.io/github/zopefoundation/RestrictedPython?branch=master

.. image:: https://readthedocs.org/projects/restrictedpython/badge/

    :target: https://restrictedpython.readthedocs.org/

    :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/RestrictedPython.svg

    :target: https://pypi.org/project/RestrictedPython/

    :alt: Current version on PyPI

.. image:: https://img.shields.io/pypi/pyversions/RestrictedPython.svg

    :target: https://pypi.org/project/RestrictedPython/

    :alt: Supported Python versions

.. image:: https://github.com/zopefoundation/RestrictedPython/raw/master/docs/logo.jpg

================

RestrictedPython

================

RestrictedPython is a tool that helps to define a subset of the Python language which allows to provide a program input into a trusted environment.

RestrictedPython is not a sandbox system or a secured environment, but it helps to define a trusted environment and execute untrusted code inside of it.

.. warning::

   RestrictedPython only supports CPython. It does _not_ support PyPy and other Python implementations as it cannot provide its restrictions there.

For full documentation please see http://restrictedpython.readthedocs.io/.

Example

=======

To give a basic understanding what RestrictedPython does here two examples:

An unproblematic code example

-----------------------------

Python allows you to execute a large set of commands.

This would not harm any system.

.. code-block:: pycon

    >>> from RestrictedPython import compile_restricted

    >>> from RestrictedPython import safe_globals

    >>>

    >>> source_code = """

    ... def example():

    ...     return 'Hello World!'

    ... """

    >>>

    >>> loc = {}

    >>> byte_code = compile_restricted(source_code, '', 'exec')

    >>> exec(byte_code, safe_globals, loc)

    >>>

    >>> loc['example']()

    'Hello World!'

Problematic code example

------------------------

This example directly executed in Python could harm your system.

.. code-block:: pycon

    >>> from RestrictedPython import compile_restricted

    >>> from RestrictedPython import safe_globals

    >>>

    >>> source_code = """

    ... import os

    ...

    ... os.listdir('/')

    ... """

    >>> byte_code = compile_restricted(source_code, '', 'exec')

    >>> exec(byte_code, safe_globals, {})

    Traceback (most recent call last):

    ImportError: __import__ not found

Contributing to RestrictedPython

--------------------------------

If you want to help maintain RestrictedPython and contribute, please refer to

the documentation `Contributing page

`_.