Go to file
Johannes Bauer 969eae12c7 Started with server implementation
Running into issues with TLSv1.3-PSK. Connection establishment does not
work at the moment.
2019-10-23 13:18:51 +02:00
codegen Cleanups 2016-09-24 20:14:53 +02:00
initramfs Only execute luksrku when an actual server config is present 2018-01-16 19:01:55 +01:00
parsers Started with server implementation 2019-10-23 13:18:51 +02:00
.gitignore Integrate editor properly from command line 2019-10-23 11:34:40 +02:00
argparse_edit.c Started with server implementation 2019-10-23 13:18:51 +02:00
argparse_edit.h Started with server implementation 2019-10-23 13:18:51 +02:00
argparse_server.c Started with server implementation 2019-10-23 13:18:51 +02:00
argparse_server.h Started with server implementation 2019-10-23 13:18:51 +02:00
blacklist.c LICENSE added (GPLv3) 2016-09-22 20:47:43 +02:00
blacklist.h LICENSE added (GPLv3) 2016-09-22 20:47:43 +02:00
ChangeLog Release v0.02 2019-10-19 15:08:30 +02:00
client.c Integrate editor properly from command line 2019-10-23 11:34:40 +02:00
client.h LICENSE added (GPLv3) 2016-09-22 20:47:43 +02:00
editor.c Started with server implementation 2019-10-23 13:18:51 +02:00
editor.h Started with server implementation 2019-10-23 13:18:51 +02:00
exec.c Fix comment 2018-01-16 19:42:22 +01:00
exec.h Show log output even in verbose mode 2018-01-16 19:40:13 +01:00
file_encryption.c Implemented export of key database 2019-10-21 22:47:58 +02:00
file_encryption.h Implemented export of key database 2019-10-21 22:47:58 +02:00
gen_config Initial import 2016-09-22 20:40:58 +02:00
global.h Implemented export of key database 2019-10-21 22:47:58 +02:00
keydb.c Implemented export of key database 2019-10-21 22:47:58 +02:00
keydb.h Integrate current state-of-affairs into luksrku 2019-10-23 09:39:40 +02:00
LICENSE LICENSE added (GPLv3) 2016-09-22 20:47:43 +02:00
LICENSE-header LICENSE added (GPLv3) 2016-09-22 20:47:43 +02:00
licensify Script to add LICENSE headers to all files 2016-09-22 20:48:11 +02:00
log.c Show log output even in verbose mode 2018-01-16 19:40:13 +01:00
log.h Show log output even in verbose mode 2018-01-16 19:40:13 +01:00
luks.c Show log output even in verbose mode 2018-01-16 19:40:13 +01:00
luks.h LICENSE added (GPLv3) 2016-09-22 20:47:43 +02:00
luksrku-config.c LICENSE added (GPLv3) 2016-09-22 20:47:43 +02:00
luksrku.c Started with server implementation 2019-10-23 13:18:51 +02:00
Makefile Started with server implementation 2019-10-23 13:18:51 +02:00
msg.h Started with server implementation 2019-10-23 13:18:51 +02:00
openssl.c Started with server implementation 2019-10-23 13:18:51 +02:00
openssl.h Remove references to SSL and replace by TLS. 2017-03-07 21:48:00 +01:00
parse-keyfile.c LICENSE added (GPLv3) 2016-09-22 20:47:43 +02:00
parse-keyfile.h LICENSE added (GPLv3) 2016-09-22 20:47:43 +02:00
pgmopts.c Started with server implementation 2019-10-23 13:18:51 +02:00
pgmopts.h Started with server implementation 2019-10-23 13:18:51 +02:00
README.md More README.md fixes 2017-08-13 12:27:21 +02:00
server.c Started with server implementation 2019-10-23 13:18:51 +02:00
server.h Started with server implementation 2019-10-23 13:18:51 +02:00
util.c Integrate current state-of-affairs into luksrku 2019-10-23 09:39:40 +02:00
util.h Implemented export of key database 2019-10-21 22:47:58 +02:00
uuid.c Further work on creating correct type-4 UUIDs 2019-10-20 17:45:21 +02:00
uuid.h Implemented more useful commands 2019-10-21 21:30:29 +02:00
vault.c More tests to show key changes 2019-10-19 11:32:32 +02:00
vault.h Make vault iteration count adaptible to hardware 2019-10-19 11:29:39 +02:00

Disclaimer

Warning luksrku is currently highly experimental software. It is not intended for production use yet. It is released following the “release early, release often” philosophy in the hope to get valuable feedback for possible areas of improvement. Please only use it when youre pretty certain that you know what youre doing. Better yet, only use it after code review. If youve reviewed my code, please let me know. Im very interested in any and all feedback. Drop it at joe@johannes-bauer.com, please. Thanks!

luksrku

luksrku is a tool that allows you to remotely unlock LUKS disks during bootup. The intention is to have headless systems running and you should be able to remotely unlock their LUKS cryptographic file systems when you know they have been (legitimately) rebooted. This works as follows: The TLS server runs on the computer which needs unlocking. This computer broadcasts a UDP packet onto the network indicating that it needs unlocking. The TLS client which knows the LUKS passphrase then catches that packet, connect to the server and sends the passphrase. The TLS configuration that is used ensures mutual authentication and perfect forward secrecy. Concretely, TLS v1.2 is used with a ECDHE handshake on Curve25519 and using the ECDHE-PSK-CHACHA20-POLY1305 cipher suite. For authentication, a 256 bit long random PSK is used. The passphrase for unlocking should be in a own keyslot (i.e., do not use a passphrase which you remember).

Configuration

Clients and servers use a configuration file. This is originally a text file that is then converted to encrypted binary format using the luksrku-config tool. This binary configuration file is encrypted using AES256-GCM, uses a 128 bit randomized initialization vector and authenticated with a 128 bit authentication tag. The key derivation function which is used to derive the 256 bit AES key from the passphrase is scrypt with N = 131072, r = 8, p = 1.

Storing in a binary format serves two purposes: 1. Error-prone parsing of human-modifiable text is done in a separate application. These chunks of code are not linked into the luksrku binary. 2. It allows for easy encryption.

The server key database contains no secrets, yet it is encrypted nevertheless. The sole purpose is to keep the number of alternative code paths minimal. There is no technical reason to encrypt the server configuration file, but again: it contains no secrets. Using the same storage for server and client was maybe an awkward design choice, but this is something that is ugly, but not security-critical.

The client key database contains the LUKS keys, therefore it is advisable to keep it encrypted with a passphrase. Only if this passphrase is correctly entered on the client, the password can be decrypted on the client and transmitted to the server. Note that care is taken to ensure no length-of-message side channels reveal information about the underlying LUKS passphrase. Therefore the transmitted messages are always of the same length.

The PSK that is used to communicate between client and server ensures mutual authentication. If the PSK is stolen by an adversary, that adversary can simply pose as a server and ask the client for the LUKS key. Therefore it is integral that this PSK is kept safe. Passive attacks (i.e., where the adversary is only eavesdropping on communication), however, are not compromised because the TLS channel provides PFS.

Prerequisites

Since the used cryptography (such as ECDH on Curve25519 and the ECDHE-PSK-CHACHA20-POLY1305 cipher suite) are fairly new, support for at least OpenSSL-1.1.0 is essential.

Example

This is a very crude example. Feel free to improve it and send a PR. Lets say we want to unlock the crypt-root of a headless system. I.e., only one LUKS partition that should be unlocked. That LUKS partition has the UUID of 952ebed9-5256-4b4c-9de5-7f8829b4a74a (use blkid to find out). This is what we can do:

  1. Build >=OpenSSL-1.1.0 (e.g., using the provided ./build_openssl command)
  2. Build and install luksrku: make && sudo make install
  3. Generate the keyfiles. For this we use the provided gen_config script:
Disk UUID : 952ebed9-5256-4b4c-9de5-7f8829b4a74a
Disk name : crypt-root
Suggestion: TDFV6Z6XyDQ52ASswVFSEl8mrVfnH9F5b
Passphrase: 

Disk UUID : 
# server.txt
# Host UUID                             Host PSK                                                            Disk UUIDs
d66f96fc-7056-46e1-aea6-0f3d705cd3bc    d94f3fc6c3507123bda4034dd8c865a1b4cf9870bda50e9ed9f861621d581017    952ebed9-5256-4b4c-9de5-7f8829b4a74a=crypt-root

# client.txt
# Host UUID                             Host PSK                                                            Disk UUIDs
d66f96fc-7056-46e1-aea6-0f3d705cd3bc    d94f3fc6c3507123bda4034dd8c865a1b4cf9870bda50e9ed9f861621d581017    952ebed9-5256-4b4c-9de5-7f8829b4a74a=54444656365a3658794451353241537377564653456c386d7256666e4839463562
  1. We want to use the suggested passphrase, which should contain 192 bits of entropy. For this, ee use cryptsetup luksAddKey to add the suggested passphrase to the LUKS keyring on the server.
  2. The config script has given suggestions for server.txt and client.txt. We copy the respective contents into the files.
  3. Then we create the client and server binary configuration files:
$ luksrku-config server server.txt server.bin
Successfully read key file with 1 entries.
$ luksrku-config client client.txt client.bin
Successfully read key file with 1 entries.
Passphrase to encrypt keyfile:
  1. Now well have a server.bin and password-protected client.bin. On the server machine (i.e., the one with the LUKS disk) we copy server.bin to /etc/luksrku-server.bin.
  2. On the server, we modify the luksrku-script in the initramfs/ subdirectory to fit the NIC of the server and the IP address we want (this is really ugly at the moment and needs to be fixed ASAP, but it is what it is now).
  3. On the server, then run the “./install” script as root which will install initramfs hooks.
  4. On the server, update the initramfs (update-initramfs -u). Previously make a copy of your initramfs so that you can boot your system in case things go wrong (which they will, trust me).
  5. Boot the server. If everything went fine (it wont at the first run), it will now broadcast UDP packets onto the network indicating its presence. These packets will be sent to UDP port 23170.
  6. On the client, start the client to unlock the servers key:
$ luksrku --client-mode -k client.bin 
Keyfile password: