summaryrefslogtreecommitdiff
path: root/Linux-PAM/modules/pam_exec/pam_exec.8
diff options
context:
space:
mode:
Diffstat (limited to 'Linux-PAM/modules/pam_exec/pam_exec.8')
-rw-r--r--Linux-PAM/modules/pam_exec/pam_exec.8116
1 files changed, 116 insertions, 0 deletions
diff --git a/Linux-PAM/modules/pam_exec/pam_exec.8 b/Linux-PAM/modules/pam_exec/pam_exec.8
new file mode 100644
index 00000000..9ac2ccbb
--- /dev/null
+++ b/Linux-PAM/modules/pam_exec/pam_exec.8
@@ -0,0 +1,116 @@
+.\" Title: pam_exec
+.\" Author:
+.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
+.\" Date: 02/04/2008
+.\" Manual: Linux-PAM Manual
+.\" Source: Linux-PAM Manual
+.\"
+.TH "PAM_EXEC" "8" "02/04/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>\.