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
|
// Copyright 2024 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/os_crypt/async/browser/secret_portal_key_provider.h"
#include "base/memory/scoped_refptr.h"
#include "base/nix/xdg_util.h"
#include "base/run_loop.h"
#include "base/test/task_environment.h"
#include "components/dbus/properties/types.h"
#include "components/dbus/utils/name_has_owner.h"
#include "components/prefs/testing_pref_service.h"
#include "dbus/message.h"
#include "dbus/mock_bus.h"
#include "dbus/mock_object_proxy.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using ::testing::_;
using ::testing::AtLeast;
using ::testing::Invoke;
using ::testing::Return;
namespace os_crypt_async {
namespace {
constexpr char kBusName[] = ":1.123";
constexpr char kSecret[] = "secret_for_testing";
constexpr char kPrefToken[] = "token_for_testing";
MATCHER_P2(MatchMethod, interface, member, "") {
return arg->GetInterface() == interface && arg->GetMember() == member;
}
} // namespace
class SecretPortalKeyProviderTest : public testing::Test {
public:
SecretPortalKeyProviderTest() = default;
void SetUp() override {
SecretPortalKeyProvider::RegisterLocalPrefs(pref_service_.registry());
mock_bus_ = base::MakeRefCounted<dbus::MockBus>(dbus::Bus::Options());
mock_dbus_proxy_ = base::MakeRefCounted<dbus::MockObjectProxy>(
mock_bus_.get(), DBUS_SERVICE_DBUS, dbus::ObjectPath(DBUS_PATH_DBUS));
EXPECT_CALL(*mock_bus_, GetObjectProxy(DBUS_SERVICE_DBUS,
dbus::ObjectPath(DBUS_PATH_DBUS)))
.WillRepeatedly(Return(mock_dbus_proxy_.get()));
mock_systemd_proxy_ = base::MakeRefCounted<dbus::MockObjectProxy>(
mock_bus_.get(), "org.freedesktop.systemd1",
dbus::ObjectPath("/org/freedesktop/systemd1"));
EXPECT_CALL(*mock_bus_,
GetObjectProxy("org.freedesktop.systemd1",
dbus::ObjectPath("/org/freedesktop/systemd1")))
.Times(AtLeast(0))
.WillRepeatedly(Return(mock_systemd_proxy_.get()));
EXPECT_CALL(*mock_systemd_proxy_, DoCallMethod(_, _, _))
.Times(AtLeast(0))
.WillRepeatedly(
Invoke([](dbus::MethodCall*, int,
dbus::ObjectProxy::ResponseCallback* callback) {
std::move(*callback).Run(nullptr);
}));
EXPECT_CALL(*mock_bus_, AssertOnOriginThread()).WillRepeatedly([] {});
EXPECT_CALL(*mock_bus_, GetDBusTaskRunner())
.WillRepeatedly(
Return(task_environment_.GetMainThreadTaskRunner().get()));
EXPECT_CALL(*mock_bus_,
GetObjectProxy(SecretPortalKeyProvider::kServiceSecret, _))
.WillRepeatedly(Invoke([&](std::string_view service_name,
const dbus::ObjectPath& object_path) {
response_path_ = object_path;
mock_response_proxy_ = base::MakeRefCounted<dbus::MockObjectProxy>(
mock_bus_.get(), SecretPortalKeyProvider::kServiceSecret,
response_path_);
EXPECT_CALL(*mock_response_proxy_, DoConnectToSignal(_, _, _, _))
.WillOnce(
Invoke([&](const std::string& interface_name,
const std::string& signal_name,
dbus::ObjectProxy::SignalCallback signal_callback,
dbus::ObjectProxy::OnConnectedCallback*
on_connected_callback) {
EXPECT_EQ(interface_name,
SecretPortalKeyProvider::kInterfaceRequest);
EXPECT_EQ(signal_name,
SecretPortalKeyProvider::kSignalResponse);
std::move(*on_connected_callback)
.Run(interface_name, signal_name, true);
dbus::Signal signal(interface_name, signal_name);
dbus::MessageWriter writer(&signal);
constexpr uint32_t kResponseSuccess = 0;
writer.AppendUint32(kResponseSuccess);
DbusDictionary dict;
dict.Put("token", MakeDbusVariant(DbusString(kPrefToken)));
dict.Write(&writer);
signal_callback.Run(&signal);
}));
return mock_response_proxy_.get();
}));
mock_secret_proxy_ = base::MakeRefCounted<dbus::MockObjectProxy>(
mock_bus_.get(), SecretPortalKeyProvider::kServiceSecret,
dbus::ObjectPath(SecretPortalKeyProvider::kObjectPathSecret));
EXPECT_CALL(*mock_bus_,
GetObjectProxy(SecretPortalKeyProvider::kServiceSecret,
dbus::ObjectPath(
SecretPortalKeyProvider::kObjectPathSecret)))
.WillRepeatedly(Return(mock_secret_proxy_.get()));
key_provider_ = base::WrapUnique(
new SecretPortalKeyProvider(&pref_service_, mock_bus_, true));
}
void TearDown() override {
// Shutdown the bus to ensure clean-up
key_provider_.reset();
base::RunLoop run_loop;
run_loop.RunUntilIdle();
}
protected:
// An IO thread is required for FileDescriptorWatcher.
base::test::TaskEnvironment task_environment_{
base::test::TaskEnvironment::MainThreadType::IO};
scoped_refptr<dbus::MockBus> mock_bus_;
scoped_refptr<dbus::MockObjectProxy> mock_dbus_proxy_;
scoped_refptr<dbus::MockObjectProxy> mock_systemd_proxy_;
scoped_refptr<dbus::MockObjectProxy> mock_response_proxy_;
scoped_refptr<dbus::MockObjectProxy> mock_secret_proxy_;
dbus::ObjectPath response_path_;
std::unique_ptr<SecretPortalKeyProvider> key_provider_;
TestingPrefServiceSimple pref_service_;
};
TEST_F(SecretPortalKeyProviderTest, GetKey) {
EXPECT_CALL(
*mock_dbus_proxy_,
DoCallMethod(MatchMethod(DBUS_INTERFACE_DBUS, "NameHasOwner"), _, _))
.WillOnce(Invoke([](dbus::MethodCall* method_call, int timeout_ms,
dbus::ObjectProxy::ResponseCallback* callback) {
dbus::MessageReader reader(method_call);
std::string service_name;
EXPECT_TRUE(reader.PopString(&service_name));
EXPECT_EQ(service_name, "org.freedesktop.systemd1");
auto response = dbus::Response::CreateEmpty();
dbus::MessageWriter writer(response.get());
writer.AppendBool(true);
std::move(*callback).Run(response.get());
}))
.WillOnce(Invoke([](dbus::MethodCall* method_call, int timeout_ms,
dbus::ObjectProxy::ResponseCallback* callback) {
dbus::MessageReader reader(method_call);
std::string service_name;
EXPECT_TRUE(reader.PopString(&service_name));
EXPECT_EQ(service_name, SecretPortalKeyProvider::kServiceSecret);
auto response = dbus::Response::CreateEmpty();
dbus::MessageWriter writer(response.get());
writer.AppendBool(true);
std::move(*callback).Run(response.get());
}));
EXPECT_CALL(*mock_bus_, GetConnectionName()).WillOnce(Return(kBusName));
EXPECT_CALL(*mock_secret_proxy_,
DoCallMethodWithErrorResponse(
MatchMethod(SecretPortalKeyProvider::kInterfaceSecret,
SecretPortalKeyProvider::kMethodRetrieveSecret),
_, _))
.WillOnce(
Invoke([&](dbus::MethodCall* method_call, int timeout_ms,
dbus::ObjectProxy::ResponseOrErrorCallback* callback) {
dbus::MessageReader reader(method_call);
base::ScopedFD write_fd;
EXPECT_TRUE(reader.PopFileDescriptor(&write_fd));
EXPECT_EQ(write(write_fd.get(), kSecret, sizeof(kSecret)),
static_cast<ssize_t>(sizeof(kSecret)));
write_fd.reset();
auto response = dbus::Response::CreateEmpty();
dbus::MessageWriter writer(response.get());
writer.AppendObjectPath(dbus::ObjectPath(response_path_));
std::move(*callback).Run(response.get(), nullptr);
}));
bool callback_called = false;
std::string key_tag;
std::optional<Encryptor::Key> key;
key_provider_->GetKey(base::BindOnce(
[](bool& callback_called, std::string& key_tag,
std::optional<Encryptor::Key>& key,
const std::string& returned_key_tag,
base::expected<Encryptor::Key, KeyProvider::KeyError> returned_key) {
callback_called = true;
key_tag = returned_key_tag;
key = std::move(returned_key.value());
},
std::ref(callback_called), std::ref(key_tag), std::ref(key)));
base::RunLoop run_loop;
run_loop.RunUntilIdle();
EXPECT_TRUE(callback_called);
EXPECT_EQ(key_tag, SecretPortalKeyProvider::kKeyTag);
EXPECT_TRUE(key.has_value());
EXPECT_TRUE(pref_service_.HasPrefPath(
SecretPortalKeyProvider::kOsCryptTokenPrefName));
EXPECT_EQ(
pref_service_.GetString(SecretPortalKeyProvider::kOsCryptTokenPrefName),
kPrefToken);
}
} // namespace os_crypt_async
|