Create SHA-256 Hash of a File in Node.js
Encryption and hashing have served as the foundation for new security modules, among other network security developments. One of the most used hash algorithms is the Secure Hash Algorithm(SHA) with a digest size of 256 bits, or SHA 256. Although there are numerous variations, SHA 256 has been the most often used in practical applications.
SHA 256 is a part of the SHA 2 family of algorithms, where SHA stands for Secure Hash Algorithm. It was a joint effort between the NSA and NIST to introduce a successor to the weaker SHA 1 family. SHA2 was published in 2001 and has been effective ever since.
The hash function generates the same output hash for the same input string. This means that, you can use this string to validate files or text or anything when you pass it across the network or even otherwise. SHA-256 can act as a stamp or for checking if the data is valid or not.
The 256 in the name SHA-256 refers to the final hash digest value, meaning that regardless of the amount of plaintext or cleartext, the hash value will always be 256 bits.
For example -
Input String | Output Hash |
---|---|
hi | 8f434346648f6b96df89dda901c5176b10a6d83961dd3c1ac88b59b2dc327aa4 |
debugpointer | ce7a00e4bf3e576bceb605c846923a634051ca695ff8a3270af998959e72d265 |
computer science is amazing! I love it. | a3f2b30d5d6ef9006dd09741aa90d595d8a90666f3fc3c3ae4bf1c1e9a8e3042 |
If you want to generate SHA-256 checksum in JavaScript i.e., client side (browser), please follow this article - Create SHA-256 Hash in JavaScript
Node.js crypto
module provides cryptographic functions to help you secure code and data in Node.js. It includes a set of wrappers for OpenSSL’s hash, HMAC, cipher, decipher, sign, and verify functions.
crypto
is built into Node.js, so there is not configuration or custom implementation needed.
For creating SHA-256 hash in nodejs script/code, we shall use the default crypto
module that comes packaged with nodejs.
If you looking to create an MD5 hash of a string, please follow the article where we discuss about this.
Creating SHA-256 Hash of a File
Now let's learn how to create an SHA-256 hash of a file. File can be any file, a text file, a JSON file, data file etc.,
You can either require
the crypto
module-
const crypto = require("crypto");
or also use the modern import
to import the crypto
module-
import { createHash } from "crypto";
Here, let's consider a text file for example - hello.txt
having content - Welcome to Debugpointer.
Let's read the contents of the file using the fs
module and read the file in a synchronous manner.
import { createHash } from "crypto";
const fs = require("fs");
const buff = fs.readFileSync("hello.txt");
const hash = createHash("sha256").update(buff).digest("hex");
console.log(hash);
The output of the above script will be an SHA-256 hash when you run the command node index.js
in your shell-
b8df5aec0d11db76a655eabfc3c6d9734a4715a8de7c85e5649accaf573fe905
Prefer SHA-256 or SHA-512 or other superior cryptographic hash functions for creating a hash for passwords, integrity verification.
It's as simple as that! You do not need any fancy npm library for creating an SHA-256 hash in Node.js.
I'm glad that you found the content useful. Happy Coding.