share/man/man3pam/pam_chauthtok.3pam

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.
   3 .\" All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH PAM_CHAUTHTOK 3PAM "Mar 1, 2005"
   8 .SH NAME
   9 pam_chauthtok \- perform password related functions within the PAM framework
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lpam\fR [ \fIlibrary\fR ... ]
  14 #include <security/pam_appl.h>
  15
  16 \fBint\fR \fBpam_chauthtok\fR(\fBpam_handle_t *\fR\fIpamh\fR, \fBconst int\fR \fIflags\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBpam_chauthtok()\fR function is called to change the authentication token
  23 associated with a particular user referenced by the authentication handle
  24 \fIpamh\fR.
  25 .sp
  26 .LP
  27 The following flag may be passed in to \fBpam_chauthtok()\fR:
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fBPAM_SILENT\fR\fR
  32 .ad
  33 .RS 30n
  34 The password service should not generate any messages.
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBPAM_CHANGE_EXPIRED_AUTHTOK\fR\fR
  41 .ad
  42 .RS 30n
  43 The password service should only update those passwords that have aged. If this
  44 flag is not passed, all password services should update their passwords.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBPAM_NO_AUTHTOK_CHECK\fR\fR
  51 .ad
  52 .RS 30n
  53 The password service should not perform conformance checks on the password
  54 entered.
  55 .RE
  56
  57 .sp
  58 .LP
  59 Upon successful completion of the call, the authentication token of the user
  60 will be changed in accordance with the password service configured in the
  61 system through \fBpam.conf\fR(4).
  62 .SH RETURN VALUES
  63 .sp
  64 .LP
  65 Upon successful completion, \fBPAM_SUCCESS\fR is returned. In addition to the
  66 error return values described in \fBpam\fR(3PAM), the following values may be
  67 returned:
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBPAM_PERM_DENIED\fR\fR
  72 .ad
  73 .RS 29n
  74 No permission.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBPAM_AUTHTOK_ERR\fR\fR
  81 .ad
  82 .RS 29n
  83 Authentication token manipulation error.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBPAM_AUTHTOK_RECOVERY_ERR\fR\fR
  90 .ad
  91 .RS 29n
  92 Authentication information cannot be recovered.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBPAM_AUTHTOK_LOCK_BUSY\fR\fR
  99 .ad
 100 .RS 29n
 101 Authentication token lock busy.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBPAM_AUTHTOK_DISABLE_AGING\fR\fR
 108 .ad
 109 .RS 29n
 110 Authentication token aging disabled.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBPAM_USER_UNKNOWN\fR\fR
 117 .ad
 118 .RS 29n
 119 User unknown to password service.
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fBPAM_TRY_AGAIN\fR\fR
 126 .ad
 127 .RS 29n
 128 Preliminary check by password service failed.
 129 .RE
 130
 131 .SH ATTRIBUTES
 132 .sp
 133 .LP
 134 See \fBattributes\fR(5) for description of the following attributes:
 135 .sp
 136
 137 .sp
 138 .TS
 139 box;
 140 c | c
 141 l | l .
 142 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 143 _
 144 Interface Stability      Stable
 145 _
 146 MT-Level        MT-Safe with exceptions
 147 .TE
 148
 149 .SH SEE ALSO
 150 .sp
 151 .LP
 152 \fBlogin\fR(1), \fBpasswd\fR(1), \fBpam\fR(3PAM), \fBpam_authenticate\fR(3PAM),
 153 \fBpam_start\fR(3PAM), \fBattributes\fR
 154 .SH NOTES
 155 .sp
 156 .LP
 157 The flag \fBPAM_CHANGE_EXPIRED_AUTHTOK\fR is typically used by a \fBlogin\fR
 158 application which has determined that the user's password has aged or expired.
 159 Before allowing the user to login, the \fBlogin\fR application may invoke
 160 \fBpam_chauthtok()\fR with this flag to allow the user to update the password.
 161 Typically, applications such as \fBpasswd\fR(1) should not use this flag.
 162 .sp
 163 .LP
 164 The \fBpam_chauthtok()\fR functions performs a preliminary check before
 165 attempting to update passwords. This check is performed for each password
 166 module in the stack as listed in \fBpam.conf\fR(4). The check may include
 167 pinging remote name services to determine if they are available. If
 168 \fBpam_chauthtok()\fR returns \fBPAM_TRY_AGAIN\fR, then the check has failed,
 169 and passwords are not updated.
 170 .sp
 171 .LP
 172 The flag \fBPAM_NO_AUTHTOK_CHECK\fR is typically used by programs that allow an
 173 administrator to bypass various password conformance checks when setting a
 174 password for a user.
 175 .sp
 176 .LP
 177 The interfaces in \fBlibpam\fR are MT-Safe only if each thread within the
 178 multithreaded application uses its own \fBPAM\fR handle.