doc/man3/SSL_set_session.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_set_session - set a TLS/SSL session to be used during TLS/SSL connect
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  int SSL_set_session(SSL *ssl, SSL_SESSION *session);
  12
  13 =head1 DESCRIPTION
  14
  15 SSL_set_session() sets B<session> to be used when the TLS/SSL connection
  16 is to be established. SSL_set_session() is only useful for TLS/SSL clients.
  17 When the session is set, the reference count of B<session> is incremented
  18 by 1. If the session is not reused, the reference count is decremented
  19 again during SSL_connect(). Whether the session was reused can be queried
  20 with the L<SSL_session_reused(3)> call.
  21
  22 If there is already a session set inside B<ssl> (because it was set with
  23 SSL_set_session() before or because the same B<ssl> was already used for
  24 a connection), SSL_SESSION_free() will be called for that session.
  25 This is also the case when B<session> is a NULL pointer. If that old
  26 session is still B<open>, it is considered bad and will be removed from the
  27 session cache (if used). A session is considered open, if L<SSL_shutdown(3)> was
  28 not called for the connection (or at least L<SSL_set_shutdown(3)> was used to
  29 set the SSL_SENT_SHUTDOWN state).
  30
  31 =head1 NOTES
  32
  33 SSL_SESSION objects keep internal link information about the session cache
  34 list, when being inserted into one SSL_CTX object's session cache.
  35 One SSL_SESSION object, regardless of its reference count, must therefore
  36 only be used with one SSL_CTX object (and the SSL objects created
  37 from this SSL_CTX object).
  38
  39 =head1 RETURN VALUES
  40
  41 The following return values can occur:
  42
  43 =over 4
  44
  45 =item Z<>0
  46
  47 The operation failed; check the error stack to find out the reason.
  48
  49 =item Z<>1
  50
  51 The operation succeeded.
  52
  53 =back
  54
  55 =head1 SEE ALSO
  56
  57 L<ssl(7)>, L<SSL_SESSION_free(3)>,
  58 L<SSL_get_session(3)>,
  59 L<SSL_session_reused(3)>,
  60 L<SSL_CTX_set_session_cache_mode(3)>
  61
  62 =head1 COPYRIGHT
  63
  64 Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
  65
  66 Licensed under the Apache License 2.0 (the "License").  You may not use
  67 this file except in compliance with the License.  You can obtain a copy
  68 in the file LICENSE in the source distribution or at
  69 L<https://www.openssl.org/source/license.html>.
  70
  71 =cut