commit 929f0156ccb2eeed30afa968d3663238ca086fcc · pyrox.dev/nixpkgs

+1 -1

nixos/doc/manual/configuration/file-systems.xml

···

       53
       53
        
          "nofail" ];</literal>.

     

       54
       54
        
         </para>

     

       55
       55
        
        </note>

     

       56
       56
       -
        <xi:include href="luks-file-systems.xml" />

     

       56
       56
       +
        <xi:include href="../from_md/configuration/luks-file-systems.section.xml" />

     

       57
       57
        
        <xi:include href="../from_md/configuration/sshfs-file-systems.section.xml" />

     

       58
       58
        
       </chapter>

+77

nixos/doc/manual/configuration/luks-file-systems.section.md

···

       1
       1
       +
       # LUKS-Encrypted File Systems {#sec-luks-file-systems}

     

       2
       2
       +
       

     

       3
       3
       +
       NixOS supports file systems that are encrypted using *LUKS* (Linux

     

       4
       4
       +
       Unified Key Setup). For example, here is how you create an encrypted

     

       5
       5
       +
       Ext4 file system on the device

     

       6
       6
       +
       `/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d`:

     

       7
       7
       +
       

     

       8
       8
       +
       ```ShellSession

     

       9
       9
       +
       # cryptsetup luksFormat /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d

     

       10
       10
       +
       

     

       11
       11
       +
       WARNING!

     

       12
       12
       +
       ========

     

       13
       13
       +
       This will overwrite data on /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d irrevocably.

     

       14
       14
       +
       

     

       15
       15
       +
       Are you sure? (Type uppercase yes): YES

     

       16
       16
       +
       Enter LUKS passphrase: ***

     

       17
       17
       +
       Verify passphrase: ***

     

       18
       18
       +
       

     

       19
       19
       +
       # cryptsetup luksOpen /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d crypted

     

       20
       20
       +
       Enter passphrase for /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d: ***

     

       21
       21
       +
       

     

       22
       22
       +
       # mkfs.ext4 /dev/mapper/crypted

     

       23
       23
       +
       ```

     

       24
       24
       +
       

     

       25
       25
       +
       The LUKS volume should be automatically picked up by

     

       26
       26
       +
       `nixos-generate-config`, but you might want to verify that your

     

       27
       27
       +
       `hardware-configuration.nix` looks correct. To manually ensure that the

     

       28
       28
       +
       system is automatically mounted at boot time as `/`, add the following

     

       29
       29
       +
       to `configuration.nix`:

     

       30
       30
       +
       

     

       31
       31
       +
       ```nix

     

       32
       32
       +
       boot.initrd.luks.devices.crypted.device = "/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d";

     

       33
       33
       +
       fileSystems."/".device = "/dev/mapper/crypted";

     

       34
       34
       +
       ```

     

       35
       35
       +
       

     

       36
       36
       +
       Should grub be used as bootloader, and `/boot` is located on an

     

       37
       37
       +
       encrypted partition, it is necessary to add the following grub option:

     

       38
       38
       +
       

     

       39
       39
       +
       ```nix

     

       40
       40
       +
       boot.loader.grub.enableCryptodisk = true;

     

       41
       41
       +
       ```

     

       42
       42
       +
       

     

       43
       43
       +
       ## FIDO2 {#sec-luks-file-systems-fido2}

     

       44
       44
       +
       

     

       45
       45
       +
       NixOS also supports unlocking your LUKS-Encrypted file system using a

     

       46
       46
       +
       FIDO2 compatible token. In the following example, we will create a new

     

       47
       47
       +
       FIDO2 credential and add it as a new key to our existing device

     

       48
       48
       +
       `/dev/sda2`:

     

       49
       49
       +
       

     

       50
       50
       +
       ```ShellSession

     

       51
       51
       +
       # export FIDO2_LABEL="/dev/sda2 @ $HOSTNAME"

     

       52
       52
       +
       # fido2luks credential "$FIDO2_LABEL"

     

       53
       53
       +
       f1d00200108b9d6e849a8b388da457688e3dd653b4e53770012d8f28e5d3b269865038c346802f36f3da7278b13ad6a3bb6a1452e24ebeeaa24ba40eef559b1b287d2a2f80b7

     

       54
       54
       +
       

     

       55
       55
       +
       # fido2luks -i add-key /dev/sda2 f1d00200108b9d6e849a8b388da457688e3dd653b4e53770012d8f28e5d3b269865038c346802f36f3da7278b13ad6a3bb6a1452e24ebeeaa24ba40eef559b1b287d2a2f80b7

     

       56
       56
       +
       Password:

     

       57
       57
       +
       Password (again):

     

       58
       58
       +
       Old password:

     

       59
       59
       +
       Old password (again):

     

       60
       60
       +
       Added to key to device /dev/sda2, slot: 2

     

       61
       61
       +
       ```

     

       62
       62
       +
       

     

       63
       63
       +
       To ensure that this file system is decrypted using the FIDO2 compatible

     

       64
       64
       +
       key, add the following to `configuration.nix`:

     

       65
       65
       +
       

     

       66
       66
       +
       ```nix

     

       67
       67
       +
       boot.initrd.luks.fido2Support = true;

     

       68
       68
       +
       boot.initrd.luks.devices."/dev/sda2".fido2.credential = "f1d00200108b9d6e849a8b388da457688e3dd653b4e53770012d8f28e5d3b269865038c346802f36f3da7278b13ad6a3bb6a1452e24ebeeaa24ba40eef559b1b287d2a2f80b7";

     

       69
       69
       +
       ```

     

       70
       70
       +
       

     

       71
       71
       +
       You can also use the FIDO2 passwordless setup, but for security reasons,

     

       72
       72
       +
       you might want to enable it only when your device is PIN protected, such

     

       73
       73
       +
       as [Trezor](https://trezor.io/).

     

       74
       74
       +
       

     

       75
       75
       +
       ```nix

     

       76
       76
       +
       boot.initrd.luks.devices."/dev/sda2".fido2.passwordLess = true;

     

       77
       77
       +
       ```

-78

nixos/doc/manual/configuration/luks-file-systems.xml

···

       1
       1
       -
       <section xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
                xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
                version="5.0"

     

       5
       5
       -
                xml:id="sec-luks-file-systems">

     

       6
       6
       -
        <title>LUKS-Encrypted File Systems</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         NixOS supports file systems that are encrypted using

     

       10
       10
       -
         <emphasis>LUKS</emphasis> (Linux Unified Key Setup). For example, here is how

     

       11
       11
       -
         you create an encrypted Ext4 file system on the device

     

       12
       12
       -
         <filename>/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d</filename>:

     

       13
       13
       -
       <screen>

     

       14
       14
       -
       <prompt># </prompt>cryptsetup luksFormat <replaceable>/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d</replaceable>

     

       15
       15
       -
       

     

       16
       16
       -
       WARNING!

     

       17
       17
       -
       ========

     

       18
       18
       -
       This will overwrite data on /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d irrevocably.

     

       19
       19
       -
       

     

       20
       20
       -
       Are you sure? (Type uppercase yes): YES

     

       21
       21
       -
       Enter LUKS passphrase: ***

     

       22
       22
       -
       Verify passphrase: ***

     

       23
       23
       -
       

     

       24
       24
       -
       <prompt># </prompt>cryptsetup luksOpen <replaceable>/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d</replaceable> <replaceable>crypted</replaceable>

     

       25
       25
       -
       Enter passphrase for /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d: ***

     

       26
       26
       -
       

     

       27
       27
       -
       <prompt># </prompt>mkfs.ext4 /dev/mapper/<replaceable>crypted</replaceable>

     

       28
       28
       -
       </screen>

     

       29
       29
       -
         The LUKS volume should be automatically picked up by

     

       30
       30
       -
         <command>nixos-generate-config</command>, but you might want to verify that your

     

       31
       31
       -
         <filename>hardware-configuration.nix</filename> looks correct.

     

       32
       32
       -
       

     

       33
       33
       -
         To manually ensure that the system is automatically mounted at boot time as

     

       34
       34
       -
         <filename>/</filename>, add the following to

     

       35
       35
       -
         <filename>configuration.nix</filename>:

     

       36
       36
       -
       <programlisting>

     

       37
       37
       -
       <link linkend="opt-boot.initrd.luks.devices._name_.device">boot.initrd.luks.devices.crypted.device</link> = "<replaceable>/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d</replaceable>";

     

       38
       38
       -
       <xref linkend="opt-fileSystems"/>."/".device = "/dev/mapper/<replaceable>crypted</replaceable>";

     

       39
       39
       -
       </programlisting>

     

       40
       40
       -
         Should grub be used as bootloader, and <filename>/boot</filename> is located

     

       41
       41
       -
         on an encrypted partition, it is necessary to add the following grub option:

     

       42
       42
       -
       <programlisting><xref linkend="opt-boot.loader.grub.enableCryptodisk"/> = true;</programlisting>

     

       43
       43
       -
        </para>

     

       44
       44
       -
         <section xml:id="sec-luks-file-systems-fido2">

     

       45
       45
       -
         <title>FIDO2</title>

     

       46
       46
       -
       

     

       47
       47
       -
         <para>

     

       48
       48
       -
          NixOS also supports unlocking your LUKS-Encrypted file system using a FIDO2 compatible token. In the following example, we will create a new FIDO2 credential

     

       49
       49
       -
          and add it as a new key to our existing device <filename>/dev/sda2</filename>:

     

       50
       50
       -
       

     

       51
       51
       -
          <screen>

     

       52
       52
       -
       <prompt># </prompt>export FIDO2_LABEL="<replaceable>/dev/sda2</replaceable> @ $HOSTNAME"

     

       53
       53
       -
       <prompt># </prompt>fido2luks credential "$FIDO2_LABEL"

     

       54
       54
       -
       f1d00200108b9d6e849a8b388da457688e3dd653b4e53770012d8f28e5d3b269865038c346802f36f3da7278b13ad6a3bb6a1452e24ebeeaa24ba40eef559b1b287d2a2f80b7

     

       55
       55
       -
       

     

       56
       56
       -
       <prompt># </prompt>fido2luks -i add-key <replaceable>/dev/sda2</replaceable> <replaceable>f1d00200108b9d6e849a8b388da457688e3dd653b4e53770012d8f28e5d3b269865038c346802f36f3da7278b13ad6a3bb6a1452e24ebeeaa24ba40eef559b1b287d2a2f80b7</replaceable>

     

       57
       57
       -
       Password:

     

       58
       58
       -
       Password (again):

     

       59
       59
       -
       Old password:

     

       60
       60
       -
       Old password (again):

     

       61
       61
       -
       Added to key to device /dev/sda2, slot: 2

     

       62
       62
       -
       </screen>

     

       63
       63
       -
       

     

       64
       64
       -
         To ensure that this file system is decrypted using the FIDO2 compatible key, add the following to <filename>configuration.nix</filename>:

     

       65
       65
       -
       <programlisting>

     

       66
       66
       -
       <link linkend="opt-boot.initrd.luks.fido2Support">boot.initrd.luks.fido2Support</link> = true;

     

       67
       67
       -
       <link linkend="opt-boot.initrd.luks.devices._name_.fido2.credential">boot.initrd.luks.devices."<replaceable>/dev/sda2</replaceable>".fido2.credential</link> = "<replaceable>f1d00200108b9d6e849a8b388da457688e3dd653b4e53770012d8f28e5d3b269865038c346802f36f3da7278b13ad6a3bb6a1452e24ebeeaa24ba40eef559b1b287d2a2f80b7</replaceable>";

     

       68
       68
       -
       </programlisting>

     

       69
       69
       -
       

     

       70
       70
       -
         You can also use the FIDO2 passwordless setup, but for security reasons, you might want to enable it only when your device is PIN protected, such as <link xlink:href="https://trezor.io/">Trezor</link>.

     

       71
       71
       -
       

     

       72
       72
       -
       <programlisting>

     

       73
       73
       -
       <link linkend="opt-boot.initrd.luks.devices._name_.fido2.passwordLess">boot.initrd.luks.devices."<replaceable>/dev/sda2</replaceable>".fido2.passwordLess</link> = true;

     

       74
       74
       -
       </programlisting>

     

       75
       75
       -
         </para>

     

       76
       76
       -
        </section>

     

       77
       77
       -
       

     

       78
       78
       -
       </section>

+84

nixos/doc/manual/from_md/configuration/luks-file-systems.section.xml

···

       1
       1
       +
       <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-luks-file-systems">

     

       2
       2
       +
         <title>LUKS-Encrypted File Systems</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           NixOS supports file systems that are encrypted using

     

       5
       5
       +
           <emphasis>LUKS</emphasis> (Linux Unified Key Setup). For example,

     

       6
       6
       +
           here is how you create an encrypted Ext4 file system on the device

     

       7
       7
       +
           <literal>/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d</literal>:

     

       8
       8
       +
         </para>

     

       9
       9
       +
         <programlisting>

     

       10
       10
       +
       # cryptsetup luksFormat /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d

     

       11
       11
       +
       

     

       12
       12
       +
       WARNING!

     

       13
       13
       +
       ========

     

       14
       14
       +
       This will overwrite data on /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d irrevocably.

     

       15
       15
       +
       

     

       16
       16
       +
       Are you sure? (Type uppercase yes): YES

     

       17
       17
       +
       Enter LUKS passphrase: ***

     

       18
       18
       +
       Verify passphrase: ***

     

       19
       19
       +
       

     

       20
       20
       +
       # cryptsetup luksOpen /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d crypted

     

       21
       21
       +
       Enter passphrase for /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d: ***

     

       22
       22
       +
       

     

       23
       23
       +
       # mkfs.ext4 /dev/mapper/crypted

     

       24
       24
       +
       </programlisting>

     

       25
       25
       +
         <para>

     

       26
       26
       +
           The LUKS volume should be automatically picked up by

     

       27
       27
       +
           <literal>nixos-generate-config</literal>, but you might want to

     

       28
       28
       +
           verify that your <literal>hardware-configuration.nix</literal> looks

     

       29
       29
       +
           correct. To manually ensure that the system is automatically mounted

     

       30
       30
       +
           at boot time as <literal>/</literal>, add the following to

     

       31
       31
       +
           <literal>configuration.nix</literal>:

     

       32
       32
       +
         </para>

     

       33
       33
       +
         <programlisting language="bash">

     

       34
       34
       +
       boot.initrd.luks.devices.crypted.device = &quot;/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d&quot;;

     

       35
       35
       +
       fileSystems.&quot;/&quot;.device = &quot;/dev/mapper/crypted&quot;;

     

       36
       36
       +
       </programlisting>

     

       37
       37
       +
         <para>

     

       38
       38
       +
           Should grub be used as bootloader, and <literal>/boot</literal> is

     

       39
       39
       +
           located on an encrypted partition, it is necessary to add the

     

       40
       40
       +
           following grub option:

     

       41
       41
       +
         </para>

     

       42
       42
       +
         <programlisting language="bash">

     

       43
       43
       +
       boot.loader.grub.enableCryptodisk = true;

     

       44
       44
       +
       </programlisting>

     

       45
       45
       +
         <section xml:id="sec-luks-file-systems-fido2">

     

       46
       46
       +
           <title>FIDO2</title>

     

       47
       47
       +
           <para>

     

       48
       48
       +
             NixOS also supports unlocking your LUKS-Encrypted file system

     

       49
       49
       +
             using a FIDO2 compatible token. In the following example, we will

     

       50
       50
       +
             create a new FIDO2 credential and add it as a new key to our

     

       51
       51
       +
             existing device <literal>/dev/sda2</literal>:

     

       52
       52
       +
           </para>

     

       53
       53
       +
           <programlisting>

     

       54
       54
       +
       # export FIDO2_LABEL=&quot;/dev/sda2 @ $HOSTNAME&quot;

     

       55
       55
       +
       # fido2luks credential &quot;$FIDO2_LABEL&quot;

     

       56
       56
       +
       f1d00200108b9d6e849a8b388da457688e3dd653b4e53770012d8f28e5d3b269865038c346802f36f3da7278b13ad6a3bb6a1452e24ebeeaa24ba40eef559b1b287d2a2f80b7

     

       57
       57
       +
       

     

       58
       58
       +
       # fido2luks -i add-key /dev/sda2 f1d00200108b9d6e849a8b388da457688e3dd653b4e53770012d8f28e5d3b269865038c346802f36f3da7278b13ad6a3bb6a1452e24ebeeaa24ba40eef559b1b287d2a2f80b7

     

       59
       59
       +
       Password:

     

       60
       60
       +
       Password (again):

     

       61
       61
       +
       Old password:

     

       62
       62
       +
       Old password (again):

     

       63
       63
       +
       Added to key to device /dev/sda2, slot: 2

     

       64
       64
       +
       </programlisting>

     

       65
       65
       +
           <para>

     

       66
       66
       +
             To ensure that this file system is decrypted using the FIDO2

     

       67
       67
       +
             compatible key, add the following to

     

       68
       68
       +
             <literal>configuration.nix</literal>:

     

       69
       69
       +
           </para>

     

       70
       70
       +
           <programlisting language="bash">

     

       71
       71
       +
       boot.initrd.luks.fido2Support = true;

     

       72
       72
       +
       boot.initrd.luks.devices.&quot;/dev/sda2&quot;.fido2.credential = &quot;f1d00200108b9d6e849a8b388da457688e3dd653b4e53770012d8f28e5d3b269865038c346802f36f3da7278b13ad6a3bb6a1452e24ebeeaa24ba40eef559b1b287d2a2f80b7&quot;;

     

       73
       73
       +
       </programlisting>

     

       74
       74
       +
           <para>

     

       75
       75
       +
             You can also use the FIDO2 passwordless setup, but for security

     

       76
       76
       +
             reasons, you might want to enable it only when your device is PIN

     

       77
       77
       +
             protected, such as

     

       78
       78
       +
             <link xlink:href="https://trezor.io/">Trezor</link>.

     

       79
       79
       +
           </para>

     

       80
       80
       +
           <programlisting language="bash">

     

       81
       81
       +
       boot.initrd.luks.devices.&quot;/dev/sda2&quot;.fido2.passwordLess = true;

     

       82
       82
       +
       </programlisting>

     

       83
       83
       +
         </section>

     

       84
       84
       +
       </section>