1 /* 2 // Copyright (c) 2018 Intel Corporation 3 // 4 // Licensed under the Apache License, Version 2.0 (the "License"); 5 // you may not use this file except in compliance with the License. 6 // You may obtain a copy of the License at 7 // 8 // http://www.apache.org/licenses/LICENSE-2.0 9 // 10 // Unless required by applicable law or agreed to in writing, software 11 // distributed under the License is distributed on an "AS IS" BASIS, 12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 // See the License for the specific language governing permissions and 14 // limitations under the License. 15 */ 16 #pragma once 17 18 #include <boost/container/flat_map.hpp> 19 #include <boost/container/flat_set.hpp> 20 #include <dbus_singleton.hpp> 21 #include <error_messages.hpp> 22 #include <node.hpp> 23 #include <optional> 24 #include <utils/json_utils.hpp> 25 #include <variant> 26 27 namespace redfish 28 { 29 30 /** 31 * DBus types primitives for several generic DBus interfaces 32 * TODO(Pawel) consider move this to separate file into boost::dbus 33 */ 34 using PropertiesMapType = boost::container::flat_map< 35 std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t, 36 int32_t, uint32_t, int64_t, uint64_t, double>>; 37 38 using GetManagedObjects = std::vector<std::pair< 39 sdbusplus::message::object_path, 40 std::vector<std::pair< 41 std::string, 42 boost::container::flat_map< 43 std::string, sdbusplus::message::variant< 44 std::string, bool, uint8_t, int16_t, uint16_t, 45 int32_t, uint32_t, int64_t, uint64_t, double, 46 std::vector<std::string>>>>>>>; 47 48 enum class LinkType 49 { 50 Local, 51 Global 52 }; 53 54 /** 55 * Structure for keeping IPv4 data required by Redfish 56 */ 57 struct IPv4AddressData 58 { 59 std::string id; 60 std::string address; 61 std::string domain; 62 std::string gateway; 63 std::string netmask; 64 std::string origin; 65 LinkType linktype; 66 67 bool operator<(const IPv4AddressData &obj) const 68 { 69 return id < obj.id; 70 } 71 }; 72 73 /** 74 * Structure for keeping basic single Ethernet Interface information 75 * available from DBus 76 */ 77 struct EthernetInterfaceData 78 { 79 uint32_t speed; 80 bool auto_neg; 81 std::string hostname; 82 std::string default_gateway; 83 std::string mac_address; 84 std::optional<uint32_t> vlan_id; 85 std::vector<std::string> nameservers; 86 }; 87 88 // Helper function that changes bits netmask notation (i.e. /24) 89 // into full dot notation 90 inline std::string getNetmask(unsigned int bits) 91 { 92 uint32_t value = 0xffffffff << (32 - bits); 93 std::string netmask = std::to_string((value >> 24) & 0xff) + "." + 94 std::to_string((value >> 16) & 0xff) + "." + 95 std::to_string((value >> 8) & 0xff) + "." + 96 std::to_string(value & 0xff); 97 return netmask; 98 } 99 100 inline std::string 101 translateAddressOriginDbusToRedfish(const std::string &inputOrigin, 102 bool isIPv4) 103 { 104 if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.Static") 105 { 106 return "Static"; 107 } 108 if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.LinkLocal") 109 { 110 if (isIPv4) 111 { 112 return "IPv4LinkLocal"; 113 } 114 else 115 { 116 return "LinkLocal"; 117 } 118 } 119 if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.DHCP") 120 { 121 if (isIPv4) 122 { 123 return "DHCP"; 124 } 125 else 126 { 127 return "DHCPv6"; 128 } 129 } 130 if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.SLAAC") 131 { 132 return "SLAAC"; 133 } 134 return ""; 135 } 136 137 inline std::string 138 translateAddressOriginRedfishToDbus(const std::string &inputOrigin) 139 { 140 if (inputOrigin == "Static") 141 { 142 return "xyz.openbmc_project.Network.IP.AddressOrigin.Static"; 143 } 144 if (inputOrigin == "DHCP" || inputOrigin == "DHCPv6") 145 { 146 return "xyz.openbmc_project.Network.IP.AddressOrigin.DHCP"; 147 } 148 if (inputOrigin == "IPv4LinkLocal" || inputOrigin == "LinkLocal") 149 { 150 return "xyz.openbmc_project.Network.IP.AddressOrigin.LinkLocal"; 151 } 152 if (inputOrigin == "SLAAC") 153 { 154 return "xyz.openbmc_project.Network.IP.AddressOrigin.SLAAC"; 155 } 156 return ""; 157 } 158 159 inline void extractEthernetInterfaceData(const std::string ðiface_id, 160 const GetManagedObjects &dbus_data, 161 EthernetInterfaceData ðData) 162 { 163 for (const auto &objpath : dbus_data) 164 { 165 for (const auto &ifacePair : objpath.second) 166 { 167 if (objpath.first == "/xyz/openbmc_project/network/" + ethiface_id) 168 { 169 if (ifacePair.first == "xyz.openbmc_project.Network.MACAddress") 170 { 171 for (const auto &propertyPair : ifacePair.second) 172 { 173 if (propertyPair.first == "MACAddress") 174 { 175 const std::string *mac = 176 std::get_if<std::string>(&propertyPair.second); 177 if (mac != nullptr) 178 { 179 ethData.mac_address = *mac; 180 } 181 } 182 } 183 } 184 else if (ifacePair.first == "xyz.openbmc_project.Network.VLAN") 185 { 186 for (const auto &propertyPair : ifacePair.second) 187 { 188 if (propertyPair.first == "Id") 189 { 190 const uint32_t *id = 191 std::get_if<uint32_t>(&propertyPair.second); 192 if (id != nullptr) 193 { 194 ethData.vlan_id = *id; 195 } 196 } 197 } 198 } 199 else if (ifacePair.first == 200 "xyz.openbmc_project.Network.EthernetInterface") 201 { 202 for (const auto &propertyPair : ifacePair.second) 203 { 204 if (propertyPair.first == "AutoNeg") 205 { 206 const bool *auto_neg = 207 std::get_if<bool>(&propertyPair.second); 208 if (auto_neg != nullptr) 209 { 210 ethData.auto_neg = *auto_neg; 211 } 212 } 213 else if (propertyPair.first == "Speed") 214 { 215 const uint32_t *speed = 216 std::get_if<uint32_t>(&propertyPair.second); 217 if (speed != nullptr) 218 { 219 ethData.speed = *speed; 220 } 221 } 222 else if (propertyPair.first == "NameServers") 223 { 224 const std::vector<std::string> *nameservers = 225 sdbusplus::message::variant_ns::get_if< 226 std::vector<std::string>>( 227 &propertyPair.second); 228 if (nameservers != nullptr) 229 { 230 ethData.nameservers = std::move(*nameservers); 231 } 232 } 233 } 234 } 235 } 236 // System configuration shows up in the global namespace, so no need 237 // to check eth number 238 if (ifacePair.first == 239 "xyz.openbmc_project.Network.SystemConfiguration") 240 { 241 for (const auto &propertyPair : ifacePair.second) 242 { 243 if (propertyPair.first == "HostName") 244 { 245 const std::string *hostname = 246 sdbusplus::message::variant_ns::get_if<std::string>( 247 &propertyPair.second); 248 if (hostname != nullptr) 249 { 250 ethData.hostname = *hostname; 251 } 252 } 253 else if (propertyPair.first == "DefaultGateway") 254 { 255 const std::string *defaultGateway = 256 sdbusplus::message::variant_ns::get_if<std::string>( 257 &propertyPair.second); 258 if (defaultGateway != nullptr) 259 { 260 ethData.default_gateway = *defaultGateway; 261 } 262 } 263 } 264 } 265 } 266 } 267 } 268 269 // Helper function that extracts data for single ethernet ipv4 address 270 inline void 271 extractIPData(const std::string ðiface_id, 272 const GetManagedObjects &dbus_data, 273 boost::container::flat_set<IPv4AddressData> &ipv4_config) 274 { 275 const std::string ipv4PathStart = 276 "/xyz/openbmc_project/network/" + ethiface_id + "/ipv4/"; 277 278 // Since there might be several IPv4 configurations aligned with 279 // single ethernet interface, loop over all of them 280 for (const auto &objpath : dbus_data) 281 { 282 // Check if proper pattern for object path appears 283 if (boost::starts_with(objpath.first.str, ipv4PathStart)) 284 { 285 for (auto &interface : objpath.second) 286 { 287 if (interface.first == "xyz.openbmc_project.Network.IP") 288 { 289 // Instance IPv4AddressData structure, and set as 290 // appropriate 291 std::pair< 292 boost::container::flat_set<IPv4AddressData>::iterator, 293 bool> 294 it = ipv4_config.insert( 295 {objpath.first.str.substr(ipv4PathStart.size())}); 296 IPv4AddressData &ipv4_address = *it.first; 297 for (auto &property : interface.second) 298 { 299 if (property.first == "Address") 300 { 301 const std::string *address = 302 std::get_if<std::string>(&property.second); 303 if (address != nullptr) 304 { 305 ipv4_address.address = *address; 306 } 307 } 308 else if (property.first == "Gateway") 309 { 310 const std::string *gateway = 311 std::get_if<std::string>(&property.second); 312 if (gateway != nullptr) 313 { 314 ipv4_address.gateway = *gateway; 315 } 316 } 317 else if (property.first == "Origin") 318 { 319 const std::string *origin = 320 std::get_if<std::string>(&property.second); 321 if (origin != nullptr) 322 { 323 ipv4_address.origin = 324 translateAddressOriginDbusToRedfish(*origin, 325 true); 326 } 327 } 328 else if (property.first == "PrefixLength") 329 { 330 const uint8_t *mask = 331 std::get_if<uint8_t>(&property.second); 332 if (mask != nullptr) 333 { 334 // convert it to the string 335 ipv4_address.netmask = getNetmask(*mask); 336 } 337 } 338 else 339 { 340 BMCWEB_LOG_ERROR 341 << "Got extra property: " << property.first 342 << " on the " << objpath.first.str << " object"; 343 } 344 } 345 // Check if given address is local, or global 346 ipv4_address.linktype = 347 boost::starts_with(ipv4_address.address, "169.254.") 348 ? LinkType::Global 349 : LinkType::Local; 350 } 351 } 352 } 353 } 354 } 355 356 /** 357 * @brief Sets given Id on the given VLAN interface through D-Bus 358 * 359 * @param[in] ifaceId Id of VLAN interface that should be modified 360 * @param[in] inputVlanId New ID of the VLAN 361 * @param[in] callback Function that will be called after the operation 362 * 363 * @return None. 364 */ 365 template <typename CallbackFunc> 366 void changeVlanId(const std::string &ifaceId, const uint32_t &inputVlanId, 367 CallbackFunc &&callback) 368 { 369 crow::connections::systemBus->async_method_call( 370 callback, "xyz.openbmc_project.Network", 371 std::string("/xyz/openbmc_project/network/") + ifaceId, 372 "org.freedesktop.DBus.Properties", "Set", 373 "xyz.openbmc_project.Network.VLAN", "Id", 374 std::variant<uint32_t>(inputVlanId)); 375 } 376 377 /** 378 * @brief Helper function that verifies IP address to check if it is in 379 * proper format. If bits pointer is provided, also calculates active 380 * bit count for Subnet Mask. 381 * 382 * @param[in] ip IP that will be verified 383 * @param[out] bits Calculated mask in bits notation 384 * 385 * @return true in case of success, false otherwise 386 */ 387 inline bool ipv4VerifyIpAndGetBitcount(const std::string &ip, 388 uint8_t *bits = nullptr) 389 { 390 std::vector<std::string> bytesInMask; 391 392 boost::split(bytesInMask, ip, boost::is_any_of(".")); 393 394 static const constexpr int ipV4AddressSectionsCount = 4; 395 if (bytesInMask.size() != ipV4AddressSectionsCount) 396 { 397 return false; 398 } 399 400 if (bits != nullptr) 401 { 402 *bits = 0; 403 } 404 405 char *endPtr; 406 long previousValue = 255; 407 bool firstZeroInByteHit; 408 for (const std::string &byte : bytesInMask) 409 { 410 if (byte.empty()) 411 { 412 return false; 413 } 414 415 // Use strtol instead of stroi to avoid exceptions 416 long value = std::strtol(byte.c_str(), &endPtr, 10); 417 418 // endPtr should point to the end of the string, otherwise given string 419 // is not 100% number 420 if (*endPtr != '\0') 421 { 422 return false; 423 } 424 425 // Value should be contained in byte 426 if (value < 0 || value > 255) 427 { 428 return false; 429 } 430 431 if (bits != nullptr) 432 { 433 // Mask has to be continuous between bytes 434 if (previousValue != 255 && value != 0) 435 { 436 return false; 437 } 438 439 // Mask has to be continuous inside bytes 440 firstZeroInByteHit = false; 441 442 // Count bits 443 for (int bitIdx = 7; bitIdx >= 0; bitIdx--) 444 { 445 if (value & (1 << bitIdx)) 446 { 447 if (firstZeroInByteHit) 448 { 449 // Continuity not preserved 450 return false; 451 } 452 else 453 { 454 (*bits)++; 455 } 456 } 457 else 458 { 459 firstZeroInByteHit = true; 460 } 461 } 462 } 463 464 previousValue = value; 465 } 466 467 return true; 468 } 469 470 /** 471 * @brief Changes IPv4 address type property (Address, Gateway) 472 * 473 * @param[in] ifaceId Id of interface whose IP should be modified 474 * @param[in] ipIdx Index of IP in input array that should be modified 475 * @param[in] ipHash DBus Hash id of modified IP 476 * @param[in] name Name of field in JSON representation 477 * @param[in] newValue New value that should be written 478 * @param[io] asyncResp Response object that will be returned to client 479 * 480 * @return true if give IP is valid and has been sent do D-Bus, false 481 * otherwise 482 */ 483 inline void changeIPv4AddressProperty( 484 const std::string &ifaceId, int ipIdx, const std::string &ipHash, 485 const std::string &name, const std::string &newValue, 486 const std::shared_ptr<AsyncResp> asyncResp) 487 { 488 auto callback = [asyncResp, ipIdx, name{std::string(name)}, 489 newValue{std::move(newValue)}]( 490 const boost::system::error_code ec) { 491 if (ec) 492 { 493 messages::internalError(asyncResp->res); 494 } 495 else 496 { 497 asyncResp->res.jsonValue["IPv4Addresses"][ipIdx][name] = newValue; 498 } 499 }; 500 501 crow::connections::systemBus->async_method_call( 502 std::move(callback), "xyz.openbmc_project.Network", 503 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + ipHash, 504 "org.freedesktop.DBus.Properties", "Set", 505 "xyz.openbmc_project.Network.IP", name, 506 std::variant<std::string>(newValue)); 507 } 508 509 /** 510 * @brief Changes IPv4 address origin property 511 * 512 * @param[in] ifaceId Id of interface whose IP should be modified 513 * @param[in] ipIdx Index of IP in input array that should be 514 * modified 515 * @param[in] ipHash DBus Hash id of modified IP 516 * @param[in] newValue New value in Redfish format 517 * @param[in] newValueDbus New value in D-Bus format 518 * @param[io] asyncResp Response object that will be returned to client 519 * 520 * @return true if give IP is valid and has been sent do D-Bus, false 521 * otherwise 522 */ 523 inline void changeIPv4Origin(const std::string &ifaceId, int ipIdx, 524 const std::string &ipHash, 525 const std::string &newValue, 526 const std::string &newValueDbus, 527 const std::shared_ptr<AsyncResp> asyncResp) 528 { 529 auto callback = [asyncResp, ipIdx, newValue{std::move(newValue)}]( 530 const boost::system::error_code ec) { 531 if (ec) 532 { 533 messages::internalError(asyncResp->res); 534 } 535 else 536 { 537 asyncResp->res.jsonValue["IPv4Addresses"][ipIdx]["AddressOrigin"] = 538 newValue; 539 } 540 }; 541 542 crow::connections::systemBus->async_method_call( 543 std::move(callback), "xyz.openbmc_project.Network", 544 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + ipHash, 545 "org.freedesktop.DBus.Properties", "Set", 546 "xyz.openbmc_project.Network.IP", "Origin", 547 std::variant<std::string>(newValueDbus)); 548 } 549 550 /** 551 * @brief Modifies SubnetMask for given IP 552 * 553 * @param[in] ifaceId Id of interface whose IP should be modified 554 * @param[in] ipIdx Index of IP in input array that should be 555 * modified 556 * @param[in] ipHash DBus Hash id of modified IP 557 * @param[in] newValueStr Mask in dot notation as string 558 * @param[in] newValue Mask as PrefixLength in bitcount 559 * @param[io] asyncResp Response object that will be returned to client 560 * 561 * @return None 562 */ 563 inline void changeIPv4SubnetMaskProperty(const std::string &ifaceId, int ipIdx, 564 const std::string &ipHash, 565 const std::string &newValueStr, 566 uint8_t &newValue, 567 std::shared_ptr<AsyncResp> asyncResp) 568 { 569 auto callback = [asyncResp, ipIdx, newValueStr{std::move(newValueStr)}]( 570 const boost::system::error_code ec) { 571 if (ec) 572 { 573 messages::internalError(asyncResp->res); 574 } 575 else 576 { 577 asyncResp->res.jsonValue["IPv4Addresses"][ipIdx]["SubnetMask"] = 578 newValueStr; 579 } 580 }; 581 582 crow::connections::systemBus->async_method_call( 583 std::move(callback), "xyz.openbmc_project.Network", 584 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + ipHash, 585 "org.freedesktop.DBus.Properties", "Set", 586 "xyz.openbmc_project.Network.IP", "PrefixLength", 587 std::variant<uint8_t>(newValue)); 588 } 589 590 /** 591 * @brief Deletes given IPv4 592 * 593 * @param[in] ifaceId Id of interface whose IP should be deleted 594 * @param[in] ipIdx Index of IP in input array that should be deleted 595 * @param[in] ipHash DBus Hash id of IP that should be deleted 596 * @param[io] asyncResp Response object that will be returned to client 597 * 598 * @return None 599 */ 600 inline void deleteIPv4(const std::string &ifaceId, const std::string &ipHash, 601 unsigned int ipIdx, 602 const std::shared_ptr<AsyncResp> asyncResp) 603 { 604 crow::connections::systemBus->async_method_call( 605 [ipIdx, asyncResp](const boost::system::error_code ec) { 606 if (ec) 607 { 608 messages::internalError(asyncResp->res); 609 } 610 else 611 { 612 asyncResp->res.jsonValue["IPv4Addresses"][ipIdx] = nullptr; 613 } 614 }, 615 "xyz.openbmc_project.Network", 616 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + ipHash, 617 "xyz.openbmc_project.Object.Delete", "Delete"); 618 } 619 620 /** 621 * @brief Creates IPv4 with given data 622 * 623 * @param[in] ifaceId Id of interface whose IP should be deleted 624 * @param[in] ipIdx Index of IP in input array that should be deleted 625 * @param[in] ipHash DBus Hash id of IP that should be deleted 626 * @param[io] asyncResp Response object that will be returned to client 627 * 628 * @return None 629 */ 630 inline void createIPv4(const std::string &ifaceId, unsigned int ipIdx, 631 uint8_t subnetMask, const std::string &gateway, 632 const std::string &address, 633 std::shared_ptr<AsyncResp> asyncResp) 634 { 635 auto createIpHandler = [asyncResp](const boost::system::error_code ec) { 636 if (ec) 637 { 638 messages::internalError(asyncResp->res); 639 } 640 }; 641 642 crow::connections::systemBus->async_method_call( 643 std::move(createIpHandler), "xyz.openbmc_project.Network", 644 "/xyz/openbmc_project/network/" + ifaceId, 645 "xyz.openbmc_project.Network.IP.Create", "IP", 646 "xyz.openbmc_project.Network.IP.Protocol.IPv4", address, subnetMask, 647 gateway); 648 } 649 650 /** 651 * Function that retrieves all properties for given Ethernet Interface 652 * Object 653 * from EntityManager Network Manager 654 * @param ethiface_id a eth interface id to query on DBus 655 * @param callback a function that shall be called to convert Dbus output 656 * into JSON 657 */ 658 template <typename CallbackFunc> 659 void getEthernetIfaceData(const std::string ðiface_id, 660 CallbackFunc &&callback) 661 { 662 crow::connections::systemBus->async_method_call( 663 [ethiface_id{std::string{ethiface_id}}, callback{std::move(callback)}]( 664 const boost::system::error_code error_code, 665 const GetManagedObjects &resp) { 666 EthernetInterfaceData ethData{}; 667 boost::container::flat_set<IPv4AddressData> ipv4Data; 668 669 if (error_code) 670 { 671 callback(false, ethData, ipv4Data); 672 return; 673 } 674 675 extractEthernetInterfaceData(ethiface_id, resp, ethData); 676 extractIPData(ethiface_id, resp, ipv4Data); 677 678 // Fix global GW 679 for (IPv4AddressData &ipv4 : ipv4Data) 680 { 681 if ((ipv4.linktype == LinkType::Global) && 682 (ipv4.gateway == "0.0.0.0")) 683 { 684 ipv4.gateway = ethData.default_gateway; 685 } 686 } 687 688 // Finally make a callback with usefull data 689 callback(true, ethData, ipv4Data); 690 }, 691 "xyz.openbmc_project.Network", "/xyz/openbmc_project/network", 692 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 693 }; 694 695 /** 696 * Function that retrieves all Ethernet Interfaces available through Network 697 * Manager 698 * @param callback a function that shall be called to convert Dbus output 699 * into JSON. 700 */ 701 template <typename CallbackFunc> 702 void getEthernetIfaceList(CallbackFunc &&callback) 703 { 704 crow::connections::systemBus->async_method_call( 705 [callback{std::move(callback)}]( 706 const boost::system::error_code error_code, 707 GetManagedObjects &resp) { 708 // Callback requires vector<string> to retrieve all available 709 // ethernet interfaces 710 std::vector<std::string> iface_list; 711 iface_list.reserve(resp.size()); 712 if (error_code) 713 { 714 callback(false, iface_list); 715 return; 716 } 717 718 // Iterate over all retrieved ObjectPaths. 719 for (const auto &objpath : resp) 720 { 721 // And all interfaces available for certain ObjectPath. 722 for (const auto &interface : objpath.second) 723 { 724 // If interface is 725 // xyz.openbmc_project.Network.EthernetInterface, this is 726 // what we're looking for. 727 if (interface.first == 728 "xyz.openbmc_project.Network.EthernetInterface") 729 { 730 // Cut out everyting until last "/", ... 731 const std::string &iface_id = objpath.first.str; 732 std::size_t last_pos = iface_id.rfind("/"); 733 if (last_pos != std::string::npos) 734 { 735 // and put it into output vector. 736 iface_list.emplace_back( 737 iface_id.substr(last_pos + 1)); 738 } 739 } 740 } 741 } 742 // Finally make a callback with useful data 743 callback(true, iface_list); 744 }, 745 "xyz.openbmc_project.Network", "/xyz/openbmc_project/network", 746 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 747 }; 748 749 /** 750 * EthernetCollection derived class for delivering Ethernet Collection Schema 751 */ 752 class EthernetCollection : public Node 753 { 754 public: 755 template <typename CrowApp> 756 EthernetCollection(CrowApp &app) : 757 Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/") 758 { 759 entityPrivileges = { 760 {boost::beast::http::verb::get, {{"Login"}}}, 761 {boost::beast::http::verb::head, {{"Login"}}}, 762 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 763 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 764 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 765 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 766 } 767 768 private: 769 /** 770 * Functions triggers appropriate requests on DBus 771 */ 772 void doGet(crow::Response &res, const crow::Request &req, 773 const std::vector<std::string> ¶ms) override 774 { 775 res.jsonValue["@odata.type"] = 776 "#EthernetInterfaceCollection.EthernetInterfaceCollection"; 777 res.jsonValue["@odata.context"] = 778 "/redfish/v1/" 779 "$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection"; 780 res.jsonValue["@odata.id"] = 781 "/redfish/v1/Managers/bmc/EthernetInterfaces"; 782 res.jsonValue["Name"] = "Ethernet Network Interface Collection"; 783 res.jsonValue["Description"] = 784 "Collection of EthernetInterfaces for this Manager"; 785 786 // Get eth interface list, and call the below callback for JSON 787 // preparation 788 getEthernetIfaceList( 789 [&res](const bool &success, 790 const std::vector<std::string> &iface_list) { 791 if (!success) 792 { 793 messages::internalError(res); 794 res.end(); 795 return; 796 } 797 798 nlohmann::json &iface_array = res.jsonValue["Members"]; 799 iface_array = nlohmann::json::array(); 800 for (const std::string &iface_item : iface_list) 801 { 802 iface_array.push_back( 803 {{"@odata.id", 804 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 805 iface_item}}); 806 } 807 808 res.jsonValue["Members@odata.count"] = iface_array.size(); 809 res.jsonValue["@odata.id"] = 810 "/redfish/v1/Managers/bmc/EthernetInterfaces"; 811 res.end(); 812 }); 813 } 814 }; 815 816 /** 817 * EthernetInterface derived class for delivering Ethernet Schema 818 */ 819 class EthernetInterface : public Node 820 { 821 public: 822 /* 823 * Default Constructor 824 */ 825 template <typename CrowApp> 826 EthernetInterface(CrowApp &app) : 827 Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/", 828 std::string()) 829 { 830 entityPrivileges = { 831 {boost::beast::http::verb::get, {{"Login"}}}, 832 {boost::beast::http::verb::head, {{"Login"}}}, 833 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 834 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 835 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 836 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 837 } 838 839 // TODO(kkowalsk) Find a suitable class/namespace for this 840 static void handleVlanPatch(const std::string &ifaceId, bool vlanEnable, 841 uint64_t vlanId, 842 const EthernetInterfaceData ðData, 843 const std::shared_ptr<AsyncResp> asyncResp) 844 { 845 if (!ethData.vlan_id) 846 { 847 // This interface is not a VLAN. Cannot do anything with it 848 // TODO(kkowalsk) Change this message 849 messages::propertyNotWritable(asyncResp->res, "VLANEnable"); 850 851 return; 852 } 853 854 // VLAN is configured on the interface 855 if (vlanEnable == true) 856 { 857 // Change VLAN Id 858 asyncResp->res.jsonValue["VLANId"] = vlanId; 859 auto callback = [asyncResp](const boost::system::error_code ec) { 860 if (ec) 861 { 862 messages::internalError(asyncResp->res); 863 } 864 else 865 { 866 asyncResp->res.jsonValue["VLANEnable"] = true; 867 } 868 }; 869 crow::connections::systemBus->async_method_call( 870 std::move(callback), "xyz.openbmc_project.Network", 871 "/xyz/openbmc_project/network/" + ifaceId, 872 "org.freedesktop.DBus.Properties", "Set", 873 "xyz.openbmc_project.Network.VLAN", "Id", 874 std::variant<uint32_t>(vlanId)); 875 } 876 else 877 { 878 auto callback = [asyncResp](const boost::system::error_code ec) { 879 if (ec) 880 { 881 messages::internalError(asyncResp->res); 882 return; 883 } 884 asyncResp->res.jsonValue["VLANEnable"] = false; 885 }; 886 887 crow::connections::systemBus->async_method_call( 888 std::move(callback), "xyz.openbmc_project.Network", 889 "/xyz/openbmc_project/network/" + ifaceId, 890 "xyz.openbmc_project.Object.Delete", "Delete"); 891 } 892 } 893 894 private: 895 void handleHostnamePatch(const std::string &hostname, 896 const std::shared_ptr<AsyncResp> asyncResp) 897 { 898 asyncResp->res.jsonValue["HostName"] = hostname; 899 crow::connections::systemBus->async_method_call( 900 [asyncResp](const boost::system::error_code ec) { 901 if (ec) 902 { 903 messages::internalError(asyncResp->res); 904 } 905 }, 906 "xyz.openbmc_project.Network", 907 "/xyz/openbmc_project/network/config", 908 "org.freedesktop.DBus.Properties", "Set", 909 "xyz.openbmc_project.Network.SystemConfiguration", "HostName", 910 std::variant<std::string>(hostname)); 911 } 912 913 void handleIPv4Patch( 914 const std::string &ifaceId, std::vector<nlohmann::json> &input, 915 const boost::container::flat_set<IPv4AddressData> &ipv4Data, 916 const std::shared_ptr<AsyncResp> asyncResp) 917 { 918 int entryIdx = 0; 919 boost::container::flat_set<IPv4AddressData>::const_iterator thisData = 920 ipv4Data.begin(); 921 for (nlohmann::json &thisJson : input) 922 { 923 std::string pathString = 924 "IPv4Addresses/" + std::to_string(entryIdx); 925 926 std::optional<std::string> address; 927 std::optional<std::string> addressOrigin; 928 std::optional<std::string> subnetMask; 929 std::optional<std::string> gateway; 930 931 if (!json_util::readJson(thisJson, asyncResp->res, "Address", 932 address, "AddressOrigin", addressOrigin, 933 "SubnetMask", subnetMask, "Gateway", 934 gateway)) 935 { 936 return; 937 } 938 939 if (address) 940 { 941 if (!ipv4VerifyIpAndGetBitcount(*address)) 942 { 943 messages::propertyValueFormatError(asyncResp->res, *address, 944 pathString + "/Address"); 945 return; 946 } 947 } 948 949 uint8_t prefixLength = 0; 950 if (subnetMask) 951 { 952 if (!ipv4VerifyIpAndGetBitcount(*subnetMask, &prefixLength)) 953 { 954 messages::propertyValueFormatError( 955 asyncResp->res, *subnetMask, 956 pathString + "/SubnetMask"); 957 return; 958 } 959 } 960 std::string addressOriginInDBusFormat; 961 if (addressOrigin) 962 { 963 // Get Address origin in proper format 964 addressOriginInDBusFormat = 965 translateAddressOriginRedfishToDbus(*addressOrigin); 966 if (addressOriginInDBusFormat.empty()) 967 { 968 messages::propertyValueNotInList( 969 asyncResp->res, *addressOrigin, 970 pathString + "/AddressOrigin"); 971 return; 972 } 973 } 974 975 if (gateway) 976 { 977 if (!ipv4VerifyIpAndGetBitcount(*gateway)) 978 { 979 messages::propertyValueFormatError(asyncResp->res, *gateway, 980 pathString + "/Gateway"); 981 return; 982 } 983 } 984 985 // if a vlan already exists, modify the existing 986 if (thisData != ipv4Data.end()) 987 { 988 // Existing object that should be modified/deleted/remain 989 // unchanged 990 if (thisJson.is_null()) 991 { 992 auto callback = [entryIdx{std::to_string(entryIdx)}, 993 asyncResp]( 994 const boost::system::error_code ec) { 995 if (ec) 996 { 997 messages::internalError(asyncResp->res); 998 return; 999 } 1000 asyncResp->res.jsonValue["IPv4Addresses"][entryIdx] = 1001 nullptr; 1002 }; 1003 crow::connections::systemBus->async_method_call( 1004 std::move(callback), "xyz.openbmc_project.Network", 1005 "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + 1006 thisData->id, 1007 "xyz.openbmc_project.Object.Delete", "Delete"); 1008 } 1009 else if (thisJson.is_object()) 1010 { 1011 // Apply changes 1012 if (address) 1013 { 1014 auto callback = 1015 [asyncResp, entryIdx, address = *address]( 1016 const boost::system::error_code ec) { 1017 if (ec) 1018 { 1019 messages::internalError(asyncResp->res); 1020 return; 1021 } 1022 asyncResp->res.jsonValue["IPv4Addresses"] 1023 [entryIdx]["Address"] = 1024 address; 1025 }; 1026 1027 crow::connections::systemBus->async_method_call( 1028 std::move(callback), "xyz.openbmc_project.Network", 1029 "/xyz/openbmc_project/network/" + ifaceId + 1030 "/ipv4/" + thisData->id, 1031 "org.freedesktop.DBus.Properties", "Set", 1032 "xyz.openbmc_project.Network.IP", "Address", 1033 std::variant<std::string>(*address)); 1034 } 1035 1036 if (subnetMask) 1037 { 1038 changeIPv4SubnetMaskProperty(ifaceId, entryIdx, 1039 thisData->id, *subnetMask, 1040 prefixLength, asyncResp); 1041 } 1042 1043 if (addressOrigin) 1044 { 1045 changeIPv4Origin(ifaceId, entryIdx, thisData->id, 1046 *addressOrigin, 1047 addressOriginInDBusFormat, asyncResp); 1048 } 1049 1050 if (gateway) 1051 { 1052 auto callback = 1053 [asyncResp, entryIdx, 1054 gateway{std::string(*gateway)}]( 1055 const boost::system::error_code ec) { 1056 if (ec) 1057 { 1058 messages::internalError(asyncResp->res); 1059 return; 1060 } 1061 asyncResp->res.jsonValue["IPv4Addresses"] 1062 [entryIdx]["Gateway"] = 1063 std::move(gateway); 1064 }; 1065 1066 crow::connections::systemBus->async_method_call( 1067 std::move(callback), "xyz.openbmc_project.Network", 1068 "/xyz/openbmc_project/network/" + ifaceId + 1069 "/ipv4/" + thisData->id, 1070 "org.freedesktop.DBus.Properties", "Set", 1071 "xyz.openbmc_project.Network.IP", "Gateway", 1072 std::variant<std::string>(*gateway)); 1073 } 1074 } 1075 thisData++; 1076 } 1077 else 1078 { 1079 // Create IPv4 with provided data 1080 if (!gateway) 1081 { 1082 messages::propertyMissing(asyncResp->res, 1083 pathString + "/Gateway"); 1084 continue; 1085 } 1086 1087 if (!address) 1088 { 1089 messages::propertyMissing(asyncResp->res, 1090 pathString + "/Address"); 1091 continue; 1092 } 1093 1094 if (!subnetMask) 1095 { 1096 messages::propertyMissing(asyncResp->res, 1097 pathString + "/SubnetMask"); 1098 continue; 1099 } 1100 1101 createIPv4(ifaceId, entryIdx, prefixLength, *gateway, *address, 1102 asyncResp); 1103 asyncResp->res.jsonValue["IPv4Addresses"][entryIdx] = thisJson; 1104 } 1105 entryIdx++; 1106 } 1107 } 1108 1109 void parseInterfaceData( 1110 nlohmann::json &json_response, const std::string &iface_id, 1111 const EthernetInterfaceData ðData, 1112 const boost::container::flat_set<IPv4AddressData> &ipv4Data) 1113 { 1114 json_response["Id"] = iface_id; 1115 json_response["@odata.id"] = 1116 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + iface_id; 1117 json_response["InterfaceEnabled"] = true; 1118 if (ethData.speed == 0) 1119 { 1120 json_response["LinkStatus"] = "NoLink"; 1121 json_response["Status"] = { 1122 {"Health", "OK"}, 1123 {"State", "Disabled"}, 1124 }; 1125 } 1126 else 1127 { 1128 json_response["LinkStatus"] = "LinkUp"; 1129 json_response["Status"] = { 1130 {"Health", "OK"}, 1131 {"State", "Enabled"}, 1132 }; 1133 } 1134 json_response["SpeedMbps"] = ethData.speed; 1135 json_response["MACAddress"] = ethData.mac_address; 1136 if (!ethData.hostname.empty()) 1137 { 1138 json_response["HostName"] = ethData.hostname; 1139 } 1140 1141 nlohmann::json &vlanObj = json_response["VLAN"]; 1142 if (ethData.vlan_id) 1143 { 1144 vlanObj["VLANEnable"] = true; 1145 vlanObj["VLANId"] = *ethData.vlan_id; 1146 } 1147 else 1148 { 1149 vlanObj["VLANEnable"] = false; 1150 vlanObj["VLANId"] = 0; 1151 } 1152 json_response["NameServers"] = ethData.nameservers; 1153 1154 if (ipv4Data.size() > 0) 1155 { 1156 nlohmann::json &ipv4_array = json_response["IPv4Addresses"]; 1157 ipv4_array = nlohmann::json::array(); 1158 for (auto &ipv4_config : ipv4Data) 1159 { 1160 ipv4_array.push_back({{"AddressOrigin", ipv4_config.origin}, 1161 {"SubnetMask", ipv4_config.netmask}, 1162 {"Address", ipv4_config.address}, 1163 {"Gateway", ipv4_config.gateway}}); 1164 } 1165 } 1166 } 1167 1168 /** 1169 * Functions triggers appropriate requests on DBus 1170 */ 1171 void doGet(crow::Response &res, const crow::Request &req, 1172 const std::vector<std::string> ¶ms) override 1173 { 1174 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1175 if (params.size() != 1) 1176 { 1177 messages::internalError(asyncResp->res); 1178 return; 1179 } 1180 1181 getEthernetIfaceData( 1182 params[0], 1183 [this, asyncResp, iface_id{std::string(params[0])}]( 1184 const bool &success, const EthernetInterfaceData ðData, 1185 const boost::container::flat_set<IPv4AddressData> &ipv4Data) { 1186 if (!success) 1187 { 1188 // TODO(Pawel)consider distinguish between non existing 1189 // object, and other errors 1190 messages::resourceNotFound(asyncResp->res, 1191 "EthernetInterface", iface_id); 1192 return; 1193 } 1194 asyncResp->res.jsonValue["@odata.type"] = 1195 "#EthernetInterface.v1_2_0.EthernetInterface"; 1196 asyncResp->res.jsonValue["@odata.context"] = 1197 "/redfish/v1/$metadata#EthernetInterface.EthernetInterface"; 1198 asyncResp->res.jsonValue["Name"] = "Manager Ethernet Interface"; 1199 asyncResp->res.jsonValue["Description"] = 1200 "Management Network Interface"; 1201 1202 parseInterfaceData(asyncResp->res.jsonValue, iface_id, ethData, 1203 ipv4Data); 1204 }); 1205 } 1206 1207 void doPatch(crow::Response &res, const crow::Request &req, 1208 const std::vector<std::string> ¶ms) override 1209 { 1210 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1211 if (params.size() != 1) 1212 { 1213 messages::internalError(asyncResp->res); 1214 return; 1215 } 1216 1217 const std::string &iface_id = params[0]; 1218 1219 std::optional<nlohmann::json> vlan; 1220 std::optional<std::string> hostname; 1221 std::optional<std::vector<nlohmann::json>> ipv4Addresses; 1222 std::optional<std::vector<nlohmann::json>> ipv6Addresses; 1223 1224 if (!json_util::readJson(req, res, "VLAN", vlan, "HostName", hostname, 1225 "IPv4Addresses", ipv4Addresses, 1226 "IPv6Addresses", ipv6Addresses)) 1227 { 1228 return; 1229 } 1230 1231 std::optional<uint64_t> vlanId; 1232 std::optional<bool> vlanEnable; 1233 1234 if (vlan) 1235 { 1236 if (!json_util::readJson(*vlan, res, "VLANEnable", vlanEnable, 1237 "VLANId", vlanId)) 1238 { 1239 return; 1240 } 1241 // Need both vlanId and vlanEnable to service this request 1242 if (static_cast<bool>(vlanId) ^ static_cast<bool>(vlanEnable)) 1243 { 1244 if (vlanId) 1245 { 1246 messages::propertyMissing(asyncResp->res, "VLANEnable"); 1247 } 1248 else 1249 { 1250 messages::propertyMissing(asyncResp->res, "VLANId"); 1251 } 1252 1253 return; 1254 } 1255 } 1256 1257 // Get single eth interface data, and call the below callback for JSON 1258 // preparation 1259 getEthernetIfaceData( 1260 iface_id, 1261 [this, asyncResp, iface_id, vlanId, vlanEnable, 1262 hostname = std::move(hostname), 1263 ipv4Addresses = std::move(ipv4Addresses), 1264 ipv6Addresses = std::move(ipv6Addresses)]( 1265 const bool &success, const EthernetInterfaceData ðData, 1266 const boost::container::flat_set<IPv4AddressData> &ipv4Data) { 1267 if (!success) 1268 { 1269 // ... otherwise return error 1270 // TODO(Pawel)consider distinguish between non existing 1271 // object, and other errors 1272 messages::resourceNotFound( 1273 asyncResp->res, "VLAN Network Interface", iface_id); 1274 return; 1275 } 1276 1277 parseInterfaceData(asyncResp->res.jsonValue, iface_id, ethData, 1278 ipv4Data); 1279 1280 if (vlanId && vlanEnable) 1281 { 1282 handleVlanPatch(iface_id, *vlanId, *vlanEnable, ethData, 1283 asyncResp); 1284 } 1285 1286 if (hostname) 1287 { 1288 handleHostnamePatch(*hostname, asyncResp); 1289 } 1290 1291 if (ipv4Addresses) 1292 { 1293 // TODO(ed) for some reason the capture of ipv4Addresses 1294 // above is returning a const value, not a non-const value. 1295 // This doesn't really work for us, as we need to be able to 1296 // efficiently move out the intermedia nlohmann::json 1297 // objects. This makes a copy of the structure, and operates 1298 // on that, but could be done more efficiently 1299 std::vector<nlohmann::json> ipv4 = 1300 std::move(*ipv4Addresses); 1301 handleIPv4Patch(iface_id, ipv4, ipv4Data, asyncResp); 1302 } 1303 1304 if (ipv6Addresses) 1305 { 1306 // TODO(kkowalsk) IPv6 Not supported on D-Bus yet 1307 messages::propertyNotWritable(asyncResp->res, 1308 "IPv6Addresses"); 1309 } 1310 }); 1311 } 1312 }; 1313 1314 /** 1315 * VlanNetworkInterface derived class for delivering VLANNetworkInterface 1316 * Schema 1317 */ 1318 class VlanNetworkInterface : public Node 1319 { 1320 public: 1321 /* 1322 * Default Constructor 1323 */ 1324 template <typename CrowApp> 1325 VlanNetworkInterface(CrowApp &app) : 1326 Node(app, 1327 "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/<str>", 1328 std::string(), std::string()) 1329 { 1330 entityPrivileges = { 1331 {boost::beast::http::verb::get, {{"Login"}}}, 1332 {boost::beast::http::verb::head, {{"Login"}}}, 1333 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 1334 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 1335 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 1336 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 1337 } 1338 1339 private: 1340 void parseInterfaceData( 1341 nlohmann::json &json_response, const std::string &parent_iface_id, 1342 const std::string &iface_id, const EthernetInterfaceData ðData, 1343 const boost::container::flat_set<IPv4AddressData> &ipv4Data) 1344 { 1345 // Fill out obvious data... 1346 json_response["Id"] = iface_id; 1347 json_response["@odata.id"] = 1348 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + parent_iface_id + 1349 "/VLANs/" + iface_id; 1350 1351 json_response["VLANEnable"] = true; 1352 if (ethData.vlan_id) 1353 { 1354 json_response["VLANId"] = *ethData.vlan_id; 1355 } 1356 } 1357 1358 bool verifyNames(crow::Response &res, const std::string &parent, 1359 const std::string &iface) 1360 { 1361 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1362 if (!boost::starts_with(iface, parent + "_")) 1363 { 1364 messages::resourceNotFound(asyncResp->res, "VLAN Network Interface", 1365 iface); 1366 return false; 1367 } 1368 else 1369 { 1370 return true; 1371 } 1372 } 1373 1374 /** 1375 * Functions triggers appropriate requests on DBus 1376 */ 1377 void doGet(crow::Response &res, const crow::Request &req, 1378 const std::vector<std::string> ¶ms) override 1379 { 1380 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1381 // TODO(Pawel) this shall be parameterized call (two params) to get 1382 // EthernetInterfaces for any Manager, not only hardcoded 'openbmc'. 1383 // Check if there is required param, truly entering this shall be 1384 // impossible. 1385 if (params.size() != 2) 1386 { 1387 messages::internalError(res); 1388 res.end(); 1389 return; 1390 } 1391 1392 const std::string &parent_iface_id = params[0]; 1393 const std::string &iface_id = params[1]; 1394 res.jsonValue["@odata.type"] = 1395 "#VLanNetworkInterface.v1_1_0.VLanNetworkInterface"; 1396 res.jsonValue["@odata.context"] = 1397 "/redfish/v1/$metadata#VLanNetworkInterface.VLanNetworkInterface"; 1398 res.jsonValue["Name"] = "VLAN Network Interface"; 1399 1400 if (!verifyNames(res, parent_iface_id, iface_id)) 1401 { 1402 return; 1403 } 1404 1405 // Get single eth interface data, and call the below callback for JSON 1406 // preparation 1407 getEthernetIfaceData( 1408 iface_id, 1409 [this, asyncResp, parent_iface_id, iface_id]( 1410 const bool &success, const EthernetInterfaceData ðData, 1411 const boost::container::flat_set<IPv4AddressData> &ipv4Data) { 1412 if (success && ethData.vlan_id) 1413 { 1414 parseInterfaceData(asyncResp->res.jsonValue, 1415 parent_iface_id, iface_id, ethData, 1416 ipv4Data); 1417 } 1418 else 1419 { 1420 // ... otherwise return error 1421 // TODO(Pawel)consider distinguish between non existing 1422 // object, and other errors 1423 messages::resourceNotFound( 1424 asyncResp->res, "VLAN Network Interface", iface_id); 1425 } 1426 }); 1427 } 1428 1429 void doPatch(crow::Response &res, const crow::Request &req, 1430 const std::vector<std::string> ¶ms) override 1431 { 1432 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1433 if (params.size() != 2) 1434 { 1435 messages::internalError(asyncResp->res); 1436 return; 1437 } 1438 1439 const std::string &parentIfaceId = params[0]; 1440 const std::string &ifaceId = params[1]; 1441 1442 if (!verifyNames(res, parentIfaceId, ifaceId)) 1443 { 1444 return; 1445 } 1446 1447 bool vlanEnable = false; 1448 uint64_t vlanId = 0; 1449 1450 if (!json_util::readJson(req, res, "VLANEnable", vlanEnable, "VLANId", 1451 vlanId)) 1452 { 1453 return; 1454 } 1455 1456 // Get single eth interface data, and call the below callback for JSON 1457 // preparation 1458 getEthernetIfaceData( 1459 ifaceId, 1460 [this, asyncResp, parentIfaceId, ifaceId, vlanEnable, vlanId]( 1461 const bool &success, const EthernetInterfaceData ðData, 1462 const boost::container::flat_set<IPv4AddressData> &ipv4Data) { 1463 if (!success) 1464 { 1465 // TODO(Pawel)consider distinguish between non existing 1466 // object, and other errors 1467 messages::resourceNotFound( 1468 asyncResp->res, "VLAN Network Interface", ifaceId); 1469 1470 return; 1471 } 1472 1473 parseInterfaceData(asyncResp->res.jsonValue, parentIfaceId, 1474 ifaceId, ethData, ipv4Data); 1475 1476 EthernetInterface::handleVlanPatch(ifaceId, vlanId, vlanEnable, 1477 ethData, asyncResp); 1478 }); 1479 } 1480 1481 void doDelete(crow::Response &res, const crow::Request &req, 1482 const std::vector<std::string> ¶ms) override 1483 { 1484 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1485 if (params.size() != 2) 1486 { 1487 messages::internalError(asyncResp->res); 1488 return; 1489 } 1490 1491 const std::string &parentIfaceId = params[0]; 1492 const std::string &ifaceId = params[1]; 1493 1494 if (!verifyNames(asyncResp->res, parentIfaceId, ifaceId)) 1495 { 1496 return; 1497 } 1498 1499 // Get single eth interface data, and call the below callback for JSON 1500 // preparation 1501 getEthernetIfaceData( 1502 ifaceId, 1503 [this, asyncResp, parentIfaceId{std::string(parentIfaceId)}, 1504 ifaceId{std::string(ifaceId)}]( 1505 const bool &success, const EthernetInterfaceData ðData, 1506 const boost::container::flat_set<IPv4AddressData> &ipv4Data) { 1507 if (success && ethData.vlan_id) 1508 { 1509 parseInterfaceData(asyncResp->res.jsonValue, parentIfaceId, 1510 ifaceId, ethData, ipv4Data); 1511 1512 auto callback = 1513 [asyncResp](const boost::system::error_code ec) { 1514 if (ec) 1515 { 1516 messages::internalError(asyncResp->res); 1517 } 1518 }; 1519 crow::connections::systemBus->async_method_call( 1520 std::move(callback), "xyz.openbmc_project.Network", 1521 std::string("/xyz/openbmc_project/network/") + ifaceId, 1522 "xyz.openbmc_project.Object.Delete", "Delete"); 1523 } 1524 else 1525 { 1526 // ... otherwise return error 1527 // TODO(Pawel)consider distinguish between non existing 1528 // object, and other errors 1529 messages::resourceNotFound( 1530 asyncResp->res, "VLAN Network Interface", ifaceId); 1531 } 1532 }); 1533 } 1534 }; 1535 1536 /** 1537 * VlanNetworkInterfaceCollection derived class for delivering 1538 * VLANNetworkInterface Collection Schema 1539 */ 1540 class VlanNetworkInterfaceCollection : public Node 1541 { 1542 public: 1543 template <typename CrowApp> 1544 VlanNetworkInterfaceCollection(CrowApp &app) : 1545 Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/", 1546 std::string()) 1547 { 1548 entityPrivileges = { 1549 {boost::beast::http::verb::get, {{"Login"}}}, 1550 {boost::beast::http::verb::head, {{"Login"}}}, 1551 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, 1552 {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, 1553 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, 1554 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; 1555 } 1556 1557 private: 1558 /** 1559 * Functions triggers appropriate requests on DBus 1560 */ 1561 void doGet(crow::Response &res, const crow::Request &req, 1562 const std::vector<std::string> ¶ms) override 1563 { 1564 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1565 if (params.size() != 1) 1566 { 1567 // This means there is a problem with the router 1568 messages::internalError(asyncResp->res); 1569 return; 1570 } 1571 1572 const std::string &rootInterfaceName = params[0]; 1573 1574 // Get eth interface list, and call the below callback for JSON 1575 // preparation 1576 getEthernetIfaceList( 1577 [asyncResp, rootInterfaceName{std::string(rootInterfaceName)}]( 1578 const bool &success, 1579 const std::vector<std::string> &iface_list) { 1580 if (!success) 1581 { 1582 messages::internalError(asyncResp->res); 1583 return; 1584 } 1585 asyncResp->res.jsonValue["@odata.type"] = 1586 "#VLanNetworkInterfaceCollection." 1587 "VLanNetworkInterfaceCollection"; 1588 asyncResp->res.jsonValue["@odata.context"] = 1589 "/redfish/v1/$metadata" 1590 "#VLanNetworkInterfaceCollection." 1591 "VLanNetworkInterfaceCollection"; 1592 asyncResp->res.jsonValue["Name"] = 1593 "VLAN Network Interface Collection"; 1594 1595 nlohmann::json iface_array = nlohmann::json::array(); 1596 1597 for (const std::string &iface_item : iface_list) 1598 { 1599 if (boost::starts_with(iface_item, rootInterfaceName + "_")) 1600 { 1601 iface_array.push_back( 1602 {{"@odata.id", 1603 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 1604 rootInterfaceName + "/VLANs/" + iface_item}}); 1605 } 1606 } 1607 1608 if (iface_array.empty()) 1609 { 1610 messages::resourceNotFound( 1611 asyncResp->res, "EthernetInterface", rootInterfaceName); 1612 return; 1613 } 1614 asyncResp->res.jsonValue["Members@odata.count"] = 1615 iface_array.size(); 1616 asyncResp->res.jsonValue["Members"] = std::move(iface_array); 1617 asyncResp->res.jsonValue["@odata.id"] = 1618 "/redfish/v1/Managers/bmc/EthernetInterfaces/" + 1619 rootInterfaceName + "/VLANs"; 1620 }); 1621 } 1622 1623 void doPost(crow::Response &res, const crow::Request &req, 1624 const std::vector<std::string> ¶ms) override 1625 { 1626 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); 1627 if (params.size() != 1) 1628 { 1629 messages::internalError(asyncResp->res); 1630 return; 1631 } 1632 1633 uint32_t vlanId = 0; 1634 if (!json_util::readJson(req, res, "VLANId", vlanId)) 1635 { 1636 return; 1637 } 1638 const std::string &rootInterfaceName = params[0]; 1639 auto callback = [asyncResp](const boost::system::error_code ec) { 1640 if (ec) 1641 { 1642 // TODO(ed) make more consistent error messages based on 1643 // phosphor-network responses 1644 messages::internalError(asyncResp->res); 1645 return; 1646 } 1647 messages::created(asyncResp->res); 1648 }; 1649 crow::connections::systemBus->async_method_call( 1650 std::move(callback), "xyz.openbmc_project.Network", 1651 "/xyz/openbmc_project/network", 1652 "xyz.openbmc_project.Network.VLAN.Create", "VLAN", 1653 rootInterfaceName, vlanId); 1654 } 1655 }; 1656 } // namespace redfish 1657