# @capgo/capacitor-ssl-pinning 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-ssl-pinning/

版本：8\.1\.15
npm 元数据更新时间：2026-10-15T04:36:37.493Z
中文译文更新时间：2026-11-09T08:00:34.405Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-ssl-pinning
原文对照：https://npmcn.com/package/%40capgo/capacitor-ssl-pinning/?lang=original
项目主页：https://capgo.app/docs/plugins/ssl-pinning/
源码仓库：https://github.com/Cap-go/capacitor-ssl-pinning

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：90.7 kB，31 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2026-03-25T04:19:19.332Z
- 最新版本发布：2026-10-15T04:36:36.598Z
- 近 30 天下载量：3798（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

与CapacitorHttp集成的Android和iOS Capacitor SSL pinning插件.

## 安装

```sh
npm install @capgo/capacitor-ssl-pinning
```

也可以使用：`pnpm add @capgo/capacitor-ssl-pinning`、`yarn add @capgo/capacitor-ssl-pinning`、`bun add @capgo/capacitor-ssl-pinning`

## README

# @ capgo/ 电容器- sl- pinning

将 SSL 证书 Pinning 添加到您的 Capacitor app 在 iOS 和 Android 上的本地 HTTP 请求中, 因此您的 API 流量只信任自己的证书 .

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-ssl-pinning)](https://capgo.app/?ref=plugin_ssl_pinning)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_ssl_pinning)

14天无限自由审判. 不需要信用卡

> 🤖 **建筑与AI编码代理?** 安装 [Capgo 技能](https://capgo.app/skills/?ref=plugin_ssl_pinning) 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 `@capgo/capacitor-ssl-pinning` 在您的电容应用程序中: `npx skills add Cap-go/capgo-skills`。然后问你的经纪人: _加入@capgo/capor-sl-pinning到我的Capacitor app,并把它接上。"_ [代理设置指南](https://capgo.app/agents/?ref=plugin_ssl_pinning) • 妇女 [主机磁共振](https://capgo.app/docs/ai/mcp/?ref=plugin_ssl_pinning)

![@capgo/capacitor-ssl-pinning for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-ssl-pinning/main/assets/github-social-preview.png)

## 主要特点

-   **仅配置**: 列表证书文件 `plugins.SSLPinning.certs` 内 `capacitor.config`。 。 。 .
-   **电容Http**: 指针适用于 `CapacitorHttp` 当启用时请求,并列出至少一个证书.
-   **同步钩子**数字 : `cap sync` 复制证书,并将 PEM 文件转换为 iOS DER .
-   **不适用情况**数字 : `excludedDomains` 让选择的 URL 跳过 Pinning .
-   **检查**数字 : `getConfiguration()` 返回活动本地配置.
-   **平台**: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-21. 在网上不可用.

密码 SSL Pinning 通过与 Capacitor 8 应用程序的集成将证书 Pinning 带给 Capacitor 8 应用程序 `CapacitorHttp` (原始内容存档于2019-10-12). Android and iOS.

执行遵循Ionic SSL 平接安装流并使用相同的 `plugins.SSLPinning` 已记录的配置形状 [ionic.io (英语)](https://ionic.io/docs/ssl-pinning/install)。 。 。 .

## 文档

这里有最完整的医生: [https://capgo.app/docs/plugins/ssl-pinning/ 互联网档案馆的存檔,存档日期2013-12-02](https://capgo.app/docs/plugins/ssl-pinning/)

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| 联合国 | 联合国 | ✅ |

## 安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

然后使用下列提示:

```text
Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-ssl-pinning` plugin in my project.
```

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
bun add @capgo/capacitor-ssl-pinning
bunx cap sync
```

## 配置

启用 Capacitor HTTP 截取并声明相对于您的应用根的证书文件 :

```ts
import type { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorHttp: {
      enabled: true,
    },
    SSLPinning: {
      certs: ['sslCerts/production/primary.cer', 'sslCerts/production/backup.der'],
      excludedDomains: ['https://analytics.google.com'],
    },
  },
};

export default config;
```

期间 `bunx cap sync`,插件将配置的证书复制到 `webDir/certs`,这使得两个本土执行都从捆绑的应用资产中加载. 两者 `.cer` 财务报告和审定财务报表 `.der` 支持; PEM `.cer` 文件会自动转换为iOS的DER.

## 使用量

让 HTTPS 调用 `CapacitorHttp`数字 :

```ts
import { CapacitorHttp } from '@capacitor/core';

const response = await CapacitorHttp.get({
  url: 'https://api.example.com/health',
});
```

如果服务器证书与被绑定的证书之一不符,则本土请求失败.

## 行为

-   Android 注射被钉 `SSLSocketFactory` 除非 URL 匹配 HTTP 请求 `excludedDomains`。 。 。 .
-   iOS 将默认的 Capacitor HTTP 处理器以固定键交换 `URLSession` 代表并同时通过Capacitor插件钩子回答WebView认证挑战.
-   Web只暴露出检查助手;浏览器不支持这种本土的打针行为.

## API 密码

-   [`getConfiguration()`](https://npmcn.com/package/%40capgo/capacitor-ssl-pinning/#readme-getconfiguration)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-ssl-pinning/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-ssl-pinning/#readme-interfaces)

用于检查 SSL 披针配置的 CAPI .

本地强制执行自动适用于 `CapacitorHttp` 请求:

1.  `plugins.CapacitorHttp.enabled` 实值 `true`
2.  `plugins.SSLPinning.certs` 包含至少一个证书

### 获取配置 ()

```typescript
getConfiguration() => Promise<SSLPinningConfigurationState>
```

返回插件可见的当前本地配置 .

**回返情况:** `Promise<[SSLPinningConfigurationState](https://npmcn.com/package/%40capgo/capacitor-ssl-pinning/#readme-sslpinningconfigurationstate)>`

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<PluginVersionResult>
```

返回本地执行版本标记 .

**回返情况:** `Promise<[PluginVersionResult](https://npmcn.com/package/%40capgo/capacitor-ssl-pinning/#readme-pluginversionresult)>`

* * *

### 接口

#### SSLPinning 配置状态

静态 SSL pinning 配置目前可见于插件 .

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`configured`** | `boolean` | 是否配置至少一个证书用于本地 Pinning . |
| **`certs`** | `string[]` | 证书路径从 `capacitor.config.*` 相对应用根. |
| **`excludedDomains`** | `string[]` | 应绕过 SSL pinning 的完全合格 URL . |

#### 插件变压器

插件版本有效载荷 .

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`version`** | `string` | 版本标识符由平台执行返回. |

## 常见问题

### @capgo/capacitor-ssl-pinning 是什么？

与CapacitorHttp集成的Android和iOS Capacitor SSL pinning插件\.

### 如何安装 @capgo/capacitor-ssl-pinning？

在项目目录运行 npm install @capgo/capacitor-ssl-pinning，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-ssl-pinning 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capgo/capacitor-ssl-pinning 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-ssl-pinning 可以商用吗？

@capgo/capacitor-ssl-pinning 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-ssl-pinning 的下载量有多少？

根据 npm 官方下载统计，@capgo/capacitor-ssl-pinning 在 2026/10/09 – 2026/11/07 这 30 天内被下载 3,798 次，日均约 127 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capgo/capacitor-ssl-pinning 还在维护吗？

最新版本 8\.1\.15 发布于 2026/10/15（25 天前）；至今共发布 15 个版本，其中过去 12 个月发布了 15 个；首次发布于 2026/03/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。