usr/src/man/man3gss/gss_delete_sec_context.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_DELETE_SEC_CONTEXT 3GSS "Jan 15, 2003"
   7 .SH NAME
   8 gss_delete_sec_context \- delete a GSS-API security context
   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_delete_sec_context\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBgss_ctx_id_t *\fR\fIcontext_handle\fR,\fBgss_buffer_t\fR \fIoutput_token\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 Use the \fBgss_delete_sec_context()\fR function to delete a security context.
  23 The \fBgss_delete_sec_context()\fR function will delete the local data
  24 structures associated with the specified security context.  You may not obtain
  25 further security services that use the context specified by
  26 \fIcontext_handle\fR.
  27 .sp
  28 .LP
  29 In addition to deleting established security contexts,
  30 \fBgss_delete_sec_context()\fR will delete any half-built security contexts
  31 that result from incomplete sequences of calls to
  32 \fBgss_init_sec_context\fR(3GSS) and  \fBgss_accept_sec_context\fR(3GSS).
  33 .sp
  34 .LP
  35 The Solaris implementation of the \fBGSS-API\fR retains the \fIoutput_token\fR
  36 parameter for compatibility with version 1 of the \fBGSS-API\fR.  Both peer
  37 applications should invoke \fBgss_delete_sec_context()\fR, passing the value
  38 \fBGSS_C_NO_BUFFER\fR to the \fIoutput_token\fR parameter; this indicates that
  39 no token is required.  If the application passes a valid buffer to
  40 \fBgss_delete_sec_context()\fR, it will return a zero-length token, indicating
  41 that no token should be transferred by the application.
  42 .SH PARAMETERS
  43 .sp
  44 .LP
  45 The parameter descriptions for \fBgss_delete_sec_context()\fR follow:
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fIminor_status\fR\fR
  50 .ad
  51 .RS 18n
  52 A mechanism specific status code.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fIcontext_handle\fR\fR
  59 .ad
  60 .RS 18n
  61 Context handle identifying specific context to delete. After deleting the
  62 context, the \fBGSS-API\fR will set \fIcontext_handle\fR to
  63 \fBGSS_C_NO_CONTEXT\fR.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIoutput_token\fR\fR
  70 .ad
  71 .RS 18n
  72 A token to be sent to remote applications that instructs them to delete the
  73 context.
  74 .RE
  75
  76 .SH ERRORS
  77 .sp
  78 .LP
  79 \fBgss_delete_sec_context()\fR may return the following status codes:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBGSS_S_COMPLETE\fR\fR
  84 .ad
  85 .RS 20n
  86 Successful completion.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBGSS_S_NO_CONTEXT\fR\fR
  93 .ad
  94 .RS 20n
  95 No valid context was supplied.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBGSS_S_FAILURE\fR\fR
 102 .ad
 103 .RS 20n
 104 The underlying mechanism detected an error for which no specific \fBGSS\fR
 105 status code is defined.  The mechanism-specific status code reported by means
 106 of the \fIminor_status\fR parameter details the error condition.
 107 .RE
 108
 109 .SH ATTRIBUTES
 110 .sp
 111 .LP
 112 See \fBattributes\fR(5)  for descriptions of the following attributes:
 113 .sp
 114
 115 .sp
 116 .TS
 117 box;
 118 c | c
 119 l | l .
 120 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 121 _
 122 MT-Level        Safe
 123 .TE
 124
 125 .SH SEE ALSO
 126 .sp
 127 .LP
 128 \fBgss_accept_sec_context\fR(3GSS), \fBgss_init_sec_context\fR(3GSS),
 129 \fBattributes\fR(5)
 130 .sp
 131 .LP
 132 \fISolaris Security for Developers Guide\fR