Mega mdoc(7) update:
[dragonfly.git] / lib / libutil / login.conf.5
1 .\" Copyright (c) 1996 David Nugent <>
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 2003/05/10 23:30:54 murray Exp $
21 .\" $DragonFly: src/lib/libutil/login.conf.5,v 1.3 2004/03/11 12:28:53 hmp Exp $
22 .\"
23 .Dd November 22, 1996
25 .Os
26 .Sh NAME
27 .Nm login.conf
28 .Nd login class capability database
30 .Pa /etc/login.conf ,
31 .Pa ~/.login_conf
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.
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.
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 .El
170 .Pp
171 These resource limit entries actually specify both the maximum
172 and current limits (see
173 .Xr getrlimit 2 ) .
174 The current (soft) limit is the one normally used, although the user is
175 permitted to increase the current limit to the maximum (hard) limit.
176 The maximum and current limits may be specified individually by appending a
177 -max or -cur to the capability name.
179 .Bl -column ignorenologin indent xbinxxusrxbin
180 .It Sy "Name    Type    Notes   Description
181 .It "charset    string          Set $MM_CHARSET environment variable to the specified
182 value.
183 .It "hushlogin  bool    false   Same as having a ~/.hushlogin file.
184 .It "ignorenologin      bool    false   Login not prevented by nologin.
185 .It "lang       string          Set $LANG environment variable to the specified value.
186 .It "manpath    path            Default search path for manpages.
187 .It "nologin    file            If the file exists it will be displayed and
188 the login session will be terminated.
189 .It "path       path    /bin /usr/bin   Default search path.
190 .It "priority   number          Initial priority (nice) level.
191 .It "requirehome        bool    false   Require a valid home directory to login.
192 .It "setenv     list            A comma-separated list of environment variables and
193 values to which they are to be set.
194 .It "shell      prog            Session shell to execute rather than the
195 shell specified in the passwd file.
196 The SHELL environment variable will
197 contain the shell specified in the password file.
198 .It "term       string          Default terminal type if not able to determine
199 from other means.
200 .It "timezone   string          Default value of $TZ environment variable.
201 .It "umask      number  022     Initial umask. Should always have a leading 0 to
202 ensure octal interpretation.
203 .It "welcome    file    /etc/motd       File containing welcome message.
204 .El
206 .Bl -column minpasswordlen indent indent
207 .It Sy "Name    Type    Notes   Description
208 .\" .It "approve        program         Program to approve login.
209 .It "copyright  file            File containing additional copyright information
210 .It "host.allow list            List of remote host wildcards from which users in
211 the class may access.
212 .It "host.deny  list            List of remote host wildcards from which users
213 in the class may not access.
214 .It "login_prompt       string          The login prompt given by
215 .Xr login 1
216 .It "minpasswordlen     number  6       The minimum length a local password
217 may be.
218 .It "mixpasswordcase    bool    true    Whether
219 .Xr passwd 1
220 will warn the user if an all lower case password is entered.
221 .It "login-backoff      number  3       The number of login attempts
222 allowed before the backoff delay is inserted after each subsequent
223 attempt.
224 .It "login-retries      number  10      The number of login attempts
225 allowed before the login fails.
226 .It "passwd_format      string  md5     The encryption format that new or
227 changed passwords will use.
228 Valid values include "des", "md5" and "blf".
229 NIS clients using a
230 .No non- Ns Dx Ns / Ns Fx
231 NIS server should probably use "des".
232 .It "passwd_prompt      string          The password prompt presented by
233 .Xr login 1
234 .It "times.allow        list            List of time periods during which
235 logins are allowed.
236 .It "times.deny list            List of time periods during which logins are
237 disallowed.
238 .It "ttys.allow list            List of ttys and ttygroups which users
239 in the class may use for access.
240 .It "ttys.deny  list            List of ttys and ttygroups which users
241 in the class may not use for access.
242 .\".It "widepasswords   bool    false   Use the wide password format. The wide password
243 .\" format allows up to 128 significant characters in the password.
244 .El
245 .Pp
246 These fields are intended to be used by
247 .Xr passwd 1
248 and other programs in the login authentication system.
249 .Pp
250 Capabilities that set environment variables are scanned for both
251 .Ql \&~
252 and
253 .Ql \&$
254 characters, which are substituted for a user's home directory and name
255 respectively.
256 To pass these characters literally into the environment variable, escape
257 the character by preceding it with a backslash '\\'.
258 .Pp
259 The
260 .Em host.allow
261 and
262 .Em host.deny
263 entries are comma separated lists used for checking remote access to the system,
264 and consist of a list of hostnames and/or IP addresses against which remote
265 network logins are checked.
266 Items in these lists may contain wildcards in the form used by shell programs
267 for wildcard matching (See
268 .Xr fnmatch 3
269 for details on the implementation).
270 The check on hosts is made against both the remote system's Internet address
271 and hostname (if available).
272 If both lists are empty or not specified, then logins from any remote host
273 are allowed.
274 If host.allow contains one or more hosts, then only remote systems matching
275 any of the items in that list are allowed to log in.
276 If host.deny contains one or more hosts, then a login from any matching hosts
277 will be disallowed.
278 .Pp
279 The
280 .Em times.allow
281 and
282 .Em times.deny
283 entries consist of a comma-separated list of time periods during which the users
284 in a class are allowed to be logged in.
285 These are expressed as one or more day codes followed by a start and end times
286 expressed in 24 hour format, separated by a hyphen or dash.
287 For example, MoThSa0200-1300 translates to Monday, Thursday and Saturday between
288 the hours of 2 am and 1 p.m..
289 If both of these time lists are empty, users in the class are allowed access at
290 any time.
291 If
292 .Em times.allow
293 is specified, then logins are only allowed during the periods given.
294 If
295 .Em times.deny
296 is specified, then logins are denied during the periods given, regardless of whether
297 one of the periods specified in
298 .Em times.allow
299 applies.
300 .Pp
301 Note that
302 .Xr login 1
303 enforces only that the actual login falls within periods allowed by these entries.
304 Further enforcement over the life of a session requires a separate daemon to
305 monitor transitions from an allowed period to a non-allowed one.
306 .Pp
307 The
308 .Em ttys.allow
309 and
310 .Em ttys.deny
311 entries contain a comma-separated list of tty devices (without the /dev/ prefix)
312 that a user in a class may use to access the system, and/or a list of ttygroups
313 (See
314 .Xr getttyent 3
315 and
316 .Xr ttys 5
317 for information on ttygroups).
318 If neither entry exists, then the choice of login device used by the user is
319 unrestricted.
320 If only
321 .Em ttys.allow
322 is specified, then the user is restricted only to ttys in the given
323 group or device list.
324 If only
325 .Em ttys.deny
326 is specified, then the user is prevented from using the specified devices or
327 devices in the group.
328 If both lists are given and are non-empty, the user is restricted to those
329 devices allowed by ttys.allow that are not available by ttys.deny.
331 .Bl -column host.accounted indent indent
332 .It Sy "Name    Type    Notes   Description
333 .It "accounted  bool    false   Enable session time accounting for all users
334 in this class.
335 .It "autodelete time            Time after expiry when account is auto-deleted.
336 .It "bootfull   bool    false   Enable 'boot only if ttygroup is full' strategy
337 when terminating sessions.
338 .It "daytime    time            Maximum login time per day.
339 .It "expireperiod       time            Time for expiry allocation.
340 .It "graceexpire        time            Grace days for expired account.
341 .It "gracetime  time            Additional grace login time allowed.
342 .It "host.accounted     list            List of remote host wildcards from which
343 login sessions will be accounted.
344 .It "host.exempt        list            List of remote host wildcards from which
345 login session accounting is exempted.
346 .It "idletime   time            Maximum idle time before logout (unused).
347 .It "monthtime  time            Maximum login time per month.
348 .It "passwordtime       time            Used by
349 .Xr passwd 1
350 to set next password expiry date.
351 .It "refreshtime        time            New time allowed on account refresh.
352 .It "refreshperiod      str             How often account time is refreshed.
353 .It "sessiontime        time            Maximum login time per session.
354 .It "sessionlimit       number          Maximum number of concurrent
355 login sessions on ttys in any group.
356 .It "ttys.accounted     list            List of ttys and ttygroups for which
357 login accounting is active.
358 .It "ttys.exempt        list            List of ttys and ttygroups for which login accounting
359 is exempt.
360 .It "warnexpire time            Advance notice for pending account expiry.
361 .It "warnpassword       time            Advance notice for pending password expiry.
362 .It "warntime   time            Advance notice for pending out-of-time.
363 .It "weektime   time            Maximum login time per week.
364 .El
365 .Pp
366 These fields are used by the time accounting system, which regulates,
367 controls and records user login access.
368 .Pp
369 The
370 .Em ttys.accounted
371 and
372 .Em ttys.exempt
373 fields operate in a similar manner to
374 .Em ttys.allow
375 and
376 .Em ttys.deny
377 as explained
378 above.
379 Similarly with the
380 .Em host.accounted
381 and
382 .Em host.exempt
383 lists.
384 .Sh BUGS
385 The
386 .Em idletime
387 setting is not enforced.
388 .Sh SEE ALSO
389 .Xr cap_mkdb 1 ,
390 .Xr login 1 ,
391 .Xr getcap 3 ,
392 .Xr getttyent 3 ,
393 .Xr login_cap 3 ,
394 .Xr login_class 3 ,
395 .Xr passwd 5 ,
396 .Xr ttys 5