Merge pull request #126 from diamante0018/dependabot/submodules/deps/libtommath-839ae9e

build(deps): bump deps/libtommath from `e823b0c` to `839ae9e`

.github/dependabot.yml

@@ -3,5 +3,5 @@ updates:
 - package-ecosystem: gitsubmodule
   directory: "/"
   schedule:
-    interval: daily
+    interval: monthly
   open-pull-requests-limit: 10

.github/workflows/build.yml

@@ -14,12 +14,12 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  PREMAKE_VERSION: "5.0.0-beta2"
+  PREMAKE_VERSION: "5.0.0-beta6"
 
 jobs:
   build:
     name: Build binaries
-    runs-on: windows-2022
+    runs-on: windows-2025
     strategy:
       matrix:
         configuration:

.github/workflows/check-formatting.yml

@@ -0,0 +1,28 @@
+name: check-formatting
+
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+    branches:
+      - "*"
+    types: [opened, synchronize, reopened]
+
+jobs:
+  check-formatting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@main
+
+      - name: Install LLVM and Clang
+        uses: KyleMayes/install-llvm-action@v2.0.2
+        with:
+          version: "17.0"
+
+      - name: Test formatting for all files
+        working-directory: ${{ github.workspace }}
+        run: |
+          export CLANG_FORMAT_BIN="${LLVM_PATH}/bin/clang-format"
+          ./scripts/check-format.sh

README.md

@@ -12,7 +12,7 @@ This software has been created purely for the purposes of academic research. It
 
 This software is a proof of concept for a vulnerability that is patched. You can't harm anyone with it if you use it on Pluto (If you were to update the addresses for the 1.9 patch of the game).
 You also can't use this vulnerability on Tekno as it was fixed in 2021 (2.0.6 version of their client).
-If you think your server is vulnerable you should seek help in the appropriate discord server or forum of the client you use.
+If you think your server is vulnerable, you should seek help from the appropriate Discord server or forum for your client.
 The exploit is documented in [exploit.cpp](src/client/component/exploit.cpp)
 
 ## Update

deps/premake/libtomcrypt.lua

@@ -27,6 +27,7 @@ end
 function libtomcrypt.project()
 	project "libtomcrypt"
 		language "C"
+		cdialect "C89"
 
 		libtomcrypt.includes()
 		libtommath.import()

deps/premake/libtommath.lua

@@ -25,6 +25,7 @@ end
 function libtommath.project()
 	project "libtommath"
 		language "C"
+		cdialect "C89"
 
 		libtommath.includes()
 

premake5.lua

@@ -60,7 +60,7 @@ filter {}
 filter "configurations:release"
 	optimize "Size"
 	defines {"NDEBUG"}
-	flags {"FatalCompileWarnings"}
+	fatalwarnings {"All"}
 
 	filter "toolset:msc*"
 		buildoptions "/GL"

scripts/check-format.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# Go to repository root
+cd "$(dirname "$0")/.." || exit 2
+
+CLANG_FORMAT_BIN="${CLANG_FORMAT_BIN:-clang-format}"
+
+find ./src -iname '*.hpp' -o -iname '*.cpp' | xargs $CLANG_FORMAT_BIN -Werror -ferror-limit=1 --dry-run

scripts/format.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Navigate to the repository root
+cd "$(dirname "$0")/.." || exit 2
+
+# Set the clang-format binary (defaults to 'clang-format')
+CLANG_FORMAT_BIN="${CLANG_FORMAT_BIN:-clang-format}"
+
+# Find and format all .hpp and .cpp files in the src directory
+find ./src \( -iname '*.hpp' -o -iname '*.cpp' \) -print0 |
+  xargs -0 "$CLANG_FORMAT_BIN" -i || {
+    echo "Error: clang-format failed." >&2
+    exit 1
+  }

src/client/component/console.cpp

@@ -2,7 +2,6 @@
 #include "loader/component_loader.hpp"
 
 #include <utils/hook.hpp>
-#include <utils/thread.hpp>
 #include <utils/flags.hpp>
 #include <utils/concurrency.hpp>
 
@@ -37,8 +36,7 @@ public:
   void post_start() override {
     this->terminate_runner_ = false;
 
-    this->console_runner_ = utils::thread::create_named_thread(
-        "Console IO", [this] { this->runner(); });
+    this->console_runner_ = std::thread([this] { this->runner(); });
   }
 
   void post_unpack() override {
@@ -77,31 +75,30 @@ private:
   int handles_[2]{};
 
   void initialize() {
-    this->console_thread_ =
-        utils::thread::create_named_thread("Console", [this] {
-          if (!utils::flags::has_flag("noconsole")) {
-            game::Sys_ShowConsole();
+    this->console_thread_ = std::thread([this] {
+      if (!utils::flags::has_flag("noconsole")) {
+        game::Sys_ShowConsole();
+      }
+
+      messages.access(
+          [&](message_queue&) { this->console_initialized_ = true; });
+
+      MSG msg;
+      while (!this->terminate_runner_) {
+        if (PeekMessageA(&msg, nullptr, NULL, NULL, PM_REMOVE)) {
+          if (msg.message == WM_QUIT) {
+            command::execute("quit", false);
+            break;
           }
 
-          messages.access(
-              [&](message_queue&) { this->console_initialized_ = true; });
-
-          MSG msg;
-          while (!this->terminate_runner_) {
-            if (PeekMessageA(&msg, nullptr, NULL, NULL, PM_REMOVE)) {
-              if (msg.message == WM_QUIT) {
-                command::execute("quit", false);
-                break;
-              }
-
-              TranslateMessage(&msg);
-              DispatchMessageA(&msg);
-            } else {
-              this->log_messages();
-              std::this_thread::sleep_for(1ms);
-            }
-          }
-        });
+          TranslateMessage(&msg);
+          DispatchMessageA(&msg);
+        } else {
+          this->log_messages();
+          std::this_thread::sleep_for(1ms);
+        }
+      }
+    });
   }
 
   void log_messages() const {

src/client/component/scheduler.cpp

@@ -3,7 +3,6 @@
 
 #include <utils/concurrency.hpp>
 #include <utils/hook.hpp>
-#include <utils/thread.hpp>
 
 #include "scheduler.hpp"
 
@@ -135,7 +134,7 @@ unsigned int thread_id;
 class component final : public component_interface {
 public:
   void post_unpack() override {
-    thread = utils::thread::create_named_thread("Async Scheduler", [] {
+    thread = std::thread([] {
       while (!kill) {
         execute(pipeline::async);
         std::this_thread::sleep_for(10ms);

src/client/dllmain.cpp

@@ -2,6 +2,19 @@
 #include "loader/component_loader.hpp"
 
 namespace {
+std::string get_current_date() {
+  auto now = std::chrono::system_clock::now();
+  auto current_time = std::chrono::system_clock::to_time_t(now);
+  std::tm local_time{};
+
+  (void)localtime_s(&local_time, &current_time);
+
+  std::stringstream ss;
+  ss << std::put_time(&local_time, "%Y%m%d_%H%M%S");
+
+  return ss.str();
+}
+
 LONG WINAPI exception_handler(PEXCEPTION_POINTERS exception_info) {
   if (exception_info->ExceptionRecord->ExceptionCode == 0x406D1388) {
     return EXCEPTION_CONTINUE_EXECUTION;
@@ -21,8 +34,8 @@ LONG WINAPI exception_handler(PEXCEPTION_POINTERS exception_info) {
                     | MiniDumpWithFullMemoryInfo     //
                     | MiniDumpWithThreadInfo;
 
-  const auto file_name = std::format("minidumps\\mw3-server-freezer_{}.dmp",
-                                     game::Sys_Milliseconds());
+  const auto file_name =
+      std::format("minidumps\\mw3-server-freezer_{}.dmp", get_current_date());
   const auto file_handle = CreateFileA(
       file_name.data(), GENERIC_WRITE | GENERIC_READ,
       FILE_SHARE_READ | FILE_SHARE_WRITE, nullptr, CREATE_ALWAYS,

src/client/game/game.cpp

@@ -24,4 +24,25 @@ void __declspec(naked) Dvar_SetVariant(dvar_t* /*dvar*/, DvarValue /*value*/,
     ret
   }
 }
+
+XAssetEntry* db_find_x_asset_entry(int type_, const char* name) {
+  static DWORD DB_FindXAssetEntry_t = 0x5c88a0;
+  XAssetEntry* result{};
+
+  __asm {
+      pushad
+      push name
+      mov edi, type_
+      call DB_FindXAssetEntry_t
+      add esp, 0x4
+      mov result, eax
+      popad
+  }
+
+  return result;
+}
+
+XAssetEntry* DB_FindXAssetEntry(int type, const char* name) {
+  return db_find_x_asset_entry(type, name);
+}
 } // namespace game

src/client/game/game.hpp

@@ -18,6 +18,8 @@ private:
 // clang-format off
 extern ScreenPlacement* ScrPlace_GetUnsafeFullPlacement();
 extern void Dvar_SetVariant(dvar_t* dvar, DvarValue value, DvarSetSource source);
+
+extern XAssetEntry* DB_FindXAssetEntry(int type, const char* name);
 // clang-format on
 } // namespace game
 

src/client/game/structs.hpp

@@ -9,6 +9,59 @@ typedef vec_t vec2_t[2];
 typedef vec_t vec3_t[3];
 typedef vec_t vec4_t[4];
 
+struct MaterialTechniqueSet {
+  const char* name;
+  unsigned char worldVertFormat;
+  unsigned char unused[2];
+  MaterialTechniqueSet* remappedTechniqueSet;
+  void* techniques[54];
+};
+
+struct __declspec(align(8)) GfxDrawSurfFields {
+  uint64_t unused : 1;
+  uint64_t primarySortKey : 6;
+  uint64_t surfType : 4;
+  uint64_t viewModelRender : 1;
+  uint64_t sceneLightIndex : 8;
+  uint64_t useHeroLighting : 1;
+  uint64_t prepass : 2;
+  uint64_t materialSortedIndex : 12;
+  uint64_t customIndex : 5;
+  uint64_t hasGfxEntIndex : 1;
+  uint64_t reflectionProbeIndex : 8;
+  uint64_t objectId : 15;
+};
+
+union GfxDrawSurf {
+  __declspec(align(8)) GfxDrawSurfFields fields;
+  __declspec(align(8)) uint64_t packed;
+};
+
+struct MaterialInfo {
+  const char* name;
+  unsigned char gameFlags;
+  unsigned char sortKey;
+  unsigned char textureAtlasRowCount;
+  unsigned char textureAtlasColumnCount;
+  GfxDrawSurf drawSurf;
+  unsigned int surfaceTypeBits;
+};
+
+struct Material {
+  MaterialInfo info;
+  char stateBitsEntry[54];
+  unsigned char textureCount;
+  unsigned char constantCount;
+  unsigned char stateBitsCount;
+  unsigned char stateFlags;
+  unsigned char cameraRegion;
+  MaterialTechniqueSet* techniqueSet;
+  void* textureTable;
+  void* constantTable;
+  void* stateBitsTable;
+  const char** subMaterials;
+};
+
 enum bdLogMessageType {
   BD_LOG_INFO,
   BD_LOG_WARNING,
@@ -261,6 +314,8 @@ struct usercmd_s {
   int remoteControlMove;
 };
 
+static_assert(offsetof(usercmd_s, buttons) == 0x4);
+
 enum LocSelInputState {
   LOC_SEL_INPUT_NONE = 0,
   LOC_SEL_INPUT_CONFIRM = 1,
@@ -367,6 +422,21 @@ struct Font_s {
 
 union XAssetHeader {
   Font_s* font;
+  Material* material;
+};
+
+struct XAsset {
+  int type;
+  XAssetHeader header;
+};
+
+struct XAssetEntry {
+  XAsset asset;
+  char zoneIndex;
+  volatile char inuseMask;
+  bool printedMissingAsset;
+  unsigned __int16 nextHash;
+  unsigned __int16 nextOverride;
 };
 
 } // namespace game

src/client/game/symbols.hpp

@@ -80,6 +80,9 @@ WEAK symbol<int(unsigned __int64, const void*, unsigned int)>
 WEAK symbol<XAssetHeader(int type, const char* name, int allowCreateDefault)>
     DB_FindXAssetHeader{0x4B25C0};
 
+WEAK symbol<int(char* dest, int size, const char* fmt, ...)> Com_sprintf{
+    0x450CF0};
+
 // Variables
 WEAK symbol<CmdArgs> cmd_args{0x1C96850};
 WEAK symbol<PlayerKeyState> playerKeys{0xB3A38C};

src/client/loader/component_loader.hpp

@@ -19,8 +19,8 @@ public:
 
   template <typename T> static T* get() {
     for (const auto& component_ : get_components()) {
-      if (typeid(*component_.get()) == typeid(T)) {
-        return reinterpret_cast<T*>(component_.get());
+      if (auto c = dynamic_cast<T*>(component_.get())) {
+        return c;
       }
     }
 

src/client/std_include.hpp

@@ -10,13 +10,16 @@
 
 #include <DbgHelp.h>
 
-#include <algorithm>
 #include <cassert>
 #include <cctype>
 #include <cstring>
+
+#include <algorithm>
+#include <chrono>
+#include <iomanip>
+#include <iostream>
 #include <format>
 #include <functional>
-#include <iostream>
 #include <mutex>
 #include <queue>
 #include <source_location>

src/common/utils/hook.cpp

@@ -103,24 +103,6 @@ void hook::quick() {
   }
 }
 
-bool hook::iat(const nt::library module, const std::string& target_module,
-               const std::string& process, void* stub) {
-  if (!module.is_valid())
-    return false;
-
-  auto ptr = module.get_iat_entry(target_module, process);
-  if (!ptr)
-    return false;
-
-  DWORD protect;
-  VirtualProtect(ptr, sizeof(*ptr), PAGE_EXECUTE_READWRITE, &protect);
-
-  *ptr = stub;
-
-  VirtualProtect(ptr, sizeof(*ptr), protect, &protect);
-  return true;
-}
-
 hook* hook::uninstall(const bool unprotect) {
   std::lock_guard _(this->state_mutex_);
 

src/common/utils/hook.hpp

@@ -75,9 +75,6 @@ public:
   void* get_original() const;
   void quick();
 
-  static bool iat(nt::library module, const std::string& target_module,
-                  const std::string& process, void* stub);
-
   static void nop(void* place, size_t length);
   static void nop(DWORD place, size_t length);
 

src/common/utils/nt.cpp

@@ -135,62 +135,6 @@ void library::free() {
 
 HMODULE library::get_handle() const { return this->module_; }
 
-void** library::get_iat_entry(const std::string& module_name,
-                              const std::string& proc_name) const {
-  if (!this->is_valid())
-    return nullptr;
-
-  const library other_module(module_name);
-  if (!other_module.is_valid())
-    return nullptr;
-
-  auto* const target_function = other_module.get_proc<void*>(proc_name);
-  if (!target_function)
-    return nullptr;
-
-  auto* header = this->get_optional_header();
-  if (!header)
-    return nullptr;
-
-  auto* import_descriptor = reinterpret_cast<PIMAGE_IMPORT_DESCRIPTOR>(
-      this->get_ptr() +
-      header->DataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT].VirtualAddress);
-
-  while (import_descriptor->Name) {
-    if (!_stricmp(
-            reinterpret_cast<char*>(this->get_ptr() + import_descriptor->Name),
-            module_name.data())) {
-      auto* original_thunk_data = reinterpret_cast<PIMAGE_THUNK_DATA>(
-          import_descriptor->OriginalFirstThunk + this->get_ptr());
-      auto* thunk_data = reinterpret_cast<PIMAGE_THUNK_DATA>(
-          import_descriptor->FirstThunk + this->get_ptr());
-
-      while (original_thunk_data->u1.AddressOfData) {
-        const size_t ordinal_number =
-            original_thunk_data->u1.AddressOfData & 0xFFFFFFF;
-
-        if (ordinal_number > 0xFFFF)
-          continue;
-
-        if (GetProcAddress(other_module.module_,
-                           reinterpret_cast<char*>(ordinal_number)) ==
-            target_function) {
-          return reinterpret_cast<void**>(&thunk_data->u1.Function);
-        }
-
-        ++original_thunk_data;
-        ++thunk_data;
-      }
-
-      // break;
-    }
-
-    ++import_descriptor;
-  }
-
-  return nullptr;
-}
-
 std::string load_resource(const int id) {
   auto* const res = FindResource(library(), MAKEINTRESOURCE(id), RT_RCDATA);
   if (!res)

src/common/utils/nt.hpp

@@ -48,27 +48,12 @@ public:
 
   HMODULE get_handle() const;
 
-  template <typename T> T get_proc(const std::string& process) const {
-    if (!this->is_valid())
-      return T{};
-    return reinterpret_cast<T>(GetProcAddress(this->module_, process.data()));
-  }
-
-  template <typename T> std::function<T> get(const std::string& process) const {
-    if (!this->is_valid())
-      return std::function<T>();
-    return reinterpret_cast<T*>(this->get_proc<void*>(process));
-  }
-
   std::vector<PIMAGE_SECTION_HEADER> get_section_headers() const;
 
   PIMAGE_NT_HEADERS get_nt_headers() const;
   PIMAGE_DOS_HEADER get_dos_header() const;
   PIMAGE_OPTIONAL_HEADER get_optional_header() const;
 
-  void** get_iat_entry(const std::string& module_name,
-                       const std::string& proc_name) const;
-
 private:
   HMODULE module_;
 };

src/common/utils/thread.cpp

@@ -1,105 +0,0 @@
-#include <thread>
-#include "nt.hpp"
-#include "string.hpp"
-
-#include "thread.hpp"
-
-#include <TlHelp32.h>
-
-#include <gsl/gsl>
-
-namespace utils::thread {
-bool set_name(const HANDLE t, const std::string& name) {
-  const nt::library kernel32("kernel32.dll");
-  if (!kernel32) {
-    return false;
-  }
-
-  const auto set_description =
-      kernel32.get_proc<HRESULT(WINAPI*)(HANDLE, PCWSTR)>(
-          "SetThreadDescription");
-  if (!set_description) {
-    return false;
-  }
-
-  return SUCCEEDED(set_description(t, string::convert(name).data()));
-}
-
-bool set_name(const DWORD id, const std::string& name) {
-  auto* const t = OpenThread(THREAD_SET_LIMITED_INFORMATION, FALSE, id);
-  if (!t)
-    return false;
-
-  const auto _ = gsl::finally([t]() { CloseHandle(t); });
-
-  return set_name(t, name);
-}
-
-bool set_name(std::thread& t, const std::string& name) {
-  return set_name(t.native_handle(), name);
-}
-
-bool set_name(const std::string& name) {
-  return set_name(GetCurrentThread(), name);
-}
-
-std::vector<DWORD> get_thread_ids() {
-  auto* const h =
-      CreateToolhelp32Snapshot(TH32CS_SNAPTHREAD, GetCurrentProcessId());
-  if (h == INVALID_HANDLE_VALUE) {
-    return {};
-  }
-
-  const auto _ = gsl::finally([h]() { CloseHandle(h); });
-
-  THREADENTRY32 entry{};
-  entry.dwSize = sizeof(entry);
-  if (!Thread32First(h, &entry)) {
-    return {};
-  }
-
-  std::vector<DWORD> ids;
-
-  do {
-    const auto check_size =
-        entry.dwSize < FIELD_OFFSET(THREADENTRY32, th32OwnerProcessID) +
-                           sizeof(entry.th32OwnerProcessID);
-    entry.dwSize = sizeof(entry);
-
-    if (check_size && entry.th32OwnerProcessID == GetCurrentProcessId()) {
-      ids.emplace_back(entry.th32ThreadID);
-    }
-  } while (Thread32Next(h, &entry));
-
-  return ids;
-}
-
-void for_each_thread(const std::function<void(HANDLE)>& callback) {
-  const auto ids = get_thread_ids();
-
-  for (const auto& id : ids) {
-    auto* const thread = OpenThread(THREAD_ALL_ACCESS, FALSE, id);
-    if (thread != nullptr) {
-      const auto _ = gsl::finally([thread]() { CloseHandle(thread); });
-
-      callback(thread);
-    }
-  }
-}
-
-void suspend_other_threads() {
-  for_each_thread([](const HANDLE thread) {
-    if (GetThreadId(thread) != GetCurrentThreadId()) {
-      SuspendThread(thread);
-    }
-  });
-}
-
-void resume_other_threads() {
-  for_each_thread([](const HANDLE thread) {
-    if (GetThreadId(thread) != GetCurrentThreadId()) {
-      ResumeThread(thread);
-    }
-  });
-}
-} // namespace utils::thread

src/common/utils/thread.hpp

@@ -1,21 +0,0 @@
-#pragma once
-
-namespace utils::thread {
-bool set_name(HANDLE t, const std::string& name);
-bool set_name(DWORD id, const std::string& name);
-bool set_name(std::thread& t, const std::string& name);
-bool set_name(const std::string& name);
-
-template <typename... Args>
-std::thread create_named_thread(const std::string& name, Args&&... args) {
-  auto t = std::thread(std::forward<Args>(args)...);
-  set_name(t, name);
-  return t;
-}
-
-std::vector<DWORD> get_thread_ids();
-void for_each_thread(const std::function<void(HANDLE)>& callback);
-
-void suspend_other_threads();
-void resume_other_threads();
-} // namespace utils::thread