diff options
Diffstat (limited to 'modules/pam_succeed_if/pam_succeed_if.8')
| -rw-r--r-- | modules/pam_succeed_if/pam_succeed_if.8 | 288 |
1 files changed, 243 insertions, 45 deletions
diff --git a/modules/pam_succeed_if/pam_succeed_if.8 b/modules/pam_succeed_if/pam_succeed_if.8 index 65c710e8..5eb05164 100644 --- a/modules/pam_succeed_if/pam_succeed_if.8 +++ b/modules/pam_succeed_if/pam_succeed_if.8 @@ -1,25 +1,183 @@ .\" Title: pam_succeed_if -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/> -.\" Date: 04/16/2008 +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> +.\" Date: 06/16/2009 .\" Manual: Linux-PAM .\" Source: Linux-PAM +.\" Language: English .\" -.TH "PAM_SUCCEED_IF" "8" "04/16/2008" "Linux-PAM" "Linux\-PAM" +.TH "PAM_SUCCEED_IF" "8" "06/16/2009" "Linux-PAM" "Linux\-PAM" +.\" ----------------------------------------------------------------- +.\" * (re)Define some macros +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" toupper - uppercase a string (locale-aware) +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de toupper +.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ +\\$* +.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH-xref - format a cross-reference to an SH section +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de SH-xref +.ie n \{\ +.\} +.toupper \\$* +.el \{\ +\\$* +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SH - level-one heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SH +.\" put an extra blank line of space above the head in non-TTY output +.if t \{\ +.sp 1 +.\} +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[an-margin]u +.ti 0 +.HTML-TAG ".NH \\n[an-level]" +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +\." make the size of the head bigger +.ps +3 +.ft B +.ne (2v + 1u) +.ie n \{\ +.\" if n (TTY output), use uppercase +.toupper \\$* +.\} +.el \{\ +.nr an-break-flag 0 +.\" if not n (not TTY), use normal case (not uppercase) +\\$1 +.in \\n[an-margin]u +.ti 0 +.\" if not n (not TTY), put a border/line under subheading +.sp -.6 +\l'\n(.lu' +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" SS - level-two heading that works better for non-TTY output +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de1 SS +.sp \\n[PD]u +.nr an-level 1 +.set-an-margin +.nr an-prevailing-indent \\n[IN] +.fi +.in \\n[IN]u +.ti \\n[SN]u +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.ps \\n[PS-SS]u +\." make the size of the head bigger +.ps +2 +.ft B +.ne (2v + 1u) +.if \\n[.$] \&\\$* +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BB/BE - put background/screen (filled box) around block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BB +.if t \{\ +.sp -.5 +.br +.in +2n +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EB +.if t \{\ +.if "\\$2"adjust-for-leading-newline" \{\ +.sp -1 +.\} +.br +.di +.in +.ll +.gcolor +.nr BW \\n(.lu-\\n(.i +.nr BH \\n(dn+.5v +.ne \\n(BHu+.5v +.ie "\\$2"adjust-for-leading-newline" \{\ +\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.el \{\ +\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] +.\} +.in 0 +.sp -.5v +.nf +.BX +.in +.sp .5v +.fi +.\} +.. +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" BM/EM - put colored marker in margin next to block of text +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.de BM +.if t \{\ +.br +.ll -2n +.gcolor red +.di BX +.\} +.. +.de EM +.if t \{\ +.br +.di +.ll +.gcolor +.nr BH \\n(dn +.ne \\n(BHu +\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] +.in 0 +.nf +.BX +.in +.fi +.\} +.. +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l -.SH "NAME" -pam_succeed_if - test account characteristics -.SH "SYNOPSIS" -.HP 18 -\fBpam_succeed_if\.so\fR [\fIflag\fR...] [\fIcondition\fR...] +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "Name" +pam_succeed_if \- test account characteristics +.SH "Synopsis" +.fam C +.HP \w'\fBpam_succeed_if\&.so\fR\ 'u +\fBpam_succeed_if\&.so\fR [\fIflag\fR...] [\fIcondition\fR...] +.fam .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 @@ -27,31 +185,31 @@ The following .PP \fBdebug\fR .RS 4 -Turns on debugging messages sent to syslog\. +Turns on debugging messages sent to syslog\&. .RE .PP \fBuse_uid\fR .RS 4 -Evaluate conditions using the account of the user whose UID the application is running under instead of the user being authenticated\. +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 .RS 4 -Don\'t log failure or success to the system log\. +Don\'t log failure or success to the system log\&. .RE .PP \fBquiet_fail\fR .RS 4 -Don\'t log failure to the system log\. +Don\'t log failure to the system log\&. .RE .PP \fBquiet_success\fR .RS 4 -Don\'t log success to the system log\. +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, @@ -64,123 +222,163 @@ and .PP \fBfield < number\fR .RS 4 -Field has a value numerically less than number\. +Field has a value numerically less than number\&. .RE .PP \fBfield <= number\fR .RS 4 -Field has a value numerically less than or equal to number\. +Field has a value numerically less than or equal to number\&. .RE .PP \fBfield eq number\fR .RS 4 -Field has a value numerically equal to number\. +Field has a value numerically equal to number\&. .RE .PP \fBfield >= number\fR .RS 4 -Field has a value numerically greater than or equal to number\. +Field has a value numerically greater than or equal to number\&. .RE .PP \fBfield > number\fR .RS 4 -Field has a value numerically greater than number\. +Field has a value numerically greater than number\&. .RE .PP \fBfield ne number\fR .RS 4 -Field has a value numerically different from number\. +Field has a value numerically different from number\&. .RE .PP \fBfield = string\fR .RS 4 -Field exactly matches the given string\. +Field exactly matches the given string\&. .RE .PP \fBfield != string\fR .RS 4 -Field does not match the given string\. +Field does not match the given string\&. .RE .PP \fBfield =~ glob\fR .RS 4 -Field matches the given glob\. +Field matches the given glob\&. .RE .PP \fBfield !~ glob\fR .RS 4 -Field does not match the given glob\. +Field does not match the given glob\&. .RE .PP -\fBfield in item:item:\.\.\.\fR +\fBfield in item:item:\&.\&.\&.\fR .RS 4 -Field is contained in the list of items separated by colons\. +Field is contained in the list of items separated by colons\&. .RE .PP -\fBfield notin item:item:\.\.\.\fR +\fBfield notin item:item:\&.\&.\&.\fR .RS 4 -Field is not contained in the list of items separated by colons\. +Field is not contained in the list of items separated by colons\&. .RE .PP \fBuser ingroup group\fR .RS 4 -User is in given group\. +User is in given group\&. .RE .PP \fBuser notingroup group\fR .RS 4 -User is not in given group\. +User is not in given group\&. .RE .PP \fBuser innetgr netgroup\fR .RS 4 -(user,host) is in given netgroup\. +(user,host) is in given netgroup\&. .RE .PP \fBuser notinnetgr group\fR .RS 4 -(user,host) is not in given netgroup\. +(user,host) is not in given netgroup\&. .RE -.SH "MODULE SERVICES PROVIDED" +.SH "MODULE TYPES PROVIDED" .PP -All services are supported\. +All module types (\fBaccount\fR, +\fBauth\fR, +\fBpassword\fR +and +\fBsession\fR) are provided\&. .SH "RETURN VALUES" .PP PAM_SUCCESS .RS 4 -The condition was true\. +The condition was true\&. .RE .PP PAM_AUTH_ERR .RS 4 -The condition was false\. +The condition was false\&. .RE .PP PAM_SERVICE_ERR .RS 4 -A service error occured or the arguments can\'t be parsed as numbers\. +A service error occurred or the arguments can\'t be parsed correctly\&. .RE .SH "EXAMPLES" .PP To emulate the behaviour of \fIpam_wheel\fR, except there is no fallback to group 0: .sp +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf -auth required pam_succeed_if\.so quiet user ingroup wheel +.if t \{\ +.sp -1 +.\} +.BB lightgray adjust-for-leading-newline +.sp -1 + +auth required pam_succeed_if\&.so quiet user ingroup wheel +.EB lightgray adjust-for-leading-newline +.if t \{\ +.sp 1 +.\} .fi +.fam +.ps +1 +.if n \{\ .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 +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf -type [default=1 success=ignore] pam_succeed_if\.so quiet uid > 500 -type required othermodule\.so arguments\.\.\. +.if t \{\ +.sp -1 +.\} +.BB lightgray adjust-for-leading-newline +.sp -1 + +type [default=1 success=ignore] pam_succeed_if\&.so quiet uid > 500 +type required othermodule\&.so arguments\&.\&.\&. +.EB lightgray adjust-for-leading-newline +.if t \{\ +.sp 1 +.\} .fi +.fam +.ps +1 +.if n \{\ .RE +.\} .SH "SEE ALSO" .PP @@ -188,4 +386,4 @@ type required othermodule\.so arguments\.\.\. \fBpam\fR(8) .SH "AUTHOR" .PP -Nalin Dahyabhai <nalin@redhat\.com> +Nalin Dahyabhai <nalin@redhat\&.com> |