xref: /openbmc/bmcweb/features/redfish/lib/ethernet.hpp (revision 8f7e9c194f36a84f4e49ad142110f4f3d0f312be) 
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 <utils/json_utils.hpp>
24 
25 #include <optional>
26 #include <regex>
27 #include <variant>
28 
29 namespace redfish
30 {
31 
32 /**
33  * DBus types primitives for several generic DBus interfaces
34  * TODO(Pawel) consider move this to separate file into boost::dbus
35  */
36 using PropertiesMapType = boost::container::flat_map<
37     std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t,
38                               int32_t, uint32_t, int64_t, uint64_t, double>>;
39 
40 using GetManagedObjects = std::vector<std::pair<
41     sdbusplus::message::object_path,
42     std::vector<std::pair<
43         std::string,
44         boost::container::flat_map<
45             std::string,
46             std::variant<std::string, bool, uint8_t, int16_t, uint16_t, int32_t,
47                          uint32_t, int64_t, uint64_t, double,
48                          std::vector<std::string>>>>>>>;
49 
50 enum class LinkType
51 {
52     Local,
53     Global
54 };
55 
56 /**
57  * Structure for keeping IPv4 data required by Redfish
58  */
59 struct IPv4AddressData
60 {
61     std::string id;
62     std::string address;
63     std::string domain;
64     std::string gateway;
65     std::string netmask;
66     std::string origin;
67     LinkType linktype;
68     bool isActive;
69 
70     bool operator<(const IPv4AddressData& obj) const
71     {
72         return id < obj.id;
73     }
74 };
75 
76 /**
77  * Structure for keeping IPv6 data required by Redfish
78  */
79 struct IPv6AddressData
80 {
81     std::string id;
82     std::string address;
83     std::string origin;
84     uint8_t prefixLength;
85 
86     bool operator<(const IPv6AddressData& obj) const
87     {
88         return id < obj.id;
89     }
90 };
91 /**
92  * Structure for keeping basic single Ethernet Interface information
93  * available from DBus
94  */
95 struct EthernetInterfaceData
96 {
97     uint32_t speed;
98     bool auto_neg;
99     bool DNSEnabled;
100     bool NTPEnabled;
101     bool HostNameEnabled;
102     bool SendHostNameEnabled;
103     bool linkUp;
104     bool nicEnabled;
105     std::string DHCPEnabled;
106     std::string operatingMode;
107     std::string hostname;
108     std::string default_gateway;
109     std::string ipv6_default_gateway;
110     std::string mac_address;
111     std::vector<std::uint32_t> vlan_id;
112     std::vector<std::string> nameServers;
113     std::vector<std::string> staticNameServers;
114     std::vector<std::string> domainnames;
115 };
116 
117 struct DHCPParameters
118 {
119     std::optional<bool> dhcpv4Enabled;
120     std::optional<bool> useDNSServers;
121     std::optional<bool> useNTPServers;
122     std::optional<bool> useUseDomainName;
123     std::optional<std::string> dhcpv6OperatingMode;
124 };
125 
126 // Helper function that changes bits netmask notation (i.e. /24)
127 // into full dot notation
128 inline std::string getNetmask(unsigned int bits)
129 {
130     uint32_t value = 0xffffffff << (32 - bits);
131     std::string netmask = std::to_string((value >> 24) & 0xff) + "." +
132                           std::to_string((value >> 16) & 0xff) + "." +
133                           std::to_string((value >> 8) & 0xff) + "." +
134                           std::to_string(value & 0xff);
135     return netmask;
136 }
137 
138 inline bool translateDHCPEnabledToBool(const std::string& inputDHCP,
139                                        bool isIPv4)
140 {
141     if (isIPv4)
142     {
143         return (
144             (inputDHCP ==
145              "xyz.openbmc_project.Network.EthernetInterface.DHCPConf.v4") ||
146             (inputDHCP ==
147              "xyz.openbmc_project.Network.EthernetInterface.DHCPConf.both"));
148     }
149     return ((inputDHCP ==
150              "xyz.openbmc_project.Network.EthernetInterface.DHCPConf.v6") ||
151             (inputDHCP ==
152              "xyz.openbmc_project.Network.EthernetInterface.DHCPConf.both"));
153 }
154 
155 inline std::string getDhcpEnabledEnumeration(bool isIPv4, bool isIPv6)
156 {
157     if (isIPv4 && isIPv6)
158     {
159         return "xyz.openbmc_project.Network.EthernetInterface.DHCPConf.both";
160     }
161     if (isIPv4)
162     {
163         return "xyz.openbmc_project.Network.EthernetInterface.DHCPConf.v4";
164     }
165     if (isIPv6)
166     {
167         return "xyz.openbmc_project.Network.EthernetInterface.DHCPConf.v6";
168     }
169     return "xyz.openbmc_project.Network.EthernetInterface.DHCPConf.none";
170 }
171 
172 inline std::string
173     translateAddressOriginDbusToRedfish(const std::string& inputOrigin,
174                                         bool isIPv4)
175 {
176     if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.Static")
177     {
178         return "Static";
179     }
180     if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.LinkLocal")
181     {
182         if (isIPv4)
183         {
184             return "IPv4LinkLocal";
185         }
186         return "LinkLocal";
187     }
188     if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.DHCP")
189     {
190         if (isIPv4)
191         {
192             return "DHCP";
193         }
194         return "DHCPv6";
195     }
196     if (inputOrigin == "xyz.openbmc_project.Network.IP.AddressOrigin.SLAAC")
197     {
198         return "SLAAC";
199     }
200     return "";
201 }
202 
203 inline bool extractEthernetInterfaceData(const std::string& ethifaceId,
204                                          GetManagedObjects& dbusData,
205                                          EthernetInterfaceData& ethData)
206 {
207     bool idFound = false;
208     for (auto& objpath : dbusData)
209     {
210         for (auto& ifacePair : objpath.second)
211         {
212             if (objpath.first == "/xyz/openbmc_project/network/" + ethifaceId)
213             {
214                 idFound = true;
215                 if (ifacePair.first == "xyz.openbmc_project.Network.MACAddress")
216                 {
217                     for (const auto& propertyPair : ifacePair.second)
218                     {
219                         if (propertyPair.first == "MACAddress")
220                         {
221                             const std::string* mac =
222                                 std::get_if<std::string>(&propertyPair.second);
223                             if (mac != nullptr)
224                             {
225                                 ethData.mac_address = *mac;
226                             }
227                         }
228                     }
229                 }
230                 else if (ifacePair.first == "xyz.openbmc_project.Network.VLAN")
231                 {
232                     for (const auto& propertyPair : ifacePair.second)
233                     {
234                         if (propertyPair.first == "Id")
235                         {
236                             const uint32_t* id =
237                                 std::get_if<uint32_t>(&propertyPair.second);
238                             if (id != nullptr)
239                             {
240                                 ethData.vlan_id.push_back(*id);
241                             }
242                         }
243                     }
244                 }
245                 else if (ifacePair.first ==
246                          "xyz.openbmc_project.Network.EthernetInterface")
247                 {
248                     for (const auto& propertyPair : ifacePair.second)
249                     {
250                         if (propertyPair.first == "AutoNeg")
251                         {
252                             const bool* autoNeg =
253                                 std::get_if<bool>(&propertyPair.second);
254                             if (autoNeg != nullptr)
255                             {
256                                 ethData.auto_neg = *autoNeg;
257                             }
258                         }
259                         else if (propertyPair.first == "Speed")
260                         {
261                             const uint32_t* speed =
262                                 std::get_if<uint32_t>(&propertyPair.second);
263                             if (speed != nullptr)
264                             {
265                                 ethData.speed = *speed;
266                             }
267                         }
268                         else if (propertyPair.first == "LinkUp")
269                         {
270                             const bool* linkUp =
271                                 std::get_if<bool>(&propertyPair.second);
272                             if (linkUp != nullptr)
273                             {
274                                 ethData.linkUp = *linkUp;
275                             }
276                         }
277                         else if (propertyPair.first == "NICEnabled")
278                         {
279                             const bool* nicEnabled =
280                                 std::get_if<bool>(&propertyPair.second);
281                             if (nicEnabled != nullptr)
282                             {
283                                 ethData.nicEnabled = *nicEnabled;
284                             }
285                         }
286                         else if (propertyPair.first == "Nameservers")
287                         {
288                             const std::vector<std::string>* nameservers =
289                                 std::get_if<std::vector<std::string>>(
290                                     &propertyPair.second);
291                             if (nameservers != nullptr)
292                             {
293                                 ethData.nameServers = *nameservers;
294                             }
295                         }
296                         else if (propertyPair.first == "StaticNameServers")
297                         {
298                             const std::vector<std::string>* staticNameServers =
299                                 std::get_if<std::vector<std::string>>(
300                                     &propertyPair.second);
301                             if (staticNameServers != nullptr)
302                             {
303                                 ethData.staticNameServers = *staticNameServers;
304                             }
305                         }
306                         else if (propertyPair.first == "DHCPEnabled")
307                         {
308                             const std::string* dhcpEnabled =
309                                 std::get_if<std::string>(&propertyPair.second);
310                             if (dhcpEnabled != nullptr)
311                             {
312                                 ethData.DHCPEnabled = *dhcpEnabled;
313                             }
314                         }
315                         else if (propertyPair.first == "DomainName")
316                         {
317                             const std::vector<std::string>* domainNames =
318                                 std::get_if<std::vector<std::string>>(
319                                     &propertyPair.second);
320                             if (domainNames != nullptr)
321                             {
322                                 ethData.domainnames = *domainNames;
323                             }
324                         }
325                     }
326                 }
327             }
328 
329             if (objpath.first == "/xyz/openbmc_project/network/config/dhcp")
330             {
331                 if (ifacePair.first ==
332                     "xyz.openbmc_project.Network.DHCPConfiguration")
333                 {
334                     for (const auto& propertyPair : ifacePair.second)
335                     {
336                         if (propertyPair.first == "DNSEnabled")
337                         {
338                             const bool* dnsEnabled =
339                                 std::get_if<bool>(&propertyPair.second);
340                             if (dnsEnabled != nullptr)
341                             {
342                                 ethData.DNSEnabled = *dnsEnabled;
343                             }
344                         }
345                         else if (propertyPair.first == "NTPEnabled")
346                         {
347                             const bool* ntpEnabled =
348                                 std::get_if<bool>(&propertyPair.second);
349                             if (ntpEnabled != nullptr)
350                             {
351                                 ethData.NTPEnabled = *ntpEnabled;
352                             }
353                         }
354                         else if (propertyPair.first == "HostNameEnabled")
355                         {
356                             const bool* hostNameEnabled =
357                                 std::get_if<bool>(&propertyPair.second);
358                             if (hostNameEnabled != nullptr)
359                             {
360                                 ethData.HostNameEnabled = *hostNameEnabled;
361                             }
362                         }
363                         else if (propertyPair.first == "SendHostNameEnabled")
364                         {
365                             const bool* sendHostNameEnabled =
366                                 std::get_if<bool>(&propertyPair.second);
367                             if (sendHostNameEnabled != nullptr)
368                             {
369                                 ethData.SendHostNameEnabled =
370                                     *sendHostNameEnabled;
371                             }
372                         }
373                     }
374                 }
375             }
376             // System configuration shows up in the global namespace, so no need
377             // to check eth number
378             if (ifacePair.first ==
379                 "xyz.openbmc_project.Network.SystemConfiguration")
380             {
381                 for (const auto& propertyPair : ifacePair.second)
382                 {
383                     if (propertyPair.first == "HostName")
384                     {
385                         const std::string* hostname =
386                             std::get_if<std::string>(&propertyPair.second);
387                         if (hostname != nullptr)
388                         {
389                             ethData.hostname = *hostname;
390                         }
391                     }
392                     else if (propertyPair.first == "DefaultGateway")
393                     {
394                         const std::string* defaultGateway =
395                             std::get_if<std::string>(&propertyPair.second);
396                         if (defaultGateway != nullptr)
397                         {
398                             ethData.default_gateway = *defaultGateway;
399                         }
400                     }
401                     else if (propertyPair.first == "DefaultGateway6")
402                     {
403                         const std::string* defaultGateway6 =
404                             std::get_if<std::string>(&propertyPair.second);
405                         if (defaultGateway6 != nullptr)
406                         {
407                             ethData.ipv6_default_gateway = *defaultGateway6;
408                         }
409                     }
410                 }
411             }
412         }
413     }
414     return idFound;
415 }
416 
417 // Helper function that extracts data for single ethernet ipv6 address
418 inline void
419     extractIPV6Data(const std::string& ethifaceId,
420                     const GetManagedObjects& dbusData,
421                     boost::container::flat_set<IPv6AddressData>& ipv6Config)
422 {
423     const std::string ipv6PathStart =
424         "/xyz/openbmc_project/network/" + ethifaceId + "/ipv6/";
425 
426     // Since there might be several IPv6 configurations aligned with
427     // single ethernet interface, loop over all of them
428     for (const auto& objpath : dbusData)
429     {
430         // Check if proper pattern for object path appears
431         if (boost::starts_with(objpath.first.str, ipv6PathStart))
432         {
433             for (auto& interface : objpath.second)
434             {
435                 if (interface.first == "xyz.openbmc_project.Network.IP")
436                 {
437                     // Instance IPv6AddressData structure, and set as
438                     // appropriate
439                     std::pair<
440                         boost::container::flat_set<IPv6AddressData>::iterator,
441                         bool>
442                         it = ipv6Config.insert(IPv6AddressData{});
443                     IPv6AddressData& ipv6Address = *it.first;
444                     ipv6Address.id =
445                         objpath.first.str.substr(ipv6PathStart.size());
446                     for (auto& property : interface.second)
447                     {
448                         if (property.first == "Address")
449                         {
450                             const std::string* address =
451                                 std::get_if<std::string>(&property.second);
452                             if (address != nullptr)
453                             {
454                                 ipv6Address.address = *address;
455                             }
456                         }
457                         else if (property.first == "Origin")
458                         {
459                             const std::string* origin =
460                                 std::get_if<std::string>(&property.second);
461                             if (origin != nullptr)
462                             {
463                                 ipv6Address.origin =
464                                     translateAddressOriginDbusToRedfish(*origin,
465                                                                         false);
466                             }
467                         }
468                         else if (property.first == "PrefixLength")
469                         {
470                             const uint8_t* prefix =
471                                 std::get_if<uint8_t>(&property.second);
472                             if (prefix != nullptr)
473                             {
474                                 ipv6Address.prefixLength = *prefix;
475                             }
476                         }
477                         else
478                         {
479                             BMCWEB_LOG_ERROR
480                                 << "Got extra property: " << property.first
481                                 << " on the " << objpath.first.str << " object";
482                         }
483                     }
484                 }
485             }
486         }
487     }
488 }
489 
490 // Helper function that extracts data for single ethernet ipv4 address
491 inline void
492     extractIPData(const std::string& ethifaceId,
493                   const GetManagedObjects& dbusData,
494                   boost::container::flat_set<IPv4AddressData>& ipv4Config)
495 {
496     const std::string ipv4PathStart =
497         "/xyz/openbmc_project/network/" + ethifaceId + "/ipv4/";
498 
499     // Since there might be several IPv4 configurations aligned with
500     // single ethernet interface, loop over all of them
501     for (const auto& objpath : dbusData)
502     {
503         // Check if proper pattern for object path appears
504         if (boost::starts_with(objpath.first.str, ipv4PathStart))
505         {
506             for (auto& interface : objpath.second)
507             {
508                 if (interface.first == "xyz.openbmc_project.Network.IP")
509                 {
510                     // Instance IPv4AddressData structure, and set as
511                     // appropriate
512                     std::pair<
513                         boost::container::flat_set<IPv4AddressData>::iterator,
514                         bool>
515                         it = ipv4Config.insert(IPv4AddressData{});
516                     IPv4AddressData& ipv4Address = *it.first;
517                     ipv4Address.id =
518                         objpath.first.str.substr(ipv4PathStart.size());
519                     for (auto& property : interface.second)
520                     {
521                         if (property.first == "Address")
522                         {
523                             const std::string* address =
524                                 std::get_if<std::string>(&property.second);
525                             if (address != nullptr)
526                             {
527                                 ipv4Address.address = *address;
528                             }
529                         }
530                         else if (property.first == "Gateway")
531                         {
532                             const std::string* gateway =
533                                 std::get_if<std::string>(&property.second);
534                             if (gateway != nullptr)
535                             {
536                                 ipv4Address.gateway = *gateway;
537                             }
538                         }
539                         else if (property.first == "Origin")
540                         {
541                             const std::string* origin =
542                                 std::get_if<std::string>(&property.second);
543                             if (origin != nullptr)
544                             {
545                                 ipv4Address.origin =
546                                     translateAddressOriginDbusToRedfish(*origin,
547                                                                         true);
548                             }
549                         }
550                         else if (property.first == "PrefixLength")
551                         {
552                             const uint8_t* mask =
553                                 std::get_if<uint8_t>(&property.second);
554                             if (mask != nullptr)
555                             {
556                                 // convert it to the string
557                                 ipv4Address.netmask = getNetmask(*mask);
558                             }
559                         }
560                         else
561                         {
562                             BMCWEB_LOG_ERROR
563                                 << "Got extra property: " << property.first
564                                 << " on the " << objpath.first.str << " object";
565                         }
566                     }
567                     // Check if given address is local, or global
568                     ipv4Address.linktype =
569                         boost::starts_with(ipv4Address.address, "169.254.")
570                             ? LinkType::Local
571                             : LinkType::Global;
572                 }
573             }
574         }
575     }
576 }
577 
578 /**
579  * @brief Sets given Id on the given VLAN interface through D-Bus
580  *
581  * @param[in] ifaceId       Id of VLAN interface that should be modified
582  * @param[in] inputVlanId   New ID of the VLAN
583  * @param[in] callback      Function that will be called after the operation
584  *
585  * @return None.
586  */
587 template <typename CallbackFunc>
588 void changeVlanId(const std::string& ifaceId, const uint32_t& inputVlanId,
589                   CallbackFunc&& callback)
590 {
591     crow::connections::systemBus->async_method_call(
592         callback, "xyz.openbmc_project.Network",
593         std::string("/xyz/openbmc_project/network/") + ifaceId,
594         "org.freedesktop.DBus.Properties", "Set",
595         "xyz.openbmc_project.Network.VLAN", "Id",
596         std::variant<uint32_t>(inputVlanId));
597 }
598 
599 /**
600  * @brief Helper function that verifies IP address to check if it is in
601  *        proper format. If bits pointer is provided, also calculates active
602  *        bit count for Subnet Mask.
603  *
604  * @param[in]  ip     IP that will be verified
605  * @param[out] bits   Calculated mask in bits notation
606  *
607  * @return true in case of success, false otherwise
608  */
609 inline bool ipv4VerifyIpAndGetBitcount(const std::string& ip,
610                                        uint8_t* bits = nullptr)
611 {
612     std::vector<std::string> bytesInMask;
613 
614     boost::split(bytesInMask, ip, boost::is_any_of("."));
615 
616     static const constexpr int ipV4AddressSectionsCount = 4;
617     if (bytesInMask.size() != ipV4AddressSectionsCount)
618     {
619         return false;
620     }
621 
622     if (bits != nullptr)
623     {
624         *bits = 0;
625     }
626 
627     char* endPtr;
628     long previousValue = 255;
629     bool firstZeroInByteHit;
630     for (const std::string& byte : bytesInMask)
631     {
632         if (byte.empty())
633         {
634             return false;
635         }
636 
637         // Use strtol instead of stroi to avoid exceptions
638         long value = std::strtol(byte.c_str(), &endPtr, 10);
639 
640         // endPtr should point to the end of the string, otherwise given string
641         // is not 100% number
642         if (*endPtr != '\0')
643         {
644             return false;
645         }
646 
647         // Value should be contained in byte
648         if (value < 0 || value > 255)
649         {
650             return false;
651         }
652 
653         if (bits != nullptr)
654         {
655             // Mask has to be continuous between bytes
656             if (previousValue != 255 && value != 0)
657             {
658                 return false;
659             }
660 
661             // Mask has to be continuous inside bytes
662             firstZeroInByteHit = false;
663 
664             // Count bits
665             for (long bitIdx = 7; bitIdx >= 0; bitIdx--)
666             {
667                 if (value & (1L << bitIdx))
668                 {
669                     if (firstZeroInByteHit)
670                     {
671                         // Continuity not preserved
672                         return false;
673                     }
674                     (*bits)++;
675                 }
676                 else
677                 {
678                     firstZeroInByteHit = true;
679                 }
680             }
681         }
682 
683         previousValue = value;
684     }
685 
686     return true;
687 }
688 
689 /**
690  * @brief Deletes given IPv4 interface
691  *
692  * @param[in] ifaceId     Id of interface whose IP should be deleted
693  * @param[in] ipHash      DBus Hash id of IP that should be deleted
694  * @param[io] asyncResp   Response object that will be returned to client
695  *
696  * @return None
697  */
698 inline void deleteIPv4(const std::string& ifaceId, const std::string& ipHash,
699                        const std::shared_ptr<AsyncResp>& asyncResp)
700 {
701     crow::connections::systemBus->async_method_call(
702         [asyncResp](const boost::system::error_code ec) {
703             if (ec)
704             {
705                 messages::internalError(asyncResp->res);
706             }
707         },
708         "xyz.openbmc_project.Network",
709         "/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + ipHash,
710         "xyz.openbmc_project.Object.Delete", "Delete");
711 }
712 
713 /**
714  * @brief Creates a static IPv4 entry
715  *
716  * @param[in] ifaceId      Id of interface upon which to create the IPv4 entry
717  * @param[in] prefixLength IPv4 prefix syntax for the subnet mask
718  * @param[in] gateway      IPv4 address of this interfaces gateway
719  * @param[in] address      IPv4 address to assign to this interface
720  * @param[io] asyncResp    Response object that will be returned to client
721  *
722  * @return None
723  */
724 inline void createIPv4(const std::string& ifaceId, uint8_t prefixLength,
725                        const std::string& gateway, const std::string& address,
726                        const std::shared_ptr<AsyncResp>& asyncResp)
727 {
728     crow::connections::systemBus->async_method_call(
729         [asyncResp](const boost::system::error_code ec) {
730             if (ec)
731             {
732                 messages::internalError(asyncResp->res);
733             }
734         },
735         "xyz.openbmc_project.Network",
736         "/xyz/openbmc_project/network/" + ifaceId,
737         "xyz.openbmc_project.Network.IP.Create", "IP",
738         "xyz.openbmc_project.Network.IP.Protocol.IPv4", address, prefixLength,
739         gateway);
740 }
741 
742 /**
743  * @brief Deletes the IPv4 entry for this interface and creates a replacement
744  * static IPv4 entry
745  *
746  * @param[in] ifaceId      Id of interface upon which to create the IPv4 entry
747  * @param[in] id           The unique hash entry identifying the DBus entry
748  * @param[in] prefixLength IPv4 prefix syntax for the subnet mask
749  * @param[in] gateway      IPv4 address of this interfaces gateway
750  * @param[in] address      IPv4 address to assign to this interface
751  * @param[io] asyncResp    Response object that will be returned to client
752  *
753  * @return None
754  */
755 inline void deleteAndCreateIPv4(const std::string& ifaceId,
756                                 const std::string& id, uint8_t prefixLength,
757                                 const std::string& gateway,
758                                 const std::string& address,
759                                 const std::shared_ptr<AsyncResp>& asyncResp)
760 {
761     crow::connections::systemBus->async_method_call(
762         [asyncResp, ifaceId, address, prefixLength,
763          gateway](const boost::system::error_code ec) {
764             if (ec)
765             {
766                 messages::internalError(asyncResp->res);
767             }
768             crow::connections::systemBus->async_method_call(
769                 [asyncResp](const boost::system::error_code ec2) {
770                     if (ec2)
771                     {
772                         messages::internalError(asyncResp->res);
773                     }
774                 },
775                 "xyz.openbmc_project.Network",
776                 "/xyz/openbmc_project/network/" + ifaceId,
777                 "xyz.openbmc_project.Network.IP.Create", "IP",
778                 "xyz.openbmc_project.Network.IP.Protocol.IPv4", address,
779                 prefixLength, gateway);
780         },
781         "xyz.openbmc_project.Network",
782         +"/xyz/openbmc_project/network/" + ifaceId + "/ipv4/" + id,
783         "xyz.openbmc_project.Object.Delete", "Delete");
784 }
785 
786 /**
787  * @brief Deletes given IPv6
788  *
789  * @param[in] ifaceId     Id of interface whose IP should be deleted
790  * @param[in] ipHash      DBus Hash id of IP that should be deleted
791  * @param[io] asyncResp   Response object that will be returned to client
792  *
793  * @return None
794  */
795 inline void deleteIPv6(const std::string& ifaceId, const std::string& ipHash,
796                        const std::shared_ptr<AsyncResp>& asyncResp)
797 {
798     crow::connections::systemBus->async_method_call(
799         [asyncResp](const boost::system::error_code ec) {
800             if (ec)
801             {
802                 messages::internalError(asyncResp->res);
803             }
804         },
805         "xyz.openbmc_project.Network",
806         "/xyz/openbmc_project/network/" + ifaceId + "/ipv6/" + ipHash,
807         "xyz.openbmc_project.Object.Delete", "Delete");
808 }
809 
810 /**
811  * @brief Deletes the IPv6 entry for this interface and creates a replacement
812  * static IPv6 entry
813  *
814  * @param[in] ifaceId      Id of interface upon which to create the IPv6 entry
815  * @param[in] id           The unique hash entry identifying the DBus entry
816  * @param[in] prefixLength IPv6 prefix syntax for the subnet mask
817  * @param[in] address      IPv6 address to assign to this interface
818  * @param[io] asyncResp    Response object that will be returned to client
819  *
820  * @return None
821  */
822 inline void deleteAndCreateIPv6(const std::string& ifaceId,
823                                 const std::string& id, uint8_t prefixLength,
824                                 const std::string& address,
825                                 const std::shared_ptr<AsyncResp>& asyncResp)
826 {
827     crow::connections::systemBus->async_method_call(
828         [asyncResp, ifaceId, address,
829          prefixLength](const boost::system::error_code ec) {
830             if (ec)
831             {
832                 messages::internalError(asyncResp->res);
833             }
834             crow::connections::systemBus->async_method_call(
835                 [asyncResp](const boost::system::error_code ec2) {
836                     if (ec2)
837                     {
838                         messages::internalError(asyncResp->res);
839                     }
840                 },
841                 "xyz.openbmc_project.Network",
842                 "/xyz/openbmc_project/network/" + ifaceId,
843                 "xyz.openbmc_project.Network.IP.Create", "IP",
844                 "xyz.openbmc_project.Network.IP.Protocol.IPv6", address,
845                 prefixLength, "");
846         },
847         "xyz.openbmc_project.Network",
848         +"/xyz/openbmc_project/network/" + ifaceId + "/ipv6/" + id,
849         "xyz.openbmc_project.Object.Delete", "Delete");
850 }
851 
852 /**
853  * @brief Creates IPv6 with given data
854  *
855  * @param[in] ifaceId      Id of interface whose IP should be added
856  * @param[in] prefixLength Prefix length that needs to be added
857  * @param[in] address      IP address that needs to be added
858  * @param[io] asyncResp    Response object that will be returned to client
859  *
860  * @return None
861  */
862 inline void createIPv6(const std::string& ifaceId, uint8_t prefixLength,
863                        const std::string& address,
864                        const std::shared_ptr<AsyncResp>& asyncResp)
865 {
866     auto createIpHandler = [asyncResp](const boost::system::error_code ec) {
867         if (ec)
868         {
869             messages::internalError(asyncResp->res);
870         }
871     };
872     // Passing null for gateway, as per redfish spec IPv6StaticAddresses object
873     // does not have associated gateway property
874     crow::connections::systemBus->async_method_call(
875         std::move(createIpHandler), "xyz.openbmc_project.Network",
876         "/xyz/openbmc_project/network/" + ifaceId,
877         "xyz.openbmc_project.Network.IP.Create", "IP",
878         "xyz.openbmc_project.Network.IP.Protocol.IPv6", address, prefixLength,
879         "");
880 }
881 
882 /**
883  * Function that retrieves all properties for given Ethernet Interface
884  * Object
885  * from EntityManager Network Manager
886  * @param ethiface_id a eth interface id to query on DBus
887  * @param callback a function that shall be called to convert Dbus output
888  * into JSON
889  */
890 template <typename CallbackFunc>
891 void getEthernetIfaceData(const std::string& ethifaceId,
892                           CallbackFunc&& callback)
893 {
894     crow::connections::systemBus->async_method_call(
895         [ethifaceId{std::string{ethifaceId}}, callback{std::move(callback)}](
896             const boost::system::error_code errorCode,
897             GetManagedObjects& resp) {
898             EthernetInterfaceData ethData{};
899             boost::container::flat_set<IPv4AddressData> ipv4Data;
900             boost::container::flat_set<IPv6AddressData> ipv6Data;
901 
902             if (errorCode)
903             {
904                 callback(false, ethData, ipv4Data, ipv6Data);
905                 return;
906             }
907 
908             bool found =
909                 extractEthernetInterfaceData(ethifaceId, resp, ethData);
910             if (!found)
911             {
912                 callback(false, ethData, ipv4Data, ipv6Data);
913                 return;
914             }
915 
916             extractIPData(ethifaceId, resp, ipv4Data);
917             // Fix global GW
918             for (IPv4AddressData& ipv4 : ipv4Data)
919             {
920                 if (((ipv4.linktype == LinkType::Global) &&
921                      (ipv4.gateway == "0.0.0.0")) ||
922                     (ipv4.origin == "DHCP"))
923                 {
924                     ipv4.gateway = ethData.default_gateway;
925                 }
926             }
927 
928             extractIPV6Data(ethifaceId, resp, ipv6Data);
929             // Finally make a callback with useful data
930             callback(true, ethData, ipv4Data, ipv6Data);
931         },
932         "xyz.openbmc_project.Network", "/xyz/openbmc_project/network",
933         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
934 }
935 
936 /**
937  * Function that retrieves all Ethernet Interfaces available through Network
938  * Manager
939  * @param callback a function that shall be called to convert Dbus output
940  * into JSON.
941  */
942 template <typename CallbackFunc>
943 void getEthernetIfaceList(CallbackFunc&& callback)
944 {
945     crow::connections::systemBus->async_method_call(
946         [callback{std::move(callback)}](
947             const boost::system::error_code errorCode,
948             GetManagedObjects& resp) {
949             // Callback requires vector<string> to retrieve all available
950             // ethernet interfaces
951             boost::container::flat_set<std::string> ifaceList;
952             ifaceList.reserve(resp.size());
953             if (errorCode)
954             {
955                 callback(false, ifaceList);
956                 return;
957             }
958 
959             // Iterate over all retrieved ObjectPaths.
960             for (const auto& objpath : resp)
961             {
962                 // And all interfaces available for certain ObjectPath.
963                 for (const auto& interface : objpath.second)
964                 {
965                     // If interface is
966                     // xyz.openbmc_project.Network.EthernetInterface, this is
967                     // what we're looking for.
968                     if (interface.first ==
969                         "xyz.openbmc_project.Network.EthernetInterface")
970                     {
971                         std::string ifaceId = objpath.first.filename();
972                         if (ifaceId.empty())
973                         {
974                             continue;
975                         }
976                         // and put it into output vector.
977                         ifaceList.emplace(ifaceId);
978                     }
979                 }
980             }
981             // Finally make a callback with useful data
982             callback(true, ifaceList);
983         },
984         "xyz.openbmc_project.Network", "/xyz/openbmc_project/network",
985         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
986 }
987 
988 /**
989  * EthernetCollection derived class for delivering Ethernet Collection Schema
990  */
991 class EthernetCollection : public Node
992 {
993   public:
994     EthernetCollection(App& app) :
995         Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/")
996     {
997         entityPrivileges = {
998             {boost::beast::http::verb::get, {{"Login"}}},
999             {boost::beast::http::verb::head, {{"Login"}}},
1000             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
1001             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
1002             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
1003             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
1004     }
1005 
1006   private:
1007     /**
1008      * Functions triggers appropriate requests on DBus
1009      */
1010     void doGet(crow::Response& res, const crow::Request&,
1011                const std::vector<std::string>&) override
1012     {
1013         res.jsonValue["@odata.type"] =
1014             "#EthernetInterfaceCollection.EthernetInterfaceCollection";
1015         res.jsonValue["@odata.id"] =
1016             "/redfish/v1/Managers/bmc/EthernetInterfaces";
1017         res.jsonValue["Name"] = "Ethernet Network Interface Collection";
1018         res.jsonValue["Description"] =
1019             "Collection of EthernetInterfaces for this Manager";
1020         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1021         // Get eth interface list, and call the below callback for JSON
1022         // preparation
1023         getEthernetIfaceList(
1024             [asyncResp](
1025                 const bool& success,
1026                 const boost::container::flat_set<std::string>& ifaceList) {
1027                 if (!success)
1028                 {
1029                     messages::internalError(asyncResp->res);
1030                     return;
1031                 }
1032 
1033                 nlohmann::json& ifaceArray =
1034                     asyncResp->res.jsonValue["Members"];
1035                 ifaceArray = nlohmann::json::array();
1036                 std::string tag = "_";
1037                 for (const std::string& ifaceItem : ifaceList)
1038                 {
1039                     std::size_t found = ifaceItem.find(tag);
1040                     if (found == std::string::npos)
1041                     {
1042                         ifaceArray.push_back(
1043                             {{"@odata.id",
1044                               "/redfish/v1/Managers/bmc/EthernetInterfaces/" +
1045                                   ifaceItem}});
1046                     }
1047                 }
1048 
1049                 asyncResp->res.jsonValue["Members@odata.count"] =
1050                     ifaceArray.size();
1051                 asyncResp->res.jsonValue["@odata.id"] =
1052                     "/redfish/v1/Managers/bmc/EthernetInterfaces";
1053             });
1054     }
1055 };
1056 
1057 /**
1058  * EthernetInterface derived class for delivering Ethernet Schema
1059  */
1060 class EthernetInterface : public Node
1061 {
1062   public:
1063     /*
1064      * Default Constructor
1065      */
1066     EthernetInterface(App& app) :
1067         Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/",
1068              std::string())
1069     {
1070         entityPrivileges = {
1071             {boost::beast::http::verb::get, {{"Login"}}},
1072             {boost::beast::http::verb::head, {{"Login"}}},
1073             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
1074             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
1075             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
1076             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
1077     }
1078 
1079   private:
1080     void handleHostnamePatch(const std::string& hostname,
1081                              const std::shared_ptr<AsyncResp>& asyncResp)
1082     {
1083         // SHOULD handle host names of up to 255 characters(RFC 1123)
1084         if (hostname.length() > 255)
1085         {
1086             messages::propertyValueFormatError(asyncResp->res, hostname,
1087                                                "HostName");
1088             return;
1089         }
1090         crow::connections::systemBus->async_method_call(
1091             [asyncResp](const boost::system::error_code ec) {
1092                 if (ec)
1093                 {
1094                     messages::internalError(asyncResp->res);
1095                 }
1096             },
1097             "xyz.openbmc_project.Network",
1098             "/xyz/openbmc_project/network/config",
1099             "org.freedesktop.DBus.Properties", "Set",
1100             "xyz.openbmc_project.Network.SystemConfiguration", "HostName",
1101             std::variant<std::string>(hostname));
1102     }
1103 
1104     void handleDomainnamePatch(const std::string& ifaceId,
1105                                const std::string& domainname,
1106                                const std::shared_ptr<AsyncResp>& asyncResp)
1107     {
1108         std::vector<std::string> vectorDomainname = {domainname};
1109         crow::connections::systemBus->async_method_call(
1110             [asyncResp](const boost::system::error_code ec) {
1111                 if (ec)
1112                 {
1113                     messages::internalError(asyncResp->res);
1114                 }
1115             },
1116             "xyz.openbmc_project.Network",
1117             "/xyz/openbmc_project/network/" + ifaceId,
1118             "org.freedesktop.DBus.Properties", "Set",
1119             "xyz.openbmc_project.Network.EthernetInterface", "DomainName",
1120             std::variant<std::vector<std::string>>(vectorDomainname));
1121     }
1122 
1123     void handleFqdnPatch(const std::string& ifaceId, const std::string& fqdn,
1124                          const std::shared_ptr<AsyncResp>& asyncResp)
1125     {
1126         // Total length of FQDN must not exceed 255 characters(RFC 1035)
1127         if (fqdn.length() > 255)
1128         {
1129             messages::propertyValueFormatError(asyncResp->res, fqdn, "FQDN");
1130             return;
1131         }
1132 
1133         size_t pos = fqdn.find('.');
1134         if (pos == std::string::npos)
1135         {
1136             messages::propertyValueFormatError(asyncResp->res, fqdn, "FQDN");
1137             return;
1138         }
1139 
1140         std::string hostname;
1141         std::string domainname;
1142         domainname = (fqdn).substr(pos + 1);
1143         hostname = (fqdn).substr(0, pos);
1144 
1145         if (!isHostnameValid(hostname) || !isDomainnameValid(domainname))
1146         {
1147             messages::propertyValueFormatError(asyncResp->res, fqdn, "FQDN");
1148             return;
1149         }
1150 
1151         handleHostnamePatch(hostname, asyncResp);
1152         handleDomainnamePatch(ifaceId, domainname, asyncResp);
1153     }
1154 
1155     bool isHostnameValid(const std::string& hostname)
1156     {
1157         // A valid host name can never have the dotted-decimal form (RFC 1123)
1158         if (std::all_of(hostname.begin(), hostname.end(), ::isdigit))
1159         {
1160             return false;
1161         }
1162         // Each label(hostname/subdomains) within a valid FQDN
1163         // MUST handle host names of up to 63 characters (RFC 1123)
1164         // labels cannot start or end with hyphens (RFC 952)
1165         // labels can start with numbers (RFC 1123)
1166         const std::regex pattern(
1167             "^[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9]$");
1168 
1169         return std::regex_match(hostname, pattern);
1170     }
1171 
1172     bool isDomainnameValid(const std::string& domainname)
1173     {
1174         // Can have multiple subdomains
1175         // Top Level Domain's min length is 2 character
1176         const std::regex pattern("^([A-Za-z0-9][a-zA-Z0-9\\-]{1,61}|[a-zA-Z0-9]"
1177                                  "{1,30}\\.)*[a-zA-Z]{2,}$");
1178 
1179         return std::regex_match(domainname, pattern);
1180     }
1181 
1182     void handleMACAddressPatch(const std::string& ifaceId,
1183                                const std::string& macAddress,
1184                                const std::shared_ptr<AsyncResp>& asyncResp)
1185     {
1186         crow::connections::systemBus->async_method_call(
1187             [asyncResp, macAddress](const boost::system::error_code ec) {
1188                 if (ec)
1189                 {
1190                     messages::internalError(asyncResp->res);
1191                     return;
1192                 }
1193             },
1194             "xyz.openbmc_project.Network",
1195             "/xyz/openbmc_project/network/" + ifaceId,
1196             "org.freedesktop.DBus.Properties", "Set",
1197             "xyz.openbmc_project.Network.MACAddress", "MACAddress",
1198             std::variant<std::string>(macAddress));
1199     }
1200 
1201     void setDHCPEnabled(const std::string& ifaceId,
1202                         const std::string& propertyName, const bool v4Value,
1203                         const bool v6Value,
1204                         const std::shared_ptr<AsyncResp>& asyncResp)
1205     {
1206         const std::string dhcp = getDhcpEnabledEnumeration(v4Value, v6Value);
1207         crow::connections::systemBus->async_method_call(
1208             [asyncResp](const boost::system::error_code ec) {
1209                 if (ec)
1210                 {
1211                     BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
1212                     messages::internalError(asyncResp->res);
1213                     return;
1214                 }
1215                 messages::success(asyncResp->res);
1216             },
1217             "xyz.openbmc_project.Network",
1218             "/xyz/openbmc_project/network/" + ifaceId,
1219             "org.freedesktop.DBus.Properties", "Set",
1220             "xyz.openbmc_project.Network.EthernetInterface", propertyName,
1221             std::variant<std::string>{dhcp});
1222     }
1223 
1224     void setEthernetInterfaceBoolProperty(
1225         const std::string& ifaceId, const std::string& propertyName,
1226         const bool& value, const std::shared_ptr<AsyncResp>& asyncResp)
1227     {
1228         crow::connections::systemBus->async_method_call(
1229             [asyncResp](const boost::system::error_code ec) {
1230                 if (ec)
1231                 {
1232                     BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
1233                     messages::internalError(asyncResp->res);
1234                     return;
1235                 }
1236             },
1237             "xyz.openbmc_project.Network",
1238             "/xyz/openbmc_project/network/" + ifaceId,
1239             "org.freedesktop.DBus.Properties", "Set",
1240             "xyz.openbmc_project.Network.EthernetInterface", propertyName,
1241             std::variant<bool>{value});
1242     }
1243 
1244     void setDHCPv4Config(const std::string& propertyName, const bool& value,
1245                          const std::shared_ptr<AsyncResp>& asyncResp)
1246     {
1247         BMCWEB_LOG_DEBUG << propertyName << " = " << value;
1248         crow::connections::systemBus->async_method_call(
1249             [asyncResp](const boost::system::error_code ec) {
1250                 if (ec)
1251                 {
1252                     BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
1253                     messages::internalError(asyncResp->res);
1254                     return;
1255                 }
1256             },
1257             "xyz.openbmc_project.Network",
1258             "/xyz/openbmc_project/network/config/dhcp",
1259             "org.freedesktop.DBus.Properties", "Set",
1260             "xyz.openbmc_project.Network.DHCPConfiguration", propertyName,
1261             std::variant<bool>{value});
1262     }
1263 
1264     void handleDHCPPatch(const std::string& ifaceId,
1265                          const EthernetInterfaceData& ethData,
1266                          const DHCPParameters& v4dhcpParms,
1267                          const DHCPParameters& v6dhcpParms,
1268                          const std::shared_ptr<AsyncResp>& asyncResp)
1269     {
1270         bool ipv4Active = translateDHCPEnabledToBool(ethData.DHCPEnabled, true);
1271         bool ipv6Active =
1272             translateDHCPEnabledToBool(ethData.DHCPEnabled, false);
1273 
1274         bool nextv4DHCPState =
1275             v4dhcpParms.dhcpv4Enabled ? *v4dhcpParms.dhcpv4Enabled : ipv4Active;
1276 
1277         bool nextv6DHCPState{};
1278         if (v6dhcpParms.dhcpv6OperatingMode)
1279         {
1280             if ((*v6dhcpParms.dhcpv6OperatingMode != "Stateful") &&
1281                 (*v6dhcpParms.dhcpv6OperatingMode != "Stateless") &&
1282                 (*v6dhcpParms.dhcpv6OperatingMode != "Disabled"))
1283             {
1284                 messages::propertyValueFormatError(
1285                     asyncResp->res, *v6dhcpParms.dhcpv6OperatingMode,
1286                     "OperatingMode");
1287                 return;
1288             }
1289             nextv6DHCPState = (*v6dhcpParms.dhcpv6OperatingMode == "Stateful");
1290         }
1291         else
1292         {
1293             nextv6DHCPState = ipv6Active;
1294         }
1295 
1296         bool nextDNS{};
1297         if (v4dhcpParms.useDNSServers && v6dhcpParms.useDNSServers)
1298         {
1299             if (*v4dhcpParms.useDNSServers != *v6dhcpParms.useDNSServers)
1300             {
1301                 messages::generalError(asyncResp->res);
1302                 return;
1303             }
1304             nextDNS = *v4dhcpParms.useDNSServers;
1305         }
1306         else if (v4dhcpParms.useDNSServers)
1307         {
1308             nextDNS = *v4dhcpParms.useDNSServers;
1309         }
1310         else if (v6dhcpParms.useDNSServers)
1311         {
1312             nextDNS = *v6dhcpParms.useDNSServers;
1313         }
1314         else
1315         {
1316             nextDNS = ethData.DNSEnabled;
1317         }
1318 
1319         bool nextNTP{};
1320         if (v4dhcpParms.useNTPServers && v6dhcpParms.useNTPServers)
1321         {
1322             if (*v4dhcpParms.useNTPServers != *v6dhcpParms.useNTPServers)
1323             {
1324                 messages::generalError(asyncResp->res);
1325                 return;
1326             }
1327             nextNTP = *v4dhcpParms.useNTPServers;
1328         }
1329         else if (v4dhcpParms.useNTPServers)
1330         {
1331             nextNTP = *v4dhcpParms.useNTPServers;
1332         }
1333         else if (v6dhcpParms.useNTPServers)
1334         {
1335             nextNTP = *v6dhcpParms.useNTPServers;
1336         }
1337         else
1338         {
1339             nextNTP = ethData.NTPEnabled;
1340         }
1341 
1342         bool nextUseDomain{};
1343         if (v4dhcpParms.useUseDomainName && v6dhcpParms.useUseDomainName)
1344         {
1345             if (*v4dhcpParms.useUseDomainName != *v6dhcpParms.useUseDomainName)
1346             {
1347                 messages::generalError(asyncResp->res);
1348                 return;
1349             }
1350             nextUseDomain = *v4dhcpParms.useUseDomainName;
1351         }
1352         else if (v4dhcpParms.useUseDomainName)
1353         {
1354             nextUseDomain = *v4dhcpParms.useUseDomainName;
1355         }
1356         else if (v6dhcpParms.useUseDomainName)
1357         {
1358             nextUseDomain = *v6dhcpParms.useUseDomainName;
1359         }
1360         else
1361         {
1362             nextUseDomain = ethData.HostNameEnabled;
1363         }
1364 
1365         BMCWEB_LOG_DEBUG << "set DHCPEnabled...";
1366         setDHCPEnabled(ifaceId, "DHCPEnabled", nextv4DHCPState, nextv6DHCPState,
1367                        asyncResp);
1368         BMCWEB_LOG_DEBUG << "set DNSEnabled...";
1369         setDHCPv4Config("DNSEnabled", nextDNS, asyncResp);
1370         BMCWEB_LOG_DEBUG << "set NTPEnabled...";
1371         setDHCPv4Config("NTPEnabled", nextNTP, asyncResp);
1372         BMCWEB_LOG_DEBUG << "set HostNameEnabled...";
1373         setDHCPv4Config("HostNameEnabled", nextUseDomain, asyncResp);
1374     }
1375 
1376     boost::container::flat_set<IPv4AddressData>::const_iterator
1377         getNextStaticIpEntry(
1378             const boost::container::flat_set<IPv4AddressData>::const_iterator&
1379                 head,
1380             const boost::container::flat_set<IPv4AddressData>::const_iterator&
1381                 end)
1382     {
1383         return std::find_if(head, end, [](const IPv4AddressData& value) {
1384             return value.origin == "Static";
1385         });
1386     }
1387 
1388     boost::container::flat_set<IPv6AddressData>::const_iterator
1389         getNextStaticIpEntry(
1390             const boost::container::flat_set<IPv6AddressData>::const_iterator&
1391                 head,
1392             const boost::container::flat_set<IPv6AddressData>::const_iterator&
1393                 end)
1394     {
1395         return std::find_if(head, end, [](const IPv6AddressData& value) {
1396             return value.origin == "Static";
1397         });
1398     }
1399 
1400     void handleIPv4StaticPatch(
1401         const std::string& ifaceId, nlohmann::json& input,
1402         const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1403         const std::shared_ptr<AsyncResp>& asyncResp)
1404     {
1405         if ((!input.is_array()) || input.empty())
1406         {
1407             messages::propertyValueTypeError(
1408                 asyncResp->res,
1409                 input.dump(2, ' ', true,
1410                            nlohmann::json::error_handler_t::replace),
1411                 "IPv4StaticAddresses");
1412             return;
1413         }
1414 
1415         unsigned entryIdx = 1;
1416         // Find the first static IP address currently active on the NIC and
1417         // match it to the first JSON element in the IPv4StaticAddresses array.
1418         // Match each subsequent JSON element to the next static IP programmed
1419         // into the NIC.
1420         boost::container::flat_set<IPv4AddressData>::const_iterator niciPentry =
1421             getNextStaticIpEntry(ipv4Data.cbegin(), ipv4Data.cend());
1422 
1423         for (nlohmann::json& thisJson : input)
1424         {
1425             std::string pathString =
1426                 "IPv4StaticAddresses/" + std::to_string(entryIdx);
1427 
1428             if (!thisJson.is_null() && !thisJson.empty())
1429             {
1430                 std::optional<std::string> address;
1431                 std::optional<std::string> subnetMask;
1432                 std::optional<std::string> gateway;
1433 
1434                 if (!json_util::readJson(thisJson, asyncResp->res, "Address",
1435                                          address, "SubnetMask", subnetMask,
1436                                          "Gateway", gateway))
1437                 {
1438                     messages::propertyValueFormatError(
1439                         asyncResp->res,
1440                         thisJson.dump(2, ' ', true,
1441                                       nlohmann::json::error_handler_t::replace),
1442                         pathString);
1443                     return;
1444                 }
1445 
1446                 // Find the address/subnet/gateway values. Any values that are
1447                 // not explicitly provided are assumed to be unmodified from the
1448                 // current state of the interface. Merge existing state into the
1449                 // current request.
1450                 const std::string* addr = nullptr;
1451                 const std::string* gw = nullptr;
1452                 uint8_t prefixLength = 0;
1453                 bool errorInEntry = false;
1454                 if (address)
1455                 {
1456                     if (ipv4VerifyIpAndGetBitcount(*address))
1457                     {
1458                         addr = &(*address);
1459                     }
1460                     else
1461                     {
1462                         messages::propertyValueFormatError(
1463                             asyncResp->res, *address, pathString + "/Address");
1464                         errorInEntry = true;
1465                     }
1466                 }
1467                 else if (niciPentry != ipv4Data.cend())
1468                 {
1469                     addr = &(niciPentry->address);
1470                 }
1471                 else
1472                 {
1473                     messages::propertyMissing(asyncResp->res,
1474                                               pathString + "/Address");
1475                     errorInEntry = true;
1476                 }
1477 
1478                 if (subnetMask)
1479                 {
1480                     if (!ipv4VerifyIpAndGetBitcount(*subnetMask, &prefixLength))
1481                     {
1482                         messages::propertyValueFormatError(
1483                             asyncResp->res, *subnetMask,
1484                             pathString + "/SubnetMask");
1485                         errorInEntry = true;
1486                     }
1487                 }
1488                 else if (niciPentry != ipv4Data.cend())
1489                 {
1490                     if (!ipv4VerifyIpAndGetBitcount(niciPentry->netmask,
1491                                                     &prefixLength))
1492                     {
1493                         messages::propertyValueFormatError(
1494                             asyncResp->res, niciPentry->netmask,
1495                             pathString + "/SubnetMask");
1496                         errorInEntry = true;
1497                     }
1498                 }
1499                 else
1500                 {
1501                     messages::propertyMissing(asyncResp->res,
1502                                               pathString + "/SubnetMask");
1503                     errorInEntry = true;
1504                 }
1505 
1506                 if (gateway)
1507                 {
1508                     if (ipv4VerifyIpAndGetBitcount(*gateway))
1509                     {
1510                         gw = &(*gateway);
1511                     }
1512                     else
1513                     {
1514                         messages::propertyValueFormatError(
1515                             asyncResp->res, *gateway, pathString + "/Gateway");
1516                         errorInEntry = true;
1517                     }
1518                 }
1519                 else if (niciPentry != ipv4Data.cend())
1520                 {
1521                     gw = &niciPentry->gateway;
1522                 }
1523                 else
1524                 {
1525                     messages::propertyMissing(asyncResp->res,
1526                                               pathString + "/Gateway");
1527                     errorInEntry = true;
1528                 }
1529 
1530                 if (errorInEntry)
1531                 {
1532                     return;
1533                 }
1534 
1535                 if (niciPentry != ipv4Data.cend())
1536                 {
1537                     deleteAndCreateIPv4(ifaceId, niciPentry->id, prefixLength,
1538                                         *gw, *addr, asyncResp);
1539                     niciPentry =
1540                         getNextStaticIpEntry(++niciPentry, ipv4Data.cend());
1541                 }
1542                 else
1543                 {
1544                     createIPv4(ifaceId, prefixLength, *gateway, *address,
1545                                asyncResp);
1546                 }
1547                 entryIdx++;
1548             }
1549             else
1550             {
1551                 if (niciPentry == ipv4Data.cend())
1552                 {
1553                     // Requesting a DELETE/DO NOT MODIFY action for an item
1554                     // that isn't present on the eth(n) interface. Input JSON is
1555                     // in error, so bail out.
1556                     if (thisJson.is_null())
1557                     {
1558                         messages::resourceCannotBeDeleted(asyncResp->res);
1559                         return;
1560                     }
1561                     messages::propertyValueFormatError(
1562                         asyncResp->res,
1563                         thisJson.dump(2, ' ', true,
1564                                       nlohmann::json::error_handler_t::replace),
1565                         pathString);
1566                     return;
1567                 }
1568 
1569                 if (thisJson.is_null())
1570                 {
1571                     deleteIPv4(ifaceId, niciPentry->id, asyncResp);
1572                 }
1573                 if (niciPentry != ipv4Data.cend())
1574                 {
1575                     niciPentry =
1576                         getNextStaticIpEntry(++niciPentry, ipv4Data.cend());
1577                 }
1578                 entryIdx++;
1579             }
1580         }
1581     }
1582 
1583     void handleStaticNameServersPatch(
1584         const std::string& ifaceId,
1585         const std::vector<std::string>& updatedStaticNameServers,
1586         const std::shared_ptr<AsyncResp>& asyncResp)
1587     {
1588         crow::connections::systemBus->async_method_call(
1589             [asyncResp](const boost::system::error_code ec) {
1590                 if (ec)
1591                 {
1592                     messages::internalError(asyncResp->res);
1593                     return;
1594                 }
1595             },
1596             "xyz.openbmc_project.Network",
1597             "/xyz/openbmc_project/network/" + ifaceId,
1598             "org.freedesktop.DBus.Properties", "Set",
1599             "xyz.openbmc_project.Network.EthernetInterface",
1600             "StaticNameServers",
1601             std::variant<std::vector<std::string>>{updatedStaticNameServers});
1602     }
1603 
1604     void handleIPv6StaticAddressesPatch(
1605         const std::string& ifaceId, const nlohmann::json& input,
1606         const boost::container::flat_set<IPv6AddressData>& ipv6Data,
1607         const std::shared_ptr<AsyncResp>& asyncResp)
1608     {
1609         if (!input.is_array() || input.empty())
1610         {
1611             messages::propertyValueTypeError(
1612                 asyncResp->res,
1613                 input.dump(2, ' ', true,
1614                            nlohmann::json::error_handler_t::replace),
1615                 "IPv6StaticAddresses");
1616             return;
1617         }
1618         size_t entryIdx = 1;
1619         boost::container::flat_set<IPv6AddressData>::const_iterator niciPentry =
1620             getNextStaticIpEntry(ipv6Data.cbegin(), ipv6Data.cend());
1621         for (const nlohmann::json& thisJson : input)
1622         {
1623             std::string pathString =
1624                 "IPv6StaticAddresses/" + std::to_string(entryIdx);
1625 
1626             if (!thisJson.is_null() && !thisJson.empty())
1627             {
1628                 std::optional<std::string> address;
1629                 std::optional<uint8_t> prefixLength;
1630                 nlohmann::json thisJsonCopy = thisJson;
1631                 if (!json_util::readJson(thisJsonCopy, asyncResp->res,
1632                                          "Address", address, "PrefixLength",
1633                                          prefixLength))
1634                 {
1635                     messages::propertyValueFormatError(
1636                         asyncResp->res,
1637                         thisJson.dump(2, ' ', true,
1638                                       nlohmann::json::error_handler_t::replace),
1639                         pathString);
1640                     return;
1641                 }
1642 
1643                 const std::string* addr;
1644                 uint8_t prefix;
1645 
1646                 // Find the address and prefixLength values. Any values that are
1647                 // not explicitly provided are assumed to be unmodified from the
1648                 // current state of the interface. Merge existing state into the
1649                 // current request.
1650                 if (address)
1651                 {
1652                     addr = &(*address);
1653                 }
1654                 else if (niciPentry != ipv6Data.end())
1655                 {
1656                     addr = &(niciPentry->address);
1657                 }
1658                 else
1659                 {
1660                     messages::propertyMissing(asyncResp->res,
1661                                               pathString + "/Address");
1662                     return;
1663                 }
1664 
1665                 if (prefixLength)
1666                 {
1667                     prefix = *prefixLength;
1668                 }
1669                 else if (niciPentry != ipv6Data.end())
1670                 {
1671                     prefix = niciPentry->prefixLength;
1672                 }
1673                 else
1674                 {
1675                     messages::propertyMissing(asyncResp->res,
1676                                               pathString + "/PrefixLength");
1677                     return;
1678                 }
1679 
1680                 if (niciPentry != ipv6Data.end())
1681                 {
1682                     deleteAndCreateIPv6(ifaceId, niciPentry->id, prefix, *addr,
1683                                         asyncResp);
1684                     niciPentry =
1685                         getNextStaticIpEntry(++niciPentry, ipv6Data.cend());
1686                 }
1687                 else
1688                 {
1689                     createIPv6(ifaceId, *prefixLength, *addr, asyncResp);
1690                 }
1691                 entryIdx++;
1692             }
1693             else
1694             {
1695                 if (niciPentry == ipv6Data.end())
1696                 {
1697                     // Requesting a DELETE/DO NOT MODIFY action for an item
1698                     // that isn't present on the eth(n) interface. Input JSON is
1699                     // in error, so bail out.
1700                     if (thisJson.is_null())
1701                     {
1702                         messages::resourceCannotBeDeleted(asyncResp->res);
1703                         return;
1704                     }
1705                     messages::propertyValueFormatError(
1706                         asyncResp->res,
1707                         thisJson.dump(2, ' ', true,
1708                                       nlohmann::json::error_handler_t::replace),
1709                         pathString);
1710                     return;
1711                 }
1712 
1713                 if (thisJson.is_null())
1714                 {
1715                     deleteIPv6(ifaceId, niciPentry->id, asyncResp);
1716                 }
1717                 if (niciPentry != ipv6Data.cend())
1718                 {
1719                     niciPentry =
1720                         getNextStaticIpEntry(++niciPentry, ipv6Data.cend());
1721                 }
1722                 entryIdx++;
1723             }
1724         }
1725     }
1726 
1727     void parseInterfaceData(
1728         const std::shared_ptr<AsyncResp>& asyncResp, const std::string& ifaceId,
1729         const EthernetInterfaceData& ethData,
1730         const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1731         const boost::container::flat_set<IPv6AddressData>& ipv6Data)
1732     {
1733         constexpr const std::array<const char*, 1> inventoryForEthernet = {
1734             "xyz.openbmc_project.Inventory.Item.Ethernet"};
1735 
1736         nlohmann::json& jsonResponse = asyncResp->res.jsonValue;
1737         jsonResponse["Id"] = ifaceId;
1738         jsonResponse["@odata.id"] =
1739             "/redfish/v1/Managers/bmc/EthernetInterfaces/" + ifaceId;
1740         jsonResponse["InterfaceEnabled"] = ethData.nicEnabled;
1741 
1742         auto health = std::make_shared<HealthPopulate>(asyncResp);
1743 
1744         crow::connections::systemBus->async_method_call(
1745             [health](const boost::system::error_code ec,
1746                      std::vector<std::string>& resp) {
1747                 if (ec)
1748                 {
1749                     return;
1750                 }
1751 
1752                 health->inventory = std::move(resp);
1753             },
1754             "xyz.openbmc_project.ObjectMapper",
1755             "/xyz/openbmc_project/object_mapper",
1756             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/",
1757             int32_t(0), inventoryForEthernet);
1758 
1759         health->populate();
1760 
1761         if (ethData.nicEnabled)
1762         {
1763             jsonResponse["LinkStatus"] = "LinkUp";
1764             jsonResponse["Status"]["State"] = "Enabled";
1765         }
1766         else
1767         {
1768             jsonResponse["LinkStatus"] = "NoLink";
1769             jsonResponse["Status"]["State"] = "Disabled";
1770         }
1771 
1772         jsonResponse["LinkStatus"] = ethData.linkUp ? "LinkUp" : "LinkDown";
1773         jsonResponse["SpeedMbps"] = ethData.speed;
1774         jsonResponse["MACAddress"] = ethData.mac_address;
1775         jsonResponse["DHCPv4"]["DHCPEnabled"] =
1776             translateDHCPEnabledToBool(ethData.DHCPEnabled, true);
1777         jsonResponse["DHCPv4"]["UseNTPServers"] = ethData.NTPEnabled;
1778         jsonResponse["DHCPv4"]["UseDNSServers"] = ethData.DNSEnabled;
1779         jsonResponse["DHCPv4"]["UseDomainName"] = ethData.HostNameEnabled;
1780 
1781         jsonResponse["DHCPv6"]["OperatingMode"] =
1782             translateDHCPEnabledToBool(ethData.DHCPEnabled, false) ? "Stateful"
1783                                                                    : "Disabled";
1784         jsonResponse["DHCPv6"]["UseNTPServers"] = ethData.NTPEnabled;
1785         jsonResponse["DHCPv6"]["UseDNSServers"] = ethData.DNSEnabled;
1786         jsonResponse["DHCPv6"]["UseDomainName"] = ethData.HostNameEnabled;
1787 
1788         if (!ethData.hostname.empty())
1789         {
1790             jsonResponse["HostName"] = ethData.hostname;
1791 
1792             // When domain name is empty then it means, that it is a network
1793             // without domain names, and the host name itself must be treated as
1794             // FQDN
1795             std::string fqdn = ethData.hostname;
1796             if (!ethData.domainnames.empty())
1797             {
1798                 fqdn += "." + ethData.domainnames[0];
1799             }
1800             jsonResponse["FQDN"] = fqdn;
1801         }
1802 
1803         jsonResponse["VLANs"] = {
1804             {"@odata.id", "/redfish/v1/Managers/bmc/EthernetInterfaces/" +
1805                               ifaceId + "/VLANs"}};
1806 
1807         jsonResponse["NameServers"] = ethData.nameServers;
1808         jsonResponse["StaticNameServers"] = ethData.staticNameServers;
1809 
1810         nlohmann::json& ipv4Array = jsonResponse["IPv4Addresses"];
1811         nlohmann::json& ipv4StaticArray = jsonResponse["IPv4StaticAddresses"];
1812         ipv4Array = nlohmann::json::array();
1813         ipv4StaticArray = nlohmann::json::array();
1814         for (auto& ipv4Config : ipv4Data)
1815         {
1816 
1817             std::string gatewayStr = ipv4Config.gateway;
1818             if (gatewayStr.empty())
1819             {
1820                 gatewayStr = "0.0.0.0";
1821             }
1822 
1823             ipv4Array.push_back({{"AddressOrigin", ipv4Config.origin},
1824                                  {"SubnetMask", ipv4Config.netmask},
1825                                  {"Address", ipv4Config.address},
1826                                  {"Gateway", gatewayStr}});
1827             if (ipv4Config.origin == "Static")
1828             {
1829                 ipv4StaticArray.push_back({{"AddressOrigin", ipv4Config.origin},
1830                                            {"SubnetMask", ipv4Config.netmask},
1831                                            {"Address", ipv4Config.address},
1832                                            {"Gateway", gatewayStr}});
1833             }
1834         }
1835 
1836         std::string ipv6GatewayStr = ethData.ipv6_default_gateway;
1837         if (ipv6GatewayStr.empty())
1838         {
1839             ipv6GatewayStr = "0:0:0:0:0:0:0:0";
1840         }
1841 
1842         jsonResponse["IPv6DefaultGateway"] = ipv6GatewayStr;
1843 
1844         nlohmann::json& ipv6Array = jsonResponse["IPv6Addresses"];
1845         nlohmann::json& ipv6StaticArray = jsonResponse["IPv6StaticAddresses"];
1846         ipv6Array = nlohmann::json::array();
1847         ipv6StaticArray = nlohmann::json::array();
1848         nlohmann::json& ipv6AddrPolicyTable =
1849             jsonResponse["IPv6AddressPolicyTable"];
1850         ipv6AddrPolicyTable = nlohmann::json::array();
1851         for (auto& ipv6Config : ipv6Data)
1852         {
1853             ipv6Array.push_back({{"Address", ipv6Config.address},
1854                                  {"PrefixLength", ipv6Config.prefixLength},
1855                                  {"AddressOrigin", ipv6Config.origin},
1856                                  {"AddressState", nullptr}});
1857             if (ipv6Config.origin == "Static")
1858             {
1859                 ipv6StaticArray.push_back(
1860                     {{"Address", ipv6Config.address},
1861                      {"PrefixLength", ipv6Config.prefixLength},
1862                      {"AddressOrigin", ipv6Config.origin},
1863                      {"AddressState", nullptr}});
1864             }
1865         }
1866     }
1867 
1868     /**
1869      * Functions triggers appropriate requests on DBus
1870      */
1871     void doGet(crow::Response& res, const crow::Request&,
1872                const std::vector<std::string>& params) override
1873     {
1874         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1875         if (params.size() != 1)
1876         {
1877             messages::internalError(asyncResp->res);
1878             return;
1879         }
1880 
1881         getEthernetIfaceData(
1882             params[0],
1883             [this, asyncResp, ifaceId{std::string(params[0])}](
1884                 const bool& success, const EthernetInterfaceData& ethData,
1885                 const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1886                 const boost::container::flat_set<IPv6AddressData>& ipv6Data) {
1887                 if (!success)
1888                 {
1889                     // TODO(Pawel)consider distinguish between non existing
1890                     // object, and other errors
1891                     messages::resourceNotFound(asyncResp->res,
1892                                                "EthernetInterface", ifaceId);
1893                     return;
1894                 }
1895 
1896                 asyncResp->res.jsonValue["@odata.type"] =
1897                     "#EthernetInterface.v1_4_1.EthernetInterface";
1898                 asyncResp->res.jsonValue["Name"] = "Manager Ethernet Interface";
1899                 asyncResp->res.jsonValue["Description"] =
1900                     "Management Network Interface";
1901 
1902                 parseInterfaceData(asyncResp, ifaceId, ethData, ipv4Data,
1903                                    ipv6Data);
1904             });
1905     }
1906 
1907     void doPatch(crow::Response& res, const crow::Request& req,
1908                  const std::vector<std::string>& params) override
1909     {
1910         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1911         if (params.size() != 1)
1912         {
1913             messages::internalError(asyncResp->res);
1914             return;
1915         }
1916 
1917         const std::string& ifaceId = params[0];
1918 
1919         std::optional<std::string> hostname;
1920         std::optional<std::string> fqdn;
1921         std::optional<std::string> macAddress;
1922         std::optional<std::string> ipv6DefaultGateway;
1923         std::optional<nlohmann::json> ipv4StaticAddresses;
1924         std::optional<nlohmann::json> ipv6StaticAddresses;
1925         std::optional<std::vector<std::string>> staticNameServers;
1926         std::optional<nlohmann::json> dhcpv4;
1927         std::optional<nlohmann::json> dhcpv6;
1928         std::optional<bool> interfaceEnabled;
1929         DHCPParameters v4dhcpParms;
1930         DHCPParameters v6dhcpParms;
1931 
1932         if (!json_util::readJson(
1933                 req, res, "HostName", hostname, "FQDN", fqdn,
1934                 "IPv4StaticAddresses", ipv4StaticAddresses, "MACAddress",
1935                 macAddress, "StaticNameServers", staticNameServers,
1936                 "IPv6DefaultGateway", ipv6DefaultGateway, "IPv6StaticAddresses",
1937                 ipv6StaticAddresses, "DHCPv4", dhcpv4, "DHCPv6", dhcpv6,
1938                 "InterfaceEnabled", interfaceEnabled))
1939         {
1940             return;
1941         }
1942         if (dhcpv4)
1943         {
1944             if (!json_util::readJson(*dhcpv4, res, "DHCPEnabled",
1945                                      v4dhcpParms.dhcpv4Enabled, "UseDNSServers",
1946                                      v4dhcpParms.useDNSServers, "UseNTPServers",
1947                                      v4dhcpParms.useNTPServers, "UseDomainName",
1948                                      v4dhcpParms.useUseDomainName))
1949             {
1950                 return;
1951             }
1952         }
1953 
1954         if (dhcpv6)
1955         {
1956             if (!json_util::readJson(*dhcpv6, res, "OperatingMode",
1957                                      v6dhcpParms.dhcpv6OperatingMode,
1958                                      "UseDNSServers", v6dhcpParms.useDNSServers,
1959                                      "UseNTPServers", v6dhcpParms.useNTPServers,
1960                                      "UseDomainName",
1961                                      v6dhcpParms.useUseDomainName))
1962             {
1963                 return;
1964             }
1965         }
1966 
1967         // Get single eth interface data, and call the below callback for
1968         // JSON preparation
1969         getEthernetIfaceData(
1970             ifaceId,
1971             [this, asyncResp, ifaceId, hostname = std::move(hostname),
1972              fqdn = std::move(fqdn), macAddress = std::move(macAddress),
1973              ipv4StaticAddresses = std::move(ipv4StaticAddresses),
1974              ipv6DefaultGateway = std::move(ipv6DefaultGateway),
1975              ipv6StaticAddresses = std::move(ipv6StaticAddresses),
1976              staticNameServers = std::move(staticNameServers),
1977              dhcpv4 = std::move(dhcpv4), dhcpv6 = std::move(dhcpv6),
1978              v4dhcpParms = std::move(v4dhcpParms),
1979              v6dhcpParms = std::move(v6dhcpParms), interfaceEnabled](
1980                 const bool& success, const EthernetInterfaceData& ethData,
1981                 const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1982                 const boost::container::flat_set<IPv6AddressData>& ipv6Data) {
1983                 if (!success)
1984                 {
1985                     // ... otherwise return error
1986                     // TODO(Pawel)consider distinguish between non existing
1987                     // object, and other errors
1988                     messages::resourceNotFound(asyncResp->res,
1989                                                "Ethernet Interface", ifaceId);
1990                     return;
1991                 }
1992 
1993                 if (dhcpv4 || dhcpv6)
1994                 {
1995                     handleDHCPPatch(ifaceId, ethData, v4dhcpParms, v6dhcpParms,
1996                                     asyncResp);
1997                 }
1998 
1999                 if (hostname)
2000                 {
2001                     handleHostnamePatch(*hostname, asyncResp);
2002                 }
2003 
2004                 if (fqdn)
2005                 {
2006                     handleFqdnPatch(ifaceId, *fqdn, asyncResp);
2007                 }
2008 
2009                 if (macAddress)
2010                 {
2011                     handleMACAddressPatch(ifaceId, *macAddress, asyncResp);
2012                 }
2013 
2014                 if (ipv4StaticAddresses)
2015                 {
2016                     // TODO(ed) for some reason the capture of ipv4Addresses
2017                     // above is returning a const value, not a non-const
2018                     // value. This doesn't really work for us, as we need to
2019                     // be able to efficiently move out the intermedia
2020                     // nlohmann::json objects. This makes a copy of the
2021                     // structure, and operates on that, but could be done
2022                     // more efficiently
2023                     nlohmann::json ipv4Static = *ipv4StaticAddresses;
2024                     handleIPv4StaticPatch(ifaceId, ipv4Static, ipv4Data,
2025                                           asyncResp);
2026                 }
2027 
2028                 if (staticNameServers)
2029                 {
2030                     handleStaticNameServersPatch(ifaceId, *staticNameServers,
2031                                                  asyncResp);
2032                 }
2033 
2034                 if (ipv6DefaultGateway)
2035                 {
2036                     messages::propertyNotWritable(asyncResp->res,
2037                                                   "IPv6DefaultGateway");
2038                 }
2039 
2040                 if (ipv6StaticAddresses)
2041                 {
2042                     nlohmann::json ipv6Static = *ipv6StaticAddresses;
2043                     handleIPv6StaticAddressesPatch(ifaceId, ipv6Static,
2044                                                    ipv6Data, asyncResp);
2045                 }
2046 
2047                 if (interfaceEnabled)
2048                 {
2049                     setEthernetInterfaceBoolProperty(
2050                         ifaceId, "NICEnabled", *interfaceEnabled, asyncResp);
2051                 }
2052             });
2053     }
2054 };
2055 
2056 /**
2057  * VlanNetworkInterface derived class for delivering VLANNetworkInterface
2058  * Schema
2059  */
2060 class VlanNetworkInterface : public Node
2061 {
2062   public:
2063     /*
2064      * Default Constructor
2065      */
2066     VlanNetworkInterface(App& app) :
2067         Node(app,
2068              "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/<str>/",
2069              std::string(), std::string())
2070     {
2071         entityPrivileges = {
2072             {boost::beast::http::verb::get, {{"Login"}}},
2073             {boost::beast::http::verb::head, {{"Login"}}},
2074             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
2075             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
2076             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
2077             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2078     }
2079 
2080   private:
2081     void parseInterfaceData(nlohmann::json& jsonResponse,
2082                             const std::string& parentIfaceId,
2083                             const std::string& ifaceId,
2084                             const EthernetInterfaceData& ethData)
2085     {
2086         // Fill out obvious data...
2087         jsonResponse["Id"] = ifaceId;
2088         jsonResponse["@odata.id"] =
2089             "/redfish/v1/Managers/bmc/EthernetInterfaces/" + parentIfaceId +
2090             "/VLANs/" + ifaceId;
2091 
2092         jsonResponse["VLANEnable"] = true;
2093         if (!ethData.vlan_id.empty())
2094         {
2095             jsonResponse["VLANId"] = ethData.vlan_id.back();
2096         }
2097     }
2098 
2099     bool verifyNames(const std::string& parent, const std::string& iface)
2100     {
2101         if (!boost::starts_with(iface, parent + "_"))
2102         {
2103             return false;
2104         }
2105         return true;
2106     }
2107 
2108     /**
2109      * Functions triggers appropriate requests on DBus
2110      */
2111     void doGet(crow::Response& res, const crow::Request&,
2112                const std::vector<std::string>& params) override
2113     {
2114         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2115         // TODO(Pawel) this shall be parameterized call (two params) to get
2116         // EthernetInterfaces for any Manager, not only hardcoded 'openbmc'.
2117         // Check if there is required param, truly entering this shall be
2118         // impossible.
2119         if (params.size() != 2)
2120         {
2121             messages::internalError(res);
2122             res.end();
2123             return;
2124         }
2125 
2126         const std::string& parentIfaceId = params[0];
2127         const std::string& ifaceId = params[1];
2128         res.jsonValue["@odata.type"] =
2129             "#VLanNetworkInterface.v1_1_0.VLanNetworkInterface";
2130         res.jsonValue["Name"] = "VLAN Network Interface";
2131 
2132         if (!verifyNames(parentIfaceId, ifaceId))
2133         {
2134             return;
2135         }
2136 
2137         // Get single eth interface data, and call the below callback for
2138         // JSON preparation
2139         getEthernetIfaceData(
2140             params[1],
2141             [this, asyncResp, parentIfaceId{std::string(params[0])},
2142              ifaceId{std::string(params[1])}](
2143                 const bool& success, const EthernetInterfaceData& ethData,
2144                 const boost::container::flat_set<IPv4AddressData>&,
2145                 const boost::container::flat_set<IPv6AddressData>&) {
2146                 if (success && ethData.vlan_id.size() != 0)
2147                 {
2148                     parseInterfaceData(asyncResp->res.jsonValue, parentIfaceId,
2149                                        ifaceId, ethData);
2150                 }
2151                 else
2152                 {
2153                     // ... otherwise return error
2154                     // TODO(Pawel)consider distinguish between non existing
2155                     // object, and other errors
2156                     messages::resourceNotFound(
2157                         asyncResp->res, "VLAN Network Interface", ifaceId);
2158                 }
2159             });
2160     }
2161 
2162     void doPatch(crow::Response& res, const crow::Request& req,
2163                  const std::vector<std::string>& params) override
2164     {
2165         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2166         if (params.size() != 2)
2167         {
2168             messages::internalError(asyncResp->res);
2169             return;
2170         }
2171 
2172         const std::string& parentIfaceId = params[0];
2173         const std::string& ifaceId = params[1];
2174 
2175         if (!verifyNames(parentIfaceId, ifaceId))
2176         {
2177             messages::resourceNotFound(asyncResp->res, "VLAN Network Interface",
2178                                        ifaceId);
2179             return;
2180         }
2181 
2182         bool vlanEnable = false;
2183         uint32_t vlanId = 0;
2184 
2185         if (!json_util::readJson(req, res, "VLANEnable", vlanEnable, "VLANId",
2186                                  vlanId))
2187         {
2188             return;
2189         }
2190 
2191         // Get single eth interface data, and call the below callback for
2192         // JSON preparation
2193         getEthernetIfaceData(
2194             params[1],
2195             [asyncResp, parentIfaceId{std::string(params[0])},
2196              ifaceId{std::string(params[1])}, &vlanEnable,
2197              &vlanId](const bool& success, const EthernetInterfaceData& ethData,
2198                       const boost::container::flat_set<IPv4AddressData>&,
2199                       const boost::container::flat_set<IPv6AddressData>&) {
2200                 if (success && !ethData.vlan_id.empty())
2201                 {
2202                     auto callback =
2203                         [asyncResp](const boost::system::error_code ec) {
2204                             if (ec)
2205                             {
2206                                 messages::internalError(asyncResp->res);
2207                             }
2208                         };
2209 
2210                     if (vlanEnable == true)
2211                     {
2212                         crow::connections::systemBus->async_method_call(
2213                             std::move(callback), "xyz.openbmc_project.Network",
2214                             "/xyz/openbmc_project/network/" + ifaceId,
2215                             "org.freedesktop.DBus.Properties", "Set",
2216                             "xyz.openbmc_project.Network.VLAN", "Id",
2217                             std::variant<uint32_t>(vlanId));
2218                     }
2219                     else
2220                     {
2221                         BMCWEB_LOG_DEBUG << "vlanEnable is false. Deleting the "
2222                                             "vlan interface";
2223                         crow::connections::systemBus->async_method_call(
2224                             std::move(callback), "xyz.openbmc_project.Network",
2225                             std::string("/xyz/openbmc_project/network/") +
2226                                 ifaceId,
2227                             "xyz.openbmc_project.Object.Delete", "Delete");
2228                     }
2229                 }
2230                 else
2231                 {
2232                     // TODO(Pawel)consider distinguish between non existing
2233                     // object, and other errors
2234                     messages::resourceNotFound(
2235                         asyncResp->res, "VLAN Network Interface", ifaceId);
2236                     return;
2237                 }
2238             });
2239     }
2240 
2241     void doDelete(crow::Response& res, const crow::Request&,
2242                   const std::vector<std::string>& params) override
2243     {
2244         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2245         if (params.size() != 2)
2246         {
2247             messages::internalError(asyncResp->res);
2248             return;
2249         }
2250 
2251         const std::string& parentIfaceId = params[0];
2252         const std::string& ifaceId = params[1];
2253 
2254         if (!verifyNames(parentIfaceId, ifaceId))
2255         {
2256             messages::resourceNotFound(asyncResp->res, "VLAN Network Interface",
2257                                        ifaceId);
2258             return;
2259         }
2260 
2261         // Get single eth interface data, and call the below callback for
2262         // JSON preparation
2263         getEthernetIfaceData(
2264             params[1],
2265             [asyncResp, parentIfaceId{std::string(params[0])},
2266              ifaceId{std::string(params[1])}](
2267                 const bool& success, const EthernetInterfaceData& ethData,
2268                 const boost::container::flat_set<IPv4AddressData>&,
2269                 const boost::container::flat_set<IPv6AddressData>&) {
2270                 if (success && !ethData.vlan_id.empty())
2271                 {
2272                     auto callback =
2273                         [asyncResp](const boost::system::error_code ec) {
2274                             if (ec)
2275                             {
2276                                 messages::internalError(asyncResp->res);
2277                             }
2278                         };
2279                     crow::connections::systemBus->async_method_call(
2280                         std::move(callback), "xyz.openbmc_project.Network",
2281                         std::string("/xyz/openbmc_project/network/") + ifaceId,
2282                         "xyz.openbmc_project.Object.Delete", "Delete");
2283                 }
2284                 else
2285                 {
2286                     // ... otherwise return error
2287                     // TODO(Pawel)consider distinguish between non existing
2288                     // object, and other errors
2289                     messages::resourceNotFound(
2290                         asyncResp->res, "VLAN Network Interface", ifaceId);
2291                 }
2292             });
2293     }
2294 };
2295 
2296 /**
2297  * VlanNetworkInterfaceCollection derived class for delivering
2298  * VLANNetworkInterface Collection Schema
2299  */
2300 class VlanNetworkInterfaceCollection : public Node
2301 {
2302   public:
2303     VlanNetworkInterfaceCollection(App& app) :
2304         Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/",
2305              std::string())
2306     {
2307         entityPrivileges = {
2308             {boost::beast::http::verb::get, {{"Login"}}},
2309             {boost::beast::http::verb::head, {{"Login"}}},
2310             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
2311             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
2312             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
2313             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2314     }
2315 
2316   private:
2317     /**
2318      * Functions triggers appropriate requests on DBus
2319      */
2320     void doGet(crow::Response& res, const crow::Request&,
2321                const std::vector<std::string>& params) override
2322     {
2323         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2324         if (params.size() != 1)
2325         {
2326             // This means there is a problem with the router
2327             messages::internalError(asyncResp->res);
2328             return;
2329         }
2330 
2331         const std::string& rootInterfaceName = params[0];
2332 
2333         // Get eth interface list, and call the below callback for JSON
2334         // preparation
2335         getEthernetIfaceList(
2336             [asyncResp, rootInterfaceName{std::string(rootInterfaceName)}](
2337                 const bool& success,
2338                 const boost::container::flat_set<std::string>& ifaceList) {
2339                 if (!success)
2340                 {
2341                     messages::internalError(asyncResp->res);
2342                     return;
2343                 }
2344 
2345                 if (ifaceList.find(rootInterfaceName) == ifaceList.end())
2346                 {
2347                     messages::resourceNotFound(asyncResp->res,
2348                                                "VLanNetworkInterfaceCollection",
2349                                                rootInterfaceName);
2350                     return;
2351                 }
2352 
2353                 asyncResp->res.jsonValue["@odata.type"] =
2354                     "#VLanNetworkInterfaceCollection."
2355                     "VLanNetworkInterfaceCollection";
2356                 asyncResp->res.jsonValue["Name"] =
2357                     "VLAN Network Interface Collection";
2358 
2359                 nlohmann::json ifaceArray = nlohmann::json::array();
2360 
2361                 for (const std::string& ifaceItem : ifaceList)
2362                 {
2363                     if (boost::starts_with(ifaceItem, rootInterfaceName + "_"))
2364                     {
2365                         std::string path =
2366                             "/redfish/v1/Managers/bmc/EthernetInterfaces/";
2367                         path += rootInterfaceName;
2368                         path += "/VLANs/";
2369                         path += ifaceItem;
2370                         ifaceArray.push_back({{"@odata.id", std::move(path)}});
2371                     }
2372                 }
2373 
2374                 asyncResp->res.jsonValue["Members@odata.count"] =
2375                     ifaceArray.size();
2376                 asyncResp->res.jsonValue["Members"] = std::move(ifaceArray);
2377                 asyncResp->res.jsonValue["@odata.id"] =
2378                     "/redfish/v1/Managers/bmc/EthernetInterfaces/" +
2379                     rootInterfaceName + "/VLANs";
2380             });
2381     }
2382 
2383     void doPost(crow::Response& res, const crow::Request& req,
2384                 const std::vector<std::string>& params) override
2385     {
2386         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2387         if (params.size() != 1)
2388         {
2389             messages::internalError(asyncResp->res);
2390             return;
2391         }
2392         bool vlanEnable = false;
2393         uint32_t vlanId = 0;
2394         if (!json_util::readJson(req, res, "VLANId", vlanId, "VLANEnable",
2395                                  vlanEnable))
2396         {
2397             return;
2398         }
2399         // Need both vlanId and vlanEnable to service this request
2400         if (!vlanId)
2401         {
2402             messages::propertyMissing(asyncResp->res, "VLANId");
2403         }
2404         if (!vlanEnable)
2405         {
2406             messages::propertyMissing(asyncResp->res, "VLANEnable");
2407         }
2408         if (static_cast<bool>(vlanId) ^ vlanEnable)
2409         {
2410             return;
2411         }
2412 
2413         const std::string& rootInterfaceName = params[0];
2414         auto callback = [asyncResp](const boost::system::error_code ec) {
2415             if (ec)
2416             {
2417                 // TODO(ed) make more consistent error messages based on
2418                 // phosphor-network responses
2419                 messages::internalError(asyncResp->res);
2420                 return;
2421             }
2422             messages::created(asyncResp->res);
2423         };
2424         crow::connections::systemBus->async_method_call(
2425             std::move(callback), "xyz.openbmc_project.Network",
2426             "/xyz/openbmc_project/network",
2427             "xyz.openbmc_project.Network.VLAN.Create", "VLAN",
2428             rootInterfaceName, vlanId);
2429     }
2430 };
2431 } // namespace redfish
2432