Skip to content

Commit

Permalink
doc: Clarify
Browse files Browse the repository at this point in the history
  • Loading branch information
quite committed Dec 15, 2023
1 parent bb0be5b commit 90fb6ef
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ $ age -i my-keys --decrypt ./note-to-self
remember to fix all bugs!
```

By default the generated identity will require physical touch of TKey
when it does ECDH key exchange. Use the flag `--no-touch` to generate
an identity that does not.
The generated identity will by default cause TKey to require physical
touch before computing a shared key (doing ECDH). You can pass the
flag `--no-touch` to generate an identity that does not.

After running the above, te file `my-keys` ends up containing a line
beginning with `AGE-PLUGIN-TKEY-`. This holds the parameters used for
Expand Down
2 changes: 1 addition & 1 deletion cmd/age-plugin-tkey/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func main() {
flag.StringVar(&agePluginFlag, "age-plugin", "", "For choosing state machine")
descGenerate := "Generate an identity backed by TKey"
descOutput := "Output identity to file at PATH"
descNoTouch := "Make the identity NOT require physical touch of TKey upon X25519 key exchange (use with --generate)"
descNoTouch := "Generate an identity for which the TKey will NOT require physical touch before computing a shared key (X25519 ECDH)"
descVersion := "Output version information and exit"
flag.BoolVar(&generateFlag, "generate", false, descGenerate)
flag.BoolVar(&generateFlag, "g", false, descGenerate)
Expand Down

0 comments on commit 90fb6ef

Please sign in to comment.