]> git.ipfire.org Git - thirdparty/openssl.git/blame - ssl/tls13_enc.c
Raise an error on syscall failure in tls_retry_write_records
[thirdparty/openssl.git] / ssl / tls13_enc.c
CommitLineData
34574f19 1/*
da1c088f 2 * Copyright 2016-2023 The OpenSSL Project Authors. All Rights Reserved.
34574f19 3 *
2c18d164 4 * Licensed under the Apache License 2.0 (the "License"). You may not use
34574f19
MC
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>
706457b7 11#include "ssl_local.h"
cc10b56d
VF
12#include "internal/ktls.h"
13#include "record/record_local.h"
08717544 14#include "internal/cryptlib.h"
34574f19
MC
15#include <openssl/evp.h>
16#include <openssl/kdf.h>
ce3b1bb4 17#include <openssl/core_names.h>
34574f19 18
0fb2815b 19#define TLS13_MAX_LABEL_LEN 249
34574f19 20
44e47328
TS
21/* ASCII: "tls13 ", in hex for EBCDIC compatibility */
22static const unsigned char label_prefix[] = "\x74\x6C\x73\x31\x33\x20";
34574f19 23
34574f19 24/*
a19ae67d
MC
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|.
0fb2815b
MC
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.
ec279ac2 30 * If |raise_error| is set, ERR_raise is called on failure.
34574f19 31 */
ec279ac2
HL
32int tls13_hkdf_expand_ex(OSSL_LIB_CTX *libctx, const char *propq,
33 const EVP_MD *md,
34 const unsigned char *secret,
35 const unsigned char *label, size_t labellen,
36 const unsigned char *data, size_t datalen,
37 unsigned char *out, size_t outlen, int raise_error)
34574f19 38{
ec279ac2 39 EVP_KDF *kdf = EVP_KDF_fetch(libctx, OSSL_KDF_NAME_TLS1_3_KDF, propq);
ce3b1bb4 40 EVP_KDF_CTX *kctx;
f7d998a2 41 OSSL_PARAM params[7], *p = params;
ce3b1bb4 42 int mode = EVP_PKEY_HKDEF_MODE_EXPAND_ONLY;
ed576acd 43 const char *mdname = EVP_MD_get0_name(md);
34574f19 44 int ret;
34574f19 45 size_t hashlen;
34574f19 46
660c5344 47 kctx = EVP_KDF_CTX_new(kdf);
ce3b1bb4 48 EVP_KDF_free(kdf);
32495464 49 if (kctx == NULL)
34574f19
MC
50 return 0;
51
0fb2815b 52 if (labellen > TLS13_MAX_LABEL_LEN) {
ec279ac2 53 if (raise_error)
0fb2815b
MC
54 /*
55 * Probably we have been called from SSL_export_keying_material(),
56 * or SSL_export_keying_material_early().
57 */
6849b73c 58 ERR_raise(ERR_LIB_SSL, SSL_R_TLS_ILLEGAL_EXPORTER_LABEL);
ec279ac2 59
660c5344 60 EVP_KDF_CTX_free(kctx);
0fb2815b
MC
61 return 0;
62 }
63
f7d998a2 64 if ((ret = EVP_MD_get_size(md)) <= 0) {
660c5344 65 EVP_KDF_CTX_free(kctx);
ec279ac2 66 if (raise_error)
6849b73c 67 ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
34574f19
MC
68 return 0;
69 }
f7d998a2 70 hashlen = (size_t)ret;
34574f19 71
ce3b1bb4
P
72 *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_MODE, &mode);
73 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
8b6ffd40 74 (char *)mdname, 0);
ce3b1bb4
P
75 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_KEY,
76 (unsigned char *)secret, hashlen);
f7d998a2
P
77 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_PREFIX,
78 (unsigned char *)label_prefix,
79 sizeof(label_prefix) - 1);
80 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_LABEL,
81 (unsigned char *)label, labellen);
82 if (data != NULL)
83 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_DATA,
84 (unsigned char *)data,
85 datalen);
ce3b1bb4
P
86 *p++ = OSSL_PARAM_construct_end();
87
5cceedb5 88 ret = EVP_KDF_derive(kctx, out, outlen, params) <= 0;
660c5344 89 EVP_KDF_CTX_free(kctx);
34574f19 90
0fb2815b 91 if (ret != 0) {
ec279ac2 92 if (raise_error)
6849b73c 93 ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
0fb2815b 94 }
f63a17d6 95
34574f19
MC
96 return ret == 0;
97}
98
ec279ac2
HL
99int tls13_hkdf_expand(SSL_CONNECTION *s, const EVP_MD *md,
100 const unsigned char *secret,
101 const unsigned char *label, size_t labellen,
102 const unsigned char *data, size_t datalen,
103 unsigned char *out, size_t outlen, int fatal)
104{
105 int ret;
106 SSL_CTX *sctx = SSL_CONNECTION_GET_CTX(s);
107
108 ret = tls13_hkdf_expand_ex(sctx->libctx, sctx->propq, md,
109 secret, label, labellen, data, datalen,
110 out, outlen, !fatal);
111 if (ret == 0 && fatal)
112 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
113
114 return ret;
115}
116
34574f19 117/*
f5ca0b04
MC
118 * Given a |secret| generate a |key| of length |keylen| bytes. Returns 1 on
119 * success 0 on failure.
34574f19 120 */
38b051a1
TM
121int tls13_derive_key(SSL_CONNECTION *s, const EVP_MD *md,
122 const unsigned char *secret,
d49e23ec 123 unsigned char *key, size_t keylen)
34574f19 124{
44e47328
TS
125 /* ASCII: "key", in hex for EBCDIC compatibility */
126 static const unsigned char keylabel[] = "\x6B\x65\x79";
f5ca0b04 127
d49e23ec 128 return tls13_hkdf_expand(s, md, secret, keylabel, sizeof(keylabel) - 1,
0fb2815b 129 NULL, 0, key, keylen, 1);
34574f19
MC
130}
131
132/*
f5ca0b04
MC
133 * Given a |secret| generate an |iv| of length |ivlen| bytes. Returns 1 on
134 * success 0 on failure.
34574f19 135 */
38b051a1
TM
136int tls13_derive_iv(SSL_CONNECTION *s, const EVP_MD *md,
137 const unsigned char *secret,
d49e23ec 138 unsigned char *iv, size_t ivlen)
34574f19 139{
44e47328
TS
140 /* ASCII: "iv", in hex for EBCDIC compatibility */
141 static const unsigned char ivlabel[] = "\x69\x76";
f5ca0b04 142
d49e23ec 143 return tls13_hkdf_expand(s, md, secret, ivlabel, sizeof(ivlabel) - 1,
0fb2815b 144 NULL, 0, iv, ivlen, 1);
34574f19
MC
145}
146
38b051a1 147int tls13_derive_finishedkey(SSL_CONNECTION *s, const EVP_MD *md,
ec15acb6
MC
148 const unsigned char *secret,
149 unsigned char *fin, size_t finlen)
6484776f 150{
44e47328
TS
151 /* ASCII: "finished", in hex for EBCDIC compatibility */
152 static const unsigned char finishedlabel[] = "\x66\x69\x6E\x69\x73\x68\x65\x64";
f5ca0b04 153
ec15acb6 154 return tls13_hkdf_expand(s, md, secret, finishedlabel,
0fb2815b 155 sizeof(finishedlabel) - 1, NULL, 0, fin, finlen, 1);
6484776f
MC
156}
157
34574f19
MC
158/*
159 * Given the previous secret |prevsecret| and a new input secret |insecret| of
160 * length |insecretlen|, generate a new secret and store it in the location
f5ca0b04 161 * pointed to by |outsecret|. Returns 1 on success 0 on failure.
34574f19 162 */
38b051a1 163int tls13_generate_secret(SSL_CONNECTION *s, const EVP_MD *md,
ec15acb6
MC
164 const unsigned char *prevsecret,
165 const unsigned char *insecret,
166 size_t insecretlen,
167 unsigned char *outsecret)
34574f19 168{
f7d998a2 169 size_t mdlen;
bceae201 170 int mdleni;
34574f19 171 int ret;
ce3b1bb4
P
172 EVP_KDF *kdf;
173 EVP_KDF_CTX *kctx;
f7d998a2 174 OSSL_PARAM params[7], *p = params;
ce3b1bb4 175 int mode = EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY;
ed576acd 176 const char *mdname = EVP_MD_get0_name(md);
44e47328
TS
177 /* ASCII: "derived", in hex for EBCDIC compatibility */
178 static const char derived_secret_label[] = "\x64\x65\x72\x69\x76\x65\x64";
38b051a1 179 SSL_CTX *sctx = SSL_CONNECTION_GET_CTX(s);
34574f19 180
38b051a1 181 kdf = EVP_KDF_fetch(sctx->libctx, OSSL_KDF_NAME_TLS1_3_KDF, sctx->propq);
660c5344 182 kctx = EVP_KDF_CTX_new(kdf);
ce3b1bb4 183 EVP_KDF_free(kdf);
32495464 184 if (kctx == NULL) {
c48ffbcc 185 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
34574f19 186 return 0;
f63a17d6 187 }
34574f19 188
ed576acd 189 mdleni = EVP_MD_get_size(md);
bceae201
MC
190 /* Ensure cast to size_t is safe */
191 if (!ossl_assert(mdleni >= 0)) {
c48ffbcc 192 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
660c5344 193 EVP_KDF_CTX_free(kctx);
bceae201
MC
194 return 0;
195 }
196 mdlen = (size_t)mdleni;
34574f19 197
ce3b1bb4
P
198 *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_MODE, &mode);
199 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
8b6ffd40 200 (char *)mdname, 0);
f7d998a2
P
201 if (insecret != NULL)
202 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_KEY,
203 (unsigned char *)insecret,
204 insecretlen);
205 if (prevsecret != NULL)
206 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SALT,
207 (unsigned char *)prevsecret, mdlen);
208 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_PREFIX,
209 (unsigned char *)label_prefix,
210 sizeof(label_prefix) - 1);
211 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_LABEL,
212 (unsigned char *)derived_secret_label,
213 sizeof(derived_secret_label) - 1);
ce3b1bb4
P
214 *p++ = OSSL_PARAM_construct_end();
215
5cceedb5 216 ret = EVP_KDF_derive(kctx, outsecret, mdlen, params) <= 0;
34574f19 217
f63a17d6 218 if (ret != 0)
c48ffbcc 219 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
f63a17d6 220
660c5344 221 EVP_KDF_CTX_free(kctx);
34574f19
MC
222 return ret == 0;
223}
224
34574f19
MC
225/*
226 * Given an input secret |insecret| of length |insecretlen| generate the
227 * handshake secret. This requires the early secret to already have been
f5ca0b04 228 * generated. Returns 1 on success 0 on failure.
34574f19 229 */
38b051a1
TM
230int tls13_generate_handshake_secret(SSL_CONNECTION *s,
231 const unsigned char *insecret,
232 size_t insecretlen)
34574f19 233{
f63a17d6 234 /* Calls SSLfatal() if required */
ec15acb6
MC
235 return tls13_generate_secret(s, ssl_handshake_md(s), s->early_secret,
236 insecret, insecretlen,
34574f19
MC
237 (unsigned char *)&s->handshake_secret);
238}
239
240/*
241 * Given the handshake secret |prev| of length |prevlen| generate the master
f5ca0b04
MC
242 * secret and store its length in |*secret_size|. Returns 1 on success 0 on
243 * failure.
34574f19 244 */
38b051a1 245int tls13_generate_master_secret(SSL_CONNECTION *s, unsigned char *out,
34574f19
MC
246 unsigned char *prev, size_t prevlen,
247 size_t *secret_size)
248{
ec15acb6 249 const EVP_MD *md = ssl_handshake_md(s);
d5349767 250 int md_size;
ec15acb6 251
d5349767
JJ
252 md_size = EVP_MD_get_size(md);
253 if (md_size <= 0) {
bcf81f74
JJ
254 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
255 return 0;
256 }
d5349767 257 *secret_size = (size_t)md_size;
f63a17d6 258 /* Calls SSLfatal() if required */
ec15acb6 259 return tls13_generate_secret(s, md, prev, NULL, 0, out);
34574f19
MC
260}
261
92760c21 262/*
f5ca0b04
MC
263 * Generates the mac for the Finished message. Returns the length of the MAC or
264 * 0 on error.
92760c21 265 */
38b051a1 266size_t tls13_final_finish_mac(SSL_CONNECTION *s, const char *str, size_t slen,
92760c21
MC
267 unsigned char *out)
268{
b740012f 269 const EVP_MD *md = ssl_handshake_md(s);
270 const char *mdname = EVP_MD_get0_name(md);
6484776f 271 unsigned char hash[EVP_MAX_MD_SIZE];
c8f6c28a 272 unsigned char finsecret[EVP_MAX_MD_SIZE];
0edb8194 273 unsigned char *key = NULL;
21dfdbef 274 size_t len = 0, hashlen;
0a8a6afd 275 OSSL_PARAM params[2], *p = params;
38b051a1 276 SSL_CTX *sctx = SSL_CONNECTION_GET_CTX(s);
c8f6c28a 277
b740012f 278 if (md == NULL)
279 return 0;
280
c8f6c28a 281 /* Safe to cast away const here since we're not "getting" any data */
38b051a1 282 if (sctx->propq != NULL)
c8f6c28a 283 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_ALG_PARAM_PROPERTIES,
38b051a1 284 (char *)sctx->propq,
c8f6c28a 285 0);
0edb8194 286 *p = OSSL_PARAM_construct_end();
92760c21 287
d4d2f3a4
MC
288 if (!ssl_handshake_hash(s, hash, sizeof(hash), &hashlen)) {
289 /* SSLfatal() already called */
6484776f 290 goto err;
d4d2f3a4 291 }
6484776f 292
38b051a1 293 if (str == SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->server_finished_label) {
0edb8194 294 key = s->server_finished_secret;
de9f5b35 295 } else if (SSL_IS_FIRST_HANDSHAKE(s)) {
0edb8194 296 key = s->client_finished_secret;
de9f5b35 297 } else {
b740012f 298 if (!tls13_derive_finishedkey(s, md,
de9f5b35
MC
299 s->client_app_traffic_secret,
300 finsecret, hashlen))
301 goto err;
0edb8194 302 key = finsecret;
de9f5b35 303 }
6484776f 304
38b051a1 305 if (!EVP_Q_mac(sctx->libctx, "HMAC", sctx->propq, mdname,
0a8a6afd
DDO
306 params, key, hashlen, hash, hashlen,
307 /* outsize as per sizeof(peer_finish_md) */
308 out, EVP_MAX_MD_SIZE * 2, &len)) {
c48ffbcc 309 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
6484776f 310 goto err;
d4d2f3a4 311 }
92760c21 312
6484776f 313 err:
c8f6c28a 314 OPENSSL_cleanse(finsecret, sizeof(finsecret));
21dfdbef 315 return len;
92760c21
MC
316}
317
318/*
319 * There isn't really a key block in TLSv1.3, but we still need this function
f5ca0b04 320 * for initialising the cipher and hash. Returns 1 on success or 0 on failure.
92760c21 321 */
38b051a1 322int tls13_setup_key_block(SSL_CONNECTION *s)
92760c21
MC
323{
324 const EVP_CIPHER *c;
325 const EVP_MD *hash;
92760c21 326
555cbb32 327 s->session->cipher = s->s3.tmp.new_cipher;
38b051a1
TM
328 if (!ssl_cipher_get_evp(SSL_CONNECTION_GET_CTX(s), s->session, &c, &hash,
329 NULL, NULL, NULL, 0)) {
5a2d0ef3
RL
330 /* Error is already recorded */
331 SSLfatal_alert(s, SSL_AD_INTERNAL_ERROR);
92760c21
MC
332 return 0;
333 }
334
c8f6c28a 335 ssl_evp_cipher_free(s->s3.tmp.new_sym_enc);
555cbb32 336 s->s3.tmp.new_sym_enc = c;
c8f6c28a 337 ssl_evp_md_free(s->s3.tmp.new_hash);
555cbb32 338 s->s3.tmp.new_hash = hash;
92760c21
MC
339
340 return 1;
341}
342
fbd23b92 343static int derive_secret_key_and_iv(SSL_CONNECTION *s, const EVP_MD *md,
d49e23ec 344 const EVP_CIPHER *ciph,
57389a32
MC
345 const unsigned char *insecret,
346 const unsigned char *hash,
347 const unsigned char *label,
348 size_t labellen, unsigned char *secret,
2b891e30
MC
349 unsigned char *key, size_t *keylen,
350 unsigned char *iv, size_t *ivlen,
4bf610bd 351 size_t *taglen)
57389a32 352{
ed576acd 353 int hashleni = EVP_MD_get_size(md);
bceae201 354 size_t hashlen;
2b891e30 355 int mode;
bceae201
MC
356
357 /* Ensure cast to size_t is safe */
358 if (!ossl_assert(hashleni >= 0)) {
c48ffbcc 359 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_EVP_LIB);
cc10b56d 360 return 0;
bceae201
MC
361 }
362 hashlen = (size_t)hashleni;
57389a32 363
a19ae67d 364 if (!tls13_hkdf_expand(s, md, insecret, label, labellen, hash, hashlen,
0fb2815b 365 secret, hashlen, 1)) {
f63a17d6 366 /* SSLfatal() already called */
cc10b56d 367 return 0;
57389a32
MC
368 }
369
2b891e30
MC
370 *keylen = EVP_CIPHER_get_key_length(ciph);
371
372 mode = EVP_CIPHER_get_mode(ciph);
373 if (mode == EVP_CIPH_CCM_MODE) {
c117af67
MC
374 uint32_t algenc;
375
2b891e30 376 *ivlen = EVP_CCM_TLS_IV_LEN;
2e1a4f6a 377 if (s->s3.tmp.new_cipher != NULL) {
378 algenc = s->s3.tmp.new_cipher->algorithm_enc;
379 } else if (s->session->cipher != NULL) {
c117af67
MC
380 /* We've not selected a cipher yet - we must be doing early data */
381 algenc = s->session->cipher->algorithm_enc;
2e1a4f6a 382 } else if (s->psksession != NULL && s->psksession->cipher != NULL) {
383 /* We must be doing early data with out-of-band PSK */
384 algenc = s->psksession->cipher->algorithm_enc;
c117af67 385 } else {
c48ffbcc 386 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_EVP_LIB);
cc10b56d 387 return 0;
c117af67
MC
388 }
389 if (algenc & (SSL_AES128CCM8 | SSL_AES256CCM8))
2b891e30 390 *taglen = EVP_CCM8_TLS_TAG_LEN;
57389a32 391 else
2b891e30 392 *taglen = EVP_CCM_TLS_TAG_LEN;
57389a32 393 } else {
cc110a0a
MC
394 int iivlen;
395
2b891e30
MC
396 if (mode == EVP_CIPH_GCM_MODE) {
397 *taglen = EVP_GCM_TLS_TAG_LEN;
398 } else {
399 /* CHACHA20P-POLY1305 */
400 *taglen = EVP_CHACHAPOLY_TLS_TAG_LEN;
401 }
cc110a0a
MC
402 iivlen = EVP_CIPHER_get_iv_length(ciph);
403 if (iivlen < 0) {
404 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_EVP_LIB);
405 return 0;
406 }
407 *ivlen = iivlen;
57389a32
MC
408 }
409
2b891e30
MC
410 if (!tls13_derive_key(s, md, secret, key, *keylen)
411 || !tls13_derive_iv(s, md, secret, iv, *ivlen)) {
f63a17d6 412 /* SSLfatal() already called */
cc10b56d 413 return 0;
57389a32
MC
414 }
415
57389a32 416 return 1;
57389a32
MC
417}
418
38b051a1 419int tls13_change_cipher_state(SSL_CONNECTION *s, int which)
0d9824c1 420{
44e47328
TS
421 /* ASCII: "c e traffic", in hex for EBCDIC compatibility */
422 static const unsigned char client_early_traffic[] = "\x63\x20\x65\x20\x74\x72\x61\x66\x66\x69\x63";
423 /* ASCII: "c hs traffic", in hex for EBCDIC compatibility */
424 static const unsigned char client_handshake_traffic[] = "\x63\x20\x68\x73\x20\x74\x72\x61\x66\x66\x69\x63";
425 /* ASCII: "c ap traffic", in hex for EBCDIC compatibility */
426 static const unsigned char client_application_traffic[] = "\x63\x20\x61\x70\x20\x74\x72\x61\x66\x66\x69\x63";
427 /* ASCII: "s hs traffic", in hex for EBCDIC compatibility */
428 static const unsigned char server_handshake_traffic[] = "\x73\x20\x68\x73\x20\x74\x72\x61\x66\x66\x69\x63";
429 /* ASCII: "s ap traffic", in hex for EBCDIC compatibility */
430 static const unsigned char server_application_traffic[] = "\x73\x20\x61\x70\x20\x74\x72\x61\x66\x66\x69\x63";
431 /* ASCII: "exp master", in hex for EBCDIC compatibility */
432 static const unsigned char exporter_master_secret[] = "\x65\x78\x70\x20\x6D\x61\x73\x74\x65\x72";
433 /* ASCII: "res master", in hex for EBCDIC compatibility */
434 static const unsigned char resumption_master_secret[] = "\x72\x65\x73\x20\x6D\x61\x73\x74\x65\x72";
435 /* ASCII: "e exp master", in hex for EBCDIC compatibility */
436 static const unsigned char early_exporter_master_secret[] = "\x65\x20\x65\x78\x70\x20\x6D\x61\x73\x74\x65\x72";
b83eac48 437 unsigned char iv[EVP_MAX_IV_LENGTH];
cc10b56d 438 unsigned char key[EVP_MAX_KEY_LENGTH];
0d9824c1 439 unsigned char secret[EVP_MAX_MD_SIZE];
ace081c1
MC
440 unsigned char hashval[EVP_MAX_MD_SIZE];
441 unsigned char *hash = hashval;
0d9824c1 442 unsigned char *insecret;
6484776f 443 unsigned char *finsecret = NULL;
2c7bd692 444 const char *log_label = NULL;
bcf81f74 445 int finsecretlen = 0;
0d9824c1 446 const unsigned char *label;
ace081c1 447 size_t labellen, hashlen = 0;
6530c490 448 int ret = 0;
42f50fdf
MC
449 const EVP_MD *md = NULL;
450 const EVP_CIPHER *cipher = NULL;
38b051a1 451 SSL_CTX *sctx = SSL_CONNECTION_GET_CTX(s);
2b891e30 452 size_t keylen, ivlen, taglen;
2b71b042
MC
453 int level;
454 int direction = (which & SSL3_CC_READ) != 0 ? OSSL_RECORD_DIRECTION_READ
455 : OSSL_RECORD_DIRECTION_WRITE;
0d9824c1 456
0d9824c1
MC
457 if (((which & SSL3_CC_CLIENT) && (which & SSL3_CC_WRITE))
458 || ((which & SSL3_CC_SERVER) && (which & SSL3_CC_READ))) {
d49e23ec
MC
459 if (which & SSL3_CC_EARLY) {
460 EVP_MD_CTX *mdctx = NULL;
461 long handlen;
462 void *hdata;
463 unsigned int hashlenui;
464 const SSL_CIPHER *sslcipher = SSL_SESSION_get0_cipher(s->session);
465
466 insecret = s->early_secret;
467 label = client_early_traffic;
468 labellen = sizeof(client_early_traffic) - 1;
469 log_label = CLIENT_EARLY_LABEL;
470
555cbb32 471 handlen = BIO_get_mem_data(s->s3.handshake_buffer, &hdata);
d49e23ec 472 if (handlen <= 0) {
c48ffbcc 473 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_R_BAD_HANDSHAKE_LENGTH);
d49e23ec
MC
474 goto err;
475 }
add8d0e9 476
08717544
MC
477 if (s->early_data_state == SSL_EARLY_DATA_CONNECTING
478 && s->max_early_data > 0
479 && s->session->ext.max_early_data == 0) {
480 /*
481 * If we are attempting to send early data, and we've decided to
482 * actually do it but max_early_data in s->session is 0 then we
483 * must be using an external PSK.
484 */
485 if (!ossl_assert(s->psksession != NULL
486 && s->max_early_data ==
487 s->psksession->ext.max_early_data)) {
c48ffbcc 488 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
08717544
MC
489 goto err;
490 }
add8d0e9 491 sslcipher = SSL_SESSION_get0_cipher(s->psksession);
08717544 492 }
d49e23ec 493 if (sslcipher == NULL) {
c48ffbcc 494 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_R_BAD_PSK);
d49e23ec
MC
495 goto err;
496 }
497
498 /*
499 * We need to calculate the handshake digest using the digest from
500 * the session. We haven't yet selected our ciphersuite so we can't
501 * use ssl_handshake_md().
502 */
503 mdctx = EVP_MD_CTX_new();
504 if (mdctx == NULL) {
e077455e 505 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_EVP_LIB);
d49e23ec
MC
506 goto err;
507 }
9727f4e7
MC
508
509 /*
510 * This ups the ref count on cipher so we better make sure we free
511 * it again
512 */
38b051a1 513 if (!ssl_cipher_get_evp_cipher(sctx, sslcipher, &cipher)) {
5a2d0ef3
RL
514 /* Error is already recorded */
515 SSLfatal_alert(s, SSL_AD_INTERNAL_ERROR);
67d744b9 516 EVP_MD_CTX_free(mdctx);
9727f4e7
MC
517 goto err;
518 }
519
38b051a1 520 md = ssl_md(sctx, sslcipher->algorithm2);
d49e23ec
MC
521 if (md == NULL || !EVP_DigestInit_ex(mdctx, md, NULL)
522 || !EVP_DigestUpdate(mdctx, hdata, handlen)
523 || !EVP_DigestFinal_ex(mdctx, hashval, &hashlenui)) {
c48ffbcc 524 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
d49e23ec
MC
525 EVP_MD_CTX_free(mdctx);
526 goto err;
527 }
528 hashlen = hashlenui;
529 EVP_MD_CTX_free(mdctx);
b38ede80
TT
530
531 if (!tls13_hkdf_expand(s, md, insecret,
532 early_exporter_master_secret,
533 sizeof(early_exporter_master_secret) - 1,
534 hashval, hashlen,
0fb2815b
MC
535 s->early_exporter_master_secret, hashlen,
536 1)) {
c48ffbcc 537 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
b38ede80
TT
538 goto err;
539 }
01a2a654
PW
540
541 if (!ssl_log_secret(s, EARLY_EXPORTER_SECRET_LABEL,
542 s->early_exporter_master_secret, hashlen)) {
543 /* SSLfatal() already called */
544 goto err;
545 }
d49e23ec 546 } else if (which & SSL3_CC_HANDSHAKE) {
0d9824c1 547 insecret = s->handshake_secret;
6484776f 548 finsecret = s->client_finished_secret;
ed576acd 549 finsecretlen = EVP_MD_get_size(ssl_handshake_md(s));
bcf81f74
JJ
550 if (finsecretlen <= 0) {
551 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
552 goto err;
553 }
0d9824c1
MC
554 label = client_handshake_traffic;
555 labellen = sizeof(client_handshake_traffic) - 1;
2c7bd692 556 log_label = CLIENT_HANDSHAKE_LABEL;
fe5e20fd 557 /*
69687aa8 558 * The handshake hash used for the server read/client write handshake
f7e393be
MC
559 * traffic secret is the same as the hash for the server
560 * write/client read handshake traffic secret. However, if we
561 * processed early data then we delay changing the server
562 * read/client write cipher state until later, and the handshake
563 * hashes have moved on. Therefore we use the value saved earlier
564 * when we did the server write/client read change cipher state.
fe5e20fd 565 */
f7e393be 566 hash = s->handshake_traffic_hash;
0d9824c1 567 } else {
ec15acb6 568 insecret = s->master_secret;
0d9824c1
MC
569 label = client_application_traffic;
570 labellen = sizeof(client_application_traffic) - 1;
2c7bd692 571 log_label = CLIENT_APPLICATION_LABEL;
ace081c1
MC
572 /*
573 * For this we only use the handshake hashes up until the server
574 * Finished hash. We do not include the client's Finished, which is
575 * what ssl_handshake_hash() would give us. Instead we use the
576 * previously saved value.
577 */
578 hash = s->server_finished_hash;
0d9824c1
MC
579 }
580 } else {
d49e23ec 581 /* Early data never applies to client-read/server-write */
0d9824c1
MC
582 if (which & SSL3_CC_HANDSHAKE) {
583 insecret = s->handshake_secret;
6484776f 584 finsecret = s->server_finished_secret;
ed576acd 585 finsecretlen = EVP_MD_get_size(ssl_handshake_md(s));
bcf81f74
JJ
586 if (finsecretlen <= 0) {
587 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
588 goto err;
589 }
0d9824c1
MC
590 label = server_handshake_traffic;
591 labellen = sizeof(server_handshake_traffic) - 1;
2c7bd692 592 log_label = SERVER_HANDSHAKE_LABEL;
0d9824c1 593 } else {
ec15acb6 594 insecret = s->master_secret;
0d9824c1
MC
595 label = server_application_traffic;
596 labellen = sizeof(server_application_traffic) - 1;
2c7bd692 597 log_label = SERVER_APPLICATION_LABEL;
0d9824c1
MC
598 }
599 }
600
d49e23ec
MC
601 if (!(which & SSL3_CC_EARLY)) {
602 md = ssl_handshake_md(s);
555cbb32 603 cipher = s->s3.tmp.new_sym_enc;
d49e23ec
MC
604 if (!ssl3_digest_cached_records(s, 1)
605 || !ssl_handshake_hash(s, hashval, sizeof(hashval), &hashlen)) {
f63a17d6 606 /* SSLfatal() already called */;
d49e23ec
MC
607 goto err;
608 }
ace081c1
MC
609 }
610
ec15acb6
MC
611 /*
612 * Save the hash of handshakes up to now for use when we calculate the
613 * client application traffic secret
614 */
615 if (label == server_application_traffic)
616 memcpy(s->server_finished_hash, hashval, hashlen);
617
f7e393be 618 if (label == server_handshake_traffic)
fe5e20fd
MC
619 memcpy(s->handshake_traffic_hash, hashval, hashlen);
620
ec15acb6
MC
621 if (label == client_application_traffic) {
622 /*
623 * We also create the resumption master secret, but this time use the
624 * hash for the whole handshake including the Client Finished
625 */
626 if (!tls13_hkdf_expand(s, ssl_handshake_md(s), insecret,
627 resumption_master_secret,
628 sizeof(resumption_master_secret) - 1,
4ff1a526 629 hashval, hashlen, s->resumption_master_secret,
0fb2815b 630 hashlen, 1)) {
f63a17d6 631 /* SSLfatal() already called */
ec15acb6
MC
632 goto err;
633 }
ec15acb6
MC
634 }
635
cc10b56d 636 /* check whether cipher is known */
1287dabd 637 if (!ossl_assert(cipher != NULL))
cc10b56d
VF
638 goto err;
639
fbd23b92 640 if (!derive_secret_key_and_iv(s, md, cipher,
cc10b56d 641 insecret, hash, label, labellen, secret, key,
4bf610bd 642 &keylen, iv, &ivlen, &taglen)) {
f63a17d6 643 /* SSLfatal() already called */
57389a32 644 goto err;
ec07b1d8 645 }
0d9824c1 646
2221ec10 647 if (label == server_application_traffic) {
57389a32 648 memcpy(s->server_app_traffic_secret, secret, hashlen);
2221ec10
TT
649 /* Now we create the exporter master secret */
650 if (!tls13_hkdf_expand(s, ssl_handshake_md(s), insecret,
651 exporter_master_secret,
652 sizeof(exporter_master_secret) - 1,
653 hash, hashlen, s->exporter_master_secret,
0fb2815b 654 hashlen, 1)) {
2221ec10
TT
655 /* SSLfatal() already called */
656 goto err;
657 }
6329ce8f
PW
658
659 if (!ssl_log_secret(s, EXPORTER_SECRET_LABEL, s->exporter_master_secret,
660 hashlen)) {
661 /* SSLfatal() already called */
662 goto err;
663 }
2221ec10 664 } else if (label == client_application_traffic)
57389a32
MC
665 memcpy(s->client_app_traffic_secret, secret, hashlen);
666
2c7bd692 667 if (!ssl_log_secret(s, log_label, secret, hashlen)) {
f63a17d6 668 /* SSLfatal() already called */
2c7bd692
CB
669 goto err;
670 }
671
57389a32
MC
672 if (finsecret != NULL
673 && !tls13_derive_finishedkey(s, ssl_handshake_md(s), secret,
bcf81f74 674 finsecret, (size_t)finsecretlen)) {
f63a17d6 675 /* SSLfatal() already called */
0d9824c1
MC
676 goto err;
677 }
678
4bf610bd
MC
679 if ((which & SSL3_CC_WRITE) != 0) {
680 if (!s->server && label == client_early_traffic)
681 s->rlayer.wrlmethod->set_plain_alerts(s->rlayer.wrl, 1);
682 else
683 s->rlayer.wrlmethod->set_plain_alerts(s->rlayer.wrl, 0);
684 }
2b891e30 685
2b71b042
MC
686 level = (which & SSL3_CC_EARLY) != 0
687 ? OSSL_RECORD_PROTECTION_LEVEL_EARLY
688 : ((which &SSL3_CC_HANDSHAKE) != 0
689 ? OSSL_RECORD_PROTECTION_LEVEL_HANDSHAKE
690 : OSSL_RECORD_PROTECTION_LEVEL_APPLICATION);
691
692 if (!ssl_set_new_record_layer(s, s->version,
693 direction,
19863d49 694 level, secret, hashlen, key, keylen, iv,
3f9175c7
MC
695 ivlen, NULL, 0, cipher, taglen, NID_undef,
696 NULL, NULL, md)) {
2b71b042
MC
697 /* SSLfatal already called */
698 goto err;
699 }
700
57389a32
MC
701 ret = 1;
702 err:
9727f4e7
MC
703 if ((which & SSL3_CC_EARLY) != 0) {
704 /* We up-refed this so now we need to down ref */
705 ssl_evp_cipher_free(cipher);
706 }
cc10b56d 707 OPENSSL_cleanse(key, sizeof(key));
57389a32
MC
708 OPENSSL_cleanse(secret, sizeof(secret));
709 return ret;
710}
0d9824c1 711
38b051a1 712int tls13_update_key(SSL_CONNECTION *s, int sending)
57389a32 713{
44e47328
TS
714 /* ASCII: "traffic upd", in hex for EBCDIC compatibility */
715 static const unsigned char application_traffic[] = "\x74\x72\x61\x66\x66\x69\x63\x20\x75\x70\x64";
57389a32 716 const EVP_MD *md = ssl_handshake_md(s);
1d153706 717 size_t hashlen;
cc10b56d 718 unsigned char key[EVP_MAX_KEY_LENGTH];
b83eac48 719 unsigned char *insecret;
57389a32 720 unsigned char secret[EVP_MAX_MD_SIZE];
2f7e61b8 721 char *log_label;
2b891e30 722 size_t keylen, ivlen, taglen;
1d153706 723 int ret = 0, l;
2b71b042
MC
724 int direction = sending ? OSSL_RECORD_DIRECTION_WRITE
725 : OSSL_RECORD_DIRECTION_READ;
b83eac48 726 unsigned char iv[EVP_MAX_IV_LENGTH];
1d153706
P
727
728 if ((l = EVP_MD_get_size(md)) <= 0) {
729 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
730 return 0;
731 }
732 hashlen = (size_t)l;
0d9824c1 733
d1186c30 734 if (s->server == sending)
57389a32
MC
735 insecret = s->server_app_traffic_secret;
736 else
737 insecret = s->client_app_traffic_secret;
bebc0c7d 738
fbd23b92 739 if (!derive_secret_key_and_iv(s, md,
555cbb32 740 s->s3.tmp.new_sym_enc, insecret, NULL,
d49e23ec 741 application_traffic,
cc10b56d 742 sizeof(application_traffic) - 1, secret, key,
4bf610bd 743 &keylen, iv, &ivlen, &taglen)) {
f63a17d6 744 /* SSLfatal() already called */
57389a32 745 goto err;
f63a17d6 746 }
57389a32
MC
747
748 memcpy(insecret, secret, hashlen);
0d9824c1 749
2b71b042
MC
750 if (!ssl_set_new_record_layer(s, s->version,
751 direction,
752 OSSL_RECORD_PROTECTION_LEVEL_APPLICATION,
3f9175c7 753 insecret, hashlen, key, keylen, iv, ivlen, NULL, 0,
2b71b042 754 s->s3.tmp.new_sym_enc, taglen, NID_undef, NULL,
3f9175c7 755 NULL, md)) {
2b71b042
MC
756 /* SSLfatal already called */
757 goto err;
2b891e30
MC
758 }
759
2f7e61b8 760 /* Call Key log on successful traffic secret update */
761 log_label = s->server == sending ? SERVER_APPLICATION_N_LABEL : CLIENT_APPLICATION_N_LABEL;
762 if (!ssl_log_secret(s, log_label, secret, hashlen)) {
763 /* SSLfatal() already called */
764 goto err;
765 }
6530c490 766 ret = 1;
0d9824c1 767 err:
cc10b56d 768 OPENSSL_cleanse(key, sizeof(key));
0d9824c1 769 OPENSSL_cleanse(secret, sizeof(secret));
6530c490 770 return ret;
0d9824c1 771}
04904312
MC
772
773int tls13_alert_code(int code)
774{
43a0f273
MC
775 /* There are 2 additional alerts in TLSv1.3 compared to TLSv1.2 */
776 if (code == SSL_AD_MISSING_EXTENSION || code == SSL_AD_CERTIFICATE_REQUIRED)
04904312
MC
777 return code;
778
779 return tls1_alert_code(code);
780}
0ca8d1ec 781
38b051a1
TM
782int tls13_export_keying_material(SSL_CONNECTION *s,
783 unsigned char *out, size_t olen,
0ca8d1ec
MC
784 const char *label, size_t llen,
785 const unsigned char *context,
786 size_t contextlen, int use_context)
787{
788 unsigned char exportsecret[EVP_MAX_MD_SIZE];
44e47328
TS
789 /* ASCII: "exporter", in hex for EBCDIC compatibility */
790 static const unsigned char exporterlabel[] = "\x65\x78\x70\x6F\x72\x74\x65\x72";
c8b93876 791 unsigned char hash[EVP_MAX_MD_SIZE], data[EVP_MAX_MD_SIZE];
0ca8d1ec
MC
792 const EVP_MD *md = ssl_handshake_md(s);
793 EVP_MD_CTX *ctx = EVP_MD_CTX_new();
c8b93876 794 unsigned int hashsize, datalen;
0ca8d1ec
MC
795 int ret = 0;
796
b740012f 797 if (ctx == NULL || md == NULL || !ossl_statem_export_allowed(s))
0ca8d1ec
MC
798 goto err;
799
800 if (!use_context)
801 contextlen = 0;
802
803 if (EVP_DigestInit_ex(ctx, md, NULL) <= 0
804 || EVP_DigestUpdate(ctx, context, contextlen) <= 0
805 || EVP_DigestFinal_ex(ctx, hash, &hashsize) <= 0
c8b93876
TT
806 || EVP_DigestInit_ex(ctx, md, NULL) <= 0
807 || EVP_DigestFinal_ex(ctx, data, &datalen) <= 0
0ca8d1ec 808 || !tls13_hkdf_expand(s, md, s->exporter_master_secret,
c8b93876 809 (const unsigned char *)label, llen,
0fb2815b 810 data, datalen, exportsecret, hashsize, 0)
0ca8d1ec 811 || !tls13_hkdf_expand(s, md, exportsecret, exporterlabel,
a19ae67d 812 sizeof(exporterlabel) - 1, hash, hashsize,
0fb2815b 813 out, olen, 0))
0ca8d1ec
MC
814 goto err;
815
816 ret = 1;
817 err:
818 EVP_MD_CTX_free(ctx);
819 return ret;
820}
b38ede80 821
38b051a1
TM
822int tls13_export_keying_material_early(SSL_CONNECTION *s,
823 unsigned char *out, size_t olen,
b38ede80
TT
824 const char *label, size_t llen,
825 const unsigned char *context,
826 size_t contextlen)
827{
44e47328
TS
828 /* ASCII: "exporter", in hex for EBCDIC compatibility */
829 static const unsigned char exporterlabel[] = "\x65\x78\x70\x6F\x72\x74\x65\x72";
b38ede80
TT
830 unsigned char exportsecret[EVP_MAX_MD_SIZE];
831 unsigned char hash[EVP_MAX_MD_SIZE], data[EVP_MAX_MD_SIZE];
832 const EVP_MD *md;
833 EVP_MD_CTX *ctx = EVP_MD_CTX_new();
834 unsigned int hashsize, datalen;
835 int ret = 0;
836 const SSL_CIPHER *sslcipher;
837
838 if (ctx == NULL || !ossl_statem_export_early_allowed(s))
839 goto err;
840
841 if (!s->server && s->max_early_data > 0
842 && s->session->ext.max_early_data == 0)
843 sslcipher = SSL_SESSION_get0_cipher(s->psksession);
844 else
845 sslcipher = SSL_SESSION_get0_cipher(s->session);
846
38b051a1 847 md = ssl_md(SSL_CONNECTION_GET_CTX(s), sslcipher->algorithm2);
b38ede80
TT
848
849 /*
850 * Calculate the hash value and store it in |data|. The reason why
851 * the empty string is used is that the definition of TLS-Exporter
852 * is like so:
853 *
854 * TLS-Exporter(label, context_value, key_length) =
855 * HKDF-Expand-Label(Derive-Secret(Secret, label, ""),
856 * "exporter", Hash(context_value), key_length)
857 *
858 * Derive-Secret(Secret, Label, Messages) =
859 * HKDF-Expand-Label(Secret, Label,
860 * Transcript-Hash(Messages), Hash.length)
861 *
862 * Here Transcript-Hash is the cipher suite hash algorithm.
863 */
b740012f 864 if (md == NULL
865 || EVP_DigestInit_ex(ctx, md, NULL) <= 0
b38ede80
TT
866 || EVP_DigestUpdate(ctx, context, contextlen) <= 0
867 || EVP_DigestFinal_ex(ctx, hash, &hashsize) <= 0
868 || EVP_DigestInit_ex(ctx, md, NULL) <= 0
869 || EVP_DigestFinal_ex(ctx, data, &datalen) <= 0
870 || !tls13_hkdf_expand(s, md, s->early_exporter_master_secret,
871 (const unsigned char *)label, llen,
0fb2815b 872 data, datalen, exportsecret, hashsize, 0)
b38ede80
TT
873 || !tls13_hkdf_expand(s, md, exportsecret, exporterlabel,
874 sizeof(exporterlabel) - 1, hash, hashsize,
0fb2815b 875 out, olen, 0))
b38ede80
TT
876 goto err;
877
878 ret = 1;
879 err:
880 EVP_MD_CTX_free(ctx);
881 return ret;
882}