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

@tsmx/string-crypto

v1.0.6

Published

Encrypt and decrypt strings.

Downloads

3,516

Readme

@tsmx/string-crypto

License: MIT npm (scoped) node-current (scoped) Build Status Coverage Status

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',
    passNull: false
};
options.key

Type: String Default: null

The key used for encryption. If not present, the key is retrieved from the environment variable ENCRYPTION_KEY.

options.passNull

Type: Boolean Default: false

Sometimes it is helpful to let a value of null pass the encryption though null can't be encrypted either. If set to true the decrypt function will return null if value is null. Defaults to false, then an exception is thrown if the passed value is null.

sc.encrypt(null); // throwing Error
sc.encrypt(null,  { passNull: true }); // null

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',
    passNull: false
};
options.key

Type: String Default: null

The key used for decryption. If not present, the key is retrieved from the environment variable ENCRYPTION_KEY.

options.passNull

Type: Boolean Default: false

Sometimes it is helpful to let a value of null pass the decryption though null can't be decrypted either. If set to true the decrypt function will return null if value is null. Defaults to false, then an exception is thrown if the passed value is null.

sc.decrypt(null); // throwing Error
sc.decrypt(null,  { passNull: true }); // null

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 '|'