V4LDBM: Get response from GetHashManager, detect severest result

components/safe_browsing_db/v4_local_database_manager.h

 // Copyright 2016 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.
 
 #ifndef COMPONENTS_SAFE_BROWSING_DB_V4_LOCAL_DATABASE_MANAGER_H_
 #define COMPONENTS_SAFE_BROWSING_DB_V4_LOCAL_DATABASE_MANAGER_H_
 
 // A class that provides the interface between the SafeBrowsing protocol manager
 // and database that holds the downloaded updates.
 
 #include <memory>
 
 #include "components/safe_browsing_db/database_manager.h"
 #include "components/safe_browsing_db/hit_report.h"
 #include "components/safe_browsing_db/v4_database.h"
 #include "components/safe_browsing_db/v4_get_hash_protocol_manager.h"
 #include "components/safe_browsing_db/v4_protocol_manager_util.h"
 #include "components/safe_browsing_db/v4_update_protocol_manager.h"
 #include "url/gurl.h"
 
 using content::ResourceType;
 
 namespace safe_browsing {
 
+typedef unsigned ThreatSeverity;
+
 // Manages the local, on-disk database of updates downloaded from the
 // SafeBrowsing service and interfaces with the protocol manager.
 class V4LocalDatabaseManager : public SafeBrowsingDatabaseManager {
  public:
+  enum class ClientCallbackType {
+    // This represents the case when we're trying to determine if a URL is
+    // unsafe from the following perspectives: Malware, Phishing, UwS.
+    CHECK_BROWSE_URL = 0,
+
+    // This should always be the last value.
+    CHECK_MAX
+  };
+
+  // The information we need to return the response to the SafeBrowsing client
+  // that asked for the safety reputation of a URL if we can't determine that
+  // synchronously.

[Nathan Parker, 2016/09/20 18:43:38]

Can you add a todo or note that this will be extended to manage additional data
types needed by the other callback types?

This union/reuse of the same struct for different purposes is a pattern I'm not
thrilled with (it is used in the existing pver3 db), but I don't know of a
strong alternative.  Maybe it'd help to document which fields are used for which
callback types, when you add others.

[vakh (use Gerrit instead), 2016/09/20 20:51:28]

Done.
I'm not thrilled either. One way would be to have a base class that's extended
for each Check* method but that seems like an overkill. Definitely not something
I would like to do before launch.
It might be more useful to add those details/comments when this code starts
working for other methods.

+  struct PendingCheck {
+    PendingCheck(Client* client,
+                 ClientCallbackType client_callback_type,
+                 const GURL& url);
+
+    ~PendingCheck();
+
+    // The SafeBrowsing client that's waiting for the safe/unsafe verdict.
+    Client* client;
+
+    // Determines which funtion from the |client| needs to be called once we
+    // know whether the URL in |url| is safe or unsafe.
+    ClientCallbackType client_callback_type;
+
+    // The URL that are being checked for being unsafe.

[Nathan Parker, 2016/09/20 18:43:37]

nit: s/are/is

[vakh (use Gerrit instead), 2016/09/20 20:51:28]

Done.

+    GURL url;
+
+    // The metadata associated with the full hash of the severest match found
+    // for that URL.
+    ThreatMetadata url_metadata;
+
+    // The threat verdict for the URL being checked.
+    SBThreatType result_threat_type;
+  };
+
   // Construct V4LocalDatabaseManager.
   // Must be initialized by calling StartOnIOThread() before using.
   V4LocalDatabaseManager(const base::FilePath& base_path);
 
   //
   // SafeBrowsingDatabaseManager implementation
   //
 
   bool IsSupported() const override;
   safe_browsing::ThreatSource GetThreatSource() const override;
@@ skipping 22 matching lines @@
  protected:
   std::unordered_set<UpdateListIdentifier> GetStoresForFullHashRequests()
       override;
 
  private:
   friend class V4LocalDatabaseManagerTest;
   void SetTaskRunnerForTest(
       const scoped_refptr<base::SequencedTaskRunner>& task_runner) {
     task_runner_ = task_runner;
   }
+  FRIEND_TEST_ALL_PREFIXES(V4LocalDatabaseManagerTest,
+                           TestGetSeverestThreatTypeAndMetadata);
+
+  // The set of clients awaiting a full hash response.
+  typedef std::unordered_set<Client*> PendingClients;
 
   ~V4LocalDatabaseManager() override;
 
   // The callback called each time the protocol manager downloads updates
   // successfully.
   void UpdateRequestCompleted(
       std::unique_ptr<ParsedServerResponse> parsed_server_response);
 
   void SetupUpdateProtocolManager(
       net::URLRequestContextGetter* request_context_getter,
       const V4ProtocolConfig& config);
 
   void SetupDatabase();
 
-  void OnFullHashResponse(const std::vector<FullHashInfo>& full_hash_infos);
+  // Called when the |v4_get_hash_protocol_manager_| has the full hash response
+  // avaialble for the URL that we requested. It determines the severest
+  // threat type and responds to the |client| with that information.
+  void OnFullHashResponse(std::unique_ptr<PendingCheck> pending_check,
+                          const std::vector<FullHashInfo>& full_hash_infos);
 
+  // Called when all the stores managed by the database have been read from
+  // disk after startup and the database is ready for use.
   void DatabaseReady(std::unique_ptr<V4Database> v4_database);
 
   // Called when the database has been updated and schedules the next update.
   void DatabaseUpdated();
 
+  // Calls the appopriate method on the |client| object, based on the contents
+  // of |pending_check|.
+  void RespondToClient(std::unique_ptr<PendingCheck> pending_check);
+
+  // Finds the most severe |SBThreatType| and the corresponding |metadata| from
+  // |full_hash_infos|.
+  static void GetSeverestThreatTypeAndMetadata(
+      SBThreatType* result_threat_type,
+      ThreatMetadata* metadata,
+      const std::vector<FullHashInfo>& full_hash_infos);
+
   // The base directory under which to create the files that contain hashes.
   const base::FilePath base_path_;
 
   // Whether the service is running.
   bool enabled_;
 
-  // Stores the current status of the lists to download from the SafeBrowsing
-  // servers.
-  // TODO(vakh): current_list_states_ doesn't really belong here.
-  // It should come through the database, from the various V4Stores.
-  base::hash_map<UpdateListIdentifier, std::string> current_list_states_;
+  // The set of clients that are waiting for a full hash response from the
+  // SafeBrowsing service.

[Nathan Parker, 2016/09/20 18:43:38]

Add what it's used for: For tracking when a client has canceled its request

[vakh (use Gerrit instead), 2016/09/20 20:51:28]

Done.

+  PendingClients pending_clients_;
 
   // The list of stores to manage (for hash prefixes and full hashes), along
   // with the corresponding filename on disk for each of them.
   StoreIdAndFileNames store_id_file_names_;
 
   // The protocol manager that downloads the hash prefix updates.
   std::unique_ptr<V4UpdateProtocolManager> v4_update_protocol_manager_;
 
   // The database that manages the stores containing the hash prefix updates.
   // All writes to this variable must happen on the IO thread only.
   std::unique_ptr<V4Database> v4_database_;
 
   // Called when the V4Database has finished applying the latest update and is
   // ready to process next update.
   DatabaseUpdatedCallback db_updated_callback_;
 
   // The sequenced task runner for running safe browsing database operations.
   scoped_refptr<base::SequencedTaskRunner> task_runner_;
 
   friend class base::RefCountedThreadSafe<V4LocalDatabaseManager>;
   DISALLOW_COPY_AND_ASSIGN(V4LocalDatabaseManager);
 };  // class V4LocalDatabaseManager
 
 }  // namespace safe_browsing
 
 #endif  // COMPONENTS_SAFE_BROWSING_DB_V4_LOCAL_DATABASE_MANAGER_H_