From a78b7a609f58ac82623c357426ef0590d6d76971 Mon Sep 17 00:00:00 2001 From: Ayushi Smriti Date: Mon, 9 Nov 2020 23:04:58 +0530 Subject: [PATCH] Process PLDM image type This change is to check whether the image uploaded is of PLDM image type based on the PackageHeaderIdentifier check which is a 16 bytes uuid field in the pldm package header. Also, determine image purpose and version. Purpose is set to pldm enum type and for version, PackageVersionString is concluded based on PackageVersionStringLength value. Tested: - On uploading a pldm image through Redfish. Uuid is identified and matched correctly. - Purpose and version is given to the image as expected and activation intf got added. - verified same with busctl cmd on xyz.openbmc_project.Software.Version and xyz.openbmc_project.Software.BMC.Updater - Verified the regular PFR update procedure works - received expected redfish response from postman - verified fwupd.sh script is reached Signed-off-by: Ayushi Smriti --- item_updater.cpp | 4 +- pfr_image_manager.cpp | 95 +++++++++++++++++++++++++++++++++++++++++-- pfr_image_manager.hpp | 6 +-- pldm.hpp | 21 ++++++++++ 4 files changed, 119 insertions(+), 7 deletions(-) create mode 100644 pldm.hpp diff --git a/item_updater.cpp b/item_updater.cpp index db255d6..7af80e3 100644 --- a/item_updater.cpp +++ b/item_updater.cpp @@ -67,6 +67,7 @@ void ItemUpdater::createActivation(sdbusplus::message::message& msg) #if defined(HOST_BIOS_UPGRADE) || defined(PFR_UPDATE) value == VersionPurpose::Host || #endif + value == VersionPurpose::PLDM || value == VersionPurpose::Other) { purpose = value; @@ -397,7 +398,8 @@ void ItemUpdater::deleteAll() } ItemUpdater::ActivationStatus - ItemUpdater::validateSquashFSImage(const std::string& filePath) + ItemUpdater::validateSquashFSImage(__attribute__((unused)) + const std::string& filePath) { #ifndef PFR_UPDATE bool valid = true; diff --git a/pfr_image_manager.cpp b/pfr_image_manager.cpp index 178367f..c923494 100644 --- a/pfr_image_manager.cpp +++ b/pfr_image_manager.cpp @@ -3,6 +3,7 @@ #include "pfr_image_manager.hpp" #include "dbus_helpers.hpp" +#include "pldm.hpp" #include "version.hpp" #include "watch.hpp" @@ -44,9 +45,10 @@ using BusyFail = Software::Image::BusyFailure; static constexpr const uint32_t pfmPos = 2054; static constexpr const uint32_t block0Magic = 0xB6EAFD19; static constexpr const uint32_t lengthBlk0Blk1 = 1024; +static constexpr const uint32_t pldmMagic = 0xF018878C; -int Manager::verifyPFRImage(const std::filesystem::path imgPath, - std::string& version, std::string& purposeString) +int Manager::verifyImage(const std::filesystem::path imgPath, + std::string& version, std::string& purposeString) { uint8_t imgType = 0; uint32_t imgMagic = 0; @@ -76,6 +78,93 @@ int Manager::verifyPFRImage(const std::filesystem::path imgPath, imgMagic = block0Data.tag; + if (htobe32(imgMagic) == pldmMagic) + { + if (!version.empty()) + { + version.clear(); + } + + imgFile.seekg(0, std::ios_base::end); + + const size_t length = imgFile.tellg(); + constexpr size_t readBytes = 36; + + if (length < readBytes) + { + phosphor::logging::log( + "Insufficient file length to read the required " + "bytes"); + return -1; + } + + imgFile.seekg(0, std::ios::beg); + + std::array buffer = {}; + + imgFile.read( + buffer.data(), + buffer.size()); // read 36 bytes of PLDM Package Header + + if (!imgFile.good()) + { + phosphor::logging::log( + "Image file read is not successful"); + return -1; + } + + if (!std::equal(buffer.begin(), + buffer.begin() + pldm::headerIdLen, + pldm::pldmPkgHeaderId + .begin())) // comparing 16 bytes of + // PackageHeaderIdentifier field + { + std::string redfishMsgID = + "OpenBMC.0.1.FirmwareUpdateFailed"; + sd_journal_send( + "MESSAGE=%s", "Firmware image verification failed", + "PRIORITY=%i", LOG_ERR, "REDFISH_MESSAGE_ID=%s", + redfishMsgID.c_str(), "REDFISH_MESSAGE_ARGS=%s", + "PLDM Image package header identifier check fail", + NULL); + + return -1; + } + + phosphor::logging::log( + "Package header identifier matched"); + purposeString = + "xyz.openbmc_project.Software.Version.VersionPurpose.PLDM"; + + const uint8_t pkgVerStrLen = static_cast( + buffer[35]); // PackageVersionStringLen byte + + imgFile.seekg(readBytes, + std::ios::beg); // point to the begin of + // PackageVersionString field + // i.e. 36th pos + + std::array ver = {}; + imgFile.read(ver.data(), + pkgVerStrLen); // read PackageVersionString bytes + + if (!imgFile.good()) + { + phosphor::logging::log( + "Image file read is not successful"); + return -1; + } + + version.assign(ver.data(), pkgVerStrLen); + phosphor::logging::log( + "Package version string value", + phosphor::logging::entry("IMAGE_VERSION=%s", + version.c_str())); + + imgFile.close(); + return 0; + } + if (imgMagic != block0Magic) { phosphor::logging::log( @@ -226,7 +315,7 @@ int Manager::processImage(const std::string& imgFilePath) std::string ver; std::string purposeString; - if (0 != verifyPFRImage(imgFilePath, ver, purposeString)) + if (0 != verifyImage(imgFilePath, ver, purposeString)) { phosphor::logging::log( "Error verifying uploaded image"); diff --git a/pfr_image_manager.hpp b/pfr_image_manager.hpp index 3591f1a..2facfe6 100644 --- a/pfr_image_manager.hpp +++ b/pfr_image_manager.hpp @@ -156,13 +156,13 @@ class Manager CustomMap mapFile(const std::filesystem::path& path, size_t size); /** - * @brief Verify the PFR image and return version and purpose + * @brief Verify the uploaded image type and return version and purpose * @param[in] - file path * @param[out] - version * @param[out] - purpose */ - int verifyPFRImage(const std::filesystem::path imgPath, - std::string& version, std::string& purposeString); + int verifyImage(const std::filesystem::path imgPath, std::string& version, + std::string& purposeString); /** @brief Persistent map of Version dbus objects and their * version id */ std::map> versions; diff --git a/pldm.hpp b/pldm.hpp new file mode 100644 index 0000000..edbd6ae --- /dev/null +++ b/pldm.hpp @@ -0,0 +1,21 @@ +namespace pldm +{ + +struct PldmPkgHeader +{ + uint8_t uuid[16]; // PackageHeaderIdentifier + uint8_t formatRev; // PackageHeaderFormatRevision + uint16_t headerSize; // PackageHeaderSize + uint8_t timestamp[13]; // PackageReleaseDateTime + uint16_t bitmapLen; // ComponentBitmapBitLength + uint8_t verStringType; // PackageVersionStringType + uint8_t verStringLen; // PackageVersionStringLength +} __attribute__((packed)); + +constexpr size_t headerIdLen = 16; + +const std::array pldmPkgHeaderId = { + 0xF0, 0x18, 0x87, 0x8C, 0xCB, 0x7D, 0x49, 0x43, + 0x98, 0x00, 0xA0, 0x2F, 0x05, 0x9A, 0xCA, 0x02}; // 16 bytes package header + // identifier uuid +} // namespace pldm -- 2.17.1