| 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: 06/29/2025 |
| 6 |
.\" Manual: Linux-PAM Manual |
| 7 |
.\" Source: Linux-PAM |
| 8 |
.\" Language: English |
| 9 |
.\" |
| 10 |
.TH "PAM_ACCESS" "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_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 |
if you don\*(Aqt specify another file\&. Then individual |
| 44 |
*\&.conf |
| 45 |
files from the |
| 46 |
/etc/security/access\&.d/ |
| 47 |
directory are read\&. The files are parsed one after another in the order of the system locale\&. 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 |
| 48 |
\fBaccessfile\fR |
| 49 |
option the files in the above directory are not parsed\&. |
| 50 |
.PP |
| 51 |
If Linux PAM is compiled with audit support the module will report when it denies access based on origin (host, tty, etc\&.)\&. |
| 52 |
.SH "OPTIONS" |
| 53 |
.PP |
| 54 |
accessfile=/path/to/access\&.conf |
| 55 |
.RS 4 |
| 56 |
Indicate an alternative |
| 57 |
access\&.conf |
| 58 |
style configuration file to override the default\&. This can be useful when different services need different access lists\&. |
| 59 |
.RE |
| 60 |
.PP |
| 61 |
debug |
| 62 |
.RS 4 |
| 63 |
A lot of debug information is printed with |
| 64 |
\fBsyslog\fR(3)\&. |
| 65 |
.RE |
| 66 |
.PP |
| 67 |
noaudit |
| 68 |
.RS 4 |
| 69 |
Do not report logins from disallowed hosts and ttys to the audit subsystem\&. |
| 70 |
.RE |
| 71 |
.PP |
| 72 |
nodefgroup |
| 73 |
.RS 4 |
| 74 |
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\&. |
| 75 |
.RE |
| 76 |
.PP |
| 77 |
nodns |
| 78 |
.RS 4 |
| 79 |
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 |
| 80 |
access\&.conf\&. |
| 81 |
.RE |
| 82 |
.PP |
| 83 |
quiet_log |
| 84 |
.RS 4 |
| 85 |
Do not log denials with |
| 86 |
\fBsyslog\fR(3)\&. |
| 87 |
.RE |
| 88 |
.PP |
| 89 |
fieldsep=separators |
| 90 |
.RS 4 |
| 91 |
This option modifies the field separator character that pam_access will recognize when parsing the access configuration file\&. For example: |
| 92 |
\fBfieldsep=|\fR |
| 93 |
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 |
| 94 |
\fBPAM_TTY\fR |
| 95 |
item is likely to be of the form "hostname:0" which includes a `:\*(Aq character in its value\&. But you should not need this\&. |
| 96 |
.RE |
| 97 |
.PP |
| 98 |
listsep=separators |
| 99 |
.RS 4 |
| 100 |
This option modifies the list separator character that pam_access will recognize when parsing the access configuration file\&. For example: |
| 101 |
\fBlistsep=,\fR |
| 102 |
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\&. |
| 103 |
.RE |
| 104 |
.SH "MODULE TYPES PROVIDED" |
| 105 |
.PP |
| 106 |
All module types (\fBauth\fR, |
| 107 |
\fBaccount\fR, |
| 108 |
\fBpassword\fR |
| 109 |
and |
| 110 |
\fBsession\fR) are provided\&. |
| 111 |
.SH "RETURN VALUES" |
| 112 |
.PP |
| 113 |
PAM_SUCCESS |
| 114 |
.RS 4 |
| 115 |
Access was granted\&. |
| 116 |
.RE |
| 117 |
.PP |
| 118 |
PAM_PERM_DENIED |
| 119 |
.RS 4 |
| 120 |
Access was not granted\&. |
| 121 |
.RE |
| 122 |
.PP |
| 123 |
PAM_IGNORE |
| 124 |
.RS 4 |
| 125 |
\fBpam_setcred\fR |
| 126 |
was called which does nothing\&. |
| 127 |
.RE |
| 128 |
.PP |
| 129 |
PAM_ABORT |
| 130 |
.RS 4 |
| 131 |
Not all relevant data or options could be gotten\&. |
| 132 |
.RE |
| 133 |
.PP |
| 134 |
PAM_USER_UNKNOWN |
| 135 |
.RS 4 |
| 136 |
The user is not known to the system\&. |
| 137 |
.RE |
| 138 |
.SH "FILES" |
| 139 |
.PP |
| 140 |
/etc/security/access\&.conf |
| 141 |
.RS 4 |
| 142 |
Default configuration file |
| 143 |
.RE |
| 144 |
.SH "SEE ALSO" |
| 145 |
.PP |
| 146 |
\fBaccess.conf\fR(5), |
| 147 |
\fBpam.d\fR(5), |
| 148 |
\fBpam\fR(7)\&. |
| 149 |
.SH "AUTHORS" |
| 150 |
.PP |
| 151 |
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>\&. |