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/channel_id_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 ChannelIDService;
  42 class CTVerifier;
  43 class ClientSocketHandle;
  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) OVERRIDE;
  74
  75   // SSLSocket implementation.
  76   virtual int ExportKeyingMaterial(const base::StringPiece& label,
  77                                    bool has_context,
  78                                    const base::StringPiece& context,
  79                                    unsigned char* out,
  80                                    unsigned int outlen) OVERRIDE;
  81   virtual int GetTLSUniqueChannelBinding(std::string* out) OVERRIDE;
  82
  83   // StreamSocket implementation.
  84   virtual int Connect(const CompletionCallback& callback) OVERRIDE;
  85   virtual void Disconnect() OVERRIDE;
  86   virtual bool IsConnected() const OVERRIDE;
  87   virtual bool IsConnectedAndIdle() const OVERRIDE;
  88   virtual int GetPeerAddress(IPEndPoint* address) const OVERRIDE;
  89   virtual int GetLocalAddress(IPEndPoint* address) const OVERRIDE;
  90   virtual const BoundNetLog& NetLog() const OVERRIDE;
  91   virtual void SetSubresourceSpeculation() OVERRIDE;
  92   virtual void SetOmniboxSpeculation() OVERRIDE;
  93   virtual bool WasEverUsed() const OVERRIDE;
  94   virtual bool UsingTCPFastOpen() const OVERRIDE;
  95   virtual bool GetSSLInfo(SSLInfo* ssl_info) OVERRIDE;
  96
  97   // Socket implementation.
  98   virtual int Read(IOBuffer* buf,
  99                    int buf_len,
 100                    const CompletionCallback& callback) OVERRIDE;
 101   virtual int Write(IOBuffer* buf,
 102                     int buf_len,
 103                     const CompletionCallback& callback) OVERRIDE;
 104   virtual int SetReceiveBufferSize(int32 size) OVERRIDE;
 105   virtual int SetSendBufferSize(int32 size) OVERRIDE;
 106   virtual ChannelIDService* GetChannelIDService() const OVERRIDE;
 107
 108  protected:
 109   // SSLClientSocket implementation.
 110   virtual scoped_refptr<X509Certificate> GetUnverifiedServerCertificateChain()
 111       const OVERRIDE;
 112
 113  private:
 114   // Helper class to handle marshalling any NSS interaction to and from the
 115   // NSS and network task runners. Not every call needs to happen on the Core
 116   class Core;
 117
 118   enum State {
 119     STATE_NONE,
 120     STATE_HANDSHAKE,
 121     STATE_HANDSHAKE_COMPLETE,
 122     STATE_VERIFY_CERT,
 123     STATE_VERIFY_CERT_COMPLETE,
 124   };
 125
 126   int Init();
 127   void InitCore();
 128
 129   // Initializes NSS SSL options.  Returns a net error code.
 130   int InitializeSSLOptions();
 131
 132   // Initializes the socket peer name in SSL.  Returns a net error code.
 133   int InitializeSSLPeerName();
 134
 135   void DoConnectCallback(int result);
 136   void OnHandshakeIOComplete(int result);
 137
 138   int DoHandshakeLoop(int last_io_result);
 139   int DoHandshake();
 140   int DoHandshakeComplete(int result);
 141   int DoVerifyCert(int result);
 142   int DoVerifyCertComplete(int result);
 143
 144   void VerifyCT();
 145
 146   void LogConnectionTypeMetrics() const;
 147
 148   // The following methods are for debugging bug 65948. Will remove this code
 149   // after fixing bug 65948.
 150   void EnsureThreadIdAssigned() const;
 151   bool CalledOnValidThread() const;
 152
 153   // Adds the SignedCertificateTimestamps from ct_verify_result_ to |ssl_info|.
 154   // SCTs are held in three separate vectors in ct_verify_result, each
 155   // vetor representing a particular verification state, this method associates
 156   // each of the SCTs with the corresponding SCTVerifyStatus as it adds it to
 157   // the |ssl_info|.signed_certificate_timestamps list.
 158   void AddSCTInfoToSSLInfo(SSLInfo* ssl_info) const;
 159
 160   // The task runner used to perform NSS operations.
 161   scoped_refptr<base::SequencedTaskRunner> nss_task_runner_;
 162   scoped_ptr<ClientSocketHandle> transport_;
 163   HostPortPair host_and_port_;
 164   SSLConfig ssl_config_;
 165
 166   scoped_refptr<Core> core_;
 167
 168   CompletionCallback user_connect_callback_;
 169
 170   CertVerifyResult server_cert_verify_result_;
 171
 172   CertVerifier* const cert_verifier_;
 173   scoped_ptr<SingleRequestCertVerifier> verifier_;
 174
 175   // Certificate Transparency: Verifier and result holder.
 176   ct::CTVerifyResult ct_verify_result_;
 177   CTVerifier* cert_transparency_verifier_;
 178
 179   // The service for retrieving Channel ID keys.  May be NULL.
 180   ChannelIDService* channel_id_service_;
 181
 182   // ssl_session_cache_shard_ is an opaque string that partitions the SSL
 183   // session cache. i.e. sessions created with one value will not attempt to
 184   // resume on the socket with a different value.
 185   const std::string ssl_session_cache_shard_;
 186
 187   // True if the SSL handshake has been completed.
 188   bool completed_handshake_;
 189
 190   State next_handshake_state_;
 191
 192   // The NSS SSL state machine. This is owned by |core_|.
 193   // TODO(rsleevi): http://crbug.com/130616 - Remove this member once
 194   // ExportKeyingMaterial is updated to be asynchronous.
 195   PRFileDesc* nss_fd_;
 196
 197   BoundNetLog net_log_;
 198
 199   base::TimeTicks start_cert_verification_time_;
 200
 201   TransportSecurityState* transport_security_state_;
 202
 203   // pinning_failure_log contains a message produced by
 204   // TransportSecurityState::DomainState::CheckPublicKeyPins in the event of a
 205   // pinning failure. It is a (somewhat) human-readable string.
 206   std::string pinning_failure_log_;
 207
 208   // The following two variables are added for debugging bug 65948. Will
 209   // remove this code after fixing bug 65948.
 210   // Added the following code Debugging in release mode.
 211   mutable base::Lock lock_;
 212   // This is mutable so that CalledOnValidThread can set it.
 213   // It's guarded by |lock_|.
 214   mutable base::PlatformThreadId valid_thread_id_;
 215 };
 216
 217 }  // namespace net
 218
 219 #endif  // NET_SOCKET_SSL_CLIENT_SOCKET_NSS_H_