CoralPay PGP 🔐

CoralPay Encryption and Decryption Lib which is a wrapper around the GPG cli tool.

Installation

yarn add @random-guys/coralpay-pgp

or

npm install @random-guys/coralpay-pgp

Usage

import { Pgp } from '@random-guys/coralpay-pgp';

try {
  const publicKeyPath = join(__dirname, './keys/public_key.txt');
  const privateKeyPath = join(__dirname, './keys/private_key.txt');
  const passphrase = 'c-ronaldo';

  const pgp = new Pgp({
    privateKeyPath,
    publicKeyPath,
    passphrase
  });

  const payload = {
    accountNumber: '00000111111'
    name: 'Raymond',
    age: '20',
  };

  const encrypted = await utilities.encryptRequest(payload);
  const decrypted = await pgp.decryptResponse(encrypted);
  console.log({ encrypted, decrypted });
} catch (error) {
  console.log(error);
}

Usage with Docker

Prerequisites

1. Modify run.sh to change the paths to your keys. This imports the keys into your gpg keychain in the container.

2. Create a passphrase (called my passphrase.txt) file. Practically this may be an envionment variable on your CI that's written to the file, knock yourself out.

Issues

Testing

If you have any issues when trying to run unit tests, where the error message is concatUint8Array: Data must be in the form of a Uint8Array, see this github issue