net/socket/ssl_client_socket_openssl.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_OPENSSL_H_
   6 #define NET_SOCKET_SSL_CLIENT_SOCKET_OPENSSL_H_
   7
   8 #include <string>
   9
  10 #include "base/compiler_specific.h"
  11 #include "base/memory/scoped_ptr.h"
  12 #include "base/memory/weak_ptr.h"
  13 #include "net/base/completion_callback.h"
  14 #include "net/base/io_buffer.h"
  15 #include "net/cert/cert_verify_result.h"
  16 #include "net/cert/ct_verify_result.h"
  17 #include "net/socket/client_socket_handle.h"
  18 #include "net/socket/ssl_client_socket.h"
  19 #include "net/ssl/channel_id_service.h"
  20 #include "net/ssl/openssl_ssl_util.h"
  21 #include "net/ssl/ssl_client_cert_type.h"
  22 #include "net/ssl/ssl_config_service.h"
  23
  24 // Avoid including misc OpenSSL headers, i.e.:
  25 // <openssl/bio.h>
  26 typedef struct bio_st BIO;
  27 // <openssl/evp.h>
  28 typedef struct evp_pkey_st EVP_PKEY;
  29 // <openssl/ssl.h>
  30 typedef struct ssl_st SSL;
  31 // <openssl/x509.h>
  32 typedef struct x509_st X509;
  33 // <openssl/ossl_type.h>
  34 typedef struct x509_store_ctx_st X509_STORE_CTX;
  35
  36 namespace net {
  37
  38 class CertVerifier;
  39 class CTVerifier;
  40 class SingleRequestCertVerifier;
  41 class SSLCertRequestInfo;
  42 class SSLInfo;
  43
  44 // An SSL client socket implemented with OpenSSL.
  45 class SSLClientSocketOpenSSL : public SSLClientSocket {
  46  public:
  47   // Takes ownership of the transport_socket, which may already be connected.
  48   // The given hostname will be compared with the name(s) in the server's
  49   // certificate during the SSL handshake.  ssl_config specifies the SSL
  50   // settings.
  51   SSLClientSocketOpenSSL(scoped_ptr<ClientSocketHandle> transport_socket,
  52                          const HostPortPair& host_and_port,
  53                          const SSLConfig& ssl_config,
  54                          const SSLClientSocketContext& context);
  55   ~SSLClientSocketOpenSSL() override;
  56
  57   const HostPortPair& host_and_port() const { return host_and_port_; }
  58   const std::string& ssl_session_cache_shard() const {
  59     return ssl_session_cache_shard_;
  60   }
  61
  62   // SSLClientSocket implementation.
  63   void GetSSLCertRequestInfo(SSLCertRequestInfo* cert_request_info) override;
  64   NextProtoStatus GetNextProto(std::string* proto) override;
  65   ChannelIDService* GetChannelIDService() const override;
  66
  67   // SSLSocket implementation.
  68   int ExportKeyingMaterial(const base::StringPiece& label,
  69                            bool has_context,
  70                            const base::StringPiece& context,
  71                            unsigned char* out,
  72                            unsigned int outlen) override;
  73   int GetTLSUniqueChannelBinding(std::string* out) override;
  74
  75   // StreamSocket implementation.
  76   int Connect(const CompletionCallback& callback) override;
  77   void Disconnect() override;
  78   bool IsConnected() const override;
  79   bool IsConnectedAndIdle() const override;
  80   int GetPeerAddress(IPEndPoint* address) const override;
  81   int GetLocalAddress(IPEndPoint* address) const override;
  82   const BoundNetLog& NetLog() const override;
  83   void SetSubresourceSpeculation() override;
  84   void SetOmniboxSpeculation() override;
  85   bool WasEverUsed() const override;
  86   bool UsingTCPFastOpen() const override;
  87   bool GetSSLInfo(SSLInfo* ssl_info) override;
  88
  89   // Socket implementation.
  90   int Read(IOBuffer* buf,
  91            int buf_len,
  92            const CompletionCallback& callback) override;
  93   int Write(IOBuffer* buf,
  94             int buf_len,
  95             const CompletionCallback& callback) override;
  96   int SetReceiveBufferSize(int32 size) override;
  97   int SetSendBufferSize(int32 size) override;
  98
  99  protected:
 100   // SSLClientSocket implementation.
 101   scoped_refptr<X509Certificate> GetUnverifiedServerCertificateChain()
 102       const override;
 103
 104  private:
 105   class PeerCertificateChain;
 106   class SSLContext;
 107   friend class SSLClientSocket;
 108   friend class SSLContext;
 109
 110   int Init();
 111   void DoReadCallback(int result);
 112   void DoWriteCallback(int result);
 113
 114   bool DoTransportIO();
 115   int DoHandshake();
 116   int DoChannelIDLookup();
 117   int DoChannelIDLookupComplete(int result);
 118   int DoVerifyCert(int result);
 119   int DoVerifyCertComplete(int result);
 120   void DoConnectCallback(int result);
 121   void UpdateServerCert();
 122   void VerifyCT();
 123
 124   void OnHandshakeIOComplete(int result);
 125   void OnSendComplete(int result);
 126   void OnRecvComplete(int result);
 127
 128   int DoHandshakeLoop(int last_io_result);
 129   int DoReadLoop();
 130   int DoWriteLoop();
 131   int DoPayloadRead();
 132   int DoPayloadWrite();
 133
 134   int BufferSend();
 135   int BufferRecv();
 136   void BufferSendComplete(int result);
 137   void BufferRecvComplete(int result);
 138   void TransportWriteComplete(int result);
 139   int TransportReadComplete(int result);
 140
 141   // Callback from the SSL layer that indicates the remote server is requesting
 142   // a certificate for this client.
 143   int ClientCertRequestCallback(SSL* ssl);
 144
 145   // CertVerifyCallback is called to verify the server's certificates. We do
 146   // verification after the handshake so this function only enforces that the
 147   // certificates don't change during renegotiation.
 148   int CertVerifyCallback(X509_STORE_CTX *store_ctx);
 149
 150   // Callback from the SSL layer to check which NPN protocol we are supporting
 151   int SelectNextProtoCallback(unsigned char** out, unsigned char* outlen,
 152                               const unsigned char* in, unsigned int inlen);
 153
 154   // Called during an operation on |transport_bio_|'s peer. Checks saved
 155   // transport error state and, if appropriate, returns an error through
 156   // OpenSSL's error system.
 157   long MaybeReplayTransportError(BIO *bio,
 158                                  int cmd,
 159                                  const char *argp, int argi, long argl,
 160                                  long retvalue);
 161
 162   // Callback from the SSL layer when an operation is performed on
 163   // |transport_bio_|'s peer.
 164   static long BIOCallback(BIO *bio,
 165                           int cmd,
 166                           const char *argp, int argi, long argl,
 167                           long retvalue);
 168
 169   // Called after the initial handshake completes and after the server
 170   // certificate has been verified. The order of handshake completion and
 171   // certificate verification depends on whether the connection was false
 172   // started. After both have happened (thus calling this twice), the session is
 173   // safe to cache and will be cached.
 174   void MaybeCacheSession();
 175
 176   // Callback from the SSL layer when the internal state machine progresses. It
 177   // is used to listen for when the handshake completes entirely; |Connect| may
 178   // return early if false starting.
 179   void InfoCallback(int type, int val);
 180
 181   // Adds the SignedCertificateTimestamps from ct_verify_result_ to |ssl_info|.
 182   // SCTs are held in three separate vectors in ct_verify_result, each
 183   // vetor representing a particular verification state, this method associates
 184   // each of the SCTs with the corresponding SCTVerifyStatus as it adds it to
 185   // the |ssl_info|.signed_certificate_timestamps list.
 186   void AddSCTInfoToSSLInfo(SSLInfo* ssl_info) const;
 187
 188   // Returns a unique key string for the SSL session cache for
 189   // this socket.
 190   std::string GetSessionCacheKey() const;
 191
 192   bool transport_send_busy_;
 193   bool transport_recv_busy_;
 194
 195   // Buffers which are shared by BoringSSL and SSLClientSocketOpenSSL.
 196   // GrowableIOBuffer is used to keep ownership and setting offset.
 197   scoped_refptr<GrowableIOBuffer> send_buffer_;
 198   scoped_refptr<GrowableIOBuffer> recv_buffer_;
 199
 200   CompletionCallback user_connect_callback_;
 201   CompletionCallback user_read_callback_;
 202   CompletionCallback user_write_callback_;
 203
 204   // Used by Read function.
 205   scoped_refptr<IOBuffer> user_read_buf_;
 206   int user_read_buf_len_;
 207
 208   // Used by Write function.
 209   scoped_refptr<IOBuffer> user_write_buf_;
 210   int user_write_buf_len_;
 211
 212   // Used by DoPayloadRead() when attempting to fill the caller's buffer with
 213   // as much data as possible without blocking.
 214   // If DoPayloadRead() encounters an error after having read some data, stores
 215   // the result to return on the *next* call to DoPayloadRead().  A value > 0
 216   // indicates there is no pending result, otherwise 0 indicates EOF and < 0
 217   // indicates an error.
 218   int pending_read_error_;
 219
 220   // If there is a pending read result, the OpenSSL result code (output of
 221   // SSL_get_error) associated with it.
 222   int pending_read_ssl_error_;
 223
 224   // If there is a pending read result, the OpenSSLErrorInfo associated with it.
 225   OpenSSLErrorInfo pending_read_error_info_;
 226
 227   // Used by TransportReadComplete() to signify an error reading from the
 228   // transport socket. A value of OK indicates the socket is still
 229   // readable. EOFs are mapped to ERR_CONNECTION_CLOSED.
 230   int transport_read_error_;
 231
 232   // Used by TransportWriteComplete() and TransportReadComplete() to signify an
 233   // error writing to the transport socket. A value of OK indicates no error.
 234   int transport_write_error_;
 235
 236   // Set when Connect finishes.
 237   scoped_ptr<PeerCertificateChain> server_cert_chain_;
 238   scoped_refptr<X509Certificate> server_cert_;
 239   CertVerifyResult server_cert_verify_result_;
 240   bool completed_connect_;
 241
 242   // Set when Read() or Write() successfully reads or writes data to or from the
 243   // network.
 244   bool was_ever_used_;
 245
 246   // Stores client authentication information between ClientAuthHandler and
 247   // GetSSLCertRequestInfo calls.
 248   bool client_auth_cert_needed_;
 249   // List of DER-encoded X.509 DistinguishedName of certificate authorities
 250   // allowed by the server.
 251   std::vector<std::string> cert_authorities_;
 252   // List of SSLClientCertType values for client certificates allowed by the
 253   // server.
 254   std::vector<SSLClientCertType> cert_key_types_;
 255
 256   CertVerifier* const cert_verifier_;
 257   scoped_ptr<SingleRequestCertVerifier> verifier_;
 258   base::TimeTicks start_cert_verification_time_;
 259
 260   // Certificate Transparency: Verifier and result holder.
 261   ct::CTVerifyResult ct_verify_result_;
 262   CTVerifier* cert_transparency_verifier_;
 263
 264   // The service for retrieving Channel ID keys.  May be NULL.
 265   ChannelIDService* channel_id_service_;
 266
 267   // OpenSSL stuff
 268   SSL* ssl_;
 269   BIO* transport_bio_;
 270
 271   scoped_ptr<ClientSocketHandle> transport_;
 272   const HostPortPair host_and_port_;
 273   SSLConfig ssl_config_;
 274   // ssl_session_cache_shard_ is an opaque string that partitions the SSL
 275   // session cache. i.e. sessions created with one value will not attempt to
 276   // resume on the socket with a different value.
 277   const std::string ssl_session_cache_shard_;
 278
 279   enum State {
 280     STATE_NONE,
 281     STATE_HANDSHAKE,
 282     STATE_CHANNEL_ID_LOOKUP,
 283     STATE_CHANNEL_ID_LOOKUP_COMPLETE,
 284     STATE_VERIFY_CERT,
 285     STATE_VERIFY_CERT_COMPLETE,
 286   };
 287   State next_handshake_state_;
 288   NextProtoStatus npn_status_;
 289   std::string npn_proto_;
 290   // Written by the |channel_id_service_|.
 291   std::string channel_id_private_key_;
 292   std::string channel_id_cert_;
 293   // True if channel ID extension was negotiated.
 294   bool channel_id_xtn_negotiated_;
 295   // True if the initial handshake has completed.
 296   bool handshake_completed_;
 297   // True if the initial handshake's certificate has been verified.
 298   bool certificate_verified_;
 299   // The request handle for |channel_id_service_|.
 300   ChannelIDService::RequestHandle channel_id_request_handle_;
 301
 302   TransportSecurityState* transport_security_state_;
 303
 304   CertPolicyEnforcer* const policy_enforcer_;
 305
 306   // pinning_failure_log contains a message produced by
 307   // TransportSecurityState::CheckPublicKeyPins in the event of a
 308   // pinning failure. It is a (somewhat) human-readable string.
 309   std::string pinning_failure_log_;
 310
 311   BoundNetLog net_log_;
 312   base::WeakPtrFactory<SSLClientSocketOpenSSL> weak_factory_;
 313 };
 314
 315 }  // namespace net
 316
 317 #endif  // NET_SOCKET_SSL_CLIENT_SOCKET_OPENSSL_H_