modules/pam_exec/pam_exec.8

   1 .\"     Title: pam_exec
   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_EXEC" "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_exec \- PAM module which calls an external command
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBpam_exec\&.so\fR\ 'u
 174 \fBpam_exec\&.so\fR [debug] [expose_authtok] [seteuid] [quiet] [log=\fIfile\fR] \fIcommand\fR [\fI\&.\&.\&.\fR]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 pam_exec is a PAM module that can be used to run an external command\&.
 179 .PP
 180 The child\'s environment is set to the current PAM environment list, as returned by
 181 \fBpam_getenvlist\fR(3)
 182 In addition, the following PAM items are exported as environment variables:
 183 \fIPAM_RHOST\fR,
 184 \fIPAM_RUSER\fR,
 185 \fIPAM_SERVICE\fR,
 186 \fIPAM_TTY\fR,
 187 \fIPAM_USER\fR
 188 and
 189 \fIPAM_TYPE\fR, which contains one of the module types:
 190 \fBaccount\fR,
 191 \fBauth\fR,
 192 \fBpassword\fR,
 193 \fBopen_session\fR
 194 and
 195 \fBclose_session\fR\&.
 196 .PP
 197 Commands called by pam_exec need to be aware of that the user can have controll over the environment\&.
 198 .SH "OPTIONS"
 199 .PP
 200 .PP
 201 \fBdebug\fR
 202 .RS 4
 203 Print debug information\&.
 204 .RE
 205 .PP
 206 \fBexpose_authtok\fR
 207 .RS 4
 208 During authentication the calling command can read the password from
 209 \fBstdin\fR(3)\&.
 210 .RE
 211 .PP
 212 \fBlog=\fR\fB\fIfile\fR\fR
 213 .RS 4
 214 The output of the command is appended to
 215 \FCfile\F[]
 216 .RE
 217 .PP
 218 \fBquiet\fR
 219 .RS 4
 220 Per default pam_exec\&.so will echo the exit status of the external command if it fails\&. Specifying this option will suppress the message\&.
 221 .RE
 222 .PP
 223 \fBseteuid\fR
 224 .RS 4
 225 Per default pam_exec\&.so will execute the external command with the real user ID of the calling process\&. Specifying this option means the command is run with the effective user ID\&.
 226 .RE
 227 .SH "MODULE TYPES PROVIDED"
 228 .PP
 229 All module types (\fBauth\fR,
 230 \fBaccount\fR,
 231 \fBpassword\fR
 232 and
 233 \fBsession\fR) are provided\&.
 234 .SH "RETURN VALUES"
 235 .PP
 236 .PP
 237 PAM_SUCCESS
 238 .RS 4
 239 The external command was run successfully\&.
 240 .RE
 241 .PP
 242 PAM_SERVICE_ERR
 243 .RS 4
 244 No argument or a wrong number of arguments were given\&.
 245 .RE
 246 .PP
 247 PAM_SYSTEM_ERR
 248 .RS 4
 249 A system error occurred or the command to execute failed\&.
 250 .RE
 251 .PP
 252 PAM_IGNORE
 253 .RS 4
 254
 255 \fBpam_setcred\fR
 256 was called, which does not execute the command\&.
 257 .RE
 258 .SH "EXAMPLES"
 259 .PP
 260 Add the following line to
 261 \FC/etc/pam\&.d/passwd\F[]
 262 to rebuild the NIS database after each local password change:
 263 .sp
 264 .if n \{\
 265 .RS 4
 266 .\}
 267 .fam C
 268 .ps -1
 269 .nf
 270 .if t \{\
 271 .sp -1
 272 .\}
 273 .BB lightgray adjust-for-leading-newline
 274 .sp -1
 275
 276         password optional pam_exec\&.so seteuid /usr/bin/make \-C /var/yp
 277
 278 .EB lightgray adjust-for-leading-newline
 279 .if t \{\
 280 .sp 1
 281 .\}
 282 .fi
 283 .fam
 284 .ps +1
 285 .if n \{\
 286 .RE
 287 .\}
 288 .sp
 289 This will execute the command
 290 .sp
 291 .if n \{\
 292 .RS 4
 293 .\}
 294 .fam C
 295 .ps -1
 296 .nf
 297 .BB lightgray
 298 make \-C /var/yp
 299 .EB lightgray
 300 .fi
 301 .fam
 302 .ps +1
 303 .if n \{\
 304 .RE
 305 .\}
 306 .sp
 307 with effective user ID\&.
 308 .SH "SEE ALSO"
 309 .PP
 310
 311 \fBpam.conf\fR(5),
 312 \fBpam.d\fR(5),
 313 \fBpam\fR(8)
 314 .SH "AUTHOR"
 315 .PP
 316 pam_exec was written by Thorsten Kukuk <kukuk@thkukuk\&.de>\&.