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