gss_get_mic - calculate a cryptographic message
cc [ flag... ] file... -lgss [ library... ] #include <gssapi/gssapi.h> OM_uint32 gss_get_mic(OM_uint32 *minor_status, const gss_ctx_id_t context_handle, gss_qop_t qop_req, const gss_buffer_t message_buffer, gss_buffer_t msg_token);
Generic Security Services API Library Functions gss_get_mic(3gss) NAME gss_get_mic - calculate a cryptographic message SYNOPSIS cc [ flag... ] file... -lgss [ library... ] #include <gssapi/gssapi.h> OM_uint32 gss_get_mic(OM_uint32 *minor_status, const gss_ctx_id_t context_handle, gss_qop_t qop_req, const gss_buffer_t message_buffer, gss_buffer_t msg_token); DESCRIPTION The gss_get_mic() function generates a cryptographic MIC for the sup- plied message, and places the MIC in a token for transfer to the peer application. The qop_req parameter allows a choice between several cryptographic algorithms, if supported by the chosen mechanism. Since some application-level protocols may wish to use tokens emitted by gss_wrap(3GSS) to provide secure framing, the GSS-API allows MICs to be derived from zero-length messages. PARAMETERS The parameter descriptions for gss_get_mic() follow: minor_status The status code returned by the underlying mechanism. context_handle Identifies the context on which the message will be sent. qop_req Specifies the requested quality of protection. Call- ers are encouraged, on portability grounds, to accept the default quality of protection offered by the cho- sen mechanism, which may be requested by specifying GSS_C_QOP_DEFAULT for this parameter. If an unsup- ported protection strength is requested, gss_get_mic() will return a major_status of GSS_S_BAD_QOP. message_buffer The message to be protected. msg_token The buffer to receive the token. Storage associated with this message must be freed by the application after use with a call to gss_release_buffer(3GSS). ERRORS gss_get_mic() may return the following status codes: GSS_S_COMPLETE Successful completion. GSS_S_CONTEXT_EXPIRED The context has already expired. GSS_S_NO_CONTEXT The context_handle parameter did not identify a valid context. GSS_S_BAD_QOP The specified QOP is not supported by the mechanism. GSS_S_FAILURE The underlying mechanism detected an error for which no specific GSS status code is defined. The mechanism-specific status code reported by means of the minor_status parameter details the error condition. ATTRIBUTES See attributes(7) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |MT-Level |Safe | +-----------------------------+-----------------------------+ ATTRIBUTES See attributes(7) for descriptions of the following attributes: +---------------+------------------------+ |ATTRIBUTE TYPE | ATTRIBUTE VALUE | +---------------+------------------------+ |Availability | security/kerberos-5 | +---------------+------------------------+ |Stability | Pass-through committed | +---------------+------------------------+ SEE ALSO gss_release_buffer(3GSS), gss_wrap(3GSS), attributes(7) NOTES Source code for open source software components in Oracle Solaris can be found at https://www.oracle.com/downloads/opensource/solaris-source- code-downloads.html. This software was built from source available at https://github.com/oracle/solaris-userland. The original community source was downloaded from http://web.mit.edu/ker- beros/dist/krb5/1.18/krb5-1.18.4.tar.gz. Further information about this software can be found on the open source community website at http://web.mit.edu/kerberos/. Solaris 11.4 22 Aug 2011 gss_get_mic(3gss)