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

   1 '\" te
   2 .\" Copyright (C) 2003, 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_RELEASE_CRED 3GSS "Jan 15, 2003"
   7 .SH NAME
   8 gss_release_cred \- discard a credential handle
   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_release_cred\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBgss_cred_id_t *\fR\fIcred_handle\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBgss_release_cred()\fR function informs the \fBGSS-API\fR that the
  23 specified credential handle is no longer required by the application and frees
  24 the associated resources. The \fIcred_handle\fR parameter is set to
  25 \fBGSS_C_NO_CREDENTIAL\fR when this call completes successfully.
  26 .SH PARAMETERS
  27 .sp
  28 .LP
  29 The parameter descriptions for \fBgss_release_cred()\fR follow:
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIminor_status\fR\fR
  34 .ad
  35 .RS 16n
  36 A mechanism specific status code.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIcred_handle\fR\fR
  43 .ad
  44 .RS 16n
  45 An opaque handle that identifies the credential to be released. If
  46 \fBGSS_C_NO_CREDENTIAL\fR is specified, the \fBgss_release_cred()\fR function
  47 will complete successfully, but it will do nothing.
  48 .RE
  49
  50 .SH ERRORS
  51 .sp
  52 .LP
  53 \fBgss_release_cred()\fR may return the following status codes:
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBGSS_S_COMPLETE\fR\fR
  58 .ad
  59 .RS 18n
  60 Successful completion.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBGSS_S_NO_CRED\fR\fR
  67 .ad
  68 .RS 18n
  69 The referenced credentials cannot be accessed.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBGSS_S_FAILURE\fR\fR
  76 .ad
  77 .RS 18n
  78 The underlying mechanism detected an error for which no specific \fBGSS\fR
  79 status code is defined.  The mechanism-specific status code reported by means
  80 of the \fIminor_status\fR parameter details the error condition.
  81 .RE
  82
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5)  for descriptions of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 c | c
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 MT-Level        Safe
  97 .TE
  98
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBattributes\fR(5)
 103 .sp
 104 .LP
 105 \fISolaris Security for Developers Guide\fR