summaryrefslogtreecommitdiff
path: root/modules/pam_limits/pam_limits.8
blob: 64044fffb128934333c10772ec524a98423d2e93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
'\" t
.\"     Title: pam_limits
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 05/18/2017
.\"    Manual: Linux-PAM Manual
.\"    Source: Linux-PAM Manual
.\"  Language: English
.\"
.TH "PAM_LIMITS" "8" "05/18/2017" "Linux-PAM Manual" "Linux-PAM Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pam_limits \- PAM module to limit resources
.SH "SYNOPSIS"
.HP \w'\fBpam_limits\&.so\fR\ 'u
\fBpam_limits\&.so\fR [conf=\fI/path/to/limits\&.conf\fR] [debug] [set_all] [utmp_early] [noaudit]
.SH "DESCRIPTION"
.PP
The pam_limits PAM module sets limits on the system resources that can be obtained in a user\-session\&. Users of
\fIuid=0\fR
are affected by this limits, too\&.
.PP
By default limits are taken from the
/etc/security/limits\&.conf
config file\&. Then individual *\&.conf files from the
/etc/security/limits\&.d/
directory are read\&. The files are parsed one after another in the order of "C" locale\&. The effect of the individual files is the same as if all the files were concatenated together in the order of parsing\&. If a config file is explicitly specified with a module option then the files in the above directory are not parsed\&.
.PP
The module must not be called by a multithreaded application\&.
.PP
If Linux PAM is compiled with audit support the module will report when it denies access based on limit of maximum number of concurrent login sessions\&.
.SH "OPTIONS"
.PP
\fBconf=\fR\fB\fI/path/to/limits\&.conf\fR\fR
.RS 4
Indicate an alternative limits\&.conf style configuration file to override the default\&.
.RE
.PP
\fBdebug\fR
.RS 4
Print debug information\&.
.RE
.PP
\fBset_all\fR
.RS 4
Set the limits for which no value is specified in the configuration file to the one from the process with the PID 1\&.
.RE
.PP
\fButmp_early\fR
.RS 4
Some broken applications actually allocate a utmp entry for the user before the user is admitted to the system\&. If some of the services you are configuring PAM for do this, you can selectively use this module argument to compensate for this behavior and at the same time maintain system\-wide consistency with a single limits\&.conf file\&.
.RE
.PP
\fBnoaudit\fR
.RS 4
Do not report exceeded maximum logins count to the audit subsystem\&.
.RE
.SH "MODULE TYPES PROVIDED"
.PP
Only the
\fBsession\fR
module type is provided\&.
.SH "RETURN VALUES"
.PP
PAM_ABORT
.RS 4
Cannot get current limits\&.
.RE
.PP
PAM_IGNORE
.RS 4
No limits found for this user\&.
.RE
.PP
PAM_PERM_DENIED
.RS 4
New limits could not be set\&.
.RE
.PP
PAM_SERVICE_ERR
.RS 4
Cannot read config file\&.
.RE
.PP
PAM_SESSION_ERR
.RS 4
Error recovering account name\&.
.RE
.PP
PAM_SUCCESS
.RS 4
Limits were changed\&.
.RE
.PP
PAM_USER_UNKNOWN
.RS 4
The user is not known to the system\&.
.RE
.SH "FILES"
.PP
/etc/security/limits\&.conf
.RS 4
Default configuration file
.RE
.SH "EXAMPLES"
.PP
For the services you need resources limits (login for example) put a the following line in
/etc/pam\&.d/login
as the last line for that service (usually after the pam_unix session line):
.sp
.if n \{\
.RS 4
.\}
.nf
#%PAM\-1\&.0
#
# Resource limits imposed on login sessions via pam_limits
#
session  required  pam_limits\&.so
    
.fi
.if n \{\
.RE
.\}
.PP
Replace "login" for each service you are using this module\&.
.SH "SEE ALSO"
.PP
\fBlimits.conf\fR(5),
\fBpam.d\fR(5),
\fBpam\fR(8)\&.
.SH "AUTHORS"
.PP
pam_limits was initially written by Cristian Gafton <gafton@redhat\&.com>