docs: clarify PIV token support wording in README#635
Open
deeferentleeg wants to merge 1 commit into
Open
Conversation
Add 'with compatible keys' to the PIV token support line to clarify that not all hardware PIV tokens are supported, only those with compatible keys (e.g. ECDSA P-256 keys in retired PIV slots). Addresses str4d#541
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
1 participant
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.
Summary
Clarifies the README wording for hardware PIV token support to avoid the impression that all PIV tokens are broadly supported.
Before:
After:
Rationale
As discussed in #541, the original wording can be read as implying that hardware PIV tokens generally (e.g. YubiKeys) are supported. In practice,
age-plugin-yubikeyonly supports PIV tokens with an ECDSA P-256 key and certificate in one of the 20 "retired" PIV slots (see the age-plugin-yubikey README).Adding "with compatible keys" aligns the
rageREADME with theage-plugin-yubikeyREADME's own scope description, while preserving the existing terminology ("PIV tokens" per NIST SP 800-57) that the maintainer noted is correct.Addresses #541.
AI usage disclosure: An AI assistant was used to help locate the relevant code and draft this change. I have reviewed and understand every line of the diff, and I am the sole author of this contribution.