2 * Copyright 2015 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <folly/io/async/AsyncSSLSocket.h>
19 #include <folly/io/async/EventBase.h>
21 #include <boost/noncopyable.hpp>
24 #include <netinet/in.h>
25 #include <netinet/tcp.h>
26 #include <openssl/err.h>
27 #include <openssl/asn1.h>
28 #include <openssl/ssl.h>
29 #include <sys/types.h>
30 #include <sys/socket.h>
34 #include <folly/Bits.h>
35 #include <folly/SocketAddress.h>
36 #include <folly/SpinLock.h>
37 #include <folly/io/IOBuf.h>
38 #include <folly/io/Cursor.h>
40 using folly::SocketAddress;
41 using folly::SSLContext;
43 using std::shared_ptr;
47 using folly::SpinLock;
48 using folly::SpinLockGuard;
49 using folly::io::Cursor;
50 using std::unique_ptr;
54 using folly::AsyncSocket;
55 using folly::AsyncSocketException;
56 using folly::AsyncSSLSocket;
57 using folly::Optional;
58 using folly::SSLContext;
60 // We have one single dummy SSL context so that we can implement attach
61 // and detach methods in a thread safe fashion without modifying opnessl.
62 static SSLContext *dummyCtx = nullptr;
63 static SpinLock dummyCtxLock;
65 // Numbers chosen as to not collide with functions in ssl.h
66 const uint8_t TASYNCSSLSOCKET_F_PERFORM_READ = 90;
67 const uint8_t TASYNCSSLSOCKET_F_PERFORM_WRITE = 91;
69 // If given min write size is less than this, buffer will be allocated on
70 // stack, otherwise it is allocated on heap
71 const size_t MAX_STACK_BUF_SIZE = 2048;
73 // This converts "illegal" shutdowns into ZERO_RETURN
74 inline bool zero_return(int error, int rc) {
75 return (error == SSL_ERROR_ZERO_RETURN || (rc == 0 && errno == 0));
78 class AsyncSSLSocketConnector: public AsyncSocket::ConnectCallback,
79 public AsyncSSLSocket::HandshakeCB {
82 AsyncSSLSocket *sslSocket_;
83 AsyncSSLSocket::ConnectCallback *callback_;
88 ~AsyncSSLSocketConnector() override {}
91 AsyncSSLSocketConnector(AsyncSSLSocket *sslSocket,
92 AsyncSocket::ConnectCallback *callback,
94 sslSocket_(sslSocket),
97 startTime_(std::chrono::duration_cast<std::chrono::milliseconds>(
98 std::chrono::steady_clock::now().time_since_epoch()).count()) {
101 void connectSuccess() noexcept override {
102 VLOG(7) << "client socket connected";
104 int64_t timeoutLeft = 0;
106 auto curTime = std::chrono::duration_cast<std::chrono::milliseconds>(
107 std::chrono::steady_clock::now().time_since_epoch()).count();
109 timeoutLeft = timeout_ - (curTime - startTime_);
110 if (timeoutLeft <= 0) {
111 AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
112 "SSL connect timed out");
118 sslSocket_->sslConn(this, timeoutLeft);
121 void connectErr(const AsyncSocketException& ex) noexcept override {
122 LOG(ERROR) << "TCP connect failed: " << ex.what();
127 void handshakeSuc(AsyncSSLSocket* /* sock */) noexcept override {
128 VLOG(7) << "client handshake success";
130 callback_->connectSuccess();
135 void handshakeErr(AsyncSSLSocket* /* socket */,
136 const AsyncSocketException& ex) noexcept override {
137 LOG(ERROR) << "client handshakeErr: " << ex.what();
142 void fail(const AsyncSocketException &ex) {
143 // fail is a noop if called twice
145 AsyncSSLSocket::ConnectCallback *cb = callback_;
149 sslSocket_->closeNow();
150 // closeNow can call handshakeErr if it hasn't been called already.
151 // So this may have been deleted, no member variable access beyond this
153 // Note that closeNow may invoke writeError callbacks if the socket had
154 // write data pending connection completion.
159 // XXX: implement an equivalent to corking for platforms with TCP_NOPUSH?
160 #ifdef TCP_CORK // Linux-only
162 * Utility class that corks a TCP socket upon construction or uncorks
163 * the socket upon destruction
165 class CorkGuard : private boost::noncopyable {
167 CorkGuard(int fd, bool multipleWrites, bool haveMore, bool* corked):
168 fd_(fd), haveMore_(haveMore), corked_(corked) {
170 // socket is already corked; nothing to do
173 if (multipleWrites || haveMore) {
174 // We are performing multiple writes in this performWrite() call,
175 // and/or there are more calls to performWrite() that will be invoked
176 // later, so enable corking
178 setsockopt(fd_, IPPROTO_TCP, TCP_CORK, &flag, sizeof(flag));
185 // more data to come; don't uncork yet
189 // socket isn't corked; nothing to do
194 setsockopt(fd_, IPPROTO_TCP, TCP_CORK, &flag, sizeof(flag));
204 class CorkGuard : private boost::noncopyable {
206 CorkGuard(int, bool, bool, bool*) {}
210 void setup_SSL_CTX(SSL_CTX *ctx) {
211 #ifdef SSL_MODE_RELEASE_BUFFERS
212 SSL_CTX_set_mode(ctx,
213 SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER |
214 SSL_MODE_ENABLE_PARTIAL_WRITE
215 | SSL_MODE_RELEASE_BUFFERS
218 SSL_CTX_set_mode(ctx,
219 SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER |
220 SSL_MODE_ENABLE_PARTIAL_WRITE
223 // SSL_CTX_set_mode is a Macro
224 #ifdef SSL_MODE_WRITE_IOVEC
225 SSL_CTX_set_mode(ctx,
226 SSL_CTX_get_mode(ctx)
227 | SSL_MODE_WRITE_IOVEC);
232 BIO_METHOD eorAwareBioMethod;
234 void* initEorBioMethod(void) {
235 memcpy(&eorAwareBioMethod, BIO_s_socket(), sizeof(eorAwareBioMethod));
236 // override the bwrite method for MSG_EOR support
237 eorAwareBioMethod.bwrite = AsyncSSLSocket::eorAwareBioWrite;
239 // Note that the eorAwareBioMethod.type and eorAwareBioMethod.name are not
240 // set here. openssl code seems to be checking ".type == BIO_TYPE_SOCKET" and
241 // then have specific handlings. The eorAwareBioWrite should be compatible
242 // with the one in openssl.
244 // Return something here to enable AsyncSSLSocket to call this method using
245 // a function-scoped static.
249 } // anonymous namespace
253 SSLException::SSLException(int sslError, int errno_copy):
254 AsyncSocketException(
255 AsyncSocketException::SSL_ERROR,
256 ERR_error_string(sslError, msg_),
257 sslError == SSL_ERROR_SYSCALL ? errno_copy : 0), error_(sslError) {}
260 * Create a client AsyncSSLSocket
262 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext> &ctx,
263 EventBase* evb, bool deferSecurityNegotiation) :
266 handshakeTimeout_(this, evb) {
268 if (deferSecurityNegotiation) {
269 sslState_ = STATE_UNENCRYPTED;
274 * Create a server/client AsyncSSLSocket
276 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext>& ctx,
277 EventBase* evb, int fd, bool server,
278 bool deferSecurityNegotiation) :
279 AsyncSocket(evb, fd),
282 handshakeTimeout_(this, evb) {
285 SSL_CTX_set_info_callback(ctx_->getSSLCtx(),
286 AsyncSSLSocket::sslInfoCallback);
288 if (deferSecurityNegotiation) {
289 sslState_ = STATE_UNENCRYPTED;
293 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
295 * Create a client AsyncSSLSocket and allow tlsext_hostname
296 * to be sent in Client Hello.
298 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext> &ctx,
300 const std::string& serverName,
301 bool deferSecurityNegotiation) :
302 AsyncSSLSocket(ctx, evb, deferSecurityNegotiation) {
303 tlsextHostname_ = serverName;
307 * Create a client AsyncSSLSocket from an already connected fd
308 * and allow tlsext_hostname to be sent in Client Hello.
310 AsyncSSLSocket::AsyncSSLSocket(const shared_ptr<SSLContext>& ctx,
311 EventBase* evb, int fd,
312 const std::string& serverName,
313 bool deferSecurityNegotiation) :
314 AsyncSSLSocket(ctx, evb, fd, false, deferSecurityNegotiation) {
315 tlsextHostname_ = serverName;
319 AsyncSSLSocket::~AsyncSSLSocket() {
320 VLOG(3) << "actual destruction of AsyncSSLSocket(this=" << this
321 << ", evb=" << eventBase_ << ", fd=" << fd_
322 << ", state=" << int(state_) << ", sslState="
323 << sslState_ << ", events=" << eventFlags_ << ")";
326 void AsyncSSLSocket::init() {
327 // Do this here to ensure we initialize this once before any use of
328 // AsyncSSLSocket instances and not as part of library load.
329 static const auto eorAwareBioMethodInitializer = initEorBioMethod();
330 (void)eorAwareBioMethodInitializer;
332 setup_SSL_CTX(ctx_->getSSLCtx());
335 void AsyncSSLSocket::closeNow() {
336 // Close the SSL connection.
337 if (ssl_ != nullptr && fd_ != -1) {
338 int rc = SSL_shutdown(ssl_);
340 rc = SSL_shutdown(ssl_);
347 if (sslSession_ != nullptr) {
348 SSL_SESSION_free(sslSession_);
349 sslSession_ = nullptr;
352 sslState_ = STATE_CLOSED;
354 if (handshakeTimeout_.isScheduled()) {
355 handshakeTimeout_.cancelTimeout();
358 DestructorGuard dg(this);
361 AsyncSocketException(
362 AsyncSocketException::END_OF_FILE,
363 "SSL connection closed locally"));
365 if (ssl_ != nullptr) {
371 AsyncSocket::closeNow();
374 void AsyncSSLSocket::shutdownWrite() {
375 // SSL sockets do not support half-shutdown, so just perform a full shutdown.
377 // (Performing a full shutdown here is more desirable than doing nothing at
378 // all. The purpose of shutdownWrite() is normally to notify the other end
379 // of the connection that no more data will be sent. If we do nothing, the
380 // other end will never know that no more data is coming, and this may result
381 // in protocol deadlock.)
385 void AsyncSSLSocket::shutdownWriteNow() {
389 bool AsyncSSLSocket::good() const {
390 return (AsyncSocket::good() &&
391 (sslState_ == STATE_ACCEPTING || sslState_ == STATE_CONNECTING ||
392 sslState_ == STATE_ESTABLISHED || sslState_ == STATE_UNENCRYPTED));
395 // The TAsyncTransport definition of 'good' states that the transport is
396 // ready to perform reads and writes, so sslState_ == UNINIT must report !good.
397 // connecting can be true when the sslState_ == UNINIT because the AsyncSocket
398 // is connected but we haven't initiated the call to SSL_connect.
399 bool AsyncSSLSocket::connecting() const {
401 (AsyncSocket::connecting() ||
402 (AsyncSocket::good() && (sslState_ == STATE_UNINIT ||
403 sslState_ == STATE_CONNECTING))));
406 std::string AsyncSSLSocket::getApplicationProtocol() noexcept {
407 const unsigned char* protoName = nullptr;
408 unsigned protoLength;
409 if (getSelectedNextProtocolNoThrow(&protoName, &protoLength)) {
410 return std::string(reinterpret_cast<const char*>(protoName), protoLength);
415 bool AsyncSSLSocket::isEorTrackingEnabled() const {
416 if (ssl_ == nullptr) {
419 const BIO *wb = SSL_get_wbio(ssl_);
420 return wb && wb->method == &eorAwareBioMethod;
423 void AsyncSSLSocket::setEorTracking(bool track) {
424 BIO *wb = SSL_get_wbio(ssl_);
426 throw AsyncSocketException(AsyncSocketException::INVALID_STATE,
427 "setting EOR tracking without an initialized "
432 if (wb->method != &eorAwareBioMethod) {
433 // only do this if we didn't
434 wb->method = &eorAwareBioMethod;
435 BIO_set_app_data(wb, this);
437 minEorRawByteNo_ = 0;
439 } else if (wb->method == &eorAwareBioMethod) {
440 wb->method = BIO_s_socket();
441 BIO_set_app_data(wb, nullptr);
443 minEorRawByteNo_ = 0;
445 CHECK(wb->method == BIO_s_socket());
449 size_t AsyncSSLSocket::getRawBytesWritten() const {
451 if (!ssl_ || !(b = SSL_get_wbio(ssl_))) {
455 return BIO_number_written(b);
458 size_t AsyncSSLSocket::getRawBytesReceived() const {
460 if (!ssl_ || !(b = SSL_get_rbio(ssl_))) {
464 return BIO_number_read(b);
468 void AsyncSSLSocket::invalidState(HandshakeCB* callback) {
469 LOG(ERROR) << "AsyncSSLSocket(this=" << this << ", fd=" << fd_
470 << ", state=" << int(state_) << ", sslState=" << sslState_ << ", "
471 << "events=" << eventFlags_ << ", server=" << short(server_) << "): "
472 << "sslAccept/Connect() called in invalid "
473 << "state, handshake callback " << handshakeCallback_ << ", new callback "
475 assert(!handshakeTimeout_.isScheduled());
476 sslState_ = STATE_ERROR;
478 AsyncSocketException ex(AsyncSocketException::INVALID_STATE,
479 "sslAccept() called with socket in invalid state");
481 handshakeEndTime_ = std::chrono::steady_clock::now();
483 callback->handshakeErr(this, ex);
486 // Check the socket state not the ssl state here.
487 if (state_ != StateEnum::CLOSED || state_ != StateEnum::ERROR) {
488 failHandshake(__func__, ex);
492 void AsyncSSLSocket::sslAccept(HandshakeCB* callback, uint32_t timeout,
493 const SSLContext::SSLVerifyPeerEnum& verifyPeer) {
494 DestructorGuard dg(this);
495 assert(eventBase_->isInEventBaseThread());
496 verifyPeer_ = verifyPeer;
498 // Make sure we're in the uninitialized state
499 if (!server_ || (sslState_ != STATE_UNINIT &&
500 sslState_ != STATE_UNENCRYPTED) ||
501 handshakeCallback_ != nullptr) {
502 return invalidState(callback);
505 // Cache local and remote socket addresses to keep them available
506 // after socket file descriptor is closed.
507 if (cacheAddrOnFailure_ && -1 != getFd()) {
508 cacheLocalPeerAddr();
511 handshakeStartTime_ = std::chrono::steady_clock::now();
512 // Make end time at least >= start time.
513 handshakeEndTime_ = handshakeStartTime_;
515 sslState_ = STATE_ACCEPTING;
516 handshakeCallback_ = callback;
519 handshakeTimeout_.scheduleTimeout(timeout);
522 /* register for a read operation (waiting for CLIENT HELLO) */
523 updateEventRegistration(EventHandler::READ, EventHandler::WRITE);
526 #if OPENSSL_VERSION_NUMBER >= 0x009080bfL
527 void AsyncSSLSocket::attachSSLContext(
528 const std::shared_ptr<SSLContext>& ctx) {
530 // Check to ensure we are in client mode. Changing a server's ssl
531 // context doesn't make sense since clients of that server would likely
532 // become confused when the server's context changes.
536 DCHECK(ctx->getSSLCtx());
539 // In order to call attachSSLContext, detachSSLContext must have been
540 // previously called which sets the socket's context to the dummy
541 // context. Thus we must acquire this lock.
542 SpinLockGuard guard(dummyCtxLock);
543 SSL_set_SSL_CTX(ssl_, ctx->getSSLCtx());
546 void AsyncSSLSocket::detachSSLContext() {
549 // We aren't using the initial_ctx for now, and it can introduce race
550 // conditions in the destructor of the SSL object.
551 #ifndef OPENSSL_NO_TLSEXT
552 if (ssl_->initial_ctx) {
553 SSL_CTX_free(ssl_->initial_ctx);
554 ssl_->initial_ctx = nullptr;
557 SpinLockGuard guard(dummyCtxLock);
558 if (nullptr == dummyCtx) {
559 // We need to lazily initialize the dummy context so we don't
560 // accidentally override any programmatic settings to openssl
561 dummyCtx = new SSLContext;
563 // We must remove this socket's references to its context right now
564 // since this socket could get passed to any thread. If the context has
565 // had its locking disabled, just doing a set in attachSSLContext()
566 // would not be thread safe.
567 SSL_set_SSL_CTX(ssl_, dummyCtx->getSSLCtx());
571 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
572 void AsyncSSLSocket::switchServerSSLContext(
573 const std::shared_ptr<SSLContext>& handshakeCtx) {
575 if (sslState_ != STATE_ACCEPTING) {
576 // We log it here and allow the switch.
577 // It should not affect our re-negotiation support (which
578 // is not supported now).
579 VLOG(6) << "fd=" << getFd()
580 << " renegotation detected when switching SSL_CTX";
583 setup_SSL_CTX(handshakeCtx->getSSLCtx());
584 SSL_CTX_set_info_callback(handshakeCtx->getSSLCtx(),
585 AsyncSSLSocket::sslInfoCallback);
586 handshakeCtx_ = handshakeCtx;
587 SSL_set_SSL_CTX(ssl_, handshakeCtx->getSSLCtx());
590 bool AsyncSSLSocket::isServerNameMatch() const {
597 SSL_SESSION *ss = SSL_get_session(ssl_);
602 if(!ss->tlsext_hostname) {
605 return (tlsextHostname_.compare(ss->tlsext_hostname) ? false : true);
608 void AsyncSSLSocket::setServerName(std::string serverName) noexcept {
609 tlsextHostname_ = std::move(serverName);
614 void AsyncSSLSocket::timeoutExpired() noexcept {
615 if (state_ == StateEnum::ESTABLISHED &&
616 (sslState_ == STATE_CACHE_LOOKUP ||
617 sslState_ == STATE_RSA_ASYNC_PENDING)) {
618 sslState_ = STATE_ERROR;
619 // We are expecting a callback in restartSSLAccept. The cache lookup
620 // and rsa-call necessarily have pointers to this ssl socket, so delay
621 // the cleanup until he calls us back.
623 assert(state_ == StateEnum::ESTABLISHED &&
624 (sslState_ == STATE_CONNECTING || sslState_ == STATE_ACCEPTING));
625 DestructorGuard dg(this);
626 AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
627 (sslState_ == STATE_CONNECTING) ?
628 "SSL connect timed out" : "SSL accept timed out");
629 failHandshake(__func__, ex);
633 int AsyncSSLSocket::getSSLExDataIndex() {
634 static auto index = SSL_get_ex_new_index(
635 0, (void*)"AsyncSSLSocket data index", nullptr, nullptr, nullptr);
639 AsyncSSLSocket* AsyncSSLSocket::getFromSSL(const SSL *ssl) {
640 return static_cast<AsyncSSLSocket *>(SSL_get_ex_data(ssl,
641 getSSLExDataIndex()));
644 void AsyncSSLSocket::failHandshake(const char* /* fn */,
645 const AsyncSocketException& ex) {
647 if (handshakeTimeout_.isScheduled()) {
648 handshakeTimeout_.cancelTimeout();
650 invokeHandshakeErr(ex);
654 void AsyncSSLSocket::invokeHandshakeErr(const AsyncSocketException& ex) {
655 handshakeEndTime_ = std::chrono::steady_clock::now();
656 if (handshakeCallback_ != nullptr) {
657 HandshakeCB* callback = handshakeCallback_;
658 handshakeCallback_ = nullptr;
659 callback->handshakeErr(this, ex);
663 void AsyncSSLSocket::invokeHandshakeCB() {
664 handshakeEndTime_ = std::chrono::steady_clock::now();
665 if (handshakeTimeout_.isScheduled()) {
666 handshakeTimeout_.cancelTimeout();
668 if (handshakeCallback_) {
669 HandshakeCB* callback = handshakeCallback_;
670 handshakeCallback_ = nullptr;
671 callback->handshakeSuc(this);
675 void AsyncSSLSocket::cacheLocalPeerAddr() {
676 SocketAddress address;
678 getLocalAddress(&address);
679 getPeerAddress(&address);
680 } catch (const std::system_error& e) {
681 // The handle can be still valid while the connection is already closed.
682 if (e.code() != std::error_code(ENOTCONN, std::system_category())) {
688 void AsyncSSLSocket::connect(ConnectCallback* callback,
689 const folly::SocketAddress& address,
691 const OptionMap &options,
692 const folly::SocketAddress& bindAddr)
695 assert(state_ == StateEnum::UNINIT);
696 assert(sslState_ == STATE_UNINIT);
697 AsyncSSLSocketConnector *connector =
698 new AsyncSSLSocketConnector(this, callback, timeout);
699 AsyncSocket::connect(connector, address, timeout, options, bindAddr);
702 void AsyncSSLSocket::applyVerificationOptions(SSL * ssl) {
703 // apply the settings specified in verifyPeer_
704 if (verifyPeer_ == SSLContext::SSLVerifyPeerEnum::USE_CTX) {
705 if(ctx_->needsPeerVerification()) {
706 SSL_set_verify(ssl, ctx_->getVerificationMode(),
707 AsyncSSLSocket::sslVerifyCallback);
710 if (verifyPeer_ == SSLContext::SSLVerifyPeerEnum::VERIFY ||
711 verifyPeer_ == SSLContext::SSLVerifyPeerEnum::VERIFY_REQ_CLIENT_CERT) {
712 SSL_set_verify(ssl, SSLContext::getVerificationMode(verifyPeer_),
713 AsyncSSLSocket::sslVerifyCallback);
718 void AsyncSSLSocket::sslConn(HandshakeCB* callback, uint64_t timeout,
719 const SSLContext::SSLVerifyPeerEnum& verifyPeer) {
720 DestructorGuard dg(this);
721 assert(eventBase_->isInEventBaseThread());
723 // Cache local and remote socket addresses to keep them available
724 // after socket file descriptor is closed.
725 if (cacheAddrOnFailure_ && -1 != getFd()) {
726 cacheLocalPeerAddr();
729 verifyPeer_ = verifyPeer;
731 // Make sure we're in the uninitialized state
732 if (server_ || (sslState_ != STATE_UNINIT && sslState_ !=
733 STATE_UNENCRYPTED) ||
734 handshakeCallback_ != nullptr) {
735 return invalidState(callback);
738 handshakeStartTime_ = std::chrono::steady_clock::now();
739 // Make end time at least >= start time.
740 handshakeEndTime_ = handshakeStartTime_;
742 sslState_ = STATE_CONNECTING;
743 handshakeCallback_ = callback;
746 ssl_ = ctx_->createSSL();
747 } catch (std::exception &e) {
748 sslState_ = STATE_ERROR;
749 AsyncSocketException ex(AsyncSocketException::INTERNAL_ERROR,
750 "error calling SSLContext::createSSL()");
751 LOG(ERROR) << "AsyncSSLSocket::sslConn(this=" << this << ", fd="
752 << fd_ << "): " << e.what();
753 return failHandshake(__func__, ex);
756 applyVerificationOptions(ssl_);
758 SSL_set_fd(ssl_, fd_);
759 if (sslSession_ != nullptr) {
760 SSL_set_session(ssl_, sslSession_);
761 SSL_SESSION_free(sslSession_);
762 sslSession_ = nullptr;
764 #if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT)
765 if (tlsextHostname_.size()) {
766 SSL_set_tlsext_host_name(ssl_, tlsextHostname_.c_str());
770 SSL_set_ex_data(ssl_, getSSLExDataIndex(), this);
773 handshakeTimeout_.scheduleTimeout(timeout);
779 SSL_SESSION *AsyncSSLSocket::getSSLSession() {
780 if (ssl_ != nullptr && sslState_ == STATE_ESTABLISHED) {
781 return SSL_get1_session(ssl_);
787 void AsyncSSLSocket::setSSLSession(SSL_SESSION *session, bool takeOwnership) {
788 sslSession_ = session;
789 if (!takeOwnership && session != nullptr) {
790 // Increment the reference count
791 CRYPTO_add(&session->references, 1, CRYPTO_LOCK_SSL_SESSION);
795 void AsyncSSLSocket::getSelectedNextProtocol(
796 const unsigned char** protoName,
798 SSLContext::NextProtocolType* protoType) const {
799 if (!getSelectedNextProtocolNoThrow(protoName, protoLen, protoType)) {
800 throw AsyncSocketException(AsyncSocketException::NOT_SUPPORTED,
801 "NPN not supported");
805 bool AsyncSSLSocket::getSelectedNextProtocolNoThrow(
806 const unsigned char** protoName,
808 SSLContext::NextProtocolType* protoType) const {
809 *protoName = nullptr;
811 #if OPENSSL_VERSION_NUMBER >= 0x1000200fL && !defined(OPENSSL_NO_TLSEXT)
812 SSL_get0_alpn_selected(ssl_, protoName, protoLen);
815 *protoType = SSLContext::NextProtocolType::ALPN;
820 #ifdef OPENSSL_NPN_NEGOTIATED
821 SSL_get0_next_proto_negotiated(ssl_, protoName, protoLen);
823 *protoType = SSLContext::NextProtocolType::NPN;
832 bool AsyncSSLSocket::getSSLSessionReused() const {
833 if (ssl_ != nullptr && sslState_ == STATE_ESTABLISHED) {
834 return SSL_session_reused(ssl_);
839 const char *AsyncSSLSocket::getNegotiatedCipherName() const {
840 return (ssl_ != nullptr) ? SSL_get_cipher_name(ssl_) : nullptr;
843 const char *AsyncSSLSocket::getSSLServerName() const {
844 #ifdef SSL_CTRL_SET_TLSEXT_SERVERNAME_CB
845 return (ssl_ != nullptr) ? SSL_get_servername(ssl_, TLSEXT_NAMETYPE_host_name)
848 throw AsyncSocketException(AsyncSocketException::NOT_SUPPORTED,
849 "SNI not supported");
853 const char *AsyncSSLSocket::getSSLServerNameNoThrow() const {
855 return getSSLServerName();
856 } catch (AsyncSocketException& ex) {
861 int AsyncSSLSocket::getSSLVersion() const {
862 return (ssl_ != nullptr) ? SSL_version(ssl_) : 0;
865 const char *AsyncSSLSocket::getSSLCertSigAlgName() const {
866 X509 *cert = (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
868 int nid = OBJ_obj2nid(cert->sig_alg->algorithm);
869 return OBJ_nid2ln(nid);
874 int AsyncSSLSocket::getSSLCertSize() const {
876 X509 *cert = (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr;
878 EVP_PKEY *key = X509_get_pubkey(cert);
879 certSize = EVP_PKEY_bits(key);
885 bool AsyncSSLSocket::willBlock(int ret, int *errorOut) noexcept {
886 int error = *errorOut = SSL_get_error(ssl_, ret);
887 if (error == SSL_ERROR_WANT_READ) {
888 // Register for read event if not already.
889 updateEventRegistration(EventHandler::READ, EventHandler::WRITE);
891 } else if (error == SSL_ERROR_WANT_WRITE) {
892 VLOG(3) << "AsyncSSLSocket(fd=" << fd_
893 << ", state=" << int(state_) << ", sslState="
894 << sslState_ << ", events=" << eventFlags_ << "): "
895 << "SSL_ERROR_WANT_WRITE";
896 // Register for write event if not already.
897 updateEventRegistration(EventHandler::WRITE, EventHandler::READ);
899 #ifdef SSL_ERROR_WANT_SESS_CACHE_LOOKUP
900 } else if (error == SSL_ERROR_WANT_SESS_CACHE_LOOKUP) {
901 // We will block but we can't register our own socket. The callback that
902 // triggered this code will re-call handleAccept at the appropriate time.
904 // We can only get here if the linked libssl.so has support for this feature
905 // as well, otherwise SSL_get_error cannot return our error code.
906 sslState_ = STATE_CACHE_LOOKUP;
908 // Unregister for all events while blocked here
909 updateEventRegistration(EventHandler::NONE,
910 EventHandler::READ | EventHandler::WRITE);
912 // The timeout (if set) keeps running here
915 #ifdef SSL_ERROR_WANT_RSA_ASYNC_PENDING
916 } else if (error == SSL_ERROR_WANT_RSA_ASYNC_PENDING) {
917 // Our custom openssl function has kicked off an async request to do
918 // modular exponentiation. When that call returns, a callback will
919 // be invoked that will re-call handleAccept.
920 sslState_ = STATE_RSA_ASYNC_PENDING;
922 // Unregister for all events while blocked here
923 updateEventRegistration(
925 EventHandler::READ | EventHandler::WRITE
928 // The timeout (if set) keeps running here
932 // SSL_ERROR_ZERO_RETURN is processed here so we can get some detail
934 long lastError = ERR_get_error();
935 VLOG(6) << "AsyncSSLSocket(fd=" << fd_ << ", "
936 << "state=" << state_ << ", "
937 << "sslState=" << sslState_ << ", "
938 << "events=" << std::hex << eventFlags_ << "): "
939 << "SSL error: " << error << ", "
940 << "errno: " << errno << ", "
941 << "ret: " << ret << ", "
942 << "read: " << BIO_number_read(SSL_get_rbio(ssl_)) << ", "
943 << "written: " << BIO_number_written(SSL_get_wbio(ssl_)) << ", "
944 << "func: " << ERR_func_error_string(lastError) << ", "
945 << "reason: " << ERR_reason_error_string(lastError);
946 if (error != SSL_ERROR_SYSCALL) {
947 if (error == SSL_ERROR_SSL) {
948 *errorOut = lastError;
950 if ((unsigned long)lastError < 0x8000) {
961 void AsyncSSLSocket::checkForImmediateRead() noexcept {
962 // openssl may have buffered data that it read from the socket already.
963 // In this case we have to process it immediately, rather than waiting for
964 // the socket to become readable again.
965 if (ssl_ != nullptr && SSL_pending(ssl_) > 0) {
966 AsyncSocket::handleRead();
971 AsyncSSLSocket::restartSSLAccept()
973 VLOG(3) << "AsyncSSLSocket::restartSSLAccept() this=" << this << ", fd=" << fd_
974 << ", state=" << int(state_) << ", "
975 << "sslState=" << sslState_ << ", events=" << eventFlags_;
976 DestructorGuard dg(this);
978 sslState_ == STATE_CACHE_LOOKUP ||
979 sslState_ == STATE_RSA_ASYNC_PENDING ||
980 sslState_ == STATE_ERROR ||
981 sslState_ == STATE_CLOSED
983 if (sslState_ == STATE_CLOSED) {
984 // I sure hope whoever closed this socket didn't delete it already,
985 // but this is not strictly speaking an error
988 if (sslState_ == STATE_ERROR) {
989 // go straight to fail if timeout expired during lookup
990 AsyncSocketException ex(AsyncSocketException::TIMED_OUT,
991 "SSL accept timed out");
992 failHandshake(__func__, ex);
995 sslState_ = STATE_ACCEPTING;
996 this->handleAccept();
1000 AsyncSSLSocket::handleAccept() noexcept {
1001 VLOG(3) << "AsyncSSLSocket::handleAccept() this=" << this
1002 << ", fd=" << fd_ << ", state=" << int(state_) << ", "
1003 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1005 assert(state_ == StateEnum::ESTABLISHED &&
1006 sslState_ == STATE_ACCEPTING);
1008 /* lazily create the SSL structure */
1010 ssl_ = ctx_->createSSL();
1011 } catch (std::exception &e) {
1012 sslState_ = STATE_ERROR;
1013 AsyncSocketException ex(AsyncSocketException::INTERNAL_ERROR,
1014 "error calling SSLContext::createSSL()");
1015 LOG(ERROR) << "AsyncSSLSocket::handleAccept(this=" << this
1016 << ", fd=" << fd_ << "): " << e.what();
1017 return failHandshake(__func__, ex);
1019 SSL_set_fd(ssl_, fd_);
1020 SSL_set_ex_data(ssl_, getSSLExDataIndex(), this);
1022 applyVerificationOptions(ssl_);
1025 if (server_ && parseClientHello_) {
1026 SSL_set_msg_callback(ssl_, &AsyncSSLSocket::clientHelloParsingCallback);
1027 SSL_set_msg_callback_arg(ssl_, this);
1031 int ret = SSL_accept(ssl_);
1034 if (willBlock(ret, &error)) {
1037 sslState_ = STATE_ERROR;
1038 SSLException ex(error, errno);
1039 return failHandshake(__func__, ex);
1043 handshakeComplete_ = true;
1044 updateEventRegistration(0, EventHandler::READ | EventHandler::WRITE);
1046 // Move into STATE_ESTABLISHED in the normal case that we are in
1048 sslState_ = STATE_ESTABLISHED;
1050 VLOG(3) << "AsyncSSLSocket " << this << ": fd " << fd_
1051 << " successfully accepted; state=" << int(state_)
1052 << ", sslState=" << sslState_ << ", events=" << eventFlags_;
1054 // Remember the EventBase we are attached to, before we start invoking any
1055 // callbacks (since the callbacks may call detachEventBase()).
1056 EventBase* originalEventBase = eventBase_;
1058 // Call the accept callback.
1059 invokeHandshakeCB();
1061 // Note that the accept callback may have changed our state.
1062 // (set or unset the read callback, called write(), closed the socket, etc.)
1063 // The following code needs to handle these situations correctly.
1065 // If the socket has been closed, readCallback_ and writeReqHead_ will
1066 // always be nullptr, so that will prevent us from trying to read or write.
1068 // The main thing to check for is if eventBase_ is still originalEventBase.
1069 // If not, we have been detached from this event base, so we shouldn't
1070 // perform any more operations.
1071 if (eventBase_ != originalEventBase) {
1075 AsyncSocket::handleInitialReadWrite();
1079 AsyncSSLSocket::handleConnect() noexcept {
1080 VLOG(3) << "AsyncSSLSocket::handleConnect() this=" << this
1081 << ", fd=" << fd_ << ", state=" << int(state_) << ", "
1082 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1084 if (state_ < StateEnum::ESTABLISHED) {
1085 return AsyncSocket::handleConnect();
1088 assert(state_ == StateEnum::ESTABLISHED &&
1089 sslState_ == STATE_CONNECTING);
1093 int ret = SSL_connect(ssl_);
1096 if (willBlock(ret, &error)) {
1099 sslState_ = STATE_ERROR;
1100 SSLException ex(error, errno);
1101 return failHandshake(__func__, ex);
1105 handshakeComplete_ = true;
1106 updateEventRegistration(0, EventHandler::READ | EventHandler::WRITE);
1108 // Move into STATE_ESTABLISHED in the normal case that we are in
1109 // STATE_CONNECTING.
1110 sslState_ = STATE_ESTABLISHED;
1112 VLOG(3) << "AsyncSSLSocket %p: fd %d successfully connected; "
1113 << "state=" << int(state_) << ", sslState=" << sslState_
1114 << ", events=" << eventFlags_;
1116 // Remember the EventBase we are attached to, before we start invoking any
1117 // callbacks (since the callbacks may call detachEventBase()).
1118 EventBase* originalEventBase = eventBase_;
1120 // Call the handshake callback.
1121 invokeHandshakeCB();
1123 // Note that the connect callback may have changed our state.
1124 // (set or unset the read callback, called write(), closed the socket, etc.)
1125 // The following code needs to handle these situations correctly.
1127 // If the socket has been closed, readCallback_ and writeReqHead_ will
1128 // always be nullptr, so that will prevent us from trying to read or write.
1130 // The main thing to check for is if eventBase_ is still originalEventBase.
1131 // If not, we have been detached from this event base, so we shouldn't
1132 // perform any more operations.
1133 if (eventBase_ != originalEventBase) {
1137 AsyncSocket::handleInitialReadWrite();
1140 void AsyncSSLSocket::setReadCB(ReadCallback *callback) {
1141 #ifdef SSL_MODE_MOVE_BUFFER_OWNERSHIP
1142 // turn on the buffer movable in openssl
1143 if (ssl_ != nullptr && !isBufferMovable_ &&
1144 callback != nullptr && callback->isBufferMovable()) {
1145 SSL_set_mode(ssl_, SSL_get_mode(ssl_) | SSL_MODE_MOVE_BUFFER_OWNERSHIP);
1146 isBufferMovable_ = true;
1150 AsyncSocket::setReadCB(callback);
1153 void AsyncSSLSocket::prepareReadBuffer(void** buf, size_t* buflen) noexcept {
1154 CHECK(readCallback_);
1155 if (isBufferMovable_) {
1159 // buf is necessary for SSLSocket without SSL_MODE_MOVE_BUFFER_OWNERSHIP
1160 readCallback_->getReadBuffer(buf, buflen);
1165 AsyncSSLSocket::handleRead() noexcept {
1166 VLOG(5) << "AsyncSSLSocket::handleRead() this=" << this << ", fd=" << fd_
1167 << ", state=" << int(state_) << ", "
1168 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1169 if (state_ < StateEnum::ESTABLISHED) {
1170 return AsyncSocket::handleRead();
1174 if (sslState_ == STATE_ACCEPTING) {
1179 else if (sslState_ == STATE_CONNECTING) {
1186 AsyncSocket::handleRead();
1190 AsyncSSLSocket::performRead(void** buf, size_t* buflen, size_t* offset) {
1191 VLOG(4) << "AsyncSSLSocket::performRead() this=" << this
1192 << ", buf=" << *buf << ", buflen=" << *buflen;
1194 if (sslState_ == STATE_UNENCRYPTED) {
1195 return AsyncSocket::performRead(buf, buflen, offset);
1200 if (!isBufferMovable_) {
1201 bytes = SSL_read(ssl_, *buf, *buflen);
1203 #ifdef SSL_MODE_MOVE_BUFFER_OWNERSHIP
1205 bytes = SSL_read_buf(ssl_, buf, (int *) offset, (int *) buflen);
1209 if (server_ && renegotiateAttempted_) {
1210 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1211 << ", sslstate=" << sslState_ << ", events=" << eventFlags_
1212 << "): client intitiated SSL renegotiation not permitted";
1213 // We pack our own SSLerr here with a dummy function
1214 errno = ERR_PACK(ERR_LIB_USER, TASYNCSSLSOCKET_F_PERFORM_READ,
1215 SSL_CLIENT_RENEGOTIATION_ATTEMPT);
1220 int error = SSL_get_error(ssl_, bytes);
1221 if (error == SSL_ERROR_WANT_READ) {
1222 // The caller will register for read event if not already.
1223 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1224 return READ_BLOCKING;
1228 } else if (error == SSL_ERROR_WANT_WRITE) {
1229 // TODO: Even though we are attempting to read data, SSL_read() may
1230 // need to write data if renegotiation is being performed. We currently
1231 // don't support this and just fail the read.
1232 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1233 << ", sslState=" << sslState_ << ", events=" << eventFlags_
1234 << "): unsupported SSL renegotiation during read",
1235 errno = ERR_PACK(ERR_LIB_USER, TASYNCSSLSOCKET_F_PERFORM_READ,
1236 SSL_INVALID_RENEGOTIATION);
1240 // TODO: Fix this code so that it can return a proper error message
1241 // to the callback, rather than relying on AsyncSocket code which
1242 // can't handle SSL errors.
1243 long lastError = ERR_get_error();
1245 VLOG(6) << "AsyncSSLSocket(fd=" << fd_ << ", "
1246 << "state=" << state_ << ", "
1247 << "sslState=" << sslState_ << ", "
1248 << "events=" << std::hex << eventFlags_ << "): "
1249 << "bytes: " << bytes << ", "
1250 << "error: " << error << ", "
1251 << "errno: " << errno << ", "
1252 << "func: " << ERR_func_error_string(lastError) << ", "
1253 << "reason: " << ERR_reason_error_string(lastError);
1255 if (zero_return(error, bytes)) {
1258 if (error != SSL_ERROR_SYSCALL) {
1259 if ((unsigned long)lastError < 0x8000) {
1268 appBytesReceived_ += bytes;
1273 void AsyncSSLSocket::handleWrite() noexcept {
1274 VLOG(5) << "AsyncSSLSocket::handleWrite() this=" << this << ", fd=" << fd_
1275 << ", state=" << int(state_) << ", "
1276 << "sslState=" << sslState_ << ", events=" << eventFlags_;
1277 if (state_ < StateEnum::ESTABLISHED) {
1278 return AsyncSocket::handleWrite();
1281 if (sslState_ == STATE_ACCEPTING) {
1287 if (sslState_ == STATE_CONNECTING) {
1294 AsyncSocket::handleWrite();
1297 int AsyncSSLSocket::interpretSSLError(int rc, int error) {
1298 if (error == SSL_ERROR_WANT_READ) {
1299 // TODO: Even though we are attempting to write data, SSL_write() may
1300 // need to read data if renegotiation is being performed. We currently
1301 // don't support this and just fail the write.
1302 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1303 << ", sslState=" << sslState_ << ", events=" << eventFlags_
1304 << "): " << "unsupported SSL renegotiation during write",
1305 errno = ERR_PACK(ERR_LIB_USER, TASYNCSSLSOCKET_F_PERFORM_WRITE,
1306 SSL_INVALID_RENEGOTIATION);
1310 // TODO: Fix this code so that it can return a proper error message
1311 // to the callback, rather than relying on AsyncSocket code which
1312 // can't handle SSL errors.
1313 long lastError = ERR_get_error();
1314 VLOG(3) << "ERROR: AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1315 << ", sslState=" << sslState_ << ", events=" << eventFlags_ << "): "
1316 << "SSL error: " << error << ", errno: " << errno
1317 << ", func: " << ERR_func_error_string(lastError)
1318 << ", reason: " << ERR_reason_error_string(lastError);
1319 if (error != SSL_ERROR_SYSCALL) {
1320 if ((unsigned long)lastError < 0x8000) {
1327 if (!zero_return(error, rc)) {
1335 ssize_t AsyncSSLSocket::performWrite(const iovec* vec,
1338 uint32_t* countWritten,
1339 uint32_t* partialWritten) {
1340 if (sslState_ == STATE_UNENCRYPTED) {
1341 return AsyncSocket::performWrite(
1342 vec, count, flags, countWritten, partialWritten);
1344 if (sslState_ != STATE_ESTABLISHED) {
1345 LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_)
1346 << ", sslState=" << sslState_
1347 << ", events=" << eventFlags_ << "): "
1348 << "TODO: AsyncSSLSocket currently does not support calling "
1349 << "write() before the handshake has fully completed";
1350 errno = ERR_PACK(ERR_LIB_USER, TASYNCSSLSOCKET_F_PERFORM_WRITE,
1355 bool cork = isSet(flags, WriteFlags::CORK) || persistentCork_;
1356 CorkGuard guard(fd_, count > 1, cork, &corked_);
1359 //#ifdef SSL_MODE_WRITE_IOVEC
1360 if (ssl_->expand == nullptr &&
1361 ssl_->compress == nullptr &&
1362 (ssl_->mode & SSL_MODE_WRITE_IOVEC)) {
1363 return performWriteIovec(vec, count, flags, countWritten, partialWritten);
1367 // Declare a buffer used to hold small write requests. It could point to a
1368 // memory block either on stack or on heap. If it is on heap, we release it
1369 // manually when scope exits
1370 char* combinedBuf{nullptr};
1372 // Note, always keep this check consistent with what we do below
1373 if (combinedBuf != nullptr && minWriteSize_ > MAX_STACK_BUF_SIZE) {
1374 delete[] combinedBuf;
1379 *partialWritten = 0;
1380 ssize_t totalWritten = 0;
1381 size_t bytesStolenFromNextBuffer = 0;
1382 for (uint32_t i = 0; i < count; i++) {
1383 const iovec* v = vec + i;
1384 size_t offset = bytesStolenFromNextBuffer;
1385 bytesStolenFromNextBuffer = 0;
1386 size_t len = v->iov_len - offset;
1392 buf = ((const char*)v->iov_base) + offset;
1396 uint32_t buffersStolen = 0;
1397 if ((len < minWriteSize_) && ((i + 1) < count)) {
1398 // Combine this buffer with part or all of the next buffers in
1399 // order to avoid really small-grained calls to SSL_write().
1400 // Each call to SSL_write() produces a separate record in
1401 // the egress SSL stream, and we've found that some low-end
1402 // mobile clients can't handle receiving an HTTP response
1403 // header and the first part of the response body in two
1404 // separate SSL records (even if those two records are in
1405 // the same TCP packet).
1407 if (combinedBuf == nullptr) {
1408 if (minWriteSize_ > MAX_STACK_BUF_SIZE) {
1409 // Allocate the buffer on heap
1410 combinedBuf = new char[minWriteSize_];
1412 // Allocate the buffer on stack
1413 combinedBuf = (char*)alloca(minWriteSize_);
1416 assert(combinedBuf != nullptr);
1418 memcpy(combinedBuf, buf, len);
1420 // INVARIANT: i + buffersStolen == complete chunks serialized
1421 uint32_t nextIndex = i + buffersStolen + 1;
1422 bytesStolenFromNextBuffer = std::min(vec[nextIndex].iov_len,
1423 minWriteSize_ - len);
1424 memcpy(combinedBuf + len, vec[nextIndex].iov_base,
1425 bytesStolenFromNextBuffer);
1426 len += bytesStolenFromNextBuffer;
1427 if (bytesStolenFromNextBuffer < vec[nextIndex].iov_len) {
1428 // couldn't steal the whole buffer
1431 bytesStolenFromNextBuffer = 0;
1434 } while ((i + buffersStolen + 1) < count && (len < minWriteSize_));
1435 bytes = eorAwareSSLWrite(
1436 ssl_, combinedBuf, len,
1437 (isSet(flags, WriteFlags::EOR) && i + buffersStolen + 1 == count));
1440 bytes = eorAwareSSLWrite(ssl_, buf, len,
1441 (isSet(flags, WriteFlags::EOR) && i + 1 == count));
1445 int error = SSL_get_error(ssl_, bytes);
1446 if (error == SSL_ERROR_WANT_WRITE) {
1447 // The caller will register for write event if not already.
1448 *partialWritten = offset;
1449 return totalWritten;
1451 int rc = interpretSSLError(bytes, error);
1454 } // else fall through to below to correctly record totalWritten
1457 totalWritten += bytes;
1459 if (bytes == (ssize_t)len) {
1460 // The full iovec is written.
1461 (*countWritten) += 1 + buffersStolen;
1465 bytes += offset; // adjust bytes to account for all of v
1466 while (bytes >= (ssize_t)v->iov_len) {
1467 // We combined this buf with part or all of the next one, and
1468 // we managed to write all of this buf but not all of the bytes
1469 // from the next one that we'd hoped to write.
1470 bytes -= v->iov_len;
1474 *partialWritten = bytes;
1475 return totalWritten;
1479 return totalWritten;
1483 //#ifdef SSL_MODE_WRITE_IOVEC
1484 ssize_t AsyncSSLSocket::performWriteIovec(const iovec* vec,
1487 uint32_t* countWritten,
1488 uint32_t* partialWritten) {
1490 for (uint32_t j = 0; j < count; j++) {
1491 tot += vec[j].iov_len;
1494 ssize_t totalWritten = SSL_write_iovec(ssl_, vec, count);
1497 *partialWritten = 0;
1498 if (totalWritten <= 0) {
1499 return interpretSSLError(totalWritten, SSL_get_error(ssl_, totalWritten));
1501 ssize_t bytes = totalWritten, i = 0;
1502 while (i < count && bytes >= (ssize_t)vec[i].iov_len) {
1503 // we managed to write all of this buf
1504 bytes -= vec[i].iov_len;
1508 *partialWritten = bytes;
1510 VLOG(4) << "SSL_write_iovec() writes " << tot
1511 << ", returns " << totalWritten << " bytes"
1512 << ", max_send_fragment=" << ssl_->max_send_fragment
1513 << ", count=" << count << ", countWritten=" << *countWritten;
1515 return totalWritten;
1520 int AsyncSSLSocket::eorAwareSSLWrite(SSL *ssl, const void *buf, int n,
1522 if (eor && SSL_get_wbio(ssl)->method == &eorAwareBioMethod) {
1523 if (appEorByteNo_) {
1524 // cannot track for more than one app byte EOR
1525 CHECK(appEorByteNo_ == appBytesWritten_ + n);
1527 appEorByteNo_ = appBytesWritten_ + n;
1530 // 1. It is fine to keep updating minEorRawByteNo_.
1531 // 2. It is _min_ in the sense that SSL record will add some overhead.
1532 minEorRawByteNo_ = getRawBytesWritten() + n;
1535 n = sslWriteImpl(ssl, buf, n);
1537 appBytesWritten_ += n;
1538 if (appEorByteNo_) {
1539 if (getRawBytesWritten() >= minEorRawByteNo_) {
1540 minEorRawByteNo_ = 0;
1542 if(appBytesWritten_ == appEorByteNo_) {
1545 CHECK(appBytesWritten_ < appEorByteNo_);
1552 void AsyncSSLSocket::sslInfoCallback(const SSL* ssl, int where, int /* ret */) {
1553 AsyncSSLSocket *sslSocket = AsyncSSLSocket::getFromSSL(ssl);
1554 if (sslSocket->handshakeComplete_ && (where & SSL_CB_HANDSHAKE_START)) {
1555 sslSocket->renegotiateAttempted_ = true;
1559 int AsyncSSLSocket::eorAwareBioWrite(BIO *b, const char *in, int inl) {
1564 AsyncSSLSocket *tsslSock;
1566 iov.iov_base = const_cast<char *>(in);
1568 memset(&msg, 0, sizeof(msg));
1573 reinterpret_cast<AsyncSSLSocket*>(BIO_get_app_data(b));
1575 tsslSock->minEorRawByteNo_ &&
1576 tsslSock->minEorRawByteNo_ <= BIO_number_written(b) + inl) {
1581 ret = sendmsg(b->num, &msg, flags);
1582 BIO_clear_retry_flags(b);
1584 if (BIO_sock_should_retry(ret))
1585 BIO_set_retry_write(b);
1590 int AsyncSSLSocket::sslVerifyCallback(int preverifyOk,
1591 X509_STORE_CTX* x509Ctx) {
1592 SSL* ssl = (SSL*) X509_STORE_CTX_get_ex_data(
1593 x509Ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
1594 AsyncSSLSocket* self = AsyncSSLSocket::getFromSSL(ssl);
1596 VLOG(3) << "AsyncSSLSocket::sslVerifyCallback() this=" << self << ", "
1597 << "fd=" << self->fd_ << ", preverifyOk=" << preverifyOk;
1598 return (self->handshakeCallback_) ?
1599 self->handshakeCallback_->handshakeVer(self, preverifyOk, x509Ctx) :
1603 void AsyncSSLSocket::enableClientHelloParsing() {
1604 parseClientHello_ = true;
1605 clientHelloInfo_.reset(new ClientHelloInfo());
1608 void AsyncSSLSocket::resetClientHelloParsing(SSL *ssl) {
1609 SSL_set_msg_callback(ssl, nullptr);
1610 SSL_set_msg_callback_arg(ssl, nullptr);
1611 clientHelloInfo_->clientHelloBuf_.clear();
1614 void AsyncSSLSocket::clientHelloParsingCallback(int written,
1621 AsyncSSLSocket *sock = static_cast<AsyncSSLSocket*>(arg);
1623 sock->resetClientHelloParsing(ssl);
1626 if (contentType != SSL3_RT_HANDSHAKE) {
1633 auto& clientHelloBuf = sock->clientHelloInfo_->clientHelloBuf_;
1634 clientHelloBuf.append(IOBuf::wrapBuffer(buf, len));
1636 Cursor cursor(clientHelloBuf.front());
1637 if (cursor.read<uint8_t>() != SSL3_MT_CLIENT_HELLO) {
1638 sock->resetClientHelloParsing(ssl);
1642 if (cursor.totalLength() < 3) {
1643 clientHelloBuf.trimEnd(len);
1644 clientHelloBuf.append(IOBuf::copyBuffer(buf, len));
1648 uint32_t messageLength = cursor.read<uint8_t>();
1649 messageLength <<= 8;
1650 messageLength |= cursor.read<uint8_t>();
1651 messageLength <<= 8;
1652 messageLength |= cursor.read<uint8_t>();
1653 if (cursor.totalLength() < messageLength) {
1654 clientHelloBuf.trimEnd(len);
1655 clientHelloBuf.append(IOBuf::copyBuffer(buf, len));
1659 sock->clientHelloInfo_->clientHelloMajorVersion_ = cursor.read<uint8_t>();
1660 sock->clientHelloInfo_->clientHelloMinorVersion_ = cursor.read<uint8_t>();
1662 cursor.skip(4); // gmt_unix_time
1663 cursor.skip(28); // random_bytes
1665 cursor.skip(cursor.read<uint8_t>()); // session_id
1667 uint16_t cipherSuitesLength = cursor.readBE<uint16_t>();
1668 for (int i = 0; i < cipherSuitesLength; i += 2) {
1669 sock->clientHelloInfo_->
1670 clientHelloCipherSuites_.push_back(cursor.readBE<uint16_t>());
1673 uint8_t compressionMethodsLength = cursor.read<uint8_t>();
1674 for (int i = 0; i < compressionMethodsLength; ++i) {
1675 sock->clientHelloInfo_->
1676 clientHelloCompressionMethods_.push_back(cursor.readBE<uint8_t>());
1679 if (cursor.totalLength() > 0) {
1680 uint16_t extensionsLength = cursor.readBE<uint16_t>();
1681 while (extensionsLength) {
1682 TLSExtension extensionType = static_cast<TLSExtension>(
1683 cursor.readBE<uint16_t>());
1684 sock->clientHelloInfo_->
1685 clientHelloExtensions_.push_back(extensionType);
1686 extensionsLength -= 2;
1687 uint16_t extensionDataLength = cursor.readBE<uint16_t>();
1688 extensionsLength -= 2;
1690 if (extensionType == TLSExtension::SIGNATURE_ALGORITHMS) {
1692 extensionDataLength -= 2;
1693 while (extensionDataLength) {
1694 HashAlgorithm hashAlg = static_cast<HashAlgorithm>(
1695 cursor.readBE<uint8_t>());
1696 SignatureAlgorithm sigAlg = static_cast<SignatureAlgorithm>(
1697 cursor.readBE<uint8_t>());
1698 extensionDataLength -= 2;
1699 sock->clientHelloInfo_->
1700 clientHelloSigAlgs_.emplace_back(hashAlg, sigAlg);
1703 cursor.skip(extensionDataLength);
1704 extensionsLength -= extensionDataLength;
1708 } catch (std::out_of_range& e) {
1709 // we'll use what we found and cleanup below.
1710 VLOG(4) << "AsyncSSLSocket::clientHelloParsingCallback(): "
1711 << "buffer finished unexpectedly." << " AsyncSSLSocket socket=" << sock;
1714 sock->resetClientHelloParsing(ssl);