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
|
// Copyright 2019 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/sharing_message/sharing_fcm_sender.h"
#include <memory>
#include "base/base64.h"
#include "base/callback_list.h"
#include "base/memory/ptr_util.h"
#include "base/memory/raw_ptr.h"
#include "base/test/mock_callback.h"
#include "components/gcm_driver/crypto/gcm_encryption_result.h"
#include "components/gcm_driver/fake_gcm_driver.h"
#include "components/sharing_message/features.h"
#include "components/sharing_message/proto/sharing_message.pb.h"
#include "components/sharing_message/sharing_constants.h"
#include "components/sharing_message/sharing_message_bridge.h"
#include "components/sharing_message/sharing_sync_preference.h"
#include "components/sharing_message/sharing_utils.h"
#include "components/sync/model/data_type_controller_delegate.h"
#include "components/sync/test/test_sync_service.h"
#include "components/sync_device_info/device_info.h"
#include "components/sync_device_info/fake_device_info_sync_service.h"
#include "components/sync_device_info/fake_local_device_info_provider.h"
#include "components/sync_preferences/testing_pref_service_syncable.h"
#include "crypto/ec_private_key.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace {
using testing::_;
const char kSenderIdFcmToken[] = "sender_id_fcm_token";
const char kSenderIdP256dh[] = "sender_id_p256dh";
const char kSenderIdAuthSecret[] = "sender_id_auth_secret";
const int kTtlSeconds = 10;
const char kServerConfiguration[] = "test_server_configuration";
const char kServerP256dh[] = "test_server_p256_dh";
const char kServerAuthSecret[] = "test_server_auth_secret";
class FakeGCMDriver : public gcm::FakeGCMDriver {
public:
FakeGCMDriver() = default;
FakeGCMDriver(const FakeGCMDriver&) = delete;
FakeGCMDriver& operator=(const FakeGCMDriver&) = delete;
~FakeGCMDriver() override = default;
void EncryptMessage(const std::string& app_id,
const std::string& authorized_entity,
const std::string& p256dh,
const std::string& auth_secret,
const std::string& message,
EncryptMessageCallback callback) override {
app_id_ = app_id;
authorized_entity_ = authorized_entity;
p256dh_ = p256dh;
auth_secret_ = auth_secret;
std::move(callback).Run(gcm::GCMEncryptionResult::ENCRYPTED_DRAFT_08,
message);
}
const std::string& app_id() { return app_id_; }
const std::string& authorized_entity() { return authorized_entity_; }
const std::string& p256dh() { return p256dh_; }
const std::string& auth_secret() { return auth_secret_; }
private:
std::string app_id_, authorized_entity_, p256dh_, auth_secret_;
};
class FakeSharingMessageBridge : public SharingMessageBridge {
public:
FakeSharingMessageBridge() = default;
FakeSharingMessageBridge(const FakeSharingMessageBridge&) = delete;
FakeSharingMessageBridge& operator=(const FakeSharingMessageBridge&) = delete;
~FakeSharingMessageBridge() override = default;
// SharingMessageBridge:
void SendSharingMessage(
std::unique_ptr<sync_pb::SharingMessageSpecifics> specifics,
CommitFinishedCallback on_commit_callback) override {
specifics_ = std::move(*specifics);
sync_pb::SharingMessageCommitError commit_error;
commit_error.set_error_code(error_code_);
std::move(on_commit_callback).Run(commit_error);
}
// SharingMessageBridge:
base::WeakPtr<syncer::DataTypeControllerDelegate> GetControllerDelegate()
override {
return nullptr;
}
const std::optional<sync_pb::SharingMessageSpecifics>& specifics() {
return specifics_;
}
void set_error_code(
const sync_pb::SharingMessageCommitError::ErrorCode& error_code) {
error_code_ = error_code;
}
private:
std::optional<sync_pb::SharingMessageSpecifics> specifics_;
sync_pb::SharingMessageCommitError::ErrorCode error_code_ =
sync_pb::SharingMessageCommitError::NONE;
};
class SharingFCMSenderTest : public testing::Test {
public:
void OnMessageSent(SharingSendMessageResult* result_out,
std::optional<std::string>* message_id_out,
SharingChannelType* channel_type_out,
SharingSendMessageResult result,
std::optional<std::string> message_id,
SharingChannelType channel_type) {
*result_out = result;
*message_id_out = std::move(message_id);
*channel_type_out = channel_type;
}
protected:
SharingFCMSenderTest()
: sync_prefs_(&prefs_, &fake_device_info_sync_service_),
sharing_fcm_sender_(
&fake_sharing_message_bridge_,
&sync_prefs_,
&fake_gcm_driver_,
fake_device_info_sync_service_.GetDeviceInfoTracker(),
&fake_local_device_info_provider_,
&test_sync_service_,
mock_sync_flare_.Get()) {
SharingSyncPreference::RegisterProfilePrefs(prefs_.registry());
}
sync_preferences::TestingPrefServiceSyncable prefs_;
FakeSharingMessageBridge fake_sharing_message_bridge_;
syncer::FakeDeviceInfoSyncService fake_device_info_sync_service_;
SharingSyncPreference sync_prefs_;
FakeGCMDriver fake_gcm_driver_;
syncer::FakeLocalDeviceInfoProvider fake_local_device_info_provider_;
syncer::TestSyncService test_sync_service_;
base::MockCallback<syncer::SyncableService::StartSyncFlare> mock_sync_flare_;
SharingFCMSender sharing_fcm_sender_;
};
TEST_F(SharingFCMSenderTest, NoFcmRegistration) {
sync_prefs_.ClearFCMRegistration();
// Do not populate sender ID channel.
components_sharing_message::FCMChannelConfiguration fcm_channel;
SharingSendMessageResult result;
std::optional<std::string> message_id;
SharingChannelType channel_type;
components_sharing_message::SharingMessage sharing_message;
sharing_message.mutable_ack_message();
sharing_fcm_sender_.SendMessageToFcmTarget(
fcm_channel, base::Seconds(kTtlSeconds), std::move(sharing_message),
base::BindOnce(&SharingFCMSenderTest::OnMessageSent,
base::Unretained(this), &result, &message_id,
&channel_type));
EXPECT_EQ(SharingSendMessageResult::kDeviceNotFound, result);
EXPECT_FALSE(message_id);
EXPECT_EQ(SharingChannelType::kUnknown, channel_type);
}
TEST_F(SharingFCMSenderTest, NoChannelsSpecified) {
sync_prefs_.SetFCMRegistration(
SharingSyncPreference::FCMRegistration(base::Time::Now()));
components_sharing_message::FCMChannelConfiguration fcm_channel;
// Don't set any channels.
SharingSendMessageResult result;
std::optional<std::string> message_id;
SharingChannelType channel_type;
components_sharing_message::SharingMessage sharing_message;
sharing_message.mutable_ack_message();
sharing_fcm_sender_.SendMessageToFcmTarget(
fcm_channel, base::Seconds(kTtlSeconds), std::move(sharing_message),
base::BindOnce(&SharingFCMSenderTest::OnMessageSent,
base::Unretained(this), &result, &message_id,
&channel_type));
EXPECT_EQ(SharingSendMessageResult::kDeviceNotFound, result);
EXPECT_FALSE(message_id);
EXPECT_EQ(SharingChannelType::kUnknown, channel_type);
}
TEST_F(SharingFCMSenderTest, PreferSync) {
sync_prefs_.SetFCMRegistration(
SharingSyncPreference::FCMRegistration(base::Time::Now()));
fake_sharing_message_bridge_.set_error_code(
sync_pb::SharingMessageCommitError::NONE);
components_sharing_message::FCMChannelConfiguration fcm_channel;
fcm_channel.set_sender_id_fcm_token(kSenderIdFcmToken);
fcm_channel.set_sender_id_p256dh(kSenderIdP256dh);
fcm_channel.set_sender_id_auth_secret(kSenderIdAuthSecret);
SharingSendMessageResult result;
std::optional<std::string> message_id;
SharingChannelType channel_type;
components_sharing_message::SharingMessage sharing_message;
sharing_message.mutable_ping_message();
sharing_fcm_sender_.SendMessageToFcmTarget(
fcm_channel, base::Seconds(kTtlSeconds), std::move(sharing_message),
base::BindOnce(&SharingFCMSenderTest::OnMessageSent,
base::Unretained(this), &result, &message_id,
&channel_type));
EXPECT_EQ(SharingSendMessageResult::kSuccessful, result);
// Ensures that a Ping message is sent through SharingMessageBridge.
components_sharing_message::SharingMessage message_sent;
ASSERT_TRUE(fake_sharing_message_bridge_.specifics());
ASSERT_TRUE(fake_sharing_message_bridge_.specifics()->has_payload());
message_sent.ParseFromString(
fake_sharing_message_bridge_.specifics()->payload());
EXPECT_TRUE(message_sent.has_ping_message());
}
struct CommitErrorCodeTestData {
const sync_pb::SharingMessageCommitError::ErrorCode commit_error_code;
const SharingSendMessageResult expected_result;
} kCommitErrorCodeTestData[] = {
{sync_pb::SharingMessageCommitError::NONE,
SharingSendMessageResult::kSuccessful},
{sync_pb::SharingMessageCommitError::NOT_FOUND,
SharingSendMessageResult::kDeviceNotFound},
{sync_pb::SharingMessageCommitError::INVALID_ARGUMENT,
SharingSendMessageResult::kPayloadTooLarge},
{sync_pb::SharingMessageCommitError::INTERNAL,
SharingSendMessageResult::kInternalError},
{sync_pb::SharingMessageCommitError::UNAVAILABLE,
SharingSendMessageResult::kInternalError},
{sync_pb::SharingMessageCommitError::RESOURCE_EXHAUSTED,
SharingSendMessageResult::kInternalError},
{sync_pb::SharingMessageCommitError::UNAUTHENTICATED,
SharingSendMessageResult::kInternalError},
{sync_pb::SharingMessageCommitError::PERMISSION_DENIED,
SharingSendMessageResult::kInternalError},
{sync_pb::SharingMessageCommitError::SYNC_TURNED_OFF,
SharingSendMessageResult::kInternalError},
{sync_pb::SharingMessageCommitError::SYNC_NETWORK_ERROR,
SharingSendMessageResult::kNetworkError},
{sync_pb::SharingMessageCommitError::SYNC_SERVER_ERROR,
SharingSendMessageResult::kInternalError},
{sync_pb::SharingMessageCommitError::SYNC_TIMEOUT,
SharingSendMessageResult::kCommitTimeout}};
class SharingFCMSenderCommitErrorCodeTest
: public SharingFCMSenderTest,
public testing::WithParamInterface<CommitErrorCodeTestData> {};
TEST_P(SharingFCMSenderCommitErrorCodeTest, ErrorCodeTest) {
fake_sharing_message_bridge_.set_error_code(GetParam().commit_error_code);
components_sharing_message::FCMChannelConfiguration fcm_channel;
fcm_channel.set_sender_id_fcm_token(kSenderIdFcmToken);
fcm_channel.set_sender_id_p256dh(kSenderIdP256dh);
fcm_channel.set_sender_id_auth_secret(kSenderIdAuthSecret);
SharingSendMessageResult result;
std::optional<std::string> message_id;
SharingChannelType channel_type;
components_sharing_message::SharingMessage sharing_message;
sharing_message.mutable_ping_message();
sharing_fcm_sender_.SendMessageToFcmTarget(
fcm_channel, base::Seconds(kTtlSeconds), std::move(sharing_message),
base::BindOnce(&SharingFCMSenderTest::OnMessageSent,
base::Unretained(this), &result, &message_id,
&channel_type));
EXPECT_EQ(kSharingFCMAppID, fake_gcm_driver_.app_id());
EXPECT_EQ(kSharingSenderID, fake_gcm_driver_.authorized_entity());
EXPECT_EQ(kSenderIdP256dh, fake_gcm_driver_.p256dh());
EXPECT_EQ(kSenderIdAuthSecret, fake_gcm_driver_.auth_secret());
auto specifics = fake_sharing_message_bridge_.specifics();
ASSERT_TRUE(specifics);
ASSERT_TRUE(specifics->has_channel_configuration());
ASSERT_TRUE(specifics->channel_configuration().has_fcm());
auto fcm = specifics->channel_configuration().fcm();
EXPECT_EQ(kSenderIdFcmToken, fcm.token());
EXPECT_EQ(kTtlSeconds, fcm.ttl());
EXPECT_EQ(10, fcm.priority());
components_sharing_message::SharingMessage message_sent;
ASSERT_TRUE(specifics->has_payload());
message_sent.ParseFromString(specifics->payload());
EXPECT_TRUE(message_sent.has_ping_message());
EXPECT_EQ(GetParam().expected_result, result);
EXPECT_TRUE(message_id);
EXPECT_EQ(SharingChannelType::kFcmSenderId, channel_type);
}
INSTANTIATE_TEST_SUITE_P(All,
SharingFCMSenderCommitErrorCodeTest,
testing::ValuesIn(kCommitErrorCodeTestData));
TEST_F(SharingFCMSenderTest, ServerTarget) {
fake_sharing_message_bridge_.set_error_code(
sync_pb::SharingMessageCommitError::NONE);
components_sharing_message::ServerChannelConfiguration server_channel;
server_channel.set_configuration(kServerConfiguration);
server_channel.set_p256dh(kServerP256dh);
server_channel.set_auth_secret(kServerAuthSecret);
SharingSendMessageResult result;
std::optional<std::string> message_id;
SharingChannelType channel_type;
components_sharing_message::SharingMessage sharing_message;
sharing_message.mutable_ping_message();
sharing_fcm_sender_.SendMessageToServerTarget(
server_channel, std::move(sharing_message),
base::BindOnce(&SharingFCMSenderTest::OnMessageSent,
base::Unretained(this), &result, &message_id,
&channel_type));
EXPECT_EQ(kSharingFCMAppID, fake_gcm_driver_.app_id());
EXPECT_EQ(kSharingSenderID, fake_gcm_driver_.authorized_entity());
EXPECT_EQ(kServerP256dh, fake_gcm_driver_.p256dh());
EXPECT_EQ(kServerAuthSecret, fake_gcm_driver_.auth_secret());
auto specifics = fake_sharing_message_bridge_.specifics();
ASSERT_TRUE(specifics);
ASSERT_TRUE(specifics->has_channel_configuration());
EXPECT_EQ(kServerConfiguration, specifics->channel_configuration().server());
components_sharing_message::SharingMessage message_sent;
ASSERT_TRUE(specifics->has_payload());
message_sent.ParseFromString(specifics->payload());
EXPECT_TRUE(message_sent.has_ping_message());
EXPECT_EQ(SharingSendMessageResult::kSuccessful, result);
EXPECT_TRUE(message_id);
EXPECT_EQ(SharingChannelType::kServer, channel_type);
}
TEST_F(SharingFCMSenderTest, ShouldPostponeSendingMessageViaSync) {
// Make sync unavailable to simulate browser startup.
test_sync_service_.SetFailedDataTypes({syncer::SHARING_MESSAGE});
sync_prefs_.SetFCMRegistration(
SharingSyncPreference::FCMRegistration(base::Time::Now()));
components_sharing_message::FCMChannelConfiguration fcm_channel;
fcm_channel.set_sender_id_fcm_token(kSenderIdFcmToken);
fcm_channel.set_sender_id_p256dh(kSenderIdP256dh);
fcm_channel.set_sender_id_auth_secret(kSenderIdAuthSecret);
base::MockCallback<
SharingMessageSender::SendMessageDelegate::SendMessageCallback>
callback;
EXPECT_CALL(callback, Run).Times(0);
// Sync flare should be called to speed up sync start.
EXPECT_CALL(mock_sync_flare_, Run(syncer::SHARING_MESSAGE));
components_sharing_message::SharingMessage sharing_message;
sharing_message.mutable_ack_message();
sharing_fcm_sender_.SendMessageToFcmTarget(
fcm_channel, base::Seconds(kTtlSeconds), std::move(sharing_message),
callback.Get());
testing::Mock::VerifyAndClearExpectations(&callback);
// Once SHARING_MESSAGE becomes active, the message should be sent.
EXPECT_CALL(callback, Run(SharingSendMessageResult::kSuccessful, _,
SharingChannelType::kFcmSenderId));
test_sync_service_.SetFailedDataTypes({});
test_sync_service_.FireStateChanged();
}
TEST_F(SharingFCMSenderTest, ShouldClearPendingMessages) {
// Make sync unavailable to simulate browser startup.
test_sync_service_.SetFailedDataTypes({syncer::SHARING_MESSAGE});
sync_prefs_.SetFCMRegistration(
SharingSyncPreference::FCMRegistration(base::Time::Now()));
components_sharing_message::FCMChannelConfiguration fcm_channel;
fcm_channel.set_sender_id_fcm_token(kSenderIdFcmToken);
fcm_channel.set_sender_id_p256dh(kSenderIdP256dh);
fcm_channel.set_sender_id_auth_secret(kSenderIdAuthSecret);
base::MockCallback<
SharingMessageSender::SendMessageDelegate::SendMessageCallback>
callback;
EXPECT_CALL(callback, Run).Times(0);
components_sharing_message::SharingMessage sharing_message;
sharing_message.mutable_ack_message();
sharing_fcm_sender_.SendMessageToFcmTarget(
fcm_channel, base::Seconds(kTtlSeconds), std::move(sharing_message),
callback.Get());
// Clear any pending messages and verify that nothing is sent once
// SHARING_MESSAGE becomes active (the `callback` above should not be called).
sharing_fcm_sender_.ClearPendingMessages();
test_sync_service_.SetFailedDataTypes({});
test_sync_service_.FireStateChanged();
}
} // namespace
|