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

@namesmt/shash

v0.3.5

Published

SHash is a collection of helpers to implement a hash secret with multiple layers of security

Downloads

287

Readme

shash TypeScript heart icon

npm version npm downloads Codecov Bundlejs jsDocs.io

shash (SHash - Stateful-salt Hash)

SHash is not a cryptographic hashing algorithm, it is a collection of helpers to implement a hash secret system with multiple layers of security.

SHash requires a storage interface to be passed in, which is used to store the stateful salt.

SHash aims to be simple and easy to use, to help you implement a hash secret with multiple layers of security:
SHash stores a stateful salt, which means that there is a layer of database/storage.
SHash allows you to specify your additional salt, which could add two layers: hard-coded salt and environment salt.
The hashed value is calculated as needed with all the salts and is not stored.

SHash supports any hashing algorithm, it is recommended to use SHA256 for the balance of security and performance,
Do note that SHA256 is NOT SAFE for highly sensitive information like passwords, because it is relatively fast and easier for an attacker to crack your passwords in case of a full breach of all layers.

Note: Hashing algorithm is not included in this package, you can use any hashing algorithm you want.

Features

  • [x] TypeScript ready!

Usage

Install package:

# npm
npm install @namesmt/shash

# yarn
yarn add @namesmt/shash

# pnpm (recommended)
pnpm install @namesmt/shash

Import and use:

// ESM
import { SHash } from '@namesmt/shash'

/**
 * This is a simple in-memory storage implementation.
 * 
 * This is not recommended for production use, but it is useful for testing.
 */
class MemoryStorage implements SHashStorageInterface {
  store: Record<string, string> = {}

  async getSalt(partition: string, id: string) { return this.store[`${partition}#${id}`] }
  async setSalt(partition: string, id: string, value: string | undefined) {
    if (value === undefined)
      delete this.store[`${partition}#${id}`]
    else
      this.store[`${partition}#${id}`] = value
  }
}

// A simple hash function for demo purposes
function demoHash(str: string) {
  return `${str}-demohashed`
}

const {
  getHash, // getHash will create a new salt for the partition and id if it does not exist.
  getExistHash, // getExistHash only returns the hash if it the stateful salt exists.
  verifyHash, // verify functions will call get* under-the-hood and then verify it with the given key, throws if it does not match.
  verifyExistHash,
  cleanSalt, // cleanSalt will remove the stateful salt for the partition and id.
} = new SHash(new MemoryStorage(), demoHash) // You could pass in any hashing algorithm

// It is recommended to use a hybrid salt from environment variable and hard-coded like: `salted${env.SECRET_SAUCE}`
const hash = await getHash('salt', 'partition', 'id')

Roadmap

  • [ ] Become the legendary 10000x developer

License License

MIT License © 2024 NamesMT