861a8154cd8573ed49460dc27a57342b0456f2cb
[openssl.git] / test / tls13encryptiontest.c
1 /*
2  * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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
13 #ifdef __VMS
14 # pragma names save
15 # pragma names as_is,shortened
16 #endif
17
18 #include "../ssl/ssl_locl.h"
19 #include "../ssl/record/record_locl.h"
20
21 #ifdef __VMS
22 # pragma names restore
23 #endif
24
25 #include "testutil.h"
26
27 /*
28  * Based on the test vectors provided in:
29  * https://www.ietf.org/id/draft-thomson-tls-tls13-vectors-01.txt
30  */
31
32 typedef struct {
33     /*
34      * We split these into 3 chunks in order to work around the 509 character
35      * limit that the standard specifies for string literals
36      */
37     const char *plaintext[3];
38     const char *ciphertext[3];
39     const char *key;
40     const char *iv;
41     const char *seq;
42 } RECORD_DATA;
43
44 static RECORD_DATA refdata[] = {
45     {
46         /*
47          * Server: EncryptedExtensions, Certificate, CertificateVerify and
48          *         Finished
49          */
50         {
51             "0800001e001c000a00140012001d001700180019010001010102010301040000"
52             "00000b0001b9000001b50001b0308201ac30820115a003020102020102300d06"
53             "092a864886f70d01010b0500300e310c300a06035504031303727361301e170d"
54             "3136303733303031323335395a170d3236303733303031323335395a300e310c"
55             "300a0603550403130372736130819f300d06092a864886f70d01010105000381"
56             "8d0030818902818100b4bb498f8279303d980836399b36c6988c0c68de55e1bd"
57             "b826d3901a2461eafd2de49a91d015abbc9a95137ace6c1af19eaa6af98c7ced",
58             "43120998e187a80ee0ccb0524b1b018c3e0b63264d449a6d38e22a5fda430846"
59             "748030530ef0461c8ca9d9efbfae8ea6d1d03e2bd193eff0ab9a8002c47428a6"
60             "d35a8d88d79f7f1e3f0203010001a31a301830090603551d1304023000300b06"
61             "03551d0f0404030205a0300d06092a864886f70d01010b05000381810085aad2"
62             "a0e5b9276b908c65f73a7267170618a54c5f8a7b337d2df7a594365417f2eae8"
63             "f8a58c8f8172f9319cf36b7fd6c55b80f21a03015156726096fd335e5e67f2db"
64             "f102702e608ccae6bec1fc63a42a99be5c3eb7107c3c54e9b9eb2bd5203b1c3b",
65             "84e0a8b2f759409ba3eac9d91d402dcc0cc8f8961229ac9187b42b4de100000f"
66             "00008408040080134e22eac57321ab47db6b38b2992cec2dd79bd065a034a9af"
67             "6b9e3d03475e4309e6523ccdf055453fb480804a3a7e996229eb28e734f6702b"
68             "ea2b32149899ac043a4b44468197868da77147ce9f73c0543c4e3fc33e306cac"
69             "8506faa80a959c5f1edccbee76eda1ad7a4fa440de35dcb87e82ec94e8725355"
70             "ce7507713a609e140000207304bb73321f01b71dd94622fae98daf634490d220"
71             "e4c8f3ffa2559911a56e5116"
72         },
73         {
74             "40ae92071a3a548b26af31e116dfc0ba4549210b17e70da16cfbda9ccdad844d"
75             "94264a9ae65b786b3eaf0de20aa89c6babb448b6f32d07f233584296eefe1931"
76             "6bd979659472ee8567cb01d70b0366cddb3c60eb9e1d789a3691dc254c14de73"
77             "f4f20100504544ce184d44547e124b1f18303b4859f8f2e2b04423d23a866b43"
78             "866374d54af41649d25f4a3ec2cecd5d4e6de1b24953440b46fbb74c1dbec6fb"
79             "b1f16bc21d4aa0e1e936a49c07127e19719bc652a2f0b7f8df4a150b2b3c9e9e"
80             "353d6ed101970ddc611abad0632c6793f9379c9d06846c311fcbd6f85edd569b",
81             "8782c4c5f62294c4611ae60f83230a53aa95e3bcbed204f19a7a1db83c0fbfec"
82             "1edd2c17498fa7b5aa2321248a92592d891e4947df6bcef52f4481797d032ad3"
83             "32046a384abece6454b3e356d7249bfa5696793c7f7d3048dc87fa7409a46918"
84             "87caaf0982c402b902d699f62dc4d5e153f13e8589e4a6206c7f74eb26ddefbb"
85             "92309fb753decfea972dec7de02eda9c6d26acd7be53a8aa20f1a93f082ae6eb"
86             "927a6a1b7bd9153551aedfaf94f61dd4cb9355ad7ab09f615d9f92c21712c732"
87             "c0e7e117797f38cbdc184e3a65e15a89f46cb3624f5fdb8dbbd275f2c8492f8d",
88             "95bdbd8d1dc1b9f21107bd433acbbac247239c073a2f24a4a9f8074f325f277d"
89             "579b6bff0269ff19aed3809a9ddd21dd29c1363c9dc44812dd41d2111f9c2e83"
90             "42046c14133b853262676f15e94de18660e04ae5c0c661ea43559af5842e161c"
91             "83dd29f64508b2ec3e635a2134fc0e1a39d3ecb51dcddfcf8382c88ffe2a7378"
92             "42ad1de7fe505b6c4d1673870f6fc2a0f2f7972acaee368a1599d64ba18798f1"
93             "0333f9779bd5b05f9b084d03dab2f3d80c2eb74ec70c9866ea31c18b491cd597"
94             "aae3e941205fcc38a3a10ce8c0269f02ccc9c51278e25f1a0f0731a9"
95         },
96         "d2dd45f87ad87801a85ac38187f9023b",
97         "f0a14f808692cef87a3daf70",
98         "0000000000000000"
99     },
100     {
101         /* Client: Finished */
102         {
103             "1400002078367856d3c8cc4e0a95eb98906ca7a48bd3cc7029f48bd4ae0dc91a"
104             "b903ca8916","",""
105         },
106         {
107             "fa15e92daa21cd05d8f9c3152a61748d9aaf049da559718e583f95aacecad657"
108             "b52a6562da09a5819e864d86ac2989360a1eb22795","",""
109         },
110         "40e1201d75d419627f04c88530a15c9d",
111         "a0f073f3b35e18f96969696b",
112         "0000000000000000"
113     },
114     {
115         /* Server: NewSessionTicket */
116         {
117             "040000a60002a3004abe594b00924e535321cadc96238da09caf9b02fecafdd6"
118             "5e3e418f03e43772cf512ed8066100503b1c08abbbf298a9d138ce821dd12fe1"
119             "710e2137cd12e6a85cd3fd7f73706e7f5dddefb87c1ef83824638464099c9d13"
120             "63e3c64ed2075c16b8ccd8e524a6bbd7a6a6e34ea1579782b15bbe7dfed5c0c0"
121             "d980fb330f9d8ab252ffe7be1277d418b6828ead4dae3b30d448442417ef76af"
122             "0008002e00040002000016","",""
123         },
124         {
125             "45a6626fa13b66ce2c5b3ef807e299a118296f26a2dd9ec7487a0673e2460d4c"
126             "79f40087dcd014c59c51379c90d26b4e4f9bb2b78f5b6761594f013ff3e4c78d"
127             "836905229eac811c4ef8b2faa89867e9ffc586f7f03c216591aa5e620eac3c62"
128             "dfe60f846036bd7ecc4464b584af184e9644e94ee1d7834dba408a51cbe42480"
129             "04796ed9c558e0f5f96115a6f6ba487e17d16a2e20a3d3a650a9a070fb53d9da"
130             "82864b5621d77650bd0c7947e9889917b53d0515627c72b0ded521","",""
131         },
132         "3381f6b3f94500f16226de440193e858",
133         "4f1d73cc1d465eb30021c41f",
134         "0000000000000000"
135     },
136     {
137         /* Client: Application Data */
138         {
139             "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f"
140             "202122232425262728292a2b2c2d2e2f303117","",""
141         },
142         {
143             "e306178ad97f74bb64f35eaf3c39846b83aef8472cbc9046749b81a949dfb12c"
144             "fbc65cbabd20ade92c1f944605892ceeb12fdee8a927bce77c83036ac5a794a8"
145             "f54a69","",""
146         },
147         "eb23a804904b80ba4fe8399e09b1ce42",
148         "efa8c50c06b9c9b8c483e174",
149         "0000000000000000"
150     },
151     {
152         /* Server: Application Data */
153         {
154             "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f"
155             "202122232425262728292a2b2c2d2e2f303117","",""
156         },
157         {
158             "467d99a807dbf778e6ffd8be52456c70665f890811ef2f3c495d5bbe983feeda"
159             "b0c251dde596bc7e2b135909ec9f9166fb0152e8c16a84e4b1039256467f9538"
160             "be4463","",""
161         },
162         "3381f6b3f94500f16226de440193e858",
163         "4f1d73cc1d465eb30021c41f",
164         "0000000000000001"
165     },
166     {
167         /* Client: CloseNotify */
168         {
169             "010015","",""
170         },
171         {
172             "6bdf60847ba6fb650da36e872adc684a4af2e8","",""
173         },
174         "eb23a804904b80ba4fe8399e09b1ce42",
175         "efa8c50c06b9c9b8c483e174",
176         "0000000000000001"
177     },
178     {
179         /* Server: CloseNotify */
180         {
181             "010015","",""
182         },
183         {
184             "621b7cc1962cd8a70109fee68a52efedf87d2e","",""
185         },
186         "3381f6b3f94500f16226de440193e858",
187         "4f1d73cc1d465eb30021c41f",
188         "0000000000000002"
189     }
190 };
191
192 /*
193  * Same thing as OPENSSL_hexstr2buf() but enables us to pass the string in
194  * 3 chunks
195  */
196 static unsigned char *multihexstr2buf(const char *str[3], size_t *len)
197 {
198     size_t outer, inner, curr = 0;
199     unsigned char *outbuf;
200     size_t totlen = 0;
201
202     /* Check lengths of all input strings are even */
203     for (outer = 0; outer < 3; outer++) {
204         totlen += strlen(str[outer]);
205         if ((totlen & 1) != 0)
206             return NULL;
207     }
208
209     totlen /= 2;
210     outbuf = OPENSSL_malloc(totlen);
211     if (outbuf == NULL)
212         return NULL;
213
214     for (outer = 0; outer < 3; outer++) {
215         for (inner = 0; str[outer][inner] != 0; inner += 2) {
216             int hi, lo;
217
218             hi = OPENSSL_hexchar2int(str[outer][inner]);
219             lo = OPENSSL_hexchar2int(str[outer][inner + 1]);
220
221             if (hi < 0 || lo < 0) {
222                 OPENSSL_free(outbuf);
223                 return NULL;
224             }
225             outbuf[curr++] = (hi << 4) | lo;
226         }
227     }
228
229     *len = totlen;
230     return outbuf;
231 }
232
233 static int load_record(SSL3_RECORD *rec, RECORD_DATA *recd, unsigned char **key,
234                        unsigned char *iv, size_t ivlen, unsigned char *seq)
235 {
236     unsigned char *pt = NULL, *sq = NULL, *ivtmp = NULL;
237     size_t ptlen;
238
239     *key = OPENSSL_hexstr2buf(recd->key, NULL);
240     ivtmp = OPENSSL_hexstr2buf(recd->iv, NULL);
241     sq = OPENSSL_hexstr2buf(recd->seq, NULL);
242     pt = multihexstr2buf(recd->plaintext, &ptlen);
243
244     if (*key == NULL || ivtmp == NULL || sq == NULL || pt == NULL)
245         goto err;
246
247     rec->data = rec->input = OPENSSL_malloc(ptlen + EVP_GCM_TLS_TAG_LEN);
248
249     if (rec->data == NULL)
250         goto err;
251
252     rec->length = ptlen;
253     memcpy(rec->data, pt, ptlen);
254     OPENSSL_free(pt);
255     memcpy(seq, sq, SEQ_NUM_SIZE);
256     OPENSSL_free(sq);
257     memcpy(iv, ivtmp, ivlen);
258     OPENSSL_free(ivtmp);
259
260     return 1;
261  err:
262     OPENSSL_free(*key);
263     *key = NULL;
264     OPENSSL_free(ivtmp);
265     OPENSSL_free(sq);
266     OPENSSL_free(pt);
267     return 0;
268 }
269
270 static int test_record(SSL3_RECORD *rec, RECORD_DATA *recd, int enc)
271 {
272     int ret = 0;
273     unsigned char *refd;
274     size_t refdatalen;
275
276     if (enc)
277         refd = multihexstr2buf(recd->ciphertext, &refdatalen);
278     else
279         refd = multihexstr2buf(recd->plaintext, &refdatalen);
280
281     if (!TEST_ptr(refd)) {
282         TEST_info("Failed to get reference data");
283         goto err;
284     }
285
286     if (!TEST_mem_eq(rec->data, rec->length, refd, refdatalen))
287         goto err;
288
289     ret = 1;
290
291  err:
292     OPENSSL_free(refd);
293     return ret;
294 }
295
296 #define TLS13_AES_128_GCM_SHA256_BYTES  ((const unsigned char *)"\x13\x01")
297
298 static int test_tls13_encryption(void)
299 {
300     SSL_CTX *ctx = NULL;
301     SSL *s = NULL;
302     SSL3_RECORD rec;
303     unsigned char *key = NULL, *iv = NULL, *seq = NULL;
304     const EVP_CIPHER *ciph = EVP_aes_128_gcm();
305     int ret = 0;
306     size_t ivlen, ctr;
307
308     rec.data = NULL;
309
310     ctx = SSL_CTX_new(TLS_method());
311     if (!TEST_ptr(ctx)) {
312         TEST_info("Failed creating SSL_CTX");
313         goto err;
314     }
315
316     s = SSL_new(ctx);
317     if (!TEST_ptr(s)) {
318         TEST_info("Failed creating SSL");
319         goto err;
320     }
321
322     s->enc_read_ctx = EVP_CIPHER_CTX_new();
323     if (!TEST_ptr(s->enc_read_ctx))
324         goto err;
325
326     s->enc_write_ctx = EVP_CIPHER_CTX_new();
327     if (!TEST_ptr(s->enc_write_ctx))
328         goto err;
329
330     s->s3->tmp.new_cipher = SSL_CIPHER_find(s, TLS13_AES_128_GCM_SHA256_BYTES);
331     if (!TEST_ptr(s->s3->tmp.new_cipher)) {
332         TEST_info("Failed to find cipher");
333         goto err;
334     }
335
336     for (ctr = 0; ctr < OSSL_NELEM(refdata); ctr++) {
337         /* Load the record */
338         ivlen = EVP_CIPHER_iv_length(ciph);
339         if (!load_record(&rec, &refdata[ctr], &key, s->read_iv, ivlen,
340                          RECORD_LAYER_get_read_sequence(&s->rlayer))) {
341             TEST_error("Failed loading key into EVP_CIPHER_CTX");
342             goto err;
343         }
344
345         /* Set up the read/write sequences */
346         memcpy(RECORD_LAYER_get_write_sequence(&s->rlayer),
347                RECORD_LAYER_get_read_sequence(&s->rlayer), SEQ_NUM_SIZE);
348         memcpy(s->write_iv, s->read_iv, ivlen);
349
350         /* Load the key into the EVP_CIPHER_CTXs */
351         if (EVP_CipherInit_ex(s->enc_write_ctx, ciph, NULL, key, NULL, 1) <= 0
352                 || EVP_CipherInit_ex(s->enc_read_ctx, ciph, NULL, key, NULL, 0)
353                    <= 0) {
354             TEST_error("Failed loading key into EVP_CIPHER_CTX\n");
355             goto err;
356         }
357
358         /* Encrypt it */
359         if (!TEST_size_t_eq(tls13_enc(s, &rec, 1, 1), 1)) {
360             TEST_info("Failed to encrypt record %zu", ctr);
361             goto err;
362         }
363         if (!TEST_true(test_record(&rec, &refdata[ctr], 1))) {
364             TEST_info("Record %zu encryption test failed", ctr);
365             goto err;
366         }
367
368         /* Decrypt it */
369         if (!TEST_int_eq(tls13_enc(s, &rec, 1, 0), 1)) {
370             TEST_info("Failed to decrypt record %zu", ctr);
371             goto err;
372         }
373         if (!TEST_true(test_record(&rec, &refdata[ctr], 0))) {
374             TEST_info("Record %zu decryption test failed", ctr);
375             goto err;
376         }
377
378         OPENSSL_free(rec.data);
379         OPENSSL_free(key);
380         OPENSSL_free(iv);
381         OPENSSL_free(seq);
382         rec.data = NULL;
383         key = NULL;
384         iv = NULL;
385         seq = NULL;
386     }
387
388     fprintf(stderr, "PASS: %"OSSLzu" records tested\n", ctr);
389     ret = 1;
390
391  err:
392     OPENSSL_free(rec.data);
393     OPENSSL_free(key);
394     OPENSSL_free(iv);
395     OPENSSL_free(seq);
396     SSL_free(s);
397     SSL_CTX_free(ctx);
398     return ret;
399 }
400
401 void register_tests(void)
402 {
403     ADD_TEST(test_tls13_encryption);
404 }