3 .\" Copyright (c) 2005 Doug Rabson
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
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
29 .\" The following commands are required for all man pages.
36 .Nd Calculate a cryptographic message integrity code (MIC) for a
37 message; integrity service
38 .\" This next command is for sections 2 and 3 only.
44 .Fa "OM_uint32 *minor_status"
45 .Fa "const gss_ctx_id_t context_handle"
46 .Fa "gss_qop_t qop_req"
47 .Fa "const gss_buffer_t message_buffer"
48 .Fa "gss_buffer_t msg_token"
52 .Fa "OM_uint32 *minor_status"
53 .Fa "const gss_ctx_id_t context_handle"
54 .Fa "gss_qop_t qop_req"
55 .Fa "gss_buffer_t message_buffer"
56 .Fa "gss_buffer_t msg_token"
59 Generates a cryptographic MIC for the supplied message,
60 and places the MIC in a token for transfer to the peer application.
63 parameter allows a choice between several cryptographic algorithms,
64 if supported by the chosen mechanism.
66 Since some application-level protocols may wish to use tokens emitted
69 to provide "secure framing",
70 implementations must support derivation of MICs from zero-length messages.
74 routine is an obsolete variant of
77 provided for backwards
78 compatibility with applications using the GSS-API V1 interface.
79 A distinct entrypoint (as opposed to #define) is provided,
80 both to allow GSS-API V1 applications to link
81 and to retain the slight parameter type differences between the
82 obsolete versions of this routine and its current form.
84 .Bl -tag -width ".It message_buffer"
86 Mechanism specific status code.
88 Identifies the context on which the message will be sent.
90 Specifies requested quality of protection.
91 Callers are encouraged, on portability grounds,
92 to accept the default quality of protection offered by the chosen
94 which may be requested by specifying
97 If an unsupported protection strength is requested,
104 Message to be protected.
106 Buffer to receive token.
107 The application must free storage associated with this buffer after
109 .Fn gss_release_buffer .
112 .Bl -tag -width ".It GSS_S_CONTEXT_EXPIRED"
114 Successful completion
115 .It GSS_S_CONTEXT_EXPIRED
116 The context has already expired
118 The context_handle parameter did not identify a valid context
120 The specified QOP is not supported by the mechanism
123 .Xr gss_release_buffer 3 ,
126 .Bl -tag -width ".It RFC 2743"
128 Generic Security Service Application Program Interface Version 2, Update 1
130 Generic Security Service API Version 2 : C-bindings
135 function first appeared in
138 John Wray, Iris Associates
140 Copyright (C) The Internet Society (2000). All Rights Reserved.
142 This document and translations of it may be copied and furnished to
143 others, and derivative works that comment on or otherwise explain it
144 or assist in its implementation may be prepared, copied, published
145 and distributed, in whole or in part, without restriction of any
146 kind, provided that the above copyright notice and this paragraph are
147 included on all such copies and derivative works. However, this
148 document itself may not be modified in any way, such as by removing
149 the copyright notice or references to the Internet Society or other
150 Internet organizations, except as needed for the purpose of
151 developing Internet standards in which case the procedures for
152 copyrights defined in the Internet Standards process must be
153 followed, or as required to translate it into languages other than
156 The limited permissions granted above are perpetual and will not be
157 revoked by the Internet Society or its successors or assigns.
159 This document and the information contained herein is provided on an
160 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
161 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
162 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
163 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
164 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.