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

Documenting session caching, 2nd step.

parent e1fee477

doc/ssl/SSL_CTX_sess_set_get_cb.pod

+5 −4
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ SSL_CTX_sess_set_new_cb, SSL_CTX_sess_set_remove_cb, SSL_CTX_sess_set_get_cb, SS 
 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,

	   void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *));

 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,

	   SSL_SESSION (*get_session-cb)(SSL *, unsigned char *, int, int *));

	   SSL_SESSION (*get_session_cb)(SSL *, unsigned char *, int, int *));



 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(struct ssl_st *ssl, SSL_SESSION *sess);

 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(struct ssl_ctx_st *ctx, SSL_SESSION *sess);
@@ -41,7 +41,7 @@ L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>). 
(SSL/TLS server only.)



SSL_CTX_sess_get_new_cb(), SSL_CTX_sess_get_remove_cb(), and

SSL_CTX_sess_get_get_cb() allow to retrieve the funtion pointers of the

SSL_CTX_sess_get_get_cb() allow to retrieve the function pointers of the

provided callback functions. If a callback function has not been set,

the NULL pointer is returned.
@@ -56,7 +56,7 @@ The new_session_cb() is called, whenever a new session has been negotiated 
and session caching is enabled (see

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

The new_session_cb() is passed the B<ssl> connection and the ssl session

B<sess>. If the callback returns B<0>, the session will be immediatly

B<sess>. If the callback returns B<0>, the session will be immediately

removed again.



The remove_session_cb() is called, whenever the SSL engine removes a session
@@ -75,6 +75,7 @@ SSL engine to increment the reference count of the SSL_SESSION object. 
=head1 SEE ALSO



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

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

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

L<SSL_CTX_flush_sessions(3)|<SSL_CTX_flush_sessions(3)>



=cut

doc/ssl/SSL_CTX_set_session_cache_mode.pod

+9 −4
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 


=head1 NAME



SSL_CTX_set_session_cache_mode - enable/disable session caching

SSL_CTX_set_session_cache_mode, SSL_CTX_get_session_cache_mode - enable/disable session caching



=head1 SYNOPSIS
@@ -68,9 +68,11 @@ Enable both SSL_SESS_CACHE_CLIENT and SSL_SESS_CACHE_SERVER at the same time. 
=item SSL_SESS_CACHE_NO_AUTO_CLEAR



Normally the session cache is checked for expired sessions every

255 connections using the SSL_CTX_flush_sessions() function. Since

255 connections using the

L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)> function. Since

this may lead to a delay which cannot be controlled, the automatic

flushing may be disabled and SSL_CTX_flush_sessions() can be called

flushing may be disabled and

L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)> can be called

explicitly by the application.



=item SSL_SESS_CACHE_NO_INTERNAL_LOOKUP
@@ -95,7 +97,10 @@ 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_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)>,

L<SSL_CTX_set_session_id_context(3)|SSL_CTX_set_session_id_context(3)>

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

L<SSL_CTX_set_timeout.pod(3)|SSL_CTX_set_timeout.pod(3)>,

L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>



=cut

doc/ssl/ssl.pod

+5 −0
Original line number Diff line number Diff line
@@ -651,16 +651,20 @@ L<SSL_accept(3)|SSL_accept(3)>, L<SSL_clear(3)|SSL_clear(3)>, 
L<SSL_connect(3)|SSL_connect(3)>,

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

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

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

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

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

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

L<SSL_CTX_load_verify_locations(3)|SSL_CTX_load_verify_locations(3)>

L<SSL_CTX_new(3)|SSL_CTX_new(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)>,

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

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

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

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

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

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

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

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

L<SSL_get_ciphers(3)|SSL_get_ciphers(3)>,
@@ -682,6 +686,7 @@ L<SSL_set_session(3)|SSL_set_session(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)>,

L<d2i_SSL_SESSION(3)|d2i_SSL_SESSION(3)>



=head1 HISTORY