usr/src/man/man5/pam_authtok_store.5

   1 '\" te
   2 .\" Copyright (C) 2002, 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_AUTHTOK_STORE 5 "Jan 26, 2004"
   8 .SH NAME
   9 pam_authtok_store \- password management module
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBpam_authtok_store.so.1\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 \fBpam_authtok_store\fR provides functionality to the PAM password management
  20 stack. It provides one function: \fBpam_sm_chauthtok()\fR.
  21 .sp
  22 .LP
  23 When invoked with flags set to \fBPAM_UPDATE_AUTHTOK\fR, this module updates
  24 the authentication token for the user specified by \fBPAM_USER\fR.
  25 .sp
  26 .LP
  27 The authentication token \fBPAM_OLDAUTHTOK\fR can be used to authenticate the
  28 user against repositories that need updating (\fBNIS\fR, \fBLDAP\fR). After
  29 successful updates, the new authentication token stored in \fBPAM_AUTHTOK\fR is
  30 the user's valid password.
  31 .sp
  32 .LP
  33 This module honors the \fBPAM_REPOSITORY\fR item, which, if set, specifies
  34 which repository is to be updated. If \fBPAM_REPOSITORY\fR is unset, it follows
  35 the \fBnsswitch.conf\fR(4).
  36 .sp
  37 .LP
  38 The following option can be passed to the module:
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBdebug\fR\fR
  43 .ad
  44 .RS 17n
  45 \fBsyslog\fR(3C) debugging information at the \fBLOG_DEBUG\fR level
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBserver_policy\fR\fR
  52 .ad
  53 .RS 17n
  54 If the account authority for the user, as specified by \fBPAM_USER\fR, is a
  55 server, do not encrypt the authentication token before updating.
  56 .RE
  57
  58 .SH ERRORS
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBPAM_SUCCESS\fR\fR
  63 .ad
  64 .RS 18n
  65 Successfully obtains authentication token
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBPAM_SYSTEM_ERR\fR\fR
  72 .ad
  73 .RS 18n
  74 Fails to get username, service name, old password or new password, user name
  75 null or empty, or password null.
  76 .RE
  77
  78 .SH ATTRIBUTES
  79 .sp
  80 .LP
  81 See \fBattributes\fR(5) for descriptions of the following attributes:
  82 .sp
  83
  84 .sp
  85 .TS
  86 box;
  87 c | c
  88 l | l .
  89 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  90 _
  91 Interface Stability     Evolving
  92 _
  93 MT Level        MT-Safe with exceptions
  94 .TE
  95
  96 .SH SEE ALSO
  97 .sp
  98 .LP
  99 \fBpam\fR(3PAM), \fBpam_authenticate\fR(3PAM), \fBpam_chauthtok\fR(3PAM),
 100 \fBsyslog\fR(3C), \fBlibpam\fR(3LIB), \fBpam.conf\fR(4), \fBattributes\fR(5),
 101 \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5), \fBpam_dhkeys\fR(5),
 102 \fBpam_passwd_auth\fR(5), \fBpam_unix_account\fR(5), \fBpam_unix_auth\fR(5),
 103 \fBpam_unix_session\fR(5)
 104 .SH NOTES
 105 .sp
 106 .LP
 107 The interfaces in \fBlibpam\fR(3LIB) are MT-Safe only if each thread within the
 108 multi-threaded application uses its own \fBPAM\fR handle.
 109 .sp
 110 .LP
 111 The \fBpam_unix\fR(5) module is no longer supported. Similar functionality is
 112 provided by \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5),
 113 \fBpam_authtok_store\fR(5), \fBpam_dhkeys\fR(5), \fBpam_passwd_auth\fR(5),
 114 \fBpam_unix_account\fR(5), \fBpam_unix_auth\fR(5), and
 115 \fBpam_unix_session\fR(5).
 116 .sp
 117 .LP
 118 If the \fBPAM_REPOSITORY\fR \fIitem_type\fR is set and a service module does
 119 not recognize the type, the service module does not process any information,
 120 and returns \fBPAM_IGNORE\fR. If the \fBPAM_REPOSITORY\fR \fIitem_type\fR is
 121 not set, a service module performs its default action.