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