@tsmx/string-crypto

string-crypto

Encrypt and decrypt strings.

Usage

Key passed via environment variable

const sc = require('@tsmx/string-crypto');

let mySecret = 'My secret string';

let encrypted = sc.encrypt(mySecret);
// '28bedae6f6497f68abe403fb88df340e|2071d6458...'

let decrypted = sc.decrypt(encrypted); 
// 'My secret string'

Key passed directly via options

const sc = require('@tsmx/string-crypto');

let mySecret = 'My secret string';

let encrypted = sc.encrypt(mySecret, { key: '0123456789qwertzuiopasdfghjklyxc' });
// 'ba7bbb57674a198ad6cb7ff65801f9c9|a49cff4c9...'

let decrypted = sc.decrypt(encrypted, { key: '0123456789qwertzuiopasdfghjklyxc' }); 
// 'My secret string'

API

encrypt(value, options = null)

Encrypts value and returns the encrypted string. The key for encryption is taken from options.key or the environment variable ENCRYPTION_KEY if no options are present.

value

Type: String

The string that should be encrypted.

options

Type: Object Default: null

Object containing the supported options for encryption. Please also refer to the notes.

options = {
    key: 'YOUR KEY HERE'
};

decrypt(value, options = null)

Decrypts value and returns the decrypted string. The key for decryption is taken from options.key or the environment variable ENCRYPTION_KEY if no options are present.

value

Type: String

The string that should be decrypted. Must be in the form that encrypt puts out.

options

Type: Object Default: null

Object containing the supported options for decryption. Please also refer to the notes.

options = {
    key: 'YOUR KEY HERE'
};

Notes

Simple helper package to encrypt and decrypt string based on standard NodeJS Crypto functions.

• Used cipher: AES-256-CBC with initialization vector (crypto.createCipheriv)
• IV generation with crypto.randomBytes
• Key length must be 32 bytes. The key can be provided as
  • a string of 32 characters length, or
  • a hexadecimal value of 64 characters length (= 32 bytes)
• If no key is directly passed via options.key it is retrieved from the environment variable ENCRYPTION_KEY.
• Result: string containing the initialization vector and the encrypted value separated by '|'