hash-base

What is hash-base?

The hash-base package is a Node.js module that provides a base implementation for creating hash functions. It is designed to be extended by other modules to create specific hash function implementations. The package simplifies the process of implementing hash algorithms by handling common tasks such as buffering and streaming data.

What are hash-base's main functionalities?

Streaming data through hash function

This code demonstrates how to extend the HashBase class to create a custom hash function. It involves defining the block size in the constructor, implementing the _update method to update the hash state, and the _digest method to produce the final hash output.

"use strict";
const HashBase = require('hash-base');
class MyHash extends HashBase {
  constructor () {
    super(64); // block size
  }
  _update () {
    // update hash state with this._block
  }
  _digest () {
    // return the final hash
    return Buffer.from([]);
  }
}
const hash = new MyHash();
hash.update('Hello, world!');
console.log(hash.digest('hex'));

Other packages similar to hash-base

crypto

The 'crypto' module is a built-in Node.js module that provides cryptographic functionality. It includes a wide range of cryptographic functions, including hash, HMAC, cipher, decipher, sign, and verify functions. Unlike hash-base, which is designed for creating custom hash functions, 'crypto' provides ready-to-use implementations of various cryptographic algorithms.

sha.js

The 'sha.js' package is a simple module for hashing messages with SHA-1, SHA-224, SHA-256, SHA-384, and SHA-512. It is similar to hash-base in that it focuses on hashing functionalities but differs by providing specific implementations of SHA algorithms rather than a base framework for creating custom hash functions.

md5.js

The 'md5.js' package is a JavaScript function for hashing messages with MD5. It is designed for simplicity and ease of use for MD5 hashing specifically. While hash-base provides a base for creating various hash functions, 'md5.js' is focused solely on MD5 hashing, making it less flexible but easier to use for MD5-specific applications.

README

hash-base

Abstract base class to inherit from if you want to create streams implementing the same API as node crypto Hash (for Cipher / Decipher check crypto-browserify/cipher-base).

Example

const HashBase = require('hash-base')
const inherits = require('inherits')

// our hash function is XOR sum of all bytes
function MyHash () {
  HashBase.call(this, 1) // in bytes

  this._sum = 0x00
}

inherits(MyHash, HashBase)

MyHash.prototype._update = function () {
  for (let i = 0; i < this._block.length; ++i) this._sum ^= this._block[i]
}

MyHash.prototype._digest = function () {
  return this._sum
}

const data = Buffer.from([ 0x00, 0x42, 0x01 ])
const hash = new MyHash().update(data).digest()
console.log(hash) // => 67

You also can check source code or crypto-browserify/md5.js

LICENSE

MIT