@jihyunlab/web-crypto
TypeScript icon, indicating that this package has built-in type declarations

1.0.13 • Public • Published

@jihyunlab/web-crypto

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

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

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

Installation

npm i @jihyunlab/web-crypto

Usage

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

import { CIPHER, createCipher } from '@jihyunlab/web-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]

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-buffer

You can install @jihyunlab/web-buffer to perform additional data conversions.

npm i @jihyunlab/web-buffer
import { WebBuffer } from '@jihyunlab/web-buffer';

const buffer = WebBuffer.from(
  new Uint8Array([106, 105, 104, 121, 117, 110, 108, 97, 98]),
  'uint8array' /* hex, base64, base64url, utf8, uint8array */
);

const utf8 = buffer.toString('utf8');
console.log(utf8); // jihyunlab

@jihyunlab/crypto

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

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

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

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

Credits

Authored and maintained by JihyunLab <info@jihyunlab.com>

License

Open source licensed as MIT.

Package Sidebar

Install

npm i @jihyunlab/web-crypto

Weekly Downloads

6

Version

1.0.13

License

MIT

Unpacked Size

18.4 kB

Total Files

13

Last publish

Collaborators

  • jihyunlab-donghyun
  • jihyunlab-jh
  • jihyunlab-dh
  • jihyunlab-jmin
  • jihyunlab-phil
  • jihyunlab-dev