LVM on LUKS

Introduction

This documentation describes how to set up Alpine Linux on a fully encrypted disk (apart from the bootloader partition). We will have an LVM container installed inside an encrypted partition that contains the root partition and the swap partition. To encrypt the partition containing the LVM volume group, dm-crypt (which is managed by the cryptsetup command) and its LUKS subsystem is used.

Note: The setup-alpine installation scripts has support for encrypted installations since v3.13. The default encryption options will not encrypt the swap partition and will not use LUKS, but is much easier to use.

Note that your /boot/ partition must be non-encrypted to work with Syslinux. When using GRUB2 it is possible to boot from an encrypted partition to provide a layer of protection from Evil Maid attacks, but Syslinux doesn't support that.

Storage Device Name

To find your storage device's name, you could either install util-linux (apk add util-linux) and find your device using the lsblk command, or you could make an educated guess by using BusyBox's blkid and df commands, and running ls /dev/sd* if you are installing to a USB, SATA or SCSI device, ls /dev/fd* for floppy disks and ls /dev/hd* for IDE (PATA) devices.

The following documentation uses the /dev/sda device as installation destination. If your environment uses a different name for your storage device, use the corresponding device name in the examples.

Setting up Alpine Linux Using LVM on Top of a LUKS Partition

To install Alpine Linux on logical volumes running on top of a LUKS encrypted partition, you cannot use the official installation procedure. The installation requires several manual steps you must run in the Alpine Linux Live CD environment.

Preparing the Temporary Installation Environment

Before you begin to install Alpine Linux, prepare the temporary environment:

Boot the latest Alpine Linux Installation CD. At the login prompt, use the root user without a password to log in. Now we will follow the Setup-alpine script and make our changes along the way.

Run the scripts in this order:

# setup-keymap
# setup-hostname
# setup-interfaces
# rc-service networking start

If you are configuring static networking (i.e. you didn't configure any interfaces to use DHCP), run setup-dns.

If you are using Wi-Fi you may need to do run rc-update add wpa_supplicant boot.

Note: On versions of OpenRC prior to 0.45 use urandom instead of seedrng

# passwd
# setup-timezone
# rc-update add networking boot
# rc-update add seedrng boot
# rc-update add acpid default
# rc-service acpid start

Edit your /etc/hosts to look like this, replacing <hostname> with your hostname and <domain> with your TLD (if you don't have a TLD, use 'localdomain':

Tip: The default text editor in BusyBox is vi (pronounced vee-eye).

Contents of /etc/hosts

127.0.0.1 <hostname> <hostname>.<domain> localhost localhost.localdomain ::1 <hostname> <hostname>.<domain> localhost localhost.localdomain

# setup-ntp
# setup-apkrepos
# apk update
# setup-sshd

Here's where we deviate from the install script.

Install the following packages required to set up LVM and LUKS:

Note: The parted partition editor is needed for advanced partitioning and GPT disklabels. BusyBox fdisk is a very stripped-down version with minimal functionality

# apk add lvm2 cryptsetup e2fsprogs parted mkinitfs

Creating the Partition Layout

Depending on your motherboard, bios features and configuration we can either use partition table in MBR (legacy BIOS) or GUID Partition Table (GPT). We'll describe both with example layouts.

BIOS/MBR with DOS disklabel

We'll be partitioning the storage device with a non-encrypted /boot partition for use with the Syslinux bootloader. Syslinux is meant for use with legacy BIOS and an MSDOS MBR partition table.
Syslinux does support GPT partition tables but GRUB2 is the better option for UEFI (UEFI is possible only with GPT).

+---------------------------+------------------------+-----------------------+
| Partition name            | Partition purpose      | Filesystem type       |
+---------------------------+------------------------+-----------------------+
| /dev/sda1                 | Boot partition         | ext4                  |
| /dev/sda2                 | LUKS container         | LUKS                  |
| |-> /dev/mapper/lvmcrypt  | LVM container          | LVM                   |
|  |-> /dev/vg01/root       | Root partition         | ext4                  |
|  |-> /dev/vg01/swap       | Swap partition         | swap                  |
+---------------------------+------------------------+-----------------------+

Warning: This will delete an existing partition table and make your data very hard to recover. If you want to dual boot, stop here and ask an expert.

Create a partition of approximately 100MB to boot from, then assign the rest of the space to your LUKS partition.

# parted -a optimal
(parted) mklabel msdos
(parted) mkpart primary ext4 0% 100M
(parted) set 1 boot on
(parted) mkpart primary ext4 100M 100%

To view your partition table, type print while still in parted. Your results should look something like this:

(parted) print
Model: ATA TOSHIBA ******** (scsi)
Disk /dev/sda: 1000GB
Sector size (logical/physical): 512B/4096B
Partition Table: msdos
Disk Flags:

Number  Start   End     Size    Type     File system  Flags
 1      1049kB  99.6MB  98.6MB  primary  ext4         boot
 2      99.6MB  1000GB  1000GB  primary  ext4

UEFI with GPT disklabel

We will be encrypting the whole disk except for the EFI system partition mounted at /boot/efi. This means GRUB2 will decrypt the LUKS volume and load the kernel from there, preventing someone with physical access to your computer from maliciously installing a rootkit (or bootkit) in your boot partition while your computer is not unlocked. The partitioning scheme will look like this:

+---------------------------+------------------------+-----------------------+
| Partition name            | Partition purpose      | Filesystem type       |
+---------------------------+------------------------+-----------------------+
| /dev/sda1                 | EFI system partition   | fat32                 |
| /dev/sda2                 | LUKS container         | LUKS                  |
| |-> /dev/mapper/lvmcrypt  | LVM container          | LVM                   |
|  |-> /dev/vg01/root       | Root partition         | ext4                  |
|  |-> /dev/vg01/boot       | Boot partition         | ext4                  |
|  |-> /dev/vg01/swap       | Swap partition         | swap                  |
+---------------------------+------------------------+-----------------------+

Warning: This will delete an existing partition table and make your data very hard to recover. If you want to dual boot, stop here and ask an expert.

Create an EFI system partition of approximately 200MB, then assign the rest of the space to your LUKS partition.

# parted -a optimal
(parted) mklabel gpt
(parted) mkpart primary fat32 0% 200M
(parted) name 1 esp
(parted) set 1 esp on
(parted) mkpart primary ext4 200M 100%
(parted) name 2 crypto-luks

Optional: Overwrite LUKS Partition with Random Data

This should be done if your hard drive wasn't encrypted previously. It helps purge old, non-encrypted data and makes it harder for an attacker to work out how much data you have on your drive if they have access to the encrypted contents.

# dd if=/dev/urandom of=/dev/sda2 bs=1M

Encrypting the LVM Physical Volume Partition

To encrypt the partition that will later contain the LVM PV, you could either use the default settings (aes-xts-plain64 cipher with 256-bit key and Argon2 hashing with iter-time 2000ms), or you could use these settings which have added security with the trade-off being a non-noticeable decrease in performance on modern computers:

Default settings:

# cryptsetup luksFormat /dev/sda2

Luks1 Optimized for security:

# cryptsetup -v -c serpent-xts-plain64 -s 512 --hash sha512 --iter-time 5000 --use-random luksFormat --type luks1 /dev/sda2

Luks2 Optimized for security:

# cryptsetup -v -c aes-xts-plain64 -s 512 --hash sha512 --pbkdf pbkdf2 --iter-time 5000 --use-random luksFormat /dev/sda2

Converting between LUKS2 and LUKS1

It is sometimes possible to convert a LUKS2 volume to a LUKS1 volume. First take a backup of the LUKS header that you can restore if anything goes wrong:

# cryptsetup luksHeaderBackup /dev/sda2 --header-backup-file sda2-luks-header-backup

Then make sure all keys use pbkdf2 by adding a new key with:

# cryptsetup luksAddKey --pbkdf pbkdf2 /dev/sda2

Remove keys that use argon2i or argon2id with cryptsetup luksRemoveKey /dev/sda2. You can check the key information using cryptsetup luksDump /dev/sda2.

Now you can try the conversion, although it may not work.

# cryptsetup convert /dev/sda2 --type luks1

Creating the Logical Volumes and File Systems

Open the LUKS partition:

# cryptsetup luksOpen /dev/sda2 lvmcrypt

Create the PV on lvmcrypt:

# pvcreate /dev/mapper/lvmcrypt

Create the vg0 LVM VG in the /dev/mapper/lvmcrypt PV:

# vgcreate vg0 /dev/mapper/lvmcrypt

LV Creation for BIOS/MBR

This will create a 2GB swap partition and a root partition which takes up the rest of the space. This setup is for those who do not need to use the hibernate/suspend to disk state. If you do need to suspend to disk, create a swap partition slightly larger than the size of your RAM (change the size after # lvcreate -L).

# lvcreate -L 2G vg0 -n swap
# lvcreate -l 100%FREE vg0 -n root

The LVs created in the previous steps are automatically marked active. To verify, enter:

# lvscan

LV Creation for UEFI/GPT

This will create a 2GB swap partition, a 2GB boot partition and a root partition which takes up the rest of the space. This setup is for those who do not need to use the hibernate/suspend to disk state. If you do need to suspend to disk, create a swap partition slightly larger than the size of your RAM (change the size after # lvcreate -L).

# lvcreate -L 2G vg0 -n swap
# lvcreate -L 2G vg0 -n boot
# lvcreate -l 100%FREE vg0 -n root

The LVs created in the previous steps are automatically marked active. To verify, enter:

# lvscan

Creating and Mounting the File Systems

Format the root and boot LVs using the ext4 file system:

# mkfs.ext4 /dev/vg0/root

Format the swap LV:

# mkswap /dev/vg0/swap

Before you can install Alpine Linux, you must mount the partitions and LVs. Mount the root LV to the /mnt/ directory:

# mount -t ext4 /dev/vg0/root /mnt/

Next format your boot partition, create a mount point, then mount it:

• If you're using BIOS and MBR:

# mkfs.ext4 /dev/sda1
# mkdir -v /mnt/boot
# mount -t ext4 /dev/sda1 /mnt/boot

• If you're using UEFI and GPT:

# apk add dosfstools
# mkfs.fat -F32 /dev/sda1
# mkfs.ext4 /dev/vg0/boot
# mkdir -v /mnt/boot
# mount -t ext4 /dev/vg0/boot /mnt/boot
# mkdir -v /mnt/boot/efi
# mount -t vfat /dev/sda1 /mnt/boot/efi

Lastly, activate your swap partition:

# swapon /dev/vg0/swap

Installing Alpine Linux

In this step you will install Alpine Linux in the /mnt/ directory, which contains the mounted file system structure:

# setup-disk -m sys /mnt/

The installer downloads the latest packages to install the base installation. Additionally, the installer automatically creates the entries for the mount points in /etc/fstab file, which is currently mounted in the /mnt/ directory.

Note: The automatic writing of the master boot record (MBR) fails in this step. Later, you'll manually write the MBR to the disk.

The swap LV is not automatically added to the fstab file. so we need to add the following line to the /mnt/etc/fstab file:

/dev/vg0/swap    swap    swap    defaults    0 0

Edit the /mnt/etc/mkinitfs/mkinitfs.conf file and append the cryptsetup module to the features parameter:

features="... cryptsetup"

If you are using GRUB with an encrypted /boot you must add the cryptkey feature so that Alpine can use a keyfile for decryption on boot.

Note: Alpine Linux uses the en-us keyboard mapping by default when prompting for the password to decrypt the partition at boot time. If you changed the keyboard mapping in the temporary environment and want to use it at the boot password prompt, be sure to add the keymap feature to the list above.

Note: Check the output of mkinitfs -L and add the features necessary for your system to boot. You may need to add kms in order to see a password prompt at boot. You may also need: usb, lvm, ext4, nvme...

Rebuild the initial RAM disk:

# mkinitfs -c /mnt/etc/mkinitfs/mkinitfs.conf -b /mnt/ $(ls /mnt/lib/modules/)

The command uses the settings from the mkinitfs.conf file set in the -c parameter to generate the RAM disk. The command is executed in the /mnt/ directory and the RAM disk is generated using the modules for the installed kernel. Without setting the kernel version using the $(ls /mnt/lib/modules/) option, mkinitfs tries to generate the RAM disk using the kernel version installed in the temporary environment, which can differ from the latest one installed by the setup-disk utility.

Installing a bootloader

To get the UUID of your storage device into a file for later use, run this command:

# blkid -s UUID -o value /dev/sda2 > ~/uuid

Tip: To easily read the UUID into a file so you don't have to type it manually, open the file in vi, then type :r /root/uuid to load the UUID onto a new line.

Syslinux with BIOS

Install the Syslinux package:

# apk add syslinux

Edit /mnt/etc/update-extlinux.conf and append the following kernel options to the default_kernel_opts parameter, replacing <UUID> with the UUID of /dev/sda2:

default_kernel_opts="... cryptroot=UUID=<UUID of sda2> cryptdm=lvmcrypt"

The cryptroot parameter sets the ID of the device/partition that contains encrypted volumes, and the cryptdm parameter uses the name of the mapping we have already configured a few lines above.

We can also double check if modules and root are set correctly, eg:

modules=sd-mod,usb-storage,ext4,cryptsetup,keymap,cryptkey,kms,lvm
root=UUID=<UUID of /dev/mapper/vg0-root>

Because the update-extlinux utility operates only on the /boot/ directory, temporarily change the root to the /mnt/ directory and update the boot loader configuration:

# chroot /mnt/
# update-extlinux
# exit

Because we didn't mount /dev nor /proc inside our /mnt/ chroot, some errors may occur when we run update-extlinux command. But you can most likely ignore these.

Write the MBR (without partition table) to the /dev/sda device:

# dd bs=440 count=1 conv=notrunc if=/mnt/usr/share/syslinux/mbr.bin of=/dev/sda

Grub with UEFI

To avoid having to type your decryption password twice every boot (once for GRUB and once for Alpine), add a keyfile to your LUKS partition. The filename is important.

# touch /mnt/crypto_keyfile.bin
# chmod 600 /mnt/crypto_keyfile.bin
# dd bs=512 count=4 if=/dev/urandom of=/mnt/crypto_keyfile.bin
# cryptsetup luksAddKey /dev/sda2 /mnt/crypto_keyfile.bin

This keyfile is stored encrypted (it is in your LUKS partition), so its presence does not affect system security.

Mount the required filesystems for the Grub EFI installer to the installation:

# mount -t proc /proc /mnt/proc
# mount --rbind /dev /mnt/dev
# mount --make-rslave /mnt/dev
# mount --rbind /sys /mnt/sys

Then run chroot:

# chroot /mnt
# source /etc/profile
# export PS1="(chroot) $PS1"

Install GRUB2 for EFI and (optionally) remove syslinux:

# apk add grub grub-efi efibootmgr
# apk del syslinux

Edit /etc/default/grub and add the following kernel options to the GRUB_CMDLINE_LINUX_DEFAULT parameter, replacing <UUID> with the UUID of the encrypted partition (in this case, /dev/sda2):

cryptroot=UUID=<UUID> cryptdm=lvmcrypt cryptkey

The cryptroot parameter sets the ID of the device/partition that contains encrypted volumes, and the cryptdm parameter uses the name of the mapping we configured a few lines above. The cryptkey parameter indicates the existence of the file /crypto_keyfile.bin you created previously.

To enable GRUB to decrypt LUKS partitions and read LVM volumes add:

GRUB_PRELOAD_MODULES="luks cryptodisk part_gpt lvm"

If using Alpine v3.11 or later, GRUB_ENABLE_CRYPTODISK=y should also be added to /etc/default/grub.

Luks1

# (chroot) grub-install --target=x86_64-efi --efi-directory=/boot/efi
# (chroot) grub-mkconfig -o /boot/grub/grub.cfg
# (chroot) exit

Luks2

Note: The method is still experimental and you may lose your access to you OS at the next OS update

Create a pre-config grub file: /root/grub-pre.cfg

set crypto_uuid=00001
cryptomount -u $crypto_uuid
set root='lvmid/00002/00003'
set prefix=($root)/boot/grub
insmod normal
normal

You can find:

• 00001 with blkid and find the uuid of your encrypted disk, i.e /dev/nvme0n1p2 remove hyphens from the UUID
• 00002 with vgdisplay & VG UUID
• 00003 with lvdisplay & LV UUID of the root partition /

# (chroot) grub-mkimage -p /boot/grub -O x86_64-efi -c /root/grub-pre.cfg -o /tmp/grubx64.efi luks2 part_gpt cryptodisk lvm ext2 gcry_rijndael pbkdf2 gcry_sha512
# (chroot) install -v /tmp/grubx64.efi /boot/efi/EFI/grub/
# (chroot) grub-mkconfig -o /boot/grub/grub.cfg
# (chroot) exit

Unmounting the Volumes and Partitions

Unmount the /mnt/ partitions, deactivate the LVM volumes, close the LUKS partition and reboot:

# cd
# umount -l /mnt/dev
# umount -l /mnt/proc
# umount -l /mnt/sys
# umount /mnt/boot/efi
# umount /mnt/boot
# swapoff /dev/vg0/swap
# umount /mnt
# vgchange -a n
# cryptsetup luksClose lvmcrypt
# reboot

Troubleshooting

General Procedure

In case your system fails to boot, you can verify the settings and fix incorrect configurations.

Reboot and do the steps in Prepare the temporary installation environment again.

Setup the LUKS partition and activate the LVs:

# cryptsetup luksOpen /dev/sda2 lvmcrypt
# vgchange -ay

Mount the file systems

Verify that you run the steps described in the Installing Alpine Linux section correctly. Update the configuration if necessary, unmount the partitions, then reboot.

System can't find boot device

* GPT partition table on a motherboard that runs BIOS instead of UEFI
* running an MSDOS/MBR/Syslinux install without enabling legacy boot mode in the UEFI settings

I see "can not mount /sysroot" during boot

* incorrect device UUID
* missing module in /mnt/etc/update-extlinux.conf or /mnt/etc/mkinitfs/mkinitfs.conf

normal.mod not found

* re-install grub-install --target=x86_64-efi

Secure boot

If secure boot complains of an unsigned bootloader, you can either disable it or adapt this guide to sign GRUB. If you're using Syslinux, then secure boot should be automatically disabled when you enable legacy boot mode.

Hardening

• To harden, you should disable DMA[1] and install a hardened version of AES (TRESOR[2] or Loop-Amnesia[3]) since by default cryptsetup with luks uses AES by default.
• Disable DMA in the BIOS and set the password for the BIOS according to Wikipedia.[4]
• Blacklist kernel modules that use DMA and any unused expansion modules (FireWire, CardBus, ExpressCard, Thunderbolt, USB 3.0, PCI Express and hotplug modules) that use DMA.

Mounting additional encrypted filesystems at boot

If you would like other encrypted LUKS partitions to be decrypted and mounted automatically during boot, for example if you have /home on a separate physical drive, some extra steps are required.

Note: This does not apply for volumes within your main encrypted partition /dev/sda2

For the purposes of these instructions we will say /dev/sdb1 contains an LVM volume that should be mounted at /home.

Create a keyfile and add it to the LUKS partition:

# dd bs=512 count=4 if=/dev/urandom of=/root/crypt-home-keyfile.bin
# cryptsetup luksAddKey /dev/sdb1 /root/crypt-home-keyfile.bin

Alpine, like Gentoo, uses the dmcrypt service rather than /etc/crypttab. Add the following lines to /etc/conf.d/dmcrypt:

target=crypt-home
source='/dev/sdb1'
key='/root/crypt-home-keyfile.bin'

Add an entry to /etc/fstab, changing vg1 to the name of your LVM volume group:

/dev/vg1/home /home ext4 rw,relatime 0 2

Enable the dmcrypt and lvm services to start on boot:

# rc-update add dmcrypt boot
# rc-update add lvm boot

After a reboot the partition should be decrypted and mounted automatically.

See also

• Bootloaders
• Alpine setup scripts
• Installing on GPT LVM
• Setting up LVM on GPT-labeled disks
• Setting up disks manually
• https://battlepenguin.com/tech/alpine-linux-with-full-disk-encryption/
• Installing Alpine Linux with full disk encryption on BIOS/MBR systems with a custom partition layout
• https://wiki.archlinux.org/index.php/GRUB
• https://wiki.archlinux.org/index.php/Syslinux
• https://wiki.gentoo.org/wiki/Dm-crypt
• https://wiki.gentoo.org/wiki/GRUB2
• https://wiki.gentoo.org/wiki/Sakaki's_EFI_Install_Guide
• https://wiki.gentoo.org/wiki/Syslinux