https://github.com/mrigankpawagi/pyjail
Python module to provide a secure environment for executing untrusted code.
https://github.com/mrigankpawagi/pyjail
python-package secure-execution
Last synced: about 2 months ago
JSON representation
Python module to provide a secure environment for executing untrusted code.
- Host: GitHub
- URL: https://github.com/mrigankpawagi/pyjail
- Owner: mrigankpawagi
- License: mit
- Created: 2024-12-03T17:33:10.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-20T15:16:48.000Z (6 months ago)
- Last Synced: 2025-03-29T18:51:14.902Z (3 months ago)
- Topics: python-package, secure-execution
- Language: Python
- Homepage: https://pypi.org/project/PyJail/
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PyJail
PyJail is a Python module designed to provide a secure environment for executing untrusted code. PyJail is available on [PyPI](https://pypi.org/project/PyJail/).
> [!NOTE]
> PyJail uses `chroot` and is therefore currently supported only on Linux. Further, you must run your Python script as root.
```bash
pip install PyJail
```
To execute a function without access to your system, call it through PyJail as shown below.
```python
from pyjail import Jail
with Jail() as jail:
result = jail.execute(untrusted_func, args=func_args, kwargs=func_kwargs)
```
The `Jail` class constructor has the optional parameters `path=os.path.join(os.getcwd(), "jail")`, `clear_before_create=False` and `clear_after_destroy=True`. The `path` parameter specifies the directory where the jail will be created. The `clear_before_create` parameter specifies whether the jail directory should be cleared before creation (if it already exists) and the `clear_after_destroy` parameter specifies whether the jail directory should be cleared after destruction.
The `execute` method takes the optional parameters `args` (positional arguments) and `kwargs` (keyword arguments) to pass arguments to the function `untrusted_func`. The `execute` method also takes an optional `timeout` parameter to specify the maximum time in seconds that the function is allowed to run. A `TimeoutError` will be raised if the function takes longer than the specified time to execute. Otherwise, the return value of the function is returned (and exceptions are raised if the function raises an exception).