sha.js

What is sha.js?

The sha.js npm package is a module that provides cryptographic hash functions, specifically SHA (Secure Hash Algorithm) family functions. It allows for the generation of hash values from input data, which is a common requirement in various security contexts, such as password hashing, data integrity checks, and digital signatures.

What are sha.js's main functionalities?

SHA-256 Hash Generation

This feature allows for the generation of SHA-256 hash values from input strings. The code sample demonstrates how to create a SHA-256 hash of the string 'hello world' and output it in hexadecimal format.

"use strict";\nconst sha256 = require('sha.js').sha256;\nconst hash = new sha256().update('hello world').digest('hex');\nconsole.log(hash);

SHA-512 Hash Generation

This feature enables the creation of SHA-512 hash values. The provided code sample shows how to generate a SHA-512 hash for the input 'hello world' and print the result in hex format.

"use strict";\nconst sha512 = require('sha.js').sha512;\nconst hash = new sha512().update('hello world').digest('hex');\nconsole.log(hash);

Other packages similar to sha.js

crypto-js

Crypto-js is a package that offers a variety of cryptographic algorithms, including SHA-1, SHA-256, and SHA-512, similar to sha.js. However, it also provides many other algorithms like AES and Rabbit, making it more versatile for different cryptographic needs.

node-forge

Node-forge is a comprehensive Node.js module that includes not only SHA hash functions but also other cryptographic tools like encryption, decryption, and digital signatures. It's more complex and feature-rich compared to sha.js, which focuses mainly on SHA hash functions.

README

sha.js

Node style SHA on pure JavaScript.

var shajs = require('sha.js')

console.log(shajs('sha256').update('42').digest('hex'))
// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049
console.log(new shajs.sha256().update('42').digest('hex'))
// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049

var sha256stream = shajs('sha256')
sha256stream.end('42')
console.log(sha256stream.read().toString('hex'))
// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049

supported hashes

sha.js currently implements:

• SHA (SHA-0) -- legacy, do not use in new systems
• SHA-1 -- legacy, do not use in new systems
• SHA-224
• SHA-256
• SHA-384
• SHA-512

Not an actual stream

Note, this doesn't actually implement a stream, but wrapping this in a stream is trivial. It does update incrementally, so you can hash things larger than RAM, as it uses a constant amount of memory (except when using base64 or utf8 encoding, see code comments).

Acknowledgements

This work is derived from Paul Johnston's A JavaScript implementation of the Secure Hash Algorithm.

LICENSE MIT