rno

react-native-openpgp

OpenPGP.js adaptation for React-Native

Showing:

Popularity

Downloads/wk

8

GitHub Stars

34

Maintenance

Last Commit

5mos ago

Contributors

47

Package

Dependencies

6

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

React-Native-OpenPGP

React-Native-OpenPGP is a Javascript implementation of the OpenPGP protocol based on OpenPGP.js.

Getting started

Installation

npm install --save react-native-openpgp

// not needed if using auto-linking RN > 0.060
react-native link react-native-openpgp

Alternatively you can add the Android and iOS modules library by following the official guide.

Usage

import * as openpgp from 'react-native-openpgp';

Encrypt and decrypt String data with a password

var options, encrypted;

options = {
  data: 'Hello, World!',      // input as String
  passwords: ['secret stuff'] // multiple passwords possible
};

openpgp.encrypt(options)
  .then((ciphertext) => {
    encrypted = ciphertext.data; // '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----'
  })
  .catch((error) => {
    console.log("Something went wrong: " + error);
  });
options = {
  message: openpgp.readMessage(encrypted), // parse armored message
  password: 'secret stuff'                         // decrypt with password
};

openpgp.decrypt(options)
  .then((plaintext) => {
    return plaintext.data; // 'Hello, World!'
  })
  .catch((error) => {
    console.log("Something went wrong: " + error);
  });

Encrypt and decrypt Uint8Array data with PGP keys

var options, encrypted;

var pubkey = '-----BEGIN PGP PUBLIC KEY BLOCK ... END PGP PUBLIC KEY BLOCK-----';
var privkey = '-----BEGIN PGP PRIVATE KEY BLOCK ... END PGP PRIVATE KEY BLOCK-----';

options = {
  data: new Uint8Array([0x01, 0x01, 0x01]),           // input as Uint8Array
  publicKeys: openpgp.readArmoredKey(pubkey).keys,   // for encryption
  privateKeys: openpgp.readArmoredKey(privkey).keys, // for signing (optional)
  armor: false                                        // don't ASCII armor
};

openpgp.encrypt(options)
  .then((ciphertext) => {
    encrypted = ciphertext.message.packets.write(); // get raw encrypted packets as Uint8Array
  })
  .catch((error) => {
    console.log("Something went wrong: " + error);
  });
options = {
  message: openpgp.readBinaryMessage(encrypted),             // parse encrypted bytes
  publicKeys: openpgp.readArmoredKey(pubkey).keys,     // for verification (optional)
  privateKey: openpgp.readArmoredKey(privkey).keys[0], // for decryption
  format: 'binary'                                      // output as Uint8Array
};

openpgp.decrypt(options)
  .then((plaintext) => {
    return plaintext.data // Uint8Array([0x01, 0x01, 0x01])
  })
  .catch((error) => {
    console.log("Something went wrong: " + error);
  });

Generate new key pair

var options = {
  userIds: [{ name:'Jon Smith', email:'jon@example.com' }], // multiple user IDs
  numBits: 2048,                                            // RSA key size
  passphrase: 'super long and hard to guess secret'         // protects the private key
};

openpgp.generateKey(options)
  .then((key) => {
    var privkey = key.privateKeyArmored; // '-----BEGIN PGP PRIVATE KEY BLOCK ... '
    var pubkey = key.publicKeyArmored;   // '-----BEGIN PGP PUBLIC KEY BLOCK ... '
  })
  .catch((error) => {
    console.log("Something went wrong: " + error);
  });

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100