usr/src/man/man3gss/gss_inquire_cred_by_mech.3gss

   1 '\" te
   2 .\" Copyright (c) 2007, 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 GSS_INQUIRE_CRED_BY_MECH 3GSS "Aug 15, 2007"
   7 .SH NAME
   8 gss_inquire_cred_by_mech \- obtain per-mechanism information about a credential
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ]
  13 #include <gssapi/gssapi.h>
  14
  15 \fBOM_uint32\fR \fBgss_inquire_cred_by_mech\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBconst gss_cred_id_t\fR \fIcred_handle\fR,\fBconst gss_OID\fR \fImech_type\fR,
  17      \fBgss_name_t *\fR\fIname\fR, \fBOM_uint32 *\fR\fIinitiator_lifetime\fR,
  18      \fBOM_uint32 *\fR\fIacceptor_lifetime\fR, \fBgss_cred_usage_t *\fR\fIcred_usage\fR);
  19 .fi
  20
  21 .SH PARAMETERS
  22 .sp
  23 .ne 2
  24 .na
  25 \fB\fIacceptor_lifetime\fR\fR
  26 .ad
  27 .RS 22n
  28 The number of seconds that the credential is capable of accepting security
  29 contexts under the specified mechanism. If the credential can no longer be used
  30 to accept contexts, or if the credential usage for this mechanism is
  31 \fBGSS_C_INITIATE\fR, this parameter will be set to \fB0\fR. Specify \fBNULL\fR
  32 if this parameter is not required.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fIcred_handle\fR\fR
  39 .ad
  40 .RS 22n
  41 A handle that refers to the target credential. Specify
  42 \fBGSS_C_NO_CREDENTIAL\fR to inquire about the default initiator principal.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIcred_usage\fR\fR
  49 .ad
  50 .RS 22n
  51 How the credential may be used with the specified mechanism. The
  52 \fIcred_usage\fR parameter may contain one of the following values:
  53 \fBGSS_C_INITIATE\fR, \fBGSS_C_ACCEPT\fR, or \fBGSS_C_BOTH\fR. Specify
  54 \fBNULL\fR if this parameter is not required.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIinitiator_lifetime\fR\fR
  61 .ad
  62 .RS 22n
  63 The number of seconds that the credential is capable of initiating security
  64 contexts under the specified mechanism. If the credential can no longer be used
  65 to initiate contexts, or if the credential usage for this mechanism is
  66 \fBGSS_C_ACCEPT\fR, this parameter will be set to \fB0\fR. Specify \fBNULL\fR
  67 if this parameter is not required.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fImech_type\fR\fR
  74 .ad
  75 .RS 22n
  76 The mechanism for which the information should be returned.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fIminor_status\fR\fR
  83 .ad
  84 .RS 22n
  85 A mechanism specific status code.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fIname\fR\fR
  92 .ad
  93 .RS 22n
  94 The name whose identity the credential asserts. Any storage associated with
  95 this \fIname\fR must be freed by the application after use by a call to
  96 \fBgss_release_name\fR(3GSS).
  97 .RE
  98
  99 .SH DESCRIPTION
 100 .sp
 101 .LP
 102 The \fBgss_inquire_cred_by_mech()\fR function obtains per-mechanism information
 103 about a credential.
 104 .SH ERRORS
 105 .sp
 106 .LP
 107 The \fBgss_inquire_cred_by_mech()\fR function can return the following status
 108 codes:
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBGSS_S_COMPLETE\fR\fR
 113 .ad
 114 .RS 30n
 115 Successful completion.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBGSS_S_CREDENTIALS_EXPIRED\fR\fR
 122 .ad
 123 .RS 30n
 124 The credentials cannot be added because they have expired.
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBGSS_S_DEFECTIVE_CREDENTIAL\fR\fR
 131 .ad
 132 .RS 30n
 133 The referenced credentials are invalid.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBGSS_S_FAILURE\fR\fR
 140 .ad
 141 .RS 30n
 142 The underlying mechanism detected an error for which no specific \fBGSS\fR
 143 status code is defined.  The mechanism-specific status code reported by means
 144 of the \fIminor_status\fR parameter details the error condition.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBGSS_S_NO_CRED\fR\fR
 151 .ad
 152 .RS 30n
 153 The referenced credentials cannot be accessed.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fBGSS_S_UNAVAILABLE\fR\fR
 160 .ad
 161 .RS 30n
 162 The \fBgss_inquire_cred_by_mech()\fR function is not available for the
 163 specified mechanism type.
 164 .RE
 165
 166 .SH ATTRIBUTES
 167 .sp
 168 .LP
 169 See \fBattributes\fR(5)  for descriptions of the following attributes:
 170 .sp
 171
 172 .sp
 173 .TS
 174 box;
 175 c | c
 176 l | l .
 177 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 178 _
 179 MT-Level        Safe
 180 .TE
 181
 182 .SH SEE ALSO
 183 .sp
 184 .LP
 185 \fBgss_release_name\fR(3GSS), \fBattributes\fR(5)
 186 .sp
 187 .LP
 188 \fISolaris Security for Developers Guide\fR