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

FreeBSD Manual Pages

  
 
  

home | help
gnutls_session_get_id(3)	    gnutls	      gnutls_session_get_id(3)

NAME
       gnutls_session_get_id - API function

SYNOPSIS
       #include	<gnutls/gnutls.h>

       int  gnutls_session_get_id(gnutls_session_t session, void * session_id,
       size_t *	session_id_size);

ARGUMENTS
       gnutls_session_t	session
		   is a	gnutls_session_t type.

       void * session_id
		   is a	pointer	to space to hold the session id.

       size_t *	session_id_size
		   initially should contain the	maximum	 session_id  size  and
		   will	be updated.

DESCRIPTION
       Returns	the  TLS session identifier. The session ID is selected	by the
       server, and in older versions of	TLS was	a unique identifier shared be-
       tween client and	server which was persistent across resumption.	In the
       latest version of TLS (1.3) or TLS with session tickets,	the notion  of
       session	identifiers  is	 undefined  and	 cannot	be relied for uniquely
       identifying sessions across client and server.

       In client side this function returns the	 identifier  returned  by  the
       server,	and  cannot be assumed to have any relation to session resump-
       tion.  In server	side this function is guaranteed to return  a  persis-
       tent identifier of the session since GnuTLS 3.6.4, which	may not	neces-
       sarily  map  into  the  TLS session ID value. Prior to that version the
       value could only	be considered a	persistent identifier, under TLS1.2 or
       earlier and when	no session tickets were	in use.

       The  session  identifier	  value	  returned   is	  always   less	  than
       GNUTLS_MAX_SESSION_ID_SIZE.

RETURNS
       On  success,  GNUTLS_E_SUCCESS (0) is returned, otherwise an error code
       is returned.

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_session_get_id(3)

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

home | help