Update README to fix bad paths and input/output #25
Conversation
This file contains 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
dcousens
commented
Jul 21, 2024
| @@ -40,21 +40,26 @@ $ age-plugin-tpm --generate -o age-identity.txt | |||
| $ age-plugin-tpm -y age-identity.txt > age-recipient.txt | |||
|
|
|||
| # Encrypt / Decrypt something | |||
| $ echo "Hack The Planet" | age -R ./age-recipient.txt -o test-decrypt.txt | |||
| $ age --decrypt -i ./age-identity.txt -o - test-decrypt.txt | |||
| $ echo 'Hack The Planet!' | age -R age-recipient.txt -o test-decrypt.txt | |||
There was a problem hiding this comment.
Missing !, and single-quotes preferred for non-expanded strings
There was a problem hiding this comment.
I dropped ./, as you don't use that for the other paths
dcousens
commented
Jul 21, 2024
| $ AGE_TPM_PIN=123 age-plugin-tpm --generate --pin -o age-identity.txt | ||
| $ age-plugin-tpm -y age-identity > age-recipient.txt | ||
| $ AGE_TPM_PIN=1234 age-plugin-tpm --generate --pin -o age-identity.txt | ||
| $ age-plugin-tpm -y age-identity.txt > age-recipient.txt |
dcousens
commented
Jul 21, 2024
| Hack The Planet! | ||
| ``` | ||
|
|
||
| ### With PIN | ||
| You can add `--pin` when calling `--generate` to require a PIN when encrypting or decrypting. |
There was a problem hiding this comment.
Alternatively, we could make the default example use --pin - which I think is preferred - and maybe an addendum in place of this text that says that --pin is optional?
|
If desired, I can split this up into two different pull requests, fixes and new copy |
Foxboron
approved these changes
Jul 21, 2024
|
Looks good to me, thanks :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request updates the README to fix some bad paths (the example didn't work) and aligns the input with the output.
Additionally, rather than hinting that
AGE_TPM_PINis how you might use a pin, I update the copy to say that this is how you might use the plugin non-interactively, instead.--pinwill prompt when encrypting and decrypting, no environment variable required.