6.3.1.25. Yubikey¶
The Yubikey is initialized with privacyIDEA and works in Yubicos own AES mode. It outputs a 44 character OTP value, consisting of a 12 character prefix and a 32 character OTP. But in contrast to the Yubico Cloud mode, in this mode the secret key is contained within the token and your own privacyIDEA installation.
If you have the time and care about privacy, you should prefer the Yubikey AES mode over the Yubico Cloud mode.
There are three possible ways to enroll a Yubikey token.
Note
We recommend that you use the privacyidea command line
client, to initialize the Yubikeys. You can use the mass enrollment, which
eases the process of initializing a whole bunch of tokens.
Run the command like this:
privacyidea -U https://your.privacyidea.server -a admin token \
yubikey_mass_enroll --yubimode YUBICO
This command initializes the token and stores the AES secret and prefix
in privacyidea, so the token is immediately useful. You can choose the slot
with --yubislot. For further help call
privcyidea yubikey_mass_enroll with the --help option.
The second way to enroll a yubikey token is also using yubikey_mass_enroll,
but with the option --filename to write to token configuration into the
specified file. The resulting file can then be imported into privacyidea:
Select Tokens -> Import Tokens, select “OATH CSV” and the file you just created.
6.3.1.25.1. Using the yubikey personalization GUI¶
Third and last you can use the privacyIDEA Web UI to enroll a Yubikey AES mode token, if you have initialized the yubikey with an external YubiKey personalization tool 1.
Use the yubikey-personalization-gui to initialize the yubikey¶
When using the yubikey personalization GUI you need to copy the value of “Secret Key (16 bytes Hex)”. This is the secret OTP key, which you need to copy and paste in the field OTP Key in the privacyIDEA Web UI.
Enroll a Yubikey AES mode token¶
In the field “Test Yubikey” push the Yubikey button. This will determine the length of the otp value and the field OTP length is automatically filled.
Note
The length of the unique passcode for each OTP is 32 characters at the end of the OTP value. The remaining characters at the beginning of the OTP value form the Public ID of the device. They remain constant for each OTP 2.
privacyIDEA takes care of separating these parts but it needs to know the complete length of the OTP value to work correctly.
6.3.1.25.1.1. Redirect api url to privacyideas /ttype/yubikey¶
Yubico servers use /wsapi/2.0/verify as the path in the
validation URL. Some tools (e.g. Kolab 2fa) let the
user/admin change the api host, but not the rest of
the URL. Let’s redirect the api URL to privacyideas
/ttype/yubikey - you’ll need to enable the following two
lines in /etc/apache2/site-enabled/privacyidea.conf:
RewriteEngine on RewriteRule “^/wsapi/2.0/verify” “/ttype/yubikey” [PT]
If you use nginx there is a similar line provided as a comment to the nginx configuration as well.
Footnotes
