Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

gss_get_mic(3gss) [sunos man page]

gss_get_mic(3GSS)				  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 supplied 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. Callers are  encouraged,	on  portability  grounds,  to  accept  the
			       default	 quality   of  protection  offered  by	the  chosen  mechanism,  which	may  be  requested  by	specifying
			       GSS_C_QOP_DEFAULT for this parameter. If an unsupported 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  mecha-
				       nism-specific status code reported by means of the minor_status parameter details the error condition.

ATTRIBUTES

       See attributes(5)  for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWgss (32-bit)		   |
       +-----------------------------+-----------------------------+
       |			     |SUNWgssx (64-bit) 	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       gss_release_buffer(3GSS), gss_wrap(3GSS), attributes(5)

       Solaris Security for Developers Guide

SunOS 5.10							    14 Jan 2003 						 gss_get_mic(3GSS)

Check Out this Related Man Page

gss_get_mic(3)								gss							    gss_get_mic(3)

NAME

       gss_get_mic - API function

SYNOPSIS

       #include <gss.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 message_token);

ARGUMENTS

       OM_uint32 * minor_status
		   (Integer, modify) Mechanism specific status code.

       const gss_ctx_id_t context_handle
		   (gss_ctx_id_t, read) Identifies the context on
		     which the message will be sent.

       gss_qop_t qop_req
		   (gss_qop_t, read, optional) Specifies requested quality
		     of protection.  Callers are encouraged, on portability grounds,
		     to accept the default quality of protection offered by the chosen
		     mechanism, which may be requested by specifying GSS_C_QOP_DEFAULT
		     for this parameter.  If an unsupported protection strength is
		     requested, gss_get_mic will return a major_status of
		     GSS_S_BAD_QOP.

       const gss_buffer_t message_buffer
		   (buffer, opaque, read) Message to be protected.

       gss_buffer_t message_token
		   (buffer, opaque, modify) Buffer to receive token.  The
		     application must free storage associated with this buffer after
		     use with a call to gss_release_buffer().

DESCRIPTION

       Generates a cryptographic MIC for the supplied 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() to provide "secure framing", implementations must sup-
       port derivation of MICs from zero-length messages.

RETURN VALUE

       `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.

REPORTING BUGS

       Report bugs to <bug-gss@gnu.org>.  GNU Generic Security Service home page: http://www.gnu.org/software/gss/ General help  using	GNU  soft-
       ware: http://www.gnu.org/gethelp/

COPYRIGHT

       Copyright (C) 2003-2011 Simon Josefsson.
       Copying	and  distribution  of  this file, with or without modification, are permitted in any medium without royalty provided the copyright
       notice and this notice are preserved.

SEE ALSO

       The full documentation for gss is maintained as a Texinfo manual.  If the info and gss programs are properly installed at  your	site,  the
       command

	      info gss

       should give you access to the complete manual.

gss								       1.0.2							    gss_get_mic(3)
Man Page