#include "content/browser/renderer_host/code_cache_host_impl.h"
#include <optional>
#include <string_view>
#include <utility>
#include "base/check_is_test.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/memory/weak_ptr.h"
#include "base/metrics/histogram_functions.h"
#include "base/strings/utf_string_conversions.h"
#include "base/thread_annotations.h"
#include "base/threading/thread.h"
#include "base/types/expected_macros.h"
#include "build/build_config.h"
#include "components/persistent_cache/pending_backend.h"
#include "components/services/storage/public/cpp/buckets/bucket_locator.h"
#include "components/services/storage/public/mojom/cache_storage_control.mojom.h"
#include "content/browser/child_process_security_policy_impl.h"
#include "content/browser/code_cache/generated_code_cache.h"
#include "content/browser/code_cache/generated_code_cache_context.h"
#include "content/browser/process_lock.h"
#include "content/browser/renderer_host/render_process_host_impl.h"
#include "content/public/browser/site_isolation_policy.h"
#include "content/public/browser/storage_partition.h"
#include "content/public/common/content_features.h"
#include "content/public/common/url_constants.h"
#include "mojo/public/cpp/base/big_buffer.h"
#include "mojo/public/cpp/bindings/self_owned_receiver.h"
#include "net/base/features.h"
#include "net/base/io_buffer.h"
#include "third_party/blink/public/common/cache_storage/cache_storage_utils.h"
#include "third_party/blink/public/common/features.h"
#include "third_party/blink/public/common/scheme_registry.h"
#include "third_party/blink/public/mojom/loader/code_cache.mojom-data-view.h"
#include "url/gurl.h"
#include "url/origin.h"
using blink::mojom::CacheStorageError;
namespace content {
namespace {
bool use_empty_secondary_key_for_testing_ = false;
enum class Operation {
kRead,
kWrite,
};
bool CheckSecurityForAccessingCodeCacheData(const GURL& resource_url,
int render_process_id,
Operation operation) {
if (!resource_url.is_valid()) {
return false;
}
ProcessLock process_lock =
ChildProcessSecurityPolicyImpl::GetInstance()->GetProcessLock(
render_process_id);
if (resource_url.SchemeIs(content::kChromeUIScheme) ||
resource_url.SchemeIs(content::kChromeUIUntrustedScheme)) {
if (!process_lock.IsLockedToSite()) {
return false;
}
if (process_lock.MatchesScheme(url::kHttpScheme) ||
process_lock.MatchesScheme(url::kHttpsScheme)) {
if (operation == Operation::kWrite) {
mojo::ReportBadMessage("HTTP(S) pages cannot cache WebUI code");
}
return false;
}
return process_lock.MatchesScheme(content::kChromeUIScheme) ||
process_lock.MatchesScheme(content::kChromeUIUntrustedScheme);
}
if (resource_url.SchemeIsHTTPOrHTTPS() ||
blink::CommonSchemeRegistry::IsExtensionScheme(
resource_url.GetScheme())) {
if (process_lock.MatchesScheme(content::kChromeUIScheme) ||
process_lock.MatchesScheme(content::kChromeUIUntrustedScheme)) {
return false;
}
return true;
}
#if BUILDFLAG(IS_OHOS)
if (resource_url.SchemeIsCodeCacheEnabled()) {
return true;
}
#endif
if (operation == Operation::kWrite) {
mojo::ReportBadMessage("Invalid URL scheme for code cache.");
}
return false;
}
std::optional<GURL> GetOriginLock(int render_process_id) {
ProcessLock process_lock =
ChildProcessSecurityPolicyImpl::GetInstance()->GetProcessLock(
render_process_id);
if (process_lock.MatchesScheme(content::kChromeUIScheme) ||
process_lock.MatchesScheme(content::kChromeUIUntrustedScheme)) {
if (!base::FeatureList::IsEnabled(features::kWebUICodeCache)) {
return std::nullopt;
}
if (blink::features::IsPersistentCacheForCodeCacheEnabled()) {
return std::nullopt;
}
}
if (!process_lock.IsLockedToSite()) {
return GURL();
}
if (process_lock.HasOpaqueOrigin()) {
return std::nullopt;
}
if (process_lock.MatchesScheme(url::kHttpScheme) ||
process_lock.MatchesScheme(url::kHttpsScheme) ||
process_lock.MatchesScheme(content::kChromeUIScheme) ||
process_lock.MatchesScheme(content::kChromeUIUntrustedScheme) ||
blink::CommonSchemeRegistry::IsExtensionScheme(
process_lock.GetProcessLockURL().GetScheme())) {
return process_lock.GetProcessLockURL();
}
return std::nullopt;
}
void DidGenerateCacheableMetadataInCacheStorageOnUI(
const GURL& url,
base::Time expected_response_time,
mojo_base::BigBuffer data,
const std::string& cache_storage_cache_name,
int render_process_id,
const blink::StorageKey& code_cache_storage_key,
storage::mojom::CacheStorageControl* cache_storage_control_for_testing,
mojo::ReportBadMessageCallback bad_message_callback) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
auto* render_process_host = RenderProcessHost::FromID(render_process_id);
if (!render_process_host)
return;
int64_t trace_id = blink::cache_storage::CreateTraceId();
TRACE_EVENT_WITH_FLOW1(
"CacheStorage",
"CodeCacheHostImpl::DidGenerateCacheableMetadataInCacheStorage",
TRACE_ID_GLOBAL(trace_id), TRACE_EVENT_FLAG_FLOW_OUT, "url", url.spec());
mojo::Remote<blink::mojom::CacheStorage> remote;
network::CrossOriginEmbedderPolicy cross_origin_embedder_policy;
network::DocumentIsolationPolicy document_isolation_policy;
storage::mojom::CacheStorageControl* cache_storage_control =
cache_storage_control_for_testing
? cache_storage_control_for_testing
: render_process_host->GetStoragePartition()
->GetCacheStorageControl();
cache_storage_control->AddReceiver(
cross_origin_embedder_policy, mojo::NullRemote(),
document_isolation_policy, mojo::NullRemote(),
storage::BucketLocator::ForDefaultBucket(code_cache_storage_key),
storage::mojom::CacheStorageOwner::kCacheAPI,
remote.BindNewPipeAndPassReceiver());
auto* raw_remote = remote.get();
raw_remote->Open(
base::UTF8ToUTF16(cache_storage_cache_name), trace_id,
base::BindOnce(
[](const GURL& url, base::Time expected_response_time,
mojo_base::BigBuffer data, int64_t trace_id,
mojo::Remote<blink::mojom::CacheStorage> preserve_remote_lifetime,
blink::mojom::CacheStorage::OpenResult result) {
if (!result.has_value()) {
return;
}
mojo::AssociatedRemote<blink::mojom::CacheStorageCache> remote;
remote.Bind(std::move(result.value()));
remote->WriteSideData(
url, expected_response_time, std::move(data), trace_id,
base::BindOnce(
[](mojo::Remote<blink::mojom::CacheStorage>
preserve_remote_lifetime,
CacheStorageError error) {
},
std::move(preserve_remote_lifetime)));
},
url, expected_response_time, std::move(data), trace_id,
std::move(remote)));
}
void AddCodeCacheReceiver(
mojo::UniqueReceiverSet<blink::mojom::CodeCacheHost>* receiver_set,
scoped_refptr<GeneratedCodeCacheContext> context,
int render_process_id,
const net::NetworkIsolationKey& nik,
const blink::StorageKey& storage_key,
mojo::PendingReceiver<blink::mojom::CodeCacheHost> receiver,
CodeCacheHostImpl::ReceiverSet::CodeCacheHostReceiverHandler handler) {
auto host =
CodeCacheHostImpl::Create(render_process_id, context, nik, storage_key);
auto* raw_host = host.get();
auto id = receiver_set->Add(std::move(host), std::move(receiver));
if (handler)
std::move(handler).Run(raw_host, id, *receiver_set);
}
class NoopCodeCacheHost : public CodeCacheHostImpl {
public:
NoopCodeCacheHost(
int render_process_id,
scoped_refptr<GeneratedCodeCacheContext> generated_code_cache_context,
const net::NetworkIsolationKey& nik,
const blink::StorageKey& storage_key)
: CodeCacheHostImpl(render_process_id,
std::move(generated_code_cache_context),
nik,
storage_key) {}
void GetPendingBackend(blink::mojom::CodeCacheType cache_type,
GetPendingBackendCallback callback) override {
std::move(callback).Run({});
}
void DidGenerateCacheableMetadata(blink::mojom::CodeCacheType cache_type,
const GURL& url,
base::Time expected_response_time,
mojo_base::BigBuffer data) override {}
void FetchCachedCode(blink::mojom::CodeCacheType cache_type,
const GURL& url,
FetchCachedCodeCallback callback) override {
std::move(callback).Run({}, {});
}
void ClearCodeCacheEntry(blink::mojom::CodeCacheType cache_type,
const GURL& url) override {}
};
class LocalCodeCacheHost : public CodeCacheHostImpl {
public:
LocalCodeCacheHost(
int render_process_id,
scoped_refptr<GeneratedCodeCacheContext> generated_code_cache_context,
const net::NetworkIsolationKey& nik,
const blink::StorageKey& storage_key)
: CodeCacheHostImpl(render_process_id,
std::move(generated_code_cache_context),
nik,
storage_key) {
CHECK(this->generated_code_cache_context());
}
void GetPendingBackend(blink::mojom::CodeCacheType cache_type,
GetPendingBackendCallback callback) override {
mojo::ReportBadMessage("Not using PersistentCache");
}
void DidGenerateCacheableMetadata(blink::mojom::CodeCacheType cache_type,
const GURL& url,
base::Time expected_response_time,
mojo_base::BigBuffer data) override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
ASSIGN_OR_RETURN(GURL secondary_key,
GetSecondaryKeyForCodeCache(url, render_process_id(),
Operation::kWrite),
[] {});
if (GeneratedCodeCache* code_cache = GetCodeCache(cache_type); code_cache) {
code_cache->WriteEntry(url, secondary_key, network_isolation_key(),
expected_response_time, std::move(data));
}
}
void FetchCachedCode(blink::mojom::CodeCacheType cache_type,
const GURL& url,
FetchCachedCodeCallback callback) override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
ASSIGN_OR_RETURN(
GURL secondary_key,
GetSecondaryKeyForCodeCache(url, render_process_id(), Operation::kRead),
[&callback] { std::move(callback).Run({}, {}); });
if (GeneratedCodeCache* code_cache = GetCodeCache(cache_type); code_cache) {
auto read_callback =
base::BindOnce(&LocalCodeCacheHost::OnReceiveCachedCode,
weak_ptr_factory_.GetWeakPtr(), cache_type,
base::TimeTicks::Now(), std::move(callback));
code_cache->FetchEntry(url, secondary_key, network_isolation_key(),
std::move(read_callback));
} else {
std::move(callback).Run(base::Time(), {});
}
}
void ClearCodeCacheEntry(blink::mojom::CodeCacheType cache_type,
const GURL& url) override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
ASSIGN_OR_RETURN(
GURL secondary_key,
GetSecondaryKeyForCodeCache(url, render_process_id(), Operation::kRead),
[] {});
if (GeneratedCodeCache* code_cache = GetCodeCache(cache_type); code_cache) {
code_cache->DeleteEntry(url, secondary_key, network_isolation_key());
}
}
private:
GeneratedCodeCache* GetCodeCache(blink::mojom::CodeCacheType cache_type)
VALID_CONTEXT_REQUIRED(sequence_checker_) {
ProcessLock process_lock =
ChildProcessSecurityPolicyImpl::GetInstance()->GetProcessLock(
render_process_id());
if (process_lock.MatchesScheme(content::kChromeUIScheme) ||
process_lock.MatchesScheme(content::kChromeUIUntrustedScheme)) {
if (cache_type == blink::mojom::CodeCacheType::kJavascript) {
return generated_code_cache_context()->generated_webui_js_code_cache();
}
return nullptr;
}
if (cache_type == blink::mojom::CodeCacheType::kJavascript) {
return generated_code_cache_context()->generated_js_code_cache();
}
DCHECK_EQ(blink::mojom::CodeCacheType::kWebAssembly, cache_type);
return generated_code_cache_context()->generated_wasm_code_cache();
}
static std::optional<GURL> GetSecondaryKeyForCodeCache(
const GURL& resource_url,
int render_process_id,
Operation operation) {
if (use_empty_secondary_key_for_testing_) {
return GURL();
}
if (!CheckSecurityForAccessingCodeCacheData(resource_url, render_process_id,
operation)) {
return std::nullopt;
}
return GetOriginLock(render_process_id);
}
void OnReceiveCachedCode(blink::mojom::CodeCacheType cache_type,
base::TimeTicks start_time,
FetchCachedCodeCallback callback,
const base::Time& response_time,
mojo_base::BigBuffer data) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (cache_type == blink::mojom::CodeCacheType::kJavascript &&
data.size() > 0) {
base::UmaHistogramTimes("SiteIsolatedCodeCache.JS.FetchCodeCache",
base::TimeTicks::Now() - start_time);
}
if (data.size() > 0) {
base::UmaHistogramCustomCounts("SiteIsolatedCodeCache.DataSize",
data.size(), 1, 10000000, 100);
}
std::move(callback).Run(response_time, std::move(data));
}
base::WeakPtrFactory<LocalCodeCacheHost> weak_ptr_factory_{this};
};
#if !BUILDFLAG(IS_FUCHSIA)
class CodeCacheWithPersistentCacheHost : public CodeCacheHostImpl {
public:
CodeCacheWithPersistentCacheHost(
int render_process_id,
scoped_refptr<GeneratedCodeCacheContext> generated_code_cache_context,
const net::NetworkIsolationKey& nik,
const blink::StorageKey& storage_key)
: CodeCacheHostImpl(render_process_id,
std::move(generated_code_cache_context),
nik,
storage_key) {
CHECK(this->generated_code_cache_context());
}
void GetPendingBackend(blink::mojom::CodeCacheType cache_type,
GetPendingBackendCallback callback) override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
ASSIGN_OR_RETURN(std::string cache_id, GetCacheId(cache_type),
[&callback] { std::move(callback).Run(std::nullopt); });
std::move(callback).Run(
generated_code_cache_context()->ShareReadOnlyConnection(cache_id));
}
void DidGenerateCacheableMetadata(blink::mojom::CodeCacheType cache_type,
const GURL& url,
base::Time expected_response_time,
mojo_base::BigBuffer data) override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!CheckSecurityForAccessingCodeCacheData(url, render_process_id(),
Operation::kWrite)) {
return;
}
ASSIGN_OR_RETURN(std::string cache_id, GetCacheId(cache_type), [] {});
std::string resource_key = GeneratedCodeCache::GetResourceKey(
url, MojoCacheTypeToCodeCacheType(cache_type));
generated_code_cache_context()->InsertIntoPersistentCacheCollection(
cache_id, resource_key, std::move(data),
persistent_cache::EntryMetadata{
.input_signature = expected_response_time.ToDeltaSinceWindowsEpoch()
.InMicroseconds()});
}
void FetchCachedCode(blink::mojom::CodeCacheType cache_type,
const GURL& url,
FetchCachedCodeCallback callback) override {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
CHECK_IS_TEST();
ASSIGN_OR_RETURN(std::string cache_id, GetCacheId(cache_type),
[&callback] { std::move(callback).Run({}, {}); });
std::string resource_key = GeneratedCodeCache::GetResourceKey(
url, MojoCacheTypeToCodeCacheType(cache_type));
if (auto metadata_and_content =
generated_code_cache_context()->FindInPersistentCacheCollection(
cache_id, resource_key);
metadata_and_content.has_value() &&
metadata_and_content->content.size() > 0) {
std::move(callback).Run(
base::Time::FromDeltaSinceWindowsEpoch(base::Microseconds(
metadata_and_content->metadata.input_signature)),
std::move(metadata_and_content->content));
} else {
std::move(callback).Run(base::Time(), mojo_base::BigBuffer());
}
}
void ClearCodeCacheEntry(blink::mojom::CodeCacheType cache_type,
const GURL& url) override {
}
private:
std::optional<std::string> GetCacheId(blink::mojom::CodeCacheType cache_type)
VALID_CONTEXT_REQUIRED(sequence_checker_) {
ASSIGN_OR_RETURN(
GURL origin_lock, GetOriginLock(render_process_id()),
[]() -> std::optional<std::string> { return std::nullopt; });
if (!origin_lock.is_empty()) {
return GeneratedCodeCache::GetContextKey(
origin_lock, network_isolation_key(),
MojoCacheTypeToCodeCacheType(cache_type));
}
if (content::SiteIsolationPolicy::IsSitePerProcessOrStricter()) {
return std::nullopt;
}
ProcessLock process_lock =
ChildProcessSecurityPolicyImpl::GetInstance()->GetProcessLock(
render_process_id());
static constexpr char kSharedContextKeyForRelaxedIsolation[] =
"_shared_context_for_relaxed_isolation";
static constexpr char kSharedContextKeyForRelaxedIsolationWebUi[] =
"_shared_context_for_relaxed_isolation_webui";
return process_lock.MatchesScheme(content::kChromeUIScheme) ||
process_lock.MatchesScheme(content::kChromeUIUntrustedScheme)
? kSharedContextKeyForRelaxedIsolationWebUi
: kSharedContextKeyForRelaxedIsolation;
}
static GeneratedCodeCache::CodeCacheType MojoCacheTypeToCodeCacheType(
blink::mojom::CodeCacheType type) {
switch (type) {
case blink::mojom::CodeCacheType::kJavascript:
return GeneratedCodeCache::CodeCacheType::kJavaScript;
case blink::mojom::CodeCacheType::kWebAssembly:
return GeneratedCodeCache::CodeCacheType::kWebAssembly;
}
}
};
#endif
}
CodeCacheHostImpl::ReceiverSet::ReceiverSet(
scoped_refptr<GeneratedCodeCacheContext> generated_code_cache_context)
: generated_code_cache_context_(generated_code_cache_context),
receiver_set_(
new mojo::UniqueReceiverSet<blink::mojom::CodeCacheHost>(),
base::OnTaskRunnerDeleter(GeneratedCodeCacheContext::GetTaskRunner(
generated_code_cache_context))) {}
CodeCacheHostImpl::ReceiverSet::~ReceiverSet() = default;
void CodeCacheHostImpl::ReceiverSet::Add(
int render_process_id,
const net::NetworkIsolationKey& nik,
const blink::StorageKey& storage_key,
mojo::PendingReceiver<blink::mojom::CodeCacheHost> receiver,
CodeCacheHostReceiverHandler handler) {
if (!receiver_set_) {
receiver_set_ = {
new mojo::UniqueReceiverSet<blink::mojom::CodeCacheHost>(),
base::OnTaskRunnerDeleter(GeneratedCodeCacheContext::GetTaskRunner(
generated_code_cache_context_))};
}
GeneratedCodeCacheContext::RunOrPostTask(
generated_code_cache_context_, FROM_HERE,
base::BindOnce(&AddCodeCacheReceiver, receiver_set_.get(),
generated_code_cache_context_, render_process_id, nik,
storage_key, std::move(receiver), std::move(handler)));
}
void CodeCacheHostImpl::ReceiverSet::Add(
int render_process_id,
const net::NetworkIsolationKey& nik,
const blink::StorageKey& storage_key,
mojo::PendingReceiver<blink::mojom::CodeCacheHost> receiver) {
Add(render_process_id, nik, storage_key, std::move(receiver),
CodeCacheHostReceiverHandler());
}
void CodeCacheHostImpl::ReceiverSet::Clear() {
receiver_set_.reset();
}
std::unique_ptr<CodeCacheHostImpl> CodeCacheHostImpl::Create(
int render_process_id,
scoped_refptr<GeneratedCodeCacheContext> generated_code_cache_context,
const net::NetworkIsolationKey& nik,
const blink::StorageKey& storage_key) {
if (!generated_code_cache_context) {
return std::make_unique<NoopCodeCacheHost>(
render_process_id, std::move(generated_code_cache_context), nik,
storage_key);
}
if (blink::features::IsPersistentCacheForCodeCacheEnabled()) {
#if !BUILDFLAG(IS_FUCHSIA)
return std::make_unique<CodeCacheWithPersistentCacheHost>(
render_process_id, std::move(generated_code_cache_context), nik,
storage_key);
#else
NOTREACHED();
#endif
}
return std::make_unique<LocalCodeCacheHost>(
render_process_id, std::move(generated_code_cache_context), nik,
storage_key);
}
CodeCacheHostImpl::~CodeCacheHostImpl() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
}
void CodeCacheHostImpl::SetCacheStorageControlForTesting(
storage::mojom::CacheStorageControl* cache_storage_control) {
cache_storage_control_for_testing_ = cache_storage_control;
}
void CodeCacheHostImpl::SetUseEmptySecondaryKeyForTesting() {
use_empty_secondary_key_for_testing_ = true;
}
CodeCacheHostImpl::CodeCacheHostImpl(
int render_process_id,
scoped_refptr<GeneratedCodeCacheContext> generated_code_cache_context,
const net::NetworkIsolationKey& nik,
const blink::StorageKey& storage_key)
: render_process_id_(render_process_id),
generated_code_cache_context_(std::move(generated_code_cache_context)),
network_isolation_key_(nik),
storage_key_(storage_key) {}
void CodeCacheHostImpl::DidGenerateCacheableMetadataInCacheStorage(
const GURL& url,
base::Time expected_response_time,
mojo_base::BigBuffer data,
const std::string& cache_storage_cache_name) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
GetUIThreadTaskRunner({})->PostTask(
FROM_HERE,
base::BindOnce(&DidGenerateCacheableMetadataInCacheStorageOnUI, url,
expected_response_time, std::move(data),
cache_storage_cache_name, render_process_id_, storage_key_,
cache_storage_control_for_testing_,
mojo::GetBadMessageCallback()));
}
}