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