File: gss_verify_mic.3

package info (click to toggle)
gss 1.0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 8,168 kB
  • sloc: ansic: 22,018; sh: 7,410; python: 2,873; perl: 861; makefile: 334; xml: 52; sed: 16
file content (80 lines) | stat: -rw-r--r-- 2,943 bytes parent folder | download | duplicates (3)
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
71
72
73
74
75
76
77
78
79
80
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gss_verify_mic" 3 "1.0.4" "gss" "gss"
.SH NAME
gss_verify_mic \- API function
.SH SYNOPSIS
.B #include <gss.h>
.sp
.BI "OM_uint32 gss_verify_mic(OM_uint32 * " minor_status ", const gss_ctx_id_t " context_handle ", const gss_buffer_t " message_buffer ", const gss_buffer_t " token_buffer ", gss_qop_t * " qop_state ");"
.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 arrived.
.IP "const gss_buffer_t message_buffer" 12
(buffer, opaque, read) Message to be verified.
.IP "const gss_buffer_t token_buffer" 12
(buffer, opaque, read) Token associated with
  message.
.IP "gss_qop_t * qop_state" 12
(gss_qop_t, modify, optional) Quality of protection
  gained from MIC Specify NULL if not required.
.SH "DESCRIPTION"
Verifies that a cryptographic MIC, contained in the token
parameter, fits the supplied message.  The qop_state parameter
allows a message recipient to determine the strength of protection
that was applied to the message.

Since some application\-level protocols may wish to use tokens
emitted by \fBgss_wrap()\fP to provide "secure framing", implementations
must support the calculation and verification of MICs over
zero\-length messages.
.SH "RETURN VALUE"

`GSS_S_COMPLETE`: Successful completion.

`GSS_S_DEFECTIVE_TOKEN`: The token failed consistency checks.

`GSS_S_BAD_SIG`: The MIC was incorrect.

`GSS_S_DUPLICATE_TOKEN`: The token was valid, and contained a
correct MIC for the message, but it had already been processed.

`GSS_S_OLD_TOKEN`: The token was valid, and contained a correct MIC
for the message, but it is too old to check for duplication.

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

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

`GSS_S_CONTEXT_EXPIRED`: The context has already expired.

`GSS_S_NO_CONTEXT`: The context_handle parameter did not identify a
valid context.
.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-2022 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.