2 * Copyright 2016 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.
17 #include <folly/io/async/AsyncSSLSocket.h>
19 #include <folly/io/async/EventBase.h>
20 #include <folly/portability/Sockets.h>
22 #include <boost/noncopyable.hpp>
25 #include <openssl/err.h>
26 #include <openssl/asn1.h>
27 #include <openssl/ssl.h>
28 #include <sys/types.h>
31 #include <folly/Bits.h>
32 #include <folly/SocketAddress.h>
33 #include <folly/SpinLock.h>
34 #include <folly/io/IOBuf.h>
35 #include <folly/io/Cursor.h>
36 #include <folly/portability/Unistd.h>
38 using folly::SocketAddress;
39 using folly::SSLContext;
41 using std::shared_ptr;
45 using folly::SpinLock;
46 using folly::SpinLockGuard;
47 using folly::io::Cursor;
48 using std::unique_ptr;
52 using folly::AsyncSocket;
53 using folly::AsyncSocketException;
54 using folly::AsyncSSLSocket;
55 using folly::Optional;
56 using folly::SSLContext;
57 using folly::ssl::OpenSSLUtils;
59 // We have one single dummy SSL context so that we can implement attach
60 // and detach methods in a thread safe fashion without modifying opnessl.
61 static SSLContext *dummyCtx = nullptr;
62 static SpinLock dummyCtxLock;
64 // If given min write size is less than this, buffer will be allocated on
65 // stack, otherwise it is allocated on heap
66 const size_t MAX_STACK_BUF_SIZE = 2048;
68 // This converts "illegal" shutdowns into ZERO_RETURN
69 inline bool zero_return(int error, int rc) {
70 return (error == SSL_ERROR_ZERO_RETURN || (rc == 0 && errno == 0));
73 class AsyncSSLSocketConnector: public AsyncSocket::ConnectCallback,
74 public AsyncSSLSocket::HandshakeCB {
77 AsyncSSLSocket *sslSocket_;
78 AsyncSSLSocket::ConnectCallback *callback_;
83 ~AsyncSSLSocketConnector() override {}
86 AsyncSSLSocketConnector(AsyncSSLSocket *sslSocket,
87 AsyncSocket::ConnectCallback *callback,
89 sslSocket_(sslSocket),
92 startTime_(std::chrono::duration_cast<std::chrono::milliseconds>(
93 std::chrono::steady_clock::now().time_since_epoch()).count()) {
96 void connectSuccess() noexcept override {
97 VLOG(7) << "client socket connected";
99 int64_t timeoutLeft = 0;
101 auto curTime = std::chrono::duration_cast<std::chrono::milliseconds>(
102 std::chrono::steady_clock::now().time_since_epoch()).count();
104 timeoutLeft = timeout_ - (curTime - startTime_);
105 if (timeoutLeft <= 0) {
106 AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
107 "SSL connect timed out");
113 sslSocket_->sslConn(this, timeoutLeft);
116 void connectErr(const AsyncSocketException& ex) noexcept override {
117 VLOG(1) << "TCP connect failed: " << ex.what();
122 void handshakeSuc(AsyncSSLSocket* /* sock */) noexcept override {
123 VLOG(7) << "client handshake success";
125 callback_->connectSuccess();
130 void handshakeErr(AsyncSSLSocket* /* socket */,
131 const AsyncSocketException& ex) noexcept override {
132 VLOG(1) << "client handshakeErr: " << ex.what();
137 void fail(const AsyncSocketException &ex) {
138 // fail is a noop if called twice
140 AsyncSSLSocket::ConnectCallback *cb = callback_;
144 sslSocket_->closeNow();
145 // closeNow can call handshakeErr if it hasn't been called already.
146 // So this may have been deleted, no member variable access beyond this
148 // Note that closeNow may invoke writeError callbacks if the socket had
149 // write data pending connection completion.
154 void setup_SSL_CTX(SSL_CTX *ctx) {
155 #ifdef SSL_MODE_RELEASE_BUFFERS
156 SSL_CTX_set_mode(ctx,
157 SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER |
158 SSL_MODE_ENABLE_PARTIAL_WRITE
159 | SSL_MODE_RELEASE_BUFFERS
162 SSL_CTX_set_mode(ctx,
163 SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER |
164 SSL_MODE_ENABLE_PARTIAL_WRITE
167 // SSL_CTX_set_mode is a Macro
168 #ifdef SSL_MODE_WRITE_IOVEC
169 SSL_CTX_set_mode(ctx,
170 SSL_CTX_get_mode(ctx)
171 | SSL_MODE_WRITE_IOVEC);
176 BIO_METHOD sslWriteBioMethod;
178 void* initsslWriteBioMethod(void) {
179 memcpy(&sslWriteBioMethod, BIO_s_socket(), sizeof(sslWriteBioMethod));
180 // override the bwrite method for MSG_EOR support
181 OpenSSLUtils::setCustomBioWriteMethod(
182 &sslWriteBioMethod, AsyncSSLSocket::bioWrite);
184 // Note that the sslWriteBioMethod.type and sslWriteBioMethod.name are not
185 // set here. openssl code seems to be checking ".type == BIO_TYPE_SOCKET" and
186 // then have specific handlings. The sslWriteBioWrite should be compatible
187 // with the one in openssl.
189 // Return something here to enable AsyncSSLSocket to call this method using
190 // a function-scoped static.
194 } // anonymous namespace
199 * Create a client AsyncSSLSocket
201 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext> &ctx,
202 EventBase* evb, bool deferSecurityNegotiation) :
205 handshakeTimeout_(this, evb),
206 connectionTimeout_(this, evb) {
208 if (deferSecurityNegotiation) {
209 sslState_ = STATE_UNENCRYPTED;
214 * Create a server/client AsyncSSLSocket
216 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext>& ctx,
217 EventBase* evb, int fd, bool server,
218 bool deferSecurityNegotiation) :
219 AsyncSocket(evb, fd),
222 handshakeTimeout_(this, evb),
223 connectionTimeout_(this, evb) {
226 SSL_CTX_set_info_callback(ctx_->getSSLCtx(),
227 AsyncSSLSocket::sslInfoCallback);
229 if (deferSecurityNegotiation) {
230 sslState_ = STATE_UNENCRYPTED;
234 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
236 * Create a client AsyncSSLSocket and allow tlsext_hostname
237 * to be sent in Client Hello.
239 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext> &ctx,
241 const std::string& serverName,
242 bool deferSecurityNegotiation) :
243 AsyncSSLSocket(ctx, evb, deferSecurityNegotiation) {
244 tlsextHostname_ = serverName;
248 * Create a client AsyncSSLSocket from an already connected fd
249 * and allow tlsext_hostname to be sent in Client Hello.
251 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext>& ctx,
252 EventBase* evb, int fd,
253 const std::string& serverName,
254 bool deferSecurityNegotiation) :
255 AsyncSSLSocket(ctx, evb, fd, false, deferSecurityNegotiation) {
256 tlsextHostname_ = serverName;
260 AsyncSSLSocket::~AsyncSSLSocket() {
261 VLOG(3) << "actual destruction of AsyncSSLSocket(this=" << this
262 << ", evb=" << eventBase_ << ", fd=" << fd_
263 << ", state=" << int(state_) << ", sslState="
264 << sslState_ << ", events=" << eventFlags_ << ")";
267 void AsyncSSLSocket::init() {
268 // Do this here to ensure we initialize this once before any use of
269 // AsyncSSLSocket instances and not as part of library load.
270 static const auto sslWriteBioMethodInitializer = initsslWriteBioMethod();
271 (void)sslWriteBioMethodInitializer;
273 setup_SSL_CTX(ctx_->getSSLCtx());
276 void AsyncSSLSocket::closeNow() {
277 // Close the SSL connection.
278 if (ssl_ != nullptr && fd_ != -1) {
279 int rc = SSL_shutdown(ssl_);
281 rc = SSL_shutdown(ssl_);
288 if (sslSession_ != nullptr) {
289 SSL_SESSION_free(sslSession_);
290 sslSession_ = nullptr;
293 sslState_ = STATE_CLOSED;
295 if (handshakeTimeout_.isScheduled()) {
296 handshakeTimeout_.cancelTimeout();
299 DestructorGuard dg(this);
302 AsyncSocketException(
303 AsyncSocketException::END_OF_FILE,
304 "SSL connection closed locally"));
306 if (ssl_ != nullptr) {
312 AsyncSocket::closeNow();
315 void AsyncSSLSocket::shutdownWrite() {
316 // SSL sockets do not support half-shutdown, so just perform a full shutdown.
318 // (Performing a full shutdown here is more desirable than doing nothing at
319 // all. The purpose of shutdownWrite() is normally to notify the other end
320 // of the connection that no more data will be sent. If we do nothing, the
321 // other end will never know that no more data is coming, and this may result
322 // in protocol deadlock.)
326 void AsyncSSLSocket::shutdownWriteNow() {
330 bool AsyncSSLSocket::good() const {
331 return (AsyncSocket::good() &&
332 (sslState_ == STATE_ACCEPTING || sslState_ == STATE_CONNECTING ||
333 sslState_ == STATE_ESTABLISHED || sslState_ == STATE_UNENCRYPTED));
336 // The TAsyncTransport definition of 'good' states that the transport is
337 // ready to perform reads and writes, so sslState_ == UNINIT must report !good.
338 // connecting can be true when the sslState_ == UNINIT because the AsyncSocket
339 // is connected but we haven't initiated the call to SSL_connect.
340 bool AsyncSSLSocket::connecting() const {
342 (AsyncSocket::connecting() ||
343 (AsyncSocket::good() && (sslState_ == STATE_UNINIT ||
344 sslState_ == STATE_CONNECTING))));
347 std::string AsyncSSLSocket::getApplicationProtocol() noexcept {
348 const unsigned char* protoName = nullptr;
349 unsigned protoLength;
350 if (getSelectedNextProtocolNoThrow(&protoName, &protoLength)) {
351 return std::string(reinterpret_cast<const char*>(protoName), protoLength);
356 bool AsyncSSLSocket::isEorTrackingEnabled() const {
360 void AsyncSSLSocket::setEorTracking(bool track) {
361 if (trackEor_ != track) {
364 minEorRawByteNo_ = 0;
368 size_t AsyncSSLSocket::getRawBytesWritten() const {
369 // The bio(s) in the write path are in a chain
370 // each bio flushes to the next and finally written into the socket
371 // to get the rawBytesWritten on the socket,
372 // get the write bytes of the last bio
374 if (!ssl_ || !(b = SSL_get_wbio(ssl_))) {
377 BIO* next = BIO_next(b);
378 while (next != NULL) {
383 return BIO_number_written(b);
386 size_t AsyncSSLSocket::getRawBytesReceived() const {
388 if (!ssl_ || !(b = SSL_get_rbio(ssl_))) {
392 return BIO_number_read(b);
396 void AsyncSSLSocket::invalidState(HandshakeCB* callback) {
397 LOG(ERROR) << "AsyncSSLSocket(this=" << this << ", fd=" << fd_
398 << ", state=" << int(state_) << ", sslState=" << sslState_ << ", "
399 << "events=" << eventFlags_ << ", server=" << short(server_)
400 << "): " << "sslAccept/Connect() called in invalid "
401 << "state, handshake callback " << handshakeCallback_
402 << ", new callback " << callback;
403 assert(!handshakeTimeout_.isScheduled());
404 sslState_ = STATE_ERROR;
406 AsyncSocketException ex(AsyncSocketException::INVALID_STATE,
407 "sslAccept() called with socket in invalid state");
409 handshakeEndTime_ = std::chrono::steady_clock::now();
411 callback->handshakeErr(this, ex);
414 // Check the socket state not the ssl state here.
415 if (state_ != StateEnum::CLOSED || state_ != StateEnum::ERROR) {
416 failHandshake(__func__, ex);
420 void AsyncSSLSocket::sslAccept(HandshakeCB* callback, uint32_t timeout,
421 const SSLContext::SSLVerifyPeerEnum& verifyPeer) {
422 DestructorGuard dg(this);
423 assert(eventBase_->isInEventBaseThread());
424 verifyPeer_ = verifyPeer;
426 // Make sure we're in the uninitialized state
427 if (!server_ || (sslState_ != STATE_UNINIT &&
428 sslState_ != STATE_UNENCRYPTED) ||
429 handshakeCallback_ != nullptr) {
430 return invalidState(callback);
433 // Cache local and remote socket addresses to keep them available
434 // after socket file descriptor is closed.
435 if (cacheAddrOnFailure_ && -1 != getFd()) {
436 cacheLocalPeerAddr();
439 handshakeStartTime_ = std::chrono::steady_clock::now();
440 // Make end time at least >= start time.
441 handshakeEndTime_ = handshakeStartTime_;
443 sslState_ = STATE_ACCEPTING;
444 handshakeCallback_ = callback;
447 handshakeTimeout_.scheduleTimeout(timeout);
450 /* register for a read operation (waiting for CLIENT HELLO) */
451 updateEventRegistration(EventHandler::READ, EventHandler::WRITE);
454 #if OPENSSL_VERSION_NUMBER >= 0x009080bfL
455 void AsyncSSLSocket::attachSSLContext(
456 const std::shared_ptr<SSLContext>& ctx) {
458 // Check to ensure we are in client mode. Changing a server's ssl
459 // context doesn't make sense since clients of that server would likely
460 // become confused when the server's context changes.
464 DCHECK(ctx->getSSLCtx());
467 // It's possible this could be attached before ssl_ is set up
472 // In order to call attachSSLContext, detachSSLContext must have been
473 // previously called.
474 // We need to update the initial_ctx if necessary
475 auto sslCtx = ctx->getSSLCtx();
476 #ifndef OPENSSL_NO_TLSEXT
477 CRYPTO_add(&sslCtx->references, 1, CRYPTO_LOCK_SSL_CTX);
478 // note that detachSSLContext has already freed ssl_->initial_ctx
479 ssl_->initial_ctx = sslCtx;
481 // Detach sets the socket's context to the dummy context. Thus we must acquire
483 SpinLockGuard guard(dummyCtxLock);
484 SSL_set_SSL_CTX(ssl_, sslCtx);
487 void AsyncSSLSocket::detachSSLContext() {
490 // It's possible for this to be called before ssl_ has been
495 // Detach the initial_ctx as well. Internally w/ OPENSSL_NO_TLSEXT
496 // it is used for session info. It will be reattached in attachSSLContext
497 #ifndef OPENSSL_NO_TLSEXT
498 if (ssl_->initial_ctx) {
499 SSL_CTX_free(ssl_->initial_ctx);
500 ssl_->initial_ctx = nullptr;
503 SpinLockGuard guard(dummyCtxLock);
504 if (nullptr == dummyCtx) {
505 // We need to lazily initialize the dummy context so we don't
506 // accidentally override any programmatic settings to openssl
507 dummyCtx = new SSLContext;
509 // We must remove this socket's references to its context right now
510 // since this socket could get passed to any thread. If the context has
511 // had its locking disabled, just doing a set in attachSSLContext()
512 // would not be thread safe.
513 SSL_set_SSL_CTX(ssl_, dummyCtx->getSSLCtx());
517 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
518 void AsyncSSLSocket::switchServerSSLContext(
519 const std::shared_ptr<SSLContext>& handshakeCtx) {
521 if (sslState_ != STATE_ACCEPTING) {
522 // We log it here and allow the switch.
523 // It should not affect our re-negotiation support (which
524 // is not supported now).
525 VLOG(6) << "fd=" << getFd()
526 << " renegotation detected when switching SSL_CTX";
529 setup_SSL_CTX(handshakeCtx->getSSLCtx());
530 SSL_CTX_set_info_callback(handshakeCtx->getSSLCtx(),
531 AsyncSSLSocket::sslInfoCallback);
532 handshakeCtx_ = handshakeCtx;
533 SSL_set_SSL_CTX(ssl_, handshakeCtx->getSSLCtx());
536 bool AsyncSSLSocket::isServerNameMatch() const {
543 SSL_SESSION *ss = SSL_get_session(ssl_);
548 if(!ss->tlsext_hostname) {
551 return (tlsextHostname_.compare(ss->tlsext_hostname) ? false : true);
554 void AsyncSSLSocket::setServerName(std::string serverName) noexcept {
555 tlsextHostname_ = std::move(serverName);
560 void AsyncSSLSocket::timeoutExpired() noexcept {
561 if (state_ == StateEnum::ESTABLISHED &&
562 (sslState_ == STATE_CACHE_LOOKUP ||
563 sslState_ == STATE_ASYNC_PENDING)) {
564 sslState_ = STATE_ERROR;
565 // We are expecting a callback in restartSSLAccept. The cache lookup
566 // and rsa-call necessarily have pointers to this ssl socket, so delay
567 // the cleanup until he calls us back.
568 } else if (state_ == StateEnum::CONNECTING) {
569 assert(sslState_ == STATE_CONNECTING);
570 DestructorGuard dg(this);
571 AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
572 "Fallback connect timed out during TFO");
573 failHandshake(__func__, ex);
575 assert(state_ == StateEnum::ESTABLISHED &&
576 (sslState_ == STATE_CONNECTING || sslState_ == STATE_ACCEPTING));
577 DestructorGuard dg(this);
578 AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
579 (sslState_ == STATE_CONNECTING) ?
580 "SSL connect timed out" : "SSL accept timed out");
581 failHandshake(__func__, ex);
585 int AsyncSSLSocket::getSSLExDataIndex() {
586 static auto index = SSL_get_ex_new_index(
587 0, (void*)"AsyncSSLSocket data index", nullptr, nullptr, nullptr);
591 AsyncSSLSocket* AsyncSSLSocket::getFromSSL(const SSL *ssl) {
592 return static_cast<AsyncSSLSocket *>(SSL_get_ex_data(ssl,
593 getSSLExDataIndex()));
596 void AsyncSSLSocket::failHandshake(const char* /* fn */,
597 const AsyncSocketException& ex) {
599 if (handshakeTimeout_.isScheduled()) {
600 handshakeTimeout_.cancelTimeout();
602 invokeHandshakeErr(ex);
606 void AsyncSSLSocket::invokeHandshakeErr(const AsyncSocketException& ex) {
607 handshakeEndTime_ = std::chrono::steady_clock::now();
608 if (handshakeCallback_ != nullptr) {
609 HandshakeCB* callback = handshakeCallback_;
610 handshakeCallback_ = nullptr;
611 callback->handshakeErr(this, ex);
615 void AsyncSSLSocket::invokeHandshakeCB() {
616 handshakeEndTime_ = std::chrono::steady_clock::now();
617 if (handshakeTimeout_.isScheduled()) {
618 handshakeTimeout_.cancelTimeout();
620 if (handshakeCallback_) {
621 HandshakeCB* callback = handshakeCallback_;
622 handshakeCallback_ = nullptr;
623 callback->handshakeSuc(this);
627 void AsyncSSLSocket::cacheLocalPeerAddr() {
628 SocketAddress address;
630 getLocalAddress(&address);
631 getPeerAddress(&address);
632 } catch (const std::system_error& e) {
633 // The handle can be still valid while the connection is already closed.
634 if (e.code() != std::error_code(ENOTCONN, std::system_category())) {
640 void AsyncSSLSocket::connect(ConnectCallback* callback,
641 const folly::SocketAddress& address,
643 const OptionMap &options,
644 const folly::SocketAddress& bindAddr)
647 assert(state_ == StateEnum::UNINIT);
648 assert(sslState_ == STATE_UNINIT);
649 AsyncSSLSocketConnector *connector =
650 new AsyncSSLSocketConnector(this, callback, timeout);
651 AsyncSocket::connect(connector, address, timeout, options, bindAddr);
654 void AsyncSSLSocket::applyVerificationOptions(SSL * ssl) {
655 // apply the settings specified in verifyPeer_
656 if (verifyPeer_ == SSLContext::SSLVerifyPeerEnum::USE_CTX) {
657 if(ctx_->needsPeerVerification()) {
658 SSL_set_verify(ssl, ctx_->getVerificationMode(),
659 AsyncSSLSocket::sslVerifyCallback);
662 if (verifyPeer_ == SSLContext::SSLVerifyPeerEnum::VERIFY ||
663 verifyPeer_ == SSLContext::SSLVerifyPeerEnum::VERIFY_REQ_CLIENT_CERT) {
664 SSL_set_verify(ssl, SSLContext::getVerificationMode(verifyPeer_),
665 AsyncSSLSocket::sslVerifyCallback);
670 bool AsyncSSLSocket::setupSSLBio() {
671 auto wb = BIO_new(&sslWriteBioMethod);
677 OpenSSLUtils::setBioAppData(wb, this);
678 OpenSSLUtils::setBioFd(wb, fd_, BIO_NOCLOSE);
679 SSL_set_bio(ssl_, wb, wb);
683 void AsyncSSLSocket::sslConn(HandshakeCB* callback, uint64_t timeout,
684 const SSLContext::SSLVerifyPeerEnum& verifyPeer) {
685 DestructorGuard dg(this);
686 assert(eventBase_->isInEventBaseThread());
688 // Cache local and remote socket addresses to keep them available
689 // after socket file descriptor is closed.
690 if (cacheAddrOnFailure_ && -1 != getFd()) {
691 cacheLocalPeerAddr();
694 verifyPeer_ = verifyPeer;
696 // Make sure we're in the uninitialized state
697 if (server_ || (sslState_ != STATE_UNINIT && sslState_ !=
698 STATE_UNENCRYPTED) ||
699 handshakeCallback_ != nullptr) {
700 return invalidState(callback);
703 sslState_ = STATE_CONNECTING;
704 handshakeCallback_ = callback;
707 ssl_ = ctx_->createSSL();
708 } catch (std::exception &e) {
709 sslState_ = STATE_ERROR;
710 AsyncSocketException ex(AsyncSocketException::INTERNAL_ERROR,
711 "error calling SSLContext::createSSL()");
712 LOG(ERROR) << "AsyncSSLSocket::sslConn(this=" << this << ", fd="
713 << fd_ << "): " << e.what();
714 return failHandshake(__func__, ex);
717 if (!setupSSLBio()) {
718 sslState_ = STATE_ERROR;
719 AsyncSocketException ex(
720 AsyncSocketException::INTERNAL_ERROR, "error creating SSL bio");
721 return failHandshake(__func__, ex);
724 applyVerificationOptions(ssl_);
726 if (sslSession_ != nullptr) {
727 sessionResumptionAttempted_ = true;
728 SSL_set_session(ssl_, sslSession_);
729 SSL_SESSION_free(sslSession_);
730 sslSession_ = nullptr;
732 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
733 if (tlsextHostname_.size()) {
734 SSL_set_tlsext_host_name(ssl_, tlsextHostname_.c_str());
738 SSL_set_ex_data(ssl_, getSSLExDataIndex(), this);
740 handshakeConnectTimeout_ = timeout;
744 // This could be called multiple times, during normal ssl connections
745 // and after TFO fallback.
746 void AsyncSSLSocket::startSSLConnect() {
747 handshakeStartTime_ = std::chrono::steady_clock::now();
748 // Make end time at least >= start time.
749 handshakeEndTime_ = handshakeStartTime_;
750 if (handshakeConnectTimeout_ > 0) {
751 handshakeTimeout_.scheduleTimeout(
752 std::chrono::milliseconds(handshakeConnectTimeout_));
757 SSL_SESSION *AsyncSSLSocket::getSSLSession() {
758 if (ssl_ != nullptr && sslState_ == STATE_ESTABLISHED) {
759 return SSL_get1_session(ssl_);
765 const SSL* AsyncSSLSocket::getSSL() const {
769 void AsyncSSLSocket::setSSLSession(SSL_SESSION *session, bool takeOwnership) {
770 sslSession_ = session;
771 if (!takeOwnership && session != nullptr) {
772 // Increment the reference count
773 CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
777 void AsyncSSLSocket::getSelectedNextProtocol(
778 const unsigned char** protoName,
780 SSLContext::NextProtocolType* protoType) const {
781 if (!getSelectedNextProtocolNoThrow(protoName, protoLen, protoType)) {
782 throw AsyncSocketException(AsyncSocketException::NOT_SUPPORTED,
783 "NPN not supported");
787 bool AsyncSSLSocket::getSelectedNextProtocolNoThrow(
788 const unsigned char** protoName,
790 SSLContext::NextProtocolType* protoType) const {
791 *protoName = nullptr;
793 #if OPENSSL_VERSION_NUMBER >= 0x1000200fL && !defined(OPENSSL_NO_TLSEXT)
794 SSL_get0_alpn_selected(ssl_, protoName, protoLen);
797 *protoType = SSLContext::NextProtocolType::ALPN;
802 #ifdef OPENSSL_NPN_NEGOTIATED
803 SSL_get0_next_proto_negotiated(ssl_, protoName, protoLen);
805 *protoType = SSLContext::NextProtocolType::NPN;
814 bool AsyncSSLSocket::getSSLSessionReused() const {
815 if (ssl_ != nullptr && sslState_ == STATE_ESTABLISHED) {
816 return SSL_session_reused(ssl_);
821 const char *AsyncSSLSocket::getNegotiatedCipherName() const {
822 return (ssl_ != nullptr) ? SSL_get_cipher_name(ssl_) : nullptr;
826 const char* AsyncSSLSocket::getSSLServerNameFromSSL(SSL* ssl) {
827 if (ssl == nullptr) {
830 #ifdef SSL_CTRL_SET_TLSEXT_SERVERNAME_CB
831 return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
837 const char *AsyncSSLSocket::getSSLServerName() const {
838 #ifdef SSL_CTRL_SET_TLSEXT_SERVERNAME_CB
839 return getSSLServerNameFromSSL(ssl_);
841 throw AsyncSocketException(AsyncSocketException::NOT_SUPPORTED,
842 "SNI not supported");
846 const char *AsyncSSLSocket::getSSLServerNameNoThrow() const {
847 return getSSLServerNameFromSSL(ssl_);
850 int AsyncSSLSocket::getSSLVersion() const {
851 return (ssl_ != nullptr) ? SSL_version(ssl_) : 0;
854 const char *AsyncSSLSocket::getSSLCertSigAlgName() const {
855 X509 *cert = (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
857 int nid = OBJ_obj2nid(cert->sig_alg->algorithm);
858 return OBJ_nid2ln(nid);
863 int AsyncSSLSocket::getSSLCertSize() const {
865 X509 *cert = (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
867 EVP_PKEY *key = X509_get_pubkey(cert);
868 certSize = EVP_PKEY_bits(key);
874 const X509* AsyncSSLSocket::getSelfCert() const {
875 return (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
878 bool AsyncSSLSocket::willBlock(int ret,
880 unsigned long* errErrorOut) noexcept {
882 int error = *sslErrorOut = SSL_get_error(ssl_, ret);
883 if (error == SSL_ERROR_WANT_READ) {
884 // Register for read event if not already.
885 updateEventRegistration(EventHandler::READ, EventHandler::WRITE);
887 } else if (error == SSL_ERROR_WANT_WRITE) {
888 VLOG(3) << "AsyncSSLSocket(fd=" << fd_
889 << ", state=" << int(state_) << ", sslState="
890 << sslState_ << ", events=" << eventFlags_ << "): "
891 << "SSL_ERROR_WANT_WRITE";
892 // Register for write event if not already.
893 updateEventRegistration(EventHandler::WRITE, EventHandler::READ);
895 #ifdef SSL_ERROR_WANT_SESS_CACHE_LOOKUP
896 } else if (error == SSL_ERROR_WANT_SESS_CACHE_LOOKUP) {
897 // We will block but we can't register our own socket. The callback that
898 // triggered this code will re-call handleAccept at the appropriate time.
900 // We can only get here if the linked libssl.so has support for this feature
901 // as well, otherwise SSL_get_error cannot return our error code.
902 sslState_ = STATE_CACHE_LOOKUP;
904 // Unregister for all events while blocked here
905 updateEventRegistration(EventHandler::NONE,
906 EventHandler::READ | EventHandler::WRITE);
908 // The timeout (if set) keeps running here
912 #ifdef SSL_ERROR_WANT_RSA_ASYNC_PENDING
913 || error == SSL_ERROR_WANT_RSA_ASYNC_PENDING
915 #ifdef SSL_ERROR_WANT_ECDSA_ASYNC_PENDING
916 || error == SSL_ERROR_WANT_ECDSA_ASYNC_PENDING
919 // Our custom openssl function has kicked off an async request to do
920 // rsa/ecdsa private key operation. When that call returns, a callback will
921 // be invoked that will re-call handleAccept.
922 sslState_ = STATE_ASYNC_PENDING;
924 // Unregister for all events while blocked here
925 updateEventRegistration(
927 EventHandler::READ | EventHandler::WRITE
930 // The timeout (if set) keeps running here
933 unsigned long lastError = *errErrorOut = ERR_get_error();
934 VLOG(6) << "AsyncSSLSocket(fd=" << fd_ << ", "
935 << "state=" << state_ << ", "
936 << "sslState=" << sslState_ << ", "
937 << "events=" << std::hex << eventFlags_ << "): "
938 << "SSL error: " << error << ", "
939 << "errno: " << errno << ", "
940 << "ret: " << ret << ", "
941 << "read: " << BIO_number_read(SSL_get_rbio(ssl_)) << ", "
942 << "written: " << BIO_number_written(SSL_get_wbio(ssl_)) << ", "
943 << "func: " << ERR_func_error_string(lastError) << ", "
944 << "reason: " << ERR_reason_error_string(lastError);
949 void AsyncSSLSocket::checkForImmediateRead() noexcept {
950 // openssl may have buffered data that it read from the socket already.
951 // In this case we have to process it immediately, rather than waiting for
952 // the socket to become readable again.
953 if (ssl_ != nullptr && SSL_pending(ssl_) > 0) {
954 AsyncSocket::handleRead();
959 AsyncSSLSocket::restartSSLAccept()
961 VLOG(3) << "AsyncSSLSocket::restartSSLAccept() this=" << this
962 << ", fd=" << fd_ << ", state=" << int(state_) << ", "
963 << "sslState=" << sslState_ << ", events=" << eventFlags_;
964 DestructorGuard dg(this);
966 sslState_ == STATE_CACHE_LOOKUP ||
967 sslState_ == STATE_ASYNC_PENDING ||
968 sslState_ == STATE_ERROR ||
969 sslState_ == STATE_CLOSED);
970 if (sslState_ == STATE_CLOSED) {
971 // I sure hope whoever closed this socket didn't delete it already,
972 // but this is not strictly speaking an error
975 if (sslState_ == STATE_ERROR) {
976 // go straight to fail if timeout expired during lookup
977 AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
978 "SSL accept timed out");
979 failHandshake(__func__, ex);
982 sslState_ = STATE_ACCEPTING;
983 this->handleAccept();
987 AsyncSSLSocket::handleAccept() noexcept {
988 VLOG(3) << "AsyncSSLSocket::handleAccept() this=" << this
989 << ", fd=" << fd_ << ", state=" << int(state_) << ", "
990 << "sslState=" << sslState_ << ", events=" << eventFlags_;
992 assert(state_ == StateEnum::ESTABLISHED &&
993 sslState_ == STATE_ACCEPTING);
995 /* lazily create the SSL structure */
997 ssl_ = ctx_->createSSL();
998 } catch (std::exception &e) {
999 sslState_ = STATE_ERROR;
1000 AsyncSocketException ex(AsyncSocketException::INTERNAL_ERROR,
1001 "error calling SSLContext::createSSL()");
1002 LOG(ERROR) << "AsyncSSLSocket::handleAccept(this=" << this
1003 << ", fd=" << fd_ << "): " << e.what();
1004 return failHandshake(__func__, ex);
1007 if (!setupSSLBio()) {
1008 sslState_ = STATE_ERROR;
1009 AsyncSocketException ex(
1010 AsyncSocketException::INTERNAL_ERROR, "error creating write bio");
1011 return failHandshake(__func__, ex);
1014 SSL_set_ex_data(ssl_, getSSLExDataIndex(), this);
1016 applyVerificationOptions(ssl_);
1019 if (server_ && parseClientHello_) {
1020 SSL_set_msg_callback(ssl_, &AsyncSSLSocket::clientHelloParsingCallback);
1021 SSL_set_msg_callback_arg(ssl_, this);
1024 int ret = SSL_accept(ssl_);
1027 unsigned long errError;
1028 int errnoCopy = errno;
1029 if (willBlock(ret, &sslError, &errError)) {
1032 sslState_ = STATE_ERROR;
1033 SSLException ex(sslError, errError, ret, errnoCopy);
1034 return failHandshake(__func__, ex);
1038 handshakeComplete_ = true;
1039 updateEventRegistration(0, EventHandler::READ | EventHandler::WRITE);
1041 // Move into STATE_ESTABLISHED in the normal case that we are in
1043 sslState_ = STATE_ESTABLISHED;
1045 VLOG(3) << "AsyncSSLSocket " << this << ": fd " << fd_
1046 << " successfully accepted; state=" << int(state_)
1047 << ", sslState=" << sslState_ << ", events=" << eventFlags_;
1049 // Remember the EventBase we are attached to, before we start invoking any
1050 // callbacks (since the callbacks may call detachEventBase()).
1051 EventBase* originalEventBase = eventBase_;
1053 // Call the accept callback.
1054 invokeHandshakeCB();
1056 // Note that the accept callback may have changed our state.
1057 // (set or unset the read callback, called write(), closed the socket, etc.)
1058 // The following code needs to handle these situations correctly.
1060 // If the socket has been closed, readCallback_ and writeReqHead_ will
1061 // always be nullptr, so that will prevent us from trying to read or write.
1063 // The main thing to check for is if eventBase_ is still originalEventBase.
1064 // If not, we have been detached from this event base, so we shouldn't
1065 // perform any more operations.
1066 if (eventBase_ != originalEventBase) {
1070 AsyncSocket::handleInitialReadWrite();
1074 AsyncSSLSocket::handleConnect() noexcept {
1075 VLOG(3) << "AsyncSSLSocket::handleConnect() this=" << this
1076 << ", fd=" << fd_ << ", state=" << int(state_) << ", "
1077 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1079 if (state_ < StateEnum::ESTABLISHED) {
1080 return AsyncSocket::handleConnect();
1084 (state_ == StateEnum::FAST_OPEN || state_ == StateEnum::ESTABLISHED) &&
1085 sslState_ == STATE_CONNECTING);
1088 auto originalState = state_;
1089 int ret = SSL_connect(ssl_);
1092 unsigned long errError;
1093 int errnoCopy = errno;
1094 if (willBlock(ret, &sslError, &errError)) {
1095 // We fell back to connecting state due to TFO
1096 if (state_ == StateEnum::CONNECTING) {
1097 DCHECK_EQ(StateEnum::FAST_OPEN, originalState);
1098 if (handshakeTimeout_.isScheduled()) {
1099 handshakeTimeout_.cancelTimeout();
1104 sslState_ = STATE_ERROR;
1105 SSLException ex(sslError, errError, ret, errnoCopy);
1106 return failHandshake(__func__, ex);
1110 handshakeComplete_ = true;
1111 updateEventRegistration(0, EventHandler::READ | EventHandler::WRITE);
1113 // Move into STATE_ESTABLISHED in the normal case that we are in
1114 // STATE_CONNECTING.
1115 sslState_ = STATE_ESTABLISHED;
1117 VLOG(3) << "AsyncSSLSocket " << this << ": "
1118 << "fd " << fd_ << " successfully connected; "
1119 << "state=" << int(state_) << ", sslState=" << sslState_
1120 << ", events=" << eventFlags_;
1122 // Remember the EventBase we are attached to, before we start invoking any
1123 // callbacks (since the callbacks may call detachEventBase()).
1124 EventBase* originalEventBase = eventBase_;
1126 // Call the handshake callback.
1127 invokeHandshakeCB();
1129 // Note that the connect callback may have changed our state.
1130 // (set or unset the read callback, called write(), closed the socket, etc.)
1131 // The following code needs to handle these situations correctly.
1133 // If the socket has been closed, readCallback_ and writeReqHead_ will
1134 // always be nullptr, so that will prevent us from trying to read or write.
1136 // The main thing to check for is if eventBase_ is still originalEventBase.
1137 // If not, we have been detached from this event base, so we shouldn't
1138 // perform any more operations.
1139 if (eventBase_ != originalEventBase) {
1143 AsyncSocket::handleInitialReadWrite();
1146 void AsyncSSLSocket::invokeConnectErr(const AsyncSocketException& ex) {
1147 connectionTimeout_.cancelTimeout();
1148 AsyncSocket::invokeConnectErr(ex);
1149 if (sslState_ == SSLStateEnum::STATE_CONNECTING) {
1150 if (handshakeTimeout_.isScheduled()) {
1151 handshakeTimeout_.cancelTimeout();
1153 // If we fell back to connecting state during TFO and the connection
1154 // failed, it would be an SSL failure as well.
1155 invokeHandshakeErr(ex);
1159 void AsyncSSLSocket::invokeConnectSuccess() {
1160 connectionTimeout_.cancelTimeout();
1161 if (sslState_ == SSLStateEnum::STATE_CONNECTING) {
1162 assert(tfoAttempted_);
1163 // If we failed TFO, we'd fall back to trying to connect the socket,
1164 // to setup things like timeouts.
1167 // still invoke the base class since it re-sets the connect time.
1168 AsyncSocket::invokeConnectSuccess();
1171 void AsyncSSLSocket::scheduleConnectTimeout() {
1172 if (sslState_ == SSLStateEnum::STATE_CONNECTING) {
1173 // We fell back from TFO, and need to set the timeouts.
1174 // We will not have a connect callback in this case, thus if the timer
1175 // expires we would have no-one to notify.
1176 // Thus we should reset even the connect timers to point to the handshake
1178 assert(connectCallback_ == nullptr);
1179 // We use a different connect timeout here than the handshake timeout, so
1180 // that we can disambiguate the 2 timers.
1181 if (connectTimeout_.count() > 0) {
1182 if (!connectionTimeout_.scheduleTimeout(connectTimeout_)) {
1183 throw AsyncSocketException(
1184 AsyncSocketException::INTERNAL_ERROR,
1185 withAddr("failed to schedule AsyncSSLSocket connect timeout"));
1190 AsyncSocket::scheduleConnectTimeout();
1193 void AsyncSSLSocket::setReadCB(ReadCallback *callback) {
1194 #ifdef SSL_MODE_MOVE_BUFFER_OWNERSHIP
1195 // turn on the buffer movable in openssl
1196 if (bufferMovableEnabled_ && ssl_ != nullptr && !isBufferMovable_ &&
1197 callback != nullptr && callback->isBufferMovable()) {
1198 SSL_set_mode(ssl_, SSL_get_mode(ssl_) | SSL_MODE_MOVE_BUFFER_OWNERSHIP);
1199 isBufferMovable_ = true;
1203 AsyncSocket::setReadCB(callback);
1206 void AsyncSSLSocket::setBufferMovableEnabled(bool enabled) {
1207 bufferMovableEnabled_ = enabled;
1210 void AsyncSSLSocket::prepareReadBuffer(void** buf, size_t* buflen) {
1211 CHECK(readCallback_);
1212 if (isBufferMovable_) {
1216 // buf is necessary for SSLSocket without SSL_MODE_MOVE_BUFFER_OWNERSHIP
1217 readCallback_->getReadBuffer(buf, buflen);
1222 AsyncSSLSocket::handleRead() noexcept {
1223 VLOG(5) << "AsyncSSLSocket::handleRead() this=" << this << ", fd=" << fd_
1224 << ", state=" << int(state_) << ", "
1225 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1226 if (state_ < StateEnum::ESTABLISHED) {
1227 return AsyncSocket::handleRead();
1231 if (sslState_ == STATE_ACCEPTING) {
1236 else if (sslState_ == STATE_CONNECTING) {
1243 AsyncSocket::handleRead();
1246 AsyncSocket::ReadResult
1247 AsyncSSLSocket::performRead(void** buf, size_t* buflen, size_t* offset) {
1248 VLOG(4) << "AsyncSSLSocket::performRead() this=" << this << ", buf=" << *buf
1249 << ", buflen=" << *buflen;
1251 if (sslState_ == STATE_UNENCRYPTED) {
1252 return AsyncSocket::performRead(buf, buflen, offset);
1256 if (!isBufferMovable_) {
1257 bytes = SSL_read(ssl_, *buf, int(*buflen));
1259 #ifdef SSL_MODE_MOVE_BUFFER_OWNERSHIP
1261 bytes = SSL_read_buf(ssl_, buf, (int *) offset, (int *) buflen);
1265 if (server_ && renegotiateAttempted_) {
1266 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1267 << ", sslstate=" << sslState_ << ", events=" << eventFlags_
1268 << "): client intitiated SSL renegotiation not permitted";
1271 folly::make_unique<SSLException>(SSLError::CLIENT_RENEGOTIATION));
1274 int error = SSL_get_error(ssl_, bytes);
1275 if (error == SSL_ERROR_WANT_READ) {
1276 // The caller will register for read event if not already.
1277 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1278 return ReadResult(READ_BLOCKING);
1280 return ReadResult(READ_ERROR);
1282 } else if (error == SSL_ERROR_WANT_WRITE) {
1283 // TODO: Even though we are attempting to read data, SSL_read() may
1284 // need to write data if renegotiation is being performed. We currently
1285 // don't support this and just fail the read.
1286 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1287 << ", sslState=" << sslState_ << ", events=" << eventFlags_
1288 << "): unsupported SSL renegotiation during read";
1291 folly::make_unique<SSLException>(SSLError::INVALID_RENEGOTIATION));
1293 if (zero_return(error, bytes)) {
1294 return ReadResult(bytes);
1296 long errError = ERR_get_error();
1297 VLOG(6) << "AsyncSSLSocket(fd=" << fd_ << ", "
1298 << "state=" << state_ << ", "
1299 << "sslState=" << sslState_ << ", "
1300 << "events=" << std::hex << eventFlags_ << "): "
1301 << "bytes: " << bytes << ", "
1302 << "error: " << error << ", "
1303 << "errno: " << errno << ", "
1304 << "func: " << ERR_func_error_string(errError) << ", "
1305 << "reason: " << ERR_reason_error_string(errError);
1308 folly::make_unique<SSLException>(error, errError, bytes, errno));
1311 appBytesReceived_ += bytes;
1312 return ReadResult(bytes);
1316 void AsyncSSLSocket::handleWrite() noexcept {
1317 VLOG(5) << "AsyncSSLSocket::handleWrite() this=" << this << ", fd=" << fd_
1318 << ", state=" << int(state_) << ", "
1319 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1320 if (state_ < StateEnum::ESTABLISHED) {
1321 return AsyncSocket::handleWrite();
1324 if (sslState_ == STATE_ACCEPTING) {
1330 if (sslState_ == STATE_CONNECTING) {
1337 AsyncSocket::handleWrite();
1340 AsyncSocket::WriteResult AsyncSSLSocket::interpretSSLError(int rc, int error) {
1341 if (error == SSL_ERROR_WANT_READ) {
1342 // Even though we are attempting to write data, SSL_write() may
1343 // need to read data if renegotiation is being performed. We currently
1344 // don't support this and just fail the write.
1345 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1346 << ", sslState=" << sslState_ << ", events=" << eventFlags_
1348 << "unsupported SSL renegotiation during write";
1351 folly::make_unique<SSLException>(SSLError::INVALID_RENEGOTIATION));
1353 if (zero_return(error, rc)) {
1354 return WriteResult(0);
1356 auto errError = ERR_get_error();
1357 VLOG(3) << "ERROR: AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1358 << ", sslState=" << sslState_ << ", events=" << eventFlags_ << "): "
1359 << "SSL error: " << error << ", errno: " << errno
1360 << ", func: " << ERR_func_error_string(errError)
1361 << ", reason: " << ERR_reason_error_string(errError);
1364 folly::make_unique<SSLException>(error, errError, rc, errno));
1368 AsyncSocket::WriteResult AsyncSSLSocket::performWrite(
1372 uint32_t* countWritten,
1373 uint32_t* partialWritten) {
1374 if (sslState_ == STATE_UNENCRYPTED) {
1375 return AsyncSocket::performWrite(
1376 vec, count, flags, countWritten, partialWritten);
1378 if (sslState_ != STATE_ESTABLISHED) {
1379 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1380 << ", sslState=" << sslState_
1381 << ", events=" << eventFlags_ << "): "
1382 << "TODO: AsyncSSLSocket currently does not support calling "
1383 << "write() before the handshake has fully completed";
1385 WRITE_ERROR, folly::make_unique<SSLException>(SSLError::EARLY_WRITE));
1388 // Declare a buffer used to hold small write requests. It could point to a
1389 // memory block either on stack or on heap. If it is on heap, we release it
1390 // manually when scope exits
1391 char* combinedBuf{nullptr};
1393 // Note, always keep this check consistent with what we do below
1394 if (combinedBuf != nullptr && minWriteSize_ > MAX_STACK_BUF_SIZE) {
1395 delete[] combinedBuf;
1400 *partialWritten = 0;
1401 ssize_t totalWritten = 0;
1402 size_t bytesStolenFromNextBuffer = 0;
1403 for (uint32_t i = 0; i < count; i++) {
1404 const iovec* v = vec + i;
1405 size_t offset = bytesStolenFromNextBuffer;
1406 bytesStolenFromNextBuffer = 0;
1407 size_t len = v->iov_len - offset;
1413 buf = ((const char*)v->iov_base) + offset;
1416 uint32_t buffersStolen = 0;
1417 auto sslWriteBuf = buf;
1418 if ((len < minWriteSize_) && ((i + 1) < count)) {
1419 // Combine this buffer with part or all of the next buffers in
1420 // order to avoid really small-grained calls to SSL_write().
1421 // Each call to SSL_write() produces a separate record in
1422 // the egress SSL stream, and we've found that some low-end
1423 // mobile clients can't handle receiving an HTTP response
1424 // header and the first part of the response body in two
1425 // separate SSL records (even if those two records are in
1426 // the same TCP packet).
1428 if (combinedBuf == nullptr) {
1429 if (minWriteSize_ > MAX_STACK_BUF_SIZE) {
1430 // Allocate the buffer on heap
1431 combinedBuf = new char[minWriteSize_];
1433 // Allocate the buffer on stack
1434 combinedBuf = (char*)alloca(minWriteSize_);
1437 assert(combinedBuf != nullptr);
1438 sslWriteBuf = combinedBuf;
1440 memcpy(combinedBuf, buf, len);
1442 // INVARIANT: i + buffersStolen == complete chunks serialized
1443 uint32_t nextIndex = i + buffersStolen + 1;
1444 bytesStolenFromNextBuffer = std::min(vec[nextIndex].iov_len,
1445 minWriteSize_ - len);
1446 memcpy(combinedBuf + len, vec[nextIndex].iov_base,
1447 bytesStolenFromNextBuffer);
1448 len += bytesStolenFromNextBuffer;
1449 if (bytesStolenFromNextBuffer < vec[nextIndex].iov_len) {
1450 // couldn't steal the whole buffer
1453 bytesStolenFromNextBuffer = 0;
1456 } while ((i + buffersStolen + 1) < count && (len < minWriteSize_));
1459 // Advance any empty buffers immediately after.
1460 if (bytesStolenFromNextBuffer == 0) {
1461 while ((i + buffersStolen + 1) < count &&
1462 vec[i + buffersStolen + 1].iov_len == 0) {
1468 isSet(flags, WriteFlags::CORK) || (i + buffersStolen + 1 < count);
1469 bytes = eorAwareSSLWrite(
1473 (isSet(flags, WriteFlags::EOR) && i + buffersStolen + 1 == count));
1476 int error = SSL_get_error(ssl_, int(bytes));
1477 if (error == SSL_ERROR_WANT_WRITE) {
1478 // The caller will register for write event if not already.
1479 *partialWritten = uint32_t(offset);
1480 return WriteResult(totalWritten);
1482 auto writeResult = interpretSSLError(int(bytes), error);
1483 if (writeResult.writeReturn < 0) {
1485 } // else fall through to below to correctly record totalWritten
1488 totalWritten += bytes;
1490 if (bytes == (ssize_t)len) {
1491 // The full iovec is written.
1492 (*countWritten) += 1 + buffersStolen;
1496 bytes += offset; // adjust bytes to account for all of v
1497 while (bytes >= (ssize_t)v->iov_len) {
1498 // We combined this buf with part or all of the next one, and
1499 // we managed to write all of this buf but not all of the bytes
1500 // from the next one that we'd hoped to write.
1501 bytes -= v->iov_len;
1505 *partialWritten = uint32_t(bytes);
1506 return WriteResult(totalWritten);
1510 return WriteResult(totalWritten);
1513 int AsyncSSLSocket::eorAwareSSLWrite(SSL *ssl, const void *buf, int n,
1515 if (eor && trackEor_) {
1516 if (appEorByteNo_) {
1517 // cannot track for more than one app byte EOR
1518 CHECK(appEorByteNo_ == appBytesWritten_ + n);
1520 appEorByteNo_ = appBytesWritten_ + n;
1523 // 1. It is fine to keep updating minEorRawByteNo_.
1524 // 2. It is _min_ in the sense that SSL record will add some overhead.
1525 minEorRawByteNo_ = getRawBytesWritten() + n;
1528 n = sslWriteImpl(ssl, buf, n);
1530 appBytesWritten_ += n;
1531 if (appEorByteNo_) {
1532 if (getRawBytesWritten() >= minEorRawByteNo_) {
1533 minEorRawByteNo_ = 0;
1535 if(appBytesWritten_ == appEorByteNo_) {
1538 CHECK(appBytesWritten_ < appEorByteNo_);
1545 void AsyncSSLSocket::sslInfoCallback(const SSL* ssl, int where, int ret) {
1546 AsyncSSLSocket *sslSocket = AsyncSSLSocket::getFromSSL(ssl);
1547 if (sslSocket->handshakeComplete_ && (where & SSL_CB_HANDSHAKE_START)) {
1548 sslSocket->renegotiateAttempted_ = true;
1550 if (where & SSL_CB_READ_ALERT) {
1551 const char* type = SSL_alert_type_string(ret);
1553 const char* desc = SSL_alert_desc_string(ret);
1554 sslSocket->alertsReceived_.emplace_back(
1555 *type, StringPiece(desc, std::strlen(desc)));
1560 int AsyncSSLSocket::bioWrite(BIO* b, const char* in, int inl) {
1564 AsyncSSLSocket* tsslSock;
1566 iov.iov_base = const_cast<char*>(in);
1568 memset(&msg, 0, sizeof(msg));
1572 auto appData = OpenSSLUtils::getBioAppData(b);
1575 tsslSock = reinterpret_cast<AsyncSSLSocket*>(appData);
1578 if (tsslSock->trackEor_ && tsslSock->minEorRawByteNo_ &&
1579 tsslSock->minEorRawByteNo_ <= BIO_number_written(b) + inl) {
1584 flags |= MSG_NOSIGNAL;
1588 if (tsslSock->corkCurrentWrite_) {
1593 auto result = tsslSock->sendSocketMessage(
1594 OpenSSLUtils::getBioFd(b, nullptr), &msg, flags);
1595 BIO_clear_retry_flags(b);
1596 if (!result.exception && result.writeReturn <= 0) {
1597 if (OpenSSLUtils::getBioShouldRetryWrite(int(result.writeReturn))) {
1598 BIO_set_retry_write(b);
1601 return int(result.writeReturn);
1604 int AsyncSSLSocket::sslVerifyCallback(
1606 X509_STORE_CTX* x509Ctx) {
1607 SSL* ssl = (SSL*) X509_STORE_CTX_get_ex_data(
1608 x509Ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
1609 AsyncSSLSocket* self = AsyncSSLSocket::getFromSSL(ssl);
1611 VLOG(3) << "AsyncSSLSocket::sslVerifyCallback() this=" << self << ", "
1612 << "fd=" << self->fd_ << ", preverifyOk=" << preverifyOk;
1613 return (self->handshakeCallback_) ?
1614 self->handshakeCallback_->handshakeVer(self, preverifyOk, x509Ctx) :
1618 void AsyncSSLSocket::enableClientHelloParsing() {
1619 parseClientHello_ = true;
1620 clientHelloInfo_.reset(new ssl::ClientHelloInfo());
1623 void AsyncSSLSocket::resetClientHelloParsing(SSL *ssl) {
1624 SSL_set_msg_callback(ssl, nullptr);
1625 SSL_set_msg_callback_arg(ssl, nullptr);
1626 clientHelloInfo_->clientHelloBuf_.clear();
1629 void AsyncSSLSocket::clientHelloParsingCallback(int written,
1636 AsyncSSLSocket *sock = static_cast<AsyncSSLSocket*>(arg);
1638 sock->resetClientHelloParsing(ssl);
1641 if (contentType != SSL3_RT_HANDSHAKE) {
1648 auto& clientHelloBuf = sock->clientHelloInfo_->clientHelloBuf_;
1649 clientHelloBuf.append(IOBuf::wrapBuffer(buf, len));
1651 Cursor cursor(clientHelloBuf.front());
1652 if (cursor.read<uint8_t>() != SSL3_MT_CLIENT_HELLO) {
1653 sock->resetClientHelloParsing(ssl);
1657 if (cursor.totalLength() < 3) {
1658 clientHelloBuf.trimEnd(len);
1659 clientHelloBuf.append(IOBuf::copyBuffer(buf, len));
1663 uint32_t messageLength = cursor.read<uint8_t>();
1664 messageLength <<= 8;
1665 messageLength |= cursor.read<uint8_t>();
1666 messageLength <<= 8;
1667 messageLength |= cursor.read<uint8_t>();
1668 if (cursor.totalLength() < messageLength) {
1669 clientHelloBuf.trimEnd(len);
1670 clientHelloBuf.append(IOBuf::copyBuffer(buf, len));
1674 sock->clientHelloInfo_->clientHelloMajorVersion_ = cursor.read<uint8_t>();
1675 sock->clientHelloInfo_->clientHelloMinorVersion_ = cursor.read<uint8_t>();
1677 cursor.skip(4); // gmt_unix_time
1678 cursor.skip(28); // random_bytes
1680 cursor.skip(cursor.read<uint8_t>()); // session_id
1682 uint16_t cipherSuitesLength = cursor.readBE<uint16_t>();
1683 for (int i = 0; i < cipherSuitesLength; i += 2) {
1684 sock->clientHelloInfo_->
1685 clientHelloCipherSuites_.push_back(cursor.readBE<uint16_t>());
1688 uint8_t compressionMethodsLength = cursor.read<uint8_t>();
1689 for (int i = 0; i < compressionMethodsLength; ++i) {
1690 sock->clientHelloInfo_->
1691 clientHelloCompressionMethods_.push_back(cursor.readBE<uint8_t>());
1694 if (cursor.totalLength() > 0) {
1695 uint16_t extensionsLength = cursor.readBE<uint16_t>();
1696 while (extensionsLength) {
1697 ssl::TLSExtension extensionType =
1698 static_cast<ssl::TLSExtension>(cursor.readBE<uint16_t>());
1699 sock->clientHelloInfo_->
1700 clientHelloExtensions_.push_back(extensionType);
1701 extensionsLength -= 2;
1702 uint16_t extensionDataLength = cursor.readBE<uint16_t>();
1703 extensionsLength -= 2;
1704 extensionsLength -= extensionDataLength;
1706 if (extensionType == ssl::TLSExtension::SIGNATURE_ALGORITHMS) {
1708 extensionDataLength -= 2;
1709 while (extensionDataLength) {
1710 ssl::HashAlgorithm hashAlg =
1711 static_cast<ssl::HashAlgorithm>(cursor.readBE<uint8_t>());
1712 ssl::SignatureAlgorithm sigAlg =
1713 static_cast<ssl::SignatureAlgorithm>(cursor.readBE<uint8_t>());
1714 extensionDataLength -= 2;
1715 sock->clientHelloInfo_->
1716 clientHelloSigAlgs_.emplace_back(hashAlg, sigAlg);
1718 } else if (extensionType == ssl::TLSExtension::SUPPORTED_VERSIONS) {
1720 extensionDataLength -= 1;
1721 while (extensionDataLength) {
1722 sock->clientHelloInfo_->clientHelloSupportedVersions_.push_back(
1723 cursor.readBE<uint16_t>());
1724 extensionDataLength -= 2;
1727 cursor.skip(extensionDataLength);
1731 } catch (std::out_of_range&) {
1732 // we'll use what we found and cleanup below.
1733 VLOG(4) << "AsyncSSLSocket::clientHelloParsingCallback(): "
1734 << "buffer finished unexpectedly." << " AsyncSSLSocket socket=" << sock;
1737 sock->resetClientHelloParsing(ssl);
1740 void AsyncSSLSocket::getSSLClientCiphers(
1741 std::string& clientCiphers,
1742 bool convertToString) const {
1743 std::string ciphers;
1745 if (parseClientHello_ == false
1746 || clientHelloInfo_->clientHelloCipherSuites_.empty()) {
1752 for (auto originalCipherCode : clientHelloInfo_->clientHelloCipherSuites_)
1760 bool nameFound = convertToString;
1762 if (convertToString) {
1763 const auto& name = OpenSSLUtils::getCipherName(originalCipherCode);
1773 std::array<uint8_t, 2>{{
1774 static_cast<uint8_t>((originalCipherCode >> 8) & 0xffL),
1775 static_cast<uint8_t>(originalCipherCode & 0x00ffL) }},
1777 /* append to ciphers = */ true);
1781 clientCiphers = std::move(ciphers);
1784 std::string AsyncSSLSocket::getSSLClientComprMethods() const {
1785 if (!parseClientHello_) {
1788 return folly::join(":", clientHelloInfo_->clientHelloCompressionMethods_);
1791 std::string AsyncSSLSocket::getSSLClientExts() const {
1792 if (!parseClientHello_) {
1795 return folly::join(":", clientHelloInfo_->clientHelloExtensions_);
1798 std::string AsyncSSLSocket::getSSLClientSigAlgs() const {
1799 if (!parseClientHello_) {
1803 std::string sigAlgs;
1804 sigAlgs.reserve(clientHelloInfo_->clientHelloSigAlgs_.size() * 4);
1805 for (size_t i = 0; i < clientHelloInfo_->clientHelloSigAlgs_.size(); i++) {
1807 sigAlgs.push_back(':');
1809 sigAlgs.append(folly::to<std::string>(
1810 clientHelloInfo_->clientHelloSigAlgs_[i].first));
1811 sigAlgs.push_back(',');
1812 sigAlgs.append(folly::to<std::string>(
1813 clientHelloInfo_->clientHelloSigAlgs_[i].second));
1819 std::string AsyncSSLSocket::getSSLClientSupportedVersions() const {
1820 if (!parseClientHello_) {
1823 return folly::join(":", clientHelloInfo_->clientHelloSupportedVersions_);
1826 std::string AsyncSSLSocket::getSSLAlertsReceived() const {
1829 for (const auto& alert : alertsReceived_) {
1833 ret.append(folly::to<std::string>(alert.first, ": ", alert.second));
1839 void AsyncSSLSocket::getSSLSharedCiphers(std::string& sharedCiphers) const {
1840 char ciphersBuffer[1024];
1841 ciphersBuffer[0] = '\0';
1842 SSL_get_shared_ciphers(ssl_, ciphersBuffer, sizeof(ciphersBuffer) - 1);
1843 sharedCiphers = ciphersBuffer;
1846 void AsyncSSLSocket::getSSLServerCiphers(std::string& serverCiphers) const {
1847 serverCiphers = SSL_get_cipher_list(ssl_, 0);
1850 while ((cipher = SSL_get_cipher_list(ssl_, i)) != nullptr) {
1851 serverCiphers.append(":");
1852 serverCiphers.append(cipher);