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 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
|
// 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.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/40285824): Remove this and convert code to safer constructs.
#pragma allow_unsafe_buffers
#endif
#include "chrome/browser/policy/messaging_layer/public/report_client.h"
#include <memory>
#include <string>
#include <string_view>
#include <utility>
#include "base/base64.h"
#include "base/files/scoped_temp_dir.h"
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/strings/string_number_conversions.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "base/types/expected.h"
#include "base/values.h"
#include "chrome/browser/enterprise/browser_management/management_service_factory.h"
#include "chrome/browser/policy/messaging_layer/public/report_client_test_util.h"
#include "chrome/browser/policy/messaging_layer/upload/file_upload_job_test_util.h"
#include "chrome/browser/policy/messaging_layer/util/dm_token_retriever_provider.h"
#include "chrome/browser/policy/messaging_layer/util/reporting_server_connector.h"
#include "chrome/browser/policy/messaging_layer/util/reporting_server_connector_test_util.h"
#include "chrome/browser/policy/messaging_layer/util/test_request_payload.h"
#include "components/policy/core/common/management/scoped_management_service_override_for_testing.h"
#include "components/reporting/client/dm_token_retriever.h"
#include "components/reporting/client/mock_dm_token_retriever.h"
#include "components/reporting/client/report_queue_configuration.h"
#include "components/reporting/client/report_queue_provider.h"
#include "components/reporting/encryption/decryption.h"
#include "components/reporting/encryption/primitives.h"
#include "components/reporting/encryption/testing_primitives.h"
#include "components/reporting/proto/synced/record_constants.pb.h"
#include "components/reporting/util/encrypted_reporting_json_keys.h"
#include "components/reporting/util/status.h"
#include "components/reporting/util/statusor.h"
#include "components/reporting/util/test_support_callbacks.h"
#include "content/public/test/browser_task_environment.h"
#include "testing/gtest/include/gtest/gtest.h"
using ::testing::_;
using ::testing::Eq;
using ::testing::Invoke;
using ::testing::Ne;
using ::testing::SizeIs;
using ::testing::StrEq;
using ::testing::StrictMock;
using ::testing::WithArgs;
namespace reporting {
namespace {
constexpr char kDMToken[] = "TOKEN";
class ReportClientTest : public ::testing::TestWithParam<bool> {
protected:
void SetUp() override {
// Encryption is enabled by default.
if (is_encryption_enabled()) {
// Generate signing key pair.
test::GenerateSigningKeyPair(signing_private_key_,
signature_verification_public_key_);
// Create decryption module.
auto decryptor_result = test::Decryptor::Create();
ASSERT_OK(decryptor_result) << decryptor_result.error();
decryptor_ = std::move(decryptor_result.value());
// Prepare the key.
signed_encryption_key_ = GenerateAndSignKey();
} else {
// Disable encryption.
scoped_feature_list_.InitFromCommandLine("", "EncryptedReporting");
}
// Provide client test environment with local storage.
#if BUILDFLAG(IS_CHROMEOS)
test_reporting_ =
ReportingClient::TestEnvironment::CreateWithStorageModule();
#else
ASSERT_TRUE(location_.CreateUniqueTempDir());
test_reporting_ = ReportingClient::TestEnvironment::CreateWithLocalStorage(
location_.GetPath(),
std::string_view(
reinterpret_cast<const char*>(signature_verification_public_key_),
kKeySize));
#endif
// Use MockDMTokenRetriever and configure it to always return the test DM
// token by default
MockDMTokenRetrieverWithResult(kDMToken);
}
void TearDown() override {
// Let everything ongoing to finish.
task_environment_.RunUntilIdle();
}
SignedEncryptionInfo GenerateAndSignKey() {
CHECK(decryptor_) << "Decryptor not created";
// Generate new pair of private key and public value.
uint8_t private_key[kKeySize];
Encryptor::PublicKeyId public_key_id;
uint8_t public_value[kKeySize];
test::GenerateEncryptionKeyPair(private_key, public_value);
test::TestEvent<StatusOr<Encryptor::PublicKeyId>> prepare_key_pair;
decryptor_->RecordKeyPair(
std::string(reinterpret_cast<const char*>(private_key), kKeySize),
std::string(reinterpret_cast<const char*>(public_value), kKeySize),
prepare_key_pair.cb());
auto prepare_key_result = prepare_key_pair.result();
CHECK(prepare_key_result.has_value()) << prepare_key_result.error();
public_key_id = prepare_key_result.value();
// Prepare public key to be delivered to Storage.
SignedEncryptionInfo signed_encryption_key;
signed_encryption_key.set_public_asymmetric_key(
std::string(reinterpret_cast<const char*>(public_value), kKeySize));
signed_encryption_key.set_public_key_id(public_key_id);
// Sign public key.
uint8_t value_to_sign[sizeof(Encryptor::PublicKeyId) + kKeySize];
memcpy(value_to_sign, &public_key_id, sizeof(Encryptor::PublicKeyId));
memcpy(value_to_sign + sizeof(Encryptor::PublicKeyId), public_value,
kKeySize);
uint8_t signature[kSignatureSize];
test::SignMessage(
signing_private_key_,
std::string_view(reinterpret_cast<const char*>(value_to_sign),
sizeof(value_to_sign)),
signature);
signed_encryption_key.set_signature(
std::string(reinterpret_cast<const char*>(signature), kSignatureSize));
// Double check signature.
EXPECT_TRUE(VerifySignature(
signature_verification_public_key_,
std::string_view(reinterpret_cast<const char*>(value_to_sign),
sizeof(value_to_sign)),
signature));
return signed_encryption_key;
}
StatusOr<std::unique_ptr<ReportQueue>> CreateQueue() {
auto config_result =
ReportQueueConfiguration::Create(
{.event_type = EventType::kUser, .destination = destination_})
.SetPolicyCheckCallback(policy_checker_callback_)
.Build();
EXPECT_TRUE(config_result.has_value()) << config_result.error();
return CreateQueueWithConfig(std::move(config_result.value()));
}
StatusOr<std::unique_ptr<ReportQueue>> CreateQueueWithConfig(
std::unique_ptr<ReportQueueConfiguration> report_queue_config) {
// Save a reference to report queue config so we can validate what DM token
// was set later in the test
report_queue_config_ = report_queue_config.get();
test::TestEvent<StatusOr<std::unique_ptr<ReportQueue>>> create_queue_event;
ReportQueueProvider::CreateQueue(std::move(report_queue_config),
create_queue_event.cb());
auto report_queue_result = create_queue_event.result();
// Let everything ongoing to finish.
task_environment_.RunUntilIdle();
return report_queue_result;
}
std::unique_ptr<ReportQueue, base::OnTaskRunnerDeleter>
CreateSpeculativeQueue() {
auto config_result =
ReportQueueConfiguration::Create(
{.event_type = EventType::kUser, .destination = destination_})
.SetPolicyCheckCallback(policy_checker_callback_)
.Build();
EXPECT_TRUE(config_result.has_value()) << config_result.error();
return CreateSpeculativeQueueWithConfig(std::move(config_result.value()));
}
std::unique_ptr<ReportQueue, base::OnTaskRunnerDeleter>
CreateSpeculativeQueueWithConfig(
std::unique_ptr<ReportQueueConfiguration> report_queue_config) {
// Save a reference to report queue config so we can validate what DM token
// was set
report_queue_config_ = report_queue_config.get();
auto speculative_queue_result = ReportQueueProvider::CreateSpeculativeQueue(
std::move(report_queue_config));
EXPECT_TRUE(speculative_queue_result.has_value())
<< speculative_queue_result.error();
return std::move(speculative_queue_result.value());
}
bool is_encryption_enabled() const { return GetParam(); }
base::Value::Dict GetEncryptionKeyResponse() {
base::Value::Dict encryption_settings;
std::string public_key =
base::Base64Encode(signed_encryption_key_.public_asymmetric_key());
encryption_settings.Set(json_keys::kPublicKey, public_key);
encryption_settings.Set(json_keys::kPublicKeyId,
signed_encryption_key_.public_key_id());
std::string public_key_signature =
base::Base64Encode(signed_encryption_key_.signature());
encryption_settings.Set(json_keys::kPublicKeySignature,
public_key_signature);
base::Value::Dict response;
response.Set(json_keys::kEncryptionSettings,
std::move(encryption_settings));
return response;
}
void VerifyDataUpload(base::Value::Dict payload) {
base::Value::List* const records =
payload.FindList(json_keys::kEncryptedRecordList);
ASSERT_THAT(records, Ne(nullptr));
ASSERT_THAT(*records, SizeIs(1));
const base::Value::Dict& record = (*records)[0].GetDict();
if (is_encryption_enabled()) {
const base::Value::Dict* const encryption_info =
record.FindDict(json_keys::kEncryptionInfo);
ASSERT_THAT(encryption_info, Ne(nullptr));
const std::string* const encryption_key =
encryption_info->FindString(json_keys::kEncryptionKey);
ASSERT_THAT(encryption_key, Ne(nullptr));
const std::string* const public_key_id =
encryption_info->FindString(json_keys::kPublicKeyId);
ASSERT_THAT(public_key_id, Ne(nullptr));
int64_t key_id;
ASSERT_TRUE(base::StringToInt64(*public_key_id, &key_id));
EXPECT_THAT(key_id, Eq(signed_encryption_key_.public_key_id()));
} else {
ASSERT_FALSE(record.contains(json_keys::kEncryptionInfo));
}
const base::Value::Dict* const seq_info =
record.FindDict(json_keys::kSequenceInformation);
ASSERT_THAT(seq_info, Ne(nullptr));
}
// Forces |DMTokenRetrieverProvider| to use the |MockDMTokenRetriever| by
// default and return specified result through the completion callback on
// trigger.
void MockDMTokenRetrieverWithResult(
const StatusOr<std::string> dm_token_result) {
DMTokenRetrieverProvider::SetDMTokenRetrieverCallbackForTesting(
base::BindRepeating(
[](const StatusOr<std::string> dm_token_result,
EventType event_type) -> std::unique_ptr<DMTokenRetriever> {
auto dm_token_retriever =
std::make_unique<StrictMock<MockDMTokenRetriever>>();
dm_token_retriever->ExpectRetrieveDMTokenAndReturnResult(
/*times=*/1, dm_token_result);
return std::move(dm_token_retriever);
},
std::move(dm_token_result)));
}
base::test::ScopedFeatureList scoped_feature_list_;
// BrowserTaskEnvironment must be instantiated before other classes that posts
// tasks.
content::BrowserTaskEnvironment task_environment_{
base::test::TaskEnvironment::TimeSource::MOCK_TIME};
// Set up this device as a managed device.
policy::ScopedManagementServiceOverrideForTesting scoped_management_service_ =
policy::ScopedManagementServiceOverrideForTesting(
policy::ManagementServiceFactory::GetForPlatform(),
policy::EnterpriseManagementAuthority::CLOUD_DOMAIN);
ReportingServerConnector::TestEnvironment test_env_;
FileUploadJob::TestEnvironment manager_test_env_;
std::unique_ptr<ReportingClient::TestEnvironment> test_reporting_;
base::ScopedTempDir location_;
uint8_t signature_verification_public_key_[kKeySize];
uint8_t signing_private_key_[kSignKeySize];
scoped_refptr<test::Decryptor> decryptor_;
SignedEncryptionInfo signed_encryption_key_;
raw_ptr<ReportQueueConfiguration, DanglingUntriaged> report_queue_config_;
const Destination destination_ = Destination::UPLOAD_EVENTS;
ReportQueueConfiguration::PolicyCheckCallback policy_checker_callback_ =
base::BindRepeating([]() { return Status::StatusOK(); });
};
// Tests that a ReportQueue can be created using the ReportingClient with a DM
// token.
//
// This scenario will eventually be deleted once we have migrated all events
// over to use event types instead.
TEST_P(ReportClientTest, CreatesReportQueueWithDMToken) {
static constexpr char random_dm_token[] = "RANDOM DM TOKEN";
auto config_result =
ReportQueueConfiguration::Create({.destination = destination_})
.SetDMToken(random_dm_token)
.SetPolicyCheckCallback(policy_checker_callback_)
.Build();
EXPECT_TRUE(config_result.has_value());
auto report_queue_result =
CreateQueueWithConfig(std::move(config_result.value()));
ASSERT_TRUE(report_queue_result.has_value());
ASSERT_THAT(std::move(report_queue_result.value()).get(), Ne(nullptr));
EXPECT_THAT(report_queue_config_->dm_token(), StrEq(random_dm_token));
}
// Tests that a ReportQueue can be created using the ReportingClient given an
// event type.
TEST_P(ReportClientTest, CreatesReportQueueGivenEventType) {
auto report_queue_result = CreateQueue();
ASSERT_TRUE(report_queue_result.has_value());
ASSERT_THAT(std::move(report_queue_result.value()).get(), Ne(nullptr));
EXPECT_THAT(report_queue_config_->dm_token(), StrEq(kDMToken));
}
// Tests that a ReportQueue cannot be created when there is DM token retrieval
// failure
TEST_P(ReportClientTest, CreateReportQueueWhenDMTokenRetrievalFailure) {
MockDMTokenRetrieverWithResult(base::unexpected(
Status(error::INTERNAL, "Simulated DM token retrieval failure")));
auto report_queue_result = CreateQueue();
ASSERT_FALSE(report_queue_result.has_value());
EXPECT_EQ(report_queue_result.error().error_code(), error::INTERNAL);
}
// Ensures that created ReportQueues are actually different.
TEST_P(ReportClientTest, CreatesTwoDifferentReportQueues) {
// Create first queue.
auto report_queue_result_1 = CreateQueue();
ASSERT_TRUE(report_queue_result_1.has_value());
// Create second queue. It will reuse the same ReportClient, so even if
// encryption is enabled, there will be no roundtrip to server to get the key.
auto report_queue_result_2 = CreateQueue();
ASSERT_TRUE(report_queue_result_2.has_value());
auto report_queue_1 = std::move(report_queue_result_1.value());
auto report_queue_2 = std::move(report_queue_result_2.value());
ASSERT_THAT(report_queue_1.get(), Ne(nullptr));
ASSERT_THAT(report_queue_2.get(), Ne(nullptr));
EXPECT_NE(report_queue_1.get(), report_queue_2.get());
}
// Remaining tests are only available with local storage option that does not
// exist on ChromeOS configuration.
#if !BUILDFLAG(IS_CHROMEOS)
// Creates queue, enqueues message and verifies it is uploaded.
TEST_P(ReportClientTest, EnqueueMessageAndUpload) {
// Create queue.
auto report_queue_result = CreateQueue();
ASSERT_TRUE(report_queue_result.has_value());
test::TestEvent<Status> enqueue_record_event;
std::move(report_queue_result.value())
->Enqueue("Record", FAST_BATCH, enqueue_record_event.cb());
if (is_encryption_enabled()) {
task_environment_.RunUntilIdle();
// Uploader is available, let it set the key.
ASSERT_THAT(*test_env_.url_loader_factory()->pending_requests(),
testing::SizeIs(1));
EXPECT_THAT(test_env_.request_body(0),
IsEncryptionKeyRequestUploadRequestValid());
test_env_.SimulateCustomResponseForRequest(0, GetEncryptionKeyResponse());
}
const auto enqueue_record_result = enqueue_record_event.result();
EXPECT_OK(enqueue_record_result) << enqueue_record_result;
// Trigger upload.
task_environment_.FastForwardBy(base::Seconds(1));
ASSERT_THAT(*test_env_.url_loader_factory()->pending_requests(),
testing::SizeIs(1));
base::Value::Dict request_body = test_env_.request_body(0);
EXPECT_THAT(request_body, IsDataUploadRequestValid());
VerifyDataUpload(std::move(request_body));
test_env_.SimulateResponseForRequest(0);
}
// Creates speculative queue, enqueues message and verifies it is uploaded
// eventually.
TEST_P(ReportClientTest, SpeculativelyEnqueueMessageAndUpload) {
// Create queue.
auto report_queue = CreateSpeculativeQueue();
// Enqueue event right away, before attaching an actual queue.
test::TestEvent<Status> enqueue_record_event;
report_queue->Enqueue("Record", FAST_BATCH, enqueue_record_event.cb());
if (is_encryption_enabled()) {
task_environment_.RunUntilIdle();
ASSERT_THAT(*test_env_.url_loader_factory()->pending_requests(),
testing::SizeIs(1));
EXPECT_THAT(test_env_.request_body(0),
IsEncryptionKeyRequestUploadRequestValid());
test_env_.SimulateCustomResponseForRequest(0, GetEncryptionKeyResponse());
}
const auto enqueue_record_result = enqueue_record_event.result();
EXPECT_OK(enqueue_record_result) << enqueue_record_result;
// Trigger upload.
task_environment_.FastForwardBy(base::Seconds(1));
ASSERT_THAT(*test_env_.url_loader_factory()->pending_requests(),
testing::SizeIs(1));
base::Value::Dict request_body = test_env_.request_body(0);
EXPECT_THAT(request_body, IsDataUploadRequestValid());
VerifyDataUpload(std::move(request_body));
test_env_.SimulateResponseForRequest(0);
}
#endif // !BUILDFLAG(IS_CHROMEOS)
INSTANTIATE_TEST_SUITE_P(ReportClientTestSuite,
ReportClientTest,
::testing::Bool() /* true - encryption enabled */);
} // namespace
} // namespace reporting
|