John Edward Broadbent | 59dffa6 | 2022-01-13 17:41:32 -0800 | [diff] [blame] | 1 | #include "estoraged_test.hpp" |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 2 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 3 | #include "estoraged.hpp" |
Tom Tung | 043af59 | 2023-11-24 13:37:05 +0800 | [diff] [blame] | 4 | #include "estoraged_conf.hpp" |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 5 | |
| 6 | #include <unistd.h> |
| 7 | |
John Wedig | 67a4744 | 2022-04-05 17:21:29 -0700 | [diff] [blame] | 8 | #include <boost/asio/io_context.hpp> |
| 9 | #include <sdbusplus/asio/connection.hpp> |
| 10 | #include <sdbusplus/asio/object_server.hpp> |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 11 | #include <xyz/openbmc_project/Common/error.hpp> |
Patrick Williams | 0e2a46f | 2023-05-10 14:35:52 -0500 | [diff] [blame] | 12 | #include <xyz/openbmc_project/Inventory/Item/Volume/server.hpp> |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 13 | |
| 14 | #include <exception> |
| 15 | #include <filesystem> |
| 16 | #include <fstream> |
| 17 | #include <iterator> |
John Wedig | 67a4744 | 2022-04-05 17:21:29 -0700 | [diff] [blame] | 18 | #include <memory> |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 19 | #include <string> |
| 20 | #include <vector> |
| 21 | |
| 22 | #include <gmock/gmock.h> |
| 23 | #include <gtest/gtest.h> |
| 24 | |
| 25 | namespace estoraged_test |
| 26 | { |
| 27 | |
Patrick Williams | 0e2a46f | 2023-05-10 14:35:52 -0500 | [diff] [blame] | 28 | using sdbusplus::server::xyz::openbmc_project::inventory::item::Volume; |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 29 | using sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure; |
| 30 | using sdbusplus::xyz::openbmc_project::Common::Error::ResourceNotFound; |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 31 | using std::filesystem::path; |
| 32 | using ::testing::_; |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 33 | using ::testing::Return; |
| 34 | using ::testing::StrEq; |
| 35 | |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 36 | class EStoragedTest : public testing::Test |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 37 | { |
| 38 | public: |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 39 | const char* testFileName = "testfile"; |
| 40 | const char* testLuksDevName = "testfile_luksDev"; |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 41 | const char* testCryptDir = "/tmp"; |
John Wedig | 6c0d8ce | 2022-04-22 14:00:43 -0700 | [diff] [blame] | 42 | const std::string testConfigPath = |
| 43 | "/xyz/openbmc_project/inventory/system/board/test_board/test_emmc"; |
John Wedig | 67a4744 | 2022-04-05 17:21:29 -0700 | [diff] [blame] | 44 | const uint64_t testSize = 24; |
John Edward Broadbent | 5d799bb | 2022-03-22 16:14:24 -0700 | [diff] [blame] | 45 | const uint8_t testLifeTime = 25; |
John Wedig | b483830 | 2022-07-22 13:51:16 -0700 | [diff] [blame] | 46 | const std::string testPartNumber = "12345678"; |
| 47 | const std::string testSerialNumber = "ABCDEF1234"; |
Rahul Kapoor | 1982505 | 2023-05-27 01:52:23 +0000 | [diff] [blame] | 48 | const std::string testLocationCode = "U102020"; |
John Wedig | d7be42b | 2024-01-19 16:07:19 -0800 | [diff] [blame^] | 49 | const std::string testDriveType = "SSD"; |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 50 | std::ofstream testFile; |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 51 | std::string passwordString; |
| 52 | std::vector<uint8_t> password; |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 53 | MockCryptsetupInterface* mockCryptIface{}; |
| 54 | MockFilesystemInterface* mockFsIface{}; |
John Wedig | 67a4744 | 2022-04-05 17:21:29 -0700 | [diff] [blame] | 55 | boost::asio::io_context io; |
| 56 | std::shared_ptr<sdbusplus::asio::connection> conn; |
| 57 | std::unique_ptr<sdbusplus::asio::object_server> objectServer; |
| 58 | std::unique_ptr<estoraged::EStoraged> esObject; |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 59 | |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 60 | EStoragedTest() : |
John Wedig | 67a4744 | 2022-04-05 17:21:29 -0700 | [diff] [blame] | 61 | passwordString("password"), |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 62 | password(passwordString.begin(), passwordString.end()) |
| 63 | {} |
| 64 | |
| 65 | void SetUp() override |
| 66 | { |
| 67 | /* Create an empty file that we'll pretend is a 'storage device'. */ |
| 68 | testFile.open(testFileName, |
| 69 | std::ios::out | std::ios::binary | std::ios::trunc); |
| 70 | testFile.close(); |
| 71 | if (testFile.fail()) |
| 72 | { |
| 73 | throw std::runtime_error("Failed to open test file"); |
| 74 | } |
| 75 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 76 | std::unique_ptr<MockCryptsetupInterface> cryptIface = |
| 77 | std::make_unique<MockCryptsetupInterface>(); |
| 78 | mockCryptIface = cryptIface.get(); |
| 79 | std::unique_ptr<MockFilesystemInterface> fsIface = |
| 80 | std::make_unique<MockFilesystemInterface>(); |
| 81 | mockFsIface = fsIface.get(); |
| 82 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 83 | /* Set up location of dummy mapped crypt file. */ |
| 84 | EXPECT_CALL(*cryptIface, cryptGetDir).WillOnce(Return(testCryptDir)); |
| 85 | |
John Wedig | 67a4744 | 2022-04-05 17:21:29 -0700 | [diff] [blame] | 86 | conn = std::make_shared<sdbusplus::asio::connection>(io); |
| 87 | // request D-Bus server name. |
| 88 | conn->request_name("xyz.openbmc_project.eStoraged.test"); |
| 89 | objectServer = std::make_unique<sdbusplus::asio::object_server>(conn); |
| 90 | |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 91 | esObject = std::make_unique<estoraged::EStoraged>( |
John Wedig | 6c0d8ce | 2022-04-22 14:00:43 -0700 | [diff] [blame] | 92 | *objectServer, testConfigPath, testFileName, testLuksDevName, |
John Wedig | b483830 | 2022-07-22 13:51:16 -0700 | [diff] [blame] | 93 | testSize, testLifeTime, testPartNumber, testSerialNumber, |
Tom Tung | 043af59 | 2023-11-24 13:37:05 +0800 | [diff] [blame] | 94 | testLocationCode, ERASE_MAX_GEOMETRY, ERASE_MIN_GEOMETRY, |
John Wedig | d7be42b | 2024-01-19 16:07:19 -0800 | [diff] [blame^] | 95 | testDriveType, std::move(cryptIface), std::move(fsIface)); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 96 | } |
| 97 | |
| 98 | void TearDown() override |
| 99 | { |
| 100 | EXPECT_EQ(0, unlink(testFileName)); |
| 101 | } |
| 102 | }; |
| 103 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 104 | const char* mappedDevicePath = "/tmp/testfile_luksDev"; |
| 105 | std::ofstream mappedDevice; |
| 106 | |
| 107 | int createMappedDev() |
| 108 | { |
| 109 | mappedDevice.open(mappedDevicePath, |
| 110 | std::ios::out | std::ios::binary | std::ios::trunc); |
| 111 | mappedDevice.close(); |
| 112 | if (mappedDevice.fail()) |
| 113 | { |
| 114 | throw std::runtime_error("Failed to open test mapped device"); |
| 115 | } |
| 116 | |
| 117 | return 0; |
| 118 | } |
| 119 | |
| 120 | int removeMappedDev() |
| 121 | { |
| 122 | EXPECT_EQ(0, unlink(mappedDevicePath)); |
| 123 | |
| 124 | return 0; |
| 125 | } |
| 126 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 127 | /* Test case to format and then lock the LUKS device. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 128 | TEST_F(EStoragedTest, FormatPass) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 129 | { |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 130 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 131 | |
| 132 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 133 | .Times(1); |
| 134 | |
| 135 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 136 | |
| 137 | EXPECT_CALL(*mockCryptIface, cryptActivateByPassphrase(_, _, _, _, _, _)) |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 138 | .WillOnce(&createMappedDev); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 139 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 140 | EXPECT_CALL(*mockFsIface, runMkfs(StrEq(esObject->getCryptDevicePath()))) |
| 141 | .WillOnce(Return(0)); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 142 | |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 143 | EXPECT_CALL(*mockFsIface, directoryExists(path(esObject->getMountPoint()))) |
| 144 | .WillOnce(Return(false)); |
| 145 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 146 | EXPECT_CALL(*mockFsIface, createDirectory(path(esObject->getMountPoint()))) |
| 147 | .WillOnce(Return(true)); |
| 148 | |
| 149 | EXPECT_CALL(*mockFsIface, |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 150 | doMount(StrEq(esObject->getCryptDevicePath()), |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 151 | StrEq(esObject->getMountPoint()), _, _, _)) |
| 152 | .WillOnce(Return(0)); |
| 153 | |
| 154 | EXPECT_CALL(*mockFsIface, doUnmount(StrEq(esObject->getMountPoint()))) |
| 155 | .WillOnce(Return(0)); |
| 156 | |
| 157 | EXPECT_CALL(*mockFsIface, removeDirectory(path(esObject->getMountPoint()))) |
| 158 | .WillOnce(Return(true)); |
| 159 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 160 | EXPECT_CALL(*mockCryptIface, cryptDeactivate(_, _)) |
| 161 | .WillOnce(&removeMappedDev); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 162 | |
| 163 | /* Format the encrypted device. */ |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 164 | esObject->formatLuks(password, Volume::FilesystemType::ext4); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 165 | EXPECT_FALSE(esObject->isLocked()); |
| 166 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 167 | esObject->lock(); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 168 | EXPECT_TRUE(esObject->isLocked()); |
| 169 | } |
| 170 | |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 171 | /* |
| 172 | * Test case where the mount point directory already exists, so it shouldn't |
| 173 | * try to create it. |
| 174 | */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 175 | TEST_F(EStoragedTest, MountPointExistsPass) |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 176 | { |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 177 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 178 | |
| 179 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 180 | .Times(1); |
| 181 | |
| 182 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 183 | |
| 184 | EXPECT_CALL(*mockCryptIface, cryptActivateByPassphrase(_, _, _, _, _, _)) |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 185 | .WillOnce(&createMappedDev); |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 186 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 187 | EXPECT_CALL(*mockFsIface, runMkfs(StrEq(esObject->getCryptDevicePath()))) |
| 188 | .WillOnce(Return(0)); |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 189 | |
| 190 | EXPECT_CALL(*mockFsIface, directoryExists(path(esObject->getMountPoint()))) |
| 191 | .WillOnce(Return(true)); |
| 192 | |
| 193 | EXPECT_CALL(*mockFsIface, createDirectory(path(esObject->getMountPoint()))) |
| 194 | .Times(0); |
| 195 | |
| 196 | EXPECT_CALL(*mockFsIface, |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 197 | doMount(StrEq(esObject->getCryptDevicePath()), |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 198 | StrEq(esObject->getMountPoint()), _, _, _)) |
| 199 | .WillOnce(Return(0)); |
| 200 | |
| 201 | EXPECT_CALL(*mockFsIface, doUnmount(StrEq(esObject->getMountPoint()))) |
| 202 | .WillOnce(Return(0)); |
| 203 | |
| 204 | EXPECT_CALL(*mockFsIface, removeDirectory(path(esObject->getMountPoint()))) |
| 205 | .WillOnce(Return(true)); |
| 206 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 207 | EXPECT_CALL(*mockCryptIface, cryptDeactivate(_, _)) |
| 208 | .WillOnce(&removeMappedDev); |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 209 | |
| 210 | /* Format the encrypted device. */ |
| 211 | esObject->formatLuks(password, Volume::FilesystemType::ext4); |
| 212 | EXPECT_FALSE(esObject->isLocked()); |
| 213 | |
| 214 | esObject->lock(); |
| 215 | EXPECT_TRUE(esObject->isLocked()); |
| 216 | } |
| 217 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 218 | /* Test case where the device/file doesn't exist. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 219 | TEST_F(EStoragedTest, FormatNoDeviceFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 220 | { |
| 221 | /* Delete the test file. */ |
| 222 | EXPECT_EQ(0, unlink(testFileName)); |
| 223 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 224 | EXPECT_THROW(esObject->formatLuks(password, Volume::FilesystemType::ext4), |
| 225 | ResourceNotFound); |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 226 | EXPECT_TRUE(esObject->isLocked()); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 227 | |
| 228 | /* Create the test file again, so that the TearDown function works. */ |
| 229 | testFile.open(testFileName, |
| 230 | std::ios::out | std::ios::binary | std::ios::trunc); |
| 231 | testFile.close(); |
| 232 | } |
| 233 | |
| 234 | /* Test case where we fail to format the LUKS device. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 235 | TEST_F(EStoragedTest, FormatFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 236 | { |
| 237 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)) |
| 238 | .WillOnce(Return(-1)); |
| 239 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 240 | EXPECT_THROW(esObject->formatLuks(password, Volume::FilesystemType::ext4), |
| 241 | InternalFailure); |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 242 | EXPECT_TRUE(esObject->isLocked()); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 243 | } |
| 244 | |
| 245 | /* Test case where we fail to set the password for the LUKS device. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 246 | TEST_F(EStoragedTest, AddKeyslotFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 247 | { |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 248 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 249 | |
| 250 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 251 | .WillOnce(Return(-1)); |
| 252 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 253 | EXPECT_THROW(esObject->formatLuks(password, Volume::FilesystemType::ext4), |
| 254 | InternalFailure); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 255 | EXPECT_TRUE(esObject->isLocked()); |
| 256 | } |
| 257 | |
| 258 | /* Test case where we fail to load the LUKS header. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 259 | TEST_F(EStoragedTest, LoadLuksHeaderFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 260 | { |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 261 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 262 | |
| 263 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 264 | .Times(1); |
| 265 | |
| 266 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).WillOnce(Return(-1)); |
| 267 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 268 | EXPECT_THROW(esObject->formatLuks(password, Volume::FilesystemType::ext4), |
| 269 | InternalFailure); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 270 | EXPECT_TRUE(esObject->isLocked()); |
| 271 | } |
| 272 | |
| 273 | /* Test case where we fail to activate the LUKS device. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 274 | TEST_F(EStoragedTest, ActivateFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 275 | { |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 276 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 277 | |
| 278 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 279 | .Times(1); |
| 280 | |
| 281 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 282 | |
| 283 | EXPECT_CALL(*mockCryptIface, cryptActivateByPassphrase(_, _, _, _, _, _)) |
| 284 | .WillOnce(Return(-1)); |
| 285 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 286 | EXPECT_THROW(esObject->formatLuks(password, Volume::FilesystemType::ext4), |
| 287 | InternalFailure); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 288 | EXPECT_TRUE(esObject->isLocked()); |
| 289 | } |
| 290 | |
| 291 | /* Test case where we fail to create the filesystem. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 292 | TEST_F(EStoragedTest, CreateFilesystemFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 293 | { |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 294 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 295 | |
| 296 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 297 | .Times(1); |
| 298 | |
| 299 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 300 | |
| 301 | EXPECT_CALL(*mockCryptIface, cryptActivateByPassphrase(_, _, _, _, _, _)) |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 302 | .WillOnce(&createMappedDev); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 303 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 304 | EXPECT_CALL(*mockFsIface, runMkfs(StrEq(esObject->getCryptDevicePath()))) |
| 305 | .WillOnce(Return(-1)); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 306 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 307 | EXPECT_THROW(esObject->formatLuks(password, Volume::FilesystemType::ext4), |
| 308 | InternalFailure); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 309 | EXPECT_FALSE(esObject->isLocked()); |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 310 | |
| 311 | EXPECT_EQ(0, removeMappedDev()); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 312 | } |
| 313 | |
| 314 | /* Test case where we fail to create the mount point. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 315 | TEST_F(EStoragedTest, CreateMountPointFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 316 | { |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 317 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 318 | |
| 319 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 320 | .Times(1); |
| 321 | |
| 322 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 323 | |
| 324 | EXPECT_CALL(*mockCryptIface, cryptActivateByPassphrase(_, _, _, _, _, _)) |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 325 | .WillOnce(&createMappedDev); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 326 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 327 | EXPECT_CALL(*mockFsIface, runMkfs(StrEq(esObject->getCryptDevicePath()))) |
| 328 | .WillOnce(Return(0)); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 329 | |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 330 | EXPECT_CALL(*mockFsIface, directoryExists(path(esObject->getMountPoint()))) |
| 331 | .WillOnce(Return(false)); |
| 332 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 333 | EXPECT_CALL(*mockFsIface, createDirectory(path(esObject->getMountPoint()))) |
| 334 | .WillOnce(Return(false)); |
| 335 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 336 | EXPECT_THROW(esObject->formatLuks(password, Volume::FilesystemType::ext4), |
| 337 | InternalFailure); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 338 | EXPECT_FALSE(esObject->isLocked()); |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 339 | |
| 340 | EXPECT_EQ(0, removeMappedDev()); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 341 | } |
| 342 | |
| 343 | /* Test case where we fail to mount the filesystem. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 344 | TEST_F(EStoragedTest, MountFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 345 | { |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 346 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 347 | |
| 348 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 349 | .Times(1); |
| 350 | |
| 351 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 352 | |
| 353 | EXPECT_CALL(*mockCryptIface, cryptActivateByPassphrase(_, _, _, _, _, _)) |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 354 | .WillOnce(&createMappedDev); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 355 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 356 | EXPECT_CALL(*mockFsIface, runMkfs(StrEq(esObject->getCryptDevicePath()))) |
| 357 | .WillOnce(Return(0)); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 358 | |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 359 | EXPECT_CALL(*mockFsIface, directoryExists(path(esObject->getMountPoint()))) |
| 360 | .WillOnce(Return(false)); |
| 361 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 362 | EXPECT_CALL(*mockFsIface, createDirectory(path(esObject->getMountPoint()))) |
| 363 | .WillOnce(Return(true)); |
| 364 | |
| 365 | EXPECT_CALL(*mockFsIface, |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 366 | doMount(StrEq(esObject->getCryptDevicePath()), |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 367 | StrEq(esObject->getMountPoint()), _, _, _)) |
| 368 | .WillOnce(Return(-1)); |
| 369 | |
| 370 | EXPECT_CALL(*mockFsIface, removeDirectory(path(esObject->getMountPoint()))) |
| 371 | .WillOnce(Return(true)); |
| 372 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 373 | EXPECT_THROW(esObject->formatLuks(password, Volume::FilesystemType::ext4), |
| 374 | InternalFailure); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 375 | EXPECT_FALSE(esObject->isLocked()); |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 376 | |
| 377 | EXPECT_EQ(0, removeMappedDev()); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 378 | } |
| 379 | |
| 380 | /* Test case where we fail to unmount the filesystem. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 381 | TEST_F(EStoragedTest, UnmountFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 382 | { |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 383 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 384 | |
| 385 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 386 | .Times(1); |
| 387 | |
| 388 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 389 | |
| 390 | EXPECT_CALL(*mockCryptIface, cryptActivateByPassphrase(_, _, _, _, _, _)) |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 391 | .WillOnce(&createMappedDev); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 392 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 393 | EXPECT_CALL(*mockFsIface, runMkfs(StrEq(esObject->getCryptDevicePath()))) |
| 394 | .WillOnce(Return(0)); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 395 | |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 396 | EXPECT_CALL(*mockFsIface, directoryExists(path(esObject->getMountPoint()))) |
| 397 | .WillOnce(Return(false)); |
| 398 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 399 | EXPECT_CALL(*mockFsIface, createDirectory(path(esObject->getMountPoint()))) |
| 400 | .WillOnce(Return(true)); |
| 401 | |
| 402 | EXPECT_CALL(*mockFsIface, |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 403 | doMount(StrEq(esObject->getCryptDevicePath()), |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 404 | StrEq(esObject->getMountPoint()), _, _, _)) |
| 405 | .WillOnce(Return(0)); |
| 406 | |
| 407 | EXPECT_CALL(*mockFsIface, doUnmount(StrEq(esObject->getMountPoint()))) |
| 408 | .WillOnce(Return(-1)); |
| 409 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 410 | esObject->formatLuks(password, Volume::FilesystemType::ext4); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 411 | EXPECT_FALSE(esObject->isLocked()); |
| 412 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 413 | EXPECT_THROW(esObject->lock(), InternalFailure); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 414 | EXPECT_FALSE(esObject->isLocked()); |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 415 | |
| 416 | EXPECT_EQ(0, removeMappedDev()); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 417 | } |
| 418 | |
| 419 | /* Test case where we fail to remove the mount point. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 420 | TEST_F(EStoragedTest, RemoveMountPointFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 421 | { |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 422 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 423 | |
| 424 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 425 | .Times(1); |
| 426 | |
| 427 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 428 | |
| 429 | EXPECT_CALL(*mockCryptIface, cryptActivateByPassphrase(_, _, _, _, _, _)) |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 430 | .WillOnce(&createMappedDev); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 431 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 432 | EXPECT_CALL(*mockFsIface, runMkfs(StrEq(esObject->getCryptDevicePath()))) |
| 433 | .WillOnce(Return(0)); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 434 | |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 435 | EXPECT_CALL(*mockFsIface, directoryExists(path(esObject->getMountPoint()))) |
| 436 | .WillOnce(Return(false)); |
| 437 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 438 | EXPECT_CALL(*mockFsIface, createDirectory(path(esObject->getMountPoint()))) |
| 439 | .WillOnce(Return(true)); |
| 440 | |
| 441 | EXPECT_CALL(*mockFsIface, |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 442 | doMount(StrEq(esObject->getCryptDevicePath()), |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 443 | StrEq(esObject->getMountPoint()), _, _, _)) |
| 444 | .WillOnce(Return(0)); |
| 445 | |
| 446 | EXPECT_CALL(*mockFsIface, doUnmount(StrEq(esObject->getMountPoint()))) |
| 447 | .WillOnce(Return(0)); |
| 448 | |
| 449 | EXPECT_CALL(*mockFsIface, removeDirectory(path(esObject->getMountPoint()))) |
| 450 | .WillOnce(Return(false)); |
| 451 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 452 | esObject->formatLuks(password, Volume::FilesystemType::ext4); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 453 | EXPECT_FALSE(esObject->isLocked()); |
| 454 | |
| 455 | /* This will fail to remove the mount point. */ |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 456 | EXPECT_THROW(esObject->lock(), InternalFailure); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 457 | EXPECT_FALSE(esObject->isLocked()); |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 458 | |
| 459 | EXPECT_EQ(0, removeMappedDev()); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 460 | } |
| 461 | |
| 462 | /* Test case where we fail to deactivate the LUKS device. */ |
Ed Tanous | 82897c3 | 2022-02-21 14:11:59 -0800 | [diff] [blame] | 463 | TEST_F(EStoragedTest, DeactivateFail) |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 464 | { |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 465 | EXPECT_CALL(*mockCryptIface, cryptFormat(_, _, _, _, _, _, _, _)).Times(1); |
| 466 | |
| 467 | EXPECT_CALL(*mockCryptIface, cryptKeyslotAddByVolumeKey(_, _, _, _, _, _)) |
| 468 | .Times(1); |
| 469 | |
| 470 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 471 | |
| 472 | EXPECT_CALL(*mockCryptIface, cryptActivateByPassphrase(_, _, _, _, _, _)) |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 473 | .WillOnce(&createMappedDev); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 474 | |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 475 | EXPECT_CALL(*mockFsIface, runMkfs(StrEq(esObject->getCryptDevicePath()))) |
| 476 | .WillOnce(Return(0)); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 477 | |
John Wedig | b17f825 | 2022-01-12 14:24:26 -0800 | [diff] [blame] | 478 | EXPECT_CALL(*mockFsIface, directoryExists(path(esObject->getMountPoint()))) |
| 479 | .WillOnce(Return(false)); |
| 480 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 481 | EXPECT_CALL(*mockFsIface, createDirectory(path(esObject->getMountPoint()))) |
| 482 | .WillOnce(Return(true)); |
| 483 | |
| 484 | EXPECT_CALL(*mockFsIface, |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 485 | doMount(StrEq(esObject->getCryptDevicePath()), |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 486 | StrEq(esObject->getMountPoint()), _, _, _)) |
| 487 | .WillOnce(Return(0)); |
| 488 | |
| 489 | EXPECT_CALL(*mockFsIface, doUnmount(StrEq(esObject->getMountPoint()))) |
| 490 | .WillOnce(Return(0)); |
| 491 | |
| 492 | EXPECT_CALL(*mockFsIface, removeDirectory(path(esObject->getMountPoint()))) |
| 493 | .WillOnce(Return(true)); |
| 494 | |
| 495 | EXPECT_CALL(*mockCryptIface, cryptDeactivate(_, _)).WillOnce(Return(-1)); |
| 496 | |
| 497 | /* Format the encrypted device. */ |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 498 | esObject->formatLuks(password, Volume::FilesystemType::ext4); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 499 | EXPECT_FALSE(esObject->isLocked()); |
| 500 | |
John Wedig | 972c3fa | 2021-12-29 17:30:41 -0800 | [diff] [blame] | 501 | EXPECT_THROW(esObject->lock(), InternalFailure); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 502 | EXPECT_FALSE(esObject->isLocked()); |
John Wedig | 2443a02 | 2023-03-17 13:42:32 -0700 | [diff] [blame] | 503 | |
| 504 | EXPECT_EQ(0, removeMappedDev()); |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 505 | } |
| 506 | |
John Wedig | 8d5a3a0 | 2022-09-29 15:25:58 -0700 | [diff] [blame] | 507 | /* Test case where we successfully change the password. */ |
| 508 | TEST_F(EStoragedTest, ChangePasswordSuccess) |
| 509 | { |
| 510 | std::string newPasswordString("newPassword"); |
| 511 | std::vector<uint8_t> newPassword(newPasswordString.begin(), |
| 512 | newPasswordString.end()); |
| 513 | |
| 514 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 515 | |
| 516 | EXPECT_CALL(*mockCryptIface, |
| 517 | cryptKeyslotChangeByPassphrase( |
| 518 | _, _, _, reinterpret_cast<const char*>(password.data()), |
| 519 | password.size(), |
| 520 | reinterpret_cast<const char*>(newPassword.data()), |
| 521 | newPassword.size())) |
| 522 | .WillOnce(Return(0)); |
| 523 | |
| 524 | /* Change the password for the LUKS-encrypted device. */ |
| 525 | esObject->changePassword(password, newPassword); |
| 526 | } |
| 527 | |
| 528 | /* Test case where we fail to change the password. */ |
| 529 | TEST_F(EStoragedTest, ChangePasswordFail) |
| 530 | { |
| 531 | std::string newPasswordString("newPassword"); |
| 532 | std::vector<uint8_t> newPassword(newPasswordString.begin(), |
| 533 | newPasswordString.end()); |
| 534 | |
| 535 | EXPECT_CALL(*mockCryptIface, cryptLoad(_, _, _)).Times(1); |
| 536 | |
| 537 | EXPECT_CALL(*mockCryptIface, |
| 538 | cryptKeyslotChangeByPassphrase( |
| 539 | _, _, _, reinterpret_cast<const char*>(password.data()), |
| 540 | password.size(), |
| 541 | reinterpret_cast<const char*>(newPassword.data()), |
| 542 | newPassword.size())) |
| 543 | .WillOnce(Return(-1)); |
| 544 | |
| 545 | EXPECT_THROW(esObject->changePassword(password, newPassword), |
| 546 | InternalFailure); |
| 547 | } |
| 548 | |
John Wedig | b810c92 | 2021-11-17 16:38:03 -0800 | [diff] [blame] | 549 | } // namespace estoraged_test |