man-pages/man8/pam_mkhomedir.8.html
2021-03-31 01:06:50 +01:00

202 lines
3.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PAM_MKHOMEDIR</TITLE>
</HEAD><BODY>
<H1>PAM_MKHOMEDIR</H1>
Section: Linux-PAM Manual (8)<BR>Updated: 05/18/2017<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
pam_mkhomedir - PAM module to create users home directory
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>pam_mkhomedir.so</B> [silent] [umask=<I>mode</I>] [skel=<I>skeldir</I>]
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DD>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.
<P>
The new users home directory will not be removed after logout of the user.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<B>silent</B>
<DL COMPACT><DT id="2"><DD>
Don't print informative messages.
</DL>
<P>
<B>umask=</B><B></B><I>mask</I>
<DL COMPACT><DT id="3"><DD>
The user file-creation mask is set to
<I>mask</I>. The default value of mask is 0022.
</DL>
<P>
<B>skel=</B><B></B><I>/path/to/skel/directory</I>
<DL COMPACT><DT id="4"><DD>
Indicate an alternative
skel
directory to override the default
/etc/skel.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>MODULE TYPES PROVIDED</H2>
<P>
Only the
<B>session</B>
module type is provided.
<A NAME="lbAG">&nbsp;</A>
<H2>RETURN VALUES</H2>
<P>
PAM_BUF_ERR
<DL COMPACT><DT id="5"><DD>
Memory buffer error.
</DL>
<P>
PAM_CRED_INSUFFICIENT
<DL COMPACT><DT id="6"><DD>
Insufficient credentials to access authentication data.
</DL>
<P>
PAM_PERM_DENIED
<DL COMPACT><DT id="7"><DD>
Not enough permissions to create the new directory or read the skel directory.
</DL>
<P>
PAM_USER_UNKNOWN
<DL COMPACT><DT id="8"><DD>
User not known to the underlying authentication module.
</DL>
<P>
PAM_SUCCESS
<DL COMPACT><DT id="9"><DD>
Environment variables were set.
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>FILES</H2>
<P>
/etc/skel
<DL COMPACT><DT id="10"><DD>
Default skel directory
</DL>
<A NAME="lbAI">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
A sample /etc/pam.d/login file:
<P>
<DL COMPACT><DT id="11"><DD>
<PRE>
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
</PRE>
</DL>
<P>
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?5+pam.d">pam.d</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?7+pam">pam</A></B>(7).
<A NAME="lbAK">&nbsp;</A>
<H2>AUTHOR</H2>
<P>
pam_mkhomedir was written by Jason Gunthorpe &lt;<A HREF="mailto:jgg@debian.org">jgg@debian.org</A>&gt;.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="12"><A HREF="#lbAB">NAME</A><DD>
<DT id="13"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="14"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="15"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="16"><A HREF="#lbAF">MODULE TYPES PROVIDED</A><DD>
<DT id="17"><A HREF="#lbAG">RETURN VALUES</A><DD>
<DT id="18"><A HREF="#lbAH">FILES</A><DD>
<DT id="19"><A HREF="#lbAI">EXAMPLES</A><DD>
<DT id="20"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="21"><A HREF="#lbAK">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:14 GMT, March 31, 2021
</BODY>
</HTML>