use @tufjs/canonical-json in @tufjs/models (#279)

Signed-off-by: Brian DeHamer <bdehamer@github.com>
theupdateframework · Apr 11, 2023 · 4e4f6e9 · 4e4f6e9
1 parent 39befcd
commit 4e4f6e9
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 74 deletions.
diff --git a/.changeset/yellow-wasps-check.md b/.changeset/yellow-wasps-check.md
@@ -0,0 +1,5 @@
+---
+'@tufjs/models': patch
+---
+
+Integrate @tufjs/canonical-json library
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/models/package.json b/packages/models/package.json
@@ -33,7 +33,8 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
-    "minimatch": "^8.0.3"
+    "minimatch": "^8.0.3",
+    "@tufjs/canonical-json": "1.0.0"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0"

diff --git a/packages/models/src/__tests__/utils/json.test.ts b/packages/models/src/__tests__/utils/json.test.ts
diff --git a/packages/models/src/metadata.ts b/packages/models/src/metadata.ts
@@ -1,3 +1,4 @@
+import { canonicalize } from '@tufjs/canonical-json';
 import util from 'util';
 import { MetadataKind, Signable } from './base';
 import { UnsignedMetadataError, ValueError } from './error';
@@ -8,8 +9,7 @@ import { Signature } from './signature';
 import { Snapshot } from './snapshot';
 import { Targets } from './targets';
 import { Timestamp } from './timestamp';
-import { guard, JSONObject, JSONValue } from './utils';
-import { canonicalize } from './utils/json';
+import { JSONObject, JSONValue, guard } from './utils';
 
 type MetadataType = Root | Timestamp | Snapshot | Targets;
 
@@ -53,7 +53,7 @@ export class Metadata<T extends MetadataType> implements Signable {
   }
 
   public sign(signer: (data: Buffer) => Signature, append = true): void {
-    const bytes = canonicalize(this.signed.toJSON());
+    const bytes = Buffer.from(canonicalize(this.signed.toJSON()));
     const signature = signer(bytes);
 
     if (!append) {

diff --git a/packages/models/src/utils/json.ts b/packages/models/src/utils/json.ts
diff --git a/packages/models/src/utils/verify.ts b/packages/models/src/utils/verify.ts
@@ -1,13 +1,13 @@
+import { canonicalize } from '@tufjs/canonical-json';
 import crypto from 'crypto';
 import { JSONObject } from '../utils/types';
-import { canonicalize } from './json';
 
 export const verifySignature = (
   metaDataSignedData: JSONObject,
   key: crypto.VerifyKeyObjectInput,
   signature: string
 ): boolean => {
-  const canonicalData = canonicalize(metaDataSignedData) || '';
+  const canonicalData = Buffer.from(canonicalize(metaDataSignedData));
 
   return crypto.verify(
     undefined,