Debian Codegraph @

upstream/debian-unstable/man8/pam_shells.8

raw
1 '\" t
2 .\" Title: pam_shells
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_SHELLS" "8" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pam_shells \- PAM module to check for valid login shell
32 .SH "SYNOPSIS"
33 .HP \w'\fBpam_shells\&.so\fR\ 'u
34 \fBpam_shells\&.so\fR
35 .SH "DESCRIPTION"
36 .PP
37 pam_shells is a PAM module that only allows access to the system if the user\*(Aqs shell is listed in
38 /etc/shells\&.
39 .PP
40 It also checks if needed files (e\&.g\&.
41 /etc/shells) are plain files and not world writable\&.
42 .SH "OPTIONS"
43 .PP
44 This module does not recognise any options\&.
45 .SH "MODULE TYPES PROVIDED"
46 .PP
47 The
48 \fBauth\fR
49 and
50 \fBaccount\fR
51 module types are provided\&.
52 .SH "RETURN VALUES"
53 .PP
54 PAM_AUTH_ERR
55 .RS 4
56 Access to the system was denied\&.
57 .RE
58 .PP
59 PAM_SUCCESS
60 .RS 4
61 The user\*(Aqs login shell was listed as valid shell in
62 /etc/shells\&.
63 .RE
64 .PP
65 PAM_USER_UNKNOWN
66 .RS 4
67 The user does not exist or the user\*(Aqs login shell could not be determined\&.
68 .RE
69 .PP
70 PAM_SERVICE_ERR
71 .RS 4
72 The module was not able to get the name of the user\&.
73 .RE
74 .SH "EXAMPLES"
75 .PP
76 .if n \{\
77 .RS 4
78 .\}
79 .nf
80 auth required pam_shells\&.so
81
82 .fi
83 .if n \{\
84 .RE
85 .\}
86 .sp
87 .SH "SEE ALSO"
88 .PP
89 \fBshells\fR(5),
90 \fBpam.conf\fR(5),
91 \fBpam.d\fR(5),
92 \fBpam\fR(7)
93 .SH "AUTHOR"
94 .PP
95 pam_shells was written by Erik Troan <ewt@redhat\&.com>\&.