X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=folly%2Fio%2Fasync%2FAsyncSSLSocket.h;h=e9aca826c379cb788578460c6179f709b827aa6f;hb=5c74326fdc75ccdfc2152c15203625d8588096b6;hp=a95270464378250bf959c057126ecd2697dd573c;hpb=c7087eb7400bc652d3a53e7b92045ccaecce9bc2;p=folly.git diff --git a/folly/io/async/AsyncSSLSocket.h b/folly/io/async/AsyncSSLSocket.h index a9527046..e9aca826 100644 --- a/folly/io/async/AsyncSSLSocket.h +++ b/folly/io/async/AsyncSSLSocket.h @@ -1,5 +1,5 @@ /* - * Copyright 2016 Facebook, Inc. + * Copyright 2017 Facebook, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,7 +16,6 @@ #pragma once -#include #include #include @@ -27,22 +26,17 @@ #include #include #include +#include #include #include #include #include +#include +#include namespace folly { -class SSLException: public folly::AsyncSocketException { - public: - SSLException(int sslError, - unsigned long errError, - int sslOperationReturnValue, - int errno_copy); -}; - /** * A class for performing asynchronous I/O on an SSL connection. * @@ -143,16 +137,18 @@ class AsyncSSLSocket : public virtual AsyncSocket { AsyncSSLSocket* sslSocket_; }; + // Timer for if we fallback from SSL connects to TCP connects + class ConnectionTimeout : public AsyncTimeout { + public: + ConnectionTimeout(AsyncSSLSocket* sslSocket, EventBase* eventBase) + : AsyncTimeout(eventBase), sslSocket_(sslSocket) {} - /** - * These are passed to the application via errno, packed in an SSL err which - * are outside the valid errno range. The values are chosen to be unique - * against values in ssl.h - */ - enum SSLError { - SSL_CLIENT_RENEGOTIATION_ATTEMPT = 900, - SSL_INVALID_RENEGOTIATION = 901, - SSL_EARLY_WRITE = 902 + virtual void timeoutExpired() noexcept override { + sslSocket_->timeoutExpired(); + } + + private: + AsyncSSLSocket* sslSocket_; }; /** @@ -207,7 +203,7 @@ class AsyncSSLSocket : public virtual AsyncSocket { } -#if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT) +#if FOLLY_OPENSSL_HAS_SNI /** * Create a client AsyncSSLSocket with tlsext_servername in * the Client Hello message. @@ -247,7 +243,7 @@ class AsyncSSLSocket : public virtual AsyncSocket { new AsyncSSLSocket(ctx, evb, serverName, deferSecurityNegotiation), Destructor()); } -#endif +#endif // FOLLY_OPENSSL_HAS_SNI /** * TODO: implement support for SSL renegotiation. @@ -276,12 +272,13 @@ class AsyncSSLSocket : public virtual AsyncSocket { virtual std::string getSecurityProtocol() const override { return "TLS"; } - bool isEorTrackingEnabled() const override; virtual void setEorTracking(bool track) override; virtual size_t getRawBytesWritten() const override; virtual size_t getRawBytesReceived() const override; void enableClientHelloParsing(); + void setPreReceivedData(std::unique_ptr data); + /** * Accept an SSL connection on the socket. * @@ -297,9 +294,11 @@ class AsyncSSLSocket : public virtual AsyncSocket { * context by default, can be set explcitly to override the * method in the context */ - virtual void sslAccept(HandshakeCB* callback, uint32_t timeout = 0, + virtual void sslAccept( + HandshakeCB* callback, + std::chrono::milliseconds timeout = std::chrono::milliseconds::zero(), const folly::SSLContext::SSLVerifyPeerEnum& verifyPeer = - folly::SSLContext::SSLVerifyPeerEnum::USE_CTX); + folly::SSLContext::SSLVerifyPeerEnum::USE_CTX); /** * Invoke SSL accept following an asynchronous session cache lookup @@ -337,9 +336,11 @@ class AsyncSSLSocket : public virtual AsyncSocket { * SSL_VERIFY_PEER and invokes * HandshakeCB::handshakeVer(). */ - virtual void sslConn(HandshakeCB *callback, uint64_t timeout = 0, - const folly::SSLContext::SSLVerifyPeerEnum& verifyPeer = - folly::SSLContext::SSLVerifyPeerEnum::USE_CTX); + virtual void sslConn( + HandshakeCB* callback, + std::chrono::milliseconds timeout = std::chrono::milliseconds::zero(), + const folly::SSLContext::SSLVerifyPeerEnum& verifyPeer = + folly::SSLContext::SSLVerifyPeerEnum::USE_CTX); enum SSLStateEnum { STATE_UNINIT, @@ -365,6 +366,11 @@ class AsyncSSLSocket : public virtual AsyncSocket { */ SSL_SESSION *getSSLSession(); + /** + * Get a handle to the SSL struct. + */ + const SSL* getSSL() const; + /** * Set the SSL session to be used during sslConn. AsyncSSLSocket will * hold a reference to the session until it is destroyed or released by the @@ -471,14 +477,21 @@ class AsyncSSLSocket : public virtual AsyncSocket { */ int getSSLCertSize() const; + /** + * Get the certificate used for this SSL connection. May be null + */ + virtual const X509* getSelfCert() const override; + virtual void attachEventBase(EventBase* eventBase) override { AsyncSocket::attachEventBase(eventBase); handshakeTimeout_.attachEventBase(eventBase); + connectionTimeout_.attachEventBase(eventBase); } virtual void detachEventBase() override { AsyncSocket::detachEventBase(); handshakeTimeout_.detachEventBase(); + connectionTimeout_.detachEventBase(); } virtual bool isDetachable() const override { @@ -507,7 +520,7 @@ class AsyncSSLSocket : public virtual AsyncSocket { void detachSSLContext(); #endif -#if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT) +#if FOLLY_OPENSSL_HAS_SNI /** * Switch the SSLContext to continue the SSL handshake. * It can only be used in server mode. @@ -530,7 +543,7 @@ class AsyncSSLSocket : public virtual AsyncSocket { * ClientHello message. */ void setServerName(std::string serverName) noexcept; -#endif +#endif // FOLLY_OPENSSL_HAS_SNI void timeoutExpired() noexcept; @@ -540,120 +553,44 @@ class AsyncSSLSocket : public virtual AsyncSocket { */ void getSSLClientCiphers( std::string& clientCiphers, - bool convertToString = true) const { - std::stringstream ciphersStream; - std::string cipherName; - - if (parseClientHello_ == false - || clientHelloInfo_->clientHelloCipherSuites_.empty()) { - clientCiphers = ""; - return; - } - - for (auto originalCipherCode : clientHelloInfo_->clientHelloCipherSuites_) - { - const SSL_CIPHER* cipher = nullptr; - if (convertToString) { - // OpenSSL expects code as a big endian char array - auto cipherCode = htons(originalCipherCode); - -#if defined(SSL_OP_NO_TLSv1_2) - cipher = - TLSv1_2_method()->get_cipher_by_char((unsigned char*)&cipherCode); -#elif defined(SSL_OP_NO_TLSv1_1) - cipher = - TLSv1_1_method()->get_cipher_by_char((unsigned char*)&cipherCode); -#elif defined(SSL_OP_NO_TLSv1) - cipher = - TLSv1_method()->get_cipher_by_char((unsigned char*)&cipherCode); -#else - cipher = - SSLv3_method()->get_cipher_by_char((unsigned char*)&cipherCode); -#endif - } - - if (cipher == nullptr) { - ciphersStream << std::setfill('0') << std::setw(4) << std::hex - << originalCipherCode << ":"; - } else { - ciphersStream << SSL_CIPHER_get_name(cipher) << ":"; - } - } - - clientCiphers = ciphersStream.str(); - clientCiphers.erase(clientCiphers.end() - 1); - } + bool convertToString = true) const; /** * Get the list of compression methods sent by the client in TLS Hello. */ - std::string getSSLClientComprMethods() const { - if (!parseClientHello_) { - return ""; - } - return folly::join(":", clientHelloInfo_->clientHelloCompressionMethods_); - } + std::string getSSLClientComprMethods() const; /** * Get the list of TLS extensions sent by the client in the TLS Hello. */ - std::string getSSLClientExts() const { - if (!parseClientHello_) { - return ""; - } - return folly::join(":", clientHelloInfo_->clientHelloExtensions_); - } + std::string getSSLClientExts() const; - std::string getSSLClientSigAlgs() const { - if (!parseClientHello_) { - return ""; - } + std::string getSSLClientSigAlgs() const; - std::string sigAlgs; - sigAlgs.reserve(clientHelloInfo_->clientHelloSigAlgs_.size() * 4); - for (size_t i = 0; i < clientHelloInfo_->clientHelloSigAlgs_.size(); i++) { - if (i) { - sigAlgs.push_back(':'); - } - sigAlgs.append(folly::to( - clientHelloInfo_->clientHelloSigAlgs_[i].first)); - sigAlgs.push_back(','); - sigAlgs.append(folly::to( - clientHelloInfo_->clientHelloSigAlgs_[i].second)); - } + /** + * Get the list of versions in the supported versions extension (used to + * negotiate TLS 1.3). + */ + std::string getSSLClientSupportedVersions() const; - return sigAlgs; - } + std::string getSSLAlertsReceived() const; /** * Get the list of shared ciphers between the server and the client. * Works well for only SSLv2, not so good for SSLv3 or TLSv1. */ - void getSSLSharedCiphers(std::string& sharedCiphers) const { - char ciphersBuffer[1024]; - ciphersBuffer[0] = '\0'; - SSL_get_shared_ciphers(ssl_, ciphersBuffer, sizeof(ciphersBuffer) - 1); - sharedCiphers = ciphersBuffer; - } + void getSSLSharedCiphers(std::string& sharedCiphers) const; /** * Get the list of ciphers supported by the server in the server's * preference order. */ - void getSSLServerCiphers(std::string& serverCiphers) const { - serverCiphers = SSL_get_cipher_list(ssl_, 0); - int i = 1; - const char *cipher; - while ((cipher = SSL_get_cipher_list(ssl_, i)) != nullptr) { - serverCiphers.append(":"); - serverCiphers.append(cipher); - i++; - } - } + void getSSLServerCiphers(std::string& serverCiphers) const; static int getSSLExDataIndex(); static AsyncSSLSocket* getFromSSL(const SSL *ssl); - static int eorAwareBioWrite(BIO *b, const char *in, int inl); + static int bioWrite(BIO* b, const char* in, int inl); + static int bioRead(BIO* b, char* out, int outl); void resetClientHelloParsing(SSL *ssl); static void clientHelloParsingCallback(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg); @@ -715,9 +652,32 @@ class AsyncSSLSocket : public virtual AsyncSocket { serviceIdentity_ = std::move(serviceIdentity); } + void setCertCacheHit(bool hit) { + certCacheHit_ = hit; + } + + bool getCertCacheHit() const { + return certCacheHit_; + } + + bool sessionResumptionAttempted() const { + return sessionResumptionAttempted_; + } + + /** + * Clears the ERR stack before invoking SSL methods. + * This is useful if unrelated code that runs in the same thread + * does not properly handle SSL error conditions, in which case + * it could cause SSL_* methods to fail with incorrect error codes. + */ + void setClearOpenSSLErrors(bool clearErr) { + clearOpenSSLErrors_ = clearErr; + } + private: void init(); + void clearOpenSSLErrors(); protected: @@ -732,7 +692,7 @@ class AsyncSSLSocket : public virtual AsyncSocket { // Inherit event notification methods from AsyncSocket except // the following. - void prepareReadBuffer(void** buf, size_t* buflen) noexcept override; + void prepareReadBuffer(void** buf, size_t* buflen) override; void handleRead() noexcept override; void handleWrite() noexcept override; void handleAccept() noexcept; @@ -747,11 +707,14 @@ class AsyncSSLSocket : public virtual AsyncSocket { // AsyncSocket calls this at the wrong time for SSL void handleInitialReadWrite() noexcept override {} - int interpretSSLError(int rc, int error); - ssize_t performRead(void** buf, size_t* buflen, size_t* offset) override; - ssize_t performWrite(const iovec* vec, uint32_t count, WriteFlags flags, - uint32_t* countWritten, uint32_t* partialWritten) - override; + WriteResult interpretSSLError(int rc, int error); + ReadResult performRead(void** buf, size_t* buflen, size_t* offset) override; + WriteResult performWrite( + const iovec* vec, + uint32_t count, + WriteFlags flags, + uint32_t* countWritten, + uint32_t* partialWritten) override; ssize_t performWriteIovec(const iovec* vec, uint32_t count, WriteFlags flags, uint32_t* countWritten, @@ -759,6 +722,7 @@ class AsyncSSLSocket : public virtual AsyncSocket { // This virtual wrapper around SSL_write exists solely for testing/mockability virtual int sslWriteImpl(SSL *ssl, const void *buf, int n) { + clearOpenSSLErrors(); return SSL_write(ssl, buf, n); } @@ -772,6 +736,13 @@ class AsyncSSLSocket : public virtual AsyncSocket { */ void applyVerificationOptions(SSL * ssl); + /** + * Sets up SSL with a custom write bio which intercepts all writes. + * + * @return true, if succeeds and false if there is an error creating the bio. + */ + bool setupSSLBio(); + /** * A SSL_write wrapper that understand EOR * @@ -789,12 +760,18 @@ class AsyncSSLSocket : public virtual AsyncSocket { void invokeHandshakeErr(const AsyncSocketException& ex); void invokeHandshakeCB(); + void invokeConnectErr(const AsyncSocketException& ex) override; + void invokeConnectSuccess() override; + void scheduleConnectTimeout() override; + void cacheLocalPeerAddr(); + void startSSLConnect(); + static void sslInfoCallback(const SSL *ssl, int type, int val); - // Whether we've applied the TCP_CORK option to the socket - bool corked_{false}; + // Whether the current write to the socket should use MSG_MORE. + bool corkCurrentWrite_{false}; // SSL related members. bool server_{false}; // Used to prevent client-initiated renegotiation. Note that AsyncSSLSocket @@ -810,6 +787,7 @@ class AsyncSSLSocket : public virtual AsyncSocket { SSL* ssl_{nullptr}; SSL_SESSION *sslSession_{nullptr}; HandshakeTimeout handshakeTimeout_; + ConnectionTimeout connectionTimeout_; // whether the SSL session was resumed using session ID or not bool sessionIDResumed_{false}; @@ -824,7 +802,7 @@ class AsyncSSLSocket : public virtual AsyncSocket { // When openssl is about to sendmsg() across the minEorRawBytesNo_, // it will pass MSG_EOR to sendmsg(). size_t minEorRawByteNo_{0}; -#if OPENSSL_VERSION_NUMBER >= 0x1000105fL && !defined(OPENSSL_NO_TLSEXT) +#if FOLLY_OPENSSL_HAS_SNI std::shared_ptr handshakeCtx_; std::string tlsextHostname_; #endif @@ -841,11 +819,20 @@ class AsyncSSLSocket : public virtual AsyncSocket { bool parseClientHello_{false}; bool cacheAddrOnFailure_{false}; bool bufferMovableEnabled_{false}; + bool certCacheHit_{false}; std::unique_ptr clientHelloInfo_; + std::vector> alertsReceived_; // Time taken to complete the ssl handshake. std::chrono::steady_clock::time_point handshakeStartTime_; std::chrono::steady_clock::time_point handshakeEndTime_; + std::chrono::milliseconds handshakeConnectTimeout_{0}; + bool sessionResumptionAttempted_{false}; + + std::unique_ptr preReceivedData_; + // Whether or not to clear the err stack before invocation of another + // SSL method + bool clearOpenSSLErrors_{false}; }; } // namespace