gnutls_record_get_state(3) — Linux manual page


gnutls_record_get_state(3)       gnutls       gnutls_record_get_state(3)

NAME         top

       gnutls_record_get_state - API function

SYNOPSIS         top

       #include <gnutls/gnutls.h>

       int gnutls_record_get_state(gnutls_session_t session, unsigned
       read, gnutls_datum_t * mac_key, gnutls_datum_t * IV,
       gnutls_datum_t * cipher_key, unsigned char [8] seq_number);

ARGUMENTS         top

       gnutls_session_t session
                   is a gnutls_session_t type

       unsigned read
                   if non-zero the read parameters are returned,
                   otherwise the write

       gnutls_datum_t * mac_key
                   the key used for MAC (if a MAC is used)

       gnutls_datum_t * IV
                   the initialization vector or nonce used

       gnutls_datum_t * cipher_key
                   the cipher key

       unsigned char [8] seq_number
                   A 64-bit sequence number

DESCRIPTION         top

       This function will return the parameters of the current record
       state.  These are only useful to be provided to an external
       off-loading device or subsystem. The returned values should be
       considered constant and valid for the lifetime of the session.

       In that case, to sync the state back you must call

RETURNS         top

       GNUTLS_E_SUCCESS on success, or an error code.

       Since 3.4.0

REPORTING BUGS         top

       Report bugs to <>.
       Home page:

COPYRIGHT         top

       Copyright © 2001- Free Software Foundation, Inc., and others.
       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.

SEE ALSO         top

       The full documentation for gnutls is maintained as a Texinfo
       manual.  If the /usr/share/doc/gnutls/ directory does not contain
       the HTML form visit 

COLOPHON         top

       This page is part of the GnuTLS (GnuTLS Transport Layer Security
       Library) project.  Information about the project can be found at
       ⟨⟩.  If you have a bug report for this
       manual page, send it to  This page was obtained
       from the tarball gnutls-3.8.0.tar.xz fetched from
       ⟨⟩ on 2023-06-23.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to

gnutls                            3.8.0       gnutls_record_get_state(3)