summaryrefslogtreecommitdiff
path: root/usr/src/man/man3gss/gss_release_cred.3gss
blob: 050e1a13c676c470cd7b4c4d042f54857dca3040 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
'\" te
.\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.\" 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.
.\" 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.
.\" 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]
.TH gss_release_cred 3GSS "15 Jan 2003" "SunOS 5.11" "Generic Security Services API Library Functions"
.SH NAME
gss_release_cred \- discard a credential handle
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ] 
#include <gssapi/gssapi.h>

\fBOM_uint32\fR \fBgss_release_cred\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
     \fBgss_cred_id_t *\fR\fIcred_handle\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBgss_release_cred()\fR function informs the \fBGSS-API\fR that the
specified credential handle is no longer required by the application and frees
the associated resources. The \fIcred_handle\fR parameter is set to
\fBGSS_C_NO_CREDENTIAL\fR when this call completes successfully.
.SH PARAMETERS
.sp
.LP
The parameter descriptions for \fBgss_release_cred()\fR follow:
.sp
.ne 2
.mk
.na
\fB\fIminor_status\fR\fR
.ad
.RS 16n
.rt  
A mechanism specific status code.
.RE

.sp
.ne 2
.mk
.na
\fB\fIcred_handle\fR\fR
.ad
.RS 16n
.rt  
An opaque handle that identifies the credential to be released. If
\fBGSS_C_NO_CREDENTIAL\fR is specified, the \fBgss_release_cred()\fR function
will complete successfully, but it will do nothing.
.RE

.SH ERRORS
.sp
.LP
\fBgss_release_cred()\fR may return the following status codes:
.sp
.ne 2
.mk
.na
\fB\fBGSS_S_COMPLETE\fR\fR
.ad
.RS 18n
.rt  
Successful completion.
.RE

.sp
.ne 2
.mk
.na
\fB\fBGSS_S_NO_CRED\fR\fR
.ad
.RS 18n
.rt  
The referenced credentials cannot be accessed.
.RE

.sp
.ne 2
.mk
.na
\fB\fBGSS_S_FAILURE\fR\fR
.ad
.RS 18n
.rt  
The underlying mechanism detected an error for which no specific \fBGSS\fR
status code is defined.  The mechanism-specific status code reported by means
of the \fIminor_status\fR parameter details the error condition.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5)  for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBattributes\fR(5)
.sp
.LP
\fISolaris Security for Developers Guide\fR