Debian Codegraph @

upstream/opensuse-tumbleweed/man8/pam_access.8

raw
1 '\" t
2 .\" Title: pam_access
3 .\" Author: [see the "AUTHORS" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_ACCESS" "8" "05/26/2026" "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_access \- PAM module for logdaemon style login access control
32 .SH "SYNOPSIS"
33 .HP \w'\fBpam_access\&.so\fR\ 'u
34 \fBpam_access\&.so\fR [debug] [noaudit] [nodefgroup] [nodns] [quiet_log] [accessfile=\fIfile\fR] [fieldsep=\fIsep\fR] [listsep=\fIsep\fR]
35 .SH "DESCRIPTION"
36 .PP
37 The pam_access PAM module is mainly for access management\&. It provides logdaemon style login access control based on login names, host or domain names, internet addresses or network numbers, or on terminal line names, X
38 \fI$DISPLAY\fR
39 values, or PAM service names in case of non\-networked logins\&.
40 .PP
41 By default rules for access management are taken from config file
42 /etc/security/access\&.conf
43 or, if that one is not present, the file
44 /usr/etc/security/access\&.conf\&. These settings can be overruled by setting in a config file explicitly specified with the
45 \fBaccessfile\fR
46 option\&. Then individual
47 *\&.conf
48 files from the
49 /etc/security/access\&.d/
50 and
51 /usr/etc/security/access\&.d
52 directories are read\&. If
53 /etc/security/access\&.d/@filename@\&.conf
54 exists, then
55 /usr/etc/security/access\&.d/@filename@\&.conf
56 will not be used\&. All
57 access\&.d/*\&.conf
58 files are sorted by their
59 @filename@\&.conf
60 in lexicographic order regardless of which of the directories they reside in\&. The effect of the individual files is the same as if all the files were concatenated together in the order of parsing\&. This means that once a pattern is matched in some file no further files are parsed\&. If a config file is explicitly specified with the
61 \fBaccessfile\fR
62 option the files in the above directories are not parsed\&.
63 .PP
64 If Linux PAM is compiled with audit support the module will report when it denies access based on origin (host, tty, etc\&.)\&.
65 .SH "OPTIONS"
66 .PP
67 accessfile=/path/to/access\&.conf
68 .RS 4
69 Indicate an alternative
70 access\&.conf
71 style configuration file to override the default\&. This can be useful when different services need different access lists\&.
72 .RE
73 .PP
74 debug
75 .RS 4
76 A lot of debug information is printed with
77 \fBsyslog\fR(3)\&.
78 .RE
79 .PP
80 noaudit
81 .RS 4
82 Do not report logins from disallowed hosts and ttys to the audit subsystem\&.
83 .RE
84 .PP
85 nodefgroup
86 .RS 4
87 User tokens which are not enclosed in parentheses will not be matched against the group database\&. The backwards compatible default is to try the group database match even for tokens not enclosed in parentheses\&.
88 .RE
89 .PP
90 nodns
91 .RS 4
92 Do not try to resolve tokens as hostnames, only IPv4 and IPv6 addresses will be resolved\&. Which means to allow login from a remote host, the IP addresses need to be specified in
93 access\&.conf\&.
94 .RE
95 .PP
96 quiet_log
97 .RS 4
98 Do not log denials with
99 \fBsyslog\fR(3)\&.
100 .RE
101 .PP
102 fieldsep=separators
103 .RS 4
104 This option modifies the field separator character that pam_access will recognize when parsing the access configuration file\&. For example:
105 \fBfieldsep=|\fR
106 will cause the default `:\*(Aq character to be treated as part of a field value and `|\*(Aq becomes the field separator\&. Doing this may be useful in conjunction with a system that wants to use pam_access with X based applications, since the
107 \fBPAM_TTY\fR
108 item is likely to be of the form "hostname:0" which includes a `:\*(Aq character in its value\&. But you should not need this\&.
109 .RE
110 .PP
111 listsep=separators
112 .RS 4
113 This option modifies the list separator character that pam_access will recognize when parsing the access configuration file\&. For example:
114 \fBlistsep=,\fR
115 will cause the default ` \*(Aq (space) and `\et\*(Aq (tab) characters to be treated as part of a list element value and `,\*(Aq becomes the only list element separator\&. Doing this may be useful on a system with group information obtained from a Windows domain, where the default built\-in groups "Domain Users", "Domain Admins" contain a space\&.
116 .RE
117 .SH "MODULE TYPES PROVIDED"
118 .PP
119 All module types (\fBauth\fR,
120 \fBaccount\fR,
121 \fBpassword\fR
122 and
123 \fBsession\fR) are provided\&.
124 .SH "RETURN VALUES"
125 .PP
126 PAM_SUCCESS
127 .RS 4
128 Access was granted\&.
129 .RE
130 .PP
131 PAM_PERM_DENIED
132 .RS 4
133 Access was not granted\&.
134 .RE
135 .PP
136 PAM_IGNORE
137 .RS 4
138 \fBpam_setcred\fR
139 was called which does nothing\&.
140 .RE
141 .PP
142 PAM_ABORT
143 .RS 4
144 Not all relevant data or options could be gotten\&.
145 .RE
146 .PP
147 PAM_USER_UNKNOWN
148 .RS 4
149 The user is not known to the system\&.
150 .RE
151 .SH "FILES"
152 .PP
153 /etc/security/access\&.conf
154 .RS 4
155 Default configuration file
156 .RE
157 .PP
158 /usr/etc/security/access\&.conf
159 .RS 4
160 Default configuration file if
161 /etc/security/access\&.conf
162 does not exist\&.
163 .RE
164 .SH "SEE ALSO"
165 .PP
166 \fBaccess.conf\fR(5),
167 \fBpam.d\fR(5),
168 \fBpam\fR(8)\&.
169 .SH "AUTHORS"
170 .PP
171 The logdaemon style login access control scheme was designed and implemented by Wietse Venema\&. The pam_access PAM module was developed by Alexei Nogin <alexei@nogin\&.dnttm\&.ru>\&. The IPv6 support and the network(address) / netmask feature was developed and provided by Mike Becher <mike\&.becher@lrz\-muenchen\&.de>\&.