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
|
// Copyright 2016 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 "components/os_crypt/key_storage_kwallet.h"
#include "base/logging.h"
#include "base/nix/xdg_util.h"
#include "dbus/message.h"
#include "dbus/mock_bus.h"
#include "dbus/mock_object_proxy.h"
#include "dbus/object_path.h"
#include "dbus/object_proxy.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace {
using testing::_;
using testing::DoAll;
using testing::Return;
using testing::SaveArg;
using testing::SetArgPointee;
using testing::StrictMock;
constexpr KWalletDBus::Error SUCCESS = KWalletDBus::Error::SUCCESS;
constexpr KWalletDBus::Error CANNOT_READ = KWalletDBus::Error::CANNOT_READ;
constexpr KWalletDBus::Error CANNOT_CONTACT =
KWalletDBus::Error::CANNOT_CONTACT;
// These names are not allowed to change in prod, unless we intentionally
// migrate.
#if defined(GOOGLE_CHROME_BUILD)
const char kExpectedFolderName[] = "Chrome Keys";
const char kExpectedEntryName[] = "Chrome Safe Storage";
#else
const char kExpectedFolderName[] = "Chromium Keys";
const char kExpectedEntryName[] = "Chromium Safe Storage";
#endif
// Environment-specific behavior is handled and tested with KWalletDBus, not
// here, but we still need a value to instantiate.
const base::nix::DesktopEnvironment kDesktopEnv =
base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_KDE5;
class MockKWalletDBus : public KWalletDBus {
public:
MockKWalletDBus() : KWalletDBus(kDesktopEnv) {
// On destruction, GetSessionBus() is called to get the bus and shut it
// down. Here we create a mock to be returned by GetSessionBus().
mock_session_bus_ = new dbus::MockBus(dbus::Bus::Options());
}
dbus::MockBus* GetSessionBus() override { return mock_session_bus_.get(); }
MOCK_METHOD0(StartKWalletd, bool());
MOCK_METHOD1(IsEnabled, KWalletDBus::Error(bool*));
MOCK_METHOD1(NetworkWallet, KWalletDBus::Error(std::string*));
MOCK_METHOD3(Open,
KWalletDBus::Error(const std::string&,
const std::string&,
int*));
MOCK_METHOD4(
HasFolder,
KWalletDBus::Error(int, const std::string&, const std::string&, bool*));
MOCK_METHOD4(
CreateFolder,
KWalletDBus::Error(int, const std::string&, const std::string&, bool*));
MOCK_METHOD5(ReadPassword,
KWalletDBus::Error(int,
const std::string&,
const std::string&,
const std::string&,
std::string*));
MOCK_METHOD6(WritePassword,
KWalletDBus::Error(int,
const std::string&,
const std::string&,
const std::string&,
const std::string&,
bool*));
MOCK_METHOD4(Close, KWalletDBus::Error(int, bool, const std::string&, bool*));
private:
scoped_refptr<dbus::MockBus> mock_session_bus_;
};
class KeyStorageKWalletTest : public testing::Test {
public:
KeyStorageKWalletTest() : key_storage_kwallet_(kDesktopEnv, "test-app") {}
void SetUp() override {
kwallet_dbus_mock_ = new StrictMock<MockKWalletDBus>();
// Calls from |key_storage_kwallet_|'s destructor
EXPECT_CALL(*kwallet_dbus_mock_, Close(_, false, _, _))
.WillOnce(DoAll(SetArgPointee<3>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_->GetSessionBus(), ShutdownAndBlock())
.Times(1);
}
void SuccessfulInit() {
EXPECT_CALL(*kwallet_dbus_mock_, IsEnabled(_))
.WillOnce(DoAll(SetArgPointee<0>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, NetworkWallet(_))
.WillOnce(
DoAll(SetArgPointee<0>(std::string("mollet")), Return(SUCCESS)));
EXPECT_TRUE(key_storage_kwallet_.InitWithKWalletDBus(
std::unique_ptr<MockKWalletDBus>(kwallet_dbus_mock_)));
}
protected:
StrictMock<MockKWalletDBus>* kwallet_dbus_mock_;
KeyStorageKWallet key_storage_kwallet_;
const std::string wallet_name_ = "mollet";
private:
DISALLOW_COPY_AND_ASSIGN(KeyStorageKWalletTest);
};
TEST_F(KeyStorageKWalletTest, InitializeFolder) {
SuccessfulInit();
EXPECT_CALL(*kwallet_dbus_mock_, Open(_, _, _))
.WillOnce(DoAll(SetArgPointee<2>(123), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, HasFolder(123, kExpectedFolderName, _, _))
.WillOnce(DoAll(SetArgPointee<3>(false), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, CreateFolder(123, kExpectedFolderName, _, _))
.WillOnce(DoAll(SetArgPointee<3>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_,
ReadPassword(123, kExpectedFolderName, kExpectedEntryName, _, _))
.WillOnce(DoAll(SetArgPointee<4>("butter"), Return(SUCCESS)));
EXPECT_EQ("butter", key_storage_kwallet_.GetKey());
}
TEST_F(KeyStorageKWalletTest, ExistingPassword) {
SuccessfulInit();
EXPECT_CALL(*kwallet_dbus_mock_, Open(_, _, _))
.WillOnce(DoAll(SetArgPointee<2>(123), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, HasFolder(123, kExpectedFolderName, _, _))
.WillOnce(DoAll(SetArgPointee<3>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_,
ReadPassword(123, kExpectedFolderName, kExpectedEntryName, _, _))
.WillOnce(DoAll(SetArgPointee<4>("butter"), Return(SUCCESS)));
EXPECT_EQ("butter", key_storage_kwallet_.GetKey());
}
TEST_F(KeyStorageKWalletTest, GenerateNewPassword) {
SuccessfulInit();
std::string generated_password;
EXPECT_CALL(*kwallet_dbus_mock_, Open(_, _, _))
.WillOnce(DoAll(SetArgPointee<2>(123), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, HasFolder(123, kExpectedFolderName, _, _))
.WillOnce(DoAll(SetArgPointee<3>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_,
ReadPassword(123, kExpectedFolderName, kExpectedEntryName, _, _))
.WillOnce(DoAll(SetArgPointee<4>(""), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, WritePassword(123, kExpectedFolderName,
kExpectedEntryName, _, _, _))
.WillOnce(DoAll(SaveArg<3>(&generated_password), SetArgPointee<5>(true),
Return(SUCCESS)));
EXPECT_EQ(generated_password, key_storage_kwallet_.GetKey());
}
TEST_F(KeyStorageKWalletTest, InitKWalletNotEnabled) {
EXPECT_CALL(*kwallet_dbus_mock_, IsEnabled(_))
.WillOnce(DoAll(SetArgPointee<0>(false), Return(SUCCESS)));
EXPECT_FALSE(key_storage_kwallet_.InitWithKWalletDBus(
std::unique_ptr<MockKWalletDBus>(kwallet_dbus_mock_)));
}
TEST_F(KeyStorageKWalletTest, InitCannotStart) {
EXPECT_CALL(*kwallet_dbus_mock_, IsEnabled(_))
.WillOnce(Return(CANNOT_CONTACT));
EXPECT_CALL(*kwallet_dbus_mock_, StartKWalletd()).WillOnce(Return(false));
EXPECT_FALSE(key_storage_kwallet_.InitWithKWalletDBus(
std::unique_ptr<MockKWalletDBus>(kwallet_dbus_mock_)));
}
TEST_F(KeyStorageKWalletTest, InitFailTwice) {
EXPECT_CALL(*kwallet_dbus_mock_, IsEnabled(_))
.WillOnce(Return(CANNOT_CONTACT))
.WillOnce(Return(CANNOT_CONTACT));
EXPECT_CALL(*kwallet_dbus_mock_, StartKWalletd()).WillOnce(Return(true));
EXPECT_FALSE(key_storage_kwallet_.InitWithKWalletDBus(
std::unique_ptr<MockKWalletDBus>(kwallet_dbus_mock_)));
}
TEST_F(KeyStorageKWalletTest, InitTryTwiceAndFail) {
EXPECT_CALL(*kwallet_dbus_mock_, IsEnabled(_))
.WillOnce(Return(CANNOT_CONTACT))
.WillOnce(DoAll(SetArgPointee<0>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, StartKWalletd()).WillOnce(Return(true));
EXPECT_CALL(*kwallet_dbus_mock_, NetworkWallet(_))
.WillOnce(Return(CANNOT_CONTACT));
EXPECT_FALSE(key_storage_kwallet_.InitWithKWalletDBus(
std::unique_ptr<MockKWalletDBus>(kwallet_dbus_mock_)));
}
TEST_F(KeyStorageKWalletTest, InitTryTwiceAndSuccess) {
EXPECT_CALL(*kwallet_dbus_mock_, IsEnabled(_))
.WillOnce(Return(CANNOT_CONTACT))
.WillOnce(DoAll(SetArgPointee<0>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, StartKWalletd()).WillOnce(Return(true));
EXPECT_CALL(*kwallet_dbus_mock_, NetworkWallet(_))
.WillOnce(DoAll(SetArgPointee<0>(wallet_name_), Return(SUCCESS)));
EXPECT_TRUE(key_storage_kwallet_.InitWithKWalletDBus(
std::unique_ptr<MockKWalletDBus>(kwallet_dbus_mock_)));
}
// Tests for a dbus connection that fails after initialization.
// Any error is expected to return an empty password.
class KeyStorageKWalletFailuresTest
: public testing::TestWithParam<KWalletDBus::Error> {
public:
KeyStorageKWalletFailuresTest()
: key_storage_kwallet_(kDesktopEnv, "test-app") {}
void SetUp() override {
// |key_storage_kwallet_| will take ownership of |kwallet_dbus_mock_|.
kwallet_dbus_mock_ = new StrictMock<MockKWalletDBus>();
// Successful initialization.
EXPECT_CALL(*kwallet_dbus_mock_, IsEnabled(_))
.WillOnce(DoAll(SetArgPointee<0>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, NetworkWallet(_))
.WillOnce(
DoAll(SetArgPointee<0>(std::string("mollet")), Return(SUCCESS)));
EXPECT_TRUE(key_storage_kwallet_.InitWithKWalletDBus(
std::unique_ptr<MockKWalletDBus>(kwallet_dbus_mock_)));
// Calls from |key_storage_kwallet_|'s destructor.
EXPECT_CALL(*kwallet_dbus_mock_, Close(_, false, _, _))
.WillOnce(DoAll(SetArgPointee<3>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_->GetSessionBus(), ShutdownAndBlock())
.Times(1);
}
protected:
StrictMock<MockKWalletDBus>* kwallet_dbus_mock_;
KeyStorageKWallet key_storage_kwallet_;
const std::string wallet_name_ = "mollet";
private:
DISALLOW_COPY_AND_ASSIGN(KeyStorageKWalletFailuresTest);
};
INSTANTIATE_TEST_CASE_P(,
KeyStorageKWalletFailuresTest,
::testing::Values(CANNOT_READ, CANNOT_CONTACT));
TEST_P(KeyStorageKWalletFailuresTest, PostInitFailureOpen) {
EXPECT_CALL(*kwallet_dbus_mock_, Open(_, _, _)).WillOnce(Return(GetParam()));
EXPECT_EQ("", key_storage_kwallet_.GetKey());
}
TEST_P(KeyStorageKWalletFailuresTest, PostInitFailureHasFolder) {
EXPECT_CALL(*kwallet_dbus_mock_, Open(_, _, _))
.WillOnce(DoAll(SetArgPointee<2>(123), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, HasFolder(123, _, _, _))
.WillOnce(Return(GetParam()));
EXPECT_EQ("", key_storage_kwallet_.GetKey());
}
TEST_P(KeyStorageKWalletFailuresTest, PostInitFailureCreateFolder) {
EXPECT_CALL(*kwallet_dbus_mock_, Open(_, _, _))
.WillOnce(DoAll(SetArgPointee<2>(123), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, HasFolder(123, _, _, _))
.WillOnce(DoAll(SetArgPointee<3>(false), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, CreateFolder(123, _, _, _))
.WillOnce(Return(GetParam()));
EXPECT_EQ("", key_storage_kwallet_.GetKey());
}
TEST_P(KeyStorageKWalletFailuresTest, PostInitFailureReadPassword) {
EXPECT_CALL(*kwallet_dbus_mock_, Open(_, _, _))
.WillOnce(DoAll(SetArgPointee<2>(123), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, HasFolder(123, _, _, _))
.WillOnce(DoAll(SetArgPointee<3>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, ReadPassword(123, _, _, _, _))
.WillOnce(Return(GetParam()));
EXPECT_EQ("", key_storage_kwallet_.GetKey());
}
TEST_P(KeyStorageKWalletFailuresTest, PostInitFailureWritePassword) {
EXPECT_CALL(*kwallet_dbus_mock_, Open(_, _, _))
.WillOnce(DoAll(SetArgPointee<2>(123), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, HasFolder(123, _, _, _))
.WillOnce(DoAll(SetArgPointee<3>(true), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, ReadPassword(123, _, _, _, _))
.WillOnce(DoAll(SetArgPointee<4>(""), Return(SUCCESS)));
EXPECT_CALL(*kwallet_dbus_mock_, WritePassword(123, _, _, _, _, _))
.WillOnce(Return(GetParam()));
EXPECT_EQ("", key_storage_kwallet_.GetKey());
}
} // namespace
|