2009-05-28 14:10:02 +01:00
|
|
|
|
# This module provides configuration for the PAM (Pluggable
|
|
|
|
|
# Authentication Modules) system.
|
|
|
|
|
|
|
|
|
|
{config, pkgs, ...}:
|
|
|
|
|
|
2009-08-16 15:49:14 +01:00
|
|
|
|
with pkgs.lib;
|
|
|
|
|
|
2009-05-28 14:10:02 +01:00
|
|
|
|
let
|
|
|
|
|
|
2013-10-15 13:47:51 +01:00
|
|
|
|
pamOpts = args: {
|
|
|
|
|
|
|
|
|
|
options = {
|
|
|
|
|
|
|
|
|
|
name = mkOption {
|
|
|
|
|
example = "sshd";
|
|
|
|
|
type = types.uniq types.string;
|
|
|
|
|
description = "Name of the PAM service.";
|
|
|
|
|
};
|
|
|
|
|
|
2013-10-15 14:05:49 +01:00
|
|
|
|
unixAuth = mkOption {
|
|
|
|
|
default = true;
|
|
|
|
|
type = types.bool;
|
|
|
|
|
description = ''
|
|
|
|
|
Whether users can log in with passwords defined in
|
|
|
|
|
<filename>/etc/shadow</filename>.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2013-10-15 13:47:51 +01:00
|
|
|
|
rootOK = mkOption {
|
|
|
|
|
default = false;
|
|
|
|
|
type = types.bool;
|
|
|
|
|
description = ''
|
|
|
|
|
If set, root doesn't need to authenticate (e.g. for the
|
|
|
|
|
<command>useradd</command> service).
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
usbAuth = mkOption {
|
|
|
|
|
default = config.security.pam.usb.enable;
|
|
|
|
|
type = types.bool;
|
|
|
|
|
description = ''
|
|
|
|
|
If set, users listed in
|
|
|
|
|
<filename>/etc/pamusb.conf</filename> are able to log in
|
|
|
|
|
with the associated USB key.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
otpwAuth = mkOption {
|
|
|
|
|
default = config.security.pam.enableOTPW;
|
|
|
|
|
type = types.bool;
|
|
|
|
|
description = ''
|
|
|
|
|
If set, the OTPW system will be used (if
|
|
|
|
|
<filename>~/.otpw</filename> exists).
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
sshAgentAuth = mkOption {
|
|
|
|
|
default = false;
|
|
|
|
|
type = types.bool;
|
|
|
|
|
description = ''
|
|
|
|
|
If set, the calling user's SSH agent is used to authenticate
|
|
|
|
|
against the keys in the calling user's
|
|
|
|
|
<filename>~/.ssh/authorized_keys</filename>. This is useful
|
|
|
|
|
for <command>sudo</command> on password-less remote systems.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
startSession = mkOption {
|
|
|
|
|
default = false;
|
|
|
|
|
type = 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.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
setLoginUid = mkOption {
|
|
|
|
|
type = types.bool;
|
|
|
|
|
description = ''
|
|
|
|
|
Set the login uid of the process
|
|
|
|
|
(<filename>/proc/self/loginuid</filename>) for auditing
|
|
|
|
|
purposes. The login uid is only set by ‘entry points’ like
|
|
|
|
|
<command>login</command> and <command>sshd</command>, not by
|
|
|
|
|
commands like <command>sudo</command>.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
forwardXAuth = mkOption {
|
|
|
|
|
default = false;
|
|
|
|
|
type = types.bool;
|
|
|
|
|
description = ''
|
|
|
|
|
Whether X authentication keys should be passed from the
|
|
|
|
|
calling user to the target user (e.g. for
|
|
|
|
|
<command>su</command>)
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
allowNullPassword = mkOption {
|
|
|
|
|
default = false;
|
|
|
|
|
type = types.bool;
|
|
|
|
|
description = ''
|
|
|
|
|
Whether to allow logging into accounts that have no password
|
|
|
|
|
set (i.e., have an empty password field in
|
|
|
|
|
<filename>/etc/passwd</filename> or
|
|
|
|
|
<filename>/etc/group</filename>). This does not enable
|
|
|
|
|
logging into disabled accounts (i.e., that have the password
|
|
|
|
|
field set to <literal>!</literal>). Note that regardless of
|
|
|
|
|
what the pam_unix documentation says, accounts with hashed
|
|
|
|
|
empty passwords are always allowed to log in.
|
|
|
|
|
'';
|
|
|
|
|
};
|
2012-09-16 18:14:19 +01:00
|
|
|
|
|
2013-10-15 13:47:51 +01:00
|
|
|
|
limits = mkOption {
|
|
|
|
|
description = ''
|
|
|
|
|
Attribute set describing resource limits. Defaults to the
|
|
|
|
|
value of <option>security.pam.loginLimits</option>.
|
|
|
|
|
'';
|
|
|
|
|
};
|
2009-05-28 14:10:02 +01:00
|
|
|
|
|
2013-10-15 13:47:51 +01:00
|
|
|
|
showMotd = mkOption {
|
|
|
|
|
default = false;
|
|
|
|
|
type = types.bool;
|
|
|
|
|
description = "Whether to show the message of the day.";
|
|
|
|
|
};
|
2009-08-16 16:46:24 +01:00
|
|
|
|
|
2013-10-15 13:47:51 +01:00
|
|
|
|
updateWtmp = mkOption {
|
|
|
|
|
default = false;
|
|
|
|
|
type = types.bool;
|
|
|
|
|
description = "Whether to update <filename>/var/log/wtmp</filename>.";
|
|
|
|
|
};
|
2010-01-12 11:02:23 +00:00
|
|
|
|
|
2013-10-15 13:47:51 +01:00
|
|
|
|
text = mkOption {
|
|
|
|
|
type = types.nullOr types.string;
|
|
|
|
|
description = "Contents of the PAM service file.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
config = let cfg = args.config; in {
|
|
|
|
|
name = mkDefault args.name;
|
|
|
|
|
setLoginUid = mkDefault cfg.startSession;
|
|
|
|
|
limits = mkDefault config.security.pam.loginLimits;
|
2012-10-23 14:10:48 +01:00
|
|
|
|
|
2013-10-15 13:47:51 +01:00
|
|
|
|
# !!! 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.
|
|
|
|
|
text = mkDefault
|
2009-08-16 15:49:14 +01:00
|
|
|
|
''
|
|
|
|
|
# Account management.
|
2011-04-13 21:48:50 +01:00
|
|
|
|
account sufficient pam_unix.so
|
2009-08-16 15:49:14 +01:00
|
|
|
|
${optionalString config.users.ldap.enable
|
2011-04-13 21:48:50 +01:00
|
|
|
|
"account sufficient ${pam_ldap}/lib/security/pam_ldap.so"}
|
2010-08-06 09:50:48 +01:00
|
|
|
|
${optionalString config.krb5.enable
|
|
|
|
|
"account sufficient ${pam_krb5}/lib/security/pam_krb5.so"}
|
2009-08-16 15:49:14 +01:00
|
|
|
|
|
|
|
|
|
# Authentication management.
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString cfg.rootOK
|
2009-08-16 15:49:14 +01:00
|
|
|
|
"auth sufficient pam_rootok.so"}
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString (config.security.pam.enableSSHAgentAuth && cfg.sshAgentAuth)
|
2012-12-17 20:08:29 +00:00
|
|
|
|
"auth sufficient ${pkgs.pam_ssh_agent_auth}/libexec/pam_ssh_agent_auth.so file=~/.ssh/authorized_keys:~/.ssh/authorized_keys2:/etc/ssh/authorized_keys.d/%u"}
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString cfg.usbAuth
|
2012-06-11 23:41:07 +01:00
|
|
|
|
"auth sufficient ${pkgs.pam_usb}/lib/security/pam_usb.so"}
|
2013-10-15 14:05:49 +01:00
|
|
|
|
${optionalString cfg.unixAuth
|
|
|
|
|
"auth sufficient pam_unix.so ${optionalString cfg.allowNullPassword "nullok"} likeauth"}
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString cfg.otpwAuth
|
2013-03-30 20:06:23 +00:00
|
|
|
|
"auth sufficient ${pkgs.otpw}/lib/security/pam_otpw.so"}
|
2011-04-13 21:48:50 +01:00
|
|
|
|
${optionalString config.users.ldap.enable
|
|
|
|
|
"auth sufficient ${pam_ldap}/lib/security/pam_ldap.so use_first_pass"}
|
2012-06-11 23:41:07 +01:00
|
|
|
|
${optionalString config.krb5.enable ''
|
|
|
|
|
auth [default=ignore success=1 service_err=reset] ${pam_krb5}/lib/security/pam_krb5.so use_first_pass
|
|
|
|
|
auth [default=die success=done] ${pam_ccreds}/lib/security/pam_ccreds.so action=validate use_first_pass
|
|
|
|
|
auth sufficient ${pam_ccreds}/lib/security/pam_ccreds.so action=store use_first_pass
|
2010-08-06 09:50:48 +01:00
|
|
|
|
''}
|
2009-08-16 15:49:14 +01:00
|
|
|
|
auth required pam_deny.so
|
|
|
|
|
|
|
|
|
|
# Password management.
|
2011-04-13 21:48:50 +01:00
|
|
|
|
password requisite pam_unix.so nullok sha512
|
2009-08-16 15:49:14 +01:00
|
|
|
|
${optionalString config.users.ldap.enable
|
|
|
|
|
"password sufficient ${pam_ldap}/lib/security/pam_ldap.so"}
|
2010-08-06 09:50:48 +01:00
|
|
|
|
${optionalString config.krb5.enable
|
|
|
|
|
"password sufficient ${pam_krb5}/lib/security/pam_krb5.so use_first_pass"}
|
2009-08-16 15:49:14 +01:00
|
|
|
|
${optionalString config.services.samba.syncPasswordsByPam
|
|
|
|
|
"password optional ${pkgs.samba}/lib/security/pam_smbpass.so nullok use_authtok try_first_pass"}
|
|
|
|
|
|
|
|
|
|
# Session management.
|
2011-04-13 21:48:50 +01:00
|
|
|
|
session required pam_unix.so
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString cfg.updateWtmp
|
2013-09-22 17:16:22 +01:00
|
|
|
|
"session required ${pkgs.pam}/lib/security/pam_lastlog.so silent"}
|
2009-08-16 15:49:14 +01:00
|
|
|
|
${optionalString config.users.ldap.enable
|
|
|
|
|
"session optional ${pam_ldap}/lib/security/pam_ldap.so"}
|
2010-08-06 09:50:48 +01:00
|
|
|
|
${optionalString config.krb5.enable
|
|
|
|
|
"session optional ${pam_krb5}/lib/security/pam_krb5.so"}
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString cfg.otpwAuth
|
2013-03-30 20:06:23 +00:00
|
|
|
|
"session optional ${pkgs.otpw}/lib/security/pam_otpw.so"}
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString cfg.startSession
|
2012-06-15 19:51:48 +01:00
|
|
|
|
"session optional ${pkgs.systemd}/lib/security/pam_systemd.so"}
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString cfg.setLoginUid
|
2013-05-13 10:27:21 +01:00
|
|
|
|
"session required pam_loginuid.so"}
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString cfg.forwardXAuth
|
2009-08-16 15:49:14 +01:00
|
|
|
|
"session optional pam_xauth.so xauthpath=${pkgs.xorg.xauth}/bin/xauth systemuser=99"}
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString (cfg.limits != [])
|
2013-10-17 14:26:48 +01:00
|
|
|
|
"session required ${pkgs.pam}/lib/security/pam_limits.so conf=${makeLimitsConf cfg.limits}"}
|
2013-10-15 13:47:51 +01:00
|
|
|
|
${optionalString (cfg.showMotd && config.users.motd != null)
|
2012-10-23 14:10:48 +01:00
|
|
|
|
"session optional ${pkgs.pam}/lib/security/pam_motd.so motd=${motd}"}
|
2009-08-16 15:49:14 +01:00
|
|
|
|
'';
|
2013-10-15 13:47:51 +01:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
inherit (pkgs) pam_krb5 pam_ccreds;
|
|
|
|
|
|
|
|
|
|
pam_ldap = if config.users.ldap.daemon.enable then pkgs.nss_pam_ldapd else pkgs.pam_ldap;
|
|
|
|
|
|
|
|
|
|
# Create a limits.conf(5) file.
|
|
|
|
|
makeLimitsConf = limits:
|
|
|
|
|
pkgs.writeText "limits.conf"
|
2013-10-17 14:36:59 +01:00
|
|
|
|
(concatMapStrings ({ domain, type, item, value }:
|
|
|
|
|
"${domain} ${type} ${item} ${toString value}\n")
|
|
|
|
|
limits);
|
2013-10-15 13:47:51 +01:00
|
|
|
|
|
|
|
|
|
motd = pkgs.writeText "motd" config.users.motd;
|
|
|
|
|
|
|
|
|
|
makePAMService = pamService:
|
|
|
|
|
{ source = pkgs.writeText "${pamService.name}.pam" pamService.text;
|
|
|
|
|
target = "pam.d/${pamService.name}";
|
2009-05-28 14:10:02 +01:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
in
|
|
|
|
|
|
|
|
|
|
{
|
2009-08-16 15:49:14 +01:00
|
|
|
|
|
|
|
|
|
###### interface
|
|
|
|
|
|
|
|
|
|
options = {
|
|
|
|
|
|
2010-01-12 11:02:23 +00:00
|
|
|
|
security.pam.loginLimits = mkOption {
|
|
|
|
|
default = [];
|
|
|
|
|
example =
|
|
|
|
|
[ { domain = "ftp";
|
|
|
|
|
type = "hard";
|
|
|
|
|
item = "nproc";
|
|
|
|
|
value = "0";
|
|
|
|
|
}
|
|
|
|
|
{ domain = "@student";
|
|
|
|
|
type = "-";
|
|
|
|
|
item = "maxlogins";
|
|
|
|
|
value = "4";
|
|
|
|
|
}
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
description =
|
2011-08-01 11:17:18 +01:00
|
|
|
|
'' Define resource limits that should apply to users or groups.
|
|
|
|
|
Each item in the list should be an attribute set with a
|
|
|
|
|
<varname>domain</varname>, <varname>type</varname>,
|
|
|
|
|
<varname>item</varname>, and <varname>value</varname>
|
|
|
|
|
attribute. The syntax and semantics of these attributes
|
|
|
|
|
must be that described in the limits.conf(5) man page.
|
2010-01-12 11:02:23 +00:00
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2009-08-16 15:49:14 +01:00
|
|
|
|
security.pam.services = mkOption {
|
|
|
|
|
default = [];
|
2013-10-15 13:47:51 +01:00
|
|
|
|
type = types.loaOf types.optionSet;
|
|
|
|
|
options = [ pamOpts ];
|
2009-08-16 15:49:14 +01:00
|
|
|
|
description =
|
|
|
|
|
''
|
|
|
|
|
This option defines the PAM services. A service typically
|
|
|
|
|
corresponds to a program that uses PAM,
|
|
|
|
|
e.g. <command>login</command> or <command>passwd</command>.
|
2013-10-15 13:47:51 +01:00
|
|
|
|
Each attribute of this set defines a PAM service, with the attribute name
|
|
|
|
|
defining the name of the service.
|
2009-08-16 15:49:14 +01:00
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2012-06-11 23:41:07 +01:00
|
|
|
|
security.pam.enableSSHAgentAuth = mkOption {
|
|
|
|
|
default = false;
|
|
|
|
|
description =
|
|
|
|
|
''
|
|
|
|
|
Enable sudo logins if the user's SSH agent provides a key
|
|
|
|
|
present in <filename>~/.ssh/authorized_keys</filename>.
|
|
|
|
|
This allows machines to exclusively use SSH keys instead of
|
|
|
|
|
passwords.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2013-03-30 20:06:23 +00:00
|
|
|
|
security.pam.enableOTPW = mkOption {
|
|
|
|
|
default = false;
|
|
|
|
|
description = ''
|
2013-10-15 13:47:51 +01:00
|
|
|
|
Enable the OTPW (one-time password) PAM module.
|
2013-03-30 20:06:23 +00:00
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2012-10-23 14:10:48 +01:00
|
|
|
|
users.motd = mkOption {
|
|
|
|
|
default = null;
|
|
|
|
|
example = "Today is Sweetmorn, the 4th day of The Aftermath in the YOLD 3178.";
|
|
|
|
|
type = types.nullOr types.string;
|
|
|
|
|
description = "Message of the day shown to users when they log in.";
|
|
|
|
|
};
|
|
|
|
|
|
2009-08-16 15:49:14 +01:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
###### implementation
|
|
|
|
|
|
|
|
|
|
config = {
|
2010-08-13 15:07:34 +01:00
|
|
|
|
|
2009-08-16 15:49:14 +01:00
|
|
|
|
environment.systemPackages =
|
|
|
|
|
# Include the PAM modules in the system path mostly for the manpages.
|
2010-06-02 20:59:44 +01:00
|
|
|
|
[ pkgs.pam ]
|
2010-08-06 09:50:48 +01:00
|
|
|
|
++ optional config.users.ldap.enable pam_ldap
|
2013-03-30 20:06:23 +00:00
|
|
|
|
++ optionals config.krb5.enable [pam_krb5 pam_ccreds]
|
|
|
|
|
++ optionals config.security.pam.enableOTPW [ pkgs.otpw ];
|
2009-08-16 15:49:14 +01:00
|
|
|
|
|
2009-08-16 16:46:24 +01:00
|
|
|
|
environment.etc =
|
2013-10-15 13:47:51 +01:00
|
|
|
|
mapAttrsToList (n: v: makePAMService v) config.security.pam.services;
|
2009-08-16 15:49:14 +01:00
|
|
|
|
|
2010-08-13 15:07:34 +01:00
|
|
|
|
security.setuidOwners = [ {
|
|
|
|
|
program = "unix_chkpwd";
|
|
|
|
|
source = "${pkgs.pam}/sbin/unix_chkpwd.orig";
|
|
|
|
|
owner = "root";
|
|
|
|
|
setuid = true;
|
|
|
|
|
} ];
|
|
|
|
|
|
2009-08-16 15:49:14 +01:00
|
|
|
|
security.pam.services =
|
2013-10-15 13:47:51 +01:00
|
|
|
|
{ other.text =
|
|
|
|
|
''
|
|
|
|
|
auth required pam_warn.so
|
|
|
|
|
auth required pam_deny.so
|
|
|
|
|
account required pam_warn.so
|
|
|
|
|
account required pam_deny.so
|
|
|
|
|
password required pam_warn.so
|
|
|
|
|
password required pam_deny.so
|
|
|
|
|
session required pam_warn.so
|
|
|
|
|
session required pam_deny.so
|
|
|
|
|
'';
|
|
|
|
|
|
|
|
|
|
# Most of these should be moved to specific modules.
|
|
|
|
|
cups = {};
|
|
|
|
|
ftp = {};
|
|
|
|
|
i3lock = {};
|
|
|
|
|
screen = {};
|
|
|
|
|
vlock = {};
|
|
|
|
|
xlock = {};
|
|
|
|
|
xscreensaver = {};
|
|
|
|
|
};
|
2009-08-16 15:49:14 +01:00
|
|
|
|
|
|
|
|
|
};
|
2010-08-13 15:07:34 +01:00
|
|
|
|
|
2009-05-28 14:10:02 +01:00
|
|
|
|
}
|