Skip to content

jihyunlab/crypto

Repository files navigation

@jihyunlab/crypto

Version Downloads Last commit License Linter code style: prettier
Build Lint codecov

@jihyunlab/crypto was developed to enhance the convenience of implementing cryptographic functionalities in Node.js applications.

The encryption function is implemented with Crypto in Node.js and provides encryption for AES 256 CBC and AES 256 GCM.

Installation

npm i @jihyunlab/crypto

Usage

You can easily encrypt and decrypt data with a simple method.

import { CIPHER, createCipher } from '@jihyunlab/crypto';

const cipher = await createCipher(CIPHER.AES_256_GCM, 'your secret key');

const encrypted = await cipher.encrypt('jihyunlab');
console.log(encrypted); // Uint8Array(37)[51, 174, 20, 84, 12, 141, 173, 206, 249, 11, 59, 112, 88, 223, 163, 211, 128, 234, 102, 116, 16, 224, 175, 45, 46, 52, 186, 141, 15, 243, 9, 120, 64, 27, 135, 169, 65]

const decrypted = await cipher.decrypt(encrypted);
console.log(decrypted); // Uint8Array(9)[106, 105, 104, 121, 117, 110, 108, 97, 98]

const buffer = Buffer.from(decrypted);
console.log(buffer.toString()); // jihyunlab

Provides encryption functionality for Uint8Array data.

const encrypted = await cipher.encrypt(
  new Uint8Array([106, 105, 104, 121, 117, 110, 108, 97, 98])
);
console.log(encrypted); // Uint8Array(37)[185, 95, 254, 103, 109, 250, 109, 50, 8, 218, 251, 74, 215, 108, 74, 86, 177, 82, 144, 154, 156, 120, 128, 169, 112, 236, 153, 23, 253, 164, 238, 159, 236, 17, 85, 26, 75]

const decrypted = await cipher.decrypt(encrypted);
console.log(decrypted); // Uint8Array(9)[106, 105, 104, 121, 117, 110, 108, 97, 98]

You can configure encryption options such as salt and iteration.

const cipher = await createCipher(CIPHER.AES_256_GCM, 'your secret key', {
  salt: 'salt',
  iterations: 256,
});

@jihyunlab/web-crypto

@jihyunlab/web-crypto implements encryption functionalities for web applications using the same interface as @jihyunlab/crypto.

Consider using @jihyunlab/web-crypto for decrypting encrypted data from @jihyunlab/crypto in web applications, or vice versa.

import { CIPHER, createCipher } from '@jihyunlab/web-crypto';

const cipher = await createCipher(CIPHER.AES_256_GCM, 'your secret key');
const encrypted = await cipher.encrypt('jihyunlab');

Credits

Authored and maintained by JihyunLab <[email protected]>

License

Open source licensed as MIT.