1 #pragma once 2 3 #include "cryptsetupInterface.hpp" 4 #include "filesystemInterface.hpp" 5 6 #include <libcryptsetup.h> 7 8 #include <sdbusplus/bus.hpp> 9 #include <sdbusplus/exception.hpp> 10 #include <sdbusplus/server/object.hpp> 11 #include <xyz/openbmc_project/eStoraged/server.hpp> 12 13 #include <filesystem> 14 #include <memory> 15 #include <string> 16 #include <string_view> 17 #include <vector> 18 19 namespace estoraged 20 { 21 using eStoragedInherit = sdbusplus::server::object_t< 22 sdbusplus::xyz::openbmc_project::server::eStoraged>; 23 using estoraged::Cryptsetup; 24 using estoraged::Filesystem; 25 26 /** @class eStoraged 27 * @brief eStoraged object to manage a LUKS encrypted storage device. 28 */ 29 class eStoraged : eStoragedInherit 30 { 31 public: 32 /** @brief Constructor for eStoraged 33 * 34 * @param[in] bus - sdbusplus dbus object 35 * @param[in] path - DBus object path 36 * @param[in] devPath - path to device file, e.g. /dev/mmcblk0 37 * @param[in] luksName - name for the LUKS container 38 * @param[in] cryptInterface - (optional) pointer to CryptsetupInterface 39 * object 40 * @param[in] fsInterface - (optional) pointer to FilesystemInterface 41 * object 42 */ 43 eStoraged(sdbusplus::bus::bus& bus, const char* path, 44 const std::string& devPath, const std::string& luksName, 45 std::unique_ptr<CryptsetupInterface> cryptInterface = 46 std::make_unique<Cryptsetup>(), 47 std::unique_ptr<FilesystemInterface> fsInterface = 48 std::make_unique<Filesystem>()) : 49 eStoragedInherit(bus, path), 50 devPath(devPath), containerName(luksName), 51 mountPoint("/mnt/" + luksName + "_fs"), 52 cryptIface(std::move(cryptInterface)), fsIface(std::move(fsInterface)) 53 {} 54 55 /** @brief Format the LUKS encrypted device and create empty filesystem. 56 * 57 * @param[in] password - password to set for the LUKS device. 58 */ 59 void format(std::vector<uint8_t> password) override; 60 61 /** @brief Erase the contents of the storage device. 62 * 63 * @param[in] password - password for the LUKS device. 64 * @param[in] eraseType - type of erase operation. 65 */ 66 void erase(std::vector<uint8_t> password, EraseMethod eraseType) override; 67 68 /** @brief Unmount filesystem and lock the LUKS device. 69 * 70 * @param[in] password - password for the LUKS device. 71 */ 72 void lock(std::vector<uint8_t> password) override; 73 74 /** @brief Unlock device and mount the filesystem. 75 * 76 * @param[in] password - password for the LUKS device. 77 */ 78 void unlock(std::vector<uint8_t> password) override; 79 80 /** @brief Change the password for the LUKS device. 81 * 82 * @param[in] oldPassword - old password for the LUKS device. 83 * @param[in] newPassword - new password for the LUKS device. 84 */ 85 void changePassword(std::vector<uint8_t> oldPassword, 86 std::vector<uint8_t> newPassword) override; 87 88 /** @brief Check if the LUKS device is currently locked. */ 89 bool isLocked() const; 90 91 /** @brief Get the mount point for the filesystem on the LUKS device. */ 92 std::string_view getMountPoint() const; 93 94 private: 95 /** @brief Full path of the device file, e.g. /dev/mmcblk0. */ 96 std::string devPath; 97 98 /** @brief Name of the LUKS container. */ 99 std::string containerName; 100 101 /** @brief Mount point for the filesystem. */ 102 std::string mountPoint; 103 104 /** @brief Pointer to cryptsetup interface object. 105 * @details This is used to mock out the cryptsetup functions. 106 */ 107 std::unique_ptr<CryptsetupInterface> cryptIface; 108 109 /** @brief Pointer to filesystem interface object. 110 * @details This is used to mock out filesystem operations. 111 */ 112 std::unique_ptr<FilesystemInterface> fsIface; 113 114 /** @brief Format LUKS encrypted device. 115 * 116 * @param[in] cd - initialized crypt_device struct for the device. 117 * @param[in] password - password to set for the LUKS device. 118 */ 119 void formatLuksDev(struct crypt_device* cd, std::vector<uint8_t> password); 120 121 /** @brief Unlock the device. 122 * 123 * @param[in] cd - initialized crypt_device struct for the device. 124 * @param[in] password - password to activate the LUKS device. 125 */ 126 void activateLuksDev(struct crypt_device* cd, 127 std::vector<uint8_t> password); 128 129 /** @brief Create the filesystem on the LUKS device. 130 * @details The LUKS device should already be activated, i.e. unlocked. 131 */ 132 void createFilesystem(); 133 134 /** @brief Deactivate the LUKS device. 135 * @details The filesystem is assumed to be unmounted already. 136 */ 137 void deactivateLuksDev(); 138 139 /** @brief Mount the filesystem. 140 * @details The filesystem should already exist and the LUKS device should 141 * be unlocked already. 142 */ 143 void mountFilesystem(); 144 145 /** @brief Unmount the filesystem. */ 146 void unmountFilesystem(); 147 }; 148 149 } // namespace estoraged 150