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