blob: cc81ece61468daf8cf41e01c7cb430f6e225e318 [file] [log] [blame]
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/public/browser/push_messaging_service.h"
#include <stdint.h>
#include <string>
#include <vector>
#include "base/command_line.h"
#include "base/macros.h"
#include "base/run_loop.h"
#include "base/threading/thread_task_runner_handle.h"
#include "chrome/browser/content_settings/host_content_settings_map_factory.h"
#include "chrome/browser/gcm/gcm_profile_service_factory.h"
#include "chrome/browser/permissions/permission_manager.h"
#include "chrome/browser/permissions/permission_manager_factory.h"
#include "chrome/browser/push_messaging/push_messaging_app_identifier.h"
#include "chrome/browser/push_messaging/push_messaging_service_factory.h"
#include "chrome/browser/push_messaging/push_messaging_service_impl.h"
#include "chrome/test/base/testing_profile.h"
#include "components/content_settings/core/browser/host_content_settings_map.h"
#include "components/gcm_driver/crypto/gcm_crypto_test_helpers.h"
#include "components/gcm_driver/fake_gcm_client_factory.h"
#include "components/gcm_driver/fake_gcm_profile_service.h"
#include "components/gcm_driver/gcm_profile_service.h"
#include "content/public/common/push_event_payload.h"
#include "content/public/common/push_messaging_status.mojom.h"
#include "content/public/common/push_subscription_options.h"
#include "content/public/test/test_browser_thread_bundle.h"
#include "testing/gtest/include/gtest/gtest.h"
#if defined(OS_ANDROID)
#include "components/gcm_driver/instance_id/instance_id_android.h"
#include "components/gcm_driver/instance_id/scoped_use_fake_instance_id_android.h"
#endif // OS_ANDROID
namespace {
const char kTestOrigin[] = "https://example.com";
const char kTestSenderId[] = "1234567890";
const int64_t kTestServiceWorkerId = 42;
const char kTestPayload[] = "Hello, world!";
// NIST P-256 public key in uncompressed format per SEC1 2.3.3.
const uint8_t kTestP256Key[] = {
0x04, 0x55, 0x52, 0x6A, 0xA5, 0x6E, 0x8E, 0xAA, 0x47, 0x97, 0x36,
0x10, 0xC1, 0x66, 0x3C, 0x1E, 0x65, 0xBF, 0xA1, 0x7B, 0xEE, 0x48,
0xC9, 0xC6, 0xBB, 0xBF, 0x02, 0x18, 0x53, 0x72, 0x1D, 0x0C, 0x7B,
0xA9, 0xE3, 0x11, 0xB7, 0x03, 0x52, 0x21, 0xD3, 0x71, 0x90, 0x13,
0xA8, 0xC1, 0xCF, 0xED, 0x20, 0xF7, 0x1F, 0xD1, 0x7F, 0xF2, 0x76,
0xB6, 0x01, 0x20, 0xD8, 0x35, 0xA5, 0xD9, 0x3C, 0x43, 0xFD};
static_assert(sizeof(kTestP256Key) == 65,
"The fake public key must be a valid P-256 uncompressed point.");
// URL-safe base64 encoded version of the |kTestP256Key|.
const char kTestEncodedP256Key[] =
"BFVSaqVujqpHlzYQwWY8HmW_oXvuSMnGu78CGFNyHQx7qeMRtwNSIdNxkBOowc_tIPcf0X_ydr"
"YBINg1pdk8Q_0";
// Implementation of the TestingProfile that provides the Push Messaging Service
// and the Permission Manager, both of which are required for the tests.
class PushMessagingTestingProfile : public TestingProfile {
public:
PushMessagingTestingProfile() {}
~PushMessagingTestingProfile() override {}
PushMessagingServiceImpl* GetPushMessagingService() override {
return PushMessagingServiceFactory::GetForProfile(this);
}
PermissionManager* GetPermissionManager() override {
return PermissionManagerFactory::GetForProfile(this);
}
private:
DISALLOW_COPY_AND_ASSIGN(PushMessagingTestingProfile);
};
std::unique_ptr<KeyedService> BuildFakeGCMProfileService(
content::BrowserContext* context) {
return gcm::FakeGCMProfileService::Build(static_cast<Profile*>(context));
}
} // namespace
class PushMessagingServiceTest : public ::testing::Test {
public:
PushMessagingServiceTest() {
// Always allow push notifications in the profile.
HostContentSettingsMap* host_content_settings_map =
HostContentSettingsMapFactory::GetForProfile(&profile_);
host_content_settings_map->SetDefaultContentSetting(
CONTENT_SETTINGS_TYPE_NOTIFICATIONS, CONTENT_SETTING_ALLOW);
// Override the GCM Profile service so that we can send fake messages.
gcm::GCMProfileServiceFactory::GetInstance()->SetTestingFactory(
&profile_, &BuildFakeGCMProfileService);
}
~PushMessagingServiceTest() override {}
// Callback to use when the subscription may have been subscribed.
void DidRegister(std::string* subscription_id_out,
std::vector<uint8_t>* p256dh_out,
std::vector<uint8_t>* auth_out,
base::Closure done_callback,
const std::string& registration_id,
const std::vector<uint8_t>& p256dh,
const std::vector<uint8_t>& auth,
content::mojom::PushRegistrationStatus status) {
EXPECT_EQ(content::mojom::PushRegistrationStatus::SUCCESS_FROM_PUSH_SERVICE,
status);
*subscription_id_out = registration_id;
*p256dh_out = p256dh;
*auth_out = auth;
done_callback.Run();
}
// Callback to use when observing messages dispatched by the push service.
void DidDispatchMessage(std::string* app_id_out,
GURL* origin_out,
int64_t* service_worker_registration_id_out,
content::PushEventPayload* payload_out,
const std::string& app_id,
const GURL& origin,
int64_t service_worker_registration_id,
const content::PushEventPayload& payload) {
*app_id_out = app_id;
*origin_out = origin;
*service_worker_registration_id_out = service_worker_registration_id;
*payload_out = payload;
}
protected:
PushMessagingTestingProfile* profile() { return &profile_; }
private:
content::TestBrowserThreadBundle thread_bundle_;
PushMessagingTestingProfile profile_;
#if defined(OS_ANDROID)
instance_id::InstanceIDAndroid::ScopedBlockOnAsyncTasksForTesting
block_async_;
instance_id::ScopedUseFakeInstanceIDAndroid use_fake_;
#endif // OS_ANDROID
};
TEST_F(PushMessagingServiceTest, PayloadEncryptionTest) {
PushMessagingServiceImpl* push_service = profile()->GetPushMessagingService();
ASSERT_TRUE(push_service);
const GURL origin(kTestOrigin);
// (1) Make sure that |kExampleOrigin| has access to use Push Messaging.
ASSERT_EQ(blink::mojom::PermissionStatus::GRANTED,
push_service->GetPermissionStatus(origin, true));
std::string subscription_id;
std::vector<uint8_t> p256dh, auth;
base::RunLoop run_loop;
// (2) Subscribe for Push Messaging, and verify that we've got the required
// information in order to be able to create encrypted messages.
content::PushSubscriptionOptions options;
options.user_visible_only = true;
options.sender_info = kTestSenderId;
push_service->SubscribeFromWorker(
origin, kTestServiceWorkerId, options,
base::Bind(&PushMessagingServiceTest::DidRegister, base::Unretained(this),
&subscription_id, &p256dh, &auth, run_loop.QuitClosure()));
EXPECT_EQ(0u, subscription_id.size()); // this must be asynchronous
run_loop.Run();
ASSERT_GT(subscription_id.size(), 0u);
ASSERT_GT(p256dh.size(), 0u);
ASSERT_GT(auth.size(), 0u);
// (3) Encrypt a message using the public key and authentication secret that
// are associated with the subscription.
gcm::IncomingMessage message;
message.sender_id = kTestSenderId;
ASSERT_TRUE(gcm::CreateEncryptedPayloadForTesting(
kTestPayload,
base::StringPiece(reinterpret_cast<char*>(p256dh.data()), p256dh.size()),
base::StringPiece(reinterpret_cast<char*>(auth.data()), auth.size()),
&message));
ASSERT_GT(message.raw_data.size(), 0u);
ASSERT_NE(kTestPayload, message.raw_data);
ASSERT_FALSE(message.decrypted);
// (4) Find the app_id that has been associated with the subscription.
PushMessagingAppIdentifier app_identifier =
PushMessagingAppIdentifier::FindByServiceWorker(profile(), origin,
kTestServiceWorkerId);
ASSERT_FALSE(app_identifier.is_null());
std::string app_id;
GURL dispatched_origin;
int64_t service_worker_registration_id;
content::PushEventPayload payload;
// (5) Observe message dispatchings from the Push Messaging service, and then
// dispatch the |message| on the GCM driver as if it had actually been
// received by Google Cloud Messaging.
push_service->SetMessageDispatchedCallbackForTesting(base::Bind(
&PushMessagingServiceTest::DidDispatchMessage, base::Unretained(this),
&app_id, &dispatched_origin, &service_worker_registration_id, &payload));
gcm::FakeGCMProfileService* fake_profile_service =
static_cast<gcm::FakeGCMProfileService*>(
gcm::GCMProfileServiceFactory::GetForProfile(profile()));
fake_profile_service->DispatchMessage(app_identifier.app_id(), message);
base::RunLoop().RunUntilIdle();
// (6) Verify that the message, as received by the Push Messaging Service, has
// indeed been decrypted by the GCM Driver, and has been forwarded to the
// Service Worker that has been associated with the subscription.
EXPECT_EQ(app_identifier.app_id(), app_id);
EXPECT_EQ(origin, dispatched_origin);
EXPECT_EQ(service_worker_registration_id, kTestServiceWorkerId);
EXPECT_FALSE(payload.is_null);
EXPECT_EQ(kTestPayload, payload.data);
}
TEST_F(PushMessagingServiceTest, NormalizeSenderInfo) {
PushMessagingServiceImpl* push_service = profile()->GetPushMessagingService();
ASSERT_TRUE(push_service);
std::string p256dh(kTestP256Key, kTestP256Key + arraysize(kTestP256Key));
ASSERT_EQ(65u, p256dh.size());
// NIST P-256 public keys in uncompressed format will be encoded using the
// URL-safe base64 encoding by the normalization function.
EXPECT_EQ(kTestEncodedP256Key, push_service->NormalizeSenderInfo(p256dh));
// Any other value, binary or not, will be passed through as-is.
EXPECT_EQ("1234567890", push_service->NormalizeSenderInfo("1234567890"));
EXPECT_EQ("foo@bar.com", push_service->NormalizeSenderInfo("foo@bar.com"));
p256dh[0] = 0x05; // invalidate |p256dh| as a public key.
EXPECT_EQ(p256dh, push_service->NormalizeSenderInfo(p256dh));
}
TEST_F(PushMessagingServiceTest, DifferentEndpoints) {
PushMessagingServiceImpl* push_service = profile()->GetPushMessagingService();
ASSERT_TRUE(push_service);
// Verifies that the service returns different endpoints depending on whether
// support for the standard protocol is requested.
EXPECT_NE(push_service->GetEndpoint(true), push_service->GetEndpoint(false));
}