This project enables unlocking of LUKS partitions using an ubikey. It uses initramfs to do this and mkinitcpio to generate it (the initramfs).
Be aware that this was only tested and intended for:
- Archlinux
- YubiKey 4
In order to unlock the encrypted partition, this project relies on a yubikey in challenge-response HMAC mode. The challenge is in a configuration file while the response is one (or the only) password used in the LUKS key slots.
First of all we need to set a configuration slot in challenge-response HMAC mode using a command similar to:
ykpersonalize -v -1 -ochal-resp -ochal-hmac -ohmac-lt64 -ochal-btn-trig -oserial-api-visible
Make sure you customize the above line with the correct slot you want to set. I use -ochal-btn-trig to force touching the device before releasing the response.
Set the challenge...
read -s challenge
... and get the response:
ykchalresp "$challenge" | tr -d '\n'
Use the response as a new key for your LUKS partition:
cryptsetup luksAddKey /dev/<device>
Install all the needed scripts by issuing:
sudo make install
Edit the /etc/ykfde.conf file.
Add the ykfde HOOK at the end of the definition of HOOKS in /etc/mkinitcpio.conf.
Regenerate initramfs:
sudo mkinitcpio -p linux
Reboot and test you configuration.
- Added DBG mode (turned on via etc/ykfde.conf if things don't work like they should and you would like to exactly understand what is going on ;))
- Added error codes + messages and added few more sanity checks (hook/ykfde)
- Added Documentation (to ykfde.conf and to hook/ykfde)
- Added Parameters (see ykfde.conf - e.g. slot, parameterized the sleep 5, because I don't need it ... ;)
- Added Possibility to combine Password with Challenge-Response
- Made the hook/ykfde script overall more robust against typos, less error prone
- Added YubiKey detection (to complete the wait for yubiKey functionality of hook/ykfde script)
- Added a testrun.sh Test script to test the hook not first during boot-up ;)
For a security analysis of this improvement (and the idea to combine password (knowledge) with YubiKey (possession) security please see this very acurate analisis from Cornelinux.
Copyright 2017 Andrei Gherzan
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.