mkhomedir_helper(8) [linux man page]

MKHOMEDIR_HELPER(8)						 Linux-PAM Manual					       MKHOMEDIR_HELPER(8)

NAME

       mkhomedir_helper - Helper binary that creates home directories

SYNOPSIS

       mkhomedir_helper {user} [umask [ path-to-skel ]]

DESCRIPTION

       mkhomedir_helper is a helper program for the pam_mkhomedir module that creates home directories and populates them with contents of the
       specified skel directory.

       The default value of umask is 0022 and the default value of path-to-skel is /etc/skel.

       The helper is separated from the module to not require direct access from login SELinux domains to the contents of user home directories.
       The SELinux domain transition happens when the module is executing the mkhomedir_helper.

       The helper never touches home directories if they already exist.

SEE ALSO

       pam_mkhomedir(8)

AUTHOR

       Written by Tomas Mraz based on the code originally in pam_mkhomedir module.

Linux-PAM Manual						    06/04/2011						       MKHOMEDIR_HELPER(8)

PAM_MKHOMEDIR(8)						 Linux-PAM Manual						  PAM_MKHOMEDIR(8)

NAME

       pam_mkhomedir - PAM module to create users home directory

SYNOPSIS

       pam_mkhomedir.so [silent] [umask=mode] [skel=skeldir]

DESCRIPTION

       The pam_mkhomedir PAM module will create a users home directory if it does not exist when the session begins. This allows users to be
       present in central database (such as NIS, kerberos or LDAP) without using a distributed file system or pre-creating a large number of
       directories. The skeleton directory (usually /etc/skel/) is used to copy default files and also sets a umask for the creation.

       The new users home directory will not be removed after logout of the user.

OPTIONS

       silent
	   Don't print informative messages.

       umask=mask
	   The user file-creation mask is set to mask. The default value of mask is 0022.

       skel=/path/to/skel/directory
	   Indicate an alternative skel directory to override the default /etc/skel.

MODULE TYPES PROVIDED

       Only the session module type is provided.

RETURN VALUES

       PAM_BUF_ERR
	   Memory buffer error.

       PAM_CRED_INSUFFICIENT
	   Insufficient credentials to access authentication data.

       PAM_PERM_DENIED
	   Not enough permissions to create the new directory or read the skel directory.

       PAM_USER_UNKNOWN
	   User not known to the underlying authentication module.

       PAM_SUCCESS
	   Environment variables were set.

FILES

       /etc/skel
	   Default skel directory

EXAMPLES

       A sample /etc/pam.d/login file:

	     auth	requisite   pam_securetty.so
	     auth	sufficient  pam_ldap.so
	     auth	required    pam_unix.so
	     auth	required    pam_nologin.so
	     account	sufficient  pam_ldap.so
	     account	required    pam_unix.so
	     password	required    pam_unix.so
	     session	required    pam_mkhomedir.so skel=/etc/skel/ umask=0022
	     session	required    pam_unix.so
	     session	optional    pam_lastlog.so
	     session	optional    pam_mail.so standard

SEE ALSO

       pam.d(5), pam(8).

AUTHOR

       pam_mkhomedir was written by Jason Gunthorpe <jgg@debian.org>.

Linux-PAM Manual						    09/19/2013							  PAM_MKHOMEDIR(8)