Commit 2d3b6a5b authored by Lutz Jänicke's avatar Lutz Jänicke
Browse files

Some more documentation bits.

parent 81d1998e

doc/ssl/SSL_CTX_set_session_cache_mode.pod

+1 −0
Original line number Diff line number Diff line
@@ -97,6 +97,7 @@ SSL_CTX_get_session_cache_mode() returns the currently set cache mode. 
=head1 SEE ALSO



L<ssl(3)|ssl(3)>, L<SSL_set_session(3)|SSL_set_session(3)>,

L<SSL_session_reused(3)|SSL_session_reused(3)>,

L<SSL_CTX_sess_number(3)|SSL_CTX_sess_number(3)>,

L<SSL_CTX_sess_set_cache_size(3)|SSL_CTX_sess_set_cache_size(3)>,

L<SSL_CTX_sess_set_get_cb(3)|SSL_CTX_sess_set_get_cb(3)>,

doc/ssl/SSL_session_reused.pod

0 → 100644
+45 −0
Original line number Diff line number Diff line 
=pod



=head1 NAME



SSL_session_reused - query whether a reused session was negotiated during handshake



=head1 SYNOPSIS



 #include <openssl/ssl.h>



 int SSL_session_reused(SSL *ssl);



=head1 DESCRIPTION



Query, whether a reused session was negotiated during the handshake.



=head1 NOTES



During the negotiation, a client can propose to reuse a session. The server

then looks up the session in its cache. If both client and server agree

on the session, it will be reused and a flag is being set that can be

queried by the application.



=head1 RETURN VALUES



The following return values can occur:



=over 4



=item 0



A new session was negotiated.



=item 1



A session was reused.



=back



=head1 SEE ALSO



L<ssl(3)|ssl(3)>, L<SSL_set_session(3)|SSL_set_session(3)>,

L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>



=cut

doc/ssl/SSL_set_session.pod

+3 −1
Original line number Diff line number Diff line
@@ -16,7 +16,8 @@ SSL_set_session() sets B<session> to be used when the TLS/SSL connection 
is to be established. SSL_set_session() is only useful for TLS/SSL clients.

When the session is set, the reference count of B<session> is incremented

by 1. If the session is not reused, the reference count is decremented

again during SSL_connect().

again during SSL_connect(). Whether the session was reused can be queried

with the L<SSL_session_reused(3)|SSL_session_reused(3)> call.



If there is already a session set inside B<ssl> (because it was set with

SSL_set_session() before or because the same B<ssl> was already used for
@@ -41,6 +42,7 @@ The operation succeeded. 
=head1 SEE ALSO



L<ssl(3)|ssl(3)>, L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>,

L<SSL_session_reused(3)|SSL_session_reused(3)>,

L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>



=cut

doc/ssl/ssl.pod

+7 −3
Original line number Diff line number Diff line
@@ -686,12 +686,16 @@ L<SSL_get_version(3)|SSL_get_version(3)>, 
L<SSL_library_init(3)|SSL_library_init(3)>,

L<SSL_load_client_CA_file(3)|SSL_load_client_CA_file(3)>,

L<SSL_new(3)|SSL_new(3)>,

L<SSL_read(3)|SSL_read(3)>, L<SSL_set_bio(3)|SSL_set_bio(3)>,

L<SSL_pending(3)|SSL_pending(3)>,

L<SSL_read(3)|SSL_read(3)>,

L<SSL_session_reused(3)|SSL_session_reused(3)>,

L<SSL_set_bio(3)|SSL_set_bio(3)>,

L<SSL_set_connect_state(3)|SSL_set_connect_state(3)>,

L<SSL_set_fd(3)|SSL_set_fd(3)>, L<SSL_pending(3)|SSL_pending(3)>,

L<SSL_set_fd(3)|SSL_set_fd(3)>,

L<SSL_set_session(3)|SSL_set_session(3)>,

L<SSL_set_shutdown(3)|SSL_set_shutdown(3)>,

L<SSL_shutdown(3)|SSL_shutdown(3)>, L<SSL_write(3)|SSL_write(3)>,

L<SSL_shutdown(3)|SSL_shutdown(3)>,

L<SSL_write(3)|SSL_write(3)>,

L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>,

L<SSL_SESSION_get_ex_new_index(3)|SSL_SESSION_get_ex_new_index(3)>,

L<SSL_SESSION_get_time(3)|SSL_SESSION_get_time(3)>,