commit 24e0db1ba99d906ca7351031eed248082f2e6e8d · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       1146
       1146
        
         ./services/networking/nixops-dns.nix

     

       1147
       1147
        
         ./services/networking/nncp.nix

     

       1148
       1148
        
         ./services/networking/nntp-proxy.nix

     

       1149
       1149
       +
         ./services/networking/nm-file-secret-agent.nix

     

       1149
       1150
        
         ./services/networking/nomad.nix

     

       1150
       1151
        
         ./services/networking/nsd.nix

     

       1151
       1152
        
         ./services/networking/ntopng.nix

+131

nixos/modules/services/networking/nm-file-secret-agent.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.networking.networkmanager;

     

       9
       9
       +
         toml = pkgs.formats.toml { };

     

       10
       10
       +
       

     

       11
       11
       +
         enabled = (lib.length cfg.ensureProfiles.secrets.entries) > 0;

     

       12
       12
       +
       

     

       13
       13
       +
         nmFileSecretAgentConfig = {

     

       14
       14
       +
           entry = builtins.map (

     

       15
       15
       +
             i:

     

       16
       16
       +
             {

     

       17
       17
       +
               key = i.key;

     

       18
       18
       +
               file = i.file;

     

       19
       19
       +
             }

     

       20
       20
       +
             // lib.optionalAttrs (i.matchId != null) { match_id = i.matchId; }

     

       21
       21
       +
             // lib.optionalAttrs (i.matchUuid != null) { match_uuid = i.matchUuid; }

     

       22
       22
       +
             // lib.optionalAttrs (i.matchType != null) { match_type = i.matchType; }

     

       23
       23
       +
             // lib.optionalAttrs (i.matchIface != null) { match_iface = i.matchIface; }

     

       24
       24
       +
             // lib.optionalAttrs (i.matchSetting != null) {

     

       25
       25
       +
               match_setting = i.matchSetting;

     

       26
       26
       +
             }

     

       27
       27
       +
           ) cfg.ensureProfiles.secrets.entries;

     

       28
       28
       +
         };

     

       29
       29
       +
         nmFileSecretAgentConfigFile = toml.generate "config.toml" nmFileSecretAgentConfig;

     

       30
       30
       +
       in

     

       31
       31
       +
       {

     

       32
       32
       +
         meta = {

     

       33
       33
       +
           maintainers = [ lib.maintainers.lilioid ];

     

       34
       34
       +
         };

     

       35
       35
       +
       

     

       36
       36
       +
         ####### interface

     

       37
       37
       +
         options = {

     

       38
       38
       +
           networking.networkmanager.ensureProfiles.secrets = {

     

       39
       39
       +
             package = lib.mkPackageOption pkgs "nm-file-secret-agent" { };

     

       40
       40
       +
             entries = lib.mkOption {

     

       41
       41
       +
               description = ''

     

       42
       42
       +
                 A list of secrets to provide to NetworkManager by reading their values from configured files.

     

       43
       43
       +
       

     

       44
       44
       +
                 Note that NetworkManager should be configured to read secrets from a secret agent.

     

       45
       45
       +
                 This can be done for example through the `networking.networkmanager.ensureProfiles.profiles` options.

     

       46
       46
       +
               '';

     

       47
       47
       +
               default = [ ];

     

       48
       48
       +
               example = [

     

       49
       49
       +
                 {

     

       50
       50
       +
                   matchId = "My WireGuard VPN";

     

       51
       51
       +
                   matchType = "wireguard";

     

       52
       52
       +
                   matchSetting = "wireguard";

     

       53
       53
       +
                   key = "private-key";

     

       54
       54
       +
                   file = "/root/wireguard_key";

     

       55
       55
       +
                 }

     

       56
       56
       +
               ];

     

       57
       57
       +
               type = lib.types.listOf (

     

       58
       58
       +
                 lib.types.submodule {

     

       59
       59
       +
                   options = {

     

       60
       60
       +
                     matchId = lib.mkOption {

     

       61
       61
       +
                       description = ''

     

       62
       62
       +
                         connection id used by NetworkManager. Often displayed as name in GUIs.

     

       63
       63
       +
       

     

       64
       64
       +
                         NetworkManager describes this as a human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".

     

       65
       65
       +
                       '';

     

       66
       66
       +
                       type = lib.types.nullOr lib.types.str;

     

       67
       67
       +
                       default = null;

     

       68
       68
       +
                       example = "wifi1";

     

       69
       69
       +
                     };

     

       70
       70
       +
                     matchUuid = lib.mkOption {

     

       71
       71
       +
                       description = ''

     

       72
       72
       +
                         UUID of the connection profile

     

       73
       73
       +
       

     

       74
       74
       +
                         UUIDs are assigned once on connection creation and should never change as long as the connection still applies to the same network.

     

       75
       75
       +
                       '';

     

       76
       76
       +
                       type = lib.types.nullOr lib.types.str;

     

       77
       77
       +
                       default = null;

     

       78
       78
       +
                       example = "669ea4c9-4cb3-4901-ab52-f9606590976e";

     

       79
       79
       +
                     };

     

       80
       80
       +
                     matchType = lib.mkOption {

     

       81
       81
       +
                       description = ''

     

       82
       82
       +
                         NetworkManager connection type

     

       83
       83
       +
       

     

       84
       84
       +
                         The NetworkManager configuration settings reference roughly corresponds to connection types.

     

       85
       85
       +
                         More might be available on your system depending on the installed plugins.

     

       86
       86
       +
       

     

       87
       87
       +
                         https://networkmanager.dev/docs/api/latest/ch01.html

     

       88
       88
       +
                       '';

     

       89
       89
       +
                       type = lib.types.nullOr lib.types.str;

     

       90
       90
       +
                       default = null;

     

       91
       91
       +
                       example = "wireguard";

     

       92
       92
       +
                     };

     

       93
       93
       +
                     matchIface = lib.mkOption {

     

       94
       94
       +
                       description = "interface name of the NetworkManager connection";

     

       95
       95
       +
                       type = lib.types.nullOr lib.types.str;

     

       96
       96
       +
                       default = null;

     

       97
       97
       +
                     };

     

       98
       98
       +
                     matchSetting = lib.mkOption {

     

       99
       99
       +
                       description = "name of the setting section for which secrets are requested";

     

       100
       100
       +
                       type = lib.types.nullOr lib.types.str;

     

       101
       101
       +
                       default = null;

     

       102
       102
       +
                     };

     

       103
       103
       +
                     key = lib.mkOption {

     

       104
       104
       +
                       description = "key in the setting section for which this entry provides a value";

     

       105
       105
       +
                       type = lib.types.str;

     

       106
       106
       +
                     };

     

       107
       107
       +
                     file = lib.mkOption {

     

       108
       108
       +
                       description = "file from which the secret value is read";

     

       109
       109
       +
                       type = lib.types.str;

     

       110
       110
       +
                     };

     

       111
       111
       +
                   };

     

       112
       112
       +
                 }

     

       113
       113
       +
               );

     

       114
       114
       +
             };

     

       115
       115
       +
           };

     

       116
       116
       +
         };

     

       117
       117
       +
       

     

       118
       118
       +
         ####### implementation

     

       119
       119
       +
         config = lib.mkIf enabled {

     

       120
       120
       +
           # start nm-file-secret-agent if required

     

       121
       121
       +
           systemd.services."nm-file-secret-agent" = {

     

       122
       122
       +
             description = "NetworkManager secret agent that responds with the content of preconfigured files";

     

       123
       123
       +
             documentation = [ "https://github.com/lilioid/nm-file-secret-agent/" ];

     

       124
       124
       +
             requires = [ "NetworkManager.service" ];

     

       125
       125
       +
             after = [ "NetworkManager.service" ];

     

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

     

       127
       127
       +
             restartTriggers = [ nmFileSecretAgentConfigFile ];

     

       128
       128
       +
             script = "${lib.getExe cfg.ensureProfiles.secrets.package} --conf ${nmFileSecretAgentConfigFile}";

     

       129
       129
       +
           };

     

       130
       130
       +
         };

     

       131
       131
       +
       }