lib/libgssapi/gss_get_mic.3

   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_GET_MIC 3 PRM
  32 .Os
  33 .Sh NAME
  34 .Nm gss_get_mic ,
  35 .Nm gss_sign
  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.
  39 .\" .Sh LIBRARY
  40 .Sh SYNOPSIS
  41 .In "gssapi/gssapi.h"
  42 .Ft OM_uint32
  43 .Fo gss_get_mic
  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"
  49 .Fc
  50 .Ft OM_uint32
  51 .Fo gss_sign
  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"
  57 .Fc
  58 .Sh DESCRIPTION
  59 Generates a cryptographic MIC for the supplied message,
  60 and places the MIC in a token for transfer to the peer application.
  61 The
  62 .Fa qop_req
  63 parameter allows a choice between several cryptographic algorithms,
  64 if supported by the chosen mechanism.
  65 .Pp
  66 Since some application-level protocols may wish to use tokens emitted
  67 by
  68 .Fn gss_wrap
  69 to provide "secure framing",
  70 implementations must support derivation of MICs from zero-length messages.
  71 .Pp
  72 The
  73 .Fn gss_sign
  74 routine is an obsolete variant of
  75 .Fn gss_get_mic .
  76 It is
  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.
  83 .Sh PARAMETERS
  84 .Bl -tag
  85 .It minor_status
  86 Mechanism specific status code.
  87 .It context_handle
  88 Identifies the context on which the message will be sent.
  89 .It qop_req
  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
  93 mechanism,
  94 which may be requested by specifying
  95 .Dv GSS_C_QOP_DEFAULT
  96 for this parameter.
  97 If an unsupported protection strength is requested,
  98 .Fn gss_get_mic
  99 will return a
 100 .Fa major_status
 101 of
 102 .Dv GSS_S_BAD_QOP .
 103 .It message_buffer
 104 Message to be protected.
 105 .It msg_token
 106 Buffer to receive token.
 107 The application must free storage associated with this buffer after
 108 use with a call to
 109 .Fn gss_release_buffer .
 110 .El
 111 .Sh RETURN VALUES
 112 .Bl -tag
 113 .It GSS_S_COMPLETE
 114 Successful completion
 115 .It GSS_S_CONTEXT_EXPIRED
 116 The context has already expired
 117 .It GSS_S_NO_CONTEXT
 118 The context_handle parameter did not identify a valid context
 119 .It GSS_S_BAD_QOP
 120 The specified QOP is not supported by the mechanism
 121 .El
 122 .Sh SEE ALSO
 123 .Xr gss_wrap 3 ,
 124 .Xr gss_release_buffer 3
 125 .Sh STANDARDS
 126 .Bl -tag
 127 .It RFC 2743
 128 Generic Security Service Application Program Interface Version 2, Update 1
 129 .It RFC 2744
 130 Generic Security Service API Version 2 : C-bindings
 131 .El
 132 .Sh HISTORY
 133 The
 134 .Nm
 135 function first appeared in
 136 .Fx 7.0 .
 137 .Sh AUTHORS
 138 John Wray, Iris Associates
 139 .Sh COPYRIGHT
 140 Copyright (C) The Internet Society (2000).  All Rights Reserved.
 141 .Pp
 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
 154 English.
 155 .Pp
 156 The limited permissions granted above are perpetual and will not be
 157 revoked by the Internet Society or its successors or assigns.
 158 .Pp
 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.