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