react-native-fast-openpgp

Getting started

$ npm install react-native-fast-openpgp --save

JSI

If you want to use with NativeModules instead of JSI you need to set

1import OpenPGP from "react-native-fast-openpgp";
2
3OpenPGP.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

1import OpenPGP from "react-native-fast-openpgp";
2
3const encrypted = await OpenPGP.encrypt(message: string, publicKey: string, signedEntity?: Entity, fileHints?: FileHints, options?: KeyOptions ): Promise<string>;
4const encrypted = await OpenPGP.encryptBytes(message: Uint8Array, publicKey: string, signedEntity?: Entity, fileHints?: FileHints, options?: KeyOptions ): Promise<Uint8Array>;
5const outputFile = await OpenPGP.encryptFile(inputFile: string, outputFile: string, publicKey: string, signedEntity?: Entity, fileHints?: FileHints, options?: KeyOptions): Promise<number>;
6
7const encryptedSymmetric = await OpenPGP.encryptSymmetric(message: string, passphrase: string, fileHints?: FileHints, options?: KeyOptions ): Promise<string>;
8const encryptedSymmetric = await OpenPGP.encryptSymmetricBytes(message: Uint8Array, passphrase: string, fileHints?: FileHints, options?: KeyOptions ): Promise<Uint8Array>;
9const outputFile = await OpenPGP.encryptSymmetricFile(inputFile: string, outputFile: string, passphrase: string, fileHints?: FileHints, options?: KeyOptions ): Promise<number> ;

Decrypt methods

1import OpenPGP from "react-native-fast-openpgp";
2
3const decrypted = await OpenPGP.decrypt(message: string, privateKey: string, passphrase: string, options?: KeyOptions ): Promise<string>;
4const decrypted = await OpenPGP.decryptBytes(message: Uint8Array, privateKey: string, passphrase: string, options?: KeyOptions ): Promise<Uint8Array>;
5const outputFile = await OpenPGP.decryptFile(inputFile: string, outputFile: string, privateKey: string, passphrase: string, options?: KeyOptions ): Promise<number>;
6
7const decryptedSymmetric = await OpenPGP.decryptSymmetric(message: string, passphrase: string, options?: KeyOptions ): Promise<string>;
8const decryptedSymmetric = await OpenPGP.decryptSymmetricBytes(message: Uint8Array, passphrase: string, options?: KeyOptions ): Promise<Uint8Array>;
9const outputFile = await OpenPGP.decryptSymmetricFile(inputFile: string, outputFile: string, passphrase: string, options?: KeyOptions ): Promise<number> ;

Sign and Verify methods

1import OpenPGP from "react-native-fast-openpgp";
2
3const signed = await OpenPGP.sign(message: string, privateKey: string, passphrase: string, options?: KeyOptions ): Promise<string>;
4const signed = await OpenPGP.signBytes(message: Uint8Array, privateKey: string, passphrase: string, options?: KeyOptions ): Promise<Uint8Array>;
5const signed = await OpenPGP.signBytesToString(message: Uint8Array, privateKey: string, passphrase: string, options?: KeyOptions ): Promise<string>;
6const signed = await OpenPGP.signFile(inputFile: string, privateKey: string, passphrase: string, options?: KeyOptions ): Promise<string>;
7
8const verified = await OpenPGP.verify(signature: string, message: string, publicKey: string ): Promise<boolean>;
9const verified = await OpenPGP.verifyBytes(signature: string, message: Uint8Array, publicKey: string ): Promise<boolean>;
10const verified = await OpenPGP.verifyFile(signature: string, inputFile: string,publicKey: string): Promise<boolean>;

Generate

1import OpenPGP from "react-native-fast-openpgp";
2
3const generated = await OpenPGP.generate(options: Options): Promise<KeyPair>;

Convert methods

1import OpenPGP from "react-native-fast-openpgp";
2
3const publicKey = await OpenPGP.convertPrivateKeyToPublicKey(privateKey: string): Promise<string>;

Metadata methods

1import OpenPGP from "react-native-fast-openpgp";
2
3const metadata1 = await OpenPGP.getPublicKeyMetadata(publicKey: string): Promise<PublicKeyMetadata>;
4const metadata2 = await OpenPGP.getPrivateKeyMetadata(privateKey: string): Promise<PrivateKeyMetadata>;

Encrypt with multiple keys

1import OpenPGP from "react-native-fast-openpgp";
2
3const publicKeys = `-----BEGIN PGP PUBLIC KEY BLOCK-----
4
5mQENBF0Tpe0BCADm+ja4vMKuodkQEhLm/092M/6gt4TaKwzv8QcA53/FrM3g8wab
6D4m65Neoc7DBEdvzgK9IUMpwG5N0t+0pfWLhs8AZdMxE7RbP
7=kbtq
8-----END PGP PUBLIC KEY BLOCK-----
9-----BEGIN PGP PUBLIC KEY BLOCK-----
10
11mQENBF0Tpe0BCADm+ja4vMKuodkQEhLm/092M/6gt4TaKwzv8QcA53/FrM3g8wab
12D4m65Neoc7DBEdvzgK9IUMpwG5N0t+0pfWLhs8AZdMxE7RbP
13=kbtq
14-----END PGP PUBLIC KEY BLOCK-----
15-----BEGIN PGP PUBLIC KEY BLOCK-----
16
17mQENBF0Tpe0BCADm+ja4vMKuodkQEhLm/092M/6gt4TaKwzv8QcA53/FrM3g8wab
18D4m65Neoc7DBEdvzgK9IUMpwG5N0t+0pfWLhs8AZdMxE7RbP
19=kbtq
20-----END PGP PUBLIC KEY BLOCK-----`;
21const encrypted = await OpenPGP.encrypt("sample text" publicKeys);

Types

1import OpenPGP from "react-native-fast-openpgp";
2
3export enum Algorithm {
4  RSA = 0,
5  ECDSA = 1,
6  EDDSA = 2,
7  ECHD = 3,
8  DSA = 4,
9  ELGAMAL = 5,
10}
11
12export enum Curve {
13  CURVE25519 = 0,
14  CURVE448 = 1,
15  P256 = 2,
16  P384 = 3,
17  P521 = 4,
18  SECP256K1 = 5,
19  BRAINPOOLP256 = 6,
20  BRAINPOOLP384 = 7,
21  BRAINPOOLP512 = 8,
22}
23
24export enum Hash {
25  SHA256 = 0,
26  SHA224 = 1,
27  SHA384 = 2,
28  SHA512 = 3,
29}
30
31export enum Compression {
32  NONE = 0,
33  ZLIB = 1,
34  ZIP = 2,
35}
36
37export enum Cipher {
38  AES128 = 0,
39  AES192 = 1,
40  AES256 = 2,
41  DES = 3,
42  CAST5 = 4,
43}
44
45export interface KeyOptions {
46    /**
47     * The public key algorithm to use - will always create a signing primary
48     * key and encryption subkey.
49     * @default RSA
50     */
51    algorithm?: Algorithm;
52
53    /**
54     * Curve configures the desired packet.Curve if the Algorithm is PubKeyAlgoECDSA,
55     * PubKeyAlgoEdDSA, or PubKeyAlgoECDH. If empty Curve25519 is used.
56     * @default CURVE25519
57     */
58    curve?: Curve;
59
60    /**
61     * RSABits is the number of bits in new RSA keys made with NewEntity.
62     * If zero, then 2048 bit keys are created.
63     * @default 2048
64     */
65    rsaBits?: number;
66
67    /**
68     * Cipher is the cipher to be used.
69     * If zero, AES-128 is used.
70     * @default AES128
71     */
72    cipher?: Cipher;
73
74    /**
75     * Compression is the compression algorithm to be
76     * applied to the plaintext before encryption. If zero, no
77     * compression is done.
78     * @default none
79     */
80    compression?: Compression;
81
82    /**
83     * Hash is the default hash function to be used.
84     * If zero, SHA-256 is used.
85     * @default SHA256
86     */
87    hash?: Hash;
88
89    /**
90     * CompressionLevel is the compression level to use. It must be set to
91     * between -1 and 9, with -1 causing the compressor to use the
92     * default compression level, 0 causing the compressor to use
93     * no compression and 1 to 9 representing increasing (better,
94     * slower) compression levels. If Level is less than -1 or
95     * more then 9, a non-nil error will be returned during
96     * encryption. See the constants above for convenient common
97     * settings for Level.
98     * @default 0
99     */
100    compressionLevel?: number;
101}
102
103export interface Options {
104    comment?: string;
105    email?: string;
106    name?: string;
107    passphrase?: string;
108    keyOptions?: KeyOptions;
109}
110
111export interface KeyPair {
112    publicKey: string;
113    privateKey: string;
114}
115
116export interface PublicKeyMetadata {
117    keyID: string;
118    keyIDShort: string;
119    creationTime: string;
120    fingerprint: string;
121    keyIDNumeric: string;
122    isSubKey: boolean;
123}
124export interface PrivateKeyMetadata {
125    keyID: string;
126    keyIDShort: string;
127    creationTime: string;
128    fingerprint: string;
129    keyIDNumeric: string;
130    isSubKey: boolean;
131    encrypted: boolean;
132}
133
134/**
135 * An Entity represents the components of an OpenPGP key: a primary public key
136 * (which must be a signing key), one or more identities claimed by that key,
137 * and zero or more subkeys, which may be encryption keys.
138 */
139export interface Entity {
140    publicKey: string;
141    privateKey: string;
142    passphrase?: string;
143}
144
145export interface FileHints {
146    /**
147     * IsBinary can be set to hint that the contents are binary data.
148     */
149    isBinary?: boolean;
150    /**
151     * FileName hints at the name of the file that should be written. It's
152     * truncated to 255 bytes if longer. It may be empty to suggest that the
153     * file should not be written to disk. It may be equal to "_CONSOLE" to
154     * suggest the data should not be written to disk.
155     */
156    fileName?: string;
157    /**
158     * ModTime format allowed: RFC3339, contains the modification time of the file, or the zero time if not applicable.
159     */
160    modTime?: string;
161}
162

Native Code

the native library is made in Golang for faster performance

https://github.com/jerson/openpgp-mobile

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT