jammy (3) gnutls_session_key_update.3.gz

Provided by: gnutls-doc_3.7.3-4ubuntu1.6_all bug

NAME

       gnutls_session_key_update - API function

SYNOPSIS

       #include <gnutls/gnutls.h>

       int gnutls_session_key_update(gnutls_session_t session, unsigned flags);

ARGUMENTS

       gnutls_session_t session
                   is a gnutls_session_t type.

       unsigned flags
                   zero of GNUTLS_KU_PEER

DESCRIPTION

       This  function  will  update/refresh the session keys when the TLS protocol is 1.3 or better. The peer is
       notified of the  update  by  sending  a  message,  so  this  function  should  be  treated  similarly  to
       gnutls_record_send() --i.e., it may return GNUTLS_E_AGAIN or GNUTLS_E_INTERRUPTED.

       When  this  flag  GNUTLS_KU_PEER is specified, this function in addition to updating the local keys, will
       ask the peer to refresh its keys too.

       If the negotiated version is not TLS 1.3 or better this function will return GNUTLS_E_INVALID_REQUEST.

RETURNS

       GNUTLS_E_SUCCESS on success, otherwise a negative error code.

SINCE

       3.6.3

REPORTING BUGS

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

       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

       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

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