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

shield-crypt

v1.1.2

Published

Simple encryption and decryption library using crypto

Downloads

5

Readme

ShieldCrypt

ShieldCrypt is a npm package for encryption and decryption using the Node.js built-in crypto library.

Installation

To install ShieldCrypt, use npm:

npm install shield-crypt

Usage

Importing ShieldCrypt

First, you need to import the ShieldCrypt module:

const ShieldCrypt = require('shield-crypt');

Creating an instance

You can create a new instance of ShieldCrypt by providing an optional configuration object. If no configuration is provided, it will generate a random key and IV for you.

// Without configuration
const shieldCryptInstance = new ShieldCrypt();

// With custom configuration
const shieldCryptInstance = new ShieldCrypt({
    algorithm: 'aes-256-cbc', // Optional: encryption algorithm, default is aes-256-ctr
    key: 'mySecretKey', // Optional: encryption key
    iv: 'myInitializationVector' // Optional: initialization vector
});

You can generate a key and iv and store it in a config or .env file.

const ShieldCrypt = require('shield-crypt');

const { key, iv } = ShieldCrypt.generateKeyIv(true); // Pass true if require hexadecimal values

console.log(key); 
// 35a1896c975f5572f6a3afd7d992fea6c9f3812a488a98ce9930ea0b7bca5e66

console.log(iv); 
// af78d78b5d3bcbe4b1497b84fa8a4b27

// Pass the generated key and iv to the constructor
const shieldCryptInstance = new ShieldCrypt({
    key,
    iv
});

Encrypting Data

To encrypt data, call the encrypt method on the ShieldCrypt instance. You can provide a callback function to handle the encrypted data asynchronously.

const data = 'Hello, world!';
const encryptedData = shieldCryptInstance.encrypt(data);
console.log(encryptedData);
// Output: Encrypted data in hexadecimal format

Decrypting Data

To decrypt previously encrypted data, call the decrypt method on the ShieldCrypt instance. You can provide a callback function to handle the decrypted data asynchronously.

const encryptedData = '...'; // Encrypted data obtained from previous encryption
const decryptedData = shieldCryptInstance.decrypt(encryptedData);
console.log(decryptedData.toString());
// Output: Decrypted data as a string