gnutls_record_get_state(3)

1gnutls_record_get_state(3)          gnutls          gnutls_record_get_state(3)
2
3
4

NAME

6       gnutls_record_get_state - API function
7

SYNOPSIS

9       #include <gnutls/gnutls.h>
10
11       int  gnutls_record_get_state(gnutls_session_t  session,  unsigned read,
12       gnutls_datum_t * mac_key, gnutls_datum_t *  IV,  gnutls_datum_t  *  ci‐
13       pher_key, unsigned char [8] seq_number);
14

ARGUMENTS

16       gnutls_session_t session
17                   is a gnutls_session_t type
18
19       unsigned read
20                   if non-zero the read parameters are returned, otherwise the
21                   write
22
23       gnutls_datum_t * mac_key
24                   the key used for MAC (if a MAC is used)
25
26       gnutls_datum_t * IV
27                   the initialization vector or nonce used
28
29       gnutls_datum_t * cipher_key
30                   the cipher key
31
32       unsigned char [8] seq_number
33                   A 64-bit sequence number
34

DESCRIPTION

36       This function will return the parameters of the current  record  state.
37       These  are only useful to be provided to an external off-loading device
38       or subsystem. The returned values should  be  considered  constant  and
39       valid for the lifetime of the session.
40
41       In    that   case,   to   sync   the   state   back   you   must   call
42       gnutls_record_set_state().
43

RETURNS

45       GNUTLS_E_SUCCESS on success, or an error code.
46
47       Since 3.4.0
48

REPORTING BUGS

50       Report bugs to <bugs@gnutls.org>.
51       Home page: https://www.gnutls.org
52
53

COPYRIGHT

55       Copyright © 2001- Free Software Foundation, Inc., and others.
56       Copying and distribution of this file, with  or  without  modification,
57       are  permitted in any medium without royalty provided the copyright no‐
58       tice and this notice are preserved.
59