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 LOG(ERROR) << "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 LOG(ERROR) << "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 // XXX: implement an equivalent to corking for platforms with TCP_NOPUSH?
155 #ifdef TCP_CORK // Linux-only
157 * Utility class that corks a TCP socket upon construction or uncorks
158 * the socket upon destruction
160 class CorkGuard : private boost::noncopyable {
162 CorkGuard(int fd, bool multipleWrites, bool haveMore, bool* corked):
163 fd_(fd), haveMore_(haveMore), corked_(corked) {
165 // socket is already corked; nothing to do
168 if (multipleWrites || haveMore) {
169 // We are performing multiple writes in this performWrite() call,
170 // and/or there are more calls to performWrite() that will be invoked
171 // later, so enable corking
173 setsockopt(fd_, IPPROTO_TCP, TCP_CORK, &flag, sizeof(flag));
180 // more data to come; don't uncork yet
184 // socket isn't corked; nothing to do
189 setsockopt(fd_, IPPROTO_TCP, TCP_CORK, &flag, sizeof(flag));
199 class CorkGuard : private boost::noncopyable {
201 CorkGuard(int, bool, bool, bool*) {}
205 void setup_SSL_CTX(SSL_CTX *ctx) {
206 #ifdef SSL_MODE_RELEASE_BUFFERS
207 SSL_CTX_set_mode(ctx,
208 SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER |
209 SSL_MODE_ENABLE_PARTIAL_WRITE
210 | SSL_MODE_RELEASE_BUFFERS
213 SSL_CTX_set_mode(ctx,
214 SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER |
215 SSL_MODE_ENABLE_PARTIAL_WRITE
218 // SSL_CTX_set_mode is a Macro
219 #ifdef SSL_MODE_WRITE_IOVEC
220 SSL_CTX_set_mode(ctx,
221 SSL_CTX_get_mode(ctx)
222 | SSL_MODE_WRITE_IOVEC);
227 BIO_METHOD sslWriteBioMethod;
229 void* initsslWriteBioMethod(void) {
230 memcpy(&sslWriteBioMethod, BIO_s_socket(), sizeof(sslWriteBioMethod));
231 // override the bwrite method for MSG_EOR support
232 OpenSSLUtils::setCustomBioWriteMethod(
233 &sslWriteBioMethod, AsyncSSLSocket::bioWrite);
235 // Note that the sslWriteBioMethod.type and sslWriteBioMethod.name are not
236 // set here. openssl code seems to be checking ".type == BIO_TYPE_SOCKET" and
237 // then have specific handlings. The sslWriteBioWrite should be compatible
238 // with the one in openssl.
240 // Return something here to enable AsyncSSLSocket to call this method using
241 // a function-scoped static.
245 } // anonymous namespace
250 * Create a client AsyncSSLSocket
252 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext> &ctx,
253 EventBase* evb, bool deferSecurityNegotiation) :
256 handshakeTimeout_(this, evb),
257 connectionTimeout_(this, evb) {
259 if (deferSecurityNegotiation) {
260 sslState_ = STATE_UNENCRYPTED;
265 * Create a server/client AsyncSSLSocket
267 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext>& ctx,
268 EventBase* evb, int fd, bool server,
269 bool deferSecurityNegotiation) :
270 AsyncSocket(evb, fd),
273 handshakeTimeout_(this, evb),
274 connectionTimeout_(this, evb) {
277 SSL_CTX_set_info_callback(ctx_->getSSLCtx(),
278 AsyncSSLSocket::sslInfoCallback);
280 if (deferSecurityNegotiation) {
281 sslState_ = STATE_UNENCRYPTED;
285 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
287 * Create a client AsyncSSLSocket and allow tlsext_hostname
288 * to be sent in Client Hello.
290 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext> &ctx,
292 const std::string& serverName,
293 bool deferSecurityNegotiation) :
294 AsyncSSLSocket(ctx, evb, deferSecurityNegotiation) {
295 tlsextHostname_ = serverName;
299 * Create a client AsyncSSLSocket from an already connected fd
300 * and allow tlsext_hostname to be sent in Client Hello.
302 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext>& ctx,
303 EventBase* evb, int fd,
304 const std::string& serverName,
305 bool deferSecurityNegotiation) :
306 AsyncSSLSocket(ctx, evb, fd, false, deferSecurityNegotiation) {
307 tlsextHostname_ = serverName;
311 AsyncSSLSocket::~AsyncSSLSocket() {
312 VLOG(3) << "actual destruction of AsyncSSLSocket(this=" << this
313 << ", evb=" << eventBase_ << ", fd=" << fd_
314 << ", state=" << int(state_) << ", sslState="
315 << sslState_ << ", events=" << eventFlags_ << ")";
318 void AsyncSSLSocket::init() {
319 // Do this here to ensure we initialize this once before any use of
320 // AsyncSSLSocket instances and not as part of library load.
321 static const auto sslWriteBioMethodInitializer = initsslWriteBioMethod();
322 (void)sslWriteBioMethodInitializer;
324 setup_SSL_CTX(ctx_->getSSLCtx());
327 void AsyncSSLSocket::closeNow() {
328 // Close the SSL connection.
329 if (ssl_ != nullptr && fd_ != -1) {
330 int rc = SSL_shutdown(ssl_);
332 rc = SSL_shutdown(ssl_);
339 if (sslSession_ != nullptr) {
340 SSL_SESSION_free(sslSession_);
341 sslSession_ = nullptr;
344 sslState_ = STATE_CLOSED;
346 if (handshakeTimeout_.isScheduled()) {
347 handshakeTimeout_.cancelTimeout();
350 DestructorGuard dg(this);
353 AsyncSocketException(
354 AsyncSocketException::END_OF_FILE,
355 "SSL connection closed locally"));
357 if (ssl_ != nullptr) {
363 AsyncSocket::closeNow();
366 void AsyncSSLSocket::shutdownWrite() {
367 // SSL sockets do not support half-shutdown, so just perform a full shutdown.
369 // (Performing a full shutdown here is more desirable than doing nothing at
370 // all. The purpose of shutdownWrite() is normally to notify the other end
371 // of the connection that no more data will be sent. If we do nothing, the
372 // other end will never know that no more data is coming, and this may result
373 // in protocol deadlock.)
377 void AsyncSSLSocket::shutdownWriteNow() {
381 bool AsyncSSLSocket::good() const {
382 return (AsyncSocket::good() &&
383 (sslState_ == STATE_ACCEPTING || sslState_ == STATE_CONNECTING ||
384 sslState_ == STATE_ESTABLISHED || sslState_ == STATE_UNENCRYPTED));
387 // The TAsyncTransport definition of 'good' states that the transport is
388 // ready to perform reads and writes, so sslState_ == UNINIT must report !good.
389 // connecting can be true when the sslState_ == UNINIT because the AsyncSocket
390 // is connected but we haven't initiated the call to SSL_connect.
391 bool AsyncSSLSocket::connecting() const {
393 (AsyncSocket::connecting() ||
394 (AsyncSocket::good() && (sslState_ == STATE_UNINIT ||
395 sslState_ == STATE_CONNECTING))));
398 std::string AsyncSSLSocket::getApplicationProtocol() noexcept {
399 const unsigned char* protoName = nullptr;
400 unsigned protoLength;
401 if (getSelectedNextProtocolNoThrow(&protoName, &protoLength)) {
402 return std::string(reinterpret_cast<const char*>(protoName), protoLength);
407 bool AsyncSSLSocket::isEorTrackingEnabled() const {
411 void AsyncSSLSocket::setEorTracking(bool track) {
412 if (trackEor_ != track) {
415 minEorRawByteNo_ = 0;
419 size_t AsyncSSLSocket::getRawBytesWritten() const {
421 if (!ssl_ || !(b = SSL_get_wbio(ssl_))) {
425 return BIO_number_written(b);
428 size_t AsyncSSLSocket::getRawBytesReceived() const {
430 if (!ssl_ || !(b = SSL_get_rbio(ssl_))) {
434 return BIO_number_read(b);
438 void AsyncSSLSocket::invalidState(HandshakeCB* callback) {
439 LOG(ERROR) << "AsyncSSLSocket(this=" << this << ", fd=" << fd_
440 << ", state=" << int(state_) << ", sslState=" << sslState_ << ", "
441 << "events=" << eventFlags_ << ", server=" << short(server_)
442 << "): " << "sslAccept/Connect() called in invalid "
443 << "state, handshake callback " << handshakeCallback_
444 << ", new callback " << callback;
445 assert(!handshakeTimeout_.isScheduled());
446 sslState_ = STATE_ERROR;
448 AsyncSocketException ex(AsyncSocketException::INVALID_STATE,
449 "sslAccept() called with socket in invalid state");
451 handshakeEndTime_ = std::chrono::steady_clock::now();
453 callback->handshakeErr(this, ex);
456 // Check the socket state not the ssl state here.
457 if (state_ != StateEnum::CLOSED || state_ != StateEnum::ERROR) {
458 failHandshake(__func__, ex);
462 void AsyncSSLSocket::sslAccept(HandshakeCB* callback, uint32_t timeout,
463 const SSLContext::SSLVerifyPeerEnum& verifyPeer) {
464 DestructorGuard dg(this);
465 assert(eventBase_->isInEventBaseThread());
466 verifyPeer_ = verifyPeer;
468 // Make sure we're in the uninitialized state
469 if (!server_ || (sslState_ != STATE_UNINIT &&
470 sslState_ != STATE_UNENCRYPTED) ||
471 handshakeCallback_ != nullptr) {
472 return invalidState(callback);
475 // Cache local and remote socket addresses to keep them available
476 // after socket file descriptor is closed.
477 if (cacheAddrOnFailure_ && -1 != getFd()) {
478 cacheLocalPeerAddr();
481 handshakeStartTime_ = std::chrono::steady_clock::now();
482 // Make end time at least >= start time.
483 handshakeEndTime_ = handshakeStartTime_;
485 sslState_ = STATE_ACCEPTING;
486 handshakeCallback_ = callback;
489 handshakeTimeout_.scheduleTimeout(timeout);
492 /* register for a read operation (waiting for CLIENT HELLO) */
493 updateEventRegistration(EventHandler::READ, EventHandler::WRITE);
496 #if OPENSSL_VERSION_NUMBER >= 0x009080bfL
497 void AsyncSSLSocket::attachSSLContext(
498 const std::shared_ptr<SSLContext>& ctx) {
500 // Check to ensure we are in client mode. Changing a server's ssl
501 // context doesn't make sense since clients of that server would likely
502 // become confused when the server's context changes.
506 DCHECK(ctx->getSSLCtx());
509 // In order to call attachSSLContext, detachSSLContext must have been
510 // previously called which sets the socket's context to the dummy
511 // context. Thus we must acquire this lock.
512 SpinLockGuard guard(dummyCtxLock);
513 SSL_set_SSL_CTX(ssl_, ctx->getSSLCtx());
516 void AsyncSSLSocket::detachSSLContext() {
519 // We aren't using the initial_ctx for now, and it can introduce race
520 // conditions in the destructor of the SSL object.
521 #ifndef OPENSSL_NO_TLSEXT
522 if (ssl_->initial_ctx) {
523 SSL_CTX_free(ssl_->initial_ctx);
524 ssl_->initial_ctx = nullptr;
527 SpinLockGuard guard(dummyCtxLock);
528 if (nullptr == dummyCtx) {
529 // We need to lazily initialize the dummy context so we don't
530 // accidentally override any programmatic settings to openssl
531 dummyCtx = new SSLContext;
533 // We must remove this socket's references to its context right now
534 // since this socket could get passed to any thread. If the context has
535 // had its locking disabled, just doing a set in attachSSLContext()
536 // would not be thread safe.
537 SSL_set_SSL_CTX(ssl_, dummyCtx->getSSLCtx());
541 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
542 void AsyncSSLSocket::switchServerSSLContext(
543 const std::shared_ptr<SSLContext>& handshakeCtx) {
545 if (sslState_ != STATE_ACCEPTING) {
546 // We log it here and allow the switch.
547 // It should not affect our re-negotiation support (which
548 // is not supported now).
549 VLOG(6) << "fd=" << getFd()
550 << " renegotation detected when switching SSL_CTX";
553 setup_SSL_CTX(handshakeCtx->getSSLCtx());
554 SSL_CTX_set_info_callback(handshakeCtx->getSSLCtx(),
555 AsyncSSLSocket::sslInfoCallback);
556 handshakeCtx_ = handshakeCtx;
557 SSL_set_SSL_CTX(ssl_, handshakeCtx->getSSLCtx());
560 bool AsyncSSLSocket::isServerNameMatch() const {
567 SSL_SESSION *ss = SSL_get_session(ssl_);
572 if(!ss->tlsext_hostname) {
575 return (tlsextHostname_.compare(ss->tlsext_hostname) ? false : true);
578 void AsyncSSLSocket::setServerName(std::string serverName) noexcept {
579 tlsextHostname_ = std::move(serverName);
584 void AsyncSSLSocket::timeoutExpired() noexcept {
585 if (state_ == StateEnum::ESTABLISHED &&
586 (sslState_ == STATE_CACHE_LOOKUP ||
587 sslState_ == STATE_ASYNC_PENDING)) {
588 sslState_ = STATE_ERROR;
589 // We are expecting a callback in restartSSLAccept. The cache lookup
590 // and rsa-call necessarily have pointers to this ssl socket, so delay
591 // the cleanup until he calls us back.
592 } else if (state_ == StateEnum::CONNECTING) {
593 assert(sslState_ == STATE_CONNECTING);
594 DestructorGuard dg(this);
595 AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
596 "Fallback connect timed out during TFO");
597 failHandshake(__func__, ex);
599 assert(state_ == StateEnum::ESTABLISHED &&
600 (sslState_ == STATE_CONNECTING || sslState_ == STATE_ACCEPTING));
601 DestructorGuard dg(this);
602 AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
603 (sslState_ == STATE_CONNECTING) ?
604 "SSL connect timed out" : "SSL accept timed out");
605 failHandshake(__func__, ex);
609 int AsyncSSLSocket::getSSLExDataIndex() {
610 static auto index = SSL_get_ex_new_index(
611 0, (void*)"AsyncSSLSocket data index", nullptr, nullptr, nullptr);
615 AsyncSSLSocket* AsyncSSLSocket::getFromSSL(const SSL *ssl) {
616 return static_cast<AsyncSSLSocket *>(SSL_get_ex_data(ssl,
617 getSSLExDataIndex()));
620 void AsyncSSLSocket::failHandshake(const char* /* fn */,
621 const AsyncSocketException& ex) {
623 if (handshakeTimeout_.isScheduled()) {
624 handshakeTimeout_.cancelTimeout();
626 invokeHandshakeErr(ex);
630 void AsyncSSLSocket::invokeHandshakeErr(const AsyncSocketException& ex) {
631 handshakeEndTime_ = std::chrono::steady_clock::now();
632 if (handshakeCallback_ != nullptr) {
633 HandshakeCB* callback = handshakeCallback_;
634 handshakeCallback_ = nullptr;
635 callback->handshakeErr(this, ex);
639 void AsyncSSLSocket::invokeHandshakeCB() {
640 handshakeEndTime_ = std::chrono::steady_clock::now();
641 if (handshakeTimeout_.isScheduled()) {
642 handshakeTimeout_.cancelTimeout();
644 if (handshakeCallback_) {
645 HandshakeCB* callback = handshakeCallback_;
646 handshakeCallback_ = nullptr;
647 callback->handshakeSuc(this);
651 void AsyncSSLSocket::cacheLocalPeerAddr() {
652 SocketAddress address;
654 getLocalAddress(&address);
655 getPeerAddress(&address);
656 } catch (const std::system_error& e) {
657 // The handle can be still valid while the connection is already closed.
658 if (e.code() != std::error_code(ENOTCONN, std::system_category())) {
664 void AsyncSSLSocket::connect(ConnectCallback* callback,
665 const folly::SocketAddress& address,
667 const OptionMap &options,
668 const folly::SocketAddress& bindAddr)
671 assert(state_ == StateEnum::UNINIT);
672 assert(sslState_ == STATE_UNINIT);
673 AsyncSSLSocketConnector *connector =
674 new AsyncSSLSocketConnector(this, callback, timeout);
675 AsyncSocket::connect(connector, address, timeout, options, bindAddr);
678 void AsyncSSLSocket::applyVerificationOptions(SSL * ssl) {
679 // apply the settings specified in verifyPeer_
680 if (verifyPeer_ == SSLContext::SSLVerifyPeerEnum::USE_CTX) {
681 if(ctx_->needsPeerVerification()) {
682 SSL_set_verify(ssl, ctx_->getVerificationMode(),
683 AsyncSSLSocket::sslVerifyCallback);
686 if (verifyPeer_ == SSLContext::SSLVerifyPeerEnum::VERIFY ||
687 verifyPeer_ == SSLContext::SSLVerifyPeerEnum::VERIFY_REQ_CLIENT_CERT) {
688 SSL_set_verify(ssl, SSLContext::getVerificationMode(verifyPeer_),
689 AsyncSSLSocket::sslVerifyCallback);
694 bool AsyncSSLSocket::setupSSLBio() {
695 auto wb = BIO_new(&sslWriteBioMethod);
701 OpenSSLUtils::setBioAppData(wb, this);
702 BIO_set_fd(wb, fd_, BIO_NOCLOSE);
703 SSL_set_bio(ssl_, wb, wb);
707 void AsyncSSLSocket::sslConn(HandshakeCB* callback, uint64_t timeout,
708 const SSLContext::SSLVerifyPeerEnum& verifyPeer) {
709 DestructorGuard dg(this);
710 assert(eventBase_->isInEventBaseThread());
712 // Cache local and remote socket addresses to keep them available
713 // after socket file descriptor is closed.
714 if (cacheAddrOnFailure_ && -1 != getFd()) {
715 cacheLocalPeerAddr();
718 verifyPeer_ = verifyPeer;
720 // Make sure we're in the uninitialized state
721 if (server_ || (sslState_ != STATE_UNINIT && sslState_ !=
722 STATE_UNENCRYPTED) ||
723 handshakeCallback_ != nullptr) {
724 return invalidState(callback);
727 sslState_ = STATE_CONNECTING;
728 handshakeCallback_ = callback;
731 ssl_ = ctx_->createSSL();
732 } catch (std::exception &e) {
733 sslState_ = STATE_ERROR;
734 AsyncSocketException ex(AsyncSocketException::INTERNAL_ERROR,
735 "error calling SSLContext::createSSL()");
736 LOG(ERROR) << "AsyncSSLSocket::sslConn(this=" << this << ", fd="
737 << fd_ << "): " << e.what();
738 return failHandshake(__func__, ex);
741 if (!setupSSLBio()) {
742 sslState_ = STATE_ERROR;
743 AsyncSocketException ex(
744 AsyncSocketException::INTERNAL_ERROR, "error creating SSL bio");
745 return failHandshake(__func__, ex);
748 applyVerificationOptions(ssl_);
750 if (sslSession_ != nullptr) {
751 SSL_set_session(ssl_, sslSession_);
752 SSL_SESSION_free(sslSession_);
753 sslSession_ = nullptr;
755 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
756 if (tlsextHostname_.size()) {
757 SSL_set_tlsext_host_name(ssl_, tlsextHostname_.c_str());
761 SSL_set_ex_data(ssl_, getSSLExDataIndex(), this);
763 handshakeConnectTimeout_ = timeout;
767 // This could be called multiple times, during normal ssl connections
768 // and after TFO fallback.
769 void AsyncSSLSocket::startSSLConnect() {
770 handshakeStartTime_ = std::chrono::steady_clock::now();
771 // Make end time at least >= start time.
772 handshakeEndTime_ = handshakeStartTime_;
773 if (handshakeConnectTimeout_ > 0) {
774 handshakeTimeout_.scheduleTimeout(handshakeConnectTimeout_);
779 SSL_SESSION *AsyncSSLSocket::getSSLSession() {
780 if (ssl_ != nullptr && sslState_ == STATE_ESTABLISHED) {
781 return SSL_get1_session(ssl_);
787 const SSL* AsyncSSLSocket::getSSL() const {
791 void AsyncSSLSocket::setSSLSession(SSL_SESSION *session, bool takeOwnership) {
792 sslSession_ = session;
793 if (!takeOwnership && session != nullptr) {
794 // Increment the reference count
795 CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
799 void AsyncSSLSocket::getSelectedNextProtocol(
800 const unsigned char** protoName,
802 SSLContext::NextProtocolType* protoType) const {
803 if (!getSelectedNextProtocolNoThrow(protoName, protoLen, protoType)) {
804 throw AsyncSocketException(AsyncSocketException::NOT_SUPPORTED,
805 "NPN not supported");
809 bool AsyncSSLSocket::getSelectedNextProtocolNoThrow(
810 const unsigned char** protoName,
812 SSLContext::NextProtocolType* protoType) const {
813 *protoName = nullptr;
815 #if OPENSSL_VERSION_NUMBER >= 0x1000200fL && !defined(OPENSSL_NO_TLSEXT)
816 SSL_get0_alpn_selected(ssl_, protoName, protoLen);
819 *protoType = SSLContext::NextProtocolType::ALPN;
824 #ifdef OPENSSL_NPN_NEGOTIATED
825 SSL_get0_next_proto_negotiated(ssl_, protoName, protoLen);
827 *protoType = SSLContext::NextProtocolType::NPN;
836 bool AsyncSSLSocket::getSSLSessionReused() const {
837 if (ssl_ != nullptr && sslState_ == STATE_ESTABLISHED) {
838 return SSL_session_reused(ssl_);
843 const char *AsyncSSLSocket::getNegotiatedCipherName() const {
844 return (ssl_ != nullptr) ? SSL_get_cipher_name(ssl_) : nullptr;
848 const char* AsyncSSLSocket::getSSLServerNameFromSSL(SSL* ssl) {
849 if (ssl == nullptr) {
852 #ifdef SSL_CTRL_SET_TLSEXT_SERVERNAME_CB
853 return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
859 const char *AsyncSSLSocket::getSSLServerName() const {
860 #ifdef SSL_CTRL_SET_TLSEXT_SERVERNAME_CB
861 return getSSLServerNameFromSSL(ssl_);
863 throw AsyncSocketException(AsyncSocketException::NOT_SUPPORTED,
864 "SNI not supported");
868 const char *AsyncSSLSocket::getSSLServerNameNoThrow() const {
869 return getSSLServerNameFromSSL(ssl_);
872 int AsyncSSLSocket::getSSLVersion() const {
873 return (ssl_ != nullptr) ? SSL_version(ssl_) : 0;
876 const char *AsyncSSLSocket::getSSLCertSigAlgName() const {
877 X509 *cert = (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
879 int nid = OBJ_obj2nid(cert->sig_alg->algorithm);
880 return OBJ_nid2ln(nid);
885 int AsyncSSLSocket::getSSLCertSize() const {
887 X509 *cert = (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
889 EVP_PKEY *key = X509_get_pubkey(cert);
890 certSize = EVP_PKEY_bits(key);
896 const X509* AsyncSSLSocket::getSelfCert() const {
897 return (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
900 bool AsyncSSLSocket::willBlock(int ret,
902 unsigned long* errErrorOut) noexcept {
904 int error = *sslErrorOut = SSL_get_error(ssl_, ret);
905 if (error == SSL_ERROR_WANT_READ) {
906 // Register for read event if not already.
907 updateEventRegistration(EventHandler::READ, EventHandler::WRITE);
909 } else if (error == SSL_ERROR_WANT_WRITE) {
910 VLOG(3) << "AsyncSSLSocket(fd=" << fd_
911 << ", state=" << int(state_) << ", sslState="
912 << sslState_ << ", events=" << eventFlags_ << "): "
913 << "SSL_ERROR_WANT_WRITE";
914 // Register for write event if not already.
915 updateEventRegistration(EventHandler::WRITE, EventHandler::READ);
917 #ifdef SSL_ERROR_WANT_SESS_CACHE_LOOKUP
918 } else if (error == SSL_ERROR_WANT_SESS_CACHE_LOOKUP) {
919 // We will block but we can't register our own socket. The callback that
920 // triggered this code will re-call handleAccept at the appropriate time.
922 // We can only get here if the linked libssl.so has support for this feature
923 // as well, otherwise SSL_get_error cannot return our error code.
924 sslState_ = STATE_CACHE_LOOKUP;
926 // Unregister for all events while blocked here
927 updateEventRegistration(EventHandler::NONE,
928 EventHandler::READ | EventHandler::WRITE);
930 // The timeout (if set) keeps running here
934 #ifdef SSL_ERROR_WANT_RSA_ASYNC_PENDING
935 || error == SSL_ERROR_WANT_RSA_ASYNC_PENDING
937 #ifdef SSL_ERROR_WANT_ECDSA_ASYNC_PENDING
938 || error == SSL_ERROR_WANT_ECDSA_ASYNC_PENDING
941 // Our custom openssl function has kicked off an async request to do
942 // rsa/ecdsa private key operation. When that call returns, a callback will
943 // be invoked that will re-call handleAccept.
944 sslState_ = STATE_ASYNC_PENDING;
946 // Unregister for all events while blocked here
947 updateEventRegistration(
949 EventHandler::READ | EventHandler::WRITE
952 // The timeout (if set) keeps running here
955 unsigned long lastError = *errErrorOut = ERR_get_error();
956 VLOG(6) << "AsyncSSLSocket(fd=" << fd_ << ", "
957 << "state=" << state_ << ", "
958 << "sslState=" << sslState_ << ", "
959 << "events=" << std::hex << eventFlags_ << "): "
960 << "SSL error: " << error << ", "
961 << "errno: " << errno << ", "
962 << "ret: " << ret << ", "
963 << "read: " << BIO_number_read(SSL_get_rbio(ssl_)) << ", "
964 << "written: " << BIO_number_written(SSL_get_wbio(ssl_)) << ", "
965 << "func: " << ERR_func_error_string(lastError) << ", "
966 << "reason: " << ERR_reason_error_string(lastError);
971 void AsyncSSLSocket::checkForImmediateRead() noexcept {
972 // openssl may have buffered data that it read from the socket already.
973 // In this case we have to process it immediately, rather than waiting for
974 // the socket to become readable again.
975 if (ssl_ != nullptr && SSL_pending(ssl_) > 0) {
976 AsyncSocket::handleRead();
981 AsyncSSLSocket::restartSSLAccept()
983 VLOG(3) << "AsyncSSLSocket::restartSSLAccept() this=" << this
984 << ", fd=" << fd_ << ", state=" << int(state_) << ", "
985 << "sslState=" << sslState_ << ", events=" << eventFlags_;
986 DestructorGuard dg(this);
988 sslState_ == STATE_CACHE_LOOKUP ||
989 sslState_ == STATE_ASYNC_PENDING ||
990 sslState_ == STATE_ERROR ||
991 sslState_ == STATE_CLOSED);
992 if (sslState_ == STATE_CLOSED) {
993 // I sure hope whoever closed this socket didn't delete it already,
994 // but this is not strictly speaking an error
997 if (sslState_ == STATE_ERROR) {
998 // go straight to fail if timeout expired during lookup
999 AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
1000 "SSL accept timed out");
1001 failHandshake(__func__, ex);
1004 sslState_ = STATE_ACCEPTING;
1005 this->handleAccept();
1009 AsyncSSLSocket::handleAccept() noexcept {
1010 VLOG(3) << "AsyncSSLSocket::handleAccept() this=" << this
1011 << ", fd=" << fd_ << ", state=" << int(state_) << ", "
1012 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1014 assert(state_ == StateEnum::ESTABLISHED &&
1015 sslState_ == STATE_ACCEPTING);
1017 /* lazily create the SSL structure */
1019 ssl_ = ctx_->createSSL();
1020 } catch (std::exception &e) {
1021 sslState_ = STATE_ERROR;
1022 AsyncSocketException ex(AsyncSocketException::INTERNAL_ERROR,
1023 "error calling SSLContext::createSSL()");
1024 LOG(ERROR) << "AsyncSSLSocket::handleAccept(this=" << this
1025 << ", fd=" << fd_ << "): " << e.what();
1026 return failHandshake(__func__, ex);
1029 if (!setupSSLBio()) {
1030 sslState_ = STATE_ERROR;
1031 AsyncSocketException ex(
1032 AsyncSocketException::INTERNAL_ERROR, "error creating write bio");
1033 return failHandshake(__func__, ex);
1036 SSL_set_ex_data(ssl_, getSSLExDataIndex(), this);
1038 applyVerificationOptions(ssl_);
1041 if (server_ && parseClientHello_) {
1042 SSL_set_msg_callback(ssl_, &AsyncSSLSocket::clientHelloParsingCallback);
1043 SSL_set_msg_callback_arg(ssl_, this);
1046 int ret = SSL_accept(ssl_);
1049 unsigned long errError;
1050 int errnoCopy = errno;
1051 if (willBlock(ret, &sslError, &errError)) {
1054 sslState_ = STATE_ERROR;
1055 SSLException ex(sslError, errError, ret, errnoCopy);
1056 return failHandshake(__func__, ex);
1060 handshakeComplete_ = true;
1061 updateEventRegistration(0, EventHandler::READ | EventHandler::WRITE);
1063 // Move into STATE_ESTABLISHED in the normal case that we are in
1065 sslState_ = STATE_ESTABLISHED;
1067 VLOG(3) << "AsyncSSLSocket " << this << ": fd " << fd_
1068 << " successfully accepted; state=" << int(state_)
1069 << ", sslState=" << sslState_ << ", events=" << eventFlags_;
1071 // Remember the EventBase we are attached to, before we start invoking any
1072 // callbacks (since the callbacks may call detachEventBase()).
1073 EventBase* originalEventBase = eventBase_;
1075 // Call the accept callback.
1076 invokeHandshakeCB();
1078 // Note that the accept callback may have changed our state.
1079 // (set or unset the read callback, called write(), closed the socket, etc.)
1080 // The following code needs to handle these situations correctly.
1082 // If the socket has been closed, readCallback_ and writeReqHead_ will
1083 // always be nullptr, so that will prevent us from trying to read or write.
1085 // The main thing to check for is if eventBase_ is still originalEventBase.
1086 // If not, we have been detached from this event base, so we shouldn't
1087 // perform any more operations.
1088 if (eventBase_ != originalEventBase) {
1092 AsyncSocket::handleInitialReadWrite();
1096 AsyncSSLSocket::handleConnect() noexcept {
1097 VLOG(3) << "AsyncSSLSocket::handleConnect() this=" << this
1098 << ", fd=" << fd_ << ", state=" << int(state_) << ", "
1099 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1101 if (state_ < StateEnum::ESTABLISHED) {
1102 return AsyncSocket::handleConnect();
1106 (state_ == StateEnum::FAST_OPEN || state_ == StateEnum::ESTABLISHED) &&
1107 sslState_ == STATE_CONNECTING);
1110 auto originalState = state_;
1111 int ret = SSL_connect(ssl_);
1114 unsigned long errError;
1115 int errnoCopy = errno;
1116 if (willBlock(ret, &sslError, &errError)) {
1117 // We fell back to connecting state due to TFO
1118 if (state_ == StateEnum::CONNECTING) {
1119 DCHECK_EQ(StateEnum::FAST_OPEN, originalState);
1120 if (handshakeTimeout_.isScheduled()) {
1121 handshakeTimeout_.cancelTimeout();
1126 sslState_ = STATE_ERROR;
1127 SSLException ex(sslError, errError, ret, errnoCopy);
1128 return failHandshake(__func__, ex);
1132 handshakeComplete_ = true;
1133 updateEventRegistration(0, EventHandler::READ | EventHandler::WRITE);
1135 // Move into STATE_ESTABLISHED in the normal case that we are in
1136 // STATE_CONNECTING.
1137 sslState_ = STATE_ESTABLISHED;
1139 VLOG(3) << "AsyncSSLSocket " << this << ": "
1140 << "fd " << fd_ << " successfully connected; "
1141 << "state=" << int(state_) << ", sslState=" << sslState_
1142 << ", events=" << eventFlags_;
1144 // Remember the EventBase we are attached to, before we start invoking any
1145 // callbacks (since the callbacks may call detachEventBase()).
1146 EventBase* originalEventBase = eventBase_;
1148 // Call the handshake callback.
1149 invokeHandshakeCB();
1151 // Note that the connect callback may have changed our state.
1152 // (set or unset the read callback, called write(), closed the socket, etc.)
1153 // The following code needs to handle these situations correctly.
1155 // If the socket has been closed, readCallback_ and writeReqHead_ will
1156 // always be nullptr, so that will prevent us from trying to read or write.
1158 // The main thing to check for is if eventBase_ is still originalEventBase.
1159 // If not, we have been detached from this event base, so we shouldn't
1160 // perform any more operations.
1161 if (eventBase_ != originalEventBase) {
1165 AsyncSocket::handleInitialReadWrite();
1168 void AsyncSSLSocket::invokeConnectErr(const AsyncSocketException& ex) {
1169 connectionTimeout_.cancelTimeout();
1170 AsyncSocket::invokeConnectErr(ex);
1173 void AsyncSSLSocket::invokeConnectSuccess() {
1174 connectionTimeout_.cancelTimeout();
1175 if (sslState_ == SSLStateEnum::STATE_CONNECTING) {
1176 // If we failed TFO, we'd fall back to trying to connect the socket,
1177 // to setup things like timeouts.
1180 // still invoke the base class since it re-sets the connect time.
1181 AsyncSocket::invokeConnectSuccess();
1184 void AsyncSSLSocket::scheduleConnectTimeout() {
1185 if (sslState_ == SSLStateEnum::STATE_CONNECTING) {
1186 // We fell back from TFO, and need to set the timeouts.
1187 // We will not have a connect callback in this case, thus if the timer
1188 // expires we would have no-one to notify.
1189 // Thus we should reset even the connect timers to point to the handshake
1191 assert(connectCallback_ == nullptr);
1192 // We use a different connect timeout here than the handshake timeout, so
1193 // that we can disambiguate the 2 timers.
1194 int timeout = connectTimeout_.count();
1196 if (!connectionTimeout_.scheduleTimeout(timeout)) {
1197 throw AsyncSocketException(
1198 AsyncSocketException::INTERNAL_ERROR,
1199 withAddr("failed to schedule AsyncSSLSocket connect timeout"));
1204 AsyncSocket::scheduleConnectTimeout();
1207 void AsyncSSLSocket::setReadCB(ReadCallback *callback) {
1208 #ifdef SSL_MODE_MOVE_BUFFER_OWNERSHIP
1209 // turn on the buffer movable in openssl
1210 if (bufferMovableEnabled_ && ssl_ != nullptr && !isBufferMovable_ &&
1211 callback != nullptr && callback->isBufferMovable()) {
1212 SSL_set_mode(ssl_, SSL_get_mode(ssl_) | SSL_MODE_MOVE_BUFFER_OWNERSHIP);
1213 isBufferMovable_ = true;
1217 AsyncSocket::setReadCB(callback);
1220 void AsyncSSLSocket::setBufferMovableEnabled(bool enabled) {
1221 bufferMovableEnabled_ = enabled;
1224 void AsyncSSLSocket::prepareReadBuffer(void** buf, size_t* buflen) noexcept {
1225 CHECK(readCallback_);
1226 if (isBufferMovable_) {
1230 // buf is necessary for SSLSocket without SSL_MODE_MOVE_BUFFER_OWNERSHIP
1231 readCallback_->getReadBuffer(buf, buflen);
1236 AsyncSSLSocket::handleRead() noexcept {
1237 VLOG(5) << "AsyncSSLSocket::handleRead() this=" << this << ", fd=" << fd_
1238 << ", state=" << int(state_) << ", "
1239 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1240 if (state_ < StateEnum::ESTABLISHED) {
1241 return AsyncSocket::handleRead();
1245 if (sslState_ == STATE_ACCEPTING) {
1250 else if (sslState_ == STATE_CONNECTING) {
1257 AsyncSocket::handleRead();
1260 AsyncSocket::ReadResult
1261 AsyncSSLSocket::performRead(void** buf, size_t* buflen, size_t* offset) {
1262 VLOG(4) << "AsyncSSLSocket::performRead() this=" << this << ", buf=" << *buf
1263 << ", buflen=" << *buflen;
1265 if (sslState_ == STATE_UNENCRYPTED) {
1266 return AsyncSocket::performRead(buf, buflen, offset);
1270 if (!isBufferMovable_) {
1271 bytes = SSL_read(ssl_, *buf, *buflen);
1273 #ifdef SSL_MODE_MOVE_BUFFER_OWNERSHIP
1275 bytes = SSL_read_buf(ssl_, buf, (int *) offset, (int *) buflen);
1279 if (server_ && renegotiateAttempted_) {
1280 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1281 << ", sslstate=" << sslState_ << ", events=" << eventFlags_
1282 << "): client intitiated SSL renegotiation not permitted";
1285 folly::make_unique<SSLException>(SSLError::CLIENT_RENEGOTIATION));
1288 int error = SSL_get_error(ssl_, bytes);
1289 if (error == SSL_ERROR_WANT_READ) {
1290 // The caller will register for read event if not already.
1291 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1292 return ReadResult(READ_BLOCKING);
1294 return ReadResult(READ_ERROR);
1296 } else if (error == SSL_ERROR_WANT_WRITE) {
1297 // TODO: Even though we are attempting to read data, SSL_read() may
1298 // need to write data if renegotiation is being performed. We currently
1299 // don't support this and just fail the read.
1300 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1301 << ", sslState=" << sslState_ << ", events=" << eventFlags_
1302 << "): unsupported SSL renegotiation during read";
1305 folly::make_unique<SSLException>(SSLError::INVALID_RENEGOTIATION));
1307 if (zero_return(error, bytes)) {
1308 return ReadResult(bytes);
1310 long errError = ERR_get_error();
1311 VLOG(6) << "AsyncSSLSocket(fd=" << fd_ << ", "
1312 << "state=" << state_ << ", "
1313 << "sslState=" << sslState_ << ", "
1314 << "events=" << std::hex << eventFlags_ << "): "
1315 << "bytes: " << bytes << ", "
1316 << "error: " << error << ", "
1317 << "errno: " << errno << ", "
1318 << "func: " << ERR_func_error_string(errError) << ", "
1319 << "reason: " << ERR_reason_error_string(errError);
1322 folly::make_unique<SSLException>(error, errError, bytes, errno));
1325 appBytesReceived_ += bytes;
1326 return ReadResult(bytes);
1330 void AsyncSSLSocket::handleWrite() noexcept {
1331 VLOG(5) << "AsyncSSLSocket::handleWrite() this=" << this << ", fd=" << fd_
1332 << ", state=" << int(state_) << ", "
1333 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1334 if (state_ < StateEnum::ESTABLISHED) {
1335 return AsyncSocket::handleWrite();
1338 if (sslState_ == STATE_ACCEPTING) {
1344 if (sslState_ == STATE_CONNECTING) {
1351 AsyncSocket::handleWrite();
1354 AsyncSocket::WriteResult AsyncSSLSocket::interpretSSLError(int rc, int error) {
1355 if (error == SSL_ERROR_WANT_READ) {
1356 // Even though we are attempting to write data, SSL_write() may
1357 // need to read data if renegotiation is being performed. We currently
1358 // don't support this and just fail the write.
1359 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1360 << ", sslState=" << sslState_ << ", events=" << eventFlags_
1362 << "unsupported SSL renegotiation during write";
1365 folly::make_unique<SSLException>(SSLError::INVALID_RENEGOTIATION));
1367 if (zero_return(error, rc)) {
1368 return WriteResult(0);
1370 auto errError = ERR_get_error();
1371 VLOG(3) << "ERROR: AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1372 << ", sslState=" << sslState_ << ", events=" << eventFlags_ << "): "
1373 << "SSL error: " << error << ", errno: " << errno
1374 << ", func: " << ERR_func_error_string(errError)
1375 << ", reason: " << ERR_reason_error_string(errError);
1378 folly::make_unique<SSLException>(error, errError, rc, errno));
1382 AsyncSocket::WriteResult AsyncSSLSocket::performWrite(
1386 uint32_t* countWritten,
1387 uint32_t* partialWritten) {
1388 if (sslState_ == STATE_UNENCRYPTED) {
1389 return AsyncSocket::performWrite(
1390 vec, count, flags, countWritten, partialWritten);
1392 if (sslState_ != STATE_ESTABLISHED) {
1393 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1394 << ", sslState=" << sslState_
1395 << ", events=" << eventFlags_ << "): "
1396 << "TODO: AsyncSSLSocket currently does not support calling "
1397 << "write() before the handshake has fully completed";
1399 WRITE_ERROR, folly::make_unique<SSLException>(SSLError::EARLY_WRITE));
1402 bool cork = isSet(flags, WriteFlags::CORK);
1403 CorkGuard guard(fd_, count > 1, cork, &corked_);
1405 // Declare a buffer used to hold small write requests. It could point to a
1406 // memory block either on stack or on heap. If it is on heap, we release it
1407 // manually when scope exits
1408 char* combinedBuf{nullptr};
1410 // Note, always keep this check consistent with what we do below
1411 if (combinedBuf != nullptr && minWriteSize_ > MAX_STACK_BUF_SIZE) {
1412 delete[] combinedBuf;
1417 *partialWritten = 0;
1418 ssize_t totalWritten = 0;
1419 size_t bytesStolenFromNextBuffer = 0;
1420 for (uint32_t i = 0; i < count; i++) {
1421 const iovec* v = vec + i;
1422 size_t offset = bytesStolenFromNextBuffer;
1423 bytesStolenFromNextBuffer = 0;
1424 size_t len = v->iov_len - offset;
1430 buf = ((const char*)v->iov_base) + offset;
1433 uint32_t buffersStolen = 0;
1434 if ((len < minWriteSize_) && ((i + 1) < count)) {
1435 // Combine this buffer with part or all of the next buffers in
1436 // order to avoid really small-grained calls to SSL_write().
1437 // Each call to SSL_write() produces a separate record in
1438 // the egress SSL stream, and we've found that some low-end
1439 // mobile clients can't handle receiving an HTTP response
1440 // header and the first part of the response body in two
1441 // separate SSL records (even if those two records are in
1442 // the same TCP packet).
1444 if (combinedBuf == nullptr) {
1445 if (minWriteSize_ > MAX_STACK_BUF_SIZE) {
1446 // Allocate the buffer on heap
1447 combinedBuf = new char[minWriteSize_];
1449 // Allocate the buffer on stack
1450 combinedBuf = (char*)alloca(minWriteSize_);
1453 assert(combinedBuf != nullptr);
1455 memcpy(combinedBuf, buf, len);
1457 // INVARIANT: i + buffersStolen == complete chunks serialized
1458 uint32_t nextIndex = i + buffersStolen + 1;
1459 bytesStolenFromNextBuffer = std::min(vec[nextIndex].iov_len,
1460 minWriteSize_ - len);
1461 memcpy(combinedBuf + len, vec[nextIndex].iov_base,
1462 bytesStolenFromNextBuffer);
1463 len += bytesStolenFromNextBuffer;
1464 if (bytesStolenFromNextBuffer < vec[nextIndex].iov_len) {
1465 // couldn't steal the whole buffer
1468 bytesStolenFromNextBuffer = 0;
1471 } while ((i + buffersStolen + 1) < count && (len < minWriteSize_));
1472 bytes = eorAwareSSLWrite(
1473 ssl_, combinedBuf, len,
1474 (isSet(flags, WriteFlags::EOR) && i + buffersStolen + 1 == count));
1477 bytes = eorAwareSSLWrite(ssl_, buf, len,
1478 (isSet(flags, WriteFlags::EOR) && i + 1 == count));
1482 int error = SSL_get_error(ssl_, bytes);
1483 if (error == SSL_ERROR_WANT_WRITE) {
1484 // The caller will register for write event if not already.
1485 *partialWritten = offset;
1486 return WriteResult(totalWritten);
1488 auto writeResult = interpretSSLError(bytes, error);
1489 if (writeResult.writeReturn < 0) {
1491 } // else fall through to below to correctly record totalWritten
1494 totalWritten += bytes;
1496 if (bytes == (ssize_t)len) {
1497 // The full iovec is written.
1498 (*countWritten) += 1 + buffersStolen;
1502 bytes += offset; // adjust bytes to account for all of v
1503 while (bytes >= (ssize_t)v->iov_len) {
1504 // We combined this buf with part or all of the next one, and
1505 // we managed to write all of this buf but not all of the bytes
1506 // from the next one that we'd hoped to write.
1507 bytes -= v->iov_len;
1511 *partialWritten = bytes;
1512 return WriteResult(totalWritten);
1516 return WriteResult(totalWritten);
1519 int AsyncSSLSocket::eorAwareSSLWrite(SSL *ssl, const void *buf, int n,
1521 if (eor && trackEor_) {
1522 if (appEorByteNo_) {
1523 // cannot track for more than one app byte EOR
1524 CHECK(appEorByteNo_ == appBytesWritten_ + n);
1526 appEorByteNo_ = appBytesWritten_ + n;
1529 // 1. It is fine to keep updating minEorRawByteNo_.
1530 // 2. It is _min_ in the sense that SSL record will add some overhead.
1531 minEorRawByteNo_ = getRawBytesWritten() + n;
1534 n = sslWriteImpl(ssl, buf, n);
1536 appBytesWritten_ += n;
1537 if (appEorByteNo_) {
1538 if (getRawBytesWritten() >= minEorRawByteNo_) {
1539 minEorRawByteNo_ = 0;
1541 if(appBytesWritten_ == appEorByteNo_) {
1544 CHECK(appBytesWritten_ < appEorByteNo_);
1551 void AsyncSSLSocket::sslInfoCallback(const SSL* ssl, int where, int ret) {
1552 AsyncSSLSocket *sslSocket = AsyncSSLSocket::getFromSSL(ssl);
1553 if (sslSocket->handshakeComplete_ && (where & SSL_CB_HANDSHAKE_START)) {
1554 sslSocket->renegotiateAttempted_ = true;
1556 if (where & SSL_CB_READ_ALERT) {
1557 const char* type = SSL_alert_type_string(ret);
1559 const char* desc = SSL_alert_desc_string(ret);
1560 sslSocket->alertsReceived_.emplace_back(
1561 *type, StringPiece(desc, std::strlen(desc)));
1566 int AsyncSSLSocket::bioWrite(BIO* b, const char* in, int inl) {
1570 AsyncSSLSocket* tsslSock;
1572 iov.iov_base = const_cast<char*>(in);
1574 memset(&msg, 0, sizeof(msg));
1578 auto appData = OpenSSLUtils::getBioAppData(b);
1581 tsslSock = reinterpret_cast<AsyncSSLSocket*>(appData);
1584 if (tsslSock->trackEor_ && tsslSock->minEorRawByteNo_ &&
1585 tsslSock->minEorRawByteNo_ <= BIO_number_written(b) + inl) {
1590 flags |= MSG_NOSIGNAL;
1594 tsslSock->sendSocketMessage(BIO_get_fd(b, nullptr), &msg, flags);
1595 BIO_clear_retry_flags(b);
1596 if (!result.exception && result.writeReturn <= 0) {
1597 if (OpenSSLUtils::getBioShouldRetryWrite(result.writeReturn)) {
1598 BIO_set_retry_write(b);
1601 return 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);
1719 cursor.skip(extensionDataLength);
1723 } catch (std::out_of_range& e) {
1724 // we'll use what we found and cleanup below.
1725 VLOG(4) << "AsyncSSLSocket::clientHelloParsingCallback(): "
1726 << "buffer finished unexpectedly." << " AsyncSSLSocket socket=" << sock;
1729 sock->resetClientHelloParsing(ssl);