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