Skip to content

Add CLI instructions for configuring a Yubikey in Challenge/Response Mode #1465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add CLI instructions for configuring a Yubikey in Challenge/Response Mode #1465

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5cb36a7
Update mfa.md
jmynes Apr 9, 2025
a8d25dd
fix: accidentally changed numbers of steps after intended changes
jmynes Apr 9, 2025
35e595d
fix: indicate that the secret key used is an example
jmynes Apr 9, 2025
91b0aee
fix: should be 40 characters, not 20
jmynes Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions user/security-in-qubes/mfa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,16 +200,28 @@ website](https://docs.nitrokey.com/software/nitropy/all-platforms/installation).

3. Configure your YubiKey / NitroKey3:

**YubiKey**
**YubiKey (via CLI)**

Configure your YubiKey for challenge-response `HMAC-SHA1` mode. This can be
done on any qube, e.g. a disposable (you need to [attach the
YubiKey](https://www.qubes-os.org/doc/how-to-use-usb-devices/) to this app qube
though) or directly on the sys-usb vm.

You need to (temporarily) install the package "yubikey-personalization-gui" and
run it by typing `yubikey-personalization-gui` in the command line.
This command will configure your Yubikey, given a 40 character (all lowercase) secret key, like the example below:

`ykpersonalize -2 -ochal-resp -ochal-hmac -ohmac-lt64 -ochal-btn-trig -a 0123456789abcdef0123456789abcdef01234567`

With the following settings:
- Configuration Slot: `2`,
- Challenge-Response Mode: `HMAC-SHA1`,
- Require usser input (Optional, but Recommended): `true`,
- HMAC-SHA1 Mode: `fixed 64 bit input`
- Secret Key (example): `0123456789abcdef0123456789abcdef01234567`

**Yubikey (via GUI)**

Previously, this document mentioned to (temporarily) install the package "yubikey-personalization-gui" and
run it by typing `yubikey-personalization-gui` in the command line. However, this program is now [EOL](https://developers.yubico.com/yubikey-personalization-gui/), and is not present in Debian repositories newer than Bullseye (e.g. this package is not available in Debian Bookworm). The GUI instructions are left below for posterity:
- In the program go to `Challenge-Response`,
- select `HMAC-SHA1`,
- choose `Configuration Slot 2`,
Expand Down