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_GET_MIC 3 PRM 59.Sh NAME 60.Nm gss_get_mic , 61.Nm gss_sign 62.Nd Calculate a cryptographic message integrity code (MIC) for a 63message; integrity service 64.\" This next command is for sections 2 and 3 only. 65.\" .Sh LIBRARY 66.Sh SYNOPSIS 67.In "gssapi/gssapi.h" 68.Ft OM_uint32 69.Fo gss_get_mic 70.Fa "OM_uint32 *minor_status" 71.Fa "const gss_ctx_id_t context_handle" 72.Fa "gss_qop_t qop_req" 73.Fa "const gss_buffer_t message_buffer" 74.Fa "gss_buffer_t msg_token" 75.Fc 76.Ft OM_uint32 77.Fo gss_sign 78.Fa "OM_uint32 *minor_status" 79.Fa "const gss_ctx_id_t context_handle" 80.Fa "gss_qop_t qop_req" 81.Fa "gss_buffer_t message_buffer" 82.Fa "gss_buffer_t msg_token" 83.Fc 84.Sh DESCRIPTION 85Generates a cryptographic MIC for the supplied message, 86and places the MIC in a token for transfer to the peer application. 87The 88.Fa qop_req 89parameter allows a choice between several cryptographic algorithms, 90if supported by the chosen mechanism. 91.Pp 92Since some application-level protocols may wish to use tokens emitted 93by 94.Fn gss_wrap 95to provide "secure framing", 96implementations must support derivation of MICs from zero-length messages. 97.Pp 98The 99.Fn gss_sign 100routine is an obsolete variant of 101.Fn gss_get_mic . 102It is 103provided for backwards 104compatibility with applications using the GSS-API V1 interface. 105A distinct entrypoint (as opposed to #define) is provided, 106both to allow GSS-API V1 applications to link 107and to retain the slight parameter type differences between the 108obsolete versions of this routine and its current form. 109.Sh PARAMETERS 110.Bl -tag 111.It minor_status 112Mechanism specific status code. 113.It context_handle 114Identifies the context on which the message will be sent. 115.It qop_req 116Specifies requested quality of protection. 117Callers are encouraged, on portability grounds, 118to accept the default quality of protection offered by the chosen 119mechanism, 120which may be requested by specifying 121.Dv GSS_C_QOP_DEFAULT 122for this parameter. 123If an unsupported protection strength is requested, 124.Fn gss_get_mic 125will return a 126.Fa major_status 127of 128.Dv GSS_S_BAD_QOP . 129.It message_buffer 130Message to be protected. 131.It msg_token 132Buffer to receive token. 133The application must free storage associated with this buffer after 134use with a call to 135.Fn gss_release_buffer . 136.El 137.Sh RETURN VALUES 138.Bl -tag 139.It GSS_S_COMPLETE 140Successful completion 141.It GSS_S_CONTEXT_EXPIRED 142The context has already expired 143.It GSS_S_NO_CONTEXT 144The context_handle parameter did not identify a valid context 145.It GSS_S_BAD_QOP 146The specified QOP is not supported by the mechanism 147.El 148.Sh SEE ALSO 149.Xr gss_wrap 3 , 150.Xr gss_release_buffer 3 151.Sh STANDARDS 152.Bl -tag 153.It RFC 2743 154Generic Security Service Application Program Interface Version 2, Update 1 155.It RFC 2744 156Generic Security Service API Version 2 : C-bindings 157.\" .Sh HISTORY 158.El 159.Sh HISTORY 160The 161.Nm 162manual page example first appeared in 163.Fx 7.0 . 164.Sh AUTHORS 165John Wray, Iris Associates 166