feat: Add name change protection config option (#90)

This allows dimensions to prevent a clients character name from changing by the server sending a different name. It also rewrites packets to ensure that both client -> server and server -> client use the name stored by dimensions. Exclusions are provided when particular dimensions actually require this functionality, whilst still providing an unchanging name for other dimensions.
popstarfreas · Oct 31, 2021 · 11a1dd4 · 11a1dd4
1 parent ad579dd
commit 11a1dd4
Show file tree

Hide file tree

Showing 6 changed files with 170 additions and 34 deletions.
diff --git a/app/node_modules/dimensions/client.ts b/app/node_modules/dimensions/client.ts
diff --git a/app/node_modules/dimensions/clientpackethandler.ts b/app/node_modules/dimensions/clientpackethandler.ts
diff --git a/app/node_modules/dimensions/configloader.ts b/app/node_modules/dimensions/configloader.ts
diff --git a/app/node_modules/dimensions/terrariaserverpackethandler.ts b/app/node_modules/dimensions/terrariaserverpackethandler.ts
diff --git a/config.js.example b/config.js.example
@@ -134,5 +134,19 @@ exports.ConfigSettings = {
             host: "localhost",
             port: 6379
         },
+
+        nameChanges: {
+            // Prevents a server from changing client's name in dimensions
+            // modes:
+            //  * "legacy" - Behaviour of v5.9.1 and lower
+            //               1. Passes through player info packets from client and server even if they have
+            //                  a mismatched name.
+            //  * "rewrite" - 1. Never updates a client's name dimensions-side after it has been set,
+            //                   unless the packet is from the server and it is excluded from this rule.
+            //                2. Rewrites packets from the client and the server if they have a name mismatch.
+            mode: "legacy",
+            // A list of dimension names that are allowed (only the server itself, not client) to update a client's name
+            rewriteExclusions: [],
+        },
     }
 };
diff --git a/config.js.quickstart b/config.js.quickstart
@@ -85,5 +85,19 @@ exports.ConfigSettings = {
             host: "localhost",
             port: 6379
         },
+
+        nameChanges: {
+            // Prevents a server from changing client's name in dimensions
+            // modes:
+            //  * "legacy" - Behaviour of v5.9.1 and lower
+            //               1. Passes through player info packets from client and server even if they have
+            //                  a mismatched name.
+            //  * "rewrite" - 1. Never updates a client's name dimensions-side after it has been set,
+            //                   unless the packet is from the server and it is excluded from this rule.
+            //                2. Rewrites packets from the client and the server if they have a name mismatch.
+            mode: "legacy",
+            // A list of dimension names that are allowed (only the server itself, not client) to update a client's name
+            rewriteExclusions: [],
+        },
     }
 };