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