diff options
Diffstat (limited to 'share/man/man5/passwd.5')
-rw-r--r-- | share/man/man5/passwd.5 | 826 |
1 files changed, 186 insertions, 640 deletions
diff --git a/share/man/man5/passwd.5 b/share/man/man5/passwd.5 index 51b1c3b..671d42b 100644 --- a/share/man/man5/passwd.5 +++ b/share/man/man5/passwd.5 @@ -1,5 +1,8 @@ +.\" $NetBSD: passwd.5,v 1.12.2.2 1999/12/17 23:14:50 he Exp $ +.\" .\" Copyright (c) 1988, 1991, 1993 .\" The Regents of the University of California. All rights reserved. +.\" Portions Copyright (c) 1994, Jason Downs. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -32,20 +35,37 @@ .\" From: @(#)passwd.5 8.1 (Berkeley) 6/5/93 .\" $FreeBSD$ .\" -.Dd September 29, 1994 +.Dd January 16, 1999 .Dt PASSWD 5 .Os .Sh NAME -.Nm passwd +.Nm passwd , +.Nm master.passwd .Nd format of the password file .Sh DESCRIPTION The .Nm passwd -files are files consisting of newline separated records, one per user, -containing ten colon -.Pq Ql \&: -separated fields. These fields are as -follows: +files are the local source of password information. +They can be used in conjunction with the Hesiod domains +.Sq passwd +and +.Sq uid , +and the +.Tn NIS +maps +.Sq passwd.byname , +.Sq passwd.byuid , +.Sq master.passwd.byname , +and +.Sq master.passwd.byuid , +as controlled by +.Xr nsswitch.conf 5 . +.Pp +The +.Nm master.passwd +file is readable only by root, and consists of newline separated +records, one per user, containing ten colon (``:'') separated +fields. These fields are as follows: .Pp .Bl -tag -width password -offset indent .It name @@ -59,7 +79,7 @@ User's id. .It gid User's login group id. .It class -User's login class. +User's general classification (unused). .It change Password change time. .It expire @@ -72,9 +92,14 @@ User's home directory. User's login shell. .El .Pp -Lines whose first non-whitespace character is a pound-sign (#) -are comments, and are ignored. Blank lines which consist -only of spaces, tabs or newlines are also ignored. +The +.Nm +file is generated from the +.Nm master.password +file by +.Xr pwd_mkdb 8 , +has the class, change, and expire fields removed, and the password +field replaced by a ``*''. .Pp The .Ar name @@ -85,17 +110,15 @@ across the system (and often across a group of systems) since they control file access. .Pp While it is possible to have multiple entries with identical login names -and/or identical uids, it is usually a mistake to do so. Routines +and/or identical user id's, it is usually a mistake to do so. Routines that manipulate these files will often return only one of the multiple entries, and that one by random selection. .Pp -The login name must never begin with a hyphen -.Pq Ql \&- ; -also, it is strongly -suggested that neither upper-case characters nor dots -.Pq Ql \&. -be part -of the name, as this tends to confuse mailers. +The login name must never begin with a hyphen (``-''); also, it is strongly +suggested that neither upper-case characters or dots (``.'') be part +of the name, as this tends to confuse mailers. No field may contain a +colon (``:'') as this has been used historically to separate the fields +in the user database. .Pp The password field is the .Em encrypted @@ -106,73 +129,66 @@ field is empty, no password will be required to gain access to the machine. This is almost invariably a mistake. Because these files contain the encrypted user passwords, they should not be readable by anyone without appropriate privileges. -Administrative accounts have a password field containing an asterisk -.Ql \&* -which disallows normal logins. .Pp The group field is the group that the user will be placed in upon login. -Although this system supports multiple groups (see +Since this system supports multiple groups (see .Xr groups 1 ) -this field indicates the user's primary group. -Secondary group memberships are selected in -.Pa /etc/group . +this field currently has little special meaning. .Pp The .Ar class -field is a key for a user's login class. -Login classes are defined in +field is a key for a user's login class. Login classes +are defined in .Xr login.conf 5 , -which is a +which is a .Xr termcap 5 -style database of user attributes, accounting, resource and -environment settings. +style database of user attributes, accounting, resource, +and environment settings. .Pp The .Ar change -field is the number in seconds, -.Dv GMT , -from the epoch, until the +field is the number of seconds from the epoch, +.Dv UTC , +until the password for the account must be changed. -This field may be left empty or set to 0 to turn off the -password aging feature. +This field may be left empty to turn off the password aging feature. .Pp The .Ar expire -field is the number in seconds, -.Dv GMT , -from the epoch, until the +field is the number of seconds from the epoch, +.Dv UTC , +until the account expires. -This field may be left empty or set to 0 to turn off the account -aging feature. +This field may be left empty to turn off the account aging feature. .Pp The .Ar gecos -field normally contains comma -.Pq Ql \&, -separated subfields as follows: +field normally contains comma (``,'') separated subfields as follows: .Pp -.Bl -bullet -compact -offset indent -.It +.Bl -tag -width office -offset indent -compact +.It name user's full name -.It -user's office location -.It +.It office +user's office number +.It wphone user's work phone number -.It +.It hphone user's home phone number .El .Pp -This information is used by the +The full name may contain a ampersand (``&'') which will be replaced by +the capitalized login name when the gecos field is displayed or used +by various programs such as +.Xr finger 1 , +.Xr sendmail 8 , +etc. +.Pp +The office and phone number subfields are used by the .Xr finger 1 -program, and the first field used by the system mailer. -If an ampersand -.Pq Ql \&& -character appears within the fullname field, programs that -use this field will substitute it with a capitalized version -of the account's login name. +program, and possibly other applications. .Pp The user's home directory is the full -.Tn UNIX +.Ux path name where the user will be placed on login. .Pp @@ -182,589 +198,119 @@ If there is nothing in the field, the Bourne shell .Pq Pa /bin/sh is assumed. -For security reasons, if the shell is set to a script that disallows -access to the system (the -.Xr nologin 8 -script, for example), care should be taken not to import any environment -variables. With -.Xr sh 1 , -this can be done by specifying the -.Fl p -flag. -Check the specific shell documentation to determine how this is -done with other shells. -.Sh YP/NIS INTERACTION -.Ss Enabling access to NIS passwd data -The system administrator can configure -.Tn FreeBSD -to use NIS/YP for -its password information by adding special records to the -.Pa /etc/master.passwd -file. -These entries should be added with -.Xr vipw 8 -so that the changes can be properly merged with the hashed -password databases and the -.Pa /etc/passwd -file ( -.Pa /etc/passwd -should never be edited manually). Alternatively, the administrator -can modify -.Pa /etc/master.passwd -in some other way and then manually update the password databases with -.Xr pwd_mkdb 8 . -.Pp -The simplest way to activate NIS is to add an empty record -with only a plus sign -.Pq Ql \&+ -in the name field, such as this: -.Bd -literal -offset indent -+::::::::: - -.Ed -The -.Ql \&+ -will tell the -.Xr getpwent 3 -routines in -.Tn FreeBSD Ns 's -standard C library to begin using the NIS passwd maps -for lookups. -.Pp -Note that the entry shown above is known as a -.Em wildcard -entry, because it matches all users (the -.Ql \&+ -without any other information -matches everybody) and allows all NIS password data to be retrieved -unaltered. -However, by -specifying a username or netgroup next to the -.Ql \&+ -in the NIS -entry, the administrator can affect what data are extracted from the -NIS passwd maps and how it is interpreted. -Here are a few example -records that illustrate this feature (note that you can have several -NIS entries in a single -.Pa master.passwd -file): -.Bd -literal -offset indent --mitnick::::::::: -+@staff::::::::: -+@permitted-users::::::::: -+dennis::::::::: -+ken:::::::::/bin/csh -+@rejected-users::32767:32767::::::/bin/false - -.Ed -Specific usernames are listed explicitly while netgroups are signified -by a preceding -.Ql \&@ . -In the above example, users in the -.Dq staff -and -.Dq permitted-users -netgroups will have their password information -read from NIS and used unaltered. -In other words, they will be allowed -normal access to the machine. -Users -.Dq ken -and -.Dq dennis , -who have -been named explicitly rather than through a netgroup, will also have -their password data read from NIS, -.Em except -that user -.Dq ken -will have his shell remapped to -.Pa /bin/csh . -This means that value for his shell specified in the NIS password map -will be overridden by the value specified in the special NIS entry in -the local -.Pa master.passwd -file. -User -.Dq ken -may have been assigned the csh shell because his -NIS password entry specified a different shell that may not be -installed on the client machine for political or technical reasons. -Meanwhile, users in the -.Dq rejected-users -netgroup are prevented -from logging in because their UIDs, GIDs and shells have been overridden -with invalid values. -.Pp -User -.Dq mitnick -will be be ignored entirely because his entry is -specified with a -.Ql \&- -instead of a -.Ql \&+ . -A minus entry can be used -to block out certain NIS password entries completely; users whose -password data has been excluded in this way are not recognized by -the system at all. -(Any overrides specified with minus entries are -also ignored since there is no point in processing override information -for a user that the system isn't going to recognize in the first place.) -In general, a minus entry is used to specifically exclude a user -who might otherwise be granted access because he happens to be a -member of an authorized netgroup. -For example, if -.Dq mitnick -is -a member of the -.Dq permitted-users -netgroup and must, for whatever -the reason, be permitted to remain in that netgroup (possibly to -retain access to other machines within the domain), the administrator -can still deny him access to a particular system with a minus entry. -Also, it is sometimes easier to explicitly list those users who are not -allowed access rather than generate a possibly complicated list of -users who are allowed access and omit the rest. -.Pp -Note that the plus and minus entries are evaluated in order from -first to last with the first match taking precedence. -This means -the system will only use the first entry that matches a particular user. -If, using the same example, there is a user -.Dq foo -who is a member of both the -.Dq staff -netgroup and the -.Dq rejected-users -netgroup, he will be admitted to -the system because the above example lists the entry for -.Dq staff -before the entry for -.Dq rejected-users . -If the order were reversed, -user -.Dq foo -would be flagged as a -.Dq rejected-user -instead and denied access. -.Pp -Lastly, any NIS password database records that do not match against -at least one of the users or netgroups specified by the NIS access -entries in the -.Pa /etc/master.passwd -file will be ignored (along with any users specified using minus -entries). In our example shown above, we do not have a wildcard -entry at the end of the list; therefore, the system will not recognize -anyone except -.Dq ken , -.Dq dennis , -the -.Dq staff -netgroup, and the -.Dq permitted-users -netgroup as authorized users. -The -.Dq rejected-users -netgroup will -be recognized but all members will have their shells remapped and -therefore be denied access. -All other NIS password records -will be ignored. -The administrator may add a wildcard entry to the -end of the list such as: -.Bd -literal -offset indent -+:::::::::/sbin/nologin - -.Ed -This entry acts as a catch-all for all users that don't match against -any of the other entries. -This technique is sometimes useful when it is -desirable to have the system be able to recognize all users in a -particular NIS domain without necessarily granting them login access. -See the description of the shell field regarding security concerns when using -a shell script as the login shell. -.Pp -The primary use of this -.Pa override -feature is to permit the administrator -to enforce access restrictions on NIS client systems. -Users can be -granted access to one group of machines and denied access to other -machines simply by adding or removing them from a particular netgroup. -Since the netgroup database can also be accessed via NIS, this allows -access restrictions to be administered from a single location, namely -the NIS master server; once a host's access list has been set in -.Pa /etc/master.passwd , -it need not be modified again unless new netgroups are created. -.Sh NOTES -.Ss Shadow passwords through NIS -.Tn FreeBSD -uses a shadow password scheme: users' encrypted passwords -are stored only in -.Pa /etc/master.passwd -and -.Pa /etc/spwd.db , -which are readable and writable only by the superuser. -This is done -to prevent users from running the encrypted passwords through -password-guessing programs and gaining unauthorized access to -other users' accounts. -NIS does not support a standard means of -password shadowing, which implies that placing your password data -into the NIS passwd maps totally defeats the security of -.Tn FreeBSD Ns 's -password shadowing system. -.Pp -.Tn FreeBSD -provides a few special features to help get around this -problem. -It is possible to implement password shadowing between -.Tn FreeBSD -NIS clients and -.Tn FreeBSD -NIS servers. -The -.Xr getpwent 3 -routines will search for a -.Pa master.passwd.byname -and -.Pa master.passwd.byuid -maps which should contain the same data found in the -.Pa /etc/master.passwd -file. -If the maps exist, -.Tn FreeBSD -will attempt to use them for user -authentication instead of the standard -.Pa passwd.byname -and -.Pa passwd.byuid -maps. -.Tn FreeBSD Ns 's -.Xr ypserv 8 -will also check client requests to make sure they originate on a -privileged port. -Since only the superuser is allowed to bind to -a privileged port, the server can tell if the requesting user -is the superuser; all requests from non-privileged users to access -the -.Pa master.passwd -maps will be refused. -Since all user authentication programs run -with superuser privilege, they should have the required access to -users' encrypted password data while normal users will only -be allowed access to the standard -.Pa passwd -maps which contain no password information. -.Pp -Note that this feature cannot be used in an environment with -.No non- Ns Tn FreeBSD -systems. -Note also that a truly determined user with -unrestricted access to your network could still compromise the -.Pa master.passwd +.Sh HESIOD SUPPORT +If +.Sq dns +is specified for the +.Sq passwd +database in +.Xr nsswitch.conf 5 , +then +.Nm +lookups occur from the +.Sq passwd +Hesiod domain. +.Sh NIS SUPPORT +If +.Sq nis +is specified for the +.Sq passwd +database in +.Xr nsswitch.conf 5 , +then +.Nm +lookups occur from the +.Sq passwd.byname , +.Sq passwd.byuid , +.Sq master.passwd.byname , +and +.Sq master.passwd.byuid +.Tn NIS maps. -.Ss UID and GID remapping with NIS overrides -Unlike -.Tn SunOS -and other operating systems that use Sun's NIS code, -.Tn FreeBSD -allows the user to override -.Pa all -of the fields in a user's NIS -.Pa passwd -entry. -For example, consider the following -.Pa /etc/master.passwd -entry: -.Bd -literal -offset indent -+@foo-users:???:666:666:0:0:0:Bogus user:/home/bogus:/bin/bogus - -.Ed -This entry will cause all users in the `foo-users' netgroup to -have -.Pa all -of their password information overridden, including UIDs, -GIDs and passwords. -The result is that all `foo-users' will be -locked out of the system, since their passwords will be remapped -to invalid values. -.Pp -This is important to remember because most people are accustomed to -using an NIS wildcard entry that looks like this: -.Bd -literal -offset indent -+:*:0:0::: - -.Ed -This often leads to new -.Tn FreeBSD -administrators choosing NIS entries for their -.Pa master.passwd -files that look like this: -.Bd -literal -offset indent -+:*:0:0:::::: - -.Ed -Or worse, this -.Bd -literal -offset indent -+::0:0:::::: - -.Ed -.Sy DO _NOT_ PUT ENTRIES LIKE THIS IN YOUR -.Sy Pa master.passwd -.Sy FILE!! -The first tells -.Tn FreeBSD -to remap all passwords to -.Ql \&* -(which -will prevent anybody from logging in) and to remap all UIDs and GIDs -to 0 (which will make everybody appear to be the superuser). The -second case just maps all UIDs and GIDs to 0, which means that -all users will appear to be root! -.Pp -.Ss Compatibility of NIS override evaluation -When Sun originally added NIS support to their -.Xr getpwent 3 -routines, they took into account the fact that the -.Tn SunOS -password -.Pa /etc/passwd -file is in plain -.Tn ASCII -format. -The -.Tn SunOS -documentation claims that -adding a -.Ql \&+ -entry to the password file causes the contents of -the NIS password database to be -.Dq inserted -at the position in the file where the -.Ql \&+ -entry appears. -If, for example, the -administrator places a -.Ql \&+:::::: -entry in the middle of -.Pa /etc/passwd , -then the entire contents of the NIS password map would appear -as though it had been copied into the middle of the password -file. -If the administrator places -.Ql \&+:::::: -entries at both the middle and the end of -.Pa /etc/passwd , -then the NIS password map would appear twice: once in the middle -of the file and once at the end. -(By using override entries -instead of simple wildcards, other combinations could be achieved.) -.Pp -By contrast, -.Fx -does not have a single -.Tn ASCII -password file: it -has a hashed password database. -This database does not have an -easily-defined beginning, middle or end, which makes it very hard -to design a scheme that is 100% compatible with -.Tn SunOS . -For example, -the -.Fn getpwnam -and -.Fn getpwuid -functions in -.Tn FreeBSD -are designed to do direct queries to the -hash database rather than a linear search. -This approach is faster -on systems where the password database is large. -However, when -using direct database queries, the system does not know or care -about the order of the original password file, and therefore -it cannot easily apply the same override logic used by -.Tn SunOS . +.Sh COMPAT SUPPORT +If +.Sq compat +is specified for the +.Sq passwd +database, and either +.Sq dns +or +.Sq nis +is specified for the +.Sq passwd_compat +database in +.Xr nsswitch.conf 5 , +then the +.Nm +file also supports standard +.Sq +/- +exclusions and inclusions, based on user names and netgroups. .Pp -Instead, -.Tn FreeBSD -groups all the NIS override entries together -and constructs a filter out of them. -Each NIS password entry -is compared against the override filter exactly once and -treated accordingly: if the filter allows the entry through -unaltered, it's treated unaltered; if the filter calls for remapping -of fields, then fields are remapped; if the filter calls for -explicit exclusion (i.e., the entry matches a -.Ql \&- -override), the entry is ignored; if the entry doesn't match against any -of the filter specifications, it's discarded. +Lines beginning with a ``-'' (minus sign) are entries marked as being excluded +from any following inclusions, which are marked with a ``+'' (plus sign). .Pp -Again, note that the NIS -.Ql \&+ -and -.Ql \&- -entries themselves are handled in the order in which they were specified -in the -.Pa /etc/master.passwd -file, since doing otherwise would lead to unpredictable behavior. +If the second character of the line is a ``@'' (at sign), the operation +involves the user fields of all entries in the netgroup specified by the +remaining characters of the +.Ar name +field. +Otherwise, the remainder of the +.Ar name +field is assumed to be a specific user name. .Pp -The end result is that -.Tn FreeBSD Ns 's -provides a very close approximation -of -.Tn SunOS Ns 's -behavior while maintaining the database paradigm, though the -.Xr getpwent 3 -functions do behave somewhat differently from their -.Tn SunOS -counterparts. -The primary differences are: -.Bl -bullet -offset indent -.It -Each NIS password map record can be mapped into the password -local password space only once. -.It -The placement of the NIS -.Ql \&+ +The ``+'' token may also be alone in the +.Ar name +field, which causes all users from either the Hesiod domain +.Nm +(with +.Sq passwd_compat: dns ) +or +.Sq passwd.byname and -.Ql \&- -entries does not necessarily -affect where NIS password records will be mapped into -the password space. -.El -.Pp -In 99% of all -.Tn FreeBSD -configurations, NIS client behavior will be -indistinguishable from that of -.Tn SunOS -or other similar systems. -Even -so, users should be aware of these architectural differences. +.Sq passwd.byuid +.Tn NIS +maps (with +.Sq passwd_compat: nis ) +to be included. .Pp -.Ss Using groups instead of netgroups for NIS overrides -.Tn FreeBSD -offers the capability to do override matching based on -user groups rather than netgroups. -If, for example, an NIS entry -is specified as: -.Bd -literal -offset indent -+@operator::::::::: - -.Ed -the system will first try to match users against a netgroup called -.Ql operator . -If an -.Ql operator -netgroup doesn't exist, the system -will try to match users against the normal -.Ql operator -group instead. -.Ss Changes in behavior from older versions of FreeBSD -There have been several bug fixes and improvements in -.Tn FreeBSD Ns 's -NIS/YP handling, some of which have caused changes in behavior. -While the behavior changes are generally positive, it is important -that users and system administrators be aware of them: -.Bl -enum -offset indent -.It -In versions prior to 2.0.5, reverse lookups (i.e. using -.Fn getpwuid ) -would not have overrides applied, which is to say that it -was possible for -.Fn getpwuid -to return a login name that -.Fn getpwnam -would not recognize. -This has been fixed: overrides specified -in -.Pa /etc/master.passwd -now apply to all -.Xr getpwent 3 -functions. -.It -Prior to -.Fx 2.0.5 , -netgroup overrides did not work at -all, largely because -.Tn FreeBSD -did not have support for reading -netgroups through NIS. -Again, this has been fixed, and -netgroups can be specified just as in -.Tn SunOS -and similar NIS-capable -systems. -.It -.Tn FreeBSD -now has NIS server capabilities and supports the use -of -.Pa master.passwd -NIS maps in addition to the standard Sixth Edition format -.Pa passwd -maps. -This means that you can specify change, expiration and class -information through NIS, provided you use a -.Tn FreeBSD -system as -the NIS server. -.El -.Sh FILES -.Bl -tag -width /etc/master.passwd -compact -.It Pa /etc/passwd -.Tn ASCII -password file, with passwords removed -.It Pa /etc/pwd.db -.Xr db 3 -format -password database, with passwords removed -.It Pa /etc/master.passwd -.Tn ASCII -password file, with passwords intact -.It Pa /etc/spwd.db -.Xr db 3 -format -password database, with passwords intact -.El +If the entry contains non-empty +.Ar uid +or +.Ar gid +fields, the specified numbers will override the information retrieved +from the Hesiod domain or the +.Tn NIS +maps. As well, if the +.Ar gecos, +.Ar dir +or +.Ar shell +entries contain text, it will override the information included via +Hesiod or +.Tn NIS . +On some systems, the +.Ar passwd +field may also be overridden. .Sh SEE ALSO .Xr chpass 1 , .Xr login 1 , .Xr passwd 1 , .Xr getpwent 3 , -.Xr login_getclass 3 , -.Xr yp 4 , -.Xr login.conf 5 , +.Xr netgroup 5 , .Xr adduser 8 , -.Xr pw 8 , .Xr pwd_mkdb 8 , -.Xr vipw 8 +.Xr vipw 8 , +.Xr yp 8 +.Pp +.%T "Managing NFS and NIS" +(O'Reilly & Associates) .Sh BUGS User information should (and eventually will) be stored elsewhere. .Pp -The YP/NIS password database makes encrypted passwords visible to -ordinary users, thus making password cracking easier unless you use -shadow passwords with the -.Pa master.passwd -maps and -.Tn FreeBSD Ns 's -.Xr ypserv 8 -server. -.Pp -Unless you're using -.Tn FreeBSD Ns 's -.Xr ypserv 8 , -which supports the use of -.Pa master.passwd -type maps, -the YP/NIS password database will be in old-style (Sixth Edition) format, -which means that site-wide values for user login class, password -expiration date, and other fields present in the current format -will not be available when a -.Tn FreeBSD -system is used as a client with -a standard NIS server. +Placing +Sq compat +exclusions in the file after any inclusions will have +unexpected results. .Sh COMPATIBILITY The password file format has changed since .Bx 4.3 . @@ -776,10 +322,9 @@ The additional fields and .Dq expire are added, but are turned off by default. -These fields can then be set using -.Xr vipw 8 -or -.Xr pw 8 . +Class is currently not implemented, but change and expire are; to set them, +use the current day in seconds from the epoch + whatever number of seconds +of offset you want. .Bd -literal -offset indent BEGIN { FS = ":"} { print $1 ":" $2 ":" $3 ":" $4 "::0:0:" $5 ":" $6 ":" $7 } @@ -789,14 +334,15 @@ A .Nm file format appeared in .At v6 . -The YP/NIS functionality is modeled after -.Tn SunOS -and first appeared in -.Fx 1.1 -The override capability is new in -.Fx 2.0 . -The override capability was updated to properly support netgroups -in -.Fx 2.0.5 . -Support for comments first appeared in -.Fx 3.0 . +.Pp +The +.Tn NIS +.Nm +file format first appeared in SunOS. +.Pp +The Hesiod support first appeared in +.Fx 4.1 . +It was imported from the +.Nx +Project, where it first appeared in +.Nx 1.4 . |