11bbe3d1eSWilliam A. Kennington III #pragma once 21bbe3d1eSWilliam A. Kennington III #include "types.hpp" 31bbe3d1eSWilliam A. Kennington III 41bbe3d1eSWilliam A. Kennington III #include <netinet/ether.h> 51bbe3d1eSWilliam A. Kennington III #include <unistd.h> 61bbe3d1eSWilliam A. Kennington III 71bbe3d1eSWilliam A. Kennington III #include <cstring> 8a520a39dSWilliam A. Kennington III #include <filesystem> 91bbe3d1eSWilliam A. Kennington III #include <optional> 101bbe3d1eSWilliam A. Kennington III #include <sdbusplus/bus.hpp> 1169f4554bSWilliam A. Kennington III #include <stdplus/zstring.hpp> 1269f4554bSWilliam A. Kennington III #include <stdplus/zstring_view.hpp> 131bbe3d1eSWilliam A. Kennington III #include <string> 141bbe3d1eSWilliam A. Kennington III #include <string_view> 1595530ec9SWilliam A. Kennington III #include <unordered_set> 161bbe3d1eSWilliam A. Kennington III #include <xyz/openbmc_project/Network/EthernetInterface/server.hpp> 171bbe3d1eSWilliam A. Kennington III 181bbe3d1eSWilliam A. Kennington III namespace phosphor 191bbe3d1eSWilliam A. Kennington III { 201bbe3d1eSWilliam A. Kennington III namespace network 211bbe3d1eSWilliam A. Kennington III { 22*20efa79fSWilliam A. Kennington III namespace config 23*20efa79fSWilliam A. Kennington III { 24*20efa79fSWilliam A. Kennington III class Parser; 25*20efa79fSWilliam A. Kennington III } 261bbe3d1eSWilliam A. Kennington III 271bbe3d1eSWilliam A. Kennington III using EthernetInterfaceIntf = 281bbe3d1eSWilliam A. Kennington III sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface; 291bbe3d1eSWilliam A. Kennington III 301bbe3d1eSWilliam A. Kennington III constexpr auto IPV4_MIN_PREFIX_LENGTH = 1; 311bbe3d1eSWilliam A. Kennington III constexpr auto IPV4_MAX_PREFIX_LENGTH = 32; 321bbe3d1eSWilliam A. Kennington III constexpr auto IPV6_MAX_PREFIX_LENGTH = 128; 331bbe3d1eSWilliam A. Kennington III 341bbe3d1eSWilliam A. Kennington III namespace mac_address 351bbe3d1eSWilliam A. Kennington III { 361bbe3d1eSWilliam A. Kennington III 371bbe3d1eSWilliam A. Kennington III /** @brief gets the MAC address from the Inventory. 381bbe3d1eSWilliam A. Kennington III * @param[in] bus - DBUS Bus Object. 391bbe3d1eSWilliam A. Kennington III * @param[in] intfName - Interface name 401bbe3d1eSWilliam A. Kennington III */ 41c38b0710SPatrick Williams ether_addr getfromInventory(sdbusplus::bus_t& bus, const std::string& intfName); 421bbe3d1eSWilliam A. Kennington III 431bbe3d1eSWilliam A. Kennington III /** @brief Converts the given mac address into byte form 441bbe3d1eSWilliam A. Kennington III * @param[in] str - The mac address in human readable form 451bbe3d1eSWilliam A. Kennington III * @returns A mac address in network byte order 461bbe3d1eSWilliam A. Kennington III * @throws std::runtime_error for bad mac 471bbe3d1eSWilliam A. Kennington III */ 4869f4554bSWilliam A. Kennington III ether_addr fromString(stdplus::zstring_view str); 491bbe3d1eSWilliam A. Kennington III 501bbe3d1eSWilliam A. Kennington III /** @brief Converts the given mac address bytes into a string 511bbe3d1eSWilliam A. Kennington III * @param[in] mac - The mac address 521bbe3d1eSWilliam A. Kennington III * @returns A valid mac address string 531bbe3d1eSWilliam A. Kennington III */ 541bbe3d1eSWilliam A. Kennington III std::string toString(const ether_addr& mac); 551bbe3d1eSWilliam A. Kennington III 561bbe3d1eSWilliam A. Kennington III /** @brief Determines if the mac address is empty 571bbe3d1eSWilliam A. Kennington III * @param[in] mac - The mac address 581bbe3d1eSWilliam A. Kennington III * @return True if 00:00:00:00:00:00 591bbe3d1eSWilliam A. Kennington III */ 601bbe3d1eSWilliam A. Kennington III bool isEmpty(const ether_addr& mac); 611bbe3d1eSWilliam A. Kennington III 621bbe3d1eSWilliam A. Kennington III /** @brief Determines if the mac address is a multicast address 631bbe3d1eSWilliam A. Kennington III * @param[in] mac - The mac address 641bbe3d1eSWilliam A. Kennington III * @return True if multicast bit is set 651bbe3d1eSWilliam A. Kennington III */ 661bbe3d1eSWilliam A. Kennington III bool isMulticast(const ether_addr& mac); 671bbe3d1eSWilliam A. Kennington III 681bbe3d1eSWilliam A. Kennington III /** @brief Determines if the mac address is a unicast address 691bbe3d1eSWilliam A. Kennington III * @param[in] mac - The mac address 701bbe3d1eSWilliam A. Kennington III * @return True if not multicast or empty 711bbe3d1eSWilliam A. Kennington III */ 721bbe3d1eSWilliam A. Kennington III bool isUnicast(const ether_addr& mac); 731bbe3d1eSWilliam A. Kennington III 741bbe3d1eSWilliam A. Kennington III } // namespace mac_address 751bbe3d1eSWilliam A. Kennington III 761bbe3d1eSWilliam A. Kennington III constexpr auto networkdService = "systemd-networkd.service"; 771bbe3d1eSWilliam A. Kennington III constexpr auto timeSynchdService = "systemd-timesyncd.service"; 781bbe3d1eSWilliam A. Kennington III 791bbe3d1eSWilliam A. Kennington III /* @brief converts a sockaddr for the specified address family into 801bbe3d1eSWilliam A. Kennington III * a type_safe InAddrAny. 811bbe3d1eSWilliam A. Kennington III * @param[in] addressFamily - The address family of the buf 821bbe3d1eSWilliam A. Kennington III * @param[in] buf - The network byte order address 831bbe3d1eSWilliam A. Kennington III */ 841bbe3d1eSWilliam A. Kennington III InAddrAny addrFromBuf(int addressFamily, std::string_view buf); 851bbe3d1eSWilliam A. Kennington III 861bbe3d1eSWilliam A. Kennington III /* @brief converts the ip bytes into a string representation 871bbe3d1eSWilliam A. Kennington III * @param[in] addr - input ip address to convert. 881bbe3d1eSWilliam A. Kennington III * @returns String representation of the ip. 891bbe3d1eSWilliam A. Kennington III */ 901bbe3d1eSWilliam A. Kennington III std::string toString(const InAddrAny& addr); 911bbe3d1eSWilliam A. Kennington III std::string toString(const struct in_addr& addr); 921bbe3d1eSWilliam A. Kennington III std::string toString(const struct in6_addr& addr); 931bbe3d1eSWilliam A. Kennington III 941bbe3d1eSWilliam A. Kennington III /* @brief checks that the given ip address valid or not. 951bbe3d1eSWilliam A. Kennington III * @param[in] addressFamily - IP address family(AF_INET/AF_INET6). 961bbe3d1eSWilliam A. Kennington III * @param[in] address - IP address. 971bbe3d1eSWilliam A. Kennington III * @returns true if it is valid otherwise false. 981bbe3d1eSWilliam A. Kennington III */ 9969f4554bSWilliam A. Kennington III bool isValidIP(int addressFamily, stdplus::const_zstring address); 1001bbe3d1eSWilliam A. Kennington III 1011bbe3d1eSWilliam A. Kennington III /* @brief checks that the given prefix is valid or not. 1021bbe3d1eSWilliam A. Kennington III * @param[in] addressFamily - IP address family(AF_INET/AF_INET6). 1031bbe3d1eSWilliam A. Kennington III * @param[in] prefix - prefix length. 1041bbe3d1eSWilliam A. Kennington III * @returns true if it is valid otherwise false. 1051bbe3d1eSWilliam A. Kennington III */ 1061bbe3d1eSWilliam A. Kennington III bool isValidPrefix(int addressFamily, uint8_t prefixLength); 1071bbe3d1eSWilliam A. Kennington III 1081bbe3d1eSWilliam A. Kennington III /** @brief Get all the interfaces from the system. 1091bbe3d1eSWilliam A. Kennington III * @returns list of interface names. 1101bbe3d1eSWilliam A. Kennington III */ 1111bbe3d1eSWilliam A. Kennington III InterfaceList getInterfaces(); 1121bbe3d1eSWilliam A. Kennington III 1131bbe3d1eSWilliam A. Kennington III /** @brief Delete the given interface. 1141bbe3d1eSWilliam A. Kennington III * @param[in] intf - interface name. 1151bbe3d1eSWilliam A. Kennington III */ 11669f4554bSWilliam A. Kennington III void deleteInterface(stdplus::const_zstring intf); 1171bbe3d1eSWilliam A. Kennington III 1181bbe3d1eSWilliam A. Kennington III /** @brief Converts the interface name into a u-boot environment 1191bbe3d1eSWilliam A. Kennington III * variable that would hold its ethernet address. 1201bbe3d1eSWilliam A. Kennington III * 1211bbe3d1eSWilliam A. Kennington III * @param[in] intf - interface name 1221bbe3d1eSWilliam A. Kennington III * @return The name of th environment key 1231bbe3d1eSWilliam A. Kennington III */ 12469f4554bSWilliam A. Kennington III std::optional<std::string> interfaceToUbootEthAddr(std::string_view intf); 1251bbe3d1eSWilliam A. Kennington III 126a520a39dSWilliam A. Kennington III /** @brief read the IPv6AcceptRA value from the configuration file 127a520a39dSWilliam A. Kennington III * @param[in] config - The parsed configuration. 1281bbe3d1eSWilliam A. Kennington III */ 129a520a39dSWilliam A. Kennington III bool getIPv6AcceptRA(const config::Parser& config); 130a520a39dSWilliam A. Kennington III 131a520a39dSWilliam A. Kennington III /** @brief read the DHCP value from the configuration file 132a520a39dSWilliam A. Kennington III * @param[in] config - The parsed configuration. 133a520a39dSWilliam A. Kennington III */ 1348060c0daSWilliam A. Kennington III struct DHCPVal 1358060c0daSWilliam A. Kennington III { 1368060c0daSWilliam A. Kennington III bool v4, v6; 1378060c0daSWilliam A. Kennington III }; 1388060c0daSWilliam A. Kennington III DHCPVal getDHCPValue(const config::Parser& config); 1391bbe3d1eSWilliam A. Kennington III 140e94c9ffcSWilliam A. Kennington III /** @brief Read a boolean DHCP property from a conf file 141e94c9ffcSWilliam A. Kennington III * @param[in] config - The parsed configuration. 142e94c9ffcSWilliam A. Kennington III * @param[in] key - The property name. 143e94c9ffcSWilliam A. Kennington III */ 144e94c9ffcSWilliam A. Kennington III bool getDHCPProp(const config::Parser& config, std::string_view key); 145e94c9ffcSWilliam A. Kennington III 1461bbe3d1eSWilliam A. Kennington III namespace internal 1471bbe3d1eSWilliam A. Kennington III { 1481bbe3d1eSWilliam A. Kennington III 1491bbe3d1eSWilliam A. Kennington III /* @brief runs the given command in child process. 1501bbe3d1eSWilliam A. Kennington III * @param[in] path - path of the binary file which needs to be execeuted. 1511bbe3d1eSWilliam A. Kennington III * @param[in] args - arguments of the command. 1521bbe3d1eSWilliam A. Kennington III */ 15369f4554bSWilliam A. Kennington III void executeCommandinChildProcess(stdplus::const_zstring path, char** args); 1541bbe3d1eSWilliam A. Kennington III 1551bbe3d1eSWilliam A. Kennington III /** @brief Get ignored interfaces from environment */ 1561bbe3d1eSWilliam A. Kennington III std::string_view getIgnoredInterfacesEnv(); 1571bbe3d1eSWilliam A. Kennington III 1581bbe3d1eSWilliam A. Kennington III /** @brief Parse the comma separated interface names */ 15995530ec9SWilliam A. Kennington III std::unordered_set<std::string_view> 16095530ec9SWilliam A. Kennington III parseInterfaces(std::string_view interfaces); 1611bbe3d1eSWilliam A. Kennington III 1621bbe3d1eSWilliam A. Kennington III /** @brief Get the ignored interfaces */ 16395530ec9SWilliam A. Kennington III const std::unordered_set<std::string_view>& getIgnoredInterfaces(); 1641bbe3d1eSWilliam A. Kennington III 1651bbe3d1eSWilliam A. Kennington III } // namespace internal 1661bbe3d1eSWilliam A. Kennington III 1671bbe3d1eSWilliam A. Kennington III /* @brief runs the given command in child process. 1681bbe3d1eSWilliam A. Kennington III * @param[in] path -path of the binary file which needs to be execeuted. 1691bbe3d1eSWilliam A. Kennington III * @param[in] tArgs - arguments of the command. 1701bbe3d1eSWilliam A. Kennington III */ 1711bbe3d1eSWilliam A. Kennington III template <typename... ArgTypes> 17269f4554bSWilliam A. Kennington III void execute(stdplus::const_zstring path, ArgTypes&&... tArgs) 1731bbe3d1eSWilliam A. Kennington III { 1741bbe3d1eSWilliam A. Kennington III using expandType = char*[]; 1751bbe3d1eSWilliam A. Kennington III 1761bbe3d1eSWilliam A. Kennington III expandType args = {const_cast<char*>(tArgs)..., nullptr}; 1771bbe3d1eSWilliam A. Kennington III 1781bbe3d1eSWilliam A. Kennington III internal::executeCommandinChildProcess(path, args); 1791bbe3d1eSWilliam A. Kennington III } 1801bbe3d1eSWilliam A. Kennington III 1811bbe3d1eSWilliam A. Kennington III } // namespace network 1821bbe3d1eSWilliam A. Kennington III 1831bbe3d1eSWilliam A. Kennington III } // namespace phosphor 184