1 #include "config.h" 2 3 #include <arpa/inet.h> 4 #include <fcntl.h> 5 #include <limits.h> 6 #include <linux/i2c-dev.h> 7 #include <linux/i2c.h> 8 #include <mapper.h> 9 #include <sys/ioctl.h> 10 #include <sys/stat.h> 11 #include <sys/types.h> 12 #include <systemd/sd-bus.h> 13 #include <unistd.h> 14 15 #include <app/channel.hpp> 16 #include <app/watchdog.hpp> 17 #include <apphandler.hpp> 18 #include <ipmid/api.hpp> 19 #include <ipmid/sessiondef.hpp> 20 #include <ipmid/sessionhelper.hpp> 21 #include <ipmid/types.hpp> 22 #include <ipmid/utils.hpp> 23 #include <nlohmann/json.hpp> 24 #include <phosphor-logging/elog-errors.hpp> 25 #include <phosphor-logging/log.hpp> 26 #include <sdbusplus/message/types.hpp> 27 #include <sys_info_param.hpp> 28 #include <xyz/openbmc_project/Common/error.hpp> 29 #include <xyz/openbmc_project/Control/Power/ACPIPowerState/server.hpp> 30 #include <xyz/openbmc_project/Software/Activation/server.hpp> 31 #include <xyz/openbmc_project/Software/Version/server.hpp> 32 #include <xyz/openbmc_project/State/BMC/server.hpp> 33 34 #include <algorithm> 35 #include <array> 36 #include <charconv> 37 #include <cstddef> 38 #include <cstdint> 39 #include <filesystem> 40 #include <fstream> 41 #include <memory> 42 #include <regex> 43 #include <string> 44 #include <string_view> 45 #include <tuple> 46 #include <vector> 47 48 extern sd_bus* bus; 49 50 constexpr auto bmc_state_interface = "xyz.openbmc_project.State.BMC"; 51 constexpr auto bmc_state_property = "CurrentBMCState"; 52 53 static constexpr auto redundancyIntf = 54 "xyz.openbmc_project.Software.RedundancyPriority"; 55 static constexpr auto versionIntf = "xyz.openbmc_project.Software.Version"; 56 static constexpr auto activationIntf = 57 "xyz.openbmc_project.Software.Activation"; 58 static constexpr auto softwareRoot = "/xyz/openbmc_project/software"; 59 60 void register_netfn_app_functions() __attribute__((constructor)); 61 62 using namespace phosphor::logging; 63 using namespace sdbusplus::xyz::openbmc_project::Common::Error; 64 using Version = sdbusplus::xyz::openbmc_project::Software::server::Version; 65 using Activation = 66 sdbusplus::xyz::openbmc_project::Software::server::Activation; 67 using BMC = sdbusplus::xyz::openbmc_project::State::server::BMC; 68 namespace fs = std::filesystem; 69 70 #ifdef ENABLE_I2C_WHITELIST_CHECK 71 typedef struct 72 { 73 uint8_t busId; 74 uint8_t slaveAddr; 75 uint8_t slaveAddrMask; 76 std::vector<uint8_t> data; 77 std::vector<uint8_t> dataMask; 78 } i2cMasterWRWhitelist; 79 80 static std::vector<i2cMasterWRWhitelist>& getWRWhitelist() 81 { 82 static std::vector<i2cMasterWRWhitelist> wrWhitelist; 83 return wrWhitelist; 84 } 85 86 static constexpr const char* i2cMasterWRWhitelistFile = 87 "/usr/share/ipmi-providers/master_write_read_white_list.json"; 88 89 static constexpr const char* filtersStr = "filters"; 90 static constexpr const char* busIdStr = "busId"; 91 static constexpr const char* slaveAddrStr = "slaveAddr"; 92 static constexpr const char* slaveAddrMaskStr = "slaveAddrMask"; 93 static constexpr const char* cmdStr = "command"; 94 static constexpr const char* cmdMaskStr = "commandMask"; 95 static constexpr int base_16 = 16; 96 #endif // ENABLE_I2C_WHITELIST_CHECK 97 static constexpr uint8_t maxIPMIWriteReadSize = 255; 98 static constexpr uint8_t oemCmdStart = 192; 99 static constexpr uint8_t oemCmdEnd = 255; 100 static constexpr uint8_t invalidParamSelectorStart = 8; 101 static constexpr uint8_t invalidParamSelectorEnd = 191; 102 103 /** 104 * @brief Returns the Version info from primary s/w object 105 * 106 * Get the Version info from the active s/w object which is having high 107 * "Priority" value(a smaller number is a higher priority) and "Purpose" 108 * is "BMC" from the list of all s/w objects those are implementing 109 * RedundancyPriority interface from the given softwareRoot path. 110 * 111 * @return On success returns the Version info from primary s/w object. 112 * 113 */ 114 std::string getActiveSoftwareVersionInfo(ipmi::Context::ptr ctx) 115 { 116 std::string revision{}; 117 ipmi::ObjectTree objectTree; 118 try 119 { 120 objectTree = ipmi::getAllDbusObjects(*ctx->bus, softwareRoot, 121 redundancyIntf); 122 } 123 catch (const sdbusplus::exception_t& e) 124 { 125 log<level::ERR>("Failed to fetch redundancy object from dbus", 126 entry("INTERFACE=%s", redundancyIntf), 127 entry("ERRMSG=%s", e.what())); 128 elog<InternalFailure>(); 129 } 130 131 auto objectFound = false; 132 for (auto& softObject : objectTree) 133 { 134 auto service = ipmi::getService(*ctx->bus, redundancyIntf, 135 softObject.first); 136 auto objValueTree = ipmi::getManagedObjects(*ctx->bus, service, 137 softwareRoot); 138 139 auto minPriority = 0xFF; 140 for (const auto& objIter : objValueTree) 141 { 142 try 143 { 144 auto& intfMap = objIter.second; 145 auto& redundancyPriorityProps = intfMap.at(redundancyIntf); 146 auto& versionProps = intfMap.at(versionIntf); 147 auto& activationProps = intfMap.at(activationIntf); 148 auto priority = 149 std::get<uint8_t>(redundancyPriorityProps.at("Priority")); 150 auto purpose = 151 std::get<std::string>(versionProps.at("Purpose")); 152 auto activation = 153 std::get<std::string>(activationProps.at("Activation")); 154 auto version = 155 std::get<std::string>(versionProps.at("Version")); 156 if ((Version::convertVersionPurposeFromString(purpose) == 157 Version::VersionPurpose::BMC) && 158 (Activation::convertActivationsFromString(activation) == 159 Activation::Activations::Active)) 160 { 161 if (priority < minPriority) 162 { 163 minPriority = priority; 164 objectFound = true; 165 revision = std::move(version); 166 } 167 } 168 } 169 catch (const std::exception& e) 170 { 171 log<level::ERR>(e.what()); 172 } 173 } 174 } 175 176 if (!objectFound) 177 { 178 log<level::ERR>("Could not found an BMC software Object"); 179 elog<InternalFailure>(); 180 } 181 182 return revision; 183 } 184 185 bool getCurrentBmcState() 186 { 187 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()}; 188 189 // Get the Inventory object implementing the BMC interface 190 ipmi::DbusObjectInfo bmcObject = ipmi::getDbusObject(bus, 191 bmc_state_interface); 192 auto variant = ipmi::getDbusProperty(bus, bmcObject.second, bmcObject.first, 193 bmc_state_interface, 194 bmc_state_property); 195 196 return std::holds_alternative<std::string>(variant) && 197 BMC::convertBMCStateFromString(std::get<std::string>(variant)) == 198 BMC::BMCState::Ready; 199 } 200 201 bool getCurrentBmcStateWithFallback(const bool fallbackAvailability) 202 { 203 try 204 { 205 return getCurrentBmcState(); 206 } 207 catch (...) 208 { 209 // Nothing provided the BMC interface, therefore return whatever was 210 // configured as the default. 211 return fallbackAvailability; 212 } 213 } 214 215 namespace acpi_state 216 { 217 using namespace sdbusplus::xyz::openbmc_project::Control::Power::server; 218 219 const static constexpr char* acpiObjPath = 220 "/xyz/openbmc_project/control/host0/acpi_power_state"; 221 const static constexpr char* acpiInterface = 222 "xyz.openbmc_project.Control.Power.ACPIPowerState"; 223 const static constexpr char* sysACPIProp = "SysACPIStatus"; 224 const static constexpr char* devACPIProp = "DevACPIStatus"; 225 226 enum class PowerStateType : uint8_t 227 { 228 sysPowerState = 0x00, 229 devPowerState = 0x01, 230 }; 231 232 // Defined in 20.6 of ipmi doc 233 enum class PowerState : uint8_t 234 { 235 s0G0D0 = 0x00, 236 s1D1 = 0x01, 237 s2D2 = 0x02, 238 s3D3 = 0x03, 239 s4 = 0x04, 240 s5G2 = 0x05, 241 s4S5 = 0x06, 242 g3 = 0x07, 243 sleep = 0x08, 244 g1Sleep = 0x09, 245 override = 0x0a, 246 legacyOn = 0x20, 247 legacyOff = 0x21, 248 unknown = 0x2a, 249 noChange = 0x7f, 250 }; 251 252 static constexpr uint8_t stateChanged = 0x80; 253 254 std::map<ACPIPowerState::ACPI, PowerState> dbusToIPMI = { 255 {ACPIPowerState::ACPI::S0_G0_D0, PowerState::s0G0D0}, 256 {ACPIPowerState::ACPI::S1_D1, PowerState::s1D1}, 257 {ACPIPowerState::ACPI::S2_D2, PowerState::s2D2}, 258 {ACPIPowerState::ACPI::S3_D3, PowerState::s3D3}, 259 {ACPIPowerState::ACPI::S4, PowerState::s4}, 260 {ACPIPowerState::ACPI::S5_G2, PowerState::s5G2}, 261 {ACPIPowerState::ACPI::S4_S5, PowerState::s4S5}, 262 {ACPIPowerState::ACPI::G3, PowerState::g3}, 263 {ACPIPowerState::ACPI::SLEEP, PowerState::sleep}, 264 {ACPIPowerState::ACPI::G1_SLEEP, PowerState::g1Sleep}, 265 {ACPIPowerState::ACPI::OVERRIDE, PowerState::override}, 266 {ACPIPowerState::ACPI::LEGACY_ON, PowerState::legacyOn}, 267 {ACPIPowerState::ACPI::LEGACY_OFF, PowerState::legacyOff}, 268 {ACPIPowerState::ACPI::Unknown, PowerState::unknown}}; 269 270 bool isValidACPIState(acpi_state::PowerStateType type, uint8_t state) 271 { 272 if (type == acpi_state::PowerStateType::sysPowerState) 273 { 274 if ((state <= static_cast<uint8_t>(acpi_state::PowerState::override)) || 275 (state == static_cast<uint8_t>(acpi_state::PowerState::legacyOn)) || 276 (state == 277 static_cast<uint8_t>(acpi_state::PowerState::legacyOff)) || 278 (state == static_cast<uint8_t>(acpi_state::PowerState::unknown)) || 279 (state == static_cast<uint8_t>(acpi_state::PowerState::noChange))) 280 { 281 return true; 282 } 283 else 284 { 285 return false; 286 } 287 } 288 else if (type == acpi_state::PowerStateType::devPowerState) 289 { 290 if ((state <= static_cast<uint8_t>(acpi_state::PowerState::s3D3)) || 291 (state == static_cast<uint8_t>(acpi_state::PowerState::unknown)) || 292 (state == static_cast<uint8_t>(acpi_state::PowerState::noChange))) 293 { 294 return true; 295 } 296 else 297 { 298 return false; 299 } 300 } 301 else 302 { 303 return false; 304 } 305 return false; 306 } 307 } // namespace acpi_state 308 309 /** @brief implements Set ACPI Power State command 310 * @param sysAcpiState - ACPI system power state to set 311 * @param devAcpiState - ACPI device power state to set 312 * 313 * @return IPMI completion code on success 314 **/ 315 ipmi::RspType<> ipmiSetAcpiPowerState(uint8_t sysAcpiState, 316 uint8_t devAcpiState) 317 { 318 auto s = static_cast<uint8_t>(acpi_state::PowerState::unknown); 319 320 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()}; 321 322 auto value = acpi_state::ACPIPowerState::ACPI::Unknown; 323 324 if (sysAcpiState & acpi_state::stateChanged) 325 { 326 // set system power state 327 s = sysAcpiState & ~acpi_state::stateChanged; 328 329 if (!acpi_state::isValidACPIState( 330 acpi_state::PowerStateType::sysPowerState, s)) 331 { 332 log<level::ERR>("set_acpi_power sys invalid input", 333 entry("S=%x", s)); 334 return ipmi::responseParmOutOfRange(); 335 } 336 337 // valid input 338 if (s == static_cast<uint8_t>(acpi_state::PowerState::noChange)) 339 { 340 log<level::DEBUG>("No change for system power state"); 341 } 342 else 343 { 344 auto found = std::find_if(acpi_state::dbusToIPMI.begin(), 345 acpi_state::dbusToIPMI.end(), 346 [&s](const auto& iter) { 347 return (static_cast<uint8_t>(iter.second) == s); 348 }); 349 350 value = found->first; 351 352 try 353 { 354 auto acpiObject = 355 ipmi::getDbusObject(bus, acpi_state::acpiInterface); 356 ipmi::setDbusProperty(bus, acpiObject.second, acpiObject.first, 357 acpi_state::acpiInterface, 358 acpi_state::sysACPIProp, 359 convertForMessage(value)); 360 } 361 catch (const InternalFailure& e) 362 { 363 log<level::ERR>("Failed in set ACPI system property", 364 entry("EXCEPTION=%s", e.what())); 365 return ipmi::responseUnspecifiedError(); 366 } 367 } 368 } 369 else 370 { 371 log<level::DEBUG>("Do not change system power state"); 372 } 373 374 if (devAcpiState & acpi_state::stateChanged) 375 { 376 // set device power state 377 s = devAcpiState & ~acpi_state::stateChanged; 378 if (!acpi_state::isValidACPIState( 379 acpi_state::PowerStateType::devPowerState, s)) 380 { 381 log<level::ERR>("set_acpi_power dev invalid input", 382 entry("S=%x", s)); 383 return ipmi::responseParmOutOfRange(); 384 } 385 386 // valid input 387 if (s == static_cast<uint8_t>(acpi_state::PowerState::noChange)) 388 { 389 log<level::DEBUG>("No change for device power state"); 390 } 391 else 392 { 393 auto found = std::find_if(acpi_state::dbusToIPMI.begin(), 394 acpi_state::dbusToIPMI.end(), 395 [&s](const auto& iter) { 396 return (static_cast<uint8_t>(iter.second) == s); 397 }); 398 399 value = found->first; 400 401 try 402 { 403 auto acpiObject = 404 ipmi::getDbusObject(bus, acpi_state::acpiInterface); 405 ipmi::setDbusProperty(bus, acpiObject.second, acpiObject.first, 406 acpi_state::acpiInterface, 407 acpi_state::devACPIProp, 408 convertForMessage(value)); 409 } 410 catch (const InternalFailure& e) 411 { 412 log<level::ERR>("Failed in set ACPI device property", 413 entry("EXCEPTION=%s", e.what())); 414 return ipmi::responseUnspecifiedError(); 415 } 416 } 417 } 418 else 419 { 420 log<level::DEBUG>("Do not change device power state"); 421 } 422 return ipmi::responseSuccess(); 423 } 424 425 /** 426 * @brief implements the get ACPI power state command 427 * 428 * @return IPMI completion code plus response data on success. 429 * - ACPI system power state 430 * - ACPI device power state 431 **/ 432 ipmi::RspType<uint8_t, // acpiSystemPowerState 433 uint8_t // acpiDevicePowerState 434 > 435 ipmiGetAcpiPowerState() 436 { 437 uint8_t sysAcpiState; 438 uint8_t devAcpiState; 439 440 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()}; 441 442 try 443 { 444 auto acpiObject = ipmi::getDbusObject(bus, acpi_state::acpiInterface); 445 446 auto sysACPIVal = ipmi::getDbusProperty( 447 bus, acpiObject.second, acpiObject.first, acpi_state::acpiInterface, 448 acpi_state::sysACPIProp); 449 auto sysACPI = acpi_state::ACPIPowerState::convertACPIFromString( 450 std::get<std::string>(sysACPIVal)); 451 sysAcpiState = static_cast<uint8_t>(acpi_state::dbusToIPMI.at(sysACPI)); 452 453 auto devACPIVal = ipmi::getDbusProperty( 454 bus, acpiObject.second, acpiObject.first, acpi_state::acpiInterface, 455 acpi_state::devACPIProp); 456 auto devACPI = acpi_state::ACPIPowerState::convertACPIFromString( 457 std::get<std::string>(devACPIVal)); 458 devAcpiState = static_cast<uint8_t>(acpi_state::dbusToIPMI.at(devACPI)); 459 } 460 catch (const InternalFailure& e) 461 { 462 return ipmi::responseUnspecifiedError(); 463 } 464 465 return ipmi::responseSuccess(sysAcpiState, devAcpiState); 466 } 467 468 typedef struct 469 { 470 char major; 471 char minor; 472 uint8_t aux[4]; 473 } Revision; 474 475 /* Use regular expression searching matched pattern X.Y, and convert it to */ 476 /* Major (X) and Minor (Y) version. */ 477 /* Example: */ 478 /* version = 2.14.0-dev */ 479 /* ^ ^ */ 480 /* | |---------------- Minor */ 481 /* |------------------ Major */ 482 /* */ 483 /* Default regex string only tries to match Major and Minor version. */ 484 /* */ 485 /* To match more firmware version info, platforms need to define it own */ 486 /* regex string to match more strings, and assign correct mapping index in */ 487 /* matches array. */ 488 /* */ 489 /* matches[0]: matched index for major ver */ 490 /* matches[1]: matched index for minor ver */ 491 /* matches[2]: matched index for aux[0] (set 0 to skip) */ 492 /* matches[3]: matched index for aux[1] (set 0 to skip) */ 493 /* matches[4]: matched index for aux[2] (set 0 to skip) */ 494 /* matches[5]: matched index for aux[3] (set 0 to skip) */ 495 /* Example: */ 496 /* regex = "([\d]+).([\d]+).([\d]+)-dev-([\d]+)-g([0-9a-fA-F]{2}) */ 497 /* ([0-9a-fA-F]{2})([0-9a-fA-F]{2})([0-9a-fA-F]{2})" */ 498 /* matches = {1,2,5,6,7,8} */ 499 /* version = 2.14.0-dev-750-g37a7c5ad1-dirty */ 500 /* ^ ^ ^ ^ ^ ^ ^ ^ */ 501 /* | | | | | | | | */ 502 /* | | | | | | | |-- Aux byte 3 (0xAD), index 8 */ 503 /* | | | | | | |---- Aux byte 2 (0xC5), index 7 */ 504 /* | | | | | |------ Aux byte 1 (0xA7), index 6 */ 505 /* | | | | |-------- Aux byte 0 (0x37), index 5 */ 506 /* | | | |------------- Not used, index 4 */ 507 /* | | |------------------- Not used, index 3 */ 508 /* | |---------------------- Minor (14), index 2 */ 509 /* |------------------------ Major (2), index 1 */ 510 int convertVersion(std::string s, Revision& rev) 511 { 512 static const std::vector<size_t> matches = { 513 MAJOR_MATCH_INDEX, MINOR_MATCH_INDEX, AUX_0_MATCH_INDEX, 514 AUX_1_MATCH_INDEX, AUX_2_MATCH_INDEX, AUX_3_MATCH_INDEX}; 515 std::regex fw_regex(FW_VER_REGEX); 516 std::smatch m; 517 Revision r = {0}; 518 size_t val; 519 520 if (std::regex_search(s, m, fw_regex)) 521 { 522 if (m.size() < *std::max_element(matches.begin(), matches.end())) 523 { // max index higher than match count 524 return -1; 525 } 526 527 // convert major 528 { 529 std::string_view str = m[matches[0]].str(); 530 auto [ptr, ec]{std::from_chars(str.begin(), str.end(), val)}; 531 if (ec != std::errc() || ptr != str.begin() + str.size()) 532 { // failed to convert major string 533 return -1; 534 } 535 r.major = val & 0x7F; 536 } 537 538 // convert minor 539 { 540 std::string_view str = m[matches[1]].str(); 541 auto [ptr, ec]{std::from_chars(str.begin(), str.end(), val)}; 542 if (ec != std::errc() || ptr != str.begin() + str.size()) 543 { // failed to convert minor string 544 return -1; 545 } 546 r.minor = val & 0xFF; 547 } 548 549 // convert aux bytes 550 { 551 size_t i; 552 for (i = 0; i < 4; i++) 553 { 554 if (matches[i + 2] == 0) 555 { 556 continue; 557 } 558 559 std::string_view str = m[matches[i + 2]].str(); 560 auto [ptr, 561 ec]{std::from_chars(str.begin(), str.end(), val, 16)}; 562 if (ec != std::errc() || ptr != str.begin() + str.size()) 563 { // failed to convert aux byte string 564 break; 565 } 566 567 r.aux[i] = val & 0xFF; 568 } 569 570 if (i != 4) 571 { // something wrong durign converting aux bytes 572 return -1; 573 } 574 } 575 576 // all matched 577 rev = r; 578 return 0; 579 } 580 581 return -1; 582 } 583 584 /* @brief: Implement the Get Device ID IPMI command per the IPMI spec 585 * @param[in] ctx - shared_ptr to an IPMI context struct 586 * 587 * @returns IPMI completion code plus response data 588 * - Device ID (manufacturer defined) 589 * - Device revision[4 bits]; reserved[3 bits]; SDR support[1 bit] 590 * - FW revision major[7 bits] (binary encoded); available[1 bit] 591 * - FW Revision minor (BCD encoded) 592 * - IPMI version (0x02 for IPMI 2.0) 593 * - device support (bitfield of supported options) 594 * - MFG IANA ID (3 bytes) 595 * - product ID (2 bytes) 596 * - AUX info (4 bytes) 597 */ 598 ipmi::RspType<uint8_t, // Device ID 599 uint8_t, // Device Revision 600 uint8_t, // Firmware Revision Major 601 uint8_t, // Firmware Revision minor 602 uint8_t, // IPMI version 603 uint8_t, // Additional device support 604 uint24_t, // MFG ID 605 uint16_t, // Product ID 606 uint32_t // AUX info 607 > 608 ipmiAppGetDeviceId([[maybe_unused]] ipmi::Context::ptr ctx) 609 { 610 static struct 611 { 612 uint8_t id; 613 uint8_t revision; 614 uint8_t fw[2]; 615 uint8_t ipmiVer; 616 uint8_t addnDevSupport; 617 uint24_t manufId; 618 uint16_t prodId; 619 uint32_t aux; 620 } devId; 621 static bool dev_id_initialized = false; 622 static bool defaultActivationSetting = true; 623 const char* filename = "/usr/share/ipmi-providers/dev_id.json"; 624 constexpr auto ipmiDevIdStateShift = 7; 625 constexpr auto ipmiDevIdFw1Mask = ~(1 << ipmiDevIdStateShift); 626 627 #ifdef GET_DBUS_ACTIVE_SOFTWARE 628 static bool haveBMCVersion = false; 629 if (!haveBMCVersion || !dev_id_initialized) 630 { 631 int r = -1; 632 Revision rev = {0, 0, 0, 0}; 633 try 634 { 635 auto version = getActiveSoftwareVersionInfo(ctx); 636 r = convertVersion(version, rev); 637 } 638 catch (const std::exception& e) 639 { 640 log<level::ERR>(e.what()); 641 } 642 643 if (r >= 0) 644 { 645 // bit7 identifies if the device is available 646 // 0=normal operation 647 // 1=device firmware, SDR update, 648 // or self-initialization in progress. 649 // The availability may change in run time, so mask here 650 // and initialize later. 651 devId.fw[0] = rev.major & ipmiDevIdFw1Mask; 652 653 rev.minor = (rev.minor > 99 ? 99 : rev.minor); 654 devId.fw[1] = rev.minor % 10 + (rev.minor / 10) * 16; 655 std::memcpy(&devId.aux, rev.aux, sizeof(rev.aux)); 656 haveBMCVersion = true; 657 } 658 } 659 #endif 660 if (!dev_id_initialized) 661 { 662 // IPMI Spec version 2.0 663 devId.ipmiVer = 2; 664 665 std::ifstream devIdFile(filename); 666 if (devIdFile.is_open()) 667 { 668 auto data = nlohmann::json::parse(devIdFile, nullptr, false); 669 if (!data.is_discarded()) 670 { 671 devId.id = data.value("id", 0); 672 devId.revision = data.value("revision", 0); 673 devId.addnDevSupport = data.value("addn_dev_support", 0); 674 devId.manufId = data.value("manuf_id", 0); 675 devId.prodId = data.value("prod_id", 0); 676 #ifdef GET_DBUS_ACTIVE_SOFTWARE 677 if (!(AUX_0_MATCH_INDEX || AUX_1_MATCH_INDEX || 678 AUX_2_MATCH_INDEX || AUX_3_MATCH_INDEX)) 679 #endif 680 { 681 devId.aux = data.value("aux", 0); 682 } 683 684 if (data.contains("firmware_revision")) 685 { 686 const auto& firmwareRevision = data.at("firmware_revision"); 687 if (firmwareRevision.contains("major")) 688 { 689 firmwareRevision.at("major").get_to(devId.fw[0]); 690 } 691 if (firmwareRevision.contains("minor")) 692 { 693 firmwareRevision.at("minor").get_to(devId.fw[1]); 694 } 695 } 696 697 // Set the availablitity of the BMC. 698 defaultActivationSetting = data.value("availability", true); 699 700 // Don't read the file every time if successful 701 dev_id_initialized = true; 702 } 703 else 704 { 705 log<level::ERR>("Device ID JSON parser failure"); 706 return ipmi::responseUnspecifiedError(); 707 } 708 } 709 else 710 { 711 log<level::ERR>("Device ID file not found"); 712 return ipmi::responseUnspecifiedError(); 713 } 714 } 715 716 // Set availability to the actual current BMC state 717 devId.fw[0] &= ipmiDevIdFw1Mask; 718 if (!getCurrentBmcStateWithFallback(defaultActivationSetting)) 719 { 720 devId.fw[0] |= (1 << ipmiDevIdStateShift); 721 } 722 723 return ipmi::responseSuccess( 724 devId.id, devId.revision, devId.fw[0], devId.fw[1], devId.ipmiVer, 725 devId.addnDevSupport, devId.manufId, devId.prodId, devId.aux); 726 } 727 728 auto ipmiAppGetSelfTestResults() -> ipmi::RspType<uint8_t, uint8_t> 729 { 730 // Byte 2: 731 // 55h - No error. 732 // 56h - Self Test function not implemented in this controller. 733 // 57h - Corrupted or inaccesssible data or devices. 734 // 58h - Fatal hardware error. 735 // FFh - reserved. 736 // all other: Device-specific 'internal failure'. 737 // Byte 3: 738 // For byte 2 = 55h, 56h, FFh: 00h 739 // For byte 2 = 58h, all other: Device-specific 740 // For byte 2 = 57h: self-test error bitfield. 741 // Note: returning 57h does not imply that all test were run. 742 // [7] 1b = Cannot access SEL device. 743 // [6] 1b = Cannot access SDR Repository. 744 // [5] 1b = Cannot access BMC FRU device. 745 // [4] 1b = IPMB signal lines do not respond. 746 // [3] 1b = SDR Repository empty. 747 // [2] 1b = Internal Use Area of BMC FRU corrupted. 748 // [1] 1b = controller update 'boot block' firmware corrupted. 749 // [0] 1b = controller operational firmware corrupted. 750 constexpr uint8_t notImplemented = 0x56; 751 constexpr uint8_t zero = 0; 752 return ipmi::responseSuccess(notImplemented, zero); 753 } 754 755 static constexpr size_t uuidBinaryLength = 16; 756 static std::array<uint8_t, uuidBinaryLength> rfc4122ToIpmi(std::string rfc4122) 757 { 758 using Argument = xyz::openbmc_project::Common::InvalidArgument; 759 // UUID is in RFC4122 format. Ex: 61a39523-78f2-11e5-9862-e6402cfc3223 760 // Per IPMI Spec 2.0 need to convert to 16 hex bytes and reverse the byte 761 // order 762 // Ex: 0x2332fc2c40e66298e511f2782395a361 763 constexpr size_t uuidHexLength = (2 * uuidBinaryLength); 764 constexpr size_t uuidRfc4122Length = (uuidHexLength + 4); 765 std::array<uint8_t, uuidBinaryLength> uuid; 766 if (rfc4122.size() == uuidRfc4122Length) 767 { 768 rfc4122.erase(std::remove(rfc4122.begin(), rfc4122.end(), '-'), 769 rfc4122.end()); 770 } 771 if (rfc4122.size() != uuidHexLength) 772 { 773 elog<InvalidArgument>(Argument::ARGUMENT_NAME("rfc4122"), 774 Argument::ARGUMENT_VALUE(rfc4122.c_str())); 775 } 776 for (size_t ind = 0; ind < uuidHexLength; ind += 2) 777 { 778 char v[3]; 779 v[0] = rfc4122[ind]; 780 v[1] = rfc4122[ind + 1]; 781 v[2] = 0; 782 size_t err; 783 long b; 784 try 785 { 786 b = std::stoul(v, &err, 16); 787 } 788 catch (const std::exception& e) 789 { 790 elog<InvalidArgument>(Argument::ARGUMENT_NAME("rfc4122"), 791 Argument::ARGUMENT_VALUE(rfc4122.c_str())); 792 } 793 // check that exactly two ascii bytes were converted 794 if (err != 2) 795 { 796 elog<InvalidArgument>(Argument::ARGUMENT_NAME("rfc4122"), 797 Argument::ARGUMENT_VALUE(rfc4122.c_str())); 798 } 799 uuid[uuidBinaryLength - (ind / 2) - 1] = static_cast<uint8_t>(b); 800 } 801 return uuid; 802 } 803 804 auto ipmiAppGetDeviceGuid() 805 -> ipmi::RspType<std::array<uint8_t, uuidBinaryLength>> 806 { 807 // return a fixed GUID based on /etc/machine-id 808 // This should match the /redfish/v1/Managers/bmc's UUID data 809 810 // machine specific application ID (for BMC ID) 811 // generated by systemd-id128 -p new as per man page 812 static constexpr sd_id128_t bmcUuidAppId = SD_ID128_MAKE( 813 e0, e1, 73, 76, 64, 61, 47, da, a5, 0c, d0, cc, 64, 12, 45, 78); 814 815 sd_id128_t bmcUuid; 816 // create the UUID from /etc/machine-id via the systemd API 817 sd_id128_get_machine_app_specific(bmcUuidAppId, &bmcUuid); 818 819 char bmcUuidCstr[SD_ID128_STRING_MAX]; 820 std::string systemUuid = sd_id128_to_string(bmcUuid, bmcUuidCstr); 821 822 std::array<uint8_t, uuidBinaryLength> uuid = rfc4122ToIpmi(systemUuid); 823 return ipmi::responseSuccess(uuid); 824 } 825 826 auto ipmiAppGetBtCapabilities() 827 -> ipmi::RspType<uint8_t, uint8_t, uint8_t, uint8_t, uint8_t> 828 { 829 // Per IPMI 2.0 spec, the input and output buffer size must be the max 830 // buffer size minus one byte to allocate space for the length byte. 831 constexpr uint8_t nrOutstanding = 0x01; 832 constexpr uint8_t inputBufferSize = MAX_IPMI_BUFFER - 1; 833 constexpr uint8_t outputBufferSize = MAX_IPMI_BUFFER - 1; 834 constexpr uint8_t transactionTime = 0x0A; 835 constexpr uint8_t nrRetries = 0x01; 836 837 return ipmi::responseSuccess(nrOutstanding, inputBufferSize, 838 outputBufferSize, transactionTime, nrRetries); 839 } 840 841 auto ipmiAppGetSystemGuid(ipmi::Context::ptr& ctx) 842 -> ipmi::RspType<std::array<uint8_t, 16>> 843 { 844 static constexpr auto uuidInterface = "xyz.openbmc_project.Common.UUID"; 845 static constexpr auto uuidProperty = "UUID"; 846 847 // Get the Inventory object implementing BMC interface 848 ipmi::DbusObjectInfo objectInfo{}; 849 boost::system::error_code ec = ipmi::getDbusObject(ctx, uuidInterface, 850 objectInfo); 851 if (ec.value()) 852 { 853 log<level::ERR>("Failed to locate System UUID object", 854 entry("INTERFACE=%s", uuidInterface), 855 entry("ERROR=%s", ec.message().c_str())); 856 return ipmi::responseUnspecifiedError(); 857 } 858 859 // Read UUID property value from bmcObject 860 // UUID is in RFC4122 format Ex: 61a39523-78f2-11e5-9862-e6402cfc3223 861 std::string rfc4122Uuid{}; 862 ec = ipmi::getDbusProperty(ctx, objectInfo.second, objectInfo.first, 863 uuidInterface, uuidProperty, rfc4122Uuid); 864 if (ec.value()) 865 { 866 log<level::ERR>("Failed in reading BMC UUID property", 867 entry("INTERFACE=%s", uuidInterface), 868 entry("PROPERTY=%s", uuidProperty), 869 entry("ERROR=%s", ec.message().c_str())); 870 return ipmi::responseUnspecifiedError(); 871 } 872 std::array<uint8_t, 16> uuid; 873 try 874 { 875 // convert to IPMI format 876 uuid = rfc4122ToIpmi(rfc4122Uuid); 877 } 878 catch (const InvalidArgument& e) 879 { 880 log<level::ERR>("Failed in parsing BMC UUID property", 881 entry("INTERFACE=%s", uuidInterface), 882 entry("PROPERTY=%s", uuidProperty), 883 entry("VALUE=%s", rfc4122Uuid.c_str())); 884 return ipmi::responseUnspecifiedError(); 885 } 886 return ipmi::responseSuccess(uuid); 887 } 888 889 /** 890 * @brief set the session state as teardown 891 * 892 * This function is to set the session state to tear down in progress if the 893 * state is active. 894 * 895 * @param[in] busp - Dbus obj 896 * @param[in] service - service name 897 * @param[in] obj - object path 898 * 899 * @return success completion code if it sets the session state to 900 * tearDownInProgress else return the corresponding error completion code. 901 **/ 902 uint8_t setSessionState(std::shared_ptr<sdbusplus::asio::connection>& busp, 903 const std::string& service, const std::string& obj) 904 { 905 try 906 { 907 uint8_t sessionState = std::get<uint8_t>(ipmi::getDbusProperty( 908 *busp, service, obj, session::sessionIntf, "State")); 909 910 if (sessionState == static_cast<uint8_t>(session::State::active)) 911 { 912 ipmi::setDbusProperty( 913 *busp, service, obj, session::sessionIntf, "State", 914 static_cast<uint8_t>(session::State::tearDownInProgress)); 915 return ipmi::ccSuccess; 916 } 917 } 918 catch (const std::exception& e) 919 { 920 log<level::ERR>("Failed in getting session state property", 921 entry("service=%s", service.c_str()), 922 entry("object path=%s", obj.c_str()), 923 entry("interface=%s", session::sessionIntf)); 924 return ipmi::ccUnspecifiedError; 925 } 926 927 return ipmi::ccInvalidFieldRequest; 928 } 929 930 ipmi::RspType<> ipmiAppCloseSession(uint32_t reqSessionId, 931 std::optional<uint8_t> requestSessionHandle) 932 { 933 auto busp = getSdBus(); 934 uint8_t reqSessionHandle = 935 requestSessionHandle.value_or(session::defaultSessionHandle); 936 937 if (reqSessionId == session::sessionZero && 938 reqSessionHandle == session::defaultSessionHandle) 939 { 940 return ipmi::response(session::ccInvalidSessionId); 941 } 942 943 if (reqSessionId == session::sessionZero && 944 reqSessionHandle == session::invalidSessionHandle) 945 { 946 return ipmi::response(session::ccInvalidSessionHandle); 947 } 948 949 if (reqSessionId != session::sessionZero && 950 reqSessionHandle != session::defaultSessionHandle) 951 { 952 return ipmi::response(ipmi::ccInvalidFieldRequest); 953 } 954 955 try 956 { 957 ipmi::ObjectTree objectTree = ipmi::getAllDbusObjects( 958 *busp, session::sessionManagerRootPath, session::sessionIntf); 959 960 for (auto& objectTreeItr : objectTree) 961 { 962 const std::string obj = objectTreeItr.first; 963 964 if (isSessionObjectMatched(obj, reqSessionId, reqSessionHandle)) 965 { 966 auto& serviceMap = objectTreeItr.second; 967 968 // Session id and session handle are unique for each session. 969 // Session id and handler are retrived from the object path and 970 // object path will be unique for each session. Checking if 971 // multiple objects exist with same object path under multiple 972 // services. 973 if (serviceMap.size() != 1) 974 { 975 return ipmi::responseUnspecifiedError(); 976 } 977 978 auto itr = serviceMap.begin(); 979 const std::string service = itr->first; 980 return ipmi::response(setSessionState(busp, service, obj)); 981 } 982 } 983 } 984 catch (const sdbusplus::exception_t& e) 985 { 986 log<level::ERR>("Failed to fetch object from dbus", 987 entry("INTERFACE=%s", session::sessionIntf), 988 entry("ERRMSG=%s", e.what())); 989 return ipmi::responseUnspecifiedError(); 990 } 991 992 return ipmi::responseInvalidFieldRequest(); 993 } 994 995 uint8_t getTotalSessionCount() 996 { 997 uint8_t count = 0, ch = 0; 998 999 while (ch < ipmi::maxIpmiChannels && 1000 count < session::maxNetworkInstanceSupported) 1001 { 1002 ipmi::ChannelInfo chInfo{}; 1003 ipmi::getChannelInfo(ch, chInfo); 1004 if (static_cast<ipmi::EChannelMediumType>(chInfo.mediumType) == 1005 ipmi::EChannelMediumType::lan8032) 1006 { 1007 count++; 1008 } 1009 ch++; 1010 } 1011 return count * session::maxSessionCountPerChannel; 1012 } 1013 1014 /** 1015 * @brief get session info request data. 1016 * 1017 * This function validates the request data and retrive request session id, 1018 * session handle. 1019 * 1020 * @param[in] ctx - context of current session. 1021 * @param[in] sessionIndex - request session index 1022 * @param[in] payload - input payload 1023 * @param[in] reqSessionId - unpacked session Id will be asigned 1024 * @param[in] reqSessionHandle - unpacked session handle will be asigned 1025 * 1026 * @return success completion code if request data is valid 1027 * else return the correcponding error completion code. 1028 **/ 1029 uint8_t getSessionInfoRequestData(const ipmi::Context::ptr ctx, 1030 const uint8_t sessionIndex, 1031 ipmi::message::Payload& payload, 1032 uint32_t& reqSessionId, 1033 uint8_t& reqSessionHandle) 1034 { 1035 if ((sessionIndex > session::maxSessionCountPerChannel) && 1036 (sessionIndex < session::searchSessionByHandle)) 1037 { 1038 return ipmi::ccInvalidFieldRequest; 1039 } 1040 1041 switch (sessionIndex) 1042 { 1043 case session::searchCurrentSession: 1044 1045 ipmi::ChannelInfo chInfo; 1046 ipmi::getChannelInfo(ctx->channel, chInfo); 1047 1048 if (static_cast<ipmi::EChannelMediumType>(chInfo.mediumType) != 1049 ipmi::EChannelMediumType::lan8032) 1050 { 1051 return ipmi::ccInvalidFieldRequest; 1052 } 1053 1054 if (!payload.fullyUnpacked()) 1055 { 1056 return ipmi::ccReqDataLenInvalid; 1057 } 1058 // Check if current sessionId is 0, sessionId 0 is reserved. 1059 if (ctx->sessionId == session::sessionZero) 1060 { 1061 return session::ccInvalidSessionId; 1062 } 1063 reqSessionId = ctx->sessionId; 1064 break; 1065 1066 case session::searchSessionByHandle: 1067 1068 if ((payload.unpack(reqSessionHandle)) || 1069 (!payload.fullyUnpacked())) 1070 { 1071 return ipmi::ccReqDataLenInvalid; 1072 } 1073 1074 if ((reqSessionHandle == session::sessionZero) || 1075 ((reqSessionHandle & session::multiIntfaceSessionHandleMask) > 1076 session::maxSessionCountPerChannel)) 1077 { 1078 return session::ccInvalidSessionHandle; 1079 } 1080 break; 1081 1082 case session::searchSessionById: 1083 1084 if ((payload.unpack(reqSessionId)) || (!payload.fullyUnpacked())) 1085 { 1086 return ipmi::ccReqDataLenInvalid; 1087 } 1088 1089 if (reqSessionId == session::sessionZero) 1090 { 1091 return session::ccInvalidSessionId; 1092 } 1093 break; 1094 1095 default: 1096 if (!payload.fullyUnpacked()) 1097 { 1098 return ipmi::ccReqDataLenInvalid; 1099 } 1100 break; 1101 } 1102 return ipmi::ccSuccess; 1103 } 1104 1105 uint8_t getSessionState(ipmi::Context::ptr ctx, const std::string& service, 1106 const std::string& objPath, uint8_t& sessionState) 1107 { 1108 boost::system::error_code ec = ipmi::getDbusProperty( 1109 ctx, service, objPath, session::sessionIntf, "State", sessionState); 1110 if (ec) 1111 { 1112 log<level::ERR>("Failed to fetch state property ", 1113 entry("SERVICE=%s", service.c_str()), 1114 entry("OBJECTPATH=%s", objPath.c_str()), 1115 entry("INTERFACE=%s", session::sessionIntf), 1116 entry("ERRMSG=%s", ec.message().c_str())); 1117 return ipmi::ccUnspecifiedError; 1118 } 1119 return ipmi::ccSuccess; 1120 } 1121 1122 static constexpr uint8_t macAddrLen = 6; 1123 /** Alias SessionDetails - contain the optional information about an 1124 * RMCP+ session. 1125 * 1126 * @param userID - uint6_t session user ID (0-63) 1127 * @param reserved - uint2_t reserved 1128 * @param privilege - uint4_t session privilege (0-5) 1129 * @param reserved - uint4_t reserved 1130 * @param channel - uint4_t session channel number 1131 * @param protocol - uint4_t session protocol 1132 * @param remoteIP - uint32_t remote IP address 1133 * @param macAddr - std::array<uint8_t, 6> mac address 1134 * @param port - uint16_t remote port 1135 */ 1136 using SessionDetails = 1137 std::tuple<uint2_t, uint6_t, uint4_t, uint4_t, uint4_t, uint4_t, uint32_t, 1138 std::array<uint8_t, macAddrLen>, uint16_t>; 1139 1140 /** @brief get session details for a given session 1141 * 1142 * @param[in] ctx - ipmi::Context pointer for accessing D-Bus 1143 * @param[in] service - D-Bus service name to fetch details from 1144 * @param[in] objPath - D-Bus object path for session 1145 * @param[out] sessionHandle - return session handle for session 1146 * @param[out] sessionState - return session state for session 1147 * @param[out] details - return a SessionDetails tuple containing other 1148 * session info 1149 * @return - ipmi::Cc success or error code 1150 */ 1151 ipmi::Cc getSessionDetails(ipmi::Context::ptr ctx, const std::string& service, 1152 const std::string& objPath, uint8_t& sessionHandle, 1153 uint8_t& sessionState, SessionDetails& details) 1154 { 1155 ipmi::PropertyMap sessionProps; 1156 boost::system::error_code ec = ipmi::getAllDbusProperties( 1157 ctx, service, objPath, session::sessionIntf, sessionProps); 1158 1159 if (ec) 1160 { 1161 log<level::ERR>("Failed to fetch state property ", 1162 entry("SERVICE=%s", service.c_str()), 1163 entry("OBJECTPATH=%s", objPath.c_str()), 1164 entry("INTERFACE=%s", session::sessionIntf), 1165 entry("ERRMSG=%s", ec.message().c_str())); 1166 return ipmi::ccUnspecifiedError; 1167 } 1168 1169 sessionState = ipmi::mappedVariant<uint8_t>( 1170 sessionProps, "State", static_cast<uint8_t>(session::State::inactive)); 1171 if (sessionState == static_cast<uint8_t>(session::State::active)) 1172 { 1173 sessionHandle = ipmi::mappedVariant<uint8_t>(sessionProps, 1174 "SessionHandle", 0); 1175 std::get<0>(details) = ipmi::mappedVariant<uint8_t>(sessionProps, 1176 "UserID", 0xff); 1177 // std::get<1>(details) = 0; // (default constructed to 0) 1178 std::get<2>(details) = 1179 ipmi::mappedVariant<uint8_t>(sessionProps, "CurrentPrivilege", 0); 1180 // std::get<3>(details) = 0; // (default constructed to 0) 1181 std::get<4>(details) = ipmi::mappedVariant<uint8_t>(sessionProps, 1182 "ChannelNum", 0xff); 1183 constexpr uint4_t rmcpPlusProtocol = 1; 1184 std::get<5>(details) = rmcpPlusProtocol; 1185 std::get<6>(details) = ipmi::mappedVariant<uint32_t>(sessionProps, 1186 "RemoteIPAddr", 0); 1187 // std::get<7>(details) = {{0}}; // default constructed to all 0 1188 std::get<8>(details) = ipmi::mappedVariant<uint16_t>(sessionProps, 1189 "RemotePort", 0); 1190 } 1191 1192 return ipmi::ccSuccess; 1193 } 1194 1195 ipmi::RspType<uint8_t, // session handle, 1196 uint8_t, // total session count 1197 uint8_t, // active session count 1198 std::optional<SessionDetails>> 1199 ipmiAppGetSessionInfo(ipmi::Context::ptr ctx, uint8_t sessionIndex, 1200 ipmi::message::Payload& payload) 1201 { 1202 uint32_t reqSessionId = 0; 1203 uint8_t reqSessionHandle = session::defaultSessionHandle; 1204 // initializing state to 0xff as 0 represents state as inactive. 1205 uint8_t state = 0xFF; 1206 1207 uint8_t completionCode = getSessionInfoRequestData( 1208 ctx, sessionIndex, payload, reqSessionId, reqSessionHandle); 1209 1210 if (completionCode) 1211 { 1212 return ipmi::response(completionCode); 1213 } 1214 ipmi::ObjectTree objectTree; 1215 boost::system::error_code ec = ipmi::getAllDbusObjects( 1216 ctx, session::sessionManagerRootPath, session::sessionIntf, objectTree); 1217 if (ec) 1218 { 1219 log<level::ERR>("Failed to fetch object from dbus", 1220 entry("INTERFACE=%s", session::sessionIntf), 1221 entry("ERRMSG=%s", ec.message().c_str())); 1222 return ipmi::responseUnspecifiedError(); 1223 } 1224 1225 uint8_t totalSessionCount = getTotalSessionCount(); 1226 uint8_t activeSessionCount = 0; 1227 uint8_t sessionHandle = session::defaultSessionHandle; 1228 uint8_t activeSessionHandle = 0; 1229 std::optional<SessionDetails> maybeDetails; 1230 uint8_t index = 0; 1231 for (auto& objectTreeItr : objectTree) 1232 { 1233 uint32_t sessionId = 0; 1234 std::string objectPath = objectTreeItr.first; 1235 1236 if (!parseCloseSessionInputPayload(objectPath, sessionId, 1237 sessionHandle)) 1238 { 1239 continue; 1240 } 1241 index++; 1242 auto& serviceMap = objectTreeItr.second; 1243 auto itr = serviceMap.begin(); 1244 1245 if (serviceMap.size() != 1) 1246 { 1247 return ipmi::responseUnspecifiedError(); 1248 } 1249 1250 std::string service = itr->first; 1251 uint8_t sessionState = 0; 1252 completionCode = getSessionState(ctx, service, objectPath, 1253 sessionState); 1254 if (completionCode) 1255 { 1256 return ipmi::response(completionCode); 1257 } 1258 1259 if (sessionState == static_cast<uint8_t>(session::State::active)) 1260 { 1261 activeSessionCount++; 1262 } 1263 1264 if (index == sessionIndex || reqSessionId == sessionId || 1265 reqSessionHandle == sessionHandle) 1266 { 1267 SessionDetails details{}; 1268 completionCode = getSessionDetails(ctx, service, objectPath, 1269 sessionHandle, state, details); 1270 1271 if (completionCode) 1272 { 1273 return ipmi::response(completionCode); 1274 } 1275 activeSessionHandle = sessionHandle; 1276 maybeDetails = std::move(details); 1277 } 1278 } 1279 1280 if (state == static_cast<uint8_t>(session::State::active) || 1281 state == static_cast<uint8_t>(session::State::tearDownInProgress)) 1282 { 1283 return ipmi::responseSuccess(activeSessionHandle, totalSessionCount, 1284 activeSessionCount, maybeDetails); 1285 } 1286 1287 return ipmi::responseInvalidFieldRequest(); 1288 } 1289 1290 static std::unique_ptr<SysInfoParamStore> sysInfoParamStore; 1291 1292 static std::string sysInfoReadSystemName() 1293 { 1294 // Use the BMC hostname as the "System Name." 1295 char hostname[HOST_NAME_MAX + 1] = {}; 1296 if (gethostname(hostname, HOST_NAME_MAX) != 0) 1297 { 1298 perror("System info parameter: system name"); 1299 } 1300 return hostname; 1301 } 1302 1303 static constexpr uint8_t paramRevision = 0x11; 1304 static constexpr size_t configParameterLength = 16; 1305 1306 static constexpr size_t smallChunkSize = 14; 1307 static constexpr size_t fullChunkSize = 16; 1308 static constexpr uint8_t progressMask = 0x3; 1309 1310 static constexpr uint8_t setComplete = 0x0; 1311 static constexpr uint8_t setInProgress = 0x1; 1312 static constexpr uint8_t commitWrite = 0x2; 1313 static uint8_t transferStatus = setComplete; 1314 1315 static constexpr uint8_t configDataOverhead = 2; 1316 1317 // For EFI based system, 256 bytes is recommended. 1318 static constexpr size_t maxBytesPerParameter = 256; 1319 1320 namespace ipmi 1321 { 1322 constexpr Cc ccParmNotSupported = 0x80; 1323 constexpr Cc ccSetInProgressActive = 0x81; 1324 constexpr Cc ccSystemInfoParameterSetReadOnly = 0x82; 1325 1326 static inline auto responseParmNotSupported() 1327 { 1328 return response(ccParmNotSupported); 1329 } 1330 static inline auto responseSetInProgressActive() 1331 { 1332 return response(ccSetInProgressActive); 1333 } 1334 static inline auto responseSystemInfoParameterSetReadOnly() 1335 { 1336 return response(ccSystemInfoParameterSetReadOnly); 1337 } 1338 } // namespace ipmi 1339 1340 ipmi::RspType<uint8_t, // Parameter revision 1341 std::optional<uint8_t>, // data1 / setSelector / ProgressStatus 1342 std::optional<std::vector<uint8_t>>> // data2-17 1343 ipmiAppGetSystemInfo(uint7_t reserved, bool getRevision, 1344 uint8_t paramSelector, uint8_t setSelector, 1345 uint8_t BlockSelector) 1346 { 1347 if (reserved || (paramSelector >= invalidParamSelectorStart && 1348 paramSelector <= invalidParamSelectorEnd)) 1349 { 1350 return ipmi::responseInvalidFieldRequest(); 1351 } 1352 if ((paramSelector >= oemCmdStart) && (paramSelector <= oemCmdEnd)) 1353 { 1354 return ipmi::responseParmNotSupported(); 1355 } 1356 if (getRevision) 1357 { 1358 return ipmi::responseSuccess(paramRevision, std::nullopt, std::nullopt); 1359 } 1360 1361 if (paramSelector == 0) 1362 { 1363 return ipmi::responseSuccess(paramRevision, transferStatus, 1364 std::nullopt); 1365 } 1366 1367 if (BlockSelector != 0) // 00h if parameter does not require a block number 1368 { 1369 return ipmi::responseParmNotSupported(); 1370 } 1371 1372 if (sysInfoParamStore == nullptr) 1373 { 1374 sysInfoParamStore = std::make_unique<SysInfoParamStore>(); 1375 sysInfoParamStore->update(IPMI_SYSINFO_SYSTEM_NAME, 1376 sysInfoReadSystemName); 1377 } 1378 1379 // Parameters other than Set In Progress are assumed to be strings. 1380 std::tuple<bool, std::string> ret = 1381 sysInfoParamStore->lookup(paramSelector); 1382 bool found = std::get<0>(ret); 1383 if (!found) 1384 { 1385 return ipmi::responseSensorInvalid(); 1386 } 1387 std::string& paramString = std::get<1>(ret); 1388 std::vector<uint8_t> configData; 1389 size_t count = 0; 1390 if (setSelector == 0) 1391 { // First chunk has only 14 bytes. 1392 configData.emplace_back(0); // encoding 1393 configData.emplace_back(paramString.length()); // string length 1394 count = std::min(paramString.length(), smallChunkSize); 1395 configData.resize(count + configDataOverhead); 1396 std::copy_n(paramString.begin(), count, 1397 configData.begin() + configDataOverhead); // 14 bytes chunk 1398 1399 // Append zero's to remaining bytes 1400 if (configData.size() < configParameterLength) 1401 { 1402 std::fill_n(std::back_inserter(configData), 1403 configParameterLength - configData.size(), 0x00); 1404 } 1405 } 1406 else 1407 { 1408 size_t offset = (setSelector * fullChunkSize) - configDataOverhead; 1409 if (offset >= paramString.length()) 1410 { 1411 return ipmi::responseParmOutOfRange(); 1412 } 1413 count = std::min(paramString.length() - offset, fullChunkSize); 1414 configData.resize(count); 1415 std::copy_n(paramString.begin() + offset, count, 1416 configData.begin()); // 16 bytes chunk 1417 } 1418 return ipmi::responseSuccess(paramRevision, setSelector, configData); 1419 } 1420 1421 ipmi::RspType<> ipmiAppSetSystemInfo(uint8_t paramSelector, uint8_t data1, 1422 std::vector<uint8_t> configData) 1423 { 1424 if (paramSelector >= invalidParamSelectorStart && 1425 paramSelector <= invalidParamSelectorEnd) 1426 { 1427 return ipmi::responseInvalidFieldRequest(); 1428 } 1429 if ((paramSelector >= oemCmdStart) && (paramSelector <= oemCmdEnd)) 1430 { 1431 return ipmi::responseParmNotSupported(); 1432 } 1433 1434 if (paramSelector == 0) 1435 { 1436 // attempt to set the 'set in progress' value (in parameter #0) 1437 // when not in the set complete state. 1438 if ((transferStatus != setComplete) && (data1 == setInProgress)) 1439 { 1440 return ipmi::responseSetInProgressActive(); 1441 } 1442 // only following 2 states are supported 1443 if (data1 > setInProgress) 1444 { 1445 phosphor::logging::log<phosphor::logging::level::ERR>( 1446 "illegal SetInProgress status"); 1447 return ipmi::responseInvalidFieldRequest(); 1448 } 1449 1450 transferStatus = data1 & progressMask; 1451 return ipmi::responseSuccess(); 1452 } 1453 1454 if (configData.size() > configParameterLength) 1455 { 1456 return ipmi::responseInvalidFieldRequest(); 1457 } 1458 1459 // Append zero's to remaining bytes 1460 if (configData.size() < configParameterLength) 1461 { 1462 fill_n(back_inserter(configData), 1463 (configParameterLength - configData.size()), 0x00); 1464 } 1465 1466 if (!sysInfoParamStore) 1467 { 1468 sysInfoParamStore = std::make_unique<SysInfoParamStore>(); 1469 sysInfoParamStore->update(IPMI_SYSINFO_SYSTEM_NAME, 1470 sysInfoReadSystemName); 1471 } 1472 1473 // lookup 1474 std::tuple<bool, std::string> ret = 1475 sysInfoParamStore->lookup(paramSelector); 1476 bool found = std::get<0>(ret); 1477 std::string& paramString = std::get<1>(ret); 1478 if (!found) 1479 { 1480 // parameter does not exist. Init new 1481 paramString = ""; 1482 } 1483 1484 uint8_t setSelector = data1; 1485 size_t count = 0; 1486 if (setSelector == 0) // First chunk has only 14 bytes. 1487 { 1488 size_t stringLen = configData.at(1); // string length 1489 // maxBytesPerParamter is 256. It will always be greater than stringLen 1490 // (unit8_t) if maxBytes changes in future, then following line is 1491 // needed. 1492 // stringLen = std::min(stringLen, maxBytesPerParameter); 1493 count = std::min(stringLen, smallChunkSize); 1494 count = std::min(count, configData.size()); 1495 paramString.resize(stringLen); // reserve space 1496 std::copy_n(configData.begin() + configDataOverhead, count, 1497 paramString.begin()); 1498 } 1499 else 1500 { 1501 size_t offset = (setSelector * fullChunkSize) - configDataOverhead; 1502 if (offset >= paramString.length()) 1503 { 1504 return ipmi::responseParmOutOfRange(); 1505 } 1506 count = std::min(paramString.length() - offset, configData.size()); 1507 std::copy_n(configData.begin(), count, paramString.begin() + offset); 1508 } 1509 sysInfoParamStore->update(paramSelector, paramString); 1510 return ipmi::responseSuccess(); 1511 } 1512 1513 #ifdef ENABLE_I2C_WHITELIST_CHECK 1514 inline std::vector<uint8_t> convertStringToData(const std::string& command) 1515 { 1516 std::istringstream iss(command); 1517 std::string token; 1518 std::vector<uint8_t> dataValue; 1519 while (std::getline(iss, token, ' ')) 1520 { 1521 dataValue.emplace_back( 1522 static_cast<uint8_t>(std::stoul(token, nullptr, base_16))); 1523 } 1524 return dataValue; 1525 } 1526 1527 static bool populateI2CMasterWRWhitelist() 1528 { 1529 nlohmann::json data = nullptr; 1530 std::ifstream jsonFile(i2cMasterWRWhitelistFile); 1531 1532 if (!jsonFile.good()) 1533 { 1534 log<level::WARNING>("i2c white list file not found!", 1535 entry("FILE_NAME: %s", i2cMasterWRWhitelistFile)); 1536 return false; 1537 } 1538 1539 try 1540 { 1541 data = nlohmann::json::parse(jsonFile, nullptr, false); 1542 } 1543 catch (const nlohmann::json::parse_error& e) 1544 { 1545 log<level::ERR>("Corrupted i2c white list config file", 1546 entry("FILE_NAME: %s", i2cMasterWRWhitelistFile), 1547 entry("MSG: %s", e.what())); 1548 return false; 1549 } 1550 1551 try 1552 { 1553 // Example JSON Structure format 1554 // "filters": [ 1555 // { 1556 // "Description": "Allow full read - ignore first byte write value 1557 // for 0x40 to 0x4F", 1558 // "busId": "0x01", 1559 // "slaveAddr": "0x40", 1560 // "slaveAddrMask": "0x0F", 1561 // "command": "0x00", 1562 // "commandMask": "0xFF" 1563 // }, 1564 // { 1565 // "Description": "Allow full read - first byte match 0x05 and 1566 // ignore second byte", 1567 // "busId": "0x01", 1568 // "slaveAddr": "0x57", 1569 // "slaveAddrMask": "0x00", 1570 // "command": "0x05 0x00", 1571 // "commandMask": "0x00 0xFF" 1572 // },] 1573 1574 nlohmann::json filters = data[filtersStr].get<nlohmann::json>(); 1575 std::vector<i2cMasterWRWhitelist>& whitelist = getWRWhitelist(); 1576 for (const auto& it : filters.items()) 1577 { 1578 nlohmann::json filter = it.value(); 1579 if (filter.is_null()) 1580 { 1581 log<level::ERR>( 1582 "Corrupted I2C master write read whitelist config file", 1583 entry("FILE_NAME: %s", i2cMasterWRWhitelistFile)); 1584 return false; 1585 } 1586 const std::vector<uint8_t>& writeData = 1587 convertStringToData(filter[cmdStr].get<std::string>()); 1588 const std::vector<uint8_t>& writeDataMask = 1589 convertStringToData(filter[cmdMaskStr].get<std::string>()); 1590 if (writeDataMask.size() != writeData.size()) 1591 { 1592 log<level::ERR>("I2C master write read whitelist filter " 1593 "mismatch for command & mask size"); 1594 return false; 1595 } 1596 whitelist.push_back( 1597 {static_cast<uint8_t>(std::stoul( 1598 filter[busIdStr].get<std::string>(), nullptr, base_16)), 1599 static_cast<uint8_t>( 1600 std::stoul(filter[slaveAddrStr].get<std::string>(), 1601 nullptr, base_16)), 1602 static_cast<uint8_t>( 1603 std::stoul(filter[slaveAddrMaskStr].get<std::string>(), 1604 nullptr, base_16)), 1605 writeData, writeDataMask}); 1606 } 1607 if (whitelist.size() != filters.size()) 1608 { 1609 log<level::ERR>( 1610 "I2C master write read whitelist filter size mismatch"); 1611 return false; 1612 } 1613 } 1614 catch (const std::exception& e) 1615 { 1616 log<level::ERR>("I2C master write read whitelist unexpected exception", 1617 entry("ERROR=%s", e.what())); 1618 return false; 1619 } 1620 return true; 1621 } 1622 1623 static inline bool isWriteDataWhitelisted(const std::vector<uint8_t>& data, 1624 const std::vector<uint8_t>& dataMask, 1625 const std::vector<uint8_t>& writeData) 1626 { 1627 std::vector<uint8_t> processedDataBuf(data.size()); 1628 std::vector<uint8_t> processedReqBuf(dataMask.size()); 1629 std::transform(writeData.begin(), writeData.end(), dataMask.begin(), 1630 processedReqBuf.begin(), std::bit_or<uint8_t>()); 1631 std::transform(data.begin(), data.end(), dataMask.begin(), 1632 processedDataBuf.begin(), std::bit_or<uint8_t>()); 1633 1634 return (processedDataBuf == processedReqBuf); 1635 } 1636 1637 static bool isCmdWhitelisted(uint8_t busId, uint8_t slaveAddr, 1638 std::vector<uint8_t>& writeData) 1639 { 1640 std::vector<i2cMasterWRWhitelist>& whiteList = getWRWhitelist(); 1641 for (const auto& wlEntry : whiteList) 1642 { 1643 if ((busId == wlEntry.busId) && 1644 ((slaveAddr | wlEntry.slaveAddrMask) == 1645 (wlEntry.slaveAddr | wlEntry.slaveAddrMask))) 1646 { 1647 const std::vector<uint8_t>& dataMask = wlEntry.dataMask; 1648 // Skip as no-match, if requested write data is more than the 1649 // write data mask size 1650 if (writeData.size() > dataMask.size()) 1651 { 1652 continue; 1653 } 1654 if (isWriteDataWhitelisted(wlEntry.data, dataMask, writeData)) 1655 { 1656 return true; 1657 } 1658 } 1659 } 1660 return false; 1661 } 1662 #else 1663 static bool populateI2CMasterWRWhitelist() 1664 { 1665 log<level::INFO>( 1666 "I2C_WHITELIST_CHECK is disabled, do not populate whitelist"); 1667 return true; 1668 } 1669 #endif // ENABLE_I2C_WHITELIST_CHECK 1670 1671 /** @brief implements master write read IPMI command which can be used for 1672 * low-level I2C/SMBus write, read or write-read access 1673 * @param isPrivateBus -to indicate private bus usage 1674 * @param busId - bus id 1675 * @param channelNum - channel number 1676 * @param reserved - skip 1 bit 1677 * @param slaveAddr - slave address 1678 * @param read count - number of bytes to be read 1679 * @param writeData - data to be written 1680 * 1681 * @returns IPMI completion code plus response data 1682 * - readData - i2c response data 1683 */ 1684 ipmi::RspType<std::vector<uint8_t>> 1685 ipmiMasterWriteRead([[maybe_unused]] bool isPrivateBus, uint3_t busId, 1686 [[maybe_unused]] uint4_t channelNum, bool reserved, 1687 uint7_t slaveAddr, uint8_t readCount, 1688 std::vector<uint8_t> writeData) 1689 { 1690 if (reserved) 1691 { 1692 return ipmi::responseInvalidFieldRequest(); 1693 } 1694 if (readCount > maxIPMIWriteReadSize) 1695 { 1696 log<level::ERR>("Master write read command: Read count exceeds limit"); 1697 return ipmi::responseParmOutOfRange(); 1698 } 1699 const size_t writeCount = writeData.size(); 1700 if (!readCount && !writeCount) 1701 { 1702 log<level::ERR>("Master write read command: Read & write count are 0"); 1703 return ipmi::responseInvalidFieldRequest(); 1704 } 1705 #ifdef ENABLE_I2C_WHITELIST_CHECK 1706 if (!isCmdWhitelisted(static_cast<uint8_t>(busId), 1707 static_cast<uint8_t>(slaveAddr), writeData)) 1708 { 1709 log<level::ERR>("Master write read request blocked!", 1710 entry("BUS=%d", static_cast<uint8_t>(busId)), 1711 entry("ADDR=0x%x", static_cast<uint8_t>(slaveAddr))); 1712 return ipmi::responseInvalidFieldRequest(); 1713 } 1714 #endif // ENABLE_I2C_WHITELIST_CHECK 1715 std::vector<uint8_t> readBuf(readCount); 1716 std::string i2cBus = "/dev/i2c-" + 1717 std::to_string(static_cast<uint8_t>(busId)); 1718 1719 ipmi::Cc ret = ipmi::i2cWriteRead(i2cBus, static_cast<uint8_t>(slaveAddr), 1720 writeData, readBuf); 1721 if (ret != ipmi::ccSuccess) 1722 { 1723 return ipmi::response(ret); 1724 } 1725 return ipmi::responseSuccess(readBuf); 1726 } 1727 1728 void register_netfn_app_functions() 1729 { 1730 // <Get Device ID> 1731 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1732 ipmi::app::cmdGetDeviceId, ipmi::Privilege::User, 1733 ipmiAppGetDeviceId); 1734 1735 // <Get BT Interface Capabilities> 1736 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1737 ipmi::app::cmdGetBtIfaceCapabilities, 1738 ipmi::Privilege::User, ipmiAppGetBtCapabilities); 1739 1740 // <Reset Watchdog Timer> 1741 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1742 ipmi::app::cmdResetWatchdogTimer, 1743 ipmi::Privilege::Operator, ipmiAppResetWatchdogTimer); 1744 1745 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1746 ipmi::app::cmdGetSessionInfo, ipmi::Privilege::User, 1747 ipmiAppGetSessionInfo); 1748 1749 // <Set Watchdog Timer> 1750 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1751 ipmi::app::cmdSetWatchdogTimer, 1752 ipmi::Privilege::Operator, ipmiSetWatchdogTimer); 1753 1754 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1755 ipmi::app::cmdCloseSession, ipmi::Privilege::Callback, 1756 ipmiAppCloseSession); 1757 1758 // <Get Watchdog Timer> 1759 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1760 ipmi::app::cmdGetWatchdogTimer, ipmi::Privilege::User, 1761 ipmiGetWatchdogTimer); 1762 1763 // <Get Self Test Results> 1764 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1765 ipmi::app::cmdGetSelfTestResults, 1766 ipmi::Privilege::User, ipmiAppGetSelfTestResults); 1767 1768 // <Get Device GUID> 1769 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1770 ipmi::app::cmdGetDeviceGuid, ipmi::Privilege::User, 1771 ipmiAppGetDeviceGuid); 1772 1773 // <Set ACPI Power State> 1774 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1775 ipmi::app::cmdSetAcpiPowerState, 1776 ipmi::Privilege::Admin, ipmiSetAcpiPowerState); 1777 // <Get ACPI Power State> 1778 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1779 ipmi::app::cmdGetAcpiPowerState, 1780 ipmi::Privilege::User, ipmiGetAcpiPowerState); 1781 1782 // Note: For security reason, this command will be registered only when 1783 // there are proper I2C Master write read whitelist 1784 if (populateI2CMasterWRWhitelist()) 1785 { 1786 // Note: For security reasons, registering master write read as admin 1787 // privilege command, even though IPMI 2.0 specification allows it as 1788 // operator privilege. 1789 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1790 ipmi::app::cmdMasterWriteRead, 1791 ipmi::Privilege::Admin, ipmiMasterWriteRead); 1792 } 1793 1794 // <Get System GUID Command> 1795 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1796 ipmi::app::cmdGetSystemGuid, ipmi::Privilege::User, 1797 ipmiAppGetSystemGuid); 1798 1799 // <Get Channel Cipher Suites Command> 1800 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1801 ipmi::app::cmdGetChannelCipherSuites, 1802 ipmi::Privilege::None, getChannelCipherSuites); 1803 1804 // <Get System Info Command> 1805 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1806 ipmi::app::cmdGetSystemInfoParameters, 1807 ipmi::Privilege::User, ipmiAppGetSystemInfo); 1808 // <Set System Info Command> 1809 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1810 ipmi::app::cmdSetSystemInfoParameters, 1811 ipmi::Privilege::Admin, ipmiAppSetSystemInfo); 1812 return; 1813 } 1814