#pragma once #include "cryptsetupInterface.hpp" #include "filesystemInterface.hpp" #include "util.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include namespace estoraged { using estoraged::Cryptsetup; using estoraged::Filesystem; using sdbusplus::xyz::openbmc_project::Inventory::Item::server::Drive; using sdbusplus::xyz::openbmc_project::Inventory::Item::server::Volume; /** @class eStoraged * @brief eStoraged object to manage a LUKS encrypted storage device. */ class EStoraged { public: /** @brief Constructor for eStoraged * * @param[in] server - sdbusplus asio object server * @param[in] configPath - path of the config object from Entity Manager * @param[in] devPath - path to device file, e.g. /dev/mmcblk0 * @param[in] luksName - name for the LUKS container * @param[in] size - size of the drive in bytes * @param[in] lifeTime - percent of lifetime remaining for a drive * @param[in] partNumber - part number for the storage device * @param[in] serialNumber - serial number for the storage device * @param[in] cryptInterface - (optional) pointer to CryptsetupInterface * object * @param[in] fsInterface - (optional) pointer to FilesystemInterface * object */ EStoraged(sdbusplus::asio::object_server& server, const std::string& configPath, const std::string& devPath, const std::string& luksName, uint64_t size, uint8_t lifeTime, const std::string& partNumber, const std::string& serialNumber, std::unique_ptr cryptInterface = std::make_unique(), std::unique_ptr fsInterface = std::make_unique()); /** @brief Destructor for eStoraged. */ ~EStoraged(); EStoraged& operator=(const EStoraged&) = delete; EStoraged(const EStoraged&) = delete; EStoraged(EStoraged&&) = default; EStoraged& operator=(EStoraged&&) = default; /** @brief Format the LUKS encrypted device and create empty filesystem. * * @param[in] password - password to set for the LUKS device. * @param[in] type - filesystem type, e.g. ext4 */ void formatLuks(const std::vector& password, Volume::FilesystemType type); /** @brief Erase the contents of the storage device. * * @param[in] eraseType - type of erase operation. */ void erase(Volume::EraseMethod eraseType); /** @brief Unmount filesystem and lock the LUKS device. */ void lock(); /** @brief Unlock device and mount the filesystem. * * @param[in] password - password for the LUKS device. */ void unlock(std::vector password); /** @brief Change the password for the LUKS device. * * @param[in] oldPassword - old password for the LUKS device. * @param[in] newPassword - new password for the LUKS device. */ void changePassword(const std::vector& oldPassword, const std::vector& newPassword); /** @brief Check if the LUKS device is currently locked. */ bool isLocked() const; /** @brief Get the mount point for the filesystem on the LUKS device. */ std::string_view getMountPoint() const; private: /** @brief Full path of the device file, e.g. /dev/mmcblk0. */ std::string devPath; /** @brief Name of the LUKS container. */ std::string containerName; /** @brief Mount point for the filesystem. */ std::string mountPoint; /** @brief Indicates whether the LUKS device is currently locked. */ bool lockedProperty{false}; /** @brief Pointer to cryptsetup interface object. * @details This is used to mock out the cryptsetup functions. */ std::unique_ptr cryptIface; /** @brief Pointer to filesystem interface object. * @details This is used to mock out filesystem operations. */ std::unique_ptr fsIface; /** @brief D-Bus object server. */ sdbusplus::asio::object_server& objectServer; /** @brief D-Bus interface for the logical volume. */ std::shared_ptr volumeInterface; /** @brief D-Bus interface for the physical drive. */ std::shared_ptr driveInterface; /** @brief D-Bus interface for the location of the drive. */ std::shared_ptr embeddedLocationInterface; /** @brief D-Bus interface for the asset information. */ std::shared_ptr assetInterface; /** @brief Association between chassis and drive. */ std::shared_ptr association; /** @brief Indicates whether the LUKS header is on the disk. */ Drive::DriveEncryptionState encryptionStatus{ Drive::DriveEncryptionState::Unknown}; /** @brief Format LUKS encrypted device. * * @param[in] password - password to set for the LUKS device. */ void formatLuksDev(std::vector password); /** @brief check the LUKS header, for devPath * * @returns a CryptHandle to the LUKS drive */ CryptHandle loadLuksHeader(); /** @brief Unlock the device. * * @param[in] password - password to activate the LUKS device. */ Drive::DriveEncryptionState findEncryptionStatus(); void activateLuksDev(std::vector password); /** @brief Create the filesystem on the LUKS device. * @details The LUKS device should already be activated, i.e. unlocked. */ void createFilesystem(); /** @brief Deactivate the LUKS device. * @details The filesystem is assumed to be unmounted already. */ void deactivateLuksDev(); /** @brief Mount the filesystem. * @details The filesystem should already exist and the LUKS device should * be unlocked already. */ void mountFilesystem(); /** @brief Unmount the filesystem. */ void unmountFilesystem(); /** @brief Set the locked property. * * @param[in] isLocked - indicates whether the LUKS device is locked. */ void locked(bool isLocked); }; } // namespace estoraged