@digitalbazaar/ed25519-signature-2018 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # @digitalbazaar/ed25519-signature-2018 Changelog
 
+## 2.1.0 - 2022-02-15
+
+### Added
+- Add compatability for 2020 keys.
+
 ## 2.0.1 - 2021-04-15
 
 ### Fixed

package/README.md

@@ -37,6 +37,15 @@ cd ed25519-signature-2018
 npm install
 ```
 
+## Tests
+
+```
+npm run test
+```
+
+Note: To run tests for karma, you will need to have Google Chrome installed,
+or otherwise set `CHROME_BIN` environment variable to Chromium. 
+
 ## Usage
 
 TBD

package/lib/Ed25519Signature2018.js

@@ -1,15 +1,24 @@
 /*!
  * Copyright (c) 2020-2021 Digital Bazaar, Inc. All rights reserved.
  */
+import * as base58btc from 'base58-universal';
 import jsonld from 'jsonld';
 import {JwsLinkedDataSignature} from '@digitalbazaar/jws-linked-data-signature';
 import {
   Ed25519VerificationKey2018
 } from '@digitalbazaar/ed25519-verification-key-2018';
+import {
+  Ed25519VerificationKey2020
+} from '@digitalbazaar/ed25519-verification-key-2020';
 
-import suiteContext from 'ed25519-signature-2018-context';
+import ed25519Signature2018SuiteContext from 'ed25519-signature-2018-context';
+import ed25519Signature2020SuiteContext from 'ed25519-signature-2020-context';
 // 'https://w3id.org/security/suites/ed25519-2018/v1'
-const SUITE_CONTEXT_URL = suiteContext.constants.CONTEXT_URL;
+const SUITE_CONTEXT_URL = ed25519Signature2018SuiteContext.constants
+  .CONTEXT_URL;
+// 'https://w3id.org/security/suites/ed25519-2020/v1'
+const SUITE_CONTEXT_URL_2020 =
+  ed25519Signature2020SuiteContext.constants.CONTEXT_URL;
 
 export class Ed25519Signature2018 extends JwsLinkedDataSignature {
   /**
@@ -57,7 +66,8 @@ export class Ed25519Signature2018 extends JwsLinkedDataSignature {
       );
     }
 
-    if(!jsonld.hasValue(verificationMethod, 'type', this.requiredKeyType)) {
+    if(!(_isEd2018Key({verificationMethod}) ||
+      _isEd2020Key({verificationMethod}))) {
       throw new Error(
         `Invalid key type. Key type must be "${this.requiredKeyType}".`);
     }
@@ -68,6 +78,29 @@ export class Ed25519Signature2018 extends JwsLinkedDataSignature {
     }
   }
 
+  async getVerificationMethod({proof, documentLoader}) {
+    const verificationMethod = await super.getVerificationMethod(
+      {proof, documentLoader});
+
+    // convert Ed25519VerificationKey2020 to Ed25519VerificationKey2018
+    if(_isEd2020Key({verificationMethod})) {
+      const key2020 = await Ed25519VerificationKey2020.from(
+        verificationMethod);
+
+      const key2018 = key2020.export({publicKey: true, context: true});
+
+      // remove 2020 public key representation
+      delete key2018.publicKeyMultibase;
+
+      // create 2018 public key representation
+      key2018.publicKeyBase58 = base58btc.encode(key2020._publicKeyBuffer);
+
+      return key2018;
+    }
+
+    return verificationMethod;
+  }
+
   /**
    * Ensures the document to be signed contains the required signature suite
    * specific `@context`, by either adding it (if `addSuiteContext` is true),
@@ -126,6 +159,9 @@ function _includesCompatibleContext({document}) {
   const hasEd2018 = _includesContext({
     document, contextUrl: SUITE_CONTEXT_URL
   });
+  const hasEd2020 = _includesContext({
+    document, contextUrl: SUITE_CONTEXT_URL_2020
+  });
   const hasCred = _includesContext({document, contextUrl: CRED_CONTEXT});
   const hasSecV2 = _includesContext({document, contextUrl: SECURITY_CONTEXT});
 
@@ -148,7 +184,7 @@ function _includesCompatibleContext({document}) {
   }
 
   // Either one by itself is fine, for this suite
-  return hasEd2018 || hasCred || hasSecV2;
+  return hasEd2018 || hasEd2020 || hasCred || hasSecV2;
 }
 
 /**
@@ -167,5 +203,22 @@ function _includesContext({document, contextUrl}) {
     (Array.isArray(context) && context.includes(contextUrl));
 }
 
+function _isEd2018Key({verificationMethod}) {
+  const hasEd2018 = _includesContext({
+    document: verificationMethod, contextUrl: SUITE_CONTEXT_URL
+  });
+  return hasEd2018 && jsonld.hasValue(
+    verificationMethod, 'type', 'Ed25519VerificationKey2018');
+}
+
+function _isEd2020Key({verificationMethod}) {
+  const hasEd2020 = _includesContext({
+    document: verificationMethod, contextUrl: SUITE_CONTEXT_URL_2020
+  });
+  return hasEd2020 && jsonld.hasValue(
+    verificationMethod, 'type', 'Ed25519VerificationKey2020');
+}
+
 Ed25519Signature2018.CONTEXT_URL = SUITE_CONTEXT_URL;
-Ed25519Signature2018.CONTEXT = suiteContext.contexts.get(SUITE_CONTEXT_URL);
+Ed25519Signature2018.CONTEXT = ed25519Signature2018SuiteContext
+  .contexts.get(SUITE_CONTEXT_URL);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalbazaar/ed25519-signature-2018",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Ed25519Signature2018 Linked Data Proof suite for use with jsonld-signatures.",
   "homepage": "https://github.com/digitalbazaar/ed25519-signature-2018",
   "author": {
@@ -24,14 +24,17 @@
   "module": "lib/main.js",
   "dependencies": {
     "@digitalbazaar/ed25519-verification-key-2018": "^3.1.1",
+    "@digitalbazaar/ed25519-verification-key-2020": "^3.2.0",
     "@digitalbazaar/jws-linked-data-signature": "^1.0.1",
+    "base58-universal": "^1.0.0",
     "ed25519-signature-2018-context": "^1.0.1",
+    "ed25519-signature-2020-context": "^1.1.0",
     "esm": "^3.2.25",
     "jsonld": "^5.2.0"
   },
   "devDependencies": {
-    "@transmute/jsonld-document-loader": "^0.2.0",
     "chai": "^4.2.0",
+    "credentials-context": "^2.0.0",
     "cross-env": "^7.0.2",
     "did-context": "^3.0.0",
     "eslint": "^7.6.0",