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

#ifndef SERVICES_NETWORK_PUBLIC_CPP_INITIATOR_LOCK_COMPATIBILITY_H_
#define SERVICES_NETWORK_PUBLIC_CPP_INITIATOR_LOCK_COMPATIBILITY_H_

#include <optional>

#include "base/component_export.h"
#include "url/origin.h"
#include "url/origin_debug.h"

namespace network {

// These values are logged to UMA. Entries should not be renumbered and
// numeric values should never be reused. Please keep in sync with
// "RequestInitiatorOriginLockCompatibility" in
// tools/metrics/histograms/enums.xml.
enum class InitiatorLockCompatibility {
  // Request came from a browser process and so the
  // |request_initiator_origin_lock| doesn't apply.
  kBrowserProcess = 0,

  // |request_initiator_origin_lock| is missing.  For historical context see
  // https://crbug.com/1098938.
  kNoLock = 1,

  // |request_initiator| is missing.  This indicates that the renderer has a bug
  // or has been compromised by an attacker.
  kNoInitiator = 2,

  // |request.request_initiator| is compatible with
  // |factory_params_.request_initiator_origin_lock| - either
  // |request.request_initiator| is opaque or it is equal to
  // |request_initiator_origin_lock|.
  kCompatibleLock = 3,

  // |request.request_initiator| is incompatible with
  // |factory_params_.request_initiator_origin_lock|.  Cases known so far where
  // this can occur:
  // - HTML Imports (see https://crbug.com/871827#c9).
  kIncorrectLock = 4,

  kMaxValue = kIncorrectLock
};

// Verifies if |request.request_initiator| matches
// |factory_params.request_initiator_origin_lock|.
//
// This should only be called for requests from renderer processes
// (ones that are not coverd by the kExcludedPlugin exception).
COMPONENT_EXPORT(NETWORK_CPP)
InitiatorLockCompatibility VerifyRequestInitiatorLock(
    const std::optional<url::Origin>& request_initiator_origin_lock,
    const std::optional<url::Origin>& request_initiator);

namespace debug {

class COMPONENT_EXPORT(NETWORK_CPP) ScopedRequestInitiatorOriginLockCrashKey
    : public url::debug::ScopedOriginCrashKey {
 public:
  explicit ScopedRequestInitiatorOriginLockCrashKey(
      const std::optional<url::Origin>& request_initiator_origin_lock);
  ~ScopedRequestInitiatorOriginLockCrashKey();

  ScopedRequestInitiatorOriginLockCrashKey(
      const ScopedRequestInitiatorOriginLockCrashKey&) = delete;
  ScopedRequestInitiatorOriginLockCrashKey& operator=(
      const ScopedRequestInitiatorOriginLockCrashKey&) = delete;
};

}  // namespace debug

}  // namespace network

#endif  // SERVICES_NETWORK_PUBLIC_CPP_INITIATOR_LOCK_COMPATIBILITY_H_