Clarify that SSL3_RANDOM_SIZE is a constant, for now.
authorNick Mathewson <nickm@torproject.org>
Tue, 26 May 2015 13:55:06 +0000 (09:55 -0400)
committerMatt Caswell <matt@openssl.org>
Thu, 28 May 2015 15:05:49 +0000 (16:05 +0100)
Signed-off-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
doc/ssl/SSL_get_client_random.pod

index e31d3f0..bec45d7 100644 (file)
@@ -15,12 +15,12 @@ SSL_get_client_random, SSL_get_server_random, SSL_SESSION_get_master_key - retri
 =head1 DESCRIPTION
 
 SSL_get_client_random() extracts the random value sent from the client
-to the server during the initial SSL/TLS handshake.  It copies this
-value into the buffer provided in B<out>, which must have at least
-B<outlen> bytes available. It returns the total number of bytes that were
-actually copied.
-If B<outlen> is less than zero, SSL_get_client_random() copies nothing, and
-returns the total size of the client_random value.
+to the server during the initial SSL/TLS handshake.  It copies as many
+bytes as it can of this value into the buffer provided in B<out>,
+which must have at least B<outlen> bytes available. It returns the
+total number of bytes that were actually copied.  If B<outlen> is less
+than zero, SSL_get_client_random() copies nothing, and returns the
+total size of the client_random value.
 
 SSL_get_server_random() behaves the same, but extracts the random value
 sent from the server to the client during the initial SSL/TLS handshake.
@@ -50,6 +50,12 @@ If you need to calculate another secret value that depends on the master
 secret, you should probably use SSL_export_keying_material() instead, and
 forget that you ever saw these functions.
 
+In current versions of the TLS protocols, the length of client_random
+(and also server_random) is always SSL3_RANDOM_SIZE bytes. Support for
+other outlen arguments to the SSL_get_*_random() functions is provided
+in case of the unlikely event that a future version or variant of TLS
+uses some other length there.
+
 Finally, though the "client_random" and "server_random" values are called
 "random", many TLS implementations will generate four bytes of those
 values based on their view of the current time.