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

@cbcheng/secure-ls

v1.3.3

Published

Secure sessionStorage or localStorage data with high level of encryption and data compression

Downloads

207

Readme

@cbcheng/secure-ls

Secure sessionStorage or localStorage data with high level of encryption and data compression.

This package is adapted from softvar.

Features

  • Secure data with various types of encryption including AES, DES, Rabbit and RC4. (defaults to Base64 encoding).
  • Compress data before storing it to sessionStorage or localStorage to save extra bytes (defaults to true).
  • Advanced API wrapper over sessionStorage or localStorage API, providing other basic utilities.
  • Save data in multiple keys inside sessionStorage or localStorage , and secure-ls will always remember it's creation.

Quickstart

1. Install

$ npm install @cbcheng/secure-ls

2. Import

// ES6 module syntax
> import SecureLS from '@cbcheng/secure-ls';

// CommonJS syntax
> const SecureLS = require('@cbcheng/secure-ls');

Libraries used

  • Encryption / Decryption using The Cipher Algorithms

    It requires secret-key for encrypting and decrypting data securely. If custom secret-key is provided as mentioned below in APIs, then the library will pick that otherwise it will generate yet another very secure unique password key using PBKDF2, which will be further used for future API requests.

    PBKDF2 is a password-based key derivation function. In many applications of cryptography, user security is ultimately dependent on a password, and because a password usually can't be used directly as a cryptographic key, some processing is required.

    A salt provides a large set of keys for any given password, and an iteration count increases the cost of producing keys from a password, thereby also increasing the difficulty of attack.

    Eg: 55e8f5585789191d350329b9ebcf2b11 and db51d35aad96610683d5a40a70b20c39.

    For the generation of such strings, secretPhrase is being used and can be found in code easily but that won't make it unsecure, PBKDF2's layer on top of that will handle security.

  • Compresion / Decompression using lz-string

Usage

  • Example 1: With default settings i.e. Base64 Encoding and Data Compression
> var ls = new SecureLS();
> ls.set('key1', {data: 'test'}); // set key1
> ls.get('key1'); // print data
  {data: 'test'}
  • Example 2: With AES Encryption, sessionStorage and Data Compression
> var ls = new SecureLS({encodingType: 'aes'});
> ls.set('key1', {data: 'test'}); // set key1
> ls.get('key1'); // print data
  {data: 'test'}

> ls.set('key2', [1, 2, 3]); // set another key
> ls.getAllKeys(); // get all keys
  ["key1", "key2"]
> ls.removeAll(); // remove all keys
  • Example 3: With RC4 Encryption but no Data Compression
> var ls = new SecureLS({encodingType: 'rc4', isCompression: false});
> ls.set('key1', {data: 'test'}); // set key1
> ls.get('key1'); // print data
  {data: 'test'}

> ls.set('key2', [1, 2, 3]); // set another key
> ls.getAllKeys(); // get all keys
  ["key1", "key2"]
> ls.removeAll(); // remove all keys
  • Example 3: With DES Encryption, no Data Compression and custom secret key
> var ls = new SecureLS({encodingType: 'des', isCompression: false, encryptionSecret: 'my-secret-key'});
> ls.set('key1', {data: 'test'}); // set key1
> ls.get('key1'); // print data
  {data: 'test'}

> ls.set('key2', [1, 2, 3]); // set another key
> ls.getAllKeys(); // get all keys
  ["key1", "key2"]
> ls.removeAll(); // remove all keys
  • Example 4: set storage with sessionStorage or localStorage.
> var ls = new SecureLS(); // default to use sessionStorage

> var ls = new SecureLS({storageType: 'sessionStorage'});  // use sessionStorage

> var ls = new SecureLS({storageType: 'localStorage'});  // use localStorage

API Documentation

Create an instance / reference before using.

var ls = new SecureLS();

Contructor accepts a configurable Object with all three keys being optional.

| Config Keys | default | accepts | | ------------------------ | -------------- | ----------------------------------------- | | encodingType | Base64 | base64/aes/des/rabbit/rc4/'' | | isCompression | true | true/false | | encryptionSecret | PBKDF2 value | String | | encryptionNamespace | null | String | | storageType | sessionStorage | String sessionStorage/localStorage |

Note: encryptionSecret will only be used for the Encryption and Decryption of data with AES, DES, RC4, RABBIT, and the library will discard it if no encoding / Base64 encoding method is choosen.

encryptionNamespace is used to make multiple instances with different encryptionSecret and/or different encryptionSecret possible.

var ls1 = new SecureLS({encodingType: 'des', encryptionSecret: 'my-secret-key-1'});
var ls2 = new SecureLS({encodingType: 'aes', encryptionSecret: 'my-secret-key-2'});

Examples:

  • No config or empty Object i.e. Default Base64 Encoding and Data compression and sessionStorage
var ls = new SecureLS();
// or
var ls = new SecureLS({});
  • No encoding No data compression i.e. Normal way of storing data
var ls = new SecureLS({encodingType: '', isCompression: false});
  • Base64 encoding but no data compression
var ls = new SecureLS({isCompression: false});
  • AES encryption and data compression
var ls = new SecureLS({encodingType: 'aes'});
  • RC4 encryption and no data compression
var ls = new SecureLS({encodingType: 'rc4', isCompression: false});
  • RABBIT encryption, no data compression and custom encryptionSecret
var ls = new SecureLS({encodingType: 'rc4', isCompression: false, encryptionSecret: 's3cr3tPa$$w0rd@123'});

Methods

  • set

    Saves data in specifed key in localStorage. If the key is not provided, the library will warn. Following types of JavaScript objects are supported:

    • Array
    • ArrayBuffer
    • Blob
    • Float32Array
    • Float64Array
    • Int8Array
    • Int16Array
    • Int32Array
    • Number
    • Object
    • Uint8Array
    • Uint8ClampedArray
    • Uint16Array
    • Uint32Array
    • String

    | Parameter | Description | | ------------- | --------------------------- | | key | key to store data in | | data | data to be stored |

      ls.set('key-name', {test: 'secure-ls'})
  • get

    Gets data back from specified key from the localStorage library. If the key is not provided, the library will warn.

    | Parameter | Description | | ------------- | ----------------------------------- | | key | key in which data is stored |

      ls.get('key-name')
  • remove

    Removes the value of a key from the localStorage. If the meta key, which stores the list of keys, is tried to be removed even if there are other keys which were created by secure-ls library, the library will warn for the action.

    | Parameter | Description | | ------------- | ----------------------------------------- | | key | remove key in which data is stored |

      ls.remove('key-name')
  • removeAll

    Removes all the keys that were created by the secure-ls library, even the meta key.

      ls.removeAll()
  • clear

    Removes all the keys ever created for that particular domain. Remember localStorage works differently for http and https protocol;

      ls.clear()
  • getAllKeys

    Gets the list of keys that were created using the secure-ls library. Helpful when data needs to be retrieved for all the keys or when keys name are not known(dynamically created keys).

    getAllKeys()

      ls.getAllKeys()

Contributing

  1. Fork the repo on GitHub.
  2. Clone the repo on machine.
  3. Execute npm install and npm run dev.
  4. Create a new branch <fix-typo> and do your work.
  5. Run npm run build to build dist files and npm run test to ensure all test cases are passing.
  6. Commit your changes to the branch.
  7. Submit a Pull request.

Development Stack

  • Webpack based src compilation & bundling and dist generation.
  • ES6 as a source of writing code.
  • Exports in a umd format so the library works everywhere.
  • ES6 test setup with Mocha and Chai.
  • Linting with ESLint.

Process

ES6 source files
       |
       |
    webpack
       |
       +--- babel, eslint
       |
  ready to use
     library
  in umd format

Credits

Many thanks to:

Copyright and license

The MIT license (MIT)

Copyright (c) 2022 Zhang Bing Cheng