diff options
Diffstat (limited to 'modules/pam_nologin/pam_nologin.8')
-rw-r--r-- | modules/pam_nologin/pam_nologin.8 | 238 |
1 files changed, 207 insertions, 31 deletions
diff --git a/modules/pam_nologin/pam_nologin.8 b/modules/pam_nologin/pam_nologin.8 index 0ddad026..bb07770f 100644 --- a/modules/pam_nologin/pam_nologin.8 +++ b/modules/pam_nologin/pam_nologin.8 @@ -1,110 +1,286 @@ .\" Title: pam_nologin -.\" 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: 03/02/2009 .\" Manual: Linux-PAM Manual .\" Source: Linux-PAM Manual +.\" Language: English .\" -.TH "PAM_NOLOGIN" "8" "04/16/2008" "Linux-PAM Manual" "Linux\-PAM Manual" +.TH "PAM_NOLOGIN" "8" "03/02/2009" "Linux-PAM Manual" "Linux\-PAM Manual" +.\" ----------------------------------------------------------------- +.\" * (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_nologin - Prevent non-root users from login -.SH "SYNOPSIS" -.HP 15 -\fBpam_nologin\.so\fR [file=\fI/path/nologin\fR] [successok] +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "Name" +pam_nologin \- Prevent non\-root users from login +.SH "Synopsis" +.fam C +.HP \w'\fBpam_nologin\&.so\fR\ 'u +\fBpam_nologin\&.so\fR [file=\fI/path/nologin\fR] [successok] +.fam .SH "DESCRIPTION" .PP pam_nologin is a PAM module that prevents users from logging into the system when -\fI/etc/nologin\fR -exists\. The contents of the -\fI/etc/nologin\fR -file are displayed to the user\. The pam_nologin module has no effect on the root user\'s ability to log in\. +\FC/etc/nologin\F[] +exists\&. The contents of the +\FC/etc/nologin\F[] +file are displayed to the user\&. The pam_nologin module has no effect on the root user\'s ability to log in\&. .SH "OPTIONS" .PP \fBfile=\fR\fB\fI/path/nologin\fR\fR .RS 4 Use this file instead the default -\fI/etc/nologin\fR\. +\FC/etc/nologin\F[]\&. .RE .PP \fBsuccessok\fR .RS 4 -Return PAM_SUCCESS if no file exists, the default is PAM_IGNORE\. +Return PAM_SUCCESS if no file exists, the default is PAM_IGNORE\&. .RE -.SH "MODULE SERVICES PROVIDED" +.SH "MODULE TYPES PROVIDED" .PP The \fBauth\fR and \fBacct\fR -services are supported\. +module types are provided\&. .SH "RETURN VALUES" .PP PAM_AUTH_ERR .RS 4 The user is not root and -\fI/etc/nologin\fR -exists, so the user is not permitted to log in\. +\FC/etc/nologin\F[] +exists, so the user is not permitted to log in\&. .RE .PP PAM_BUF_ERR .RS 4 -Memory buffer error\. +Memory buffer error\&. .RE .PP PAM_IGNORE .RS 4 -This is the default return value\. +This is the default return value\&. .RE .PP PAM_SUCCESS .RS 4 Success: either the user is root or the -\fI/etc/nologin\fR -file does not exist\. +\FC/etc/nologin\F[] +file does not exist\&. .RE .PP PAM_USER_UNKNOWN .RS 4 -User not known to the underlying authentication module\. +User not known to the underlying authentication module\&. .RE .SH "EXAMPLES" .PP The suggested usage for -\fI/etc/pam\.d/login\fR +\FC/etc/pam\&.d/login\F[] is: .sp +.if n \{\ .RS 4 +.\} +.fam C +.ps -1 .nf -auth required pam_nologin\.so +.if t \{\ +.sp -1 +.\} +.BB lightgray adjust-for-leading-newline +.sp -1 + +auth required pam_nologin\&.so +.EB lightgray adjust-for-leading-newline +.if t \{\ +.sp 1 +.\} .fi +.fam +.ps +1 +.if n \{\ .RE +.\} .sp .SH "NOTES" .PP -In order to make this module effective, all login methods should be secured by it\. It should be used as a +In order to make this module effective, all login methods should be secured by it\&. It should be used as a \fIrequired\fR method listed before any \fIsufficient\fR -methods in order to get standard Unix nologin semantics\. Note, the use of +methods in order to get standard Unix nologin semantics\&. Note, the use of \fBsuccessok\fR module argument causes the module to return \fIPAM_SUCCESS\fR and as such would break such a configuration \- failing \fIsufficient\fR modules would lead to a successful login because the nologin module -\fIsucceeded\fR\. +\fIsucceeded\fR\&. .SH "SEE ALSO" .PP \fBnologin\fR(5), \fBpam.conf\fR(5), -\fBpam.d\fR(8), +\fBpam.d\fR(5), \fBpam\fR(8) .SH "AUTHOR" .PP -pam_nologin was written by Michael K\. Johnson <johnsonm@redhat\.com>\. +pam_nologin was written by Michael K\&. Johnson <johnsonm@redhat\&.com>\&. |