https://github.com/juanelas/object-sha

A package to perform SHA hash functions over key-value objects that works both in Node.js and native JS. It also can be used with typescript projects. It provides a single method `digest()` that first creates an array of the object values ordered by the object keys (order in JS objects is not guaranteed); then, it JSON.stringify it; and finally it hashes it. The output is a string with the hexadecimal representation of the digest. Internally the hash is computed using node crypto (node.js) or subtle crypto (browsers). In order to guarantee native compatibility with browsers, the supported hash algorithms are SHA-1, SHA-256, SHA-384 and SHA-512.
https://github.com/juanelas/object-sha

hash hashable object sha2

Last synced: 9 days ago
JSON representation

A package to perform SHA hash functions over key-value objects that works both in Node.js and native JS. It also can be used with typescript projects. It provides a single method `digest()` that first creates an array of the object values ordered by the object keys (order in JS objects is not guaranteed); then, it JSON.stringify it; and finally it hashes it. The output is a string with the hexadecimal representation of the digest. Internally the hash is computed using node crypto (node.js) or subtle crypto (browsers). In order to guarantee native compatibility with browsers, the supported hash algorithms are SHA-1, SHA-256, SHA-384 and SHA-512.

• Host: GitHub
• URL: https://github.com/juanelas/object-sha
• Owner: juanelas
• License: mit
• Created: 2020-03-24T22:32:17.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-04-14T12:38:42.000Z (about 2 years ago)
• Last Synced: 2024-10-29T00:14:18.306Z (7 months ago)
• Topics: hash, hashable, object, sha2
• Language: JavaScript
• Size: 352 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![Node.js CI](https://github.com/juanelas/object-sha/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/juanelas/object-sha/actions/workflows/build-and-test.yml)

[![Coverage Status](https://coveralls.io/repos/github/juanelas/object-sha/badge.svg?branch=main)](https://coveralls.io/github/juanelas/object-sha?branch=main)

# object-sha

A package to compute the SHA hash of a JS Object. It works in Node.js and native JS and can be directly imported into TypeScript projects (types provided).

It includes two methods `hashable(obj)` and `digest(obj)` (see [API Ref Doc](#api-reference-documentation) below):

- `hashable(obj)` prepares any object with no known order to be hashable. It recursively traverses the input to find `Object`s. Then every `Object` is converted to an array sorted by key of 2-arrays [key, value]. The final result is JSON.stringify-ed and returned as a string. Since a specific order is now guaranteed, we can safely use the output as the input for any hash algorithm.

- `digest(obj, [algorithm])` performs an SHA-2 hash to the input obj, which is first made hashable with `hashable(obj)`. The output is a string with the hexadecimal representation of the digest. Internally the hash is computed using node crypto (node.js) or subtle crypto (browsers). Supported hash algorithms are `SHA-1`, `SHA-256`, `SHA-384` and `SHA-512`.

## Usage

`object-sha` can be imported to your project with `npm`:

```console

npm install object-sha

```

Then either require (Node.js CJS):

```javascript

const objectSha = require('object-sha')

```

or import (JavaScript ES module):

```javascript

import * as objectSha from 'object-sha'

```

The appropriate version for browser or node is automatically exported.

You can also download the [IIFE bundle](https://raw.githubusercontent.com/juanelas/object-sha/main/dist/bundle.iife.js), the [ESM bundle](https://raw.githubusercontent.com/juanelas/object-sha/main/dist/bundle.esm.min.js) or the [UMD bundle](https://raw.githubusercontent.com/juanelas/object-sha/main/dist/bundle.umd.js) and manually add it to your project, or, if you have already installed `object-sha` in your project, just get the bundles from `node_modules/object-sha/dist/bundles/`.

An example of usage could be:

```typescript

const objectSha = require('object-sha') // or import * as objectSha from 'object-sha'

const obj1 = { src: 'A', dst: 'B', msg: { hello: 'goodbye!', arr: [2, 9, { b: 5, a: 7 }] } }

const obj2 = { dst: 'B', src: 'A', msg: { arr: [2, 9, { a: 7, b: 5 }], hello: 'goodbye!' } }

console.log(objectSha.hashable(obj1)) // [["dst","B"],["msg",[["arr",[2,9,[["a",7],["b",5]]]],["hello","goodbye!"]]],["src","A"]]

console.log(objectSha.hashable(obj2)) // [["dst","B"],["msg",[["arr",[2,9,[["a",7],["b",5]]]],["hello","goodbye!"]]],["src","A"]]

objectSha.digest(obj1).then(console.log) // 6269af73d25f886a50879942cdf5c40500371c6f4d510cec0a67b2992b0a9549

objectSha.digest(obj2).then(console.log) // 6269af73d25f886a50879942cdf5c40500371c6f4d510cec0a67b2992b0a9549

objectSha.digest(obj1, 'SHA-512').then(console.log) // f3325ec4c42cc0154c6a9c78446ce3915196c6ae62d077838b699ca83faa2bd2c0639dd6ca43561afb28bfeb2ffd7481b45c07eaebb7098e1c62ef3c0d441b0b

objectSha.digest(obj2, 'SHA-512').then(console.log) // f3325ec4c42cc0154c6a9c78446ce3915196c6ae62d077838b699ca83faa2bd2c0639dd6ca43561afb28bfeb2ffd7481b45c07eaebb7098e1c62ef3c0d441b0b

```

## API reference documentation

[Check the API](./docs/API.md)