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