posixlocks resource limit part 1/4: Add support to the login.conf database,
[dragonfly.git] / lib / libutil / login.conf.5
1 .\" Copyright (c) 1996 David Nugent <davidn@blaze.net.au>
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, is permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice immediately at the beginning of the file, without modification,
9 .\"    this list of conditions, and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. This work was done expressly for inclusion into FreeBSD.  Other use
14 .\"    is permitted provided this notation is included.
15 .\" 4. Absolutely no warranty of function or purpose is made by the author
16 .\"    David Nugent.
17 .\" 5. Modifications may be freely made to this file providing the above
18 .\"    conditions are met.
19 .\"
20 .\" $FreeBSD: src/lib/libutil/login.conf.5,v 1.22.2.18 2003/05/10 23:30:54 murray Exp $
21 .\" $DragonFly: src/lib/libutil/login.conf.5,v 1.4 2004/04/22 16:52:55 dillon Exp $
22 .\"
23 .Dd November 22, 1996
24 .Dt LOGIN.CONF 5
25 .Os
26 .Sh NAME
27 .Nm login.conf
28 .Nd login class capability database
29 .Sh SYNOPSIS
30 .Pa /etc/login.conf ,
31 .Pa ~/.login_conf
32 .Sh DESCRIPTION
33 .Nm
34 contains various attributes and capabilities of login classes.
35 A login class (an optional annotation against each record in the user
36 account database,
37 .Pa /etc/master.passwd )
38 determines session accounting, resource limits and user environment settings.
39 It is used by various programs in the system to set up a user's login
40 environment and to enforce policy, accounting and administrative restrictions.
41 It also provides the means by which users are able to be
42 authenticated to the system and the types of authentication available.
43 .Pp
44 A special record "default" in the system user class capability database
45 .Pa /etc/login.conf
46 is used automatically for any
47 non-root user without a valid login class in
48 .Pa /etc/master.passwd .
49 A user with a uid of 0 without a valid login class will use the record
50 "root" if it exists, or "default" if not.
51 .Pp
52 In
53 .Dx ,
54 users may individually create a file called
55 .Pa .login_conf
56 in their home directory using the same format, consisting of a single
57 entry with a record id of "me".
58 If present, this file is used by
59 .Xr login 1
60 to set user-defined environment settings which override those specified
61 in the system login capabilities database.
62 Only a subset of login capabilities may be overridden, typically those
63 which do not involve authentication, resource limits and accounting.
64 .Pp
65 Records in a class capabilities database consist of a number of
66 colon-separated fields.
67 The first entry for each record gives one or more names that a record is
68 to be known by, each separated by a '|' character.
69 The first name is the most common abbreviation.
70 The last name given should be a long name that is more descriptive
71 of the capability entry, and all others are synonyms.
72 All names but the last should be in lower case and contain no blanks;
73 the last name may contain upper case characters and blanks for
74 readability.
75 .Pp
76 See
77 .Xr getcap 3
78 for a more in-depth description of the format of a capability database.
79 .Sh CAPABILITIES
80 Fields within each record in the database follow the
81 .Xr getcap 3
82 conventions for boolean, type string
83 .Ql \&=
84 and type numeric
85 .Ql \&# ,
86 although type numeric is deprecated in favour of the string format and
87 either form is accepted for a numeric datum.
88 Values fall into the following categories:
89 .Bl -tag -width "program"
90 .It bool
91 If the name is present, then the boolean value is true; otherwise, it is
92 false
93 .It file
94 Path name to a data file
95 .It program
96 Path name to an executable file
97 .It list
98 A list of values (or pairs of values) separated by commas or spaces
99 .It path
100 A space or comma separated list of path names, following the usual csh
101 conventions (leading tilde with and without username being expanded to
102 home directories etc.)
103 .It number
104 A numeric value, either decimal (default), hexadecimal (with leading 0x),
105 or octal (with a leading 0).
106 With a numeric type, only one numeric value is allowed.
107 Numeric types may also be specified in string format (ie. the capability
108 tag being delimited from the value by '=' instead of '#').
109 Whichever method is used, then all records in the database must use the
110 same method to allow values to be correctly overridden in interpolated
111 records.
112 .It size
113 A number which expresses a size.
114 The default interpretation of a value is the number of bytes, but a
115 suffix may specify alternate units:
116 .Bl -tag -offset indent -compact -width xxxx
117 .It b
118 explicitly selects 512-byte blocks
119 .It k
120 selects kilobytes (1024 bytes)
121 .It m
122 specifies a multiplier of 1 megabyte (1048576 bytes),
123 .It g
124 specifies units of gigabytes, and
125 .It t
126 represents terabytes.
127 .El
128 A size value is a numeric quantity and case of the suffix is not significant.
129 Concatenated values are added together.
130 .It time
131 A period of time, by default in seconds.
132 A prefix may specify a different unit:
133 .Bl -tag -offset indent -compact -width xxxx
134 .It y
135 indicates the number of 365 day years,
136 .It w
137 indicates the number of weeks,
138 .It d
139 the number of days,
140 .It h
141 the number of hours,
142 .It m
143 the number of minutes, and
144 .It s
145 the number of seconds.
146 .El
147 Concatenated values are added together.
148 For example, 2 hours and 40 minutes may be written either as
149 9600s, 160m or 2h40m.
150 .El
151 .Pp
152 The usual convention to interpolate capability entries using the special
153 .Em tc=value
154 notation may be used.
155 .Sh RESOURCE LIMITS
156 .Bl -column coredumpsize indent indent
157 .It Sy "Name    Type    Notes   Description
158 .It "coredumpsize       size            Maximum coredump size limit.
159 .It "cputime    time            CPU usage limit.
160 .It "datasize   size            Maximum data size limit.
161 .It "filesize   size            Maximum file size limit.
162 .It "maxproc    number          Maximum number of processes.
163 .It "memorylocked       size            Maximum locked in core memory size limit.
164 .It "memoryuse  size            Maximum of core memory use size limit.
165 .It "openfiles  number          Maximum number of open files per process.
166 .It "sbsize     size            Maximum permitted socketbuffer size.
167 .It "vmemoryuse size            Maximum permitted total VM useage per process.
168 .It "stacksize  size            Maximum stack size limit.
169 .It "posixlocks size            Maximum number of POSIX-type advisory-mode locks.
170 .El
171 .Pp
172 These resource limit entries actually specify both the maximum
173 and current limits (see
174 .Xr getrlimit 2 ) .
175 The current (soft) limit is the one normally used, although the user is
176 permitted to increase the current limit to the maximum (hard) limit.
177 The maximum and current limits may be specified individually by appending a
178 -max or -cur to the capability name.
179 .Sh ENVIRONMENT
180 .Bl -column ignorenologin indent xbinxxusrxbin
181 .It Sy "Name    Type    Notes   Description
182 .It "charset    string          Set $MM_CHARSET environment variable to the specified
183 value.
184 .It "hushlogin  bool    false   Same as having a ~/.hushlogin file.
185 .It "ignorenologin      bool    false   Login not prevented by nologin.
186 .It "lang       string          Set $LANG environment variable to the specified value.
187 .It "manpath    path            Default search path for manpages.
188 .It "nologin    file            If the file exists it will be displayed and
189 the login session will be terminated.
190 .It "path       path    /bin /usr/bin   Default search path.
191 .It "priority   number          Initial priority (nice) level.
192 .It "requirehome        bool    false   Require a valid home directory to login.
193 .It "setenv     list            A comma-separated list of environment variables and
194 values to which they are to be set.
195 .It "shell      prog            Session shell to execute rather than the
196 shell specified in the passwd file.
197 The SHELL environment variable will
198 contain the shell specified in the password file.
199 .It "term       string          Default terminal type if not able to determine
200 from other means.
201 .It "timezone   string          Default value of $TZ environment variable.
202 .It "umask      number  022     Initial umask. Should always have a leading 0 to
203 ensure octal interpretation.
204 .It "welcome    file    /etc/motd       File containing welcome message.
205 .El
206 .Sh AUTHENTICATION
207 .Bl -column minpasswordlen indent indent
208 .It Sy "Name    Type    Notes   Description
209 .\" .It "approve        program         Program to approve login.
210 .It "copyright  file            File containing additional copyright information
211 .It "host.allow list            List of remote host wildcards from which users in
212 the class may access.
213 .It "host.deny  list            List of remote host wildcards from which users
214 in the class may not access.
215 .It "login_prompt       string          The login prompt given by
216 .Xr login 1
217 .It "minpasswordlen     number  6       The minimum length a local password
218 may be.
219 .It "mixpasswordcase    bool    true    Whether
220 .Xr passwd 1
221 will warn the user if an all lower case password is entered.
222 .It "login-backoff      number  3       The number of login attempts
223 allowed before the backoff delay is inserted after each subsequent
224 attempt.
225 .It "login-retries      number  10      The number of login attempts
226 allowed before the login fails.
227 .It "passwd_format      string  md5     The encryption format that new or
228 changed passwords will use.
229 Valid values include "des", "md5" and "blf".
230 NIS clients using a
231 .No non- Ns Dx Ns / Ns Fx
232 NIS server should probably use "des".
233 .It "passwd_prompt      string          The password prompt presented by
234 .Xr login 1
235 .It "times.allow        list            List of time periods during which
236 logins are allowed.
237 .It "times.deny list            List of time periods during which logins are
238 disallowed.
239 .It "ttys.allow list            List of ttys and ttygroups which users
240 in the class may use for access.
241 .It "ttys.deny  list            List of ttys and ttygroups which users
242 in the class may not use for access.
243 .\".It "widepasswords   bool    false   Use the wide password format. The wide password
244 .\" format allows up to 128 significant characters in the password.
245 .El
246 .Pp
247 These fields are intended to be used by
248 .Xr passwd 1
249 and other programs in the login authentication system.
250 .Pp
251 Capabilities that set environment variables are scanned for both
252 .Ql \&~
253 and
254 .Ql \&$
255 characters, which are substituted for a user's home directory and name
256 respectively.
257 To pass these characters literally into the environment variable, escape
258 the character by preceding it with a backslash '\\'.
259 .Pp
260 The
261 .Em host.allow
262 and
263 .Em host.deny
264 entries are comma separated lists used for checking remote access to the system,
265 and consist of a list of hostnames and/or IP addresses against which remote
266 network logins are checked.
267 Items in these lists may contain wildcards in the form used by shell programs
268 for wildcard matching (See
269 .Xr fnmatch 3
270 for details on the implementation).
271 The check on hosts is made against both the remote system's Internet address
272 and hostname (if available).
273 If both lists are empty or not specified, then logins from any remote host
274 are allowed.
275 If host.allow contains one or more hosts, then only remote systems matching
276 any of the items in that list are allowed to log in.
277 If host.deny contains one or more hosts, then a login from any matching hosts
278 will be disallowed.
279 .Pp
280 The
281 .Em times.allow
282 and
283 .Em times.deny
284 entries consist of a comma-separated list of time periods during which the users
285 in a class are allowed to be logged in.
286 These are expressed as one or more day codes followed by a start and end times
287 expressed in 24 hour format, separated by a hyphen or dash.
288 For example, MoThSa0200-1300 translates to Monday, Thursday and Saturday between
289 the hours of 2 am and 1 p.m..
290 If both of these time lists are empty, users in the class are allowed access at
291 any time.
292 If
293 .Em times.allow
294 is specified, then logins are only allowed during the periods given.
295 If
296 .Em times.deny
297 is specified, then logins are denied during the periods given, regardless of whether
298 one of the periods specified in
299 .Em times.allow
300 applies.
301 .Pp
302 Note that
303 .Xr login 1
304 enforces only that the actual login falls within periods allowed by these entries.
305 Further enforcement over the life of a session requires a separate daemon to
306 monitor transitions from an allowed period to a non-allowed one.
307 .Pp
308 The
309 .Em ttys.allow
310 and
311 .Em ttys.deny
312 entries contain a comma-separated list of tty devices (without the /dev/ prefix)
313 that a user in a class may use to access the system, and/or a list of ttygroups
314 (See
315 .Xr getttyent 3
316 and
317 .Xr ttys 5
318 for information on ttygroups).
319 If neither entry exists, then the choice of login device used by the user is
320 unrestricted.
321 If only
322 .Em ttys.allow
323 is specified, then the user is restricted only to ttys in the given
324 group or device list.
325 If only
326 .Em ttys.deny
327 is specified, then the user is prevented from using the specified devices or
328 devices in the group.
329 If both lists are given and are non-empty, the user is restricted to those
330 devices allowed by ttys.allow that are not available by ttys.deny.
331 .Sh ACCOUNTING LIMITS
332 .Bl -column host.accounted indent indent
333 .It Sy "Name    Type    Notes   Description
334 .It "accounted  bool    false   Enable session time accounting for all users
335 in this class.
336 .It "autodelete time            Time after expiry when account is auto-deleted.
337 .It "bootfull   bool    false   Enable 'boot only if ttygroup is full' strategy
338 when terminating sessions.
339 .It "daytime    time            Maximum login time per day.
340 .It "expireperiod       time            Time for expiry allocation.
341 .It "graceexpire        time            Grace days for expired account.
342 .It "gracetime  time            Additional grace login time allowed.
343 .It "host.accounted     list            List of remote host wildcards from which
344 login sessions will be accounted.
345 .It "host.exempt        list            List of remote host wildcards from which
346 login session accounting is exempted.
347 .It "idletime   time            Maximum idle time before logout (unused).
348 .It "monthtime  time            Maximum login time per month.
349 .It "passwordtime       time            Used by
350 .Xr passwd 1
351 to set next password expiry date.
352 .It "refreshtime        time            New time allowed on account refresh.
353 .It "refreshperiod      str             How often account time is refreshed.
354 .It "sessiontime        time            Maximum login time per session.
355 .It "sessionlimit       number          Maximum number of concurrent
356 login sessions on ttys in any group.
357 .It "ttys.accounted     list            List of ttys and ttygroups for which
358 login accounting is active.
359 .It "ttys.exempt        list            List of ttys and ttygroups for which login accounting
360 is exempt.
361 .It "warnexpire time            Advance notice for pending account expiry.
362 .It "warnpassword       time            Advance notice for pending password expiry.
363 .It "warntime   time            Advance notice for pending out-of-time.
364 .It "weektime   time            Maximum login time per week.
365 .El
366 .Pp
367 These fields are used by the time accounting system, which regulates,
368 controls and records user login access.
369 .Pp
370 The
371 .Em ttys.accounted
372 and
373 .Em ttys.exempt
374 fields operate in a similar manner to
375 .Em ttys.allow
376 and
377 .Em ttys.deny
378 as explained
379 above.
380 Similarly with the
381 .Em host.accounted
382 and
383 .Em host.exempt
384 lists.
385 .Sh BUGS
386 The
387 .Em idletime
388 setting is not enforced.
389 .Sh SEE ALSO
390 .Xr cap_mkdb 1 ,
391 .Xr login 1 ,
392 .Xr getcap 3 ,
393 .Xr getttyent 3 ,
394 .Xr login_cap 3 ,
395 .Xr login_class 3 ,
396 .Xr passwd 5 ,
397 .Xr ttys 5