commit 72f6935afb54ec7420ba8a687d4dab9e8c67219d · pyrox.dev/nixpkgs

+15

nixos/doc/manual/redirects.json

···

       1
       1
        
       {

     

       2
       2
       +
         "module-boot-plymouth-tpm2-totp": [

     

       3
       3
       +
           "index.html#module-boot-plymouth-tpm2-totp"

     

       4
       4
       +
         ],

     

       5
       5
       +
         "module-boot-plymouth-tpm2-totp-quick-start": [

     

       6
       6
       +
           "index.html#module-boot-plymouth-tpm2-totp-quick-start"

     

       7
       7
       +
         ],

     

       8
       8
       +
         "module-boot-plymouth-tpm2-totp-quick-start-check": [

     

       9
       9
       +
           "index.html#module-boot-plymouth-tpm2-totp-quick-start-check"

     

       10
       10
       +
         ],

     

       11
       11
       +
         "module-boot-plymouth-tpm2-totp-quick-start-configure": [

     

       12
       12
       +
           "index.html#module-boot-plymouth-tpm2-totp-quick-start-configure"

     

       13
       13
       +
         ],

     

       14
       14
       +
         "module-boot-plymouth-tpm2-totp-quick-start-enable": [

     

       15
       15
       +
           "index.html#module-boot-plymouth-tpm2-totp-quick-start-enable"

     

       16
       16
       +
         ],

     

       2
       17
        
         "sec-override-nixos-test": [

     

       3
       18
        
           "index.html#sec-override-nixos-test"

     

       4
       19
        
         ],

+2

nixos/doc/manual/release-notes/rl-2511.section.md

···

       88
       88
        
       

     

       89
       89
        
       - The [Neat IP Address Planner](https://spritelink.github.io/NIPAP/) (NIPAP) can now be enabled through [services.nipap.enable](#opt-services.nipap.enable).

     

       90
       90
        
       

     

       91
       91
       +
       - [tpm2-totp](https://github.com/tpm2-software/tpm2-totp) can now be used to show a TOTP during boot using Plymouth. Available as [boot.plymouth.tpm2-totp](#opt-boot.plymouth.tpm2-totp.enable).

     

       92
       92
       +
       

     

       91
       93
        
       - [nix-store-veritysetup](https://github.com/nikstur/nix-store-veritysetup-generator), a systemd generator to unlock the Nix Store as a dm-verity protected block device. Available as [boot.initrd.nix-store-veritysetup](options.html#opt-boot.initrd.nix-store-veritysetup.enable).

     

       92
       94
        
       

     

       93
       95
        
       - [ente](https://github.com/ente-io/ente), a service that provides a fully open source, end-to-end encrypted platform for photos and videos. Available as [services.ente.api](#opt-services.ente.api.enable) and  [services.ente.web](#opt-services.ente.web.enable).

+1

nixos/modules/module-list.nix

···

       1830
       1830
        
         ./system/boot/modprobe.nix

     

       1831
       1831
        
         ./system/boot/networkd.nix

     

       1832
       1832
        
         ./system/boot/nix-store-veritysetup.nix

     

       1833
       1833
       +
         ./system/boot/plymouth-tpm2-totp.nix

     

       1833
       1834
        
         ./system/boot/plymouth.nix

     

       1834
       1835
        
         ./system/boot/resolved.nix

     

       1835
       1836
        
         ./system/boot/shutdown.nix

+29

nixos/modules/system/boot/plymouth-tpm2-totp.md

···

       1
       1
       +
       # tpm2-totp with Plymouth {#module-boot-plymouth-tpm2-totp}

     

       2
       2
       +
       

     

       3
       3
       +
       [tpm2-totp](https://github.com/tpm2-software/tpm2-totp) attests the trustworthiness of a device against a human using time-based one-time passwords. This module uses a `tpm2-totp` configuration to display a TOTP at boot using Plymouth.

     

       4
       4
       +
       

     

       5
       5
       +
       ## Quick start {#module-boot-plymouth-tpm2-totp-quick-start}

     

       6
       6
       +
       

     

       7
       7
       +
       ### 1. Enable modules {#module-boot-plymouth-tpm2-totp-quick-start-enable}

     

       8
       8
       +
       

     

       9
       9
       +
       ```nix

     

       10
       10
       +
       {

     

       11
       11
       +
         boot.plymouth.tpm2-totp.enable = true;

     

       12
       12
       +
       

     

       13
       13
       +
         # Plymouth and systemd initrd/stage-1 are required:

     

       14
       14
       +
         boot.plymouth.enable = true;

     

       15
       15
       +
         boot.initrd.systemd.enable = true;

     

       16
       16
       +
       }

     

       17
       17
       +
       ```

     

       18
       18
       +
       

     

       19
       19
       +
       Switch to the new configuration before proceeding to the next step.

     

       20
       20
       +
       

     

       21
       21
       +
       ### 2. Configure `tpm2-totp` {#module-boot-plymouth-tpm2-totp-quick-start-configure}

     

       22
       22
       +
       

     

       23
       23
       +
       Generate a new TOTP secret and save the secret in your chosen authenticator app. See `man tpm2-totp` for commands and configuration examples.

     

       24
       24
       +
       

     

       25
       25
       +
       More information, including security considerations, can be found in the `README.md` in the [tpm2-totp](https://github.com/tpm2-software/tpm2-totp) repository. Be sure to select the tag for the version of `tpm2-totp` you have installed.

     

       26
       26
       +
       

     

       27
       27
       +
       ### 3. Check configuration {#module-boot-plymouth-tpm2-totp-quick-start-check}

     

       28
       28
       +
       

     

       29
       29
       +
       Reboot and you should see the TOTP appear on the Plymouth boot screen. The TOTP should match the code displayed in your authenticator app (or the code immediately before/after).

+59

nixos/modules/system/boot/plymouth-tpm2-totp.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         cfg = config.boot.plymouth.tpm2-totp;

     

       10
       10
       +
       in

     

       11
       11
       +
       {

     

       12
       12
       +
         options.boot.plymouth.tpm2-totp = {

     

       13
       13
       +
           enable = lib.mkEnableOption "tpm2-totp using Plymouth" // {

     

       14
       14
       +
             description = "Whether to display a TOTP during boot using tpm2-totp and Plymouth.";

     

       15
       15
       +
           };

     

       16
       16
       +
       

     

       17
       17
       +
           package = lib.mkPackageOption pkgs "tpm2-totp" { default = "tpm2-totp-with-plymouth"; };

     

       18
       18
       +
         };

     

       19
       19
       +
       

     

       20
       20
       +
         meta = {

     

       21
       21
       +
           maintainers = with lib.maintainers; [ majiir ];

     

       22
       22
       +
           doc = ./plymouth-tpm2-totp.md;

     

       23
       23
       +
         };

     

       24
       24
       +
       

     

       25
       25
       +
         config = lib.mkIf cfg.enable {

     

       26
       26
       +
           assertions = [

     

       27
       27
       +
             {

     

       28
       28
       +
               assertion = config.boot.initrd.systemd.enable;

     

       29
       29
       +
               message = "boot.plymouth.tpm2-totp is only supported with boot.initrd.systemd.";

     

       30
       30
       +
             }

     

       31
       31
       +
           ];

     

       32
       32
       +
       

     

       33
       33
       +
           environment.systemPackages = [

     

       34
       34
       +
             cfg.package

     

       35
       35
       +
           ];

     

       36
       36
       +
       

     

       37
       37
       +
           boot.initrd.systemd.storePaths = [

     

       38
       38
       +
             "${cfg.package}/libexec/tpm2-totp/plymouth-tpm2-totp"

     

       39
       39
       +
             "${cfg.package}/lib/libtpm2-totp.so.0"

     

       40
       40
       +
             "${cfg.package}/lib/libtpm2-totp.so.0.0.0"

     

       41
       41
       +
           ];

     

       42
       42
       +
       

     

       43
       43
       +
           # Based on https://github.com/tpm2-software/tpm2-totp/blob/9bcfdcbfdd42e0b2e1d7769852009608f889631c/dist/plymouth-tpm2-totp.service.in

     

       44
       44
       +
           boot.initrd.systemd.services.plymouth-tpm2-totp = {

     

       45
       45
       +
             description = "Display a TOTP during boot using Plymouth";

     

       46
       46
       +
             requires = [ "plymouth-start.service" ];

     

       47
       47
       +
             after = [

     

       48
       48
       +
               "plymouth-start.service"

     

       49
       49
       +
               "tpm2.target"

     

       50
       50
       +
             ];

     

       51
       51
       +
             wantedBy = [ "sysinit.target" ];

     

       52
       52
       +
             unitConfig.DefaultDependencies = false;

     

       53
       53
       +
             serviceConfig = {

     

       54
       54
       +
               Type = "exec";

     

       55
       55
       +
               ExecStart = "${cfg.package}/libexec/tpm2-totp/plymouth-tpm2-totp";

     

       56
       56
       +
             };

     

       57
       57
       +
           };

     

       58
       58
       +
         };

     

       59
       59
       +
       }

+6 -1

pkgs/by-name/tp/tpm2-totp/package.nix

···

       5
       5
        
         tpm2-tss,

     

       6
       6
        
         autoreconfHook,

     

       7
       7
        
         autoconf-archive,

     

       8
       8
       +
         pandoc,

     

       8
       9
        
         pkg-config,

     

       10
       10
       +
         withPlymouth ? false,

     

       11
       11
       +
         plymouth,

     

       9
       12
        
         qrencode,

     

       10
       13
        
       }:

     

       11
       14
        
       

     
···

       27
       30
        
         nativeBuildInputs = [

     

       28
       31
        
           autoreconfHook

     

       29
       32
        
           autoconf-archive

     

       33
       33
       +
           pandoc

     

       30
       34
        
           pkg-config

     

       31
       35
        
         ];

     

       32
       36
        
       

     

       33
       37
        
         buildInputs = [

     

       34
       38
        
           tpm2-tss

     

       35
       39
        
           qrencode

     

       36
       36
       -
         ];

     

       40
       40
       +
         ]

     

       41
       41
       +
         ++ lib.optional withPlymouth plymouth;

     

       37
       42
        
       

     

       38
       43
        
         meta = with lib; {

     

       39
       44
        
           description = "Attest the trustworthiness of a device against a human using time-based one-time passwords";

+4

pkgs/top-level/all-packages.nix

···

       4269
       4269
        
           }

     

       4270
       4270
        
         );

     

       4271
       4271
        
       

     

       4272
       4272
       +
         tpm2-totp-with-plymouth = tpm2-totp.override {

     

       4273
       4273
       +
           withPlymouth = true;

     

       4274
       4274
       +
         };

     

       4275
       4275
       +
       

     

       4272
       4276
        
         trackma-curses = trackma.override { withCurses = true; };

     

       4273
       4277
        
       

     

       4274
       4278
        
         trackma-gtk = trackma.override { withGTK = true; };