2 * Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
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
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>
19 #define TLS13_MAX_LABEL_LEN 249
21 /* Always filled with zeros */
22 static const unsigned char default_zeros
[EVP_MAX_MD_SIZE
];
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.
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
)
37 static const unsigned char label_prefix
[] = { 0x74, 0x6C, 0x73, 0x31, 0x33, 0x20, 0x00 };
39 static const unsigned char label_prefix
[] = "tls13 ";
41 EVP_KDF
*kdf
= EVP_KDF_fetch(s
->ctx
->libctx
, OSSL_KDF_NAME_HKDF
,
44 OSSL_PARAM params
[5], *p
= params
;
45 int mode
= EVP_PKEY_HKDEF_MODE_EXPAND_ONLY
;
46 const char *mdname
= EVP_MD_name(md
);
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
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
];
60 kctx
= EVP_KDF_CTX_new(kdf
);
65 if (labellen
> TLS13_MAX_LABEL_LEN
) {
67 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
70 * Probably we have been called from SSL_export_keying_material(),
71 * or SSL_export_keying_material_early().
73 ERR_raise(ERR_LIB_SSL
, SSL_R_TLS_ILLEGAL_EXPORTER_LABEL
);
75 EVP_KDF_CTX_free(kctx
);
79 hashlen
= EVP_MD_size(md
);
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
);
93 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
95 ERR_raise(ERR_LIB_SSL
, ERR_R_INTERNAL_ERROR
);
99 *p
++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_MODE
, &mode
);
100 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST
,
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();
108 ret
= EVP_KDF_CTX_set_params(kctx
, params
) <= 0
109 || EVP_KDF_derive(kctx
, out
, outlen
) <= 0;
111 EVP_KDF_CTX_free(kctx
);
115 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
117 ERR_raise(ERR_LIB_SSL
, ERR_R_INTERNAL_ERROR
);
124 * Given a |secret| generate a |key| of length |keylen| bytes. Returns 1 on
125 * success 0 on failure.
127 int tls13_derive_key(SSL
*s
, const EVP_MD
*md
, const unsigned char *secret
,
128 unsigned char *key
, size_t keylen
)
130 #ifdef CHARSET_EBCDIC
131 static const unsigned char keylabel
[] ={ 0x6B, 0x65, 0x79, 0x00 };
133 static const unsigned char keylabel
[] = "key";
136 return tls13_hkdf_expand(s
, md
, secret
, keylabel
, sizeof(keylabel
) - 1,
137 NULL
, 0, key
, keylen
, 1);
141 * Given a |secret| generate an |iv| of length |ivlen| bytes. Returns 1 on
142 * success 0 on failure.
144 int tls13_derive_iv(SSL
*s
, const EVP_MD
*md
, const unsigned char *secret
,
145 unsigned char *iv
, size_t ivlen
)
147 #ifdef CHARSET_EBCDIC
148 static const unsigned char ivlabel
[] = { 0x69, 0x76, 0x00 };
150 static const unsigned char ivlabel
[] = "iv";
153 return tls13_hkdf_expand(s
, md
, secret
, ivlabel
, sizeof(ivlabel
) - 1,
154 NULL
, 0, iv
, ivlen
, 1);
157 int tls13_derive_finishedkey(SSL
*s
, const EVP_MD
*md
,
158 const unsigned char *secret
,
159 unsigned char *fin
, size_t finlen
)
161 #ifdef CHARSET_EBCDIC
162 static const unsigned char finishedlabel
[] = { 0x66, 0x69, 0x6E, 0x69, 0x73, 0x68, 0x65, 0x64, 0x00 };
164 static const unsigned char finishedlabel
[] = "finished";
167 return tls13_hkdf_expand(s
, md
, secret
, finishedlabel
,
168 sizeof(finishedlabel
) - 1, NULL
, 0, fin
, finlen
, 1);
172 * Given the previous secret |prevsecret| and a new input secret |insecret| of
173 * length |insecretlen|, generate a new secret and store it in the location
174 * pointed to by |outsecret|. Returns 1 on success 0 on failure.
176 int tls13_generate_secret(SSL
*s
, const EVP_MD
*md
,
177 const unsigned char *prevsecret
,
178 const unsigned char *insecret
,
180 unsigned char *outsecret
)
182 size_t mdlen
, prevsecretlen
;
187 OSSL_PARAM params
[5], *p
= params
;
188 int mode
= EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY
;
189 const char *mdname
= EVP_MD_name(md
);
190 #ifdef CHARSET_EBCDIC
191 static const char derived_secret_label
[] = { 0x64, 0x65, 0x72, 0x69, 0x76, 0x65, 0x64, 0x00 };
193 static const char derived_secret_label
[] = "derived";
195 unsigned char preextractsec
[EVP_MAX_MD_SIZE
];
197 kdf
= EVP_KDF_fetch(s
->ctx
->libctx
, OSSL_KDF_NAME_HKDF
, s
->ctx
->propq
);
198 kctx
= EVP_KDF_CTX_new(kdf
);
201 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
205 mdleni
= EVP_MD_size(md
);
206 /* Ensure cast to size_t is safe */
207 if (!ossl_assert(mdleni
>= 0)) {
208 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
209 EVP_KDF_CTX_free(kctx
);
212 mdlen
= (size_t)mdleni
;
214 if (insecret
== NULL
) {
215 insecret
= default_zeros
;
218 if (prevsecret
== NULL
) {
219 prevsecret
= default_zeros
;
222 EVP_MD_CTX
*mctx
= EVP_MD_CTX_new();
223 unsigned char hash
[EVP_MAX_MD_SIZE
];
225 /* The pre-extract derive step uses a hash of no messages */
227 || EVP_DigestInit_ex(mctx
, md
, NULL
) <= 0
228 || EVP_DigestFinal_ex(mctx
, hash
, NULL
) <= 0) {
229 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
230 EVP_MD_CTX_free(mctx
);
231 EVP_KDF_CTX_free(kctx
);
234 EVP_MD_CTX_free(mctx
);
236 /* Generate the pre-extract secret */
237 if (!tls13_hkdf_expand(s
, md
, prevsecret
,
238 (unsigned char *)derived_secret_label
,
239 sizeof(derived_secret_label
) - 1, hash
, mdlen
,
240 preextractsec
, mdlen
, 1)) {
241 /* SSLfatal() already called */
242 EVP_KDF_CTX_free(kctx
);
246 prevsecret
= preextractsec
;
247 prevsecretlen
= mdlen
;
250 *p
++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_MODE
, &mode
);
251 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST
,
253 *p
++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_KEY
,
254 (unsigned char *)insecret
,
256 *p
++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SALT
,
257 (unsigned char *)prevsecret
,
259 *p
++ = OSSL_PARAM_construct_end();
261 ret
= EVP_KDF_CTX_set_params(kctx
, params
) <= 0
262 || EVP_KDF_derive(kctx
, outsecret
, mdlen
) <= 0;
265 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
267 EVP_KDF_CTX_free(kctx
);
268 if (prevsecret
== preextractsec
)
269 OPENSSL_cleanse(preextractsec
, mdlen
);
274 * Given an input secret |insecret| of length |insecretlen| generate the
275 * handshake secret. This requires the early secret to already have been
276 * generated. Returns 1 on success 0 on failure.
278 int tls13_generate_handshake_secret(SSL
*s
, const unsigned char *insecret
,
281 /* Calls SSLfatal() if required */
282 return tls13_generate_secret(s
, ssl_handshake_md(s
), s
->early_secret
,
283 insecret
, insecretlen
,
284 (unsigned char *)&s
->handshake_secret
);
288 * Given the handshake secret |prev| of length |prevlen| generate the master
289 * secret and store its length in |*secret_size|. Returns 1 on success 0 on
292 int tls13_generate_master_secret(SSL
*s
, unsigned char *out
,
293 unsigned char *prev
, size_t prevlen
,
296 const EVP_MD
*md
= ssl_handshake_md(s
);
298 *secret_size
= EVP_MD_size(md
);
299 /* Calls SSLfatal() if required */
300 return tls13_generate_secret(s
, md
, prev
, NULL
, 0, out
);
304 * Generates the mac for the Finished message. Returns the length of the MAC or
307 size_t tls13_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
310 const char *mdname
= EVP_MD_name(ssl_handshake_md(s
));
311 EVP_MAC
*hmac
= EVP_MAC_fetch(s
->ctx
->libctx
, "HMAC", s
->ctx
->propq
);
312 unsigned char hash
[EVP_MAX_MD_SIZE
];
313 unsigned char finsecret
[EVP_MAX_MD_SIZE
];
314 unsigned char *key
= NULL
;
315 size_t hashlen
, ret
= 0;
316 EVP_MAC_CTX
*ctx
= NULL
;
317 OSSL_PARAM params
[3], *p
= params
;
320 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
324 /* Safe to cast away const here since we're not "getting" any data */
325 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_ALG_PARAM_DIGEST
,
327 if (s
->ctx
->propq
!= NULL
)
328 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_ALG_PARAM_PROPERTIES
,
329 (char *)s
->ctx
->propq
,
331 *p
= OSSL_PARAM_construct_end();
333 if (!ssl_handshake_hash(s
, hash
, sizeof(hash
), &hashlen
)) {
334 /* SSLfatal() already called */
338 if (str
== s
->method
->ssl3_enc
->server_finished_label
) {
339 key
= s
->server_finished_secret
;
340 } else if (SSL_IS_FIRST_HANDSHAKE(s
)) {
341 key
= s
->client_finished_secret
;
343 if (!tls13_derive_finishedkey(s
, ssl_handshake_md(s
),
344 s
->client_app_traffic_secret
,
350 ctx
= EVP_MAC_CTX_new(hmac
);
352 || !EVP_MAC_init(ctx
, key
, hashlen
, params
)
353 || !EVP_MAC_update(ctx
, hash
, hashlen
)
354 /* outsize as per sizeof(peer_finish_md) */
355 || !EVP_MAC_final(ctx
, out
, &hashlen
, EVP_MAX_MD_SIZE
* 2)) {
356 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
362 OPENSSL_cleanse(finsecret
, sizeof(finsecret
));
363 EVP_MAC_CTX_free(ctx
);
369 * There isn't really a key block in TLSv1.3, but we still need this function
370 * for initialising the cipher and hash. Returns 1 on success or 0 on failure.
372 int tls13_setup_key_block(SSL
*s
)
377 s
->session
->cipher
= s
->s3
.tmp
.new_cipher
;
378 if (!ssl_cipher_get_evp(s
->ctx
, s
->session
, &c
, &hash
, NULL
, NULL
, NULL
,
380 /* Error is already recorded */
381 SSLfatal_alert(s
, SSL_AD_INTERNAL_ERROR
);
385 ssl_evp_cipher_free(s
->s3
.tmp
.new_sym_enc
);
386 s
->s3
.tmp
.new_sym_enc
= c
;
387 ssl_evp_md_free(s
->s3
.tmp
.new_hash
);
388 s
->s3
.tmp
.new_hash
= hash
;
393 static int derive_secret_key_and_iv(SSL
*s
, int sending
, const EVP_MD
*md
,
394 const EVP_CIPHER
*ciph
,
395 const unsigned char *insecret
,
396 const unsigned char *hash
,
397 const unsigned char *label
,
398 size_t labellen
, unsigned char *secret
,
399 unsigned char *key
, unsigned char *iv
,
400 EVP_CIPHER_CTX
*ciph_ctx
)
402 size_t ivlen
, keylen
, taglen
;
403 int hashleni
= EVP_MD_size(md
);
406 /* Ensure cast to size_t is safe */
407 if (!ossl_assert(hashleni
>= 0)) {
408 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_EVP_LIB
);
411 hashlen
= (size_t)hashleni
;
413 if (!tls13_hkdf_expand(s
, md
, insecret
, label
, labellen
, hash
, hashlen
,
414 secret
, hashlen
, 1)) {
415 /* SSLfatal() already called */
419 /* TODO(size_t): convert me */
420 keylen
= EVP_CIPHER_key_length(ciph
);
421 if (EVP_CIPHER_mode(ciph
) == EVP_CIPH_CCM_MODE
) {
424 ivlen
= EVP_CCM_TLS_IV_LEN
;
425 if (s
->s3
.tmp
.new_cipher
!= NULL
) {
426 algenc
= s
->s3
.tmp
.new_cipher
->algorithm_enc
;
427 } else if (s
->session
->cipher
!= NULL
) {
428 /* We've not selected a cipher yet - we must be doing early data */
429 algenc
= s
->session
->cipher
->algorithm_enc
;
430 } else if (s
->psksession
!= NULL
&& s
->psksession
->cipher
!= NULL
) {
431 /* We must be doing early data with out-of-band PSK */
432 algenc
= s
->psksession
->cipher
->algorithm_enc
;
434 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_EVP_LIB
);
437 if (algenc
& (SSL_AES128CCM8
| SSL_AES256CCM8
))
438 taglen
= EVP_CCM8_TLS_TAG_LEN
;
440 taglen
= EVP_CCM_TLS_TAG_LEN
;
442 ivlen
= EVP_CIPHER_iv_length(ciph
);
446 if (!tls13_derive_key(s
, md
, secret
, key
, keylen
)
447 || !tls13_derive_iv(s
, md
, secret
, iv
, ivlen
)) {
448 /* SSLfatal() already called */
452 if (EVP_CipherInit_ex(ciph_ctx
, ciph
, NULL
, NULL
, NULL
, sending
) <= 0
453 || !EVP_CIPHER_CTX_ctrl(ciph_ctx
, EVP_CTRL_AEAD_SET_IVLEN
, ivlen
, NULL
)
454 || (taglen
!= 0 && !EVP_CIPHER_CTX_ctrl(ciph_ctx
, EVP_CTRL_AEAD_SET_TAG
,
456 || EVP_CipherInit_ex(ciph_ctx
, NULL
, NULL
, key
, NULL
, -1) <= 0) {
457 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_EVP_LIB
);
464 int tls13_change_cipher_state(SSL
*s
, int which
)
466 #ifdef CHARSET_EBCDIC
467 static const unsigned char client_early_traffic
[] = {0x63, 0x20, 0x65, 0x20, /*traffic*/0x74, 0x72, 0x61, 0x66, 0x66, 0x69, 0x63, 0x00};
468 static const unsigned char client_handshake_traffic
[] = {0x63, 0x20, 0x68, 0x73, 0x20, /*traffic*/0x74, 0x72, 0x61, 0x66, 0x66, 0x69, 0x63, 0x00};
469 static const unsigned char client_application_traffic
[] = {0x63, 0x20, 0x61, 0x70, 0x20, /*traffic*/0x74, 0x72, 0x61, 0x66, 0x66, 0x69, 0x63, 0x00};
470 static const unsigned char server_handshake_traffic
[] = {0x73, 0x20, 0x68, 0x73, 0x20, /*traffic*/0x74, 0x72, 0x61, 0x66, 0x66, 0x69, 0x63, 0x00};
471 static const unsigned char server_application_traffic
[] = {0x73, 0x20, 0x61, 0x70, 0x20, /*traffic*/0x74, 0x72, 0x61, 0x66, 0x66, 0x69, 0x63, 0x00};
472 static const unsigned char exporter_master_secret
[] = {0x65, 0x78, 0x70, 0x20, /* master*/ 0x6D, 0x61, 0x73, 0x74, 0x65, 0x72, 0x00};
473 static const unsigned char resumption_master_secret
[] = {0x72, 0x65, 0x73, 0x20, /* master*/ 0x6D, 0x61, 0x73, 0x74, 0x65, 0x72, 0x00};
474 static const unsigned char early_exporter_master_secret
[] = {0x65, 0x20, 0x65, 0x78, 0x70, 0x20, /* master*/ 0x6D, 0x61, 0x73, 0x74, 0x65, 0x72, 0x00};
476 static const unsigned char client_early_traffic
[] = "c e traffic";
477 static const unsigned char client_handshake_traffic
[] = "c hs traffic";
478 static const unsigned char client_application_traffic
[] = "c ap traffic";
479 static const unsigned char server_handshake_traffic
[] = "s hs traffic";
480 static const unsigned char server_application_traffic
[] = "s ap traffic";
481 static const unsigned char exporter_master_secret
[] = "exp master";
482 static const unsigned char resumption_master_secret
[] = "res master";
483 static const unsigned char early_exporter_master_secret
[] = "e exp master";
486 unsigned char key
[EVP_MAX_KEY_LENGTH
];
487 unsigned char secret
[EVP_MAX_MD_SIZE
];
488 unsigned char hashval
[EVP_MAX_MD_SIZE
];
489 unsigned char *hash
= hashval
;
490 unsigned char *insecret
;
491 unsigned char *finsecret
= NULL
;
492 const char *log_label
= NULL
;
493 EVP_CIPHER_CTX
*ciph_ctx
;
494 size_t finsecretlen
= 0;
495 const unsigned char *label
;
496 size_t labellen
, hashlen
= 0;
498 const EVP_MD
*md
= NULL
;
499 const EVP_CIPHER
*cipher
= NULL
;
500 #if !defined(OPENSSL_NO_KTLS) && defined(OPENSSL_KTLS_TLS13)
501 ktls_crypto_info_t crypto_info
;
505 if (which
& SSL3_CC_READ
) {
506 if (s
->enc_read_ctx
!= NULL
) {
507 EVP_CIPHER_CTX_reset(s
->enc_read_ctx
);
509 s
->enc_read_ctx
= EVP_CIPHER_CTX_new();
510 if (s
->enc_read_ctx
== NULL
) {
511 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
515 ciph_ctx
= s
->enc_read_ctx
;
518 RECORD_LAYER_reset_read_sequence(&s
->rlayer
);
520 s
->statem
.enc_write_state
= ENC_WRITE_STATE_INVALID
;
521 if (s
->enc_write_ctx
!= NULL
) {
522 EVP_CIPHER_CTX_reset(s
->enc_write_ctx
);
524 s
->enc_write_ctx
= EVP_CIPHER_CTX_new();
525 if (s
->enc_write_ctx
== NULL
) {
526 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
530 ciph_ctx
= s
->enc_write_ctx
;
533 RECORD_LAYER_reset_write_sequence(&s
->rlayer
);
536 if (((which
& SSL3_CC_CLIENT
) && (which
& SSL3_CC_WRITE
))
537 || ((which
& SSL3_CC_SERVER
) && (which
& SSL3_CC_READ
))) {
538 if (which
& SSL3_CC_EARLY
) {
539 EVP_MD_CTX
*mdctx
= NULL
;
542 unsigned int hashlenui
;
543 const SSL_CIPHER
*sslcipher
= SSL_SESSION_get0_cipher(s
->session
);
545 insecret
= s
->early_secret
;
546 label
= client_early_traffic
;
547 labellen
= sizeof(client_early_traffic
) - 1;
548 log_label
= CLIENT_EARLY_LABEL
;
550 handlen
= BIO_get_mem_data(s
->s3
.handshake_buffer
, &hdata
);
552 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_R_BAD_HANDSHAKE_LENGTH
);
556 if (s
->early_data_state
== SSL_EARLY_DATA_CONNECTING
557 && s
->max_early_data
> 0
558 && s
->session
->ext
.max_early_data
== 0) {
560 * If we are attempting to send early data, and we've decided to
561 * actually do it but max_early_data in s->session is 0 then we
562 * must be using an external PSK.
564 if (!ossl_assert(s
->psksession
!= NULL
565 && s
->max_early_data
==
566 s
->psksession
->ext
.max_early_data
)) {
567 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
570 sslcipher
= SSL_SESSION_get0_cipher(s
->psksession
);
572 if (sslcipher
== NULL
) {
573 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_R_BAD_PSK
);
578 * We need to calculate the handshake digest using the digest from
579 * the session. We haven't yet selected our ciphersuite so we can't
580 * use ssl_handshake_md().
582 mdctx
= EVP_MD_CTX_new();
584 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_MALLOC_FAILURE
);
589 * This ups the ref count on cipher so we better make sure we free
592 if (!ssl_cipher_get_evp_cipher(s
->ctx
, sslcipher
, &cipher
)) {
593 /* Error is already recorded */
594 SSLfatal_alert(s
, SSL_AD_INTERNAL_ERROR
);
595 EVP_MD_CTX_free(mdctx
);
599 md
= ssl_md(s
->ctx
, sslcipher
->algorithm2
);
600 if (md
== NULL
|| !EVP_DigestInit_ex(mdctx
, md
, NULL
)
601 || !EVP_DigestUpdate(mdctx
, hdata
, handlen
)
602 || !EVP_DigestFinal_ex(mdctx
, hashval
, &hashlenui
)) {
603 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
604 EVP_MD_CTX_free(mdctx
);
608 EVP_MD_CTX_free(mdctx
);
610 if (!tls13_hkdf_expand(s
, md
, insecret
,
611 early_exporter_master_secret
,
612 sizeof(early_exporter_master_secret
) - 1,
614 s
->early_exporter_master_secret
, hashlen
,
616 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
620 if (!ssl_log_secret(s
, EARLY_EXPORTER_SECRET_LABEL
,
621 s
->early_exporter_master_secret
, hashlen
)) {
622 /* SSLfatal() already called */
625 } else if (which
& SSL3_CC_HANDSHAKE
) {
626 insecret
= s
->handshake_secret
;
627 finsecret
= s
->client_finished_secret
;
628 finsecretlen
= EVP_MD_size(ssl_handshake_md(s
));
629 label
= client_handshake_traffic
;
630 labellen
= sizeof(client_handshake_traffic
) - 1;
631 log_label
= CLIENT_HANDSHAKE_LABEL
;
633 * The handshake hash used for the server read/client write handshake
634 * traffic secret is the same as the hash for the server
635 * write/client read handshake traffic secret. However, if we
636 * processed early data then we delay changing the server
637 * read/client write cipher state until later, and the handshake
638 * hashes have moved on. Therefore we use the value saved earlier
639 * when we did the server write/client read change cipher state.
641 hash
= s
->handshake_traffic_hash
;
643 insecret
= s
->master_secret
;
644 label
= client_application_traffic
;
645 labellen
= sizeof(client_application_traffic
) - 1;
646 log_label
= CLIENT_APPLICATION_LABEL
;
648 * For this we only use the handshake hashes up until the server
649 * Finished hash. We do not include the client's Finished, which is
650 * what ssl_handshake_hash() would give us. Instead we use the
651 * previously saved value.
653 hash
= s
->server_finished_hash
;
656 /* Early data never applies to client-read/server-write */
657 if (which
& SSL3_CC_HANDSHAKE
) {
658 insecret
= s
->handshake_secret
;
659 finsecret
= s
->server_finished_secret
;
660 finsecretlen
= EVP_MD_size(ssl_handshake_md(s
));
661 label
= server_handshake_traffic
;
662 labellen
= sizeof(server_handshake_traffic
) - 1;
663 log_label
= SERVER_HANDSHAKE_LABEL
;
665 insecret
= s
->master_secret
;
666 label
= server_application_traffic
;
667 labellen
= sizeof(server_application_traffic
) - 1;
668 log_label
= SERVER_APPLICATION_LABEL
;
672 if (!(which
& SSL3_CC_EARLY
)) {
673 md
= ssl_handshake_md(s
);
674 cipher
= s
->s3
.tmp
.new_sym_enc
;
675 if (!ssl3_digest_cached_records(s
, 1)
676 || !ssl_handshake_hash(s
, hashval
, sizeof(hashval
), &hashlen
)) {
677 /* SSLfatal() already called */;
683 * Save the hash of handshakes up to now for use when we calculate the
684 * client application traffic secret
686 if (label
== server_application_traffic
)
687 memcpy(s
->server_finished_hash
, hashval
, hashlen
);
689 if (label
== server_handshake_traffic
)
690 memcpy(s
->handshake_traffic_hash
, hashval
, hashlen
);
692 if (label
== client_application_traffic
) {
694 * We also create the resumption master secret, but this time use the
695 * hash for the whole handshake including the Client Finished
697 if (!tls13_hkdf_expand(s
, ssl_handshake_md(s
), insecret
,
698 resumption_master_secret
,
699 sizeof(resumption_master_secret
) - 1,
700 hashval
, hashlen
, s
->resumption_master_secret
,
702 /* SSLfatal() already called */
707 /* check whether cipher is known */
708 if(!ossl_assert(cipher
!= NULL
))
711 if (!derive_secret_key_and_iv(s
, which
& SSL3_CC_WRITE
, md
, cipher
,
712 insecret
, hash
, label
, labellen
, secret
, key
,
714 /* SSLfatal() already called */
718 if (label
== server_application_traffic
) {
719 memcpy(s
->server_app_traffic_secret
, secret
, hashlen
);
720 /* Now we create the exporter master secret */
721 if (!tls13_hkdf_expand(s
, ssl_handshake_md(s
), insecret
,
722 exporter_master_secret
,
723 sizeof(exporter_master_secret
) - 1,
724 hash
, hashlen
, s
->exporter_master_secret
,
726 /* SSLfatal() already called */
730 if (!ssl_log_secret(s
, EXPORTER_SECRET_LABEL
, s
->exporter_master_secret
,
732 /* SSLfatal() already called */
735 } else if (label
== client_application_traffic
)
736 memcpy(s
->client_app_traffic_secret
, secret
, hashlen
);
738 if (!ssl_log_secret(s
, log_label
, secret
, hashlen
)) {
739 /* SSLfatal() already called */
743 if (finsecret
!= NULL
744 && !tls13_derive_finishedkey(s
, ssl_handshake_md(s
), secret
,
745 finsecret
, finsecretlen
)) {
746 /* SSLfatal() already called */
750 if (!s
->server
&& label
== client_early_traffic
)
751 s
->statem
.enc_write_state
= ENC_WRITE_STATE_WRITE_PLAIN_ALERTS
;
753 s
->statem
.enc_write_state
= ENC_WRITE_STATE_VALID
;
754 #ifndef OPENSSL_NO_KTLS
755 # if defined(OPENSSL_KTLS_TLS13)
756 if (!(which
& SSL3_CC_WRITE
) || !(which
& SSL3_CC_APPLICATION
)
757 || ((which
& SSL3_CC_WRITE
) && (s
->mode
& SSL_MODE_NO_KTLS_TX
)))
760 /* ktls supports only the maximum fragment size */
761 if (ssl_get_max_send_fragment(s
) != SSL3_RT_MAX_PLAIN_LENGTH
)
764 /* ktls does not support record padding */
765 if (s
->record_padding_cb
!= NULL
)
768 /* check that cipher is supported */
769 if (!ktls_check_supported_cipher(s
, cipher
, ciph_ctx
))
774 if (!ossl_assert(bio
!= NULL
)) {
775 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, ERR_R_INTERNAL_ERROR
);
779 /* All future data will get encrypted by ktls. Flush the BIO or skip ktls */
780 if (BIO_flush(bio
) <= 0)
783 /* configure kernel crypto structure */
784 if (!ktls_configure_crypto(s
, cipher
, ciph_ctx
,
785 RECORD_LAYER_get_write_sequence(&s
->rlayer
),
786 &crypto_info
, NULL
, iv
, key
, NULL
, 0))
789 /* ktls works with user provided buffers directly */
790 if (BIO_set_ktls(bio
, &crypto_info
, which
& SSL3_CC_WRITE
))
791 ssl3_release_write_buffer(s
);
797 if ((which
& SSL3_CC_EARLY
) != 0) {
798 /* We up-refed this so now we need to down ref */
799 ssl_evp_cipher_free(cipher
);
801 OPENSSL_cleanse(key
, sizeof(key
));
802 OPENSSL_cleanse(secret
, sizeof(secret
));
806 int tls13_update_key(SSL
*s
, int sending
)
808 #ifdef CHARSET_EBCDIC
809 static const unsigned char application_traffic
[] = { 0x74, 0x72 ,0x61 ,0x66 ,0x66 ,0x69 ,0x63 ,0x20 ,0x75 ,0x70 ,0x64, 0x00};
811 static const unsigned char application_traffic
[] = "traffic upd";
813 const EVP_MD
*md
= ssl_handshake_md(s
);
814 size_t hashlen
= EVP_MD_size(md
);
815 unsigned char key
[EVP_MAX_KEY_LENGTH
];
816 unsigned char *insecret
, *iv
;
817 unsigned char secret
[EVP_MAX_MD_SIZE
];
818 EVP_CIPHER_CTX
*ciph_ctx
;
821 if (s
->server
== sending
)
822 insecret
= s
->server_app_traffic_secret
;
824 insecret
= s
->client_app_traffic_secret
;
827 s
->statem
.enc_write_state
= ENC_WRITE_STATE_INVALID
;
829 ciph_ctx
= s
->enc_write_ctx
;
830 RECORD_LAYER_reset_write_sequence(&s
->rlayer
);
833 ciph_ctx
= s
->enc_read_ctx
;
834 RECORD_LAYER_reset_read_sequence(&s
->rlayer
);
837 if (!derive_secret_key_and_iv(s
, sending
, ssl_handshake_md(s
),
838 s
->s3
.tmp
.new_sym_enc
, insecret
, NULL
,
840 sizeof(application_traffic
) - 1, secret
, key
,
842 /* SSLfatal() already called */
846 memcpy(insecret
, secret
, hashlen
);
848 s
->statem
.enc_write_state
= ENC_WRITE_STATE_VALID
;
851 OPENSSL_cleanse(key
, sizeof(key
));
852 OPENSSL_cleanse(secret
, sizeof(secret
));
856 int tls13_alert_code(int code
)
858 /* There are 2 additional alerts in TLSv1.3 compared to TLSv1.2 */
859 if (code
== SSL_AD_MISSING_EXTENSION
|| code
== SSL_AD_CERTIFICATE_REQUIRED
)
862 return tls1_alert_code(code
);
865 int tls13_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
866 const char *label
, size_t llen
,
867 const unsigned char *context
,
868 size_t contextlen
, int use_context
)
870 unsigned char exportsecret
[EVP_MAX_MD_SIZE
];
871 #ifdef CHARSET_EBCDIC
872 static const unsigned char exporterlabel
[] = {0x65, 0x78, 0x70, 0x6F, 0x72, 0x74, 0x65, 0x72, 0x00};
874 static const unsigned char exporterlabel
[] = "exporter";
876 unsigned char hash
[EVP_MAX_MD_SIZE
], data
[EVP_MAX_MD_SIZE
];
877 const EVP_MD
*md
= ssl_handshake_md(s
);
878 EVP_MD_CTX
*ctx
= EVP_MD_CTX_new();
879 unsigned int hashsize
, datalen
;
882 if (ctx
== NULL
|| !ossl_statem_export_allowed(s
))
888 if (EVP_DigestInit_ex(ctx
, md
, NULL
) <= 0
889 || EVP_DigestUpdate(ctx
, context
, contextlen
) <= 0
890 || EVP_DigestFinal_ex(ctx
, hash
, &hashsize
) <= 0
891 || EVP_DigestInit_ex(ctx
, md
, NULL
) <= 0
892 || EVP_DigestFinal_ex(ctx
, data
, &datalen
) <= 0
893 || !tls13_hkdf_expand(s
, md
, s
->exporter_master_secret
,
894 (const unsigned char *)label
, llen
,
895 data
, datalen
, exportsecret
, hashsize
, 0)
896 || !tls13_hkdf_expand(s
, md
, exportsecret
, exporterlabel
,
897 sizeof(exporterlabel
) - 1, hash
, hashsize
,
903 EVP_MD_CTX_free(ctx
);
907 int tls13_export_keying_material_early(SSL
*s
, unsigned char *out
, size_t olen
,
908 const char *label
, size_t llen
,
909 const unsigned char *context
,
912 #ifdef CHARSET_EBCDIC
913 static const unsigned char exporterlabel
[] = {0x65, 0x78, 0x70, 0x6F, 0x72, 0x74, 0x65, 0x72, 0x00};
915 static const unsigned char exporterlabel
[] = "exporter";
917 unsigned char exportsecret
[EVP_MAX_MD_SIZE
];
918 unsigned char hash
[EVP_MAX_MD_SIZE
], data
[EVP_MAX_MD_SIZE
];
920 EVP_MD_CTX
*ctx
= EVP_MD_CTX_new();
921 unsigned int hashsize
, datalen
;
923 const SSL_CIPHER
*sslcipher
;
925 if (ctx
== NULL
|| !ossl_statem_export_early_allowed(s
))
928 if (!s
->server
&& s
->max_early_data
> 0
929 && s
->session
->ext
.max_early_data
== 0)
930 sslcipher
= SSL_SESSION_get0_cipher(s
->psksession
);
932 sslcipher
= SSL_SESSION_get0_cipher(s
->session
);
934 md
= ssl_md(s
->ctx
, sslcipher
->algorithm2
);
937 * Calculate the hash value and store it in |data|. The reason why
938 * the empty string is used is that the definition of TLS-Exporter
941 * TLS-Exporter(label, context_value, key_length) =
942 * HKDF-Expand-Label(Derive-Secret(Secret, label, ""),
943 * "exporter", Hash(context_value), key_length)
945 * Derive-Secret(Secret, Label, Messages) =
946 * HKDF-Expand-Label(Secret, Label,
947 * Transcript-Hash(Messages), Hash.length)
949 * Here Transcript-Hash is the cipher suite hash algorithm.
951 if (EVP_DigestInit_ex(ctx
, md
, NULL
) <= 0
952 || EVP_DigestUpdate(ctx
, context
, contextlen
) <= 0
953 || EVP_DigestFinal_ex(ctx
, hash
, &hashsize
) <= 0
954 || EVP_DigestInit_ex(ctx
, md
, NULL
) <= 0
955 || EVP_DigestFinal_ex(ctx
, data
, &datalen
) <= 0
956 || !tls13_hkdf_expand(s
, md
, s
->early_exporter_master_secret
,
957 (const unsigned char *)label
, llen
,
958 data
, datalen
, exportsecret
, hashsize
, 0)
959 || !tls13_hkdf_expand(s
, md
, exportsecret
, exporterlabel
,
960 sizeof(exporterlabel
) - 1, hash
, hashsize
,
966 EVP_MD_CTX_free(ctx
);