aboutsummaryrefslogtreecommitdiff
path: root/Minecraft.Server/Access/WhitelistManager.cpp
diff options
context:
space:
mode:
authorkuwa <kuwa.com3@gmail.com>2026-03-15 16:32:50 +0900
committerGitHub <noreply@github.com>2026-03-15 02:32:50 -0500
commitf483074cd2ff2cc9e9c3ef1df4430d4a65d1fb2a (patch)
tree9cd094e38b2259ea913fecb7d6fde16046277182 /Minecraft.Server/Access/WhitelistManager.cpp
parent4d200a589dd3d0a8424eaef6c0d6fd454d16e411 (diff)
Dedicated Server Software - Minecraft.Server.exe (#498)
* add: Dedicated Server implementation - Introduced `ServerMain.cpp` for the dedicated server logic, handling command-line arguments, server initialization, and network management. - Created `postbuild_server.ps1` script for post-build tasks, including copying necessary resources and DLLs for the dedicated server. - Added `CopyServerAssets.cmake` to manage the copying of server assets during the build process, ensuring required files are available for the dedicated server. - Defined project filters in `Minecraft.Server.vcxproj.filters` for better organization of server-related files. * add: refactor world loader & add server properties - Introduced ServerLogger for logging startup steps and world I/O operations. - Implemented ServerProperties for loading and saving server configuration from `server.properties`. - Added WorldManager to handle world loading and creation based on server properties. - Updated ServerMain to integrate server properties loading and world management. - Enhanced project files to include new source and header files for the server components. * update: implement enhanced logging functionality with configurable log levels * update: update keyboard and mouse input initialization 1dc8a005ed111463c22c17b487e5ec8a3e2d30f3 * fix: change virtual screen resolution to 1920x1080(HD) Since 31881af56936aeef38ff322b975fd0 , `skinHud.swf` for 720 is not included in `MediaWindows64.arc`, the app crashes unless the virtual screen is set to HD. * fix: dedicated server build settings for miniaudio migration and missing sources - remove stale Windows64 Miles (mss64) link/copy references from server build - add Common/Filesystem/Filesystem.cpp to Minecraft.Server.vcxproj - add Windows64/PostProcesser.cpp to Minecraft.Server.vcxproj - fix unresolved externals (PostProcesser::*, FileExists) in dedicated server build * update: changed the virtual screen to 720p Since the crash caused by the 720p `skinHud.swf` not being included in `MediaWindows64.arc` has been resolved, switching back to 720p to reduce resource usage. * add: add Docker support for Dedicated Server add with entrypoint and build scripts * fix: add initial save for newly created worlds in dedicated server on the server side, I fixed the behavior introduced after commit aadb511, where newly created worlds are intentionally not saved to disk immediately. * update: add basically all configuration options that are implemented in the classes to `server.properties` * update: add LAN advertising configuration for server.properties LAN-Discovery, which isn’t needed in server mode and could potentially be a security risk, has also been disabled(only server mode). * add: add implementing interactive command line using linenoise - Integrated linenoise library for line editing and completion in the server console. - Updated ServerLogger to handle external writes safely during logging. - Modified ServerMain to initialize and manage the ServerCli for command input. - The implementation is separate from everything else, so it doesn't affect anything else. - The command input section and execution section are separated into threads. * update: enhance command line completion with predictive hints Like most command line tools, it highlights predictions in gray. * add: implement `StringUtils` for string manipulation and refactor usages Unified the scattered utility functions. * fix: send DisconnectPacket on shutdown and fix Win64 recv-thread teardown race Before this change, server/host shutdown closed sockets directly in ServerConnection::stop(), which bypassed the normal disconnect flow. As a result, clients could be dropped without receiving a proper DisconnectPacket during stop/kill/world-close paths. Also, WinsockNetLayer::Shutdown() could destroy synchronization objects while host-side recv threads were still exiting, causing a crash in RecvThreadProc (access violation on world close in host mode). * fix: return client to menus when Win64 host connection drops - Add client-side host disconnect handling in CPlatformNetworkManagerStub::DoWork() for _WINDOWS64. - When in QNET_STATE_GAME_PLAY as a non-host and WinsockNetLayer::IsConnected() becomes false, trigger g_NetworkManager.HandleDisconnect(false) to enter the normal disconnect/UI flow. - Use m_bLeaveGameOnTick as a one-shot guard to prevent repeated disconnect handling while the link remains down. - Reset m_bLeaveGameOnTick on LeaveGame(), HostGame(), and JoinGame() to avoid stale state across sessions. * update: converted Japanese comments to English * add: create `Minecraft.Server` developer guide in English and Japanese * update: add note about issue * add: add `nlohmann/json` json lib * add: add FileUtils Moved file operations to `utils`. * add: Dedicated Server BAN access manager with persistent player and IP bans - add Access frontend that publishes thread-safe ban manager snapshots for dedicated server use - add BanManager storage for banned-players.json and banned-ips.json with load/save/update flows - add persistent player and IP ban checks during dedicated server connection handling - add UTF-8 BOM-safe JSON parsing and shared file helpers backed by nlohmann/json - add Unicode-safe ban file read/write and safer atomic replacement behavior on Windows - add active-ban snapshot APIs and expiry-aware filtering for expires metadata - add RAII-based dedicated access shutdown handling during server startup and teardown * update: changed file read/write operations to use `FileUtils`. - As a side effect, saving has become faster! * fix: Re-added the source that had somehow disappeared. * add: significantly improved the dedicated server logging system - add ServerLogManager to Minecraft.Server as the single entry point for dedicated-server log output - forward CMinecraftApp logger output to the server logger when running with g_Win64DedicatedServer - add named network logs for incoming, accepted, rejected, and disconnected connections - cache connection metadata by smallId so player name and remote IP remain available for disconnect logs - keep Minecraft.Client changes minimal by using lightweight hook points and handling log orchestration on the server side * fix: added the updated library source * add: add `ban` and `pardon` commands for Player and IP * fix: fix stop command shutdown process add dedicated server shutdown request handling * fix: fixed the save logic during server shutdown Removed redundant repeated saves and eliminated the risks of async writes. * update: added new sever files to Docker entrypoint * fix: replace shutdown flag with atomic variable for thread safety * update: update Dedicated Server developer guide English is machine translated. Please forgive me. * update: check for the existence of `GameHDD` and create * add: add Whitelist to Dedicated Server * refactor: clean up and refactor the code - unify duplicated implementations that were copied repeatedly - update outdated patterns to more modern ones * fix: include UI header (new update fix) * fix: fix the detection range for excessive logging `getHighestNonEmptyY()` returning `-1` occurs normally when the chunk is entirely air. The caller (`Minecraft.World/LevelChunk.cpp:2400`) normalizes `-1` to `0`. * update: add world size config to dedicated server properties * update: update README add explanation of `server.properties` & launch arguments * update: add nightly release workflow for dedicated server and client builds to Actions * fix: update name for workflow * add random seed generation * add: add Docker nightly workflow for Dedicated Server publish to GitHub Container Registry * fix: ghost player when clients disconnect out of order #4 * fix: fix 7zip option * fix: fix Docker workflow for Dedicated Server artifact handling * add: add no build Dedicated Server startup scripts and Docker Compose * update: add README for Docker Dedicated Server setup with no local build * refactor: refactor command path structure As the number of commands has increased and become harder to navigate, each command has been organized into separate folders. * update: support stream(file stdin) input mode for server CLI Support for the stream (file stdin) required when attaching a tty to a Docker container on Linux. * add: add new CLI Console Commands for Dedicated Server Most of these commands are executed using the command dispatcher implemented on the `Minecraft.World` side. When registering them with the dispatcher, the sender uses a permission-enabled configuration that treats the CLI as a player. - default game. - enchant - experience. - give - kill(currently, getting a permission error for some reason) - time - weather. - update tp & gamemode command * fix: change player map icon to random select * update: increase the player limit * add: restore the basic anti-cheat implementation and add spawn protection Added the following anti-cheat measures and add spawn protection to `server.properties`. - instant break - speed - reach * fix: fix Docker image tag --------- Co-authored-by: sylvessa <225480449+sylvessa@users.noreply.github.com>
Diffstat (limited to 'Minecraft.Server/Access/WhitelistManager.cpp')
-rw-r--r--Minecraft.Server/Access/WhitelistManager.cpp297
1 files changed, 297 insertions, 0 deletions
diff --git a/Minecraft.Server/Access/WhitelistManager.cpp b/Minecraft.Server/Access/WhitelistManager.cpp
new file mode 100644
index 00000000..33ea7e46
--- /dev/null
+++ b/Minecraft.Server/Access/WhitelistManager.cpp
@@ -0,0 +1,297 @@
+#include "stdafx.h"
+
+#include "WhitelistManager.h"
+
+#include "..\Common\AccessStorageUtils.h"
+#include "..\Common\FileUtils.h"
+#include "..\Common\StringUtils.h"
+#include "..\ServerLogger.h"
+#include "..\vendor\nlohmann\json.hpp"
+
+#include <algorithm>
+
+namespace ServerRuntime
+{
+ namespace Access
+ {
+ using OrderedJson = nlohmann::ordered_json;
+
+ namespace
+ {
+ static const char *kWhitelistFileName = "whitelist.json";
+ }
+
+ WhitelistManager::WhitelistManager(const std::string &baseDirectory)
+ : m_baseDirectory(baseDirectory.empty() ? "." : baseDirectory)
+ {
+ }
+
+ bool WhitelistManager::EnsureWhitelistFileExists() const
+ {
+ const std::string path = GetWhitelistFilePath();
+ if (!AccessStorageUtils::EnsureJsonListFileExists(path))
+ {
+ LogErrorf("access", "failed to create %s", path.c_str());
+ return false;
+ }
+ return true;
+ }
+
+ bool WhitelistManager::Reload()
+ {
+ std::vector<WhitelistedPlayerEntry> players;
+ if (!LoadPlayers(&players))
+ {
+ return false;
+ }
+
+ m_whitelistedPlayers.swap(players);
+ return true;
+ }
+
+ bool WhitelistManager::Save() const
+ {
+ std::vector<WhitelistedPlayerEntry> players;
+ return SnapshotWhitelistedPlayers(&players) && SavePlayers(players);
+ }
+
+ bool WhitelistManager::LoadPlayers(std::vector<WhitelistedPlayerEntry> *outEntries) const
+ {
+ if (outEntries == nullptr)
+ {
+ return false;
+ }
+ outEntries->clear();
+
+ std::string text;
+ const std::string path = GetWhitelistFilePath();
+ if (!FileUtils::ReadTextFile(path, &text))
+ {
+ LogErrorf("access", "failed to read %s", path.c_str());
+ return false;
+ }
+
+ if (text.empty())
+ {
+ text = "[]";
+ }
+
+ OrderedJson root;
+ try
+ {
+ root = OrderedJson::parse(StringUtils::StripUtf8Bom(text));
+ }
+ catch (const nlohmann::json::exception &e)
+ {
+ LogErrorf("access", "failed to parse %s: %s", path.c_str(), e.what());
+ return false;
+ }
+
+ if (!root.is_array())
+ {
+ LogErrorf("access", "failed to parse %s: root json value is not an array", path.c_str());
+ return false;
+ }
+
+ for (const auto &object : root)
+ {
+ if (!object.is_object())
+ {
+ LogWarnf("access", "skipping whitelist entry that is not an object in %s", path.c_str());
+ continue;
+ }
+
+ std::string rawXuid;
+ if (!AccessStorageUtils::TryGetStringField(object, "xuid", &rawXuid))
+ {
+ LogWarnf("access", "skipping whitelist entry without xuid in %s", path.c_str());
+ continue;
+ }
+
+ WhitelistedPlayerEntry entry;
+ entry.xuid = AccessStorageUtils::NormalizeXuid(rawXuid);
+ if (entry.xuid.empty())
+ {
+ LogWarnf("access", "skipping whitelist entry with empty xuid in %s", path.c_str());
+ continue;
+ }
+
+ AccessStorageUtils::TryGetStringField(object, "name", &entry.name);
+ AccessStorageUtils::TryGetStringField(object, "created", &entry.metadata.created);
+ AccessStorageUtils::TryGetStringField(object, "source", &entry.metadata.source);
+ NormalizeMetadata(&entry.metadata);
+
+ outEntries->push_back(entry);
+ }
+
+ return true;
+ }
+
+ bool WhitelistManager::SavePlayers(const std::vector<WhitelistedPlayerEntry> &entries) const
+ {
+ OrderedJson root = OrderedJson::array();
+ for (const auto &entry : entries)
+ {
+ OrderedJson object = OrderedJson::object();
+ object["xuid"] = AccessStorageUtils::NormalizeXuid(entry.xuid);
+ object["name"] = entry.name;
+ object["created"] = entry.metadata.created;
+ object["source"] = entry.metadata.source;
+ root.push_back(object);
+ }
+
+ const std::string path = GetWhitelistFilePath();
+ const std::string json = root.empty() ? std::string("[]\n") : (root.dump(2) + "\n");
+ if (!FileUtils::WriteTextFileAtomic(path, json))
+ {
+ LogErrorf("access", "failed to write %s", path.c_str());
+ return false;
+ }
+ return true;
+ }
+
+ const std::vector<WhitelistedPlayerEntry> &WhitelistManager::GetWhitelistedPlayers() const
+ {
+ return m_whitelistedPlayers;
+ }
+
+ bool WhitelistManager::SnapshotWhitelistedPlayers(std::vector<WhitelistedPlayerEntry> *outEntries) const
+ {
+ if (outEntries == nullptr)
+ {
+ return false;
+ }
+
+ *outEntries = m_whitelistedPlayers;
+ return true;
+ }
+
+ bool WhitelistManager::IsPlayerWhitelistedByXuid(const std::string &xuid) const
+ {
+ const auto normalized = AccessStorageUtils::NormalizeXuid(xuid);
+ if (normalized.empty())
+ {
+ return false;
+ }
+
+ return std::any_of(
+ m_whitelistedPlayers.begin(),
+ m_whitelistedPlayers.end(),
+ [&normalized](const WhitelistedPlayerEntry &entry)
+ {
+ return entry.xuid == normalized;
+ });
+ }
+
+ bool WhitelistManager::AddPlayer(const WhitelistedPlayerEntry &entry)
+ {
+ std::vector<WhitelistedPlayerEntry> updatedEntries;
+ if (!SnapshotWhitelistedPlayers(&updatedEntries))
+ {
+ return false;
+ }
+
+ auto normalized = entry;
+ normalized.xuid = AccessStorageUtils::NormalizeXuid(normalized.xuid);
+ NormalizeMetadata(&normalized.metadata);
+ if (normalized.xuid.empty())
+ {
+ return false;
+ }
+
+ const auto existing = std::find_if(
+ updatedEntries.begin(),
+ updatedEntries.end(),
+ [&normalized](const WhitelistedPlayerEntry &candidate)
+ {
+ return candidate.xuid == normalized.xuid;
+ });
+
+ if (existing != updatedEntries.end())
+ {
+ *existing = normalized;
+ if (!SavePlayers(updatedEntries))
+ {
+ return false;
+ }
+
+ m_whitelistedPlayers.swap(updatedEntries);
+ return true;
+ }
+
+ updatedEntries.push_back(normalized);
+ if (!SavePlayers(updatedEntries))
+ {
+ return false;
+ }
+
+ m_whitelistedPlayers.swap(updatedEntries);
+ return true;
+ }
+
+ bool WhitelistManager::RemovePlayerByXuid(const std::string &xuid)
+ {
+ const auto normalized = AccessStorageUtils::NormalizeXuid(xuid);
+ if (normalized.empty())
+ {
+ return false;
+ }
+
+ std::vector<WhitelistedPlayerEntry> updatedEntries;
+ if (!SnapshotWhitelistedPlayers(&updatedEntries))
+ {
+ return false;
+ }
+
+ const auto oldSize = updatedEntries.size();
+ updatedEntries.erase(
+ std::remove_if(
+ updatedEntries.begin(),
+ updatedEntries.end(),
+ [&normalized](const WhitelistedPlayerEntry &entry) { return entry.xuid == normalized; }),
+ updatedEntries.end());
+
+ if (updatedEntries.size() == oldSize)
+ {
+ return false;
+ }
+
+ if (!SavePlayers(updatedEntries))
+ {
+ return false;
+ }
+
+ m_whitelistedPlayers.swap(updatedEntries);
+ return true;
+ }
+
+ std::string WhitelistManager::GetWhitelistFilePath() const
+ {
+ return BuildPath(kWhitelistFileName);
+ }
+
+ WhitelistMetadata WhitelistManager::BuildDefaultMetadata(const char *source)
+ {
+ WhitelistMetadata metadata;
+ metadata.created = StringUtils::GetCurrentUtcTimestampIso8601();
+ metadata.source = (source != nullptr) ? source : "Server";
+ return metadata;
+ }
+
+ void WhitelistManager::NormalizeMetadata(WhitelistMetadata *metadata)
+ {
+ if (metadata == nullptr)
+ {
+ return;
+ }
+
+ metadata->created = StringUtils::TrimAscii(metadata->created);
+ metadata->source = StringUtils::TrimAscii(metadata->source);
+ }
+
+ std::string WhitelistManager::BuildPath(const char *fileName) const
+ {
+ return AccessStorageUtils::BuildPathFromBaseDirectory(m_baseDirectory, fileName);
+ }
+ }
+}