Blame doc/functions/gnutls_session_get_id2

Packit aea12f
Packit aea12f
Packit aea12f
Packit aea12f
Packit aea12f
@deftypefun {int} {gnutls_session_get_id2} (gnutls_session_t @var{session}, gnutls_datum_t * @var{session_id})
Packit aea12f
@var{session}: is a @code{gnutls_session_t}  type.
Packit aea12f
Packit aea12f
@var{session_id}: will point to the session ID.
Packit aea12f
Packit aea12f
Returns the TLS session identifier. The session ID is selected by the
Packit aea12f
server, and in older versions of TLS was a unique identifier shared
Packit aea12f
between client and server which was persistent across resumption.
Packit aea12f
In the latest version of TLS (1.3) or TLS 1.2 with session tickets, the
Packit aea12f
notion of session identifiers is undefined and cannot be relied for uniquely
Packit aea12f
identifying sessions across client and server.
Packit aea12f
Packit aea12f
In client side this function returns the identifier returned by the
Packit aea12f
server, and cannot be assumed to have any relation to session resumption.
Packit aea12f
In server side this function is guaranteed to return a persistent
Packit aea12f
identifier of the session since GnuTLS 3.6.4, which may not necessarily
Packit aea12f
map into the TLS session ID value. Prior to that version the value
Packit aea12f
could only be considered a persistent identifier, under TLS1.2 or earlier
Packit aea12f
and when no session tickets were in use.
Packit aea12f
Packit aea12f
The session identifier value returned is always less than
Packit aea12f
@code{GNUTLS_MAX_SESSION_ID_SIZE}  and should be treated as constant.
Packit aea12f
Packit aea12f
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned, otherwise
Packit aea12f
an error code is returned.
Packit aea12f
Packit aea12f
@strong{Since:} 3.1.4
Packit aea12f
@end deftypefun