usr/src/man/man5/pam_passwd_auth.5

   1 '\" te
   2 .\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PAM_PASSWD_AUTH 5 "Aug 10, 2002"
   7 .SH NAME
   8 pam_passwd_auth \- authentication module for password
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBpam_passwd_auth.so.1\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fBpam_passwd_auth\fR provides authentication functionality to the password
  19 service as implemented by \fBpasswd\fR(1). It differs from the standard
  20 \fBPAM\fR authentication modules in its prompting behavior. It should be the
  21 first module on the password service authentication stack.
  22 .sp
  23 .LP
  24 The name of the user whose password attributes are to be updated must be
  25 present in the \fBPAM_USER\fR item. This can be accomplished due to a previous
  26 call to \fBpam_start\fR(3PAM), or explicitly set by \fBpam_set_item\fR(3PAM).
  27 Based on the current user-id and the repository that is to by updated, the
  28 module determines whether a password is necessary for a successful update of
  29 the password repository, and if so, which password is required.
  30 .sp
  31 .LP
  32 The following options can be passed to the module:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fBdebug\fR\fR
  37 .ad
  38 .RS 17n
  39 \fBsyslog\fR(3C) debugging information at the \fBLOG_DEBUG\fR level
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBnowarn\fR\fR
  46 .ad
  47 .RS 17n
  48 Turn off warning messages
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBserver_policy\fR\fR
  55 .ad
  56 .RS 17n
  57 If the account authority for the user, as specified by \fBPAM_USER\fR, is a
  58 server, do not apply the Unix policy from the passwd entry in the name service
  59 switch.
  60 .RE
  61
  62 .SH ERRORS
  63 .sp
  64 .LP
  65 The following error codes are returned:
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBPAM_BUF_ERR\fR\fR
  70 .ad
  71 .RS 18n
  72 Memory buffer error
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBPAM_IGNORE\fR\fR
  79 .ad
  80 .RS 18n
  81 Ignore module, not participating in result
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBPAM_SUCCESS\fR\fR
  88 .ad
  89 .RS 18n
  90 Successfully obtains authentication token
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBPAM_SYSTEM_ERR\fR\fR
  97 .ad
  98 .RS 18n
  99 System error
 100 .RE
 101
 102 .SH ATTRIBUTES
 103 .sp
 104 .LP
 105 See \fBattributes\fR(5) for descriptions of the following attributes:
 106 .sp
 107
 108 .sp
 109 .TS
 110 box;
 111 c | c
 112 l | l .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Evolving
 116 _
 117 MT Level        MT-Safe with exceptions
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBpasswd\fR(1), \fBpam\fR(3PAM), \fBpam_authenticate\fR(3PAM),
 124 \fBpam_start\fR(3PAM), \fBpam_set_item\fR(3PAM), \fBsyslog\fR(3C),
 125 \fBlibpam\fR(3LIB), \fBpam.conf\fR(4), \fBattributes\fR(5),
 126 \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5),
 127 \fBpam_authtok_store\fR(5), \fBpam_dhkeys\fR(5), \fBpam_unix_account\fR(5),
 128 \fBpam_unix_auth\fR(5), \fBpam_unix_session\fR(5)
 129 .SH NOTES
 130 .sp
 131 .LP
 132 The interfaces in \fBlibpam\fR(3LIB) are MT-Safe only if each thread within the
 133 multi-threaded application uses its own PAM handle.
 134 .sp
 135 .LP
 136 This module relies on the value of the current real \fBUID\fR, this module is
 137 only safe for MT-applications that don't change \fBUID\fRs during the call to
 138 \fBpam_authenticate\fR(3PAM).
 139 .sp
 140 .LP
 141 The \fBpam_unix\fR(5) module is no longer supported. Similar functionality is
 142 provided by \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5),
 143 \fBpam_authtok_store\fR(5), \fBpam_dhkeys\fR(5), \fBpam_passwd_auth\fR(5),
 144 \fBpam_unix_account\fR(5), \fBpam_unix_auth\fR(5), and
 145 \fBpam_unix_session\fR(5).