chrome/browser/net/certificate_error_reporter.h

   1 // Copyright 2015 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 CHROME_BROWSER_NET_CERTIFICATE_ERROR_REPORTER_H_
   6 #define CHROME_BROWSER_NET_CERTIFICATE_ERROR_REPORTER_H_
   7
   8 #include <set>
   9 #include <string>
  10
  11 #include "base/macros.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "net/url_request/url_request.h"
  14 #include "url/gurl.h"
  15
  16 namespace net {
  17 class URLRequestContext;
  18 class SSLInfo;
  19 }
  20
  21 namespace chrome_browser_net {
  22
  23 class CertLoggerRequest;
  24
  25 // Provides functionality for sending reports about invalid SSL
  26 // certificate chains to a report collection server.
  27 class CertificateErrorReporter : public net::URLRequest::Delegate {
  28  public:
  29   // These represent the types of reports that can be sent.
  30   enum ReportType {
  31     // A report of a certificate chain that failed a certificate pinning
  32     // check.
  33     REPORT_TYPE_PINNING_VIOLATION,
  34     // A report for an invalid certificate chain that is being sent for
  35     // a user who has opted-in to the extended reporting program.
  36     REPORT_TYPE_EXTENDED_REPORTING
  37   };
  38
  39   // Represents whether or not to send cookies along with reports sent
  40   // to the server.
  41   enum CookiesPreference { SEND_COOKIES, DO_NOT_SEND_COOKIES };
  42
  43   // Create a certificate error reporter that will send certificate
  44   // error reports to |upload_url|, using |request_context| as the
  45   // context for the reports. |cookies_preference| controls whether
  46   // cookies will be sent along with the reports.
  47   CertificateErrorReporter(net::URLRequestContext* request_context,
  48                            const GURL& upload_url,
  49                            CookiesPreference cookies_preference);
  50
  51   ~CertificateErrorReporter() override;
  52
  53   // Construct, serialize, and send a certificate report to the report
  54   // collection server containing the |ssl_info| associated with a
  55   // connection to |hostname|.
  56   //
  57   // SendReport actually sends the report over the network; callers are
  58   // responsible for enforcing any preconditions (such as obtaining user
  59   // opt-in, only sending reports for certain hostnames, checking for
  60   // incognito mode, etc.).
  61   virtual void SendReport(ReportType type,
  62                           const std::string& hostname,
  63                           const net::SSLInfo& ssl_info);
  64
  65   // net::URLRequest::Delegate
  66   void OnResponseStarted(net::URLRequest* request) override;
  67   void OnReadCompleted(net::URLRequest* request, int bytes_read) override;
  68
  69  private:
  70   // Create a URLRequest with which to send a certificate report to the
  71   // server.
  72   virtual scoped_ptr<net::URLRequest> CreateURLRequest(
  73       net::URLRequestContext* context);
  74
  75   // Serialize and send a CertLoggerRequest protobuf to the report
  76   // collection server.
  77   void SendCertLoggerRequest(const CertLoggerRequest& request);
  78
  79   // Populate the CertLoggerRequest for a report.
  80   static void BuildReport(const std::string& hostname,
  81                           const net::SSLInfo& ssl_info,
  82                           CertLoggerRequest* out_request);
  83
  84   // Performs post-report cleanup.
  85   void RequestComplete(net::URLRequest* request);
  86
  87   net::URLRequestContext* const request_context_;
  88   const GURL upload_url_;
  89
  90   // Owns the contained requests.
  91   std::set<net::URLRequest*> inflight_requests_;
  92
  93   CookiesPreference cookies_preference_;
  94
  95   DISALLOW_COPY_AND_ASSIGN(CertificateErrorReporter);
  96 };
  97
  98 }  // namespace chrome_browser_net
  99
 100 #endif  // CHROME_BROWSER_NET_CERTIFICATE_ERROR_REPORTER_H_