Clarify warning
authorBodo Möller <bodo@openssl.org>
Thu, 13 Oct 2011 13:24:13 +0000 (13:24 +0000)
committerBodo Möller <bodo@openssl.org>
Thu, 13 Oct 2011 13:24:13 +0000 (13:24 +0000)
doc/ssl/SSL_clear.pod

index 8e077e31c9a8d9633734cab986e51136f3b30d57..d4df1bfac316f5d4e4f5aed173a58612d2dfcb2b 100644 (file)
@@ -39,10 +39,16 @@ for a description of the method's properties.
 SSL_clear() resets the SSL object to allow for another connection. The
 reset operation however keeps several settings of the last sessions
 (some of these settings were made automatically during the last
-handshake). It only makes sense when opening a new session (or reusing
-an old one) with the same peer that shares these settings.
-SSL_clear() is not a short form for the sequence
-L<SSL_free(3)|SSL_free(3)>; L<SSL_new(3)|SSL_new(3)>; .
+handshake). It only makes sense for a new connection with the exact
+same peer that shares these settings, and may fail if that peer
+changes its settings between connections. Use the sequence
+L<SSL_get_session(3)|SSL_get_session(3)>;
+L<SSL_new(3)|SSL_new(3)>;
+L<SSL_set_session(3)|SSL_set_session(3)>;
+L<SSL_free(3)|SSL_free(3)>
+instead to avoid such failures
+(or simply L<SSL_free(3)|SSL_free(3)>; L<SSL_new(3)|SSL_new(3)>
+if session reuse is not desired).
 
 =head1 RETURN VALUES