b1067e842092c717ed504d2eecd1d4e549578a4b
[openssl.git] / test / ossl_shim / ossl_shim.cc
1 /*
2  * Copyright 1995-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 #if !defined(__STDC_FORMAT_MACROS)
11 #define __STDC_FORMAT_MACROS
12 #endif
13
14 #include "packeted_bio.h"
15 #include <openssl/e_os2.h>
16
17 #if !defined(OPENSSL_SYS_WINDOWS)
18 #include <arpa/inet.h>
19 #include <netinet/in.h>
20 #include <netinet/tcp.h>
21 #include <signal.h>
22 #include <sys/socket.h>
23 #include <sys/time.h>
24 #include <unistd.h>
25 #else
26 #include <io.h>
27 OPENSSL_MSVC_PRAGMA(warning(push, 3))
28 #include <winsock2.h>
29 #include <ws2tcpip.h>
30 OPENSSL_MSVC_PRAGMA(warning(pop))
31
32 OPENSSL_MSVC_PRAGMA(comment(lib, "Ws2_32.lib"))
33 #endif
34
35 #include <assert.h>
36 #include <inttypes.h>
37 #include <string.h>
38
39 #include <openssl/bio.h>
40 #include <openssl/buffer.h>
41 #include <openssl/bn.h>
42 #include <openssl/crypto.h>
43 #include <openssl/dh.h>
44 #include <openssl/err.h>
45 #include <openssl/evp.h>
46 #include <openssl/hmac.h>
47 #include <openssl/objects.h>
48 #include <openssl/rand.h>
49 #include <openssl/ssl.h>
50 #include <openssl/x509.h>
51
52 #include <memory>
53 #include <string>
54 #include <vector>
55
56 #include "async_bio.h"
57 #include "test_config.h"
58
59 namespace bssl {
60
61 #if !defined(OPENSSL_SYS_WINDOWS)
62 static int closesocket(int sock) {
63   return close(sock);
64 }
65
66 static void PrintSocketError(const char *func) {
67   perror(func);
68 }
69 #else
70 static void PrintSocketError(const char *func) {
71   fprintf(stderr, "%s: %d\n", func, WSAGetLastError());
72 }
73 #endif
74
75 static int Usage(const char *program) {
76   fprintf(stderr, "Usage: %s [flags...]\n", program);
77   return 1;
78 }
79
80 struct TestState {
81   // async_bio is async BIO which pauses reads and writes.
82   BIO *async_bio = nullptr;
83   // packeted_bio is the packeted BIO which simulates read timeouts.
84   BIO *packeted_bio = nullptr;
85   bool cert_ready = false;
86   bool handshake_done = false;
87   // private_key is the underlying private key used when testing custom keys.
88   bssl::UniquePtr<EVP_PKEY> private_key;
89   bool got_new_session = false;
90   bssl::UniquePtr<SSL_SESSION> new_session;
91   bool ticket_decrypt_done = false;
92   bool alpn_select_done = false;
93 };
94
95 static void TestStateExFree(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
96                             int index, long argl, void *argp) {
97   delete ((TestState *)ptr);
98 }
99
100 static int g_config_index = 0;
101 static int g_state_index = 0;
102
103 static bool SetTestConfig(SSL *ssl, const TestConfig *config) {
104   return SSL_set_ex_data(ssl, g_config_index, (void *)config) == 1;
105 }
106
107 static const TestConfig *GetTestConfig(const SSL *ssl) {
108   return (const TestConfig *)SSL_get_ex_data(ssl, g_config_index);
109 }
110
111 static bool SetTestState(SSL *ssl, std::unique_ptr<TestState> state) {
112   // |SSL_set_ex_data| takes ownership of |state| only on success.
113   if (SSL_set_ex_data(ssl, g_state_index, state.get()) == 1) {
114     state.release();
115     return true;
116   }
117   return false;
118 }
119
120 static TestState *GetTestState(const SSL *ssl) {
121   return (TestState *)SSL_get_ex_data(ssl, g_state_index);
122 }
123
124 static bssl::UniquePtr<X509> LoadCertificate(const std::string &file) {
125   bssl::UniquePtr<BIO> bio(BIO_new(BIO_s_file()));
126   if (!bio || !BIO_read_filename(bio.get(), file.c_str())) {
127     return nullptr;
128   }
129   return bssl::UniquePtr<X509>(PEM_read_bio_X509(bio.get(), NULL, NULL, NULL));
130 }
131
132 static bssl::UniquePtr<EVP_PKEY> LoadPrivateKey(const std::string &file) {
133   bssl::UniquePtr<BIO> bio(BIO_new(BIO_s_file()));
134   if (!bio || !BIO_read_filename(bio.get(), file.c_str())) {
135     return nullptr;
136   }
137   return bssl::UniquePtr<EVP_PKEY>(
138       PEM_read_bio_PrivateKey(bio.get(), NULL, NULL, NULL));
139 }
140
141 template<typename T>
142 struct Free {
143   void operator()(T *buf) {
144     free(buf);
145   }
146 };
147
148 static bool GetCertificate(SSL *ssl, bssl::UniquePtr<X509> *out_x509,
149                            bssl::UniquePtr<EVP_PKEY> *out_pkey) {
150   const TestConfig *config = GetTestConfig(ssl);
151
152   if (!config->key_file.empty()) {
153     *out_pkey = LoadPrivateKey(config->key_file.c_str());
154     if (!*out_pkey) {
155       return false;
156     }
157   }
158   if (!config->cert_file.empty()) {
159     *out_x509 = LoadCertificate(config->cert_file.c_str());
160     if (!*out_x509) {
161       return false;
162     }
163   }
164   return true;
165 }
166
167 static bool InstallCertificate(SSL *ssl) {
168   bssl::UniquePtr<X509> x509;
169   bssl::UniquePtr<EVP_PKEY> pkey;
170   if (!GetCertificate(ssl, &x509, &pkey)) {
171     return false;
172   }
173
174   if (pkey && !SSL_use_PrivateKey(ssl, pkey.get())) {
175     return false;
176   }
177
178   if (x509 && !SSL_use_certificate(ssl, x509.get())) {
179     return false;
180   }
181
182   return true;
183 }
184
185 static int ClientCertCallback(SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey) {
186   if (GetTestConfig(ssl)->async && !GetTestState(ssl)->cert_ready) {
187     return -1;
188   }
189
190   bssl::UniquePtr<X509> x509;
191   bssl::UniquePtr<EVP_PKEY> pkey;
192   if (!GetCertificate(ssl, &x509, &pkey)) {
193     return -1;
194   }
195
196   // Return zero for no certificate.
197   if (!x509) {
198     return 0;
199   }
200
201   // Asynchronous private keys are not supported with client_cert_cb.
202   *out_x509 = x509.release();
203   *out_pkey = pkey.release();
204   return 1;
205 }
206
207 static int VerifySucceed(X509_STORE_CTX *store_ctx, void *arg) {
208   return 1;
209 }
210
211 static int VerifyFail(X509_STORE_CTX *store_ctx, void *arg) {
212   X509_STORE_CTX_set_error(store_ctx, X509_V_ERR_APPLICATION_VERIFICATION);
213   return 0;
214 }
215
216 static int NextProtosAdvertisedCallback(SSL *ssl, const uint8_t **out,
217                                         unsigned int *out_len, void *arg) {
218   const TestConfig *config = GetTestConfig(ssl);
219   if (config->advertise_npn.empty()) {
220     return SSL_TLSEXT_ERR_NOACK;
221   }
222
223   *out = (const uint8_t*)config->advertise_npn.data();
224   *out_len = config->advertise_npn.size();
225   return SSL_TLSEXT_ERR_OK;
226 }
227
228 static int NextProtoSelectCallback(SSL* ssl, uint8_t** out, uint8_t* outlen,
229                                    const uint8_t* in, unsigned inlen, void* arg) {
230   const TestConfig *config = GetTestConfig(ssl);
231   if (config->select_next_proto.empty()) {
232     return SSL_TLSEXT_ERR_NOACK;
233   }
234
235   *out = (uint8_t*)config->select_next_proto.data();
236   *outlen = config->select_next_proto.size();
237   return SSL_TLSEXT_ERR_OK;
238 }
239
240 static int AlpnSelectCallback(SSL* ssl, const uint8_t** out, uint8_t* outlen,
241                               const uint8_t* in, unsigned inlen, void* arg) {
242   if (GetTestState(ssl)->alpn_select_done) {
243     fprintf(stderr, "AlpnSelectCallback called after completion.\n");
244     exit(1);
245   }
246
247   GetTestState(ssl)->alpn_select_done = true;
248
249   const TestConfig *config = GetTestConfig(ssl);
250   if (config->decline_alpn) {
251     return SSL_TLSEXT_ERR_NOACK;
252   }
253
254   if (!config->expected_advertised_alpn.empty() &&
255       (config->expected_advertised_alpn.size() != inlen ||
256        memcmp(config->expected_advertised_alpn.data(),
257               in, inlen) != 0)) {
258     fprintf(stderr, "bad ALPN select callback inputs\n");
259     exit(1);
260   }
261
262   *out = (const uint8_t*)config->select_alpn.data();
263   *outlen = config->select_alpn.size();
264   return SSL_TLSEXT_ERR_OK;
265 }
266
267 static unsigned PskClientCallback(SSL *ssl, const char *hint,
268                                   char *out_identity,
269                                   unsigned max_identity_len,
270                                   uint8_t *out_psk, unsigned max_psk_len) {
271   const TestConfig *config = GetTestConfig(ssl);
272
273   if (config->psk_identity.empty()) {
274     if (hint != nullptr) {
275       fprintf(stderr, "Server PSK hint was non-null.\n");
276       return 0;
277     }
278   } else if (hint == nullptr ||
279              strcmp(hint, config->psk_identity.c_str()) != 0) {
280     fprintf(stderr, "Server PSK hint did not match.\n");
281     return 0;
282   }
283
284   // Account for the trailing '\0' for the identity.
285   if (config->psk_identity.size() >= max_identity_len ||
286       config->psk.size() > max_psk_len) {
287     fprintf(stderr, "PSK buffers too small\n");
288     return 0;
289   }
290
291   BUF_strlcpy(out_identity, config->psk_identity.c_str(),
292               max_identity_len);
293   memcpy(out_psk, config->psk.data(), config->psk.size());
294   return config->psk.size();
295 }
296
297 static unsigned PskServerCallback(SSL *ssl, const char *identity,
298                                   uint8_t *out_psk, unsigned max_psk_len) {
299   const TestConfig *config = GetTestConfig(ssl);
300
301   if (strcmp(identity, config->psk_identity.c_str()) != 0) {
302     fprintf(stderr, "Client PSK identity did not match.\n");
303     return 0;
304   }
305
306   if (config->psk.size() > max_psk_len) {
307     fprintf(stderr, "PSK buffers too small\n");
308     return 0;
309   }
310
311   memcpy(out_psk, config->psk.data(), config->psk.size());
312   return config->psk.size();
313 }
314
315 static int CertCallback(SSL *ssl, void *arg) {
316   const TestConfig *config = GetTestConfig(ssl);
317
318   // Check the CertificateRequest metadata is as expected.
319   //
320   // TODO(davidben): Test |SSL_get_client_CA_list|.
321   if (!SSL_is_server(ssl) &&
322       !config->expected_certificate_types.empty()) {
323     const uint8_t *certificate_types;
324     size_t certificate_types_len =
325         SSL_get0_certificate_types(ssl, &certificate_types);
326     if (certificate_types_len != config->expected_certificate_types.size() ||
327         memcmp(certificate_types,
328                config->expected_certificate_types.data(),
329                certificate_types_len) != 0) {
330       fprintf(stderr, "certificate types mismatch\n");
331       return 0;
332     }
333   }
334
335   // The certificate will be installed via other means.
336   if (!config->async ||
337       config->use_old_client_cert_callback) {
338     return 1;
339   }
340
341   if (!GetTestState(ssl)->cert_ready) {
342     return -1;
343   }
344   if (!InstallCertificate(ssl)) {
345     return 0;
346   }
347   return 1;
348 }
349
350 static void InfoCallback(const SSL *ssl, int type, int val) {
351   if (type == SSL_CB_HANDSHAKE_DONE) {
352     if (GetTestConfig(ssl)->handshake_never_done) {
353       fprintf(stderr, "Handshake unexpectedly completed.\n");
354       // Abort before any expected error code is printed, to ensure the overall
355       // test fails.
356       abort();
357     }
358     GetTestState(ssl)->handshake_done = true;
359
360     // Callbacks may be called again on a new handshake.
361     GetTestState(ssl)->ticket_decrypt_done = false;
362     GetTestState(ssl)->alpn_select_done = false;
363   }
364 }
365
366 static int NewSessionCallback(SSL *ssl, SSL_SESSION *session) {
367   GetTestState(ssl)->got_new_session = true;
368   GetTestState(ssl)->new_session.reset(session);
369   return 1;
370 }
371
372 static int TicketKeyCallback(SSL *ssl, uint8_t *key_name, uint8_t *iv,
373                              EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
374                              int encrypt) {
375   if (!encrypt) {
376     if (GetTestState(ssl)->ticket_decrypt_done) {
377       fprintf(stderr, "TicketKeyCallback called after completion.\n");
378       return -1;
379     }
380
381     GetTestState(ssl)->ticket_decrypt_done = true;
382   }
383
384   // This is just test code, so use the all-zeros key.
385   static const uint8_t kZeros[16] = {0};
386
387   if (encrypt) {
388     memcpy(key_name, kZeros, sizeof(kZeros));
389     RAND_bytes(iv, 16);
390   } else if (memcmp(key_name, kZeros, 16) != 0) {
391     return 0;
392   }
393
394   if (!HMAC_Init_ex(hmac_ctx, kZeros, sizeof(kZeros), EVP_sha256(), NULL) ||
395       !EVP_CipherInit_ex(ctx, EVP_aes_128_cbc(), NULL, kZeros, iv, encrypt)) {
396     return -1;
397   }
398
399   if (!encrypt) {
400     return GetTestConfig(ssl)->renew_ticket ? 2 : 1;
401   }
402   return 1;
403 }
404
405 // kCustomExtensionValue is the extension value that the custom extension
406 // callbacks will add.
407 static const uint16_t kCustomExtensionValue = 1234;
408 static void *const kCustomExtensionAddArg =
409     reinterpret_cast<void *>(kCustomExtensionValue);
410 static void *const kCustomExtensionParseArg =
411     reinterpret_cast<void *>(kCustomExtensionValue + 1);
412 static const char kCustomExtensionContents[] = "custom extension";
413
414 static int CustomExtensionAddCallback(SSL *ssl, unsigned extension_value,
415                                       const uint8_t **out, size_t *out_len,
416                                       int *out_alert_value, void *add_arg) {
417   if (extension_value != kCustomExtensionValue ||
418       add_arg != kCustomExtensionAddArg) {
419     abort();
420   }
421
422   if (GetTestConfig(ssl)->custom_extension_skip) {
423     return 0;
424   }
425   if (GetTestConfig(ssl)->custom_extension_fail_add) {
426     return -1;
427   }
428
429   *out = reinterpret_cast<const uint8_t*>(kCustomExtensionContents);
430   *out_len = sizeof(kCustomExtensionContents) - 1;
431
432   return 1;
433 }
434
435 static void CustomExtensionFreeCallback(SSL *ssl, unsigned extension_value,
436                                         const uint8_t *out, void *add_arg) {
437   if (extension_value != kCustomExtensionValue ||
438       add_arg != kCustomExtensionAddArg ||
439       out != reinterpret_cast<const uint8_t *>(kCustomExtensionContents)) {
440     abort();
441   }
442 }
443
444 static int CustomExtensionParseCallback(SSL *ssl, unsigned extension_value,
445                                         const uint8_t *contents,
446                                         size_t contents_len,
447                                         int *out_alert_value, void *parse_arg) {
448   if (extension_value != kCustomExtensionValue ||
449       parse_arg != kCustomExtensionParseArg) {
450     abort();
451   }
452
453   if (contents_len != sizeof(kCustomExtensionContents) - 1 ||
454       memcmp(contents, kCustomExtensionContents, contents_len) != 0) {
455     *out_alert_value = SSL_AD_DECODE_ERROR;
456     return 0;
457   }
458
459   return 1;
460 }
461
462 // Connect returns a new socket connected to localhost on |port| or -1 on
463 // error.
464 static int Connect(uint16_t port) {
465   int sock = socket(AF_INET, SOCK_STREAM, 0);
466   if (sock == -1) {
467     PrintSocketError("socket");
468     return -1;
469   }
470   int nodelay = 1;
471   if (setsockopt(sock, IPPROTO_TCP, TCP_NODELAY,
472           reinterpret_cast<const char*>(&nodelay), sizeof(nodelay)) != 0) {
473     PrintSocketError("setsockopt");
474     closesocket(sock);
475     return -1;
476   }
477   sockaddr_in sin;
478   memset(&sin, 0, sizeof(sin));
479   sin.sin_family = AF_INET;
480   sin.sin_port = htons(port);
481   if (!inet_pton(AF_INET, "127.0.0.1", &sin.sin_addr)) {
482     PrintSocketError("inet_pton");
483     closesocket(sock);
484     return -1;
485   }
486   if (connect(sock, reinterpret_cast<const sockaddr*>(&sin),
487               sizeof(sin)) != 0) {
488     PrintSocketError("connect");
489     closesocket(sock);
490     return -1;
491   }
492   return sock;
493 }
494
495 class SocketCloser {
496  public:
497   explicit SocketCloser(int sock) : sock_(sock) {}
498   ~SocketCloser() {
499     // Half-close and drain the socket before releasing it. This seems to be
500     // necessary for graceful shutdown on Windows. It will also avoid write
501     // failures in the test runner.
502 #if defined(OPENSSL_SYS_WINDOWS)
503     shutdown(sock_, SD_SEND);
504 #else
505     shutdown(sock_, SHUT_WR);
506 #endif
507     while (true) {
508       char buf[1024];
509       if (recv(sock_, buf, sizeof(buf), 0) <= 0) {
510         break;
511       }
512     }
513     closesocket(sock_);
514   }
515
516  private:
517   const int sock_;
518 };
519
520 static bssl::UniquePtr<SSL_CTX> SetupCtx(const TestConfig *config) {
521   const char sess_id_ctx[] = "ossl_shim";
522   bssl::UniquePtr<SSL_CTX> ssl_ctx(SSL_CTX_new(
523       config->is_dtls ? DTLS_method() : TLS_method()));
524   if (!ssl_ctx) {
525     return nullptr;
526   }
527
528   SSL_CTX_set_security_level(ssl_ctx.get(), 0);
529 #if 0
530   /* Disabled for now until we have some TLS1.3 support */
531   // Enable TLS 1.3 for tests.
532   if (!config->is_dtls &&
533       !SSL_CTX_set_max_proto_version(ssl_ctx.get(), TLS1_3_VERSION)) {
534     return nullptr;
535   }
536 #else
537   /* Ensure we don't negotiate TLSv1.3 until we can handle it */
538   if (!config->is_dtls &&
539       !SSL_CTX_set_max_proto_version(ssl_ctx.get(), TLS1_2_VERSION)) {
540     return nullptr;
541   }
542 #endif
543
544   std::string cipher_list = "ALL";
545   if (!config->cipher.empty()) {
546     cipher_list = config->cipher;
547     SSL_CTX_set_options(ssl_ctx.get(), SSL_OP_CIPHER_SERVER_PREFERENCE);
548   }
549   if (!SSL_CTX_set_cipher_list(ssl_ctx.get(), cipher_list.c_str())) {
550     return nullptr;
551   }
552
553   DH *tmpdh;
554
555   if (config->use_sparse_dh_prime) {
556     BIGNUM *p, *g;
557     p = BN_new();
558     g = BN_new();
559     tmpdh = DH_new();
560     if (p == NULL || g == NULL || tmpdh == NULL) {
561         BN_free(p);
562         BN_free(g);
563         DH_free(tmpdh);
564         return nullptr;
565     }
566     // This prime number is 2^1024 + 643 – a value just above a power of two.
567     // Because of its form, values modulo it are essentially certain to be one
568     // byte shorter. This is used to test padding of these values.
569     if (BN_hex2bn(
570             &p,
571             "1000000000000000000000000000000000000000000000000000000000000000"
572             "0000000000000000000000000000000000000000000000000000000000000000"
573             "0000000000000000000000000000000000000000000000000000000000000000"
574             "0000000000000000000000000000000000000000000000000000000000000028"
575             "3") == 0 ||
576         !BN_set_word(g, 2)) {
577       BN_free(p);
578       BN_free(g);
579       DH_free(tmpdh);
580       return nullptr;
581     }
582     DH_set0_pqg(tmpdh, p, NULL, g);
583   } else {
584       tmpdh = DH_get_2048_256();
585   }
586
587   bssl::UniquePtr<DH> dh(tmpdh);
588
589   if (!dh || !SSL_CTX_set_tmp_dh(ssl_ctx.get(), dh.get())) {
590     return nullptr;
591   }
592
593   SSL_CTX_set_session_cache_mode(ssl_ctx.get(), SSL_SESS_CACHE_BOTH);
594
595   if (config->use_old_client_cert_callback) {
596     SSL_CTX_set_client_cert_cb(ssl_ctx.get(), ClientCertCallback);
597   }
598
599   SSL_CTX_set_npn_advertised_cb(
600       ssl_ctx.get(), NextProtosAdvertisedCallback, NULL);
601   if (!config->select_next_proto.empty()) {
602     SSL_CTX_set_next_proto_select_cb(ssl_ctx.get(), NextProtoSelectCallback,
603                                      NULL);
604   }
605
606   if (!config->select_alpn.empty() || config->decline_alpn) {
607     SSL_CTX_set_alpn_select_cb(ssl_ctx.get(), AlpnSelectCallback, NULL);
608   }
609
610   SSL_CTX_set_info_callback(ssl_ctx.get(), InfoCallback);
611   SSL_CTX_sess_set_new_cb(ssl_ctx.get(), NewSessionCallback);
612
613   if (config->use_ticket_callback) {
614     SSL_CTX_set_tlsext_ticket_key_cb(ssl_ctx.get(), TicketKeyCallback);
615   }
616
617   if (config->enable_client_custom_extension &&
618       !SSL_CTX_add_client_custom_ext(
619           ssl_ctx.get(), kCustomExtensionValue, CustomExtensionAddCallback,
620           CustomExtensionFreeCallback, kCustomExtensionAddArg,
621           CustomExtensionParseCallback, kCustomExtensionParseArg)) {
622     return nullptr;
623   }
624
625   if (config->enable_server_custom_extension &&
626       !SSL_CTX_add_server_custom_ext(
627           ssl_ctx.get(), kCustomExtensionValue, CustomExtensionAddCallback,
628           CustomExtensionFreeCallback, kCustomExtensionAddArg,
629           CustomExtensionParseCallback, kCustomExtensionParseArg)) {
630     return nullptr;
631   }
632
633   if (config->verify_fail) {
634     SSL_CTX_set_cert_verify_callback(ssl_ctx.get(), VerifyFail, NULL);
635   } else {
636     SSL_CTX_set_cert_verify_callback(ssl_ctx.get(), VerifySucceed, NULL);
637   }
638
639   if (config->use_null_client_ca_list) {
640     SSL_CTX_set_client_CA_list(ssl_ctx.get(), nullptr);
641   }
642
643   if (!SSL_CTX_set_session_id_context(ssl_ctx.get(),
644                                       (const unsigned char *)sess_id_ctx,
645                                       sizeof(sess_id_ctx) - 1))
646     return nullptr;
647
648   return ssl_ctx;
649 }
650
651 // RetryAsync is called after a failed operation on |ssl| with return code
652 // |ret|. If the operation should be retried, it simulates one asynchronous
653 // event and returns true. Otherwise it returns false.
654 static bool RetryAsync(SSL *ssl, int ret) {
655   // No error; don't retry.
656   if (ret >= 0) {
657     return false;
658   }
659
660   TestState *test_state = GetTestState(ssl);
661   assert(GetTestConfig(ssl)->async);
662
663   if (test_state->packeted_bio != nullptr &&
664       PacketedBioAdvanceClock(test_state->packeted_bio)) {
665     // The DTLS retransmit logic silently ignores write failures. So the test
666     // may progress, allow writes through synchronously.
667     AsyncBioEnforceWriteQuota(test_state->async_bio, false);
668     int timeout_ret = DTLSv1_handle_timeout(ssl);
669     AsyncBioEnforceWriteQuota(test_state->async_bio, true);
670
671     if (timeout_ret < 0) {
672       fprintf(stderr, "Error retransmitting.\n");
673       return false;
674     }
675     return true;
676   }
677
678   // See if we needed to read or write more. If so, allow one byte through on
679   // the appropriate end to maximally stress the state machine.
680   switch (SSL_get_error(ssl, ret)) {
681     case SSL_ERROR_WANT_READ:
682       AsyncBioAllowRead(test_state->async_bio, 1);
683       return true;
684     case SSL_ERROR_WANT_WRITE:
685       AsyncBioAllowWrite(test_state->async_bio, 1);
686       return true;
687     case SSL_ERROR_WANT_X509_LOOKUP:
688       test_state->cert_ready = true;
689       return true;
690     default:
691       return false;
692   }
693 }
694
695 // DoRead reads from |ssl|, resolving any asynchronous operations. It returns
696 // the result value of the final |SSL_read| call.
697 static int DoRead(SSL *ssl, uint8_t *out, size_t max_out) {
698   const TestConfig *config = GetTestConfig(ssl);
699   TestState *test_state = GetTestState(ssl);
700   int ret;
701   do {
702     if (config->async) {
703       // The DTLS retransmit logic silently ignores write failures. So the test
704       // may progress, allow writes through synchronously. |SSL_read| may
705       // trigger a retransmit, so disconnect the write quota.
706       AsyncBioEnforceWriteQuota(test_state->async_bio, false);
707     }
708     ret = config->peek_then_read ? SSL_peek(ssl, out, max_out)
709                                  : SSL_read(ssl, out, max_out);
710     if (config->async) {
711       AsyncBioEnforceWriteQuota(test_state->async_bio, true);
712     }
713   } while (config->async && RetryAsync(ssl, ret));
714
715   if (config->peek_then_read && ret > 0) {
716     std::unique_ptr<uint8_t[]> buf(new uint8_t[static_cast<size_t>(ret)]);
717
718     // SSL_peek should synchronously return the same data.
719     int ret2 = SSL_peek(ssl, buf.get(), ret);
720     if (ret2 != ret ||
721         memcmp(buf.get(), out, ret) != 0) {
722       fprintf(stderr, "First and second SSL_peek did not match.\n");
723       return -1;
724     }
725
726     // SSL_read should synchronously return the same data and consume it.
727     ret2 = SSL_read(ssl, buf.get(), ret);
728     if (ret2 != ret ||
729         memcmp(buf.get(), out, ret) != 0) {
730       fprintf(stderr, "SSL_peek and SSL_read did not match.\n");
731       return -1;
732     }
733   }
734
735   return ret;
736 }
737
738 // WriteAll writes |in_len| bytes from |in| to |ssl|, resolving any asynchronous
739 // operations. It returns the result of the final |SSL_write| call.
740 static int WriteAll(SSL *ssl, const uint8_t *in, size_t in_len) {
741   const TestConfig *config = GetTestConfig(ssl);
742   int ret;
743   do {
744     ret = SSL_write(ssl, in, in_len);
745     if (ret > 0) {
746       in += ret;
747       in_len -= ret;
748     }
749   } while ((config->async && RetryAsync(ssl, ret)) || (ret > 0 && in_len > 0));
750   return ret;
751 }
752
753 // DoShutdown calls |SSL_shutdown|, resolving any asynchronous operations. It
754 // returns the result of the final |SSL_shutdown| call.
755 static int DoShutdown(SSL *ssl) {
756   const TestConfig *config = GetTestConfig(ssl);
757   int ret;
758   do {
759     ret = SSL_shutdown(ssl);
760   } while (config->async && RetryAsync(ssl, ret));
761   return ret;
762 }
763
764 static uint16_t GetProtocolVersion(const SSL *ssl) {
765   uint16_t version = SSL_version(ssl);
766   if (!SSL_is_dtls(ssl)) {
767     return version;
768   }
769   return 0x0201 + ~version;
770 }
771
772 // CheckHandshakeProperties checks, immediately after |ssl| completes its
773 // initial handshake (or False Starts), whether all the properties are
774 // consistent with the test configuration and invariants.
775 static bool CheckHandshakeProperties(SSL *ssl, bool is_resume) {
776   const TestConfig *config = GetTestConfig(ssl);
777
778   if (SSL_get_current_cipher(ssl) == nullptr) {
779     fprintf(stderr, "null cipher after handshake\n");
780     return false;
781   }
782
783   if (is_resume &&
784       (!!SSL_session_reused(ssl) == config->expect_session_miss)) {
785     fprintf(stderr, "session was%s reused\n",
786             SSL_session_reused(ssl) ? "" : " not");
787     return false;
788   }
789
790   if (!GetTestState(ssl)->handshake_done) {
791     fprintf(stderr, "handshake was not completed\n");
792     return false;
793   }
794
795   if (!config->is_server) {
796     bool expect_new_session =
797         !config->expect_no_session &&
798         (!SSL_session_reused(ssl) || config->expect_ticket_renewal) &&
799         // Session tickets are sent post-handshake in TLS 1.3.
800         GetProtocolVersion(ssl) < TLS1_3_VERSION;
801     if (expect_new_session != GetTestState(ssl)->got_new_session) {
802       fprintf(stderr,
803               "new session was%s cached, but we expected the opposite\n",
804               GetTestState(ssl)->got_new_session ? "" : " not");
805       return false;
806     }
807   }
808
809   if (!config->expected_server_name.empty()) {
810     const char *server_name =
811         SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
812     if (server_name != config->expected_server_name) {
813       fprintf(stderr, "servername mismatch (got %s; want %s)\n",
814               server_name, config->expected_server_name.c_str());
815       return false;
816     }
817   }
818
819   if (!config->expected_next_proto.empty()) {
820     const uint8_t *next_proto;
821     unsigned next_proto_len;
822     SSL_get0_next_proto_negotiated(ssl, &next_proto, &next_proto_len);
823     if (next_proto_len != config->expected_next_proto.size() ||
824         memcmp(next_proto, config->expected_next_proto.data(),
825                next_proto_len) != 0) {
826       fprintf(stderr, "negotiated next proto mismatch\n");
827       return false;
828     }
829   }
830
831   if (!config->expected_alpn.empty()) {
832     const uint8_t *alpn_proto;
833     unsigned alpn_proto_len;
834     SSL_get0_alpn_selected(ssl, &alpn_proto, &alpn_proto_len);
835     if (alpn_proto_len != config->expected_alpn.size() ||
836         memcmp(alpn_proto, config->expected_alpn.data(),
837                alpn_proto_len) != 0) {
838       fprintf(stderr, "negotiated alpn proto mismatch\n");
839       return false;
840     }
841   }
842
843   if (config->expect_extended_master_secret) {
844     if (!SSL_get_extms_support(ssl)) {
845       fprintf(stderr, "No EMS for connection when expected");
846       return false;
847     }
848   }
849
850   if (config->expect_verify_result) {
851     int expected_verify_result = config->verify_fail ?
852       X509_V_ERR_APPLICATION_VERIFICATION :
853       X509_V_OK;
854
855     if (SSL_get_verify_result(ssl) != expected_verify_result) {
856       fprintf(stderr, "Wrong certificate verification result\n");
857       return false;
858     }
859   }
860
861   if (!config->psk.empty()) {
862     if (SSL_get_peer_cert_chain(ssl) != nullptr) {
863       fprintf(stderr, "Received peer certificate on a PSK cipher.\n");
864       return false;
865     }
866   } else if (!config->is_server || config->require_any_client_certificate) {
867     if (SSL_get_peer_certificate(ssl) == nullptr) {
868       fprintf(stderr, "Received no peer certificate but expected one.\n");
869       return false;
870     }
871   }
872
873   return true;
874 }
875
876 // DoExchange runs a test SSL exchange against the peer. On success, it returns
877 // true and sets |*out_session| to the negotiated SSL session. If the test is a
878 // resumption attempt, |is_resume| is true and |session| is the session from the
879 // previous exchange.
880 static bool DoExchange(bssl::UniquePtr<SSL_SESSION> *out_session,
881                        SSL_CTX *ssl_ctx, const TestConfig *config,
882                        bool is_resume, SSL_SESSION *session) {
883   bssl::UniquePtr<SSL> ssl(SSL_new(ssl_ctx));
884   if (!ssl) {
885     return false;
886   }
887
888   if (!SetTestConfig(ssl.get(), config) ||
889       !SetTestState(ssl.get(), std::unique_ptr<TestState>(new TestState))) {
890     return false;
891   }
892
893   if (config->fallback_scsv &&
894       !SSL_set_mode(ssl.get(), SSL_MODE_SEND_FALLBACK_SCSV)) {
895     return false;
896   }
897   // Install the certificate synchronously if nothing else will handle it.
898   if (!config->use_old_client_cert_callback &&
899       !config->async &&
900       !InstallCertificate(ssl.get())) {
901     return false;
902   }
903   SSL_set_cert_cb(ssl.get(), CertCallback, nullptr);
904   if (config->require_any_client_certificate) {
905     SSL_set_verify(ssl.get(), SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
906                    NULL);
907   }
908   if (config->verify_peer) {
909     SSL_set_verify(ssl.get(), SSL_VERIFY_PEER, NULL);
910   }
911   if (config->partial_write) {
912     SSL_set_mode(ssl.get(), SSL_MODE_ENABLE_PARTIAL_WRITE);
913   }
914   if (config->no_tls13) {
915     SSL_set_options(ssl.get(), SSL_OP_NO_TLSv1_3);
916   }
917   if (config->no_tls12) {
918     SSL_set_options(ssl.get(), SSL_OP_NO_TLSv1_2);
919   }
920   if (config->no_tls11) {
921     SSL_set_options(ssl.get(), SSL_OP_NO_TLSv1_1);
922   }
923   if (config->no_tls1) {
924     SSL_set_options(ssl.get(), SSL_OP_NO_TLSv1);
925   }
926   if (config->no_ssl3) {
927     SSL_set_options(ssl.get(), SSL_OP_NO_SSLv3);
928   }
929   if (!config->host_name.empty() &&
930       !SSL_set_tlsext_host_name(ssl.get(), config->host_name.c_str())) {
931     return false;
932   }
933   if (!config->advertise_alpn.empty() &&
934       SSL_set_alpn_protos(ssl.get(),
935                           (const uint8_t *)config->advertise_alpn.data(),
936                           config->advertise_alpn.size()) != 0) {
937     return false;
938   }
939   if (!config->psk.empty()) {
940     SSL_set_psk_client_callback(ssl.get(), PskClientCallback);
941     SSL_set_psk_server_callback(ssl.get(), PskServerCallback);
942   }
943   if (!config->psk_identity.empty() &&
944       !SSL_use_psk_identity_hint(ssl.get(), config->psk_identity.c_str())) {
945     return false;
946   }
947   if (!config->srtp_profiles.empty() &&
948       SSL_set_tlsext_use_srtp(ssl.get(), config->srtp_profiles.c_str())) {
949     return false;
950   }
951   if (config->min_version != 0 &&
952       !SSL_set_min_proto_version(ssl.get(), (uint16_t)config->min_version)) {
953     return false;
954   }
955   if (config->max_version != 0 &&
956       !SSL_set_max_proto_version(ssl.get(), (uint16_t)config->max_version)) {
957     return false;
958   }
959   if (config->mtu != 0) {
960     SSL_set_options(ssl.get(), SSL_OP_NO_QUERY_MTU);
961     SSL_set_mtu(ssl.get(), config->mtu);
962   }
963   if (config->renegotiate_freely) {
964     // This is always on for OpenSSL.
965   }
966   if (!config->check_close_notify) {
967     SSL_set_quiet_shutdown(ssl.get(), 1);
968   }
969   if (config->p384_only) {
970     int nid = NID_secp384r1;
971     if (!SSL_set1_curves(ssl.get(), &nid, 1)) {
972       return false;
973     }
974   }
975   if (config->enable_all_curves) {
976     static const int kAllCurves[] = {
977       NID_X25519, NID_X9_62_prime256v1, NID_X448, NID_secp521r1, NID_secp384r1
978     };
979     if (!SSL_set1_curves(ssl.get(), kAllCurves,
980                          OPENSSL_ARRAY_SIZE(kAllCurves))) {
981       return false;
982     }
983   }
984   if (config->max_cert_list > 0) {
985     SSL_set_max_cert_list(ssl.get(), config->max_cert_list);
986   }
987
988   if (!config->async) {
989     SSL_set_mode(ssl.get(), SSL_MODE_AUTO_RETRY);
990   }
991
992   int sock = Connect(config->port);
993   if (sock == -1) {
994     return false;
995   }
996   SocketCloser closer(sock);
997
998   bssl::UniquePtr<BIO> bio(BIO_new_socket(sock, BIO_NOCLOSE));
999   if (!bio) {
1000     return false;
1001   }
1002   if (config->is_dtls) {
1003     bssl::UniquePtr<BIO> packeted = PacketedBioCreate(!config->async);
1004     if (!packeted) {
1005       return false;
1006     }
1007     GetTestState(ssl.get())->packeted_bio = packeted.get();
1008     BIO_push(packeted.get(), bio.release());
1009     bio = std::move(packeted);
1010   }
1011   if (config->async) {
1012     bssl::UniquePtr<BIO> async_scoped =
1013         config->is_dtls ? AsyncBioCreateDatagram() : AsyncBioCreate();
1014     if (!async_scoped) {
1015       return false;
1016     }
1017     BIO_push(async_scoped.get(), bio.release());
1018     GetTestState(ssl.get())->async_bio = async_scoped.get();
1019     bio = std::move(async_scoped);
1020   }
1021   SSL_set_bio(ssl.get(), bio.get(), bio.get());
1022   bio.release();  // SSL_set_bio takes ownership.
1023
1024   if (session != NULL) {
1025     if (!config->is_server) {
1026       if (SSL_set_session(ssl.get(), session) != 1) {
1027         return false;
1028       }
1029     }
1030   }
1031
1032 #if 0
1033   // KNOWN BUG: OpenSSL's SSL_get_current_cipher behaves incorrectly when
1034   // offering resumption.
1035   if (SSL_get_current_cipher(ssl.get()) != nullptr) {
1036     fprintf(stderr, "non-null cipher before handshake\n");
1037     return false;
1038   }
1039 #endif
1040
1041   int ret;
1042   if (config->implicit_handshake) {
1043     if (config->is_server) {
1044       SSL_set_accept_state(ssl.get());
1045     } else {
1046       SSL_set_connect_state(ssl.get());
1047     }
1048   } else {
1049     do {
1050       if (config->is_server) {
1051         ret = SSL_accept(ssl.get());
1052       } else {
1053         ret = SSL_connect(ssl.get());
1054       }
1055     } while (config->async && RetryAsync(ssl.get(), ret));
1056     if (ret != 1 ||
1057         !CheckHandshakeProperties(ssl.get(), is_resume)) {
1058       return false;
1059     }
1060
1061     // Reset the state to assert later that the callback isn't called in
1062     // renegotiations.
1063     GetTestState(ssl.get())->got_new_session = false;
1064   }
1065
1066   if (config->export_keying_material > 0) {
1067     std::vector<uint8_t> result(
1068         static_cast<size_t>(config->export_keying_material));
1069     if (SSL_export_keying_material(
1070             ssl.get(), result.data(), result.size(),
1071             config->export_label.data(), config->export_label.size(),
1072             reinterpret_cast<const uint8_t*>(config->export_context.data()),
1073             config->export_context.size(), config->use_export_context) != 1) {
1074       fprintf(stderr, "failed to export keying material\n");
1075       return false;
1076     }
1077     if (WriteAll(ssl.get(), result.data(), result.size()) < 0) {
1078       return false;
1079     }
1080   }
1081
1082   if (config->write_different_record_sizes) {
1083     if (config->is_dtls) {
1084       fprintf(stderr, "write_different_record_sizes not supported for DTLS\n");
1085       return false;
1086     }
1087     // This mode writes a number of different record sizes in an attempt to
1088     // trip up the CBC record splitting code.
1089     static const size_t kBufLen = 32769;
1090     std::unique_ptr<uint8_t[]> buf(new uint8_t[kBufLen]);
1091     memset(buf.get(), 0x42, kBufLen);
1092     static const size_t kRecordSizes[] = {
1093         0, 1, 255, 256, 257, 16383, 16384, 16385, 32767, 32768, 32769};
1094     for (size_t i = 0; i < OPENSSL_ARRAY_SIZE(kRecordSizes); i++) {
1095       const size_t len = kRecordSizes[i];
1096       if (len > kBufLen) {
1097         fprintf(stderr, "Bad kRecordSizes value.\n");
1098         return false;
1099       }
1100       if (WriteAll(ssl.get(), buf.get(), len) < 0) {
1101         return false;
1102       }
1103     }
1104   } else {
1105     if (config->shim_writes_first) {
1106       if (WriteAll(ssl.get(), reinterpret_cast<const uint8_t *>("hello"),
1107                    5) < 0) {
1108         return false;
1109       }
1110     }
1111     if (!config->shim_shuts_down) {
1112       for (;;) {
1113         static const size_t kBufLen = 16384;
1114         std::unique_ptr<uint8_t[]> buf(new uint8_t[kBufLen]);
1115
1116         // Read only 512 bytes at a time in TLS to ensure records may be
1117         // returned in multiple reads.
1118         int n = DoRead(ssl.get(), buf.get(), config->is_dtls ? kBufLen : 512);
1119         int err = SSL_get_error(ssl.get(), n);
1120         if (err == SSL_ERROR_ZERO_RETURN ||
1121             (n == 0 && err == SSL_ERROR_SYSCALL)) {
1122           if (n != 0) {
1123             fprintf(stderr, "Invalid SSL_get_error output\n");
1124             return false;
1125           }
1126           // Stop on either clean or unclean shutdown.
1127           break;
1128         } else if (err != SSL_ERROR_NONE) {
1129           if (n > 0) {
1130             fprintf(stderr, "Invalid SSL_get_error output\n");
1131             return false;
1132           }
1133           return false;
1134         }
1135         // Successfully read data.
1136         if (n <= 0) {
1137           fprintf(stderr, "Invalid SSL_get_error output\n");
1138           return false;
1139         }
1140
1141         // After a successful read, with or without False Start, the handshake
1142         // must be complete.
1143         if (!GetTestState(ssl.get())->handshake_done) {
1144           fprintf(stderr, "handshake was not completed after SSL_read\n");
1145           return false;
1146         }
1147
1148         for (int i = 0; i < n; i++) {
1149           buf[i] ^= 0xff;
1150         }
1151         if (WriteAll(ssl.get(), buf.get(), n) < 0) {
1152           return false;
1153         }
1154       }
1155     }
1156   }
1157
1158   if (!config->is_server &&
1159       !config->implicit_handshake &&
1160       // Session tickets are sent post-handshake in TLS 1.3.
1161       GetProtocolVersion(ssl.get()) < TLS1_3_VERSION &&
1162       GetTestState(ssl.get())->got_new_session) {
1163     fprintf(stderr, "new session was established after the handshake\n");
1164     return false;
1165   }
1166
1167   if (GetProtocolVersion(ssl.get()) >= TLS1_3_VERSION && !config->is_server) {
1168     bool expect_new_session =
1169         !config->expect_no_session && !config->shim_shuts_down;
1170     if (expect_new_session != GetTestState(ssl.get())->got_new_session) {
1171       fprintf(stderr,
1172               "new session was%s cached, but we expected the opposite\n",
1173               GetTestState(ssl.get())->got_new_session ? "" : " not");
1174       return false;
1175     }
1176   }
1177
1178   if (out_session) {
1179     *out_session = std::move(GetTestState(ssl.get())->new_session);
1180   }
1181
1182   ret = DoShutdown(ssl.get());
1183
1184   if (config->shim_shuts_down && config->check_close_notify) {
1185     // We initiate shutdown, so |SSL_shutdown| will return in two stages. First
1186     // it returns zero when our close_notify is sent, then one when the peer's
1187     // is received.
1188     if (ret != 0) {
1189       fprintf(stderr, "Unexpected SSL_shutdown result: %d != 0\n", ret);
1190       return false;
1191     }
1192     ret = DoShutdown(ssl.get());
1193   }
1194
1195   if (ret != 1) {
1196     fprintf(stderr, "Unexpected SSL_shutdown result: %d != 1\n", ret);
1197     return false;
1198   }
1199
1200   if (SSL_total_renegotiations(ssl.get()) !=
1201       config->expect_total_renegotiations) {
1202     fprintf(stderr, "Expected %d renegotiations, got %ld\n",
1203             config->expect_total_renegotiations,
1204             SSL_total_renegotiations(ssl.get()));
1205     return false;
1206   }
1207
1208   return true;
1209 }
1210
1211 class StderrDelimiter {
1212  public:
1213   ~StderrDelimiter() { fprintf(stderr, "--- DONE ---\n"); }
1214 };
1215
1216 static int Main(int argc, char **argv) {
1217   // To distinguish ASan's output from ours, add a trailing message to stderr.
1218   // Anything following this line will be considered an error.
1219   StderrDelimiter delimiter;
1220
1221 #if defined(OPENSSL_SYS_WINDOWS)
1222   /* Initialize Winsock. */
1223   WORD wsa_version = MAKEWORD(2, 2);
1224   WSADATA wsa_data;
1225   int wsa_err = WSAStartup(wsa_version, &wsa_data);
1226   if (wsa_err != 0) {
1227     fprintf(stderr, "WSAStartup failed: %d\n", wsa_err);
1228     return 1;
1229   }
1230   if (wsa_data.wVersion != wsa_version) {
1231     fprintf(stderr, "Didn't get expected version: %x\n", wsa_data.wVersion);
1232     return 1;
1233   }
1234 #else
1235   signal(SIGPIPE, SIG_IGN);
1236 #endif
1237
1238   OPENSSL_init_crypto(0, NULL);
1239   OPENSSL_init_ssl(0, NULL);
1240   g_config_index = SSL_get_ex_new_index(0, NULL, NULL, NULL, NULL);
1241   g_state_index = SSL_get_ex_new_index(0, NULL, NULL, NULL, TestStateExFree);
1242   if (g_config_index < 0 || g_state_index < 0) {
1243     return 1;
1244   }
1245
1246   TestConfig config;
1247   if (!ParseConfig(argc - 1, argv + 1, &config)) {
1248     return Usage(argv[0]);
1249   }
1250
1251   bssl::UniquePtr<SSL_CTX> ssl_ctx = SetupCtx(&config);
1252   if (!ssl_ctx) {
1253     ERR_print_errors_fp(stderr);
1254     return 1;
1255   }
1256
1257   bssl::UniquePtr<SSL_SESSION> session;
1258   for (int i = 0; i < config.resume_count + 1; i++) {
1259     bool is_resume = i > 0;
1260     if (is_resume && !config.is_server && !session) {
1261       fprintf(stderr, "No session to offer.\n");
1262       return 1;
1263     }
1264
1265     bssl::UniquePtr<SSL_SESSION> offer_session = std::move(session);
1266     if (!DoExchange(&session, ssl_ctx.get(), &config, is_resume,
1267                     offer_session.get())) {
1268       fprintf(stderr, "Connection %d failed.\n", i + 1);
1269       ERR_print_errors_fp(stderr);
1270       return 1;
1271     }
1272   }
1273
1274   return 0;
1275 }
1276
1277 }  // namespace bssl
1278
1279 int main(int argc, char **argv) {
1280   return bssl::Main(argc, argv);
1281 }