Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Add an Ansible role to install the proxy as a hardened systemd service

Aperta
  • Qualcosa non va?
#96 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
12/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
ansible, docker, go, linux, rust
Ambito
devops, infrastructure

Direzione di ricerca

The proxy's policy loading is in go/internal/policy/manager.go, and the README's systemd Service section shows the manual install that the role would automate. The work is a new Ansible collection under ansible/ with one role, plus tests in ansible/tests/ that run against a real Docker daemon. Done means the role installs and verifies the binary, writes policies and a hardened unit, restarts on change, and the test suite passes with ansible-lint and --syntax-check in CI.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Type: Feature

Is your feature request related to a problem?

There is no supported way to install the proxy on a host. The README's systemd Service section lists manual commands and a minimal unit. Every consumer must write the same install: the pinned binary and its checksum, the service account and its groups, the policy files and their modes, a hardened unit, log rotation, and a restart when a policy changes. Some details are easy to get wrong:

  • The proxy reads its policies only at startup (go/internal/policy/manager.go). A changed policy with no restart is a silent no-op.
  • The proxy ignores unknown policy keys. A misspelled key loads without an error and enforces nothing.
  • The proxy can give its socket only to a group that it belongs to. Without that membership, startup fails.
  • The proxy opens the audit log once and never reopens it. A rotation by rename leaves it writing to the rotated file.

lodestar-infrastructure is the first consumer (ChainSafe/lodestar-infrastructure#64, the spec in ChainSafe/lodestar-infrastructure#9). The install is not specific to Lodestar.

Describe the solution

Add an Ansible collection, chainsafe.docker_socket_policy, under ansible/. It contains one role, docker_socket_policy. Consumers install it from this repository at a release tag (git+https://github.com/ChainSafe/docker-socket-policy.git#/ansible/). The role:

  • installs the Go or Rust release binary for amd64 or arm64, and checks it against the sha256 digest that GitHub publishes for the asset;
  • creates a system account in the Docker group and the socket group;
  • writes one policy per entry, root:<group> 0640, and removes policy files that it does not manage;
  • rejects unknown or unenforced policy keys (ports, user_id, group_id), and rejects overlapping service or container names;
  • writes a unit with ProtectSystem=strict, RestrictAddressFamilies=AF_UNIX, an empty capability set, MemoryDenyWriteExecute=true and UMask=0027;
  • restarts the proxy when a policy, the binary or the unit changes;
  • writes a logrotate rule with copytruncate.

ansible/tests/ installs the role with two test policies that share one image, then sends real requests through the proxy to a real daemon on a disposable host. The tests cover denied mounts, groups, namespaces, capabilities, devices, inherited mounts, policy confusion, lifecycle on unmanaged containers, exec, update, path tricks and pulls. They also check the forced values and socket access by group. CI runs ansible-lint and --syntax-check.

Describe alternatives

  • A role in ChainSafe/ansible-collection (chainsafe.general). Rejected: the policy schema changes with proxy releases (container_names in v0.5.0, group_add in v0.6.0). A role in this repository is versioned and tested with the binary that it installs.
  • A role in lodestar-infrastructure's lodestar-collection. Rejected: the install is not specific to Lodestar.
  • Keep the README commands only. Rejected: every consumer repeats the details above.

Which implementation(s) would this affect?

  • Go (installs the Go binary)
  • Rust (installs the Rust binary)
  • TypeScript (released as a tarball that needs Node; the role does not install it)
  • Quint specification
  • All

Additional context

No proxy code changes. The first release that contains ansible/ would be the first version that consumers can pin.

Lingua principale
Rust
Stelle
2
Fork
0
Merge medio
12h 11m
PR unite (30g)
30

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ChainSafe/docker-socket-policy

Tutte le issue di ChainSafe/docker-socket-policy

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.