Stable, cross-platform JSON serialization and hashing for Python and JavaScript.
To make it possible to compare and hash JSON objects in a stable way across platforms.
pip install crosshash
npm install crosshashThe following functions are implemented in both Python and JavaScript and the output is guaranteed to be the same:
- Sort keys alphabetically
- Ensure no unsafe numbers are present
- Serialize using the same format as
JSON.stringify()(lowest common denominator)
- Serialize the object with
crossjson() - Hash the resulting string with MD5
Both Python and JavaScript implementations come with a CLI that can be used to generate stable JSON and hashes.
JSON='{"B":2,"C":[1,2,3],"A":1}'
[ $(crosshash-js --hash "$JSON") == $(crosshash-py --hash "$JSON") ] && echo 'It’s a match!'
[ $(crosshash-js --json "$JSON") == $(crosshash-py --json "$JSON") ] && echo 'It’s a match!'from crosshash import crossjson, crosshash, CrossHashError, MAX_SAFE_INTEGER
obj = {'B': 2, 'C': [1, 2, 3], 'A': 1}
# Generate stable JSON:
assert crossjson(obj) == '{"A":1,"B":2,"C":[1,2,3]}'
# Generate stable hash:
assert crosshash(obj) == '12982c60a9a8829ea4eeb2e1e7e1e04e'
# Throws `CrossHashError`:
crosshash({'A': MAX_SAFE_INTEGER + 1}) You can invoke crosshash.py directly or use python -m crosshash. The package also installs an executable called crosshash-py.
$ crosshash-py --json '{"B": 2, "C": [1, 2, 3], "A": 1}'
{"A":1,"B":2,"C":[1,2,3]}$ crosshash-py --hash '{"B": 2, "C": [1, 2, 3], "A": 1}'
12982c60a9a8829ea4eeb2e1e7e1e04eThe library runs in the browser and Node.js and comes with TypeScript definitions.
const {crossjson, crosshash, CrossHashError} = require('crosshash')
const obj = {B: 2, C: [1, 2, 3], A: 1}
// Generate stable JSON:
assert(crossjson(obj) === '{"A":1,"B":2,"C":[1,2,3]}')
// Generate stable hash:
assert(crosshash(obj) === '12982c60a9a8829ea4eeb2e1e7e1e04e')
// Throws `CrossHashError`:
crosshash({A: Number.MAX_SAFE_INTEGER + 1}) You can invoke crosshash.js directly or using npx. The package also installs an executable called crosshash-js.
$ crosshash-js --json '{"B": 2, "C": [1, 2, 3], "A": 1}'
{"A":1,"B":2,"C":[1,2,3]}$ crosshash-js --hash '{"B": 2, "C": [1, 2, 3], "A": 1}'
12982c60a9a8829ea4eeb2e1e7e1e04eThe Python/JavaScript libraries with matching versions are guaranteed to produce the same output. The format is unlikely to change but it’s not guaranteed to be stable across different versions. Therefore, it’s not recommended to cache the output. This may change as the library matures to v1.0.
To ensure consistency, the test suite invokes the Python and JavaScript implementations of crossjson() and crosshash() on the same data and compares the results.
It should be fairly straightforward to add support for other languages.
git clone [email protected]:httpie/crosshash.git
cd ./crosshash
make install
make test