Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
gnutls_record_get_state(3)	    gnutls	    gnutls_record_get_state(3)

NAME
       gnutls_record_get_state - API function

SYNOPSIS
       #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	*  ci-
       pher_key, unsigned char [8] seq_number);

ARGUMENTS
       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
       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
       gnutls_record_set_state().

RETURNS
       GNUTLS_E_SUCCESS	on success, or an error	code.

       Since 3.4.0

REPORTING BUGS
       Report bugs to <bugs@gnutls.org>.
       Home page: https://www.gnutls.org

COPYRIGHT
       Copyright (C) 2001-2023 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  no-
       tice and	this notice are	preserved.

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

       https://www.gnutls.org/manual/

gnutls				     3.8.9	    gnutls_record_get_state(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=gnutls_record_get_state&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help