[PM-14846] Improve IP Address and Port Handling in StringExtensions (#5118)

Author: SaintPatrck

app/src/main/java/com/x8bit/bitwarden/data/platform/util/StringExtensions.kt

@@ -10,13 +10,55 @@ import java.net.URISyntaxException
  */
 private const val ANDROID_APP_PROTOCOL: String = "androidapp://"
 
+/**
+ * Regex to match an IP address (IPv4) with an optional port within the valid range (0-65535).
+ *
+ * This regex matches the following:
+ * - An optional "http://" or "https://" prefix.
+ * - A standard IPv4 address (four groups of digits separated by dots).
+ * - An optional colon (:) followed by a port number (digits).
+ * - The port number, if present, must be within the range of 0-65535.
+ *
+ * Example valid strings:
+ * - 192.168.1.1
+ * - 10.0.0.5:8080
+ * - 255.255.255.0:9000
+ * - 0.0.0.0
+ * - 1.1.1.1:0
+ * - 1.1.1.1:65535
+ * - https://192.168.1.1
+ * - https://10.0.0.5:8080
+ * - http://255.255.255.0:9000
+ * - http://10.0.0.5:8080
+ *
+ * Example invalid strings:
+ * - 256.1.1.1 (invalid IP component)
+ * - 10.1.1 (missing IP components)
+ * - 10.1.1.1:abc (non-numeric port)
+ * - 10.1.1.1:-1 (invalid port)
+ * - 10.1.1.1: (missing port)
+ * - 1.1.1.1:65536 (invalid port)
+ * - 1.1.1.1:99999 (invalid port)
+ * - ://192.168.1.1 (invalid scheme)
+ * - androidapp://192.168.1.1 (invalid scheme)
+ * - file://usr/docs/file.txt (invalid scheme)
+ */
+@Suppress("MaxLineLength")
+private val IP_ADDRESS_WITH_OPTIONAL_PORT =
+    Regex("""^(https?://)?((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}(:([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?$""")
+
 /**
  * Try creating a [URI] out of this [String]. If it fails, return null.
  */
 fun String.toUriOrNull(): URI? =
     try {
-        URI(this)
-    } catch (e: URISyntaxException) {
+        // URI cannot parse IP addresses without a scheme, so add one if necessary.
+        if (this.isIpAddress() && !this.hasHttpProtocol()) {
+            URI("https://$this")
+        } else {
+            URI(this)
+        }
+    } catch (_: URISyntaxException) {
         null
     }
 
@@ -32,6 +74,12 @@ fun String.isAndroidApp(): Boolean =
 fun String.hasHttpProtocol(): Boolean =
     this.startsWith(prefix = "http://") || this.startsWith(prefix = "https://")
 
+/**
+ * Whether this [String] represents an IP address with an optional port.
+ */
+fun String.isIpAddress(): Boolean =
+    this.matches(IP_ADDRESS_WITH_OPTIONAL_PORT)
+
 /**
  * Try and extract the web host from this [String] if it represents an Android app.
  */

app/src/test/java/com/x8bit/bitwarden/data/util/StringExtensionsTest.kt

@@ -9,6 +9,7 @@ import com.x8bit.bitwarden.data.platform.util.getWebHostFromAndroidUriOrNull
 import com.x8bit.bitwarden.data.platform.util.hasHttpProtocol
 import com.x8bit.bitwarden.data.platform.util.hasPort
 import com.x8bit.bitwarden.data.platform.util.isAndroidApp
+import com.x8bit.bitwarden.data.platform.util.isIpAddress
 import com.x8bit.bitwarden.data.platform.util.parseDomainOrNull
 import com.x8bit.bitwarden.data.platform.util.toUriOrNull
 import io.mockk.every
@@ -200,6 +201,12 @@ class StringExtensionsTest {
         assertTrue(uriString.hasPort())
     }
 
+    @Test
+    fun `hasPort returns true when URI is IP address and port`() {
+        val uriString = "192.168.1.1:8080"
+        assertTrue(uriString.hasPort())
+    }
+
     @Test
     fun `getHostWithPortOrNull should return host with port when present`() {
         val uriString = "www.google.com:8080"
@@ -223,4 +230,48 @@ class StringExtensionsTest {
         val uriString = "androidapp://www.google.com:8080"
         assertEquals("www.google.com:8080", uriString.getHostWithPortOrNull())
     }
+
+    @Suppress("MaxLineLength")
+    @Test
+    fun `getHostWithPortOrNull should return host with port when URI is IP address with port and scheme`() {
+        val uriString = "https://192.168.1.1:8080"
+        assertEquals("192.168.1.1:8080", uriString.getHostWithPortOrNull())
+    }
+
+    @Test
+    fun `isIpAddress should return correct value for various IP addresses`() {
+        testIpAddresses.forEach { (ipAddress, expected) ->
+            assertEquals(expected, ipAddress.isIpAddress()) { "Failed for $ipAddress" }
+        }
+    }
+
+    private val testIpAddresses = listOf(
+        "192.168.1.1" to true,
+        "10.0.0.5:8080" to true,
+        "255.255.255.0:9000" to true,
+        "0.0.0.0" to true,
+        "256.1.1.1" to false,
+        "10.1.1" to false,
+        "10.1.1.1:abc" to false,
+        "10.1.1.1:-1" to false,
+        "10.1.1.1:" to false,
+        "10.1.1.1:0" to true,
+        "1.1.1.1:123" to true,
+        "1.1.1.1:65535" to true,
+        "1.1.1.1:65536" to false,
+        "1.1.1.1:99999" to false,
+        ":1234" to false,
+        "255.255.255.255:65535" to true,
+        "255.255.255.255:0" to true,
+        "255.255.255.255:" to false,
+        "255.255.255.255:-1" to false,
+        "http://192.168.1.1" to true,
+        "https://10.0.0.5:8080" to true,
+        "http://255.255.255.0:9000" to true,
+        "https://0.0.0.0" to true,
+        "http://256.1.1.1" to false,
+        "https://10.1.1" to false,
+        "http://10.1.1.1:abc" to false,
+        "https://10.1.1.1:-1" to false,
+    )
 }