@aws-crypto/sha256-browser

What is @aws-crypto/sha256-browser?

The @aws-crypto/sha256-browser npm package is a JavaScript implementation of the SHA-256 cryptographic hash function specifically optimized for browser environments. It is part of the AWS SDK for JavaScript and is used to generate SHA-256 hashes of data, which is a common requirement for various security-related operations such as data integrity checks, digital signatures, and password hashing.

What are @aws-crypto/sha256-browser's main functionalities?

Generating SHA-256 hash

This feature allows you to generate a SHA-256 hash of the given data. The code sample demonstrates how to import the Sha256 class, create a new instance, update it with data, and then obtain the digest (the hash) as a promise.

import { Sha256 } from '@aws-crypto/sha256-browser';

async function hashData(data) {
  const hash = new Sha256();
  hash.update(data);
  return hash.digest();
}

const data = new Uint8Array([/* data bytes here */]);
hashData(data).then(digest => {
  console.log(digest);
});

Other packages similar to @aws-crypto/sha256-browser

crypto-js

Crypto-js is a popular package that provides a variety of cryptographic algorithms including SHA-256. It is not specific to AWS and can be used in both browser and Node.js environments. Compared to @aws-crypto/sha256-browser, crypto-js offers a broader range of cryptographic functions.

js-sha256

js-sha256 is a simple SHA-256 hash function for JavaScript that supports UTF-8 encoding. It is smaller and may be faster than @aws-crypto/sha256-browser but lacks the AWS SDK integration and optimizations for AWS services.

hash.js

hash.js is a JavaScript hash library that supports several hash functions including SHA-256. It is designed to work in both Node.js and browser environments. While it provides similar functionality to @aws-crypto/sha256-browser, it is not tied to AWS and offers a wider range of hash functions.

README

@aws-crypto/sha256-browser

SHA256 wrapper for browsers that prefers window.crypto.subtle but will fall back to a pure JS implementation in @aws-crypto/sha256-js to provide a consistent interface for SHA256.

Usage

• To hash "some data"

import {Sha256} from '@aws-crypto/sha256-browser'

const hash = new Sha256();
hash.update('some data');
const result = await hash.digest();

• To hmac "some data" with "a key"

import {Sha256} from '@aws-crypto/sha256-browser'

const hash = new Sha256('a key');
hash.update('some data');
const result = await hash.digest();

Test

npm test

Changelog

3.0.0 (2023-01-12)

Bug Fixes

• docs: sha256 packages, clarify hmac support (#455) (1be5043)

• feat!: replace Hash implementations with Checksum interface (#492) (da43dc0), closes #492

BREAKING CHANGES

• All classes that implemented Hash now implement Checksum.