This is a series of working notes on the Yubikey which is an interesting device used to supplement passwords to make two-factor authentication easier. It is essentially a hardware security token device that pretends to your computer to be a keyboard and enters a one-time only password that can be used to verify your identity – much like a password, but much more secure.
Well perhaps "easier" only if someone does all the configuration for you, although I am inclined to look a bit deeper into such things for my own amusement. My own key is a Yubikey NEO, but much of what follows also applies to the other Yubikey models.
Observations
This is the spot for observations on using the Yubikey over time.
- For some reason the Yubikey doesn't always "light up" on my workstation at work. It works fine at home – the green light always turns on ready for a key press – but at work it often seems to flicker and stay out. Not sure what causes this, but it always seems to be persistent when you really need to use it!
Configuration
… is to some extent unnecessary, but under Linux there are three bits of software that can be installed to configure additional features of the Yubikey :-
- The library: https://developers.yubico.com/libykneomgr/
- The command-line tool: https://developers.yubico.com/yubikey-personalization/
- The GUI: https://developers.yubico.com/yubikey-personalization-gui/
All three build easily from the instructions given. Just make sure to remember to copy the udev rules from yubikey-personalization to /etc/udev/rules.d/ and run udevadm trigger to enable them. This will make sure you can access your yubikey as a console user, so you don't have to become root.
Enabling Linux Authentication
This was all done with a Linux container (LXC), so it could be relatively easily thrown away and restarted. The first step was to install the relevant PAM module :-
# apt-get install libpam-yubico
This pulls in a ton of other required packages.
The next is to grab the unchanging part of your Yubikey token. This is the first 12 characters of what you get when you activate it. Whilst you have it to hand, now would be a good time to create the mapping file – /etc/yubikey-mappings :-
# Yubikey ID mappings # Format: # user-id:yubikey-id:yubikey-id:... # (But usually only one) user-id:ccccccsomeid
Next step is to add a little something to one of the pam files. For testing (assuming you have console) access, the relevant file might be /etc/pam.d/sshd but once you have things working, /etc/pam.d/common-auth might be a better choice. Right at the top of the file add :-
auth sufficient pam_yubico.so debug id=16 authfile=/etc/yubikey-mappings # Added for Yubikey authentication.
Because these things always have problems when you first try them, it makes sense to set up the debugging log :-
touch /var/run/pam-debug.log chmod a+w /var/run/pam-debug.log
At this point, assuming everything works as expected :-
- You will be able to authenticate using ssh using either your Yubikey, or your password.
- This assumes your server is able to communicate with the Yubi Cloud.
There are further improvements to be made … and we'll get to those shortly.
But That's Not Two-Factor Authentication!
Indeed not, so we'll fix that right now.
Firstly remove the line we previously added to /etc/pam.d/sshd; because of the way that Debian configures pam, it is less disruptive (i.e. fewer changes) to make the change to /etc/pam.d/common-auth :-
auth requisite pam_yubico.so id=16 debug authfile=/etc/yubikey-mappings # Yubikey configuration added. auth [success=1 default=ignore] pam_unix.so nullok_secure use_first_pass
But before restarting sshd (you have been doing that haven't you?), you will need to add a Yubikey ID to /etc/yubikey-mappings for the root user.
At this point, you will only be able to authenticate if you enter your username, followed by both your Unix password and activate your Yubikey at the password prompt. Entering both at the same prompt is a little weird especially when you consider that there is no indications anywhere that Yubikey authentication is required.
But we can fix that. First of all, one small change to common-auth – remove the use_first_pass phrase.
Next edit the file /etc/ssh/sshd_config and find the ChallengeResponseAuthentication phrase and set to "Yes" :-
ChallengeResponseAuthentication yes
And after a quick reboot, the log in process works in a sensible way :-
» ssh chagers Yubikey for `mike': (Press YubiKey) Password: (Enter Unix password) Linux chagers 3.14-0.bpo.1-amd64 #1 SMP Debian 3.14.12-1~bpo70+1 (2014-07-13) x86_64 The programs included with the Debian GNU/Linux system are free software; the exact distribution terms for each program are described in the individual files in /usr/share/doc/*/copyright. Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent permitted by applicable law. Last login: Wed Dec 31 15:37:05 2014 ... </pre>