Add token field to ClientSafeBrowsingReportReqeust

chrome/browser/safe_browsing/download_protection_service.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
 // Helper class which handles communication with the SafeBrowsing servers for
 // improved binary download protection.
 
 #ifndef CHROME_BROWSER_SAFE_BROWSING_DOWNLOAD_PROTECTION_SERVICE_H_
 #define CHROME_BROWSER_SAFE_BROWSING_DOWNLOAD_PROTECTION_SERVICE_H_
 
 #include <stdint.h>
 
 #include <memory>
 #include <set>
 #include <string>
 #include <unordered_map>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/callback_list.h"
 #include "base/files/file_path.h"
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
+#include "base/supports_user_data.h"
 #include "chrome/browser/safe_browsing/ui_manager.h"
 #include "components/safe_browsing_db/database_manager.h"
 #include "net/url_request/url_request_context_getter.h"
 #include "url/gurl.h"
 
 
 namespace content {
 class DownloadItem;
 class PageNavigator;
 }
@@ skipping 50 matching lines @@
   virtual void ParseManualBlacklistFlag();
 
   // Return true if this hash value is blacklisted via flag (for testing).
   virtual bool IsHashManuallyBlacklisted(const std::string& sha256_hash) const;
 
   // Checks whether the given client download is likely to be malicious or not.
   // The result is delivered asynchronously via the given callback.  This
   // method must be called on the UI thread, and the callback will also be
   // invoked on the UI thread.  This method must be called once the download
   // is finished and written to disk.
-  virtual void CheckClientDownload(content::DownloadItem* item,
-                                   const CheckDownloadCallback& callback);
+  virtual void CheckClientDownload(
+      content::DownloadItem* item,
+      const CheckDownloadCallback& callback);
 
   // Checks whether any of the URLs in the redirect chain of the
   // download match the SafeBrowsing bad binary URL list.  The result is
   // delivered asynchronously via the given callback.  This method must be
   // called on the UI thread, and the callback will also be invoked on the UI
   // thread.  Pre-condition: !info.download_url_chain.empty().
   virtual void CheckDownloadUrl(const content::DownloadItem& item,
                                 const CheckDownloadCallback& callback);
 
   // Returns true iff the download specified by |info| should be scanned by
@@ skipping 34 matching lines @@
 
   // Registers a callback that will be run when a ClientDownloadRequest has
   // been formed.
   ClientDownloadRequestSubscription RegisterClientDownloadRequestCallback(
       const ClientDownloadRequestCallback& callback);
 
   double whitelist_sample_rate() const {
     return whitelist_sample_rate_;
   }
 
+  static void SetDownloadPingToken(content::DownloadItem* item,
+                                   const std::string& token);
+
+  static std::string GetDownloadPingToken(const content::DownloadItem* item);
+
  protected:
   // Enum to keep track why a particular download verdict was chosen.
   // This is used to keep some stats around.
   enum DownloadCheckResultReason {
     REASON_INVALID_URL,
     REASON_SB_DISABLED,
     REASON_WHITELISTED_URL,
     REASON_WHITELISTED_REFERRER,
     REASON_INVALID_REQUEST_PROTO,
     REASON_SERVER_PING_FAILED,
@@ skipping 15 matching lines @@
     REASON_DOWNLOAD_POTENTIALLY_UNWANTED,
     REASON_UNSUPPORTED_URL_SCHEME,
     REASON_MANUAL_BLACKLIST,
     REASON_MAX  // Always add new values before this one.
   };
 
  private:
   class CheckClientDownloadRequest;
   class PPAPIDownloadRequest;
   friend class DownloadProtectionServiceTest;
+  friend class DownloadDangerPromptTest;
 
   FRIEND_TEST_ALL_PREFIXES(DownloadProtectionServiceTest,
                            CheckClientDownloadWhitelistedUrlWithoutSampling);
   FRIEND_TEST_ALL_PREFIXES(DownloadProtectionServiceTest,
                            CheckClientDownloadWhitelistedUrlWithSampling);
   FRIEND_TEST_ALL_PREFIXES(DownloadProtectionServiceTest,
                            CheckClientDownloadValidateRequest);
   FRIEND_TEST_ALL_PREFIXES(DownloadProtectionServiceTest,
                            CheckClientDownloadSuccess);
   FRIEND_TEST_ALL_PREFIXES(DownloadProtectionServiceTest,
@@ skipping 12 matching lines @@
                            CheckClientCrxDownloadSuccess);
   FRIEND_TEST_ALL_PREFIXES(DownloadProtectionServiceTest,
                            PPAPIDownloadRequest_InvalidResponse);
   FRIEND_TEST_ALL_PREFIXES(DownloadProtectionServiceTest,
                            PPAPIDownloadRequest_Timeout);
   FRIEND_TEST_ALL_PREFIXES(DownloadProtectionServiceFlagTest,
                            CheckClientDownloadOverridenByFlag);
 
   static const char kDownloadRequestUrl[];
 
+  static const void* const kDownloadPingTokenKey;

[Nathan Parker, 2016/06/07 23:00:53]

Could all of this be in an anonymous namespace in the .cc file?  If you're using
it in tests, then no (and never mind).

[Jialiu Lin, 2016/06/08 00:06:16]

Yes, I'm using it in download_danger_prompt_browsertest

+
+  // Helper class for easy setting and getting token string.
+  class DownloadPingToken : public base::SupportsUserData::Data {
+   public:
+    explicit DownloadPingToken(const std::string& token)
+       : token_string_(token) {}
+
+    std::string token_string() {
+      return token_string_;
+    }
+   private:
+    std::string token_string_;
+
+    DISALLOW_COPY_AND_ASSIGN(DownloadPingToken);
+  };
+
   // Cancels all requests in |download_requests_|, and empties it, releasing
   // the references to the requests.
   void CancelPendingRequests();
 
   // Called by a CheckClientDownloadRequest instance when it finishes, to
   // remove it from |download_requests_|.
   void RequestFinished(CheckClientDownloadRequest* request);
 
   void PPAPIDownloadCheckRequestFinished(PPAPIDownloadRequest* request);
 
@@ skipping 43 matching lines @@
   std::set<std::string> manual_blacklist_hashes_;
 
   // Rate of whitelisted downloads we sample to send out download ping.
   double whitelist_sample_rate_;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadProtectionService);
 };
 }  // namespace safe_browsing
 
 #endif  // CHROME_BROWSER_SAFE_BROWSING_DOWNLOAD_PROTECTION_SERVICE_H_