summaryrefslogtreecommitdiff
path: root/modules/pam_exec/pam_exec.8
blob: da7c7830a4d6791e037b33a5f4099a669418e4a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
.\"     Title: pam_exec
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
.\"      Date: 04/16/2008
.\"    Manual: Linux-PAM Manual
.\"    Source: Linux-PAM Manual
.\"
.TH "PAM_EXEC" "8" "04/16/2008" "Linux-PAM Manual" "Linux\-PAM Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
pam_exec - PAM module which calls an external command
.SH "SYNOPSIS"
.HP 12
\fBpam_exec\.so\fR [debug] [seteuid] [quiet] [log=\fIfile\fR] \fIcommand\fR [\fI\.\.\.\fR]
.SH "DESCRIPTION"
.PP
pam_exec is a PAM module that can be used to run an external command\.
.PP
The child\'s environment is set to the current PAM environment list, as returned by
\fBpam_getenvlist\fR(3)
In addition, the following PAM items are exported as environment variables:
\fIPAM_RHOST\fR,
\fIPAM_RUSER\fR,
\fIPAM_SERVICE\fR,
\fIPAM_TTY\fR, and
\fIPAM_USER\fR\.
.SH "OPTIONS"
.PP
.PP
\fBdebug\fR
.RS 4
Print debug information\.
.RE
.PP
\fBlog=\fR\fB\fIfile\fR\fR
.RS 4
The output of the command is appended to
\fIfile\fR
.RE
.PP
\fBquiet\fR
.RS 4
Per default pam_exec\.so will echo the exit status of the external command if it fails\. Specifying this option will suppress the message\.
.RE
.PP
\fBseteuid\fR
.RS 4
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\.
.RE
.SH "MODULE SERVICES PROVIDED"
.PP
The services
\fBauth\fR,
\fBaccount\fR,
\fBpassword\fR
and
\fBsession\fR
are supported\.
.SH "RETURN VALUES"
.PP
.PP
PAM_SUCCESS
.RS 4
The external command runs successfull\.
.RE
.PP
PAM_SERVICE_ERR
.RS 4
No argument or a wrong number of arguments were given\.
.RE
.PP
PAM_SYSTEM_ERR
.RS 4
A system error occured or the command to execute failed\.
.RE
.PP
PAM_IGNORE
.RS 4

\fBpam_setcred\fR
was called, which does not execute the command\.
.RE
.SH "EXAMPLES"
.PP
Add the following line to
\fI/etc/pam\.d/passwd\fR
to rebuild the NIS database after each local password change:
.sp
.RS 4
.nf
        passwd optional pam_exec\.so seteuid make \-C /var/yp
      
.fi
.RE
.sp
This will execute the command
.sp
.RS 4
.nf
make \-C /var/yp
.fi
.RE
.sp
with effective user ID\.
.SH "SEE ALSO"
.PP

\fBpam.conf\fR(5),
\fBpam.d\fR(8),
\fBpam\fR(8)
.SH "AUTHOR"
.PP
pam_exec was written by Thorsten Kukuk <kukuk@thkukuk\.de>\.