feat: Verified mods

NorthstarDLL/NorthstarDLL.vcxproj

@@ -567,6 +567,7 @@
     <ClInclude Include="exploitfixes.h" />
     <ClInclude Include="exploitfixes_utf8parser.h" />
     <ClInclude Include="nsmem.h" />
+    <ClInclude Include="verifiedmods.h" />
     <ClInclude Include="version.h" />
   </ItemGroup>
   <ItemGroup>
@@ -629,6 +630,7 @@
     <ClCompile Include="sourceinterface.cpp" />
     <ClCompile Include="squirrel.cpp" />
     <ClCompile Include="exploitfixes.cpp" />
+    <ClCompile Include="verifiedmods.cpp" />
     <ClCompile Include="version.cpp" />
   </ItemGroup>
   <ItemGroup>

NorthstarDLL/NorthstarDLL.vcxproj.filters

@@ -1521,6 +1521,9 @@
     <ClInclude Include="scriptjson.h">
       <Filter>Header Files\Shared</Filter>
     </ClInclude>
+    <ClInclude Include="verifiedmods.h">
+      <Filter>Header Files\Client</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="dllmain.cpp">
@@ -1538,9 +1541,6 @@
     <ClCompile Include="dedicated.cpp">
       <Filter>Source Files\Server\Dedicated</Filter>
     </ClCompile>
-    <ClCompile Include="sourceconsole.cpp">
-      <Filter>Source Files\Client</Filter>
-    </ClCompile>
     <ClCompile Include="squirrel.cpp">
       <Filter>Source Files\Shared</Filter>
     </ClCompile>
@@ -1694,6 +1694,12 @@
     <ClCompile Include="scriptutility.cpp">
       <Filter>Source Files\Shared</Filter>
     </ClCompile>
+    <ClCompile Include="sourceconsole.cpp">
+      <Filter>Source Files\Dedicated</Filter>
+    </ClCompile>
+    <ClCompile Include="verifiedmods.cpp">
+      <Filter>Source Files\Client</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <MASM Include="audio_asm.asm">

NorthstarDLL/dllmain.cpp

@@ -46,6 +46,7 @@
 #include "version.h"
 #include "pch.h"
 #include "scriptutility.h"
+#include "verifiedmods.h"
 
 #include "rapidjson/document.h"
 #include "rapidjson/stringbuffer.h"
@@ -243,6 +244,7 @@ bool InitialiseNorthstar()
 		AddDllLoadCallbackForClient("engine.dll", InitialiseChatCommands);
 		AddDllLoadCallbackForClient("client.dll", InitialiseScriptModMenu);
 		AddDllLoadCallbackForClient("client.dll", InitialiseScriptServerBrowser);
+		AddDllLoadCallbackForClient("client.dll", InitialiseVerifiedModsScripts);
 		AddDllLoadCallbackForClient("localize.dll", InitialiseModLocalisation);
 		AddDllLoadCallbackForClient("engine.dll", InitialiseClientAuthHooks);
 		AddDllLoadCallbackForClient("client.dll", InitialiseLatencyFleX);

NorthstarDLL/verifiedmods.cpp

@@ -0,0 +1,169 @@
+#include "pch.h"
+#include "masterserver.h"
+#include "rapidjson/document.h"
+#include "rapidjson/writer.h"
+#include "rapidjson/stringbuffer.h"
+#include "squirrel.h"
+#include "verifiedmods.h"
+
+using namespace rapidjson;
+
+Document verifiedModsJson;
+
+// Test string used to test branch without masterserver
+const char* modsTestString =
+	"{"
+	"\"Dinorush's LTS Rebalance\" : {\"DependencyPrefix\" : \"Dinorush-LTSRebalance\", \"Versions\" : []}, "
+	"\"Dinorush.Brute4\" : {\"DependencyPrefix\" : \"Dinorush-Brute4\", \"Versions\" : [  \"1.5\", \"1.6\" ]}, "
+	"\"Mod Settings\" : {\"DependencyPrefix\" : \"EladNLG-ModSettings\", \"Versions\" : [ \"1.0.0\", \"1.1.0\" ]}, "
+	"\"Moblin.Archon\" : {\"DependencyPrefix\" : \"GalacticMoblin-MoblinArchon\", \"Versions\" : [ \"1.3.0\", \"1.3.1\" ]}"
+	"}";
+
+void _FetchVerifiedModsList() {
+	spdlog::info("Requesting verified mods list from {}", Cvar_ns_masterserver_hostname->GetString());
+
+	std::thread requestThread([]() {
+		CURL* curl = curl_easy_init();
+
+		std::string readBuffer;
+		curl_easy_setopt(curl, CURLOPT_URL, fmt::format("{}/client/verifiedmods", Cvar_ns_masterserver_hostname->GetString()).c_str());
+		curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
+		curl_easy_setopt(curl, CURLOPT_WRITEDATA, &readBuffer);
+
+		// TODO fetch list from masterserver
+		verifiedModsJson.Parse( modsTestString );
+		return;
+
+		CURLcode result = curl_easy_perform(curl);
+		spdlog::info(result);
+
+		if (result == CURLcode::CURLE_OK)
+		{
+			spdlog::info("curl succeeded");
+
+			verifiedModsJson.Parse(readBuffer.c_str());
+
+			if (verifiedModsJson.HasParseError())
+			{
+				spdlog::error("Failed reading masterserver verified mods response: encountered parse error.");
+				goto REQUEST_END_CLEANUP;
+			}
+			if (!verifiedModsJson.IsObject())
+			{
+				spdlog::error("Failed reading masterserver verified mods response: root object is not an object");
+				goto REQUEST_END_CLEANUP;
+			}
+			if (verifiedModsJson.HasMember("error"))
+			{
+				spdlog::error("Failed reading masterserver response: got fastify error response");
+				spdlog::error(readBuffer);
+				if (verifiedModsJson["error"].HasMember("enum"))
+					spdlog::error(std::string(verifiedModsJson["error"]["enum"].GetString()));
+				else
+					spdlog::error(std::string("No error message provided"));
+				goto REQUEST_END_CLEANUP;
+			}
+		}
+		else
+		{
+			spdlog::error("Failed requesting verified mods list: error {}", curl_easy_strerror(result));
+		}
+
+		REQUEST_END_CLEANUP:
+			curl_easy_cleanup(curl);
+	});
+	requestThread.detach();
+}
+
+std::string GetVerifiedModsList() {
+	if (verifiedModsJson.IsNull())
+	{
+		_FetchVerifiedModsList();
+
+		while (verifiedModsJson.IsNull())
+		{
+			spdlog::info("Wait for verified mods list to arrive...");
+			Sleep(2000); // TODO do this asynchronously to avoid blocking the thread
+		}
+
+		spdlog::info("Verified mods list arrived.");
+	}
+
+	StringBuffer buffer;
+	Writer<StringBuffer> writer(buffer);
+	verifiedModsJson.Accept(writer);
+	return buffer.GetString();
+}
+
+/**
+* Checks if a mod is verified by controlling if its name matches a key in the verified mods JSON
+* document, and if its version is included in the JSON versions list.
+*/
+bool IsModVerified(char* modName, char* modVersion)
+{
+	// 1. Mod is not verified if its name isn't a `verifiedModsJson` key.
+	if (!verifiedModsJson.HasMember(modName))
+	{
+		spdlog::info("Mod \"{}\" is not verified, and thus couldn't be downloaded.", modName);
+		return false;
+	}
+
+	// 2. Check if mod version has been validated.
+	const Value& entry = verifiedModsJson[modName];
+	GenericArray versions = entry["Versions"].GetArray();
+
+	spdlog::info("There's an entry for mod \"{}\", now checking version...", modName);
+
+	for (rapidjson::Value::ConstValueIterator iterator = versions.Begin(); iterator != versions.End(); iterator++)
+	{
+		const rapidjson::Value& version = *iterator;
+		if (strcmp(version.GetString(), modVersion) == 0)
+		{
+			spdlog::info("Mod \"{}\" (version {}) is verified.", modName, modVersion);
+			return true;
+		}
+	}
+
+	spdlog::info("Required version {} for mod \"{}\" is not verified, and thus couldn't be downloaded.", modVersion, modName);
+	return false;
+}
+
+void DownloadMod(char* modName, char* modVersion) {
+	if (!IsModVerified(modName, modVersion))
+		return;
+
+	// TODO check if mod is already present
+	// TODO check if mod is verified (throw if not)
+	// TODO download zip in temporary folder
+	// TODO move mod to mods/ folder
+}
+
+
+
+/**
+ * Squirrel-exposed wrapper methods
+ **/ 
+
+SQRESULT SQ_GetVerifiedModsList(void* sqvm)
+{
+	std::string mods = GetVerifiedModsList();
+	const SQChar* buffer = mods.c_str();
+	ClientSq_pushstring(sqvm, buffer, -1);
+	return SQRESULT_NOTNULL;
+}
+
+SQRESULT SQ_IsModVerified(void* sqvm)
+{
+	const SQChar* modName = ClientSq_getstring(sqvm, 1);
+	const SQChar* modVersion = ClientSq_getstring(sqvm, 2);
+
+	bool result = IsModVerified((char*)modName, (char*)modVersion);
+
+	ClientSq_pushbool(sqvm, result);
+	return SQRESULT_NOTNULL;
+}
+
+void InitialiseVerifiedModsScripts(HMODULE baseAddress) {
+	g_UISquirrelManager->AddFuncRegistration("string", "GetVerifiedModsList", "", "", SQ_GetVerifiedModsList);
+	g_UISquirrelManager->AddFuncRegistration("bool", "IsModVerified", "string modName, string modVersion", "", SQ_IsModVerified);
+}

NorthstarDLL/verifiedmods.h

@@ -0,0 +1,4 @@
+#pragma once
+#include "memalloc.h"
+
+void InitialiseVerifiedModsScripts(HMODULE baseAddress);