Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
#96 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
12/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
ansible, docker, go, linux, rust

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Rust
星标
2
派生
0
平均合并
12 小时 11 分钟
30 天内合并 PR
30

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ChainSafe/docker-socket-policy 的其他 Issue

查看 ChainSafe/docker-socket-policy 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。