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