File: README.md

package info (click to toggle)
golang-webpki-org-jsoncanonicalizer 1.0.1-3
  • links: PTS, VCS
  • area: main
  • in suites: experimental, forky, sid, trixie
  • size: 296 kB
  • sloc: makefile: 2
file content (34 lines) | stat: -rw-r--r-- 961 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
## JSON Canonicalizer for Go

The [jsoncanonicalizer](src/webpki.org/jsoncanonicalizer)
folder contains the source code for a 
JCS (RFC 8785) compliant JSON canonicalizer written in Go.

### Building and testing

- Set GOPATH to this directory.

- For running `verify-numbers.go` you need to download a 3Gb+ file with test
data described in the root directory [testdata](../testdata).  This file can be stored in
any directory and requires updating the file path in `verify-numbers.go`.

- Perform the commands:
```code
$ cd test
$ go build webpki.org/jsoncanonicalizer
$ go run verify-canonicalization.go
$ go run verify-numbers.go
```


### Using the JSON canonicalizer

```go
import "webpki.org/jsoncanonicalizer"

func Transform(jsonData []byte) (result []byte, e error)
```
Note that both the input and the result is assumed to be in UTF-8 format.

### Constraints
The JSON canonicalizer only accepts a JSON _Object_ or _Array_ as the top level data type.