Refactoring that allows enables Bitmask to handle providers that have more than one obfs4 bridge per host correctly. The refactoring also allows us to filter gateways for transport layer protocols (tcp, udp, kcp) in addition to transport types (openvpn, obfs4, obfs4_hop)

2 files changed, 84 insertions, 2 deletions

diff --git a/app/src/main/java/de/blinkt/openvpn/VpnProfile.java b/app/src/main/java/de/blinkt/openvpn/VpnProfile.java
index ae8901e0..511893d7 100644
--- a/app/src/main/java/de/blinkt/openvpn/VpnProfile.java
+++ b/app/src/main/java/de/blinkt/openvpn/VpnProfile.java
@@ -5,6 +5,8 @@
 
 package de.blinkt.openvpn;
 
+import static de.blinkt.openvpn.core.connection.Connection.TransportType.OBFS4;
+import static de.blinkt.openvpn.core.connection.Connection.TransportType.OBFS4_HOP;
 import static se.leap.bitmaskclient.base.models.Constants.PROVIDER_PROFILE;
 import static se.leap.bitmaskclient.base.utils.ConfigHelper.stringEqual;
 
@@ -50,6 +52,7 @@ import java.security.cert.X509Certificate;
 import java.security.interfaces.RSAPrivateKey;
 import java.security.spec.MGF1ParameterSpec;
 import java.security.spec.PSSParameterSpec;
+import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
 import java.util.Locale;
@@ -73,10 +76,12 @@ import de.blinkt.openvpn.core.VpnStatus;
 import de.blinkt.openvpn.core.X509Utils;
 import de.blinkt.openvpn.core.connection.Connection;
 import de.blinkt.openvpn.core.connection.ConnectionAdapter;
+import de.blinkt.openvpn.core.connection.Obfs4Connection;
 import se.leap.bitmaskclient.BuildConfig;
 import se.leap.bitmaskclient.R;
 import se.leap.bitmaskclient.base.models.ProviderObservable;
 import se.leap.bitmaskclient.base.utils.PreferenceHelper;
+import se.leap.bitmaskclient.pluggableTransports.models.Obfs4Options;
 
 public class VpnProfile implements Serializable, Cloneable {
     // Note that this class cannot be moved to core where it belongs since
@@ -272,11 +277,20 @@ public class VpnProfile implements Serializable, Cloneable {
     }
 
     @Override
+    public int hashCode() {
+        int result =(mGatewayIp != null ? mGatewayIp.hashCode() : 0);
+        result = 31 * result + Arrays.hashCode(mConnections);
+        result = 31 * result + mTransportType;
+        return result;
+    }
+
+    @Override
     public boolean equals(Object obj) {
         if (obj instanceof VpnProfile) {
             VpnProfile vp = (VpnProfile) obj;
             return stringEqual(vp.mGatewayIp, mGatewayIp) &&
-                    vp.mTransportType == mTransportType;
+                    vp.mTransportType == mTransportType &&
+                    Arrays.equals(mConnections, vp.mConnections);
         }
         return false;
     }
@@ -315,6 +329,22 @@ public class VpnProfile implements Serializable, Cloneable {
         return Connection.TransportType.fromInt(mTransportType);
     }
 
+    public @Nullable Obfs4Options getObfs4Options() {
+        Connection.TransportType transportType = getTransportType();
+        if (!(transportType == OBFS4 || transportType == OBFS4_HOP)) {
+            return null;
+        }
+        return ((Obfs4Connection) mConnections[0]).getObfs4Options();
+    }
+
+    public String getObfuscationTransportLayerProtocol() {
+        try {
+            return getObfs4Options().transport.getProtocols()[0];
+        } catch (NullPointerException | ArrayIndexOutOfBoundsException ignore) {
+            return null;
+        }
+    }
+
     public String getName() {
         if (TextUtils.isEmpty(mName))
             return "No profile name";
diff --git a/app/src/main/java/de/blinkt/openvpn/core/connection/Connection.java b/app/src/main/java/de/blinkt/openvpn/core/connection/Connection.java
index 0b28cbca..9943faff 100644
--- a/app/src/main/java/de/blinkt/openvpn/core/connection/Connection.java
+++ b/app/src/main/java/de/blinkt/openvpn/core/connection/Connection.java
@@ -9,10 +9,13 @@ import static de.blinkt.openvpn.core.connection.Connection.TransportType.*;
 
 import android.text.TextUtils;
 
+import androidx.annotation.NonNull;
+
 import com.google.gson.annotations.JsonAdapter;
 
 import java.io.Serializable;
 import java.util.Locale;
+import java.util.Objects;
 
 @JsonAdapter(ConnectionAdapter.class)
 public abstract class Connection implements Serializable, Cloneable {
@@ -301,5 +304,54 @@ public abstract class Connection implements Serializable, Cloneable {
         this.mProxyAuthPassword = proxyAuthPassword;
     }
 
-    public abstract TransportType getTransportType();
+    public abstract @NonNull TransportType getTransportType();
+
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (!(o instanceof Connection that)) return false;
+
+        if (mUseUdp != that.mUseUdp) return false;
+        if (mUseCustomConfig != that.mUseCustomConfig) return false;
+        if (mEnabled != that.mEnabled) return false;
+        if (mConnectTimeout != that.mConnectTimeout) return false;
+        if (mUseProxyAuth != that.mUseProxyAuth) return false;
+        if (!Objects.equals(mServerName, that.mServerName))
+            return false;
+        if (!Objects.equals(mServerPort, that.mServerPort))
+            return false;
+        if (!Objects.equals(mCustomConfiguration, that.mCustomConfiguration))
+            return false;
+        if (mProxyType != that.mProxyType) return false;
+        if (!Objects.equals(mProxyName, that.mProxyName))
+            return false;
+        if (!Objects.equals(mProxyPort, that.mProxyPort))
+            return false;
+        if (!Objects.equals(mProxyAuthUser, that.mProxyAuthUser))
+            return false;
+        if (getTransportType() != that.getTransportType()) {
+            return false;
+        }
+        return Objects.equals(mProxyAuthPassword, that.mProxyAuthPassword);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = mServerName != null ? mServerName.hashCode() : 0;
+        result = 31 * result + (mServerPort != null ? mServerPort.hashCode() : 0);
+        result = 31 * result + (mUseUdp ? 1 : 0);
+        result = 31 * result + (mCustomConfiguration != null ? mCustomConfiguration.hashCode() : 0);
+        result = 31 * result + (mUseCustomConfig ? 1 : 0);
+        result = 31 * result + (mEnabled ? 1 : 0);
+        result = 31 * result + mConnectTimeout;
+        result = 31 * result + (mProxyType != null ? mProxyType.hashCode() : 0);
+        result = 31 * result + (mProxyName != null ? mProxyName.hashCode() : 0);
+        result = 31 * result + (mProxyPort != null ? mProxyPort.hashCode() : 0);
+        result = 31 * result + (mUseProxyAuth ? 1 : 0);
+        result = 31 * result + (mProxyAuthUser != null ? mProxyAuthUser.hashCode() : 0);
+        result = 31 * result + (mProxyAuthPassword != null ? mProxyAuthPassword.hashCode() : 0);
+        result = 31 * result + getTransportType().toInt();
+        return result;
+    }
 }