Implements new, more robust design for communicating between SSLConnectJobs.

net/socket/socket_test_util.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "net/socket/socket_test_util.h"
 
 #include <algorithm>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/bind.h"
 #include "base/bind_helpers.h"
+#include "base/callback_helpers.h"
 #include "base/compiler_specific.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "base/time/time.h"
 #include "net/base/address_family.h"
 #include "net/base/address_list.h"
 #include "net/base/auth.h"
 #include "net/base/load_timing_info.h"
 #include "net/http/http_network_session.h"
 #include "net/http/http_request_headers.h"
@@ skipping 247 matching lines @@
 }
 
 SSLSocketDataProvider::SSLSocketDataProvider(IoMode mode, int result)
     : connect(mode, result),
       next_proto_status(SSLClientSocket::kNextProtoUnsupported),
       was_npn_negotiated(false),
       protocol_negotiated(kProtoUnknown),
       client_cert_sent(false),
       cert_request_info(NULL),
       channel_id_sent(false),
-      connection_status(0) {
+      connection_status(0),
+      should_block_in_connect(false),
+      blocked_in_connect(false),
+      is_in_session_cache(false) {
   SSLConnectionStatusSetVersion(SSL_CONNECTION_VERSION_TLS1_2,
                                 &connection_status);
   // Set to TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305
   SSLConnectionStatusSetCipherSuite(0xcc14, &connection_status);
 }
 
 SSLSocketDataProvider::~SSLSocketDataProvider() {
 }
 
 void SSLSocketDataProvider::SetNextProto(NextProto proto) {
@@ skipping 401 matching lines @@
       new MockTCPClientSocket(addresses, net_log, data_provider));
   data_provider->set_socket(socket.get());
   return socket.PassAs<StreamSocket>();
 }
 
 scoped_ptr<SSLClientSocket> MockClientSocketFactory::CreateSSLClientSocket(
     scoped_ptr<ClientSocketHandle> transport_socket,
     const HostPortPair& host_and_port,
     const SSLConfig& ssl_config,
     const SSLClientSocketContext& context) {
-  return scoped_ptr<SSLClientSocket>(
+  scoped_ptr<MockSSLClientSocket> socket(
       new MockSSLClientSocket(transport_socket.Pass(),
-                              host_and_port, ssl_config,
+                              host_and_port,
+                              ssl_config,
                               mock_ssl_data_.GetNext()));
+  ssl_client_sockets_.push_back(socket.get());
+  return socket.PassAs<SSLClientSocket>();
 }
 
 void MockClientSocketFactory::ClearSSLSessionCache() {
 }
 
 const char MockClientSocket::kTlsUnique[] = "MOCK_TLSUNIQ";
 
 MockClientSocket::MockClientSocket(const BoundNetLog& net_log)
     : connected_(false),
       net_log_(net_log),
@@ skipping 35 matching lines @@
   bool rv = ParseIPLiteralToNumber("192.0.2.33", &ip);
   CHECK(rv);
   *address = IPEndPoint(ip, 123);
   return OK;
 }
 
 const BoundNetLog& MockClientSocket::NetLog() const {
   return net_log_;
 }
 
+bool MockClientSocket::InSessionCache() const {
+  return true;
+}
+
+void MockClientSocket::SetHandshakeSuccessCallback(const base::Closure& cb) {
+  NOTIMPLEMENTED();
+}
+
+void MockClientSocket::SetHandshakeFailureCallback(const base::Closure& cb) {
+  NOTIMPLEMENTED();
+}
+
 void MockClientSocket::GetSSLCertRequestInfo(
   SSLCertRequestInfo* cert_request_info) {
 }
 
 int MockClientSocket::ExportKeyingMaterial(const base::StringPiece& label,
                                            bool has_context,
                                            const base::StringPiece& context,
                                            unsigned char* out,
                                            unsigned int outlen) {
   memset(out, 'A', outlen);
   return OK;
 }
 
 int MockClientSocket::GetTLSUniqueChannelBinding(std::string* out) {
   out->assign(MockClientSocket::kTlsUnique);
   return OK;
 }
 
 ServerBoundCertService* MockClientSocket::GetServerBoundCertService() const {
   NOTREACHED();
   return NULL;
 }
 
+CompletionCallback MockClientSocket::connect_callback() {
+  return connect_callback_;
+}
+
 SSLClientSocket::NextProtoStatus
 MockClientSocket::GetNextProto(std::string* proto, std::string* server_protos) {
   proto->clear();
   server_protos->clear();
   return SSLClientSocket::kNextProtoUnsupported;
 }
 
 scoped_refptr<X509Certificate>
 MockClientSocket::GetUnverifiedServerCertificateChain() const {
   NOTREACHED();
@@ skipping 513 matching lines @@
     ssl_client_socket->connected_ = true;
   callback.Run(rv);
 }
 
 MockSSLClientSocket::MockSSLClientSocket(
     scoped_ptr<ClientSocketHandle> transport_socket,
     const HostPortPair& host_port_pair,
     const SSLConfig& ssl_config,
     SSLSocketDataProvider* data)
     : MockClientSocket(
-         // Have to use the right BoundNetLog for LoadTimingInfo regression
-         // tests.
-         transport_socket->socket()->NetLog()),
+          // Have to use the right BoundNetLog for LoadTimingInfo regression
+          // tests.
+          transport_socket->socket()->NetLog()),
       transport_(transport_socket.Pass()),
       data_(data),
       is_npn_state_set_(false),
       new_npn_value_(false),
       is_protocol_negotiated_set_(false),
       protocol_negotiated_(kProtoUnknown) {
   DCHECK(data_);
   peer_addr_ = data->connect.peer_addr;
 }
 
 MockSSLClientSocket::~MockSSLClientSocket() {
   Disconnect();
 }
 
 int MockSSLClientSocket::Read(IOBuffer* buf, int buf_len,
                               const CompletionCallback& callback) {
   return transport_->socket()->Read(buf, buf_len, callback);
 }
 
 int MockSSLClientSocket::Write(IOBuffer* buf, int buf_len,
                                const CompletionCallback& callback) {
   return transport_->socket()->Write(buf, buf_len, callback);
 }
 
 int MockSSLClientSocket::Connect(const CompletionCallback& callback) {
-  int rv = transport_->socket()->Connect(
-      base::Bind(&ConnectCallback, base::Unretained(this), callback));
+  int rv;
+  if (!data_->blocked_in_connect) {

[Ryan Sleevi, 2014/07/18 22:01:16]

When would this ever be true in a well-behaved client?

That is, Connect() can only be called before Disconnect(), and can be called
afterwards.

This sort of goes back to my "don't stick state in data providers"

+    rv = transport_->socket()->Connect(
+        base::Bind(&ConnectCallback, base::Unretained(this), callback));
+  } else {
+    rv = OK;
+  }
+
   if (rv == OK) {
-    if (data_->connect.result == OK)
+    if (data_->connect.result == OK) {
       connected_ = true;
-    if (data_->connect.mode == ASYNC) {
-      RunCallbackAsync(callback, data_->connect.result);
-      return ERR_IO_PENDING;
+      if (data_->should_block_in_connect) {
+        connect_callback_ = callback;
+        data_->should_block_in_connect = false;
+        data_->blocked_in_connect = true;
+        return ERR_IO_PENDING;

[Ryan Sleevi, 2014/07/18 22:01:16]

This doesn't look right to me.

We don't need to expose connect_callback_ to callers, we should instead have a
method on the MockSSLClientSocket that says something like
RestartPausedConnect(), which will then run connect_callback_ itself (and thus
doesn't need to be on the base mock socket, and can exist only in the
MockSSLClientSocket, and as a private member)

[mshelley, 2014/07/21 23:00:07]

Done.

+      } else if (!success_callback_.is_null()) {
+        // The presence of |success_callback_| indicates that SSL Connect Job
+        // Waiting is enabled.
+        base::ResetAndReturn(&success_callback_).Run();
+      }
+      if (data_->connect.mode == ASYNC) {
+        RunCallbackAsync(callback, data_->connect.result);
+        return ERR_IO_PENDING;
+      }
+    } else if (!error_callback_.is_null()) {
+      if (data_->should_block_in_connect) {
+        connect_callback_ = callback;
+        data_->should_block_in_connect = false;
+        data_->blocked_in_connect = true;
+        return ERR_IO_PENDING;
+      }
+      base::ResetAndReturn(&error_callback_).Run();

[Ryan Sleevi, 2014/07/18 22:01:16]

We may want to restructure this all into a more defined state machine

DoConnect()
DoConnectComplete()

etc.

The transitions are as follows:
transport_->Connect() succeeds -> enters into the "CONNECT" state
- Shouldn't block on connect
  - Immediately transitions to the ConnectComplete stage
  - ConnectComplete handles running error_callback_ vs connect_callback
- Should block on Connect
  - Sets next stage to ConnectComplete, returns ERR_IO_PENDING, is up to the
caller to call like RestartConnect
  - RestartConnect restarts the handshake loop
  - ConnectComplete again handles errors vs connect
- ConnectComplete also is responsible for RunCallbackAsync

[mshelley, 2014/07/21 23:00:07]

Done.

     }
     return data_->connect.result;
   }
   return rv;
 }
 
 void MockSSLClientSocket::Disconnect() {
   MockClientSocket::Disconnect();
   if (transport_->socket() != NULL)
     transport_->socket()->Disconnect();
 }
 
 bool MockSSLClientSocket::IsConnected() const {
-  return transport_->socket()->IsConnected();
+  return transport_->socket()->IsConnected() && connected_;
 }
 
 bool MockSSLClientSocket::WasEverUsed() const {
   return transport_->socket()->WasEverUsed();
 }
 
 bool MockSSLClientSocket::UsingTCPFastOpen() const {
   return transport_->socket()->UsingTCPFastOpen();
 }
 
@@ skipping 15 matching lines @@
   DCHECK(cert_request_info);
   if (data_->cert_request_info) {
     cert_request_info->host_and_port =
         data_->cert_request_info->host_and_port;
     cert_request_info->client_certs = data_->cert_request_info->client_certs;
   } else {
     cert_request_info->Reset();
   }
 }
 
+bool MockSSLClientSocket::InSessionCache() const {
+  return data_->is_in_session_cache;
+}
+
+void MockSSLClientSocket::SetHandshakeSuccessCallback(const base::Closure& cb) {
+  success_callback_ = cb;
+}
+
+void MockSSLClientSocket::SetHandshakeFailureCallback(const base::Closure& cb) {
+  error_callback_ = cb;
+}
+
 SSLClientSocket::NextProtoStatus MockSSLClientSocket::GetNextProto(
     std::string* proto, std::string* server_protos) {
   *proto = data_->next_proto;
   *server_protos = data_->server_protos;
   return data_->next_proto_status;
 }
 
 bool MockSSLClientSocket::set_was_npn_negotiated(bool negotiated) {
   is_npn_state_set_ = true;
   return new_npn_value_ = negotiated;
@@ skipping 494 matching lines @@
 
 const char kSOCKS5OkRequest[] =
     { 0x05, 0x01, 0x00, 0x03, 0x04, 'h', 'o', 's', 't', 0x00, 0x50 };
 const int kSOCKS5OkRequestLength = arraysize(kSOCKS5OkRequest);
 
 const char kSOCKS5OkResponse[] =
     { 0x05, 0x00, 0x00, 0x01, 127, 0, 0, 1, 0x00, 0x50 };
 const int kSOCKS5OkResponseLength = arraysize(kSOCKS5OkResponse);
 
 }  // namespace net