fix: correct docs and add keygen script#20
Merged
Conversation
…ygen script Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
Author
|
Clean / CI green. Adds a signing-key generator script + doc fixes. Low-risk to merge. Quick check before merging: confirm the script only generates a keypair locally and never commits or prints private material, and that the docs point at the keyring-pin workflow. |
# Conflicts: # README.md
… public material The script previously echoed the Ed25519 private key (hex) to stdout, exposing it to the terminal, shell history, and CI logs. Write the private key to a 0600 file instead (default ./signing-key.hex, or an operator-supplied path) and print only public material: the public key in hex (for the embeddedPubKeyHex ldflags) and in std-base64 (for the per-entry public_key pin in trusted-agents.json). Refuse to overwrite an existing key file, create the file with a tight umask before writing any secret, and gitignore signing-key.hex and *.key so the private key can never be committed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes README IsTrusted return type, updates misleading package comment, adds -ldflags injection instructions, adds scripts/gen-signing-key.sh.
Changes
IsTrusted(nodeID)return type from(description, ok)to(hostname, ok)to match the actual function signature.VerifyAndStripSig.-ldflagsinjection comment nearembeddedPubKeyshowing how to supply the real key at build time and pointing to the new keygen script.go runwith inline Go code to generate an ed25519 keypair and print both the secret private key and the hex public key ready for-ldflagsinjection.