object-rsa
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

ObjectRSA

CI

Encrypt and decrypt JavaScript objects using asymmetric key encryption

Installation

npm install object-rsa

Usage

Initialize the class with at least a key. Have this in mind:

  • Private keys can encrypt and decrypt
  • Public keys can only encrypt
import ObjectRSA from 'object-rsa';

const objectRsa = new ObjectRSA({
  privateKey: '------',
  publicKey: '------'
});

You can create a key pair with the crypto module:

import crypto from 'crypto';

const { publicKey, privateKey } = crypto.generateKeyPairSync('rsa', {
  modulusLength: 2048,
});

Methods

Encrypt object

const objectToEncrypt = {
  number: '4242 4242 4242 4242',
  code: '939',
  expiration: '12/23'
};

const encryptedObject = objectRsa.encrypt(objectToEncrypt);

encryptedObject will now look like:

{
  number: 'bo3gQCqp96Ksqt47BuVGGj+jpjK4Q5j8mAmv+EgW...',
  code: 'DF/pkpCbgRJ61z1pHhH2sps02pN0S2eFY9XI6QFzvmMvN...',
  expiration: 'FaAYCvvMvciMcY1AGX2Jaoy2sf5pzaP...'
}

Decrypt object

const objectToDecrypt = {
  number: 'bo3gQCqp96Ksqt47BuVGGj+jpjK4Q5j8mAmv+EgW...',
  code: 'DF/pkpCbgRJ61z1pHhH2sps02pN0S2eFY9XI6QFzvmMvN...',
  expiration: 'FaAYCvvMvciMcY1AGX2Jaoy2sf5pzaP...'
};

const decryptedObject = objectRsa.decrypt(objectToDecrypt);

decryptedObject will now look like:

{
  number: '4242 4242 4242 4242',
  code: '939',
  expiration: '12/23'
}

What is encrypted

For now, not every value inside the object is encrypted. Check this list (✅ is encrypted, ❌ is not encrypted):

  • Strings ✅
  • Objects ✅
  • Arrays ✅
  • Arrays of objects ✅
  • Booleans ❌
  • Numbers ❌

Package template

We used the package template using:

npx get-template@latest package

Readme

Keywords

Package Sidebar

Install

npm i object-rsa

Weekly Downloads

0

Version

1.0.2

License

MIT

Unpacked Size

10.9 kB

Total Files

8

Last publish

Collaborators

  • itaibo