system.mac.cpp

#include <vcpkg/base/hash.h>
#include <vcpkg/base/parse.h>
#include <vcpkg/base/strings.h>
#include <vcpkg/base/system.mac.h>
#include <vcpkg/base/system.process.h>
#include <vcpkg/base/util.h>

#include <map>

#if !defined(_WIN32)
#include <net/if.h>
#if defined(__APPLE__) || defined(__FreeBSD__)
#include <ifaddrs.h>

#include <net/if_dl.h>
#define AF_TYPE AF_LINK
#elif defined(__linux__)
#include <ifaddrs.h>

#include <netpacket/packet.h>
#define AF_TYPE AF_PACKET
#else
// Fallback to use ioctl calls for systems without getifaddrs()
#include <unistd.h>

#include <netinet/in.h>
#include <sys/ioctl.h>
#include <sys/socket.h>
#endif
#endif

namespace vcpkg
{
    static constexpr size_t MAC_BYTES_LENGTH = 6;
    // 6 hex-bytes (12 hex-digits) + five separators
    static constexpr size_t MAC_STRING_LENGTH = MAC_BYTES_LENGTH * 2 + 5;

    bool validate_mac_address_format(StringView mac)
    {
        static constexpr char format[] = "xx:xx:xx:xx:xx:xx";
        if (mac.size() != MAC_STRING_LENGTH) return false;
        for (size_t i = 0; i < MAC_STRING_LENGTH; ++i)
        {
            if (format[i] == ':' && mac[i] != ':') return false;
            if (format[i] == 'x' && !ParserBase::is_hex_digit(mac[i])) return false;
        }
        return true;
    }

    bool is_valid_mac_for_telemetry(StringView mac)
    {
        // this exclusion list is the taken from VS Code's source code
        // https://github.com/microsoft/vscode/blob/main/src/vs/base/node/macAddress.ts
        static constexpr std::array<StringLiteral, 3> invalid_macs{
            "00:00:00:00:00:00",
            "ff:ff:ff:ff:ff:ff",
            // iBridge MAC address used on some Apple devices
            "ac:de:48:00:11:22",
        };

        if (!validate_mac_address_format(mac)) return false;
        return !Util::Vectors::contains(invalid_macs, mac);
    }

    std::string mac_bytes_to_string(const Span<char>& bytes)
    {
        if (bytes.size() != MAC_BYTES_LENGTH) return {};

        static constexpr char hexits[] = "0123456789abcdef";
        char mac_address[MAC_STRING_LENGTH];
        char* mac = mac_address;
        unsigned char non_zero_mac = 0;
        for (size_t i = 0; i < MAC_BYTES_LENGTH; ++i)
        {
            if (i > 0)
            {
                *mac++ = ':';
            }
            unsigned char c = bytes[i];
            *mac++ = hexits[(c & 0xf0) >> 4];
            *mac++ = hexits[(c & 0x0f)];
            non_zero_mac |= c;
        }
        return std::string(mac_address, non_zero_mac ? MAC_STRING_LENGTH : 0);
    }

    bool extract_mac_from_getmac_output_line(StringView line, std::string& out)
    {
        // getmac /V /NH /FO CSV
        // outputs each interface on its own comma-separated line
        // "connection name","network adapter","physical address","transport name"
        auto is_quote = [](auto ch) -> bool { return ch == '"'; };

        auto parser = ParserBase(line, "getmac ouptut");

        out.clear();

        // ignore "connection name"
        if (parser.require_character('"')) return false;
        parser.match_until(is_quote);
        if (parser.require_character('"')) return false;
        if (parser.require_character(',')) return false;

        // ignore "network adapter"
        if (parser.require_character('"')) return false;
        parser.match_until(is_quote);
        if (parser.require_character('"')) return false;
        if (parser.require_character(',')) return false;

        // get "physical address"
        if (parser.require_character('"')) return false;
        out = parser.match_until(is_quote).to_string();
        if (parser.require_character('"')) return false;
        if (parser.require_character(',')) return false;

        // ignore "transport name"
        if (parser.require_character('"')) return false;
        parser.match_until(is_quote);
        if (parser.require_character('"')) return false;

        parser.skip_whitespace();
        if (!parser.at_eof())
        {
            out.clear();
            return false;
        }

        // output line was properly formatted
        std::replace(out.begin(), out.end(), '-', ':');
        Strings::inplace_ascii_to_lowercase(out);
        return true;
    }

    std::string get_user_mac_hash()
    {
#if defined(_WIN32)
        // getmac /V /NH /FO CSV
        // outputs each interface on its own comma-separated line
        // "connection name","network adapter","physical address","transport name"
        auto maybe_getmac = cmd_execute_and_capture_output(
            Command("getmac").string_arg("/V").string_arg("/NH").string_arg("/FO").string_arg("CSV"));
        if (auto getmac = maybe_getmac.get())
        {
            for (auto&& line : Strings::split(getmac->output, '\n'))
            {
                std::string mac;
                if (extract_mac_from_getmac_output_line(line, mac) && is_valid_mac_for_telemetry(mac))
                {
                    return Hash::get_string_hash(mac, Hash::Algorithm::Sha256);
                }
            }
        }
#elif defined(__linux__) || defined(__APPLE__) || defined(__FreeBSD__)
        // The getifaddrs(ifaddrs** ifap) function creates a linked list of structures
        // describing the network interfaces of the local system, and stores
        // the address of the first item of the list in *ifap.
        // man page: https://www.man7.org/linux/man-pages/man3/getifaddrs.3.html
        struct ifaddrs_guard
        {
            ifaddrs* ptr = nullptr;
            ~ifaddrs_guard()
            {
                if (ptr) freeifaddrs(ptr);
            }
        } interfaces;

        if (getifaddrs(&interfaces.ptr) < 0)
        {
            return "0";
        }

        for (auto interface = interfaces.ptr; interface; interface = interface->ifa_next)
        {
            // The ifa_addr field points to a structure containing the interface
            // address (the sa_family subfield should be consulted to
            // determine the format of the address structure).  This field may
            // contain a null pointer.
            if (!interface->ifa_addr || interface->ifa_addr->sa_family != AF_TYPE ||
                (interface->ifa_flags & IFF_LOOPBACK) || !(interface->ifa_flags & IFF_UP) ||
                !(interface->ifa_flags & IFF_RUNNING))
            {
                continue;
            }

            // Convert the generic sockaddr into a specified representation
            // based on the value of sa_family, on macOS the AF_PACKET
            // family is not available so we fall back to AF_LINK.
            // AF_PACKET and sockaddr_ll: https://man7.org/linux/man-pages/man7/packet.7.html
            // AF_LINK and sockaddr_dl: https://illumos.org/man/3SOCKET/sockaddr_dl
#if defined(__linux__)
            auto address = reinterpret_cast<sockaddr_ll*>(interface->ifa_addr);
            if (address->sll_halen != MAC_BYTES_LENGTH) continue;
            auto mac_bytes = Span<char>(reinterpret_cast<char*>(address->sll_addr), MAC_BYTES_LENGTH);
#elif defined(__APPLE__) || defined(__FreeBSD__)
            auto address = reinterpret_cast<sockaddr_dl*>(interface->ifa_addr);
            if (address->sdl_alen != MAC_BYTES_LENGTH) continue;
            // The macro LLADDR() returns the start of the link-layer network address.
            auto mac_bytes = Span<char>(reinterpret_cast<char*>(LLADDR(address)), MAC_BYTES_LENGTH);
#endif
            auto mac = mac_bytes_to_string(mac_bytes);
            if (is_valid_mac_for_telemetry(mac))
            {
                return Hash::get_string_hash(mac, Hash::Algorithm::Sha256);
            }
        }
#else
        // fallback for other platforms
        struct socket_guard
        {
            int fd = -1;
            ~socket_guard()
            {
                if (fd > 0) close(fd);
            }
            inline operator int() { return fd; }
        } fd{socket(AF_INET, SOCK_DGRAM, IPPROTO_IP)};

        if (fd == -1) return "0";

        ifconf interfaces;
        std::memset(&interfaces, 0, sizeof(ifconf));
        // Calling ioctl with ifconf.ifc_req set to null returns
        // the size of buffer needed to contain all interfaces
        // in ifconf.ifc_len.
        // https://www.man7.org/linux/man-pages/man7/netdevice.7.html
        if (ioctl(fd, SIOCGIFCONF, &interfaces) < 0) return "0";

        // add one to ensure that even if remainder > 0, we reserve enough space
        auto data = std::vector<ifreq>(interfaces.ifc_len / sizeof(ifreq) + 1);
        interfaces.ifc_req = data.data();
        if (ioctl(fd, SIOCGIFCONF, &interfaces) < 0) return "0";

        // On a successful call, ifc_req contains a pointer to an array
        // of ifreq structures filled with all currently active interface addresses.
        // Within each structure ifr_name will receive the interface name, and
        // ifr_addr the address.
        const ifreq* const end = interfaces.ifc_req + (interfaces.ifc_len / sizeof(ifreq));
        for (auto it = interfaces.ifc_req; it != end; ++it)
        {
            ifreq& interface = *it;

            // Retrieve interface hardware addresses (ignore loopback)
            if ((ioctl(fd, SIOCGIFFLAGS, &interface) >= 0) && !(interface.ifr_flags & IFF_LOOPBACK) &&
                (interface.ifr_flags & IFF_UP) && (interface.ifr_flags & IFF_RUNNING) &&
                (ioctl(fd, SIOCGIFHWADDR, &interface) >= 0))
            {
                auto mac = mac_bytes_to_string(Span<char>(interface.ifr_hwaddr.sa_data, MAC_BYTES_LENGTH));
                if (is_valid_mac_for_telemetry(mac))
                {
                    return Hash::get_string_hash(mac, Hash::Algorithm::Sha256);
                }
            }
        }
#endif
        return "0";
    }
}