1.\" -*- nroff -*- 2.\" 3.\" Copyright (c) 2005 Doug Rabson 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" $FreeBSD$ 28.\" 29.\" Copyright (C) The Internet Society (2000). All Rights Reserved. 30.\" 31.\" This document and translations of it may be copied and furnished to 32.\" others, and derivative works that comment on or otherwise explain it 33.\" or assist in its implementation may be prepared, copied, published 34.\" and distributed, in whole or in part, without restriction of any 35.\" kind, provided that the above copyright notice and this paragraph are 36.\" included on all such copies and derivative works. However, this 37.\" document itself may not be modified in any way, such as by removing 38.\" the copyright notice or references to the Internet Society or other 39.\" Internet organizations, except as needed for the purpose of 40.\" developing Internet standards in which case the procedures for 41.\" copyrights defined in the Internet Standards process must be 42.\" followed, or as required to translate it into languages other than 43.\" English. 44.\" 45.\" The limited permissions granted above are perpetual and will not be 46.\" revoked by the Internet Society or its successors or assigns. 47.\" 48.\" This document and the information contained herein is provided on an 49.\" "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 50.\" TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 51.\" BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 52.\" HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 53.\" MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 54.\" 55.\" The following commands are required for all man pages. 56.Dd November 12, 2005 57.Os 58.Dt GSS_DELETE_SEC_CONTEXT 3 PRM 59.Sh NAME 60.Nm gss_delete_sec_context 61.Nd Discard a security context 62.\" This next command is for sections 2 and 3 only. 63.\" .Sh LIBRARY 64.Sh SYNOPSIS 65.In "gssapi/gssapi.h" 66.Ft OM_uint32 67.Fo gss_delete_sec_context 68.Fa "OM_uint32 *minor_status" 69.Fa "gss_ctx_id_t *context_handle" 70.Fa "gss_buffer_t output_token" 71.Fc 72.Sh DESCRIPTION 73Delete a security context. 74.Fn gss_delete_sec_context 75will delete the local data structures associated with the specified 76security context, 77and may generate an output_token, 78which when passed to the peer 79.Fn gss_process_context_token 80will instruct it to do likewise. 81If no token is required by the mechanism, 82the GSS-API should set the length field of the output_token (if 83provided) to zero. 84No further security services may be obtained using the context 85specified by 86.Fa context_handle . 87.Pp 88In addition to deleting established security contexts, 89.Fn gss_delete_sec_context 90must also be able to delete "half-built" security contexts resulting 91from an incomplete sequence of 92.Fn gss_init_sec_context 93/ 94.Fn gss_accept_sec_context 95calls. 96.Pp 97The 98.Fa output_token 99parameter is retained for compatibility with version 1 of the GSS-API. 100It is recommended that both peer applications invoke 101.Fn gss_delete_sec_context 102passing the value 103.Dv GSS_C_NO_BUFFER 104for the 105.Fa output_token 106parameter, 107indicating that no token is required, 108and that 109.Fn gss_delete_sec_context 110should simply delete local context data structures. 111If the application does pass a valid buffer to 112.Fn gss_delete_sec_context , 113mechanisms are encouraged to return a zero-length token, 114indicating that no peer action is necessary, 115and that no token should be transferred by the application. 116.Sh PARAMETERS 117.Bl -tag 118.It minor_status 119Mechanism specific status code. 120.It context_handle 121Context handle identifying context to delete. 122After deleting the context, 123the GSS-API will set this context handle to 124.Dv GSS_C_NO_CONTEXT . 125.It output_token 126Token to be sent to remote application to instruct it to also delete 127the context. 128It is recommended that applications specify 129.Dv GSS_C_NO_BUFFER 130for this parameter, 131requesting local deletion only. 132If a buffer parameter is provided by the application, 133the mechanism may return a token in it; 134mechanisms that implement only local deletion should set the length 135field of this token to zero to indicate to the application that no 136token is to be sent to the peer. 137.El 138.Sh RETURN VALUES 139.Bl -tag 140.It GSS_S_COMPLETE 141Successful completion 142.It GSS_S_NO_CONTEXT 143No valid context was supplied 144.El 145.Sh SEE ALSO 146.Xr gss_process_context_token 3 , 147.Xr gss_init_sec_context 3 , 148.Xr gss_accept_sec_context 3 149.Sh STANDARDS 150.Bl -tag 151.It RFC 2743 152Generic Security Service Application Program Interface Version 2, Update 1 153.It RFC 2744 154Generic Security Service API Version 2 : C-bindings 155.\" .Sh HISTORY 156.El 157.Sh HISTORY 158The 159.Nm 160manual page example first appeared in 161.Fx 7.0 . 162.Sh AUTHORS 163John Wray, Iris Associates 164