Jump to content

# Clevis

From ArchWiki

Related articles

- Booster
- Mkinitcpio
- Dracut
- Dm-crypt
- YubiKey
- Trusted Platform Module

Clevis allows binding a LUKS volume to a system by creating a key and encrypting it using the TPM, and sealing the key using PCR values which represent the system state at the time of the Clevis pin creation.

Passwords manually entered by a user is a traditional and widely used way to unlock encrypted LUKS partitions. But it has a few disadvantages:

- It requires manual intervention and thus does not work with setups that require automatic boot (e.g. a large server farm).
- An average human brain is capable of remembering relatively simple passwords (~20-30 bits of entropy) that are much weaker than keys used for modern block ciphers (128/256 bits).

A solution for it would be encrypting data with a strong key stored securely somewhere else, for example at your TPM chip or YubiKey or some network service. Clevis is a framework that implements this idea. It allows to encrypt (in terms of clevis bind) data with a pluggable pin. Currently clevis implements 3 pins:

- TPM2 data binding (works only if you have a Trusted Platform Module chip at your computer)
- Network service (called Tang) data binding
- Shamir's Secret Sharing that allows you to combine other pins.
- YubiKey binding using an external plugin.

Warning If you use this method on your root volume, this means that, as long as the previously mentioned certain conditions are met, your computer will unlock automatically at boot without needing to enter an encryption password.

- This means that access to data is not protected in case the hardware gets stolen.
- Be aware that this method makes you more vulnerable to cold boot attacks, because even if your computer has been powered off for a long time (ensuring the memory is completely cleared), an attacker could simply turn it on and wait for the TPM to load the key automatically. This may be a concern for high-value targets.

## Installation

To use clevis install clevis package.

## Bind some data

Here is an example of data binding with TPM2:

    $ clevis encrypt tpm2 '{}' <<< 'hello, world'

     ..1P2Emag_4k-GlhyY.MuQQYPa8QHrysZ74uA.0ddDxfZA3R-cCmaKu5yUZA

This long base64-encoded message is our text encrypted with an internal TPM key. It can be decrypted at the current computer only. Trying to decrypt it from another computer (or rather with another TPM chip) will return an error.

    $ clevis decrypt tpm2 '{}' <<< ' ..1P2Emag_4k-GlhyY.MuQQYPa8QHrysZ74uA.0ddDxfZA3R-cCmaKu5yUZA'

    hello, world

## Bind a LUKS volume

This article or section needs language, wiki syntax or style improvements. See Help:Style for reference.

Reason: please use the first argument of the template to provide a brief explanation. (Discuss in Talk:Clevis)
Warning Set a strong backup password in case the TPM unsealing fails, using:

    # cryptsetup luksAddKey /dev/sdX

To bind a LUKS volume to the TPM, use:

    # clevis luks bind -d /dev/sdX tpm2 '{}'

where `'{}'` contains the configuration: even with no parameters the drive cannot be decrypted from another computer, unless the attacker knows the backup password.

Note To seal the LUKS key against the UEFI settings and the Secure Boot policy, use:

    '{"pcr_ids":"1,7"}'

If the UEFI or Secure Boot settings are modified, the TPM will compute different PCR values and decryption will fail. This gives protection against evil maid attacks.

For a list of parameters, see clevis-encrypt-tpm2(1) § CONFIG.

For a simplified explanation of the meaning of PCRs, see Trusted Platform Module#Accessing PCR registers.

For a full explanation of the meanings of PCRs, see the TCG specification (§ 2.3.4).

If this fails with `ERROR: pcr-input-file filesize does not match pcr set-list`, you should specify a different pcr bank:

    '{"pcr_bank":"sha256","pcr_ids":"1,7"}'

As of August 2022 Clevis only supports sha1 (default) and sha256 banks, so naturally the only different option is sha256 - you can look up available and used banks using `# tpm2_pcrread`.

To generate a new Clevis pin after changes in system configuration that result in different PCR values, for example updating the UEFI when PCR 0 is used, run

    # cryptsetup luksDump /dev/sdX

    Tokens:
      token slot: clevis
            Keyslot:  keyslot

to find the slot used for the Clevis pin, then

    # clevis luks regen -d /dev/sdX -s keyslot

To remove the Clevis binding, run:

    # clevis luks unbind -d /dev/sdX -s keyslot

Warning Double check you have chosen the right slot, or you might lose access to your volume.

You can unlock a TPM-bound volume using:

    # clevis luks unlock -d /dev/sdX

For automated decryption of volumes in /etc/crypttab, enable `clevis-luks-askpass.path`.

For automated decryption of the root volume, we should make some changes to our Initramfs generators:

### Mkinitcpio hook

Install the mkinitcpio-clevis-hookAUR package. Then enable the clevis hook editing mkinitcpio.conf:

    /etc/mkinitcpio.conf

    # Edit the hooks and add clevis before the 'encrypt' hook. Eg:
    HOOKS=(.. clevis encrypt ..)

Note If you are using plymouth, replace the `plymouth-encrypt` hook with encrypt. `plymouth-encrypt` is reported to be buggy when the device is already unlocked. More info.
Note Clevis's integration with Tang requires curl present in the initramfs. Add it to the `BINARIES` array:

    /etc/mkinitcpio.conf

    BINARIES=(/usr/bin/curl)

Don't forget to perform network configuration. Using the mkinitcpio net hook is one way to do so.

At the end regenerate the initramfs.

### Booster

Luckily Booster automatically decrypts LUKS volumes bound using Clevis out of the box!

Booster is also able to read the LUKS tokens, decode clevis information, reconstruct the password and unlock the partition automatically.

Tang (network binding) pin requires network enabled. Please refer to Booster#Configuration section for more information on network configuration with booster.

### Dracut

Dracut needs the following extra packages:

- libpwquality
- luksmeta
- nmap

Followed by an initramfs regeneration:

    # dracut -f

Note If you intend to use Clevis' tang PIN to unlock your drive(s), `curl` must be included in the kernel image. Add a file to `/etc/dracut.conf.d` telling dracut to include it before running `dracut -f`:

    /etc/dracut.conf.d/curl.conf

    install_items+=" /usr/bin/curl "

## Tips and tricks

### YubiKey binding

Clevis allows binding a LUKS partition using YubiKey's challenge-response mode. To bind a LUKS partition, run

    # clevis luks bind -d /dev/sdX yubikey '{"slot":1}'

Install yubikey-personalization. Edit the configuration file and add following option:

    /etc/booster.yaml

    extra_files: ykchalresp

Regenerate the booster images. Booster will detect this configuration during boot and use the present YubiKey to unlock the drive.

## See also

- Project homepage
- mkinitcpio-clevis-hook's homepage

Hidden category:

- Pages or sections flagged with Template:Style

Clevis
Add topic