folly/io/async/AsyncSSLSocket.cpp

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <folly/io/async/AsyncSSLSocket.h>
  18
  19 #include <folly/io/async/EventBase.h>
  20 #include <folly/portability/Sockets.h>
  21
  22 #include <boost/noncopyable.hpp>
  23 #include <errno.h>
  24 #include <fcntl.h>
  25 #include <openssl/err.h>
  26 #include <openssl/asn1.h>
  27 #include <openssl/ssl.h>
  28 #include <sys/types.h>
  29 #include <chrono>
  30
  31 #include <folly/Bits.h>
  32 #include <folly/SocketAddress.h>
  33 #include <folly/SpinLock.h>
  34 #include <folly/io/Cursor.h>
  35 #include <folly/io/IOBuf.h>
  36 #include <folly/portability/OpenSSL.h>
  37 #include <folly/portability/Unistd.h>
  38
  39 using folly::SocketAddress;
  40 using folly::SSLContext;
  41 using std::string;
  42 using std::shared_ptr;
  43
  44 using folly::Endian;
  45 using folly::IOBuf;
  46 using folly::SpinLock;
  47 using folly::SpinLockGuard;
  48 using folly::io::Cursor;
  49 using std::unique_ptr;
  50 using std::bind;
  51
  52 namespace {
  53 using folly::AsyncSocket;
  54 using folly::AsyncSocketException;
  55 using folly::AsyncSSLSocket;
  56 using folly::Optional;
  57 using folly::SSLContext;
  58 // For OpenSSL portability API
  59 using namespace folly::ssl;
  60 using folly::ssl::OpenSSLUtils;
  61
  62 // We have one single dummy SSL context so that we can implement attach
  63 // and detach methods in a thread safe fashion without modifying opnessl.
  64 static SSLContext *dummyCtx = nullptr;
  65 static SpinLock dummyCtxLock;
  66
  67 // If given min write size is less than this, buffer will be allocated on
  68 // stack, otherwise it is allocated on heap
  69 const size_t MAX_STACK_BUF_SIZE = 2048;
  70
  71 // This converts "illegal" shutdowns into ZERO_RETURN
  72 inline bool zero_return(int error, int rc) {
  73   return (error == SSL_ERROR_ZERO_RETURN || (rc == 0 && errno == 0));
  74 }
  75
  76 class AsyncSSLSocketConnector: public AsyncSocket::ConnectCallback,
  77                                 public AsyncSSLSocket::HandshakeCB {
  78
  79  private:
  80   AsyncSSLSocket *sslSocket_;
  81   AsyncSSLSocket::ConnectCallback *callback_;
  82   int timeout_;
  83   int64_t startTime_;
  84
  85  protected:
  86   ~AsyncSSLSocketConnector() override {}
  87
  88  public:
  89   AsyncSSLSocketConnector(AsyncSSLSocket *sslSocket,
  90                            AsyncSocket::ConnectCallback *callback,
  91                            int timeout) :
  92       sslSocket_(sslSocket),
  93       callback_(callback),
  94       timeout_(timeout),
  95       startTime_(std::chrono::duration_cast<std::chrono::milliseconds>(
  96                    std::chrono::steady_clock::now().time_since_epoch()).count()) {
  97   }
  98
  99   void connectSuccess() noexcept override {
 100     VLOG(7) << "client socket connected";
 101
 102     int64_t timeoutLeft = 0;
 103     if (timeout_ > 0) {
 104       auto curTime = std::chrono::duration_cast<std::chrono::milliseconds>(
 105         std::chrono::steady_clock::now().time_since_epoch()).count();
 106
 107       timeoutLeft = timeout_ - (curTime - startTime_);
 108       if (timeoutLeft <= 0) {
 109         AsyncSocketException ex(
 110             AsyncSocketException::TIMED_OUT,
 111             folly::sformat("SSL connect timed out after {}ms", timeout_));
 112         fail(ex);
 113         delete this;
 114         return;
 115       }
 116     }
 117     sslSocket_->sslConn(this, std::chrono::milliseconds(timeoutLeft));
 118   }
 119
 120   void connectErr(const AsyncSocketException& ex) noexcept override {
 121     VLOG(1) << "TCP connect failed: " << ex.what();
 122     fail(ex);
 123     delete this;
 124   }
 125
 126   void handshakeSuc(AsyncSSLSocket* /* sock */) noexcept override {
 127     VLOG(7) << "client handshake success";
 128     if (callback_) {
 129       callback_->connectSuccess();
 130     }
 131     delete this;
 132   }
 133
 134   void handshakeErr(AsyncSSLSocket* /* socket */,
 135                     const AsyncSocketException& ex) noexcept override {
 136     VLOG(1) << "client handshakeErr: " << ex.what();
 137     fail(ex);
 138     delete this;
 139   }
 140
 141   void fail(const AsyncSocketException &ex) {
 142     // fail is a noop if called twice
 143     if (callback_) {
 144       AsyncSSLSocket::ConnectCallback *cb = callback_;
 145       callback_ = nullptr;
 146
 147       cb->connectErr(ex);
 148       sslSocket_->closeNow();
 149       // closeNow can call handshakeErr if it hasn't been called already.
 150       // So this may have been deleted, no member variable access beyond this
 151       // point
 152       // Note that closeNow may invoke writeError callbacks if the socket had
 153       // write data pending connection completion.
 154     }
 155   }
 156 };
 157
 158 void setup_SSL_CTX(SSL_CTX *ctx) {
 159 #ifdef SSL_MODE_RELEASE_BUFFERS
 160   SSL_CTX_set_mode(ctx,
 161                    SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER |
 162                    SSL_MODE_ENABLE_PARTIAL_WRITE
 163                    | SSL_MODE_RELEASE_BUFFERS
 164                    );
 165 #else
 166   SSL_CTX_set_mode(ctx,
 167                    SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER |
 168                    SSL_MODE_ENABLE_PARTIAL_WRITE
 169                    );
 170 #endif
 171 // SSL_CTX_set_mode is a Macro
 172 #ifdef SSL_MODE_WRITE_IOVEC
 173   SSL_CTX_set_mode(ctx,
 174                    SSL_CTX_get_mode(ctx)
 175                    | SSL_MODE_WRITE_IOVEC);
 176 #endif
 177
 178 }
 179
 180 BIO_METHOD sslBioMethod;
 181
 182 void* initsslBioMethod(void) {
 183   memcpy(&sslBioMethod, BIO_s_socket(), sizeof(sslBioMethod));
 184   // override the bwrite method for MSG_EOR support
 185   OpenSSLUtils::setCustomBioWriteMethod(
 186       &sslBioMethod, AsyncSSLSocket::bioWrite);
 187   OpenSSLUtils::setCustomBioReadMethod(&sslBioMethod, AsyncSSLSocket::bioRead);
 188
 189   // Note that the sslBioMethod.type and sslBioMethod.name are not
 190   // set here. openssl code seems to be checking ".type == BIO_TYPE_SOCKET" and
 191   // then have specific handlings. The sslWriteBioWrite should be compatible
 192   // with the one in openssl.
 193
 194   // Return something here to enable AsyncSSLSocket to call this method using
 195   // a function-scoped static.
 196   return nullptr;
 197 }
 198
 199 } // anonymous namespace
 200
 201 namespace folly {
 202
 203 /**
 204  * Create a client AsyncSSLSocket
 205  */
 206 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext> &ctx,
 207                                EventBase* evb, bool deferSecurityNegotiation) :
 208     AsyncSocket(evb),
 209     ctx_(ctx),
 210     handshakeTimeout_(this, evb),
 211     connectionTimeout_(this, evb) {
 212   init();
 213   if (deferSecurityNegotiation) {
 214     sslState_ = STATE_UNENCRYPTED;
 215   }
 216 }
 217
 218 /**
 219  * Create a server/client AsyncSSLSocket
 220  */
 221 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext>& ctx,
 222                                EventBase* evb, int fd, bool server,
 223                                bool deferSecurityNegotiation) :
 224     AsyncSocket(evb, fd),
 225     server_(server),
 226     ctx_(ctx),
 227     handshakeTimeout_(this, evb),
 228     connectionTimeout_(this, evb) {
 229   noTransparentTls_ = true;
 230   init();
 231   if (server) {
 232     SSL_CTX_set_info_callback(ctx_->getSSLCtx(),
 233                               AsyncSSLSocket::sslInfoCallback);
 234   }
 235   if (deferSecurityNegotiation) {
 236     sslState_ = STATE_UNENCRYPTED;
 237   }
 238 }
 239
 240 #if FOLLY_OPENSSL_HAS_SNI
 241 /**
 242  * Create a client AsyncSSLSocket and allow tlsext_hostname
 243  * to be sent in Client Hello.
 244  */
 245 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext> &ctx,
 246                                  EventBase* evb,
 247                                const std::string& serverName,
 248                                bool deferSecurityNegotiation) :
 249     AsyncSSLSocket(ctx, evb, deferSecurityNegotiation) {
 250   tlsextHostname_ = serverName;
 251 }
 252
 253 /**
 254  * Create a client AsyncSSLSocket from an already connected fd
 255  * and allow tlsext_hostname to be sent in Client Hello.
 256  */
 257 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext>& ctx,
 258                                  EventBase* evb, int fd,
 259                                const std::string& serverName,
 260                                bool deferSecurityNegotiation) :
 261     AsyncSSLSocket(ctx, evb, fd, false, deferSecurityNegotiation) {
 262   tlsextHostname_ = serverName;
 263 }
 264 #endif // FOLLY_OPENSSL_HAS_SNI
 265
 266 AsyncSSLSocket::~AsyncSSLSocket() {
 267   VLOG(3) << "actual destruction of AsyncSSLSocket(this=" << this
 268           << ", evb=" << eventBase_ << ", fd=" << fd_
 269           << ", state=" << int(state_) << ", sslState="
 270           << sslState_ << ", events=" << eventFlags_ << ")";
 271 }
 272
 273 void AsyncSSLSocket::init() {
 274   // Do this here to ensure we initialize this once before any use of
 275   // AsyncSSLSocket instances and not as part of library load.
 276   static const auto sslBioMethodInitializer = initsslBioMethod();
 277   (void)sslBioMethodInitializer;
 278
 279   setup_SSL_CTX(ctx_->getSSLCtx());
 280 }
 281
 282 void AsyncSSLSocket::closeNow() {
 283   // Close the SSL connection.
 284   if (ssl_ != nullptr && fd_ != -1) {
 285     int rc = SSL_shutdown(ssl_);
 286     if (rc == 0) {
 287       rc = SSL_shutdown(ssl_);
 288     }
 289     if (rc < 0) {
 290       ERR_clear_error();
 291     }
 292   }
 293
 294   if (sslSession_ != nullptr) {
 295     SSL_SESSION_free(sslSession_);
 296     sslSession_ = nullptr;
 297   }
 298
 299   sslState_ = STATE_CLOSED;
 300
 301   if (handshakeTimeout_.isScheduled()) {
 302     handshakeTimeout_.cancelTimeout();
 303   }
 304
 305   DestructorGuard dg(this);
 306
 307   invokeHandshakeErr(
 308       AsyncSocketException(
 309         AsyncSocketException::END_OF_FILE,
 310         "SSL connection closed locally"));
 311
 312   if (ssl_ != nullptr) {
 313     SSL_free(ssl_);
 314     ssl_ = nullptr;
 315   }
 316
 317   // Close the socket.
 318   AsyncSocket::closeNow();
 319 }
 320
 321 void AsyncSSLSocket::shutdownWrite() {
 322   // SSL sockets do not support half-shutdown, so just perform a full shutdown.
 323   //
 324   // (Performing a full shutdown here is more desirable than doing nothing at
 325   // all.  The purpose of shutdownWrite() is normally to notify the other end
 326   // of the connection that no more data will be sent.  If we do nothing, the
 327   // other end will never know that no more data is coming, and this may result
 328   // in protocol deadlock.)
 329   close();
 330 }
 331
 332 void AsyncSSLSocket::shutdownWriteNow() {
 333   closeNow();
 334 }
 335
 336 bool AsyncSSLSocket::good() const {
 337   return (AsyncSocket::good() &&
 338           (sslState_ == STATE_ACCEPTING || sslState_ == STATE_CONNECTING ||
 339            sslState_ == STATE_ESTABLISHED || sslState_ == STATE_UNENCRYPTED));
 340 }
 341
 342 // The TAsyncTransport definition of 'good' states that the transport is
 343 // ready to perform reads and writes, so sslState_ == UNINIT must report !good.
 344 // connecting can be true when the sslState_ == UNINIT because the AsyncSocket
 345 // is connected but we haven't initiated the call to SSL_connect.
 346 bool AsyncSSLSocket::connecting() const {
 347   return (!server_ &&
 348           (AsyncSocket::connecting() ||
 349            (AsyncSocket::good() && (sslState_ == STATE_UNINIT ||
 350                                      sslState_ == STATE_CONNECTING))));
 351 }
 352
 353 std::string AsyncSSLSocket::getApplicationProtocol() noexcept {
 354   const unsigned char* protoName = nullptr;
 355   unsigned protoLength;
 356   if (getSelectedNextProtocolNoThrow(&protoName, &protoLength)) {
 357     return std::string(reinterpret_cast<const char*>(protoName), protoLength);
 358   }
 359   return "";
 360 }
 361
 362 void AsyncSSLSocket::setEorTracking(bool track) {
 363   if (isEorTrackingEnabled() != track) {
 364     AsyncSocket::setEorTracking(track);
 365     appEorByteNo_ = 0;
 366     minEorRawByteNo_ = 0;
 367   }
 368 }
 369
 370 size_t AsyncSSLSocket::getRawBytesWritten() const {
 371   // The bio(s) in the write path are in a chain
 372   // each bio flushes to the next and finally written into the socket
 373   // to get the rawBytesWritten on the socket,
 374   // get the write bytes of the last bio
 375   BIO *b;
 376   if (!ssl_ || !(b = SSL_get_wbio(ssl_))) {
 377     return 0;
 378   }
 379   BIO* next = BIO_next(b);
 380   while (next != NULL) {
 381     b = next;
 382     next = BIO_next(b);
 383   }
 384
 385   return BIO_number_written(b);
 386 }
 387
 388 size_t AsyncSSLSocket::getRawBytesReceived() const {
 389   BIO *b;
 390   if (!ssl_ || !(b = SSL_get_rbio(ssl_))) {
 391     return 0;
 392   }
 393
 394   return BIO_number_read(b);
 395 }
 396
 397
 398 void AsyncSSLSocket::invalidState(HandshakeCB* callback) {
 399   LOG(ERROR) << "AsyncSSLSocket(this=" << this << ", fd=" << fd_
 400              << ", state=" << int(state_) << ", sslState=" << sslState_ << ", "
 401              << "events=" << eventFlags_ << ", server=" << short(server_)
 402              << "): " << "sslAccept/Connect() called in invalid "
 403              << "state, handshake callback " << handshakeCallback_
 404              << ", new callback " << callback;
 405   assert(!handshakeTimeout_.isScheduled());
 406   sslState_ = STATE_ERROR;
 407
 408   AsyncSocketException ex(AsyncSocketException::INVALID_STATE,
 409                          "sslAccept() called with socket in invalid state");
 410
 411   handshakeEndTime_ = std::chrono::steady_clock::now();
 412   if (callback) {
 413     callback->handshakeErr(this, ex);
 414   }
 415
 416   failHandshake(__func__, ex);
 417 }
 418
 419 void AsyncSSLSocket::sslAccept(
 420     HandshakeCB* callback,
 421     std::chrono::milliseconds timeout,
 422     const SSLContext::SSLVerifyPeerEnum& verifyPeer) {
 423   DestructorGuard dg(this);
 424   assert(eventBase_->isInEventBaseThread());
 425   verifyPeer_ = verifyPeer;
 426
 427   // Make sure we're in the uninitialized state
 428   if (!server_ || (sslState_ != STATE_UNINIT &&
 429                    sslState_ != STATE_UNENCRYPTED) ||
 430       handshakeCallback_ != nullptr) {
 431     return invalidState(callback);
 432   }
 433
 434   // Cache local and remote socket addresses to keep them available
 435   // after socket file descriptor is closed.
 436   if (cacheAddrOnFailure_ && -1 != getFd()) {
 437     cacheLocalPeerAddr();
 438   }
 439
 440   handshakeStartTime_ = std::chrono::steady_clock::now();
 441   // Make end time at least >= start time.
 442   handshakeEndTime_ = handshakeStartTime_;
 443
 444   sslState_ = STATE_ACCEPTING;
 445   handshakeCallback_ = callback;
 446
 447   if (timeout > std::chrono::milliseconds::zero()) {
 448     handshakeTimeout_.scheduleTimeout(timeout);
 449   }
 450
 451   /* register for a read operation (waiting for CLIENT HELLO) */
 452   updateEventRegistration(EventHandler::READ, EventHandler::WRITE);
 453
 454   if (preReceivedData_) {
 455     handleRead();
 456   }
 457 }
 458
 459 #if OPENSSL_VERSION_NUMBER >= 0x009080bfL
 460 void AsyncSSLSocket::attachSSLContext(
 461   const std::shared_ptr<SSLContext>& ctx) {
 462
 463   // Check to ensure we are in client mode. Changing a server's ssl
 464   // context doesn't make sense since clients of that server would likely
 465   // become confused when the server's context changes.
 466   DCHECK(!server_);
 467   DCHECK(!ctx_);
 468   DCHECK(ctx);
 469   DCHECK(ctx->getSSLCtx());
 470   ctx_ = ctx;
 471
 472   // It's possible this could be attached before ssl_ is set up
 473   if (!ssl_) {
 474     return;
 475   }
 476
 477   // In order to call attachSSLContext, detachSSLContext must have been
 478   // previously called.
 479   // We need to update the initial_ctx if necessary
 480   auto sslCtx = ctx->getSSLCtx();
 481   SSL_CTX_up_ref(sslCtx);
 482 #ifndef OPENSSL_NO_TLSEXT
 483   // note that detachSSLContext has already freed ssl_->initial_ctx
 484   ssl_->initial_ctx = sslCtx;
 485 #endif
 486   // Detach sets the socket's context to the dummy context. Thus we must acquire
 487   // this lock.
 488   SpinLockGuard guard(dummyCtxLock);
 489   SSL_set_SSL_CTX(ssl_, sslCtx);
 490 }
 491
 492 void AsyncSSLSocket::detachSSLContext() {
 493   DCHECK(ctx_);
 494   ctx_.reset();
 495   // It's possible for this to be called before ssl_ has been
 496   // set up
 497   if (!ssl_) {
 498     return;
 499   }
 500 // Detach the initial_ctx as well.  Internally w/ OPENSSL_NO_TLSEXT
 501 // it is used for session info.  It will be reattached in attachSSLContext
 502 #ifndef OPENSSL_NO_TLSEXT
 503   if (ssl_->initial_ctx) {
 504     SSL_CTX_free(ssl_->initial_ctx);
 505     ssl_->initial_ctx = nullptr;
 506   }
 507 #endif
 508   SpinLockGuard guard(dummyCtxLock);
 509   if (nullptr == dummyCtx) {
 510     // We need to lazily initialize the dummy context so we don't
 511     // accidentally override any programmatic settings to openssl
 512     dummyCtx = new SSLContext;
 513   }
 514   // We must remove this socket's references to its context right now
 515   // since this socket could get passed to any thread. If the context has
 516   // had its locking disabled, just doing a set in attachSSLContext()
 517   // would not be thread safe.
 518   SSL_set_SSL_CTX(ssl_, dummyCtx->getSSLCtx());
 519 }
 520 #endif
 521
 522 #if FOLLY_OPENSSL_HAS_SNI
 523 void AsyncSSLSocket::switchServerSSLContext(
 524   const std::shared_ptr<SSLContext>& handshakeCtx) {
 525   CHECK(server_);
 526   if (sslState_ != STATE_ACCEPTING) {
 527     // We log it here and allow the switch.
 528     // It should not affect our re-negotiation support (which
 529     // is not supported now).
 530     VLOG(6) << "fd=" << getFd()
 531             << " renegotation detected when switching SSL_CTX";
 532   }
 533
 534   setup_SSL_CTX(handshakeCtx->getSSLCtx());
 535   SSL_CTX_set_info_callback(handshakeCtx->getSSLCtx(),
 536                             AsyncSSLSocket::sslInfoCallback);
 537   handshakeCtx_ = handshakeCtx;
 538   SSL_set_SSL_CTX(ssl_, handshakeCtx->getSSLCtx());
 539 }
 540
 541 bool AsyncSSLSocket::isServerNameMatch() const {
 542   CHECK(!server_);
 543
 544   if (!ssl_) {
 545     return false;
 546   }
 547
 548   SSL_SESSION *ss = SSL_get_session(ssl_);
 549   if (!ss) {
 550     return false;
 551   }
 552
 553   if(!ss->tlsext_hostname) {
 554     return false;
 555   }
 556   return (tlsextHostname_.compare(ss->tlsext_hostname) ? false : true);
 557 }
 558
 559 void AsyncSSLSocket::setServerName(std::string serverName) noexcept {
 560   tlsextHostname_ = std::move(serverName);
 561 }
 562
 563 #endif // FOLLY_OPENSSL_HAS_SNI
 564
 565 void AsyncSSLSocket::timeoutExpired(
 566     std::chrono::milliseconds timeout) noexcept {
 567   if (state_ == StateEnum::ESTABLISHED &&
 568       (sslState_ == STATE_CACHE_LOOKUP || sslState_ == STATE_ASYNC_PENDING)) {
 569     sslState_ = STATE_ERROR;
 570     // We are expecting a callback in restartSSLAccept.  The cache lookup
 571     // and rsa-call necessarily have pointers to this ssl socket, so delay
 572     // the cleanup until he calls us back.
 573   } else if (state_ == StateEnum::CONNECTING) {
 574     assert(sslState_ == STATE_CONNECTING);
 575     DestructorGuard dg(this);
 576     AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
 577                            "Fallback connect timed out during TFO");
 578     failHandshake(__func__, ex);
 579   } else {
 580     assert(state_ == StateEnum::ESTABLISHED &&
 581            (sslState_ == STATE_CONNECTING || sslState_ == STATE_ACCEPTING));
 582     DestructorGuard dg(this);
 583     AsyncSocketException ex(
 584         AsyncSocketException::TIMED_OUT,
 585         folly::sformat(
 586             "SSL {} timed out after {}ms",
 587             (sslState_ == STATE_CONNECTING) ? "connect" : "accept",
 588             timeout.count()));
 589     failHandshake(__func__, ex);
 590   }
 591 }
 592
 593 int AsyncSSLSocket::getSSLExDataIndex() {
 594   static auto index = SSL_get_ex_new_index(
 595       0, (void*)"AsyncSSLSocket data index", nullptr, nullptr, nullptr);
 596   return index;
 597 }
 598
 599 AsyncSSLSocket* AsyncSSLSocket::getFromSSL(const SSL *ssl) {
 600   return static_cast<AsyncSSLSocket *>(SSL_get_ex_data(ssl,
 601       getSSLExDataIndex()));
 602 }
 603
 604 void AsyncSSLSocket::failHandshake(const char* /* fn */,
 605                                    const AsyncSocketException& ex) {
 606   startFail();
 607   if (handshakeTimeout_.isScheduled()) {
 608     handshakeTimeout_.cancelTimeout();
 609   }
 610   invokeHandshakeErr(ex);
 611   finishFail();
 612 }
 613
 614 void AsyncSSLSocket::invokeHandshakeErr(const AsyncSocketException& ex) {
 615   handshakeEndTime_ = std::chrono::steady_clock::now();
 616   if (handshakeCallback_ != nullptr) {
 617     HandshakeCB* callback = handshakeCallback_;
 618     handshakeCallback_ = nullptr;
 619     callback->handshakeErr(this, ex);
 620   }
 621 }
 622
 623 void AsyncSSLSocket::invokeHandshakeCB() {
 624   handshakeEndTime_ = std::chrono::steady_clock::now();
 625   if (handshakeTimeout_.isScheduled()) {
 626     handshakeTimeout_.cancelTimeout();
 627   }
 628   if (handshakeCallback_) {
 629     HandshakeCB* callback = handshakeCallback_;
 630     handshakeCallback_ = nullptr;
 631     callback->handshakeSuc(this);
 632   }
 633 }
 634
 635 void AsyncSSLSocket::cacheLocalPeerAddr() {
 636   SocketAddress address;
 637   try {
 638     getLocalAddress(&address);
 639     getPeerAddress(&address);
 640   } catch (const std::system_error& e) {
 641     // The handle can be still valid while the connection is already closed.
 642     if (e.code() != std::error_code(ENOTCONN, std::system_category())) {
 643       throw;
 644     }
 645   }
 646 }
 647
 648 void AsyncSSLSocket::connect(ConnectCallback* callback,
 649                               const folly::SocketAddress& address,
 650                               int timeout,
 651                               const OptionMap &options,
 652                               const folly::SocketAddress& bindAddr)
 653                               noexcept {
 654   assert(!server_);
 655   assert(state_ == StateEnum::UNINIT);
 656   assert(sslState_ == STATE_UNINIT);
 657   noTransparentTls_ = true;
 658   AsyncSSLSocketConnector *connector =
 659     new AsyncSSLSocketConnector(this, callback, timeout);
 660   AsyncSocket::connect(connector, address, timeout, options, bindAddr);
 661 }
 662
 663 bool AsyncSSLSocket::needsPeerVerification() const {
 664   if (verifyPeer_ == SSLContext::SSLVerifyPeerEnum::USE_CTX) {
 665     return ctx_->needsPeerVerification();
 666   }
 667   return (
 668       verifyPeer_ == SSLContext::SSLVerifyPeerEnum::VERIFY ||
 669       verifyPeer_ == SSLContext::SSLVerifyPeerEnum::VERIFY_REQ_CLIENT_CERT);
 670 }
 671
 672 void AsyncSSLSocket::applyVerificationOptions(SSL * ssl) {
 673   // apply the settings specified in verifyPeer_
 674   if (verifyPeer_ == SSLContext::SSLVerifyPeerEnum::USE_CTX) {
 675     if(ctx_->needsPeerVerification()) {
 676       SSL_set_verify(ssl, ctx_->getVerificationMode(),
 677         AsyncSSLSocket::sslVerifyCallback);
 678     }
 679   } else {
 680     if (verifyPeer_ == SSLContext::SSLVerifyPeerEnum::VERIFY ||
 681         verifyPeer_ == SSLContext::SSLVerifyPeerEnum::VERIFY_REQ_CLIENT_CERT) {
 682       SSL_set_verify(ssl, SSLContext::getVerificationMode(verifyPeer_),
 683         AsyncSSLSocket::sslVerifyCallback);
 684     }
 685   }
 686 }
 687
 688 bool AsyncSSLSocket::setupSSLBio() {
 689   auto sslBio = BIO_new(&sslBioMethod);
 690
 691   if (!sslBio) {
 692     return false;
 693   }
 694
 695   OpenSSLUtils::setBioAppData(sslBio, this);
 696   OpenSSLUtils::setBioFd(sslBio, fd_, BIO_NOCLOSE);
 697   SSL_set_bio(ssl_, sslBio, sslBio);
 698   return true;
 699 }
 700
 701 void AsyncSSLSocket::sslConn(
 702     HandshakeCB* callback,
 703     std::chrono::milliseconds timeout,
 704     const SSLContext::SSLVerifyPeerEnum& verifyPeer) {
 705   DestructorGuard dg(this);
 706   assert(eventBase_->isInEventBaseThread());
 707
 708   // Cache local and remote socket addresses to keep them available
 709   // after socket file descriptor is closed.
 710   if (cacheAddrOnFailure_ && -1 != getFd()) {
 711     cacheLocalPeerAddr();
 712   }
 713
 714   verifyPeer_ = verifyPeer;
 715
 716   // Make sure we're in the uninitialized state
 717   if (server_ || (sslState_ != STATE_UNINIT && sslState_ !=
 718                   STATE_UNENCRYPTED) ||
 719       handshakeCallback_ != nullptr) {
 720     return invalidState(callback);
 721   }
 722
 723   sslState_ = STATE_CONNECTING;
 724   handshakeCallback_ = callback;
 725
 726   try {
 727     ssl_ = ctx_->createSSL();
 728   } catch (std::exception &e) {
 729     sslState_ = STATE_ERROR;
 730     AsyncSocketException ex(AsyncSocketException::INTERNAL_ERROR,
 731                            "error calling SSLContext::createSSL()");
 732     LOG(ERROR) << "AsyncSSLSocket::sslConn(this=" << this << ", fd="
 733             << fd_ << "): " << e.what();
 734     return failHandshake(__func__, ex);
 735   }
 736
 737   if (!setupSSLBio()) {
 738     sslState_ = STATE_ERROR;
 739     AsyncSocketException ex(
 740         AsyncSocketException::INTERNAL_ERROR, "error creating SSL bio");
 741     return failHandshake(__func__, ex);
 742   }
 743
 744   applyVerificationOptions(ssl_);
 745
 746   if (sslSession_ != nullptr) {
 747     sessionResumptionAttempted_ = true;
 748     SSL_set_session(ssl_, sslSession_);
 749     SSL_SESSION_free(sslSession_);
 750     sslSession_ = nullptr;
 751   }
 752 #if FOLLY_OPENSSL_HAS_SNI
 753   if (tlsextHostname_.size()) {
 754     SSL_set_tlsext_host_name(ssl_, tlsextHostname_.c_str());
 755   }
 756 #endif
 757
 758   SSL_set_ex_data(ssl_, getSSLExDataIndex(), this);
 759
 760   handshakeConnectTimeout_ = timeout;
 761   startSSLConnect();
 762 }
 763
 764 // This could be called multiple times, during normal ssl connections
 765 // and after TFO fallback.
 766 void AsyncSSLSocket::startSSLConnect() {
 767   handshakeStartTime_ = std::chrono::steady_clock::now();
 768   // Make end time at least >= start time.
 769   handshakeEndTime_ = handshakeStartTime_;
 770   if (handshakeConnectTimeout_ > std::chrono::milliseconds::zero()) {
 771     handshakeTimeout_.scheduleTimeout(handshakeConnectTimeout_);
 772   }
 773   handleConnect();
 774 }
 775
 776 SSL_SESSION *AsyncSSLSocket::getSSLSession() {
 777   if (ssl_ != nullptr && sslState_ == STATE_ESTABLISHED) {
 778     return SSL_get1_session(ssl_);
 779   }
 780
 781   return sslSession_;
 782 }
 783
 784 const SSL* AsyncSSLSocket::getSSL() const {
 785   return ssl_;
 786 }
 787
 788 void AsyncSSLSocket::setSSLSession(SSL_SESSION *session, bool takeOwnership) {
 789   sslSession_ = session;
 790   if (!takeOwnership && session != nullptr) {
 791     // Increment the reference count
 792     // This API exists in BoringSSL and OpenSSL 1.1.0
 793     SSL_SESSION_up_ref(session);
 794   }
 795 }
 796
 797 void AsyncSSLSocket::getSelectedNextProtocol(
 798     const unsigned char** protoName,
 799     unsigned* protoLen,
 800     SSLContext::NextProtocolType* protoType) const {
 801   if (!getSelectedNextProtocolNoThrow(protoName, protoLen, protoType)) {
 802     throw AsyncSocketException(AsyncSocketException::NOT_SUPPORTED,
 803                               "NPN not supported");
 804   }
 805 }
 806
 807 bool AsyncSSLSocket::getSelectedNextProtocolNoThrow(
 808     const unsigned char** protoName,
 809     unsigned* protoLen,
 810     SSLContext::NextProtocolType* protoType) const {
 811   *protoName = nullptr;
 812   *protoLen = 0;
 813 #if FOLLY_OPENSSL_HAS_ALPN
 814   SSL_get0_alpn_selected(ssl_, protoName, protoLen);
 815   if (*protoLen > 0) {
 816     if (protoType) {
 817       *protoType = SSLContext::NextProtocolType::ALPN;
 818     }
 819     return true;
 820   }
 821 #endif
 822 #ifdef OPENSSL_NPN_NEGOTIATED
 823   SSL_get0_next_proto_negotiated(ssl_, protoName, protoLen);
 824   if (protoType) {
 825     *protoType = SSLContext::NextProtocolType::NPN;
 826   }
 827   return true;
 828 #else
 829   (void)protoType;
 830   return false;
 831 #endif
 832 }
 833
 834 bool AsyncSSLSocket::getSSLSessionReused() const {
 835   if (ssl_ != nullptr && sslState_ == STATE_ESTABLISHED) {
 836     return SSL_session_reused(ssl_);
 837   }
 838   return false;
 839 }
 840
 841 const char *AsyncSSLSocket::getNegotiatedCipherName() const {
 842   return (ssl_ != nullptr) ? SSL_get_cipher_name(ssl_) : nullptr;
 843 }
 844
 845 /* static */
 846 const char* AsyncSSLSocket::getSSLServerNameFromSSL(SSL* ssl) {
 847   if (ssl == nullptr) {
 848     return nullptr;
 849   }
 850 #ifdef SSL_CTRL_SET_TLSEXT_SERVERNAME_CB
 851   return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
 852 #else
 853   return nullptr;
 854 #endif
 855 }
 856
 857 const char *AsyncSSLSocket::getSSLServerName() const {
 858 #ifdef SSL_CTRL_SET_TLSEXT_SERVERNAME_CB
 859   return getSSLServerNameFromSSL(ssl_);
 860 #else
 861   throw AsyncSocketException(AsyncSocketException::NOT_SUPPORTED,
 862                              "SNI not supported");
 863 #endif
 864 }
 865
 866 const char *AsyncSSLSocket::getSSLServerNameNoThrow() const {
 867   return getSSLServerNameFromSSL(ssl_);
 868 }
 869
 870 int AsyncSSLSocket::getSSLVersion() const {
 871   return (ssl_ != nullptr) ? SSL_version(ssl_) : 0;
 872 }
 873
 874 const char *AsyncSSLSocket::getSSLCertSigAlgName() const {
 875   X509 *cert = (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
 876   if (cert) {
 877     int nid = OBJ_obj2nid(cert->sig_alg->algorithm);
 878     return OBJ_nid2ln(nid);
 879   }
 880   return nullptr;
 881 }
 882
 883 int AsyncSSLSocket::getSSLCertSize() const {
 884   int certSize = 0;
 885   X509 *cert = (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
 886   if (cert) {
 887     EVP_PKEY *key = X509_get_pubkey(cert);
 888     certSize = EVP_PKEY_bits(key);
 889     EVP_PKEY_free(key);
 890   }
 891   return certSize;
 892 }
 893
 894 const X509* AsyncSSLSocket::getSelfCert() const {
 895   return (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
 896 }
 897
 898 bool AsyncSSLSocket::willBlock(int ret,
 899                                int* sslErrorOut,
 900                                unsigned long* errErrorOut) noexcept {
 901   *errErrorOut = 0;
 902   int error = *sslErrorOut = SSL_get_error(ssl_, ret);
 903   if (error == SSL_ERROR_WANT_READ) {
 904     // Register for read event if not already.
 905     updateEventRegistration(EventHandler::READ, EventHandler::WRITE);
 906     return true;
 907   } else if (error == SSL_ERROR_WANT_WRITE) {
 908     VLOG(3) << "AsyncSSLSocket(fd=" << fd_
 909             << ", state=" << int(state_) << ", sslState="
 910             << sslState_ << ", events=" << eventFlags_ << "): "
 911             << "SSL_ERROR_WANT_WRITE";
 912     // Register for write event if not already.
 913     updateEventRegistration(EventHandler::WRITE, EventHandler::READ);
 914     return true;
 915 #ifdef SSL_ERROR_WANT_SESS_CACHE_LOOKUP
 916   } else if (error == SSL_ERROR_WANT_SESS_CACHE_LOOKUP) {
 917     // We will block but we can't register our own socket.  The callback that
 918     // triggered this code will re-call handleAccept at the appropriate time.
 919
 920     // We can only get here if the linked libssl.so has support for this feature
 921     // as well, otherwise SSL_get_error cannot return our error code.
 922     sslState_ = STATE_CACHE_LOOKUP;
 923
 924     // Unregister for all events while blocked here
 925     updateEventRegistration(EventHandler::NONE,
 926                             EventHandler::READ | EventHandler::WRITE);
 927
 928     // The timeout (if set) keeps running here
 929     return true;
 930 #endif
 931   } else if (0
 932 #ifdef SSL_ERROR_WANT_RSA_ASYNC_PENDING
 933       || error == SSL_ERROR_WANT_RSA_ASYNC_PENDING
 934 #endif
 935 #ifdef SSL_ERROR_WANT_ECDSA_ASYNC_PENDING
 936       || error == SSL_ERROR_WANT_ECDSA_ASYNC_PENDING
 937 #endif
 938       ) {
 939     // Our custom openssl function has kicked off an async request to do
 940     // rsa/ecdsa private key operation.  When that call returns, a callback will
 941     // be invoked that will re-call handleAccept.
 942     sslState_ = STATE_ASYNC_PENDING;
 943
 944     // Unregister for all events while blocked here
 945     updateEventRegistration(
 946       EventHandler::NONE,
 947       EventHandler::READ | EventHandler::WRITE
 948     );
 949
 950     // The timeout (if set) keeps running here
 951     return true;
 952   } else {
 953     unsigned long lastError = *errErrorOut = ERR_get_error();
 954     VLOG(6) << "AsyncSSLSocket(fd=" << fd_ << ", "
 955             << "state=" << state_ << ", "
 956             << "sslState=" << sslState_ << ", "
 957             << "events=" << std::hex << eventFlags_ << "): "
 958             << "SSL error: " << error << ", "
 959             << "errno: " << errno << ", "
 960             << "ret: " << ret << ", "
 961             << "read: " << BIO_number_read(SSL_get_rbio(ssl_)) << ", "
 962             << "written: " << BIO_number_written(SSL_get_wbio(ssl_)) << ", "
 963             << "func: " << ERR_func_error_string(lastError) << ", "
 964             << "reason: " << ERR_reason_error_string(lastError);
 965     return false;
 966   }
 967 }
 968
 969 void AsyncSSLSocket::checkForImmediateRead() noexcept {
 970   // openssl may have buffered data that it read from the socket already.
 971   // In this case we have to process it immediately, rather than waiting for
 972   // the socket to become readable again.
 973   if (ssl_ != nullptr && SSL_pending(ssl_) > 0) {
 974     AsyncSocket::handleRead();
 975   }
 976 }
 977
 978 void
 979 AsyncSSLSocket::restartSSLAccept()
 980 {
 981   VLOG(3) << "AsyncSSLSocket::restartSSLAccept() this=" << this
 982           << ", fd=" << fd_ << ", state=" << int(state_) << ", "
 983           << "sslState=" << sslState_ << ", events=" << eventFlags_;
 984   DestructorGuard dg(this);
 985   assert(
 986     sslState_ == STATE_CACHE_LOOKUP ||
 987     sslState_ == STATE_ASYNC_PENDING ||
 988     sslState_ == STATE_ERROR ||
 989     sslState_ == STATE_CLOSED);
 990   if (sslState_ == STATE_CLOSED) {
 991     // I sure hope whoever closed this socket didn't delete it already,
 992     // but this is not strictly speaking an error
 993     return;
 994   }
 995   if (sslState_ == STATE_ERROR) {
 996     // go straight to fail if timeout expired during lookup
 997     AsyncSocketException ex(
 998         AsyncSocketException::TIMED_OUT, "SSL accept timed out");
 999     failHandshake(__func__, ex);
1000     return;
1001   }
1002   sslState_ = STATE_ACCEPTING;
1003   this->handleAccept();
1004 }
1005
1006 void
1007 AsyncSSLSocket::handleAccept() noexcept {
1008   VLOG(3) << "AsyncSSLSocket::handleAccept() this=" << this
1009           << ", fd=" << fd_ << ", state=" << int(state_) << ", "
1010           << "sslState=" << sslState_ << ", events=" << eventFlags_;
1011   assert(server_);
1012   assert(state_ == StateEnum::ESTABLISHED &&
1013          sslState_ == STATE_ACCEPTING);
1014   if (!ssl_) {
1015     /* lazily create the SSL structure */
1016     try {
1017       ssl_ = ctx_->createSSL();
1018     } catch (std::exception &e) {
1019       sslState_ = STATE_ERROR;
1020       AsyncSocketException ex(AsyncSocketException::INTERNAL_ERROR,
1021                              "error calling SSLContext::createSSL()");
1022       LOG(ERROR) << "AsyncSSLSocket::handleAccept(this=" << this
1023                  << ", fd=" << fd_ << "): " << e.what();
1024       return failHandshake(__func__, ex);
1025     }
1026
1027     if (!setupSSLBio()) {
1028       sslState_ = STATE_ERROR;
1029       AsyncSocketException ex(
1030           AsyncSocketException::INTERNAL_ERROR, "error creating write bio");
1031       return failHandshake(__func__, ex);
1032     }
1033
1034     SSL_set_ex_data(ssl_, getSSLExDataIndex(), this);
1035
1036     applyVerificationOptions(ssl_);
1037   }
1038
1039   if (server_ && parseClientHello_) {
1040     SSL_set_msg_callback(ssl_, &AsyncSSLSocket::clientHelloParsingCallback);
1041     SSL_set_msg_callback_arg(ssl_, this);
1042   }
1043
1044   int ret = SSL_accept(ssl_);
1045   if (ret <= 0) {
1046     int sslError;
1047     unsigned long errError;
1048     int errnoCopy = errno;
1049     if (willBlock(ret, &sslError, &errError)) {
1050       return;
1051     } else {
1052       sslState_ = STATE_ERROR;
1053       SSLException ex(sslError, errError, ret, errnoCopy);
1054       return failHandshake(__func__, ex);
1055     }
1056   }
1057
1058   handshakeComplete_ = true;
1059   updateEventRegistration(0, EventHandler::READ | EventHandler::WRITE);
1060
1061   // Move into STATE_ESTABLISHED in the normal case that we are in
1062   // STATE_ACCEPTING.
1063   sslState_ = STATE_ESTABLISHED;
1064
1065   VLOG(3) << "AsyncSSLSocket " << this << ": fd " << fd_
1066           << " successfully accepted; state=" << int(state_)
1067           << ", sslState=" << sslState_ << ", events=" << eventFlags_;
1068
1069   // Remember the EventBase we are attached to, before we start invoking any
1070   // callbacks (since the callbacks may call detachEventBase()).
1071   EventBase* originalEventBase = eventBase_;
1072
1073   // Call the accept callback.
1074   invokeHandshakeCB();
1075
1076   // Note that the accept callback may have changed our state.
1077   // (set or unset the read callback, called write(), closed the socket, etc.)
1078   // The following code needs to handle these situations correctly.
1079   //
1080   // If the socket has been closed, readCallback_ and writeReqHead_ will
1081   // always be nullptr, so that will prevent us from trying to read or write.
1082   //
1083   // The main thing to check for is if eventBase_ is still originalEventBase.
1084   // If not, we have been detached from this event base, so we shouldn't
1085   // perform any more operations.
1086   if (eventBase_ != originalEventBase) {
1087     return;
1088   }
1089
1090   AsyncSocket::handleInitialReadWrite();
1091 }
1092
1093 void
1094 AsyncSSLSocket::handleConnect() noexcept {
1095   VLOG(3) <<  "AsyncSSLSocket::handleConnect() this=" << this
1096           << ", fd=" << fd_ << ", state=" << int(state_) << ", "
1097           << "sslState=" << sslState_ << ", events=" << eventFlags_;
1098   assert(!server_);
1099   if (state_ < StateEnum::ESTABLISHED) {
1100     return AsyncSocket::handleConnect();
1101   }
1102
1103   assert(
1104       (state_ == StateEnum::FAST_OPEN || state_ == StateEnum::ESTABLISHED) &&
1105       sslState_ == STATE_CONNECTING);
1106   assert(ssl_);
1107
1108   auto originalState = state_;
1109   int ret = SSL_connect(ssl_);
1110   if (ret <= 0) {
1111     int sslError;
1112     unsigned long errError;
1113     int errnoCopy = errno;
1114     if (willBlock(ret, &sslError, &errError)) {
1115       // We fell back to connecting state due to TFO
1116       if (state_ == StateEnum::CONNECTING) {
1117         DCHECK_EQ(StateEnum::FAST_OPEN, originalState);
1118         if (handshakeTimeout_.isScheduled()) {
1119           handshakeTimeout_.cancelTimeout();
1120         }
1121       }
1122       return;
1123     } else {
1124       sslState_ = STATE_ERROR;
1125       SSLException ex(sslError, errError, ret, errnoCopy);
1126       return failHandshake(__func__, ex);
1127     }
1128   }
1129
1130   handshakeComplete_ = true;
1131   updateEventRegistration(0, EventHandler::READ | EventHandler::WRITE);
1132
1133   // Move into STATE_ESTABLISHED in the normal case that we are in
1134   // STATE_CONNECTING.
1135   sslState_ = STATE_ESTABLISHED;
1136
1137   VLOG(3) << "AsyncSSLSocket " << this << ": "
1138           << "fd " << fd_ << " successfully connected; "
1139           << "state=" << int(state_) << ", sslState=" << sslState_
1140           << ", events=" << eventFlags_;
1141
1142   // Remember the EventBase we are attached to, before we start invoking any
1143   // callbacks (since the callbacks may call detachEventBase()).
1144   EventBase* originalEventBase = eventBase_;
1145
1146   // Call the handshake callback.
1147   invokeHandshakeCB();
1148
1149   // Note that the connect callback may have changed our state.
1150   // (set or unset the read callback, called write(), closed the socket, etc.)
1151   // The following code needs to handle these situations correctly.
1152   //
1153   // If the socket has been closed, readCallback_ and writeReqHead_ will
1154   // always be nullptr, so that will prevent us from trying to read or write.
1155   //
1156   // The main thing to check for is if eventBase_ is still originalEventBase.
1157   // If not, we have been detached from this event base, so we shouldn't
1158   // perform any more operations.
1159   if (eventBase_ != originalEventBase) {
1160     return;
1161   }
1162
1163   AsyncSocket::handleInitialReadWrite();
1164 }
1165
1166 void AsyncSSLSocket::invokeConnectErr(const AsyncSocketException& ex) {
1167   connectionTimeout_.cancelTimeout();
1168   AsyncSocket::invokeConnectErr(ex);
1169   if (sslState_ == SSLStateEnum::STATE_CONNECTING) {
1170     if (handshakeTimeout_.isScheduled()) {
1171       handshakeTimeout_.cancelTimeout();
1172     }
1173     // If we fell back to connecting state during TFO and the connection
1174     // failed, it would be an SSL failure as well.
1175     invokeHandshakeErr(ex);
1176   }
1177 }
1178
1179 void AsyncSSLSocket::invokeConnectSuccess() {
1180   connectionTimeout_.cancelTimeout();
1181   if (sslState_ == SSLStateEnum::STATE_CONNECTING) {
1182     assert(tfoAttempted_);
1183     // If we failed TFO, we'd fall back to trying to connect the socket,
1184     // to setup things like timeouts.
1185     startSSLConnect();
1186   }
1187   // still invoke the base class since it re-sets the connect time.
1188   AsyncSocket::invokeConnectSuccess();
1189 }
1190
1191 void AsyncSSLSocket::scheduleConnectTimeout() {
1192   if (sslState_ == SSLStateEnum::STATE_CONNECTING) {
1193     // We fell back from TFO, and need to set the timeouts.
1194     // We will not have a connect callback in this case, thus if the timer
1195     // expires we would have no-one to notify.
1196     // Thus we should reset even the connect timers to point to the handshake
1197     // timeouts.
1198     assert(connectCallback_ == nullptr);
1199     // We use a different connect timeout here than the handshake timeout, so
1200     // that we can disambiguate the 2 timers.
1201     if (connectTimeout_.count() > 0) {
1202       if (!connectionTimeout_.scheduleTimeout(connectTimeout_)) {
1203         throw AsyncSocketException(
1204             AsyncSocketException::INTERNAL_ERROR,
1205             withAddr("failed to schedule AsyncSSLSocket connect timeout"));
1206       }
1207     }
1208     return;
1209   }
1210   AsyncSocket::scheduleConnectTimeout();
1211 }
1212
1213 void AsyncSSLSocket::setReadCB(ReadCallback *callback) {
1214 #ifdef SSL_MODE_MOVE_BUFFER_OWNERSHIP
1215   // turn on the buffer movable in openssl
1216   if (bufferMovableEnabled_ && ssl_ != nullptr && !isBufferMovable_ &&
1217       callback != nullptr && callback->isBufferMovable()) {
1218     SSL_set_mode(ssl_, SSL_get_mode(ssl_) | SSL_MODE_MOVE_BUFFER_OWNERSHIP);
1219     isBufferMovable_ = true;
1220   }
1221 #endif
1222
1223   AsyncSocket::setReadCB(callback);
1224 }
1225
1226 void AsyncSSLSocket::setBufferMovableEnabled(bool enabled) {
1227   bufferMovableEnabled_ = enabled;
1228 }
1229
1230 void AsyncSSLSocket::prepareReadBuffer(void** buf, size_t* buflen) {
1231   CHECK(readCallback_);
1232   if (isBufferMovable_) {
1233     *buf = nullptr;
1234     *buflen = 0;
1235   } else {
1236     // buf is necessary for SSLSocket without SSL_MODE_MOVE_BUFFER_OWNERSHIP
1237     readCallback_->getReadBuffer(buf, buflen);
1238   }
1239 }
1240
1241 void
1242 AsyncSSLSocket::handleRead() noexcept {
1243   VLOG(5) << "AsyncSSLSocket::handleRead() this=" << this << ", fd=" << fd_
1244           << ", state=" << int(state_) << ", "
1245           << "sslState=" << sslState_ << ", events=" << eventFlags_;
1246   if (state_ < StateEnum::ESTABLISHED) {
1247     return AsyncSocket::handleRead();
1248   }
1249
1250
1251   if (sslState_ == STATE_ACCEPTING) {
1252     assert(server_);
1253     handleAccept();
1254     return;
1255   }
1256   else if (sslState_ == STATE_CONNECTING) {
1257     assert(!server_);
1258     handleConnect();
1259     return;
1260   }
1261
1262   // Normal read
1263   AsyncSocket::handleRead();
1264 }
1265
1266 AsyncSocket::ReadResult
1267 AsyncSSLSocket::performRead(void** buf, size_t* buflen, size_t* offset) {
1268   VLOG(4) << "AsyncSSLSocket::performRead() this=" << this << ", buf=" << *buf
1269           << ", buflen=" << *buflen;
1270
1271   if (sslState_ == STATE_UNENCRYPTED) {
1272     return AsyncSocket::performRead(buf, buflen, offset);
1273   }
1274
1275   int bytes = 0;
1276   if (!isBufferMovable_) {
1277     bytes = SSL_read(ssl_, *buf, int(*buflen));
1278   }
1279 #ifdef SSL_MODE_MOVE_BUFFER_OWNERSHIP
1280   else {
1281     bytes = SSL_read_buf(ssl_, buf, (int *) offset, (int *) buflen);
1282   }
1283 #endif
1284
1285   if (server_ && renegotiateAttempted_) {
1286     LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1287                << ", sslstate=" << sslState_ << ", events=" << eventFlags_
1288                << "): client intitiated SSL renegotiation not permitted";
1289     return ReadResult(
1290         READ_ERROR,
1291         folly::make_unique<SSLException>(SSLError::CLIENT_RENEGOTIATION));
1292   }
1293   if (bytes <= 0) {
1294     int error = SSL_get_error(ssl_, bytes);
1295     if (error == SSL_ERROR_WANT_READ) {
1296       // The caller will register for read event if not already.
1297       if (errno == EWOULDBLOCK || errno == EAGAIN) {
1298         return ReadResult(READ_BLOCKING);
1299       } else {
1300         return ReadResult(READ_ERROR);
1301       }
1302     } else if (error == SSL_ERROR_WANT_WRITE) {
1303       // TODO: Even though we are attempting to read data, SSL_read() may
1304       // need to write data if renegotiation is being performed.  We currently
1305       // don't support this and just fail the read.
1306       LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1307                  << ", sslState=" << sslState_ << ", events=" << eventFlags_
1308                  << "): unsupported SSL renegotiation during read";
1309       return ReadResult(
1310           READ_ERROR,
1311           folly::make_unique<SSLException>(SSLError::INVALID_RENEGOTIATION));
1312     } else {
1313       if (zero_return(error, bytes)) {
1314         return ReadResult(bytes);
1315       }
1316       auto errError = ERR_get_error();
1317       VLOG(6) << "AsyncSSLSocket(fd=" << fd_ << ", "
1318               << "state=" << state_ << ", "
1319               << "sslState=" << sslState_ << ", "
1320               << "events=" << std::hex << eventFlags_ << "): "
1321               << "bytes: " << bytes << ", "
1322               << "error: " << error << ", "
1323               << "errno: " << errno << ", "
1324               << "func: " << ERR_func_error_string(errError) << ", "
1325               << "reason: " << ERR_reason_error_string(errError);
1326       return ReadResult(
1327           READ_ERROR,
1328           folly::make_unique<SSLException>(error, errError, bytes, errno));
1329     }
1330   } else {
1331     appBytesReceived_ += bytes;
1332     return ReadResult(bytes);
1333   }
1334 }
1335
1336 void AsyncSSLSocket::handleWrite() noexcept {
1337   VLOG(5) << "AsyncSSLSocket::handleWrite() this=" << this << ", fd=" << fd_
1338           << ", state=" << int(state_) << ", "
1339           << "sslState=" << sslState_ << ", events=" << eventFlags_;
1340   if (state_ < StateEnum::ESTABLISHED) {
1341     return AsyncSocket::handleWrite();
1342   }
1343
1344   if (sslState_ == STATE_ACCEPTING) {
1345     assert(server_);
1346     handleAccept();
1347     return;
1348   }
1349
1350   if (sslState_ == STATE_CONNECTING) {
1351     assert(!server_);
1352     handleConnect();
1353     return;
1354   }
1355
1356   // Normal write
1357   AsyncSocket::handleWrite();
1358 }
1359
1360 AsyncSocket::WriteResult AsyncSSLSocket::interpretSSLError(int rc, int error) {
1361   if (error == SSL_ERROR_WANT_READ) {
1362     // Even though we are attempting to write data, SSL_write() may
1363     // need to read data if renegotiation is being performed.  We currently
1364     // don't support this and just fail the write.
1365     LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1366                << ", sslState=" << sslState_ << ", events=" << eventFlags_
1367                << "): "
1368                << "unsupported SSL renegotiation during write";
1369     return WriteResult(
1370         WRITE_ERROR,
1371         folly::make_unique<SSLException>(SSLError::INVALID_RENEGOTIATION));
1372   } else {
1373     if (zero_return(error, rc)) {
1374       return WriteResult(0);
1375     }
1376     auto errError = ERR_get_error();
1377     VLOG(3) << "ERROR: AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1378             << ", sslState=" << sslState_ << ", events=" << eventFlags_ << "): "
1379             << "SSL error: " << error << ", errno: " << errno
1380             << ", func: " << ERR_func_error_string(errError)
1381             << ", reason: " << ERR_reason_error_string(errError);
1382     return WriteResult(
1383         WRITE_ERROR,
1384         folly::make_unique<SSLException>(error, errError, rc, errno));
1385   }
1386 }
1387
1388 AsyncSocket::WriteResult AsyncSSLSocket::performWrite(
1389     const iovec* vec,
1390     uint32_t count,
1391     WriteFlags flags,
1392     uint32_t* countWritten,
1393     uint32_t* partialWritten) {
1394   if (sslState_ == STATE_UNENCRYPTED) {
1395     return AsyncSocket::performWrite(
1396       vec, count, flags, countWritten, partialWritten);
1397   }
1398   if (sslState_ != STATE_ESTABLISHED) {
1399     LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1400                << ", sslState=" << sslState_
1401                << ", events=" << eventFlags_ << "): "
1402                << "TODO: AsyncSSLSocket currently does not support calling "
1403                << "write() before the handshake has fully completed";
1404     return WriteResult(
1405         WRITE_ERROR, folly::make_unique<SSLException>(SSLError::EARLY_WRITE));
1406   }
1407
1408   // Declare a buffer used to hold small write requests.  It could point to a
1409   // memory block either on stack or on heap. If it is on heap, we release it
1410   // manually when scope exits
1411   char* combinedBuf{nullptr};
1412   SCOPE_EXIT {
1413     // Note, always keep this check consistent with what we do below
1414     if (combinedBuf != nullptr && minWriteSize_ > MAX_STACK_BUF_SIZE) {
1415       delete[] combinedBuf;
1416     }
1417   };
1418
1419   *countWritten = 0;
1420   *partialWritten = 0;
1421   ssize_t totalWritten = 0;
1422   size_t bytesStolenFromNextBuffer = 0;
1423   for (uint32_t i = 0; i < count; i++) {
1424     const iovec* v = vec + i;
1425     size_t offset = bytesStolenFromNextBuffer;
1426     bytesStolenFromNextBuffer = 0;
1427     size_t len = v->iov_len - offset;
1428     const void* buf;
1429     if (len == 0) {
1430       (*countWritten)++;
1431       continue;
1432     }
1433     buf = ((const char*)v->iov_base) + offset;
1434
1435     ssize_t bytes;
1436     uint32_t buffersStolen = 0;
1437     auto sslWriteBuf = buf;
1438     if ((len < minWriteSize_) && ((i + 1) < count)) {
1439       // Combine this buffer with part or all of the next buffers in
1440       // order to avoid really small-grained calls to SSL_write().
1441       // Each call to SSL_write() produces a separate record in
1442       // the egress SSL stream, and we've found that some low-end
1443       // mobile clients can't handle receiving an HTTP response
1444       // header and the first part of the response body in two
1445       // separate SSL records (even if those two records are in
1446       // the same TCP packet).
1447
1448       if (combinedBuf == nullptr) {
1449         if (minWriteSize_ > MAX_STACK_BUF_SIZE) {
1450           // Allocate the buffer on heap
1451           combinedBuf = new char[minWriteSize_];
1452         } else {
1453           // Allocate the buffer on stack
1454           combinedBuf = (char*)alloca(minWriteSize_);
1455         }
1456       }
1457       assert(combinedBuf != nullptr);
1458       sslWriteBuf = combinedBuf;
1459
1460       memcpy(combinedBuf, buf, len);
1461       do {
1462         // INVARIANT: i + buffersStolen == complete chunks serialized
1463         uint32_t nextIndex = i + buffersStolen + 1;
1464         bytesStolenFromNextBuffer = std::min(vec[nextIndex].iov_len,
1465                                              minWriteSize_ - len);
1466         if (bytesStolenFromNextBuffer > 0) {
1467           assert(vec[nextIndex].iov_base != nullptr);
1468           ::memcpy(
1469               combinedBuf + len,
1470               vec[nextIndex].iov_base,
1471               bytesStolenFromNextBuffer);
1472         }
1473         len += bytesStolenFromNextBuffer;
1474         if (bytesStolenFromNextBuffer < vec[nextIndex].iov_len) {
1475           // couldn't steal the whole buffer
1476           break;
1477         } else {
1478           bytesStolenFromNextBuffer = 0;
1479           buffersStolen++;
1480         }
1481       } while ((i + buffersStolen + 1) < count && (len < minWriteSize_));
1482     }
1483
1484     // Advance any empty buffers immediately after.
1485     if (bytesStolenFromNextBuffer == 0) {
1486       while ((i + buffersStolen + 1) < count &&
1487              vec[i + buffersStolen + 1].iov_len == 0) {
1488         buffersStolen++;
1489       }
1490     }
1491
1492     corkCurrentWrite_ =
1493         isSet(flags, WriteFlags::CORK) || (i + buffersStolen + 1 < count);
1494     bytes = eorAwareSSLWrite(
1495         ssl_,
1496         sslWriteBuf,
1497         int(len),
1498         (isSet(flags, WriteFlags::EOR) && i + buffersStolen + 1 == count));
1499
1500     if (bytes <= 0) {
1501       int error = SSL_get_error(ssl_, int(bytes));
1502       if (error == SSL_ERROR_WANT_WRITE) {
1503         // The caller will register for write event if not already.
1504         *partialWritten = uint32_t(offset);
1505         return WriteResult(totalWritten);
1506       }
1507       auto writeResult = interpretSSLError(int(bytes), error);
1508       if (writeResult.writeReturn < 0) {
1509         return writeResult;
1510       } // else fall through to below to correctly record totalWritten
1511     }
1512
1513     totalWritten += bytes;
1514
1515     if (bytes == (ssize_t)len) {
1516       // The full iovec is written.
1517       (*countWritten) += 1 + buffersStolen;
1518       i += buffersStolen;
1519       // continue
1520     } else {
1521       bytes += offset; // adjust bytes to account for all of v
1522       while (bytes >= (ssize_t)v->iov_len) {
1523         // We combined this buf with part or all of the next one, and
1524         // we managed to write all of this buf but not all of the bytes
1525         // from the next one that we'd hoped to write.
1526         bytes -= v->iov_len;
1527         (*countWritten)++;
1528         v = &(vec[++i]);
1529       }
1530       *partialWritten = uint32_t(bytes);
1531       return WriteResult(totalWritten);
1532     }
1533   }
1534
1535   return WriteResult(totalWritten);
1536 }
1537
1538 int AsyncSSLSocket::eorAwareSSLWrite(SSL *ssl, const void *buf, int n,
1539                                       bool eor) {
1540   if (eor && isEorTrackingEnabled()) {
1541     if (appEorByteNo_) {
1542       // cannot track for more than one app byte EOR
1543       CHECK(appEorByteNo_ == appBytesWritten_ + n);
1544     } else {
1545       appEorByteNo_ = appBytesWritten_ + n;
1546     }
1547
1548     // 1. It is fine to keep updating minEorRawByteNo_.
1549     // 2. It is _min_ in the sense that SSL record will add some overhead.
1550     minEorRawByteNo_ = getRawBytesWritten() + n;
1551   }
1552
1553   n = sslWriteImpl(ssl, buf, n);
1554   if (n > 0) {
1555     appBytesWritten_ += n;
1556     if (appEorByteNo_) {
1557       if (getRawBytesWritten() >= minEorRawByteNo_) {
1558         minEorRawByteNo_ = 0;
1559       }
1560       if(appBytesWritten_ == appEorByteNo_) {
1561         appEorByteNo_ = 0;
1562       } else {
1563         CHECK(appBytesWritten_ < appEorByteNo_);
1564       }
1565     }
1566   }
1567   return n;
1568 }
1569
1570 void AsyncSSLSocket::sslInfoCallback(const SSL* ssl, int where, int ret) {
1571   AsyncSSLSocket *sslSocket = AsyncSSLSocket::getFromSSL(ssl);
1572   if (sslSocket->handshakeComplete_ && (where & SSL_CB_HANDSHAKE_START)) {
1573     sslSocket->renegotiateAttempted_ = true;
1574   }
1575   if (where & SSL_CB_READ_ALERT) {
1576     const char* type = SSL_alert_type_string(ret);
1577     if (type) {
1578       const char* desc = SSL_alert_desc_string(ret);
1579       sslSocket->alertsReceived_.emplace_back(
1580           *type, StringPiece(desc, std::strlen(desc)));
1581     }
1582   }
1583 }
1584
1585 int AsyncSSLSocket::bioWrite(BIO* b, const char* in, int inl) {
1586   struct msghdr msg;
1587   struct iovec iov;
1588   int flags = 0;
1589   AsyncSSLSocket* tsslSock;
1590
1591   iov.iov_base = const_cast<char*>(in);
1592   iov.iov_len = size_t(inl);
1593   memset(&msg, 0, sizeof(msg));
1594   msg.msg_iov = &iov;
1595   msg.msg_iovlen = 1;
1596
1597   auto appData = OpenSSLUtils::getBioAppData(b);
1598   CHECK(appData);
1599
1600   tsslSock = reinterpret_cast<AsyncSSLSocket*>(appData);
1601   CHECK(tsslSock);
1602
1603   if (tsslSock->isEorTrackingEnabled() && tsslSock->minEorRawByteNo_ &&
1604       tsslSock->minEorRawByteNo_ <= BIO_number_written(b) + inl) {
1605     flags = MSG_EOR;
1606   }
1607
1608 #ifdef MSG_NOSIGNAL
1609   flags |= MSG_NOSIGNAL;
1610 #endif
1611
1612 #ifdef MSG_MORE
1613   if (tsslSock->corkCurrentWrite_) {
1614     flags |= MSG_MORE;
1615   }
1616 #endif
1617
1618   auto result = tsslSock->sendSocketMessage(
1619       OpenSSLUtils::getBioFd(b, nullptr), &msg, flags);
1620   BIO_clear_retry_flags(b);
1621   if (!result.exception && result.writeReturn <= 0) {
1622     if (OpenSSLUtils::getBioShouldRetryWrite(int(result.writeReturn))) {
1623       BIO_set_retry_write(b);
1624     }
1625   }
1626   return int(result.writeReturn);
1627 }
1628
1629 int AsyncSSLSocket::bioRead(BIO* b, char* out, int outl) {
1630   if (!out) {
1631     return 0;
1632   }
1633   BIO_clear_retry_flags(b);
1634
1635   auto appData = OpenSSLUtils::getBioAppData(b);
1636   CHECK(appData);
1637   auto sslSock = reinterpret_cast<AsyncSSLSocket*>(appData);
1638
1639   if (sslSock->preReceivedData_ && !sslSock->preReceivedData_->empty()) {
1640     VLOG(5) << "AsyncSSLSocket::bioRead() this=" << sslSock
1641             << ", reading pre-received data";
1642
1643     Cursor cursor(sslSock->preReceivedData_.get());
1644     auto len = cursor.pullAtMost(out, outl);
1645
1646     IOBufQueue queue;
1647     queue.append(std::move(sslSock->preReceivedData_));
1648     queue.trimStart(len);
1649     sslSock->preReceivedData_ = queue.move();
1650     return len;
1651   } else {
1652     auto result = recv(OpenSSLUtils::getBioFd(b, nullptr), out, outl, 0);
1653     if (result <= 0 && OpenSSLUtils::getBioShouldRetryWrite(result)) {
1654       BIO_set_retry_read(b);
1655     }
1656     return result;
1657   }
1658 }
1659
1660 int AsyncSSLSocket::sslVerifyCallback(
1661     int preverifyOk,
1662     X509_STORE_CTX* x509Ctx) {
1663   SSL* ssl = (SSL*) X509_STORE_CTX_get_ex_data(
1664     x509Ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
1665   AsyncSSLSocket* self = AsyncSSLSocket::getFromSSL(ssl);
1666
1667   VLOG(3) <<  "AsyncSSLSocket::sslVerifyCallback() this=" << self << ", "
1668           << "fd=" << self->fd_ << ", preverifyOk=" << preverifyOk;
1669   return (self->handshakeCallback_) ?
1670     self->handshakeCallback_->handshakeVer(self, preverifyOk, x509Ctx) :
1671     preverifyOk;
1672 }
1673
1674 void AsyncSSLSocket::setPreReceivedData(std::unique_ptr<IOBuf> data) {
1675   CHECK(sslState_ == STATE_UNINIT || sslState_ == STATE_UNENCRYPTED);
1676   CHECK(!preReceivedData_);
1677   preReceivedData_ = std::move(data);
1678 }
1679
1680 void AsyncSSLSocket::enableClientHelloParsing()  {
1681     parseClientHello_ = true;
1682     clientHelloInfo_.reset(new ssl::ClientHelloInfo());
1683 }
1684
1685 void AsyncSSLSocket::resetClientHelloParsing(SSL *ssl)  {
1686   SSL_set_msg_callback(ssl, nullptr);
1687   SSL_set_msg_callback_arg(ssl, nullptr);
1688   clientHelloInfo_->clientHelloBuf_.clear();
1689 }
1690
1691 void AsyncSSLSocket::clientHelloParsingCallback(int written,
1692                                                 int /* version */,
1693                                                 int contentType,
1694                                                 const void* buf,
1695                                                 size_t len,
1696                                                 SSL* ssl,
1697                                                 void* arg) {
1698   AsyncSSLSocket *sock = static_cast<AsyncSSLSocket*>(arg);
1699   if (written != 0) {
1700     sock->resetClientHelloParsing(ssl);
1701     return;
1702   }
1703   if (contentType != SSL3_RT_HANDSHAKE) {
1704     return;
1705   }
1706   if (len == 0) {
1707     return;
1708   }
1709
1710   auto& clientHelloBuf = sock->clientHelloInfo_->clientHelloBuf_;
1711   clientHelloBuf.append(IOBuf::wrapBuffer(buf, len));
1712   try {
1713     Cursor cursor(clientHelloBuf.front());
1714     if (cursor.read<uint8_t>() != SSL3_MT_CLIENT_HELLO) {
1715       sock->resetClientHelloParsing(ssl);
1716       return;
1717     }
1718
1719     if (cursor.totalLength() < 3) {
1720       clientHelloBuf.trimEnd(len);
1721       clientHelloBuf.append(IOBuf::copyBuffer(buf, len));
1722       return;
1723     }
1724
1725     uint32_t messageLength = cursor.read<uint8_t>();
1726     messageLength <<= 8;
1727     messageLength |= cursor.read<uint8_t>();
1728     messageLength <<= 8;
1729     messageLength |= cursor.read<uint8_t>();
1730     if (cursor.totalLength() < messageLength) {
1731       clientHelloBuf.trimEnd(len);
1732       clientHelloBuf.append(IOBuf::copyBuffer(buf, len));
1733       return;
1734     }
1735
1736     sock->clientHelloInfo_->clientHelloMajorVersion_ = cursor.read<uint8_t>();
1737     sock->clientHelloInfo_->clientHelloMinorVersion_ = cursor.read<uint8_t>();
1738
1739     cursor.skip(4); // gmt_unix_time
1740     cursor.skip(28); // random_bytes
1741
1742     cursor.skip(cursor.read<uint8_t>()); // session_id
1743
1744     uint16_t cipherSuitesLength = cursor.readBE<uint16_t>();
1745     for (int i = 0; i < cipherSuitesLength; i += 2) {
1746       sock->clientHelloInfo_->
1747         clientHelloCipherSuites_.push_back(cursor.readBE<uint16_t>());
1748     }
1749
1750     uint8_t compressionMethodsLength = cursor.read<uint8_t>();
1751     for (int i = 0; i < compressionMethodsLength; ++i) {
1752       sock->clientHelloInfo_->
1753         clientHelloCompressionMethods_.push_back(cursor.readBE<uint8_t>());
1754     }
1755
1756     if (cursor.totalLength() > 0) {
1757       uint16_t extensionsLength = cursor.readBE<uint16_t>();
1758       while (extensionsLength) {
1759         ssl::TLSExtension extensionType =
1760             static_cast<ssl::TLSExtension>(cursor.readBE<uint16_t>());
1761         sock->clientHelloInfo_->
1762           clientHelloExtensions_.push_back(extensionType);
1763         extensionsLength -= 2;
1764         uint16_t extensionDataLength = cursor.readBE<uint16_t>();
1765         extensionsLength -= 2;
1766         extensionsLength -= extensionDataLength;
1767
1768         if (extensionType == ssl::TLSExtension::SIGNATURE_ALGORITHMS) {
1769           cursor.skip(2);
1770           extensionDataLength -= 2;
1771           while (extensionDataLength) {
1772             ssl::HashAlgorithm hashAlg =
1773                 static_cast<ssl::HashAlgorithm>(cursor.readBE<uint8_t>());
1774             ssl::SignatureAlgorithm sigAlg =
1775                 static_cast<ssl::SignatureAlgorithm>(cursor.readBE<uint8_t>());
1776             extensionDataLength -= 2;
1777             sock->clientHelloInfo_->
1778               clientHelloSigAlgs_.emplace_back(hashAlg, sigAlg);
1779           }
1780         } else if (extensionType == ssl::TLSExtension::SUPPORTED_VERSIONS) {
1781           cursor.skip(1);
1782           extensionDataLength -= 1;
1783           while (extensionDataLength) {
1784             sock->clientHelloInfo_->clientHelloSupportedVersions_.push_back(
1785                 cursor.readBE<uint16_t>());
1786             extensionDataLength -= 2;
1787           }
1788         } else {
1789           cursor.skip(extensionDataLength);
1790         }
1791       }
1792     }
1793   } catch (std::out_of_range&) {
1794     // we'll use what we found and cleanup below.
1795     VLOG(4) << "AsyncSSLSocket::clientHelloParsingCallback(): "
1796       << "buffer finished unexpectedly." << " AsyncSSLSocket socket=" << sock;
1797   }
1798
1799   sock->resetClientHelloParsing(ssl);
1800 }
1801
1802 void AsyncSSLSocket::getSSLClientCiphers(
1803     std::string& clientCiphers,
1804     bool convertToString) const {
1805   std::string ciphers;
1806
1807   if (parseClientHello_ == false
1808       || clientHelloInfo_->clientHelloCipherSuites_.empty()) {
1809     clientCiphers = "";
1810     return;
1811   }
1812
1813   bool first = true;
1814   for (auto originalCipherCode : clientHelloInfo_->clientHelloCipherSuites_)
1815   {
1816     if (first) {
1817       first = false;
1818     } else {
1819       ciphers +=  ":";
1820     }
1821
1822     bool nameFound = convertToString;
1823
1824     if (convertToString) {
1825       const auto& name = OpenSSLUtils::getCipherName(originalCipherCode);
1826       if (name.empty()) {
1827         nameFound = false;
1828       } else {
1829         ciphers += name;
1830       }
1831     }
1832
1833     if (!nameFound) {
1834       folly::hexlify(
1835           std::array<uint8_t, 2>{{
1836               static_cast<uint8_t>((originalCipherCode >> 8) & 0xffL),
1837               static_cast<uint8_t>(originalCipherCode & 0x00ffL) }},
1838           ciphers,
1839           /* append to ciphers = */ true);
1840     }
1841   }
1842
1843   clientCiphers = std::move(ciphers);
1844 }
1845
1846 std::string AsyncSSLSocket::getSSLClientComprMethods() const {
1847   if (!parseClientHello_) {
1848     return "";
1849   }
1850   return folly::join(":", clientHelloInfo_->clientHelloCompressionMethods_);
1851 }
1852
1853 std::string AsyncSSLSocket::getSSLClientExts() const {
1854   if (!parseClientHello_) {
1855     return "";
1856   }
1857   return folly::join(":", clientHelloInfo_->clientHelloExtensions_);
1858 }
1859
1860 std::string AsyncSSLSocket::getSSLClientSigAlgs() const {
1861   if (!parseClientHello_) {
1862     return "";
1863   }
1864
1865   std::string sigAlgs;
1866   sigAlgs.reserve(clientHelloInfo_->clientHelloSigAlgs_.size() * 4);
1867   for (size_t i = 0; i < clientHelloInfo_->clientHelloSigAlgs_.size(); i++) {
1868     if (i) {
1869       sigAlgs.push_back(':');
1870     }
1871     sigAlgs.append(folly::to<std::string>(
1872         clientHelloInfo_->clientHelloSigAlgs_[i].first));
1873     sigAlgs.push_back(',');
1874     sigAlgs.append(folly::to<std::string>(
1875         clientHelloInfo_->clientHelloSigAlgs_[i].second));
1876   }
1877
1878   return sigAlgs;
1879 }
1880
1881 std::string AsyncSSLSocket::getSSLClientSupportedVersions() const {
1882   if (!parseClientHello_) {
1883     return "";
1884   }
1885   return folly::join(":", clientHelloInfo_->clientHelloSupportedVersions_);
1886 }
1887
1888 std::string AsyncSSLSocket::getSSLAlertsReceived() const {
1889   std::string ret;
1890
1891   for (const auto& alert : alertsReceived_) {
1892     if (!ret.empty()) {
1893       ret.append(",");
1894     }
1895     ret.append(folly::to<std::string>(alert.first, ": ", alert.second));
1896   }
1897
1898   return ret;
1899 }
1900
1901 void AsyncSSLSocket::getSSLSharedCiphers(std::string& sharedCiphers) const {
1902   char ciphersBuffer[1024];
1903   ciphersBuffer[0] = '\0';
1904   SSL_get_shared_ciphers(ssl_, ciphersBuffer, sizeof(ciphersBuffer) - 1);
1905   sharedCiphers = ciphersBuffer;
1906 }
1907
1908 void AsyncSSLSocket::getSSLServerCiphers(std::string& serverCiphers) const {
1909   serverCiphers = SSL_get_cipher_list(ssl_, 0);
1910   int i = 1;
1911   const char *cipher;
1912   while ((cipher = SSL_get_cipher_list(ssl_, i)) != nullptr) {
1913     serverCiphers.append(":");
1914     serverCiphers.append(cipher);
1915     i++;
1916   }
1917 }
1918
1919 } // namespace