X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=folly%2Fio%2Fasync%2FAsyncSSLSocket.cpp;h=f91416ed61ac3c0dcff529b329a4165ebcf43719;hb=a3bd593ad9374cd3a1db31066874b9bad1cf74b4;hp=ae078401c59d1e811230a7446790770629adfba2;hpb=b05969e4b4474cadf1cb1f8ebc37567cc63c9b88;p=folly.git diff --git a/folly/io/async/AsyncSSLSocket.cpp b/folly/io/async/AsyncSSLSocket.cpp index ae078401..f91416ed 100644 --- a/folly/io/async/AsyncSSLSocket.cpp +++ b/folly/io/async/AsyncSSLSocket.cpp @@ -1,5 +1,5 @@ /* - * Copyright 2015 Facebook, Inc. + * Copyright 2016 Facebook, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,18 +17,15 @@ #include #include +#include #include #include #include -#include -#include #include #include #include #include -#include -#include #include #include @@ -36,6 +33,7 @@ #include #include #include +#include using folly::SocketAddress; using folly::SSLContext; @@ -55,16 +53,13 @@ using folly::AsyncSocket; using folly::AsyncSocketException; using folly::AsyncSSLSocket; using folly::Optional; +using folly::SSLContext; // We have one single dummy SSL context so that we can implement attach // and detach methods in a thread safe fashion without modifying opnessl. static SSLContext *dummyCtx = nullptr; static SpinLock dummyCtxLock; -// Numbers chosen as to not collide with functions in ssl.h -const uint8_t TASYNCSSLSOCKET_F_PERFORM_READ = 90; -const uint8_t TASYNCSSLSOCKET_F_PERFORM_WRITE = 91; - // If given min write size is less than this, buffer will be allocated on // stack, otherwise it is allocated on heap const size_t MAX_STACK_BUF_SIZE = 2048; @@ -123,7 +118,7 @@ class AsyncSSLSocketConnector: public AsyncSocket::ConnectCallback, delete this; } - void handshakeSuc(AsyncSSLSocket* sock) noexcept override { + void handshakeSuc(AsyncSSLSocket* /* sock */) noexcept override { VLOG(7) << "client handshake success"; if (callback_) { callback_->connectSuccess(); @@ -131,7 +126,7 @@ class AsyncSSLSocketConnector: public AsyncSocket::ConnectCallback, delete this; } - void handshakeErr(AsyncSSLSocket* socket, + void handshakeErr(AsyncSSLSocket* /* socket */, const AsyncSocketException& ex) noexcept override { LOG(ERROR) << "client handshakeErr: " << ex.what(); fail(ex); @@ -228,16 +223,16 @@ void setup_SSL_CTX(SSL_CTX *ctx) { } -BIO_METHOD eorAwareBioMethod; +BIO_METHOD sslWriteBioMethod; -void* initEorBioMethod(void) { - memcpy(&eorAwareBioMethod, BIO_s_socket(), sizeof(eorAwareBioMethod)); +void* initsslWriteBioMethod(void) { + memcpy(&sslWriteBioMethod, BIO_s_socket(), sizeof(sslWriteBioMethod)); // override the bwrite method for MSG_EOR support - eorAwareBioMethod.bwrite = AsyncSSLSocket::eorAwareBioWrite; + sslWriteBioMethod.bwrite = AsyncSSLSocket::bioWrite; - // Note that the eorAwareBioMethod.type and eorAwareBioMethod.name are not + // Note that the sslWriteBioMethod.type and sslWriteBioMethod.name are not // set here. openssl code seems to be checking ".type == BIO_TYPE_SOCKET" and - // then have specific handlings. The eorAwareBioWrite should be compatible + // then have specific handlings. The sslWriteBioWrite should be compatible // with the one in openssl. // Return something here to enable AsyncSSLSocket to call this method using @@ -249,12 +244,6 @@ void* initEorBioMethod(void) { namespace folly { -SSLException::SSLException(int sslError, int errno_copy): - AsyncSocketException( - AsyncSocketException::SSL_ERROR, - ERR_error_string(sslError, msg_), - sslError == SSL_ERROR_SYSCALL ? errno_copy : 0), error_(sslError) {} - /** * Create a client AsyncSSLSocket */ @@ -325,8 +314,8 @@ AsyncSSLSocket::~AsyncSSLSocket() { void AsyncSSLSocket::init() { // Do this here to ensure we initialize this once before any use of // AsyncSSLSocket instances and not as part of library load. - static const auto eorAwareBioMethodInitializer = initEorBioMethod(); - (void)eorAwareBioMethodInitializer; + static const auto sslWriteBioMethodInitializer = initsslWriteBioMethod(); + (void)sslWriteBioMethodInitializer; setup_SSL_CTX(ctx_->getSSLCtx()); } @@ -356,13 +345,10 @@ void AsyncSSLSocket::closeNow() { DestructorGuard dg(this); - if (handshakeCallback_) { - AsyncSocketException ex(AsyncSocketException::END_OF_FILE, - "SSL connection closed locally"); - HandshakeCB* callback = handshakeCallback_; - handshakeCallback_ = nullptr; - callback->handshakeErr(this, ex); - } + invokeHandshakeErr( + AsyncSocketException( + AsyncSocketException::END_OF_FILE, + "SSL connection closed locally")); if (ssl_ != nullptr) { SSL_free(ssl_); @@ -405,34 +391,24 @@ bool AsyncSSLSocket::connecting() const { sslState_ == STATE_CONNECTING)))); } +std::string AsyncSSLSocket::getApplicationProtocol() noexcept { + const unsigned char* protoName = nullptr; + unsigned protoLength; + if (getSelectedNextProtocolNoThrow(&protoName, &protoLength)) { + return std::string(reinterpret_cast(protoName), protoLength); + } + return ""; +} + bool AsyncSSLSocket::isEorTrackingEnabled() const { - const BIO *wb = SSL_get_wbio(ssl_); - return wb && wb->method == &eorAwareBioMethod; + return trackEor_; } void AsyncSSLSocket::setEorTracking(bool track) { - BIO *wb = SSL_get_wbio(ssl_); - if (!wb) { - throw AsyncSocketException(AsyncSocketException::INVALID_STATE, - "setting EOR tracking without an initialized " - "BIO"); - } - - if (track) { - if (wb->method != &eorAwareBioMethod) { - // only do this if we didn't - wb->method = &eorAwareBioMethod; - BIO_set_app_data(wb, this); - appEorByteNo_ = 0; - minEorRawByteNo_ = 0; - } - } else if (wb->method == &eorAwareBioMethod) { - wb->method = BIO_s_socket(); - BIO_set_app_data(wb, nullptr); + if (trackEor_ != track) { + trackEor_ = track; appEorByteNo_ = 0; minEorRawByteNo_ = 0; - } else { - CHECK(wb->method == BIO_s_socket()); } } @@ -468,6 +444,7 @@ void AsyncSSLSocket::invalidState(HandshakeCB* callback) { AsyncSocketException ex(AsyncSocketException::INVALID_STATE, "sslAccept() called with socket in invalid state"); + handshakeEndTime_ = std::chrono::steady_clock::now(); if (callback) { callback->handshakeErr(this, ex); } @@ -491,6 +468,16 @@ void AsyncSSLSocket::sslAccept(HandshakeCB* callback, uint32_t timeout, return invalidState(callback); } + // Cache local and remote socket addresses to keep them available + // after socket file descriptor is closed. + if (cacheAddrOnFailure_ && -1 != getFd()) { + cacheLocalPeerAddr(); + } + + handshakeStartTime_ = std::chrono::steady_clock::now(); + // Make end time at least >= start time. + handshakeEndTime_ = handshakeStartTime_; + sslState_ = STATE_ACCEPTING; handshakeCallback_ = callback; @@ -593,7 +580,7 @@ void AsyncSSLSocket::setServerName(std::string serverName) noexcept { void AsyncSSLSocket::timeoutExpired() noexcept { if (state_ == StateEnum::ESTABLISHED && (sslState_ == STATE_CACHE_LOOKUP || - sslState_ == STATE_RSA_ASYNC_PENDING)) { + sslState_ == STATE_ASYNC_PENDING)) { sslState_ = STATE_ERROR; // We are expecting a callback in restartSSLAccept. The cache lookup // and rsa-call necessarily have pointers to this ssl socket, so delay @@ -620,23 +607,27 @@ AsyncSSLSocket* AsyncSSLSocket::getFromSSL(const SSL *ssl) { getSSLExDataIndex())); } -void AsyncSSLSocket::failHandshake(const char* fn, - const AsyncSocketException& ex) { +void AsyncSSLSocket::failHandshake(const char* /* fn */, + const AsyncSocketException& ex) { startFail(); - if (handshakeTimeout_.isScheduled()) { handshakeTimeout_.cancelTimeout(); } + invokeHandshakeErr(ex); + finishFail(); +} + +void AsyncSSLSocket::invokeHandshakeErr(const AsyncSocketException& ex) { + handshakeEndTime_ = std::chrono::steady_clock::now(); if (handshakeCallback_ != nullptr) { HandshakeCB* callback = handshakeCallback_; handshakeCallback_ = nullptr; callback->handshakeErr(this, ex); } - - finishFail(); } void AsyncSSLSocket::invokeHandshakeCB() { + handshakeEndTime_ = std::chrono::steady_clock::now(); if (handshakeTimeout_.isScheduled()) { handshakeTimeout_.cancelTimeout(); } @@ -647,6 +638,19 @@ void AsyncSSLSocket::invokeHandshakeCB() { } } +void AsyncSSLSocket::cacheLocalPeerAddr() { + SocketAddress address; + try { + getLocalAddress(&address); + getPeerAddress(&address); + } catch (const std::system_error& e) { + // The handle can be still valid while the connection is already closed. + if (e.code() != std::error_code(ENOTCONN, std::system_category())) { + throw; + } + } +} + void AsyncSSLSocket::connect(ConnectCallback* callback, const folly::SocketAddress& address, int timeout, @@ -677,11 +681,30 @@ void AsyncSSLSocket::applyVerificationOptions(SSL * ssl) { } } +bool AsyncSSLSocket::setupSSLBio() { + auto wb = BIO_new(&sslWriteBioMethod); + + if (!wb) { + return false; + } + + BIO_set_app_data(wb, this); + BIO_set_fd(wb, fd_, BIO_NOCLOSE); + SSL_set_bio(ssl_, wb, wb); + return true; +} + void AsyncSSLSocket::sslConn(HandshakeCB* callback, uint64_t timeout, const SSLContext::SSLVerifyPeerEnum& verifyPeer) { DestructorGuard dg(this); assert(eventBase_->isInEventBaseThread()); + // Cache local and remote socket addresses to keep them available + // after socket file descriptor is closed. + if (cacheAddrOnFailure_ && -1 != getFd()) { + cacheLocalPeerAddr(); + } + verifyPeer_ = verifyPeer; // Make sure we're in the uninitialized state @@ -691,6 +714,10 @@ void AsyncSSLSocket::sslConn(HandshakeCB* callback, uint64_t timeout, return invalidState(callback); } + handshakeStartTime_ = std::chrono::steady_clock::now(); + // Make end time at least >= start time. + handshakeEndTime_ = handshakeStartTime_; + sslState_ = STATE_CONNECTING; handshakeCallback_ = callback; @@ -705,9 +732,15 @@ void AsyncSSLSocket::sslConn(HandshakeCB* callback, uint64_t timeout, return failHandshake(__func__, ex); } + if (!setupSSLBio()) { + sslState_ = STATE_ERROR; + AsyncSocketException ex( + AsyncSocketException::INTERNAL_ERROR, "error creating SSL bio"); + return failHandshake(__func__, ex); + } + applyVerificationOptions(ssl_); - SSL_set_fd(ssl_, fd_); if (sslSession_ != nullptr) { SSL_set_session(ssl_, sslSession_); SSL_SESSION_free(sslSession_); @@ -736,6 +769,10 @@ SSL_SESSION *AsyncSSLSocket::getSSLSession() { return sslSession_; } +const SSL* AsyncSSLSocket::getSSL() const { + return ssl_; +} + void AsyncSSLSocket::setSSLSession(SSL_SESSION *session, bool takeOwnership) { sslSession_ = session; if (!takeOwnership && session != nullptr) { @@ -744,23 +781,39 @@ void AsyncSSLSocket::setSSLSession(SSL_SESSION *session, bool takeOwnership) { } } -void AsyncSSLSocket::getSelectedNextProtocol(const unsigned char** protoName, - unsigned* protoLen) const { - if (!getSelectedNextProtocolNoThrow(protoName, protoLen)) { +void AsyncSSLSocket::getSelectedNextProtocol( + const unsigned char** protoName, + unsigned* protoLen, + SSLContext::NextProtocolType* protoType) const { + if (!getSelectedNextProtocolNoThrow(protoName, protoLen, protoType)) { throw AsyncSocketException(AsyncSocketException::NOT_SUPPORTED, "NPN not supported"); } } bool AsyncSSLSocket::getSelectedNextProtocolNoThrow( - const unsigned char** protoName, - unsigned* protoLen) const { + const unsigned char** protoName, + unsigned* protoLen, + SSLContext::NextProtocolType* protoType) const { *protoName = nullptr; *protoLen = 0; +#if OPENSSL_VERSION_NUMBER >= 0x1000200fL && !defined(OPENSSL_NO_TLSEXT) + SSL_get0_alpn_selected(ssl_, protoName, protoLen); + if (*protoLen > 0) { + if (protoType) { + *protoType = SSLContext::NextProtocolType::ALPN; + } + return true; + } +#endif #ifdef OPENSSL_NPN_NEGOTIATED SSL_get0_next_proto_negotiated(ssl_, protoName, protoLen); + if (protoType) { + *protoType = SSLContext::NextProtocolType::NPN; + } return true; #else + (void)protoType; return false; #endif } @@ -776,28 +829,44 @@ const char *AsyncSSLSocket::getNegotiatedCipherName() const { return (ssl_ != nullptr) ? SSL_get_cipher_name(ssl_) : nullptr; } +/* static */ +const char* AsyncSSLSocket::getSSLServerNameFromSSL(SSL* ssl) { + if (ssl == nullptr) { + return nullptr; + } +#ifdef SSL_CTRL_SET_TLSEXT_SERVERNAME_CB + return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name); +#else + return nullptr; +#endif +} + const char *AsyncSSLSocket::getSSLServerName() const { #ifdef SSL_CTRL_SET_TLSEXT_SERVERNAME_CB - return (ssl_ != nullptr) ? SSL_get_servername(ssl_, TLSEXT_NAMETYPE_host_name) - : nullptr; + return getSSLServerNameFromSSL(ssl_); #else throw AsyncSocketException(AsyncSocketException::NOT_SUPPORTED, - "SNI not supported"); + "SNI not supported"); #endif } const char *AsyncSSLSocket::getSSLServerNameNoThrow() const { - try { - return getSSLServerName(); - } catch (AsyncSocketException& ex) { - return nullptr; - } + return getSSLServerNameFromSSL(ssl_); } int AsyncSSLSocket::getSSLVersion() const { return (ssl_ != nullptr) ? SSL_version(ssl_) : 0; } +const char *AsyncSSLSocket::getSSLCertSigAlgName() const { + X509 *cert = (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr; + if (cert) { + int nid = OBJ_obj2nid(cert->sig_alg->algorithm); + return OBJ_nid2ln(nid); + } + return nullptr; +} + int AsyncSSLSocket::getSSLCertSize() const { int certSize = 0; X509 *cert = (ssl_ != nullptr) ? SSL_get_certificate(ssl_) : nullptr; @@ -809,8 +878,11 @@ int AsyncSSLSocket::getSSLCertSize() const { return certSize; } -bool AsyncSSLSocket::willBlock(int ret, int *errorOut) noexcept { - int error = *errorOut = SSL_get_error(ssl_, ret); +bool AsyncSSLSocket::willBlock(int ret, + int* sslErrorOut, + unsigned long* errErrorOut) noexcept { + *errErrorOut = 0; + int error = *sslErrorOut = SSL_get_error(ssl_, ret); if (error == SSL_ERROR_WANT_READ) { // Register for read event if not already. updateEventRegistration(EventHandler::READ, EventHandler::WRITE); @@ -839,12 +911,18 @@ bool AsyncSSLSocket::willBlock(int ret, int *errorOut) noexcept { // The timeout (if set) keeps running here return true; #endif + } else if (0 #ifdef SSL_ERROR_WANT_RSA_ASYNC_PENDING - } else if (error == SSL_ERROR_WANT_RSA_ASYNC_PENDING) { + || error == SSL_ERROR_WANT_RSA_ASYNC_PENDING +#endif +#ifdef SSL_ERROR_WANT_ECDSA_ASYNC_PENDING + || error == SSL_ERROR_WANT_ECDSA_ASYNC_PENDING +#endif + ) { // Our custom openssl function has kicked off an async request to do - // modular exponentiation. When that call returns, a callback will + // rsa/ecdsa private key operation. When that call returns, a callback will // be invoked that will re-call handleAccept. - sslState_ = STATE_RSA_ASYNC_PENDING; + sslState_ = STATE_ASYNC_PENDING; // Unregister for all events while blocked here updateEventRegistration( @@ -854,11 +932,8 @@ bool AsyncSSLSocket::willBlock(int ret, int *errorOut) noexcept { // The timeout (if set) keeps running here return true; -#endif } else { - // SSL_ERROR_ZERO_RETURN is processed here so we can get some detail - // in the log - long lastError = ERR_get_error(); + unsigned long lastError = *errErrorOut = ERR_get_error(); VLOG(6) << "AsyncSSLSocket(fd=" << fd_ << ", " << "state=" << state_ << ", " << "sslState=" << sslState_ << ", " @@ -870,17 +945,6 @@ bool AsyncSSLSocket::willBlock(int ret, int *errorOut) noexcept { << "written: " << BIO_number_written(SSL_get_wbio(ssl_)) << ", " << "func: " << ERR_func_error_string(lastError) << ", " << "reason: " << ERR_reason_error_string(lastError); - if (error != SSL_ERROR_SYSCALL) { - if (error == SSL_ERROR_SSL) { - *errorOut = lastError; - } - if ((unsigned long)lastError < 0x8000) { - errno = ENOSYS; - } else { - errno = lastError; - } - } - ERR_clear_error(); return false; } } @@ -903,7 +967,7 @@ AsyncSSLSocket::restartSSLAccept() DestructorGuard dg(this); assert( sslState_ == STATE_CACHE_LOOKUP || - sslState_ == STATE_RSA_ASYNC_PENDING || + sslState_ == STATE_ASYNC_PENDING || sslState_ == STATE_ERROR || sslState_ == STATE_CLOSED ); @@ -943,26 +1007,34 @@ AsyncSSLSocket::handleAccept() noexcept { << ", fd=" << fd_ << "): " << e.what(); return failHandshake(__func__, ex); } - SSL_set_fd(ssl_, fd_); + + if (!setupSSLBio()) { + sslState_ = STATE_ERROR; + AsyncSocketException ex( + AsyncSocketException::INTERNAL_ERROR, "error creating write bio"); + return failHandshake(__func__, ex); + } + SSL_set_ex_data(ssl_, getSSLExDataIndex(), this); applyVerificationOptions(ssl_); } if (server_ && parseClientHello_) { - SSL_set_msg_callback_arg(ssl_, this); SSL_set_msg_callback(ssl_, &AsyncSSLSocket::clientHelloParsingCallback); + SSL_set_msg_callback_arg(ssl_, this); } - errno = 0; int ret = SSL_accept(ssl_); if (ret <= 0) { - int error; - if (willBlock(ret, &error)) { + int sslError; + unsigned long errError; + int errnoCopy = errno; + if (willBlock(ret, &sslError, &errError)) { return; } else { sslState_ = STATE_ERROR; - SSLException ex(error, errno); + SSLException ex(sslError, errError, ret, errnoCopy); return failHandshake(__func__, ex); } } @@ -1012,19 +1084,21 @@ AsyncSSLSocket::handleConnect() noexcept { return AsyncSocket::handleConnect(); } - assert(state_ == StateEnum::ESTABLISHED && - sslState_ == STATE_CONNECTING); + assert( + (state_ == StateEnum::FAST_OPEN || state_ == StateEnum::ESTABLISHED) && + sslState_ == STATE_CONNECTING); assert(ssl_); - errno = 0; int ret = SSL_connect(ssl_); if (ret <= 0) { - int error; - if (willBlock(ret, &error)) { + int sslError; + unsigned long errError; + int errnoCopy = errno; + if (willBlock(ret, &sslError, &errError)) { return; } else { sslState_ = STATE_ERROR; - SSLException ex(error, errno); + SSLException ex(sslError, errError, ret, errnoCopy); return failHandshake(__func__, ex); } } @@ -1036,7 +1110,8 @@ AsyncSSLSocket::handleConnect() noexcept { // STATE_CONNECTING. sslState_ = STATE_ESTABLISHED; - VLOG(3) << "AsyncSSLSocket %p: fd %d successfully connected; " + VLOG(3) << "AsyncSSLSocket " << this << ": " + << "fd " << fd_ << " successfully connected; " << "state=" << int(state_) << ", sslState=" << sslState_ << ", events=" << eventFlags_; @@ -1064,10 +1139,21 @@ AsyncSSLSocket::handleConnect() noexcept { AsyncSocket::handleInitialReadWrite(); } +void AsyncSSLSocket::invokeConnectSuccess() { + if (sslState_ == SSLStateEnum::STATE_CONNECTING) { + // If we failed TFO, we'd fall back to trying to connect the socket, + // when we succeed we should handle the writes that caused us to start + // TFO. + handleWrite(); + } + AsyncSocket::invokeConnectSuccess(); +} + void AsyncSSLSocket::setReadCB(ReadCallback *callback) { #ifdef SSL_MODE_MOVE_BUFFER_OWNERSHIP // turn on the buffer movable in openssl - if (!isBufferMovable_ && callback != nullptr && callback->isBufferMovable()) { + if (bufferMovableEnabled_ && ssl_ != nullptr && !isBufferMovable_ && + callback != nullptr && callback->isBufferMovable()) { SSL_set_mode(ssl_, SSL_get_mode(ssl_) | SSL_MODE_MOVE_BUFFER_OWNERSHIP); isBufferMovable_ = true; } @@ -1076,6 +1162,10 @@ void AsyncSSLSocket::setReadCB(ReadCallback *callback) { AsyncSocket::setReadCB(callback); } +void AsyncSSLSocket::setBufferMovableEnabled(bool enabled) { + bufferMovableEnabled_ = enabled; +} + void AsyncSSLSocket::prepareReadBuffer(void** buf, size_t* buflen) noexcept { CHECK(readCallback_); if (isBufferMovable_) { @@ -1112,16 +1202,15 @@ AsyncSSLSocket::handleRead() noexcept { AsyncSocket::handleRead(); } -ssize_t +AsyncSocket::ReadResult AsyncSSLSocket::performRead(void** buf, size_t* buflen, size_t* offset) { - VLOG(4) << "AsyncSSLSocket::performRead() this=" << this - << ", buf=" << *buf << ", buflen=" << *buflen; + VLOG(4) << "AsyncSSLSocket::performRead() this=" << this << ", buf=" << *buf + << ", buflen=" << *buflen; if (sslState_ == STATE_UNENCRYPTED) { return AsyncSocket::performRead(buf, buflen, offset); } - errno = 0; ssize_t bytes = 0; if (!isBufferMovable_) { bytes = SSL_read(ssl_, *buf, *buflen); @@ -1136,34 +1225,34 @@ AsyncSSLSocket::performRead(void** buf, size_t* buflen, size_t* offset) { LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_) << ", sslstate=" << sslState_ << ", events=" << eventFlags_ << "): client intitiated SSL renegotiation not permitted"; - // We pack our own SSLerr here with a dummy function - errno = ERR_PACK(ERR_LIB_USER, TASYNCSSLSOCKET_F_PERFORM_READ, - SSL_CLIENT_RENEGOTIATION_ATTEMPT); - ERR_clear_error(); - return READ_ERROR; + return ReadResult( + READ_ERROR, + folly::make_unique(SSLError::CLIENT_RENEGOTIATION)); } if (bytes <= 0) { int error = SSL_get_error(ssl_, bytes); if (error == SSL_ERROR_WANT_READ) { // The caller will register for read event if not already. - return READ_BLOCKING; + if (errno == EWOULDBLOCK || errno == EAGAIN) { + return ReadResult(READ_BLOCKING); + } else { + return ReadResult(READ_ERROR); + } } else if (error == SSL_ERROR_WANT_WRITE) { // TODO: Even though we are attempting to read data, SSL_read() may // need to write data if renegotiation is being performed. We currently // don't support this and just fail the read. LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_) << ", sslState=" << sslState_ << ", events=" << eventFlags_ - << "): unsupported SSL renegotiation during read", - errno = ERR_PACK(ERR_LIB_USER, TASYNCSSLSOCKET_F_PERFORM_READ, - SSL_INVALID_RENEGOTIATION); - ERR_clear_error(); - return READ_ERROR; + << "): unsupported SSL renegotiation during read"; + return ReadResult( + READ_ERROR, + folly::make_unique(SSLError::INVALID_RENEGOTIATION)); } else { - // TODO: Fix this code so that it can return a proper error message - // to the callback, rather than relying on AsyncSocket code which - // can't handle SSL errors. - long lastError = ERR_get_error(); - + if (zero_return(error, bytes)) { + return ReadResult(bytes); + } + long errError = ERR_get_error(); VLOG(6) << "AsyncSSLSocket(fd=" << fd_ << ", " << "state=" << state_ << ", " << "sslState=" << sslState_ << ", " @@ -1171,24 +1260,15 @@ AsyncSSLSocket::performRead(void** buf, size_t* buflen, size_t* offset) { << "bytes: " << bytes << ", " << "error: " << error << ", " << "errno: " << errno << ", " - << "func: " << ERR_func_error_string(lastError) << ", " - << "reason: " << ERR_reason_error_string(lastError); - ERR_clear_error(); - if (zero_return(error, bytes)) { - return bytes; - } - if (error != SSL_ERROR_SYSCALL) { - if ((unsigned long)lastError < 0x8000) { - errno = ENOSYS; - } else { - errno = lastError; - } - } - return READ_ERROR; + << "func: " << ERR_func_error_string(errError) << ", " + << "reason: " << ERR_reason_error_string(errError); + return ReadResult( + READ_ERROR, + folly::make_unique(error, errError, bytes, errno)); } } else { appBytesReceived_ += bytes; - return bytes; + return ReadResult(bytes); } } @@ -1216,49 +1296,40 @@ void AsyncSSLSocket::handleWrite() noexcept { AsyncSocket::handleWrite(); } -int AsyncSSLSocket::interpretSSLError(int rc, int error) { +AsyncSocket::WriteResult AsyncSSLSocket::interpretSSLError(int rc, int error) { if (error == SSL_ERROR_WANT_READ) { - // TODO: Even though we are attempting to write data, SSL_write() may + // Even though we are attempting to write data, SSL_write() may // need to read data if renegotiation is being performed. We currently // don't support this and just fail the write. LOG(ERROR) << "AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_) << ", sslState=" << sslState_ << ", events=" << eventFlags_ - << "): " << "unsupported SSL renegotiation during write", - errno = ERR_PACK(ERR_LIB_USER, TASYNCSSLSOCKET_F_PERFORM_WRITE, - SSL_INVALID_RENEGOTIATION); - ERR_clear_error(); - return -1; + << "): " + << "unsupported SSL renegotiation during write"; + return WriteResult( + WRITE_ERROR, + folly::make_unique(SSLError::INVALID_RENEGOTIATION)); } else { - // TODO: Fix this code so that it can return a proper error message - // to the callback, rather than relying on AsyncSocket code which - // can't handle SSL errors. - long lastError = ERR_get_error(); + if (zero_return(error, rc)) { + return WriteResult(0); + } + auto errError = ERR_get_error(); VLOG(3) << "ERROR: AsyncSSLSocket(fd=" << fd_ << ", state=" << int(state_) << ", sslState=" << sslState_ << ", events=" << eventFlags_ << "): " << "SSL error: " << error << ", errno: " << errno - << ", func: " << ERR_func_error_string(lastError) - << ", reason: " << ERR_reason_error_string(lastError); - if (error != SSL_ERROR_SYSCALL) { - if ((unsigned long)lastError < 0x8000) { - errno = ENOSYS; - } else { - errno = lastError; - } - } - ERR_clear_error(); - if (!zero_return(error, rc)) { - return -1; - } else { - return 0; - } + << ", func: " << ERR_func_error_string(errError) + << ", reason: " << ERR_reason_error_string(errError); + return WriteResult( + WRITE_ERROR, + folly::make_unique(error, errError, rc, errno)); } } -ssize_t AsyncSSLSocket::performWrite(const iovec* vec, - uint32_t count, - WriteFlags flags, - uint32_t* countWritten, - uint32_t* partialWritten) { +AsyncSocket::WriteResult AsyncSSLSocket::performWrite( + const iovec* vec, + uint32_t count, + WriteFlags flags, + uint32_t* countWritten, + uint32_t* partialWritten) { if (sslState_ == STATE_UNENCRYPTED) { return AsyncSocket::performWrite( vec, count, flags, countWritten, partialWritten); @@ -1269,23 +1340,13 @@ ssize_t AsyncSSLSocket::performWrite(const iovec* vec, << ", events=" << eventFlags_ << "): " << "TODO: AsyncSSLSocket currently does not support calling " << "write() before the handshake has fully completed"; - errno = ERR_PACK(ERR_LIB_USER, TASYNCSSLSOCKET_F_PERFORM_WRITE, - SSL_EARLY_WRITE); - return -1; + return WriteResult( + WRITE_ERROR, folly::make_unique(SSLError::EARLY_WRITE)); } bool cork = isSet(flags, WriteFlags::CORK); CorkGuard guard(fd_, count > 1, cork, &corked_); -#if 0 -//#ifdef SSL_MODE_WRITE_IOVEC - if (ssl_->expand == nullptr && - ssl_->compress == nullptr && - (ssl_->mode & SSL_MODE_WRITE_IOVEC)) { - return performWriteIovec(vec, count, flags, countWritten, partialWritten); - } -#endif - // Declare a buffer used to hold small write requests. It could point to a // memory block either on stack or on heap. If it is on heap, we release it // manually when scope exits @@ -1314,7 +1375,6 @@ ssize_t AsyncSSLSocket::performWrite(const iovec* vec, buf = ((const char*)v->iov_base) + offset; ssize_t bytes; - errno = 0; uint32_t buffersStolen = 0; if ((len < minWriteSize_) && ((i + 1) < count)) { // Combine this buffer with part or all of the next buffers in @@ -1368,11 +1428,11 @@ ssize_t AsyncSSLSocket::performWrite(const iovec* vec, if (error == SSL_ERROR_WANT_WRITE) { // The caller will register for write event if not already. *partialWritten = offset; - return totalWritten; + return WriteResult(totalWritten); } - int rc = interpretSSLError(bytes, error); - if (rc < 0) { - return rc; + auto writeResult = interpretSSLError(bytes, error); + if (writeResult.writeReturn < 0) { + return writeResult; } // else fall through to below to correctly record totalWritten } @@ -1394,54 +1454,16 @@ ssize_t AsyncSSLSocket::performWrite(const iovec* vec, v = &(vec[++i]); } *partialWritten = bytes; - return totalWritten; + return WriteResult(totalWritten); } } - return totalWritten; + return WriteResult(totalWritten); } -#if 0 -//#ifdef SSL_MODE_WRITE_IOVEC -ssize_t AsyncSSLSocket::performWriteIovec(const iovec* vec, - uint32_t count, - WriteFlags flags, - uint32_t* countWritten, - uint32_t* partialWritten) { - size_t tot = 0; - for (uint32_t j = 0; j < count; j++) { - tot += vec[j].iov_len; - } - - ssize_t totalWritten = SSL_write_iovec(ssl_, vec, count); - - *countWritten = 0; - *partialWritten = 0; - if (totalWritten <= 0) { - return interpretSSLError(totalWritten, SSL_get_error(ssl_, totalWritten)); - } else { - ssize_t bytes = totalWritten, i = 0; - while (i < count && bytes >= (ssize_t)vec[i].iov_len) { - // we managed to write all of this buf - bytes -= vec[i].iov_len; - (*countWritten)++; - i++; - } - *partialWritten = bytes; - - VLOG(4) << "SSL_write_iovec() writes " << tot - << ", returns " << totalWritten << " bytes" - << ", max_send_fragment=" << ssl_->max_send_fragment - << ", count=" << count << ", countWritten=" << *countWritten; - - return totalWritten; - } -} -#endif - int AsyncSSLSocket::eorAwareSSLWrite(SSL *ssl, const void *buf, int n, bool eor) { - if (eor && SSL_get_wbio(ssl)->method == &eorAwareBioMethod) { + if (eor && trackEor_) { if (appEorByteNo_) { // cannot track for more than one app byte EOR CHECK(appEorByteNo_ == appBytesWritten_ + n); @@ -1471,47 +1493,58 @@ int AsyncSSLSocket::eorAwareSSLWrite(SSL *ssl, const void *buf, int n, return n; } -void -AsyncSSLSocket::sslInfoCallback(const SSL *ssl, int where, int ret) { +void AsyncSSLSocket::sslInfoCallback(const SSL* ssl, int where, int ret) { AsyncSSLSocket *sslSocket = AsyncSSLSocket::getFromSSL(ssl); if (sslSocket->handshakeComplete_ && (where & SSL_CB_HANDSHAKE_START)) { sslSocket->renegotiateAttempted_ = true; } + if (where & SSL_CB_READ_ALERT) { + const char* type = SSL_alert_type_string(ret); + if (type) { + const char* desc = SSL_alert_desc_string(ret); + sslSocket->alertsReceived_.emplace_back( + *type, StringPiece(desc, std::strlen(desc))); + } + } } -int AsyncSSLSocket::eorAwareBioWrite(BIO *b, const char *in, int inl) { - int ret; +int AsyncSSLSocket::bioWrite(BIO* b, const char* in, int inl) { struct msghdr msg; struct iovec iov; int flags = 0; - AsyncSSLSocket *tsslSock; + AsyncSSLSocket* tsslSock; - iov.iov_base = const_cast(in); + iov.iov_base = const_cast(in); iov.iov_len = inl; memset(&msg, 0, sizeof(msg)); msg.msg_iov = &iov; msg.msg_iovlen = 1; - tsslSock = - reinterpret_cast(BIO_get_app_data(b)); - if (tsslSock && - tsslSock->minEorRawByteNo_ && + auto appData = BIO_get_app_data(b); + CHECK(appData); + + tsslSock = reinterpret_cast(appData); + CHECK(tsslSock); + + if (tsslSock->trackEor_ && tsslSock->minEorRawByteNo_ && tsslSock->minEorRawByteNo_ <= BIO_number_written(b) + inl) { flags = MSG_EOR; } - errno = 0; - ret = sendmsg(b->num, &msg, flags); + auto result = + tsslSock->sendSocketMessage(BIO_get_fd(b, nullptr), &msg, flags); BIO_clear_retry_flags(b); - if (ret <= 0) { - if (BIO_sock_should_retry(ret)) + if (!result.exception && result.writeReturn <= 0) { + if (BIO_sock_should_retry(result.writeReturn)) { BIO_set_retry_write(b); + } } - return(ret); + return result.writeReturn; } -int AsyncSSLSocket::sslVerifyCallback(int preverifyOk, - X509_STORE_CTX* x509Ctx) { +int AsyncSSLSocket::sslVerifyCallback( + int preverifyOk, + X509_STORE_CTX* x509Ctx) { SSL* ssl = (SSL*) X509_STORE_CTX_get_ex_data( x509Ctx, SSL_get_ex_data_X509_STORE_CTX_idx()); AsyncSSLSocket* self = AsyncSSLSocket::getFromSSL(ssl); @@ -1525,7 +1558,7 @@ int AsyncSSLSocket::sslVerifyCallback(int preverifyOk, void AsyncSSLSocket::enableClientHelloParsing() { parseClientHello_ = true; - clientHelloInfo_.reset(new ClientHelloInfo()); + clientHelloInfo_.reset(new ssl::ClientHelloInfo()); } void AsyncSSLSocket::resetClientHelloParsing(SSL *ssl) { @@ -1534,17 +1567,19 @@ void AsyncSSLSocket::resetClientHelloParsing(SSL *ssl) { clientHelloInfo_->clientHelloBuf_.clear(); } -void -AsyncSSLSocket::clientHelloParsingCallback(int written, int version, - int contentType, const void *buf, size_t len, SSL *ssl, void *arg) -{ +void AsyncSSLSocket::clientHelloParsingCallback(int written, + int /* version */, + int contentType, + const void* buf, + size_t len, + SSL* ssl, + void* arg) { AsyncSSLSocket *sock = static_cast(arg); if (written != 0) { sock->resetClientHelloParsing(ssl); return; } if (contentType != SSL3_RT_HANDSHAKE) { - sock->resetClientHelloParsing(ssl); return; } if (len == 0) { @@ -1600,22 +1635,22 @@ AsyncSSLSocket::clientHelloParsingCallback(int written, int version, if (cursor.totalLength() > 0) { uint16_t extensionsLength = cursor.readBE(); while (extensionsLength) { - TLSExtension extensionType = static_cast( - cursor.readBE()); + ssl::TLSExtension extensionType = + static_cast(cursor.readBE()); sock->clientHelloInfo_-> clientHelloExtensions_.push_back(extensionType); extensionsLength -= 2; uint16_t extensionDataLength = cursor.readBE(); extensionsLength -= 2; - if (extensionType == TLSExtension::SIGNATURE_ALGORITHMS) { + if (extensionType == ssl::TLSExtension::SIGNATURE_ALGORITHMS) { cursor.skip(2); extensionDataLength -= 2; while (extensionDataLength) { - HashAlgorithm hashAlg = static_cast( - cursor.readBE()); - SignatureAlgorithm sigAlg = static_cast( - cursor.readBE()); + ssl::HashAlgorithm hashAlg = + static_cast(cursor.readBE()); + ssl::SignatureAlgorithm sigAlg = + static_cast(cursor.readBE()); extensionDataLength -= 2; sock->clientHelloInfo_-> clientHelloSigAlgs_.emplace_back(hashAlg, sigAlg);