commit b470c93c1eeb15a30170b6d7cb4ec04ef36bbf87 · pyrox.dev/nixpkgs

+144 -136
nixos/modules/services/networking/spiped.nix
···

       7
       7
        
       in

     

       8
       8
        
       {

     

       9
       9
        
         options = {

     

       10
       10
       -
           services.spiped = mkOption {

     

       11
       11
       -
             type = types.attrsOf (types.submodule (

     

       12
       12
       -
               {

     

       13
       13
       -
                 options = {

     

       14
       14
       -
                   encrypt = mkOption {

     

       15
       15
       -
                     type    = types.bool;

     

       16
       16
       -
                     default = false;

     

       17
       17
       -
                     description = ''

     

       18
       18
       -
                       Take unencrypted connections from the

     

       19
       19
       -
                       <literal>source</literal> socket and send encrypted

     

       20
       20
       -
                       connections to the <literal>target</literal> socket.

     

       21
       21
       -
                     '';

     

       22
       22
       -
                   };

     

       10
       10
       +
           services.spiped = {

     

       11
       11
       +
             enable = mkOption {

     

       12
       12
       +
               type        = types.bool;

     

       13
       13
       +
               default     = false;

     

       14
       14
       +
               description = "Enable the spiped service module.";

     

       15
       15
       +
             };

     

       23
       16
        
       

     

       24
       24
       -
                   decrypt = mkOption {

     

       25
       25
       -
                     type    = types.bool;

     

       26
       26
       -
                     default = false;

     

       27
       27
       -
                     description = ''

     

       28
       28
       -
                       Take encrypted connections from the

     

       29
       29
       -
                       <literal>source</literal> socket and send unencrypted

     

       30
       30
       -
                       connections to the <literal>target</literal> socket.

     

       31
       31
       -
                     '';

     

       32
       32
       -
                   };

     

       17
       17
       +
             config = mkOption {

     

       18
       18
       +
               type = types.attrsOf (types.submodule (

     

       19
       19
       +
                 {

     

       20
       20
       +
                   options = {

     

       21
       21
       +
                     encrypt = mkOption {

     

       22
       22
       +
                       type    = types.bool;

     

       23
       23
       +
                       default = false;

     

       24
       24
       +
                       description = ''

     

       25
       25
       +
                         Take unencrypted connections from the

     

       26
       26
       +
                         <literal>source</literal> socket and send encrypted

     

       27
       27
       +
                         connections to the <literal>target</literal> socket.

     

       28
       28
       +
                       '';

     

       29
       29
       +
                     };

     

       33
       30
        
       

     

       34
       34
       -
                   source = mkOption {

     

       35
       35
       -
                     type    = types.str;

     

       36
       36
       -
                     description = ''

     

       37
       37
       -
                       Address on which spiped should listen for incoming

     

       38
       38
       -
                       connections.  Must be in one of the following formats:

     

       39
       39
       -
                       <literal>/absolute/path/to/unix/socket</literal>,

     

       40
       40
       -
                       <literal>host.name:port</literal>,

     

       41
       41
       -
                       <literal>[ip.v4.ad.dr]:port</literal> or

     

       42
       42
       -
                       <literal>[ipv6::addr]:port</literal> - note that

     

       43
       43
       -
                       hostnames are resolved when spiped is launched and are

     

       44
       44
       -
                       not re-resolved later; thus if DNS entries change

     

       45
       45
       -
                       spiped will continue to connect to the expired

     

       46
       46
       -
                       address.

     

       47
       47
       -
                     '';

     

       48
       48
       -
                   };

     

       31
       31
       +
                     decrypt = mkOption {

     

       32
       32
       +
                       type    = types.bool;

     

       33
       33
       +
                       default = false;

     

       34
       34
       +
                       description = ''

     

       35
       35
       +
                         Take encrypted connections from the

     

       36
       36
       +
                         <literal>source</literal> socket and send unencrypted

     

       37
       37
       +
                         connections to the <literal>target</literal> socket.

     

       38
       38
       +
                       '';

     

       39
       39
       +
                     };

     

       49
       40
        
       

     

       50
       50
       -
                   target = mkOption {

     

       51
       51
       -
                     type    = types.str;

     

       52
       52
       -
                     description = "Address to which spiped should connect.";

     

       53
       53
       -
                   };

     

       41
       41
       +
                     source = mkOption {

     

       42
       42
       +
                       type    = types.str;

     

       43
       43
       +
                       description = ''

     

       44
       44
       +
                         Address on which spiped should listen for incoming

     

       45
       45
       +
                         connections.  Must be in one of the following formats:

     

       46
       46
       +
                         <literal>/absolute/path/to/unix/socket</literal>,

     

       47
       47
       +
                         <literal>host.name:port</literal>,

     

       48
       48
       +
                         <literal>[ip.v4.ad.dr]:port</literal> or

     

       49
       49
       +
                         <literal>[ipv6::addr]:port</literal> - note that

     

       50
       50
       +
                         hostnames are resolved when spiped is launched and are

     

       51
       51
       +
                         not re-resolved later; thus if DNS entries change

     

       52
       52
       +
                         spiped will continue to connect to the expired

     

       53
       53
       +
                         address.

     

       54
       54
       +
                       '';

     

       55
       55
       +
                     };

     

       54
       56
        
       

     

       55
       55
       -
                   keyfile = mkOption {

     

       56
       56
       -
                     type    = types.path;

     

       57
       57
       -
                     description = ''

     

       58
       58
       -
                       Name of a file containing the spiped key. As the

     

       59
       59
       -
                       daemon runs as the <literal>spiped</literal> user, the

     

       60
       60
       -
                       key file must be somewhere owned by that user. By

     

       61
       61
       -
                       default, we recommend putting the keys for any spipe

     

       62
       62
       -
                       services in <literal>/var/lib/spiped</literal>.

     

       63
       63
       -
                     '';

     

       64
       64
       -
                   };

     

       57
       57
       +
                     target = mkOption {

     

       58
       58
       +
                       type    = types.str;

     

       59
       59
       +
                       description = "Address to which spiped should connect.";

     

       60
       60
       +
                     };

     

       65
       61
        
       

     

       66
       66
       -
                   timeout = mkOption {

     

       67
       67
       -
                     type = types.int;

     

       68
       68
       -
                     default = 5;

     

       69
       69
       -
                     description = ''

     

       70
       70
       -
                       Timeout, in seconds, after which an attempt to connect to

     

       71
       71
       -
                       the target or a protocol handshake will be aborted (and the

     

       72
       72
       -
                       connection dropped) if not completed

     

       73
       73
       -
                     '';

     

       74
       74
       -
                   };

     

       62
       62
       +
                     keyfile = mkOption {

     

       63
       63
       +
                       type    = types.path;

     

       64
       64
       +
                       description = ''

     

       65
       65
       +
                         Name of a file containing the spiped key. As the

     

       66
       66
       +
                         daemon runs as the <literal>spiped</literal> user, the

     

       67
       67
       +
                         key file must be somewhere owned by that user. By

     

       68
       68
       +
                         default, we recommend putting the keys for any spipe

     

       69
       69
       +
                         services in <literal>/var/lib/spiped</literal>.

     

       70
       70
       +
                       '';

     

       71
       71
       +
                     };

     

       75
       72
        
       

     

       76
       76
       -
                   maxConns = mkOption {

     

       77
       77
       -
                     type = types.int;

     

       78
       78
       -
                     default = 100;

     

       79
       79
       -
                     description = ''

     

       80
       80
       -
                       Limit on the number of simultaneous connections allowed.

     

       81
       81
       -
                     '';

     

       82
       82
       -
                   };

     

       73
       73
       +
                     timeout = mkOption {

     

       74
       74
       +
                       type = types.int;

     

       75
       75
       +
                       default = 5;

     

       76
       76
       +
                       description = ''

     

       77
       77
       +
                         Timeout, in seconds, after which an attempt to connect to

     

       78
       78
       +
                         the target or a protocol handshake will be aborted (and the

     

       79
       79
       +
                         connection dropped) if not completed

     

       80
       80
       +
                       '';

     

       81
       81
       +
                     };

     

       83
       82
        
       

     

       84
       84
       -
                   waitForDNS = mkOption {

     

       85
       85
       -
                     type = types.bool;

     

       86
       86
       -
                     default = false;

     

       87
       87
       -
                     description = ''

     

       88
       88
       -
                       Wait for DNS. Normally when <literal>spiped</literal> is

     

       89
       89
       -
                       launched it resolves addresses and binds to its source

     

       90
       90
       -
                       socket before the parent process returns; with this option

     

       91
       91
       -
                       it will daemonize first and retry failed DNS lookups until

     

       92
       92
       -
                       they succeed. This allows <literal>spiped</literal> to

     

       93
       93
       -
                       launch even if DNS isn't set up yet, but at the expense of

     

       94
       94
       -
                       losing the guarantee that once <literal>spiped</literal> has

     

       95
       95
       -
                       finished launching it will be ready to create pipes.

     

       96
       96
       -
                     '';

     

       97
       97
       -
                   };

     

       83
       83
       +
                     maxConns = mkOption {

     

       84
       84
       +
                       type = types.int;

     

       85
       85
       +
                       default = 100;

     

       86
       86
       +
                       description = ''

     

       87
       87
       +
                         Limit on the number of simultaneous connections allowed.

     

       88
       88
       +
                       '';

     

       89
       89
       +
                     };

     

       98
       90
        
       

     

       99
       99
       -
                   disableKeepalives = mkOption {

     

       100
       100
       -
                     type = types.bool;

     

       101
       101
       -
                     default = false;

     

       102
       102
       -
                     description = "Disable transport layer keep-alives.";

     

       103
       103
       -
                   };

     

       91
       91
       +
                     waitForDNS = mkOption {

     

       92
       92
       +
                       type = types.bool;

     

       93
       93
       +
                       default = false;

     

       94
       94
       +
                       description = ''

     

       95
       95
       +
                         Wait for DNS. Normally when <literal>spiped</literal> is

     

       96
       96
       +
                         launched it resolves addresses and binds to its source

     

       97
       97
       +
                         socket before the parent process returns; with this option

     

       98
       98
       +
                         it will daemonize first and retry failed DNS lookups until

     

       99
       99
       +
                         they succeed. This allows <literal>spiped</literal> to

     

       100
       100
       +
                         launch even if DNS isn't set up yet, but at the expense of

     

       101
       101
       +
                         losing the guarantee that once <literal>spiped</literal> has

     

       102
       102
       +
                         finished launching it will be ready to create pipes.

     

       103
       103
       +
                       '';

     

       104
       104
       +
                     };

     

       104
       105
        
       

     

       105
       105
       -
                   weakHandshake = mkOption {

     

       106
       106
       -
                     type = types.bool;

     

       107
       107
       -
                     default = false;

     

       108
       108
       -
                     description = ''

     

       109
       109
       -
                       Use fast/weak handshaking: This reduces the CPU time spent

     

       110
       110
       -
                       in the initial connection setup, at the expense of losing

     

       111
       111
       -
                       perfect forward secrecy.

     

       112
       112
       -
                     '';

     

       113
       113
       -
                   };

     

       106
       106
       +
                     disableKeepalives = mkOption {

     

       107
       107
       +
                       type = types.bool;

     

       108
       108
       +
                       default = false;

     

       109
       109
       +
                       description = "Disable transport layer keep-alives.";

     

       110
       110
       +
                     };

     

       114
       111
        
       

     

       115
       115
       -
                   resolveRefresh = mkOption {

     

       116
       116
       -
                     type = types.int;

     

       117
       117
       -
                     default = 60;

     

       118
       118
       -
                     description = ''

     

       119
       119
       -
                       Resolution refresh time for the target socket, in seconds.

     

       120
       120
       -
                     '';

     

       121
       121
       -
                   };

     

       112
       112
       +
                     weakHandshake = mkOption {

     

       113
       113
       +
                       type = types.bool;

     

       114
       114
       +
                       default = false;

     

       115
       115
       +
                       description = ''

     

       116
       116
       +
                         Use fast/weak handshaking: This reduces the CPU time spent

     

       117
       117
       +
                         in the initial connection setup, at the expense of losing

     

       118
       118
       +
                         perfect forward secrecy.

     

       119
       119
       +
                       '';

     

       120
       120
       +
                     };

     

       122
       121
        
       

     

       123
       123
       -
                   disableReresolution = mkOption {

     

       124
       124
       -
                     type = types.bool;

     

       125
       125
       -
                     default = false;

     

       126
       126
       -
                     description = "Disable target address re-resolution.";

     

       122
       122
       +
                     resolveRefresh = mkOption {

     

       123
       123
       +
                       type = types.int;

     

       124
       124
       +
                       default = 60;

     

       125
       125
       +
                       description = ''

     

       126
       126
       +
                         Resolution refresh time for the target socket, in seconds.

     

       127
       127
       +
                       '';

     

       128
       128
       +
                     };

     

       129
       129
       +
       

     

       130
       130
       +
                     disableReresolution = mkOption {

     

       131
       131
       +
                       type = types.bool;

     

       132
       132
       +
                       default = false;

     

       133
       133
       +
                       description = "Disable target address re-resolution.";

     

       134
       134
       +
                     };

     

       127
       135
        
                   };

     

       128
       128
       -
                 };

     

       129
       129
       -
               }

     

       130
       130
       -
             ));

     

       136
       136
       +
                 }

     

       137
       137
       +
               ));

     

       131
       138
        
       

     

       132
       132
       -
             default = {};

     

       139
       139
       +
               default = {};

     

       133
       140
        
       

     

       134
       134
       -
             example = literalExample ''

     

       135
       135
       -
               {

     

       136
       136
       -
                 pipe1 =

     

       137
       137
       -
                   { keyfile = "/var/lib/spiped/pipe1.key";

     

       138
       138
       -
                     encrypt = true;

     

       139
       139
       -
                     source  = "localhost:6000";

     

       140
       140
       -
                     target  = "endpoint.example.com:7000";

     

       141
       141
       -
                   };

     

       142
       142
       -
                 pipe2 =

     

       143
       143
       -
                   { keyfile = "/var/lib/spiped/pipe2.key";

     

       144
       144
       -
                     decrypt = true;

     

       145
       145
       -
                     source  = "0.0.0.0:7000";

     

       146
       146
       -
                     target  = "localhost:3000";

     

       147
       147
       -
                   };

     

       148
       148
       -
               }

     

       149
       149
       -
             '';

     

       141
       141
       +
               example = literalExample ''

     

       142
       142
       +
                 {

     

       143
       143
       +
                   pipe1 =

     

       144
       144
       +
                     { keyfile = "/var/lib/spiped/pipe1.key";

     

       145
       145
       +
                       encrypt = true;

     

       146
       146
       +
                       source  = "localhost:6000";

     

       147
       147
       +
                       target  = "endpoint.example.com:7000";

     

       148
       148
       +
                     };

     

       149
       149
       +
                   pipe2 =

     

       150
       150
       +
                     { keyfile = "/var/lib/spiped/pipe2.key";

     

       151
       151
       +
                       decrypt = true;

     

       152
       152
       +
                       source  = "0.0.0.0:7000";

     

       153
       153
       +
                       target  = "localhost:3000";

     

       154
       154
       +
                     };

     

       155
       155
       +
                 }

     

       156
       156
       +
               '';

     

       150
       157
        
       

     

       151
       151
       -
             description = ''

     

       152
       152
       -
               Configuration for a secure pipe daemon. The daemon can be

     

       153
       153
       -
               started, stopped, or examined using

     

       154
       154
       -
               <literal>systemctl</literal>, under the name

     

       155
       155
       -
               <literal>spiped@foo</literal>.

     

       156
       156
       -
             '';

     

       158
       158
       +
               description = ''

     

       159
       159
       +
                 Configuration for a secure pipe daemon. The daemon can be

     

       160
       160
       +
                 started, stopped, or examined using

     

       161
       161
       +
                 <literal>systemctl</literal>, under the name

     

       162
       162
       +
                 <literal>spiped@foo</literal>.

     

       163
       163
       +
               '';

     

       164
       164
       +
             };

     

       157
       165
        
           };

     

       158
       166
        
         };

     

       159
       167
        
       

     

       160
       160
       -
         config = {

     

       168
       168
       +
         config = mkIf cfg.enable {

     

       161
       169
        
           assertions = mapAttrsToList (name: c: {

     

       162
       170
        
             assertion = (c.encrypt -> !c.decrypt) || (c.decrypt -> c.encrypt);

     

       163
       171
        
             message   = "A pipe must either encrypt or decrypt";

     

       164
       164
       -
           }) cfg;

     

       172
       172
       +
           }) cfg.config;

     

       165
       173
        
       

     

       166
       174
        
           users.extraGroups.spiped.gid = config.ids.gids.spiped;

     

       167
       175
        
           users.extraUsers.spiped = {

     
···

       189
       197
        
             script = "exec ${pkgs.spiped}/bin/spiped -F `cat /etc/spiped/$1.spec`";

     

       190
       198
        
           };

     

       191
       199
        
       

     

       192
       192
       -
           system.activationScripts.spiped = optionalString (cfg != {})

     

       200
       200
       +
           system.activationScripts.spiped = optionalString (cfg.config != {})

     

       193
       201
        
             "mkdir -p /var/lib/spiped";

     

       194
       202
        
       

     

       195
       203
        
           # Setup spiped config files

     
···

       207
       215
        
                   (if cfg.disableReresolution then "-R"

     

       208
       216
        
                     else "-r ${toString cfg.resolveRefresh}")

     

       209
       217
        
                 ];

     

       210
       210
       -
             }) cfg;

     

       218
       218
       +
             }) cfg.config;

     

       211
       219
        
         };

     

       212
       220
        
       }