2 * Copyright 2015 Facebook, Inc.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <arpa/inet.h>
21 #include <openssl/ssl.h>
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>
30 #include <folly/Bits.h>
31 #include <folly/io/IOBuf.h>
32 #include <folly/io/Cursor.h>
36 class SSLException: public folly::AsyncSocketException {
38 SSLException(int sslError, int errno_copy);
40 int getSSLError() const { return error_; }
48 * A class for performing asynchronous I/O on an SSL connection.
50 * AsyncSSLSocket allows users to asynchronously wait for data on an
51 * SSL connection, and to asynchronously send data.
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.
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.
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.
77 class AsyncSSLSocket : public virtual AsyncSocket {
79 typedef std::unique_ptr<AsyncSSLSocket, Destructor> UniquePtr;
80 using X509_deleter = folly::static_function_deleter<X509, &X509_free>;
84 virtual ~HandshakeCB() = default;
87 * handshakeVer() is invoked during handshaking to give the
88 * application chance to validate it's peer's certificate.
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.
97 * See the passages on verify_callback in SSL_CTX_set_verify(3)
100 virtual bool handshakeVer(AsyncSSLSocket* /*sock*/,
102 X509_STORE_CTX* /*ctx*/) noexcept {
107 * handshakeSuc() is called when a new SSL connection is
108 * established, i.e., after SSL_accept/connect() returns successfully.
110 * The HandshakeCB will be uninstalled before handshakeSuc()
113 * @param sock SSL socket on which the handshake was initiated
115 virtual void handshakeSuc(AsyncSSLSocket *sock) noexcept = 0;
118 * handshakeErr() is called if an error occurs while
119 * establishing the SSL connection.
121 * The HandshakeCB will be uninstalled before handshakeErr()
124 * @param sock SSL socket on which the handshake was initiated
125 * @param ex An exception representing the error.
127 virtual void handshakeErr(
128 AsyncSSLSocket *sock,
129 const AsyncSocketException& ex)
133 class HandshakeTimeout : public AsyncTimeout {
135 HandshakeTimeout(AsyncSSLSocket* sslSocket, EventBase* eventBase)
136 : AsyncTimeout(eventBase)
137 , sslSocket_(sslSocket) {}
139 virtual void timeoutExpired() noexcept {
140 sslSocket_->timeoutExpired();
144 AsyncSSLSocket* sslSocket_;
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
154 SSL_CLIENT_RENEGOTIATION_ATTEMPT = 900,
155 SSL_INVALID_RENEGOTIATION = 901,
156 SSL_EARLY_WRITE = 902
160 * Create a client AsyncSSLSocket
162 AsyncSSLSocket(const std::shared_ptr<folly::SSLContext> &ctx,
163 EventBase* evb, bool deferSecurityNegotiation = false);
166 * Create a server/client AsyncSSLSocket from an already connected
167 * socket file descriptor.
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.
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
182 AsyncSSLSocket(const std::shared_ptr<folly::SSLContext>& ctx,
183 EventBase* evb, int fd,
184 bool server = true, bool deferSecurityNegotiation = false);
188 * Helper function to create a server/client shared_ptr<AsyncSSLSocket>.
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),
200 * Helper function to create a client shared_ptr<AsyncSSLSocket>.
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),
211 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
213 * Create a client AsyncSSLSocket with tlsext_servername in
214 * the Client Hello message.
216 AsyncSSLSocket(const std::shared_ptr<folly::SSLContext> &ctx,
218 const std::string& serverName,
219 bool deferSecurityNegotiation = false);
222 * Create a client AsyncSSLSocket from an already connected
223 * socket file descriptor.
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.
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.
236 AsyncSSLSocket(const std::shared_ptr<folly::SSLContext>& ctx,
239 const std::string& serverName,
240 bool deferSecurityNegotiation = false);
242 static std::shared_ptr<AsyncSSLSocket> newSocket(
243 const std::shared_ptr<folly::SSLContext>& ctx,
245 const std::string& serverName,
246 bool deferSecurityNegotiation = false) {
247 return std::shared_ptr<AsyncSSLSocket>(
248 new AsyncSSLSocket(ctx, evb, serverName, deferSecurityNegotiation),
254 * TODO: implement support for SSL renegotiation.
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.
266 // Inherit TAsyncTransport methods from AsyncSocket except the
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 virtual std::string getApplicationProtocol() noexcept override;
278 virtual std::string getSecurityProtocol() const override { return "TLS"; }
280 bool isEorTrackingEnabled() const override;
281 virtual void setEorTracking(bool track) override;
282 virtual size_t getRawBytesWritten() const override;
283 virtual size_t getRawBytesReceived() const override;
284 void enableClientHelloParsing();
287 * Accept an SSL connection on the socket.
289 * The callback will be invoked and uninstalled when an SSL
290 * connection has been established on the underlying socket.
291 * The value of verifyPeer determines the client verification method.
292 * By default, its set to use the value in the underlying context
294 * @param callback callback object to invoke on success/failure
295 * @param timeout timeout for this function in milliseconds, or 0 for no
297 * @param verifyPeer SSLVerifyPeerEnum uses the options specified in the
298 * context by default, can be set explcitly to override the
299 * method in the context
301 virtual void sslAccept(HandshakeCB* callback, uint32_t timeout = 0,
302 const folly::SSLContext::SSLVerifyPeerEnum& verifyPeer =
303 folly::SSLContext::SSLVerifyPeerEnum::USE_CTX);
306 * Invoke SSL accept following an asynchronous session cache lookup
308 void restartSSLAccept();
311 * Connect to the given address, invoking callback when complete or on error
313 * Note timeout applies to TCP + SSL connection time
315 void connect(ConnectCallback* callback,
316 const folly::SocketAddress& address,
318 const OptionMap &options = emptyOptionMap,
319 const folly::SocketAddress& bindAddr = anyAddress())
322 using AsyncSocket::connect;
325 * Initiate an SSL connection on the socket
326 * The callback will be invoked and uninstalled when an SSL connection
327 * has been establshed on the underlying socket.
328 * The verification option verifyPeer is applied if it's passed explicitly.
329 * If it's not, the options in SSLContext set on the underlying SSLContext
332 * @param callback callback object to invoke on success/failure
333 * @param timeout timeout for this function in milliseconds, or 0 for no
335 * @param verifyPeer SSLVerifyPeerEnum uses the options specified in the
336 * context by default, can be set explcitly to override the
337 * method in the context. If verification is turned on sets
338 * SSL_VERIFY_PEER and invokes
339 * HandshakeCB::handshakeVer().
341 virtual void sslConn(HandshakeCB *callback, uint64_t timeout = 0,
342 const folly::SSLContext::SSLVerifyPeerEnum& verifyPeer =
343 folly::SSLContext::SSLVerifyPeerEnum::USE_CTX);
350 STATE_RSA_ASYNC_PENDING,
353 STATE_REMOTE_CLOSED, /// remote end closed; we can still write
354 STATE_CLOSING, ///< close() called, but waiting on writes to complete
355 /// close() called with pending writes, before connect() has completed
356 STATE_CONNECTING_CLOSING,
361 SSLStateEnum getSSLState() const { return sslState_;}
364 * Get a handle to the negotiated SSL session. This increments the session
365 * refcount and must be deallocated by the caller.
367 SSL_SESSION *getSSLSession();
370 * Set the SSL session to be used during sslConn. AsyncSSLSocket will
371 * hold a reference to the session until it is destroyed or released by the
372 * underlying SSL structure.
374 * @param takeOwnership if true, AsyncSSLSocket will assume the caller's
375 * reference count to session.
377 void setSSLSession(SSL_SESSION *session, bool takeOwnership = false);
380 * Get the name of the protocol selected by the client during
381 * Next Protocol Negotiation (NPN) or Application Layer Protocol Negotiation
384 * Throw an exception if openssl does not support NPN
386 * @param protoName Name of the protocol (not guaranteed to be
387 * null terminated); will be set to nullptr if
388 * the client did not negotiate a protocol.
389 * Note: the AsyncSSLSocket retains ownership
391 * @param protoNameLen Length of the name.
392 * @param protoType Whether this was an NPN or ALPN negotiation
394 virtual void getSelectedNextProtocol(
395 const unsigned char** protoName,
397 SSLContext::NextProtocolType* protoType = nullptr) const;
400 * Get the name of the protocol selected by the client during
401 * Next Protocol Negotiation (NPN) or Application Layer Protocol Negotiation
404 * @param protoName Name of the protocol (not guaranteed to be
405 * null terminated); will be set to nullptr if
406 * the client did not negotiate a protocol.
407 * Note: the AsyncSSLSocket retains ownership
409 * @param protoNameLen Length of the name.
410 * @param protoType Whether this was an NPN or ALPN negotiation
411 * @return false if openssl does not support NPN
413 virtual bool getSelectedNextProtocolNoThrow(
414 const unsigned char** protoName,
416 SSLContext::NextProtocolType* protoType = nullptr) const;
419 * Determine if the session specified during setSSLSession was reused
420 * or if the server rejected it and issued a new session.
422 virtual bool getSSLSessionReused() const;
425 * true if the session was resumed using session ID
427 bool sessionIDResumed() const { return sessionIDResumed_; }
429 void setSessionIDResumed(bool resumed) {
430 sessionIDResumed_ = resumed;
434 * Get the negociated cipher name for this SSL connection.
435 * Returns the cipher used or the constant value "NONE" when no SSL session
436 * has been established.
438 virtual const char* getNegotiatedCipherName() const;
441 * Get the server name for this SSL connection.
442 * Returns the server name used or the constant value "NONE" when no SSL
443 * session has been established.
444 * If openssl has no SNI support, throw TTransportException.
446 const char *getSSLServerName() const;
449 * Get the server name for this SSL connection.
450 * Returns the server name used or the constant value "NONE" when no SSL
451 * session has been established.
452 * If openssl has no SNI support, return "NONE"
454 const char *getSSLServerNameNoThrow() const;
457 * Get the SSL version for this connection.
458 * Possible return values are SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
459 * with hexa representations 0x200, 0x300, 0x301,
460 * or 0 if no SSL session has been established.
462 int getSSLVersion() const;
465 * Get the signature algorithm used in the cert that is used for this
468 const char *getSSLCertSigAlgName() const;
471 * Get the certificate size used for this SSL connection.
473 int getSSLCertSize() const;
475 virtual void attachEventBase(EventBase* eventBase) override {
476 AsyncSocket::attachEventBase(eventBase);
477 handshakeTimeout_.attachEventBase(eventBase);
480 virtual void detachEventBase() override {
481 AsyncSocket::detachEventBase();
482 handshakeTimeout_.detachEventBase();
485 virtual bool isDetachable() const override {
486 return AsyncSocket::isDetachable() && !handshakeTimeout_.isScheduled();
489 virtual void attachTimeoutManager(TimeoutManager* manager) {
490 handshakeTimeout_.attachTimeoutManager(manager);
493 virtual void detachTimeoutManager() {
494 handshakeTimeout_.detachTimeoutManager();
497 #if OPENSSL_VERSION_NUMBER >= 0x009080bfL
499 * This function will set the SSL context for this socket to the
500 * argument. This should only be used on client SSL Sockets that have
501 * already called detachSSLContext();
503 void attachSSLContext(const std::shared_ptr<folly::SSLContext>& ctx);
506 * Detaches the SSL context for this socket.
508 void detachSSLContext();
511 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
513 * Switch the SSLContext to continue the SSL handshake.
514 * It can only be used in server mode.
516 void switchServerSSLContext(
517 const std::shared_ptr<folly::SSLContext>& handshakeCtx);
520 * Did server recognize/support the tlsext_hostname in Client Hello?
521 * It can only be used in client mode.
523 * @return true - tlsext_hostname is matched by the server
524 * false - tlsext_hostname is not matched or
525 * is not supported by server
527 bool isServerNameMatch() const;
530 * Set the SNI hostname that we'll advertise to the server in the
531 * ClientHello message.
533 void setServerName(std::string serverName) noexcept;
536 void timeoutExpired() noexcept;
539 * Get the list of supported ciphers sent by the client in the client's
542 void getSSLClientCiphers(std::string& clientCiphers) const {
543 std::stringstream ciphersStream;
544 std::string cipherName;
546 if (parseClientHello_ == false
547 || clientHelloInfo_->clientHelloCipherSuites_.empty()) {
552 for (auto originalCipherCode : clientHelloInfo_->clientHelloCipherSuites_)
554 // OpenSSL expects code as a big endian char array
555 auto cipherCode = htons(originalCipherCode);
557 #if defined(SSL_OP_NO_TLSv1_2)
558 const SSL_CIPHER* cipher =
559 TLSv1_2_method()->get_cipher_by_char((unsigned char*)&cipherCode);
560 #elif defined(SSL_OP_NO_TLSv1_1)
561 const SSL_CIPHER* cipher =
562 TLSv1_1_method()->get_cipher_by_char((unsigned char*)&cipherCode);
563 #elif defined(SSL_OP_NO_TLSv1)
564 const SSL_CIPHER* cipher =
565 TLSv1_method()->get_cipher_by_char((unsigned char*)&cipherCode);
567 const SSL_CIPHER* cipher =
568 SSLv3_method()->get_cipher_by_char((unsigned char*)&cipherCode);
571 if (cipher == nullptr) {
572 ciphersStream << std::setfill('0') << std::setw(4) << std::hex
573 << originalCipherCode << ":";
575 ciphersStream << SSL_CIPHER_get_name(cipher) << ":";
579 clientCiphers = ciphersStream.str();
580 clientCiphers.erase(clientCiphers.end() - 1);
584 * Get the list of compression methods sent by the client in TLS Hello.
586 std::string getSSLClientComprMethods() const {
587 if (!parseClientHello_) {
590 return folly::join(":", clientHelloInfo_->clientHelloCompressionMethods_);
594 * Get the list of TLS extensions sent by the client in the TLS Hello.
596 std::string getSSLClientExts() const {
597 if (!parseClientHello_) {
600 return folly::join(":", clientHelloInfo_->clientHelloExtensions_);
603 std::string getSSLClientSigAlgs() const {
604 if (!parseClientHello_) {
609 sigAlgs.reserve(clientHelloInfo_->clientHelloSigAlgs_.size() * 4);
610 for (size_t i = 0; i < clientHelloInfo_->clientHelloSigAlgs_.size(); i++) {
612 sigAlgs.push_back(':');
614 sigAlgs.append(folly::to<std::string>(
615 clientHelloInfo_->clientHelloSigAlgs_[i].first));
616 sigAlgs.push_back(',');
617 sigAlgs.append(folly::to<std::string>(
618 clientHelloInfo_->clientHelloSigAlgs_[i].second));
625 * Get the list of shared ciphers between the server and the client.
626 * Works well for only SSLv2, not so good for SSLv3 or TLSv1.
628 void getSSLSharedCiphers(std::string& sharedCiphers) const {
629 char ciphersBuffer[1024];
630 ciphersBuffer[0] = '\0';
631 SSL_get_shared_ciphers(ssl_, ciphersBuffer, sizeof(ciphersBuffer) - 1);
632 sharedCiphers = ciphersBuffer;
636 * Get the list of ciphers supported by the server in the server's
639 void getSSLServerCiphers(std::string& serverCiphers) const {
640 serverCiphers = SSL_get_cipher_list(ssl_, 0);
643 while ((cipher = SSL_get_cipher_list(ssl_, i)) != nullptr) {
644 serverCiphers.append(":");
645 serverCiphers.append(cipher);
650 static int getSSLExDataIndex();
651 static AsyncSSLSocket* getFromSSL(const SSL *ssl);
652 static int eorAwareBioWrite(BIO *b, const char *in, int inl);
653 void resetClientHelloParsing(SSL *ssl);
654 static void clientHelloParsingCallback(int write_p, int version,
655 int content_type, const void *buf, size_t len, SSL *ssl, void *arg);
657 // http://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml
658 enum class TLSExtension: uint16_t {
660 MAX_FRAGMENT_LENGTH = 1,
661 CLIENT_CERTIFICATE_URL = 2,
669 SUPPORTED_GROUPS = 10,
670 EC_POINT_FORMATS = 11,
672 SIGNATURE_ALGORITHMS = 13,
675 APPLICATION_LAYER_PROTOCOL_NEGOTIATION = 16,
676 STATUS_REQUEST_V2 = 17,
677 SIGNED_CERTIFICATE_TIMESTAMP = 18,
678 CLIENT_CERTIFICATE_TYPE = 19,
679 SERVER_CERTIFICATE_TYPE = 20,
681 ENCRYPT_THEN_MAC = 22,
682 EXTENDED_MASTER_SECRET = 23,
684 RENEGOTIATION_INFO = 65281
687 // http://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-18
688 enum class HashAlgorithm: uint8_t {
698 // http://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-16
699 enum class SignatureAlgorithm: uint8_t {
706 struct ClientHelloInfo {
707 folly::IOBufQueue clientHelloBuf_;
708 uint8_t clientHelloMajorVersion_;
709 uint8_t clientHelloMinorVersion_;
710 std::vector<uint16_t> clientHelloCipherSuites_;
711 std::vector<uint8_t> clientHelloCompressionMethods_;
712 std::vector<TLSExtension> clientHelloExtensions_;
714 std::pair<HashAlgorithm, SignatureAlgorithm>> clientHelloSigAlgs_;
718 ClientHelloInfo* getClientHelloInfo() const {
719 return clientHelloInfo_.get();
723 * Returns the time taken to complete a handshake.
725 virtual std::chrono::nanoseconds getHandshakeTime() const {
726 return handshakeEndTime_ - handshakeStartTime_;
729 void setMinWriteSize(size_t minWriteSize) {
730 minWriteSize_ = minWriteSize;
733 size_t getMinWriteSize() const {
734 return minWriteSize_;
737 void setReadCB(ReadCallback* callback) override;
740 * Returns the peer certificate, or nullptr if no peer certificate received.
742 virtual std::unique_ptr<X509, X509_deleter> getPeerCert() const {
747 X509* cert = SSL_get_peer_certificate(ssl_);
748 return std::unique_ptr<X509, X509_deleter>(cert);
758 * Protected destructor.
760 * Users of AsyncSSLSocket must never delete it directly. Instead, invoke
761 * destroy() instead. (See the documentation in DelayedDestruction.h for
766 // Inherit event notification methods from AsyncSocket except
768 void prepareReadBuffer(void** buf, size_t* buflen) noexcept override;
769 void handleRead() noexcept override;
770 void handleWrite() noexcept override;
771 void handleAccept() noexcept;
772 void handleConnect() noexcept override;
774 void invalidState(HandshakeCB* callback);
775 bool willBlock(int ret, int *errorOut) noexcept;
777 virtual void checkForImmediateRead() noexcept override;
778 // AsyncSocket calls this at the wrong time for SSL
779 void handleInitialReadWrite() noexcept override {}
781 int interpretSSLError(int rc, int error);
782 ssize_t performRead(void** buf, size_t* buflen, size_t* offset) override;
783 ssize_t performWrite(const iovec* vec, uint32_t count, WriteFlags flags,
784 uint32_t* countWritten, uint32_t* partialWritten)
787 ssize_t performWriteIovec(const iovec* vec, uint32_t count,
788 WriteFlags flags, uint32_t* countWritten,
789 uint32_t* partialWritten);
791 // This virtual wrapper around SSL_write exists solely for testing/mockability
792 virtual int sslWriteImpl(SSL *ssl, const void *buf, int n) {
793 return SSL_write(ssl, buf, n);
797 * Apply verification options passed to sslConn/sslAccept or those set
798 * in the underlying SSLContext object.
800 * @param ssl pointer to the SSL object on which verification options will be
801 * applied. If verifyPeer_ was explicitly set either via sslConn/sslAccept,
802 * those options override the settings in the underlying SSLContext.
804 void applyVerificationOptions(SSL * ssl);
807 * A SSL_write wrapper that understand EOR
809 * @param ssl: SSL* object
810 * @param buf: Buffer to be written
811 * @param n: Number of bytes to be written
812 * @param eor: Does the last byte (buf[n-1]) have the app-last-byte?
813 * @return: The number of app bytes successfully written to the socket
815 int eorAwareSSLWrite(SSL *ssl, const void *buf, int n, bool eor);
817 // Inherit error handling methods from AsyncSocket, plus the following.
818 void failHandshake(const char* fn, const AsyncSocketException& ex);
820 void invokeHandshakeErr(const AsyncSocketException& ex);
821 void invokeHandshakeCB();
823 static void sslInfoCallback(const SSL *ssl, int type, int val);
825 // SSL related members.
827 // Used to prevent client-initiated renegotiation. Note that AsyncSSLSocket
828 // doesn't fully support renegotiation, so we could just fail all attempts
829 // to enforce this. Once it is supported, we should make it an option
830 // to disable client-initiated renegotiation.
831 bool handshakeComplete_{false};
832 bool renegotiateAttempted_{false};
833 SSLStateEnum sslState_{STATE_UNINIT};
834 std::shared_ptr<folly::SSLContext> ctx_;
835 // Callback for SSL_accept() or SSL_connect()
836 HandshakeCB* handshakeCallback_{nullptr};
838 SSL_SESSION *sslSession_{nullptr};
839 HandshakeTimeout handshakeTimeout_;
840 // whether the SSL session was resumed using session ID or not
841 bool sessionIDResumed_{false};
843 // The app byte num that we are tracking for the MSG_EOR
844 // Only one app EOR byte can be tracked.
845 size_t appEorByteNo_{0};
847 // Try to avoid calling SSL_write() for buffers smaller than this.
848 // It doesn't take effect when it is 0.
849 size_t minWriteSize_{1500};
851 // When openssl is about to sendmsg() across the minEorRawBytesNo_,
852 // it will pass MSG_EOR to sendmsg().
853 size_t minEorRawByteNo_{0};
854 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
855 std::shared_ptr<folly::SSLContext> handshakeCtx_;
856 std::string tlsextHostname_;
858 folly::SSLContext::SSLVerifyPeerEnum
859 verifyPeer_{folly::SSLContext::SSLVerifyPeerEnum::USE_CTX};
861 // Callback for SSL_CTX_set_verify()
862 static int sslVerifyCallback(int preverifyOk, X509_STORE_CTX* ctx);
864 bool parseClientHello_{false};
865 std::unique_ptr<ClientHelloInfo> clientHelloInfo_;
867 // Time taken to complete the ssl handshake.
868 std::chrono::steady_clock::time_point handshakeStartTime_;
869 std::chrono::steady_clock::time_point handshakeEndTime_;