xref: /openbmc/bmcweb/features/redfish/lib/ethernet.hpp (revision 7ea79e5e15814eb8566f3e6799f2d7eee23527a6) 
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             },
1216             "xyz.openbmc_project.Network",
1217             "/xyz/openbmc_project/network/" + ifaceId,
1218             "org.freedesktop.DBus.Properties", "Set",
1219             "xyz.openbmc_project.Network.EthernetInterface", propertyName,
1220             std::variant<std::string>{dhcp});
1221     }
1222 
1223     void setEthernetInterfaceBoolProperty(
1224         const std::string& ifaceId, const std::string& propertyName,
1225         const bool& value, const std::shared_ptr<AsyncResp>& asyncResp)
1226     {
1227         crow::connections::systemBus->async_method_call(
1228             [asyncResp](const boost::system::error_code ec) {
1229                 if (ec)
1230                 {
1231                     BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
1232                     messages::internalError(asyncResp->res);
1233                     return;
1234                 }
1235             },
1236             "xyz.openbmc_project.Network",
1237             "/xyz/openbmc_project/network/" + ifaceId,
1238             "org.freedesktop.DBus.Properties", "Set",
1239             "xyz.openbmc_project.Network.EthernetInterface", propertyName,
1240             std::variant<bool>{value});
1241     }
1242 
1243     void setDHCPv4Config(const std::string& propertyName, const bool& value,
1244                          const std::shared_ptr<AsyncResp>& asyncResp)
1245     {
1246         BMCWEB_LOG_DEBUG << propertyName << " = " << value;
1247         crow::connections::systemBus->async_method_call(
1248             [asyncResp](const boost::system::error_code ec) {
1249                 if (ec)
1250                 {
1251                     BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
1252                     messages::internalError(asyncResp->res);
1253                     return;
1254                 }
1255             },
1256             "xyz.openbmc_project.Network",
1257             "/xyz/openbmc_project/network/config/dhcp",
1258             "org.freedesktop.DBus.Properties", "Set",
1259             "xyz.openbmc_project.Network.DHCPConfiguration", propertyName,
1260             std::variant<bool>{value});
1261     }
1262 
1263     void handleDHCPPatch(const std::string& ifaceId,
1264                          const EthernetInterfaceData& ethData,
1265                          const DHCPParameters& v4dhcpParms,
1266                          const DHCPParameters& v6dhcpParms,
1267                          const std::shared_ptr<AsyncResp>& asyncResp)
1268     {
1269         bool ipv4Active = translateDHCPEnabledToBool(ethData.DHCPEnabled, true);
1270         bool ipv6Active =
1271             translateDHCPEnabledToBool(ethData.DHCPEnabled, false);
1272 
1273         bool nextv4DHCPState =
1274             v4dhcpParms.dhcpv4Enabled ? *v4dhcpParms.dhcpv4Enabled : ipv4Active;
1275 
1276         bool nextv6DHCPState{};
1277         if (v6dhcpParms.dhcpv6OperatingMode)
1278         {
1279             if ((*v6dhcpParms.dhcpv6OperatingMode != "Stateful") &&
1280                 (*v6dhcpParms.dhcpv6OperatingMode != "Stateless") &&
1281                 (*v6dhcpParms.dhcpv6OperatingMode != "Disabled"))
1282             {
1283                 messages::propertyValueFormatError(
1284                     asyncResp->res, *v6dhcpParms.dhcpv6OperatingMode,
1285                     "OperatingMode");
1286                 return;
1287             }
1288             nextv6DHCPState = (*v6dhcpParms.dhcpv6OperatingMode == "Stateful");
1289         }
1290         else
1291         {
1292             nextv6DHCPState = ipv6Active;
1293         }
1294 
1295         bool nextDNS{};
1296         if (v4dhcpParms.useDNSServers && v6dhcpParms.useDNSServers)
1297         {
1298             if (*v4dhcpParms.useDNSServers != *v6dhcpParms.useDNSServers)
1299             {
1300                 messages::generalError(asyncResp->res);
1301                 return;
1302             }
1303             nextDNS = *v4dhcpParms.useDNSServers;
1304         }
1305         else if (v4dhcpParms.useDNSServers)
1306         {
1307             nextDNS = *v4dhcpParms.useDNSServers;
1308         }
1309         else if (v6dhcpParms.useDNSServers)
1310         {
1311             nextDNS = *v6dhcpParms.useDNSServers;
1312         }
1313         else
1314         {
1315             nextDNS = ethData.DNSEnabled;
1316         }
1317 
1318         bool nextNTP{};
1319         if (v4dhcpParms.useNTPServers && v6dhcpParms.useNTPServers)
1320         {
1321             if (*v4dhcpParms.useNTPServers != *v6dhcpParms.useNTPServers)
1322             {
1323                 messages::generalError(asyncResp->res);
1324                 return;
1325             }
1326             nextNTP = *v4dhcpParms.useNTPServers;
1327         }
1328         else if (v4dhcpParms.useNTPServers)
1329         {
1330             nextNTP = *v4dhcpParms.useNTPServers;
1331         }
1332         else if (v6dhcpParms.useNTPServers)
1333         {
1334             nextNTP = *v6dhcpParms.useNTPServers;
1335         }
1336         else
1337         {
1338             nextNTP = ethData.NTPEnabled;
1339         }
1340 
1341         bool nextUseDomain{};
1342         if (v4dhcpParms.useUseDomainName && v6dhcpParms.useUseDomainName)
1343         {
1344             if (*v4dhcpParms.useUseDomainName != *v6dhcpParms.useUseDomainName)
1345             {
1346                 messages::generalError(asyncResp->res);
1347                 return;
1348             }
1349             nextUseDomain = *v4dhcpParms.useUseDomainName;
1350         }
1351         else if (v4dhcpParms.useUseDomainName)
1352         {
1353             nextUseDomain = *v4dhcpParms.useUseDomainName;
1354         }
1355         else if (v6dhcpParms.useUseDomainName)
1356         {
1357             nextUseDomain = *v6dhcpParms.useUseDomainName;
1358         }
1359         else
1360         {
1361             nextUseDomain = ethData.HostNameEnabled;
1362         }
1363 
1364         BMCWEB_LOG_DEBUG << "set DHCPEnabled...";
1365         setDHCPEnabled(ifaceId, "DHCPEnabled", nextv4DHCPState, nextv6DHCPState,
1366                        asyncResp);
1367         BMCWEB_LOG_DEBUG << "set DNSEnabled...";
1368         setDHCPv4Config("DNSEnabled", nextDNS, asyncResp);
1369         BMCWEB_LOG_DEBUG << "set NTPEnabled...";
1370         setDHCPv4Config("NTPEnabled", nextNTP, asyncResp);
1371         BMCWEB_LOG_DEBUG << "set HostNameEnabled...";
1372         setDHCPv4Config("HostNameEnabled", nextUseDomain, asyncResp);
1373     }
1374 
1375     boost::container::flat_set<IPv4AddressData>::const_iterator
1376         getNextStaticIpEntry(
1377             const boost::container::flat_set<IPv4AddressData>::const_iterator&
1378                 head,
1379             const boost::container::flat_set<IPv4AddressData>::const_iterator&
1380                 end)
1381     {
1382         return std::find_if(head, end, [](const IPv4AddressData& value) {
1383             return value.origin == "Static";
1384         });
1385     }
1386 
1387     boost::container::flat_set<IPv6AddressData>::const_iterator
1388         getNextStaticIpEntry(
1389             const boost::container::flat_set<IPv6AddressData>::const_iterator&
1390                 head,
1391             const boost::container::flat_set<IPv6AddressData>::const_iterator&
1392                 end)
1393     {
1394         return std::find_if(head, end, [](const IPv6AddressData& value) {
1395             return value.origin == "Static";
1396         });
1397     }
1398 
1399     void handleIPv4StaticPatch(
1400         const std::string& ifaceId, nlohmann::json& input,
1401         const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1402         const std::shared_ptr<AsyncResp>& asyncResp)
1403     {
1404         if ((!input.is_array()) || input.empty())
1405         {
1406             messages::propertyValueTypeError(
1407                 asyncResp->res,
1408                 input.dump(2, ' ', true,
1409                            nlohmann::json::error_handler_t::replace),
1410                 "IPv4StaticAddresses");
1411             return;
1412         }
1413 
1414         unsigned entryIdx = 1;
1415         // Find the first static IP address currently active on the NIC and
1416         // match it to the first JSON element in the IPv4StaticAddresses array.
1417         // Match each subsequent JSON element to the next static IP programmed
1418         // into the NIC.
1419         boost::container::flat_set<IPv4AddressData>::const_iterator niciPentry =
1420             getNextStaticIpEntry(ipv4Data.cbegin(), ipv4Data.cend());
1421 
1422         for (nlohmann::json& thisJson : input)
1423         {
1424             std::string pathString =
1425                 "IPv4StaticAddresses/" + std::to_string(entryIdx);
1426 
1427             if (!thisJson.is_null() && !thisJson.empty())
1428             {
1429                 std::optional<std::string> address;
1430                 std::optional<std::string> subnetMask;
1431                 std::optional<std::string> gateway;
1432 
1433                 if (!json_util::readJson(thisJson, asyncResp->res, "Address",
1434                                          address, "SubnetMask", subnetMask,
1435                                          "Gateway", gateway))
1436                 {
1437                     messages::propertyValueFormatError(
1438                         asyncResp->res,
1439                         thisJson.dump(2, ' ', true,
1440                                       nlohmann::json::error_handler_t::replace),
1441                         pathString);
1442                     return;
1443                 }
1444 
1445                 // Find the address/subnet/gateway values. Any values that are
1446                 // not explicitly provided are assumed to be unmodified from the
1447                 // current state of the interface. Merge existing state into the
1448                 // current request.
1449                 const std::string* addr = nullptr;
1450                 const std::string* gw = nullptr;
1451                 uint8_t prefixLength = 0;
1452                 bool errorInEntry = false;
1453                 if (address)
1454                 {
1455                     if (ipv4VerifyIpAndGetBitcount(*address))
1456                     {
1457                         addr = &(*address);
1458                     }
1459                     else
1460                     {
1461                         messages::propertyValueFormatError(
1462                             asyncResp->res, *address, pathString + "/Address");
1463                         errorInEntry = true;
1464                     }
1465                 }
1466                 else if (niciPentry != ipv4Data.cend())
1467                 {
1468                     addr = &(niciPentry->address);
1469                 }
1470                 else
1471                 {
1472                     messages::propertyMissing(asyncResp->res,
1473                                               pathString + "/Address");
1474                     errorInEntry = true;
1475                 }
1476 
1477                 if (subnetMask)
1478                 {
1479                     if (!ipv4VerifyIpAndGetBitcount(*subnetMask, &prefixLength))
1480                     {
1481                         messages::propertyValueFormatError(
1482                             asyncResp->res, *subnetMask,
1483                             pathString + "/SubnetMask");
1484                         errorInEntry = true;
1485                     }
1486                 }
1487                 else if (niciPentry != ipv4Data.cend())
1488                 {
1489                     if (!ipv4VerifyIpAndGetBitcount(niciPentry->netmask,
1490                                                     &prefixLength))
1491                     {
1492                         messages::propertyValueFormatError(
1493                             asyncResp->res, niciPentry->netmask,
1494                             pathString + "/SubnetMask");
1495                         errorInEntry = true;
1496                     }
1497                 }
1498                 else
1499                 {
1500                     messages::propertyMissing(asyncResp->res,
1501                                               pathString + "/SubnetMask");
1502                     errorInEntry = true;
1503                 }
1504 
1505                 if (gateway)
1506                 {
1507                     if (ipv4VerifyIpAndGetBitcount(*gateway))
1508                     {
1509                         gw = &(*gateway);
1510                     }
1511                     else
1512                     {
1513                         messages::propertyValueFormatError(
1514                             asyncResp->res, *gateway, pathString + "/Gateway");
1515                         errorInEntry = true;
1516                     }
1517                 }
1518                 else if (niciPentry != ipv4Data.cend())
1519                 {
1520                     gw = &niciPentry->gateway;
1521                 }
1522                 else
1523                 {
1524                     messages::propertyMissing(asyncResp->res,
1525                                               pathString + "/Gateway");
1526                     errorInEntry = true;
1527                 }
1528 
1529                 if (errorInEntry)
1530                 {
1531                     return;
1532                 }
1533 
1534                 if (niciPentry != ipv4Data.cend())
1535                 {
1536                     deleteAndCreateIPv4(ifaceId, niciPentry->id, prefixLength,
1537                                         *gw, *addr, asyncResp);
1538                     niciPentry =
1539                         getNextStaticIpEntry(++niciPentry, ipv4Data.cend());
1540                 }
1541                 else
1542                 {
1543                     createIPv4(ifaceId, prefixLength, *gateway, *address,
1544                                asyncResp);
1545                 }
1546                 entryIdx++;
1547             }
1548             else
1549             {
1550                 if (niciPentry == ipv4Data.cend())
1551                 {
1552                     // Requesting a DELETE/DO NOT MODIFY action for an item
1553                     // that isn't present on the eth(n) interface. Input JSON is
1554                     // in error, so bail out.
1555                     if (thisJson.is_null())
1556                     {
1557                         messages::resourceCannotBeDeleted(asyncResp->res);
1558                         return;
1559                     }
1560                     messages::propertyValueFormatError(
1561                         asyncResp->res,
1562                         thisJson.dump(2, ' ', true,
1563                                       nlohmann::json::error_handler_t::replace),
1564                         pathString);
1565                     return;
1566                 }
1567 
1568                 if (thisJson.is_null())
1569                 {
1570                     deleteIPv4(ifaceId, niciPentry->id, asyncResp);
1571                 }
1572                 if (niciPentry != ipv4Data.cend())
1573                 {
1574                     niciPentry =
1575                         getNextStaticIpEntry(++niciPentry, ipv4Data.cend());
1576                 }
1577                 entryIdx++;
1578             }
1579         }
1580     }
1581 
1582     void handleStaticNameServersPatch(
1583         const std::string& ifaceId,
1584         const std::vector<std::string>& updatedStaticNameServers,
1585         const std::shared_ptr<AsyncResp>& asyncResp)
1586     {
1587         crow::connections::systemBus->async_method_call(
1588             [asyncResp](const boost::system::error_code ec) {
1589                 if (ec)
1590                 {
1591                     messages::internalError(asyncResp->res);
1592                     return;
1593                 }
1594             },
1595             "xyz.openbmc_project.Network",
1596             "/xyz/openbmc_project/network/" + ifaceId,
1597             "org.freedesktop.DBus.Properties", "Set",
1598             "xyz.openbmc_project.Network.EthernetInterface",
1599             "StaticNameServers",
1600             std::variant<std::vector<std::string>>{updatedStaticNameServers});
1601     }
1602 
1603     void handleIPv6StaticAddressesPatch(
1604         const std::string& ifaceId, const nlohmann::json& input,
1605         const boost::container::flat_set<IPv6AddressData>& ipv6Data,
1606         const std::shared_ptr<AsyncResp>& asyncResp)
1607     {
1608         if (!input.is_array() || input.empty())
1609         {
1610             messages::propertyValueTypeError(
1611                 asyncResp->res,
1612                 input.dump(2, ' ', true,
1613                            nlohmann::json::error_handler_t::replace),
1614                 "IPv6StaticAddresses");
1615             return;
1616         }
1617         size_t entryIdx = 1;
1618         boost::container::flat_set<IPv6AddressData>::const_iterator niciPentry =
1619             getNextStaticIpEntry(ipv6Data.cbegin(), ipv6Data.cend());
1620         for (const nlohmann::json& thisJson : input)
1621         {
1622             std::string pathString =
1623                 "IPv6StaticAddresses/" + std::to_string(entryIdx);
1624 
1625             if (!thisJson.is_null() && !thisJson.empty())
1626             {
1627                 std::optional<std::string> address;
1628                 std::optional<uint8_t> prefixLength;
1629                 nlohmann::json thisJsonCopy = thisJson;
1630                 if (!json_util::readJson(thisJsonCopy, asyncResp->res,
1631                                          "Address", address, "PrefixLength",
1632                                          prefixLength))
1633                 {
1634                     messages::propertyValueFormatError(
1635                         asyncResp->res,
1636                         thisJson.dump(2, ' ', true,
1637                                       nlohmann::json::error_handler_t::replace),
1638                         pathString);
1639                     return;
1640                 }
1641 
1642                 const std::string* addr;
1643                 uint8_t prefix;
1644 
1645                 // Find the address and prefixLength values. Any values that are
1646                 // not explicitly provided are assumed to be unmodified from the
1647                 // current state of the interface. Merge existing state into the
1648                 // current request.
1649                 if (address)
1650                 {
1651                     addr = &(*address);
1652                 }
1653                 else if (niciPentry != ipv6Data.end())
1654                 {
1655                     addr = &(niciPentry->address);
1656                 }
1657                 else
1658                 {
1659                     messages::propertyMissing(asyncResp->res,
1660                                               pathString + "/Address");
1661                     return;
1662                 }
1663 
1664                 if (prefixLength)
1665                 {
1666                     prefix = *prefixLength;
1667                 }
1668                 else if (niciPentry != ipv6Data.end())
1669                 {
1670                     prefix = niciPentry->prefixLength;
1671                 }
1672                 else
1673                 {
1674                     messages::propertyMissing(asyncResp->res,
1675                                               pathString + "/PrefixLength");
1676                     return;
1677                 }
1678 
1679                 if (niciPentry != ipv6Data.end())
1680                 {
1681                     deleteAndCreateIPv6(ifaceId, niciPentry->id, prefix, *addr,
1682                                         asyncResp);
1683                     niciPentry =
1684                         getNextStaticIpEntry(++niciPentry, ipv6Data.cend());
1685                 }
1686                 else
1687                 {
1688                     createIPv6(ifaceId, *prefixLength, *addr, asyncResp);
1689                 }
1690                 entryIdx++;
1691             }
1692             else
1693             {
1694                 if (niciPentry == ipv6Data.end())
1695                 {
1696                     // Requesting a DELETE/DO NOT MODIFY action for an item
1697                     // that isn't present on the eth(n) interface. Input JSON is
1698                     // in error, so bail out.
1699                     if (thisJson.is_null())
1700                     {
1701                         messages::resourceCannotBeDeleted(asyncResp->res);
1702                         return;
1703                     }
1704                     messages::propertyValueFormatError(
1705                         asyncResp->res,
1706                         thisJson.dump(2, ' ', true,
1707                                       nlohmann::json::error_handler_t::replace),
1708                         pathString);
1709                     return;
1710                 }
1711 
1712                 if (thisJson.is_null())
1713                 {
1714                     deleteIPv6(ifaceId, niciPentry->id, asyncResp);
1715                 }
1716                 if (niciPentry != ipv6Data.cend())
1717                 {
1718                     niciPentry =
1719                         getNextStaticIpEntry(++niciPentry, ipv6Data.cend());
1720                 }
1721                 entryIdx++;
1722             }
1723         }
1724     }
1725 
1726     void parseInterfaceData(
1727         const std::shared_ptr<AsyncResp>& asyncResp, const std::string& ifaceId,
1728         const EthernetInterfaceData& ethData,
1729         const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1730         const boost::container::flat_set<IPv6AddressData>& ipv6Data)
1731     {
1732         constexpr const std::array<const char*, 1> inventoryForEthernet = {
1733             "xyz.openbmc_project.Inventory.Item.Ethernet"};
1734 
1735         nlohmann::json& jsonResponse = asyncResp->res.jsonValue;
1736         jsonResponse["Id"] = ifaceId;
1737         jsonResponse["@odata.id"] =
1738             "/redfish/v1/Managers/bmc/EthernetInterfaces/" + ifaceId;
1739         jsonResponse["InterfaceEnabled"] = ethData.nicEnabled;
1740 
1741         auto health = std::make_shared<HealthPopulate>(asyncResp);
1742 
1743         crow::connections::systemBus->async_method_call(
1744             [health](const boost::system::error_code ec,
1745                      std::vector<std::string>& resp) {
1746                 if (ec)
1747                 {
1748                     return;
1749                 }
1750 
1751                 health->inventory = std::move(resp);
1752             },
1753             "xyz.openbmc_project.ObjectMapper",
1754             "/xyz/openbmc_project/object_mapper",
1755             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/",
1756             int32_t(0), inventoryForEthernet);
1757 
1758         health->populate();
1759 
1760         if (ethData.nicEnabled)
1761         {
1762             jsonResponse["LinkStatus"] = "LinkUp";
1763             jsonResponse["Status"]["State"] = "Enabled";
1764         }
1765         else
1766         {
1767             jsonResponse["LinkStatus"] = "NoLink";
1768             jsonResponse["Status"]["State"] = "Disabled";
1769         }
1770 
1771         jsonResponse["LinkStatus"] = ethData.linkUp ? "LinkUp" : "LinkDown";
1772         jsonResponse["SpeedMbps"] = ethData.speed;
1773         jsonResponse["MACAddress"] = ethData.mac_address;
1774         jsonResponse["DHCPv4"]["DHCPEnabled"] =
1775             translateDHCPEnabledToBool(ethData.DHCPEnabled, true);
1776         jsonResponse["DHCPv4"]["UseNTPServers"] = ethData.NTPEnabled;
1777         jsonResponse["DHCPv4"]["UseDNSServers"] = ethData.DNSEnabled;
1778         jsonResponse["DHCPv4"]["UseDomainName"] = ethData.HostNameEnabled;
1779 
1780         jsonResponse["DHCPv6"]["OperatingMode"] =
1781             translateDHCPEnabledToBool(ethData.DHCPEnabled, false) ? "Stateful"
1782                                                                    : "Disabled";
1783         jsonResponse["DHCPv6"]["UseNTPServers"] = ethData.NTPEnabled;
1784         jsonResponse["DHCPv6"]["UseDNSServers"] = ethData.DNSEnabled;
1785         jsonResponse["DHCPv6"]["UseDomainName"] = ethData.HostNameEnabled;
1786 
1787         if (!ethData.hostname.empty())
1788         {
1789             jsonResponse["HostName"] = ethData.hostname;
1790 
1791             // When domain name is empty then it means, that it is a network
1792             // without domain names, and the host name itself must be treated as
1793             // FQDN
1794             std::string fqdn = ethData.hostname;
1795             if (!ethData.domainnames.empty())
1796             {
1797                 fqdn += "." + ethData.domainnames[0];
1798             }
1799             jsonResponse["FQDN"] = fqdn;
1800         }
1801 
1802         jsonResponse["VLANs"] = {
1803             {"@odata.id", "/redfish/v1/Managers/bmc/EthernetInterfaces/" +
1804                               ifaceId + "/VLANs"}};
1805 
1806         jsonResponse["NameServers"] = ethData.nameServers;
1807         jsonResponse["StaticNameServers"] = ethData.staticNameServers;
1808 
1809         nlohmann::json& ipv4Array = jsonResponse["IPv4Addresses"];
1810         nlohmann::json& ipv4StaticArray = jsonResponse["IPv4StaticAddresses"];
1811         ipv4Array = nlohmann::json::array();
1812         ipv4StaticArray = nlohmann::json::array();
1813         for (auto& ipv4Config : ipv4Data)
1814         {
1815 
1816             std::string gatewayStr = ipv4Config.gateway;
1817             if (gatewayStr.empty())
1818             {
1819                 gatewayStr = "0.0.0.0";
1820             }
1821 
1822             ipv4Array.push_back({{"AddressOrigin", ipv4Config.origin},
1823                                  {"SubnetMask", ipv4Config.netmask},
1824                                  {"Address", ipv4Config.address},
1825                                  {"Gateway", gatewayStr}});
1826             if (ipv4Config.origin == "Static")
1827             {
1828                 ipv4StaticArray.push_back({{"AddressOrigin", ipv4Config.origin},
1829                                            {"SubnetMask", ipv4Config.netmask},
1830                                            {"Address", ipv4Config.address},
1831                                            {"Gateway", gatewayStr}});
1832             }
1833         }
1834 
1835         std::string ipv6GatewayStr = ethData.ipv6_default_gateway;
1836         if (ipv6GatewayStr.empty())
1837         {
1838             ipv6GatewayStr = "0:0:0:0:0:0:0:0";
1839         }
1840 
1841         jsonResponse["IPv6DefaultGateway"] = ipv6GatewayStr;
1842 
1843         nlohmann::json& ipv6Array = jsonResponse["IPv6Addresses"];
1844         nlohmann::json& ipv6StaticArray = jsonResponse["IPv6StaticAddresses"];
1845         ipv6Array = nlohmann::json::array();
1846         ipv6StaticArray = nlohmann::json::array();
1847         nlohmann::json& ipv6AddrPolicyTable =
1848             jsonResponse["IPv6AddressPolicyTable"];
1849         ipv6AddrPolicyTable = nlohmann::json::array();
1850         for (auto& ipv6Config : ipv6Data)
1851         {
1852             ipv6Array.push_back({{"Address", ipv6Config.address},
1853                                  {"PrefixLength", ipv6Config.prefixLength},
1854                                  {"AddressOrigin", ipv6Config.origin},
1855                                  {"AddressState", nullptr}});
1856             if (ipv6Config.origin == "Static")
1857             {
1858                 ipv6StaticArray.push_back(
1859                     {{"Address", ipv6Config.address},
1860                      {"PrefixLength", ipv6Config.prefixLength},
1861                      {"AddressOrigin", ipv6Config.origin},
1862                      {"AddressState", nullptr}});
1863             }
1864         }
1865     }
1866 
1867     /**
1868      * Functions triggers appropriate requests on DBus
1869      */
1870     void doGet(crow::Response& res, const crow::Request&,
1871                const std::vector<std::string>& params) override
1872     {
1873         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1874         if (params.size() != 1)
1875         {
1876             messages::internalError(asyncResp->res);
1877             return;
1878         }
1879 
1880         getEthernetIfaceData(
1881             params[0],
1882             [this, asyncResp, ifaceId{std::string(params[0])}](
1883                 const bool& success, const EthernetInterfaceData& ethData,
1884                 const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1885                 const boost::container::flat_set<IPv6AddressData>& ipv6Data) {
1886                 if (!success)
1887                 {
1888                     // TODO(Pawel)consider distinguish between non existing
1889                     // object, and other errors
1890                     messages::resourceNotFound(asyncResp->res,
1891                                                "EthernetInterface", ifaceId);
1892                     return;
1893                 }
1894 
1895                 asyncResp->res.jsonValue["@odata.type"] =
1896                     "#EthernetInterface.v1_4_1.EthernetInterface";
1897                 asyncResp->res.jsonValue["Name"] = "Manager Ethernet Interface";
1898                 asyncResp->res.jsonValue["Description"] =
1899                     "Management Network Interface";
1900 
1901                 parseInterfaceData(asyncResp, ifaceId, ethData, ipv4Data,
1902                                    ipv6Data);
1903             });
1904     }
1905 
1906     void doPatch(crow::Response& res, const crow::Request& req,
1907                  const std::vector<std::string>& params) override
1908     {
1909         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1910         if (params.size() != 1)
1911         {
1912             messages::internalError(asyncResp->res);
1913             return;
1914         }
1915 
1916         const std::string& ifaceId = params[0];
1917 
1918         std::optional<std::string> hostname;
1919         std::optional<std::string> fqdn;
1920         std::optional<std::string> macAddress;
1921         std::optional<std::string> ipv6DefaultGateway;
1922         std::optional<nlohmann::json> ipv4StaticAddresses;
1923         std::optional<nlohmann::json> ipv6StaticAddresses;
1924         std::optional<std::vector<std::string>> staticNameServers;
1925         std::optional<nlohmann::json> dhcpv4;
1926         std::optional<nlohmann::json> dhcpv6;
1927         std::optional<bool> interfaceEnabled;
1928         DHCPParameters v4dhcpParms;
1929         DHCPParameters v6dhcpParms;
1930 
1931         if (!json_util::readJson(
1932                 req, res, "HostName", hostname, "FQDN", fqdn,
1933                 "IPv4StaticAddresses", ipv4StaticAddresses, "MACAddress",
1934                 macAddress, "StaticNameServers", staticNameServers,
1935                 "IPv6DefaultGateway", ipv6DefaultGateway, "IPv6StaticAddresses",
1936                 ipv6StaticAddresses, "DHCPv4", dhcpv4, "DHCPv6", dhcpv6,
1937                 "InterfaceEnabled", interfaceEnabled))
1938         {
1939             return;
1940         }
1941         if (dhcpv4)
1942         {
1943             if (!json_util::readJson(*dhcpv4, res, "DHCPEnabled",
1944                                      v4dhcpParms.dhcpv4Enabled, "UseDNSServers",
1945                                      v4dhcpParms.useDNSServers, "UseNTPServers",
1946                                      v4dhcpParms.useNTPServers, "UseDomainName",
1947                                      v4dhcpParms.useUseDomainName))
1948             {
1949                 return;
1950             }
1951         }
1952 
1953         if (dhcpv6)
1954         {
1955             if (!json_util::readJson(*dhcpv6, res, "OperatingMode",
1956                                      v6dhcpParms.dhcpv6OperatingMode,
1957                                      "UseDNSServers", v6dhcpParms.useDNSServers,
1958                                      "UseNTPServers", v6dhcpParms.useNTPServers,
1959                                      "UseDomainName",
1960                                      v6dhcpParms.useUseDomainName))
1961             {
1962                 return;
1963             }
1964         }
1965 
1966         // Get single eth interface data, and call the below callback for
1967         // JSON preparation
1968         getEthernetIfaceData(
1969             ifaceId,
1970             [this, asyncResp, ifaceId, hostname = std::move(hostname),
1971              fqdn = std::move(fqdn), macAddress = std::move(macAddress),
1972              ipv4StaticAddresses = std::move(ipv4StaticAddresses),
1973              ipv6DefaultGateway = std::move(ipv6DefaultGateway),
1974              ipv6StaticAddresses = std::move(ipv6StaticAddresses),
1975              staticNameServers = std::move(staticNameServers),
1976              dhcpv4 = std::move(dhcpv4), dhcpv6 = std::move(dhcpv6),
1977              v4dhcpParms = std::move(v4dhcpParms),
1978              v6dhcpParms = std::move(v6dhcpParms), interfaceEnabled](
1979                 const bool& success, const EthernetInterfaceData& ethData,
1980                 const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1981                 const boost::container::flat_set<IPv6AddressData>& ipv6Data) {
1982                 if (!success)
1983                 {
1984                     // ... otherwise return error
1985                     // TODO(Pawel)consider distinguish between non existing
1986                     // object, and other errors
1987                     messages::resourceNotFound(asyncResp->res,
1988                                                "Ethernet Interface", ifaceId);
1989                     return;
1990                 }
1991 
1992                 if (dhcpv4 || dhcpv6)
1993                 {
1994                     handleDHCPPatch(ifaceId, ethData, v4dhcpParms, v6dhcpParms,
1995                                     asyncResp);
1996                 }
1997 
1998                 if (hostname)
1999                 {
2000                     handleHostnamePatch(*hostname, asyncResp);
2001                 }
2002 
2003                 if (fqdn)
2004                 {
2005                     handleFqdnPatch(ifaceId, *fqdn, asyncResp);
2006                 }
2007 
2008                 if (macAddress)
2009                 {
2010                     handleMACAddressPatch(ifaceId, *macAddress, asyncResp);
2011                 }
2012 
2013                 if (ipv4StaticAddresses)
2014                 {
2015                     // TODO(ed) for some reason the capture of ipv4Addresses
2016                     // above is returning a const value, not a non-const
2017                     // value. This doesn't really work for us, as we need to
2018                     // be able to efficiently move out the intermedia
2019                     // nlohmann::json objects. This makes a copy of the
2020                     // structure, and operates on that, but could be done
2021                     // more efficiently
2022                     nlohmann::json ipv4Static = *ipv4StaticAddresses;
2023                     handleIPv4StaticPatch(ifaceId, ipv4Static, ipv4Data,
2024                                           asyncResp);
2025                 }
2026 
2027                 if (staticNameServers)
2028                 {
2029                     handleStaticNameServersPatch(ifaceId, *staticNameServers,
2030                                                  asyncResp);
2031                 }
2032 
2033                 if (ipv6DefaultGateway)
2034                 {
2035                     messages::propertyNotWritable(asyncResp->res,
2036                                                   "IPv6DefaultGateway");
2037                 }
2038 
2039                 if (ipv6StaticAddresses)
2040                 {
2041                     nlohmann::json ipv6Static = *ipv6StaticAddresses;
2042                     handleIPv6StaticAddressesPatch(ifaceId, ipv6Static,
2043                                                    ipv6Data, asyncResp);
2044                 }
2045 
2046                 if (interfaceEnabled)
2047                 {
2048                     setEthernetInterfaceBoolProperty(
2049                         ifaceId, "NICEnabled", *interfaceEnabled, asyncResp);
2050                 }
2051             });
2052     }
2053 };
2054 
2055 /**
2056  * VlanNetworkInterface derived class for delivering VLANNetworkInterface
2057  * Schema
2058  */
2059 class VlanNetworkInterface : public Node
2060 {
2061   public:
2062     /*
2063      * Default Constructor
2064      */
2065     VlanNetworkInterface(App& app) :
2066         Node(app,
2067              "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/<str>/",
2068              std::string(), std::string())
2069     {
2070         entityPrivileges = {
2071             {boost::beast::http::verb::get, {{"Login"}}},
2072             {boost::beast::http::verb::head, {{"Login"}}},
2073             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
2074             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
2075             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
2076             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2077     }
2078 
2079   private:
2080     void parseInterfaceData(nlohmann::json& jsonResponse,
2081                             const std::string& parentIfaceId,
2082                             const std::string& ifaceId,
2083                             const EthernetInterfaceData& ethData)
2084     {
2085         // Fill out obvious data...
2086         jsonResponse["Id"] = ifaceId;
2087         jsonResponse["@odata.id"] =
2088             "/redfish/v1/Managers/bmc/EthernetInterfaces/" + parentIfaceId +
2089             "/VLANs/" + ifaceId;
2090 
2091         jsonResponse["VLANEnable"] = true;
2092         if (!ethData.vlan_id.empty())
2093         {
2094             jsonResponse["VLANId"] = ethData.vlan_id.back();
2095         }
2096     }
2097 
2098     bool verifyNames(const std::string& parent, const std::string& iface)
2099     {
2100         if (!boost::starts_with(iface, parent + "_"))
2101         {
2102             return false;
2103         }
2104         return true;
2105     }
2106 
2107     /**
2108      * Functions triggers appropriate requests on DBus
2109      */
2110     void doGet(crow::Response& res, const crow::Request&,
2111                const std::vector<std::string>& params) override
2112     {
2113         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2114         // TODO(Pawel) this shall be parameterized call (two params) to get
2115         // EthernetInterfaces for any Manager, not only hardcoded 'openbmc'.
2116         // Check if there is required param, truly entering this shall be
2117         // impossible.
2118         if (params.size() != 2)
2119         {
2120             messages::internalError(res);
2121             res.end();
2122             return;
2123         }
2124 
2125         const std::string& parentIfaceId = params[0];
2126         const std::string& ifaceId = params[1];
2127         res.jsonValue["@odata.type"] =
2128             "#VLanNetworkInterface.v1_1_0.VLanNetworkInterface";
2129         res.jsonValue["Name"] = "VLAN Network Interface";
2130 
2131         if (!verifyNames(parentIfaceId, ifaceId))
2132         {
2133             return;
2134         }
2135 
2136         // Get single eth interface data, and call the below callback for
2137         // JSON preparation
2138         getEthernetIfaceData(
2139             params[1],
2140             [this, asyncResp, parentIfaceId{std::string(params[0])},
2141              ifaceId{std::string(params[1])}](
2142                 const bool& success, const EthernetInterfaceData& ethData,
2143                 const boost::container::flat_set<IPv4AddressData>&,
2144                 const boost::container::flat_set<IPv6AddressData>&) {
2145                 if (success && ethData.vlan_id.size() != 0)
2146                 {
2147                     parseInterfaceData(asyncResp->res.jsonValue, parentIfaceId,
2148                                        ifaceId, ethData);
2149                 }
2150                 else
2151                 {
2152                     // ... otherwise return error
2153                     // TODO(Pawel)consider distinguish between non existing
2154                     // object, and other errors
2155                     messages::resourceNotFound(
2156                         asyncResp->res, "VLAN Network Interface", ifaceId);
2157                 }
2158             });
2159     }
2160 
2161     void doPatch(crow::Response& res, const crow::Request& req,
2162                  const std::vector<std::string>& params) override
2163     {
2164         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2165         if (params.size() != 2)
2166         {
2167             messages::internalError(asyncResp->res);
2168             return;
2169         }
2170 
2171         const std::string& parentIfaceId = params[0];
2172         const std::string& ifaceId = params[1];
2173 
2174         if (!verifyNames(parentIfaceId, ifaceId))
2175         {
2176             messages::resourceNotFound(asyncResp->res, "VLAN Network Interface",
2177                                        ifaceId);
2178             return;
2179         }
2180 
2181         bool vlanEnable = false;
2182         uint32_t vlanId = 0;
2183 
2184         if (!json_util::readJson(req, res, "VLANEnable", vlanEnable, "VLANId",
2185                                  vlanId))
2186         {
2187             return;
2188         }
2189 
2190         // Get single eth interface data, and call the below callback for
2191         // JSON preparation
2192         getEthernetIfaceData(
2193             params[1],
2194             [asyncResp, parentIfaceId{std::string(params[0])},
2195              ifaceId{std::string(params[1])}, &vlanEnable,
2196              &vlanId](const bool& success, const EthernetInterfaceData& ethData,
2197                       const boost::container::flat_set<IPv4AddressData>&,
2198                       const boost::container::flat_set<IPv6AddressData>&) {
2199                 if (success && !ethData.vlan_id.empty())
2200                 {
2201                     auto callback =
2202                         [asyncResp](const boost::system::error_code ec) {
2203                             if (ec)
2204                             {
2205                                 messages::internalError(asyncResp->res);
2206                             }
2207                         };
2208 
2209                     if (vlanEnable == true)
2210                     {
2211                         crow::connections::systemBus->async_method_call(
2212                             std::move(callback), "xyz.openbmc_project.Network",
2213                             "/xyz/openbmc_project/network/" + ifaceId,
2214                             "org.freedesktop.DBus.Properties", "Set",
2215                             "xyz.openbmc_project.Network.VLAN", "Id",
2216                             std::variant<uint32_t>(vlanId));
2217                     }
2218                     else
2219                     {
2220                         BMCWEB_LOG_DEBUG << "vlanEnable is false. Deleting the "
2221                                             "vlan interface";
2222                         crow::connections::systemBus->async_method_call(
2223                             std::move(callback), "xyz.openbmc_project.Network",
2224                             std::string("/xyz/openbmc_project/network/") +
2225                                 ifaceId,
2226                             "xyz.openbmc_project.Object.Delete", "Delete");
2227                     }
2228                 }
2229                 else
2230                 {
2231                     // TODO(Pawel)consider distinguish between non existing
2232                     // object, and other errors
2233                     messages::resourceNotFound(
2234                         asyncResp->res, "VLAN Network Interface", ifaceId);
2235                     return;
2236                 }
2237             });
2238     }
2239 
2240     void doDelete(crow::Response& res, const crow::Request&,
2241                   const std::vector<std::string>& params) override
2242     {
2243         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2244         if (params.size() != 2)
2245         {
2246             messages::internalError(asyncResp->res);
2247             return;
2248         }
2249 
2250         const std::string& parentIfaceId = params[0];
2251         const std::string& ifaceId = params[1];
2252 
2253         if (!verifyNames(parentIfaceId, ifaceId))
2254         {
2255             messages::resourceNotFound(asyncResp->res, "VLAN Network Interface",
2256                                        ifaceId);
2257             return;
2258         }
2259 
2260         // Get single eth interface data, and call the below callback for
2261         // JSON preparation
2262         getEthernetIfaceData(
2263             params[1],
2264             [asyncResp, parentIfaceId{std::string(params[0])},
2265              ifaceId{std::string(params[1])}](
2266                 const bool& success, const EthernetInterfaceData& ethData,
2267                 const boost::container::flat_set<IPv4AddressData>&,
2268                 const boost::container::flat_set<IPv6AddressData>&) {
2269                 if (success && !ethData.vlan_id.empty())
2270                 {
2271                     auto callback =
2272                         [asyncResp](const boost::system::error_code ec) {
2273                             if (ec)
2274                             {
2275                                 messages::internalError(asyncResp->res);
2276                             }
2277                         };
2278                     crow::connections::systemBus->async_method_call(
2279                         std::move(callback), "xyz.openbmc_project.Network",
2280                         std::string("/xyz/openbmc_project/network/") + ifaceId,
2281                         "xyz.openbmc_project.Object.Delete", "Delete");
2282                 }
2283                 else
2284                 {
2285                     // ... otherwise return error
2286                     // TODO(Pawel)consider distinguish between non existing
2287                     // object, and other errors
2288                     messages::resourceNotFound(
2289                         asyncResp->res, "VLAN Network Interface", ifaceId);
2290                 }
2291             });
2292     }
2293 };
2294 
2295 /**
2296  * VlanNetworkInterfaceCollection derived class for delivering
2297  * VLANNetworkInterface Collection Schema
2298  */
2299 class VlanNetworkInterfaceCollection : public Node
2300 {
2301   public:
2302     VlanNetworkInterfaceCollection(App& app) :
2303         Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/",
2304              std::string())
2305     {
2306         entityPrivileges = {
2307             {boost::beast::http::verb::get, {{"Login"}}},
2308             {boost::beast::http::verb::head, {{"Login"}}},
2309             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
2310             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
2311             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
2312             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2313     }
2314 
2315   private:
2316     /**
2317      * Functions triggers appropriate requests on DBus
2318      */
2319     void doGet(crow::Response& res, const crow::Request&,
2320                const std::vector<std::string>& params) override
2321     {
2322         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2323         if (params.size() != 1)
2324         {
2325             // This means there is a problem with the router
2326             messages::internalError(asyncResp->res);
2327             return;
2328         }
2329 
2330         const std::string& rootInterfaceName = params[0];
2331 
2332         // Get eth interface list, and call the below callback for JSON
2333         // preparation
2334         getEthernetIfaceList(
2335             [asyncResp, rootInterfaceName{std::string(rootInterfaceName)}](
2336                 const bool& success,
2337                 const boost::container::flat_set<std::string>& ifaceList) {
2338                 if (!success)
2339                 {
2340                     messages::internalError(asyncResp->res);
2341                     return;
2342                 }
2343 
2344                 if (ifaceList.find(rootInterfaceName) == ifaceList.end())
2345                 {
2346                     messages::resourceNotFound(asyncResp->res,
2347                                                "VLanNetworkInterfaceCollection",
2348                                                rootInterfaceName);
2349                     return;
2350                 }
2351 
2352                 asyncResp->res.jsonValue["@odata.type"] =
2353                     "#VLanNetworkInterfaceCollection."
2354                     "VLanNetworkInterfaceCollection";
2355                 asyncResp->res.jsonValue["Name"] =
2356                     "VLAN Network Interface Collection";
2357 
2358                 nlohmann::json ifaceArray = nlohmann::json::array();
2359 
2360                 for (const std::string& ifaceItem : ifaceList)
2361                 {
2362                     if (boost::starts_with(ifaceItem, rootInterfaceName + "_"))
2363                     {
2364                         std::string path =
2365                             "/redfish/v1/Managers/bmc/EthernetInterfaces/";
2366                         path += rootInterfaceName;
2367                         path += "/VLANs/";
2368                         path += ifaceItem;
2369                         ifaceArray.push_back({{"@odata.id", std::move(path)}});
2370                     }
2371                 }
2372 
2373                 asyncResp->res.jsonValue["Members@odata.count"] =
2374                     ifaceArray.size();
2375                 asyncResp->res.jsonValue["Members"] = std::move(ifaceArray);
2376                 asyncResp->res.jsonValue["@odata.id"] =
2377                     "/redfish/v1/Managers/bmc/EthernetInterfaces/" +
2378                     rootInterfaceName + "/VLANs";
2379             });
2380     }
2381 
2382     void doPost(crow::Response& res, const crow::Request& req,
2383                 const std::vector<std::string>& params) override
2384     {
2385         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2386         if (params.size() != 1)
2387         {
2388             messages::internalError(asyncResp->res);
2389             return;
2390         }
2391         bool vlanEnable = false;
2392         uint32_t vlanId = 0;
2393         if (!json_util::readJson(req, res, "VLANId", vlanId, "VLANEnable",
2394                                  vlanEnable))
2395         {
2396             return;
2397         }
2398         // Need both vlanId and vlanEnable to service this request
2399         if (!vlanId)
2400         {
2401             messages::propertyMissing(asyncResp->res, "VLANId");
2402         }
2403         if (!vlanEnable)
2404         {
2405             messages::propertyMissing(asyncResp->res, "VLANEnable");
2406         }
2407         if (static_cast<bool>(vlanId) ^ vlanEnable)
2408         {
2409             return;
2410         }
2411 
2412         const std::string& rootInterfaceName = params[0];
2413         auto callback = [asyncResp](const boost::system::error_code ec) {
2414             if (ec)
2415             {
2416                 // TODO(ed) make more consistent error messages based on
2417                 // phosphor-network responses
2418                 messages::internalError(asyncResp->res);
2419                 return;
2420             }
2421             messages::created(asyncResp->res);
2422         };
2423         crow::connections::systemBus->async_method_call(
2424             std::move(callback), "xyz.openbmc_project.Network",
2425             "/xyz/openbmc_project/network",
2426             "xyz.openbmc_project.Network.VLAN.Create", "VLAN",
2427             rootInterfaceName, vlanId);
2428     }
2429 };
2430 } // namespace redfish
2431