1gss_get_mic(3GSS)Generic Security Services API Library Functiongsss_get_mic(3GSS)
2
3
4

NAME

6       gss_get_mic - calculate a cryptographic message
7

SYNOPSIS

9       cc [ flag... ] file... -lgss  [ library... ]
10       #include <gssapi/gssapi.h>
11
12       OM_uint32 gss_get_mic(OM_uint32 *minor_status,
13            const gss_ctx_id_t context_handle, gss_qop_t qop_req,
14            const gss_buffer_t message_buffer, gss_buffer_t msg_token);
15
16

DESCRIPTION

18       The  gss_get_mic()  function generates a cryptographic MIC for the sup‐
19       plied message, and places the MIC in a token for transfer to  the  peer
20       application.  The  qop_req  parameter  allows  a choice between several
21       cryptographic algorithms, if supported by the chosen mechanism.
22
23
24       Since some application-level protocols may wish to use  tokens  emitted
25       by gss_wrap(3GSS) to provide secure framing, the GSS-API allows MICs to
26       be derived from zero-length messages.
27

PARAMETERS

29       The parameter descriptions for gss_get_mic() follow:
30
31       minor_status      The status code returned by the underlying mechanism.
32
33
34       context_handle    Identifies the context on which the message  will  be
35                         sent.
36
37
38       qop_req           Specifies  the requested quality of protection. Call‐
39                         ers are encouraged, on portability grounds, to accept
40                         the default quality of protection offered by the cho‐
41                         sen mechanism, which may be requested  by  specifying
42                         GSS_C_QOP_DEFAULT  for  this  parameter. If an unsup‐
43                         ported    protection    strength    is     requested,
44                         gss_get_mic()   will   return   a   major_status   of
45                         GSS_S_BAD_QOP.
46
47
48       message_buffer    The message to be protected.
49
50
51       msg_token         The buffer to receive the token.  Storage  associated
52                         with  this  message  must be freed by the application
53                         after use with a call to gss_release_buffer(3GSS).
54
55

ERRORS

57       gss_get_mic() may return the following status codes:
58
59       GSS_S_COMPLETE           Successful completion.
60
61
62       GSS_S_CONTEXT_EXPIRED    The context has already expired.
63
64
65       GSS_S_NO_CONTEXT         The context_handle parameter did not  identify
66                                a valid context.
67
68
69       GSS_S_BAD_QOP            The  specified  QOP  is  not  supported by the
70                                mechanism.
71
72
73       GSS_S_FAILURE            The underlying mechanism detected an error for
74                                which  no specific GSS status code is defined.
75                                The mechanism-specific status code reported by
76                                means  of  the  minor_status parameter details
77                                the error condition.
78
79

ATTRIBUTES

81       See attributes(5)  for descriptions of the following attributes:
82
83
84
85
86       ┌─────────────────────────────┬─────────────────────────────┐
87       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
88       ├─────────────────────────────┼─────────────────────────────┤
89       │Availability                 │SUNWgss (32-bit)             │
90       ├─────────────────────────────┼─────────────────────────────┤
91       │                             │SUNWgssx (64-bit)            │
92       ├─────────────────────────────┼─────────────────────────────┤
93       │MT-Level                     │Safe                         │
94       └─────────────────────────────┴─────────────────────────────┘
95

SEE ALSO

97       gss_release_buffer(3GSS), gss_wrap(3GSS), attributes(5)
98
99
100       Solaris Security for Developers Guide
101
102
103
104SunOS 5.11                        14 Jan 2003                gss_get_mic(3GSS)
Impressum