給OkHttp Client添加socks代理

来源:https://www.cnblogs.com/cwjcsu/archive/2018/02/08/add-socks-proxy-support-for-okhttp.html
-Advertisement-
Play Games

Okhttp的使用沒有httpClient廣泛，網上關於Okhttp設置代理的方法很少，這篇文章完整介紹了需要註意的方方面面。 上一篇博客中介紹了socks代理的入口是創建 時傳入一個 對象。 OkHttp client通過 創建，可以通過定製 和`java.net.SocketFactory`來實 ...


Okhttp的使用沒有httpClient廣泛，網上關於Okhttp設置代理的方法很少，這篇文章完整介紹了需要註意的方方面面。

上一篇博客中介紹了socks代理的入口是創建java.net.Socket時傳入一個java.net.Porxy對象。 OkHttp client通過OkHttpClient.Builder創建，可以通過定製javax.net.ssl.SSLSocketFactory和java.net.SocketFactory來實現socks代理。

定製SocketFactory

JDK中預設的是java.net.DefaultSocketFactory,它是包可見的，沒法擴展，所以只能用java.net.SocketFactory擴展，沒有什麼其他好的招數，這個過程其實有點繁瑣。

public class ProxySocketFactory extends SocketFactory {

    private ProxyConfigProvider proxyConfigProvider;

    public ProxySocketFactory(ProxyConfigProvider proxyConfigProvider) {
        this.proxyConfigProvider = proxyConfigProvider;
    }

    @Override
    public Socket createSocket() throws IOException {
        ProxyConfig proxyConfig = proxyConfigProvider.getProxyConfig();
        if (proxyConfig != null) {
            return new Socket(proxyConfig.getProxy());
        } else {
            return new Socket();
        }
    }

    public Socket createSocket(String host, int port)
            throws IOException, UnknownHostException {
        Socket socket = createSocket();
        try {
            socket.connect(new InetSocketAddress(host, port));
        } catch (IOException e) {
            socket.close();
            throw e;
        }
        return socket;
    }

    public Socket createSocket(InetAddress address, int port)
            throws IOException {
        Socket socket = createSocket();
        try {
            socket.connect(new InetSocketAddress(address, port));
        } catch (IOException e) {
            socket.close();
            throw e;
        }
        return socket;
    }

    public Socket createSocket(String host, int port,
                               InetAddress clientAddress, int clientPort)
            throws IOException, UnknownHostException {
        Socket socket = createSocket();
        try {
            socket.bind(new InetSocketAddress(clientAddress, clientPort));
            socket.connect(new InetSocketAddress(host, port));
        } catch (IOException e) {
            socket.close();
            throw e;
        }
        return socket;
    }

    public Socket createSocket(InetAddress address, int port,
                               InetAddress clientAddress, int clientPort)
            throws IOException {
        Socket socket = createSocket();
        try {
            socket.bind(new InetSocketAddress(clientAddress, clientPort));
            socket.connect(new InetSocketAddress(address, port));
        } catch (IOException e) {
            socket.close();
            throw e;
        }
        return socket;
    }
}

上面代碼這麼長，並不是隨便寫的，也省不了。我參考了DefaultSocketFactory裡面創建Socket對象的各個構造函數，保證了ProxySocketFactory的跟DefaultSocketFactory對應方法的行為完全一致，只是在創建socket時用了代理而已。簡單一句話：只要傳入了IP地址和埠，就會直接發起連接。

對SSL socket工廠的定製同樣繁瑣。不是簡單的繼承（繼承搞不定），而是採用包裝模式，用原來的SSLSocketFactory來實現與代理無關的方法。

public class ProxySSLSocketFactory extends SSLSocketFactory {
    private ProxyConfigProvider configProvider;
    private SSLSocketFactory socketFactory;

    public ProxySSLSocketFactory(ProxyConfigProvider configProvider, SSLSocketFactory socketFactory) {
        this.configProvider = configProvider;
        this.socketFactory = socketFactory;
    }

    @Override
    public String[] getDefaultCipherSuites() {
        return socketFactory.getDefaultCipherSuites();
    }

    @Override
    public String[] getSupportedCipherSuites() {
        return socketFactory.getSupportedCipherSuites();
    }

    public Socket createSocket()
            throws IOException {
        ProxyConfig proxyConfig = configProvider.getProxyConfig();
        if (proxyConfig != null) {
            return new Socket(proxyConfig.getProxy());
        } else {
            return new Socket();
        }
    }

    public Socket createSocket(String host, int port)
            throws IOException {
        Socket socket = createSocket();
        try {
            return socketFactory.createSocket(socket, host, port, true);
        } catch (IOException e) {
            socket.close();
            throw e;
        }
    }

    public Socket createSocket(Socket s, String host,
                               int port, boolean autoClose)
            throws IOException {
        //TODO 無法代理
        return socketFactory.createSocket(s, host, port, autoClose);
    }

    public Socket createSocket(InetAddress address, int port)
            throws IOException {
        Socket socket = createSocket();
        try {
            return socketFactory.createSocket(socket, address.getHostAddress(), port, true);
        } catch (IOException e) {
            socket.close();
            throw e;
        }
    }

    public Socket createSocket(String host, int port,
                               InetAddress clientAddress, int clientPort)
            throws IOException {
        Socket socket = createSocket();
        try {
            socket.bind(new InetSocketAddress(clientAddress, clientPort));
            return socketFactory.createSocket(socket, host, port, true);
        } catch (IOException e) {
            socket.close();
            throw e;
        }
    }

    public Socket createSocket(InetAddress address, int port,
                               InetAddress clientAddress, int clientPort)
            throws IOException {
        Socket socket = createSocket();
        try {
            socket.bind(new InetSocketAddress(clientAddress, clientPort));
            return socketFactory.createSocket(socket, address.getHostAddress(), port, true);
        } catch (IOException e) {
            socket.close();
            throw e;
        }
    }
}

註意，其中有一個方法是無法使用代理的：Socket createSocket(Socket s, String host,int port, boolean autoClose)，因為傳入的已經是一個創建好的Socket，所以使用這個方法，要註意你的組件有沒有用到這個方法，如果用到了，代理的功能需要在這個方法的調用者那一層去實現。我測試OkHttp client是沒有用到這個方法的。

創建OkHttpClient對象

兩個工廠類設計好了之後，下麵就是運用他們創建OkHttpClient對象。

    public OkHttpClient buildOkHttpClient() {
        OkHttpClient httpClient = new OkHttpClient.Builder()
                .sslSocketFactory(new ProxySSLSocketFactory(proxyProvider, NOP_TLSV12_SSL_CONTEXT.getSocketFactory()), NOP_TRUST_MANAGER)
                .socketFactory(new ProxySocketFactory(proxyProvider))
                .hostnameVerifier(NOP_HOSTNAME_VERIFIER)
                .connectTimeout(DEFAULT_CONNECTION_TIMEOUT, TimeUnit.SECONDS)
                .writeTimeout(DEFAULT_CONNECTION_TIMEOUT, TimeUnit.SECONDS)
                .readTimeout(DEFAULT_CONNECTION_TIMEOUT, TimeUnit.SECONDS)                
                .addInterceptor(new OkHttpProxyInterceptor())
                .build();
        return httpClient;
    }

上面的方法註意兩行：

.sslSocketFactory(xxx)
.socketFactory(xxx)

其他代碼，有對超時的設置.xxxTimeout()，這裡不贅述，還有對https請求證書的設置以及對socks密碼的設置，稍後詳解

設置https需要註意的地方

NOP_TRUST_MANAGER對象設置為信任任何證書：

    public static final X509TrustManager NOP_TRUST_MANAGER = new X509TrustManager() {
        @Override
        public void checkClientTrusted(X509Certificate[] x509Certificates, String s)
                throws CertificateException {
        }

        @Override
        public void checkServerTrusted(X509Certificate[] x509Certificates, String s)
                throws CertificateException {
        }

        @Override
        public X509Certificate[] getAcceptedIssuers() {
            return new X509Certificate[0];
        }
    };

NOP_HOSTNAME_VERIFIER對象設置為信任任何功能變數名稱：

    public static final HostnameVerifier NOP_HOSTNAME_VERIFIER = new HostnameVerifier() {
        @Override
        public boolean verify(String s, SSLSession sslSession) {
            return true;
        }
    };

https的協議版本可能不支持TLSv1

上面兩條設置網上很多文檔都會介紹，重點需要關註的是NOP_TLSV12_SSL_CONTEXT對象。

乾貨來了：JDK使用的HTTPS協議版本參考這裡-diagnosing-tls,-ssl,-and-https，可以看到在JDK7以前，預設都是TLSv1，JDK8才預設採用TLSv1.2，而很多較新的網站都已經禁用HTTPS使用TLSv1握手了，認為這個協議已經不夠安全（例如，我在給minio-java client添加proxy支持時，發現minio-server就這麼乾的）。所以你用java去發起HTTPS連接經常會出現SSL相關的異常，大部分異常信息根本看不懂。

所以，需要在代碼裡面指定https使用TLSv1.2：

    static {
        try {
            NOP_TLSV12_SSL_CONTEXT = SSLContext.getInstance("TLSv1.2");
            NOP_TLSV12_SSL_CONTEXT.init(null, new TrustManager[]{NOP_TRUST_MANAGER}, new java.security.SecureRandom());
        } catch (NoSuchAlgorithmException e) {
            e.printStackTrace();
        } catch (KeyManagementException e) {
            e.printStackTrace();
        }
    }

實際上也可以通過：

System.setProperty("https.protocols","TLSv1.2");//在創建任何SSLSocketFactory之前調用

或者設置虛擬機參數：

-Dhttps.protocols=TLSv1.2,TLSv1.1,TLSv1

放在前面的協議會被優先選用

檢測https支持的協議版本

如果出現SSL相關異常，但是又不確定是不是協議版本導致的，可以有幾個工具進行檢驗：
nmap : nmap --script ssl-enum-ciphers -p 443 baidu.com,在我機器上看到：

PORT    STATE SERVICE
443/tcp open  https
| ssl-enum-ciphers: 
|   SSLv3: 
|     ciphers: 
|       TLS_ECDHE_RSA_WITH_RC4_128_SHA (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (secp256r1) - A
|       TLS_RSA_WITH_AES_128_CBC_SHA (rsa 2048) - A
|       TLS_RSA_WITH_AES_256_CBC_SHA (rsa 2048) - A
|       TLS_RSA_WITH_RC4_128_SHA (rsa 2048) - A
|     compressors: 
|       NULL
|     cipher preference: server
|     warnings: 
|       CBC-mode cipher in SSLv3 (CVE-2014-3566)
|   TLSv1.0: 
|     ciphers: 
|       TLS_ECDHE_RSA_WITH_RC4_128_SHA (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (secp256r1) - A
|       TLS_RSA_WITH_AES_128_CBC_SHA (rsa 2048) - A
|       TLS_RSA_WITH_AES_256_CBC_SHA (rsa 2048) - A
|       TLS_RSA_WITH_RC4_128_SHA (rsa 2048) - A
|     compressors: 
|       NULL
|     cipher preference: server
|   TLSv1.1: 
|     ciphers: 
|       TLS_ECDHE_RSA_WITH_RC4_128_SHA (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (secp256r1) - A
|       TLS_RSA_WITH_AES_128_CBC_SHA (rsa 2048) - A
|       TLS_RSA_WITH_AES_256_CBC_SHA (rsa 2048) - A
|       TLS_RSA_WITH_RC4_128_SHA (rsa 2048) - A
|     compressors: 
|       NULL
|     cipher preference: server
|     warnings: 
|       Weak cipher RC4 in TLSv1.1 or newer not needed for BEAST mitigation
|   TLSv1.2: 
|     ciphers: 
|       TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_RC4_128_SHA (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (secp256r1) - A
|       TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (secp256r1) - A
|       TLS_RSA_WITH_AES_128_GCM_SHA256 (rsa 2048) - A
|       TLS_RSA_WITH_AES_256_GCM_SHA384 (rsa 2048) - A
|       TLS_RSA_WITH_AES_128_CBC_SHA256 (rsa 2048) - A
|       TLS_RSA_WITH_AES_128_CBC_SHA (rsa 2048) - A
|       TLS_RSA_WITH_AES_256_CBC_SHA256 (rsa 2048) - A
|       TLS_RSA_WITH_AES_256_CBC_SHA (rsa 2048) - A
|       TLS_RSA_WITH_RC4_128_SHA (rsa 2048) - A
|     compressors: 
|       NULL
|     cipher preference: server
|     warnings: 
|       Weak cipher RC4 in TLSv1.1 or newer not needed for BEAST mitigation
|_  least strength: A

設置Socks的用戶名和密碼

OkHttp提供了攔截器的機制okhttp3.Interceptor，可以定製http發起的流程。
設置密碼有兩種方式：一種是設置全局的，另一種是按線程隔離（也是就是按請求隔離），不同請求可以設置不同的用戶名和密碼，詳細介紹以及部分代碼見我的上一篇博客-給HttpClient添加Socks代理。
註意到上面代碼有這麼一行：

.addInterceptor(new OkHttpProxyInterceptor())

就是設置一個攔截器。

    private class OkHttpProxyInterceptor implements Interceptor {
        @Override
        public Response intercept(Chain chain) throws IOException {
            ProxyConfig proxyConfig = ProxyHttpClientBuilder.this.getProxyConfig();
            boolean clearCredentials = false;
            if (proxyConfig != null) {
                if (proxyConfig.getAuthentication() != null) {
                    ThreadLocalProxyAuthenticator.setCredentials(proxyConfig.getAuthentication());
                    clearCredentials = true;
                }
            }
            try {
                return chain.proceed(chain.request());
            } finally {
                if (clearCredentials) {
                    ThreadLocalProxyAuthenticator.clearCredentials();
                }
            }
        }
    }

ThreadLocalProxyAuthenticator,ProxyConfig等類見上一篇博客。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • jsp常見jstl語法（二）
    <c:choose>標簽與Javascript switch語句的功能一樣，用於在眾多選項中做出選擇。 語法格式 屬性 <c:choose></c:choose>和<c:otherwise></c:otherwise>沒有屬性 <c:otherwise></c:otherwise>屬性只有test如 ...
  • SSE和WebSocket的用法和比較
    在我們日常開發中，會遇到服務端和客戶端的通訊，今天我們就來比較一下HTML5新特性SSE和WebSocket的用法。 一，SSE 簡介 SSE（Server-Sent Events，伺服器發送事件）是圍繞只讀Comet 交互推出的API 或者模式。 SSE API允許網頁獲得來自伺服器的更新（HTM ...
  • 【JavaScript】簡介、<Script>標簽及基本概念
    一、前言 時光荏苒，歲月匆匆。今年年初進入數據平臺部門轉型做Web平臺。要想搞好前端肯定要學好JavaScript，於是準備抓上一倆本書從基礎學起。 二、內容 簡介 JavaScript是一種專為與網頁交互而設計的腳本語言，由下列三個不同的部分組成： 1. ECMAScript，提供核心語言功能； ...
  • CSS3屬性詳解（圖文教程）
    本文最初發表於 "博客園" ，併在 "GitHub" 上持續更新 前端的系列文章 。歡迎在GitHub上關註我，一起入門和進階前端。 以下是正文。 前言 我們在上一篇文章中學習了 "CSS3的選擇器" ，本文來學一下CSS3的一些屬性。 本文主要內容： 顏色 文本 盒模型中的 box sizing ...
  • 便捷學習網站
    教學： 慕課網：https://www.imooc.com/ CSS： CSS參考手冊：http://www.css88.com/book/css/ jQuery: jQuery插件庫：http://www.jq22.com/ 圖片： UI設計網：http://web.cndesign.com/ ...
  • vue中使用ueditor
    最近在做後臺管理系統的時候遇到要使用富文本編輯器。最後選擇了ueditor，我的項目使用 vue+vuex+vue-router+webpack+elementUI的方案完成框架的搭建， 1、下載UEditor官網最新的jsp版本的包，下載完成解壓之後得到一個utf8-jsp的文件夾，裡面包含的內容 ...
  • ELK + Filebeat日誌分析系統安裝
    之前搭建過elk，用於分析日誌，無奈伺服器資源不足，開了多個Logstash之後發現占用記憶體過高，於是現在改為Filebeat做日誌收集，記錄一下搭建過程和遇到問題的解決方案。 第一步 ， 安裝jdk8 。 設置環境變數 在profile文件下，添加 添加之後，執行 使配置生效。 然後輸入 檢驗是否 ...
  • [C#]設計模式-建造者模式-創建型模式
    介紹完工廠模式，現在來看一下建造者模式。建造者模式就是將一系列對象組裝為一個完整對象並且返回給用戶，例如汽車，就是需要由各個部件來由工人建造成一個複雜的組合實體，這個複雜實體的構造過程就被外部化到一個建造者的對象，由這個建造者對象返回創建好的實體，是不是跟工廠很像呀？ 建造者模式則主要由幾個對象構成 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類