1 /*
2 * Copyright 2016-2023 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 <openssl/ssl.h>
11 #include <openssl/evp.h>
12 #include "../ssl/ssl_local.h"
13 #include "../ssl/record/record_local.h"
14 #include "internal/recordmethod.h"
15 #include "../ssl/record/methods/recmethod_local.h"
16 #include "internal/nelem.h"
17 #include "testutil.h"
18
19 /*
20 * Based on the test vectors provided in:
21 * https://tools.ietf.org/html/draft-ietf-tls-tls13-vectors-06
22 */
23
24 typedef struct {
25 /*
26 * We split these into 3 chunks in order to work around the 509 character
27 * limit that the standard specifies for string literals
28 */
29 const char *plaintext[3];
30 const char *ciphertext[3];
31 const char *key;
32 const char *iv;
33 const char *seq;
34 } RECORD_DATA;
35
36 /*
37 * Note 1: The plaintext values given here have an additional "16" or "17" byte
38 * added to the end when compared to the official vectors. The official vectors
39 * do not include the inner content type, but we require it.
40 *
41 * Note 2: These are the vectors for the "Simple 1-RTT Handshake"
42 */
43 static RECORD_DATA refdata[] = {
44 {
45 /*
46 * Server: EncryptedExtensions, Certificate, CertificateVerify and
47 * Finished
48 */
49 {
50 "080000240022000a00140012001d00170018001901000101010201030104001c"
51 "00024001000000000b0001b9000001b50001b0308201ac30820115a003020102"
52 "020102300d06092a864886f70d01010b0500300e310c300a0603550403130372"
53 "7361301e170d3136303733303031323335395a170d3236303733303031323335"
54 "395a300e310c300a0603550403130372736130819f300d06092a864886f70d01"
55 "0101050003818d0030818902818100b4bb498f8279303d980836399b36c6988c"
56 "0c68de55e1bdb826d3901a2461eafd2de49a91d015abbc9a95137ace6c1af19e",
57 "aa6af98c7ced43120998e187a80ee0ccb0524b1b018c3e0b63264d449a6d38e2"
58 "2a5fda430846748030530ef0461c8ca9d9efbfae8ea6d1d03e2bd193eff0ab9a"
59 "8002c47428a6d35a8d88d79f7f1e3f0203010001a31a301830090603551d1304"
60 "023000300b0603551d0f0404030205a0300d06092a864886f70d01010b050003"
61 "81810085aad2a0e5b9276b908c65f73a7267170618a54c5f8a7b337d2df7a594"
62 "365417f2eae8f8a58c8f8172f9319cf36b7fd6c55b80f21a03015156726096fd"
63 "335e5e67f2dbf102702e608ccae6bec1fc63a42a99be5c3eb7107c3c54e9b9eb",
64 "2bd5203b1c3b84e0a8b2f759409ba3eac9d91d402dcc0cc8f8961229ac9187b4"
65 "2b4de100000f00008408040080754040d0ddab8cf0e2da2bc4995b868ad745c8"
66 "e1564e33cde17880a42392cc624aeef6b67bb3f0ae71d9d54a2309731d87dc59"
67 "f642d733be2eb27484ad8a8c8eb3516a7ac57f2625e2b5c0888a8541f4e734f7"
68 "3d054761df1dd02f0e3e9a33cfa10b6e3eb4ebf7ac053b01fdabbddfc54133bc"
69 "d24c8bbdceb223b2aa03452a2914000020ac86acbc9cd25a45b57ad5b64db15d"
70 "4405cf8c80e314583ebf3283ef9a99310c16"
71 },
72 {
73 "f10b26d8fcaf67b5b828f712122216a1cd14187465b77637cbcd78539128bb93"
74 "246dcca1af56f1eaa271666077455bc54965d85f05f9bd36d6996171eb536aff"
75 "613eeddc42bad5a2d2227c4606f1215f980e7afaf56bd3b85a51be130003101a"
76 "758d077b1c891d8e7a22947e5a229851fd42a9dd422608f868272abf92b3d43f"
77 "b46ac420259346067f66322fd708885680f4b4433c29116f2dfa529e09bba53c"
78 "7cd920121724809eaddcc84307ef46fc51a0b33d99d39db337fcd761ce0f2b02"
79 "dc73dedb6fddb77c4f8099bde93d5bee08bcf2131f29a2a37ff07949e8f8bcdd",
80 "3e8310b8bf8b3444c85aaf0d2aeb2d4f36fd14d5cb51fcebff418b3827136ab9"
81 "529e9a3d3f35e4c0ae749ea2dbc94982a1281d3e6daab719aa4460889321a008"
82 "bf10fa06ac0c61cc122cc90d5e22c0030c986ae84a33a0c47df174bcfbd50bf7"
83 "8ffdf24051ab423db63d5815db2f830040f30521131c98c66f16c362addce2fb"
84 "a0602cf0a7dddf22e8def7516cdfee95b4056cc9ad38c95352335421b5b1ffba"
85 "df75e5212fdad7a75f52a2801486a1eec3539580bee0e4b337cda6085ac9eccd"
86 "1a0f1a46cebfbb5cdfa3251ac28c3bc826148c6d8c1eb6a06f77f6ff632c6a83",
87 "e283e8f9df7c6dbabf1c6ea40629a85b43ab0c73d34f9d5072832a104eda3f75"
88 "f5d83da6e14822a18e14099d749eafd823ca2ac7542086501eca206ce7887920"
89 "008573757ce2f230a890782b99cc682377beee812756d04f9025135fb599d746"
90 "fefe7316c922ac265ca0d29021375adb63c1509c3e242dfb92b8dee891f7368c"
91 "4058399b8db9075f2dcc8216194e503b6652d87d2cb41f99adfdcc5be5ec7e1e"
92 "6326ac22d70bd3ba652827532d669aff005173597f8039c3ea4922d3ec757670"
93 "222f6ac29b93e90d7ad3f6dd96328e429cfcfd5cca22707fe2d86ad1dcb0be75"
94 "6e8e"
95 },
96 "c66cb1aec519df44c91e10995511ac8b",
97 "f7f6884c4981716c2d0d29a4",
98 "0000000000000000"
99 },
100 {
101 /* Client: Finished */
102 {
103 "14000020b9027a0204b972b52cdefa58950fa1580d68c9cb124dbe691a7178f2"
104 "5c554b2316", "", ""
105 },
106 {
107 "9539b4ae2f87fd8e616b295628ea953d9e3858db274970d19813ec136cae7d96"
108 "e0417775fcabd3d8858fdc60240912d218f5afb21c", "", ""
109 },
110 "2679a43e1d76784034ea1797d5ad2649",
111 "5482405290dd0d2f81c0d942",
112 "0000000000000000"
113 },
114 {
115 /* Server: NewSessionTicket */
116 {
117 "040000c90000001e2fd3992f02000000b2ff099f9676cdff8b0bf8825d000000"
118 "007905a9d28efeef4a47c6f9b06a0cecdb0070d920b898997c75b79636943ed4"
119 "2046a96142bd084a04acfa0c490f452d756dea02c0f927259f1f3231ac0d541a"
120 "769129b740ce38090842b828c27fd729f59737ba98aa7b42e043c5da28f8dca8"
121 "590b2df410d5134fd6c4cacad8b30370602afa35d265bf4d127976bb36dbda6a"
122 "626f0270e20eebc73d6fcae2b1a0da122ee9042f76be56ebf41aa469c3d2c9da"
123 "9197d80008002a00040000040016", "", ""
124 },
125 {
126 "3680c2b2109d25caa26c3b06eea9fdc5cb31613ba702176596da2e886bf6af93"
127 "507bd68161ad9cb4780653842e1041ecbf0088a65ac4ef438419dd1d95ddd9bd"
128 "2ad4484e7e167d0e6c008448ae58a0418713b6fc6c51e4bb23a537fb75a74f73"
129 "de31fe6aa0bc522515f8b25f8955428b5de5ac06762cec22b0aa78c94385ef8e"
130 "70fa24945b7c1f268510871689bbbbfaf2e7f4a19277024f95f1143ab12a31ec"
131 "63adb128cb390711fd6d06a498df3e98615d8eb102e23353b480efcca5e8e026"
132 "7a6d0fe2441f14c8c9664aefb2cfff6ae9e0442728b6a0940c1e824fda06",
133 "", ""
134
135 },
136 "a688ebb5ac826d6f42d45c0cc44b9b7d",
137 "c1cad4425a438b5de714830a",
138 "0000000000000000"
139 },
140 {
141 /* Client: Application Data */
142 {
143 "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f"
144 "202122232425262728292a2b2c2d2e2f303117", "", ""
145 },
146 {
147 "8c3497da00ae023e53c01b4324b665404c1b49e78fe2bf4d17f6348ae8340551"
148 "e363a0cd05f2179c4fef5ad689b5cae0bae94adc63632e571fb79aa91544c639"
149 "4d28a1", "", ""
150
151 },
152 "88b96ad686c84be55ace18a59cce5c87",
153 "b99dc58cd5ff5ab082fdad19",
154 "0000000000000000"
155 },
156
157
158 {
159 /* Server: Application Data */
160 {
161 "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f"
162 "202122232425262728292a2b2c2d2e2f303117", "", ""
163 },
164 {
165 "f65f49fd2df6cd2347c3d30166e3cfddb6308a5906c076112c6a37ff1dbd406b"
166 "5813c0abd734883017a6b2833186b13c14da5d75f33d8760789994e27d82043a"
167 "b88d65", "", ""
168 },
169 "a688ebb5ac826d6f42d45c0cc44b9b7d",
170 "c1cad4425a438b5de714830a",
171 "0000000000000001"
172 },
173 {
174 /* Client: CloseNotify */
175 {
176 "010015", "", ""
177 },
178 {
179 "2c2148163d7938a35f6acf2a6606f8cbd1d9f2", "", ""
180 },
181 "88b96ad686c84be55ace18a59cce5c87",
182 "b99dc58cd5ff5ab082fdad19",
183 "0000000000000001"
184 },
185 {
186 /* Server: CloseNotify */
187 {
188 "010015", "", ""
189 },
190 {
191 "f8141ebdb5eda511e0bce639a56ff9ea825a21", "", ""
192
193 },
194 "a688ebb5ac826d6f42d45c0cc44b9b7d",
195 "c1cad4425a438b5de714830a",
196 "0000000000000002"
197 }
198 };
199
200 /*
201 * Same thing as OPENSSL_hexstr2buf() but enables us to pass the string in
202 * 3 chunks
203 */
multihexstr2buf(const char * str[3],size_t * len)204 static unsigned char *multihexstr2buf(const char *str[3], size_t *len)
205 {
206 size_t outer, inner, curr = 0;
207 unsigned char *outbuf;
208 size_t totlen = 0;
209
210 /* Check lengths of all input strings are even */
211 for (outer = 0; outer < 3; outer++) {
212 totlen += strlen(str[outer]);
213 if ((totlen & 1) != 0)
214 return NULL;
215 }
216
217 totlen /= 2;
218 outbuf = OPENSSL_malloc(totlen);
219 if (outbuf == NULL)
220 return NULL;
221
222 for (outer = 0; outer < 3; outer++) {
223 for (inner = 0; str[outer][inner] != 0; inner += 2) {
224 int hi, lo;
225
226 hi = OPENSSL_hexchar2int(str[outer][inner]);
227 lo = OPENSSL_hexchar2int(str[outer][inner + 1]);
228
229 if (hi < 0 || lo < 0) {
230 OPENSSL_free(outbuf);
231 return NULL;
232 }
233 outbuf[curr++] = (hi << 4) | lo;
234 }
235 }
236
237 *len = totlen;
238 return outbuf;
239 }
240
load_record(TLS_RL_RECORD * rec,RECORD_DATA * recd,unsigned char ** key,unsigned char * iv,size_t ivlen,unsigned char * seq)241 static int load_record(TLS_RL_RECORD *rec, RECORD_DATA *recd,
242 unsigned char **key, unsigned char *iv, size_t ivlen,
243 unsigned char *seq)
244 {
245 unsigned char *pt = NULL, *sq = NULL, *ivtmp = NULL;
246 size_t ptlen;
247
248 *key = OPENSSL_hexstr2buf(recd->key, NULL);
249 ivtmp = OPENSSL_hexstr2buf(recd->iv, NULL);
250 sq = OPENSSL_hexstr2buf(recd->seq, NULL);
251 pt = multihexstr2buf(recd->plaintext, &ptlen);
252
253 if (*key == NULL || ivtmp == NULL || sq == NULL || pt == NULL)
254 goto err;
255
256 rec->data = rec->input = OPENSSL_malloc(ptlen + EVP_GCM_TLS_TAG_LEN);
257
258 if (rec->data == NULL)
259 goto err;
260
261 rec->length = ptlen;
262 memcpy(rec->data, pt, ptlen);
263 OPENSSL_free(pt);
264 memcpy(seq, sq, SEQ_NUM_SIZE);
265 OPENSSL_free(sq);
266 memcpy(iv, ivtmp, ivlen);
267 OPENSSL_free(ivtmp);
268
269 return 1;
270 err:
271 OPENSSL_free(*key);
272 *key = NULL;
273 OPENSSL_free(ivtmp);
274 OPENSSL_free(sq);
275 OPENSSL_free(pt);
276 return 0;
277 }
278
test_record(TLS_RL_RECORD * rec,RECORD_DATA * recd,int enc)279 static int test_record(TLS_RL_RECORD *rec, RECORD_DATA *recd, int enc)
280 {
281 int ret = 0;
282 unsigned char *refd;
283 size_t refdatalen = 0;
284
285 if (enc)
286 refd = multihexstr2buf(recd->ciphertext, &refdatalen);
287 else
288 refd = multihexstr2buf(recd->plaintext, &refdatalen);
289
290 if (!TEST_ptr(refd)) {
291 TEST_info("Failed to get reference data");
292 goto err;
293 }
294
295 if (!TEST_mem_eq(rec->data, rec->length, refd, refdatalen))
296 goto err;
297
298 ret = 1;
299
300 err:
301 OPENSSL_free(refd);
302 return ret;
303 }
304
305 #define TLS13_AES_128_GCM_SHA256_BYTES ((const unsigned char *)"\x13\x01")
306
test_tls13_encryption(void)307 static int test_tls13_encryption(void)
308 {
309 TLS_RL_RECORD rec;
310 unsigned char *key = NULL;
311 const EVP_CIPHER *ciph = EVP_aes_128_gcm();
312 int ret = 0;
313 size_t ivlen, ctr;
314 unsigned char seqbuf[SEQ_NUM_SIZE];
315 unsigned char iv[EVP_MAX_IV_LENGTH];
316 OSSL_RECORD_LAYER *rrl = NULL, *wrl = NULL;
317
318 /*
319 * Encrypted TLSv1.3 records always have an outer content type of
320 * application data, and a record version of TLSv1.2.
321 */
322 rec.data = NULL;
323 rec.type = SSL3_RT_APPLICATION_DATA;
324 rec.rec_version = TLS1_2_VERSION;
325
326 for (ctr = 0; ctr < OSSL_NELEM(refdata); ctr++) {
327 /* Load the record */
328 ivlen = EVP_CIPHER_get_iv_length(ciph);
329 if (!load_record(&rec, &refdata[ctr], &key, iv, ivlen, seqbuf)) {
330 TEST_error("Failed loading key into EVP_CIPHER_CTX");
331 goto err;
332 }
333
334 /* Set up the write record layer */
335 if (!TEST_true(ossl_tls_record_method.new_record_layer(
336 NULL, NULL, TLS1_3_VERSION, OSSL_RECORD_ROLE_SERVER,
337 OSSL_RECORD_DIRECTION_WRITE,
338 OSSL_RECORD_PROTECTION_LEVEL_APPLICATION, 0, NULL, 0,
339 key, 16, iv, ivlen, NULL, 0, EVP_aes_128_gcm(),
340 EVP_GCM_TLS_TAG_LEN, 0, NULL, NULL, NULL, NULL, NULL,
341 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
342 &wrl)))
343 goto err;
344 memcpy(wrl->sequence, seqbuf, sizeof(seqbuf));
345
346 /* Encrypt it */
347 if (!TEST_size_t_eq(wrl->funcs->cipher(wrl, &rec, 1, 1, NULL, 0), 1)) {
348 TEST_info("Failed to encrypt record %zu", ctr);
349 goto err;
350 }
351
352 if (!TEST_true(test_record(&rec, &refdata[ctr], 1))) {
353 TEST_info("Record %zu encryption test failed", ctr);
354 goto err;
355 }
356
357 /* Set up the read record layer */
358 if (!TEST_true(ossl_tls_record_method.new_record_layer(
359 NULL, NULL, TLS1_3_VERSION, OSSL_RECORD_ROLE_SERVER,
360 OSSL_RECORD_DIRECTION_READ,
361 OSSL_RECORD_PROTECTION_LEVEL_APPLICATION, 0, NULL, 0,
362 key, 16, iv, ivlen, NULL, 0, EVP_aes_128_gcm(),
363 EVP_GCM_TLS_TAG_LEN, 0, NULL, NULL, NULL, NULL, NULL,
364 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
365 &rrl)))
366 goto err;
367 memcpy(rrl->sequence, seqbuf, sizeof(seqbuf));
368
369 /* Decrypt it */
370 if (!TEST_int_eq(rrl->funcs->cipher(rrl, &rec, 1, 0, NULL, 0), 1)) {
371 TEST_info("Failed to decrypt record %zu", ctr);
372 goto err;
373 }
374
375 if (!TEST_true(test_record(&rec, &refdata[ctr], 0))) {
376 TEST_info("Record %zu decryption test failed", ctr);
377 goto err;
378 }
379
380 ossl_tls_record_method.free(rrl);
381 ossl_tls_record_method.free(wrl);
382 rrl = wrl = NULL;
383 OPENSSL_free(rec.data);
384 OPENSSL_free(key);
385 rec.data = NULL;
386 key = NULL;
387 }
388
389 TEST_note("PASS: %zu records tested", ctr);
390 ret = 1;
391
392 err:
393 ossl_tls_record_method.free(rrl);
394 ossl_tls_record_method.free(wrl);
395 OPENSSL_free(rec.data);
396 OPENSSL_free(key);
397 return ret;
398 }
399
setup_tests(void)400 int setup_tests(void)
401 {
402 ADD_TEST(test_tls13_encryption);
403 return 1;
404 }
405
