Implements new, more robust design for communicating between SSLConnectJobs.

net/socket/ssl_client_socket.h

 // 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.
 
 #ifndef NET_SOCKET_SSL_CLIENT_SOCKET_H_
 #define NET_SOCKET_SSL_CLIENT_SOCKET_H_
 
 #include <string>
 
 #include "base/gtest_prod_util.h"
 #include "net/base/completion_callback.h"
 #include "net/base/load_flags.h"
 #include "net/base/net_errors.h"
 #include "net/socket/ssl_socket.h"
 #include "net/socket/stream_socket.h"
 
 namespace net {
 
 class CertVerifier;
 class CTVerifier;
+class HostPortPair;
 class ServerBoundCertService;
 class SSLCertRequestInfo;
 struct SSLConfig;
 class SSLInfo;
 class TransportSecurityState;
 class X509Certificate;
 
 // This struct groups together several fields which are used by various
 // classes related to SSLClientSocket.
 struct SSLClientSocketContext {
@@ skipping 43 matching lines @@
     kNextProtoUnsupported = 0,  // The server doesn't support NPN.
     kNextProtoNegotiated = 1,   // We agreed on a protocol.
     kNextProtoNoOverlap = 2,    // No protocols in common. We requested
                                 // the first protocol in our list.
   };
 
   // StreamSocket:
   virtual bool WasNpnNegotiated() const OVERRIDE;
   virtual NextProto GetNegotiatedProtocol() const OVERRIDE;
 
+  // Formats a unique key for the SSL session cache. This method
+  // is necessary so that all classes create cache keys in a consistent
+  // manner.
+  // TODO(mshelley) This method will be deleted in an upcoming CL when
+  // it will no longer be necessary to generate a cache key outside of
+  // an SSLClientSocket.
+  static std::string CreateSessionCacheKey(
+      const HostPortPair& host_and_port,
+      const std::string& ssl_session_cache_shard);
+
+  // Returns true if there is a cache entry in the SSL session cache
+  // for the cache key of the SSL socket.
+  //
+  // The cache key consists of a host and port concatenated with a session
+  // cache shard. These two strings are passed to the constructor of most
+  // subclasses of SSLClientSocket.
+  virtual bool InSessionCache() const = 0;
+
+  // Sets the callback to be run upon the connection's true handshake
+  // completion.
+  // TODO(mshelley) Provide a "result" input parameter to the callback.

[Ryan Sleevi, 2014/07/25 01:36:35]

Comment nit: "true handshake completion" is ambiguous here

// Sets |callback| to be run when the handshake has fully completed.
// For example, in the case of False Start, Connect() will return
// early, before the peer's TLS Finished message has been verified,
// in order to allow the caller to call Write() and send application
// data with the client's Finished message.
// In such situations, |callback| will be invoked sometime after
// Connect() - either during a Write() or Read() call, and before
// invoking the Read() or Write() callback.
// Otherwise, during a traditional TLS connection (i.e. no False
// Start), this will be called right before the Connect() callback
// is called.
//
// Note that it's not valid to mutate this socket during such
// callbacks, including deleting the socket.
//
// TODO(mshelley): Provide additional details about whether or not
// the handshake actually succeeded or not. This can be inferred
// from the result to Connect()/Read()/Write(), but may be useful
// to inform here as well.


Note that other wordings are fine, I was primarily trying to focus on explicitly
spelling out the preconditions and post-conditions. The most useful one here is
a guaranteed ordering about when this callback will be called in relation to the
others (Read/Write/Connect), and what's legal to do on the socket (e.g.
Disconnect())

[mshelley, 2014/07/26 00:58:27]

Done.

+  virtual void SetHandshakeCompletionCallback(
+      const base::Closure& callback) = 0;
+
   // Gets the SSL CertificateRequest info of the socket after Connect failed
   // with ERR_SSL_CLIENT_AUTH_CERT_NEEDED.
   virtual void GetSSLCertRequestInfo(
       SSLCertRequestInfo* cert_request_info) = 0;
 
   // Get the application level protocol that we negotiated with the server.
   // *proto is set to the resulting protocol (n.b. that the string may have
   // embedded NULs).
   //   kNextProtoUnsupported: *proto is cleared.
   //   kNextProtoNegotiated:  *proto is set to the negotiated protocol.
@@ skipping 89 matching lines @@
   bool channel_id_sent_;
   // True if SCTs were received via a TLS extension.
   bool signed_cert_timestamps_received_;
   // True if a stapled OCSP response was received.
   bool stapled_ocsp_response_received_;
 };
 
 }  // namespace net
 
 #endif  // NET_SOCKET_SSL_CLIENT_SOCKET_H_