commit 42b6d626997c4ebe420da7ccd70352cc08681238 · pyrox.dev/nixpkgs

+71

nixos/modules/services/databases/lldap.nix

···

       102
       102
        
                   default = "sqlite://./users.db?mode=rwc";

     

       103
       103
        
                   example = "postgres://postgres-user:password@postgres-server/my-database";

     

       104
       104
        
                 };

     

       105
       105
       +
       

     

       106
       106
       +
                 ldap_user_pass_file = mkOption {

     

       107
       107
       +
                   type = types.nullOr types.str;

     

       108
       108
       +
                   default = null;

     

       109
       109
       +
                   description = ''

     

       110
       110
       +
                     Path to a file containing the default admin password.

     

       111
       111
       +
       

     

       112
       112
       +
                     If you want to update the default admin password through this setting,

     

       113
       113
       +
                     you must set `force_ldap_user_pass_reset` to `true`.

     

       114
       114
       +
                     Otherwise changing this setting will have no effect

     

       115
       115
       +
                     unless this is the very first time LLDAP is started and its database is still empty.

     

       116
       116
       +
                   '';

     

       117
       117
       +
                 };

     

       118
       118
       +
       

     

       119
       119
       +
                 force_ldap_user_pass_reset = mkOption {

     

       120
       120
       +
                   type = types.oneOf [

     

       121
       121
       +
                     types.bool

     

       122
       122
       +
                     (types.enum [ "always" ])

     

       123
       123
       +
                   ];

     

       124
       124
       +
                   default = false;

     

       125
       125
       +
                   description = ''

     

       126
       126
       +
                     Force reset of the admin password.

     

       127
       127
       +
       

     

       128
       128
       +
                     Set this setting to `"always"` to update the admin password when `ldap_user_pass_file` changes.

     

       129
       129
       +
                     Setting to `"always"` also means any password update in the UI will be overwritten next time the service restarts.

     

       130
       130
       +
       

     

       131
       131
       +
                     The difference between `true` and `"always"` is the former is intended for a one time fix

     

       132
       132
       +
                     while the latter is intended for a declarative workflow. In practice, the result

     

       133
       133
       +
                     is the same: the password gets reset. The only practical difference is the former

     

       134
       134
       +
                     outputs a warning message while the latter outputs an info message.

     

       135
       135
       +
                   '';

     

       136
       136
       +
                 };

     

       137
       137
       +
       

     

       138
       138
       +
                 jwt_secret_file = mkOption {

     

       139
       139
       +
                   type = types.nullOr types.str;

     

       140
       140
       +
                   default = null;

     

       141
       141
       +
                   description = ''

     

       142
       142
       +
                     Path to a file containing the JWT secret.

     

       143
       143
       +
                   '';

     

       144
       144
       +
                 };

     

       105
       145
        
               };

     

       106
       146
        
             };

     

       147
       147
       +
       

     

       148
       148
       +
             # TOML does not allow null values, so we use null to omit those fields

     

       149
       149
       +
             apply = lib.filterAttrsRecursive (_: v: v != null);

     

       150
       150
       +
           };

     

       151
       151
       +
       

     

       152
       152
       +
           silenceForceUserPassResetWarning = mkOption {

     

       153
       153
       +
             type = types.bool;

     

       154
       154
       +
             default = false;

     

       155
       155
       +
             description = ''

     

       156
       156
       +
               Disable warning when the admin password is set declaratively with the `ldap_user_pass_file` setting

     

       157
       157
       +
               but the `force_ldap_user_pass_reset` is set to `false`.

     

       158
       158
       +
       

     

       159
       159
       +
               This can lead to the admin password to drift from the one given declaratively.

     

       160
       160
       +
               If that is okay for you and you want to silence the warning, set this option to `true`.

     

       161
       161
       +
             '';

     

       107
       162
        
           };

     

       108
       163
        
         };

     

       109
       164
        
       

     

       110
       165
        
         config = lib.mkIf cfg.enable {

     

       166
       166
       +
           warnings =

     

       167
       167
       +
             lib.optionals

     

       168
       168
       +
               (

     

       169
       169
       +
                 (cfg.settings.ldap_user_pass_file or null) != null

     

       170
       170
       +
                 && cfg.settings.force_ldap_user_pass_reset == false

     

       171
       171
       +
                 && cfg.silenceForceUserPassResetWarning == false

     

       172
       172
       +
               )

     

       173
       173
       +
               [

     

       174
       174
       +
                 ''

     

       175
       175
       +
                   lldap: The default admin password is declared with the setting `ldap_user_pass_file`, but `force_ldap_user_pass_reset` is set to `false`.

     

       176
       176
       +
                   This means the admin password can be changed through the UI and will drift from the one defined in your nix config.

     

       177
       177
       +
                   It also means changing the setting `ldap_user_pass_file` will have no effect on the admin password.

     

       178
       178
       +
                   Either set `force_ldap_user_pass_reset` to `"always"` or silence this warning by setting the option `services.lldap.silenceForceUserPassResetWarning` to `true`.

     

       179
       179
       +
                 ''

     

       180
       180
       +
               ];

     

       181
       181
       +
       

     

       111
       182
        
           systemd.services.lldap = {

     

       112
       183
        
             description = "Lightweight LDAP server (lldap)";

     

       113
       184
        
             wants = [ "network-online.target" ];

+63 -9

nixos/tests/lldap.nix

···

       1
       1
        
       { ... }:

     

       2
       2
       +
       let

     

       3
       3
       +
         adminPassword = "mySecretPassword";

     

       4
       4
       +
       in

     

       2
       5
        
       {

     

       3
       6
        
         name = "lldap";

     

       4
       7
        
       

     
···

       7
       10
        
           {

     

       8
       11
        
             services.lldap = {

     

       9
       12
        
               enable = true;

     

       13
       13
       +
       

     

       10
       14
        
               settings = {

     

       11
       15
        
                 verbose = true;

     

       12
       16
        
                 ldap_base_dn = "dc=example,dc=com";

     

       13
       17
        
               };

     

       14
       18
        
             };

     

       15
       19
        
             environment.systemPackages = [ pkgs.openldap ];

     

       20
       20
       +
       

     

       21
       21
       +
             specialisation = {

     

       22
       22
       +
               differentAdminPassword.configuration =

     

       23
       23
       +
                 { ... }:

     

       24
       24
       +
                 {

     

       25
       25
       +
                   services.lldap.settings = {

     

       26
       26
       +
                     ldap_user_pass_file = toString (pkgs.writeText "adminPasswordFile" adminPassword);

     

       27
       27
       +
                     force_ldap_user_pass_reset = "always";

     

       28
       28
       +
                   };

     

       29
       29
       +
                 };

     

       30
       30
       +
       

     

       31
       31
       +
               changeAdminPassword.configuration =

     

       32
       32
       +
                 { ... }:

     

       33
       33
       +
                 {

     

       34
       34
       +
                   services.lldap.settings = {

     

       35
       35
       +
                     ldap_user_pass_file = toString (pkgs.writeText "adminPasswordFile" "password");

     

       36
       36
       +
                     force_ldap_user_pass_reset = false;

     

       37
       37
       +
                   };

     

       38
       38
       +
                 };

     

       39
       39
       +
             };

     

       16
       40
        
           };

     

       17
       41
        
       

     

       18
       18
       -
         testScript = ''

     

       19
       19
       -
           machine.wait_for_unit("lldap.service")

     

       20
       20
       -
           machine.wait_for_open_port(3890)

     

       21
       21
       -
           machine.wait_for_open_port(17170)

     

       42
       42
       +
         testScript =

     

       43
       43
       +
           { nodes, ... }:

     

       44
       44
       +
           let

     

       45
       45
       +
             specializations = "${nodes.machine.system.build.toplevel}/specialisation";

     

       46
       46
       +
           in

     

       47
       47
       +
           ''

     

       48
       48
       +
             machine.wait_for_unit("lldap.service")

     

       49
       49
       +
             machine.wait_for_open_port(3890)

     

       50
       50
       +
             machine.wait_for_open_port(17170)

     

       51
       51
       +
       

     

       52
       52
       +
             machine.succeed("curl --location --fail http://localhost:17170/")

     

       22
       53
        
       

     

       23
       23
       -
           machine.succeed("curl --location --fail http://localhost:17170/")

     

       54
       54
       +
             adminPassword="${adminPassword}"

     

       24
       55
        
       

     

       25
       25
       -
           print(

     

       26
       26
       -
             machine.succeed('ldapsearch -H ldap://localhost:3890 -D uid=admin,ou=people,dc=example,dc=com -b "ou=people,dc=example,dc=com" -w password')

     

       27
       27
       -
           )

     

       28
       28
       -
         '';

     

       56
       56
       +
             def try_login(user, password, expect_success=True):

     

       57
       57
       +
                 cmd = f'ldapsearch -H ldap://localhost:3890 -D uid={user},ou=people,dc=example,dc=com -b "ou=people,dc=example,dc=com" -w {password}'

     

       58
       58
       +
                 code, response = machine.execute(cmd)

     

       59
       59
       +
                 print(cmd)

     

       60
       60
       +
                 print(response)

     

       61
       61
       +
                 if expect_success:

     

       62
       62
       +
                     if code != 0:

     

       63
       63
       +
                         raise Exception(f"Expected success, had failure {code}")

     

       64
       64
       +
                 else:

     

       65
       65
       +
                     if code == 0:

     

       66
       66
       +
                         raise Exception("Expected failure, had success")

     

       67
       67
       +
                 return response

     

       68
       68
       +
       

     

       69
       69
       +
             with subtest("default admin password"):

     

       70
       70
       +
                 try_login("admin", "password",    expect_success=True)

     

       71
       71
       +
                 try_login("admin", adminPassword, expect_success=False)

     

       72
       72
       +
       

     

       73
       73
       +
             with subtest("different admin password"):

     

       74
       74
       +
                 machine.succeed('${specializations}/differentAdminPassword/bin/switch-to-configuration test')

     

       75
       75
       +
                 try_login("admin", "password",    expect_success=False)

     

       76
       76
       +
                 try_login("admin", adminPassword, expect_success=True)

     

       77
       77
       +
       

     

       78
       78
       +
             with subtest("change admin password has no effect"):

     

       79
       79
       +
                 machine.succeed('${specializations}/differentAdminPassword/bin/switch-to-configuration test')

     

       80
       80
       +
                 try_login("admin", "password",    expect_success=False)

     

       81
       81
       +
                 try_login("admin", adminPassword, expect_success=True)

     

       82
       82
       +
           '';

     

       29
       83
        
       }