Skip to main content
@capgo/capacitor-ssl-pinning Auth & Security Open source

SSL Pinning Capacitor plugin

Pin HTTPS connections to bundled certificates for CapacitorHttp on iOS and Android

Install

bun add @capgo/capacitor-ssl-pinning bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-ssl-pinning
  • pnpm add @capgo/capacitor-ssl-pinning
  • yarn add @capgo/capacitor-ssl-pinning

Guide

How to use SSL Pinning in Capacitor

Using @capgo/capacitor-ssl-pinning

Capacitor API for inspecting SSL pinning configuration.

Install

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

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { SSLPinning } from '@capgo/capacitor-ssl-pinning';

API at a glance

Method Description
getConfiguration Returns the active native configuration visible to the plugin.

Examples

getConfiguration()

Returns the active native configuration visible to the plugin.

import { SSLPinning } from '@capgo/capacitor-ssl-pinning';

const result = await SSLPinning.getConfiguration();
console.log(result);

Full reference

Keep going from Using @capgo/capacitor-ssl-pinning

If you are using Using @capgo/capacitor-ssl-pinning to plan security and compliance, connect it with @capgo/capacitor-ssl-pinning for the implementation detail in @capgo/capacitor-ssl-pinning, Getting Started for the implementation detail in Getting Started, Encryption for the implementation detail in Encryption, Compliance for the implementation detail in Compliance, and Capgo Security Scanner for the product workflow in Capgo Security Scanner.

FAQ

SSL Pinning plugin FAQ

How do I install the SSL Pinning plugin in a Capacitor app?

Run "bun add @capgo/capacitor-ssl-pinning" (or "npm install @capgo/capacitor-ssl-pinning"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-ssl-pinning" in your app code.

Does @capgo/capacitor-ssl-pinning work with React, Vue and Angular?

Yes. SSL Pinning is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-ssl-pinning support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-ssl-pinning free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-ssl-pinning/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses SSL Pinning without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Ship SSL Pinning changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo