// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_SECURITY_INTERSTITIALS_CONTENT_SECURITY_BLOCKING_PAGE_FACTORY_H_
#define COMPONENTS_SECURITY_INTERSTITIALS_CONTENT_SECURITY_BLOCKING_PAGE_FACTORY_H_

#include <memory>

#include "base/memory/raw_ptr.h"
#include "build/build_config.h"
#include "components/security_interstitials/content/bad_clock_blocking_page.h"
#include "components/security_interstitials/content/blocked_interception_blocking_page.h"
#include "components/security_interstitials/content/captive_portal_blocking_page.h"
#include "components/security_interstitials/content/https_only_mode_blocking_page.h"
#include "components/security_interstitials/content/insecure_form_blocking_page.h"
#include "components/security_interstitials/content/local_self_signed_blocking_page.h"
#include "components/security_interstitials/content/mitm_software_blocking_page.h"
#include "components/security_interstitials/content/ssl_blocking_page.h"
#include "components/security_interstitials/content/ssl_blocking_page_base.h"
#include "components/security_interstitials/core/https_only_mode_metrics.h"
#include "net/base/net_errors.h"
#include "url/gurl.h"

// An interface that the embedder implements to supply instances of security
// blocking pages that are configured for that embedder.
class SecurityBlockingPageFactory {
 public:
  SecurityBlockingPageFactory() = default;

  SecurityBlockingPageFactory(const SecurityBlockingPageFactory&) = delete;
  SecurityBlockingPageFactory& operator=(const SecurityBlockingPageFactory&) =
      delete;

  virtual ~SecurityBlockingPageFactory() = default;

  // Creates an SSL blocking page. |options_mask| must be a bitwise mask of
  // SSLErrorUI::SSLErrorOptionsMask values.
  virtual std::unique_ptr<SSLBlockingPage> CreateSSLPage(
      content::WebContents* web_contents,
      net::Error cert_error,
      const net::SSLInfo& ssl_info,
      const GURL& request_url,
      int options_mask,
      const base::Time& time_triggered,
      const GURL& support_url) = 0;

  // Creates a local self-signed blocking page.
  virtual std::unique_ptr<LocalSelfSignedBlockingPage>
  CreateLocalSelfSignedBlockingPage(content::WebContents* web_contents,
                                    net::Error cert_error,
                                    const net::SSLInfo& ssl_info,
                                    const GURL& request_url,
                                    int options_mask,
                                    const base::Time& time_triggered,
                                    const GURL& support_url) = 0;

  // Creates a captive portal blocking page.
  virtual std::unique_ptr<CaptivePortalBlockingPage>
  CreateCaptivePortalBlockingPage(content::WebContents* web_contents,
                                  const GURL& request_url,
                                  const GURL& login_url,
                                  const net::SSLInfo& ssl_info,
                                  net::Error cert_error) = 0;

  // Creates a bad clock blocking page.
  virtual std::unique_ptr<BadClockBlockingPage> CreateBadClockBlockingPage(
      content::WebContents* web_contents,
      net::Error cert_error,
      const net::SSLInfo& ssl_info,
      const GURL& request_url,
      const base::Time& time_triggered,
      ssl_errors::ClockState clock_state) = 0;

  // Creates a man-in-the-middle software blocking page.
  virtual std::unique_ptr<MITMSoftwareBlockingPage>
  CreateMITMSoftwareBlockingPage(content::WebContents* web_contents,
                                 net::Error cert_error,
                                 const GURL& request_url,
                                 const net::SSLInfo& ssl_info,
                                 const std::string& mitm_software_name) = 0;

  // Creates a blocked interception blocking page.
  virtual std::unique_ptr<BlockedInterceptionBlockingPage>
  CreateBlockedInterceptionBlockingPage(content::WebContents* web_contents,
                                        net::Error cert_error,
                                        const GURL& request_url,
                                        const net::SSLInfo& ssl_info) = 0;

  virtual std::unique_ptr<security_interstitials::InsecureFormBlockingPage>
  CreateInsecureFormBlockingPage(content::WebContents* web_contents,
                                 const GURL& request_url) = 0;

  virtual std::unique_ptr<security_interstitials::HttpsOnlyModeBlockingPage>
  CreateHttpsOnlyModeBlockingPage(
      content::WebContents* web_contents,
      const GURL& request_url,
      security_interstitials::https_only_mode::HttpInterstitialState
          interstitial_state,
      std::optional<std::string> url_type_param,
      security_interstitials::HttpsOnlyModeBlockingPage::MetricsCallback
          metrics_callback) = 0;
};

#endif  // COMPONENTS_SECURITY_INTERSTITIALS_CONTENT_SECURITY_BLOCKING_PAGE_FACTORY_H_