@iteam/encrypt

Some (hopefully) sensible defaults for encrypting in node

Stats

StarsIssuesVersionUpdatedCreatedSize
@iteam/encrypt
0.3.23 years ago4 years agoMinified + gzip package size for @iteam/encrypt in KB

Readme

encrypt

Some (hopefully) sensible defaults for encrypting in node

The data is serialized using msgpack5. This allows for any valid js structure to be encrypted/decrypted

Install

npm install --save @iteam/encrypt

Use

Super simple

const {encrypt, decrypt} = require('@iteam/encrypt').init('my super secret password')

const encrypted = encrypt('some text')  // returns a Buffer
const decrypted = decrypt(encrypted)    // returns 'some text'

With options

const {encrypt, decrypt} = require('@iteam/encrypt')
  .init({
    algorithm: 'aes-256-gcm',   // Default is 'aes-256-cbc',
    authTag: true,              // Only works with gcm
    encoding: 'base64',         // Default is null - ie Buffer
    iv: Buffer.alloc(16),       // Not recommended. Sets iv to zeros only. Other, not recommended value is false which removes iv all together
    password: 'some password'
  })

const encrypted = encrypt('some text')  // returns a base64 encoded string
const decrypted = decrypt(encrypted)    // returns 'some text'

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.