diff options
Diffstat (limited to 'secure/lib/libcrypto/man/SSL_get_client_random.3')
| -rw-r--r-- | secure/lib/libcrypto/man/SSL_get_client_random.3 | 52 |
1 files changed, 28 insertions, 24 deletions
diff --git a/secure/lib/libcrypto/man/SSL_get_client_random.3 b/secure/lib/libcrypto/man/SSL_get_client_random.3 index df66be4a69254..b6ca1a949eca2 100644 --- a/secure/lib/libcrypto/man/SSL_get_client_random.3 +++ b/secure/lib/libcrypto/man/SSL_get_client_random.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,16 +54,20 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.if !\nF .nr F 0 -.if \nF>0 \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} . \} .\} +.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_CLIENT_RANDOM 3" -.TH SSL_GET_CLIENT_RANDOM 3 "2018-11-20" "1.1.1a" "OpenSSL" +.TH SSL_GET_CLIENT_RANDOM 3 "2019-02-26" "1.1.1b" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -150,24 +154,24 @@ SSL_get_client_random, SSL_get_server_random, SSL_SESSION_get_master_key, SSL_SE .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" -\&\fISSL_get_client_random()\fR extracts the random value sent from the client +\&\fBSSL_get_client_random()\fR extracts the random value sent from the client to the server during the initial \s-1SSL/TLS\s0 handshake. It copies as many bytes as it can of this value into the buffer provided in \fBout\fR, which must have at least \fBoutlen\fR bytes available. It returns the total number of bytes that were actually copied. If \fBoutlen\fR is -zero, \fISSL_get_client_random()\fR copies nothing, and returns the +zero, \fBSSL_get_client_random()\fR copies nothing, and returns the total size of the client_random value. .PP -\&\fISSL_get_server_random()\fR behaves the same, but extracts the random value +\&\fBSSL_get_server_random()\fR behaves the same, but extracts the random value sent from the server to the client during the initial \s-1SSL/TLS\s0 handshake. .PP -\&\fISSL_SESSION_get_master_key()\fR behaves the same, but extracts the master +\&\fBSSL_SESSION_get_master_key()\fR behaves the same, but extracts the master secret used to guarantee the security of the \s-1SSL/TLS\s0 session. This one can be dangerous if misused; see \s-1NOTES\s0 below. .PP -\&\fISSL_SESSION_set1_master_key()\fR sets the master key value associated with the +\&\fBSSL_SESSION_set1_master_key()\fR sets the master key value associated with the \&\s-1SSL_SESSION\s0 \fBsess\fR. For example, this could be used to set up a session based -\&\s-1PSK\s0 (see \fISSL_CTX_set_psk_use_session_callback\fR\|(3)). The master key of length +\&\s-1PSK\s0 (see \fBSSL_CTX_set_psk_use_session_callback\fR\|(3)). The master key of length \&\fBlen\fR should be provided at \fBin\fR. The supplied master key is copied by the function, so the caller is responsible for freeing and cleaning any memory associated with \fBin\fR. The caller must ensure that the length of the key is @@ -181,20 +185,20 @@ use in low-level protocols. You probably should not use them, unless you are implementing something that needs access to the internal protocol details. .PP -Despite the names of \fISSL_get_client_random()\fR and \fISSL_get_server_random()\fR, they +Despite the names of \fBSSL_get_client_random()\fR and \fBSSL_get_server_random()\fR, they \&\s-1ARE NOT\s0 random number generators. Instead, they return the mostly-random values that were already generated and used in the \s-1TLS\s0 protocol. Using them -in place of \fIRAND_bytes()\fR would be grossly foolish. +in place of \fBRAND_bytes()\fR would be grossly foolish. .PP The security of your \s-1TLS\s0 session depends on keeping the master key secret: do not expose it, or any information about it, to anybody. If you need to calculate another secret value that depends on the master -secret, you should probably use \fISSL_export_keying_material()\fR instead, and +secret, you should probably use \fBSSL_export_keying_material()\fR instead, and forget that you ever saw these functions. .PP In current versions of the \s-1TLS\s0 protocols, the length of client_random (and also server_random) is always \s-1SSL3_RANDOM_SIZE\s0 bytes. Support for -other outlen arguments to the SSL_get_*\fI_random()\fR functions is provided +other outlen arguments to the SSL_get_*\fB_random()\fR functions is provided in case of the unlikely event that a future version or variant of \s-1TLS\s0 uses some other length there. .PP @@ -203,7 +207,7 @@ Finally, though the \*(L"client_random\*(R" and \*(L"server_random\*(R" values a values based on their view of the current time. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fISSL_SESSION_set1_master_key()\fR returns 1 on success or 0 on failure. +\&\fBSSL_SESSION_set1_master_key()\fR returns 1 on success or 0 on failure. .PP For the other functions, if \fBoutlen\fR is greater than 0 then these functions return the number of bytes actually copied, which will be less than or equal to @@ -211,10 +215,10 @@ return the number of bytes actually copied, which will be less than or equal to of bytes they would copy \*(-- that is, the length of the underlying field. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fIssl\fR\|(7), -\&\fIRAND_bytes\fR\|(3), -\&\fISSL_export_keying_material\fR\|(3), -\&\fISSL_CTX_set_psk_use_session_callback\fR\|(3) +\&\fBssl\fR\|(7), +\&\fBRAND_bytes\fR\|(3), +\&\fBSSL_export_keying_material\fR\|(3), +\&\fBSSL_CTX_set_psk_use_session_callback\fR\|(3) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2015\-2017 The OpenSSL Project Authors. All Rights Reserved. |