e2ee-ts v1.0.6

End to End Encryption

A cryptography module that provides RSA & AES encryption interfaces.
Currently supports RSA-OAEP (Asymmetrical) encryption and AES-GCM (Symmetrical) encryption.
This module is available on npm.

Feature highlights

• Easy interfaces to safely encrypt / decrypt.
• RSA & AES encryption algorithms.
• PEM format export.

Contents

• Why should I use this?
• Installation
• APIs
  • RSA-OAEP
    • init()
    • exportPublicKey()
    • importClientPublic()
    • encrypt()
    • decrypt()
    • spkiToPEM()
  • AES-GCM
    • init()
    • exportKey()
    • importBufferKey()
    • encrypt()
    • decrypt()
• Tests

Why should I use this?

This module abstracts the webcrypto APIs, and provides easier interfaces to interact with.

Installation

Yarn

yarn add e2ee-ts

npm

npm i e2ee-ts

RSA Client

init()

Creates a RSA key pair, note that the private key cannot be exported. This method must be called first before other methods can be called, otherwise, it will reject all the operations.

const client = new RSAClient();
await client.init();

exportPublicKey()

Exports the public key as ArrayBuffer. Returns Promise<ArrayBuffer>.

const client = new RSAClient();
await client.init();
const expotedKey = await client.exportPublicKey();

importClientPublic(ArrayBuffer)

Imports a public key into the object, which will be used for encryption.

const client = new RSAClient();
await client.init();
const expotedKey = await client.exportPublicKey();

const client2 = new RSAClient();
await client2.importClientPublic(expotedKey);

encrypt(BufferSource)

Encrypts BufferSource using the public key. Returns Promise<ArrayBuffer>.

await client.encrypt(
  message as ArrayBuffer,
);

decrypt(ArrayBuffer)

Decrypts ArrayBuffer using the private key. Returns Promise<ArrayBuffer>.

await client.decrypt(
  encryptedMessage as ArrayBuffer
);

spkiToPEM(ArrayBuffer)

Converts spki into human readable PEM format.

const client = new RSAClient();
await client.init();
const expotedKey = await client.exportPublicKey();
const pem = client.spkiToPEM(expotedKey)

AES Client

init()

Generates a AES key, note that the private key cannot be exported. This method must be called first before other methods can be called, otherwise, it will reject all the operations.

const client = new AESClient();
await client.init();

exportKey()

Exports the key as ArrayBuffer. Returns Promise<ArrayBuffer>.

const client = new AESClient();
await client.init();
const expotedKey = await client.exportKey();

importBufferKey(ArrayBuffer)

Imports a key into the object, which will be used for encryption.

const client = new AESClient();
await client.init();
const expotedKey = await client.exportKey();

const client2 = new AESClient();
await client2.importBufferKey(expotedKey);

encrypt(BufferSource)

Encrypts BufferSource using the public key. Returns Promise<ArrayBuffer>.

await client.encrypt(
  message as ArrayBuffer,
);

decrypt(ArrayBuffer)

Decrypts ArrayBuffer using the private key. Returns Promise<ArrayBuffer>.

await client.decrypt(
  encryptedMessage as ArrayBuffer
);

Tests

All unit test cases are defined under __tests__ folder.
Run it with:

npm run test