Skip to main content

User-space sandbox runner for Python console scripts

Project description

hermetic

Run a python tool, or your application with certain APIs disabled, such as network or subprocess.

The previously safe library you depend on was highjacked and will be sending your password files to a remote server. Or you installed this and the malicious hackers didn't include evasive code to defeat this fig leaf of a security feature and the day is saved.

If Alice and Bob know about your application and specifically are targeting this, this tool won't help.

Usage

Command-Line Interface

Use the hermetic command to run any Python console script, separating its arguments with --.

Syntax: hermetic [flags] -- <command> [command_args]

Common Flags:

  • --no-network: Disable all network activity.
  • --allow-localhost: Allows network connections to localhost (used with --no-network).
  • --allow-domain <domain>: Allows connections to a specific domain (repeatable).
  • --no-subprocess: Disable creating new processes.
  • --fs-readonly[=/path/to/root]: Make the filesystem read-only. Optionally, restrict all reads to be within the specified root directory.
  • --block-native: Block imports of native C extensions.
  • --profile <name>: Apply a pre-configured profile (e.g., block-all).
  • --trace: Print a message to stderr when an action is blocked.

CLI Examples:

Block network access for the httpie tool:

$ hermetic --no-network -- http [https://example.com](https://example.com)

hermetic: blocked action: network disabled: DNS(example.com)

Run a script in a read-only filesystem where it can only read from ./sandbox:

$ hermetic --fs-readonly=./sandbox -- python my_script.py

# my_script.py will raise PolicyViolation if it tries to read outside ./sandbox
# or write anywhere.

Apply the block-all profile to completely lock down a script:

$ hermetic --profile block-all -- my_analyzer.py --input data.csv

Programmatic API

You can use hermetic directly in your Python code via the hermetic_blocker context manager or the @with_hermetic decorator.

Decorator

The @with_hermetic decorator is the easiest way to apply guards to an entire function.

from hermetic import with_hermetic
import requests

@with_hermetic(block_network=True, allow_domains=["api.internal.com"])
def process_data():
    # This will fail because all network access is blocked by default.
    # requests.get("https://example.com") # --> raises PolicyViolation

    # This is allowed because the domain is on the allow-list.
    return requests.get("https://api.internal.com/data")

process_data()

Context Manager

For more granular control, use the hermetic_blocker context manager.

from hermetic import hermetic_blocker
import os

def check_system():
    # Subprocesses are allowed here
    os.system("echo 'Checking system...'")

    with hermetic_blocker(block_subprocess=True):
        # Inside this block, os.system() would raise a PolicyViolation
        print("Running in a sandboxed context.")
        os.system("echo 'This will fail.'") # --> raises PolicyViolation

    # Subprocesses are allowed again
    os.system("echo 'Exited sandbox.'")

check_system()

Where could this work?

There are APIs you don't need but an application or 3rd party library you depend on needs. So you block them.

The 3rd party library must be unaware of hermetic or monkeypatching. Import order is important, hermetic must run early enough to intercept all imports to the banned API. Then use of the banned API is blocked and the whole app stops.

This already works in unit testing where there isn't an adversarial relationship between the developers testing the code and writing the code under test, where you block network traffic to guarantee a unit test is pure of network side effects.

Is this defeatable?

Yes, by many routes. Native code, import order tricks, undoing a monkey patch, bringing along a vendorized copy of APIs, and so on.

This is "envelope instead of postcard" level security. This is "lock your door with standard key that can be picked with a $5 purchase on Ebay" level security.

Real sandboxing is running your code in a docker container.

Prior Art

This technique of monkey-patching for isolation is well-established, particularly in the testing ecosystem.

For stronger sandboxing, consider:

  • pysandbox: Uses Linux seccomp for kernel-level syscall filtering.
  • RestrictedPython: Rewrites Python AST to enforce constraints.
  • Docker: OS-level virtualization.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hermetic_seal-0.1.0.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hermetic_seal-0.1.0-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file hermetic_seal-0.1.0.tar.gz.

File metadata

  • Download URL: hermetic_seal-0.1.0.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hermetic_seal-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f8f3c93b387a9050a55f9f8c941174cd1405181aa120406aaf4104070fb309e4
MD5 1d6568eb5a88a5d2ba8ab4ed5018d6d5
BLAKE2b-256 7b0c8ce9b40fd54c7fc31d80bbe5b411042967a2ca1a775172c9ef943f7a2bfd

See more details on using hashes here.

Provenance

The following attestation bundles were made for hermetic_seal-0.1.0.tar.gz:

Publisher: publish_to_pypi.yml on matthewdeanmartin/hermetic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hermetic_seal-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: hermetic_seal-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hermetic_seal-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e5a892e2c888b062c5437bb9e1f50675cff28ec84a2dd691e985509d2cbd9bb7
MD5 88f99a0c33fd62324177a85dfa53e739
BLAKE2b-256 ca7eb58cbe6321c37bffc5b6e1cc429a572643d44b55dc62af1a4cd3aa1d4fd4

See more details on using hashes here.

Provenance

The following attestation bundles were made for hermetic_seal-0.1.0-py3-none-any.whl:

Publisher: publish_to_pypi.yml on matthewdeanmartin/hermetic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page