File: gss_get_mic.3

package info (click to toggle)
gss 1.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 8,232 kB
  • ctags: 2,436
  • sloc: sh: 13,069; ansic: 11,900; python: 2,873; perl: 623; makefile: 172; sed: 16
file content (70 lines) | stat: -rw-r--r-- 2,693 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gss_get_mic" 3 "1.0.3" "gss" "gss"
.SH NAME
gss_get_mic \- API function
.SH SYNOPSIS
.B #include <gss.h>
.sp
.BI "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 ");"
.SH ARGUMENTS
.IP "OM_uint32 * minor_status" 12
(Integer, modify) Mechanism specific status code.
.IP "const gss_ctx_id_t context_handle" 12
(gss_ctx_id_t, read) Identifies the context on
  which the message will be sent.
.IP "gss_qop_t qop_req" 12
(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.
.IP "const gss_buffer_t message_buffer" 12
(buffer, opaque, read) Message to be protected.
.IP "gss_buffer_t message_token" 12
(buffer, opaque, modify) Buffer to receive token.  The
  application must free storage associated with this buffer after
  use with a call to \fBgss_release_buffer()\fP.
.SH "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 \fBgss_wrap()\fP to provide "secure framing", implementations
must support derivation of MICs from zero\-length messages.
.SH "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.
.SH "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 software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2003-2013 Simon Josefsson.
.br
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.
.SH "SEE ALSO"
The full documentation for
.B gss
is maintained as a Texinfo manual.  If the
.B info
and
.B gss
programs are properly installed at your site, the command
.IP
.B info gss
.PP
should give you access to the complete manual.