Merge pull request #28 from RedCokeDevelopment/dev

Version 0.1.5.1 - Fix multiple CVE vulnerabilities from dependence

Author: RedTeaDev

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>dev.redcoke</groupId>
     <artifactId>mcserverping</artifactId>
-    <version>0.1.5</version>
+    <version>0.1.5.1</version>
 
     <name>MCServerPing</name>
     <description>A Java API for obtaining info about a Minecraft Server</description>
@@ -61,10 +61,6 @@
             <name>jcenter-bintray</name>
             <url>https://jcenter.bintray.com</url>
         </repository>
-        <repository>
-            <id>bungeecord-repo</id>
-            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
-        </repository>
         <repository>
             <id>maven_central</id>
             <name>Maven Central</name>
@@ -76,12 +72,12 @@
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
-            <version>2.9.0</version>
+            <version>2.11.0</version>
         </dependency>
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
-            <version>1.18.32</version>
+            <version>1.18.34</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
@@ -92,7 +88,7 @@
         <dependency>
             <groupId>dnsjava</groupId>
             <artifactId>dnsjava</artifactId>
-            <version>3.5.1</version>
+            <version>3.6.0</version>
         </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>

src/main/java/dev/redcoke/mcserverping/MCServerPing.java

@@ -12,27 +12,27 @@
 import java.util.concurrent.*;
 import java.util.concurrent.atomic.AtomicInteger;
 
+import dev.redcoke.mcserverping.utils.TextComponentFormatter;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
 import org.xbill.DNS.Lookup;
 import org.xbill.DNS.SRVRecord;
 import org.xbill.DNS.Type;
 
 /**
  * API for pinging and obtaining info about a Minecraft server.
  */
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
 public final class MCServerPing {
-
-  private MCServerPing() {
-  }
-
-
   /**
    * Pings a Minecraft Server to obtain server info.
    *
    * @param address server address
    * @return MCServerPingResponse
-   * @throws IOException
+   * @throws IOException failed to resolve hostname
    */
-  public static MCServerPingResponse getPing(final String address) throws IOException, TimeoutException {
+  @SuppressWarnings("unused")
+  public static ServerPingResponse getPing(final String address) throws IOException, TimeoutException {
     return getPing(address, 25565);
   }
 
@@ -41,10 +41,12 @@ public static MCServerPingResponse getPing(final String address) throws IOExcept
    *
    * @param address server address
    * @param port    server port
-   * @return MCServerPingResponse
-   * @throws IOException
+   * @return MCServerPingResponse server info
+   * @throws IOException failed to resolve hostname
+   * @throws TimeoutException when the server does not respond within 3 seconds
+   * @see ServerPingResponse
    */
-  public static MCServerPingResponse getPing(final String address, final int port)
+  public static ServerPingResponse getPing(final String address, final int port)
           throws IOException, TimeoutException {
 
     if (address == null) {
@@ -59,11 +61,8 @@ public static MCServerPingResponse getPing(final String address, final int port)
     if (srvRecords != null) {
       for (var srvRecord : srvRecords) {
         var srv = (SRVRecord) srvRecord;
-
-
         serverHost = srv.getTarget().toString().replaceFirst("\\.$", "");
         serverPort = srv.getPort();
-
       }
     }
 
@@ -149,13 +148,12 @@ public static MCServerPingResponse getPing(final String address, final int port)
 
     jsonObj.addProperty("ping", ping);
 
-    return MCServerPingResponse.serverPingFromJsonObj(jsonObj);
+    return ServerPingResponse.serverPingFromJsonObj(jsonObj);
   }
 
 
   /**
    * Throws IOException when condition is false.
-   *
    * @param b Condition
    * @param m Exception cause
    * @throws IOException Exception
@@ -166,6 +164,13 @@ public static void io(final boolean b, final String m) throws IOException {
     }
   }
 
+  /**
+   * Reads a VarInt from a DataInputStream.
+   * @param in DataInputStream
+   * @return int
+   * @throws IOException Failed to read VarInt or invalid VarInt
+   * @throws TimeoutException Timed out
+   */
   public static int readVarInt(DataInputStream in) throws IOException, TimeoutException {
     int i = 0;
     int j = 0;

src/main/java/dev/redcoke/mcserverping/MCServerPingResponse.java

@@ -0,0 +1,62 @@
+package dev.redcoke.mcserverping;
+
+import com.google.gson.Gson;
+import com.google.gson.JsonArray;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParser;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import org.jetbrains.annotations.CheckReturnValue;
+import org.jetbrains.annotations.Nullable;
+
+@Getter
+@RequiredArgsConstructor
+public final class ServerPingResponse {
+    private final int ping;
+    private final String version;
+    private final int protocol;
+    @Nullable private final Integer maxPlayers;
+    @Nullable private final Integer onlinePlayers;
+    private final String motd;
+    private final JsonArray descriptionExtras;
+    private final String serverIcon;
+
+    private static final Gson gson = new Gson().newBuilder().setPrettyPrinting().disableHtmlEscaping().create();
+
+    public static ServerPingResponse serverPingFromJsonObj(JsonObject jsonObj) {
+        var serverPing = jsonObj.get("ping").getAsInt();
+        String versionName;
+        int serverProtocol;
+        if (jsonObj.get("version").getAsJsonObject().has("name")) { // 1.19+ format
+            versionName = jsonObj.get("version").getAsJsonObject().get("name").getAsString();
+            serverProtocol = jsonObj.get("version").getAsJsonObject().get("protocol").getAsInt();
+        } else { // legacy SLP format (pre 1.19.4)
+            versionName = jsonObj.get("version").getAsString();
+            serverProtocol = jsonObj.get("protocol").getAsInt();
+        }
+        Integer playerMax = null;
+        Integer playerOnline = null;
+        if (jsonObj.has("players")) { // Players object is optional somehow
+            playerMax = jsonObj.get("players").getAsJsonObject().get("max").getAsInt();
+            playerOnline = jsonObj.get("players").getAsJsonObject().get("online").getAsInt();
+        }
+        var serverMOTD = jsonObj.get("description").getAsJsonObject().get("text").getAsString();
+        var serverDescriptionExtra = (jsonObj.get("description").getAsJsonObject().get("extra") == null) ? null : jsonObj.get("description").getAsJsonObject().get("extra").getAsJsonArray();
+        var favIcon = jsonObj.get("favicon").getAsString();
+        return new ServerPingResponse(
+                serverPing, versionName, serverProtocol, playerMax, playerOnline, serverMOTD, serverDescriptionExtra, favIcon
+        );
+    }
+
+    @CheckReturnValue
+    @SuppressWarnings("unused")
+    public String getAsJsonString() {
+        return gson.toJson(this);
+    }
+
+    @CheckReturnValue
+    @SuppressWarnings("unused")
+    public JsonObject getAsJsonObject() {
+        return JsonParser.parseString(getAsJsonString()).getAsJsonObject();
+    }
+}

src/main/java/dev/redcoke/mcserverping/ServerPingResponse.java

@@ -1,4 +1,4 @@
-package dev.redcoke.mcserverping;
+package dev.redcoke.mcserverping.utils;
 
 import com.google.gson.JsonArray;
 import com.google.gson.JsonObject;

…mcserverping/TextComponentFormatter.java …erping/utils/TextComponentFormatter.javasrc/main/java/dev/redcoke/mcserverping/TextComponentFormatter.java renamed to src/main/java/dev/redcoke/mcserverping/utils/TextComponentFormatter.java src/main/java/dev/redcoke/mcserverping/TextComponentFormatter.java renamed to src/main/java/dev/redcoke/mcserverping/utils/TextComponentFormatter.java

@@ -13,7 +13,7 @@ void test() {
     List<String> servers = List.of("hypixel.net", "2b2t.org", "play.cubecraft.net");
     for (var server : servers) {
       try {
-        MCServerPing.getPing(server, 25565).getAsJsonString();
+        var ignored = MCServerPing.getPing(server, 25565).getAsJsonString();
       } catch (IOException | TimeoutException ex) {
         Assertions.fail(ex);
       }