usr/src/man/man3gss/gss_get_mic.3gss

   1 '\" te
   2 .\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GSS_GET_MIC 3GSS "Jan 14, 2003"
   7 .SH NAME
   8 gss_get_mic \- calculate a cryptographic message
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ]
  13 #include <gssapi/gssapi.h>
  14
  15 \fBOM_uint32\fR \fBgss_get_mic\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBconst gss_ctx_id_t\fR \fIcontext_handle\fR, \fBgss_qop_t\fR \fIqop_req\fR,
  17      \fBconst gss_buffer_t\fR \fImessage_buffer\fR, \fBgss_buffer_t\fR \fImsg_token\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBgss_get_mic()\fR function generates a cryptographic \fBMIC\fR for the
  24 supplied message, and places the \fBMIC\fR in a token for transfer to the peer
  25 application. The \fIqop_req\fR parameter allows a choice between several
  26 cryptographic algorithms, if supported by the chosen mechanism.
  27 .sp
  28 .LP
  29 Since some application-level protocols may wish to use tokens emitted by
  30 \fBgss_wrap\fR(3GSS) to provide secure framing, the \fBGSS-API\fR allows
  31 \fBMIC\fRs to be derived from zero-length messages.
  32 .SH PARAMETERS
  33 .sp
  34 .LP
  35 The parameter descriptions for \fBgss_get_mic()\fR follow:
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIminor_status\fR\fR
  40 .ad
  41 .RS 18n
  42 The status code returned by the underlying mechanism.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIcontext_handle\fR\fR
  49 .ad
  50 .RS 18n
  51 Identifies the context on which the message will be sent.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fIqop_req\fR\fR
  58 .ad
  59 .RS 18n
  60 Specifies the requested quality of protection. Callers are encouraged, on
  61 portability grounds, to accept the default quality of protection offered by the
  62 chosen mechanism, which may be requested by specifying \fBGSS_C_QOP_DEFAULT\fR
  63 for this parameter. If an unsupported protection strength is requested,
  64 \fBgss_get_mic()\fR will return a \fImajor_status\fR of \fBGSS_S_BAD_QOP\fR.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fImessage_buffer\fR\fR
  71 .ad
  72 .RS 18n
  73 The message to be protected.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fImsg_token\fR\fR
  80 .ad
  81 .RS 18n
  82 The buffer to receive the token. Storage associated with this message must be
  83 freed by the application after use with a call to
  84 \fBgss_release_buffer\fR(3GSS).
  85 .RE
  86
  87 .SH ERRORS
  88 .sp
  89 .LP
  90 \fBgss_get_mic()\fR may return the following status codes:
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBGSS_S_COMPLETE\fR\fR
  95 .ad
  96 .RS 25n
  97 Successful completion.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBGSS_S_CONTEXT_EXPIRED\fR\fR
 104 .ad
 105 .RS 25n
 106 The context has already expired.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBGSS_S_NO_CONTEXT\fR\fR
 113 .ad
 114 .RS 25n
 115 The \fIcontext_handle\fR parameter did not identify a valid context.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBGSS_S_BAD_QOP\fR\fR
 122 .ad
 123 .RS 25n
 124 The specified \fBQOP\fR is not supported by the mechanism.
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBGSS_S_FAILURE\fR\fR
 131 .ad
 132 .RS 25n
 133 The underlying mechanism detected an error for which no specific \fBGSS\fR
 134 status code is defined.  The mechanism-specific status code reported by means
 135 of the \fIminor_status\fR parameter details the error condition.
 136 .RE
 137
 138 .SH ATTRIBUTES
 139 .sp
 140 .LP
 141 See \fBattributes\fR(5)  for descriptions of the following attributes:
 142 .sp
 143
 144 .sp
 145 .TS
 146 box;
 147 c | c
 148 l | l .
 149 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 150 _
 151 MT-Level        Safe
 152 .TE
 153
 154 .SH SEE ALSO
 155 .sp
 156 .LP
 157 \fBgss_release_buffer\fR(3GSS), \fBgss_wrap\fR(3GSS), \fBattributes\fR(5)
 158 .sp
 159 .LP
 160 \fISolaris Security for Developers Guide\fR