folly/io/async/AsyncSSLSocket.h

   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 #pragma once
  18
  19 #include <arpa/inet.h>
  20 #include <iomanip>
  21 #include <openssl/ssl.h>
  22
  23 #include <folly/Optional.h>
  24 #include <folly/String.h>
  25 #include <folly/io/async/AsyncSocket.h>
  26 #include <folly/io/async/SSLContext.h>
  27 #include <folly/io/async/AsyncTimeout.h>
  28 #include <folly/io/async/TimeoutManager.h>
  29
  30 #include <folly/Bits.h>
  31 #include <folly/io/IOBuf.h>
  32 #include <folly/io/Cursor.h>
  33
  34 namespace folly {
  35
  36 class SSLException: public folly::AsyncSocketException {
  37  public:
  38   SSLException(int sslError, int errno_copy);
  39
  40   int getSSLError() const { return error_; }
  41
  42  protected:
  43   int error_;
  44   char msg_[256];
  45 };
  46
  47 /**
  48  * A class for performing asynchronous I/O on an SSL connection.
  49  *
  50  * AsyncSSLSocket allows users to asynchronously wait for data on an
  51  * SSL connection, and to asynchronously send data.
  52  *
  53  * The APIs for reading and writing are intentionally asymmetric.
  54  * Waiting for data to read is a persistent API: a callback is
  55  * installed, and is notified whenever new data is available.  It
  56  * continues to be notified of new events until it is uninstalled.
  57  *
  58  * AsyncSSLSocket does not provide read timeout functionality,
  59  * because it typically cannot determine when the timeout should be
  60  * active.  Generally, a timeout should only be enabled when
  61  * processing is blocked waiting on data from the remote endpoint.
  62  * For server connections, the timeout should not be active if the
  63  * server is currently processing one or more outstanding requests for
  64  * this connection.  For client connections, the timeout should not be
  65  * active if there are no requests pending on the connection.
  66  * Additionally, if a client has multiple pending requests, it will
  67  * ususally want a separate timeout for each request, rather than a
  68  * single read timeout.
  69  *
  70  * The write API is fairly intuitive: a user can request to send a
  71  * block of data, and a callback will be informed once the entire
  72  * block has been transferred to the kernel, or on error.
  73  * AsyncSSLSocket does provide a send timeout, since most callers
  74  * want to give up if the remote end stops responding and no further
  75  * progress can be made sending the data.
  76  */
  77 class AsyncSSLSocket : public virtual AsyncSocket {
  78  public:
  79   typedef std::unique_ptr<AsyncSSLSocket, Destructor> UniquePtr;
  80   using X509_deleter = folly::static_function_deleter<X509, &X509_free>;
  81
  82   class HandshakeCB {
  83    public:
  84     virtual ~HandshakeCB() = default;
  85
  86     /**
  87      * handshakeVer() is invoked during handshaking to give the
  88      * application chance to validate it's peer's certificate.
  89      *
  90      * Note that OpenSSL performs only rudimentary internal
  91      * consistency verification checks by itself. Any other validation
  92      * like whether or not the certificate was issued by a trusted CA.
  93      * The default implementation of this callback mimics what what
  94      * OpenSSL does internally if SSL_VERIFY_PEER is set with no
  95      * verification callback.
  96      *
  97      * See the passages on verify_callback in SSL_CTX_set_verify(3)
  98      * for more details.
  99      */
 100     virtual bool handshakeVer(AsyncSSLSocket* /*sock*/,
 101                                  bool preverifyOk,
 102                                  X509_STORE_CTX* /*ctx*/) noexcept {
 103       return preverifyOk;
 104     }
 105
 106     /**
 107      * handshakeSuc() is called when a new SSL connection is
 108      * established, i.e., after SSL_accept/connect() returns successfully.
 109      *
 110      * The HandshakeCB will be uninstalled before handshakeSuc()
 111      * is called.
 112      *
 113      * @param sock  SSL socket on which the handshake was initiated
 114      */
 115     virtual void handshakeSuc(AsyncSSLSocket *sock) noexcept = 0;
 116
 117     /**
 118      * handshakeErr() is called if an error occurs while
 119      * establishing the SSL connection.
 120      *
 121      * The HandshakeCB will be uninstalled before handshakeErr()
 122      * is called.
 123      *
 124      * @param sock  SSL socket on which the handshake was initiated
 125      * @param ex  An exception representing the error.
 126      */
 127     virtual void handshakeErr(
 128       AsyncSSLSocket *sock,
 129       const AsyncSocketException& ex)
 130       noexcept = 0;
 131   };
 132
 133   class HandshakeTimeout : public AsyncTimeout {
 134    public:
 135     HandshakeTimeout(AsyncSSLSocket* sslSocket, EventBase* eventBase)
 136       : AsyncTimeout(eventBase)
 137       , sslSocket_(sslSocket) {}
 138
 139     virtual void timeoutExpired() noexcept {
 140       sslSocket_->timeoutExpired();
 141     }
 142
 143    private:
 144     AsyncSSLSocket* sslSocket_;
 145   };
 146
 147
 148   /**
 149    * These are passed to the application via errno, packed in an SSL err which
 150    * are outside the valid errno range.  The values are chosen to be unique
 151    * against values in ssl.h
 152    */
 153   enum SSLError {
 154     SSL_CLIENT_RENEGOTIATION_ATTEMPT = 900,
 155     SSL_INVALID_RENEGOTIATION = 901,
 156     SSL_EARLY_WRITE = 902
 157   };
 158
 159   /**
 160    * Create a client AsyncSSLSocket
 161    */
 162   AsyncSSLSocket(const std::shared_ptr<folly::SSLContext> &ctx,
 163                  EventBase* evb, bool deferSecurityNegotiation = false);
 164
 165   /**
 166    * Create a server/client AsyncSSLSocket from an already connected
 167    * socket file descriptor.
 168    *
 169    * Note that while AsyncSSLSocket enables TCP_NODELAY for sockets it creates
 170    * when connecting, it does not change the socket options when given an
 171    * existing file descriptor.  If callers want TCP_NODELAY enabled when using
 172    * this version of the constructor, they need to explicitly call
 173    * setNoDelay(true) after the constructor returns.
 174    *
 175    * @param ctx             SSL context for this connection.
 176    * @param evb EventBase that will manage this socket.
 177    * @param fd  File descriptor to take over (should be a connected socket).
 178    * @param server Is socket in server mode?
 179    * @param deferSecurityNegotiation
 180    *          unencrypted data can be sent before sslConn/Accept
 181    */
 182   AsyncSSLSocket(const std::shared_ptr<folly::SSLContext>& ctx,
 183                  EventBase* evb, int fd,
 184                  bool server = true, bool deferSecurityNegotiation = false);
 185
 186
 187   /**
 188    * Helper function to create a server/client shared_ptr<AsyncSSLSocket>.
 189    */
 190   static std::shared_ptr<AsyncSSLSocket> newSocket(
 191     const std::shared_ptr<folly::SSLContext>& ctx,
 192     EventBase* evb, int fd, bool server=true,
 193     bool deferSecurityNegotiation = false) {
 194     return std::shared_ptr<AsyncSSLSocket>(
 195       new AsyncSSLSocket(ctx, evb, fd, server, deferSecurityNegotiation),
 196       Destructor());
 197   }
 198
 199   /**
 200    * Helper function to create a client shared_ptr<AsyncSSLSocket>.
 201    */
 202   static std::shared_ptr<AsyncSSLSocket> newSocket(
 203     const std::shared_ptr<folly::SSLContext>& ctx,
 204     EventBase* evb, bool deferSecurityNegotiation = false) {
 205     return std::shared_ptr<AsyncSSLSocket>(
 206       new AsyncSSLSocket(ctx, evb, deferSecurityNegotiation),
 207       Destructor());
 208   }
 209
 210
 211 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
 212   /**
 213    * Create a client AsyncSSLSocket with tlsext_servername in
 214    * the Client Hello message.
 215    */
 216   AsyncSSLSocket(const std::shared_ptr<folly::SSLContext> &ctx,
 217                   EventBase* evb,
 218                  const std::string& serverName,
 219                 bool deferSecurityNegotiation = false);
 220
 221   /**
 222    * Create a client AsyncSSLSocket from an already connected
 223    * socket file descriptor.
 224    *
 225    * Note that while AsyncSSLSocket enables TCP_NODELAY for sockets it creates
 226    * when connecting, it does not change the socket options when given an
 227    * existing file descriptor.  If callers want TCP_NODELAY enabled when using
 228    * this version of the constructor, they need to explicitly call
 229    * setNoDelay(true) after the constructor returns.
 230    *
 231    * @param ctx  SSL context for this connection.
 232    * @param evb  EventBase that will manage this socket.
 233    * @param fd   File descriptor to take over (should be a connected socket).
 234    * @param serverName tlsext_hostname that will be sent in ClientHello.
 235    */
 236   AsyncSSLSocket(const std::shared_ptr<folly::SSLContext>& ctx,
 237                   EventBase* evb,
 238                   int fd,
 239                  const std::string& serverName,
 240                 bool deferSecurityNegotiation = false);
 241
 242   static std::shared_ptr<AsyncSSLSocket> newSocket(
 243     const std::shared_ptr<folly::SSLContext>& ctx,
 244     EventBase* evb,
 245     const std::string& serverName,
 246     bool deferSecurityNegotiation = false) {
 247     return std::shared_ptr<AsyncSSLSocket>(
 248       new AsyncSSLSocket(ctx, evb, serverName, deferSecurityNegotiation),
 249       Destructor());
 250   }
 251 #endif
 252
 253   /**
 254    * TODO: implement support for SSL renegotiation.
 255    *
 256    * This involves proper handling of the SSL_ERROR_WANT_READ/WRITE
 257    * code as a result of SSL_write/read(), instead of returning an
 258    * error. In that case, the READ/WRITE event should be registered,
 259    * and a flag (e.g., writeBlockedOnRead) should be set to indiciate
 260    * the condition. In the next invocation of read/write callback, if
 261    * the flag is on, performWrite()/performRead() should be called in
 262    * addition to the normal call to performRead()/performWrite(), and
 263    * the flag should be reset.
 264    */
 265
 266   // Inherit TAsyncTransport methods from AsyncSocket except the
 267   // following.
 268   // See the documentation in TAsyncTransport.h
 269   // TODO: implement graceful shutdown in close()
 270   // TODO: implement detachSSL() that returns the SSL connection
 271   virtual void closeNow() override;
 272   virtual void shutdownWrite() override;
 273   virtual void shutdownWriteNow() override;
 274   virtual bool good() const override;
 275   virtual bool connecting() const override;
 276
 277   bool isEorTrackingEnabled() const override;
 278   virtual void setEorTracking(bool track) override;
 279   virtual size_t getRawBytesWritten() const override;
 280   virtual size_t getRawBytesReceived() const override;
 281   void enableClientHelloParsing();
 282
 283   /**
 284    * Accept an SSL connection on the socket.
 285    *
 286    * The callback will be invoked and uninstalled when an SSL
 287    * connection has been established on the underlying socket.
 288    * The value of verifyPeer determines the client verification method.
 289    * By default, its set to use the value in the underlying context
 290    *
 291    * @param callback callback object to invoke on success/failure
 292    * @param timeout timeout for this function in milliseconds, or 0 for no
 293    *                timeout
 294    * @param verifyPeer  SSLVerifyPeerEnum uses the options specified in the
 295    *                context by default, can be set explcitly to override the
 296    *                method in the context
 297    */
 298   virtual void sslAccept(HandshakeCB* callback, uint32_t timeout = 0,
 299       const folly::SSLContext::SSLVerifyPeerEnum& verifyPeer =
 300             folly::SSLContext::SSLVerifyPeerEnum::USE_CTX);
 301
 302   /**
 303    * Invoke SSL accept following an asynchronous session cache lookup
 304    */
 305   void restartSSLAccept();
 306
 307   /**
 308    * Connect to the given address, invoking callback when complete or on error
 309    *
 310    * Note timeout applies to TCP + SSL connection time
 311    */
 312   void connect(ConnectCallback* callback,
 313                const folly::SocketAddress& address,
 314                int timeout = 0,
 315                const OptionMap &options = emptyOptionMap,
 316                const folly::SocketAddress& bindAddr = anyAddress())
 317                noexcept override;
 318
 319   using AsyncSocket::connect;
 320
 321   /**
 322    * Initiate an SSL connection on the socket
 323    * The callback will be invoked and uninstalled when an SSL connection
 324    * has been establshed on the underlying socket.
 325    * The verification option verifyPeer is applied if it's passed explicitly.
 326    * If it's not, the options in SSLContext set on the underlying SSLContext
 327    * are applied.
 328    *
 329    * @param callback callback object to invoke on success/failure
 330    * @param timeout timeout for this function in milliseconds, or 0 for no
 331    *                timeout
 332    * @param verifyPeer  SSLVerifyPeerEnum uses the options specified in the
 333    *                context by default, can be set explcitly to override the
 334    *                method in the context. If verification is turned on sets
 335    *                SSL_VERIFY_PEER and invokes
 336    *                HandshakeCB::handshakeVer().
 337    */
 338   virtual void sslConn(HandshakeCB *callback, uint64_t timeout = 0,
 339             const folly::SSLContext::SSLVerifyPeerEnum& verifyPeer =
 340                   folly::SSLContext::SSLVerifyPeerEnum::USE_CTX);
 341
 342   enum SSLStateEnum {
 343     STATE_UNINIT,
 344     STATE_UNENCRYPTED,
 345     STATE_ACCEPTING,
 346     STATE_CACHE_LOOKUP,
 347     STATE_RSA_ASYNC_PENDING,
 348     STATE_CONNECTING,
 349     STATE_ESTABLISHED,
 350     STATE_REMOTE_CLOSED, /// remote end closed; we can still write
 351     STATE_CLOSING,       ///< close() called, but waiting on writes to complete
 352     /// close() called with pending writes, before connect() has completed
 353     STATE_CONNECTING_CLOSING,
 354     STATE_CLOSED,
 355     STATE_ERROR
 356   };
 357
 358   SSLStateEnum getSSLState() const { return sslState_;}
 359
 360   /**
 361    * Get a handle to the negotiated SSL session.  This increments the session
 362    * refcount and must be deallocated by the caller.
 363    */
 364   SSL_SESSION *getSSLSession();
 365
 366   /**
 367    * Set the SSL session to be used during sslConn.  AsyncSSLSocket will
 368    * hold a reference to the session until it is destroyed or released by the
 369    * underlying SSL structure.
 370    *
 371    * @param takeOwnership if true, AsyncSSLSocket will assume the caller's
 372    *                      reference count to session.
 373    */
 374   void setSSLSession(SSL_SESSION *session, bool takeOwnership = false);
 375
 376   /**
 377    * Get the name of the protocol selected by the client during
 378    * Next Protocol Negotiation (NPN)
 379    *
 380    * Throw an exception if openssl does not support NPN
 381    *
 382    * @param protoName      Name of the protocol (not guaranteed to be
 383    *                       null terminated); will be set to nullptr if
 384    *                       the client did not negotiate a protocol.
 385    *                       Note: the AsyncSSLSocket retains ownership
 386    *                       of this string.
 387    * @param protoNameLen   Length of the name.
 388    */
 389   virtual void getSelectedNextProtocol(const unsigned char** protoName,
 390       unsigned* protoLen) const;
 391
 392   /**
 393    * Get the name of the protocol selected by the client during
 394    * Next Protocol Negotiation (NPN)
 395    *
 396    * @param protoName      Name of the protocol (not guaranteed to be
 397    *                       null terminated); will be set to nullptr if
 398    *                       the client did not negotiate a protocol.
 399    *                       Note: the AsyncSSLSocket retains ownership
 400    *                       of this string.
 401    * @param protoNameLen   Length of the name.
 402    * @return false if openssl does not support NPN
 403    */
 404   virtual bool getSelectedNextProtocolNoThrow(const unsigned char** protoName,
 405       unsigned* protoLen) const;
 406
 407   /**
 408    * Determine if the session specified during setSSLSession was reused
 409    * or if the server rejected it and issued a new session.
 410    */
 411   bool getSSLSessionReused() const;
 412
 413   /**
 414    * true if the session was resumed using session ID
 415    */
 416   bool sessionIDResumed() const { return sessionIDResumed_; }
 417
 418   void setSessionIDResumed(bool resumed) {
 419     sessionIDResumed_ = resumed;
 420   }
 421
 422   /**
 423    * Get the negociated cipher name for this SSL connection.
 424    * Returns the cipher used or the constant value "NONE" when no SSL session
 425    * has been established.
 426    */
 427   const char *getNegotiatedCipherName() const;
 428
 429   /**
 430    * Get the server name for this SSL connection.
 431    * Returns the server name used or the constant value "NONE" when no SSL
 432    * session has been established.
 433    * If openssl has no SNI support, throw TTransportException.
 434    */
 435   const char *getSSLServerName() const;
 436
 437   /**
 438    * Get the server name for this SSL connection.
 439    * Returns the server name used or the constant value "NONE" when no SSL
 440    * session has been established.
 441    * If openssl has no SNI support, return "NONE"
 442    */
 443   const char *getSSLServerNameNoThrow() const;
 444
 445   /**
 446    * Get the SSL version for this connection.
 447    * Possible return values are SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
 448    * with hexa representations 0x200, 0x300, 0x301,
 449    * or 0 if no SSL session has been established.
 450    */
 451   int getSSLVersion() const;
 452
 453   /**
 454    * Get the certificate size used for this SSL connection.
 455    */
 456   int getSSLCertSize() const;
 457
 458   /* Get the number of bytes read from the wire (including protocol
 459    * overhead). Returns 0 once the connection has been closed.
 460    */
 461   unsigned long getBytesRead() const {
 462     if (ssl_ != nullptr) {
 463       return BIO_number_read(SSL_get_rbio(ssl_));
 464     }
 465     return 0;
 466   }
 467
 468   /* Get the number of bytes written to the wire (including protocol
 469    * overhead).  Returns 0 once the connection has been closed.
 470    */
 471   unsigned long getBytesWritten() const {
 472     if (ssl_ != nullptr) {
 473       return BIO_number_written(SSL_get_wbio(ssl_));
 474     }
 475     return 0;
 476   }
 477
 478   virtual void attachEventBase(EventBase* eventBase) override {
 479     AsyncSocket::attachEventBase(eventBase);
 480     handshakeTimeout_.attachEventBase(eventBase);
 481   }
 482
 483   virtual void detachEventBase() override {
 484     AsyncSocket::detachEventBase();
 485     handshakeTimeout_.detachEventBase();
 486   }
 487
 488   virtual bool isDetachable() const override {
 489     return AsyncSocket::isDetachable() && !handshakeTimeout_.isScheduled();
 490   }
 491
 492   virtual void attachTimeoutManager(TimeoutManager* manager) {
 493     handshakeTimeout_.attachTimeoutManager(manager);
 494   }
 495
 496   virtual void detachTimeoutManager() {
 497     handshakeTimeout_.detachTimeoutManager();
 498   }
 499
 500 #if OPENSSL_VERSION_NUMBER >= 0x009080bfL
 501   /**
 502    * This function will set the SSL context for this socket to the
 503    * argument. This should only be used on client SSL Sockets that have
 504    * already called detachSSLContext();
 505    */
 506   void attachSSLContext(const std::shared_ptr<folly::SSLContext>& ctx);
 507
 508   /**
 509    * Detaches the SSL context for this socket.
 510    */
 511   void detachSSLContext();
 512 #endif
 513
 514 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
 515   /**
 516    * Switch the SSLContext to continue the SSL handshake.
 517    * It can only be used in server mode.
 518    */
 519   void switchServerSSLContext(
 520     const std::shared_ptr<folly::SSLContext>& handshakeCtx);
 521
 522   /**
 523    * Did server recognize/support the tlsext_hostname in Client Hello?
 524    * It can only be used in client mode.
 525    *
 526    * @return true - tlsext_hostname is matched by the server
 527    *         false - tlsext_hostname is not matched or
 528    *                 is not supported by server
 529    */
 530   bool isServerNameMatch() const;
 531
 532   /**
 533    * Set the SNI hostname that we'll advertise to the server in the
 534    * ClientHello message.
 535    */
 536   void setServerName(std::string serverName) noexcept;
 537 #endif
 538
 539   void timeoutExpired() noexcept;
 540
 541   /**
 542    * Get the list of supported ciphers sent by the client in the client's
 543    * preference order.
 544    */
 545   void getSSLClientCiphers(std::string& clientCiphers) const {
 546     std::stringstream ciphersStream;
 547     std::string cipherName;
 548
 549     if (parseClientHello_ == false
 550         || clientHelloInfo_->clientHelloCipherSuites_.empty()) {
 551       clientCiphers = "";
 552       return;
 553     }
 554
 555     for (auto originalCipherCode : clientHelloInfo_->clientHelloCipherSuites_)
 556     {
 557       // OpenSSL expects code as a big endian char array
 558       auto cipherCode = htons(originalCipherCode);
 559
 560 #if defined(SSL_OP_NO_TLSv1_2)
 561       const SSL_CIPHER* cipher =
 562           TLSv1_2_method()->get_cipher_by_char((unsigned char*)&cipherCode);
 563 #elif defined(SSL_OP_NO_TLSv1_1)
 564       const SSL_CIPHER* cipher =
 565           TLSv1_1_method()->get_cipher_by_char((unsigned char*)&cipherCode);
 566 #elif defined(SSL_OP_NO_TLSv1)
 567       const SSL_CIPHER* cipher =
 568           TLSv1_method()->get_cipher_by_char((unsigned char*)&cipherCode);
 569 #else
 570       const SSL_CIPHER* cipher =
 571           SSLv3_method()->get_cipher_by_char((unsigned char*)&cipherCode);
 572 #endif
 573
 574       if (cipher == nullptr) {
 575         ciphersStream << std::setfill('0') << std::setw(4) << std::hex
 576                       << originalCipherCode << ":";
 577       } else {
 578         ciphersStream << SSL_CIPHER_get_name(cipher) << ":";
 579       }
 580     }
 581
 582     clientCiphers = ciphersStream.str();
 583     clientCiphers.erase(clientCiphers.end() - 1);
 584   }
 585
 586   /**
 587    * Get the list of compression methods sent by the client in TLS Hello.
 588    */
 589   std::string getSSLClientComprMethods() const {
 590     if (!parseClientHello_) {
 591       return "";
 592     }
 593     return folly::join(":", clientHelloInfo_->clientHelloCompressionMethods_);
 594   }
 595
 596   /**
 597    * Get the list of TLS extensions sent by the client in the TLS Hello.
 598    */
 599   std::string getSSLClientExts() const {
 600     if (!parseClientHello_) {
 601       return "";
 602     }
 603     return folly::join(":", clientHelloInfo_->clientHelloExtensions_);
 604   }
 605
 606   std::string getSSLClientSigAlgs() const {
 607     if (!parseClientHello_) {
 608       return "";
 609     }
 610
 611     std::string sigAlgs;
 612     sigAlgs.reserve(clientHelloInfo_->clientHelloSigAlgs_.size() * 4);
 613     for (size_t i = 0; i < clientHelloInfo_->clientHelloSigAlgs_.size(); i++) {
 614       if (i) {
 615         sigAlgs.push_back(':');
 616       }
 617       sigAlgs.append(folly::to<std::string>(
 618           clientHelloInfo_->clientHelloSigAlgs_[i].first));
 619       sigAlgs.push_back(',');
 620       sigAlgs.append(folly::to<std::string>(
 621           clientHelloInfo_->clientHelloSigAlgs_[i].second));
 622     }
 623
 624     return sigAlgs;
 625   }
 626
 627   /**
 628    * Get the list of shared ciphers between the server and the client.
 629    * Works well for only SSLv2, not so good for SSLv3 or TLSv1.
 630    */
 631   void getSSLSharedCiphers(std::string& sharedCiphers) const {
 632     char ciphersBuffer[1024];
 633     ciphersBuffer[0] = '\0';
 634     SSL_get_shared_ciphers(ssl_, ciphersBuffer, sizeof(ciphersBuffer) - 1);
 635     sharedCiphers = ciphersBuffer;
 636   }
 637
 638   /**
 639    * Get the list of ciphers supported by the server in the server's
 640    * preference order.
 641    */
 642   void getSSLServerCiphers(std::string& serverCiphers) const {
 643     serverCiphers = SSL_get_cipher_list(ssl_, 0);
 644     int i = 1;
 645     const char *cipher;
 646     while ((cipher = SSL_get_cipher_list(ssl_, i)) != nullptr) {
 647       serverCiphers.append(":");
 648       serverCiphers.append(cipher);
 649       i++;
 650     }
 651   }
 652
 653   static int getSSLExDataIndex();
 654   static AsyncSSLSocket* getFromSSL(const SSL *ssl);
 655   static int eorAwareBioWrite(BIO *b, const char *in, int inl);
 656   void resetClientHelloParsing(SSL *ssl);
 657   static void clientHelloParsingCallback(int write_p, int version,
 658       int content_type, const void *buf, size_t len, SSL *ssl, void *arg);
 659
 660   // http://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml
 661   enum class TLSExtension: uint16_t {
 662     SERVER_NAME = 0,
 663     MAX_FRAGMENT_LENGTH = 1,
 664     CLIENT_CERTIFICATE_URL = 2,
 665     TRUSTED_CA_KEYS = 3,
 666     TRUNCATED_HMAC = 4,
 667     STATUS_REQUEST = 5,
 668     USER_MAPPING = 6,
 669     CLIENT_AUTHZ = 7,
 670     SERVER_AUTHZ = 8,
 671     CERT_TYPE = 9,
 672     SUPPORTED_GROUPS = 10,
 673     EC_POINT_FORMATS = 11,
 674     SRP = 12,
 675     SIGNATURE_ALGORITHMS = 13,
 676     USE_SRTP = 14,
 677     HEARTBEAT = 15,
 678     APPLICATION_LAYER_PROTOCOL_NEGOTIATION = 16,
 679     STATUS_REQUEST_V2 = 17,
 680     SIGNED_CERTIFICATE_TIMESTAMP = 18,
 681     CLIENT_CERTIFICATE_TYPE = 19,
 682     SERVER_CERTIFICATE_TYPE = 20,
 683     PADDING = 21,
 684     ENCRYPT_THEN_MAC = 22,
 685     EXTENDED_MASTER_SECRET = 23,
 686     SESSION_TICKET = 35,
 687     RENEGOTIATION_INFO = 65281
 688   };
 689
 690   // http://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-18
 691   enum class HashAlgorithm: uint8_t {
 692     NONE = 0,
 693     MD5 = 1,
 694     SHA1 = 2,
 695     SHA224 = 3,
 696     SHA256 = 4,
 697     SHA384 = 5,
 698     SHA512 = 6
 699   };
 700
 701   // http://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-16
 702   enum class SignatureAlgorithm: uint8_t {
 703     ANONYMOUS = 0,
 704     RSA = 1,
 705     DSA = 2,
 706     ECDSA = 3
 707   };
 708
 709   struct ClientHelloInfo {
 710     folly::IOBufQueue clientHelloBuf_;
 711     uint8_t clientHelloMajorVersion_;
 712     uint8_t clientHelloMinorVersion_;
 713     std::vector<uint16_t> clientHelloCipherSuites_;
 714     std::vector<uint8_t> clientHelloCompressionMethods_;
 715     std::vector<TLSExtension> clientHelloExtensions_;
 716     std::vector<
 717       std::pair<HashAlgorithm, SignatureAlgorithm>> clientHelloSigAlgs_;
 718   };
 719
 720   // For unit-tests
 721   ClientHelloInfo* getClientHelloInfo() const {
 722     return clientHelloInfo_.get();
 723   }
 724
 725   /**
 726    * Returns the time taken to complete a handshake.
 727    */
 728   std::chrono::nanoseconds getHandshakeTime() const {
 729     return handshakeEndTime_ - handshakeStartTime_;
 730   }
 731
 732   void setMinWriteSize(size_t minWriteSize) {
 733     minWriteSize_ = minWriteSize;
 734   }
 735
 736   size_t getMinWriteSize() const {
 737     return minWriteSize_;
 738   }
 739
 740   void setReadCB(ReadCallback* callback) override;
 741
 742   /**
 743    * Returns the peer certificate, or nullptr if no peer certificate received.
 744    */
 745   std::unique_ptr<X509, X509_deleter> getPeerCert() const {
 746     if (!ssl_) {
 747       return nullptr;
 748     }
 749
 750     X509* cert = SSL_get_peer_certificate(ssl_);
 751     return std::unique_ptr<X509, X509_deleter>(cert);
 752   }
 753
 754  private:
 755
 756   void init();
 757
 758  protected:
 759
 760   /**
 761    * Protected destructor.
 762    *
 763    * Users of AsyncSSLSocket must never delete it directly.  Instead, invoke
 764    * destroy() instead.  (See the documentation in DelayedDestruction.h for
 765    * more details.)
 766    */
 767   ~AsyncSSLSocket();
 768
 769   // Inherit event notification methods from AsyncSocket except
 770   // the following.
 771   void prepareReadBuffer(void** buf, size_t* buflen) noexcept override;
 772   void handleRead() noexcept override;
 773   void handleWrite() noexcept override;
 774   void handleAccept() noexcept;
 775   void handleConnect() noexcept override;
 776
 777   void invalidState(HandshakeCB* callback);
 778   bool willBlock(int ret, int *errorOut) noexcept;
 779
 780   virtual void checkForImmediateRead() noexcept override;
 781   // AsyncSocket calls this at the wrong time for SSL
 782   void handleInitialReadWrite() noexcept override {}
 783
 784   int interpretSSLError(int rc, int error);
 785   ssize_t performRead(void** buf, size_t* buflen, size_t* offset) override;
 786   ssize_t performWrite(const iovec* vec, uint32_t count, WriteFlags flags,
 787                        uint32_t* countWritten, uint32_t* partialWritten)
 788     override;
 789
 790   ssize_t performWriteIovec(const iovec* vec, uint32_t count,
 791                             WriteFlags flags, uint32_t* countWritten,
 792                             uint32_t* partialWritten);
 793
 794   // This virtual wrapper around SSL_write exists solely for testing/mockability
 795   virtual int sslWriteImpl(SSL *ssl, const void *buf, int n) {
 796     return SSL_write(ssl, buf, n);
 797   }
 798
 799   /**
 800    * Apply verification options passed to sslConn/sslAccept or those set
 801    * in the underlying SSLContext object.
 802    *
 803    * @param ssl pointer to the SSL object on which verification options will be
 804    * applied. If verifyPeer_ was explicitly set either via sslConn/sslAccept,
 805    * those options override the settings in the underlying SSLContext.
 806    */
 807   void applyVerificationOptions(SSL * ssl);
 808
 809   /**
 810    * A SSL_write wrapper that understand EOR
 811    *
 812    * @param ssl: SSL* object
 813    * @param buf: Buffer to be written
 814    * @param n:   Number of bytes to be written
 815    * @param eor: Does the last byte (buf[n-1]) have the app-last-byte?
 816    * @return:    The number of app bytes successfully written to the socket
 817    */
 818   int eorAwareSSLWrite(SSL *ssl, const void *buf, int n, bool eor);
 819
 820   // Inherit error handling methods from AsyncSocket, plus the following.
 821   void failHandshake(const char* fn, const AsyncSocketException& ex);
 822
 823   void invokeHandshakeErr(const AsyncSocketException& ex);
 824   void invokeHandshakeCB();
 825
 826   static void sslInfoCallback(const SSL *ssl, int type, int val);
 827
 828   // Whether we've applied the TCP_CORK option to the socket
 829   bool corked_{false};
 830   // SSL related members.
 831   bool server_{false};
 832   // Used to prevent client-initiated renegotiation.  Note that AsyncSSLSocket
 833   // doesn't fully support renegotiation, so we could just fail all attempts
 834   // to enforce this.  Once it is supported, we should make it an option
 835   // to disable client-initiated renegotiation.
 836   bool handshakeComplete_{false};
 837   bool renegotiateAttempted_{false};
 838   SSLStateEnum sslState_{STATE_UNINIT};
 839   std::shared_ptr<folly::SSLContext> ctx_;
 840   // Callback for SSL_accept() or SSL_connect()
 841   HandshakeCB* handshakeCallback_{nullptr};
 842   SSL* ssl_{nullptr};
 843   SSL_SESSION *sslSession_{nullptr};
 844   HandshakeTimeout handshakeTimeout_;
 845   // whether the SSL session was resumed using session ID or not
 846   bool sessionIDResumed_{false};
 847
 848   // The app byte num that we are tracking for the MSG_EOR
 849   // Only one app EOR byte can be tracked.
 850   size_t appEorByteNo_{0};
 851
 852   // Try to avoid calling SSL_write() for buffers smaller than this.
 853   // It doesn't take effect when it is 0.
 854   size_t minWriteSize_{1500};
 855
 856   // When openssl is about to sendmsg() across the minEorRawBytesNo_,
 857   // it will pass MSG_EOR to sendmsg().
 858   size_t minEorRawByteNo_{0};
 859 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
 860   std::shared_ptr<folly::SSLContext> handshakeCtx_;
 861   std::string tlsextHostname_;
 862 #endif
 863   folly::SSLContext::SSLVerifyPeerEnum
 864     verifyPeer_{folly::SSLContext::SSLVerifyPeerEnum::USE_CTX};
 865
 866   // Callback for SSL_CTX_set_verify()
 867   static int sslVerifyCallback(int preverifyOk, X509_STORE_CTX* ctx);
 868
 869   bool parseClientHello_{false};
 870   std::unique_ptr<ClientHelloInfo> clientHelloInfo_;
 871
 872   // Time taken to complete the ssl handshake.
 873   std::chrono::steady_clock::time_point handshakeStartTime_;
 874   std::chrono::steady_clock::time_point handshakeEndTime_;
 875 };
 876
 877 } // namespace