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.\" The following commands are required for all man pages. 30.Dd January 26, 2010 31.Dt GSS_WRAP 3 PRM 32.Os 33.Sh NAME 34.Nm gss_wrap , 35.Nm gss_seal 36.Nd Attach a cryptographic MIC and optionally encrypt a message 37.\" This next command is for sections 2 and 3 only. 38.\" .Sh LIBRARY 39.Sh SYNOPSIS 40.In "gssapi/gssapi.h" 41.Ft OM_uint32 42.Fo gss_wrap 43.Fa "OM_uint32 *minor_status" 44.Fa "const gss_ctx_id_t context_handle" 45.Fa "int conf_req_flag" 46.Fa "gss_qop_t qop_req" 47.Fa "const gss_buffer_t input_message_buffer" 48.Fa "int *conf_state" 49.Fa "gss_buffer_t output_message_buffer" 50.Fc 51.Ft OM_uint32 52.Fo gss_seal 53.Fa "OM_uint32 *minor_status" 54.Fa "gss_ctx_id_t context_handle" 55.Fa "int conf_req_flag" 56.Fa "gss_qop_t qop_req" 57.Fa "gss_buffer_t input_message_buffer" 58.Fa "int *conf_state" 59.Fa "gss_buffer_t output_message_buffer" 60.Fc 61.Sh DESCRIPTION 62Attaches a cryptographic MIC and optionally encrypts the specified 63.Dv input_message . 64The output_message contains both the MIC and the message. 65The 66.Dv qop_req 67parameter allows a choice between several cryptographic algorithms, 68if supported by the chosen mechanism. 69.Pp 70Since some application-level protocols may wish to use tokens emitted 71by 72.Fn gss_wrap 73to provide "secure framing", 74implementations must support the wrapping of zero-length messages. 75.Pp 76The 77.Fn gss_seal 78routine is an obsolete variant of 79.Fn gss_wrap . 80It is 81provided for backwards 82compatibility with applications using the GSS-API V1 interface. 83A distinct entrypoint (as opposed to #define) is provided, 84both to allow GSS-API V1 applications to link 85and to retain the slight parameter type differences between the 86obsolete versions of this routine and its current form. 87.Sh PARAMETERS 88.Bl -tag -width ".It output_message_buffer" 89.It minor_status 90Mechanism specific status code. 91.It context_handle 92Identifies the context on which the message will be sent. 93.It conf_req_flag 94.Bl -tag -width "Non-zero" -compact 95.It Non-zero 96Both confidentiality and integrity services are requested. 97.It Zero 98Only integrity service is requested. 99.El 100.It qop_req 101Specifies required quality of protection. 102A mechanism-specific default may be requested by setting qop_req to 103.Dv GSS_C_QOP_DEFAULT . 104If an unsupported protection strength is requested, 105.Fn gss_wrap 106will return a major_status of 107.Dv GSS_S_BAD_QOP . 108.It input_message_buffer 109Message to be protected. 110.It conf_state 111.Bl -tag -width "Non-zero" -compact 112.It Non-zero 113Confidentiality, data origin authentication and integrity services 114have been applied. 115.It Zero 116Integrity and data origin services only has been applied. 117.El 118.It output_message_buffer 119Buffer to receive protected message. 120Storage associated with this buffer must 121be freed by the application after use 122with a call to 123.Xr gss_release_buffer 3 . 124.El 125.Sh RETURN VALUES 126.Bl -tag -width ".It GSS_S_CONTEXT_EXPIRED" 127.It GSS_S_COMPLETE 128Successful completion. 129.It GSS_S_CONTEXT_EXPIRED 130The context has already expired 131.It GSS_S_NO_CONTEXT 132The context_handle parameter did not identify a valid context. 133.It GSS_S_BAD_QOP 134The specified QOP is not supported by the mechanism. 135.El 136.Sh SEE ALSO 137.Xr gss_unwrap 3 , 138.Xr gss_release_buffer 3 139.Sh STANDARDS 140.Bl -tag -width ".It RFC 2743" 141.It RFC 2743 142Generic Security Service Application Program Interface Version 2, Update 1 143.It RFC 2744 144Generic Security Service API Version 2 : C-bindings 145.El 146.Sh HISTORY 147The 148.Nm 149function first appeared in 150.Fx 7.0 . 151.Sh AUTHORS 152John Wray, Iris Associates 153.Sh COPYRIGHT 154Copyright (C) The Internet Society (2000). All Rights Reserved. 155.Pp 156This document and translations of it may be copied and furnished to 157others, and derivative works that comment on or otherwise explain it 158or assist in its implementation may be prepared, copied, published 159and distributed, in whole or in part, without restriction of any 160kind, provided that the above copyright notice and this paragraph are 161included on all such copies and derivative works. However, this 162document itself may not be modified in any way, such as by removing 163the copyright notice or references to the Internet Society or other 164Internet organizations, except as needed for the purpose of 165developing Internet standards in which case the procedures for 166copyrights defined in the Internet Standards process must be 167followed, or as required to translate it into languages other than 168English. 169.Pp 170The limited permissions granted above are perpetual and will not be 171revoked by the Internet Society or its successors or assigns. 172.Pp 173This document and the information contained herein is provided on an 174"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 175TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 176BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 177HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 178MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 179