Merge pull request #151 from binance/websocket_proxy_auth

add proxy auth support for websocket

Author: theo-s68

README.md

@@ -54,7 +54,7 @@ Each connector is published as a separate maven dependency. For example:
 <dependency>
   <groupId>io.github.binance</groupId>
   <artifactId>binance-spot</artifactId>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
 </dependency>
 ```
 
@@ -148,6 +148,17 @@ When creating WebSocket API clients (such as SpotWebSocketApi), you can follow:
     Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("host", 123));
     // Add the proxy to the configuration
     clientConfiguration.setProxy(proxy);
+    // Create the Proxy Authenticator
+    Authenticator proxyAuthenticator = new Authenticator() {
+        @Override public Request authenticate(Route route, Response response) throws IOException {
+            String credential = Credentials.basic("username", "password");
+            return response.request().newBuilder()
+                    .header("Proxy-Authorization", credential)
+                    .build();
+        }
+    };
+    // Add the proxy authenticator to the configuration
+    clientConfiguration.setProxyAuthenticator(proxyAuthenticator);
     // Use with API
     SpotRestApi spotRestApi = new SpotRestApi(clientConfiguration);
 ```
@@ -159,7 +170,16 @@ When creating WebSocket API clients (such as SpotWebSocketApi), you can follow:
     // Create the HTTP proxy
     HttpProxy proxy = new HttpProxy("host", 123);
     // Add the proxy to the configuration
-    clientConfiguration.setProxy(proxy);
+    clientConfiguration.setWebSocketProxy(proxy);
+    // Create the Proxy Authentication
+    BasicAuthentication basicAuthentication = new BasicAuthentication(
+            URI.create("http://host:123"),
+            Authentication.ANY_REALM,
+            "username",
+            "password"
+    );
+    // Add the Proxy Authentication to the configuration
+    clientConfiguration.setWebSocketProxyAuthentication(basicAuthentication);
     // Use with API
     SpotWebSocketApi spotWebSocketApi = new SpotWebSocketApi(clientConfiguration);
 ```
@@ -171,9 +191,18 @@ When creating WebSocket API clients (such as SpotWebSocketApi), you can follow:
     // Create the HTTP proxy
     HttpProxy proxy = new HttpProxy("host", 123);
     // Add the proxy to the configuration
-    clientConfiguration.setProxy(proxy);
+    clientConfiguration.setWebSocketProxy(proxy);
+    // Create the Proxy Authentication
+    BasicAuthentication basicAuthentication = new BasicAuthentication(
+            URI.create("http://host:123"),
+            Authentication.ANY_REALM,
+            "username",
+            "password"
+    );
+    // Add the Proxy Authentication to the configuration
+    clientConfiguration.setWebSocketProxyAuthentication(basicAuthentication);
     // Use with API
-    SpotWebSocketStreams spotWebSocketApi = new SpotWebSocketStreams(clientConfiguration);
+    SpotWebSocketApi spotWebSocketApi = new SpotWebSocketApi(clientConfiguration);
 ```
 
 

clients/common/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.2.0 - 2025-05-13
+
+- Add proxy authentication for websocket
+
 ## 1.1.0 - 2025-05-02
 
 - Adding `proxyAuthenticator` support.

clients/common/pom.xml

@@ -10,6 +10,6 @@
 
     <artifactId>binance-common</artifactId>
     <name>common</name>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
     <packaging>jar</packaging>
 </project>

clients/common/src/main/java/com/binance/connector/client/common/websocket/adapter/ConnectionWrapper.java

@@ -113,6 +113,9 @@ public ConnectionWrapper(
 
             if (configuration.getWebSocketProxy() != null) {
                 httpClient.getProxyConfiguration().addProxy(configuration.getWebSocketProxy());
+                if (configuration.getWebSocketProxyAuthentication() != null) {
+                    httpClient.getAuthenticationStore().addAuthentication(configuration.getWebSocketProxyAuthentication());
+                }
             }
             webSocketClient = new WebSocketClient(httpClient);
         }

clients/common/src/main/java/com/binance/connector/client/common/websocket/configuration/WebSocketClientConfiguration.java

@@ -2,13 +2,17 @@
 
 import com.binance.connector.client.common.configuration.ClientConfiguration;
 import org.eclipse.jetty.client.ProxyConfiguration;
+import org.eclipse.jetty.client.api.Authentication;
 
 public class WebSocketClientConfiguration extends ClientConfiguration {
     /** Base URL */
     protected String url = "wss://ws-api.binance.com:443/ws-api/v3";
 
     /** Proxy configuration */
-    protected ProxyConfiguration.Proxy proxy;
+    protected ProxyConfiguration.Proxy webSocketProxy;
+
+    /** Proxy Auth configuration */
+    protected Authentication webSocketProxyAuthentication;
 
     /** Auto LOGON or generate and send signature for each request. */
     private Boolean autoLogon = false;
@@ -36,11 +40,19 @@ public void setUrl(String url) {
     }
 
     public ProxyConfiguration.Proxy getWebSocketProxy() {
-        return proxy;
+        return webSocketProxy;
+    }
+
+    public void setWebSocketProxy(ProxyConfiguration.Proxy webSocketProxy) {
+        this.webSocketProxy = webSocketProxy;
+    }
+
+    public Authentication getWebSocketProxyAuthentication() {
+        return webSocketProxyAuthentication;
     }
 
-    public void setProxy(ProxyConfiguration.Proxy proxy) {
-        this.proxy = proxy;
+    public void setWebSocketProxyAuthentication(Authentication webSocketProxyAuthentication) {
+        this.webSocketProxyAuthentication = webSocketProxyAuthentication;
     }
 
     public Boolean getAutoLogon() {

clients/derivatives-trading-coin-futures/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.2.0 - 2025-05-13
+
+- Add proxy authentication for websocket
+
 ## 1.1.0 - 2025-05-02
 
 - Update `binance/common` module to version `1.1.0`.

clients/derivatives-trading-coin-futures/README.md

@@ -42,7 +42,7 @@ Then add dependency to pom.xml:
 <dependency>
   <groupId>io.github.binance</groupId>
   <artifactId>binance-derivatives-trading-coin-futures</artifactId>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
 </dependency>
 ```
 

clients/derivatives-trading-coin-futures/docs/rest-api/migration-guide.md

@@ -22,7 +22,7 @@ With the transition to a modularized structure, the Binance Connector has been s
 <dependency>
   <groupId>io.github.binance</groupId>
   <artifactId>binance-derivatives-trading-coin-futures</artifactId>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
 </dependency>
 ```
 
@@ -91,7 +91,7 @@ by:
  <dependency>
      <groupId>io.github.binance</groupId>
      <artifactId>binance-derivatives-trading-coin-futures</artifactId>
-     <version>1.1.0</version>
+     <version>1.2.0</version>
  </dependency>
 ```
 

clients/derivatives-trading-coin-futures/pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>binance-derivatives-trading-coin-futures</artifactId>
     <name>derivatives-trading-coin-futures</name>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
     <packaging>jar</packaging>
 
     <parent>
@@ -31,7 +31,7 @@
         <dependency>
             <groupId>io.github.binance</groupId>
             <artifactId>binance-common</artifactId>
-            <version>1.1.0</version>
+            <version>1.2.0</version>
         </dependency>
     </dependencies>
 </project>

clients/derivatives-trading-coin-futures/src/main/java/com/binance/connector/client/derivatives_trading_coin_futures/rest/api/AccountApi.java

@@ -54,7 +54,7 @@ public class AccountApi {
 
     private static final String USER_AGENT =
             String.format(
-                    "binance-derivatives-trading-coin-futures/1.1.0 (Java/%s; %s; %s)",
+                    "binance-derivatives-trading-coin-futures/1.2.0 (Java/%s; %s; %s)",
                     SystemUtil.getJavaVersion(), SystemUtil.getOs(), SystemUtil.getArch());
     private static final boolean HAS_TIME_UNIT = false;