Additional updates to SSL_CTX_sess_set_get_cb.pod
authorBenjamin Kaduk <bkaduk@akamai.com>
Thu, 16 Jan 2020 22:37:44 +0000 (14:37 -0800)
committerBenjamin Kaduk <kaduk@mit.edu>
Fri, 13 Mar 2020 21:20:13 +0000 (14:20 -0700)
commit06f876837a8ec76b28c42953731a156c0c3700e2
treeb3f886770e17337138eb6feec4a0c247c10427af
parentc08dea30d4d127412097b39d9974ba6090041a7c
Additional updates to SSL_CTX_sess_set_get_cb.pod

Generally modernize the language.

Refer to TLS instead of SSL/TLS, and try to have more consistent
usage of commas and that/which.

Reword some descriptions to avoid implying that a list of potential
reasons for behavior is an exhaustive list.

Clarify how get_session_cb() is only called on servers (i.e., in general,
and that it's given the session ID proposed by the client).

Clarify the semantics of the get_cb()'s "copy" argument.
The behavior seems to have changed in commit
8876bc054802b043a3ec95554b6c5873291770be, though the behavior prior
to that commit was not to leave the reference-count unchanged if
*copy was not written to -- instead, libssl seemed to assume that the
callback already had incremented the reference count.

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10943)
doc/man3/SSL_CTX_sess_set_get_cb.pod