xref: /openbmc/bmcweb/redfish-core/lib/ethernet.hpp (revision a1ffbb84cf0f7f75ccb84fa6e0752b645b81ebdf) 
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& ethiface_id,
204                                          GetManagedObjects& dbus_data,
205                                          EthernetInterfaceData& ethData)
206 {
207     bool idFound = false;
208     for (auto& objpath : dbus_data)
209     {
210         for (auto& ifacePair : objpath.second)
211         {
212             if (objpath.first == "/xyz/openbmc_project/network/" + ethiface_id)
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& ethiface_id,
420                     const GetManagedObjects& dbus_data,
421                     boost::container::flat_set<IPv6AddressData>& ipv6_config)
422 {
423     const std::string ipv6PathStart =
424         "/xyz/openbmc_project/network/" + ethiface_id + "/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 : dbus_data)
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 = ipv6_config.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& ethiface_id,
493                   const GetManagedObjects& dbus_data,
494                   boost::container::flat_set<IPv4AddressData>& ipv4_config)
495 {
496     const std::string ipv4PathStart =
497         "/xyz/openbmc_project/network/" + ethiface_id + "/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 : dbus_data)
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 = ipv4_config.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& ethiface_id,
892                           CallbackFunc&& callback)
893 {
894     crow::connections::systemBus->async_method_call(
895         [ethifaceId{std::string{ethiface_id}}, callback{std::move(callback)}](
896             const boost::system::error_code error_code,
897             GetManagedObjects& resp) {
898             EthernetInterfaceData ethData{};
899             boost::container::flat_set<IPv4AddressData> ipv4Data;
900             boost::container::flat_set<IPv6AddressData> ipv6Data;
901 
902             if (error_code)
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 error_code,
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 (error_code)
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                         // Cut out everything until last "/", ...
972                         const std::string& ifaceId = objpath.first.str;
973                         std::size_t lastPos = ifaceId.rfind('/');
974                         if (lastPos != std::string::npos)
975                         {
976                             // and put it into output vector.
977                             ifaceList.emplace(ifaceId.substr(lastPos + 1));
978                         }
979                     }
980                 }
981             }
982             // Finally make a callback with useful data
983             callback(true, ifaceList);
984         },
985         "xyz.openbmc_project.Network", "/xyz/openbmc_project/network",
986         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
987 }
988 
989 /**
990  * EthernetCollection derived class for delivering Ethernet Collection Schema
991  */
992 class EthernetCollection : public Node
993 {
994   public:
995     EthernetCollection(App& app) :
996         Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/")
997     {
998         entityPrivileges = {
999             {boost::beast::http::verb::get, {{"Login"}}},
1000             {boost::beast::http::verb::head, {{"Login"}}},
1001             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
1002             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
1003             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
1004             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
1005     }
1006 
1007   private:
1008     /**
1009      * Functions triggers appropriate requests on DBus
1010      */
1011     void doGet(crow::Response& res, const crow::Request&,
1012                const std::vector<std::string>&) override
1013     {
1014         res.jsonValue["@odata.type"] =
1015             "#EthernetInterfaceCollection.EthernetInterfaceCollection";
1016         res.jsonValue["@odata.id"] =
1017             "/redfish/v1/Managers/bmc/EthernetInterfaces";
1018         res.jsonValue["Name"] = "Ethernet Network Interface Collection";
1019         res.jsonValue["Description"] =
1020             "Collection of EthernetInterfaces for this Manager";
1021         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1022         // Get eth interface list, and call the below callback for JSON
1023         // preparation
1024         getEthernetIfaceList(
1025             [asyncResp](
1026                 const bool& success,
1027                 const boost::container::flat_set<std::string>& iface_list) {
1028                 if (!success)
1029                 {
1030                     messages::internalError(asyncResp->res);
1031                     return;
1032                 }
1033 
1034                 nlohmann::json& ifaceArray =
1035                     asyncResp->res.jsonValue["Members"];
1036                 ifaceArray = nlohmann::json::array();
1037                 std::string tag = "_";
1038                 for (const std::string& ifaceItem : iface_list)
1039                 {
1040                     std::size_t found = ifaceItem.find(tag);
1041                     if (found == std::string::npos)
1042                     {
1043                         ifaceArray.push_back(
1044                             {{"@odata.id",
1045                               "/redfish/v1/Managers/bmc/EthernetInterfaces/" +
1046                                   ifaceItem}});
1047                     }
1048                 }
1049 
1050                 asyncResp->res.jsonValue["Members@odata.count"] =
1051                     ifaceArray.size();
1052                 asyncResp->res.jsonValue["@odata.id"] =
1053                     "/redfish/v1/Managers/bmc/EthernetInterfaces";
1054             });
1055     }
1056 };
1057 
1058 /**
1059  * EthernetInterface derived class for delivering Ethernet Schema
1060  */
1061 class EthernetInterface : public Node
1062 {
1063   public:
1064     /*
1065      * Default Constructor
1066      */
1067     EthernetInterface(App& app) :
1068         Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/",
1069              std::string())
1070     {
1071         entityPrivileges = {
1072             {boost::beast::http::verb::get, {{"Login"}}},
1073             {boost::beast::http::verb::head, {{"Login"}}},
1074             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
1075             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
1076             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
1077             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
1078     }
1079 
1080   private:
1081     void handleHostnamePatch(const std::string& hostname,
1082                              const std::shared_ptr<AsyncResp>& asyncResp)
1083     {
1084         // SHOULD handle host names of up to 255 characters(RFC 1123)
1085         if (hostname.length() > 255)
1086         {
1087             messages::propertyValueFormatError(asyncResp->res, hostname,
1088                                                "HostName");
1089             return;
1090         }
1091         crow::connections::systemBus->async_method_call(
1092             [asyncResp](const boost::system::error_code ec) {
1093                 if (ec)
1094                 {
1095                     messages::internalError(asyncResp->res);
1096                 }
1097             },
1098             "xyz.openbmc_project.Network",
1099             "/xyz/openbmc_project/network/config",
1100             "org.freedesktop.DBus.Properties", "Set",
1101             "xyz.openbmc_project.Network.SystemConfiguration", "HostName",
1102             std::variant<std::string>(hostname));
1103     }
1104 
1105     void handleDomainnamePatch(const std::string& ifaceId,
1106                                const std::string& domainname,
1107                                const std::shared_ptr<AsyncResp>& asyncResp)
1108     {
1109         std::vector<std::string> vectorDomainname = {domainname};
1110         crow::connections::systemBus->async_method_call(
1111             [asyncResp](const boost::system::error_code ec) {
1112                 if (ec)
1113                 {
1114                     messages::internalError(asyncResp->res);
1115                 }
1116             },
1117             "xyz.openbmc_project.Network",
1118             "/xyz/openbmc_project/network/" + ifaceId,
1119             "org.freedesktop.DBus.Properties", "Set",
1120             "xyz.openbmc_project.Network.EthernetInterface", "DomainName",
1121             std::variant<std::vector<std::string>>(vectorDomainname));
1122     }
1123 
1124     void handleFqdnPatch(const std::string& ifaceId, const std::string& fqdn,
1125                          const std::shared_ptr<AsyncResp>& asyncResp)
1126     {
1127         // Total length of FQDN must not exceed 255 characters(RFC 1035)
1128         if (fqdn.length() > 255)
1129         {
1130             messages::propertyValueFormatError(asyncResp->res, fqdn, "FQDN");
1131             return;
1132         }
1133 
1134         size_t pos = fqdn.find('.');
1135         if (pos == std::string::npos)
1136         {
1137             messages::propertyValueFormatError(asyncResp->res, fqdn, "FQDN");
1138             return;
1139         }
1140 
1141         std::string hostname;
1142         std::string domainname;
1143         domainname = (fqdn).substr(pos + 1);
1144         hostname = (fqdn).substr(0, pos);
1145 
1146         if (!isHostnameValid(hostname) || !isDomainnameValid(domainname))
1147         {
1148             messages::propertyValueFormatError(asyncResp->res, fqdn, "FQDN");
1149             return;
1150         }
1151 
1152         handleHostnamePatch(hostname, asyncResp);
1153         handleDomainnamePatch(ifaceId, domainname, asyncResp);
1154     }
1155 
1156     bool isHostnameValid(const std::string& hostname)
1157     {
1158         // A valid host name can never have the dotted-decimal form (RFC 1123)
1159         if (std::all_of(hostname.begin(), hostname.end(), ::isdigit))
1160         {
1161             return false;
1162         }
1163         // Each label(hostname/subdomains) within a valid FQDN
1164         // MUST handle host names of up to 63 characters (RFC 1123)
1165         // labels cannot start or end with hyphens (RFC 952)
1166         // labels can start with numbers (RFC 1123)
1167         const std::regex pattern(
1168             "^[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9]$");
1169 
1170         return std::regex_match(hostname, pattern);
1171     }
1172 
1173     bool isDomainnameValid(const std::string& domainname)
1174     {
1175         // Can have multiple subdomains
1176         // Top Level Domain's min length is 2 character
1177         const std::regex pattern("^([A-Za-z0-9][a-zA-Z0-9\\-]{1,61}|[a-zA-Z0-9]"
1178                                  "{1,30}\\.)*[a-zA-Z]{2,}$");
1179 
1180         return std::regex_match(domainname, pattern);
1181     }
1182 
1183     void handleMACAddressPatch(const std::string& ifaceId,
1184                                const std::string& macAddress,
1185                                const std::shared_ptr<AsyncResp>& asyncResp)
1186     {
1187         crow::connections::systemBus->async_method_call(
1188             [asyncResp, macAddress](const boost::system::error_code ec) {
1189                 if (ec)
1190                 {
1191                     messages::internalError(asyncResp->res);
1192                     return;
1193                 }
1194             },
1195             "xyz.openbmc_project.Network",
1196             "/xyz/openbmc_project/network/" + ifaceId,
1197             "org.freedesktop.DBus.Properties", "Set",
1198             "xyz.openbmc_project.Network.MACAddress", "MACAddress",
1199             std::variant<std::string>(macAddress));
1200     }
1201 
1202     void setDHCPEnabled(const std::string& ifaceId,
1203                         const std::string& propertyName, const bool v4Value,
1204                         const bool v6Value,
1205                         const std::shared_ptr<AsyncResp>& asyncResp)
1206     {
1207         const std::string dhcp = getDhcpEnabledEnumeration(v4Value, v6Value);
1208         crow::connections::systemBus->async_method_call(
1209             [asyncResp](const boost::system::error_code ec) {
1210                 if (ec)
1211                 {
1212                     BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
1213                     messages::internalError(asyncResp->res);
1214                     return;
1215                 }
1216             },
1217             "xyz.openbmc_project.Network",
1218             "/xyz/openbmc_project/network/" + ifaceId,
1219             "org.freedesktop.DBus.Properties", "Set",
1220             "xyz.openbmc_project.Network.EthernetInterface", propertyName,
1221             std::variant<std::string>{dhcp});
1222     }
1223 
1224     void setEthernetInterfaceBoolProperty(
1225         const std::string& ifaceId, const std::string& propertyName,
1226         const bool& value, const std::shared_ptr<AsyncResp>& asyncResp)
1227     {
1228         crow::connections::systemBus->async_method_call(
1229             [asyncResp](const boost::system::error_code ec) {
1230                 if (ec)
1231                 {
1232                     BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
1233                     messages::internalError(asyncResp->res);
1234                     return;
1235                 }
1236             },
1237             "xyz.openbmc_project.Network",
1238             "/xyz/openbmc_project/network/" + ifaceId,
1239             "org.freedesktop.DBus.Properties", "Set",
1240             "xyz.openbmc_project.Network.EthernetInterface", propertyName,
1241             std::variant<bool>{value});
1242     }
1243 
1244     void setDHCPv4Config(const std::string& propertyName, const bool& value,
1245                          const std::shared_ptr<AsyncResp>& asyncResp)
1246     {
1247         BMCWEB_LOG_DEBUG << propertyName << " = " << value;
1248         crow::connections::systemBus->async_method_call(
1249             [asyncResp](const boost::system::error_code ec) {
1250                 if (ec)
1251                 {
1252                     BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
1253                     messages::internalError(asyncResp->res);
1254                     return;
1255                 }
1256             },
1257             "xyz.openbmc_project.Network",
1258             "/xyz/openbmc_project/network/config/dhcp",
1259             "org.freedesktop.DBus.Properties", "Set",
1260             "xyz.openbmc_project.Network.DHCPConfiguration", propertyName,
1261             std::variant<bool>{value});
1262     }
1263 
1264     void handleDHCPPatch(const std::string& ifaceId,
1265                          const EthernetInterfaceData& ethData,
1266                          const DHCPParameters& v4dhcpParms,
1267                          const DHCPParameters& v6dhcpParms,
1268                          const std::shared_ptr<AsyncResp>& asyncResp)
1269     {
1270         bool ipv4Active = translateDHCPEnabledToBool(ethData.DHCPEnabled, true);
1271         bool ipv6Active =
1272             translateDHCPEnabledToBool(ethData.DHCPEnabled, false);
1273 
1274         bool nextv4DHCPState =
1275             v4dhcpParms.dhcpv4Enabled ? *v4dhcpParms.dhcpv4Enabled : ipv4Active;
1276 
1277         bool nextv6DHCPState{};
1278         if (v6dhcpParms.dhcpv6OperatingMode)
1279         {
1280             if ((*v6dhcpParms.dhcpv6OperatingMode != "Stateful") &&
1281                 (*v6dhcpParms.dhcpv6OperatingMode != "Stateless") &&
1282                 (*v6dhcpParms.dhcpv6OperatingMode != "Disabled"))
1283             {
1284                 messages::propertyValueFormatError(
1285                     asyncResp->res, *v6dhcpParms.dhcpv6OperatingMode,
1286                     "OperatingMode");
1287                 return;
1288             }
1289             nextv6DHCPState = (*v6dhcpParms.dhcpv6OperatingMode == "Stateful");
1290         }
1291         else
1292         {
1293             nextv6DHCPState = ipv6Active;
1294         }
1295 
1296         bool nextDNS{};
1297         if (v4dhcpParms.useDNSServers && v6dhcpParms.useDNSServers)
1298         {
1299             if (*v4dhcpParms.useDNSServers != *v6dhcpParms.useDNSServers)
1300             {
1301                 messages::generalError(asyncResp->res);
1302                 return;
1303             }
1304             nextDNS = *v4dhcpParms.useDNSServers;
1305         }
1306         else if (v4dhcpParms.useDNSServers)
1307         {
1308             nextDNS = *v4dhcpParms.useDNSServers;
1309         }
1310         else if (v6dhcpParms.useDNSServers)
1311         {
1312             nextDNS = *v6dhcpParms.useDNSServers;
1313         }
1314         else
1315         {
1316             nextDNS = ethData.DNSEnabled;
1317         }
1318 
1319         bool nextNTP{};
1320         if (v4dhcpParms.useNTPServers && v6dhcpParms.useNTPServers)
1321         {
1322             if (*v4dhcpParms.useNTPServers != *v6dhcpParms.useNTPServers)
1323             {
1324                 messages::generalError(asyncResp->res);
1325                 return;
1326             }
1327             nextNTP = *v4dhcpParms.useNTPServers;
1328         }
1329         else if (v4dhcpParms.useNTPServers)
1330         {
1331             nextNTP = *v4dhcpParms.useNTPServers;
1332         }
1333         else if (v6dhcpParms.useNTPServers)
1334         {
1335             nextNTP = *v6dhcpParms.useNTPServers;
1336         }
1337         else
1338         {
1339             nextNTP = ethData.NTPEnabled;
1340         }
1341 
1342         bool nextUseDomain{};
1343         if (v4dhcpParms.useUseDomainName && v6dhcpParms.useUseDomainName)
1344         {
1345             if (*v4dhcpParms.useUseDomainName != *v6dhcpParms.useUseDomainName)
1346             {
1347                 messages::generalError(asyncResp->res);
1348                 return;
1349             }
1350             nextUseDomain = *v4dhcpParms.useUseDomainName;
1351         }
1352         else if (v4dhcpParms.useUseDomainName)
1353         {
1354             nextUseDomain = *v4dhcpParms.useUseDomainName;
1355         }
1356         else if (v6dhcpParms.useUseDomainName)
1357         {
1358             nextUseDomain = *v6dhcpParms.useUseDomainName;
1359         }
1360         else
1361         {
1362             nextUseDomain = ethData.HostNameEnabled;
1363         }
1364 
1365         BMCWEB_LOG_DEBUG << "set DHCPEnabled...";
1366         setDHCPEnabled(ifaceId, "DHCPEnabled", nextv4DHCPState, nextv6DHCPState,
1367                        asyncResp);
1368         BMCWEB_LOG_DEBUG << "set DNSEnabled...";
1369         setDHCPv4Config("DNSEnabled", nextDNS, asyncResp);
1370         BMCWEB_LOG_DEBUG << "set NTPEnabled...";
1371         setDHCPv4Config("NTPEnabled", nextNTP, asyncResp);
1372         BMCWEB_LOG_DEBUG << "set HostNameEnabled...";
1373         setDHCPv4Config("HostNameEnabled", nextUseDomain, asyncResp);
1374     }
1375 
1376     boost::container::flat_set<IPv4AddressData>::const_iterator
1377         getNextStaticIpEntry(
1378             boost::container::flat_set<IPv4AddressData>::const_iterator head,
1379             const boost::container::flat_set<IPv4AddressData>::const_iterator&
1380                 end)
1381     {
1382         for (; head != end; head++)
1383         {
1384             if (head->origin == "Static")
1385             {
1386                 return head;
1387             }
1388         }
1389         return end;
1390     }
1391 
1392     boost::container::flat_set<IPv6AddressData>::const_iterator
1393         getNextStaticIpEntry(
1394             boost::container::flat_set<IPv6AddressData>::const_iterator head,
1395             const boost::container::flat_set<IPv6AddressData>::const_iterator&
1396                 end)
1397     {
1398         for (; head != end; head++)
1399         {
1400             if (head->origin == "Static")
1401             {
1402                 return head;
1403             }
1404         }
1405         return end;
1406     }
1407 
1408     void handleIPv4StaticPatch(
1409         const std::string& ifaceId, nlohmann::json& input,
1410         const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1411         const std::shared_ptr<AsyncResp>& asyncResp)
1412     {
1413         if ((!input.is_array()) || input.empty())
1414         {
1415             messages::propertyValueTypeError(asyncResp->res, input.dump(),
1416                                              "IPv4StaticAddresses");
1417             return;
1418         }
1419 
1420         unsigned entryIdx = 1;
1421         // Find the first static IP address currently active on the NIC and
1422         // match it to the first JSON element in the IPv4StaticAddresses array.
1423         // Match each subsequent JSON element to the next static IP programmed
1424         // into the NIC.
1425         boost::container::flat_set<IPv4AddressData>::const_iterator niciPentry =
1426             getNextStaticIpEntry(ipv4Data.cbegin(), ipv4Data.cend());
1427 
1428         for (nlohmann::json& thisJson : input)
1429         {
1430             std::string pathString =
1431                 "IPv4StaticAddresses/" + std::to_string(entryIdx);
1432 
1433             if (!thisJson.is_null() && !thisJson.empty())
1434             {
1435                 std::optional<std::string> address;
1436                 std::optional<std::string> subnetMask;
1437                 std::optional<std::string> gateway;
1438 
1439                 if (!json_util::readJson(thisJson, asyncResp->res, "Address",
1440                                          address, "SubnetMask", subnetMask,
1441                                          "Gateway", gateway))
1442                 {
1443                     messages::propertyValueFormatError(
1444                         asyncResp->res, thisJson.dump(), pathString);
1445                     return;
1446                 }
1447 
1448                 // Find the address/subnet/gateway values. Any values that are
1449                 // not explicitly provided are assumed to be unmodified from the
1450                 // current state of the interface. Merge existing state into the
1451                 // current request.
1452                 const std::string* addr = nullptr;
1453                 const std::string* gw = nullptr;
1454                 uint8_t prefixLength = 0;
1455                 bool errorInEntry = false;
1456                 if (address)
1457                 {
1458                     if (ipv4VerifyIpAndGetBitcount(*address))
1459                     {
1460                         addr = &(*address);
1461                     }
1462                     else
1463                     {
1464                         messages::propertyValueFormatError(
1465                             asyncResp->res, *address, pathString + "/Address");
1466                         errorInEntry = true;
1467                     }
1468                 }
1469                 else if (niciPentry != ipv4Data.cend())
1470                 {
1471                     addr = &(niciPentry->address);
1472                 }
1473                 else
1474                 {
1475                     messages::propertyMissing(asyncResp->res,
1476                                               pathString + "/Address");
1477                     errorInEntry = true;
1478                 }
1479 
1480                 if (subnetMask)
1481                 {
1482                     if (!ipv4VerifyIpAndGetBitcount(*subnetMask, &prefixLength))
1483                     {
1484                         messages::propertyValueFormatError(
1485                             asyncResp->res, *subnetMask,
1486                             pathString + "/SubnetMask");
1487                         errorInEntry = true;
1488                     }
1489                 }
1490                 else if (niciPentry != ipv4Data.cend())
1491                 {
1492                     if (!ipv4VerifyIpAndGetBitcount(niciPentry->netmask,
1493                                                     &prefixLength))
1494                     {
1495                         messages::propertyValueFormatError(
1496                             asyncResp->res, niciPentry->netmask,
1497                             pathString + "/SubnetMask");
1498                         errorInEntry = true;
1499                     }
1500                 }
1501                 else
1502                 {
1503                     messages::propertyMissing(asyncResp->res,
1504                                               pathString + "/SubnetMask");
1505                     errorInEntry = true;
1506                 }
1507 
1508                 if (gateway)
1509                 {
1510                     if (ipv4VerifyIpAndGetBitcount(*gateway))
1511                     {
1512                         gw = &(*gateway);
1513                     }
1514                     else
1515                     {
1516                         messages::propertyValueFormatError(
1517                             asyncResp->res, *gateway, pathString + "/Gateway");
1518                         errorInEntry = true;
1519                     }
1520                 }
1521                 else if (niciPentry != ipv4Data.cend())
1522                 {
1523                     gw = &niciPentry->gateway;
1524                 }
1525                 else
1526                 {
1527                     messages::propertyMissing(asyncResp->res,
1528                                               pathString + "/Gateway");
1529                     errorInEntry = true;
1530                 }
1531 
1532                 if (errorInEntry)
1533                 {
1534                     return;
1535                 }
1536 
1537                 if (niciPentry != ipv4Data.cend())
1538                 {
1539                     deleteAndCreateIPv4(ifaceId, niciPentry->id, prefixLength,
1540                                         *gw, *addr, asyncResp);
1541                     niciPentry =
1542                         getNextStaticIpEntry(++niciPentry, ipv4Data.cend());
1543                 }
1544                 else
1545                 {
1546                     createIPv4(ifaceId, prefixLength, *gateway, *address,
1547                                asyncResp);
1548                 }
1549                 entryIdx++;
1550             }
1551             else
1552             {
1553                 if (niciPentry == ipv4Data.cend())
1554                 {
1555                     // Requesting a DELETE/DO NOT MODIFY action for an item
1556                     // that isn't present on the eth(n) interface. Input JSON is
1557                     // in error, so bail out.
1558                     if (thisJson.is_null())
1559                     {
1560                         messages::resourceCannotBeDeleted(asyncResp->res);
1561                         return;
1562                     }
1563                     messages::propertyValueFormatError(
1564                         asyncResp->res, thisJson.dump(), 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(asyncResp->res, input.dump(),
1611                                              "IPv6StaticAddresses");
1612             return;
1613         }
1614         size_t entryIdx = 1;
1615         boost::container::flat_set<IPv6AddressData>::const_iterator niciPentry =
1616             getNextStaticIpEntry(ipv6Data.cbegin(), ipv6Data.cend());
1617         for (const nlohmann::json& thisJson : input)
1618         {
1619             std::string pathString =
1620                 "IPv6StaticAddresses/" + std::to_string(entryIdx);
1621 
1622             if (!thisJson.is_null() && !thisJson.empty())
1623             {
1624                 std::optional<std::string> address;
1625                 std::optional<uint8_t> prefixLength;
1626                 nlohmann::json thisJsonCopy = thisJson;
1627                 if (!json_util::readJson(thisJsonCopy, asyncResp->res,
1628                                          "Address", address, "PrefixLength",
1629                                          prefixLength))
1630                 {
1631                     messages::propertyValueFormatError(
1632                         asyncResp->res, thisJson.dump(), pathString);
1633                     return;
1634                 }
1635 
1636                 const std::string* addr;
1637                 uint8_t prefix;
1638 
1639                 // Find the address and prefixLength values. Any values that are
1640                 // not explicitly provided are assumed to be unmodified from the
1641                 // current state of the interface. Merge existing state into the
1642                 // current request.
1643                 if (address)
1644                 {
1645                     addr = &(*address);
1646                 }
1647                 else if (niciPentry != ipv6Data.end())
1648                 {
1649                     addr = &(niciPentry->address);
1650                 }
1651                 else
1652                 {
1653                     messages::propertyMissing(asyncResp->res,
1654                                               pathString + "/Address");
1655                     return;
1656                 }
1657 
1658                 if (prefixLength)
1659                 {
1660                     prefix = *prefixLength;
1661                 }
1662                 else if (niciPentry != ipv6Data.end())
1663                 {
1664                     prefix = niciPentry->prefixLength;
1665                 }
1666                 else
1667                 {
1668                     messages::propertyMissing(asyncResp->res,
1669                                               pathString + "/PrefixLength");
1670                     return;
1671                 }
1672 
1673                 if (niciPentry != ipv6Data.end())
1674                 {
1675                     deleteAndCreateIPv6(ifaceId, niciPentry->id, prefix, *addr,
1676                                         asyncResp);
1677                     niciPentry =
1678                         getNextStaticIpEntry(++niciPentry, ipv6Data.cend());
1679                 }
1680                 else
1681                 {
1682                     createIPv6(ifaceId, *prefixLength, *addr, asyncResp);
1683                 }
1684                 entryIdx++;
1685             }
1686             else
1687             {
1688                 if (niciPentry == ipv6Data.end())
1689                 {
1690                     // Requesting a DELETE/DO NOT MODIFY action for an item
1691                     // that isn't present on the eth(n) interface. Input JSON is
1692                     // in error, so bail out.
1693                     if (thisJson.is_null())
1694                     {
1695                         messages::resourceCannotBeDeleted(asyncResp->res);
1696                         return;
1697                     }
1698                     messages::propertyValueFormatError(
1699                         asyncResp->res, thisJson.dump(), pathString);
1700                     return;
1701                 }
1702 
1703                 if (thisJson.is_null())
1704                 {
1705                     deleteIPv6(ifaceId, niciPentry->id, asyncResp);
1706                 }
1707                 if (niciPentry != ipv6Data.cend())
1708                 {
1709                     niciPentry =
1710                         getNextStaticIpEntry(++niciPentry, ipv6Data.cend());
1711                 }
1712                 entryIdx++;
1713             }
1714         }
1715     }
1716 
1717     void parseInterfaceData(
1718         const std::shared_ptr<AsyncResp>& asyncResp,
1719         const std::string& iface_id, const EthernetInterfaceData& ethData,
1720         const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1721         const boost::container::flat_set<IPv6AddressData>& ipv6Data)
1722     {
1723         constexpr const std::array<const char*, 1> inventoryForEthernet = {
1724             "xyz.openbmc_project.Inventory.Item.Ethernet"};
1725 
1726         nlohmann::json& jsonResponse = asyncResp->res.jsonValue;
1727         jsonResponse["Id"] = iface_id;
1728         jsonResponse["@odata.id"] =
1729             "/redfish/v1/Managers/bmc/EthernetInterfaces/" + iface_id;
1730         jsonResponse["InterfaceEnabled"] = ethData.nicEnabled;
1731 
1732         auto health = std::make_shared<HealthPopulate>(asyncResp);
1733 
1734         crow::connections::systemBus->async_method_call(
1735             [health](const boost::system::error_code ec,
1736                      std::vector<std::string>& resp) {
1737                 if (ec)
1738                 {
1739                     return;
1740                 }
1741 
1742                 health->inventory = std::move(resp);
1743             },
1744             "xyz.openbmc_project.ObjectMapper",
1745             "/xyz/openbmc_project/object_mapper",
1746             "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/",
1747             int32_t(0), inventoryForEthernet);
1748 
1749         health->populate();
1750 
1751         if (ethData.nicEnabled)
1752         {
1753             jsonResponse["LinkStatus"] = "LinkUp";
1754             jsonResponse["Status"]["State"] = "Enabled";
1755         }
1756         else
1757         {
1758             jsonResponse["LinkStatus"] = "NoLink";
1759             jsonResponse["Status"]["State"] = "Disabled";
1760         }
1761 
1762         jsonResponse["LinkStatus"] = ethData.linkUp ? "LinkUp" : "LinkDown";
1763         jsonResponse["SpeedMbps"] = ethData.speed;
1764         jsonResponse["MACAddress"] = ethData.mac_address;
1765         jsonResponse["DHCPv4"]["DHCPEnabled"] =
1766             translateDHCPEnabledToBool(ethData.DHCPEnabled, true);
1767         jsonResponse["DHCPv4"]["UseNTPServers"] = ethData.NTPEnabled;
1768         jsonResponse["DHCPv4"]["UseDNSServers"] = ethData.DNSEnabled;
1769         jsonResponse["DHCPv4"]["UseDomainName"] = ethData.HostNameEnabled;
1770 
1771         jsonResponse["DHCPv6"]["OperatingMode"] =
1772             translateDHCPEnabledToBool(ethData.DHCPEnabled, false) ? "Stateful"
1773                                                                    : "Disabled";
1774         jsonResponse["DHCPv6"]["UseNTPServers"] = ethData.NTPEnabled;
1775         jsonResponse["DHCPv6"]["UseDNSServers"] = ethData.DNSEnabled;
1776         jsonResponse["DHCPv6"]["UseDomainName"] = ethData.HostNameEnabled;
1777 
1778         if (!ethData.hostname.empty())
1779         {
1780             jsonResponse["HostName"] = ethData.hostname;
1781 
1782             // When domain name is empty then it means, that it is a network
1783             // without domain names, and the host name itself must be treated as
1784             // FQDN
1785             std::string fqdn = ethData.hostname;
1786             if (!ethData.domainnames.empty())
1787             {
1788                 fqdn += "." + ethData.domainnames[0];
1789             }
1790             jsonResponse["FQDN"] = fqdn;
1791         }
1792 
1793         jsonResponse["VLANs"] = {
1794             {"@odata.id", "/redfish/v1/Managers/bmc/EthernetInterfaces/" +
1795                               iface_id + "/VLANs"}};
1796 
1797         jsonResponse["NameServers"] = ethData.nameServers;
1798         jsonResponse["StaticNameServers"] = ethData.staticNameServers;
1799 
1800         nlohmann::json& ipv4Array = jsonResponse["IPv4Addresses"];
1801         nlohmann::json& ipv4StaticArray = jsonResponse["IPv4StaticAddresses"];
1802         ipv4Array = nlohmann::json::array();
1803         ipv4StaticArray = nlohmann::json::array();
1804         for (auto& ipv4Config : ipv4Data)
1805         {
1806 
1807             std::string gatewayStr = ipv4Config.gateway;
1808             if (gatewayStr.empty())
1809             {
1810                 gatewayStr = "0.0.0.0";
1811             }
1812 
1813             ipv4Array.push_back({{"AddressOrigin", ipv4Config.origin},
1814                                  {"SubnetMask", ipv4Config.netmask},
1815                                  {"Address", ipv4Config.address},
1816                                  {"Gateway", gatewayStr}});
1817             if (ipv4Config.origin == "Static")
1818             {
1819                 ipv4StaticArray.push_back({{"AddressOrigin", ipv4Config.origin},
1820                                            {"SubnetMask", ipv4Config.netmask},
1821                                            {"Address", ipv4Config.address},
1822                                            {"Gateway", gatewayStr}});
1823             }
1824         }
1825 
1826         jsonResponse["IPv6DefaultGateway"] = ethData.ipv6_default_gateway;
1827 
1828         nlohmann::json& ipv6Array = jsonResponse["IPv6Addresses"];
1829         nlohmann::json& ipv6StaticArray = jsonResponse["IPv6StaticAddresses"];
1830         ipv6Array = nlohmann::json::array();
1831         ipv6StaticArray = nlohmann::json::array();
1832         nlohmann::json& ipv6AddrPolicyTable =
1833             jsonResponse["IPv6AddressPolicyTable"];
1834         ipv6AddrPolicyTable = nlohmann::json::array();
1835         for (auto& ipv6Config : ipv6Data)
1836         {
1837             ipv6Array.push_back({{"Address", ipv6Config.address},
1838                                  {"PrefixLength", ipv6Config.prefixLength},
1839                                  {"AddressOrigin", ipv6Config.origin},
1840                                  {"AddressState", nullptr}});
1841             if (ipv6Config.origin == "Static")
1842             {
1843                 ipv6StaticArray.push_back(
1844                     {{"Address", ipv6Config.address},
1845                      {"PrefixLength", ipv6Config.prefixLength},
1846                      {"AddressOrigin", ipv6Config.origin},
1847                      {"AddressState", nullptr}});
1848             }
1849         }
1850     }
1851 
1852     /**
1853      * Functions triggers appropriate requests on DBus
1854      */
1855     void doGet(crow::Response& res, const crow::Request&,
1856                const std::vector<std::string>& params) override
1857     {
1858         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1859         if (params.size() != 1)
1860         {
1861             messages::internalError(asyncResp->res);
1862             return;
1863         }
1864 
1865         getEthernetIfaceData(
1866             params[0],
1867             [this, asyncResp, ifaceId{std::string(params[0])}](
1868                 const bool& success, const EthernetInterfaceData& ethData,
1869                 const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1870                 const boost::container::flat_set<IPv6AddressData>& ipv6Data) {
1871                 if (!success)
1872                 {
1873                     // TODO(Pawel)consider distinguish between non existing
1874                     // object, and other errors
1875                     messages::resourceNotFound(asyncResp->res,
1876                                                "EthernetInterface", ifaceId);
1877                     return;
1878                 }
1879 
1880                 asyncResp->res.jsonValue["@odata.type"] =
1881                     "#EthernetInterface.v1_4_1.EthernetInterface";
1882                 asyncResp->res.jsonValue["Name"] = "Manager Ethernet Interface";
1883                 asyncResp->res.jsonValue["Description"] =
1884                     "Management Network Interface";
1885 
1886                 parseInterfaceData(asyncResp, ifaceId, ethData, ipv4Data,
1887                                    ipv6Data);
1888             });
1889     }
1890 
1891     void doPatch(crow::Response& res, const crow::Request& req,
1892                  const std::vector<std::string>& params) override
1893     {
1894         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1895         if (params.size() != 1)
1896         {
1897             messages::internalError(asyncResp->res);
1898             return;
1899         }
1900 
1901         const std::string& ifaceId = params[0];
1902 
1903         std::optional<std::string> hostname;
1904         std::optional<std::string> fqdn;
1905         std::optional<std::string> macAddress;
1906         std::optional<std::string> ipv6DefaultGateway;
1907         std::optional<nlohmann::json> ipv4StaticAddresses;
1908         std::optional<nlohmann::json> ipv6StaticAddresses;
1909         std::optional<std::vector<std::string>> staticNameServers;
1910         std::optional<nlohmann::json> dhcpv4;
1911         std::optional<nlohmann::json> dhcpv6;
1912         std::optional<bool> interfaceEnabled;
1913         DHCPParameters v4dhcpParms;
1914         DHCPParameters v6dhcpParms;
1915 
1916         if (!json_util::readJson(
1917                 req, res, "HostName", hostname, "FQDN", fqdn,
1918                 "IPv4StaticAddresses", ipv4StaticAddresses, "MACAddress",
1919                 macAddress, "StaticNameServers", staticNameServers,
1920                 "IPv6DefaultGateway", ipv6DefaultGateway, "IPv6StaticAddresses",
1921                 ipv6StaticAddresses, "DHCPv4", dhcpv4, "DHCPv6", dhcpv6,
1922                 "InterfaceEnabled", interfaceEnabled))
1923         {
1924             return;
1925         }
1926         if (dhcpv4)
1927         {
1928             if (!json_util::readJson(*dhcpv4, res, "DHCPEnabled",
1929                                      v4dhcpParms.dhcpv4Enabled, "UseDNSServers",
1930                                      v4dhcpParms.useDNSServers, "UseNTPServers",
1931                                      v4dhcpParms.useNTPServers, "UseDomainName",
1932                                      v4dhcpParms.useUseDomainName))
1933             {
1934                 return;
1935             }
1936         }
1937 
1938         if (dhcpv6)
1939         {
1940             if (!json_util::readJson(*dhcpv6, res, "OperatingMode",
1941                                      v6dhcpParms.dhcpv6OperatingMode,
1942                                      "UseDNSServers", v6dhcpParms.useDNSServers,
1943                                      "UseNTPServers", v6dhcpParms.useNTPServers,
1944                                      "UseDomainName",
1945                                      v6dhcpParms.useUseDomainName))
1946             {
1947                 return;
1948             }
1949         }
1950 
1951         // Get single eth interface data, and call the below callback for
1952         // JSON preparation
1953         getEthernetIfaceData(
1954             ifaceId,
1955             [this, asyncResp, ifaceId, hostname = std::move(hostname),
1956              fqdn = std::move(fqdn), macAddress = std::move(macAddress),
1957              ipv4StaticAddresses = std::move(ipv4StaticAddresses),
1958              ipv6DefaultGateway = std::move(ipv6DefaultGateway),
1959              ipv6StaticAddresses = std::move(ipv6StaticAddresses),
1960              staticNameServers = std::move(staticNameServers),
1961              dhcpv4 = std::move(dhcpv4), dhcpv6 = std::move(dhcpv6),
1962              v4dhcpParms = std::move(v4dhcpParms),
1963              v6dhcpParms = std::move(v6dhcpParms), interfaceEnabled](
1964                 const bool& success, const EthernetInterfaceData& ethData,
1965                 const boost::container::flat_set<IPv4AddressData>& ipv4Data,
1966                 const boost::container::flat_set<IPv6AddressData>& ipv6Data) {
1967                 if (!success)
1968                 {
1969                     // ... otherwise return error
1970                     // TODO(Pawel)consider distinguish between non existing
1971                     // object, and other errors
1972                     messages::resourceNotFound(asyncResp->res,
1973                                                "Ethernet Interface", ifaceId);
1974                     return;
1975                 }
1976 
1977                 if (dhcpv4 || dhcpv6)
1978                 {
1979                     handleDHCPPatch(ifaceId, ethData, v4dhcpParms, v6dhcpParms,
1980                                     asyncResp);
1981                 }
1982 
1983                 if (hostname)
1984                 {
1985                     handleHostnamePatch(*hostname, asyncResp);
1986                 }
1987 
1988                 if (fqdn)
1989                 {
1990                     handleFqdnPatch(ifaceId, *fqdn, asyncResp);
1991                 }
1992 
1993                 if (macAddress)
1994                 {
1995                     handleMACAddressPatch(ifaceId, *macAddress, asyncResp);
1996                 }
1997 
1998                 if (ipv4StaticAddresses)
1999                 {
2000                     // TODO(ed) for some reason the capture of ipv4Addresses
2001                     // above is returning a const value, not a non-const
2002                     // value. This doesn't really work for us, as we need to
2003                     // be able to efficiently move out the intermedia
2004                     // nlohmann::json objects. This makes a copy of the
2005                     // structure, and operates on that, but could be done
2006                     // more efficiently
2007                     nlohmann::json ipv4Static = *ipv4StaticAddresses;
2008                     handleIPv4StaticPatch(ifaceId, ipv4Static, ipv4Data,
2009                                           asyncResp);
2010                 }
2011 
2012                 if (staticNameServers)
2013                 {
2014                     handleStaticNameServersPatch(ifaceId, *staticNameServers,
2015                                                  asyncResp);
2016                 }
2017 
2018                 if (ipv6DefaultGateway)
2019                 {
2020                     messages::propertyNotWritable(asyncResp->res,
2021                                                   "IPv6DefaultGateway");
2022                 }
2023 
2024                 if (ipv6StaticAddresses)
2025                 {
2026                     nlohmann::json ipv6Static = *ipv6StaticAddresses;
2027                     handleIPv6StaticAddressesPatch(ifaceId, ipv6Static,
2028                                                    ipv6Data, asyncResp);
2029                 }
2030 
2031                 if (interfaceEnabled)
2032                 {
2033                     setEthernetInterfaceBoolProperty(
2034                         ifaceId, "NICEnabled", *interfaceEnabled, asyncResp);
2035                 }
2036             });
2037     }
2038 };
2039 
2040 /**
2041  * VlanNetworkInterface derived class for delivering VLANNetworkInterface
2042  * Schema
2043  */
2044 class VlanNetworkInterface : public Node
2045 {
2046   public:
2047     /*
2048      * Default Constructor
2049      */
2050     VlanNetworkInterface(App& app) :
2051         Node(app,
2052              "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/<str>/",
2053              std::string(), std::string())
2054     {
2055         entityPrivileges = {
2056             {boost::beast::http::verb::get, {{"Login"}}},
2057             {boost::beast::http::verb::head, {{"Login"}}},
2058             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
2059             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
2060             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
2061             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2062     }
2063 
2064   private:
2065     void parseInterfaceData(nlohmann::json& json_response,
2066                             const std::string& parent_iface_id,
2067                             const std::string& iface_id,
2068                             const EthernetInterfaceData& ethData)
2069     {
2070         // Fill out obvious data...
2071         json_response["Id"] = iface_id;
2072         json_response["@odata.id"] =
2073             "/redfish/v1/Managers/bmc/EthernetInterfaces/" + parent_iface_id +
2074             "/VLANs/" + iface_id;
2075 
2076         json_response["VLANEnable"] = true;
2077         if (!ethData.vlan_id.empty())
2078         {
2079             json_response["VLANId"] = ethData.vlan_id.back();
2080         }
2081     }
2082 
2083     bool verifyNames(const std::string& parent, const std::string& iface)
2084     {
2085         if (!boost::starts_with(iface, parent + "_"))
2086         {
2087             return false;
2088         }
2089         return true;
2090     }
2091 
2092     /**
2093      * Functions triggers appropriate requests on DBus
2094      */
2095     void doGet(crow::Response& res, const crow::Request&,
2096                const std::vector<std::string>& params) override
2097     {
2098         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2099         // TODO(Pawel) this shall be parameterized call (two params) to get
2100         // EthernetInterfaces for any Manager, not only hardcoded 'openbmc'.
2101         // Check if there is required param, truly entering this shall be
2102         // impossible.
2103         if (params.size() != 2)
2104         {
2105             messages::internalError(res);
2106             res.end();
2107             return;
2108         }
2109 
2110         const std::string& parentIfaceId = params[0];
2111         const std::string& ifaceId = params[1];
2112         res.jsonValue["@odata.type"] =
2113             "#VLanNetworkInterface.v1_1_0.VLanNetworkInterface";
2114         res.jsonValue["Name"] = "VLAN Network Interface";
2115 
2116         if (!verifyNames(parentIfaceId, ifaceId))
2117         {
2118             return;
2119         }
2120 
2121         // Get single eth interface data, and call the below callback for
2122         // JSON preparation
2123         getEthernetIfaceData(
2124             params[1],
2125             [this, asyncResp, parentIfaceId{std::string(params[0])},
2126              ifaceId{std::string(params[1])}](
2127                 const bool& success, const EthernetInterfaceData& ethData,
2128                 const boost::container::flat_set<IPv4AddressData>&,
2129                 const boost::container::flat_set<IPv6AddressData>&) {
2130                 if (success && ethData.vlan_id.size() != 0)
2131                 {
2132                     parseInterfaceData(asyncResp->res.jsonValue, parentIfaceId,
2133                                        ifaceId, ethData);
2134                 }
2135                 else
2136                 {
2137                     // ... otherwise return error
2138                     // TODO(Pawel)consider distinguish between non existing
2139                     // object, and other errors
2140                     messages::resourceNotFound(
2141                         asyncResp->res, "VLAN Network Interface", ifaceId);
2142                 }
2143             });
2144     }
2145 
2146     void doPatch(crow::Response& res, const crow::Request& req,
2147                  const std::vector<std::string>& params) override
2148     {
2149         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2150         if (params.size() != 2)
2151         {
2152             messages::internalError(asyncResp->res);
2153             return;
2154         }
2155 
2156         const std::string& parentIfaceId = params[0];
2157         const std::string& ifaceId = params[1];
2158 
2159         if (!verifyNames(parentIfaceId, ifaceId))
2160         {
2161             messages::resourceNotFound(asyncResp->res, "VLAN Network Interface",
2162                                        ifaceId);
2163             return;
2164         }
2165 
2166         bool vlanEnable = false;
2167         uint32_t vlanId = 0;
2168 
2169         if (!json_util::readJson(req, res, "VLANEnable", vlanEnable, "VLANId",
2170                                  vlanId))
2171         {
2172             return;
2173         }
2174 
2175         // Get single eth interface data, and call the below callback for
2176         // JSON preparation
2177         getEthernetIfaceData(
2178             params[1],
2179             [asyncResp, parentIfaceId{std::string(params[0])},
2180              ifaceId{std::string(params[1])}, &vlanEnable,
2181              &vlanId](const bool& success, const EthernetInterfaceData& ethData,
2182                       const boost::container::flat_set<IPv4AddressData>&,
2183                       const boost::container::flat_set<IPv6AddressData>&) {
2184                 if (success && !ethData.vlan_id.empty())
2185                 {
2186                     auto callback =
2187                         [asyncResp](const boost::system::error_code ec) {
2188                             if (ec)
2189                             {
2190                                 messages::internalError(asyncResp->res);
2191                             }
2192                         };
2193 
2194                     if (vlanEnable == true)
2195                     {
2196                         crow::connections::systemBus->async_method_call(
2197                             std::move(callback), "xyz.openbmc_project.Network",
2198                             "/xyz/openbmc_project/network/" + ifaceId,
2199                             "org.freedesktop.DBus.Properties", "Set",
2200                             "xyz.openbmc_project.Network.VLAN", "Id",
2201                             std::variant<uint32_t>(vlanId));
2202                     }
2203                     else
2204                     {
2205                         BMCWEB_LOG_DEBUG << "vlanEnable is false. Deleting the "
2206                                             "vlan interface";
2207                         crow::connections::systemBus->async_method_call(
2208                             std::move(callback), "xyz.openbmc_project.Network",
2209                             std::string("/xyz/openbmc_project/network/") +
2210                                 ifaceId,
2211                             "xyz.openbmc_project.Object.Delete", "Delete");
2212                     }
2213                 }
2214                 else
2215                 {
2216                     // TODO(Pawel)consider distinguish between non existing
2217                     // object, and other errors
2218                     messages::resourceNotFound(
2219                         asyncResp->res, "VLAN Network Interface", ifaceId);
2220                     return;
2221                 }
2222             });
2223     }
2224 
2225     void doDelete(crow::Response& res, const crow::Request&,
2226                   const std::vector<std::string>& params) override
2227     {
2228         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2229         if (params.size() != 2)
2230         {
2231             messages::internalError(asyncResp->res);
2232             return;
2233         }
2234 
2235         const std::string& parentIfaceId = params[0];
2236         const std::string& ifaceId = params[1];
2237 
2238         if (!verifyNames(parentIfaceId, ifaceId))
2239         {
2240             messages::resourceNotFound(asyncResp->res, "VLAN Network Interface",
2241                                        ifaceId);
2242             return;
2243         }
2244 
2245         // Get single eth interface data, and call the below callback for
2246         // JSON preparation
2247         getEthernetIfaceData(
2248             params[1],
2249             [asyncResp, parentIfaceId{std::string(params[0])},
2250              ifaceId{std::string(params[1])}](
2251                 const bool& success, const EthernetInterfaceData& ethData,
2252                 const boost::container::flat_set<IPv4AddressData>&,
2253                 const boost::container::flat_set<IPv6AddressData>&) {
2254                 if (success && !ethData.vlan_id.empty())
2255                 {
2256                     auto callback =
2257                         [asyncResp](const boost::system::error_code ec) {
2258                             if (ec)
2259                             {
2260                                 messages::internalError(asyncResp->res);
2261                             }
2262                         };
2263                     crow::connections::systemBus->async_method_call(
2264                         std::move(callback), "xyz.openbmc_project.Network",
2265                         std::string("/xyz/openbmc_project/network/") + ifaceId,
2266                         "xyz.openbmc_project.Object.Delete", "Delete");
2267                 }
2268                 else
2269                 {
2270                     // ... otherwise return error
2271                     // TODO(Pawel)consider distinguish between non existing
2272                     // object, and other errors
2273                     messages::resourceNotFound(
2274                         asyncResp->res, "VLAN Network Interface", ifaceId);
2275                 }
2276             });
2277     }
2278 };
2279 
2280 /**
2281  * VlanNetworkInterfaceCollection derived class for delivering
2282  * VLANNetworkInterface Collection Schema
2283  */
2284 class VlanNetworkInterfaceCollection : public Node
2285 {
2286   public:
2287     VlanNetworkInterfaceCollection(App& app) :
2288         Node(app, "/redfish/v1/Managers/bmc/EthernetInterfaces/<str>/VLANs/",
2289              std::string())
2290     {
2291         entityPrivileges = {
2292             {boost::beast::http::verb::get, {{"Login"}}},
2293             {boost::beast::http::verb::head, {{"Login"}}},
2294             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
2295             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
2296             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
2297             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2298     }
2299 
2300   private:
2301     /**
2302      * Functions triggers appropriate requests on DBus
2303      */
2304     void doGet(crow::Response& res, const crow::Request&,
2305                const std::vector<std::string>& params) override
2306     {
2307         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2308         if (params.size() != 1)
2309         {
2310             // This means there is a problem with the router
2311             messages::internalError(asyncResp->res);
2312             return;
2313         }
2314 
2315         const std::string& rootInterfaceName = params[0];
2316 
2317         // Get eth interface list, and call the below callback for JSON
2318         // preparation
2319         getEthernetIfaceList(
2320             [asyncResp, rootInterfaceName{std::string(rootInterfaceName)}](
2321                 const bool& success,
2322                 const boost::container::flat_set<std::string>& iface_list) {
2323                 if (!success)
2324                 {
2325                     messages::internalError(asyncResp->res);
2326                     return;
2327                 }
2328 
2329                 if (iface_list.find(rootInterfaceName) == iface_list.end())
2330                 {
2331                     messages::resourceNotFound(asyncResp->res,
2332                                                "VLanNetworkInterfaceCollection",
2333                                                rootInterfaceName);
2334                     return;
2335                 }
2336 
2337                 asyncResp->res.jsonValue["@odata.type"] =
2338                     "#VLanNetworkInterfaceCollection."
2339                     "VLanNetworkInterfaceCollection";
2340                 asyncResp->res.jsonValue["Name"] =
2341                     "VLAN Network Interface Collection";
2342 
2343                 nlohmann::json ifaceArray = nlohmann::json::array();
2344 
2345                 for (const std::string& ifaceItem : iface_list)
2346                 {
2347                     if (boost::starts_with(ifaceItem, rootInterfaceName + "_"))
2348                     {
2349                         std::string path =
2350                             "/redfish/v1/Managers/bmc/EthernetInterfaces/";
2351                         path += rootInterfaceName;
2352                         path += "/VLANs/";
2353                         path += ifaceItem;
2354                         ifaceArray.push_back({{"@odata.id", std::move(path)}});
2355                     }
2356                 }
2357 
2358                 asyncResp->res.jsonValue["Members@odata.count"] =
2359                     ifaceArray.size();
2360                 asyncResp->res.jsonValue["Members"] = std::move(ifaceArray);
2361                 asyncResp->res.jsonValue["@odata.id"] =
2362                     "/redfish/v1/Managers/bmc/EthernetInterfaces/" +
2363                     rootInterfaceName + "/VLANs";
2364             });
2365     }
2366 
2367     void doPost(crow::Response& res, const crow::Request& req,
2368                 const std::vector<std::string>& params) override
2369     {
2370         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2371         if (params.size() != 1)
2372         {
2373             messages::internalError(asyncResp->res);
2374             return;
2375         }
2376         bool vlanEnable = false;
2377         uint32_t vlanId = 0;
2378         if (!json_util::readJson(req, res, "VLANId", vlanId, "VLANEnable",
2379                                  vlanEnable))
2380         {
2381             return;
2382         }
2383         // Need both vlanId and vlanEnable to service this request
2384         if (!vlanId)
2385         {
2386             messages::propertyMissing(asyncResp->res, "VLANId");
2387         }
2388         if (!vlanEnable)
2389         {
2390             messages::propertyMissing(asyncResp->res, "VLANEnable");
2391         }
2392         if (static_cast<bool>(vlanId) ^ vlanEnable)
2393         {
2394             return;
2395         }
2396 
2397         const std::string& rootInterfaceName = params[0];
2398         auto callback = [asyncResp](const boost::system::error_code ec) {
2399             if (ec)
2400             {
2401                 // TODO(ed) make more consistent error messages based on
2402                 // phosphor-network responses
2403                 messages::internalError(asyncResp->res);
2404                 return;
2405             }
2406             messages::created(asyncResp->res);
2407         };
2408         crow::connections::systemBus->async_method_call(
2409             std::move(callback), "xyz.openbmc_project.Network",
2410             "/xyz/openbmc_project/network",
2411             "xyz.openbmc_project.Network.VLAN.Create", "VLAN",
2412             rootInterfaceName, vlanId);
2413     }
2414 };
2415 } // namespace redfish
2416