folly/io/async/AsyncSSLSocket.cpp

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