Merge pull request #225 from simoleo89/fix/user-profile-inputs

fix(users): bound profile setting inputs

Emulator/src/main/java/com/eu/habbo/messages/incoming/users/RequestProfileFriendsEvent.java

@@ -10,6 +10,10 @@ public class RequestProfileFriendsEvent extends MessageHandler {
     @Override
     public void handle() throws Exception {
         int userId = this.packet.readInt();
+
+        if (!UserInputGuard.isPositiveId(userId))
+            return;
+
         Habbo habbo = Emulator.getGameEnvironment().getHabboManager().getHabbo(userId);
 
         if (habbo != null)

Emulator/src/main/java/com/eu/habbo/messages/incoming/users/RequestUserProfileEvent.java

@@ -10,6 +10,10 @@ public class RequestUserProfileEvent extends MessageHandler {
     @Override
     public void handle() throws Exception {
         int habboId = this.packet.readInt();
+
+        if (!UserInputGuard.isPositiveId(habboId))
+            return;
+
         Habbo habbo = Emulator.getGameEnvironment().getHabboManager().getHabbo(habboId);
 
         if (habbo != null)

Emulator/src/main/java/com/eu/habbo/messages/incoming/users/RequestWearingBadgesEvent.java

@@ -10,6 +10,10 @@ public class RequestWearingBadgesEvent extends MessageHandler {
     @Override
     public void handle() throws Exception {
         int userId = this.packet.readInt();
+
+        if (!UserInputGuard.isPositiveId(userId))
+            return;
+
         Habbo habbo = Emulator.getGameServer().getGameClientManager().getHabbo(userId);
 
         if (habbo == null || habbo.getHabboInfo() == null || habbo.getInventory() == null || habbo.getInventory().getBadgesComponent() == null)

Emulator/src/main/java/com/eu/habbo/messages/incoming/users/SaveMottoEvent.java

@@ -9,15 +9,16 @@ import com.eu.habbo.plugin.events.users.UserSavedMottoEvent;
 public class SaveMottoEvent extends MessageHandler {
     @Override
     public void handle() throws Exception {
-        String motto = Emulator.getGameEnvironment().getWordFilter().filter(this.packet.readString(), this.client.getHabbo());
+        String motto = UserInputGuard.normalizeText(Emulator.getGameEnvironment().getWordFilter().filter(this.packet.readString(), this.client.getHabbo()));
         UserSavedMottoEvent event = new UserSavedMottoEvent(this.client.getHabbo(), this.client.getHabbo().getHabboInfo().getMotto(), motto);
         Emulator.getPluginManager().fireEvent(event);
-        motto = event.newMotto;
+        motto = UserInputGuard.normalizeText(event.newMotto);
 
-        if(motto.length() <= Emulator.getConfig().getInt("motto.max_length", 38)) {
-            this.client.getHabbo().getHabboInfo().setMotto(motto);
-            this.client.getHabbo().getHabboInfo().run();
-        }
+        if (motto.length() > Emulator.getConfig().getInt("motto.max_length", 38))
+            return;
+
+        this.client.getHabbo().getHabboInfo().setMotto(motto);
+        this.client.getHabbo().getHabboInfo().run();
 
         if (this.client.getHabbo().getHabboInfo().getCurrentRoom() != null) {
             this.client.getHabbo().getHabboInfo().getCurrentRoom().sendComposer(new RoomUserDataComposer(this.client.getHabbo()).compose());

Emulator/src/main/java/com/eu/habbo/messages/incoming/users/SaveUserVolumesEvent.java

@@ -7,9 +7,9 @@ import com.eu.habbo.plugin.events.users.UserSavedSettingsEvent;
 public class SaveUserVolumesEvent extends MessageHandler {
     @Override
     public void handle() throws Exception {
-        int system = this.packet.readInt();
-        int furni = this.packet.readInt();
-        int trax = this.packet.readInt();
+        int system = UserInputGuard.clampVolume(this.packet.readInt());
+        int furni = UserInputGuard.clampVolume(this.packet.readInt());
+        int trax = UserInputGuard.clampVolume(this.packet.readInt());
 
         this.client.getHabbo().getHabboStats().volumeSystem = system;
         this.client.getHabbo().getHabboStats().volumeFurni = furni;

Emulator/src/main/java/com/eu/habbo/messages/incoming/users/UpdateUIFlagsEvent.java

@@ -5,7 +5,7 @@ import com.eu.habbo.messages.incoming.MessageHandler;
 public class UpdateUIFlagsEvent extends MessageHandler {
     @Override
     public void handle() throws Exception {
-        int flags = this.packet.readInt();
+        int flags = UserInputGuard.sanitizeUiFlags(this.packet.readInt());
 
         this.client.getHabbo().getHabboStats().uiFlags = flags;
         this.client.getHabbo().getHabboStats().run();

Emulator/src/main/java/com/eu/habbo/messages/incoming/users/UserInputGuard.java

@@ -0,0 +1,26 @@
+package com.eu.habbo.messages.incoming.users;
+
+final class UserInputGuard {
+    static final int MIN_VOLUME = 0;
+    static final int MAX_VOLUME = 100;
+    static final int MAX_UI_FLAGS = 0xFFFF;
+
+    private UserInputGuard() {
+    }
+
+    static boolean isPositiveId(int id) {
+        return id > 0;
+    }
+
+    static int clampVolume(int volume) {
+        return Math.max(MIN_VOLUME, Math.min(MAX_VOLUME, volume));
+    }
+
+    static int sanitizeUiFlags(int flags) {
+        return flags < 0 ? 0 : flags & MAX_UI_FLAGS;
+    }
+
+    static String normalizeText(String value) {
+        return value == null ? "" : value.trim();
+    }
+}

Emulator/src/test/java/com/eu/habbo/messages/incoming/users/UserInputGuardContractTest.java

@@ -0,0 +1,64 @@
+package com.eu.habbo.messages.incoming.users;
+
+import org.junit.jupiter.api.Test;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+class UserInputGuardContractTest {
+    private static String source(String name) throws Exception {
+        return Files.readString(Path.of("src/main/java/com/eu/habbo/messages/incoming/users/" + name + ".java"));
+    }
+
+    @Test
+    void userProfileLookupsRejectInvalidIdsBeforeOfflineQueries() throws Exception {
+        for (String handler : new String[]{"RequestUserProfileEvent", "RequestProfileFriendsEvent", "RequestWearingBadgesEvent"}) {
+            String source = source(handler);
+            int read = source.indexOf("this.packet.readInt()");
+            int guard = source.indexOf("UserInputGuard.isPositiveId", read);
+            int lookup = Math.max(source.indexOf("getOfflineHabboInfo", guard), source.indexOf("getBadgesOfflineHabbo", guard));
+
+            assertTrue(guard > read, handler + " should validate the packet id after reading it");
+            assertTrue(lookup == -1 || guard < lookup, handler + " should validate ids before offline lookups");
+        }
+    }
+
+    @Test
+    void settingsInputsAreNormalizedBeforePersistence() throws Exception {
+        String volumes = source("SaveUserVolumesEvent");
+        String flags = source("UpdateUIFlagsEvent");
+
+        assertTrue(volumes.contains("UserInputGuard.clampVolume(this.packet.readInt())"),
+                "volume settings should be clamped to the client-supported range");
+        assertTrue(flags.contains("UserInputGuard.sanitizeUiFlags(this.packet.readInt())"),
+                "UI flags should be sanitized before persistence");
+    }
+
+    @Test
+    void mottoIsNormalizedAndRejectedBeforeSaveSideEffects() throws Exception {
+        String motto = source("SaveMottoEvent");
+
+        int pluginValue = motto.indexOf("UserInputGuard.normalizeText(event.newMotto)");
+        int lengthGuard = motto.indexOf("motto.length() > Emulator.getConfig().getInt", pluginValue);
+        int save = motto.indexOf("setMotto(motto)", lengthGuard);
+        int achievement = motto.indexOf("AchievementManager.progressAchievement", save);
+
+        assertTrue(pluginValue > -1, "plugin-mutated motto should be normalized");
+        assertTrue(lengthGuard > pluginValue && lengthGuard < save,
+                "motto length should be validated before saving");
+        assertTrue(save < achievement,
+                "motto achievement should only progress after a valid save");
+    }
+
+    @Test
+    void helperClampsAndMasksValues() {
+        assertEquals(0, UserInputGuard.clampVolume(-20));
+        assertEquals(40, UserInputGuard.clampVolume(40));
+        assertEquals(100, UserInputGuard.clampVolume(101));
+        assertEquals(0, UserInputGuard.sanitizeUiFlags(-1));
+        assertEquals(0xFFFF, UserInputGuard.sanitizeUiFlags(0x1FFFF));
+    }
+}