Android Pinning 技术文档

1. 安装指南

1.1 使用 Gradle 安装

如果你使用 Gradle 构建你的 Android 项目，可以通过在 build.gradle 文件中添加以下依赖来引入 AndroidPinning 库：

dependencies {
    implementation 'org.thoughtcrime.ssl.pinning:AndroidPinning:1.0.0'
}

1.2 手动导入

如果你不使用 Gradle，也可以手动将 AndroidPinning 库导入到你的项目中。首先，从 GitHub 下载库的源代码，然后将其作为库项目导入到你的 Android Studio 项目中。

2. 项目的使用说明

AndroidPinning 是一个独立的 Android 库项目，旨在简化 Android 应用中 SSL 连接的证书固定（Certificate Pinning），以减少对证书颁发机构（CA）的依赖。

2.1 证书固定的概念

证书固定是一种安全措施，通过验证证书链是否符合预期，即使证书是由 CA 签名的，也能防止其他 CA 为你的域名创建伪造证书。这对于移动应用来说尤为重要，因为大多数移动应用只连接到一组特定的后端服务。

2.2 使用场景

• 自签名证书：如果你控制后端服务，可以使用自签名证书，并将证书与应用一起分发。
• CA 签名证书：如果你必须使用 CA 签名的证书，可以通过证书固定来增强安全性。

3. 项目 API 使用文档

3.1 PinningHelper 类

PinningHelper 类提供了两个主要方法来帮助你实现证书固定：

3.1.1 getPinnedHttpsURLConnection

该方法用于创建一个带有证书固定的 HttpsURLConnection 对象。

String[] pins = new String[] {"f30012bbc18c231ac1a44b788e410ce754182513"};
URL url = new URL("https://www.google.com");
HttpsURLConnection connection = PinningHelper.getPinnedHttpsURLConnection(context, pins, url);

return connection.getInputStream();

3.1.2 getPinnedHttpClient

该方法用于创建一个带有证书固定的 HttpClient 对象。

String[] pins = new String[] {"f30012bbc18c231ac1a44b788e410ce754182513"};
HttpClient httpClient = PinningHelper.getPinnedHttpClient(context, pins);

HttpResponse response = httpClient.execute(new HttpGet("https://www.google.com/"));

3.2 PinningTrustManager 和 PinningSSLSocketFactory

你也可以直接使用 PinningTrustManager 和 PinningSSLSocketFactory 来实现更高级的证书固定配置。

String[] pins = new String[] {"40c5401d6f8cbaf08b00edefb1ee87d005b3b9cd"};
SchemeRegistry schemeRegistry = new SchemeRegistry();
schemeRegistry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), 80));
schemeRegistry.register(new Scheme("https", new PinningSSLSocketFactory(getContext(), pins, 0), 443));

HttpParams httpParams = new BasicHttpParams();
ClientConnectionManager connectionManager = new ThreadSafeClientConnManager(httpParams, schemeRegistry);
DefaultHttpClient httpClient = new DefaultHttpClient(connectionManager, httpParams);

HttpResponse response = httpClient.execute(new HttpGet("https://www.google.com/"));

4. 项目安装方式

4.1 通过 Gradle 安装

如前所述，通过在 build.gradle 文件中添加依赖来安装 AndroidPinning 库：

dependencies {
    implementation 'org.thoughtcrime.ssl.pinning:AndroidPinning:1.0.0'
}

4.2 手动导入

手动下载并导入 AndroidPinning 库项目到你的 Android Studio 项目中。

通过以上步骤，你可以轻松地在 Android 项目中实现证书固定，从而提高应用的安全性。