History

realSnehal 400e0876de frontend		2024-07-16 20:25:36 +05:30
..
lib	frontend	2024-07-16 20:25:36 +05:30
LICENSE	frontend	2024-07-16 20:25:36 +05:30
README.md	frontend	2024-07-16 20:25:36 +05:30
package.json	frontend	2024-07-16 20:25:36 +05:30

README.md

@tufjs/canonical-json

JSON canonicalization compliant with the OLPC Canonical JSON specification.

Why

If you're looking for RFC 8785 compliant JSON canonicalization there are any number of libraries to choose from. You should only select this library if you know that you specifically need support for the OLPC-style of canonicalization.

One reason you might chose OLPC compliance is for interoperability with The Update Framework which specifically calls out OLPC as the canonicalization standard for computing signatures over TUF metadata.

The canonicalized strings generated by this library are compatible with those generated by the Python-based securesystemslib library and the Go-based go-securesystemslib library.

Installation

npm install @tufjs/canonical-json

Usage

const json = require('@tufjs/canonical-json')

const obj = {
  bool: true,
  num: 42,
  ary: [1, 2, 3],
  str: "foo\\bar"
}

console.log(json.canonicalize(obj))
// output: {"ary":[1,2,3],"bool":true,"num":42,"str":"foo\\bar"}