components/safe_browsing/core/realtime/policy_engine.h

// Copyright 2019 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_CORE_REALTIME_POLICY_ENGINE_H_
#define COMPONENTS_SAFE_BROWSING_CORE_REALTIME_POLICY_ENGINE_H_

#include <string>

#include "base/callback.h"
#include "build/build_config.h"

class PrefService;

namespace variations {
class VariationsService;
}

namespace safe_browsing {

enum class ResourceType;

// This class implements the logic to decide whether the real time lookup
// feature is enabled for a given user/profile.
// TODO(crbug.com/1050859): To make this class build in IOS, remove
// browser_context dependency in this class, and replace it with pref_service
// and simple_factory_key.
class RealTimePolicyEngine {
 public:
  RealTimePolicyEngine() = delete;
  ~RealTimePolicyEngine() = delete;

  // A callback via which the client of this component indicates whether they
  // are configured to support token fetches. Used as part of
  // CanPerformFullURLLookupWithToken().
  using ClientConfiguredForTokenFetchesCallback =
      base::OnceCallback<bool(bool user_has_enabled_enhanced_protection)>;

  // Return true if full URL lookups are enabled for |resource_type|. If
  // |can_rt_check_subresource_url| is set to false, return true only if
  // |resource_type| is |kMainFrame|.
  static bool CanPerformFullURLLookupForResourceType(
      ResourceType resource_type,
      bool can_rt_check_subresource_url);

  // Return true if the feature to enable full URL lookups is enabled and the
  // allowlist fetch is enabled for the profile represented by
  // |pref_service|.
  static bool CanPerformFullURLLookup(
      PrefService* pref_service,
      bool is_off_the_record,
      variations::VariationsService* variations_service);

  // Return true if the OAuth token should be associated with the URL lookup
  // pings.
  static bool CanPerformFullURLLookupWithToken(
      PrefService* pref_service,
      bool is_off_the_record,
      ClientConfiguredForTokenFetchesCallback client_callback,
      variations::VariationsService* variations_service);

  static bool CanPerformEnterpriseFullURLLookup(const PrefService* pref_service,
                                                bool has_valid_dm_token,
                                                bool is_off_the_record);

  friend class SafeBrowsingService;

 private:
  static bool IsInExcludedCountry(const std::string& country_code);

  // Is the feature to perform real-time URL lookup enabled?
  static bool IsUrlLookupEnabled();

  // Whether the user has opted-in to MBB.
  static bool IsUserMbbOptedIn(PrefService* pref_service);

  // Whether the user has opted-in to Enhanced Protection.
  static bool IsUserEpOptedIn(PrefService* pref_service);

  friend class RealTimePolicyEngineTest;
};  // class RealTimePolicyEngine

}  // namespace safe_browsing

#endif  // COMPONENTS_SAFE_BROWSING_CORE_REALTIME_POLICY_ENGINE_H_