An operator links an agent's GitHub personal access token in the swarm UI
(LinkGithubAccountForm, "link github account" on /agents). swarm-controller's
PUT /api/hives/{hive}/agents/{agent}/github-account stores it at
swarm/agents/<agent>/github-token (swarm_secret_client::github), a flat leaf
under the agent's prefix that the agent's existing read grant already covers:
no policy change, and no list grant, since there is one token per agent.
In the agent, hive-agent-github-token (oneshot + 2-minute timer, as the agent
user, under its own store certificate, ordered before hive-github-notify)
reads that path and writes <state>/github-token, 0600 and agent-owned, the
file the gh wrapper, git credential helper and hive-github-notify already
read. It replaces the file by rename only when the bytes changed and never
deletes it: a hive-written github-token stays until a token is linked in the
swarm UI. It is installed only with a store address and
services.hyperhive.agent.github.enable.
Removed: the dashboard's CR3D3NTIALS page (credentials.html/js/css, its
build entries and H0M3 tile; GITHUB was its only tab), hive-c0re's
dashboard/matrix_accounts.rs with GET/POST /api/github-account,
priv_client::write_agent_github_token, the host socket's
SetAgentGithubToken and `hivectl github set-token`, and hive-priv's
WriteAgentGithubToken with write_agent_state_file, its only caller gone.
Docs: integrations/github.md and swarm/ui.md describe the swarm path,
swarm/credentials.md gains the store-path row, and the hive UI docs,
hivectl docs and security.md's hive-priv table drop the removed pieces.
Closes #4347
131 lines
6 KiB
Nix
131 lines
6 KiB
Nix
# GitHub integration (services.hyperhive.agent.github.enable): a `gh` wrapper + a git
|
|
# credential helper, both reading the PAT from the agent's
|
|
# `github-token` state file at invocation, so a token ./github-token.nix
|
|
# fetches takes effect with no rebuild. The token PATH is baked in at build
|
|
# time (nix knows `userName`) — NOT read from `$HIVE_GITHUB_TOKEN_FILE`,
|
|
# because claude's Bash tool runs `bash -c` in a minimal env that
|
|
# doesn't source `/etc/set-environment`, so the env var isn't present
|
|
# where `gh`/`git` actually run. The token value never enters the nix
|
|
# store (only its path). github.com only; git auths as `x-access-token`
|
|
# + PAT.
|
|
{
|
|
pkgs,
|
|
lib,
|
|
config,
|
|
...
|
|
}:
|
|
let
|
|
userName = config.services.hyperhive.agent.user.name;
|
|
ghWrapper = pkgs.writeShellScriptBin "gh" ''
|
|
if [ -r "/agents/${userName}/state/github-token" ]; then
|
|
GH_TOKEN="$(cat "/agents/${userName}/state/github-token")"
|
|
export GH_TOKEN
|
|
fi
|
|
exec ${pkgs.gh}/bin/gh "$@"
|
|
'';
|
|
gitCredHelper = pkgs.writeShellScriptBin "git-credential-hive-github" ''
|
|
# git credential-helper protocol: only the `get` action needs an answer.
|
|
[ "''${1:-}" = "get" ] || exit 0
|
|
if [ -r "/agents/${userName}/state/github-token" ]; then
|
|
# GitHub ignores the username for PAT auth — `x-access-token` is the
|
|
# conventional placeholder; the PAT is the password.
|
|
printf 'username=x-access-token\n'
|
|
printf 'password=%s\n' "$(cat "/agents/${userName}/state/github-token")"
|
|
fi
|
|
'';
|
|
in
|
|
{
|
|
options.services.hyperhive.agent.github.enable = lib.mkOption {
|
|
type = lib.types.bool;
|
|
default = true;
|
|
description = ''
|
|
Install the GitHub integration in this agent: a `gh` CLI wrapper and a
|
|
git credential helper for `https://github.com`, both authenticated from
|
|
an operator-supplied personal access token (PAT). The operator links the
|
|
PAT in the swarm UI, and the agent fetches it from the swarm secret store
|
|
into `<state>/github-token` (needs `services.hyperhive.agent.bao.addr`),
|
|
so giving an agent GitHub is a runtime action, no per-agent config or
|
|
rebuild. The wrappers read the token file at invocation, so a fetched
|
|
PAT takes effect immediately; until one exists, `gh` / `git push` just
|
|
fail unauthenticated.
|
|
|
|
github.com only. git authenticates as `x-access-token` + the PAT (GitHub
|
|
ignores the username for PAT auth); `gh` derives its identity from the
|
|
token. Keep the PAT minimally scoped: the agent has passwordless sudo, so
|
|
a compromised agent can act within the token's scopes --- scope is the
|
|
real blast-radius limiter.
|
|
|
|
On by default. Host-driven: set `services.hyperhive.github.enable = false`
|
|
to turn the integration off hive-wide (meta.rs propagates the override
|
|
into every agent).
|
|
'';
|
|
};
|
|
|
|
config = {
|
|
# No bare pkgs.gh here — the wrapper *is* `gh` and hardcodes the
|
|
# real binary path, so it can't be shadowed.
|
|
environment.systemPackages = lib.optionals config.services.hyperhive.agent.github.enable [
|
|
ghWrapper
|
|
gitCredHelper
|
|
];
|
|
|
|
# Wire the GitHub credential helper for `git push` over HTTPS. Host-scoped
|
|
# to `https://github.com`, so it never touches the forge (localhost:3000)
|
|
# or any other remote. The helper reads the PAT from the agent's
|
|
# `github-token` state file at invocation and auths as `x-access-token` +
|
|
# the PAT. System /etc/gitconfig merges under the agent's ~/.gitconfig
|
|
# (safe.directory), so this is additive.
|
|
# Nested-path binding + mkIf (matching the other `environment.etc."…"`
|
|
# entries in the harness modules) — a whole-set `environment.etc = {…}`
|
|
# here would collide with them at the nix level ("attribute already
|
|
# defined").
|
|
environment.etc."gitconfig" = lib.mkIf config.services.hyperhive.agent.github.enable {
|
|
text = ''
|
|
[credential "https://github.com"]
|
|
helper = hive-github
|
|
username = x-access-token
|
|
'';
|
|
};
|
|
|
|
# GitHub notification poller — the github.com sibling of
|
|
# `hive-forge-notify` (forge.nix). Same delivery path: unread list ->
|
|
# per-thread summary -> todo on the harness's in-agent socket.
|
|
#
|
|
# Its own binary and its own package, so the deployment decides
|
|
# whether an agent gets GitHub notifications at all — the unit is
|
|
# installed or it isn't. That keeps the choice here rather than in a
|
|
# cargo feature, which would unify across the workspace and stop the
|
|
# two builds sharing any cached crate.
|
|
#
|
|
# The separate package is what makes that real: the per-bin
|
|
# extractor copies exactly one binary, so an agent that installs
|
|
# only the Forgejo poller has no github.com poller anywhere in its
|
|
# closure — not merely an unstarted unit.
|
|
systemd.services.hive-github-notify = lib.mkIf config.services.hyperhive.agent.github.enable {
|
|
description = "github.com notification poller for this agent";
|
|
wantedBy = [ "multi-user.target" ];
|
|
after = [ "network.target" ];
|
|
environment = {
|
|
# Same in-agent todo socket the forge poller and the harness use
|
|
# (agent-service.nix) — one todo stream, two producers.
|
|
HIVE_AGENT_SOCKET = "/run/hive-agent/${userName}/agent.sock";
|
|
RUST_LOG = "info";
|
|
# HYPERHIVE_STATE_DIR comes from systemd.globalEnvironment; the
|
|
# poller reads the agent's `github-token` from under it.
|
|
};
|
|
serviceConfig = {
|
|
ExecStart = "${config.services.hyperhive.agent.packages.hive-github-notify}/bin/hive-github-notify";
|
|
SyslogIdentifier = "hive-github-notify";
|
|
# `on-failure`, NOT `always`, for the same reason as the forge
|
|
# poller: this unit ships on every agent, but most agents have no
|
|
# PAT. The poller reports that by logging why and exiting 0, which
|
|
# under `always` would become a restart loop on every PAT-less
|
|
# agent. A crash still restarts.
|
|
Restart = "on-failure";
|
|
RestartSec = 5;
|
|
User = userName;
|
|
Group = userName;
|
|
};
|
|
};
|
|
};
|
|
}
|