Expand the documentation of |SSL_set_shed_handshake_config|.

Change-Id: I49a693ef8aef2a0d83bc5d1c71bd896e28bf1a98
Reviewed-on: https://boringssl-review.googlesource.com/28246
Commit-Queue: Matt Braithwaite <mab@google.com>
CQ-Verified: CQ bot account: commit-bot@chromium.org <commit-bot@chromium.org>
Reviewed-by: David Benjamin <davidben@google.com>
This commit is contained in:
Matthew Braithwaite 2018-05-08 14:03:05 -07:00 committed by CQ bot account: commit-bot@chromium.org
parent 8094b54eb1
commit 3babc86d0f

View File

@ -3320,9 +3320,15 @@ OPENSSL_EXPORT void SSL_CTX_set_current_time_cb(
SSL_CTX *ctx, void (*cb)(const SSL *ssl, struct timeval *out_clock));
// SSL_set_shed_handshake_config allows some of the configuration of |ssl| to be
// freed after its handshake completes. When configuration shedding is enabled,
// it is an error to call APIs that query the state that was shed, and it is an
// error to call |SSL_clear|.
// freed after its handshake completes. Once configuration has been shed, APIs
// that query it may fail. "Configuration" in this context means anything that
// was set by the caller, as distinct from information derived from the
// handshake. For example, |SSL_get_ciphers| queries how the |SSL| was
// configured by the caller, and fails after configuration has been shed,
// whereas |SSL_get_cipher| queries the result of the handshake, and is
// unaffected by configuration shedding.
//
// If configuration shedding is enabled, it is an error to call |SSL_clear|.
//
// Note that configuration shedding as a client additionally depends on
// renegotiation being disabled (see |SSL_set_renegotiate_mode|). If