lib/libpam/modules/pam_unix/pam_unix.8

   1 .\" Copyright (c) 2001 Mark R V Murray
   2 .\" All rights reserved.
   3 .\" Copyright (c) 2001 Networks Associates Technology, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   7 .\" NAI Labs, the Security Research Division of Network Associates, Inc.
   8 .\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
   9 .\" DARPA CHATS research program.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. The name of the author may not be used to endorse or promote
  20 .\"    products derived from this software without specific prior written
  21 .\"    permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\" $FreeBSD$
  36 .\"
  37 .Dd March 27, 2007
  38 .Dt PAM_UNIX 8
  39 .Os
  40 .Sh NAME
  41 .Nm pam_unix
  42 .Nd UNIX PAM module
  43 .Sh SYNOPSIS
  44 .Op Ar service-name
  45 .Ar module-type
  46 .Ar control-flag
  47 .Pa pam_unix
  48 .Op Ar options
  49 .Sh DESCRIPTION
  50 The
  51 .Ux
  52 authentication service module for PAM,
  53 .Nm
  54 provides functionality for three PAM categories:
  55 authentication,
  56 account management, and password management.
  57 In terms of the
  58 .Ar module-type
  59 parameter, they are the
  60 .Dq Li auth ,
  61 .Dq Li account ,
  62 and
  63 .Dq Li password
  64 features.
  65 It also provides a null function for session management.
  66 .Ss Ux Ss Authentication Module
  67 The
  68 .Ux
  69 authentication component
  70 provides functions to verify the identity of a user
  71 .Pq Fn pam_sm_authenticate ,
  72 which obtains the relevant
  73 .Xr passwd 5
  74 entry.
  75 It prompts the user for a password
  76 and verifies that this is correct with
  77 .Xr crypt 3 .
  78 .Pp
  79 The following options may be passed to the authentication module:
  80 .Bl -tag -width ".Cm use_first_pass"
  81 .It Cm debug
  82 .Xr syslog 3
  83 debugging information at
  84 .Dv LOG_DEBUG
  85 level.
  86 .It Cm use_first_pass
  87 If the authentication module
  88 is not the first in the stack,
  89 and a previous module
  90 obtained the user's password,
  91 that password is used
  92 to authenticate the user.
  93 If this fails,
  94 the authentication module returns failure
  95 without prompting the user for a password.
  96 This option has no effect
  97 if the authentication module
  98 is the first in the stack,
  99 or if no previous modules
 100 obtained the user's password.
 101 .It Cm try_first_pass
 102 This option is similar to the
 103 .Cm use_first_pass
 104 option,
 105 except that if the previously obtained password fails,
 106 the user is prompted for another password.
 107 .It Cm auth_as_self
 108 This option will require the user
 109 to authenticate himself as the user
 110 given by
 111 .Xr getlogin 2 ,
 112 not as the account they are attempting to access.
 113 This is primarily for services like
 114 .Xr su 1 ,
 115 where the user's ability to retype
 116 their own password
 117 might be deemed sufficient.
 118 .It Cm nullok
 119 If the password database
 120 has no password
 121 for the entity being authenticated,
 122 then this option
 123 will forgo password prompting,
 124 and silently allow authentication to succeed.
 125 .It Cm local_pass
 126 Use only the local password database,
 127 even if NIS is in use.
 128 This will cause an authentication failure
 129 if the system is configured
 130 to only use NIS.
 131 .It Cm nis_pass
 132 Use only the NIS password database.
 133 This will cause an authentication failure
 134 if the system is not configured
 135 to use NIS.
 136 .El
 137 .Ss Ux Ss Account Management Module
 138 The
 139 .Ux
 140 account management component
 141 provides a function to perform account management,
 142 .Fn pam_sm_acct_mgmt .
 143 The function verifies
 144 that the authenticated user
 145 is allowed to log into the local user account
 146 by checking the following criteria:
 147 .Bl -dash -offset indent
 148 .It
 149 locked status of the account compatible with
 150 .Xr pw 8
 151 .Cm lock ;
 152 .It
 153 the password expiry date from
 154 .Xr passwd 5 ;
 155 .It
 156 .Xr login.conf 5
 157 restrictions on the remote host, login time, and tty.
 158 .El
 159 .Pp
 160 The following options may be passed to the management module:
 161 .Bl -tag -width ".Cm use_first_pass"
 162 .It Cm debug
 163 .Xr syslog 3
 164 debugging information at
 165 .Dv LOG_DEBUG
 166 level.
 167 .El
 168 .Ss Ux Ss Password Management Module
 169 The
 170 .Ux
 171 password management component
 172 provides a function to perform password management,
 173 .Fn pam_sm_chauthtok .
 174 The function changes
 175 the user's password.
 176 .Pp
 177 The following options may be passed to the password module:
 178 .Bl -tag -width ".Cm use_first_pass"
 179 .It Cm debug
 180 .Xr syslog 3
 181 debugging information at
 182 .Dv LOG_DEBUG
 183 level.
 184 .It Cm no_warn
 185 suppress warning messages to the user.
 186 These messages include
 187 reasons why the user's
 188 authentication attempt was declined.
 189 .It Cm local_pass
 190 forces the password module
 191 to change a local password
 192 in favour of a NIS one.
 193 .It Cm nis_pass
 194 forces the password module
 195 to change a NIS password
 196 in favour of a local one.
 197 .El
 198 .Sh FILES
 199 .Bl -tag -width ".Pa /etc/master.passwd" -compact
 200 .It Pa /etc/master.passwd
 201 default
 202 .Ux
 203 password database.
 204 .El
 205 .Sh SEE ALSO
 206 .Xr passwd 1 ,
 207 .Xr getlogin 2 ,
 208 .Xr crypt 3 ,
 209 .Xr getpwent 3 ,
 210 .Xr syslog 3 ,
 211 .Xr nsswitch.conf 5 ,
 212 .Xr passwd 5 ,
 213 .Xr pam 8 ,
 214 .Xr pw 8 ,
 215 .Xr yp 8