commit 296e7f92cde7cd3cba094400d9bfdd614a04fcea · pyrox.dev/nixpkgs

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

···

       59
       59
        
       

     

       60
       60
        
       - [QDMR](https://dm3mat.darc.de/qdmr/), a GUI application and command line tool for programming DMR radios [programs.qdmr](#opt-programs.qdmr.enable)

     

       61
       61
        
       

     

       62
       62
       +
       - [keyd](https://github.com/rvaiya/keyd), a key remapping daemon for linux. Available as [services.keyd](#opt-services.keyd.enable).

     

       63
       63
       +
       

     

       62
       64
        
       - [v2rayA](https://v2raya.org), a Linux web GUI client of Project V which supports V2Ray, Xray, SS, SSR, Trojan and Pingtunnel. Available as [services.v2raya](options.html#opt-services.v2raya.enable).

     

       63
       65
        
       

     

       64
       66
        
       - [ulogd](https://www.netfilter.org/projects/ulogd/index.html), a userspace logging daemon for netfilter/iptables related logging. Available as [services.ulogd](options.html#opt-services.ulogd.enable).

nixos/modules/module-list.nix

···

       511
       511
        
         ./services/hardware/usbmuxd.nix

     

       512
       512
        
         ./services/hardware/usbrelayd.nix

     

       513
       513
        
         ./services/hardware/vdr.nix

     

       514
       514
       +
         ./services/hardware/keyd.nix

     

       514
       515
        
         ./services/home-automation/evcc.nix

     

       515
       516
        
         ./services/home-automation/home-assistant.nix

     

       516
       517
        
         ./services/home-automation/zigbee2mqtt.nix

+112

nixos/modules/services/hardware/keyd.nix

···

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

     

       2
       2
       +
       with lib;

     

       3
       3
       +
       let

     

       4
       4
       +
         cfg = config.services.keyd;

     

       5
       5
       +
         settingsFormat = pkgs.formats.ini { };

     

       6
       6
       +
       in

     

       7
       7
       +
       {

     

       8
       8
       +
         options = {

     

       9
       9
       +
           services.keyd = {

     

       10
       10
       +
             enable = mkEnableOption (lib.mdDoc "keyd, a key remapping daemon");

     

       11
       11
       +
       

     

       12
       12
       +
             ids = mkOption {

     

       13
       13
       +
               type = types.listOf types.string;

     

       14
       14
       +
               default = [ "*" ];

     

       15
       15
       +
               example = [ "*" "-0123:0456" ];

     

       16
       16
       +
               description = lib.mdDoc ''

     

       17
       17
       +
                 Device identifiers, as shown by {manpage}`keyd(1)`.

     

       18
       18
       +
               '';

     

       19
       19
       +
             };

     

       20
       20
       +
       

     

       21
       21
       +
             settings = mkOption {

     

       22
       22
       +
               type = settingsFormat.type;

     

       23
       23
       +
               default = { };

     

       24
       24
       +
               example = {

     

       25
       25
       +
                 main = {

     

       26
       26
       +
                   capslock = "overload(control, esc)";

     

       27
       27
       +
                   rightalt = "layer(rightalt)";

     

       28
       28
       +
                 };

     

       29
       29
       +
       

     

       30
       30
       +
                 rightalt = {

     

       31
       31
       +
                   j = "down";

     

       32
       32
       +
                   k = "up";

     

       33
       33
       +
                   h = "left";

     

       34
       34
       +
                   l = "right";

     

       35
       35
       +
                 };

     

       36
       36
       +
               };

     

       37
       37
       +
               description = lib.mdDoc ''

     

       38
       38
       +
                 Configuration, except `ids` section, that is written to {file}`/etc/keyd/default.conf`.

     

       39
       39
       +
                 See <https://github.com/rvaiya/keyd> how to configure.

     

       40
       40
       +
               '';

     

       41
       41
       +
             };

     

       42
       42
       +
           };

     

       43
       43
       +
         };

     

       44
       44
       +
       

     

       45
       45
       +
         config = mkIf cfg.enable {

     

       46
       46
       +
           environment.etc."keyd/default.conf".source = pkgs.runCommand "default.conf"

     

       47
       47
       +
             {

     

       48
       48
       +
               ids = ''

     

       49
       49
       +
                 [ids]

     

       50
       50
       +
                 ${concatStringsSep "\n" cfg.ids}

     

       51
       51
       +
               '';

     

       52
       52
       +
               passAsFile = [ "ids" ];

     

       53
       53
       +
             } ''

     

       54
       54
       +
             cat $idsPath <(echo) ${settingsFormat.generate "keyd-main.conf" cfg.settings} >$out

     

       55
       55
       +
           '';

     

       56
       56
       +
       

     

       57
       57
       +
           hardware.uinput.enable = lib.mkDefault true;

     

       58
       58
       +
       

     

       59
       59
       +
           systemd.services.keyd = {

     

       60
       60
       +
             description = "Keyd remapping daemon";

     

       61
       61
       +
             documentation = [ "man:keyd(1)" ];

     

       62
       62
       +
       

     

       63
       63
       +
             wantedBy = [ "multi-user.target" ];

     

       64
       64
       +
       

     

       65
       65
       +
             restartTriggers = [

     

       66
       66
       +
               config.environment.etc."keyd/default.conf".source

     

       67
       67
       +
             ];

     

       68
       68
       +
       

     

       69
       69
       +
             # this is configurable in 2.4.2, later versions seem to remove this option.

     

       70
       70
       +
             # post-2.4.2 may need to set makeFlags in the derivation:

     

       71
       71
       +
             #

     

       72
       72
       +
             #     makeFlags = [ "SOCKET_PATH/run/keyd/keyd.socket" ];

     

       73
       73
       +
             environment.KEYD_SOCKET = "/run/keyd/keyd.sock";

     

       74
       74
       +
       

     

       75
       75
       +
             serviceConfig = {

     

       76
       76
       +
               ExecStart = "${pkgs.keyd}/bin/keyd";

     

       77
       77
       +
               Restart = "always";

     

       78
       78
       +
       

     

       79
       79
       +
               DynamicUser = true;

     

       80
       80
       +
               SupplementaryGroups = [

     

       81
       81
       +
                 config.users.groups.input.name

     

       82
       82
       +
                 config.users.groups.uinput.name

     

       83
       83
       +
               ];

     

       84
       84
       +
       

     

       85
       85
       +
               RuntimeDirectory = "keyd";

     

       86
       86
       +
       

     

       87
       87
       +
               # Hardening

     

       88
       88
       +
               CapabilityBoundingSet = "";

     

       89
       89
       +
               DeviceAllow = [

     

       90
       90
       +
                 "char-input rw"

     

       91
       91
       +
                 "/dev/uinput rw"

     

       92
       92
       +
               ];

     

       93
       93
       +
               ProtectClock = true;

     

       94
       94
       +
               PrivateNetwork = true;

     

       95
       95
       +
               ProtectHome = true;

     

       96
       96
       +
               ProtectHostname = true;

     

       97
       97
       +
               PrivateUsers = true;

     

       98
       98
       +
               PrivateMounts = true;

     

       99
       99
       +
               RestrictNamespaces = true;

     

       100
       100
       +
               ProtectKernelLogs = true;

     

       101
       101
       +
               ProtectKernelModules = true;

     

       102
       102
       +
               ProtectKernelTunables = true;

     

       103
       103
       +
               ProtectControlGroups = true;

     

       104
       104
       +
               MemoryDenyWriteExecute = true;

     

       105
       105
       +
               RestrictRealtime = true;

     

       106
       106
       +
               LockPersonality = true;

     

       107
       107
       +
               ProtectProc = "noaccess";

     

       108
       108
       +
               UMask = "0077";

     

       109
       109
       +
             };

     

       110
       110
       +
           };

     

       111
       111
       +
         };

     

       112
       112
       +
       }

nixos/tests/all-tests.nix

···

       346
       346
        
         keter = handleTest ./keter.nix {};

     

       347
       347
        
         kexec = handleTest ./kexec.nix {};

     

       348
       348
        
         keycloak = discoverTests (import ./keycloak.nix);

     

       349
       349
       +
         keyd = handleTest ./keyd.nix {};

     

       349
       350
        
         keymap = handleTest ./keymap.nix {};

     

       350
       351
        
         knot = handleTest ./knot.nix {};

     

       351
       352
        
         komga = handleTest ./komga.nix {};

+82

nixos/tests/keyd.nix

···

       1
       1
       +
       # The test template is taken from the `./keymap.nix`

     

       2
       2
       +
       { system ? builtins.currentSystem

     

       3
       3
       +
       , config ? { }

     

       4
       4
       +
       , pkgs ? import ../.. { inherit system config; }

     

       5
       5
       +
       }:

     

       6
       6
       +
       

     

       7
       7
       +
       with import ../lib/testing-python.nix { inherit system pkgs; };

     

       8
       8
       +
       

     

       9
       9
       +
       let

     

       10
       10
       +
         readyFile = "/tmp/readerReady";

     

       11
       11
       +
         resultFile = "/tmp/readerResult";

     

       12
       12
       +
       

     

       13
       13
       +
         testReader = pkgs.writeScript "test-input-reader" ''

     

       14
       14
       +
           rm -f ${resultFile} ${resultFile}.tmp

     

       15
       15
       +
           logger "testReader: START: Waiting for $1 characters, expecting '$2'."

     

       16
       16
       +
           touch ${readyFile}

     

       17
       17
       +
           read -r -N $1 chars

     

       18
       18
       +
           rm -f ${readyFile}

     

       19
       19
       +
           if [ "$chars" == "$2" ]; then

     

       20
       20
       +
             logger -s "testReader: PASS: Got '$2' as expected." 2>${resultFile}.tmp

     

       21
       21
       +
           else

     

       22
       22
       +
             logger -s "testReader: FAIL: Expected '$2' but got '$chars'." 2>${resultFile}.tmp

     

       23
       23
       +
           fi

     

       24
       24
       +
           # rename after the file is written to prevent a race condition

     

       25
       25
       +
           mv  ${resultFile}.tmp ${resultFile}

     

       26
       26
       +
         '';

     

       27
       27
       +
       

     

       28
       28
       +
       

     

       29
       29
       +
         mkKeyboardTest = name: { settings, test }: with pkgs.lib; makeTest {

     

       30
       30
       +
           inherit name;

     

       31
       31
       +
       

     

       32
       32
       +
           nodes.machine = {

     

       33
       33
       +
             services.keyd = {

     

       34
       34
       +
               enable = true;

     

       35
       35
       +
               inherit settings;

     

       36
       36
       +
             };

     

       37
       37
       +
           };

     

       38
       38
       +
       

     

       39
       39
       +
           testScript = ''

     

       40
       40
       +
             import shlex

     

       41
       41
       +
       

     

       42
       42
       +
             machine.wait_for_unit("keyd.service")

     

       43
       43
       +
       

     

       44
       44
       +
             def run_test_case(cmd, test_case_name, inputs, expected):

     

       45
       45
       +
                 with subtest(test_case_name):

     

       46
       46
       +
                     assert len(inputs) == len(expected)

     

       47
       47
       +
                     machine.execute("rm -f ${readyFile} ${resultFile}")

     

       48
       48
       +
                     # set up process that expects all the keys to be entered

     

       49
       49
       +
                     machine.succeed(

     

       50
       50
       +
                         "{} {} {} {} >&2 &".format(

     

       51
       51
       +
                             cmd,

     

       52
       52
       +
                             "${testReader}",

     

       53
       53
       +
                             len(inputs),

     

       54
       54
       +
                             shlex.quote("".join(expected)),

     

       55
       55
       +
                         )

     

       56
       56
       +
                     )

     

       57
       57
       +
                     # wait for reader to be ready

     

       58
       58
       +
                     machine.wait_for_file("${readyFile}")

     

       59
       59
       +
                     # send all keys

     

       60
       60
       +
                     for key in inputs:

     

       61
       61
       +
                         machine.send_key(key)

     

       62
       62
       +
                     # wait for result and check

     

       63
       63
       +
                     machine.wait_for_file("${resultFile}")

     

       64
       64
       +
                     machine.succeed("grep -q 'PASS:' ${resultFile}")

     

       65
       65
       +
             test = ${builtins.toJSON test}

     

       66
       66
       +
             run_test_case("openvt -sw --", "${name}", test["press"], test["expect"])

     

       67
       67
       +
           '';

     

       68
       68
       +
         };

     

       69
       69
       +
       

     

       70
       70
       +
       in

     

       71
       71
       +
       pkgs.lib.mapAttrs mkKeyboardTest {

     

       72
       72
       +
         swap-ab_and_ctrl-as-shift = {

     

       73
       73
       +
           test.press = [ "a" "ctrl-b" "c" ];

     

       74
       74
       +
           test.expect = [ "b" "A" "c" ];

     

       75
       75
       +
       

     

       76
       76
       +
           settings.main = {

     

       77
       77
       +
             "a" = "b";

     

       78
       78
       +
             "b" = "a";

     

       79
       79
       +
             "control" = "oneshot(shift)";

     

       80
       80
       +
           };

     

       81
       81
       +
         };

     

       82
       82
       +
       }

pkgs/tools/inputmethods/keyd/default.nix

···

       6
       6
        
       , systemd

     

       7
       7
        
       , runtimeShell

     

       8
       8
        
       , python3

     

       9
       9
       +
       , nixosTests

     

       9
       10
        
       }:

     

       10
       11
        
       

     

       11
       12
        
       let

     
···

       59
       60
        
       

     

       60
       61
        
         enableParallelBuilding = true;

     

       61
       62
        
       

     

       63
       63
       +
         # post-2.4.2 may need this to unbreak the test

     

       64
       64
       +
         # makeFlags = [ "SOCKET_PATH/run/keyd/keyd.socket" ];

     

       65
       65
       +
       

     

       62
       66
        
         postInstall = ''

     

       63
       67
        
           ln -sf ${lib.getExe appMap} $out/bin/${appMap.pname}

     

       64
       68
        
           rm -rf $out/etc

     

       65
       69
        
         '';

     

       70
       70
       +
       

     

       71
       71
       +
         passthru.tests.keyd = nixosTests.keyd;

     

       66
       72
        
       

     

       67
       73
        
         meta = with lib; {

     

       68
       74
        
           description = "A key remapping daemon for linux.";