folly/io/async/AsyncSSLSocket.h

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18
  19 #include <iomanip>
  20
  21 #include <folly/Optional.h>
  22 #include <folly/String.h>
  23 #include <folly/io/async/AsyncSocket.h>
  24 #include <folly/io/async/AsyncTimeout.h>
  25 #include <folly/io/async/SSLContext.h>
  26 #include <folly/io/async/TimeoutManager.h>
  27 #include <folly/io/async/ssl/OpenSSLPtrTypes.h>
  28 #include <folly/io/async/ssl/OpenSSLUtils.h>
  29 #include <folly/io/async/ssl/SSLErrors.h>
  30 #include <folly/io/async/ssl/TLSDefinitions.h>
  31
  32 #include <folly/Bits.h>
  33 #include <folly/io/IOBuf.h>
  34 #include <folly/io/Cursor.h>
  35 #include <folly/portability/OpenSSL.h>
  36 #include <folly/portability/Sockets.h>
  37
  38 namespace folly {
  39
  40 /**
  41  * A class for performing asynchronous I/O on an SSL connection.
  42  *
  43  * AsyncSSLSocket allows users to asynchronously wait for data on an
  44  * SSL connection, and to asynchronously send data.
  45  *
  46  * The APIs for reading and writing are intentionally asymmetric.
  47  * Waiting for data to read is a persistent API: a callback is
  48  * installed, and is notified whenever new data is available.  It
  49  * continues to be notified of new events until it is uninstalled.
  50  *
  51  * AsyncSSLSocket does not provide read timeout functionality,
  52  * because it typically cannot determine when the timeout should be
  53  * active.  Generally, a timeout should only be enabled when
  54  * processing is blocked waiting on data from the remote endpoint.
  55  * For server connections, the timeout should not be active if the
  56  * server is currently processing one or more outstanding requests for
  57  * this connection.  For client connections, the timeout should not be
  58  * active if there are no requests pending on the connection.
  59  * Additionally, if a client has multiple pending requests, it will
  60  * ususally want a separate timeout for each request, rather than a
  61  * single read timeout.
  62  *
  63  * The write API is fairly intuitive: a user can request to send a
  64  * block of data, and a callback will be informed once the entire
  65  * block has been transferred to the kernel, or on error.
  66  * AsyncSSLSocket does provide a send timeout, since most callers
  67  * want to give up if the remote end stops responding and no further
  68  * progress can be made sending the data.
  69  */
  70 class AsyncSSLSocket : public virtual AsyncSocket {
  71  public:
  72   typedef std::unique_ptr<AsyncSSLSocket, Destructor> UniquePtr;
  73   using X509_deleter = folly::static_function_deleter<X509, &X509_free>;
  74
  75   class HandshakeCB {
  76    public:
  77     virtual ~HandshakeCB() = default;
  78
  79     /**
  80      * handshakeVer() is invoked during handshaking to give the
  81      * application chance to validate it's peer's certificate.
  82      *
  83      * Note that OpenSSL performs only rudimentary internal
  84      * consistency verification checks by itself. Any other validation
  85      * like whether or not the certificate was issued by a trusted CA.
  86      * The default implementation of this callback mimics what what
  87      * OpenSSL does internally if SSL_VERIFY_PEER is set with no
  88      * verification callback.
  89      *
  90      * See the passages on verify_callback in SSL_CTX_set_verify(3)
  91      * for more details.
  92      */
  93     virtual bool handshakeVer(AsyncSSLSocket* /*sock*/,
  94                                  bool preverifyOk,
  95                                  X509_STORE_CTX* /*ctx*/) noexcept {
  96       return preverifyOk;
  97     }
  98
  99     /**
 100      * handshakeSuc() is called when a new SSL connection is
 101      * established, i.e., after SSL_accept/connect() returns successfully.
 102      *
 103      * The HandshakeCB will be uninstalled before handshakeSuc()
 104      * is called.
 105      *
 106      * @param sock  SSL socket on which the handshake was initiated
 107      */
 108     virtual void handshakeSuc(AsyncSSLSocket *sock) noexcept = 0;
 109
 110     /**
 111      * handshakeErr() is called if an error occurs while
 112      * establishing the SSL connection.
 113      *
 114      * The HandshakeCB will be uninstalled before handshakeErr()
 115      * is called.
 116      *
 117      * @param sock  SSL socket on which the handshake was initiated
 118      * @param ex  An exception representing the error.
 119      */
 120     virtual void handshakeErr(
 121       AsyncSSLSocket *sock,
 122       const AsyncSocketException& ex)
 123       noexcept = 0;
 124   };
 125
 126   class Timeout : public AsyncTimeout {
 127    public:
 128     Timeout(AsyncSSLSocket* sslSocket, EventBase* eventBase)
 129         : AsyncTimeout(eventBase), sslSocket_(sslSocket) {}
 130
 131     bool scheduleTimeout(TimeoutManager::timeout_type timeout) {
 132       timeout_ = timeout;
 133       return AsyncTimeout::scheduleTimeout(timeout);
 134     }
 135
 136     bool scheduleTimeout(uint32_t timeoutMs) {
 137       return scheduleTimeout(std::chrono::milliseconds{timeoutMs});
 138     }
 139
 140     TimeoutManager::timeout_type getTimeout() {
 141       return timeout_;
 142     }
 143
 144     virtual void timeoutExpired() noexcept override {
 145       sslSocket_->timeoutExpired(timeout_);
 146     }
 147
 148    private:
 149     AsyncSSLSocket* sslSocket_;
 150     TimeoutManager::timeout_type timeout_;
 151   };
 152
 153   /**
 154    * Create a client AsyncSSLSocket
 155    */
 156   AsyncSSLSocket(const std::shared_ptr<folly::SSLContext> &ctx,
 157                  EventBase* evb, bool deferSecurityNegotiation = false);
 158
 159   /**
 160    * Create a server/client AsyncSSLSocket from an already connected
 161    * socket file descriptor.
 162    *
 163    * Note that while AsyncSSLSocket enables TCP_NODELAY for sockets it creates
 164    * when connecting, it does not change the socket options when given an
 165    * existing file descriptor.  If callers want TCP_NODELAY enabled when using
 166    * this version of the constructor, they need to explicitly call
 167    * setNoDelay(true) after the constructor returns.
 168    *
 169    * @param ctx             SSL context for this connection.
 170    * @param evb EventBase that will manage this socket.
 171    * @param fd  File descriptor to take over (should be a connected socket).
 172    * @param server Is socket in server mode?
 173    * @param deferSecurityNegotiation
 174    *          unencrypted data can be sent before sslConn/Accept
 175    */
 176   AsyncSSLSocket(const std::shared_ptr<folly::SSLContext>& ctx,
 177                  EventBase* evb, int fd,
 178                  bool server = true, bool deferSecurityNegotiation = false);
 179
 180
 181   /**
 182    * Helper function to create a server/client shared_ptr<AsyncSSLSocket>.
 183    */
 184   static std::shared_ptr<AsyncSSLSocket> newSocket(
 185     const std::shared_ptr<folly::SSLContext>& ctx,
 186     EventBase* evb, int fd, bool server=true,
 187     bool deferSecurityNegotiation = false) {
 188     return std::shared_ptr<AsyncSSLSocket>(
 189       new AsyncSSLSocket(ctx, evb, fd, server, deferSecurityNegotiation),
 190       Destructor());
 191   }
 192
 193   /**
 194    * Helper function to create a client shared_ptr<AsyncSSLSocket>.
 195    */
 196   static std::shared_ptr<AsyncSSLSocket> newSocket(
 197     const std::shared_ptr<folly::SSLContext>& ctx,
 198     EventBase* evb, bool deferSecurityNegotiation = false) {
 199     return std::shared_ptr<AsyncSSLSocket>(
 200       new AsyncSSLSocket(ctx, evb, deferSecurityNegotiation),
 201       Destructor());
 202   }
 203
 204
 205 #if FOLLY_OPENSSL_HAS_SNI
 206   /**
 207    * Create a client AsyncSSLSocket with tlsext_servername in
 208    * the Client Hello message.
 209    */
 210   AsyncSSLSocket(const std::shared_ptr<folly::SSLContext> &ctx,
 211                   EventBase* evb,
 212                  const std::string& serverName,
 213                 bool deferSecurityNegotiation = false);
 214
 215   /**
 216    * Create a client AsyncSSLSocket from an already connected
 217    * socket file descriptor.
 218    *
 219    * Note that while AsyncSSLSocket enables TCP_NODELAY for sockets it creates
 220    * when connecting, it does not change the socket options when given an
 221    * existing file descriptor.  If callers want TCP_NODELAY enabled when using
 222    * this version of the constructor, they need to explicitly call
 223    * setNoDelay(true) after the constructor returns.
 224    *
 225    * @param ctx  SSL context for this connection.
 226    * @param evb  EventBase that will manage this socket.
 227    * @param fd   File descriptor to take over (should be a connected socket).
 228    * @param serverName tlsext_hostname that will be sent in ClientHello.
 229    */
 230   AsyncSSLSocket(const std::shared_ptr<folly::SSLContext>& ctx,
 231                   EventBase* evb,
 232                   int fd,
 233                  const std::string& serverName,
 234                 bool deferSecurityNegotiation = false);
 235
 236   static std::shared_ptr<AsyncSSLSocket> newSocket(
 237     const std::shared_ptr<folly::SSLContext>& ctx,
 238     EventBase* evb,
 239     const std::string& serverName,
 240     bool deferSecurityNegotiation = false) {
 241     return std::shared_ptr<AsyncSSLSocket>(
 242       new AsyncSSLSocket(ctx, evb, serverName, deferSecurityNegotiation),
 243       Destructor());
 244   }
 245 #endif // FOLLY_OPENSSL_HAS_SNI
 246
 247   /**
 248    * TODO: implement support for SSL renegotiation.
 249    *
 250    * This involves proper handling of the SSL_ERROR_WANT_READ/WRITE
 251    * code as a result of SSL_write/read(), instead of returning an
 252    * error. In that case, the READ/WRITE event should be registered,
 253    * and a flag (e.g., writeBlockedOnRead) should be set to indiciate
 254    * the condition. In the next invocation of read/write callback, if
 255    * the flag is on, performWrite()/performRead() should be called in
 256    * addition to the normal call to performRead()/performWrite(), and
 257    * the flag should be reset.
 258    */
 259
 260   // Inherit TAsyncTransport methods from AsyncSocket except the
 261   // following.
 262   // See the documentation in TAsyncTransport.h
 263   // TODO: implement graceful shutdown in close()
 264   // TODO: implement detachSSL() that returns the SSL connection
 265   virtual void closeNow() override;
 266   virtual void shutdownWrite() override;
 267   virtual void shutdownWriteNow() override;
 268   virtual bool good() const override;
 269   virtual bool connecting() const override;
 270   virtual std::string getApplicationProtocol() noexcept override;
 271
 272   virtual std::string getSecurityProtocol() const override { return "TLS"; }
 273
 274   virtual void setEorTracking(bool track) override;
 275   virtual size_t getRawBytesWritten() const override;
 276   virtual size_t getRawBytesReceived() const override;
 277   void enableClientHelloParsing();
 278
 279   void setPreReceivedData(std::unique_ptr<IOBuf> data);
 280
 281   /**
 282    * Accept an SSL connection on the socket.
 283    *
 284    * The callback will be invoked and uninstalled when an SSL
 285    * connection has been established on the underlying socket.
 286    * The value of verifyPeer determines the client verification method.
 287    * By default, its set to use the value in the underlying context
 288    *
 289    * @param callback callback object to invoke on success/failure
 290    * @param timeout timeout for this function in milliseconds, or 0 for no
 291    *                timeout
 292    * @param verifyPeer  SSLVerifyPeerEnum uses the options specified in the
 293    *                context by default, can be set explcitly to override the
 294    *                method in the context
 295    */
 296   virtual void sslAccept(
 297       HandshakeCB* callback,
 298       std::chrono::milliseconds timeout = std::chrono::milliseconds::zero(),
 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(
 339       HandshakeCB* callback,
 340       std::chrono::milliseconds timeout = std::chrono::milliseconds::zero(),
 341       const folly::SSLContext::SSLVerifyPeerEnum& verifyPeer =
 342           folly::SSLContext::SSLVerifyPeerEnum::USE_CTX);
 343
 344   enum SSLStateEnum {
 345     STATE_UNINIT,
 346     STATE_UNENCRYPTED,
 347     STATE_ACCEPTING,
 348     STATE_CACHE_LOOKUP,
 349     STATE_ASYNC_PENDING,
 350     STATE_CONNECTING,
 351     STATE_ESTABLISHED,
 352     STATE_REMOTE_CLOSED, /// remote end closed; we can still write
 353     STATE_CLOSING,       ///< close() called, but waiting on writes to complete
 354     /// close() called with pending writes, before connect() has completed
 355     STATE_CONNECTING_CLOSING,
 356     STATE_CLOSED,
 357     STATE_ERROR
 358   };
 359
 360   SSLStateEnum getSSLState() const { return sslState_;}
 361
 362   /**
 363    * Get a handle to the negotiated SSL session.  This increments the session
 364    * refcount and must be deallocated by the caller.
 365    */
 366   SSL_SESSION *getSSLSession();
 367
 368   /**
 369    * Get a handle to the SSL struct.
 370    */
 371   const SSL* getSSL() const;
 372
 373   /**
 374    * Set the SSL session to be used during sslConn.  AsyncSSLSocket will
 375    * hold a reference to the session until it is destroyed or released by the
 376    * underlying SSL structure.
 377    *
 378    * @param takeOwnership if true, AsyncSSLSocket will assume the caller's
 379    *                      reference count to session.
 380    */
 381   void setSSLSession(SSL_SESSION *session, bool takeOwnership = false);
 382
 383   /**
 384    * Get the name of the protocol selected by the client during
 385    * Next Protocol Negotiation (NPN) or Application Layer Protocol Negotiation
 386    * (ALPN)
 387    *
 388    * Throw an exception if openssl does not support NPN
 389    *
 390    * @param protoName      Name of the protocol (not guaranteed to be
 391    *                       null terminated); will be set to nullptr if
 392    *                       the client did not negotiate a protocol.
 393    *                       Note: the AsyncSSLSocket retains ownership
 394    *                       of this string.
 395    * @param protoNameLen   Length of the name.
 396    * @param protoType      Whether this was an NPN or ALPN negotiation
 397    */
 398   virtual void getSelectedNextProtocol(
 399       const unsigned char** protoName,
 400       unsigned* protoLen,
 401       SSLContext::NextProtocolType* protoType = nullptr) const;
 402
 403   /**
 404    * Get the name of the protocol selected by the client during
 405    * Next Protocol Negotiation (NPN) or Application Layer Protocol Negotiation
 406    * (ALPN)
 407    *
 408    * @param protoName      Name of the protocol (not guaranteed to be
 409    *                       null terminated); will be set to nullptr if
 410    *                       the client did not negotiate a protocol.
 411    *                       Note: the AsyncSSLSocket retains ownership
 412    *                       of this string.
 413    * @param protoNameLen   Length of the name.
 414    * @param protoType      Whether this was an NPN or ALPN negotiation
 415    * @return false if openssl does not support NPN
 416    */
 417   virtual bool getSelectedNextProtocolNoThrow(
 418       const unsigned char** protoName,
 419       unsigned* protoLen,
 420       SSLContext::NextProtocolType* protoType = nullptr) const;
 421
 422   /**
 423    * Determine if the session specified during setSSLSession was reused
 424    * or if the server rejected it and issued a new session.
 425    */
 426   virtual bool getSSLSessionReused() const;
 427
 428   /**
 429    * true if the session was resumed using session ID
 430    */
 431   bool sessionIDResumed() const { return sessionIDResumed_; }
 432
 433   void setSessionIDResumed(bool resumed) {
 434     sessionIDResumed_ = resumed;
 435   }
 436
 437   /**
 438    * Get the negociated cipher name for this SSL connection.
 439    * Returns the cipher used or the constant value "NONE" when no SSL session
 440    * has been established.
 441    */
 442   virtual const char* getNegotiatedCipherName() const;
 443
 444   /**
 445    * Get the server name for this SSL connection.
 446    * Returns the server name used or the constant value "NONE" when no SSL
 447    * session has been established.
 448    * If openssl has no SNI support, throw TTransportException.
 449    */
 450   const char *getSSLServerName() const;
 451
 452   /**
 453    * Get the server name for this SSL connection.
 454    * Returns the server name used or the constant value "NONE" when no SSL
 455    * session has been established.
 456    * If openssl has no SNI support, return "NONE"
 457    */
 458   const char *getSSLServerNameNoThrow() const;
 459
 460   /**
 461    * Get the SSL version for this connection.
 462    * Possible return values are SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
 463    * with hexa representations 0x200, 0x300, 0x301,
 464    * or 0 if no SSL session has been established.
 465    */
 466   int getSSLVersion() const;
 467
 468   /**
 469    * Get the signature algorithm used in the cert that is used for this
 470    * connection.
 471    */
 472   const char *getSSLCertSigAlgName() const;
 473
 474   /**
 475    * Get the certificate size used for this SSL connection.
 476    */
 477   int getSSLCertSize() const;
 478
 479   /**
 480    * Get the certificate used for this SSL connection. May be null
 481    */
 482   virtual const X509* getSelfCert() const override;
 483
 484   virtual void attachEventBase(EventBase* eventBase) override {
 485     AsyncSocket::attachEventBase(eventBase);
 486     handshakeTimeout_.attachEventBase(eventBase);
 487     connectionTimeout_.attachEventBase(eventBase);
 488   }
 489
 490   virtual void detachEventBase() override {
 491     AsyncSocket::detachEventBase();
 492     handshakeTimeout_.detachEventBase();
 493     connectionTimeout_.detachEventBase();
 494   }
 495
 496   virtual bool isDetachable() const override {
 497     return AsyncSocket::isDetachable() && !handshakeTimeout_.isScheduled();
 498   }
 499
 500   virtual void attachTimeoutManager(TimeoutManager* manager) {
 501     handshakeTimeout_.attachTimeoutManager(manager);
 502   }
 503
 504   virtual void detachTimeoutManager() {
 505     handshakeTimeout_.detachTimeoutManager();
 506   }
 507
 508 #if OPENSSL_VERSION_NUMBER >= 0x009080bfL
 509   /**
 510    * This function will set the SSL context for this socket to the
 511    * argument. This should only be used on client SSL Sockets that have
 512    * already called detachSSLContext();
 513    */
 514   void attachSSLContext(const std::shared_ptr<folly::SSLContext>& ctx);
 515
 516   /**
 517    * Detaches the SSL context for this socket.
 518    */
 519   void detachSSLContext();
 520 #endif
 521
 522 #if FOLLY_OPENSSL_HAS_SNI
 523   /**
 524    * Switch the SSLContext to continue the SSL handshake.
 525    * It can only be used in server mode.
 526    */
 527   void switchServerSSLContext(
 528     const std::shared_ptr<folly::SSLContext>& handshakeCtx);
 529
 530   /**
 531    * Did server recognize/support the tlsext_hostname in Client Hello?
 532    * It can only be used in client mode.
 533    *
 534    * @return true - tlsext_hostname is matched by the server
 535    *         false - tlsext_hostname is not matched or
 536    *                 is not supported by server
 537    */
 538   bool isServerNameMatch() const;
 539
 540   /**
 541    * Set the SNI hostname that we'll advertise to the server in the
 542    * ClientHello message.
 543    */
 544   void setServerName(std::string serverName) noexcept;
 545 #endif // FOLLY_OPENSSL_HAS_SNI
 546
 547   void timeoutExpired(std::chrono::milliseconds timeout) noexcept;
 548
 549   /**
 550    * Get the list of supported ciphers sent by the client in the client's
 551    * preference order.
 552    */
 553   void getSSLClientCiphers(
 554       std::string& clientCiphers,
 555       bool convertToString = true) const;
 556
 557   /**
 558    * Get the list of compression methods sent by the client in TLS Hello.
 559    */
 560   std::string getSSLClientComprMethods() const;
 561
 562   /**
 563    * Get the list of TLS extensions sent by the client in the TLS Hello.
 564    */
 565   std::string getSSLClientExts() const;
 566
 567   std::string getSSLClientSigAlgs() const;
 568
 569   /**
 570    * Get the list of versions in the supported versions extension (used to
 571    * negotiate TLS 1.3).
 572    */
 573   std::string getSSLClientSupportedVersions() const;
 574
 575   std::string getSSLAlertsReceived() const;
 576
 577   /**
 578    * Get the list of shared ciphers between the server and the client.
 579    * Works well for only SSLv2, not so good for SSLv3 or TLSv1.
 580    */
 581   void getSSLSharedCiphers(std::string& sharedCiphers) const;
 582
 583   /**
 584    * Get the list of ciphers supported by the server in the server's
 585    * preference order.
 586    */
 587   void getSSLServerCiphers(std::string& serverCiphers) const;
 588
 589   /**
 590    * Method to check if peer verfication is set.
 591    *
 592    * @return true if peer verification is required.
 593    */
 594   bool needsPeerVerification() const;
 595
 596   static int getSSLExDataIndex();
 597   static AsyncSSLSocket* getFromSSL(const SSL *ssl);
 598   static int bioWrite(BIO* b, const char* in, int inl);
 599   static int bioRead(BIO* b, char* out, int outl);
 600   void resetClientHelloParsing(SSL *ssl);
 601   static void clientHelloParsingCallback(int write_p, int version,
 602       int content_type, const void *buf, size_t len, SSL *ssl, void *arg);
 603   static const char* getSSLServerNameFromSSL(SSL* ssl);
 604
 605   // For unit-tests
 606   ssl::ClientHelloInfo* getClientHelloInfo() const {
 607     return clientHelloInfo_.get();
 608   }
 609
 610   /**
 611    * Returns the time taken to complete a handshake.
 612    */
 613   virtual std::chrono::nanoseconds getHandshakeTime() const {
 614     return handshakeEndTime_ - handshakeStartTime_;
 615   }
 616
 617   void setMinWriteSize(size_t minWriteSize) {
 618     minWriteSize_ = minWriteSize;
 619   }
 620
 621   size_t getMinWriteSize() const {
 622     return minWriteSize_;
 623   }
 624
 625   void setReadCB(ReadCallback* callback) override;
 626
 627   /**
 628    * Tries to enable the buffer movable experimental feature in openssl.
 629    * This is not guaranteed to succeed in case openssl does not have
 630    * the experimental feature built in.
 631    */
 632   void setBufferMovableEnabled(bool enabled);
 633
 634   /**
 635    * Returns the peer certificate, or nullptr if no peer certificate received.
 636    */
 637   virtual ssl::X509UniquePtr getPeerCert() const override {
 638     if (!ssl_) {
 639       return nullptr;
 640     }
 641
 642     X509* cert = SSL_get_peer_certificate(ssl_);
 643     return ssl::X509UniquePtr(cert);
 644   }
 645
 646   /**
 647    * Force AsyncSSLSocket object to cache local and peer socket addresses.
 648    * If called with "true" before connect() this function forces full local
 649    * and remote socket addresses to be cached in the socket object and available
 650    * through getLocalAddress()/getPeerAddress() methods even after the socket is
 651    * closed.
 652    */
 653   void forceCacheAddrOnFailure(bool force) { cacheAddrOnFailure_ = force; }
 654
 655   const std::string& getServiceIdentity() const { return serviceIdentity_; }
 656
 657   void setServiceIdentity(std::string serviceIdentity) {
 658     serviceIdentity_ = std::move(serviceIdentity);
 659   }
 660
 661   void setCertCacheHit(bool hit) {
 662     certCacheHit_ = hit;
 663   }
 664
 665   bool getCertCacheHit() const {
 666     return certCacheHit_;
 667   }
 668
 669   bool sessionResumptionAttempted() const {
 670     return sessionResumptionAttempted_;
 671   }
 672
 673  private:
 674
 675   void init();
 676
 677  protected:
 678
 679   /**
 680    * Protected destructor.
 681    *
 682    * Users of AsyncSSLSocket must never delete it directly.  Instead, invoke
 683    * destroy() instead.  (See the documentation in DelayedDestruction.h for
 684    * more details.)
 685    */
 686   ~AsyncSSLSocket();
 687
 688   // Inherit event notification methods from AsyncSocket except
 689   // the following.
 690   void prepareReadBuffer(void** buf, size_t* buflen) override;
 691   void handleRead() noexcept override;
 692   void handleWrite() noexcept override;
 693   void handleAccept() noexcept;
 694   void handleConnect() noexcept override;
 695
 696   void invalidState(HandshakeCB* callback);
 697   bool willBlock(int ret,
 698                  int* sslErrorOut,
 699                  unsigned long* errErrorOut) noexcept;
 700
 701   virtual void checkForImmediateRead() noexcept override;
 702   // AsyncSocket calls this at the wrong time for SSL
 703   void handleInitialReadWrite() noexcept override {}
 704
 705   WriteResult interpretSSLError(int rc, int error);
 706   ReadResult performRead(void** buf, size_t* buflen, size_t* offset) override;
 707   WriteResult performWrite(
 708       const iovec* vec,
 709       uint32_t count,
 710       WriteFlags flags,
 711       uint32_t* countWritten,
 712       uint32_t* partialWritten) override;
 713
 714   ssize_t performWriteIovec(const iovec* vec, uint32_t count,
 715                             WriteFlags flags, uint32_t* countWritten,
 716                             uint32_t* partialWritten);
 717
 718   // This virtual wrapper around SSL_write exists solely for testing/mockability
 719   virtual int sslWriteImpl(SSL *ssl, const void *buf, int n) {
 720     return SSL_write(ssl, buf, n);
 721   }
 722
 723   /**
 724    * Apply verification options passed to sslConn/sslAccept or those set
 725    * in the underlying SSLContext object.
 726    *
 727    * @param ssl pointer to the SSL object on which verification options will be
 728    * applied. If verifyPeer_ was explicitly set either via sslConn/sslAccept,
 729    * those options override the settings in the underlying SSLContext.
 730    */
 731   void applyVerificationOptions(SSL * ssl);
 732
 733   /**
 734    * Sets up SSL with a custom write bio which intercepts all writes.
 735    *
 736    * @return true, if succeeds and false if there is an error creating the bio.
 737    */
 738   bool setupSSLBio();
 739
 740   /**
 741    * A SSL_write wrapper that understand EOR
 742    *
 743    * @param ssl: SSL* object
 744    * @param buf: Buffer to be written
 745    * @param n:   Number of bytes to be written
 746    * @param eor: Does the last byte (buf[n-1]) have the app-last-byte?
 747    * @return:    The number of app bytes successfully written to the socket
 748    */
 749   int eorAwareSSLWrite(SSL *ssl, const void *buf, int n, bool eor);
 750
 751   // Inherit error handling methods from AsyncSocket, plus the following.
 752   void failHandshake(const char* fn, const AsyncSocketException& ex);
 753
 754   void invokeHandshakeErr(const AsyncSocketException& ex);
 755   void invokeHandshakeCB();
 756
 757   void invokeConnectErr(const AsyncSocketException& ex) override;
 758   void invokeConnectSuccess() override;
 759   void scheduleConnectTimeout() override;
 760
 761   void cacheLocalPeerAddr();
 762
 763   void startSSLConnect();
 764
 765   static void sslInfoCallback(const SSL *ssl, int type, int val);
 766
 767   // Whether the current write to the socket should use MSG_MORE.
 768   bool corkCurrentWrite_{false};
 769   // SSL related members.
 770   bool server_{false};
 771   // Used to prevent client-initiated renegotiation.  Note that AsyncSSLSocket
 772   // doesn't fully support renegotiation, so we could just fail all attempts
 773   // to enforce this.  Once it is supported, we should make it an option
 774   // to disable client-initiated renegotiation.
 775   bool handshakeComplete_{false};
 776   bool renegotiateAttempted_{false};
 777   SSLStateEnum sslState_{STATE_UNINIT};
 778   std::shared_ptr<folly::SSLContext> ctx_;
 779   // Callback for SSL_accept() or SSL_connect()
 780   HandshakeCB* handshakeCallback_{nullptr};
 781   SSL* ssl_{nullptr};
 782   SSL_SESSION *sslSession_{nullptr};
 783   Timeout handshakeTimeout_;
 784   Timeout connectionTimeout_;
 785   // whether the SSL session was resumed using session ID or not
 786   bool sessionIDResumed_{false};
 787
 788   // The app byte num that we are tracking for the MSG_EOR
 789   // Only one app EOR byte can be tracked.
 790   size_t appEorByteNo_{0};
 791
 792   // Try to avoid calling SSL_write() for buffers smaller than this.
 793   // It doesn't take effect when it is 0.
 794   size_t minWriteSize_{1500};
 795
 796   // When openssl is about to sendmsg() across the minEorRawBytesNo_,
 797   // it will pass MSG_EOR to sendmsg().
 798   size_t minEorRawByteNo_{0};
 799 #if FOLLY_OPENSSL_HAS_SNI
 800   std::shared_ptr<folly::SSLContext> handshakeCtx_;
 801   std::string tlsextHostname_;
 802 #endif
 803
 804   // a service identity that this socket/connection is associated with
 805   std::string serviceIdentity_;
 806
 807   folly::SSLContext::SSLVerifyPeerEnum
 808     verifyPeer_{folly::SSLContext::SSLVerifyPeerEnum::USE_CTX};
 809
 810   // Callback for SSL_CTX_set_verify()
 811   static int sslVerifyCallback(int preverifyOk, X509_STORE_CTX* ctx);
 812
 813   bool parseClientHello_{false};
 814   bool cacheAddrOnFailure_{false};
 815   bool bufferMovableEnabled_{false};
 816   bool certCacheHit_{false};
 817   std::unique_ptr<ssl::ClientHelloInfo> clientHelloInfo_;
 818   std::vector<std::pair<char, StringPiece>> alertsReceived_;
 819
 820   // Time taken to complete the ssl handshake.
 821   std::chrono::steady_clock::time_point handshakeStartTime_;
 822   std::chrono::steady_clock::time_point handshakeEndTime_;
 823   std::chrono::milliseconds handshakeConnectTimeout_{0};
 824   bool sessionResumptionAttempted_{false};
 825
 826   std::unique_ptr<IOBuf> preReceivedData_;
 827 };
 828
 829 } // namespace