Commit 0563e0a3 authored by Majiir Paktu's avatar Majiir Paktu
Browse files

nixos/pam: give each rule a name 

These names are internal identifiers. They will be used as keys so that
users can reconfigure rules by merging a rule config with the same name.
The name is arbitrary. The built-in rules are named after the PAM where
practical.
parent fbd7427b

nixos/modules/security/pam.nix

+91 −85
Original line number Diff line number Diff line
@@ -14,6 +14,12 @@ let 
    '';

    type = types.listOf (types.submodule {

      options = {

        name = mkOption {

          type = types.str;

          description = lib.mdDoc ''

            Name of this rule.

          '';

        };

        enable = mkOption {

          type = types.bool;

          default = true;
@@ -544,79 +550,79 @@ let 
      # module provides the right hooks.

      rules = {

        account = [

          { enable = use_ldap; text = ''

          { name = "ldap"; enable = use_ldap; text = ''

            sufficient ${pam_ldap}/lib/security/pam_ldap.so

          ''; }

          { enable = cfg.mysqlAuth; text = ''

          { name = "mysql"; enable = cfg.mysqlAuth; text = ''

            sufficient ${pkgs.pam_mysql}/lib/security/pam_mysql.so config_file=/etc/security/pam_mysql.conf

          ''; }

          { enable = config.services.kanidm.enablePam; text = ''

          { name = "kanidm"; enable = config.services.kanidm.enablePam; text = ''

            sufficient ${pkgs.kanidm}/lib/pam_kanidm.so ignore_unknown_user

          ''; }

          { enable = config.services.sssd.enable; text = ''

          { name = "sss"; enable = config.services.sssd.enable; text = ''

            ${if cfg.sssdStrictAccess then "[default=bad success=ok user_unknown=ignore]" else "sufficient"} ${pkgs.sssd}/lib/security/pam_sss.so

          ''; }

          { enable = config.security.pam.krb5.enable; text = ''

          { name = "krb5"; enable = config.security.pam.krb5.enable; text = ''

            sufficient ${pam_krb5}/lib/security/pam_krb5.so

          ''; }

          { enable = cfg.googleOsLoginAccountVerification; text = ''

          { name = "oslogin_login"; enable = cfg.googleOsLoginAccountVerification; text = ''

            [success=ok ignore=ignore default=die] ${pkgs.google-guest-oslogin}/lib/security/pam_oslogin_login.so

          ''; }

          { enable = cfg.googleOsLoginAccountVerification; text = ''

          { name = "oslogin_admin"; enable = cfg.googleOsLoginAccountVerification; text = ''

            [success=ok default=ignore] ${pkgs.google-guest-oslogin}/lib/security/pam_oslogin_admin.so

          ''; }

          { enable = config.services.homed.enable; text = ''

          { name = "systemd_home"; enable = config.services.homed.enable; text = ''

            sufficient ${config.systemd.package}/lib/security/pam_systemd_home.so

          ''; }

          # The required pam_unix.so module has to come after all the sufficient modules

          # because otherwise, the account lookup will fail if the user does not exist

          # locally, for example with MySQL- or LDAP-auth.

          { text = ''

          { name = "unix"; text = ''

            required pam_unix.so

          ''; }

        ];



        auth = [

          { enable = cfg.googleOsLoginAuthentication; text = ''

          { name = "oslogin_login"; enable = cfg.googleOsLoginAuthentication; text = ''

            [success=done perm_denied=die default=ignore] ${pkgs.google-guest-oslogin}/lib/security/pam_oslogin_login.so

          ''; }

          { enable = cfg.rootOK; text = ''

          { name = "rootok"; enable = cfg.rootOK; text = ''

            sufficient pam_rootok.so

          ''; }

          { enable = cfg.requireWheel; text = ''

          { name = "wheel"; enable = cfg.requireWheel; text = ''

            required pam_wheel.so use_uid

          ''; }

          { enable = cfg.logFailures; text = ''

          { name = "faillock"; enable = cfg.logFailures; text = ''

            required pam_faillock.so

          ''; }

          { enable = cfg.mysqlAuth; text = ''

          { name = "mysql"; enable = cfg.mysqlAuth; text = ''

            sufficient ${pkgs.pam_mysql}/lib/security/pam_mysql.so config_file=/etc/security/pam_mysql.conf

          ''; }

          { enable = config.security.pam.enableSSHAgentAuth && cfg.sshAgentAuth; text = ''

          { name = "ssh_agent_auth"; enable = config.security.pam.enableSSHAgentAuth && cfg.sshAgentAuth; text = ''

            sufficient ${pkgs.pam_ssh_agent_auth}/libexec/pam_ssh_agent_auth.so file=${lib.concatStringsSep ":" config.services.openssh.authorizedKeysFiles}

          ''; }

          (let p11 = config.security.pam.p11; in { enable = cfg.p11Auth; text = ''

          (let p11 = config.security.pam.p11; in { name = "p11"; enable = cfg.p11Auth; text = ''

            ${p11.control} ${pkgs.pam_p11}/lib/security/pam_p11.so ${pkgs.opensc}/lib/opensc-pkcs11.so

          ''; })

          (let u2f = config.security.pam.u2f; in { enable = cfg.u2fAuth; text = ''

          (let u2f = config.security.pam.u2f; in { name = "u2f"; enable = cfg.u2fAuth; text = ''

            ${u2f.control} ${pkgs.pam_u2f}/lib/security/pam_u2f.so ${optionalString u2f.debug "debug"} ${optionalString (u2f.authFile != null) "authfile=${u2f.authFile}"} ${optionalString u2f.interactive "interactive"} ${optionalString u2f.cue "cue"} ${optionalString (u2f.appId != null) "appid=${u2f.appId}"} ${optionalString (u2f.origin != null) "origin=${u2f.origin}"}

          ''; })

          { enable = cfg.usbAuth; text = ''

          { name = "usb"; enable = cfg.usbAuth; text = ''

            sufficient ${pkgs.pam_usb}/lib/security/pam_usb.so

          ''; }

          (let ussh = config.security.pam.ussh; in { enable = config.security.pam.ussh.enable && cfg.usshAuth; text = ''

          (let ussh = config.security.pam.ussh; in { name = "ussh"; enable = config.security.pam.ussh.enable && cfg.usshAuth; text = ''

            ${ussh.control} ${pkgs.pam_ussh}/lib/security/pam_ussh.so ${optionalString (ussh.caFile != null) "ca_file=${ussh.caFile}"} ${optionalString (ussh.authorizedPrincipals != null) "authorized_principals=${ussh.authorizedPrincipals}"} ${optionalString (ussh.authorizedPrincipalsFile != null) "authorized_principals_file=${ussh.authorizedPrincipalsFile}"} ${optionalString (ussh.group != null) "group=${ussh.group}"}

          ''; })

          (let oath = config.security.pam.oath; in { enable = cfg.oathAuth; text = ''

          (let oath = config.security.pam.oath; in { name = "oath"; enable = cfg.oathAuth; text = ''

            requisite ${pkgs.oath-toolkit}/lib/security/pam_oath.so window=${toString oath.window} usersfile=${toString oath.usersFile} digits=${toString oath.digits}

          ''; })

          (let yubi = config.security.pam.yubico; in { enable = cfg.yubicoAuth; text = ''

          (let yubi = config.security.pam.yubico; in { name = "yubico"; enable = cfg.yubicoAuth; text = ''

            ${yubi.control} ${pkgs.yubico-pam}/lib/security/pam_yubico.so mode=${toString yubi.mode} ${optionalString (yubi.challengeResponsePath != null) "chalresp_path=${yubi.challengeResponsePath}"} ${optionalString (yubi.mode == "client") "id=${toString yubi.id}"} ${optionalString yubi.debug "debug"}

          ''; })

          (let dp9ik = config.security.pam.dp9ik; in { enable = dp9ik.enable; text = ''

          (let dp9ik = config.security.pam.dp9ik; in { name = "p9"; enable = dp9ik.enable; text = ''

            ${dp9ik.control} ${pkgs.pam_dp9ik}/lib/security/pam_p9.so ${dp9ik.authserver}

          ''; })

          { enable = cfg.fprintAuth; text = ''

          { name = "fprintd"; enable = cfg.fprintAuth; text = ''

            sufficient ${pkgs.fprintd}/lib/security/pam_fprintd.so

          ''; }

        ] ++
@@ -640,201 +646,201 @@ let 
              || cfg.duoSecurity.enable

              || cfg.zfs))

            [

              { enable = config.services.homed.enable; text = ''

              { name = "systemd_home-early"; enable = config.services.homed.enable; text = ''

                optional ${config.systemd.package}/lib/security/pam_systemd_home.so

              ''; }

              { enable = cfg.unixAuth; text = ''

              { name = "unix-early"; enable = cfg.unixAuth; text = ''

                optional pam_unix.so ${optionalString cfg.allowNullPassword "nullok"} ${optionalString cfg.nodelay "nodelay"} likeauth

              ''; }

              { enable = config.security.pam.enableEcryptfs; text = ''

              { name = "ecryptfs"; enable = config.security.pam.enableEcryptfs; text = ''

                optional ${pkgs.ecryptfs}/lib/security/pam_ecryptfs.so unwrap

              ''; }

              { enable = config.security.pam.enableFscrypt; text = ''

              { name = "fscrypt"; enable = config.security.pam.enableFscrypt; text = ''

                optional ${pkgs.fscrypt-experimental}/lib/security/pam_fscrypt.so

              ''; }

              { enable = cfg.zfs; text = ''

              { name = "zfs_key"; enable = cfg.zfs; text = ''

                optional ${config.boot.zfs.package}/lib/security/pam_zfs_key.so homes=${config.security.pam.zfs.homes}

              ''; }

              { enable = cfg.pamMount; text = ''

              { name = "mount"; enable = cfg.pamMount; text = ''

                optional ${pkgs.pam_mount}/lib/security/pam_mount.so disable_interactive

              ''; }

              { enable = cfg.enableKwallet; text = ''

              { name = "kwallet5"; enable = cfg.enableKwallet; text = ''

                optional ${pkgs.plasma5Packages.kwallet-pam}/lib/security/pam_kwallet5.so kwalletd=${pkgs.plasma5Packages.kwallet.bin}/bin/kwalletd5

              ''; }

              { enable = cfg.enableGnomeKeyring; text = ''

              { name = "gnome_keyring"; enable = cfg.enableGnomeKeyring; text = ''

                optional ${pkgs.gnome.gnome-keyring}/lib/security/pam_gnome_keyring.so

              ''; }

              { enable = cfg.gnupg.enable; text = ''

              { name = "gnupg"; enable = cfg.gnupg.enable; text = ''

                optional ${pkgs.pam_gnupg}/lib/security/pam_gnupg.so ${optionalString cfg.gnupg.storeOnly "store-only"}

              ''; }

              { enable = cfg.failDelay.enable; text = ''

              { name = "faildelay"; enable = cfg.failDelay.enable; text = ''

                optional ${pkgs.pam}/lib/security/pam_faildelay.so delay=${toString cfg.failDelay.delay}

              ''; }

              { enable = cfg.googleAuthenticator.enable; text = ''

              { name = "google_authenticator"; enable = cfg.googleAuthenticator.enable; text = ''

                required ${pkgs.google-authenticator}/lib/security/pam_google_authenticator.so no_increment_hotp

              ''; }

              { enable = cfg.duoSecurity.enable; text = ''

              { name = "duo"; enable = cfg.duoSecurity.enable; text = ''

                required ${pkgs.duo-unix}/lib/security/pam_duo.so

              ''; }

            ]) ++ [

          { enable = config.services.homed.enable; text = ''

          { name = "systemd_home"; enable = config.services.homed.enable; text = ''

            sufficient ${config.systemd.package}/lib/security/pam_systemd_home.so

          ''; }

          { enable = cfg.unixAuth; text = ''

          { name = "unix"; enable = cfg.unixAuth; text = ''

            sufficient pam_unix.so ${optionalString cfg.allowNullPassword "nullok"} ${optionalString cfg.nodelay "nodelay"} likeauth try_first_pass

          ''; }

          { enable = cfg.otpwAuth; text = ''

          { name = "otpw"; enable = cfg.otpwAuth; text = ''

            sufficient ${pkgs.otpw}/lib/security/pam_otpw.so

          ''; }

          { enable = use_ldap; text = ''

          { name = "ldap"; enable = use_ldap; text = ''

            sufficient ${pam_ldap}/lib/security/pam_ldap.so use_first_pass

          ''; }

          { enable = config.services.kanidm.enablePam; text = ''

          { name = "kanidm"; enable = config.services.kanidm.enablePam; text = ''

            sufficient ${pkgs.kanidm}/lib/pam_kanidm.so ignore_unknown_user use_first_pass

          ''; }

          { enable = config.services.sssd.enable; text = ''

          { name = "sss"; enable = config.services.sssd.enable; text = ''

            sufficient ${pkgs.sssd}/lib/security/pam_sss.so use_first_pass

          ''; }

          { enable = config.security.pam.krb5.enable; text = ''

          { name = "krb5"; enable = config.security.pam.krb5.enable; text = ''

            [default=ignore success=1 service_err=reset] ${pam_krb5}/lib/security/pam_krb5.so use_first_pass

          ''; }

          { enable = config.security.pam.krb5.enable; text = ''

          { name = "ccreds-validate"; enable = config.security.pam.krb5.enable; text = ''

            [default=die success=done] ${pam_ccreds}/lib/security/pam_ccreds.so action=validate use_first_pass

          ''; }

          { enable = config.security.pam.krb5.enable; text = ''

          { name = "ccreds-store"; enable = config.security.pam.krb5.enable; text = ''

            sufficient ${pam_ccreds}/lib/security/pam_ccreds.so action=store use_first_pass

          ''; }

          { text = ''

          { name = "deny"; text = ''

            required pam_deny.so

          ''; }

        ];



        password = [

          { enable = config.services.homed.enable; text = ''

          { name = "systemd_home"; enable = config.services.homed.enable; text = ''

            sufficient ${config.systemd.package}/lib/security/pam_systemd_home.so

          ''; }

          { text = ''

          { name = "unix"; text = ''

            sufficient pam_unix.so nullok yescrypt

          ''; }

          { enable = config.security.pam.enableEcryptfs; text = ''

          { name = "ecryptfs"; enable = config.security.pam.enableEcryptfs; text = ''

            optional ${pkgs.ecryptfs}/lib/security/pam_ecryptfs.so

          ''; }

          { enable = config.security.pam.enableFscrypt; text = ''

          { name = "fscrypt"; enable = config.security.pam.enableFscrypt; text = ''

            optional ${pkgs.fscrypt-experimental}/lib/security/pam_fscrypt.so

          ''; }

          { enable = cfg.zfs; text = ''

          { name = "zfs_key"; enable = cfg.zfs; text = ''

            optional ${config.boot.zfs.package}/lib/security/pam_zfs_key.so homes=${config.security.pam.zfs.homes}

          ''; }

          { enable = cfg.pamMount; text = ''

          { name = "mount"; enable = cfg.pamMount; text = ''

            optional ${pkgs.pam_mount}/lib/security/pam_mount.so

          ''; }

          { enable = use_ldap; text = ''

          { name = "ldap"; enable = use_ldap; text = ''

            sufficient ${pam_ldap}/lib/security/pam_ldap.so

          ''; }

          { enable = cfg.mysqlAuth; text = ''

          { name = "mysql"; enable = cfg.mysqlAuth; text = ''

            sufficient ${pkgs.pam_mysql}/lib/security/pam_mysql.so config_file=/etc/security/pam_mysql.conf

          ''; }

          { enable = config.services.kanidm.enablePam; text = ''

          { name = "kanidm"; enable = config.services.kanidm.enablePam; text = ''

            sufficient ${pkgs.kanidm}/lib/pam_kanidm.so

          ''; }

          { enable = config.services.sssd.enable; text = ''

          { name = "sss"; enable = config.services.sssd.enable; text = ''

            sufficient ${pkgs.sssd}/lib/security/pam_sss.so

          ''; }

          { enable = config.security.pam.krb5.enable; text = ''

          { name = "krb5"; enable = config.security.pam.krb5.enable; text = ''

            sufficient ${pam_krb5}/lib/security/pam_krb5.so use_first_pass

          ''; }

          { enable = cfg.enableGnomeKeyring; text = ''

          { name = "gnome_keyring"; enable = cfg.enableGnomeKeyring; text = ''

            optional ${pkgs.gnome.gnome-keyring}/lib/security/pam_gnome_keyring.so use_authtok

          ''; }

        ];



        session = [

          { enable = cfg.setEnvironment; text = ''

          { name = "env"; enable = cfg.setEnvironment; text = ''

            required pam_env.so conffile=/etc/pam/environment readenv=0

          ''; }

          { text = ''

          { name = "unix"; text = ''

            required pam_unix.so

          ''; }

          { enable = cfg.setLoginUid; text = ''

          { name = "loginuid"; enable = cfg.setLoginUid; text = ''

            ${if config.boot.isContainer then "optional" else "required"} pam_loginuid.so

          ''; }

          { enable = cfg.ttyAudit.enable; text = ''

          { name = "tty_audit"; enable = cfg.ttyAudit.enable; text = ''

            required ${pkgs.pam}/lib/security/pam_tty_audit.so ${optionalString cfg.ttyAudit.openOnly "open_only"} ${optionalString (cfg.ttyAudit.enablePattern != null) "enable=${cfg.ttyAudit.enablePattern}"} ${optionalString (cfg.ttyAudit.disablePattern != null) "disable=${cfg.ttyAudit.disablePattern}"}

          ''; }

          { enable = config.services.homed.enable; text = ''

          { name = "systemd_home"; enable = config.services.homed.enable; text = ''

            required ${config.systemd.package}/lib/security/pam_systemd_home.so

          ''; }

          { enable = cfg.makeHomeDir; text = ''

          { name = "mkhomedir"; enable = cfg.makeHomeDir; text = ''

            required ${pkgs.pam}/lib/security/pam_mkhomedir.so silent skel=${config.security.pam.makeHomeDir.skelDirectory} umask=${config.security.pam.makeHomeDir.umask}

          ''; }

          { enable = cfg.updateWtmp; text = ''

          { name = "lastlog"; enable = cfg.updateWtmp; text = ''

            required ${pkgs.pam}/lib/security/pam_lastlog.so silent

          ''; }

          { enable = config.security.pam.enableEcryptfs; text = ''

          { name = "ecryptfs"; enable = config.security.pam.enableEcryptfs; text = ''

            optional ${pkgs.ecryptfs}/lib/security/pam_ecryptfs.so

          ''; }

          # Work around https://github.com/systemd/systemd/issues/8598

          # Skips the pam_fscrypt module for systemd-user sessions which do not have a password

          # anyways.

          # See also https://github.com/google/fscrypt/issues/95

          { enable = config.security.pam.enableFscrypt; text = ''

          { name = "fscrypt-skip-systemd"; enable = config.security.pam.enableFscrypt; text = ''

            [success=1 default=ignore] pam_succeed_if.so service = systemd-user

          ''; }

          { enable = config.security.pam.enableFscrypt; text = ''

          { name = "fscrypt"; enable = config.security.pam.enableFscrypt; text = ''

            optional ${pkgs.fscrypt-experimental}/lib/security/pam_fscrypt.so

          ''; }

          { enable = cfg.zfs; text = ''

          { name = "zfs_key-skip-systemd"; enable = cfg.zfs; text = ''

            [success=1 default=ignore] pam_succeed_if.so service = systemd-user

          ''; }

          { enable = cfg.zfs; text = ''

          { name = "zfs_key"; enable = cfg.zfs; text = ''

            optional ${config.boot.zfs.package}/lib/security/pam_zfs_key.so homes=${config.security.pam.zfs.homes} ${optionalString config.security.pam.zfs.noUnmount "nounmount"}

          ''; }

          { enable = cfg.pamMount; text = ''

          { name = "mount"; enable = cfg.pamMount; text = ''

            optional ${pkgs.pam_mount}/lib/security/pam_mount.so disable_interactive

          ''; }

          { enable = use_ldap; text = ''

          { name = "ldap"; enable = use_ldap; text = ''

            optional ${pam_ldap}/lib/security/pam_ldap.so

          ''; }

          { enable = cfg.mysqlAuth; text = ''

          { name = "mysql"; enable = cfg.mysqlAuth; text = ''

            optional ${pkgs.pam_mysql}/lib/security/pam_mysql.so config_file=/etc/security/pam_mysql.conf

          ''; }

          { enable = config.services.kanidm.enablePam; text = ''

          { name = "kanidm"; enable = config.services.kanidm.enablePam; text = ''

            optional ${pkgs.kanidm}/lib/pam_kanidm.so

          ''; }

          { enable = config.services.sssd.enable; text = ''

          { name = "sss"; enable = config.services.sssd.enable; text = ''

            optional ${pkgs.sssd}/lib/security/pam_sss.so

          ''; }

          { enable = config.security.pam.krb5.enable; text = ''

          { name = "krb5"; enable = config.security.pam.krb5.enable; text = ''

            optional ${pam_krb5}/lib/security/pam_krb5.so

          ''; }

          { enable = cfg.otpwAuth; text = ''

          { name = "otpw"; enable = cfg.otpwAuth; text = ''

            optional ${pkgs.otpw}/lib/security/pam_otpw.so

          ''; }

          { enable = cfg.startSession; text = ''

          { name = "systemd"; enable = cfg.startSession; text = ''

            optional ${config.systemd.package}/lib/security/pam_systemd.so

          ''; }

          { enable = cfg.forwardXAuth; text = ''

          { name = "xauth"; enable = cfg.forwardXAuth; text = ''

            optional pam_xauth.so xauthpath=${pkgs.xorg.xauth}/bin/xauth systemuser=99

          ''; }

          { enable = cfg.limits != []; text = ''

          { name = "limits"; enable = cfg.limits != []; text = ''

            required ${pkgs.pam}/lib/security/pam_limits.so conf=${makeLimitsConf cfg.limits}

          ''; }

          { enable = cfg.showMotd && (config.users.motd != null || config.users.motdFile != null); text = ''

          { name = "motd"; enable = cfg.showMotd && (config.users.motd != null || config.users.motdFile != null); text = ''

            optional ${pkgs.pam}/lib/security/pam_motd.so motd=${motd}

          ''; }

          { enable = cfg.enableAppArmor && config.security.apparmor.enable; text = ''

          { name = "apparmor"; enable = cfg.enableAppArmor && config.security.apparmor.enable; text = ''

            optional ${pkgs.apparmor-pam}/lib/security/pam_apparmor.so order=user,group,default debug

          ''; }

          { enable = cfg.enableKwallet; text = ''

          { name = "kwallet5"; enable = cfg.enableKwallet; text = ''

            optional ${pkgs.plasma5Packages.kwallet-pam}/lib/security/pam_kwallet5.so kwalletd=${pkgs.plasma5Packages.kwallet.bin}/bin/kwalletd5

          ''; }

          { enable = cfg.enableGnomeKeyring; text = ''

          { name = "gnome_keyring"; enable = cfg.enableGnomeKeyring; text = ''

            optional ${pkgs.gnome.gnome-keyring}/lib/security/pam_gnome_keyring.so auto_start

          ''; }

          { enable = cfg.gnupg.enable; text = ''

          { name = "gnupg"; enable = cfg.gnupg.enable; text = ''

            optional ${pkgs.pam_gnupg}/lib/security/pam_gnupg.so ${optionalString cfg.gnupg.noAutostart " no-autostart"}

          ''; }

          { enable = config.virtualisation.lxc.lxcfs.enable; text = ''

          { name = "cgfs"; enable = config.virtualisation.lxc.lxcfs.enable; text = ''

            optional ${pkgs.lxc}/lib/security/pam_cgfs.so -c all

          ''; }

        ];