commit 7362e078cb048075629147af6c535dbc50f4451f · pyrox.dev/nixpkgs

+198 -90
nixos/modules/programs/shadow.nix
···

       1
       1
        
       # Configuration for the pwdutils suite of tools: passwd, useradd, etc.

     

       2
       2
       -
       

     

       3
       2
        
       { config, lib, utils, pkgs, ... }:

     

       4
       4
       -
       

     

       5
       3
        
       with lib;

     

       6
       6
       -
       

     

       7
       4
        
       let

     

       5
       5
       +
         cfg = config.security.loginDefs;

     

       6
       6
       +
       in

     

       7
       7
       +
       {

     

       8
       8
       +
         options = with types; {

     

       9
       9
       +
           security.loginDefs = {

     

       10
       10
       +
             package = mkPackageOptionMD pkgs "shadow" { };

     

       8
       11
        
       

     

       9
       9
       -
         /*

     

       10
       10
       -
         There are three different sources for user/group id ranges, each of which gets

     

       11
       11
       -
         used by different programs:

     

       12
       12
       -
         - The login.defs file, used by the useradd, groupadd and newusers commands

     

       13
       13
       -
         - The update-users-groups.pl file, used by NixOS in the activation phase to

     

       14
       14
       -
           decide on which ids to use for declaratively defined users without a static

     

       15
       15
       -
           id

     

       16
       16
       -
         - Systemd compile time options -Dsystem-uid-max= and -Dsystem-gid-max=, used

     

       17
       17
       -
           by systemd for features like ConditionUser=@system and systemd-sysusers

     

       18
       18
       -
         */

     

       19
       19
       -
         loginDefs =

     

       20
       20
       -
           ''

     

       21
       21
       -
             DEFAULT_HOME yes

     

       12
       12
       +
             chfnRestrict = mkOption {

     

       13
       13
       +
               description = mdDoc ''

     

       14
       14
       +
                 Use chfn SUID to allow non-root users to change their account GECOS information.

     

       15
       15
       +
               '';

     

       16
       16
       +
               type = nullOr str;

     

       17
       17
       +
               default = null;

     

       18
       18
       +
             };

     

       22
       19
        
       

     

       23
       23
       -
             SYS_UID_MIN  400

     

       24
       24
       -
             SYS_UID_MAX  999

     

       25
       25
       -
             UID_MIN      1000

     

       26
       26
       -
             UID_MAX      29999

     

       20
       20
       +
             settings = mkOption {

     

       21
       21
       +
               description = mdDoc ''

     

       22
       22
       +
                 Config options for the /etc/login.defs file, that defines

     

       23
       23
       +
                 the site-specific configuration for the shadow password suite.

     

       24
       24
       +
                 See login.defs(5) man page for available options.

     

       25
       25
       +
               '';

     

       26
       26
       +
               type = submodule {

     

       27
       27
       +
                 freeformType = (pkgs.formats.keyValue { }).type;

     

       28
       28
       +
                 /* There are three different sources for user/group id ranges, each of which gets

     

       29
       29
       +
                    used by different programs:

     

       30
       30
       +
                    - The login.defs file, used by the useradd, groupadd and newusers commands

     

       31
       31
       +
                    - The update-users-groups.pl file, used by NixOS in the activation phase to

     

       32
       32
       +
                      decide on which ids to use for declaratively defined users without a static

     

       33
       33
       +
                      id

     

       34
       34
       +
                    - Systemd compile time options -Dsystem-uid-max= and -Dsystem-gid-max=, used

     

       35
       35
       +
                      by systemd for features like ConditionUser=@system and systemd-sysusers

     

       36
       36
       +
                     */

     

       37
       37
       +
                 options = {

     

       38
       38
       +
                   DEFAULT_HOME = mkOption {

     

       39
       39
       +
                     description = mdDoc "Indicate if login is allowed if we can't cd to the home directory.";

     

       40
       40
       +
                     default = "yes";

     

       41
       41
       +
                     type = enum [ "yes" "no" ];

     

       42
       42
       +
                   };

     

       27
       43
        
       

     

       28
       28
       -
             SYS_GID_MIN  400

     

       29
       29
       -
             SYS_GID_MAX  999

     

       30
       30
       -
             GID_MIN      1000

     

       31
       31
       -
             GID_MAX      29999

     

       44
       44
       +
                   ENCRYPT_METHOD = mkOption {

     

       45
       45
       +
                     description = mdDoc "This defines the system default encryption algorithm for encrypting passwords.";

     

       46
       46
       +
                     # The default crypt() method, keep in sync with the PAM default

     

       47
       47
       +
                     default = "YESCRYPT";

     

       48
       48
       +
                     type = enum [ "YESCRYPT" "SHA512" "SHA256" "MD5" "DES"];

     

       49
       49
       +
                   };

     

       32
       50
        
       

     

       33
       33
       -
             TTYGROUP     tty

     

       34
       34
       -
             TTYPERM      0620

     

       51
       51
       +
                   SYS_UID_MIN = mkOption {

     

       52
       52
       +
                     description = mdDoc "Range of user IDs used for the creation of system users by useradd or newusers.";

     

       53
       53
       +
                     default = 400;

     

       54
       54
       +
                     type = int;

     

       55
       55
       +
                   };

     

       35
       56
        
       

     

       36
       36
       -
             # Ensure privacy for newly created home directories.

     

       37
       37
       -
             UMASK        077

     

       57
       57
       +
                   SYS_UID_MAX = mkOption {

     

       58
       58
       +
                     description = mdDoc "Range of user IDs used for the creation of system users by useradd or newusers.";

     

       59
       59
       +
                     default = 999;

     

       60
       60
       +
                     type = int;

     

       61
       61
       +
                   };

     

       38
       62
        
       

     

       39
       39
       -
             # Uncomment this and install chfn SUID to allow non-root

     

       40
       40
       -
             # users to change their account GECOS information.

     

       41
       41
       -
             # This should be made configurable.

     

       42
       42
       -
             #CHFN_RESTRICT frwh

     

       63
       63
       +
                   UID_MIN = mkOption {

     

       64
       64
       +
                     description = mdDoc "Range of user IDs used for the creation of regular users by useradd or newusers.";

     

       65
       65
       +
                     default = 1000;

     

       66
       66
       +
                     type = int;

     

       67
       67
       +
                   };

     

       43
       68
        
       

     

       44
       44
       -
             # The default crypt() method, keep in sync with the PAM default

     

       45
       45
       -
             ENCRYPT_METHOD YESCRYPT

     

       46
       46
       -
           '';

     

       69
       69
       +
                   UID_MAX = mkOption {

     

       70
       70
       +
                     description = mdDoc "Range of user IDs used for the creation of regular users by useradd or newusers.";

     

       71
       71
       +
                     default = 29999;

     

       72
       72
       +
                     type = int;

     

       73
       73
       +
                   };

     

       47
       74
        
       

     

       48
       48
       -
         mkSetuidRoot = source:

     

       49
       49
       -
           { setuid = true;

     

       50
       50
       -
             owner = "root";

     

       51
       51
       -
             group = "root";

     

       52
       52
       -
             inherit source;

     

       53
       53
       -
           };

     

       75
       75
       +
                   SYS_GID_MIN = mkOption {

     

       76
       76
       +
                     description = mdDoc "Range of group IDs used for the creation of system groups by useradd, groupadd, or newusers";

     

       77
       77
       +
                     default = 400;

     

       78
       78
       +
                     type = int;

     

       79
       79
       +
                   };

     

       54
       80
        
       

     

       55
       55
       -
       in

     

       81
       81
       +
                   SYS_GID_MAX = mkOption {

     

       82
       82
       +
                     description = mdDoc "Range of group IDs used for the creation of system groups by useradd, groupadd, or newusers";

     

       83
       83
       +
                     default = 999;

     

       84
       84
       +
                     type = int;

     

       85
       85
       +
                   };

     

       56
       86
        
       

     

       57
       57
       -
       {

     

       87
       87
       +
                   GID_MIN = mkOption {

     

       88
       88
       +
                     description = mdDoc "Range of group IDs used for the creation of regular groups by useradd, groupadd, or newusers.";

     

       89
       89
       +
                     default = 1000;

     

       90
       90
       +
                     type = int;

     

       91
       91
       +
                   };

     

       58
       92
        
       

     

       59
       59
       -
         ###### interface

     

       93
       93
       +
                   GID_MAX = mkOption {

     

       94
       94
       +
                     description = mdDoc "Range of group IDs used for the creation of regular groups by useradd, groupadd, or newusers.";

     

       95
       95
       +
                     default = 29999;

     

       96
       96
       +
                     type = int;

     

       97
       97
       +
                   };

     

       60
       98
        
       

     

       61
       61
       -
         options = {

     

       99
       99
       +
                   TTYGROUP = mkOption {

     

       100
       100
       +
                     description = mdDoc ''

     

       101
       101
       +
                       The terminal permissions: the login tty will be owned by the TTYGROUP group,

     

       102
       102
       +
                       and the permissions will be set to TTYPERM'';

     

       103
       103
       +
                     default = "tty";

     

       104
       104
       +
                     type = str;

     

       105
       105
       +
                   };

     

       62
       106
        
       

     

       63
       63
       -
           users.defaultUserShell = lib.mkOption {

     

       64
       64
       -
             description = lib.mdDoc ''

     

       107
       107
       +
                   TTYPERM = mkOption {

     

       108
       108
       +
                     description = mdDoc ''

     

       109
       109
       +
                       The terminal permissions: the login tty will be owned by the TTYGROUP group,

     

       110
       110
       +
                       and the permissions will be set to TTYPERM'';

     

       111
       111
       +
                     default = "0620";

     

       112
       112
       +
                     type = str;

     

       113
       113
       +
                   };

     

       114
       114
       +
       

     

       115
       115
       +
                   # Ensure privacy for newly created home directories.

     

       116
       116
       +
                   UMASK = mkOption {

     

       117
       117
       +
                     description = mdDoc "The file mode creation mask is initialized to this value.";

     

       118
       118
       +
                     default = "077";

     

       119
       119
       +
                     type = str;

     

       120
       120
       +
                   };

     

       121
       121
       +
                 };

     

       122
       122
       +
               };

     

       123
       123
       +
               default = { };

     

       124
       124
       +
             };

     

       125
       125
       +
           };

     

       126
       126
       +
       

     

       127
       127
       +
           users.defaultUserShell = mkOption {

     

       128
       128
       +
             description = mdDoc ''

     

       65
       129
        
               This option defines the default shell assigned to user

     

       66
       130
        
               accounts. This can be either a full system path or a shell package.

     

       67
       131
        
       

     
···

       69
       133
        
               used outside the store (in particular in /etc/passwd).

     

       70
       134
        
             '';

     

       71
       135
        
             example = literalExpression "pkgs.zsh";

     

       72
       72
       -
             type = types.either types.path types.shellPackage;

     

       136
       136
       +
             type = either path shellPackage;

     

       73
       137
        
           };

     

       74
       74
       -
       

     

       75
       138
        
         };

     

       76
       76
       -
       

     

       77
       139
        
       

     

       78
       140
        
         ###### implementation

     

       79
       141
        
       

     

       80
       142
        
         config = {

     

       143
       143
       +
           assertions = [

     

       144
       144
       +
             {

     

       145
       145
       +
               assertion = cfg.settings.SYS_UID_MIN <= cfg.settings.SYS_UID_MAX;

     

       146
       146
       +
               message = "SYS_UID_MIN must be less than or equal to SYS_UID_MAX";

     

       147
       147
       +
             }

     

       148
       148
       +
             {

     

       149
       149
       +
               assertion = cfg.settings.UID_MIN <= cfg.settings.UID_MAX;

     

       150
       150
       +
               message = "UID_MIN must be less than or equal to UID_MAX";

     

       151
       151
       +
             }

     

       152
       152
       +
             {

     

       153
       153
       +
               assertion = cfg.settings.SYS_GID_MIN <= cfg.settings.SYS_GID_MAX;

     

       154
       154
       +
               message = "SYS_GID_MIN must be less than or equal to SYS_GID_MAX";

     

       155
       155
       +
             }

     

       156
       156
       +
             {

     

       157
       157
       +
               assertion = cfg.settings.GID_MIN <= cfg.settings.GID_MAX;

     

       158
       158
       +
               message = "GID_MIN must be less than or equal to GID_MAX";

     

       159
       159
       +
             }

     

       160
       160
       +
           ];

     

       81
       161
        
       

     

       82
       82
       -
           environment.systemPackages =

     

       83
       83
       -
             lib.optional config.users.mutableUsers pkgs.shadow ++

     

       84
       84
       -
             lib.optional (types.shellPackage.check config.users.defaultUserShell)

     

       85
       85
       -
               config.users.defaultUserShell;

     

       162
       162
       +
           security.loginDefs.settings.CHFN_RESTRICT =

     

       163
       163
       +
             mkIf (cfg.chfnRestrict != null) cfg.chfnRestrict;

     

       164
       164
       +
       

     

       165
       165
       +
           environment.systemPackages = optional config.users.mutableUsers cfg.package

     

       166
       166
       +
             ++ optional (types.shellPackage.check config.users.defaultUserShell) config.users.defaultUserShell

     

       167
       167
       +
             ++ optional (cfg.chfnRestrict != null) pkgs.util-linux;

     

       86
       168
        
       

     

       87
       169
        
           environment.etc =

     

       88
       88
       -
             { # /etc/login.defs: global configuration for pwdutils.  You

     

       89
       89
       -
               # cannot login without it!

     

       90
       90
       -
               "login.defs".source = pkgs.writeText "login.defs" loginDefs;

     

       170
       170
       +
             # Create custom toKeyValue generator

     

       171
       171
       +
             # see https://man7.org/linux/man-pages/man5/login.defs.5.html for config specification

     

       172
       172
       +
             let

     

       173
       173
       +
               toKeyValue = generators.toKeyValue {

     

       174
       174
       +
                 mkKeyValue = generators.mkKeyValueDefault { } " ";

     

       175
       175
       +
               };

     

       176
       176
       +
             in

     

       177
       177
       +
             {

     

       178
       178
       +
               # /etc/login.defs: global configuration for pwdutils.

     

       179
       179
       +
               # You cannot login without it!

     

       180
       180
       +
               "login.defs".source = pkgs.writeText "login.defs" (toKeyValue cfg.settings);

     

       91
       181
        
       

     

       92
       182
        
               # /etc/default/useradd: configuration for useradd.

     

       93
       93
       -
               "default/useradd".source = pkgs.writeText "useradd"

     

       94
       94
       -
                 ''

     

       95
       95
       -
                   GROUP=100

     

       96
       96
       -
                   HOME=/home

     

       97
       97
       -
                   SHELL=${utils.toShellPath config.users.defaultUserShell}

     

       98
       98
       -
                 '';

     

       183
       183
       +
               "default/useradd".source = pkgs.writeText "useradd" ''

     

       184
       184
       +
                 GROUP=100

     

       185
       185
       +
                 HOME=/home

     

       186
       186
       +
                 SHELL=${utils.toShellPath config.users.defaultUserShell}

     

       187
       187
       +
               '';

     

       99
       188
        
             };

     

       100
       189
        
       

     

       101
       101
       -
           security.pam.services =

     

       102
       102
       -
             { chsh = { rootOK = true; };

     

       103
       103
       -
               chfn = { rootOK = true; };

     

       104
       104
       -
               su = { rootOK = true; forwardXAuth = true; logFailures = true; };

     

       105
       105
       -
               passwd = {};

     

       106
       106
       -
               # Note: useradd, groupadd etc. aren't setuid root, so it

     

       107
       107
       -
               # doesn't really matter what the PAM config says as long as it

     

       108
       108
       -
               # lets root in.

     

       109
       109
       -
               useradd = { rootOK = true; };

     

       110
       110
       -
               usermod = { rootOK = true; };

     

       111
       111
       -
               userdel = { rootOK = true; };

     

       112
       112
       -
               groupadd = { rootOK = true; };

     

       113
       113
       -
               groupmod = { rootOK = true; };

     

       114
       114
       -
               groupmems = { rootOK = true; };

     

       115
       115
       -
               groupdel = { rootOK = true; };

     

       116
       116
       -
               login = { startSession = true; allowNullPassword = true; showMotd = true; updateWtmp = true; };

     

       117
       117
       -
               chpasswd = { rootOK = true; };

     

       190
       190
       +
           security.pam.services = {

     

       191
       191
       +
             chsh = { rootOK = true; };

     

       192
       192
       +
             chfn = { rootOK = true; };

     

       193
       193
       +
             su = {

     

       194
       194
       +
               rootOK = true;

     

       195
       195
       +
               forwardXAuth = true;

     

       196
       196
       +
               logFailures = true;

     

       118
       197
        
             };

     

       119
       119
       -
       

     

       120
       120
       -
           security.wrappers = {

     

       121
       121
       -
             su        = mkSetuidRoot "${pkgs.shadow.su}/bin/su";

     

       122
       122
       -
             sg        = mkSetuidRoot "${pkgs.shadow.out}/bin/sg";

     

       123
       123
       -
             newgrp    = mkSetuidRoot "${pkgs.shadow.out}/bin/newgrp";

     

       124
       124
       -
             newuidmap = mkSetuidRoot "${pkgs.shadow.out}/bin/newuidmap";

     

       125
       125
       -
             newgidmap = mkSetuidRoot "${pkgs.shadow.out}/bin/newgidmap";

     

       126
       126
       -
           } // lib.optionalAttrs config.users.mutableUsers {

     

       127
       127
       -
             chsh   = mkSetuidRoot "${pkgs.shadow.out}/bin/chsh";

     

       128
       128
       -
             passwd = mkSetuidRoot "${pkgs.shadow.out}/bin/passwd";

     

       198
       198
       +
             passwd = { };

     

       199
       199
       +
             # Note: useradd, groupadd etc. aren't setuid root, so it

     

       200
       200
       +
             # doesn't really matter what the PAM config says as long as it

     

       201
       201
       +
             # lets root in.

     

       202
       202
       +
             useradd.rootOK = true;

     

       203
       203
       +
             usermod.rootOK = true;

     

       204
       204
       +
             userdel.rootOK = true;

     

       205
       205
       +
             groupadd.rootOK = true;

     

       206
       206
       +
             groupmod.rootOK = true;

     

       207
       207
       +
             groupmems.rootOK = true;

     

       208
       208
       +
             groupdel.rootOK = true;

     

       209
       209
       +
             login = {

     

       210
       210
       +
               startSession = true;

     

       211
       211
       +
               allowNullPassword = true;

     

       212
       212
       +
               showMotd = true;

     

       213
       213
       +
               updateWtmp = true;

     

       214
       214
       +
             };

     

       215
       215
       +
             chpasswd = { rootOK = true; };

     

       129
       216
        
           };

     

       217
       217
       +
       

     

       218
       218
       +
           security.wrappers =

     

       219
       219
       +
             let

     

       220
       220
       +
               mkSetuidRoot = source: {

     

       221
       221
       +
                 setuid = true;

     

       222
       222
       +
                 owner = "root";

     

       223
       223
       +
                 group = "root";

     

       224
       224
       +
                 inherit source;

     

       225
       225
       +
               };

     

       226
       226
       +
             in

     

       227
       227
       +
             {

     

       228
       228
       +
               su = mkSetuidRoot "${cfg.package.su}/bin/su";

     

       229
       229
       +
               sg = mkSetuidRoot "${cfg.package.out}/bin/sg";

     

       230
       230
       +
               newgrp = mkSetuidRoot "${cfg.package.out}/bin/newgrp";

     

       231
       231
       +
               newuidmap = mkSetuidRoot "${cfg.package.out}/bin/newuidmap";

     

       232
       232
       +
               newgidmap = mkSetuidRoot "${cfg.package.out}/bin/newgidmap";

     

       233
       233
       +
             }

     

       234
       234
       +
             // optionalAttrs config.users.mutableUsers {

     

       235
       235
       +
               chsh = mkSetuidRoot "${cfg.package.out}/bin/chsh";

     

       236
       236
       +
               passwd = mkSetuidRoot "${cfg.package.out}/bin/passwd";

     

       237
       237
       +
             };

     

       130
       238
        
         };

     

       131
       239
        
       }