OrcLib: Text: Fmt: add in_addr

Author: jgautier-anssi

src/OrcLib/CMakeLists.txt

@@ -658,6 +658,8 @@ set(SRC_TEXT
     "Text/Guid.cpp"
     "Text/Hex.h"
     "Text/HexDump.h"
+    "Text/in_addr.h"
+    "Text/in_addr.cpp"
     "Text/StdoutContainerAdapter.h"
     "Text/Tree.h"
     "Text/Tree.cpp"

src/OrcLib/OrcLib.h

@@ -30,6 +30,7 @@
 #include <type_traits>
 
 #include <Windows.h>
+#include <winsock.h>
 
 #include <Utils/Result.h>
 

src/OrcLib/Text/Fmt/in_addr.h

@@ -0,0 +1,62 @@
+//
+// SPDX-License-Identifier: LGPL-2.1-or-later
+//
+// Copyright © 2023 ANSSI. All Rights Reserved.
+//
+// Author(s): fabienfl (ANSSI)
+//
+
+#pragma once
+
+#include "Text/in_addr.h"
+
+namespace fmt_in_addr {
+
+static const char* kNotApplicable = "<N/A>";
+static const wchar_t* kNotApplicableW = L"<N/A>";
+
+}  // namespace fmt_in_addr
+
+template <>
+struct fmt::formatter<in_addr> : public fmt::formatter<std::string_view>
+{
+    template <typename FormatContext>
+    auto format(const in_addr& ip, FormatContext& ctx) -> decltype(ctx.out())
+    {
+        auto s = Orc::ToString(ip).value_or(fmt_in_addr::kNotApplicable);
+        return formatter<std::string_view>::format(s, ctx);
+    }
+};
+
+template <>
+struct fmt::formatter<in_addr, wchar_t> : public fmt::formatter<std::wstring_view, wchar_t>
+{
+    template <typename FormatContext>
+    auto format(const in_addr& ip, FormatContext& ctx) -> decltype(ctx.out())
+    {
+        auto s = Orc::ToWString(ip).value_or(fmt_in_addr::kNotApplicableW);
+        return formatter<std::wstring_view, wchar_t>::format(s, ctx);
+    }
+};
+
+template <>
+struct fmt::formatter<in6_addr> : public fmt::formatter<std::string_view>
+{
+    template <typename FormatContext>
+    auto format(const in6_addr& ip, FormatContext& ctx) -> decltype(ctx.out())
+    {
+        auto s = Orc::ToString(ip).value_or(fmt_in_addr::kNotApplicable);
+        return formatter<std::string_view>::format(s, ctx);
+    }
+};
+
+template <>
+struct fmt::formatter<in6_addr, wchar_t> : public fmt::formatter<std::wstring_view, wchar_t>
+{
+    template <typename FormatContext>
+    auto format(const in6_addr& ip, FormatContext& ctx) -> decltype(ctx.out())
+    {
+        auto s = Orc::ToWString(ip).value_or(fmt_in_addr::kNotApplicableW);
+        return formatter<std::wstring_view, wchar_t>::format(s, ctx);
+    }
+};

src/OrcLib/Text/in_addr.cpp

@@ -0,0 +1,102 @@
+#include "in_addr.h"
+
+#ifdef __has_include
+#    if __has_include("ip2string.h")
+#        define ENABLE_IP2STRING
+#    endif
+#endif
+
+#ifdef ENABLE_IP2STRING
+#include <ip2string.h>
+#include <Mstcpip.h>
+
+#include "Log/Log.h"
+#include "Text/Fmt/in_addr.h"
+
+#ifndef STATUS_SUCCESS
+#    define STATUS_SUCCESS 0
+#endif
+
+namespace {
+
+const static size_t kDefaultStringSize = 256;
+
+}
+
+namespace Orc {
+
+Result<std::string> ToString(const in_addr& ip)
+{
+    std::string s;
+    s.reserve(kDefaultStringSize);
+
+    ULONG size = s.size();
+    auto status = RtlIpv4AddressToStringExA(&ip, 0, s.data(), &size);
+    if (status != STATUS_SUCCESS)
+    {
+        std::error_code ec = SystemError(HRESULT_FROM_NT(status));
+        Log::Error("Failed RtlIpv4AddressToStringExA [{}]", ec);
+        return ec;
+    }
+
+    s.resize(size);
+    return s;
+}
+
+Result<std::wstring> ToWString(const in_addr& ip)
+{
+    std::wstring s;
+    s.reserve(kDefaultStringSize);
+
+    ULONG size = s.size();
+    auto status = RtlIpv4AddressToStringExW(&ip, 0, s.data(), &size);
+    if (status != STATUS_SUCCESS)
+    {
+        std::error_code ec = SystemError(HRESULT_FROM_NT(status));
+        Log::Error("Failed RtlIpv4AddressToStringExW [{}]", ec);
+        return ec;
+    }
+
+    s.resize(size);
+    return s;
+}
+
+Result<std::string> ToString(const in6_addr& ip)
+{
+    std::string s;
+    s.reserve(kDefaultStringSize);
+
+    ULONG size = s.size();
+    auto status = RtlIpv6AddressToStringExA(&ip, 0, 0, s.data(), &size);
+    if (status != STATUS_SUCCESS)
+    {
+        std::error_code ec = SystemError(HRESULT_FROM_NT(status));
+        Log::Error("Failed RtlIpv6AddressToStringExA [{}]", ec);
+        return ec;
+    }
+
+    s.resize(size);
+    return s;
+}
+
+Result<std::wstring> ToWString(const in6_addr& ip)
+{
+    std::wstring s;
+    s.reserve(kDefaultStringSize);
+
+    ULONG size = s.size();
+    auto status = RtlIpv6AddressToStringExW(&ip, 0, 0, s.data(), &size);
+    if (status != STATUS_SUCCESS)
+    {
+        std::error_code ec = SystemError(HRESULT_FROM_NT(status));
+        Log::Error("Failed RtlIpv6AddressToStringExW [{}]", ec);
+        return ec;
+    }
+
+    s.resize(size);
+    return s;
+}
+
+}  // namespace Orc
+
+#endif  // ENABLE_IP2STRING

src/OrcLib/Text/in_addr.h

@@ -0,0 +1,26 @@
+//
+// SPDX-License-Identifier: LGPL-2.1-or-later
+//
+// Copyright © 2022 ANSSI. All Rights Reserved.
+//
+// Author(s): jeanga (ANSSI)
+//
+
+#pragma once
+
+#include <string>
+
+#include <Utils/Result.h>
+
+struct in_addr;
+struct in6_addr;
+
+namespace Orc {
+
+Result<std::string> ToString(const in_addr& ip);
+Result<std::wstring> ToWString(const in_addr& ip);
+
+Result<std::string> ToString(const in6_addr& ip);
+Result<std::wstring> ToWString(const in6_addr& ip);
+
+}  // namespace Orc