commit e103c5cfcf6347f51636c758f372b720803bc8f8 · pyrox.dev/nixpkgs

+2

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

···

       67
       67
        
       

     

       68
       68
        
       - [RustDesk](https://rustdesk.com), a full-featured open source remote control alternative for self-hosting and security with minimal configuration. Alternative to TeamViewer.

     

       69
       69
        
       

     

       70
       70
       +
       - [systemd-lock-handler](https://git.sr.ht/~whynothugo/systemd-lock-handler/), a bridge between logind D-Bus events and systemd targets. Available as [services.systemd-lock-handler.enable](#opt-services.systemd-lock-handler.enable).

     

       71
       71
       +
       

     

       70
       72
        
       ## Backward Incompatibilities {#sec-release-24.05-incompatibilities}

     

       71
       73
        
       

     

       72
       74
        
       <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

+1

nixos/modules/module-list.nix

···

       1236
       1236
        
         ./services/system/saslauthd.nix

     

       1237
       1237
        
         ./services/system/self-deploy.nix

     

       1238
       1238
        
         ./services/system/systembus-notify.nix

     

       1239
       1239
       +
         ./services/system/systemd-lock-handler.nix

     

       1239
       1240
        
         ./services/system/uptimed.nix

     

       1240
       1241
        
         ./services/system/zram-generator.nix

     

       1241
       1242
        
         ./services/torrent/deluge.nix

+47

nixos/modules/services/system/systemd-lock-handler.md

···

       1
       1
       +
       # systemd-lock-handler {#module-services-systemd-lock-handler}

     

       2
       2
       +
       

     

       3
       3
       +
       The `systemd-lock-handler` module provides a service that bridges

     

       4
       4
       +
       D-Bus events from `logind` to user-level systemd targets:

     

       5
       5
       +
       

     

       6
       6
       +
         - `lock.target` started by `loginctl lock-session`,

     

       7
       7
       +
         - `unlock.target` started by `loginctl unlock-session` and

     

       8
       8
       +
         - `sleep.target` started by `systemctl suspend`.

     

       9
       9
       +
       

     

       10
       10
       +
       You can create a user service that starts with any of these targets.

     

       11
       11
       +
       

     

       12
       12
       +
       For example, to create a service for `swaylock`:

     

       13
       13
       +
       

     

       14
       14
       +
       ```nix

     

       15
       15
       +
       {

     

       16
       16
       +
         services.systemd-lock-handler.enable = true;

     

       17
       17
       +
       

     

       18
       18
       +
         systemd.user.services.swaylock = {

     

       19
       19
       +
           description = "Screen locker for Wayland";

     

       20
       20
       +
           documentation = ["man:swaylock(1)"];

     

       21
       21
       +
       

     

       22
       22
       +
           # If swaylock exits cleanly, unlock the session:

     

       23
       23
       +
           onSuccess = ["unlock.target"];

     

       24
       24
       +
       

     

       25
       25
       +
           # When lock.target is stopped, stops this too:

     

       26
       26
       +
           partOf = ["lock.target"];

     

       27
       27
       +
       

     

       28
       28
       +
           # Delay lock.target until this service is ready:

     

       29
       29
       +
           before = ["lock.target"];

     

       30
       30
       +
           wantedBy = ["lock.target"];

     

       31
       31
       +
       

     

       32
       32
       +
           serviceConfig = {

     

       33
       33
       +
             # systemd will consider this service started when swaylock forks...

     

       34
       34
       +
             Type = "forking";

     

       35
       35
       +
       

     

       36
       36
       +
             # ... and swaylock will fork only after it has locked the screen.

     

       37
       37
       +
             ExecStart = "${lib.getExe pkgs.swaylock} -f";

     

       38
       38
       +
       

     

       39
       39
       +
             # If swaylock crashes, always restart it immediately:

     

       40
       40
       +
             Restart = "on-failure";

     

       41
       41
       +
             RestartSec = 0;

     

       42
       42
       +
           };

     

       43
       43
       +
         };

     

       44
       44
       +
       }

     

       45
       45
       +
       ```

     

       46
       46
       +
       

     

       47
       47
       +
       See [upstream documentation](https://sr.ht/~whynothugo/systemd-lock-handler) for more information.

+27

nixos/modules/services/system/systemd-lock-handler.nix

···

       1
       1
       +
       { config

     

       2
       2
       +
       , pkgs

     

       3
       3
       +
       , lib

     

       4
       4
       +
       , ...

     

       5
       5
       +
       }:

     

       6
       6
       +
       let

     

       7
       7
       +
         cfg = config.services.systemd-lock-handler;

     

       8
       8
       +
         inherit (lib) mkIf mkEnableOption mkPackageOption;

     

       9
       9
       +
       in

     

       10
       10
       +
       {

     

       11
       11
       +
         options.services.systemd-lock-handler = {

     

       12
       12
       +
           enable = mkEnableOption (lib.mdDoc "systemd-lock-handler");

     

       13
       13
       +
           package = mkPackageOption pkgs "systemd-lock-handler" { };

     

       14
       14
       +
         };

     

       15
       15
       +
       

     

       16
       16
       +
         config = mkIf cfg.enable {

     

       17
       17
       +
           systemd.packages = [ cfg.package ];

     

       18
       18
       +
       

     

       19
       19
       +
           # https://github.com/NixOS/nixpkgs/issues/81138

     

       20
       20
       +
           systemd.user.services.systemd-lock-handler.wantedBy = [ "default.target" ];

     

       21
       21
       +
         };

     

       22
       22
       +
       

     

       23
       23
       +
         meta = {

     

       24
       24
       +
           maintainers = with lib.maintainers; [ liff ];

     

       25
       25
       +
           doc = ./systemd-lock-handler.md;

     

       26
       26
       +
         };

     

       27
       27
       +
       }

+1

nixos/tests/all-tests.nix

···

       856
       856
        
         systemd-journal = handleTest ./systemd-journal.nix {};

     

       857
       857
        
         systemd-journal-gateway = handleTest ./systemd-journal-gateway.nix {};

     

       858
       858
        
         systemd-journal-upload = handleTest ./systemd-journal-upload.nix {};

     

       859
       859
       +
         systemd-lock-handler = runTestOn ["aarch64-linux" "x86_64-linux"] ./systemd-lock-handler.nix;

     

       859
       860
        
         systemd-machinectl = handleTest ./systemd-machinectl.nix {};

     

       860
       861
        
         systemd-networkd = handleTest ./systemd-networkd.nix {};

     

       861
       862
        
         systemd-networkd-dhcpserver = handleTest ./systemd-networkd-dhcpserver.nix {};

+56

nixos/tests/systemd-lock-handler.nix

···

       1
       1
       +
       { lib, ... }: {

     

       2
       2
       +
         name = "systemd-lock-handler";

     

       3
       3
       +
       

     

       4
       4
       +
         meta.maintainers = with lib.maintainers; [ liff ];

     

       5
       5
       +
       

     

       6
       6
       +
         enableOCR = true;

     

       7
       7
       +
       

     

       8
       8
       +
         nodes.machine = { config, pkgs, lib, ... }:

     

       9
       9
       +
           let

     

       10
       10
       +
             touch = "${lib.getBin pkgs.coreutils}/bin/touch";

     

       11
       11
       +
           in

     

       12
       12
       +
           {

     

       13
       13
       +
             imports = [ common/wayland-cage.nix ];

     

       14
       14
       +
       

     

       15
       15
       +
             services.systemd-lock-handler.enable = true;

     

       16
       16
       +
       

     

       17
       17
       +
             systemd.user.services = {

     

       18
       18
       +
               test-lock = {

     

       19
       19
       +
                 partOf = [ "lock.target" ];

     

       20
       20
       +
                 onSuccess = [ "unlock.target" ];

     

       21
       21
       +
                 before = [ "lock.target" ];

     

       22
       22
       +
                 wantedBy = [ "lock.target" ];

     

       23
       23
       +
                 serviceConfig.ExecStart = "${touch} /tmp/lock.target.activated";

     

       24
       24
       +
               };

     

       25
       25
       +
               test-unlock = {

     

       26
       26
       +
                 partOf = [ "unlock.target" ];

     

       27
       27
       +
                 after = [ "unlock.target" ];

     

       28
       28
       +
                 wantedBy = [ "unlock.target" ];

     

       29
       29
       +
                 serviceConfig.ExecStart = "${touch} /tmp/unlock.target.activated";

     

       30
       30
       +
               };

     

       31
       31
       +
               test-sleep = {

     

       32
       32
       +
                 partOf = [ "sleep.target" ];

     

       33
       33
       +
                 before = [ "sleep.target" ];

     

       34
       34
       +
                 wantedBy = [ "sleep.target" ];

     

       35
       35
       +
                 serviceConfig.ExecStart = "${touch} /tmp/sleep.target.activated";

     

       36
       36
       +
               };

     

       37
       37
       +
             };

     

       38
       38
       +
           };

     

       39
       39
       +
       

     

       40
       40
       +
         testScript = ''

     

       41
       41
       +
           machine.wait_for_unit('graphical.target')

     

       42
       42
       +
           machine.wait_for_text('alice@machine')

     

       43
       43
       +
       

     

       44
       44
       +
           machine.send_chars('loginctl lock-session\n')

     

       45
       45
       +
           machine.wait_for_file('/tmp/lock.target.activated')

     

       46
       46
       +
           machine.wait_for_file('/tmp/unlock.target.activated')

     

       47
       47
       +
       

     

       48
       48
       +
           machine.send_chars('systemctl suspend\n')

     

       49
       49
       +
           # wait_for_file won’t complete before the machine is asleep,

     

       50
       50
       +
           # so we’ll watch the log instead.

     

       51
       51
       +
           machine.wait_for_console_text('Started test-sleep.service.')

     

       52
       52
       +
       

     

       53
       53
       +
           # The VM is asleep, regular shutdown won’t work.

     

       54
       54
       +
           machine.crash()

     

       55
       55
       +
         '';

     

       56
       56
       +
       }

+5 -1

pkgs/by-name/sy/systemd-lock-handler/package.nix

···

       2
       2
        
       , fetchFromSourcehut

     

       3
       3
        
       , buildGoModule

     

       4
       4
        
       , nix-update-script

     

       5
       5
       +
       , nixosTests

     

       5
       6
        
       }:

     

       6
       7
        
       

     

       7
       8
        
       buildGoModule rec {

     
···

       17
       18
        
       

     

       18
       19
        
         vendorHash = "sha256-dWzojV3tDA5lLdpAQNC9NaADGyvV7dNOS3x8mfgNNtA=";

     

       19
       20
        
       

     

       20
       20
       -
         passthru.updateScript = nix-update-script { };

     

       21
       21
       +
         passthru = {

     

       22
       22
       +
           updateScript = nix-update-script { };

     

       23
       23
       +
           tests = nixosTests.systemd-lock-handler;

     

       24
       24
       +
         };

     

       21
       25
        
       

     

       22
       26
        
         # The Makefile expects to find the binary in the source root. Make

     

       23
       27
        
         # the one built by `buildGoModule` available so that `make install`