|
1 '\" te |
|
2 .\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved. |
|
3 .TH gss_get_mic 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions" |
|
4 .SH NAME |
|
5 gss_get_mic \- calculate a cryptographic message |
|
6 .SH SYNOPSIS |
|
7 .LP |
|
8 .nf |
|
9 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR [ \fIlibrary\fR... ] |
|
10 #include <gssapi/gssapi.h> |
|
11 |
|
12 \fBOM_uint32\fR \fBgss_get_mic\fR(\fBOM_uint32 *\fR\fIminor_status\fR, |
|
13 \fBconst gss_ctx_id_t\fR \fIcontext_handle\fR, \fBgss_qop_t\fR \fIqop_req\fR, |
|
14 \fBconst gss_buffer_t\fR \fImessage_buffer\fR, \fBgss_buffer_t\fR \fImsg_token\fR); |
|
15 .fi |
|
16 |
|
17 .SH DESCRIPTION |
|
18 .sp |
|
19 .LP |
|
20 The \fBgss_get_mic()\fR function generates a cryptographic \fBMIC\fR for the supplied message, and places the \fBMIC\fR in a token for transfer to the peer application. The \fIqop_req\fR parameter allows a choice between several cryptographic algorithms, if supported by the chosen mechanism. |
|
21 .sp |
|
22 .LP |
|
23 Since some application-level protocols may wish to use tokens emitted by \fBgss_wrap\fR(3GSS) to provide secure framing, the \fBGSS-API\fR allows \fBMIC\fRs to be derived from zero-length messages. |
|
24 .SH PARAMETERS |
|
25 .sp |
|
26 .LP |
|
27 The parameter descriptions for \fBgss_get_mic()\fR follow: |
|
28 .sp |
|
29 .ne 2 |
|
30 .mk |
|
31 .na |
|
32 \fB\fIminor_status\fR\fR |
|
33 .ad |
|
34 .RS 18n |
|
35 .rt |
|
36 The status code returned by the underlying mechanism. |
|
37 .RE |
|
38 |
|
39 .sp |
|
40 .ne 2 |
|
41 .mk |
|
42 .na |
|
43 \fB\fIcontext_handle\fR\fR |
|
44 .ad |
|
45 .RS 18n |
|
46 .rt |
|
47 Identifies the context on which the message will be sent. |
|
48 .RE |
|
49 |
|
50 .sp |
|
51 .ne 2 |
|
52 .mk |
|
53 .na |
|
54 \fB\fIqop_req\fR\fR |
|
55 .ad |
|
56 .RS 18n |
|
57 .rt |
|
58 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 \fBGSS_C_QOP_DEFAULT\fR for this parameter. If an unsupported protection strength is requested, \fBgss_get_mic()\fR will return a \fImajor_status\fR of \fBGSS_S_BAD_QOP\fR. |
|
59 .RE |
|
60 |
|
61 .sp |
|
62 .ne 2 |
|
63 .mk |
|
64 .na |
|
65 \fB\fImessage_buffer\fR\fR |
|
66 .ad |
|
67 .RS 18n |
|
68 .rt |
|
69 The message to be protected. |
|
70 .RE |
|
71 |
|
72 .sp |
|
73 .ne 2 |
|
74 .mk |
|
75 .na |
|
76 \fB\fImsg_token\fR\fR |
|
77 .ad |
|
78 .RS 18n |
|
79 .rt |
|
80 The buffer to receive the token. Storage associated with this message must be freed by the application after use with a call to \fBgss_release_buffer\fR(3GSS). |
|
81 .RE |
|
82 |
|
83 .SH ERRORS |
|
84 .sp |
|
85 .LP |
|
86 \fBgss_get_mic()\fR may return the following status codes: |
|
87 .sp |
|
88 .ne 2 |
|
89 .mk |
|
90 .na |
|
91 \fB\fBGSS_S_COMPLETE\fR\fR |
|
92 .ad |
|
93 .RS 25n |
|
94 .rt |
|
95 Successful completion. |
|
96 .RE |
|
97 |
|
98 .sp |
|
99 .ne 2 |
|
100 .mk |
|
101 .na |
|
102 \fB\fBGSS_S_CONTEXT_EXPIRED\fR\fR |
|
103 .ad |
|
104 .RS 25n |
|
105 .rt |
|
106 The context has already expired. |
|
107 .RE |
|
108 |
|
109 .sp |
|
110 .ne 2 |
|
111 .mk |
|
112 .na |
|
113 \fB\fBGSS_S_NO_CONTEXT\fR\fR |
|
114 .ad |
|
115 .RS 25n |
|
116 .rt |
|
117 The \fIcontext_handle\fR parameter did not identify a valid context. |
|
118 .RE |
|
119 |
|
120 .sp |
|
121 .ne 2 |
|
122 .mk |
|
123 .na |
|
124 \fB\fBGSS_S_BAD_QOP\fR\fR |
|
125 .ad |
|
126 .RS 25n |
|
127 .rt |
|
128 The specified \fBQOP\fR is not supported by the mechanism. |
|
129 .RE |
|
130 |
|
131 .sp |
|
132 .ne 2 |
|
133 .mk |
|
134 .na |
|
135 \fB\fBGSS_S_FAILURE\fR\fR |
|
136 .ad |
|
137 .RS 25n |
|
138 .rt |
|
139 The underlying mechanism detected an error for which no specific \fBGSS\fR status code is defined. The mechanism-specific status code reported by means of the \fIminor_status\fR parameter details the error condition. |
|
140 .RE |
|
141 |
|
142 .SH ATTRIBUTES |
|
143 .sp |
|
144 .LP |
|
145 See \fBattributes\fR(5) for descriptions of the following attributes: |
|
146 .sp |
|
147 |
|
148 .sp |
|
149 .TS |
|
150 tab() box; |
|
151 cw(2.75i) |cw(2.75i) |
|
152 lw(2.75i) |lw(2.75i) |
|
153 . |
|
154 ATTRIBUTE TYPEATTRIBUTE VALUE |
|
155 _ |
|
156 MT-LevelSafe |
|
157 .TE |
|
158 |
|
159 .SH SEE ALSO |
|
160 .sp |
|
161 .LP |
|
162 \fBgss_release_buffer\fR(3GSS), \fBgss_wrap\fR(3GSS), \fBattributes\fR(5) |
|
163 .sp |
|
164 .LP |
|
165 |