@jrc03c/js-crypto-helpers v0.0.23

Intro

This library just provides a few thin wrappers around core JS crypto functions with sane defaults. I mostly adapted these functions from the following MDN articles:

• crypto.subtle.encrypt : AES-GCM
• crypto.subtle.deriveKey : PBKDF2
• crypto.subtle.digest

I also followed these recommendations, which are described here:

• PBKDF2 w/ 32-byte salt w/ SHA-512 @ 210,000 iterations
• AES-256 in GCM mode w/ 32-byte initialization vector

🚨 DISCLAIMER: I am not a cryptography professional. Use at your own risk! 🚨

Installation

For command line use:

npm install -g @jrc03c/js-crypto-helpers

In Node / bundlers:

npm install --save @jrc03c/js-crypto-helpers

Or in the browser with a CDN:

<script src="https://unpkg.com/@jrc03c/js-crypto-helpers/dist/js-crypto-helpers.js"></script>

Usage

Command line

decrypt --help
encrypt --help
hash --help
random-string --help

NOTE: Be aware that these functions will copy their results to your clipboard if (1) you have xsel installed and (2) you don't specify an output file (i.e., you intend the output to be printed to stdout).

NOTE: I initially had some trouble calling the hash function from the command line, and I think that's because there maybe other programs that use that word. What I ended up doing was putting this in my ~/.bashrc file:

alias hash="node path/to/js-crypto-helpers/src/hash-bin.js".

Node / browser

const { encrypt, decrypt, hash } = require("@jrc03c/js-crypto-helpers")

encrypt("My secret text", "p455w0rd!").then(result => {
  console.log(result)
  // JTdCJTIyc2FsdCUyMiUzQSU3QiUyMnZhbHVlcyUyMiUzQSU1QjIyNyUyQzk2JTJDMzAlMkMxODQlMkMyNDElMkMxMDMlMkM3NyUyQzM1JTJDNzUlMkMxNTMlMkM5NiUyQzEyNSUyQzEzOSUyQzU5JTJDMTEyJTJDMTIwJTVEJTJDJTIyU3ltYm9sKCU0MFR5cGVkQXJyYXlDb25zdHJ1Y3RvciklMjIlM0ElMjJVaW50OEFycmF5JTIyJTdEJTJDJTIyaXYlMjIlM0ElN0IlMjJ2YWx1ZXMlMjIlM0ElNUIzMCUyQzE4NiUyQzEzNyUyQzE0NyUyQzIwNCUyQzIyNCUyQzUlMkMxNzYlMkMxMDIlMkMyMTglMkM2MSUyQzIwNCUyQzIyNCUyQzc1JTJDMjUlMkMxNDAlNUQlMkMlMjJTeW1ib2woJTQwVHlwZWRBcnJheUNvbnN0cnVjdG9yKSUyMiUzQSUyMlVpbnQ4QXJyYXklMjIlN0QlMkMlMjJ2YWx1ZSUyMiUzQSU3QiUyMnZhbHVlcyUyMiUzQSU1QjYyJTJDOCUyQzE0JTJDNzMlMkMxJTJDMjMzJTJDMTAxJTJDMTUlMkMzMCUyQzIyNiUyQzE4MSUyQzE3OSUyQzE0NCUyQzE2JTJDMjI2JTJDMTkwJTJDMTg2JTJDMTc2JTJDMTM5JTJDMiUyQzI5JTJDMjMzJTJDMTUxJTJDNDUlMkM0MyUyQzE0OCUyQzgxJTJDMiUyQzE4MSUyQzI1MSUyQzUlMkMyMDElNUQlMkMlMjJTeW1ib2woJTQwVHlwZWRBcnJheUNvbnN0cnVjdG9yKSUyMiUzQSUyMkFycmF5QnVmZmVyJTIyJTdEJTdE

  decrypt(result, "p455w0rd!").then(orig => {
    console.log(orig)
    // "My secret text"
  })
})

hash("someone@example.com").then(result => {
  console.log(result)
  // a4dcddc4e706799ef4fcd15119077f072804fe679f64008be00b720621900b504ee99976446867865544f4384d0454448ac7d6232a2073389c5b8d43ce4b5ec5
})

Programmatic API

base64Decode

Parameters:

• text = A string in Base64 to be decoded.

Returns:

• A string representing the original value before it was Base64-encoded.

Example:

const { base64Decode, base64Encode } = require("@jrc03c/js-crypto-helpers")
const input = "こんにちは世界！"

const encoded = base64Encode(input)
console.log(encoded)
// JUUzJTgxJTkzJUUzJTgyJTkzJUUzJTgxJUFCJUUzJTgxJUExJUUzJTgxJUFGJUU0JUI4JTk2JUU3JTk1JThDJUVGJUJDJTgx

const output = base64Decode(encoded)
console.log(output)
// こんにちは世界！

base64Encode

Parameters:

• text = A string to be encoded into Base64.

Returns:

• A string in Base64 encoding.

Example:

const { base64Decode, base64Encode } = require("@jrc03c/js-crypto-helpers")
const input = "こんにちは世界！"

const encoded = base64Encode(input)
console.log(encoded)
// JUUzJTgxJTkzJUUzJTgyJTkzJUUzJTgxJUFCJUUzJTgxJUExJUUzJTgxJUFGJUU0JUI4JTk2JUU3JTk1JThDJUVGJUJDJTgx

const output = base64Decode(encoded)
console.log(output)
// こんにちは世界！

decrypt

Parameters:

• data = A string that was previously returned by the encrypt function.
• password = A string.
• options = (optional) An object with these properties:
  • keyIterations = (optional) A positive integer representing the number of iterations used by the key derivation algorithm. The default value is 210,000. Note that this number must be the same as the number of iterations used to encrypt the original data.

Returns:

• A Promise that resolves to a string representing the original, decrypted value.

Example:

const { decrypt, encrypt } = require("@jrc03c/js-crypto-helpers")

encrypt("My secret text", "p455w0rd!").then(async encryptedData => {
  console.log(await decrypt(encryptedData, "p455w0rd!"))
  // My secret text
})

encrypt

Parameters:

• value = A value to be encrypted. Note that this value can be of any type, not just strings! The only caveat is that objects instantiated from specific classes will not be decrypted back into their original instance form; instead, they'll be returned as plain JS objects. For example, if you create a class called Foo, create an instance of that class named foo, encrypt that instance, and then decrypt it again later, it will probably still have most of the visible properties of foo, but it will no longer be an instance of the Foo class.
• password = A string.
• options = (optional) An object with these properties:
  • saltLength = (optional) A positive integer representing the length of the salt to be generated. If salt is passed as well, then saltLength is ignored. The default value is 16.
  • ivLength = (optional) A positive integer representing the length of the initialization vector to be generated. The default value is 16.
  • keyIterations = (optional) A positive integer representing the number of iterations used by the key derivation algorithm. The default value is 210,000.

Returns:

• A Promise that resolves to a string representing the encrypted data.

Example:

const { decrypt, encrypt } = require("@jrc03c/js-crypto-helpers")

encrypt("My secret text", "p455w0rd!").then(async data => {
  console.log(await decrypt(data, "p455w0rd!"))
  // My secret text
})

hash

Parameters:

• value = A value to be hashed. Note that this value can be of any type, not just strings! Non-string values are converted to strings using this library's stringify function.
• salt = A string to be added to value before hashing.

Returns:

• A Promise that resolves to a string.

Example:

const { hash } = require("@jrc03c/js-crypto-helpers")

// without salt
hash("Hello, world!").then(console.log)
// f716fb41b25d366c6a3b86c3c04aad45500416fb56223dc56aa3ced1e775e15717f57f80a619067df61d7751a17e0d549979a32a079b9596ff79d9e856acb3ef

// with salt
hash("Hello, world!", "This is a salt!").then(console.log)
// fb355ba9f91f56836ae8b05fcae647f34073eb41cc63044d73fc101020a25a1a50045d9363fbbc1d97683da00eecdd6f06f994c4837f2349688292053e07d369

// with salt added to the original value instead of being passed as an argument
hash("Hello, world!" + "This is a salt!").then(console.log)
// fb355ba9f91f56836ae8b05fcae647f34073eb41cc63044d73fc101020a25a1a50045d9363fbbc1d97683da00eecdd6f06f994c4837f2349688292053e07d369

parse

Technically speaking, this function is just re-exported from the @jrc03c/js-text-tools library without any modification. See the source code there for implementation details. Note that this function is designed to be paired with the stringify function from the same library, especially when attempting to stringify typed arrays (e.g., UInt8Array, ArrayBuffer, etc.). Generally speaking, it functions much like JSON.parse except that it adds support for a few extra edge cases like symbols and typed arrays.

Parameters:

• value = A string to be parsed.

Returns:

• A value of whatever type the stringified value represented.

Example:

const { parse, stringify } = require("@jrc03c/js-crypto-helpers")

const s = stringify({ hello: "world" })
const orig = parse(s)

console.log(orig)
// { hello: 'world' } object

console.log(typeof orig)
// object

randomString

Parameters:

• length = A positive integer representing the length of the string to be returned.
• charset = (optional) A string containing the characters of which the returned string should be composed.

Returns:

• A string.

Example:

const { randomString } = require("@jrc03c/js-crypto-helpers")

console.log(randomString(32))
// y3Qotz5cZZYdXGCuyZB2SymSmr6t5kmo

console.log(randomString(32, "foo"))
// oofoofoffooofofofoofoffoffooooff

stringify

Technically speaking, this function is just re-exported from the @jrc03c/js-text-tools library without any modification. See the source code there for implementation details, and see the notes below the parse function for more information.

NOTE: This function will destroy any circular references that exist in objects.

Parameters:

• value = A value to be stringified.
• indentation = (optional) A string used to indent each line in the returned string. If not passed, the returned string won't contain any line breaks or indentation (except, of course, where strings already inside the object contain line breaks and indentations). This parameter is very similar to the third argument passed into JSON.stringify (e.g., JSON.stringify(myObject, null, 2)) except that indentation in this implementation can be any characters, not just spaces. Of course, that opens up the possibility of creating invalid JSON, but I'm not too worried about that.

Returns:

• A string.

Example:

const { stringify } = require("@jrc03c/js-crypto-helpers")
const object = { hello: "world" }
const indentation = "  "

// without indentation
console.log(stringify(object))
// {"hello":"world"}

// with indentation
console.log(stringify(object, indentation))
// {
//   "hello": "world"
// }