secure/lib/libcrypto/man/man3/SSL_get_client_random.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SSL_GET_CLIENT_RANDOM 3"
 136 .TH SSL_GET_CLIENT_RANDOM 3 "2020-09-22" "1.1.1h" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 SSL_get_client_random, SSL_get_server_random, SSL_SESSION_get_master_key, SSL_SESSION_set1_master_key \&\- get internal TLS/SSL random values and get/set master key
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& size_t SSL_get_client_random(const SSL *ssl, unsigned char *out, size_t outlen);
 149 \& size_t SSL_get_server_random(const SSL *ssl, unsigned char *out, size_t outlen);
 150 \& size_t SSL_SESSION_get_master_key(const SSL_SESSION *session,
 151 \&                                   unsigned char *out, size_t outlen);
 152 \& int SSL_SESSION_set1_master_key(SSL_SESSION *sess, const unsigned char *in,
 153 \&                                 size_t len);
 154 .Ve
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 \&\fBSSL_get_client_random()\fR extracts the random value sent from the client
 158 to the server during the initial \s-1SSL/TLS\s0 handshake.  It copies as many
 159 bytes as it can of this value into the buffer provided in \fBout\fR,
 160 which must have at least \fBoutlen\fR bytes available. It returns the
 161 total number of bytes that were actually copied.  If \fBoutlen\fR is
 162 zero, \fBSSL_get_client_random()\fR copies nothing, and returns the
 163 total size of the client_random value.
 164 .PP
 165 \&\fBSSL_get_server_random()\fR behaves the same, but extracts the random value
 166 sent from the server to the client during the initial \s-1SSL/TLS\s0 handshake.
 167 .PP
 168 \&\fBSSL_SESSION_get_master_key()\fR behaves the same, but extracts the master
 169 secret used to guarantee the security of the \s-1SSL/TLS\s0 session.  This one
 170 can be dangerous if misused; see \s-1NOTES\s0 below.
 171 .PP
 172 \&\fBSSL_SESSION_set1_master_key()\fR sets the master key value associated with the
 173 \&\s-1SSL_SESSION\s0 \fBsess\fR. For example, this could be used to set up a session based
 174 \&\s-1PSK\s0 (see \fBSSL_CTX_set_psk_use_session_callback\fR\|(3)). The master key of length
 175 \&\fBlen\fR should be provided at \fBin\fR. The supplied master key is copied by the
 176 function, so the caller is responsible for freeing and cleaning any memory
 177 associated with \fBin\fR. The caller must ensure that the length of the key is
 178 suitable for the ciphersuite associated with the \s-1SSL_SESSION.\s0
 179 .SH "NOTES"
 180 .IX Header "NOTES"
 181 You probably shouldn't use these functions.
 182 .PP
 183 These functions expose internal values from the \s-1TLS\s0 handshake, for
 184 use in low-level protocols.  You probably should not use them, unless
 185 you are implementing something that needs access to the internal protocol
 186 details.
 187 .PP
 188 Despite the names of \fBSSL_get_client_random()\fR and \fBSSL_get_server_random()\fR, they
 189 \&\s-1ARE NOT\s0 random number generators.  Instead, they return the mostly-random values that
 190 were already generated and used in the \s-1TLS\s0 protocol.  Using them
 191 in place of \fBRAND_bytes()\fR would be grossly foolish.
 192 .PP
 193 The security of your \s-1TLS\s0 session depends on keeping the master key secret:
 194 do not expose it, or any information about it, to anybody.
 195 If you need to calculate another secret value that depends on the master
 196 secret, you should probably use \fBSSL_export_keying_material()\fR instead, and
 197 forget that you ever saw these functions.
 198 .PP
 199 In current versions of the \s-1TLS\s0 protocols, the length of client_random
 200 (and also server_random) is always \s-1SSL3_RANDOM_SIZE\s0 bytes. Support for
 201 other outlen arguments to the SSL_get_*\fB_random()\fR functions is provided
 202 in case of the unlikely event that a future version or variant of \s-1TLS\s0
 203 uses some other length there.
 204 .PP
 205 Finally, though the \*(L"client_random\*(R" and \*(L"server_random\*(R" values are called
 206 \&\*(L"random\*(R", many \s-1TLS\s0 implementations will generate four bytes of those
 207 values based on their view of the current time.
 208 .SH "RETURN VALUES"
 209 .IX Header "RETURN VALUES"
 210 \&\fBSSL_SESSION_set1_master_key()\fR returns 1 on success or 0 on failure.
 211 .PP
 212 For the other functions, if \fBoutlen\fR is greater than 0 then these functions
 213 return the number of bytes actually copied, which will be less than or equal to
 214 \&\fBoutlen\fR. If \fBoutlen\fR is 0 then these functions return the maximum number
 215 of bytes they would copy \*(-- that is, the length of the underlying field.
 216 .SH "SEE ALSO"
 217 .IX Header "SEE ALSO"
 218 \&\fBssl\fR\|(7),
 219 \&\fBRAND_bytes\fR\|(3),
 220 \&\fBSSL_export_keying_material\fR\|(3),
 221 \&\fBSSL_CTX_set_psk_use_session_callback\fR\|(3)
 222 .SH "COPYRIGHT"
 223 .IX Header "COPYRIGHT"
 224 Copyright 2015\-2017 The OpenSSL Project Authors. All Rights Reserved.
 225 .PP
 226 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 227 this file except in compliance with the License.  You can obtain a copy
 228 in the file \s-1LICENSE\s0 in the source distribution or at
 229 <https://www.openssl.org/source/license.html>.