npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

encrypt-at-rest

v1.0.0

Published

Simple, secure encryption-at-rest for Node with AES 256 GCM

Downloads

10

Readme

encrypt-at-rest

Simple, secure, forward-proof encryption at rest for Node using AES 256 GCM, with support for multiple master encryption keys.

let encrypted = encrypt("something"); // returns base64 string
decrypt(encrypted); // "something"

Approach

  • Secure: Uses AES 256 GCM (Galois Counter Mode) algorithm for encryption, an authenticated encryption mechanism, with a unique initialization vector (IV) for each encrypted value.

  • Forward-proof: Each encrypted value contains all information needed to decrypt the value. The encryption key id, algorithm, IV, and authentication tag are all stored along with the encrypted value, so that decrypt() is able to work with multiple encryption keys.

  • Simple: Both encrypt() / decrypt() only take one argument, making the library extremely simple to use.

Installation

npm i encrypt-at-rest --save

Usage

This master key will need to be populated on application startup using setEncryptionKey(base64EncodedMasterKey). The master key must be 32 bytes in length.

Create a master encryption key

npm run generate-encryption-key

{"id":"ee518f7a-d297-4130-9b71-c1b36e6de793","value":"poKsapwI6vBAA+gQdFrxbOauEL6yxYXjCmUPxtxdQ6k="}

Load a key into memory on application startup

const {
	loadKey,
} = require("encrypt-at-rest");

// example: the serialized encryption key is loaded via an environment variable
loadKey(process.env.MASTER_ENCRYPTION_KEY);

Use the key to encrypt/decrypt values

const {
	decrypt,
	encrypt,
} = require("encrypt-at-rest");
const {
	strictEqual,
} = require("assert");

// Encrypt a value, e.g. before storing in database
const inputValue = "some valuable piece of information";
const encryptedValue = encrypt(inputValue);

// Decrypt a value, e.g. when pulling out of database
strictEqual(inputValue, decrypt(encryptedValue));

Load multiple keys

const {
	createKey,
	loadKey,
} = require("encrypt-at-rest");

// Encryption keys should be stored in and retrieved from a secure environment, e.g. AWS KMS,
// and loaded at runtime into the app.
let allKeys = await keysTable.fetchAll();
allKeys.forEach(keyRow => {
	const key = loadKey(createKey(keyRow.get("id"), keyRow.get("value"));
	if (keyRow.get("is_current")) {
		key.markCurrent();
	}
});

Contributing

This repo intentionally has no dependencies to keep it as lightweight as possible, including dev dependencies.

Lint: npm i eslint -g && npm run lint

Test: npm test. Tests are written using native node assertions.