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

   1 '\" te
   2 .\" Copyright (C) 2004 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 3GSS "Jan 30, 2004"
   7 .SH NAME
   8 gss_inquire_cred \- obtain 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\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBconst gss_cred_id_t\fR \fIcred_handle\fR,\fBgss_name_t *\fR\fIname\fR,
  17      \fBOM_uint32 *\fR\fIlifetime\fR, \fBgss_cred_usage_t *\fR\fIcred_usage\fR,
  18      \fBgss_OID_set *\fR\fImechanisms\fR);
  19 .fi
  20
  21 .SH PARAMETERS
  22 .sp
  23 .LP
  24 The parameter descriptions for \fBgss_inquire_cred()\fR follow:
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIminor_status\fR\fR
  29 .ad
  30 .RS 16n
  31 Mechanism specific status code.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIcred_handle\fR\fR
  38 .ad
  39 .RS 16n
  40 Handle that refers to the target credential. Specify \fBGSS_C_NO_CREDENTIAL\fR
  41 to inquire about the default initiator principal.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIname\fR\fR
  48 .ad
  49 .RS 16n
  50 Name of the identity asserted by the credential. Any storage associated with
  51 this name should be freed by the application after use by a call to
  52 \fBgss_release_name\fR(3GSS).
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fIlifetime\fR\fR
  59 .ad
  60 .RS 16n
  61 Number of seconds for which the credential remains valid. If the credential has
  62 expired, this parameter will be set to zero. Specify \fBNULL\fR if the
  63 parameter is not required.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIcred_usage\fR\fR
  70 .ad
  71 .RS 16n
  72 Flag that indicates how a credential is used. The \fIcred_usage\fR parameter
  73 may contain one of the following values: \fBGSS_C_INITIATE\fR,
  74 \fBGSS_C_ACCEPT\fR, or \fBGSS_C_BOTH\fR. Specify \fBNULL\fR if this parameter
  75 is not required.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fImechanisms\fR\fR
  82 .ad
  83 .RS 16n
  84 Set of mechanisms supported by the credential. Storage for the returned
  85 \fBOID\fR-set must be freed by the application after use by a call to
  86 \fBgss_release_oid_set\fR(3GSS). Specify \fBNULL\fR if this parameter is not
  87 required.
  88 .RE
  89
  90 .SH DESCRIPTION
  91 .sp
  92 .LP
  93 Use the \fBgss_inquire_cred()\fR function to obtain information about a
  94 credential.
  95 .SH RETURN VALUES
  96 .sp
  97 .LP
  98 The \fBgss_inquire_cred()\fR function can return the following status codes:
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBGSS_S_COMPLETE\fR\fR
 103 .ad
 104 .RS 30n
 105 Successful completion.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBGSS_S_NO_CRED\fR\fR
 112 .ad
 113 .RS 30n
 114 The referenced credentials could not be accessed.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fBGSS_S_DEFECTIVE_CREDENTIAL\fR\fR
 121 .ad
 122 .RS 30n
 123 The referenced credentials were invalid.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fBGSS_S_CREDENTIALS_EXPIRED\fR\fR
 130 .ad
 131 .RS 30n
 132 The referenced credentials have expired. If the \fIlifetime\fR parameter was
 133 not passed as \fBNULL\fR, it will be set to \fB0\fR.
 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 of
 144 the \fIminor_status\fR parameter details the error condition.
 145 .RE
 146
 147 .SH ATTRIBUTES
 148 .sp
 149 .LP
 150 See \fBattributes\fR(5) for descriptions of the following attributes:
 151 .sp
 152
 153 .sp
 154 .TS
 155 box;
 156 c | c
 157 l | l .
 158 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 159 _
 160 MT-Level        Safe
 161 .TE
 162
 163 .SH SEE ALSO
 164 .sp
 165 .LP
 166 \fBgss_release_name\fR(3GSS), \fBgss_release_oid_set\fR(3GSS),
 167 \fBlibgss\fR(3LIB), \fBattributes\fR(5)
 168 .sp
 169 .LP
 170 \fISolaris Security for Developers Guide\fR