summaryrefslogtreecommitdiff
path: root/modules/pam_succeed_if/pam_succeed_if.8
diff options
context:
space:
mode:
Diffstat (limited to 'modules/pam_succeed_if/pam_succeed_if.8')
-rw-r--r--modules/pam_succeed_if/pam_succeed_if.8184
1 files changed, 116 insertions, 68 deletions
diff --git a/modules/pam_succeed_if/pam_succeed_if.8 b/modules/pam_succeed_if/pam_succeed_if.8
index 30af456c..45155850 100644
--- a/modules/pam_succeed_if/pam_succeed_if.8
+++ b/modules/pam_succeed_if/pam_succeed_if.8
@@ -1,47 +1,57 @@
.\" Title: pam_succeed_if
.\" Author:
-.\" Generator: DocBook XSL Stylesheets vsnapshot_2006\-08\-24_0226 <http://docbook.sf.net/>
-.\" Date: 08/31/2006
-.\" Manual: Linux\-PAM
-.\" Source: Linux\-PAM
+.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
+.\" Date: 01/07/2008
+.\" Manual: Linux-PAM
+.\" Source: Linux-PAM
.\"
-.TH "PAM_SUCCEED_IF" "8" "08/31/2006" "Linux\-PAM" "Linux\-PAM"
+.TH "PAM_SUCCEED_IF" "8" "01/07/2008" "Linux-PAM" "Linux\-PAM"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-pam_succeed_if \- test account characteristics
+pam_succeed_if - test account characteristics
.SH "SYNOPSIS"
.HP 18
-\fBpam_succeed_if.so\fR [\fIflag\fR...] [\fIcondition\fR...]
+\fBpam_succeed_if\.so\fR [\fIflag\fR...] [\fIcondition\fR...]
.SH "DESCRIPTION"
.PP
-pam_succeed_if.so is designed to succeed or fail authentication based on characteristics of the account belonging to the user being authenticated. One use is to select whether to load other modules based on this test.
+pam_succeed_if\.so is designed to succeed or fail authentication based on characteristics of the account belonging to the user being authenticated\. One use is to select whether to load other modules based on this test\.
.PP
-The module should be given one or more conditions as module arguments, and authentication will succeed only if all of the conditions are met.
+The module should be given one or more conditions as module arguments, and authentication will succeed only if all of the conditions are met\.
.SH "OPTIONS"
.PP
The following
\fIflag\fRs are supported:
-.TP 3n
+.PP
\fBdebug\fR
-Turns on debugging messages sent to syslog.
-.TP 3n
+.RS 4
+Turns on debugging messages sent to syslog\.
+.RE
+.PP
\fBuse_uid\fR
-Evaluate conditions using the account of the user whose UID the application is running under instead of the user being authenticated.
-.TP 3n
+.RS 4
+Evaluate conditions using the account of the user whose UID the application is running under instead of the user being authenticated\.
+.RE
+.PP
\fBquiet\fR
-Don't log failure or success to the system log.
-.TP 3n
+.RS 4
+Don\'t log failure or success to the system log\.
+.RE
+.PP
\fBquiet_fail\fR
-Don't log failure to the system log.
-.TP 3n
+.RS 4
+Don\'t log failure to the system log\.
+.RE
+.PP
\fBquiet_success\fR
-Don't log success to the system log.
+.RS 4
+Don\'t log success to the system log\.
+.RE
.PP
-\fICondition\fRs are three words: a field, a test, and a value to test for.
+\fICondition\fRs are three words: a field, a test, and a value to test for\.
.PP
Available fields are
\fIuser\fR,
@@ -51,85 +61,123 @@ Available fields are
\fIhome\fR
and
\fIservice\fR:
-.TP 3n
+.PP
\fBfield < number\fR
-Field has a value numerically less than number.
-.TP 3n
+.RS 4
+Field has a value numerically less than number\.
+.RE
+.PP
\fBfield <= number\fR
-Field has a value numerically less than or equal to number.
-.TP 3n
+.RS 4
+Field has a value numerically less than or equal to number\.
+.RE
+.PP
\fBfield eq number\fR
-Field has a value numerically less equal to number.
-.TP 3n
+.RS 4
+Field has a value numerically equal to number\.
+.RE
+.PP
\fBfield >= number\fR
-Field has a value numerically greater than or equal to number.
-.TP 3n
+.RS 4
+Field has a value numerically greater than or equal to number\.
+.RE
+.PP
\fBfield > number\fR
-Field has a value numerically greater than number.
-.TP 3n
+.RS 4
+Field has a value numerically greater than number\.
+.RE
+.PP
\fBfield ne number\fR
-Field has a value numerically different from number.
-.TP 3n
+.RS 4
+Field has a value numerically different from number\.
+.RE
+.PP
\fBfield = string\fR
-Field exactly matches the given string.
-.TP 3n
+.RS 4
+Field exactly matches the given string\.
+.RE
+.PP
\fBfield != string\fR
-Field does not match the given string.
-.TP 3n
+.RS 4
+Field does not match the given string\.
+.RE
+.PP
\fBfield =~ glob\fR
-Field matches the given glob.
-.TP 3n
+.RS 4
+Field matches the given glob\.
+.RE
+.PP
\fBfield !~ glob\fR
-Field does not match the given glob.
-.TP 3n
-\fBfield in item:item:...\fR
-Field is contained in the list of items separated by colons.
-.TP 3n
-\fBfield notin item:item:...\fR
-Field is not contained in the list of items separated by colons.
-.TP 3n
+.RS 4
+Field does not match the given glob\.
+.RE
+.PP
+\fBfield in item:item:\.\.\.\fR
+.RS 4
+Field is contained in the list of items separated by colons\.
+.RE
+.PP
+\fBfield notin item:item:\.\.\.\fR
+.RS 4
+Field is not contained in the list of items separated by colons\.
+.RE
+.PP
\fBuser ingroup group\fR
-User is in given group.
-.TP 3n
+.RS 4
+User is in given group\.
+.RE
+.PP
\fBuser notingroup group\fR
-User is not in given group.
-.TP 3n
+.RS 4
+User is not in given group\.
+.RE
+.PP
\fBuser innetgr netgroup\fR
-(user,host) is in given netgroup.
-.TP 3n
+.RS 4
+(user,host) is in given netgroup\.
+.RE
+.PP
\fBuser notinnetgr group\fR
-(user,host) is not in given netgroup.
+.RS 4
+(user,host) is not in given netgroup\.
+.RE
.SH "MODULE SERVICES PROVIDED"
.PP
-All services are supported.
+All services are supported\.
.SH "RETURN VALUES"
-.TP 3n
+.PP
PAM_SUCCESS
-The condition was true.
-.TP 3n
+.RS 4
+The condition was true\.
+.RE
+.PP
PAM_AUTH_ERR
-The condition was false.
-.TP 3n
+.RS 4
+The condition was false\.
+.RE
+.PP
PAM_SERVICE_ERR
-A service error occured or the arguments can't be parsed as numbers.
+.RS 4
+A service error occured or the arguments can\'t be parsed as numbers\.
+.RE
.SH "EXAMPLES"
.PP
To emulate the behaviour of
\fIpam_wheel\fR, except there is no fallback to group 0:
.sp
-.RS 3n
+.RS 4
.nf
-auth required pam_succeed_if.so quiet user ingroup wheel
+auth required pam_succeed_if\.so quiet user ingroup wheel
.fi
.RE
.PP
-Given that the type matches, only loads the othermodule rule if the UID is over 500. Adjust the number after default to skip several rules.
+Given that the type matches, only loads the othermodule rule if the UID is over 500\. Adjust the number after default to skip several rules\.
.sp
-.RS 3n
+.RS 4
.nf
-type [default=1 success=ignore] pam_succeed_if.so quiet uid > 500
-type required othermodule.so arguments...
+type [default=1 success=ignore] pam_succeed_if\.so quiet uid > 500
+type required othermodule\.so arguments\.\.\.
.fi
.RE
@@ -140,4 +188,4 @@ type required othermodule.so arguments...
\fBpam\fR(8)
.SH "AUTHOR"
.PP
-Nalin Dahyabhai <nalin@redhat.com>
+Nalin Dahyabhai <nalin@redhat\.com>