modules/pam_limits/pam_limits.8

   1 .\"     Title: pam_limits
   2 .\"    Author: [see the "AUTHORS" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 06/21/2011
   5 .\"    Manual: Linux-PAM Manual
   6 .\"    Source: Linux-PAM Manual
   7 .\"  Language: English
   8 .\"
   9 .TH "PAM_LIMITS" "8" "06/21/2011" "Linux-PAM Manual" "Linux-PAM Manual"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 pam_limits \- PAM module to limit resources
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBpam_limits\&.so\fR\ 'u
 174 \fBpam_limits\&.so\fR [conf=\fI/path/to/limits\&.conf\fR] [debug] [set_all] [utmp_early] [noaudit]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 The pam_limits PAM module sets limits on the system resources that can be obtained in a user\-session\&. Users of
 179 \fIuid=0\fR
 180 are affected by this limits, too\&.
 181 .PP
 182 By default limits are taken from the
 183 \FC/etc/security/limits\&.conf\F[]
 184 config file\&. Then individual *\&.conf files from the
 185 \FC/etc/security/limits\&.d/\F[]
 186 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\&.
 187 .PP
 188 The module must not be called by a multithreaded application\&.
 189 .PP
 190 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\&.
 191 .SH "OPTIONS"
 192 .PP
 193 \fBconf=\fR\fB\fI/path/to/limits\&.conf\fR\fR
 194 .RS 4
 195 Indicate an alternative limits\&.conf style configuration file to override the default\&.
 196 .RE
 197 .PP
 198 \fBdebug\fR
 199 .RS 4
 200 Print debug information\&.
 201 .RE
 202 .PP
 203 \fBset_all\fR
 204 .RS 4
 205 Set the limits for which no value is specified in the configuration file to the one from the process with the PID 1\&.
 206 .RE
 207 .PP
 208 \fButmp_early\fR
 209 .RS 4
 210 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\&.
 211 .RE
 212 .PP
 213 \fBnoaudit\fR
 214 .RS 4
 215 Do not report exceeded maximum logins count to the audit subsystem\&.
 216 .RE
 217 .SH "MODULE TYPES PROVIDED"
 218 .PP
 219 Only the
 220 \fBsession\fR
 221 module type is provided\&.
 222 .SH "RETURN VALUES"
 223 .PP
 224 PAM_ABORT
 225 .RS 4
 226 Cannot get current limits\&.
 227 .RE
 228 .PP
 229 PAM_IGNORE
 230 .RS 4
 231 No limits found for this user\&.
 232 .RE
 233 .PP
 234 PAM_PERM_DENIED
 235 .RS 4
 236 New limits could not be set\&.
 237 .RE
 238 .PP
 239 PAM_SERVICE_ERR
 240 .RS 4
 241 Cannot read config file\&.
 242 .RE
 243 .PP
 244 PAM_SESSION_ERR
 245 .RS 4
 246 Error recovering account name\&.
 247 .RE
 248 .PP
 249 PAM_SUCCESS
 250 .RS 4
 251 Limits were changed\&.
 252 .RE
 253 .PP
 254 PAM_USER_UNKNOWN
 255 .RS 4
 256 The user is not known to the system\&.
 257 .RE
 258 .SH "FILES"
 259 .PP
 260 \FC/etc/security/limits\&.conf\F[]
 261 .RS 4
 262 Default configuration file
 263 .RE
 264 .SH "EXAMPLES"
 265 .PP
 266 For the services you need resources limits (login for example) put a the following line in
 267 \FC/etc/pam\&.d/login\F[]
 268 as the last line for that service (usually after the pam_unix session line):
 269 .sp
 270 .if n \{\
 271 .RS 4
 272 .\}
 273 .fam C
 274 .ps -1
 275 .nf
 276 .if t \{\
 277 .sp -1
 278 .\}
 279 .BB lightgray adjust-for-leading-newline
 280 .sp -1
 281
 282 #%PAM\-1\&.0
 283 #
 284 # Resource limits imposed on login sessions via pam_limits
 285 #
 286 session  required  pam_limits\&.so
 287
 288 .EB lightgray adjust-for-leading-newline
 289 .if t \{\
 290 .sp 1
 291 .\}
 292 .fi
 293 .fam
 294 .ps +1
 295 .if n \{\
 296 .RE
 297 .\}
 298 .PP
 299 Replace "login" for each service you are using this module\&.
 300 .SH "SEE ALSO"
 301 .PP
 302
 303 \fBlimits.conf\fR(5),
 304 \fBpam.d\fR(5),
 305 \fBpam\fR(8)\&.
 306 .SH "AUTHORS"
 307 .PP
 308 pam_limits was initially written by Cristian Gafton <gafton@redhat\&.com>