Skip to content

docs: warn that nodkey is work in progress and gives no guarantee - #160

Merged
groupsky merged 1 commit into
mainfrom
docs/readme-wip-warning
Nov 6, 2026
Merged

groupsky merged 1 commit into
mainfrom
docs/readme-wip-warning

Conversation

@groupsky

@groupsky groupsky commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Adds a warning at the top of the README:

  • nodkey is work in progress, has had no outside security audit, and may have bugs that leak a secret.
  • It does not protect you from a malicious agent once you approve: the agent can keep the secret or reuse the SSH login. Some ways to reach a secret skip nodkey (root on the broker host, a store login or the approver's Telegram on the agent machine). Links to THREAT-MODEL.md section 5.
  • No warranty, as the Apache-2.0 license says; use at your own risk.

Also: the Status line now starts with "work in progress", and the "How it works" line about secret values says the command itself can print the value.

Security review (the repo's security-reviewer role): no blockers; its three wording fixes are applied. Docs only, no code change.

Say in the README that nodkey is new and not audited, that it does not
protect you from a malicious agent once you approve, and that it comes
with no warranty. Point to THREAT-MODEL.md section 5 for the full list.
@groupsky
groupsky merged commit ecc1e60 into main Nov 6, 2026
7 checks passed
@groupsky
groupsky deleted the docs/readme-wip-warning branch November 6, 2026 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant