SSL Connect Job Waiting

net/socket/ssl_client_socket_pool.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/ssl_client_socket_pool.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/metrics/field_trial.h"
 #include "base/metrics/histogram.h"
 #include "base/metrics/sparse_histogram.h"
 #include "base/values.h"
 #include "net/base/host_port_pair.h"
 #include "net/base/net_errors.h"
 #include "net/http/http_proxy_client_socket.h"
 #include "net/http/http_proxy_client_socket_pool.h"
 #include "net/socket/client_socket_factory.h"
 #include "net/socket/client_socket_handle.h"
 #include "net/socket/socks_client_socket_pool.h"
 #include "net/socket/ssl_client_socket.h"
+#include "net/socket/ssl_client_socket_openssl.h"

[wtc, 2014/06/13 22:47:24]

This needs to be put inside #if defined(USE_OPENSSL).

Chromium style recommends listing the conditional #include's last, after the
cross-platform #include's, so add the following after line 25:

#if defined(USE_OPENSSL)
#include "net/socket/ssl_client_socket_openssl.h"
#endif

See the Chromium Coding Style page:
http://www.chromium.org/developers/coding-style#TOC-Platform-specific-code

[mshelley1, 2014/06/16 19:02:50]

Done.

 #include "net/socket/transport_client_socket_pool.h"
 #include "net/ssl/ssl_cert_request_info.h"
 #include "net/ssl/ssl_connection_status_flags.h"
 #include "net/ssl/ssl_info.h"
 
 namespace net {
 
 SSLSocketParams::SSLSocketParams(
     const scoped_refptr<TransportSocketParams>& direct_params,
     const scoped_refptr<SOCKSSocketParams>& socks_proxy_params,
@@ skipping 70 matching lines @@
                              RequestPriority priority,
                              const scoped_refptr<SSLSocketParams>& params,
                              const base::TimeDelta& timeout_duration,
                              TransportClientSocketPool* transport_pool,
                              SOCKSClientSocketPool* socks_pool,
                              HttpProxyClientSocketPool* http_proxy_pool,
                              ClientSocketFactory* client_socket_factory,
                              HostResolver* host_resolver,
                              const SSLClientSocketContext& context,
                              Delegate* delegate,
-                             NetLog* net_log)
+                             NetLog* net_log,
+                             PendingJobList* pending)
     : ConnectJob(group_name,
                  timeout_duration,
                  priority,
                  delegate,
                  BoundNetLog::Make(net_log, NetLog::SOURCE_CONNECT_JOB)),
       params_(params),
       transport_pool_(transport_pool),
       socks_pool_(socks_pool),
       http_proxy_pool_(http_proxy_pool),
       client_socket_factory_(client_socket_factory),
       host_resolver_(host_resolver),
       context_(context.cert_verifier,
                context.server_bound_cert_service,
                context.transport_security_state,
                context.cert_transparency_verifier,
                (params->privacy_mode() == PRIVACY_MODE_ENABLED
                     ? "pm/" + context.ssl_session_cache_shard
                     : context.ssl_session_cache_shard)),
-      callback_(base::Bind(&SSLConnectJob::OnIOComplete,
-                           base::Unretained(this))) {}
+      callback_(

[Ryan Sleevi, 2014/06/13 23:24:22]

nit: We typically call this io_callback_

[mshelley1, 2014/06/16 19:02:50]

Done.

+          base::Bind(&SSLConnectJob::OnIOComplete, base::Unretained(this))),
+      pending_(pending) {
+}
 
 SSLConnectJob::~SSLConnectJob() {}
 
+bool SSLConnectJob::enable_job_waiting_ = false;
+
 LoadState SSLConnectJob::GetLoadState() const {
   switch (next_state_) {
     case STATE_TUNNEL_CONNECT_COMPLETE:
       if (transport_socket_handle_->socket())
         return LOAD_STATE_ESTABLISHING_PROXY_TUNNEL;
       // else, fall through.
     case STATE_TRANSPORT_CONNECT:
     case STATE_TRANSPORT_CONNECT_COMPLETE:
     case STATE_SOCKS_CONNECT:
     case STATE_SOCKS_CONNECT_COMPLETE:
     case STATE_TUNNEL_CONNECT:
       return transport_socket_handle_->GetLoadState();
+    case STATE_CHECK_FOR_RESUME:
+    case STATE_WAIT:
     case STATE_SSL_CONNECT:
     case STATE_SSL_CONNECT_COMPLETE:
       return LOAD_STATE_SSL_HANDSHAKE;
     default:
       NOTREACHED();
       return LOAD_STATE_IDLE;
   }
 }
 
 void SSLConnectJob::GetAdditionalErrorState(ClientSocketHandle* handle) {
   // Headers in |error_response_info_| indicate a proxy tunnel setup
   // problem. See DoTunnelConnectComplete.
   if (error_response_info_.headers.get()) {
     handle->set_pending_http_proxy_connection(
         transport_socket_handle_.release());
   }
   handle->set_ssl_error_response_info(error_response_info_);
   if (!connect_timing_.ssl_start.is_null())
     handle->set_is_ssl_error(true);
 }
 
+void SSLConnectJob::EnableJobWaiting(bool enable) {
+  enable_job_waiting_ = enable;
+}
+
 void SSLConnectJob::OnIOComplete(int result) {
   int rv = DoLoop(result);
   if (rv != ERR_IO_PENDING)
     NotifyDelegateOfCompletion(rv);  // Deletes |this|.
 }
 
 int SSLConnectJob::DoLoop(int result) {
   DCHECK_NE(next_state_, STATE_NONE);
 
   int rv = result;
@@ skipping 15 matching lines @@
       case STATE_SOCKS_CONNECT_COMPLETE:
         rv = DoSOCKSConnectComplete(rv);
         break;
       case STATE_TUNNEL_CONNECT:
         DCHECK_EQ(OK, rv);
         rv = DoTunnelConnect();
         break;
       case STATE_TUNNEL_CONNECT_COMPLETE:
         rv = DoTunnelConnectComplete(rv);
         break;
+      case STATE_CHECK_FOR_RESUME:
+        rv = DoCheckForResume();
+        break;
+      case STATE_WAIT:
+        next_state_ = STATE_CHECK_FOR_RESUME;
+        rv = ERR_IO_PENDING;

[Ryan Sleevi, 2014/06/13 23:24:22]

First Reaction: This is weird to have it as an state transition, since it only
serves to set the next transition.

Normally, you would have DoCheckForResume() set this state, and return
ERR_IO_PENDING there.

[mshelley1, 2014/06/16 19:02:50]

Done.

+        break;
       case STATE_SSL_CONNECT:
         DCHECK_EQ(OK, rv);
         rv = DoSSLConnect();
         break;
       case STATE_SSL_CONNECT_COMPLETE:
         rv = DoSSLConnectComplete(rv);
         break;
       default:
         NOTREACHED() << "bad state";
         rv = ERR_FAILED;
@@ skipping 13 matching lines @@
       params_->GetDirectConnectionParams();
   return transport_socket_handle_->Init(group_name(),
                                         direct_params,
                                         priority(),
                                         callback_,
                                         transport_pool_,
                                         net_log());
 }
 
 int SSLConnectJob::DoTransportConnectComplete(int result) {
-  if (result == OK)
-    next_state_ = STATE_SSL_CONNECT;
+  if (result == OK) {

[Ryan Sleevi, 2014/06/13 23:24:22]

We try to handle errors before success cases;

if (result != OK)
  return result;

if (enable_job_waiting_)
  next_state_ = STATE_CHECK_FOR_RESUME;
else
  next_state_ = STATE_SSL_CONNECT;

return result;

[mshelley1, 2014/06/16 19:02:49]

Done.

+    if (enable_job_waiting_)
+      next_state_ = STATE_CHECK_FOR_RESUME;
+    else
+      next_state_ = STATE_SSL_CONNECT;
+  }
 
   return result;
 }
 
 int SSLConnectJob::DoSOCKSConnect() {
   DCHECK(socks_pool_);
   next_state_ = STATE_SOCKS_CONNECT_COMPLETE;
   transport_socket_handle_.reset(new ClientSocketHandle());
   scoped_refptr<SOCKSSocketParams> socks_proxy_params =
       params_->GetSocksProxyConnectionParams();
   return transport_socket_handle_->Init(group_name(),
                                         socks_proxy_params,
                                         priority(),
                                         callback_,
                                         socks_pool_,
                                         net_log());
 }
 
 int SSLConnectJob::DoSOCKSConnectComplete(int result) {
-  if (result == OK)
-    next_state_ = STATE_SSL_CONNECT;
+  if (result == OK) {
+    if (enable_job_waiting_)
+      next_state_ = STATE_CHECK_FOR_RESUME;
+    else
+      next_state_ = STATE_SSL_CONNECT;
+  }

[Ryan Sleevi, 2014/06/13 23:24:22]

Ditto ordering

[mshelley1, 2014/06/16 19:02:50]

Done.

 
   return result;
 }
 
 int SSLConnectJob::DoTunnelConnect() {
   DCHECK(http_proxy_pool_);
   next_state_ = STATE_TUNNEL_CONNECT_COMPLETE;
 
   transport_socket_handle_.reset(new ClientSocketHandle());
   scoped_refptr<HttpProxySocketParams> http_proxy_params =
@@ skipping 14 matching lines @@
     error_response_info_ = transport_socket_handle_->ssl_error_response_info();
   } else if (result == ERR_PROXY_AUTH_REQUESTED ||
              result == ERR_HTTPS_PROXY_TUNNEL_RESPONSE) {
     StreamSocket* socket = transport_socket_handle_->socket();
     HttpProxyClientSocket* tunnel_socket =
         static_cast<HttpProxyClientSocket*>(socket);
     error_response_info_ = *tunnel_socket->GetConnectResponseInfo();
   }
   if (result < 0)
     return result;
-
-  next_state_ = STATE_SSL_CONNECT;
+  if (enable_job_waiting_)
+    next_state_ = STATE_CHECK_FOR_RESUME;
+  else
+    next_state_ = STATE_SSL_CONNECT;

[Ryan Sleevi, 2014/06/13 23:24:22]

STYLE: This is now the third time this conditional has been duplicated.

It suggests there should be a private helper function, to ensure state
transitions are the same (eg: it's the only one that should ever set state =
STATE_SSL_CONNECT, presumably)

next_state_ = GetNextConnectState() ?

[mshelley1, 2014/06/16 19:02:50]

Done.

   return result;
 }
 
+int SSLConnectJob::DoCheckForResume() {
+  // If the group is in the cache, continue.
+  if (SSLClientSocketOpenSSL::InSessionCache(GetSessionCacheKey())) {
+    next_state_ = STATE_SSL_CONNECT;
+    return OK;
+  }
+
+  // If there are pending jobs, wait.
+  if (!pending_->empty()) {
+    pending_->push_back(this);
+    next_state_ = STATE_WAIT;
+    return OK;

[Ryan Sleevi, 2014/06/13 23:24:22]

This should be ERR_IO_PENDING

[mshelley1, 2014/06/16 19:02:50]

Done.

+  }
+
+  // If there are no pending jobs, continue
+  pending_->push_back(this);
+  next_state_ = STATE_SSL_CONNECT;
+  return OK;
+}
+
 int SSLConnectJob::DoSSLConnect() {
   next_state_ = STATE_SSL_CONNECT_COMPLETE;
   // Reset the timeout to just the time allowed for the SSL handshake.
   ResetTimer(base::TimeDelta::FromSeconds(kSSLHandshakeTimeoutInSeconds));
 
   // If the handle has a fresh socket, get its connect start and DNS times.
   // This should always be the case.
   const LoadTimingInfo::ConnectTiming& socket_connect_timing =
       transport_socket_handle_->connect_timing();
   if (!transport_socket_handle_->is_reused() &&
@@ skipping 96 matching lines @@
                                  100);
     } else if (ssl_info.handshake_type == SSLInfo::HANDSHAKE_FULL) {
       UMA_HISTOGRAM_CUSTOM_TIMES("Net.SSL_Connection_Latency_Full_Handshake",
                                  connect_duration,
                                  base::TimeDelta::FromMilliseconds(1),
                                  base::TimeDelta::FromMinutes(1),
                                  100);
     }
 
     const std::string& host = params_->host_and_port().host();
-    bool is_google = host == "google.com" ||
-                     (host.size() > 11 &&
-                      host.rfind(".google.com") == host.size() - 11);
+    bool is_google =
+        host == "google.com" ||
+        (host.size() > 11 && host.rfind(".google.com") == host.size() - 11);
     if (is_google) {
       UMA_HISTOGRAM_CUSTOM_TIMES("Net.SSL_Connection_Latency_Google2",
                                  connect_duration,
                                  base::TimeDelta::FromMilliseconds(1),
                                  base::TimeDelta::FromMinutes(1),
                                  100);
       if (ssl_info.handshake_type == SSLInfo::HANDSHAKE_RESUME) {
         UMA_HISTOGRAM_CUSTOM_TIMES("Net.SSL_Connection_Latency_Google_"
                                        "Resume_Handshake",
                                    connect_duration,
@@ skipping 12 matching lines @@
   }
 
   if (result == OK || IsCertificateError(result)) {
     SetSocket(ssl_socket_.PassAs<StreamSocket>());
   } else if (result == ERR_SSL_CLIENT_AUTH_CERT_NEEDED) {
     error_response_info_.cert_request_info = new SSLCertRequestInfo;
     ssl_socket_->GetSSLCertRequestInfo(
         error_response_info_.cert_request_info.get());
   }
 
+  if (enable_job_waiting_) {

[Ryan Sleevi, 2014/06/13 23:24:22]

This should probably all be moved into a helper function; it's a discrete set of
functionality tied to this job_waiting_, so centralizing it (and documenting
what it does) is a good structural cleanup.

[mshelley1, 2014/06/16 19:02:50]

Done.

+    // If there is a pending list
+    if (!pending_->empty()) {
+      // The first element of the vector will always be the leading job.
+      PendingJobList::iterator i = pending_->begin();
+      // If the connection was successful, tell all pending jobs to proceed.
+      if (result == OK) {
+        for (PendingJobList::iterator job = i + 1; job != pending_->end();
+             ++job) {
+          (*job)->DoSSL();
+        }
+        // pending_->erase(i);
+        pending_->clear();
+      }
+      // If the connection failed, tell only one job to proceed as the new
+      // leader.
+      else if (i + 1 != pending_->end()) {
+        (*(i + 1))->DoSSL();
+        pending_->erase(i);
+      }
+      // If there are no more jobs and the leader failed, delete the entry.
+      else
+        pending_->erase(i);
+    }
+  }
+
   return result;
 }
 
+void SSLConnectJob::DoSSL() {
+  next_state_ = STATE_SSL_CONNECT;
+  OnIOComplete(OK);
+}
+
+std::string SSLConnectJob::GetSessionCacheKey() {
+  return params_->host_and_port().ToString() + "/" +
+         context_.ssl_session_cache_shard;
+}
+
 SSLConnectJob::State SSLConnectJob::GetInitialState(
     SSLSocketParams::ConnectionType connection_type) {
   switch (connection_type) {
     case SSLSocketParams::DIRECT:
       return STATE_TRANSPORT_CONNECT;
     case SSLSocketParams::HTTP_PROXY:
       return STATE_TUNNEL_CONNECT;
     case SSLSocketParams::SOCKS_PROXY:
       return STATE_SOCKS_CONNECT;
   }
@@ skipping 13 matching lines @@
     ClientSocketFactory* client_socket_factory,
     HostResolver* host_resolver,
     const SSLClientSocketContext& context,
     NetLog* net_log)
     : transport_pool_(transport_pool),
       socks_pool_(socks_pool),
       http_proxy_pool_(http_proxy_pool),
       client_socket_factory_(client_socket_factory),
       host_resolver_(host_resolver),
       context_(context),
-      net_log_(net_log) {
+      net_log_(net_log),
+      pending_(new PendingJobMap()) {
   base::TimeDelta max_transport_timeout = base::TimeDelta();
   base::TimeDelta pool_timeout;
   if (transport_pool_)
     max_transport_timeout = transport_pool_->ConnectionTimeout();
   if (socks_pool_) {
     pool_timeout = socks_pool_->ConnectionTimeout();
     if (pool_timeout > max_transport_timeout)
       max_transport_timeout = pool_timeout;
   }
   if (http_proxy_pool_) {
@@ skipping 17 matching lines @@
     const std::string& ssl_session_cache_shard,
     ClientSocketFactory* client_socket_factory,
     TransportClientSocketPool* transport_pool,
     SOCKSClientSocketPool* socks_pool,
     HttpProxyClientSocketPool* http_proxy_pool,
     SSLConfigService* ssl_config_service,
     NetLog* net_log)
     : transport_pool_(transport_pool),
       socks_pool_(socks_pool),
       http_proxy_pool_(http_proxy_pool),
-      base_(this, max_sockets, max_sockets_per_group, histograms,
+      base_(this,
+            max_sockets,
+            max_sockets_per_group,
+            histograms,
             ClientSocketPool::unused_idle_socket_timeout(),
             ClientSocketPool::used_idle_socket_timeout(),
-            new SSLConnectJobFactory(transport_pool,
-                                     socks_pool,
-                                     http_proxy_pool,
-                                     client_socket_factory,
-                                     host_resolver,
-                                     SSLClientSocketContext(
-                                         cert_verifier,
-                                         server_bound_cert_service,
-                                         transport_security_state,
-                                         cert_transparency_verifier,
-                                         ssl_session_cache_shard),
-                                     net_log)),
+            new SSLConnectJobFactory(
+                transport_pool,
+                socks_pool,
+                http_proxy_pool,
+                client_socket_factory,
+                host_resolver,
+                SSLClientSocketContext(cert_verifier,
+                                       server_bound_cert_service,
+                                       transport_security_state,
+                                       cert_transparency_verifier,
+                                       ssl_session_cache_shard),
+                net_log)),
       ssl_config_service_(ssl_config_service) {
   if (ssl_config_service_.get())
     ssl_config_service_->AddObserver(this);
   if (transport_pool_)
     base_.AddLowerLayeredPool(transport_pool_);
   if (socks_pool_)
     base_.AddLowerLayeredPool(socks_pool_);
   if (http_proxy_pool_)
     base_.AddLowerLayeredPool(http_proxy_pool_);
 }
 
 SSLClientSocketPool::~SSLClientSocketPool() {
   if (ssl_config_service_.get())
     ssl_config_service_->RemoveObserver(this);
 }
 
 scoped_ptr<ConnectJob>
 SSLClientSocketPool::SSLConnectJobFactory::NewConnectJob(
     const std::string& group_name,
     const PoolBase::Request& request,
     ConnectJob::Delegate* delegate) const {
-  return scoped_ptr<ConnectJob>(
-      new SSLConnectJob(group_name, request.priority(), request.params(),
-                        ConnectionTimeout(), transport_pool_, socks_pool_,
-                        http_proxy_pool_, client_socket_factory_,
-                        host_resolver_, context_, delegate, net_log_));
+  PendingJobMap::iterator p = pending_->find(group_name);
+  SSLConnectJob::PendingJobList* pending_job_list;
+  if (p == pending_->end()) {
+    (*pending_)[group_name] = new SSLConnectJob::PendingJobList();
+    pending_job_list = (*pending_)[group_name];

[Ryan Sleevi, 2014/06/13 23:24:22]

This is actually somewhat inefficient; it does two scans of the map's
red-black-tree

You can do

std::pair<PendingJobMap::iterator, bool> it =
pending_->insert(PendingJobMap::value_type(group_name, new
SSLConnectJob::PendingJobList()));
pending_job_list = it->first.second;


If the PendingJobMap::value_type constructor doesn't work, std::pair<const
std::string, SSLConnectJob::PendingJobList*>(...)
or

PendingJobMap::value_type value(group_name, new
SSLConnectJob::PendingJobList());
... it = pending_->insert(value);

[mshelley1, 2014/06/16 19:02:50]

Done.

+  } else
+    pending_job_list = p->second;

[Ryan Sleevi, 2014/06/13 23:24:22]

If one portion of an if statement includes braces, the other conditions should
too.

[mshelley1, 2014/06/16 19:02:50]

Done.

+  return scoped_ptr<ConnectJob>(new SSLConnectJob(group_name,
+                                                  request.priority(),
+                                                  request.params(),
+                                                  ConnectionTimeout(),
+                                                  transport_pool_,
+                                                  socks_pool_,
+                                                  http_proxy_pool_,
+                                                  client_socket_factory_,
+                                                  host_resolver_,
+                                                  context_,
+                                                  delegate,
+                                                  net_log_,
+                                                  pending_job_list));
 }
 
 base::TimeDelta
 SSLClientSocketPool::SSLConnectJobFactory::ConnectionTimeout() const {
   return timeout_;
 }
 
 int SSLClientSocketPool::RequestSocket(const std::string& group_name,
                                        const void* socket_params,
                                        RequestPriority priority,
@@ skipping 103 matching lines @@
   if (base_.CloseOneIdleSocket())
     return true;
   return base_.CloseOneIdleConnectionInHigherLayeredPool();
 }
 
 void SSLClientSocketPool::OnSSLConfigChanged() {
   FlushWithError(ERR_NETWORK_CHANGED);
 }
 
 }  // namespace net