# react-native-fast-openpgp > library for use openPGP Latest version **2.9.3** (published 2025-09-30) · MIT license · 0 weekly downloads ## Install ```sh npm install react-native-fast-openpgp pnpm add react-native-fast-openpgp yarn add react-native-fast-openpgp bun add react-native-fast-openpgp ``` ## Health **Score 40/100 (D)** — status: maintenance-mode. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads; large bundle. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 2.9.3 | | Published | 2025-09-30 | | First published | 2019-07-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >= 18.0.0 | | Dependencies | 2 | | Unpacked size | 44.9 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 52 | | Author | Gerson Alexander Pardo Gamez | | Maintainers | pardacho | | Keywords | react-native, ios, android | ## Links - npm: https://www.npmjs.com/package/react-native-fast-openpgp - Repository: https://github.com/jerson/react-native-fast-openpgp - Homepage: https://github.com/jerson/react-native-fast-openpgp#readme - Issues: https://github.com/jerson/react-native-fast-openpgp/issues - npm.io page: https://npm.io/package/react-native-fast-openpgp ## Dependencies (2) - [big-integer](https://npm.io/package/big-integer.md) ^1.6.51 - [flatbuffers](https://npm.io/package/flatbuffers.md) 24.3.25 ## Alternatives - [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads - [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads - [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads - [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads - [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads ## Recent versions - 2.9.3 (latest) — 2025-09-30 - 2.9.2 — 2025-04-23 - 2.9.1 — 2025-03-16 - 2.9.0 — 2025-03-15 - 2.8.1 — 2025-03-13 - 2.8.0 — 2024-12-01 - 2.7.4 — 2024-07-19 - 2.7.3 — 2024-05-23 - 2.7.2 — 2024-01-28 - 2.7.1 — 2023-12-21 - 2.7.0 — 2023-10-23 - 2.6.0 — 2023-01-29 - 2.5.1 — 2022-10-30 - 2.5.0 — 2022-10-30 - 2.4.5 — 2022-10-23 - … 58 more at https://npm.io/package/react-native-fast-openpgp/versions ## README # react-native-fast-openpgp [![Android](https://github.com/jerson/react-native-fast-openpgp/actions/workflows/android.yml/badge.svg)](https://github.com/jerson/react-native-fast-openpgp/actions/workflows/android.yml) [![iOS](https://github.com/jerson/react-native-fast-openpgp/actions/workflows/ios.yml/badge.svg)](https://github.com/jerson/react-native-fast-openpgp/actions/workflows/ios.yml) ## Getting started `$ npm install react-native-fast-openpgp --save` ## JSI If you want to use with `NativeModules` instead of `JSI` you need to set ```typescript import OpenPGP from "react-native-fast-openpgp"; OpenPGP.useJSI = false; ``` if you need to use generate methods it is a good idea to disable it, because for now JSI will block your UI but it is faster compared to NativeModules ## Usage ### Encrypt methods ```typescript import OpenPGP from "react-native-fast-openpgp"; const encrypted = await OpenPGP.encrypt(message: string, publicKey: string, signedEntity?: Entity, fileHints?: FileHints, options?: KeyOptions ): Promise; const encrypted = await OpenPGP.encryptBytes(message: Uint8Array, publicKey: string, signedEntity?: Entity, fileHints?: FileHints, options?: KeyOptions ): Promise; const outputFile = await OpenPGP.encryptFile(inputFile: string, outputFile: string, publicKey: string, signedEntity?: Entity, fileHints?: FileHints, options?: KeyOptions): Promise; const encryptedSymmetric = await OpenPGP.encryptSymmetric(message: string, passphrase: string, fileHints?: FileHints, options?: KeyOptions ): Promise; const encryptedSymmetric = await OpenPGP.encryptSymmetricBytes(message: Uint8Array, passphrase: string, fileHints?: FileHints, options?: KeyOptions ): Promise; const outputFile = await OpenPGP.encryptSymmetricFile(inputFile: string, outputFile: string, passphrase: string, fileHints?: FileHints, options?: KeyOptions ): Promise ; ``` ### Decrypt methods ```typescript import OpenPGP from "react-native-fast-openpgp"; const decrypted = await OpenPGP.decrypt(message: string, privateKey: string, passphrase: string, options?: KeyOptions ): Promise; const decrypted = await OpenPGP.decryptBytes(message: Uint8Array, privateKey: string, passphrase: string, options?: KeyOptions ): Promise; const outputFile = await OpenPGP.decryptFile(inputFile: string, outputFile: string, privateKey: string, passphrase: string, options?: KeyOptions ): Promise; const decryptedSymmetric = await OpenPGP.decryptSymmetric(message: string, passphrase: string, options?: KeyOptions ): Promise; const decryptedSymmetric = await OpenPGP.decryptSymmetricBytes(message: Uint8Array, passphrase: string, options?: KeyOptions ): Promise; const outputFile = await OpenPGP.decryptSymmetricFile(inputFile: string, outputFile: string, passphrase: string, options?: KeyOptions ): Promise ; ``` ### Sign and Verify methods ```typescript import OpenPGP from "react-native-fast-openpgp"; const signed = await OpenPGP.sign(message: string, privateKey: string, passphrase: string, options?: KeyOptions ): Promise; const signed = await OpenPGP.signBytes(message: Uint8Array, privateKey: string, passphrase: string, options?: KeyOptions ): Promise; const signed = await OpenPGP.signBytesToString(message: Uint8Array, privateKey: string, passphrase: string, options?: KeyOptions ): Promise; const signed = await OpenPGP.signFile(inputFile: string, privateKey: string, passphrase: string, options?: KeyOptions ): Promise; const verified = await OpenPGP.verify(signature: string, message: string, publicKey: string ): Promise; const verified = await OpenPGP.verifyBytes(signature: string, message: Uint8Array, publicKey: string ): Promise; const verified = await OpenPGP.verifyFile(signature: string, inputFile: string,publicKey: string): Promise; ``` ### Generate ```typescript import OpenPGP from "react-native-fast-openpgp"; const generated = await OpenPGP.generate(options: Options): Promise; ``` ### Convert methods ```typescript import OpenPGP from "react-native-fast-openpgp"; const publicKey = await OpenPGP.convertPrivateKeyToPublicKey(privateKey: string): Promise; ``` ### Metadata methods ```typescript import OpenPGP from "react-native-fast-openpgp"; const metadata1 = await OpenPGP.getPublicKeyMetadata(publicKey: string): Promise; const metadata2 = await OpenPGP.getPrivateKeyMetadata(privateKey: string): Promise; ``` ### Encrypt with multiple keys ```typescript import OpenPGP from "react-native-fast-openpgp"; const publicKeys = `-----BEGIN PGP PUBLIC KEY BLOCK----- mQENBF0Tpe0BCADm+ja4vMKuodkQEhLm/092M/6gt4TaKwzv8QcA53/FrM3g8wab D4m65Neoc7DBEdvzgK9IUMpwG5N0t+0pfWLhs8AZdMxE7RbP =kbtq -----END PGP PUBLIC KEY BLOCK----- -----BEGIN PGP PUBLIC KEY BLOCK----- mQENBF0Tpe0BCADm+ja4vMKuodkQEhLm/092M/6gt4TaKwzv8QcA53/FrM3g8wab D4m65Neoc7DBEdvzgK9IUMpwG5N0t+0pfWLhs8AZdMxE7RbP =kbtq -----END PGP PUBLIC KEY BLOCK----- -----BEGIN PGP PUBLIC KEY BLOCK----- mQENBF0Tpe0BCADm+ja4vMKuodkQEhLm/092M/6gt4TaKwzv8QcA53/FrM3g8wab D4m65Neoc7DBEdvzgK9IUMpwG5N0t+0pfWLhs8AZdMxE7RbP =kbtq -----END PGP PUBLIC KEY BLOCK-----`; const encrypted = await OpenPGP.encrypt("sample text" publicKeys); ``` ### Types ```typescript import OpenPGP from "react-native-fast-openpgp"; export enum Algorithm { RSA = 0, ECDSA = 1, EDDSA = 2, ECHD = 3, DSA = 4, ELGAMAL = 5, } export enum Curve { CURVE25519 = 0, CURVE448 = 1, P256 = 2, P384 = 3, P521 = 4, SECP256K1 = 5, BRAINPOOLP256 = 6, BRAINPOOLP384 = 7, BRAINPOOLP512 = 8, } export enum Hash { SHA256 = 0, SHA224 = 1, SHA384 = 2, SHA512 = 3, } export enum Compression { NONE = 0, ZLIB = 1, ZIP = 2, } export enum Cipher { AES128 = 0, AES192 = 1, AES256 = 2, DES = 3, CAST5 = 4, } export interface KeyOptions { /** * The public key algorithm to use - will always create a signing primary * key and encryption subkey. * @default RSA */ algorithm?: Algorithm; /** * Curve configures the desired packet.Curve if the Algorithm is PubKeyAlgoECDSA, * PubKeyAlgoEdDSA, or PubKeyAlgoECDH. If empty Curve25519 is used. * @default CURVE25519 */ curve?: Curve; /** * RSABits is the number of bits in new RSA keys made with NewEntity. * If zero, then 2048 bit keys are created. * @default 2048 */ rsaBits?: number; /** * Cipher is the cipher to be used. * If zero, AES-128 is used. * @default AES128 */ cipher?: Cipher; /** * Compression is the compression algorithm to be * applied to the plaintext before encryption. If zero, no * compression is done. * @default none */ compression?: Compression; /** * Hash is the default hash function to be used. * If zero, SHA-256 is used. * @default SHA256 */ hash?: Hash; /** * CompressionLevel is the compression level to use. It must be set to * between -1 and 9, with -1 causing the compressor to use the * default compression level, 0 causing the compressor to use * no compression and 1 to 9 representing increasing (better, * slower) compression levels. If Level is less than -1 or * more then 9, a non-nil error will be returned during * encryption. See the constants above for convenient common * settings for Level. * @default 0 */ compressionLevel?: number; } export interface Options { comment?: string; email?: string; name?: string; passphrase?: string; keyOptions?: KeyOptions; } export interface KeyPair { publicKey: string; privateKey: string; } export interface PublicKeyMetadata { keyID: string; keyIDShort: string; creationTime: string; fingerprint: string; keyIDNumeric: string; isSubKey: boolean; } export interface PrivateKeyMetadata { keyID: string; keyIDShort: string; creationTime: string; fingerprint: string; keyIDNumeric: string; isSubKey: boolean; encrypted: boolean; } /** * An Entity represents the components of an OpenPGP key: a primary public key * (which must be a signing key), one or more identities claimed by that key, * and zero or more subkeys, which may be encryption keys. */ export interface Entity { publicKey: string; privateKey: string; passphrase?: string; } export interface FileHints { /** * IsBinary can be set to hint that the contents are binary data. */ isBinary?: boolean; /** * FileName hints at the name of the file that should be written. It's * truncated to 255 bytes if longer. It may be empty to suggest that the * file should not be written to disk. It may be equal to "_CONSOLE" to * suggest the data should not be written to disk. */ fileName?: string; /** * ModTime format allowed: RFC3339, contains the modification time of the file, or the zero time if not applicable. */ modTime?: string; } ``` ## Native Code the native library is made in Golang for faster performance ## Contributing See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. ## License MIT --- _Source: https://npm.io/package/react-native-fast-openpgp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._