commit d62c14f5d1b39a61fae1688e5f760b1cb9c3a1ec · pyrox.dev/nixpkgs

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

···

       111
       111
        
       

     

       112
       112
        
       - [PostgREST](https://postgrest.org), a standalone web server that turns your PostgreSQL database directly into a RESTful API. Available as [services.postgrest](options.html#opt-services.postgrest.enable).

     

       113
       113
        
       

     

       114
       114
       +
       - [postgres-websockets](https://github.com/diogob/postgres-websockets), a middleware that adds websockets capabilites on top of PostgreSQL's asynchronous notifications using LISTEN and NOTIFY commands. Available as [services.postgres-websockets](options.html#opt-services.postgres-websockets.enable).

     

       115
       115
       +
       

     

       114
       116
        
       - [µStreamer](https://github.com/pikvm/ustreamer), a lightweight MJPEG-HTTP streamer. Available as [services.ustreamer](options.html#opt-services.ustreamer).

     

       115
       117
        
       

     

       116
       118
        
       - [Whoogle Search](https://github.com/benbusby/whoogle-search), a self-hosted, ad-free, privacy-respecting metasearch engine. Available as [services.whoogle-search](options.html#opt-services.whoogle-search.enable).

nixos/modules/module-list.nix

···

       515
       515
        
         ./services/databases/opentsdb.nix

     

       516
       516
        
         ./services/databases/pgbouncer.nix

     

       517
       517
        
         ./services/databases/pgmanage.nix

     

       518
       518
       +
         ./services/databases/postgres-websockets.nix

     

       518
       519
        
         ./services/databases/postgresql.nix

     

       519
       520
        
         ./services/databases/postgrest.nix

     

       520
       521
        
         ./services/databases/redis.nix

+221

nixos/modules/services/databases/postgres-websockets.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.services.postgres-websockets;

     

       10
       10
       +
       

     

       11
       11
       +
         # Turns an attrset of libpq connection params:

     

       12
       12
       +
         #   {

     

       13
       13
       +
         #     dbname = "postgres";

     

       14
       14
       +
         #     user = "authenticator";

     

       15
       15
       +
         #   }

     

       16
       16
       +
         # into a libpq connection string:

     

       17
       17
       +
         #   dbname=postgres user=authenticator

     

       18
       18
       +
         PGWS_DB_URI = lib.pipe cfg.environment.PGWS_DB_URI [

     

       19
       19
       +
           (lib.filterAttrs (_: v: v != null))

     

       20
       20
       +
           (lib.mapAttrsToList (k: v: "${k}='${lib.escape [ "'" "\\" ] v}'"))

     

       21
       21
       +
           (lib.concatStringsSep " ")

     

       22
       22
       +
         ];

     

       23
       23
       +
       in

     

       24
       24
       +
       

     

       25
       25
       +
       {

     

       26
       26
       +
         meta = {

     

       27
       27
       +
           maintainers = with lib.maintainers; [ wolfgangwalther ];

     

       28
       28
       +
         };

     

       29
       29
       +
       

     

       30
       30
       +
         options.services.postgres-websockets = {

     

       31
       31
       +
           enable = lib.mkEnableOption "postgres-websockets";

     

       32
       32
       +
       

     

       33
       33
       +
           pgpassFile = lib.mkOption {

     

       34
       34
       +
             type =

     

       35
       35
       +
               with lib.types;

     

       36
       36
       +
               nullOr (pathWith {

     

       37
       37
       +
                 inStore = false;

     

       38
       38
       +
                 absolute = true;

     

       39
       39
       +
               });

     

       40
       40
       +
             default = null;

     

       41
       41
       +
             example = "/run/keys/db_password";

     

       42
       42
       +
             description = ''

     

       43
       43
       +
               The password to authenticate to PostgreSQL with.

     

       44
       44
       +
               Not needed for peer or trust based authentication.

     

       45
       45
       +
       

     

       46
       46
       +
               The file must be a valid `.pgpass` file as described in:

     

       47
       47
       +
               <https://www.postgresql.org/docs/current/libpq-pgpass.html>

     

       48
       48
       +
       

     

       49
       49
       +
               In most cases, the following will be enough:

     

       50
       50
       +
               ```

     

       51
       51
       +
               *:*:*:*:<password>

     

       52
       52
       +
               ```

     

       53
       53
       +
             '';

     

       54
       54
       +
           };

     

       55
       55
       +
       

     

       56
       56
       +
           jwtSecretFile = lib.mkOption {

     

       57
       57
       +
             type =

     

       58
       58
       +
               with lib.types;

     

       59
       59
       +
               nullOr (pathWith {

     

       60
       60
       +
                 inStore = false;

     

       61
       61
       +
                 absolute = true;

     

       62
       62
       +
               });

     

       63
       63
       +
             example = "/run/keys/jwt_secret";

     

       64
       64
       +
             description = ''

     

       65
       65
       +
               Secret used to sign JWT tokens used to open communications channels.

     

       66
       66
       +
             '';

     

       67
       67
       +
           };

     

       68
       68
       +
       

     

       69
       69
       +
           environment = lib.mkOption {

     

       70
       70
       +
             type = lib.types.submodule {

     

       71
       71
       +
               freeformType = with lib.types; attrsOf str;

     

       72
       72
       +
       

     

       73
       73
       +
               options = {

     

       74
       74
       +
                 PGWS_DB_URI = lib.mkOption {

     

       75
       75
       +
                   type = lib.types.submodule {

     

       76
       76
       +
                     freeformType = with lib.types; attrsOf str;

     

       77
       77
       +
       

     

       78
       78
       +
                     # This should not be used; use pgpassFile instead.

     

       79
       79
       +
                     options.password = lib.mkOption {

     

       80
       80
       +
                       default = null;

     

       81
       81
       +
                       readOnly = true;

     

       82
       82
       +
                       internal = true;

     

       83
       83
       +
                     };

     

       84
       84
       +
                     # This should not be used; use pgpassFile instead.

     

       85
       85
       +
                     options.passfile = lib.mkOption {

     

       86
       86
       +
                       default = null;

     

       87
       87
       +
                       readOnly = true;

     

       88
       88
       +
                       internal = true;

     

       89
       89
       +
                     };

     

       90
       90
       +
                   };

     

       91
       91
       +
                   default = { };

     

       92
       92
       +
                   description = ''

     

       93
       93
       +
                     libpq connection parameters as documented in:

     

       94
       94
       +
       

     

       95
       95
       +
                     <https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS>

     

       96
       96
       +
       

     

       97
       97
       +
                     ::: {.note}

     

       98
       98
       +
                     The `environment.PGWS_DB_URI.password` and `environment.PGWS_DB_URI.passfile` options are blocked.

     

       99
       99
       +
                     Use [`pgpassFile`](#opt-services.postgres-websockets.pgpassFile) instead.

     

       100
       100
       +
                     :::

     

       101
       101
       +
                   '';

     

       102
       102
       +
                   example = lib.literalExpression ''

     

       103
       103
       +
                     {

     

       104
       104
       +
                       host = "localhost";

     

       105
       105
       +
                       dbname = "postgres";

     

       106
       106
       +
                     }

     

       107
       107
       +
                   '';

     

       108
       108
       +
                 };

     

       109
       109
       +
       

     

       110
       110
       +
                 # This should not be used; use jwtSecretFile instead.

     

       111
       111
       +
                 PGWS_JWT_SECRET = lib.mkOption {

     

       112
       112
       +
                   default = null;

     

       113
       113
       +
                   readOnly = true;

     

       114
       114
       +
                   internal = true;

     

       115
       115
       +
                 };

     

       116
       116
       +
       

     

       117
       117
       +
                 PGWS_HOST = lib.mkOption {

     

       118
       118
       +
                   type = with lib.types; nullOr str;

     

       119
       119
       +
                   default = "127.0.0.1";

     

       120
       120
       +
                   description = ''

     

       121
       121
       +
                     Address the server will listen for websocket connections.

     

       122
       122
       +
                   '';

     

       123
       123
       +
                 };

     

       124
       124
       +
               };

     

       125
       125
       +
             };

     

       126
       126
       +
             default = { };

     

       127
       127
       +
             description = ''

     

       128
       128
       +
               postgres-websockets configuration as defined in:

     

       129
       129
       +
               <https://github.com/diogob/postgres-websockets/blob/master/src/PostgresWebsockets/Config.hs#L71-L87>

     

       130
       130
       +
       

     

       131
       131
       +
               `PGWS_DB_URI` is represented as an attribute set, see [`environment.PGWS_DB_URI`](#opt-services.postgres-websockets.environment.PGWS_DB_URI)

     

       132
       132
       +
       

     

       133
       133
       +
               ::: {.note}

     

       134
       134
       +
               The `environment.PGWS_JWT_SECRET` option is blocked.

     

       135
       135
       +
               Use [`jwtSecretFile`](#opt-services.postgres-websockets.jwtSecretFile) instead.

     

       136
       136
       +
               :::

     

       137
       137
       +
             '';

     

       138
       138
       +
             example = lib.literalExpression ''

     

       139
       139
       +
               {

     

       140
       140
       +
                 PGWS_LISTEN_CHANNEL = "my_channel";

     

       141
       141
       +
                 PGWS_DB_URI.dbname = "postgres";

     

       142
       142
       +
               }

     

       143
       143
       +
             '';

     

       144
       144
       +
           };

     

       145
       145
       +
         };

     

       146
       146
       +
       

     

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

     

       148
       148
       +
           services.postgres-websockets.environment.PGWS_DB_URI.application_name =

     

       149
       149
       +
             with pkgs.postgres-websockets;

     

       150
       150
       +
             "${pname} ${version}";

     

       151
       151
       +
       

     

       152
       152
       +
           systemd.services.postgres-websockets = {

     

       153
       153
       +
             description = "postgres-websockets";

     

       154
       154
       +
       

     

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

     

       156
       156
       +
             wants = [ "network-online.target" ];

     

       157
       157
       +
             after = [

     

       158
       158
       +
               "network-online.target"

     

       159
       159
       +
               "postgresql.service"

     

       160
       160
       +
             ];

     

       161
       161
       +
       

     

       162
       162
       +
             environment =

     

       163
       163
       +
               cfg.environment

     

       164
       164
       +
               // {

     

       165
       165
       +
                 inherit PGWS_DB_URI;

     

       166
       166
       +
                 PGWS_JWT_SECRET = "@%d/jwt_secret";

     

       167
       167
       +
               }

     

       168
       168
       +
               // lib.optionalAttrs (cfg.pgpassFile != null) {

     

       169
       169
       +
                 PGPASSFILE = "%C/postgres-websockets/pgpass";

     

       170
       170
       +
               };

     

       171
       171
       +
       

     

       172
       172
       +
             serviceConfig = {

     

       173
       173
       +
               CacheDirectory = "postgres-websockets";

     

       174
       174
       +
               CacheDirectoryMode = "0700";

     

       175
       175
       +
               LoadCredential = [

     

       176
       176
       +
                 "jwt_secret:${cfg.jwtSecretFile}"

     

       177
       177
       +
               ] ++ lib.optional (cfg.pgpassFile != null) "pgpass:${cfg.pgpassFile}";

     

       178
       178
       +
               Restart = "always";

     

       179
       179
       +
               User = "postgres-websockets";

     

       180
       180
       +
       

     

       181
       181
       +
               # Hardening

     

       182
       182
       +
               CapabilityBoundingSet = [ "" ];

     

       183
       183
       +
               DevicePolicy = "closed";

     

       184
       184
       +
               DynamicUser = true;

     

       185
       185
       +
               LockPersonality = true;

     

       186
       186
       +
               MemoryDenyWriteExecute = true;

     

       187
       187
       +
               NoNewPrivileges = true;

     

       188
       188
       +
               PrivateDevices = true;

     

       189
       189
       +
               PrivateIPC = true;

     

       190
       190
       +
               PrivateMounts = true;

     

       191
       191
       +
               ProcSubset = "pid";

     

       192
       192
       +
               ProtectClock = true;

     

       193
       193
       +
               ProtectControlGroups = true;

     

       194
       194
       +
               ProtectHostname = true;

     

       195
       195
       +
               ProtectKernelLogs = true;

     

       196
       196
       +
               ProtectKernelModules = true;

     

       197
       197
       +
               ProtectKernelTunables = true;

     

       198
       198
       +
               ProtectProc = "invisible";

     

       199
       199
       +
               RestrictAddressFamilies = [

     

       200
       200
       +
                 "AF_INET"

     

       201
       201
       +
                 "AF_INET6"

     

       202
       202
       +
                 "AF_UNIX"

     

       203
       203
       +
               ];

     

       204
       204
       +
               RestrictNamespaces = true;

     

       205
       205
       +
               RestrictRealtime = true;

     

       206
       206
       +
               SystemCallArchitectures = "native";

     

       207
       207
       +
               SystemCallFilter = [ "" ];

     

       208
       208
       +
               UMask = "0077";

     

       209
       209
       +
             };

     

       210
       210
       +
       

     

       211
       211
       +
             # Copy the pgpass file to different location, to have it report mode 0400.

     

       212
       212
       +
             # Fixes: https://github.com/systemd/systemd/issues/29435

     

       213
       213
       +
             script = ''

     

       214
       214
       +
               if [ -f "$CREDENTIALS_DIRECTORY/pgpass" ]; then

     

       215
       215
       +
                   cp -f "$CREDENTIALS_DIRECTORY/pgpass" "$CACHE_DIRECTORY/pgpass"

     

       216
       216
       +
               fi

     

       217
       217
       +
               exec ${lib.getExe pkgs.postgres-websockets}

     

       218
       218
       +
             '';

     

       219
       219
       +
           };

     

       220
       220
       +
         };

     

       221
       221
       +
       }

nixos/tests/all-tests.nix

···

       1080
       1080
        
           handleTest ./postfix-raise-smtpd-tls-security-level.nix

     

       1081
       1081
        
             { };

     

       1082
       1082
        
         postfixadmin = handleTest ./postfixadmin.nix { };

     

       1083
       1083
       +
         postgres-websockets = runTest ./postgres-websockets.nix;

     

       1083
       1084
        
         postgresql = handleTest ./postgresql { };

     

       1084
       1085
        
         postgrest = runTest ./postgrest.nix;

     

       1085
       1086
        
         powerdns = handleTest ./powerdns.nix { };

+84

nixos/tests/postgres-websockets.nix

···

       1
       1
       +
       { lib, ... }:

     

       2
       2
       +
       {

     

       3
       3
       +
         name = "postgres-websockets";

     

       4
       4
       +
       

     

       5
       5
       +
         meta = {

     

       6
       6
       +
           maintainers = with lib.maintainers; [ wolfgangwalther ];

     

       7
       7
       +
         };

     

       8
       8
       +
       

     

       9
       9
       +
         nodes.machine =

     

       10
       10
       +
           {

     

       11
       11
       +
             config,

     

       12
       12
       +
             lib,

     

       13
       13
       +
             pkgs,

     

       14
       14
       +
             ...

     

       15
       15
       +
           }:

     

       16
       16
       +
           {

     

       17
       17
       +
             environment.systemPackages = [ pkgs.websocat ];

     

       18
       18
       +
       

     

       19
       19
       +
             services.postgresql = {

     

       20
       20
       +
               enable = true;

     

       21
       21
       +
               initialScript = pkgs.writeText "init.sql" ''

     

       22
       22
       +
                 CREATE ROLE "postgres-websockets" LOGIN NOINHERIT;

     

       23
       23
       +
                 CREATE ROLE "postgres-websockets_with_password" LOGIN NOINHERIT PASSWORD 'password';

     

       24
       24
       +
               '';

     

       25
       25
       +
             };

     

       26
       26
       +
       

     

       27
       27
       +
             services.postgres-websockets = {

     

       28
       28
       +
               enable = true;

     

       29
       29
       +
               jwtSecretFile = "/run/secrets/jwt.secret";

     

       30
       30
       +
               environment.PGWS_DB_URI.dbname = "postgres";

     

       31
       31
       +
               environment.PGWS_LISTEN_CHANNEL = "websockets-listener";

     

       32
       32
       +
             };

     

       33
       33
       +
       

     

       34
       34
       +
             specialisation.withPassword.configuration = {

     

       35
       35
       +
               services.postgresql.enableTCPIP = true;

     

       36
       36
       +
               services.postgres-websockets = {

     

       37
       37
       +
                 pgpassFile = "/run/secrets/.pgpass";

     

       38
       38
       +
                 environment.PGWS_DB_URI.host = "localhost";

     

       39
       39
       +
                 environment.PGWS_DB_URI.user = "postgres-websockets_with_password";

     

       40
       40
       +
               };

     

       41
       41
       +
             };

     

       42
       42
       +
           };

     

       43
       43
       +
       

     

       44
       44
       +
         extraPythonPackages = p: [ p.pyjwt ];

     

       45
       45
       +
       

     

       46
       46
       +
         testScript =

     

       47
       47
       +
           { nodes, ... }:

     

       48
       48
       +
           let

     

       49
       49
       +
             withPassword = "${nodes.machine.system.build.toplevel}/specialisation/withPassword";

     

       50
       50
       +
           in

     

       51
       51
       +
           ''

     

       52
       52
       +
             machine.execute("""

     

       53
       53
       +
               mkdir -p /run/secrets

     

       54
       54
       +
               echo reallyreallyreallyreallyverysafe > /run/secrets/jwt.secret

     

       55
       55
       +
             """)

     

       56
       56
       +
       

     

       57
       57
       +
             import jwt

     

       58
       58
       +
             token = jwt.encode({ "mode": "rw" }, "reallyreallyreallyreallyverysafe")

     

       59
       59
       +
       

     

       60
       60
       +
             def test():

     

       61
       61
       +
                 machine.wait_for_unit("postgresql.service")

     

       62
       62
       +
                 machine.wait_for_unit("postgres-websockets.service")

     

       63
       63
       +
       

     

       64
       64
       +
                 machine.succeed(f"echo 'hi there' | websocat --no-close 'ws://localhost:3000/test/{token}' > output &")

     

       65
       65
       +
                 machine.sleep(1)

     

       66
       66
       +
                 machine.succeed("grep 'hi there' output")

     

       67
       67
       +
       

     

       68
       68
       +
                 machine.succeed("""

     

       69
       69
       +
                   sudo -u postgres psql -c "SELECT pg_notify('websockets-listener', json_build_object('channel', 'test', 'event', 'message', 'payload', 'Hello World')::text);" >/dev/null

     

       70
       70
       +
                 """)

     

       71
       71
       +
                 machine.sleep(1)

     

       72
       72
       +
                 machine.succeed("grep 'Hello World' output")

     

       73
       73
       +
       

     

       74
       74
       +
             with subtest("without password"):

     

       75
       75
       +
                 test()

     

       76
       76
       +
       

     

       77
       77
       +
             with subtest("with password"):

     

       78
       78
       +
                 machine.execute("""

     

       79
       79
       +
                   echo "*:*:*:*:password" > /run/secrets/.pgpass

     

       80
       80
       +
                 """)

     

       81
       81
       +
                 machine.succeed("${withPassword}/bin/switch-to-configuration test >&2")

     

       82
       82
       +
                 test()

     

       83
       83
       +
           '';

     

       84
       84
       +
       }

+4 -1

pkgs/development/haskell-modules/configuration-nix.nix

···

       481
       481
        
         hasql-transaction = dontCheck super.hasql-transaction;

     

       482
       482
        
       

     

       483
       483
        
         # Avoid compiling twice by providing executable as a separate output (with small closure size),

     

       484
       484
       -
         postgres-websockets = enableSeparateBinOutput super.postgres-websockets;

     

       484
       484
       +
         postgres-websockets = lib.pipe super.postgres-websockets [

     

       485
       485
       +
           enableSeparateBinOutput

     

       486
       486
       +
           (overrideCabal { passthru.tests = pkgs.nixosTests.postgres-websockets; })

     

       487
       487
       +
         ];

     

       485
       488
        
       

     

       486
       489
        
         # Test suite requires a running postgresql server,

     

       487
       490
        
         # avoid compiling twice by providing executable as a separate output (with small closure size),