ssl/tls13_enc.c

   1 /*
   2  * Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <stdlib.h>
  11 #include "ssl_local.h"
  12 #include "internal/ktls.h"
  13 #include "record/record_local.h"
  14 #include "internal/cryptlib.h"
  15 #include <openssl/evp.h>
  16 #include <openssl/kdf.h>
  17 #include <openssl/core_names.h>
  18
  19 #define TLS13_MAX_LABEL_LEN     249
  20
  21 /* Always filled with zeros */
  22 static const unsigned char default_zeros[EVP_MAX_MD_SIZE];
  23
  24 /*
  25  * Given a |secret|; a |label| of length |labellen|; and |data| of length
  26  * |datalen| (e.g. typically a hash of the handshake messages), derive a new
  27  * secret |outlen| bytes long and store it in the location pointed to be |out|.
  28  * The |data| value may be zero length. Any errors will be treated as fatal if
  29  * |fatal| is set. Returns 1 on success  0 on failure.
  30  */
  31 int tls13_hkdf_expand(SSL *s, const EVP_MD *md, const unsigned char *secret,
  32                              const unsigned char *label, size_t labellen,
  33                              const unsigned char *data, size_t datalen,
  34                              unsigned char *out, size_t outlen, int fatal)
  35 {
  36 #ifdef CHARSET_EBCDIC
  37     static const unsigned char label_prefix[] = { 0x74, 0x6C, 0x73, 0x31, 0x33, 0x20, 0x00 };
  38 #else
  39     static const unsigned char label_prefix[] = "tls13 ";
  40 #endif
  41     EVP_KDF *kdf = EVP_KDF_fetch(s->ctx->libctx, OSSL_KDF_NAME_HKDF,
  42                                  s->ctx->propq);
  43     EVP_KDF_CTX *kctx;
  44     OSSL_PARAM params[5], *p = params;
  45     int mode = EVP_PKEY_HKDEF_MODE_EXPAND_ONLY;
  46     const char *mdname = EVP_MD_name(md);
  47     int ret;
  48     size_t hkdflabellen;
  49     size_t hashlen;
  50     /*
  51      * 2 bytes for length of derived secret + 1 byte for length of combined
  52      * prefix and label + bytes for the label itself + 1 byte length of hash
  53      * + bytes for the hash itself
  54      */
  55     unsigned char hkdflabel[sizeof(uint16_t) + sizeof(uint8_t)
  56                             + (sizeof(label_prefix) - 1) + TLS13_MAX_LABEL_LEN
  57                             + 1 + EVP_MAX_MD_SIZE];
  58     WPACKET pkt;
  59
  60     kctx = EVP_KDF_CTX_new(kdf);
  61     EVP_KDF_free(kdf);
  62     if (kctx == NULL)
  63         return 0;
  64
  65     if (labellen > TLS13_MAX_LABEL_LEN) {
  66         if (fatal) {
  67             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
  68         } else {
  69             /*
  70              * Probably we have been called from SSL_export_keying_material(),
  71              * or SSL_export_keying_material_early().
  72              */
  73             ERR_raise(ERR_LIB_SSL, SSL_R_TLS_ILLEGAL_EXPORTER_LABEL);
  74         }
  75         EVP_KDF_CTX_free(kctx);
  76         return 0;
  77     }
  78
  79     hashlen = EVP_MD_size(md);
  80
  81     if (!WPACKET_init_static_len(&pkt, hkdflabel, sizeof(hkdflabel), 0)
  82             || !WPACKET_put_bytes_u16(&pkt, outlen)
  83             || !WPACKET_start_sub_packet_u8(&pkt)
  84             || !WPACKET_memcpy(&pkt, label_prefix, sizeof(label_prefix) - 1)
  85             || !WPACKET_memcpy(&pkt, label, labellen)
  86             || !WPACKET_close(&pkt)
  87             || !WPACKET_sub_memcpy_u8(&pkt, data, (data == NULL) ? 0 : datalen)
  88             || !WPACKET_get_total_written(&pkt, &hkdflabellen)
  89             || !WPACKET_finish(&pkt)) {
  90         EVP_KDF_CTX_free(kctx);
  91         WPACKET_cleanup(&pkt);
  92         if (fatal)
  93             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
  94         else
  95             ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
  96         return 0;
  97     }
  98
  99     *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_MODE, &mode);
 100     *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
 101                                             (char *)mdname, 0);
 102     *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_KEY,
 103                                              (unsigned char *)secret, hashlen);
 104     *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_INFO,
 105                                              hkdflabel, hkdflabellen);
 106     *p++ = OSSL_PARAM_construct_end();
 107
 108     ret = EVP_KDF_derive(kctx, out, outlen, params) <= 0;
 109
 110     EVP_KDF_CTX_free(kctx);
 111
 112     if (ret != 0) {
 113         if (fatal)
 114             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 115         else
 116             ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
 117     }
 118
 119     return ret == 0;
 120 }
 121
 122 /*
 123  * Given a |secret| generate a |key| of length |keylen| bytes. Returns 1 on
 124  * success  0 on failure.
 125  */
 126 int tls13_derive_key(SSL *s, const EVP_MD *md, const unsigned char *secret,
 127                      unsigned char *key, size_t keylen)
 128 {
 129 #ifdef CHARSET_EBCDIC
 130   static const unsigned char keylabel[] ={ 0x6B, 0x65, 0x79, 0x00 };
 131 #else
 132   static const unsigned char keylabel[] = "key";
 133 #endif
 134
 135     return tls13_hkdf_expand(s, md, secret, keylabel, sizeof(keylabel) - 1,
 136                              NULL, 0, key, keylen, 1);
 137 }
 138
 139 /*
 140  * Given a |secret| generate an |iv| of length |ivlen| bytes. Returns 1 on
 141  * success  0 on failure.
 142  */
 143 int tls13_derive_iv(SSL *s, const EVP_MD *md, const unsigned char *secret,
 144                     unsigned char *iv, size_t ivlen)
 145 {
 146 #ifdef CHARSET_EBCDIC
 147   static const unsigned char ivlabel[] = { 0x69, 0x76, 0x00 };
 148 #else
 149   static const unsigned char ivlabel[] = "iv";
 150 #endif
 151
 152     return tls13_hkdf_expand(s, md, secret, ivlabel, sizeof(ivlabel) - 1,
 153                              NULL, 0, iv, ivlen, 1);
 154 }
 155
 156 int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
 157                              const unsigned char *secret,
 158                              unsigned char *fin, size_t finlen)
 159 {
 160 #ifdef CHARSET_EBCDIC
 161   static const unsigned char finishedlabel[] = { 0x66, 0x69, 0x6E, 0x69, 0x73, 0x68, 0x65, 0x64, 0x00 };
 162 #else
 163   static const unsigned char finishedlabel[] = "finished";
 164 #endif
 165
 166     return tls13_hkdf_expand(s, md, secret, finishedlabel,
 167                              sizeof(finishedlabel) - 1, NULL, 0, fin, finlen, 1);
 168 }
 169
 170 /*
 171  * Given the previous secret |prevsecret| and a new input secret |insecret| of
 172  * length |insecretlen|, generate a new secret and store it in the location
 173  * pointed to by |outsecret|. Returns 1 on success  0 on failure.
 174  */
 175 int tls13_generate_secret(SSL *s, const EVP_MD *md,
 176                           const unsigned char *prevsecret,
 177                           const unsigned char *insecret,
 178                           size_t insecretlen,
 179                           unsigned char *outsecret)
 180 {
 181     size_t mdlen, prevsecretlen;
 182     int mdleni;
 183     int ret;
 184     EVP_KDF *kdf;
 185     EVP_KDF_CTX *kctx;
 186     OSSL_PARAM params[5], *p = params;
 187     int mode = EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY;
 188     const char *mdname = EVP_MD_name(md);
 189 #ifdef CHARSET_EBCDIC
 190     static const char derived_secret_label[] = { 0x64, 0x65, 0x72, 0x69, 0x76, 0x65, 0x64, 0x00 };
 191 #else
 192     static const char derived_secret_label[] = "derived";
 193 #endif
 194     unsigned char preextractsec[EVP_MAX_MD_SIZE];
 195
 196     kdf = EVP_KDF_fetch(s->ctx->libctx, OSSL_KDF_NAME_HKDF, s->ctx->propq);
 197     kctx = EVP_KDF_CTX_new(kdf);
 198     EVP_KDF_free(kdf);
 199     if (kctx == NULL) {
 200         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 201         return 0;
 202     }
 203
 204     mdleni = EVP_MD_size(md);
 205     /* Ensure cast to size_t is safe */
 206     if (!ossl_assert(mdleni >= 0)) {
 207         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 208         EVP_KDF_CTX_free(kctx);
 209         return 0;
 210     }
 211     mdlen = (size_t)mdleni;
 212
 213     if (insecret == NULL) {
 214         insecret = default_zeros;
 215         insecretlen = mdlen;
 216     }
 217     if (prevsecret == NULL) {
 218         prevsecret = default_zeros;
 219         prevsecretlen = 0;
 220     } else {
 221         EVP_MD_CTX *mctx = EVP_MD_CTX_new();
 222         unsigned char hash[EVP_MAX_MD_SIZE];
 223
 224         /* The pre-extract derive step uses a hash of no messages */
 225         if (mctx == NULL
 226                 || EVP_DigestInit_ex(mctx, md, NULL) <= 0
 227                 || EVP_DigestFinal_ex(mctx, hash, NULL) <= 0) {
 228             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 229             EVP_MD_CTX_free(mctx);
 230             EVP_KDF_CTX_free(kctx);
 231             return 0;
 232         }
 233         EVP_MD_CTX_free(mctx);
 234
 235         /* Generate the pre-extract secret */
 236         if (!tls13_hkdf_expand(s, md, prevsecret,
 237                                (unsigned char *)derived_secret_label,
 238                                sizeof(derived_secret_label) - 1, hash, mdlen,
 239                                preextractsec, mdlen, 1)) {
 240             /* SSLfatal() already called */
 241             EVP_KDF_CTX_free(kctx);
 242             return 0;
 243         }
 244
 245         prevsecret = preextractsec;
 246         prevsecretlen = mdlen;
 247     }
 248
 249     *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_MODE, &mode);
 250     *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
 251                                             (char *)mdname, 0);
 252     *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_KEY,
 253                                              (unsigned char *)insecret,
 254                                              insecretlen);
 255     *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SALT,
 256                                              (unsigned char *)prevsecret,
 257                                              prevsecretlen);
 258     *p++ = OSSL_PARAM_construct_end();
 259
 260     ret = EVP_KDF_derive(kctx, outsecret, mdlen, params) <= 0;
 261
 262     if (ret != 0)
 263         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 264
 265     EVP_KDF_CTX_free(kctx);
 266     if (prevsecret == preextractsec)
 267         OPENSSL_cleanse(preextractsec, mdlen);
 268     return ret == 0;
 269 }
 270
 271 /*
 272  * Given an input secret |insecret| of length |insecretlen| generate the
 273  * handshake secret. This requires the early secret to already have been
 274  * generated. Returns 1 on success  0 on failure.
 275  */
 276 int tls13_generate_handshake_secret(SSL *s, const unsigned char *insecret,
 277                                 size_t insecretlen)
 278 {
 279     /* Calls SSLfatal() if required */
 280     return tls13_generate_secret(s, ssl_handshake_md(s), s->early_secret,
 281                                  insecret, insecretlen,
 282                                  (unsigned char *)&s->handshake_secret);
 283 }
 284
 285 /*
 286  * Given the handshake secret |prev| of length |prevlen| generate the master
 287  * secret and store its length in |*secret_size|. Returns 1 on success  0 on
 288  * failure.
 289  */
 290 int tls13_generate_master_secret(SSL *s, unsigned char *out,
 291                                  unsigned char *prev, size_t prevlen,
 292                                  size_t *secret_size)
 293 {
 294     const EVP_MD *md = ssl_handshake_md(s);
 295
 296     *secret_size = EVP_MD_size(md);
 297     /* Calls SSLfatal() if required */
 298     return tls13_generate_secret(s, md, prev, NULL, 0, out);
 299 }
 300
 301 /*
 302  * Generates the mac for the Finished message. Returns the length of the MAC or
 303  * 0 on error.
 304  */
 305 size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
 306                              unsigned char *out)
 307 {
 308     const char *mdname = EVP_MD_name(ssl_handshake_md(s));
 309     EVP_MAC *hmac = EVP_MAC_fetch(s->ctx->libctx, "HMAC", s->ctx->propq);
 310     unsigned char hash[EVP_MAX_MD_SIZE];
 311     unsigned char finsecret[EVP_MAX_MD_SIZE];
 312     unsigned char *key = NULL;
 313     size_t hashlen, ret = 0;
 314     EVP_MAC_CTX *ctx = NULL;
 315     OSSL_PARAM params[3], *p = params;
 316
 317     if (hmac == NULL) {
 318         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 319         goto err;
 320     }
 321
 322     /* Safe to cast away const here since we're not "getting" any data */
 323     *p++ = OSSL_PARAM_construct_utf8_string(OSSL_ALG_PARAM_DIGEST,
 324                                             (char *)mdname, 0);
 325     if (s->ctx->propq != NULL)
 326         *p++ = OSSL_PARAM_construct_utf8_string(OSSL_ALG_PARAM_PROPERTIES,
 327                                                 (char *)s->ctx->propq,
 328                                                 0);
 329     *p = OSSL_PARAM_construct_end();
 330
 331     if (!ssl_handshake_hash(s, hash, sizeof(hash), &hashlen)) {
 332         /* SSLfatal() already called */
 333         goto err;
 334     }
 335
 336     if (str == s->method->ssl3_enc->server_finished_label) {
 337         key = s->server_finished_secret;
 338     } else if (SSL_IS_FIRST_HANDSHAKE(s)) {
 339         key = s->client_finished_secret;
 340     } else {
 341         if (!tls13_derive_finishedkey(s, ssl_handshake_md(s),
 342                                       s->client_app_traffic_secret,
 343                                       finsecret, hashlen))
 344             goto err;
 345         key = finsecret;
 346     }
 347
 348     ctx = EVP_MAC_CTX_new(hmac);
 349     if (ctx == NULL
 350             || !EVP_MAC_init(ctx, key, hashlen, params)
 351             || !EVP_MAC_update(ctx, hash, hashlen)
 352                /* outsize as per sizeof(peer_finish_md) */
 353             || !EVP_MAC_final(ctx, out, &hashlen, EVP_MAX_MD_SIZE * 2)) {
 354         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 355         goto err;
 356     }
 357
 358     ret = hashlen;
 359  err:
 360     OPENSSL_cleanse(finsecret, sizeof(finsecret));
 361     EVP_MAC_CTX_free(ctx);
 362     EVP_MAC_free(hmac);
 363     return ret;
 364 }
 365
 366 /*
 367  * There isn't really a key block in TLSv1.3, but we still need this function
 368  * for initialising the cipher and hash. Returns 1 on success or 0 on failure.
 369  */
 370 int tls13_setup_key_block(SSL *s)
 371 {
 372     const EVP_CIPHER *c;
 373     const EVP_MD *hash;
 374
 375     s->session->cipher = s->s3.tmp.new_cipher;
 376     if (!ssl_cipher_get_evp(s->ctx, s->session, &c, &hash, NULL, NULL, NULL,
 377                             0)) {
 378         /* Error is already recorded */
 379         SSLfatal_alert(s, SSL_AD_INTERNAL_ERROR);
 380         return 0;
 381     }
 382
 383     ssl_evp_cipher_free(s->s3.tmp.new_sym_enc);
 384     s->s3.tmp.new_sym_enc = c;
 385     ssl_evp_md_free(s->s3.tmp.new_hash);
 386     s->s3.tmp.new_hash = hash;
 387
 388     return 1;
 389 }
 390
 391 static int derive_secret_key_and_iv(SSL *s, int sending, const EVP_MD *md,
 392                                     const EVP_CIPHER *ciph,
 393                                     const unsigned char *insecret,
 394                                     const unsigned char *hash,
 395                                     const unsigned char *label,
 396                                     size_t labellen, unsigned char *secret,
 397                                     unsigned char *key, unsigned char *iv,
 398                                     EVP_CIPHER_CTX *ciph_ctx)
 399 {
 400     size_t ivlen, keylen, taglen;
 401     int hashleni = EVP_MD_size(md);
 402     size_t hashlen;
 403
 404     /* Ensure cast to size_t is safe */
 405     if (!ossl_assert(hashleni >= 0)) {
 406         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_EVP_LIB);
 407         return 0;
 408     }
 409     hashlen = (size_t)hashleni;
 410
 411     if (!tls13_hkdf_expand(s, md, insecret, label, labellen, hash, hashlen,
 412                            secret, hashlen, 1)) {
 413         /* SSLfatal() already called */
 414         return 0;
 415     }
 416
 417     /* TODO(size_t): convert me */
 418     keylen = EVP_CIPHER_key_length(ciph);
 419     if (EVP_CIPHER_mode(ciph) == EVP_CIPH_CCM_MODE) {
 420         uint32_t algenc;
 421
 422         ivlen = EVP_CCM_TLS_IV_LEN;
 423         if (s->s3.tmp.new_cipher != NULL) {
 424             algenc = s->s3.tmp.new_cipher->algorithm_enc;
 425         } else if (s->session->cipher != NULL) {
 426             /* We've not selected a cipher yet - we must be doing early data */
 427             algenc = s->session->cipher->algorithm_enc;
 428         } else if (s->psksession != NULL && s->psksession->cipher != NULL) {
 429             /* We must be doing early data with out-of-band PSK */
 430             algenc = s->psksession->cipher->algorithm_enc;
 431         } else {
 432             SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_EVP_LIB);
 433             return 0;
 434         }
 435         if (algenc & (SSL_AES128CCM8 | SSL_AES256CCM8))
 436             taglen = EVP_CCM8_TLS_TAG_LEN;
 437          else
 438             taglen = EVP_CCM_TLS_TAG_LEN;
 439     } else {
 440         ivlen = EVP_CIPHER_iv_length(ciph);
 441         taglen = 0;
 442     }
 443
 444     if (!tls13_derive_key(s, md, secret, key, keylen)
 445             || !tls13_derive_iv(s, md, secret, iv, ivlen)) {
 446         /* SSLfatal() already called */
 447         return 0;
 448     }
 449
 450     if (EVP_CipherInit_ex(ciph_ctx, ciph, NULL, NULL, NULL, sending) <= 0
 451         || !EVP_CIPHER_CTX_ctrl(ciph_ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)
 452         || (taglen != 0 && !EVP_CIPHER_CTX_ctrl(ciph_ctx, EVP_CTRL_AEAD_SET_TAG,
 453                                                 taglen, NULL))
 454         || EVP_CipherInit_ex(ciph_ctx, NULL, NULL, key, NULL, -1) <= 0) {
 455         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_EVP_LIB);
 456         return 0;
 457     }
 458
 459     return 1;
 460 }
 461
 462 int tls13_change_cipher_state(SSL *s, int which)
 463 {
 464 #ifdef CHARSET_EBCDIC
 465   static const unsigned char client_early_traffic[]       = {0x63, 0x20, 0x65, 0x20,       /*traffic*/0x74, 0x72, 0x61, 0x66, 0x66, 0x69, 0x63, 0x00};
 466   static const unsigned char client_handshake_traffic[]   = {0x63, 0x20, 0x68, 0x73, 0x20, /*traffic*/0x74, 0x72, 0x61, 0x66, 0x66, 0x69, 0x63, 0x00};
 467   static const unsigned char client_application_traffic[] = {0x63, 0x20, 0x61, 0x70, 0x20, /*traffic*/0x74, 0x72, 0x61, 0x66, 0x66, 0x69, 0x63, 0x00};
 468   static const unsigned char server_handshake_traffic[]   = {0x73, 0x20, 0x68, 0x73, 0x20, /*traffic*/0x74, 0x72, 0x61, 0x66, 0x66, 0x69, 0x63, 0x00};
 469   static const unsigned char server_application_traffic[] = {0x73, 0x20, 0x61, 0x70, 0x20, /*traffic*/0x74, 0x72, 0x61, 0x66, 0x66, 0x69, 0x63, 0x00};
 470   static const unsigned char exporter_master_secret[] = {0x65, 0x78, 0x70, 0x20,                    /* master*/  0x6D, 0x61, 0x73, 0x74, 0x65, 0x72, 0x00};
 471   static const unsigned char resumption_master_secret[] = {0x72, 0x65, 0x73, 0x20,                  /* master*/  0x6D, 0x61, 0x73, 0x74, 0x65, 0x72, 0x00};
 472   static const unsigned char early_exporter_master_secret[] = {0x65, 0x20, 0x65, 0x78, 0x70, 0x20,  /* master*/  0x6D, 0x61, 0x73, 0x74, 0x65, 0x72, 0x00};
 473 #else
 474     static const unsigned char client_early_traffic[] = "c e traffic";
 475     static const unsigned char client_handshake_traffic[] = "c hs traffic";
 476     static const unsigned char client_application_traffic[] = "c ap traffic";
 477     static const unsigned char server_handshake_traffic[] = "s hs traffic";
 478     static const unsigned char server_application_traffic[] = "s ap traffic";
 479     static const unsigned char exporter_master_secret[] = "exp master";
 480     static const unsigned char resumption_master_secret[] = "res master";
 481     static const unsigned char early_exporter_master_secret[] = "e exp master";
 482 #endif
 483     unsigned char *iv;
 484     unsigned char key[EVP_MAX_KEY_LENGTH];
 485     unsigned char secret[EVP_MAX_MD_SIZE];
 486     unsigned char hashval[EVP_MAX_MD_SIZE];
 487     unsigned char *hash = hashval;
 488     unsigned char *insecret;
 489     unsigned char *finsecret = NULL;
 490     const char *log_label = NULL;
 491     EVP_CIPHER_CTX *ciph_ctx;
 492     size_t finsecretlen = 0;
 493     const unsigned char *label;
 494     size_t labellen, hashlen = 0;
 495     int ret = 0;
 496     const EVP_MD *md = NULL;
 497     const EVP_CIPHER *cipher = NULL;
 498 #if !defined(OPENSSL_NO_KTLS) && defined(OPENSSL_KTLS_TLS13)
 499     ktls_crypto_info_t crypto_info;
 500     BIO *bio;
 501 #endif
 502
 503     if (which & SSL3_CC_READ) {
 504         if (s->enc_read_ctx != NULL) {
 505             EVP_CIPHER_CTX_reset(s->enc_read_ctx);
 506         } else {
 507             s->enc_read_ctx = EVP_CIPHER_CTX_new();
 508             if (s->enc_read_ctx == NULL) {
 509                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_MALLOC_FAILURE);
 510                 goto err;
 511             }
 512         }
 513         ciph_ctx = s->enc_read_ctx;
 514         iv = s->read_iv;
 515
 516         RECORD_LAYER_reset_read_sequence(&s->rlayer);
 517     } else {
 518         s->statem.enc_write_state = ENC_WRITE_STATE_INVALID;
 519         if (s->enc_write_ctx != NULL) {
 520             EVP_CIPHER_CTX_reset(s->enc_write_ctx);
 521         } else {
 522             s->enc_write_ctx = EVP_CIPHER_CTX_new();
 523             if (s->enc_write_ctx == NULL) {
 524                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_MALLOC_FAILURE);
 525                 goto err;
 526             }
 527         }
 528         ciph_ctx = s->enc_write_ctx;
 529         iv = s->write_iv;
 530
 531         RECORD_LAYER_reset_write_sequence(&s->rlayer);
 532     }
 533
 534     if (((which & SSL3_CC_CLIENT) && (which & SSL3_CC_WRITE))
 535             || ((which & SSL3_CC_SERVER) && (which & SSL3_CC_READ))) {
 536         if (which & SSL3_CC_EARLY) {
 537             EVP_MD_CTX *mdctx = NULL;
 538             long handlen;
 539             void *hdata;
 540             unsigned int hashlenui;
 541             const SSL_CIPHER *sslcipher = SSL_SESSION_get0_cipher(s->session);
 542
 543             insecret = s->early_secret;
 544             label = client_early_traffic;
 545             labellen = sizeof(client_early_traffic) - 1;
 546             log_label = CLIENT_EARLY_LABEL;
 547
 548             handlen = BIO_get_mem_data(s->s3.handshake_buffer, &hdata);
 549             if (handlen <= 0) {
 550                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_R_BAD_HANDSHAKE_LENGTH);
 551                 goto err;
 552             }
 553
 554             if (s->early_data_state == SSL_EARLY_DATA_CONNECTING
 555                     && s->max_early_data > 0
 556                     && s->session->ext.max_early_data == 0) {
 557                 /*
 558                  * If we are attempting to send early data, and we've decided to
 559                  * actually do it but max_early_data in s->session is 0 then we
 560                  * must be using an external PSK.
 561                  */
 562                 if (!ossl_assert(s->psksession != NULL
 563                         && s->max_early_data ==
 564                            s->psksession->ext.max_early_data)) {
 565                     SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 566                     goto err;
 567                 }
 568                 sslcipher = SSL_SESSION_get0_cipher(s->psksession);
 569             }
 570             if (sslcipher == NULL) {
 571                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_R_BAD_PSK);
 572                 goto err;
 573             }
 574
 575             /*
 576              * We need to calculate the handshake digest using the digest from
 577              * the session. We haven't yet selected our ciphersuite so we can't
 578              * use ssl_handshake_md().
 579              */
 580             mdctx = EVP_MD_CTX_new();
 581             if (mdctx == NULL) {
 582                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_MALLOC_FAILURE);
 583                 goto err;
 584             }
 585
 586             /*
 587              * This ups the ref count on cipher so we better make sure we free
 588              * it again
 589              */
 590             if (!ssl_cipher_get_evp_cipher(s->ctx, sslcipher, &cipher)) {
 591                 /* Error is already recorded */
 592                 SSLfatal_alert(s, SSL_AD_INTERNAL_ERROR);
 593                 EVP_MD_CTX_free(mdctx);
 594                 goto err;
 595             }
 596
 597             md = ssl_md(s->ctx, sslcipher->algorithm2);
 598             if (md == NULL || !EVP_DigestInit_ex(mdctx, md, NULL)
 599                     || !EVP_DigestUpdate(mdctx, hdata, handlen)
 600                     || !EVP_DigestFinal_ex(mdctx, hashval, &hashlenui)) {
 601                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 602                 EVP_MD_CTX_free(mdctx);
 603                 goto err;
 604             }
 605             hashlen = hashlenui;
 606             EVP_MD_CTX_free(mdctx);
 607
 608             if (!tls13_hkdf_expand(s, md, insecret,
 609                                    early_exporter_master_secret,
 610                                    sizeof(early_exporter_master_secret) - 1,
 611                                    hashval, hashlen,
 612                                    s->early_exporter_master_secret, hashlen,
 613                                    1)) {
 614                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 615                 goto err;
 616             }
 617
 618             if (!ssl_log_secret(s, EARLY_EXPORTER_SECRET_LABEL,
 619                                 s->early_exporter_master_secret, hashlen)) {
 620                 /* SSLfatal() already called */
 621                 goto err;
 622             }
 623         } else if (which & SSL3_CC_HANDSHAKE) {
 624             insecret = s->handshake_secret;
 625             finsecret = s->client_finished_secret;
 626             finsecretlen = EVP_MD_size(ssl_handshake_md(s));
 627             label = client_handshake_traffic;
 628             labellen = sizeof(client_handshake_traffic) - 1;
 629             log_label = CLIENT_HANDSHAKE_LABEL;
 630             /*
 631              * The handshake hash used for the server read/client write handshake
 632              * traffic secret is the same as the hash for the server
 633              * write/client read handshake traffic secret. However, if we
 634              * processed early data then we delay changing the server
 635              * read/client write cipher state until later, and the handshake
 636              * hashes have moved on. Therefore we use the value saved earlier
 637              * when we did the server write/client read change cipher state.
 638              */
 639             hash = s->handshake_traffic_hash;
 640         } else {
 641             insecret = s->master_secret;
 642             label = client_application_traffic;
 643             labellen = sizeof(client_application_traffic) - 1;
 644             log_label = CLIENT_APPLICATION_LABEL;
 645             /*
 646              * For this we only use the handshake hashes up until the server
 647              * Finished hash. We do not include the client's Finished, which is
 648              * what ssl_handshake_hash() would give us. Instead we use the
 649              * previously saved value.
 650              */
 651             hash = s->server_finished_hash;
 652         }
 653     } else {
 654         /* Early data never applies to client-read/server-write */
 655         if (which & SSL3_CC_HANDSHAKE) {
 656             insecret = s->handshake_secret;
 657             finsecret = s->server_finished_secret;
 658             finsecretlen = EVP_MD_size(ssl_handshake_md(s));
 659             label = server_handshake_traffic;
 660             labellen = sizeof(server_handshake_traffic) - 1;
 661             log_label = SERVER_HANDSHAKE_LABEL;
 662         } else {
 663             insecret = s->master_secret;
 664             label = server_application_traffic;
 665             labellen = sizeof(server_application_traffic) - 1;
 666             log_label = SERVER_APPLICATION_LABEL;
 667         }
 668     }
 669
 670     if (!(which & SSL3_CC_EARLY)) {
 671         md = ssl_handshake_md(s);
 672         cipher = s->s3.tmp.new_sym_enc;
 673         if (!ssl3_digest_cached_records(s, 1)
 674                 || !ssl_handshake_hash(s, hashval, sizeof(hashval), &hashlen)) {
 675             /* SSLfatal() already called */;
 676             goto err;
 677         }
 678     }
 679
 680     /*
 681      * Save the hash of handshakes up to now for use when we calculate the
 682      * client application traffic secret
 683      */
 684     if (label == server_application_traffic)
 685         memcpy(s->server_finished_hash, hashval, hashlen);
 686
 687     if (label == server_handshake_traffic)
 688         memcpy(s->handshake_traffic_hash, hashval, hashlen);
 689
 690     if (label == client_application_traffic) {
 691         /*
 692          * We also create the resumption master secret, but this time use the
 693          * hash for the whole handshake including the Client Finished
 694          */
 695         if (!tls13_hkdf_expand(s, ssl_handshake_md(s), insecret,
 696                                resumption_master_secret,
 697                                sizeof(resumption_master_secret) - 1,
 698                                hashval, hashlen, s->resumption_master_secret,
 699                                hashlen, 1)) {
 700             /* SSLfatal() already called */
 701             goto err;
 702         }
 703     }
 704
 705     /* check whether cipher is known */
 706     if(!ossl_assert(cipher != NULL))
 707         goto err;
 708
 709     if (!derive_secret_key_and_iv(s, which & SSL3_CC_WRITE, md, cipher,
 710                                   insecret, hash, label, labellen, secret, key,
 711                                   iv, ciph_ctx)) {
 712         /* SSLfatal() already called */
 713         goto err;
 714     }
 715
 716     if (label == server_application_traffic) {
 717         memcpy(s->server_app_traffic_secret, secret, hashlen);
 718         /* Now we create the exporter master secret */
 719         if (!tls13_hkdf_expand(s, ssl_handshake_md(s), insecret,
 720                                exporter_master_secret,
 721                                sizeof(exporter_master_secret) - 1,
 722                                hash, hashlen, s->exporter_master_secret,
 723                                hashlen, 1)) {
 724             /* SSLfatal() already called */
 725             goto err;
 726         }
 727
 728         if (!ssl_log_secret(s, EXPORTER_SECRET_LABEL, s->exporter_master_secret,
 729                             hashlen)) {
 730             /* SSLfatal() already called */
 731             goto err;
 732         }
 733     } else if (label == client_application_traffic)
 734         memcpy(s->client_app_traffic_secret, secret, hashlen);
 735
 736     if (!ssl_log_secret(s, log_label, secret, hashlen)) {
 737         /* SSLfatal() already called */
 738         goto err;
 739     }
 740
 741     if (finsecret != NULL
 742             && !tls13_derive_finishedkey(s, ssl_handshake_md(s), secret,
 743                                          finsecret, finsecretlen)) {
 744         /* SSLfatal() already called */
 745         goto err;
 746     }
 747
 748     if (!s->server && label == client_early_traffic)
 749         s->statem.enc_write_state = ENC_WRITE_STATE_WRITE_PLAIN_ALERTS;
 750     else
 751         s->statem.enc_write_state = ENC_WRITE_STATE_VALID;
 752 #ifndef OPENSSL_NO_KTLS
 753 # if defined(OPENSSL_KTLS_TLS13)
 754     if (!(which & SSL3_CC_WRITE)
 755             || !(which & SSL3_CC_APPLICATION)
 756             || (s->options & SSL_OP_ENABLE_KTLS) == 0)
 757         goto skip_ktls;
 758
 759     /* ktls supports only the maximum fragment size */
 760     if (ssl_get_max_send_fragment(s) != SSL3_RT_MAX_PLAIN_LENGTH)
 761         goto skip_ktls;
 762
 763     /* ktls does not support record padding */
 764     if (s->record_padding_cb != NULL)
 765         goto skip_ktls;
 766
 767     /* check that cipher is supported */
 768     if (!ktls_check_supported_cipher(s, cipher, ciph_ctx))
 769         goto skip_ktls;
 770
 771     bio = s->wbio;
 772
 773     if (!ossl_assert(bio != NULL)) {
 774         SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
 775         goto err;
 776     }
 777
 778     /* All future data will get encrypted by ktls. Flush the BIO or skip ktls */
 779     if (BIO_flush(bio) <= 0)
 780         goto skip_ktls;
 781
 782     /* configure kernel crypto structure */
 783     if (!ktls_configure_crypto(s, cipher, ciph_ctx,
 784                                RECORD_LAYER_get_write_sequence(&s->rlayer),
 785                                &crypto_info, NULL, iv, key, NULL, 0))
 786         goto skip_ktls;
 787
 788     /* ktls works with user provided buffers directly */
 789     if (BIO_set_ktls(bio, &crypto_info, which & SSL3_CC_WRITE))
 790         ssl3_release_write_buffer(s);
 791 skip_ktls:
 792 # endif
 793 #endif
 794     ret = 1;
 795  err:
 796     if ((which & SSL3_CC_EARLY) != 0) {
 797         /* We up-refed this so now we need to down ref */
 798         ssl_evp_cipher_free(cipher);
 799     }
 800     OPENSSL_cleanse(key, sizeof(key));
 801     OPENSSL_cleanse(secret, sizeof(secret));
 802     return ret;
 803 }
 804
 805 int tls13_update_key(SSL *s, int sending)
 806 {
 807 #ifdef CHARSET_EBCDIC
 808   static const unsigned char application_traffic[] = { 0x74, 0x72 ,0x61 ,0x66 ,0x66 ,0x69 ,0x63 ,0x20 ,0x75 ,0x70 ,0x64, 0x00};
 809 #else
 810   static const unsigned char application_traffic[] = "traffic upd";
 811 #endif
 812     const EVP_MD *md = ssl_handshake_md(s);
 813     size_t hashlen = EVP_MD_size(md);
 814     unsigned char key[EVP_MAX_KEY_LENGTH];
 815     unsigned char *insecret, *iv;
 816     unsigned char secret[EVP_MAX_MD_SIZE];
 817     EVP_CIPHER_CTX *ciph_ctx;
 818     int ret = 0;
 819
 820     if (s->server == sending)
 821         insecret = s->server_app_traffic_secret;
 822     else
 823         insecret = s->client_app_traffic_secret;
 824
 825     if (sending) {
 826         s->statem.enc_write_state = ENC_WRITE_STATE_INVALID;
 827         iv = s->write_iv;
 828         ciph_ctx = s->enc_write_ctx;
 829         RECORD_LAYER_reset_write_sequence(&s->rlayer);
 830     } else {
 831         iv = s->read_iv;
 832         ciph_ctx = s->enc_read_ctx;
 833         RECORD_LAYER_reset_read_sequence(&s->rlayer);
 834     }
 835
 836     if (!derive_secret_key_and_iv(s, sending, ssl_handshake_md(s),
 837                                   s->s3.tmp.new_sym_enc, insecret, NULL,
 838                                   application_traffic,
 839                                   sizeof(application_traffic) - 1, secret, key,
 840                                   iv, ciph_ctx)) {
 841         /* SSLfatal() already called */
 842         goto err;
 843     }
 844
 845     memcpy(insecret, secret, hashlen);
 846
 847     s->statem.enc_write_state = ENC_WRITE_STATE_VALID;
 848     ret = 1;
 849  err:
 850     OPENSSL_cleanse(key, sizeof(key));
 851     OPENSSL_cleanse(secret, sizeof(secret));
 852     return ret;
 853 }
 854
 855 int tls13_alert_code(int code)
 856 {
 857     /* There are 2 additional alerts in TLSv1.3 compared to TLSv1.2 */
 858     if (code == SSL_AD_MISSING_EXTENSION || code == SSL_AD_CERTIFICATE_REQUIRED)
 859         return code;
 860
 861     return tls1_alert_code(code);
 862 }
 863
 864 int tls13_export_keying_material(SSL *s, unsigned char *out, size_t olen,
 865                                  const char *label, size_t llen,
 866                                  const unsigned char *context,
 867                                  size_t contextlen, int use_context)
 868 {
 869     unsigned char exportsecret[EVP_MAX_MD_SIZE];
 870 #ifdef CHARSET_EBCDIC
 871     static const unsigned char exporterlabel[] = {0x65, 0x78, 0x70, 0x6F, 0x72, 0x74, 0x65, 0x72, 0x00};
 872 #else
 873     static const unsigned char exporterlabel[] = "exporter";
 874 #endif
 875     unsigned char hash[EVP_MAX_MD_SIZE], data[EVP_MAX_MD_SIZE];
 876     const EVP_MD *md = ssl_handshake_md(s);
 877     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
 878     unsigned int hashsize, datalen;
 879     int ret = 0;
 880
 881     if (ctx == NULL || !ossl_statem_export_allowed(s))
 882         goto err;
 883
 884     if (!use_context)
 885         contextlen = 0;
 886
 887     if (EVP_DigestInit_ex(ctx, md, NULL) <= 0
 888             || EVP_DigestUpdate(ctx, context, contextlen) <= 0
 889             || EVP_DigestFinal_ex(ctx, hash, &hashsize) <= 0
 890             || EVP_DigestInit_ex(ctx, md, NULL) <= 0
 891             || EVP_DigestFinal_ex(ctx, data, &datalen) <= 0
 892             || !tls13_hkdf_expand(s, md, s->exporter_master_secret,
 893                                   (const unsigned char *)label, llen,
 894                                   data, datalen, exportsecret, hashsize, 0)
 895             || !tls13_hkdf_expand(s, md, exportsecret, exporterlabel,
 896                                   sizeof(exporterlabel) - 1, hash, hashsize,
 897                                   out, olen, 0))
 898         goto err;
 899
 900     ret = 1;
 901  err:
 902     EVP_MD_CTX_free(ctx);
 903     return ret;
 904 }
 905
 906 int tls13_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
 907                                        const char *label, size_t llen,
 908                                        const unsigned char *context,
 909                                        size_t contextlen)
 910 {
 911 #ifdef CHARSET_EBCDIC
 912   static const unsigned char exporterlabel[] = {0x65, 0x78, 0x70, 0x6F, 0x72, 0x74, 0x65, 0x72, 0x00};
 913 #else
 914   static const unsigned char exporterlabel[] = "exporter";
 915 #endif
 916     unsigned char exportsecret[EVP_MAX_MD_SIZE];
 917     unsigned char hash[EVP_MAX_MD_SIZE], data[EVP_MAX_MD_SIZE];
 918     const EVP_MD *md;
 919     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
 920     unsigned int hashsize, datalen;
 921     int ret = 0;
 922     const SSL_CIPHER *sslcipher;
 923
 924     if (ctx == NULL || !ossl_statem_export_early_allowed(s))
 925         goto err;
 926
 927     if (!s->server && s->max_early_data > 0
 928             && s->session->ext.max_early_data == 0)
 929         sslcipher = SSL_SESSION_get0_cipher(s->psksession);
 930     else
 931         sslcipher = SSL_SESSION_get0_cipher(s->session);
 932
 933     md = ssl_md(s->ctx, sslcipher->algorithm2);
 934
 935     /*
 936      * Calculate the hash value and store it in |data|. The reason why
 937      * the empty string is used is that the definition of TLS-Exporter
 938      * is like so:
 939      *
 940      * TLS-Exporter(label, context_value, key_length) =
 941      *     HKDF-Expand-Label(Derive-Secret(Secret, label, ""),
 942      *                       "exporter", Hash(context_value), key_length)
 943      *
 944      * Derive-Secret(Secret, Label, Messages) =
 945      *       HKDF-Expand-Label(Secret, Label,
 946      *                         Transcript-Hash(Messages), Hash.length)
 947      *
 948      * Here Transcript-Hash is the cipher suite hash algorithm.
 949      */
 950     if (EVP_DigestInit_ex(ctx, md, NULL) <= 0
 951             || EVP_DigestUpdate(ctx, context, contextlen) <= 0
 952             || EVP_DigestFinal_ex(ctx, hash, &hashsize) <= 0
 953             || EVP_DigestInit_ex(ctx, md, NULL) <= 0
 954             || EVP_DigestFinal_ex(ctx, data, &datalen) <= 0
 955             || !tls13_hkdf_expand(s, md, s->early_exporter_master_secret,
 956                                   (const unsigned char *)label, llen,
 957                                   data, datalen, exportsecret, hashsize, 0)
 958             || !tls13_hkdf_expand(s, md, exportsecret, exporterlabel,
 959                                   sizeof(exporterlabel) - 1, hash, hashsize,
 960                                   out, olen, 0))
 961         goto err;
 962
 963     ret = 1;
 964  err:
 965     EVP_MD_CTX_free(ctx);
 966     return ret;
 967 }