modules/pam_mkhomedir/pam_mkhomedir.8

   1 .\"     Title: pam_mkhomedir
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 08/17/2012
   5 .\"    Manual: Linux-PAM Manual
   6 .\"    Source: Linux-PAM Manual
   7 .\"  Language: English
   8 .\"
   9 .TH "PAM_MKHOMEDIR" "8" "08/17/2012" "Linux-PAM Manual" "Linux-PAM Manual"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 pam_mkhomedir \- PAM module to create users home directory
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBpam_mkhomedir\&.so\fR\ 'u
 174 \fBpam_mkhomedir\&.so\fR [silent] [umask=\fImode\fR] [skel=\fIskeldir\fR]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 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
 179 \FC/etc/skel/\F[]) is used to copy default files and also sets a umask for the creation\&.
 180 .PP
 181 The new users home directory will not be removed after logout of the user\&.
 182 .SH "OPTIONS"
 183 .PP
 184 \fBsilent\fR
 185 .RS 4
 186 Don\'t print informative messages\&.
 187 .RE
 188 .PP
 189 \fBumask=\fR\fB\fImask\fR\fR
 190 .RS 4
 191 The user file\-creation mask is set to
 192 \fImask\fR\&. The default value of mask is 0022\&.
 193 .RE
 194 .PP
 195 \fBskel=\fR\fB\fI/path/to/skel/directory\fR\fR
 196 .RS 4
 197 Indicate an alternative
 198 \FCskel\F[]
 199 directory to override the default
 200 \FC/etc/skel\F[]\&.
 201 .RE
 202 .SH "MODULE TYPES PROVIDED"
 203 .PP
 204 Only the
 205 \fBsession\fR
 206 module type is provided\&.
 207 .SH "RETURN VALUES"
 208 .PP
 209 PAM_BUF_ERR
 210 .RS 4
 211 Memory buffer error\&.
 212 .RE
 213 .PP
 214 PAM_CRED_INSUFFICIENT
 215 .RS 4
 216 Insufficient credentials to access authentication data\&.
 217 .RE
 218 .PP
 219 PAM_PERM_DENIED
 220 .RS 4
 221 Not enough permissions to create the new directory or read the skel directory\&.
 222 .RE
 223 .PP
 224 PAM_USER_UNKNOWN
 225 .RS 4
 226 User not known to the underlying authentication module\&.
 227 .RE
 228 .PP
 229 PAM_SUCCESS
 230 .RS 4
 231 Environment variables were set\&.
 232 .RE
 233 .SH "FILES"
 234 .PP
 235 \FC/etc/skel\F[]
 236 .RS 4
 237 Default skel directory
 238 .RE
 239 .SH "EXAMPLES"
 240 .PP
 241 A sample /etc/pam\&.d/login file:
 242 .sp
 243 .if n \{\
 244 .RS 4
 245 .\}
 246 .fam C
 247 .ps -1
 248 .nf
 249 .if t \{\
 250 .sp -1
 251 .\}
 252 .BB lightgray adjust-for-leading-newline
 253 .sp -1
 254
 255   auth       requisite   pam_securetty\&.so
 256   auth       sufficient  pam_ldap\&.so
 257   auth       required    pam_unix\&.so
 258   auth       required    pam_nologin\&.so
 259   account    sufficient  pam_ldap\&.so
 260   account    required    pam_unix\&.so
 261   password   required    pam_unix\&.so
 262   session    required    pam_mkhomedir\&.so skel=/etc/skel/ umask=0022
 263   session    required    pam_unix\&.so
 264   session    optional    pam_lastlog\&.so
 265   session    optional    pam_mail\&.so standard
 266
 267 .EB lightgray adjust-for-leading-newline
 268 .if t \{\
 269 .sp 1
 270 .\}
 271 .fi
 272 .fam
 273 .ps +1
 274 .if n \{\
 275 .RE
 276 .\}
 277 .sp
 278 .SH "SEE ALSO"
 279 .PP
 280
 281 \fBpam.d\fR(5),
 282 \fBpam\fR(8)\&.
 283 .SH "AUTHOR"
 284 .PP
 285 pam_mkhomedir was written by Jason Gunthorpe <jgg@debian\&.org>\&.