Support multiple YubiKeys via PIVIT_YK_SERIAL environment variable #61
Conversation
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
Also tweak the contributing guide make command. Yubikey discovery behavior below. Errors when: - no cards are found - multiple cards are found and the serial is not specified - one or more cards are found and the serial does not match any Successfully returns a card when: - only one card is found and the serial is not specified - one or more cards are found and the serial matches Note that this also applies if there are other potential PIV sources attached, such as a smart card reader.
yoavamit
reviewed
Apr 17, 2025
Collaborator
yoavamit
left a comment
There was a problem hiding this comment.
Simple and clean!
Please update the README as well
pkg/pivit/pivit.go
Outdated
| continue | ||
| } | ||
|
|
||
| // Get serial number |
Collaborator
There was a problem hiding this comment.
supernit: please remove these comments. This code is simple enough that it doesn't need them.
From a readability perspective - I think it only hurts.
pkg/pivit/pivit.go
Outdated
| return nil, fmt.Errorf("invalid serial number format: %v", err) | ||
| } | ||
|
|
||
| // Serial specified - try to find matching card |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #61 +/- ##
==========================================
- Coverage 59.15% 57.72% -1.44%
==========================================
Files 10 10
Lines 928 951 +23
==========================================
Hits 549 549
- Misses 312 335 +23
Partials 67 67 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Overview
This change allows users to use
pivitwhile multiple YubiKeys are attached, or just want specificity when interacting with a YubiKey. This also tweaks the contributing guide make command.Errors when:
Successfully returns a card when:
Note that this also applies if there are other potential PIV sources attached, such as a smart card reader.
Changes
YubikeyHandleWithSerial()function.YubikeyHandle()call the new function with backward-compatible behavior.runCommand()to read the serial from the environment and use the new function.Testing
Behavior when one YubiKey is attached:
No YubiKeys:
Multiple yubikeys: