Documenting the options deprecating in CHANGES.md
[openssl.git] / ssl / t1_enc.c
1 /*
2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright 2005 Nokia. All rights reserved.
4  *
5  * Licensed under the Apache License 2.0 (the "License").  You may not use
6  * this file except in compliance with the License.  You can obtain a copy
7  * in the file LICENSE in the source distribution or at
8  * https://www.openssl.org/source/license.html
9  */
10
11 #include <stdio.h>
12 #include "ssl_local.h"
13 #include "record/record_local.h"
14 #include "internal/ktls.h"
15 #include "internal/cryptlib.h"
16 #include <openssl/comp.h>
17 #include <openssl/evp.h>
18 #include <openssl/kdf.h>
19 #include <openssl/rand.h>
20 #include <openssl/obj_mac.h>
21 #include <openssl/core_names.h>
22 #include <openssl/trace.h>
23
24 /* seed1 through seed5 are concatenated */
25 static int tls1_PRF(SSL *s,
26                     const void *seed1, size_t seed1_len,
27                     const void *seed2, size_t seed2_len,
28                     const void *seed3, size_t seed3_len,
29                     const void *seed4, size_t seed4_len,
30                     const void *seed5, size_t seed5_len,
31                     const unsigned char *sec, size_t slen,
32                     unsigned char *out, size_t olen, int fatal)
33 {
34     const EVP_MD *md = ssl_prf_md(s);
35     EVP_KDF *kdf;
36     EVP_KDF_CTX *kctx = NULL;
37     OSSL_PARAM params[8], *p = params;
38     const char *mdname;
39
40     if (md == NULL) {
41         /* Should never happen */
42         if (fatal)
43             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
44         else
45             ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
46         return 0;
47     }
48     kdf = EVP_KDF_fetch(s->ctx->libctx, OSSL_KDF_NAME_TLS1_PRF, s->ctx->propq);
49     if (kdf == NULL)
50         goto err;
51     kctx = EVP_KDF_CTX_new(kdf);
52     EVP_KDF_free(kdf);
53     if (kctx == NULL)
54         goto err;
55     mdname = EVP_MD_name(md);
56     *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
57                                             (char *)mdname, 0);
58     *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SECRET,
59                                              (unsigned char *)sec,
60                                              (size_t)slen);
61     *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SEED,
62                                              (void *)seed1, (size_t)seed1_len);
63     *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SEED,
64                                              (void *)seed2, (size_t)seed2_len);
65     *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SEED,
66                                              (void *)seed3, (size_t)seed3_len);
67     *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SEED,
68                                              (void *)seed4, (size_t)seed4_len);
69     *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SEED,
70                                              (void *)seed5, (size_t)seed5_len);
71     *p = OSSL_PARAM_construct_end();
72     if (EVP_KDF_CTX_set_params(kctx, params)
73             && EVP_KDF_derive(kctx, out, olen)) {
74         EVP_KDF_CTX_free(kctx);
75         return 1;
76     }
77
78  err:
79     if (fatal)
80         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
81     else
82         ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
83     EVP_KDF_CTX_free(kctx);
84     return 0;
85 }
86
87 static int tls1_generate_key_block(SSL *s, unsigned char *km, size_t num)
88 {
89     int ret;
90
91     /* Calls SSLfatal() as required */
92     ret = tls1_PRF(s,
93                    TLS_MD_KEY_EXPANSION_CONST,
94                    TLS_MD_KEY_EXPANSION_CONST_SIZE, s->s3.server_random,
95                    SSL3_RANDOM_SIZE, s->s3.client_random, SSL3_RANDOM_SIZE,
96                    NULL, 0, NULL, 0, s->session->master_key,
97                    s->session->master_key_length, km, num, 1);
98
99     return ret;
100 }
101
102 #ifndef OPENSSL_NO_KTLS
103  /*
104   * Count the number of records that were not processed yet from record boundary.
105   *
106   * This function assumes that there are only fully formed records read in the
107   * record layer. If read_ahead is enabled, then this might be false and this
108   * function will fail.
109   */
110 # ifndef OPENSSL_NO_KTLS_RX
111 static int count_unprocessed_records(SSL *s)
112 {
113     SSL3_BUFFER *rbuf = RECORD_LAYER_get_rbuf(&s->rlayer);
114     PACKET pkt, subpkt;
115     int count = 0;
116
117     if (!PACKET_buf_init(&pkt, rbuf->buf + rbuf->offset, rbuf->left))
118         return -1;
119
120     while (PACKET_remaining(&pkt) > 0) {
121         /* Skip record type and version */
122         if (!PACKET_forward(&pkt, 3))
123             return -1;
124
125         /* Read until next record */
126         if (PACKET_get_length_prefixed_2(&pkt, &subpkt))
127             return -1;
128
129         count += 1;
130     }
131
132     return count;
133 }
134 # endif
135 #endif
136
137
138 int tls_provider_set_tls_params(SSL *s, EVP_CIPHER_CTX *ctx,
139                                 const EVP_CIPHER *ciph,
140                                 const EVP_MD *md)
141 {
142     /*
143      * Provided cipher, the TLS padding/MAC removal is performed provider
144      * side so we need to tell the ctx about our TLS version and mac size
145      */
146     OSSL_PARAM params[3], *pprm = params;
147     size_t macsize = 0;
148     int imacsize = -1;
149
150     if ((EVP_CIPHER_flags(ciph) & EVP_CIPH_FLAG_AEAD_CIPHER) == 0
151                /*
152                 * We look at s->ext.use_etm instead of SSL_READ_ETM() or
153                 * SSL_WRITE_ETM() because this test applies to both reading
154                 * and writing.
155                 */
156             && !s->ext.use_etm)
157         imacsize = EVP_MD_size(md);
158     if (imacsize >= 0)
159         macsize = (size_t)imacsize;
160
161     *pprm++ = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_TLS_VERSION,
162                                        &s->version);
163     *pprm++ = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_TLS_MAC_SIZE,
164                                           &macsize);
165     *pprm = OSSL_PARAM_construct_end();
166
167     if (!EVP_CIPHER_CTX_set_params(ctx, params)) {
168         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
169         return 0;
170     }
171
172     return 1;
173 }
174
175
176 static int tls_iv_length_within_key_block(const EVP_CIPHER *c)
177 {
178     /* If GCM/CCM mode only part of IV comes from PRF */
179     if (EVP_CIPHER_mode(c) == EVP_CIPH_GCM_MODE)
180         return EVP_GCM_TLS_FIXED_IV_LEN;
181     else if (EVP_CIPHER_mode(c) == EVP_CIPH_CCM_MODE)
182         return EVP_CCM_TLS_FIXED_IV_LEN;
183     else
184         return EVP_CIPHER_iv_length(c);
185 }
186
187 int tls1_change_cipher_state(SSL *s, int which)
188 {
189     unsigned char *p, *mac_secret;
190     unsigned char *ms, *key, *iv;
191     EVP_CIPHER_CTX *dd;
192     const EVP_CIPHER *c;
193 #ifndef OPENSSL_NO_COMP
194     const SSL_COMP *comp;
195 #endif
196     const EVP_MD *m;
197     int mac_type;
198     size_t *mac_secret_size;
199     EVP_MD_CTX *mac_ctx;
200     EVP_PKEY *mac_key;
201     size_t n, i, j, k, cl;
202     int reuse_dd = 0;
203 #ifndef OPENSSL_NO_KTLS
204     ktls_crypto_info_t crypto_info;
205     unsigned char *rec_seq;
206     void *rl_sequence;
207 # ifndef OPENSSL_NO_KTLS_RX
208     int count_unprocessed;
209     int bit;
210 # endif
211     BIO *bio;
212 #endif
213
214     c = s->s3.tmp.new_sym_enc;
215     m = s->s3.tmp.new_hash;
216     mac_type = s->s3.tmp.new_mac_pkey_type;
217 #ifndef OPENSSL_NO_COMP
218     comp = s->s3.tmp.new_compression;
219 #endif
220
221     if (which & SSL3_CC_READ) {
222         if (s->ext.use_etm)
223             s->s3.flags |= TLS1_FLAGS_ENCRYPT_THEN_MAC_READ;
224         else
225             s->s3.flags &= ~TLS1_FLAGS_ENCRYPT_THEN_MAC_READ;
226
227         if (s->s3.tmp.new_cipher->algorithm2 & TLS1_STREAM_MAC)
228             s->mac_flags |= SSL_MAC_FLAG_READ_MAC_STREAM;
229         else
230             s->mac_flags &= ~SSL_MAC_FLAG_READ_MAC_STREAM;
231
232         if (s->s3.tmp.new_cipher->algorithm2 & TLS1_TLSTREE)
233             s->mac_flags |= SSL_MAC_FLAG_READ_MAC_TLSTREE;
234         else
235             s->mac_flags &= ~SSL_MAC_FLAG_READ_MAC_TLSTREE;
236
237         if (s->enc_read_ctx != NULL) {
238             reuse_dd = 1;
239         } else if ((s->enc_read_ctx = EVP_CIPHER_CTX_new()) == NULL) {
240             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_MALLOC_FAILURE);
241             goto err;
242         } else {
243             /*
244              * make sure it's initialised in case we exit later with an error
245              */
246             EVP_CIPHER_CTX_reset(s->enc_read_ctx);
247         }
248         dd = s->enc_read_ctx;
249         mac_ctx = ssl_replace_hash(&s->read_hash, NULL);
250         if (mac_ctx == NULL) {
251             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
252             goto err;
253         }
254 #ifndef OPENSSL_NO_COMP
255         COMP_CTX_free(s->expand);
256         s->expand = NULL;
257         if (comp != NULL) {
258             s->expand = COMP_CTX_new(comp->method);
259             if (s->expand == NULL) {
260                 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
261                          SSL_R_COMPRESSION_LIBRARY_ERROR);
262                 goto err;
263             }
264         }
265 #endif
266         /*
267          * this is done by dtls1_reset_seq_numbers for DTLS
268          */
269         if (!SSL_IS_DTLS(s))
270             RECORD_LAYER_reset_read_sequence(&s->rlayer);
271         mac_secret = &(s->s3.read_mac_secret[0]);
272         mac_secret_size = &(s->s3.read_mac_secret_size);
273     } else {
274         s->statem.enc_write_state = ENC_WRITE_STATE_INVALID;
275         if (s->ext.use_etm)
276             s->s3.flags |= TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE;
277         else
278             s->s3.flags &= ~TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE;
279
280         if (s->s3.tmp.new_cipher->algorithm2 & TLS1_STREAM_MAC)
281             s->mac_flags |= SSL_MAC_FLAG_WRITE_MAC_STREAM;
282         else
283             s->mac_flags &= ~SSL_MAC_FLAG_WRITE_MAC_STREAM;
284
285         if (s->s3.tmp.new_cipher->algorithm2 & TLS1_TLSTREE)
286             s->mac_flags |= SSL_MAC_FLAG_WRITE_MAC_TLSTREE;
287         else
288             s->mac_flags &= ~SSL_MAC_FLAG_WRITE_MAC_TLSTREE;
289         if (s->enc_write_ctx != NULL && !SSL_IS_DTLS(s)) {
290             reuse_dd = 1;
291         } else if ((s->enc_write_ctx = EVP_CIPHER_CTX_new()) == NULL) {
292             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_MALLOC_FAILURE);
293             goto err;
294         }
295         dd = s->enc_write_ctx;
296         if (SSL_IS_DTLS(s)) {
297             mac_ctx = EVP_MD_CTX_new();
298             if (mac_ctx == NULL) {
299                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_MALLOC_FAILURE);
300                 goto err;
301             }
302             s->write_hash = mac_ctx;
303         } else {
304             mac_ctx = ssl_replace_hash(&s->write_hash, NULL);
305             if (mac_ctx == NULL) {
306                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_MALLOC_FAILURE);
307                 goto err;
308             }
309         }
310 #ifndef OPENSSL_NO_COMP
311         COMP_CTX_free(s->compress);
312         s->compress = NULL;
313         if (comp != NULL) {
314             s->compress = COMP_CTX_new(comp->method);
315             if (s->compress == NULL) {
316                 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
317                          SSL_R_COMPRESSION_LIBRARY_ERROR);
318                 goto err;
319             }
320         }
321 #endif
322         /*
323          * this is done by dtls1_reset_seq_numbers for DTLS
324          */
325         if (!SSL_IS_DTLS(s))
326             RECORD_LAYER_reset_write_sequence(&s->rlayer);
327         mac_secret = &(s->s3.write_mac_secret[0]);
328         mac_secret_size = &(s->s3.write_mac_secret_size);
329     }
330
331     if (reuse_dd)
332         EVP_CIPHER_CTX_reset(dd);
333
334     p = s->s3.tmp.key_block;
335     i = *mac_secret_size = s->s3.tmp.new_mac_secret_size;
336
337     /* TODO(size_t): convert me */
338     cl = EVP_CIPHER_key_length(c);
339     j = cl;
340     k = tls_iv_length_within_key_block(c);
341     if ((which == SSL3_CHANGE_CIPHER_CLIENT_WRITE) ||
342         (which == SSL3_CHANGE_CIPHER_SERVER_READ)) {
343         ms = &(p[0]);
344         n = i + i;
345         key = &(p[n]);
346         n += j + j;
347         iv = &(p[n]);
348         n += k + k;
349     } else {
350         n = i;
351         ms = &(p[n]);
352         n += i + j;
353         key = &(p[n]);
354         n += j + k;
355         iv = &(p[n]);
356         n += k;
357     }
358
359     if (n > s->s3.tmp.key_block_length) {
360         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
361         goto err;
362     }
363
364     memcpy(mac_secret, ms, i);
365
366     if (!(EVP_CIPHER_flags(c) & EVP_CIPH_FLAG_AEAD_CIPHER)) {
367         if (mac_type == EVP_PKEY_HMAC) {
368             mac_key = EVP_PKEY_new_raw_private_key_ex(s->ctx->libctx, "HMAC",
369                                                       s->ctx->propq, mac_secret,
370                                                       *mac_secret_size);
371         } else {
372             /*
373              * If its not HMAC then the only other types of MAC we support are
374              * the GOST MACs, so we need to use the old style way of creating
375              * a MAC key.
376              */
377             mac_key = EVP_PKEY_new_mac_key(mac_type, NULL, mac_secret,
378                                            (int)*mac_secret_size);
379         }
380         if (mac_key == NULL
381             || EVP_DigestSignInit_ex(mac_ctx, NULL, EVP_MD_name(m),
382                                      s->ctx->libctx, s->ctx->propq, mac_key) <= 0) {
383             EVP_PKEY_free(mac_key);
384             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
385             goto err;
386         }
387         EVP_PKEY_free(mac_key);
388     }
389
390     OSSL_TRACE_BEGIN(TLS) {
391         BIO_printf(trc_out, "which = %04X, mac key:\n", which);
392         BIO_dump_indent(trc_out, ms, i, 4);
393     } OSSL_TRACE_END(TLS);
394
395     if (EVP_CIPHER_mode(c) == EVP_CIPH_GCM_MODE) {
396         if (!EVP_CipherInit_ex(dd, c, NULL, key, NULL, (which & SSL3_CC_WRITE))
397             || !EVP_CIPHER_CTX_ctrl(dd, EVP_CTRL_GCM_SET_IV_FIXED, (int)k,
398                                     iv)) {
399             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
400             goto err;
401         }
402     } else if (EVP_CIPHER_mode(c) == EVP_CIPH_CCM_MODE) {
403         int taglen;
404         if (s->s3.tmp.
405             new_cipher->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8))
406             taglen = EVP_CCM8_TLS_TAG_LEN;
407         else
408             taglen = EVP_CCM_TLS_TAG_LEN;
409         if (!EVP_CipherInit_ex(dd, c, NULL, NULL, NULL, (which & SSL3_CC_WRITE))
410             || !EVP_CIPHER_CTX_ctrl(dd, EVP_CTRL_AEAD_SET_IVLEN, 12, NULL)
411             || !EVP_CIPHER_CTX_ctrl(dd, EVP_CTRL_AEAD_SET_TAG, taglen, NULL)
412             || !EVP_CIPHER_CTX_ctrl(dd, EVP_CTRL_CCM_SET_IV_FIXED, (int)k, iv)
413             || !EVP_CipherInit_ex(dd, NULL, NULL, key, NULL, -1)) {
414             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
415             goto err;
416         }
417     } else {
418         if (!EVP_CipherInit_ex(dd, c, NULL, key, iv, (which & SSL3_CC_WRITE))) {
419             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
420             goto err;
421         }
422     }
423     /* Needed for "composite" AEADs, such as RC4-HMAC-MD5 */
424     if ((EVP_CIPHER_flags(c) & EVP_CIPH_FLAG_AEAD_CIPHER) && *mac_secret_size
425         && !EVP_CIPHER_CTX_ctrl(dd, EVP_CTRL_AEAD_SET_MAC_KEY,
426                                 (int)*mac_secret_size, mac_secret)) {
427         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
428         goto err;
429     }
430     if (EVP_CIPHER_provider(c) != NULL
431             && !tls_provider_set_tls_params(s, dd, c, m)) {
432         /* SSLfatal already called */
433         goto err;
434     }
435
436 #ifndef OPENSSL_NO_KTLS
437     if (s->compress)
438         goto skip_ktls;
439
440     if (((which & SSL3_CC_READ) && (s->mode & SSL_MODE_NO_KTLS_RX))
441         || ((which & SSL3_CC_WRITE) && (s->mode & SSL_MODE_NO_KTLS_TX)))
442         goto skip_ktls;
443
444     /* ktls supports only the maximum fragment size */
445     if (ssl_get_max_send_fragment(s) != SSL3_RT_MAX_PLAIN_LENGTH)
446         goto skip_ktls;
447
448     /* check that cipher is supported */
449     if (!ktls_check_supported_cipher(s, c, dd))
450         goto skip_ktls;
451
452     if (which & SSL3_CC_WRITE)
453         bio = s->wbio;
454     else
455         bio = s->rbio;
456
457     if (!ossl_assert(bio != NULL)) {
458         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
459         goto err;
460     }
461
462     /* All future data will get encrypted by ktls. Flush the BIO or skip ktls */
463     if (which & SSL3_CC_WRITE) {
464        if (BIO_flush(bio) <= 0)
465            goto skip_ktls;
466     }
467
468     /* ktls doesn't support renegotiation */
469     if ((BIO_get_ktls_send(s->wbio) && (which & SSL3_CC_WRITE)) ||
470         (BIO_get_ktls_recv(s->rbio) && (which & SSL3_CC_READ))) {
471         SSLfatal(s, SSL_AD_NO_RENEGOTIATION, ERR_R_INTERNAL_ERROR);
472         goto err;
473     }
474
475     if (which & SSL3_CC_WRITE)
476         rl_sequence = RECORD_LAYER_get_write_sequence(&s->rlayer);
477     else
478         rl_sequence = RECORD_LAYER_get_read_sequence(&s->rlayer);
479
480     if (!ktls_configure_crypto(s, c, dd, rl_sequence, &crypto_info, &rec_seq,
481                                iv, key, ms, *mac_secret_size))
482         goto skip_ktls;
483
484     if (which & SSL3_CC_READ) {
485 # ifndef OPENSSL_NO_KTLS_RX
486         count_unprocessed = count_unprocessed_records(s);
487         if (count_unprocessed < 0)
488             goto skip_ktls;
489
490         /* increment the crypto_info record sequence */
491         while (count_unprocessed) {
492             for (bit = 7; bit >= 0; bit--) { /* increment */
493                 ++rec_seq[bit];
494                 if (rec_seq[bit] != 0)
495                     break;
496             }
497             count_unprocessed--;
498         }
499 # else
500         goto skip_ktls;
501 # endif
502     }
503
504     /* ktls works with user provided buffers directly */
505     if (BIO_set_ktls(bio, &crypto_info, which & SSL3_CC_WRITE)) {
506         if (which & SSL3_CC_WRITE)
507             ssl3_release_write_buffer(s);
508         SSL_set_options(s, SSL_OP_NO_RENEGOTIATION);
509     }
510
511  skip_ktls:
512 #endif                          /* OPENSSL_NO_KTLS */
513     s->statem.enc_write_state = ENC_WRITE_STATE_VALID;
514
515     OSSL_TRACE_BEGIN(TLS) {
516         BIO_printf(trc_out, "which = %04X, key:\n", which);
517         BIO_dump_indent(trc_out, key, EVP_CIPHER_key_length(c), 4);
518         BIO_printf(trc_out, "iv:\n");
519         BIO_dump_indent(trc_out, iv, k, 4);
520     } OSSL_TRACE_END(TLS);
521
522     return 1;
523  err:
524     return 0;
525 }
526
527 int tls1_setup_key_block(SSL *s)
528 {
529     unsigned char *p;
530     const EVP_CIPHER *c;
531     const EVP_MD *hash;
532     SSL_COMP *comp;
533     int mac_type = NID_undef;
534     size_t num, mac_secret_size = 0;
535     int ret = 0;
536
537     if (s->s3.tmp.key_block_length != 0)
538         return 1;
539
540     if (!ssl_cipher_get_evp(s->ctx, s->session, &c, &hash, &mac_type,
541                             &mac_secret_size, &comp, s->ext.use_etm)) {
542         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_R_CIPHER_OR_HASH_UNAVAILABLE);
543         return 0;
544     }
545
546     ssl_evp_cipher_free(s->s3.tmp.new_sym_enc);
547     s->s3.tmp.new_sym_enc = c;
548     ssl_evp_md_free(s->s3.tmp.new_hash);
549     s->s3.tmp.new_hash = hash;
550     s->s3.tmp.new_mac_pkey_type = mac_type;
551     s->s3.tmp.new_mac_secret_size = mac_secret_size;
552     num = mac_secret_size + EVP_CIPHER_key_length(c) + tls_iv_length_within_key_block(c);
553     num *= 2;
554
555     ssl3_cleanup_key_block(s);
556
557     if ((p = OPENSSL_malloc(num)) == NULL) {
558         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_MALLOC_FAILURE);
559         goto err;
560     }
561
562     s->s3.tmp.key_block_length = num;
563     s->s3.tmp.key_block = p;
564
565     OSSL_TRACE_BEGIN(TLS) {
566         BIO_printf(trc_out, "key block length: %ld\n", num);
567         BIO_printf(trc_out, "client random\n");
568         BIO_dump_indent(trc_out, s->s3.client_random, SSL3_RANDOM_SIZE, 4);
569         BIO_printf(trc_out, "server random\n");
570         BIO_dump_indent(trc_out, s->s3.server_random, SSL3_RANDOM_SIZE, 4);
571         BIO_printf(trc_out, "master key\n");
572         BIO_dump_indent(trc_out,
573                         s->session->master_key,
574                         s->session->master_key_length, 4);
575     } OSSL_TRACE_END(TLS);
576
577     if (!tls1_generate_key_block(s, p, num)) {
578         /* SSLfatal() already called */
579         goto err;
580     }
581
582     OSSL_TRACE_BEGIN(TLS) {
583         BIO_printf(trc_out, "key block\n");
584         BIO_dump_indent(trc_out, p, num, 4);
585     } OSSL_TRACE_END(TLS);
586
587     if (!(s->options & SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS)
588         && s->method->version <= TLS1_VERSION) {
589         /*
590          * enable vulnerability countermeasure for CBC ciphers with known-IV
591          * problem (http://www.openssl.org/~bodo/tls-cbc.txt)
592          */
593         s->s3.need_empty_fragments = 1;
594
595         if (s->session->cipher != NULL) {
596             if (s->session->cipher->algorithm_enc == SSL_eNULL)
597                 s->s3.need_empty_fragments = 0;
598
599 #ifndef OPENSSL_NO_RC4
600             if (s->session->cipher->algorithm_enc == SSL_RC4)
601                 s->s3.need_empty_fragments = 0;
602 #endif
603         }
604     }
605
606     ret = 1;
607  err:
608     return ret;
609 }
610
611 size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
612                              unsigned char *out)
613 {
614     size_t hashlen;
615     unsigned char hash[EVP_MAX_MD_SIZE];
616     size_t finished_size = TLS1_FINISH_MAC_LENGTH;
617
618     if (s->s3.tmp.new_cipher->algorithm_mkey & SSL_kGOST18)
619         finished_size = 32;
620
621     if (!ssl3_digest_cached_records(s, 0)) {
622         /* SSLfatal() already called */
623         return 0;
624     }
625
626     if (!ssl_handshake_hash(s, hash, sizeof(hash), &hashlen)) {
627         /* SSLfatal() already called */
628         return 0;
629     }
630
631     if (!tls1_PRF(s, str, slen, hash, hashlen, NULL, 0, NULL, 0, NULL, 0,
632                   s->session->master_key, s->session->master_key_length,
633                   out, finished_size, 1)) {
634         /* SSLfatal() already called */
635         return 0;
636     }
637     OPENSSL_cleanse(hash, hashlen);
638     return finished_size;
639 }
640
641 int tls1_generate_master_secret(SSL *s, unsigned char *out, unsigned char *p,
642                                 size_t len, size_t *secret_size)
643 {
644     if (s->session->flags & SSL_SESS_FLAG_EXTMS) {
645         unsigned char hash[EVP_MAX_MD_SIZE * 2];
646         size_t hashlen;
647         /*
648          * Digest cached records keeping record buffer (if present): this won't
649          * affect client auth because we're freezing the buffer at the same
650          * point (after client key exchange and before certificate verify)
651          */
652         if (!ssl3_digest_cached_records(s, 1)
653                 || !ssl_handshake_hash(s, hash, sizeof(hash), &hashlen)) {
654             /* SSLfatal() already called */
655             return 0;
656         }
657         OSSL_TRACE_BEGIN(TLS) {
658             BIO_printf(trc_out, "Handshake hashes:\n");
659             BIO_dump(trc_out, (char *)hash, hashlen);
660         } OSSL_TRACE_END(TLS);
661         if (!tls1_PRF(s,
662                       TLS_MD_EXTENDED_MASTER_SECRET_CONST,
663                       TLS_MD_EXTENDED_MASTER_SECRET_CONST_SIZE,
664                       hash, hashlen,
665                       NULL, 0,
666                       NULL, 0,
667                       NULL, 0, p, len, out,
668                       SSL3_MASTER_SECRET_SIZE, 1)) {
669             /* SSLfatal() already called */
670             return 0;
671         }
672         OPENSSL_cleanse(hash, hashlen);
673     } else {
674         if (!tls1_PRF(s,
675                       TLS_MD_MASTER_SECRET_CONST,
676                       TLS_MD_MASTER_SECRET_CONST_SIZE,
677                       s->s3.client_random, SSL3_RANDOM_SIZE,
678                       NULL, 0,
679                       s->s3.server_random, SSL3_RANDOM_SIZE,
680                       NULL, 0, p, len, out,
681                       SSL3_MASTER_SECRET_SIZE, 1)) {
682            /* SSLfatal() already called */
683             return 0;
684         }
685     }
686
687     OSSL_TRACE_BEGIN(TLS) {
688         BIO_printf(trc_out, "Premaster Secret:\n");
689         BIO_dump_indent(trc_out, p, len, 4);
690         BIO_printf(trc_out, "Client Random:\n");
691         BIO_dump_indent(trc_out, s->s3.client_random, SSL3_RANDOM_SIZE, 4);
692         BIO_printf(trc_out, "Server Random:\n");
693         BIO_dump_indent(trc_out, s->s3.server_random, SSL3_RANDOM_SIZE, 4);
694         BIO_printf(trc_out, "Master Secret:\n");
695         BIO_dump_indent(trc_out,
696                         s->session->master_key,
697                         SSL3_MASTER_SECRET_SIZE, 4);
698     } OSSL_TRACE_END(TLS);
699
700     *secret_size = SSL3_MASTER_SECRET_SIZE;
701     return 1;
702 }
703
704 int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
705                                 const char *label, size_t llen,
706                                 const unsigned char *context,
707                                 size_t contextlen, int use_context)
708 {
709     unsigned char *val = NULL;
710     size_t vallen = 0, currentvalpos;
711     int rv;
712
713     /*
714      * construct PRF arguments we construct the PRF argument ourself rather
715      * than passing separate values into the TLS PRF to ensure that the
716      * concatenation of values does not create a prohibited label.
717      */
718     vallen = llen + SSL3_RANDOM_SIZE * 2;
719     if (use_context) {
720         vallen += 2 + contextlen;
721     }
722
723     val = OPENSSL_malloc(vallen);
724     if (val == NULL)
725         goto err2;
726     currentvalpos = 0;
727     memcpy(val + currentvalpos, (unsigned char *)label, llen);
728     currentvalpos += llen;
729     memcpy(val + currentvalpos, s->s3.client_random, SSL3_RANDOM_SIZE);
730     currentvalpos += SSL3_RANDOM_SIZE;
731     memcpy(val + currentvalpos, s->s3.server_random, SSL3_RANDOM_SIZE);
732     currentvalpos += SSL3_RANDOM_SIZE;
733
734     if (use_context) {
735         val[currentvalpos] = (contextlen >> 8) & 0xff;
736         currentvalpos++;
737         val[currentvalpos] = contextlen & 0xff;
738         currentvalpos++;
739         if ((contextlen > 0) || (context != NULL)) {
740             memcpy(val + currentvalpos, context, contextlen);
741         }
742     }
743
744     /*
745      * disallow prohibited labels note that SSL3_RANDOM_SIZE > max(prohibited
746      * label len) = 15, so size of val > max(prohibited label len) = 15 and
747      * the comparisons won't have buffer overflow
748      */
749     if (memcmp(val, TLS_MD_CLIENT_FINISH_CONST,
750                TLS_MD_CLIENT_FINISH_CONST_SIZE) == 0)
751         goto err1;
752     if (memcmp(val, TLS_MD_SERVER_FINISH_CONST,
753                TLS_MD_SERVER_FINISH_CONST_SIZE) == 0)
754         goto err1;
755     if (memcmp(val, TLS_MD_MASTER_SECRET_CONST,
756                TLS_MD_MASTER_SECRET_CONST_SIZE) == 0)
757         goto err1;
758     if (memcmp(val, TLS_MD_EXTENDED_MASTER_SECRET_CONST,
759                TLS_MD_EXTENDED_MASTER_SECRET_CONST_SIZE) == 0)
760         goto err1;
761     if (memcmp(val, TLS_MD_KEY_EXPANSION_CONST,
762                TLS_MD_KEY_EXPANSION_CONST_SIZE) == 0)
763         goto err1;
764
765     rv = tls1_PRF(s,
766                   val, vallen,
767                   NULL, 0,
768                   NULL, 0,
769                   NULL, 0,
770                   NULL, 0,
771                   s->session->master_key, s->session->master_key_length,
772                   out, olen, 0);
773
774     goto ret;
775  err1:
776     ERR_raise(ERR_LIB_SSL, SSL_R_TLS_ILLEGAL_EXPORTER_LABEL);
777     rv = 0;
778     goto ret;
779  err2:
780     ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
781     rv = 0;
782  ret:
783     OPENSSL_clear_free(val, vallen);
784     return rv;
785 }
786
787 int tls1_alert_code(int code)
788 {
789     switch (code) {
790     case SSL_AD_CLOSE_NOTIFY:
791         return SSL3_AD_CLOSE_NOTIFY;
792     case SSL_AD_UNEXPECTED_MESSAGE:
793         return SSL3_AD_UNEXPECTED_MESSAGE;
794     case SSL_AD_BAD_RECORD_MAC:
795         return SSL3_AD_BAD_RECORD_MAC;
796     case SSL_AD_DECRYPTION_FAILED:
797         return TLS1_AD_DECRYPTION_FAILED;
798     case SSL_AD_RECORD_OVERFLOW:
799         return TLS1_AD_RECORD_OVERFLOW;
800     case SSL_AD_DECOMPRESSION_FAILURE:
801         return SSL3_AD_DECOMPRESSION_FAILURE;
802     case SSL_AD_HANDSHAKE_FAILURE:
803         return SSL3_AD_HANDSHAKE_FAILURE;
804     case SSL_AD_NO_CERTIFICATE:
805         return -1;
806     case SSL_AD_BAD_CERTIFICATE:
807         return SSL3_AD_BAD_CERTIFICATE;
808     case SSL_AD_UNSUPPORTED_CERTIFICATE:
809         return SSL3_AD_UNSUPPORTED_CERTIFICATE;
810     case SSL_AD_CERTIFICATE_REVOKED:
811         return SSL3_AD_CERTIFICATE_REVOKED;
812     case SSL_AD_CERTIFICATE_EXPIRED:
813         return SSL3_AD_CERTIFICATE_EXPIRED;
814     case SSL_AD_CERTIFICATE_UNKNOWN:
815         return SSL3_AD_CERTIFICATE_UNKNOWN;
816     case SSL_AD_ILLEGAL_PARAMETER:
817         return SSL3_AD_ILLEGAL_PARAMETER;
818     case SSL_AD_UNKNOWN_CA:
819         return TLS1_AD_UNKNOWN_CA;
820     case SSL_AD_ACCESS_DENIED:
821         return TLS1_AD_ACCESS_DENIED;
822     case SSL_AD_DECODE_ERROR:
823         return TLS1_AD_DECODE_ERROR;
824     case SSL_AD_DECRYPT_ERROR:
825         return TLS1_AD_DECRYPT_ERROR;
826     case SSL_AD_EXPORT_RESTRICTION:
827         return TLS1_AD_EXPORT_RESTRICTION;
828     case SSL_AD_PROTOCOL_VERSION:
829         return TLS1_AD_PROTOCOL_VERSION;
830     case SSL_AD_INSUFFICIENT_SECURITY:
831         return TLS1_AD_INSUFFICIENT_SECURITY;
832     case SSL_AD_INTERNAL_ERROR:
833         return TLS1_AD_INTERNAL_ERROR;
834     case SSL_AD_USER_CANCELLED:
835         return TLS1_AD_USER_CANCELLED;
836     case SSL_AD_NO_RENEGOTIATION:
837         return TLS1_AD_NO_RENEGOTIATION;
838     case SSL_AD_UNSUPPORTED_EXTENSION:
839         return TLS1_AD_UNSUPPORTED_EXTENSION;
840     case SSL_AD_CERTIFICATE_UNOBTAINABLE:
841         return TLS1_AD_CERTIFICATE_UNOBTAINABLE;
842     case SSL_AD_UNRECOGNIZED_NAME:
843         return TLS1_AD_UNRECOGNIZED_NAME;
844     case SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE:
845         return TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE;
846     case SSL_AD_BAD_CERTIFICATE_HASH_VALUE:
847         return TLS1_AD_BAD_CERTIFICATE_HASH_VALUE;
848     case SSL_AD_UNKNOWN_PSK_IDENTITY:
849         return TLS1_AD_UNKNOWN_PSK_IDENTITY;
850     case SSL_AD_INAPPROPRIATE_FALLBACK:
851         return TLS1_AD_INAPPROPRIATE_FALLBACK;
852     case SSL_AD_NO_APPLICATION_PROTOCOL:
853         return TLS1_AD_NO_APPLICATION_PROTOCOL;
854     case SSL_AD_CERTIFICATE_REQUIRED:
855         return SSL_AD_HANDSHAKE_FAILURE;
856     default:
857         return -1;
858     }
859 }