Change return type of the new accessors
[openssl.git] / doc / ssl / SSL_get_client_random.pod
index e31d3f0..2cddf73 100644 (file)
@@ -8,19 +8,19 @@ SSL_get_client_random, SSL_get_server_random, SSL_SESSION_get_master_key - retri
 
  #include <openssl/ssl.h>
 
int SSL_get_client_random(const SSL *ssl, unsigned char *out, int outlen);
int SSL_get_server_random(const SSL *ssl, unsigned char *out, int outlen);
int SSL_SESSION_get_master_key(const SSL_SESSION *session, unsigned char *out, int outlen);
size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen);
size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen);
size_t SSL_SESSION_get_master_key(const SSL_SESSION *session, unsigned char *out, size_t outlen);
 
 =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
+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.
@@ -57,10 +63,10 @@ values based on their view of the current time.
 
 =head1 RETURN VALUES
 
-If B<outlen> is at least 0, these functions return the number of bytes
+If B<outlen> is greater than 0, these functions return the number of bytes
 actually copied, which will be less than or equal to B<outlen>.
 
-If B<outlen> is less than 0, these functions return the maximum number
+If B<outlen> is 0, these functions return the maximum number
 of bytes they would copy--that is, the length of the underlying field.
 
 =head1 SEE ALSO