1045dd60ab2b316643f06a8fd1fffc7913f933a1
[openssl.git] / test / clienthellotest.c
1 /*
2  * Copyright 2015-2018 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 <string.h>
11
12 #include <openssl/opensslconf.h>
13 #include <openssl/bio.h>
14 #include <openssl/crypto.h>
15 #include <openssl/evp.h>
16 #include <openssl/ssl.h>
17 #include <openssl/err.h>
18 #include <time.h>
19
20 #include "../ssl/packet_locl.h"
21
22 #include "testutil.h"
23
24 #define CLIENT_VERSION_LEN      2
25
26 #define TOTAL_NUM_TESTS                         4
27
28 /*
29  * Test that explicitly setting ticket data results in it appearing in the
30  * ClientHello for a negotiated SSL/TLS version
31  */
32 #define TEST_SET_SESSION_TICK_DATA_VER_NEG      0
33 /* Enable padding and make sure ClientHello is long enough to require it */
34 #define TEST_ADD_PADDING                        1
35 /* Enable padding and make sure ClientHello is short enough to not need it */
36 #define TEST_PADDING_NOT_NEEDED                 2
37 /*
38  * Enable padding and add a PSK to the ClientHello (this will also ensure the
39  * ClientHello is long enough to need padding)
40  */
41 #define TEST_ADD_PADDING_AND_PSK                3
42
43 #define F5_WORKAROUND_MIN_MSG_LEN   0x7f
44 #define F5_WORKAROUND_MAX_MSG_LEN   0x200
45
46 static const char *sessionfile = NULL;
47 /* Dummy ALPN protocols used to pad out the size of the ClientHello */
48 static const char alpn_prots[] =
49     "0123456789012345678901234567890123456789012345678901234567890123456789"
50     "0123456789012345678901234567890123456789012345678901234567890123456789"
51     "01234567890123456789";
52
53 static int test_client_hello(int currtest)
54 {
55     SSL_CTX *ctx;
56     SSL *con = NULL;
57     BIO *rbio;
58     BIO *wbio;
59     long len;
60     unsigned char *data;
61     PACKET pkt = {0}, pkt2 = {0}, pkt3 = {0};
62     char *dummytick = "Hello World!";
63     unsigned int type = 0;
64     int testresult = 0;
65     size_t msglen;
66     BIO *sessbio = NULL;
67     SSL_SESSION *sess = NULL;
68
69 #ifdef OPENSSL_NO_TLS1_3
70     if (currtest == TEST_ADD_PADDING_AND_PSK)
71         return 1;
72 #endif
73
74     /*
75      * For each test set up an SSL_CTX and SSL and see what ClientHello gets
76      * produced when we try to connect
77      */
78     ctx = SSL_CTX_new(TLS_method());
79     if (!TEST_ptr(ctx))
80         goto end;
81     if (!TEST_true(SSL_CTX_set_max_proto_version(ctx, TLS_MAX_VERSION)))
82         goto end;
83
84     switch(currtest) {
85     case TEST_SET_SESSION_TICK_DATA_VER_NEG:
86 #if !defined(OPENSSL_NO_TLS1_3) && defined(OPENSSL_NO_TLS1_2)
87         /* TLSv1.3 is enabled and TLSv1.2 is disabled so can't do this test */
88         return 1;
89 #else
90         /* Testing for session tickets <= TLS1.2; not relevant for 1.3 */
91         if (!TEST_true(SSL_CTX_set_max_proto_version(ctx, TLS1_2_VERSION)))
92             goto end;
93 #endif
94         break;
95
96     case TEST_ADD_PADDING_AND_PSK:
97         /*
98          * In this case we're doing TLSv1.3 and we're sending a PSK so the
99          * ClientHello is already going to be quite long. To avoid getting one
100          * that is too long for this test we use a restricted ciphersuite list
101          */
102         if (!TEST_false(SSL_CTX_set_cipher_list(ctx, "")))
103             goto end;
104         ERR_clear_error();
105          /* Fall through */
106     case TEST_ADD_PADDING:
107     case TEST_PADDING_NOT_NEEDED:
108         SSL_CTX_set_options(ctx, SSL_OP_TLSEXT_PADDING);
109         /* Make sure we get a consistent size across TLS versions */
110         SSL_CTX_clear_options(ctx, SSL_OP_ENABLE_MIDDLEBOX_COMPAT);
111         /*
112          * Add some dummy ALPN protocols so that the ClientHello is at least
113          * F5_WORKAROUND_MIN_MSG_LEN bytes long - meaning padding will be
114          * needed.
115          */
116         if (currtest == TEST_ADD_PADDING) {
117              if (!TEST_false(SSL_CTX_set_alpn_protos(ctx,
118                                     (unsigned char *)alpn_prots,
119                                     sizeof(alpn_prots) - 1)))
120                 goto end;
121         /*
122          * Otherwise we need to make sure we have a small enough message to
123          * not need padding.
124          */
125         } else if (!TEST_true(SSL_CTX_set_cipher_list(ctx,
126                               "AES128-SHA"))
127                    || !TEST_true(SSL_CTX_set_ciphersuites(ctx,
128                                  "TLS_AES_128_GCM_SHA256"))) {
129             goto end;
130         }
131         break;
132
133     default:
134         goto end;
135     }
136
137     con = SSL_new(ctx);
138     if (!TEST_ptr(con))
139         goto end;
140
141     if (currtest == TEST_ADD_PADDING_AND_PSK) {
142         sessbio = BIO_new_file(sessionfile, "r");
143         if (!TEST_ptr(sessbio)) {
144             TEST_info("Unable to open session.pem");
145             goto end;
146         }
147         sess = PEM_read_bio_SSL_SESSION(sessbio, NULL, NULL, NULL);
148         if (!TEST_ptr(sess)) {
149             TEST_info("Unable to load SSL_SESSION");
150             goto end;
151         }
152         /*
153          * We reset the creation time so that we don't discard the session as
154          * too old.
155          */
156         if (!TEST_true(SSL_SESSION_set_time(sess, (long)time(NULL)))
157                 || !TEST_true(SSL_set_session(con, sess)))
158             goto end;
159     }
160
161     rbio = BIO_new(BIO_s_mem());
162     wbio = BIO_new(BIO_s_mem());
163     if (!TEST_ptr(rbio)|| !TEST_ptr(wbio)) {
164         BIO_free(rbio);
165         BIO_free(wbio);
166         goto end;
167     }
168
169     SSL_set_bio(con, rbio, wbio);
170     SSL_set_connect_state(con);
171
172     if (currtest == TEST_SET_SESSION_TICK_DATA_VER_NEG) {
173         if (!TEST_true(SSL_set_session_ticket_ext(con, dummytick,
174                                                   strlen(dummytick))))
175             goto end;
176     }
177
178     if (!TEST_int_le(SSL_connect(con), 0)) {
179         /* This shouldn't succeed because we don't have a server! */
180         goto end;
181     }
182
183     len = BIO_get_mem_data(wbio, (char **)&data);
184     if (!TEST_true(PACKET_buf_init(&pkt, data, len))
185                /* Skip the record header */
186             || !PACKET_forward(&pkt, SSL3_RT_HEADER_LENGTH))
187         goto end;
188
189     msglen = PACKET_remaining(&pkt);
190
191     /* Skip the handshake message header */
192     if (!TEST_true(PACKET_forward(&pkt, SSL3_HM_HEADER_LENGTH))
193                /* Skip client version and random */
194             || !TEST_true(PACKET_forward(&pkt, CLIENT_VERSION_LEN
195                                                + SSL3_RANDOM_SIZE))
196                /* Skip session id */
197             || !TEST_true(PACKET_get_length_prefixed_1(&pkt, &pkt2))
198                /* Skip ciphers */
199             || !TEST_true(PACKET_get_length_prefixed_2(&pkt, &pkt2))
200                /* Skip compression */
201             || !TEST_true(PACKET_get_length_prefixed_1(&pkt, &pkt2))
202                /* Extensions len */
203             || !TEST_true(PACKET_as_length_prefixed_2(&pkt, &pkt2)))
204         goto end;
205
206     /* Loop through all extensions */
207     while (PACKET_remaining(&pkt2)) {
208
209         if (!TEST_true(PACKET_get_net_2(&pkt2, &type))
210                 || !TEST_true(PACKET_get_length_prefixed_2(&pkt2, &pkt3)))
211             goto end;
212
213         if (type == TLSEXT_TYPE_session_ticket) {
214             if (currtest == TEST_SET_SESSION_TICK_DATA_VER_NEG) {
215                 if (TEST_true(PACKET_equal(&pkt3, dummytick,
216                                            strlen(dummytick)))) {
217                     /* Ticket data is as we expected */
218                     testresult = 1;
219                 }
220                 goto end;
221             }
222         }
223         if (type == TLSEXT_TYPE_padding) {
224             if (!TEST_false(currtest == TEST_PADDING_NOT_NEEDED))
225                 goto end;
226             else if (TEST_true(currtest == TEST_ADD_PADDING
227                     || currtest == TEST_ADD_PADDING_AND_PSK))
228                 testresult = TEST_true(msglen == F5_WORKAROUND_MAX_MSG_LEN);
229         }
230     }
231
232     if (currtest == TEST_PADDING_NOT_NEEDED)
233         testresult = 1;
234
235 end:
236     SSL_free(con);
237     SSL_CTX_free(ctx);
238     SSL_SESSION_free(sess);
239     BIO_free(sessbio);
240
241     return testresult;
242 }
243
244 int setup_tests(void)
245 {
246     if (!TEST_ptr(sessionfile = test_get_argument(0)))
247         return 0;
248
249     ADD_ALL_TESTS(test_client_hello, TOTAL_NUM_TESTS);
250     return 1;
251 }