usr/src/man/man3pam/pam_sm_setcred.3pam

   1 '\" te
   2 .\"  Copyright (c) 1998, 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_SM_SETCRED 3PAM "Nov 18, 2003"
   7 .SH NAME
   8 pam_sm_setcred \- service provider implementation for pam_setcred
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lpam\fR [ \fIlibrary\fR ... ]
  13 #include <security/pam_appl.h>
  14 #include <security/pam_modules.h>
  15
  16
  17
  18 \fBint\fR \fBpam_sm_setcred\fR(\fBpam_handle_t *\fR\fIpamh\fR, \fBint\fR \fIflags\fR, \fBint\fR \fIargc\fR,
  19      \fBconst char **\fR\fIargv\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 In response to a call to \fBpam_setcred\fR(3PAM), the  \fBPAM\fR framework
  26 calls \fBpam_sm_setcred()\fR from the modules listed in the \fBpam.conf\fR(4)
  27 file.  The authentication provider supplies the back-end functionality for this
  28 interface function.
  29 .sp
  30 .LP
  31 The \fBpam_sm_setcred()\fR function is called to set the credentials of the
  32 current user associated with the authentication handle, \fIpamh\fR. The
  33 following flags may be set in the \fIflags\fR field.  Note that the first four
  34 flags are mutually exclusive:
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fBPAM_ESTABLISH_CRED\fR\fR
  39 .ad
  40 .RS 25n
  41 Set user credentials for the authentication service.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBPAM_DELETE_CRED\fR\fR
  48 .ad
  49 .RS 25n
  50 Delete user credentials associated with the authentication service.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBPAM_REINITIALIZE_CRED\fR\fR
  57 .ad
  58 .RS 25n
  59 Reinitialize user credentials.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBPAM_REFRESH_CRED\fR\fR
  66 .ad
  67 .RS 25n
  68 Extend lifetime of user credentials.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBPAM_SILENT\fR\fR
  75 .ad
  76 .RS 25n
  77 Authentication service should not generate messages
  78 .RE
  79
  80 .sp
  81 .LP
  82 If no flag is set,  \fBPAM_ESTABLISH\fR \fB_CRED\fR is used as the default.
  83 .sp
  84 .LP
  85 The \fIargc\fR argument represents the number of module options passed in from
  86 the configuration file \fBpam.conf\fR(4). \fIargv\fR specifies the module
  87 options, which are interpreted and processed by the authentication service.  If
  88 an unknown option is passed to the  module, an error should be logged and the
  89 option ignored.
  90 .sp
  91 .LP
  92 If the  \fBPAM_SILENT\fR flag is not set, then \fBpam_sm_setcred()\fR should
  93 print any failure status from the corresponding  \fBpam_sm_authenticate()\fR
  94 function using the conversation function.
  95 .sp
  96 .LP
  97 The authentication status (success or reason for failure) is saved as
  98 module-specific state in the authentication handle by the authentication
  99 module. The status should be retrieved using \fBpam_get_data()\fR, and used to
 100 determine if user credentials should be set.
 101 .SH RETURN VALUES
 102 .sp
 103 .LP
 104 Upon successful completion,  \fBPAM_SUCCESS\fR should be returned. The
 105 following values may also be returned upon error:
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBPAM_CRED_UNAVAIL\fR\fR
 110 .ad
 111 .RS 20n
 112 Underlying authentication service can not retrieve user credentials.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBPAM_CRED_EXPIRED\fR\fR
 119 .ad
 120 .RS 20n
 121 User credentials have expired.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBPAM_USER_UNKNOWN\fR\fR
 128 .ad
 129 .RS 20n
 130 User unknown to the authentication service.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBPAM_CRED_ERR\fR\fR
 137 .ad
 138 .RS 20n
 139 Failure in setting user credentials.
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fBPAM_IGNORE\fR\fR
 146 .ad
 147 .RS 20n
 148 Ignore underlying authentication module regardless of whether the control flag
 149 is \fIrequired\fR,\fIoptional\fR, or  \fIsufficient\fR.
 150 .RE
 151
 152 .SH ATTRIBUTES
 153 .sp
 154 .LP
 155 See \fBattributes\fR(5) for description of the following attributes:
 156 .sp
 157
 158 .sp
 159 .TS
 160 box;
 161 c | c
 162 l | l .
 163 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 164 _
 165 Interface Stability      Stable
 166 _
 167 MT-Level        MT-Safe with exceptions
 168 .TE
 169
 170 .SH SEE ALSO
 171 .sp
 172 .LP
 173 \fBpam\fR(3PAM), \fBpam_authenticate\fR(3PAM), \fBpam_get_data\fR(3PAM)
 174 \fBpam_setcred\fR(3PAM), \fBpam_sm_authenticate\fR(3PAM), \fBlibpam\fR(3LIB),
 175 \fBpam.conf\fR(4), \fBattributes\fR(5)
 176 .SH NOTES
 177 .sp
 178 .LP
 179 The \fBpam_sm_setcred()\fR function is passed the same module options that are
 180 used by \fBpam_sm_authenticate()\fR.
 181 .sp
 182 .LP
 183 The interfaces in  \fBlibpam\fR are MT-Safe only if each thread within the
 184 multithreaded application uses its own  \fBPAM\fR handle.
 185 .sp
 186 .LP
 187 If the \fBPAM_REPOSITORY\fR \fIitem_type\fR is set and a service module does
 188 not recognize the type, the service module does not process any information,
 189 and returns \fBPAM_IGNORE\fR. If the \fBPAM_REPOSITORY\fR \fIitem_type\fR is
 190 not set, a service module performs its default action.