Repository navigation
Expand file tree
/
Copy pathpam.nix
More file actions
2810 lines (2573 loc) · 98.6 KB
/
Copy pathpam.nix
File metadata and controls
2810 lines (2573 loc) · 98.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This module provides configuration for the PAM (Pluggable
# Authentication Modules) system.
{
config,
lib,
utils,
pkgs,
...
}:
let
inherit (lib)
attrNames
catAttrs
concatLines
concatMap
filter
unique
flip
elem
attrValues
concatMapStrings
hasPrefix
concatStringsSep
sort
;
moduleSettingsType =
with lib.types;
attrsOf (
nullOr (oneOf [
bool
str
int
pathInStore
])
);
moduleSettingsDescription = ''
Boolean values render just the key if true, and nothing if false.
Null values are ignored.
All other values are rendered as key-value pairs.
'';
mkRulesTypeOption =
type:
lib.mkOption {
# These options are experimental and subject to breaking changes without notice.
description = ''
PAM `${type}` rules for this service.
Attribute keys are the name of each rule.
'';
type = lib.types.attrsOf (
lib.types.submodule (
{ name, config, ... }:
{
options = {
name = lib.mkOption {
type = lib.types.str;
description = ''
Name of this rule.
'';
internal = true;
readOnly = true;
};
enable = lib.mkOption {
type = lib.types.bool;
default = true;
description = ''
Whether this rule is added to the PAM service config file.
'';
};
order = lib.mkOption {
type = lib.types.int;
description = ''
Order of this rule in the service file. Rules are arranged in ascending order of this value.
::: {.warning}
The `order` values for the built-in rules are subject to change. If you assign a constant value to this option, a system update could silently reorder your rule. You could be locked out of your system, or your system could be left wide open. When using this option, set it to a relative offset from another rule's `order` value:
```nix
{
security.pam.services.login.rules.auth.foo.order =
config.security.pam.services.login.rules.auth.unix.order + 10;
}
```
:::
'';
};
control = lib.mkOption {
type = lib.types.str;
description = ''
Indicates the behavior of the PAM-API should the module fail to succeed in its authentication task. See `control` in {manpage}`pam.conf(5)` for details.
'';
};
modulePath = lib.mkOption {
type = lib.types.str;
description = ''
Either the full filename of the PAM to be used by the application (it begins with a '/'), or a relative pathname from the default module location. See `module-path` in {manpage}`pam.conf(5)` for details.
'';
};
args = lib.mkOption {
type = lib.types.listOf lib.types.str;
description = ''
Tokens that can be used to modify the specific behavior of the given PAM. Such arguments will be documented for each individual module. See `module-arguments` in {manpage}`pam.conf(5)` for details.
Escaping rules for spaces and square brackets are automatically applied.
{option}`settings` are automatically added as {option}`args`. It's recommended to use the {option}`settings` option whenever possible so that arguments can be overridden.
'';
};
settings = lib.mkOption {
type = moduleSettingsType;
default = { };
description = ''
Settings to add as `module-arguments`.
${moduleSettingsDescription}
'';
};
};
config = {
inherit name;
# Formats an attrset of settings as args for use as `module-arguments`.
args = lib.concatLists (
lib.flip lib.mapAttrsToList config.settings (
name: value:
if lib.isBool value then
lib.optional value name
else
lib.optional (value != null) "${name}=${toString value}"
)
);
};
}
)
);
};
package = config.security.pam.package;
parentConfig = config;
pamOpts =
{ config, name, ... }:
let
cfg = config;
in
let
config = parentConfig;
in
{
imports = [
(lib.mkRenamedOptionModule [ "enableKwallet" ] [ "kwallet" "enable" ])
(lib.mkRenamedOptionModule [ "u2fAuth" ] [ "u2f" "enable" ])
(lib.mkRenamedOptionModule [ "updateWtmp" ] [ "lastlog" "enable" ])
];
options = {
name = lib.mkOption {
example = "sshd";
type = lib.types.str;
description = "Name of the PAM service.";
};
enable = lib.mkEnableOption "this PAM service" // {
default = true;
example = false;
};
rules = lib.mkOption {
# This option is experimental and subject to breaking changes without notice.
visible = false;
description = ''
PAM rules for this service.
::: {.warning}
This option and its suboptions are experimental and subject to breaking changes without notice.
If you use this option in your system configuration, you will need to manually monitor this module for any changes. Otherwise, failure to adjust your configuration properly could lead to you being locked out of your system, or worse, your system could be left wide open to attackers.
If you share configuration examples that use this option, you MUST include this warning so that users are informed.
You may freely use this option within `nixpkgs`, and future changes will account for those use sites.
:::
'';
type = lib.types.submodule {
options = lib.genAttrs [ "account" "auth" "password" "session" ] mkRulesTypeOption;
};
};
useDefaultRules = lib.mkOption {
# This option is experimental and subject to breaking changes without notice.
visible = false;
default = true;
type = lib.types.bool;
description = ''
Whether to set up the default NixOS rule stack for this service.
Set this to `false` if you want to define the entire rule stack for this service.
::: {.warning}
This option is experimental and subject to breaking changes without notice.
If you use this option in your system configuration, you will need to manually monitor this module for any changes. Otherwise, failure to adjust your configuration properly could lead to you being locked out of your system, or worse, your system could be left wide open to attackers.
If you share configuration examples that use this option, you MUST include this warning so that users are informed.
You may freely use this option within `nixpkgs`, and future changes will account for those use sites.
:::
'';
};
unixAuth = lib.mkOption {
default = true;
type = lib.types.bool;
description = ''
Whether users can log in with passwords defined in
{file}`/etc/shadow`.
'';
};
rootOK = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, root doesn't need to authenticate (e.g. for the
{command}`useradd` service).
'';
};
p11Auth = lib.mkOption {
default = config.security.pam.p11.enable;
defaultText = lib.literalExpression "config.security.pam.p11.enable";
type = lib.types.bool;
description = ''
If set, keys listed in
{file}`~/.ssh/authorized_keys` and
{file}`~/.eid/authorized_certificates`
can be used to log in with the associated PKCS#11 tokens.
'';
};
u2f = {
enable = lib.mkOption {
default = config.security.pam.u2f.enable;
defaultText = lib.literalExpression "config.security.pam.u2f.enable";
type = lib.types.bool;
description = ''
If set, users listed in
{file}`$XDG_CONFIG_HOME/Yubico/u2f_keys` (or
{file}`$HOME/.config/Yubico/u2f_keys` if XDG variable is
not set) are able to log in with the associated U2F key. Path can be
changed using {option}`security.pam.u2f.authFile` option.
'';
};
control = lib.mkOption {
default = config.security.pam.u2f.control;
defaultText = lib.literalExpression "config.security.pam.u2f.control";
type = lib.types.enum [
"required"
"requisite"
"sufficient"
"optional"
];
description = ''
This option sets pam "control".
If you want to have multi factor authentication, use "required".
If you want to use U2F device instead of regular password, use "sufficient".
Read
{manpage}`pam.conf(5)`
for better understanding of this option.
'';
};
};
usshAuth = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, users with an SSH certificate containing an authorized principal
in their SSH agent are able to log in. Specific options are controlled
using the {option}`security.pam.ussh` options.
Note that the {option}`security.pam.ussh.enable` must also be
set for this option to take effect.
'';
};
yubicoAuth = lib.mkOption {
default = config.security.pam.yubico.enable;
defaultText = lib.literalExpression "config.security.pam.yubico.enable";
type = lib.types.bool;
description = ''
If set, users listed in
{file}`~/.yubico/authorized_yubikeys`
are able to log in with the associated Yubikey tokens.
'';
};
googleAuthenticator = {
enable = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, users with enabled Google Authenticator (created
{file}`~/.google_authenticator`) will be required
to provide Google Authenticator token to log in.
'';
};
allowNullOTP = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Whether to allow login for accounts that have no OTP set
(i.e., accounts with no OTP configured or no existing
{file}`~/.google_authenticator`).
'';
};
forwardPass = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
The authentication provides a single field requiring
the user's password followed by the one-time password (OTP).
'';
};
};
otpwAuth = lib.mkOption {
default = config.security.pam.enableOTPW;
defaultText = lib.literalExpression "config.security.pam.enableOTPW";
type = lib.types.bool;
description = ''
If set, the OTPW system will be used (if
{file}`~/.otpw` exists).
'';
};
googleOsLoginAccountVerification = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, will use the Google OS Login PAM modules
(`pam_oslogin_login`,
`pam_oslogin_admin`) to verify possible OS Login
users and set sudoers configuration accordingly.
This only makes sense to enable for the `sshd` PAM
service.
'';
};
googleOsLoginAuthentication = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, will use the `pam_oslogin_login`'s user
authentication methods to authenticate users using 2FA.
This only makes sense to enable for the `sshd` PAM
service.
'';
};
mysqlAuth = lib.mkOption {
default = config.users.mysql.enable;
defaultText = lib.literalExpression "config.users.mysql.enable";
type = lib.types.bool;
description = ''
If set, the `pam_mysql` module will be used to
authenticate users against a MySQL/MariaDB database.
'';
};
fprintAuth = lib.mkOption {
default = config.services.fprintd.enablePam;
defaultText = lib.literalExpression "config.services.fprintd.enablePam";
type = lib.types.bool;
description = ''
If set, fingerprint reader will be used (if exists and
your fingerprints are enrolled).
::: {.note}
This setting should only be enabled for clients that can ensure
user attention, such as lockscreens.
See https://github.com/NixOS/nixpkgs/issues/442117
:::
'';
};
howdy = {
enable = lib.mkOption {
default = config.security.pam.howdy.enable;
defaultText = lib.literalExpression "config.security.pam.howdy.enable";
type = lib.types.bool;
description = ''
Whether to enable the Howdy PAM module.
If set, users can be authenticated using Howdy, the Windows
Hello™-style facial authentication service.
'';
};
control = lib.mkOption {
default = config.security.pam.howdy.control;
defaultText = lib.literalExpression "config.security.pam.howdy.control";
type = lib.types.str;
description = ''
This option sets the PAM "control" used for this module.
'';
};
};
oathAuth = lib.mkOption {
default = config.security.pam.oath.enable;
defaultText = lib.literalExpression "config.security.pam.oath.enable";
type = lib.types.bool;
description = ''
If set, the OATH Toolkit will be used.
'';
};
sshAgentAuth = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, the calling user's SSH agent is used to authenticate
against the keys in the calling user's
{file}`~/.ssh/authorized_keys`. This is useful
for {command}`sudo` on password-less remote systems.
'';
};
rssh = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, the calling user's SSH agent is used to authenticate
against the configured keys. This module works in a manner
similar to pam_ssh_agent_auth, but supports a wider range
of SSH key types, including those protected by security
keys (FIDO2).
'';
};
duoSecurity = {
enable = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, use the Duo Security pam module
`pam_duo` for authentication. Requires
configuration of {option}`security.duosec` options.
'';
};
};
startSession = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, the service will register a new session with
systemd's login manager. For local sessions, this will give
the user access to audio devices, CD-ROM drives. In the
default PolicyKit configuration, it also allows the user to
reboot the system.
'';
};
setEnvironment = lib.mkOption {
type = lib.types.bool;
default = true;
description = ''
Whether the service should set the environment variables
listed in {option}`environment.sessionVariables`
using `pam_env.so`.
'';
};
setLoginUid = lib.mkOption {
type = lib.types.bool;
description = ''
Set the login uid of the process
({file}`/proc/self/loginuid`) for auditing
purposes. The login uid is only set by ‘entry points’ like
{command}`login` and {command}`sshd`, not by
commands like {command}`sudo`.
'';
};
ttyAudit = {
enable = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Enable or disable TTY auditing for specified users
'';
};
enablePattern = lib.mkOption {
type = lib.types.nullOr lib.types.str;
default = null;
description = ''
For each user matching one of comma-separated
glob patterns, enable TTY auditing
'';
};
disablePattern = lib.mkOption {
type = lib.types.nullOr lib.types.str;
default = null;
description = ''
For each user matching one of comma-separated
glob patterns, disable TTY auditing
'';
};
openOnly = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Set the TTY audit flag when opening the session,
but do not restore it when closing the session.
Using this option is necessary for some services
that don't fork() to run the authenticated session,
such as sudo.
'';
};
};
forwardXAuth = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
Whether X authentication keys should be passed from the
calling user to the target user (e.g. for
{command}`su`)
'';
};
pamMount = lib.mkOption {
default = config.security.pam.mount.enable;
defaultText = lib.literalExpression "config.security.pam.mount.enable";
type = lib.types.bool;
description = ''
Enable PAM mount (pam_mount) system to mount filesystems on user login.
'';
};
allowNullPassword = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
Whether to allow logging into accounts that have no password
set (i.e., have an empty password field in
{file}`/etc/passwd` or
{file}`/etc/group`). This does not enable
logging into disabled accounts (i.e., that have the password
field set to `!`). Note that regardless of
what the pam_unix documentation says, accounts with hashed
empty passwords are always allowed to log in.
'';
};
nodelay = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
Whether the delay after typing a wrong password should be disabled.
'';
};
requireWheel = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
Whether to permit root access only to members of group wheel.
'';
};
limits = lib.mkOption {
default = [ ];
type = limitsType;
description = ''
Attribute set describing resource limits. Defaults to the
value of {option}`security.pam.loginLimits`.
The meaning of the values is explained in {manpage}`limits.conf(5)`.
'';
};
showMotd = lib.mkOption {
default = false;
type = lib.types.bool;
description = "Whether to show the message of the day.";
};
makeHomeDir = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
Whether to try to create home directories for users
with `$HOME`s pointing to nonexistent
locations on session login.
'';
};
lastlog = {
enable = lib.mkOption {
default = false;
type = lib.types.bool;
description = "Whether to update {file}`/var/log/wtmp`.";
};
silent = lib.mkOption {
default = true;
example = false;
type = lib.types.bool;
description = ''
Whether to suppress the message showing the last login date.
'';
};
};
logFailures = lib.mkOption {
default = false;
type = lib.types.bool;
description = "Whether to log authentication failures in {file}`/var/log/faillog`.";
};
enableAppArmor = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
Enable support for attaching AppArmor profiles at the
user/group level, e.g., as part of a role based access
control scheme.
'';
};
kwallet = {
enable = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If enabled, pam_wallet will attempt to automatically unlock the
user's default KDE wallet upon login. If the user has no wallet named
"kdewallet", or the login password does not match their wallet
password, KDE will prompt separately after login.
'';
};
package = lib.mkPackageOption pkgs.kdePackages "kwallet-pam" {
pkgsText = "pkgs.kdePackages";
};
forceRun = lib.mkEnableOption null // {
description = ''
The `force_run` option is used to tell the PAM module for KWallet
to forcefully run even if no graphical session (such as a GUI
display manager) is detected. This is useful for when you are
starting an X Session or a Wayland Session from a TTY. If you
intend to log-in from a TTY, it is recommended that you enable
this option **and** ensure that `plasma-kwallet-pam.service` is
started by `graphical-session.target`.
'';
};
};
sssdStrictAccess = lib.mkOption {
default = false;
type = lib.types.bool;
description = "enforce sssd access control";
};
enableGnomeKeyring = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If enabled, pam_gnome_keyring will attempt to automatically unlock the
user's default Gnome keyring upon login. If the user login password does
not match their keyring password, Gnome Keyring will prompt separately
after login.
'';
};
oo7 = {
enable = lib.mkEnableOption ''
automatically unlock the user's default Session Keyring using pam_oo7.
If the user's login password does not match their keyring password,
oo7 will prompt separately after login.
'';
};
rosec = {
enable = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If enabled, pam_rosec will attempt to automatically unlock the
user's rosec vault upon login. If the user login password does not
match their vault password, rosec will prompt separately after login.
'';
};
};
enableUMask = lib.mkOption {
default = config.security.pam.enableUMask;
defaultText = lib.literalExpression "config.security.pam.enableUMask";
type = lib.types.bool;
description = "If enabled, the pam_umask module will be loaded.";
};
failDelay = {
enable = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
If enabled, this will replace the `FAIL_DELAY` setting from `login.defs`.
Change the delay on failure per-application.
'';
};
delay = lib.mkOption {
default = 3000000;
type = lib.types.int;
example = 1000000;
description = "The delay time (in microseconds) on failure.";
};
};
gnupg = {
enable = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
If enabled, pam_gnupg will attempt to automatically unlock the
user's GPG keys with the login password via
{command}`gpg-agent`. The keygrips of all keys to be
unlocked should be written to {file}`~/.pam-gnupg`,
and can be queried with {command}`gpg -K --with-keygrip`.
Presetting passphrases must be enabled by adding
`allow-preset-passphrase` in
{file}`~/.gnupg/gpg-agent.conf`.
'';
};
noAutostart = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Don't start {command}`gpg-agent` if it is not running.
Useful in conjunction with starting {command}`gpg-agent` as
a systemd user service.
'';
};
storeOnly = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Don't send the password immediately after login, but store for PAM
`session`.
'';
};
};
slurm = {
enable = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, ONLY prevents users from logging into nodes if they have no
jobs in the node. This module is a legacy implementation with
functionality limited to login restrictions.
'';
};
adopt = {
enable = lib.mkOption {
default = false;
type = lib.types.bool;
description = ''
If set, it prevents users from logging into nodes if they have no jobs
in the node. It also tracks any other spawned processes for accounting
and ensures complete job cleanup when a job is completed for any
successful connection. Spawned processes get "adopted" as external
steps into the current job. As such, those steps get integrated with
Slurm accounting and control group facilities.
'';
};
settings = lib.mkOption {
type = lib.types.submodule {
freeformType = moduleSettingsType;
options = {
action_no_jobs = lib.mkOption {
type = lib.types.enum [
"ignore"
"deny"
];
default = "deny";
description = ''
What to do if no jobs from the user are found, deny or ignore
(pass along to next PAM module).
'';
};
action_unknown = lib.mkOption {
type = lib.types.enum [
"newest"
"allow"
"deny"
];
default = "newest";
description = ''
If the user has jobs, attach them to the newest job. Allow
the connection through without adoption.
'';
};
action_adopt_failure = lib.mkOption {
type = lib.types.enum [
"allow"
"deny"
];
default = "deny";
description = ''
What to do if the process is unable to be adopted into a job.
`allow` matches the upstream default which is only really
suitable for testing; production systems will want `deny`
as a default.
'';
};
action_generic_failure = lib.mkOption {
type = lib.types.enum [
"ignore"
"allow"
"deny"
];
default = "ignore";
description = ''
Catch all for failures related to kernel issues or slurmd
access. Ignore falls through to the next PAM module, allowing
the connection to go through without adoption.
'';
};
disable_x11 = lib.mkOption {
type = lib.types.enum [
"0"
"1"
];
default = "0";
description = ''
Disable or enable x11 sessions. '0' means the adopted connection
has Slurm X11 forwarding with DISPLAY overwritten using X11
tunnel endpoint details.
'';
};
nodename = lib.mkOption {
type = with lib.types; nullOr nonEmptyStr;
default = null;
example = "compute-a-01";
description = ''
Set this only when the Slurm `NodeName` for this machine
differs from `hostname -s`. If unset, `pam_slurm_adopt`
uses the host short name.
'';
};
join_container = lib.mkOption {
type = lib.types.enum [
"true"
"false"
];
default = "true";
description = ''
Attach to a container created by job_container/tmpfs
'';
};
};
};
default = {
service = name;
};
description = ''
Slurm Adopt Settings. More information is available at:
- https://slurm.schedmd.com/pam_slurm_adopt.html
'';
};
};
};
zfs = lib.mkOption {
default = config.security.pam.zfs.enable;
defaultText = lib.literalExpression "config.security.pam.zfs.enable";
type = lib.types.bool;
description = ''
Enable unlocking and mounting of encrypted ZFS home dataset at login.
'';
};
text = lib.mkOption {
type = lib.types.nullOr lib.types.lines;
description = "Contents of the PAM service file.";
};
};
# The resulting /etc/pam.d/* file contents are verified in
# nixos/tests/pam/pam-file-contents.nix. Please update tests there when
# changing the derivation.
config = {
name = lib.mkDefault name;
setLoginUid = lib.mkDefault cfg.startSession;
limits = lib.mkDefault config.security.pam.loginLimits;
text =
let
hasSpaceInfix = lib.hasInfix " ";
escapeEndingBrackets = lib.replaceStrings [ "]" ] [ "\\]" ];
# Formats a string for use in `module-arguments`. See `man pam.conf`.
formatModuleArgument =
token: if hasSpaceInfix token then "[${escapeEndingBrackets token}]" else token;
formatRules =
type:
concatStringsSep "\n" (
map
(
rule:
"${type} ${rule.control} ${rule.modulePath}${
if rule.args == [ ] then "" else " " + concatStringsSep " " (map formatModuleArgument rule.args)
} # ${rule.name} (order ${toString rule.order})"
)
(
sort (
a: b:
if a.order != b.order then
a.order < b.order
else
throw "security.pam.services.${name}.rules.${type}: rules '${a.name}' and '${b.name}' cannot have the same order value (${toString a.order})"
) (filter (rule: rule.enable) (attrValues cfg.rules.${type}))
)
);
in
lib.mkDefault ''
# Account management.
${formatRules "account"}
# Authentication management.
${formatRules "auth"}
# Password management.
${formatRules "password"}
# Session management.
${formatRules "session"}
'';
# !!! TODO: move the LDAP stuff to the LDAP module, and the
# Samba stuff to the Samba module. This requires that the PAM
# module provides the right hooks.
rules = (
lib.optionalAttrs cfg.useDefaultRules {
account = utils.pam.autoOrderRules [
{
name = "ldap";
enable = use_ldap;
control = "sufficient";
modulePath = "${pam_ldap}/lib/security/pam_ldap.so";
}
{
name = "mysql";
enable = cfg.mysqlAuth;
control = "sufficient";
modulePath = "${pkgs.pam_mysql}/lib/security/pam_mysql.so";
settings = {
config_file = "/etc/security/pam_mysql.conf";
};
}
{
name = "kanidm";
enable = config.services.kanidm.unix.enable;
control = "sufficient";
modulePath = "${config.services.kanidm.package}/lib/pam_kanidm.so";
settings = {
ignore_unknown_user = true;
};
}
{
name = "sss";
enable = config.services.sssd.enable;
control =
if cfg.sssdStrictAccess then "[default=bad success=ok user_unknown=ignore]" else "sufficient";