crypto/openssl/doc/ssl/SSL_get_session.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_get_session - retrieve TLS/SSL session data
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  SSL_SESSION *SSL_get_session(const SSL *ssl);
  12  SSL_SESSION *SSL_get0_session(const SSL *ssl);
  13  SSL_SESSION *SSL_get1_session(SSL *ssl);
  14
  15 =head1 DESCRIPTION
  16
  17 SSL_get_session() returns a pointer to the B<SSL_SESSION> actually used in
  18 B<ssl>. The reference count of the B<SSL_SESSION> is not incremented, so
  19 that the pointer can become invalid by other operations.
  20
  21 SSL_get0_session() is the same as SSL_get_session().
  22
  23 SSL_get1_session() is the same as SSL_get_session(), but the reference
  24 count of the B<SSL_SESSION> is incremented by one.
  25
  26 =head1 NOTES
  27
  28 The ssl session contains all information required to re-establish the
  29 connection without a new handshake.
  30
  31 A session will be automatically removed from the session cache and marked as
  32 non-resumable if the connection is not closed down cleanly, e.g. if a fatal
  33 error occurs on the connection or L<SSL_shutdown(3)> is not called prior to
  34 L<SSL_free(3)>.
  35
  36 SSL_get0_session() returns a pointer to the actual session. As the
  37 reference counter is not incremented, the pointer is only valid while
  38 the connection is in use. If L<SSL_clear(3)|SSL_clear(3)> or
  39 L<SSL_free(3)|SSL_free(3)> is called, the session may be removed completely
  40 (if considered bad), and the pointer obtained will become invalid. Even
  41 if the session is valid, it can be removed at any time due to timeout
  42 during L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>.
  43
  44 If the data is to be kept, SSL_get1_session() will increment the reference
  45 count, so that the session will not be implicitly removed by other operations
  46 but stays in memory. In order to remove the session
  47 L<SSL_SESSION_free(3)|SSL_SESSION_free(3)> must be explicitly called once
  48 to decrement the reference count again.
  49
  50 SSL_SESSION objects keep internal link information about the session cache
  51 list, when being inserted into one SSL_CTX object's session cache.
  52 One SSL_SESSION object, regardless of its reference count, must therefore
  53 only be used with one SSL_CTX object (and the SSL objects created
  54 from this SSL_CTX object).
  55
  56 =head1 RETURN VALUES
  57
  58 The following return values can occur:
  59
  60 =over 4
  61
  62 =item NULL
  63
  64 There is no session available in B<ssl>.
  65
  66 =item Pointer to an SSL
  67
  68 The return value points to the data of an SSL session.
  69
  70 =back
  71
  72 =head1 SEE ALSO
  73
  74 L<ssl(3)|ssl(3)>, L<SSL_free(3)|SSL_free(3)>,
  75 L<SSL_clear(3)|SSL_clear(3)>,
  76 L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>
  77
  78 =cut