NAMEgss_unwrap, gss_unseal — Convert a message previously protected by gss_wrap(3) back to a usable form
SYNOPSIS#include < gssapi/gssapi.h>
gss_unwrap( OM_uint32 *minor_status, const gss_ctx_id_t context_handle, const gss_buffer_t input_message_buffer, gss_buffer_t output_message_buffer, int *conf_state, gss_qop_t *qop_state);
gss_unseal( OM_uint32 *minor_status, gss_ctx_id_t context_handle, gss_buffer_t input_message_buffer, gss_buffer_t output_message_buffer, int *conf_state, gss_qop_t *qop_state);
DESCRIPTIONConverts a message previously protected by gss_wrap(3) back to a usable form, verifying the embedded MIC. The conf_state parameter indicates whether the message was encrypted; the qop_state parameter indicates the strength of protection that was used to provide the confidentiality and integrity services.
Since some application-level protocols may wish to use tokens emitted by gss_wrap(3) to provide "secure framing", implementations must support the wrapping and unwrapping of zero-length messages.
The gss_unseal() routine is an obsolete variant of gss_unwrap(). It is provided for backwards compatibility with applications using the GSS-API V1 interface. A distinct entrypoint (as opposed to #define) is provided, both to allow GSS-API V1 applications to link and to retain the slight parameter type differences between the obsolete versions of this routine and its current form.
- Mechanism specific status code.
- Identifies the context on which the message arrived.
- Protected message.
- Buffer to receive unwrapped message. Storage associated with this buffer must be freed by the application after use with a call to gss_release_buffer(3).
- Confidentiality and integrity protection were used.
- Integrity service only was used.
Specify NULL if not required.
- Quality of protection provided. Specify NULL if not required.
- Successful completion.
- The token failed consistency checks.
- The MIC was incorrect
- The token was valid, and contained a correct MIC for the message, but it had already been processed.
- The token was valid, and contained a correct MIC for the message, but it is too old to check for duplication.
- The token was valid, and contained a correct MIC for the message, but has been verified out of sequence; a later token has already been received.
- The token was valid, and contained a correct MIC for the message, but has been verified out of sequence; an earlier expected token has not yet been received.
- The context has already expired.
- The context_handle parameter did not identify a valid context.
- RFC 2743
- Generic Security Service Application Program Interface Version 2, Update 1
- RFC 2744
- Generic Security Service API Version 2 : C-bindings
HISTORYThe gss_unwrap function first appeared in FreeBSD 7.0.
AUTHORSJohn Wray, Iris Associates
COPYRIGHTCopyright (C) The Internet Society (2000). All Rights Reserved.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
|January 26, 2010||FreeBSD|