chrome/browser/safe_browsing/ping_manager.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 CHROME_BROWSER_SAFE_BROWSING_PING_MANAGER_H_
   6 #define CHROME_BROWSER_SAFE_BROWSING_PING_MANAGER_H_
   7
   8 // A class that reports safebrowsing statistics to Google's SafeBrowsing
   9 // servers.
  10 #include <set>
  11 #include <string>
  12 #include <vector>
  13
  14 #include "base/gtest_prod_util.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "chrome/browser/safe_browsing/protocol_manager_helper.h"
  17 #include "chrome/browser/safe_browsing/safe_browsing_util.h"
  18 #include "net/url_request/url_fetcher_delegate.h"
  19 #include "url/gurl.h"
  20
  21 namespace certificate_reporting {
  22 class ErrorReporter;
  23 }
  24
  25 namespace net {
  26 class SSLInfo;
  27 class URLRequestContextGetter;
  28 }  // namespace net
  29
  30
  31 class SafeBrowsingPingManager : public net::URLFetcherDelegate {
  32  public:
  33   ~SafeBrowsingPingManager() override;
  34
  35   // Create an instance of the safe browsing ping manager.
  36   static SafeBrowsingPingManager* Create(
  37       net::URLRequestContextGetter* request_context_getter,
  38       const SafeBrowsingProtocolConfig& config);
  39
  40   // net::URLFetcherDelegate interface.
  41   void OnURLFetchComplete(const net::URLFetcher* source) override;
  42
  43   // For UMA users we report to Google when a SafeBrowsing interstitial is shown
  44   // to the user.  |threat_type| should be one of the types known by
  45   // SafeBrowsingHitUrl.
  46   void ReportSafeBrowsingHit(const GURL& malicious_url,
  47                              const GURL& page_url,
  48                              const GURL& referrer_url,
  49                              bool is_subresource,
  50                              SBThreatType threat_type,
  51                              const std::string& post_data,
  52                              bool is_extended_reporting);
  53
  54   // Users can opt-in on the SafeBrowsing interstitial to send detailed
  55   // malware reports. |report| is the serialized report.
  56   void ReportMalwareDetails(const std::string& report);
  57
  58   // Users can opt-in on the SSL interstitial to send reports of invalid
  59   // certificate chains.
  60   void ReportInvalidCertificateChain(const std::string& serialized_report);
  61
  62   void SetCertificateErrorReporterForTesting(
  63       scoped_ptr<certificate_reporting::ErrorReporter>
  64           certificate_error_reporter);
  65
  66  private:
  67   FRIEND_TEST_ALL_PREFIXES(SafeBrowsingPingManagerTest,
  68                            TestSafeBrowsingHitUrl);
  69   FRIEND_TEST_ALL_PREFIXES(SafeBrowsingPingManagerTest,
  70                            TestMalwareDetailsUrl);
  71
  72   typedef std::set<const net::URLFetcher*> Reports;
  73
  74   // Constructs a SafeBrowsingPingManager that issues network requests
  75   // using |request_context_getter|.
  76   SafeBrowsingPingManager(
  77       net::URLRequestContextGetter* request_context_getter,
  78       const SafeBrowsingProtocolConfig& config);
  79
  80   // Generates URL for reporting safe browsing hits for UMA users.
  81   GURL SafeBrowsingHitUrl(const GURL& malicious_url,
  82                           const GURL& page_url,
  83                           const GURL& referrer_url,
  84                           bool is_subresource,
  85                           SBThreatType threat_type,
  86                           bool is_extended_reporting) const;
  87   // Generates URL for reporting malware details for users who opt-in.
  88   GURL MalwareDetailsUrl() const;
  89
  90   // Current product version sent in each request.
  91   std::string version_;
  92
  93   // The safe browsing client name sent in each request.
  94   std::string client_name_;
  95
  96   // The context we use to issue network requests.
  97   scoped_refptr<net::URLRequestContextGetter> request_context_getter_;
  98
  99   // URL prefix where browser reports hits to the safebrowsing list and
 100   // sends detaild malware reports for UMA users.
 101   std::string url_prefix_;
 102
 103   // Track outstanding SafeBrowsing report fetchers for clean up.
 104   // We add both "hit" and "detail" fetchers in this set.
 105   Reports safebrowsing_reports_;
 106
 107   // Sends reports of invalid SSL certificate chains.
 108   scoped_ptr<certificate_reporting::ErrorReporter> certificate_error_reporter_;
 109
 110   DISALLOW_COPY_AND_ASSIGN(SafeBrowsingPingManager);
 111 };
 112
 113 #endif  // CHROME_BROWSER_SAFE_BROWSING_PING_MANAGER_H_