Google Git
Sign in
chromium / chromium / src / lkgr / . / components / browsing_topics / util.cc
blob: c33c8924963c6da9c0208bc3831f1981ac5b2a32 [file] [log] [blame]
Avi Drissman8ba1bad2022-09-13 19:22:36[diff] [blame]1// Copyright 2022 The Chromium Authors
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#include "components/browsing_topics/util.h"
6
Peter Kastingccea09832025-01-27 18:38:22[diff] [blame]7#include <algorithm>
8
Elly4b270c42024-11-26 20:09:04[diff] [blame]9#include "base/numerics/byte_conversions.h"
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]10#include "base/rand_util.h"
Elly15dee24d2025-05-10 01:10:23[diff] [blame]11#include "crypto/hash.h"
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]12#include "crypto/hmac.h"
Yao Xiaoc95d3152022-03-18 03:43:22[diff] [blame]13#include "third_party/blink/public/common/features.h"
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]14
15namespace browsing_topics {
16
17namespace {
18
19// Note that updating the use case prefixes below will change the pre-existing
20// per-user stickiness. Some of the derived data may already have been persisted
21// elsewhere. Be sure you are aware of the implications before updating those
22// strings. Note also that the version here is just about the hash method, and
23// is distinctive from the broader configuration version of the Topics API.
24const char kRandomOrTopTopicDecisionPrefix[] =
25 "TopicsV1_RandomOrTopTopicDecision|";
26const char kRandomTopicIndexDecisionPrefix[] =
27 "TopicsV1_RandomTopicIndexDecision|";
28const char kTopTopicIndexDecisionPrefix[] = "TopicsV1_TopTopicIndexDecision|";
Yao Xiao7d287882024-09-28 16:22:31[diff] [blame]29const char kEpochIntroductionTimeDecisionPrefix[] =
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]30 "TopicsV1_EpochSwitchTimeDecision|";
Yao Xiao7d287882024-09-28 16:22:31[diff] [blame]31const char kEpochPhaseOutTimeDecisionPrefix[] =
32 "TopicsV1_EpochPhaseOutTimeDecision|";
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]33const char kContextDomainStoragePrefix[] = "TopicsV1_ContextDomainStorage|";
Yao Xiaoc95d3152022-03-18 03:43:22[diff] [blame]34const char kMainFrameHostStoragePrefix[] = "TopicsV1_MainFrameHostStorage|";
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]35
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]36uint64_t HmacHash(ReadOnlyHmacKey hmac_key,
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]37 const std::string& use_case_prefix,
38 const std::string& data) {
Elly4b270c42024-11-26 20:09:04[diff] [blame]39 auto hash = crypto::hmac::SignSha256(
40 hmac_key, base::as_byte_span(use_case_prefix + data));
41 return base::U64FromNativeEndian(base::span(hash).first<8u>());
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]42}
43
Peter Kasting4f54ba62022-10-29 01:45:01[diff] [blame]44bool g_hmac_key_overridden = false;
danakj95305d272024-05-09 20:38:44[diff] [blame]45
Peter Kasting4f54ba62022-10-29 01:45:01[diff] [blame]46browsing_topics::HmacKey& GetHmacKeyOverrideForTesting() {
47 static browsing_topics::HmacKey key;
48 return key;
49}
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]50
Yao Xiao63cc1fc2024-09-25 17:21:51[diff] [blame]51std::string GetEpochId(base::Time epoch_calculation_time) {
52 int64_t time_microseconds =
53 epoch_calculation_time.ToDeltaSinceWindowsEpoch().InMicroseconds();
54
55 return std::string(reinterpret_cast<const char*>(&time_microseconds),
56 sizeof(time_microseconds));
57}
58
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]59} // namespace
60
Yao Xiaoa7cada472024-04-11 20:44:19[diff] [blame]61bool DoesCalculationFailDueToHanging(CalculatorResultStatus status) {
62 return status == CalculatorResultStatus::kHangingAfterApiUsageRequested ||
63 status == CalculatorResultStatus::kHangingAfterHistoryRequested ||
64 status == CalculatorResultStatus::kHangingAfterModelRequested ||
65 status == CalculatorResultStatus::kHangingAfterAnnotationRequested;
66}
67
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]68HmacKey GenerateRandomHmacKey() {
Peter Kasting4f54ba62022-10-29 01:45:01[diff] [blame]69 if (g_hmac_key_overridden)
70 return GetHmacKeyOverrideForTesting();
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]71
72 HmacKey result = {};
danakj95305d272024-05-09 20:38:44[diff] [blame]73 base::RandBytes(result);
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]74
75 return result;
76}
77
78uint64_t HashTopDomainForRandomOrTopTopicDecision(
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]79 ReadOnlyHmacKey hmac_key,
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]80 base::Time epoch_calculation_time,
81 const std::string& top_domain) {
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]82 return HmacHash(hmac_key, kRandomOrTopTopicDecisionPrefix,
Yao Xiao63cc1fc2024-09-25 17:21:51[diff] [blame]83 GetEpochId(epoch_calculation_time) + top_domain);
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]84}
85
86uint64_t HashTopDomainForRandomTopicIndexDecision(
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]87 ReadOnlyHmacKey hmac_key,
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]88 base::Time epoch_calculation_time,
89 const std::string& top_domain) {
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]90 return HmacHash(hmac_key, kRandomTopicIndexDecisionPrefix,
Yao Xiao63cc1fc2024-09-25 17:21:51[diff] [blame]91 GetEpochId(epoch_calculation_time) + top_domain);
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]92}
93
94uint64_t HashTopDomainForTopTopicIndexDecision(
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]95 ReadOnlyHmacKey hmac_key,
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]96 base::Time epoch_calculation_time,
97 const std::string& top_domain) {
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]98 return HmacHash(hmac_key, kTopTopicIndexDecisionPrefix,
Yao Xiao63cc1fc2024-09-25 17:21:51[diff] [blame]99 GetEpochId(epoch_calculation_time) + top_domain);
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]100}
101
Yao Xiao7d287882024-09-28 16:22:31[diff] [blame]102uint64_t HashTopDomainForEpochIntroductionTimeDecision(
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]103 ReadOnlyHmacKey hmac_key,
Yao Xiao63cc1fc2024-09-25 17:21:51[diff] [blame]104 base::Time epoch_calculation_time,
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]105 const std::string& top_domain) {
Yao Xiao7d287882024-09-28 16:22:31[diff] [blame]106 return HmacHash(hmac_key, kEpochIntroductionTimeDecisionPrefix,
107 GetEpochId(epoch_calculation_time) + top_domain);
108}
109
110uint64_t HashTopDomainForEpochPhaseOutTimeDecision(
111 ReadOnlyHmacKey hmac_key,
112 base::Time epoch_calculation_time,
113 const std::string& top_domain) {
114 return HmacHash(hmac_key, kEpochPhaseOutTimeDecisionPrefix,
Yao Xiao63cc1fc2024-09-25 17:21:51[diff] [blame]115 GetEpochId(epoch_calculation_time) + top_domain);
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]116}
117
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]118HashedDomain HashContextDomainForStorage(ReadOnlyHmacKey hmac_key,
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]119 const std::string& context_domain) {
120 return HashedDomain(
121 HmacHash(hmac_key, kContextDomainStoragePrefix, context_domain));
122}
123
Yao Xiaoc95d3152022-03-18 03:43:22[diff] [blame]124HashedHost HashMainFrameHostForStorage(const std::string& main_frame_host) {
Elly15dee24d2025-05-10 01:10:23[diff] [blame]125 auto hash =
126 crypto::hash::Sha256(kMainFrameHostStoragePrefix + main_frame_host);
127 int64_t result = base::I64FromNativeEndian(base::span(hash).first<8u>());
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]128 return HashedHost(result);
129}
130
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]131void OverrideHmacKeyForTesting(ReadOnlyHmacKey hmac_key) {
Peter Kasting4f54ba62022-10-29 01:45:01[diff] [blame]132 g_hmac_key_overridden = true;
Peter Kastingccea09832025-01-27 18:38:22[diff] [blame]133 std::ranges::copy(hmac_key, GetHmacKeyOverrideForTesting().begin());
Yao Xiao0cb3fc12022-03-16 00:30:38[diff] [blame]134}
135
Yao Xiaodc070d12022-03-08 21:19:13[diff] [blame]136} // namespace browsing_topics