shrine512

v1.0.1

Published

3 years ago

Convenient and extremely easy to use SHA-512 encryption/decryption of strings or objects with a single method for each direction - easy!

Downloads

0High
0Medium
0Low

bemoje

sha512 aes aes-256 aes-256-gcm gcm sha 512 encryption decryption shrine shrine512 encrypt decrypt crypt crypto easy simple beginner object string

shrine512

link link link

Introduction

Convenient and beginner-friendly module for encryption. It is very very easy to use and perform 'AES-256-GCM' (SHA-512) encryption/decryption of strings, objects, filecontent, etc. It is using Node.js' native crypto API, which is very good, but not very self-explanatory or at all easy to use unless you are quite familiar with the many concepts of cryptography prior to using it. If you just want to get started with encrypting something, this module makes it as accessible as is possible.

Fun fact: The encryption algorithm itself was originally developed by the NSA of the US government.

For those who aren't sure when less could be enough, this module offers a very heavy type of encryption. However, this heaviness is also obvious from a computational point of view, meaning that it takes a lot longer to encrypt and decrypt data with this module compared to other methods whenever a little or even sometimes much less computational effort would otherwise suffice - that is, in terms of protecting against brute-force attacks to a degree where that kind of attack is no longer practically feasable. To summarize: it's easy. It's always a secure type of encryption, but often way more than neccessary - and therefore slow.

Disclaimer! The success of brute-force attacks are a matter of chance by nature, so even though it is neither practically relevant to worry about when sufficiently encrypted, nor realistic to randomly guess a strong encryption key, it is, however theoretically possible to correctly guess any secret, incl. any encryption key.

Benjamin M�ller Jensen

Why make this?

Many encryption libraries / tools require a lot of prior knowledge to know how to even use them. This does not. It's so simple, it's basically just an on/off switch. I might just be half-blind or unlucky, but I have not come across any module that is just absolutely simple with good defaults or fixed settings out of the box, so I thought to fill the gap as to help javascript on its never-ending way to becoming ever more friendly to newcomers than it already is.
Although other means of encryption can be 'good enough' in various specific use-cases, this tool consistently offers somewhere between 'way too much' and 'definately enough' encryption, assuming your encryption key is not (figuratively and not isolated to) just "1234".

Features

A single exposed class with only two simple instance methods, encrypt & decrypt.
Support for both strings & objects. So anything JSON.stringify-parsable, basically. In most cases, that means anything from file-contents to whatever.
Tested with Mark Sugarburger's testing framework, Jest indeed with 100 % code-coverage.
A 128-bit (maximum) auth-tag length is always used and is automatic and not configurable. See this if you should be confused as to why tag-length is important.
Serializes with JSON.stringify and unserializes with JSON.parse. If that should not suffice, consider handling serialization yourself prior to passing your data to the encryption method. More universal serialization is a todo :)
Encryption is undeterministic, meaning that the same data encrypted multiple times does not produce identical output, so that it's not just obvious and self-revealing the fact that it was so.
Salt (IV) is automatic and also very random. This is to avoid being open to plaintext-checking attacks. The basics of this form of attack being that an attacker can predict the IV if the same one is used repeatedly. In certain scenarios, an attacker can even use the encryption operation as an 'oracle' and can thereby deduce the value of low entropy plaintext-blocks if encrypted by the same encryption key (of which the IV is part, along with the encryption key). So it's a way to indistinguisly imitate yourself creating a new unique key every time you encrypt something. This happens natively in t
This and the encryption key are both stored so that it is inaccesible at runtime to all except the instance methods themselves, and can thereby be used multiple times without having to pass the encryption key around in an insecure way, potentially exposing it by accident. When the instance is garbage-collected by the runtime environment (V8, for instance), the encryption key is also destroyed simultaneously and to date inevitably, and to date with no possible means of recovery.
The used algorithm natively attempts to compensate for short encryption keys, but please create long encryption keys instead of relying on that.

Installation

Compatibility

Dependencies

Package

npm install --save shrine512

Usage

Import

import Shrine512 from 'shrine512'

Require

const Shrine512 = require('shrine512')

Example

import Shrine512 from 'shrine512'
import assert from 'assert'

(async () => {
    try {
        //for simpler syntax
        const str = JSON.stringify
        const log = console.log

		//pass secret to new instance
		const shrine = new Shrine512('sum sickret, huh')

		//encrypt
		const enStr = await shrine.encrypt('a string')
		const enObj = await shrine.encrypt({ an: 'object' })

		//decrypt
		const deStr = await shrine.decrypt(enStr)
		const deObj = await shrine.decrypt(enObj)

		//assert
		assert(deStr === 'a string')
		assert(str(deObj) === str({ an: 'object' }))

		//console
        log({ enStr, enObj, deStr, deObj })

	} catch (e) { }
})()

/**
 * Console output:
 * ------------------
 * {
 *    enStr: '6abf361826ff8268a0dc60f77b9a8868145441ee921077c00b4 (...)',
 *    enObj: 'f8ab65f0bac60aa070c3649dca602c818fe364a39d0219d8ceb (...)',
 *    deStr: 'a string',
 *    deObj: { an: 'object' }
 * }
 */

Tests

npm run test

Coverage

| File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s | |-----------------------|----------|----------|----------|----------|-------------------| | All files | 100 | 100 | 100 | 100 | | | Shrine512.js | 100 | 100 | 100 | 100 | | | createDecryptor.js | 100 | 100 | 100 | 100 | | | createEncryptor.js | 100 | 100 | 100 | 100 | | | createKeyRetreiver.js | 100 | 100 | 100 | 100 | | | isNonEmpStr.js | 100 | 100 | 100 | 100 | | | isObject.js | 100 | 100 | 100 | 100 | | | isUndefined.js | 100 | 100 | 100 | 100 | | | main.js | 0 | 0 | 0 | 0 | |

PASS tests/shrine-512t.est.js (6.195s)

Test Suites: 1 passed, 1 total
Tests: 27 passed, 27 total
Snapshots: 0 total
Time: 7.155s
Ran all test suites.

Shrine512 works fine

? works with promises (129ms)
? works with random strings of random lengths between 1 and 40 with random encryption keys of random lengths between 1 and 16 (1 (1997ms)
? works with objects containing a string of random length between 1 and 40 with random encryption keys of random lengths betweeneen 1 and 16 (1993ms)
? works with async/await (124ms)
? works with async/await and resolves (125ms)
? throws if undefined to encrypt is provided explicit
? throws if undefined to encrypt is provided (1ms)
? throws if undefined to encrypt is provided
? throws if null to encrypt is provided (63ms)
? throws if undefined to decrypt is provided
? throws if null to decrypt is provided
? does not throw if something to encrypt is provided (62ms)
? does not throw if something to decrypt is provided (62ms)
? decrypts with a different shrine object than it was encrypted with, provided identical secret (126ms)
? throws and does not decrypt with a different secret than was used to encrypt (63ms)
? throws on zero-length secret (3ms)
? throws on null secret
? throws on undefined secret (1ms)
? throws on non- string secret
? throws on zero-length input to encrypt (63ms)
? throws on null input to encrypt
? throws on undefined input to encrypt
? throws on zero-length input to decrypt
? throws on undefined input to decrypt
? throws on zero-length string input to decrypt (1ms)
? throws on non- string input to encrypt (63ms)
? throws on non- string input to encrypt (62ms)

Trivial, but Important Disclaimers and Warnngs About Encryption Security

In too many cases, the cause of data loss is forgetting one's own password/key.
In too many cases, the cause of privacy loss (leaked data or unintended attacker access) is storing one's password/key somewhere that is not secure.
Please do not forget the fact that anyone with the correct encryption key can access any encrypted data as easily as its owner.
Please do remember that short key are far less secure. 16 characters is recommeneded.
It's not important to create an unreadable key, such as this: "js9JkwusS73KSks.__sa7S". It's important that it's 16 characters LONG... AND non-trivial. The point is to make it unguessable by automatic/programmatical means, even if any given person/software has detailed information about you. Hint: It's impossible for anyone/thing to ever obtain certain information, such as someone's daughter's birtdate, so it's best to always use that whenever you can (sarcasm).
Do always stay on top of present time threats that may exist that could comprimise or expoose your encryption key. For instance, watch out for keyloggers. But would you just get a few things in order, and it should, however, be an extremely secure form of achieving data-privacy.

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

BSD-3 License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Source Code

version: 1.0.0
author: Benjamin Moeller Jensen <[email protected]>
license: BSD-3 Clause

createDecryptor

Returns the function that performs decryption.

Parameters

sigrid string The secret phrase
sym object The object used as key in the weakmap. @see createKeyRetreiver

Returns object

createEncryptor

Returns the function that performs the encryption.

Parameters

sigrid string The secret phrase
sym object The object used as key in the weakmap. @see createKeyRetreiver

Returns object

isNonEmpStr

Returns true of val is a string that isnt empty

Parameters

val any

Returns boolean

isObject

Returns true if val is of type object

Parameters

val any

Returns boolean

isUndefined

Returns true if val is undefined or null

Parameters

val any

Returns boolean

Shrine512

The only public export. The constructor takes a secret encryption key and constructs an object from it that has two methods on it that can encrypt and decrypt respective, both strings and objects.

main.js

Module entry point

/**
 * Convenient and very VERY very easy to use 'AES-256-GCM' (SHA-512) encryption/decryption of strings, objects, filecontent, etc.
 * @module Shrine512
 * @version 1.0.0
 * @author Benjamin Moeller Jensen <[email protected]>
 * @license BSD-3 Clause
 */
import Shrine512 from './Shrine512'
export default Shrine512

Shrine512.js

import createDecryptor from './createDecryptor'
import createEncryptor from './createEncryptor'
import isNonEmpStr from './isNonEmpStr'
/**
 * The only public export. The constructor takes a secret encryption key and constructs an object from it that has two methods on it that can encrypt and decrypt respective, both strings and objects.
 * @public
 * @class Shrine512
 */
export default class Shrine512 {
	/**
	 * @constructor
	 * @param {string} sigrid The secret encryption key.
	 */
	constructor (sigrid) {
		if (!isNonEmpStr(sigrid)) throw new TypeError('Expected non-empty string value.')
		const sym = { dam: [this, Symbol(', man')] }

		this.encrypt = createEncryptor(sigrid, sym)
		this.decrypt = createDecryptor(sigrid, sym)

		Object.freeze(this)
	}
}

isUndefined.js

/**
 * Returns true if val is undefined or null
 * @module isUndefined
 * @param {any} val
 * @returns {boolean}
 */
export default function isUndefined (val) {
    return val === undefined || val === null
}

isObject.js

/**
 * Returns true if val is of type object
 * @module isObject
 * @param {any} val
 * @returns {boolean}
 */
export default function isObject (val) {
    return typeof val === 'object'
}

isNonEmpStr.js

/**
 * Returns true of val is a string that isnt empty
 * @module isNonEmpStr
 * @param {any} val
 * @returns {boolean}
 */
export default function isNonEmpStr (val) {
    return typeof val === 'string' && val.length > 0
}

createKeyRetreiver.js

import crypto from 'crypto'
const map = new WeakMap()

/**
 * Creates a function that creates the correct key provided a encryption key and it is also passed a unique symbol along with 'this'-object reference created inside the constructor of the exported class. So only that object will be able to retrieve this key-getter from the weakmap.
 * If the object has been destroyed, a new key retriever can be created by creating a new object witht the class constructor, and it will not be the same key-getter function exactly, but it will decrypt just as well.
 * @private
 * @module createKeyRetreiver
 * @param {string} sigrid
 * @param {Symbol} sym
 */
export default function createKeyRetreiver (sigrid, sym) {
	const getter = salt => crypto.pbkdf2Sync(sigrid, salt, 100000, 32, 'sha512')
	map.set(sym, getter)
	return map.get(sym)
}

createEncryptor.js

import crypto from 'crypto'
import isUndefined from './isUndefined'
import isObject from './isObject'
import isNonEmpStr from './isNonEmpStr'
import createKeyRetreiver from './createKeyRetreiver'

const algorithm = 'aes-256-gcm'
const ivLength = 16
const saltLength = 64

/**
 * Returns the function that performs the encryption.
 * @module createEncryptor
 * @param {string} sigrid The encryption key
 * @param {object} sym The object used as key in the weakmap. @see createKeyRetreiver
 * @returns {object}
 */
export default function createEncryptor (sigrid, sym) {
	const keyGetter = createKeyRetreiver(sigrid, sym)
	return async function encrypt (value) {
        try {
            if (isUndefined(value)) {
                throw new Error('Expected non-empty string value or object.')
            }
			let val
			let isObj = isObject(value)
			if (!isObj) {
				if (!isNonEmpStr(value)) {
					val = { value }
					isObj = true
				} else {
					val = value
				}
			} else {
				val = value
			}
			const iv = crypto.randomBytes(ivLength)
			const salt = crypto.randomBytes(saltLength)
			const key = keyGetter(salt)
			const cipher = crypto.createCipheriv(algorithm, key, iv)
			val = isObj ? JSON.stringify(value) : value
			const encrypted = Buffer.concat([cipher.update(String(val), 'utf8'), cipher.final()])
			const tag = cipher.getAuthTag()
			const ret = Buffer.concat([salt, iv, tag, encrypted]).toString('hex')
			return ret
		} catch (e) {
			return e
		}
	}
}

createDecryptor.js

import crypto from 'crypto'
import isNonEmpStr from './isNonEmpStr'
import createKeyRetreiver from './createKeyRetreiver'

const tagLength = 16
const algorithm = 'aes-256-gcm'
const ivLength = 16
const saltLength = 64
const tagPosition = saltLength + ivLength
const encryptedPosition = tagPosition + tagLength

/**
 * Returns the function that performs decryption.
 * @module createDecryptor
 * @param {string} sigrid The encryption key
 * @param {object} sym The object used as key in the weakmap. @see createKeyRetreiver
 * @returns {object}
 */
export default function createDecryptor (sigrid, sym) {
	const keyGetter = createKeyRetreiver(sigrid, sym)
	return async function decrypt (value) {
		if (!isNonEmpStr(value)) {
			throw new TypeError('Expected non-empty string value.')
		}
		try {
			const stringValue = Buffer.from(String(value), 'hex')
			const salt = stringValue.slice(0, saltLength)
			const iv = stringValue.slice(saltLength, tagPosition)
			const tag = stringValue.slice(tagPosition, encryptedPosition)
			const encrypted = stringValue.slice(encryptedPosition)
			const key = keyGetter(salt)
			const decipher = crypto.createDecipheriv(algorithm, key, iv)
			decipher.setAuthTag(tag)
			let ret = decipher.update(encrypted) + decipher.final('utf8')
			try {
				return JSON.parse(ret)
			} catch (e) {
				return ret
			}
		} catch (e) {
			return e
		}
	}
}

shrine512.test.js

'use strict'
import Shrine512 from '../src/main'
import randomstring from 'randomstring'
import randomNumber from 'math-random'
const make = {
	randomStrings: () => {
		let rndStrings = []
		for (let i = 1; i <= 4; i++) {
			rndStrings.push(randomstring.generate(i * 4))
		}
		return rndStrings
	},
	randomObjects: () => {
		let rndObjects = []
		for (let i = 1; i <= 4; i++) {
			rndObjects.push({ key: randomstring.generate(i * 4) })
		}
		return rndObjects
	},
	shrines: () => {
		let rndSecrets = []
		for (let i = 1; i <= 4; i++) {
			rndSecrets.push(randomstring.generate(1 + randomNumber(i) * i * 4))
		}
		let shrines = []
		for (let secret of rndSecrets) {
			shrines.push({ shrine: new Shrine512(secret), secret: secret })
		}
		return shrines
	},
}
describe(`Shrine512's runnin'-legs are just fine and dandy.`, () => {
	it('works with promises', () => {
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		const str = 'im all stringy'
		shrine.encrypt(str).then(encrypted => {
			shrine.decrypt(encrypted).then(decrypted => {
				expect(decrypted).toEqual(str)
			})
		})
	})
	it('works with random strings of random lengths between 1 and 16 with random encryption keys of random lengths between 1 and 16', () => {
		for (let shrineNSecret of make.shrines()) {
			for (let str of make.randomStrings()) {
				shrineNSecret.shrine.encrypt(str).then(encrypted => {
					shrineNSecret.shrine.decrypt(encrypted).then(decrypted => {
						expect(decrypted).toEqual(str)
					})
				})
			}
		}
	})
	it('works with objects containing a string of random length between 1 and 16 with random encryption keys of random lengths between 1 and 16', () => {
		for (let shrineNSecret of make.shrines()) {
			for (let obj of make.randomObjects()) {
				shrineNSecret.shrine.encrypt(obj).then(encrypted => {
					shrineNSecret.shrine.decrypt(encrypted).then(decrypted => {
						expect(decrypted).toEqual(obj)
					})
				})
			}
		}
	})
	it('works with async/await', async () => {
		expect.assertions(1)
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		const str = 'im all stringy'
		const encrypted = await shrine.encrypt(str)
		const decrypted = await shrine.decrypt(encrypted)
		expect(decrypted).toEqual(str)
	})
	it('works with async/await and resolves', async () => {
		expect.assertions(1)
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		const str = 'im all stringy'
		const encrypted = await shrine.encrypt(str)
		const decrypted = shrine.decrypt(encrypted)
		expect(decrypted).resolves.toEqual(str)
	})
	it('throws if undefined to encrypt is provided explicit', () => {
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		shrine
			.encrypt()
			.then(err =>
				expect(err).toEqual(new Error('Expected non-empty string value or object.')),
			)
	})
	it('throws if undefined to encrypt is provided', () => {
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		shrine
			.encrypt()
			.then(err =>
				expect(err).toThrowError(new Error('Expected non-empty string value or object.')),
			)
	})
	it('throws if undefined to encrypt is provided', () => {
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		shrine.encrypt().then(err => expect(err).toThrow())
	})
	it('throws if null to encrypt is provided', () => {
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		shrine
			.encrypt('')
			.then(err =>
				expect(err).toEqual(new Error('Expected non-empty string value or object.')),
			)
	})
	it('throws if undefined to decrypt is provided', () => {
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		shrine.decrypt().then(err => expect(err).toThrow())
	})
	it('throws if null to decrypt is provided', () => {
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		shrine.decrypt(null).then(err => expect(err).toThrow())
	})
	it('does not throw if something to encrypt is provided', () => {
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		shrine.encrypt('something').then(err => expect(err).not.toThrow())
	})
	it('does not throw if something to decrypt is provided', () => {
		const secret = 'unquestionably unguessable'
		const shrine = new Shrine512(secret)
		shrine.decrypt('something').then(err => expect(err).not.toThrow())
	})
	it('decrypts with a different shrine object than it was encrypted with, provided identical secret', async () => {
		const secret = 'unquestionably unguessable'
		const shrineEnc = new Shrine512(secret)
		const shrineDec = new Shrine512(secret)
		const str = 'im all stringy'
		const encrypted = await shrineEnc.encrypt(str)
		const decrypted = await shrineDec.decrypt(encrypted)
		expect(decrypted).toEqual(str)
	})
	it('throws and does not decrypt with a different secret than was used to encrypt', () => {
		const str = 'im all stringy'
		let shrine = new Shrine512('onehardone')
		shrine.encrypt(str).then(encrypted => {
			new Shrine512('onehardonetwo').shrine2.decrypt(encrypted).then(err => {
				expect(err).toThrowError(
					new Error('Unsupported state or unable to authenticate data'),
				)
			})
		})
	})
	it('throws on zero-length secret', () => {
		const secret = ''
		const test = () => new Shrine512(secret)
		expect(test).toThrowError(new Error('Expected non-empty string value.'))
	})
	it('throws on null secret', () => {
		const secret = null
		const test = () => new Shrine512(secret)
		expect(test).toThrowError(new Error('Expected non-empty string value.'))
	})
	it('throws on undefined secret', () => {
		const secret = undefined
		const test = () => new Shrine512(secret)
		expect(test).toThrowError(new Error('Expected non-empty string value.'))
	})
	it('throws on non- string secret', () => {
		const secret = /asd/
		const test = () => new Shrine512(secret)
		expect(test).toThrowError(new Error('Expected non-empty string value.'))
	})
	it('throws on zero-length input to encrypt', () => {
		const secret = 'not nothing'
		const shrine = new Shrine512(secret)
		const str = ''
		shrine.encrypt(str).then(encrypted => {
			expect(encrypted).toThrowError(new Error('Expected non-empty string value.'))
		})
	})
	it('throws on null input to encrypt', () => {
		const secret = 'not nothing'
		const shrine = new Shrine512(secret)
		const str = null
		shrine.encrypt(str).then(encrypted => {
			expect(encrypted).toThrowError(new Error('Expected non-empty string value.'))
		})
	})
	it('throws on undefined input to encrypt', () => {
		const secret = 'not nothing'
		const shrine = new Shrine512(secret)
		const str = undefined
		shrine.encrypt(str).then(encrypted => {
			expect(encrypted).toThrowError(new Error('Expected non-empty string value.'))
		})
	})
	it('throws on zero-length input to decrypt', () => {
		const secret = 'not nothing'
		const shrine = new Shrine512(secret)
		const encrypted = null
		shrine.decrypt(encrypted).then(decrypted => {
			expect(decrypted).toThrowError(new Error('Expected non-empty string value.'))
		})
	})
	it('throws on undefined input to decrypt', () => {
		const secret = 'not nothing'
		const shrine = new Shrine512(secret)
		const encrypted = undefined
		shrine.decrypt(encrypted).then(decrypted => {
			expect(decrypted).toThrowError(new Error('Expected non-empty string value.'))
		})
	})
	it('throws on zero-length string input to decrypt', () => {
		const secret = 'not nothing'
		const shrine = new Shrine512(secret)
		const encrypted = ''
		shrine.decrypt(encrypted).then(decrypted => {
			expect(decrypted).toThrowError(new Error('Expected non-empty string value.'))
		})
	})
	it('throws on non- string input to encrypt', () => {
		const secret = 'not nothing'
		const shrine = new Shrine512(secret)
		const str = 512
		shrine.encrypt(str).then(encrypted => {
			expect(encrypted).toThrowError(new Error('Expected non-empty string value.'))
		})
	})
	it('throws on non- string input to encrypt', () => {
		const secret = 'not nothing'
		const shrine = new Shrine512(secret)
		const encrypted = /asd/
		shrine.encrypt(encrypted).then(decrypted => {
			expect(decrypted).toThrowError(new Error('Expected non-empty string value.'))
		})
	})
})

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

shrine512

Introduction

Benjamin M�ller Jensen

Why make this?

Features

Table of Contents

Installation

Compatibility

Dependencies

Package

Usage

Import

Require

Example

Tests

Coverage

PASS tests/shrine-512t.est.js (6.195s)

Shrine512 works fine

Trivial, but Important Disclaimers and Warnngs About Encryption Security

Support

Contributing

BSD-3 License

Source Code

Table of Contents

createDecryptor

Parameters

createEncryptor

Parameters

isNonEmpStr

Parameters

isObject

Parameters

isUndefined

Parameters

Shrine512

main.js

Module entry point

Shrine512.js

isUndefined.js

isObject.js

isNonEmpStr.js

createKeyRetreiver.js

createEncryptor.js

createDecryptor.js

shrine512.test.js