1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/trusted_vault/standalone_trusted_vault_storage.h"
#include <memory>
#include "base/files/file_util.h"
#include "base/files/important_file_writer.h"
#include "base/hash/md5.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/metrics/histogram_functions.h"
#include "components/trusted_vault/proto_string_bytes_conversion.h"
#include "components/trusted_vault/standalone_trusted_vault_server_constants.h"
#include "components/trusted_vault/trusted_vault_histograms.h"
#include "components/trusted_vault/trusted_vault_server_constants.h"
namespace trusted_vault {
namespace {
constexpr base::FilePath::CharType kChromeSyncTrustedVaultFilename[] =
FILE_PATH_LITERAL("trusted_vault.pb");
constexpr base::FilePath::CharType kPasskeysTrustedVaultFilename[] =
FILE_PATH_LITERAL("passkeys_trusted_vault.pb");
constexpr int kCurrentLocalTrustedVaultVersion = 4;
base::FilePath GetBackendFilePath(const base::FilePath& base_dir,
SecurityDomainId security_domain) {
switch (security_domain) {
case SecurityDomainId::kChromeSync:
return base_dir.Append(kChromeSyncTrustedVaultFilename);
case SecurityDomainId::kPasskeys:
return base_dir.Append(kPasskeysTrustedVaultFilename);
}
NOTREACHED();
}
trusted_vault_pb::LocalTrustedVault ReadDataFromDiskImpl(
const base::FilePath& file_path,
SecurityDomainId security_domain_id) {
std::string file_content;
trusted_vault_pb::LocalTrustedVault data_proto;
if (!base::PathExists(file_path)) {
RecordTrustedVaultFileReadStatus(
security_domain_id, TrustedVaultFileReadStatusForUMA::kNotFound);
return data_proto;
}
if (!base::ReadFileToString(file_path, &file_content)) {
RecordTrustedVaultFileReadStatus(
security_domain_id, TrustedVaultFileReadStatusForUMA::kFileReadFailed);
return data_proto;
}
trusted_vault_pb::LocalTrustedVaultFileContent file_proto;
if (!file_proto.ParseFromString(file_content)) {
RecordTrustedVaultFileReadStatus(
security_domain_id,
TrustedVaultFileReadStatusForUMA::kFileProtoDeserializationFailed);
return data_proto;
}
if (base::MD5String(file_proto.serialized_local_trusted_vault()) !=
file_proto.md5_digest_hex_string()) {
RecordTrustedVaultFileReadStatus(
security_domain_id,
TrustedVaultFileReadStatusForUMA::kMD5DigestMismatch);
return data_proto;
}
if (!data_proto.ParseFromString(
file_proto.serialized_local_trusted_vault())) {
RecordTrustedVaultFileReadStatus(
security_domain_id,
TrustedVaultFileReadStatusForUMA::kDataProtoDeserializationFailed);
return data_proto;
}
RecordTrustedVaultFileReadStatus(security_domain_id,
TrustedVaultFileReadStatusForUMA::kSuccess);
return data_proto;
}
// Version 0 may contain corrupted data: missing constant key if the client
// was affected by crbug.com/1267391, this function injects constant key if it's
// not stored and there is exactly one non-constant key. |local_trusted_vault|
// must not be null and must have |version| set to 0.
void UpgradeToVersion1(
trusted_vault_pb::LocalTrustedVault* local_trusted_vault) {
CHECK(local_trusted_vault);
CHECK_EQ(local_trusted_vault->data_version(), 0);
std::string constant_key_as_proto_string;
AssignBytesToProtoString(GetConstantTrustedVaultKey(),
&constant_key_as_proto_string);
for (trusted_vault_pb::LocalTrustedVaultPerUser& per_user_vault :
*local_trusted_vault->mutable_user()) {
if (per_user_vault.vault_key_size() == 1 &&
per_user_vault.vault_key(0).key_material() !=
constant_key_as_proto_string) {
// Add constant key in the beginning.
*per_user_vault.add_vault_key() = per_user_vault.vault_key(0);
per_user_vault.mutable_vault_key(0)->set_key_material(
constant_key_as_proto_string);
}
}
local_trusted_vault->set_data_version(1);
}
// Version 1 may contain `keys_marked_as_stale_by_consumer` (before the field
// was renamed) accidentally set to true, upgrade to version 2 resets it to
// false.
void UpgradeToVersion2(
trusted_vault_pb::LocalTrustedVault* local_trusted_vault) {
CHECK(local_trusted_vault);
CHECK_EQ(local_trusted_vault->data_version(), 1);
for (trusted_vault_pb::LocalTrustedVaultPerUser& per_user_vault :
*local_trusted_vault->mutable_user()) {
per_user_vault.set_keys_marked_as_stale_by_consumer(false);
}
local_trusted_vault->set_data_version(2);
}
// Version 2 may contain `device_registered_version` set to 0 or 1, this concept
// was introduced a while ago to address a bug, upgrade to version 3 resets
// device registered flag to false if `device_registered_version` is 0, so the
// rest of the implementation doesn't need to handle this case.
void UpgradeToVersion3(
trusted_vault_pb::LocalTrustedVault* local_trusted_vault) {
CHECK(local_trusted_vault);
CHECK_EQ(local_trusted_vault->data_version(), 2);
for (trusted_vault_pb::LocalTrustedVaultPerUser& per_user_vault :
*local_trusted_vault->mutable_user()) {
if (per_user_vault.local_device_registration_info()
.device_registered_version() == 0) {
per_user_vault.mutable_local_device_registration_info()
->set_device_registered(false);
}
}
local_trusted_vault->set_data_version(3);
}
// Version 3 had the `last_registration_returned_local_data_obsolete` field in
// `LocalDeviceRegistrationInfo` message. That was migrated to the
// `LocalTrustedVaultPerUser` message in version 4.
void UpgradeToVersion4(
trusted_vault_pb::LocalTrustedVault* local_trusted_vault) {
CHECK(local_trusted_vault);
CHECK_EQ(local_trusted_vault->data_version(), 3);
for (trusted_vault_pb::LocalTrustedVaultPerUser& per_user_vault :
*local_trusted_vault->mutable_user()) {
if (per_user_vault.local_device_registration_info()
.has_deprecated_last_registration_returned_local_data_obsolete()) {
per_user_vault.set_last_registration_returned_local_data_obsolete(
per_user_vault.local_device_registration_info()
.deprecated_last_registration_returned_local_data_obsolete());
}
}
local_trusted_vault->set_data_version(4);
}
void WriteDataToDiskImpl(const trusted_vault_pb::LocalTrustedVault& data,
const base::FilePath& file_path,
SecurityDomainId security_domain_id) {
trusted_vault_pb::LocalTrustedVaultFileContent file_proto;
file_proto.set_serialized_local_trusted_vault(data.SerializeAsString());
file_proto.set_md5_digest_hex_string(
base::MD5String(file_proto.serialized_local_trusted_vault()));
bool success = base::ImportantFileWriter::WriteFileAtomically(
file_path, file_proto.SerializeAsString(), "TrustedVault");
if (!success) {
DLOG(ERROR) << "Failed to write trusted vault file.";
}
base::UmaHistogramBoolean("TrustedVault.FileWriteSuccess." +
GetSecurityDomainNameForUma(security_domain_id),
success);
}
// Default file access logic StandaloneTrustedVaultStorage.
// Responsible for mapping per user / per security domain storage to files,
// and required data migrations.
class DefaultFileAccess : public StandaloneTrustedVaultStorage::FileAccess {
public:
DefaultFileAccess(const base::FilePath& base_dir,
SecurityDomainId security_domain_id)
: file_path_(GetBackendFilePath(base_dir, security_domain_id)),
security_domain_id_(security_domain_id) {}
DefaultFileAccess(const DefaultFileAccess& other) = delete;
DefaultFileAccess& operator=(const DefaultFileAccess& other) = delete;
~DefaultFileAccess() override = default;
trusted_vault_pb::LocalTrustedVault ReadFromDisk() override {
auto data = ReadDataFromDiskImpl(file_path_, security_domain_id_);
if (data.user_size() == 0) {
// No data, set the current version and omit writing the file.
data.set_data_version(kCurrentLocalTrustedVaultVersion);
}
if (data.data_version() == 0) {
UpgradeToVersion1(&data);
WriteToDisk(data);
}
if (data.data_version() == 1) {
UpgradeToVersion2(&data);
WriteToDisk(data);
}
if (data.data_version() == 2) {
UpgradeToVersion3(&data);
WriteToDisk(data);
}
if (data.data_version() == 3) {
UpgradeToVersion4(&data);
WriteToDisk(data);
}
CHECK_EQ(data.data_version(), kCurrentLocalTrustedVaultVersion);
return data;
}
void WriteToDisk(const trusted_vault_pb::LocalTrustedVault& data) override {
WriteDataToDiskImpl(data, file_path_, security_domain_id_);
}
private:
const base::FilePath file_path_;
const SecurityDomainId security_domain_id_;
};
} // namespace
std::unique_ptr<StandaloneTrustedVaultStorage>
StandaloneTrustedVaultStorage::CreateForTesting(
std::unique_ptr<FileAccess> file_access) {
return base::WrapUnique(
new StandaloneTrustedVaultStorage(std::move(file_access)));
}
StandaloneTrustedVaultStorage::StandaloneTrustedVaultStorage(
const base::FilePath& base_dir,
SecurityDomainId security_domain_id)
: file_access_(
std::make_unique<DefaultFileAccess>(base_dir, security_domain_id)) {}
StandaloneTrustedVaultStorage::StandaloneTrustedVaultStorage(
std::unique_ptr<FileAccess> file_access)
: file_access_(std::move(file_access)) {
CHECK(file_access_);
}
StandaloneTrustedVaultStorage::~StandaloneTrustedVaultStorage() = default;
trusted_vault_pb::LocalTrustedVaultPerUser*
StandaloneTrustedVaultStorage::AddUserVault(const GaiaId& gaia_id) {
CHECK(FindUserVault(gaia_id) == nullptr);
auto* user_vault = data_.add_user();
user_vault->set_gaia_id(gaia_id.ToString());
return user_vault;
}
trusted_vault_pb::LocalTrustedVaultPerUser*
StandaloneTrustedVaultStorage::FindUserVault(const GaiaId& gaia_id) {
for (int i = 0; i < data_.user_size(); ++i) {
if (GaiaId(data_.user(i).gaia_id()) == gaia_id) {
return data_.mutable_user(i);
}
}
return nullptr;
}
void StandaloneTrustedVaultStorage::RemoveUserVaults(
base::FunctionRef<bool(const trusted_vault_pb::LocalTrustedVaultPerUser&)>
predicate) {
auto removed = std::ranges::remove_if(*data_.mutable_user(), predicate);
data_.mutable_user()->erase(removed.begin(), removed.end());
}
void StandaloneTrustedVaultStorage::ReadDataFromDisk() {
data_ = file_access_->ReadFromDisk();
}
void StandaloneTrustedVaultStorage::WriteDataToDisk() {
file_access_->WriteToDisk(data_);
}
// static
bool StandaloneTrustedVaultStorage::HasNonConstantKey(
const trusted_vault_pb::LocalTrustedVaultPerUser& per_user_vault) {
std::string constant_key_as_proto_string;
AssignBytesToProtoString(GetConstantTrustedVaultKey(),
&constant_key_as_proto_string);
for (const trusted_vault_pb::LocalTrustedVaultKey& key :
per_user_vault.vault_key()) {
if (key.key_material() != constant_key_as_proto_string) {
return true;
}
}
return false;
}
// static
std::vector<std::vector<uint8_t>>
StandaloneTrustedVaultStorage::GetAllVaultKeys(
const trusted_vault_pb::LocalTrustedVaultPerUser& per_user_vault) {
std::vector<std::vector<uint8_t>> vault_keys;
for (const trusted_vault_pb::LocalTrustedVaultKey& key :
per_user_vault.vault_key()) {
vault_keys.emplace_back(ProtoStringToBytes(key.key_material()));
}
return vault_keys;
}
} // namespace trusted_vault
|