net/socket/ssl_client_socket_nss.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef NET_SOCKET_SSL_CLIENT_SOCKET_NSS_H_
   6 #define NET_SOCKET_SSL_CLIENT_SOCKET_NSS_H_
   7
   8 #include <certt.h>
   9 #include <keyt.h>
  10 #include <nspr.h>
  11 #include <nss.h>
  12
  13 #include <string>
  14 #include <vector>
  15
  16 #include "base/memory/scoped_ptr.h"
  17 #include "base/synchronization/lock.h"
  18 #include "base/threading/platform_thread.h"
  19 #include "base/time/time.h"
  20 #include "base/timer/timer.h"
  21 #include "net/base/completion_callback.h"
  22 #include "net/base/host_port_pair.h"
  23 #include "net/base/net_export.h"
  24 #include "net/base/net_log.h"
  25 #include "net/base/nss_memio.h"
  26 #include "net/cert/cert_verify_result.h"
  27 #include "net/cert/ct_verify_result.h"
  28 #include "net/cert/x509_certificate.h"
  29 #include "net/socket/ssl_client_socket.h"
  30 #include "net/ssl/server_bound_cert_service.h"
  31 #include "net/ssl/ssl_config_service.h"
  32
  33 namespace base {
  34 class SequencedTaskRunner;
  35 }
  36
  37 namespace net {
  38
  39 class BoundNetLog;
  40 class CertVerifier;
  41 class CTVerifier;
  42 class ClientSocketHandle;
  43 class ServerBoundCertService;
  44 class SingleRequestCertVerifier;
  45 class TransportSecurityState;
  46 class X509Certificate;
  47
  48 // An SSL client socket implemented with Mozilla NSS.
  49 class SSLClientSocketNSS : public SSLClientSocket {
  50  public:
  51   // Takes ownership of the |transport_socket|, which must already be connected.
  52   // The hostname specified in |host_and_port| will be compared with the name(s)
  53   // in the server's certificate during the SSL handshake.  If SSL client
  54   // authentication is requested, the host_and_port field of SSLCertRequestInfo
  55   // will be populated with |host_and_port|.  |ssl_config| specifies
  56   // the SSL settings.
  57   //
  58   // Because calls to NSS may block, such as due to needing to access slow
  59   // hardware or needing to synchronously unlock protected tokens, calls to
  60   // NSS may optionally be run on a dedicated thread. If synchronous/blocking
  61   // behaviour is desired, for performance or compatibility, the current task
  62   // runner should be supplied instead.
  63   SSLClientSocketNSS(base::SequencedTaskRunner* nss_task_runner,
  64                      scoped_ptr<ClientSocketHandle> transport_socket,
  65                      const HostPortPair& host_and_port,
  66                      const SSLConfig& ssl_config,
  67                      const SSLClientSocketContext& context);
  68   virtual ~SSLClientSocketNSS();
  69
  70   // SSLClientSocket implementation.
  71   virtual void GetSSLCertRequestInfo(
  72       SSLCertRequestInfo* cert_request_info) OVERRIDE;
  73   virtual NextProtoStatus GetNextProto(std::string* proto,
  74                                        std::string* server_protos) OVERRIDE;
  75
  76   // SSLSocket implementation.
  77   virtual int ExportKeyingMaterial(const base::StringPiece& label,
  78                                    bool has_context,
  79                                    const base::StringPiece& context,
  80                                    unsigned char* out,
  81                                    unsigned int outlen) OVERRIDE;
  82   virtual int GetTLSUniqueChannelBinding(std::string* out) OVERRIDE;
  83
  84   // StreamSocket implementation.
  85   virtual int Connect(const CompletionCallback& callback) OVERRIDE;
  86   virtual void Disconnect() OVERRIDE;
  87   virtual bool IsConnected() const OVERRIDE;
  88   virtual bool IsConnectedAndIdle() const OVERRIDE;
  89   virtual int GetPeerAddress(IPEndPoint* address) const OVERRIDE;
  90   virtual int GetLocalAddress(IPEndPoint* address) const OVERRIDE;
  91   virtual const BoundNetLog& NetLog() const OVERRIDE;
  92   virtual void SetSubresourceSpeculation() OVERRIDE;
  93   virtual void SetOmniboxSpeculation() OVERRIDE;
  94   virtual bool WasEverUsed() const OVERRIDE;
  95   virtual bool UsingTCPFastOpen() const OVERRIDE;
  96   virtual bool GetSSLInfo(SSLInfo* ssl_info) OVERRIDE;
  97
  98   // Socket implementation.
  99   virtual int Read(IOBuffer* buf,
 100                    int buf_len,
 101                    const CompletionCallback& callback) OVERRIDE;
 102   virtual int Write(IOBuffer* buf,
 103                     int buf_len,
 104                     const CompletionCallback& callback) OVERRIDE;
 105   virtual bool SetReceiveBufferSize(int32 size) OVERRIDE;
 106   virtual bool SetSendBufferSize(int32 size) OVERRIDE;
 107   virtual ServerBoundCertService* GetServerBoundCertService() const OVERRIDE;
 108
 109  private:
 110   // Helper class to handle marshalling any NSS interaction to and from the
 111   // NSS and network task runners. Not every call needs to happen on the Core
 112   class Core;
 113
 114   enum State {
 115     STATE_NONE,
 116     STATE_HANDSHAKE,
 117     STATE_HANDSHAKE_COMPLETE,
 118     STATE_VERIFY_CERT,
 119     STATE_VERIFY_CERT_COMPLETE,
 120   };
 121
 122   int Init();
 123   void InitCore();
 124
 125   // Initializes NSS SSL options.  Returns a net error code.
 126   int InitializeSSLOptions();
 127
 128   // Initializes the socket peer name in SSL.  Returns a net error code.
 129   int InitializeSSLPeerName();
 130
 131   void DoConnectCallback(int result);
 132   void OnHandshakeIOComplete(int result);
 133
 134   int DoHandshakeLoop(int last_io_result);
 135   int DoHandshake();
 136   int DoHandshakeComplete(int result);
 137   int DoVerifyCert(int result);
 138   int DoVerifyCertComplete(int result);
 139
 140   void VerifyCT();
 141
 142   void LogConnectionTypeMetrics() const;
 143
 144   // The following methods are for debugging bug 65948. Will remove this code
 145   // after fixing bug 65948.
 146   void EnsureThreadIdAssigned() const;
 147   bool CalledOnValidThread() const;
 148
 149   // Adds the SignedCertificateTimestamps from ct_verify_result_ to |ssl_info|.
 150   // SCTs are held in three separate vectors in ct_verify_result, each
 151   // vetor representing a particular verification state, this method associates
 152   // each of the SCTs with the corresponding SCTVerifyStatus as it adds it to
 153   // the |ssl_info|.signed_certificate_timestamps list.
 154   void AddSCTInfoToSSLInfo(SSLInfo* ssl_info) const;
 155
 156   // The task runner used to perform NSS operations.
 157   scoped_refptr<base::SequencedTaskRunner> nss_task_runner_;
 158   scoped_ptr<ClientSocketHandle> transport_;
 159   HostPortPair host_and_port_;
 160   SSLConfig ssl_config_;
 161
 162   scoped_refptr<Core> core_;
 163
 164   CompletionCallback user_connect_callback_;
 165
 166   CertVerifyResult server_cert_verify_result_;
 167   HashValueVector side_pinned_public_keys_;
 168
 169   CertVerifier* const cert_verifier_;
 170   scoped_ptr<SingleRequestCertVerifier> verifier_;
 171
 172   // Certificate Transparency: Verifier and result holder.
 173   ct::CTVerifyResult ct_verify_result_;
 174   CTVerifier* cert_transparency_verifier_;
 175
 176   // The service for retrieving Channel ID keys.  May be NULL.
 177   ServerBoundCertService* server_bound_cert_service_;
 178
 179   // ssl_session_cache_shard_ is an opaque string that partitions the SSL
 180   // session cache. i.e. sessions created with one value will not attempt to
 181   // resume on the socket with a different value.
 182   const std::string ssl_session_cache_shard_;
 183
 184   // True if the SSL handshake has been completed.
 185   bool completed_handshake_;
 186
 187   State next_handshake_state_;
 188
 189   // The NSS SSL state machine. This is owned by |core_|.
 190   // TODO(rsleevi): http://crbug.com/130616 - Remove this member once
 191   // ExportKeyingMaterial is updated to be asynchronous.
 192   PRFileDesc* nss_fd_;
 193
 194   BoundNetLog net_log_;
 195
 196   base::TimeTicks start_cert_verification_time_;
 197
 198   TransportSecurityState* transport_security_state_;
 199
 200   // The following two variables are added for debugging bug 65948. Will
 201   // remove this code after fixing bug 65948.
 202   // Added the following code Debugging in release mode.
 203   mutable base::Lock lock_;
 204   // This is mutable so that CalledOnValidThread can set it.
 205   // It's guarded by |lock_|.
 206   mutable base::PlatformThreadId valid_thread_id_;
 207 };
 208
 209 }  // namespace net
 210
 211 #endif  // NET_SOCKET_SSL_CLIENT_SOCKET_NSS_H_