Skip to main content

Privileged operations agent for Hop3 (kernel-boundary executor)

Project description

hop3-rootd

Privileged-operations agent for Hop3. Runs as root; exposes a narrow control-plane API to hop3-server (running unprivileged as the hop3 user) over a Unix domain socket.

See notes/adrs/041-privileged-operations-agent.md for the design rationale and notes/adrs/040-network-firewall-and-port-exposure.md for the firewall integration that motivated v1's op set.

What this is

hop3-rootd is the kernel-boundary executor for Hop3's runtime privileged actions. The unprivileged hop3-server reaches it via a Unix socket; rootd validates each request structurally, applies the privileged action (nftables mutation, nginx reload, etc.), and returns a typed result.

In v1 the operations are:

  • firewall.add_rule, firewall.remove_rule, firewall.list_rules — manage rules in a dedicated inet hop3 nftables table.
  • nginx.reload, nginx.validate_config — wrap the privileged nginx commands previously granted to hop3-server via /etc/sudoers.d/hop3 (now retired).
  • daemon.health, daemon.handshake — introspection.

What this is not

  • A policy enforcement layer. SO_PEERCRED admits the hop3 user; structural validation rejects malformed requests. There is no per-op authorization, no policy file. Operator-level "did you mean this?" prompts live in hop3 deploy, not in rootd.
  • A general-purpose privileged-shell daemon. Rootd never accepts shell strings; every operation is a typed intent with a fixed argument schema.

Deployment

hop3-rootd ships as a stdlib-only Python package and is installed by hop3-installer alongside hop3-server. It runs as a hardened systemd unit (full ProtectX suite, CapabilityBoundingSet=CAP_NET_ADMIN, syscall filter, resource limits). The socket is at /run/hop3-rootd/socket, mode 0660, group hop3.

Development

# Run unit tests (no privileges needed)
pytest tests/a_unit/ -v

# Run integration tests (requires root + nftables)
sudo pytest tests/b_integration/ -v

# Lint
ruff check src tests
ruff format src tests

License

Apache-2.0 — Copyright (c) 2026, Abilian SAS

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

hop3_rootd-0.5.0.dev3.tar.gz (50.8 kB view details)

Uploaded Source

Built Distribution

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

hop3_rootd-0.5.0.dev3-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

Details for the file hop3_rootd-0.5.0.dev3.tar.gz.

File metadata

  • Download URL: hop3_rootd-0.5.0.dev3.tar.gz
  • Upload date:
  • Size: 50.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for hop3_rootd-0.5.0.dev3.tar.gz
Algorithm Hash digest
SHA256 bde8113d67a5c42f083140bc129293e2a0ec2be1def9e0d7e0f8b454c5da2888
MD5 6abe588be3ab51a1c8cc48221852d350
BLAKE2b-256 a5954f1aed86baf1702f4bd8c9dcd861ac6f45a61482c6b2f47203381102dc97

See more details on using hashes here.

File details

Details for the file hop3_rootd-0.5.0.dev3-py3-none-any.whl.

File metadata

File hashes

Hashes for hop3_rootd-0.5.0.dev3-py3-none-any.whl
Algorithm Hash digest
SHA256 22b2c2505fe7eb52ad55547ad373cff87842c0a84f8635314898562c80dc5eaf
MD5 dade5b2a068450fd9bedce82e465034d
BLAKE2b-256 cdbce473a0f2b5ac46942370a572970c89c24060330bb180b6ee0663cfba063e

See more details on using hashes here.

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