@digitalbazaar/ed25519-signature-2018 2.0.0 → 3.0.0

package/README.md

@@ -27,7 +27,13 @@ TBD
 
 ## Install
 
-- Node.js 12+ is required.
+- Browsers and Node.js 14+ are supported.
+
+To install from NPM:
+
+```
+npm install @digitalbazaar/ed25519-signature-2018
+```
 
 To install locally (for development):
 
@@ -37,6 +43,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/lib/index.js

@@ -1,8 +1,7 @@
 /*!
  * Copyright (c) 2020-2021 Digital Bazaar, Inc. All rights reserved.
  */
-'use strict';
+import suiteContext from 'ed25519-signature-2018-context';
 
-// translate `main.js` to CommonJS
-require = require('esm')(module);
-module.exports = require('./main.js');
+export {Ed25519Signature2018} from './Ed25519Signature2018.js';
+export {suiteContext};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalbazaar/ed25519-signature-2018",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Ed25519Signature2018 Linked Data Proof suite for use with jsonld-signatures.",
   "homepage": "https://github.com/digitalbazaar/ed25519-signature-2018",
   "author": {
@@ -17,67 +17,63 @@
     "email": "support@digitalbazaar.com"
   },
   "license": "BSD-3-Clause",
-  "main": "lib/index.js",
+  "type": "module",
+  "exports": "./lib/index.js",
   "files": [
-    "lib/*.js"
+    "lib/**/*.js"
   ],
-  "module": "lib/main.js",
   "dependencies": {
-    "@digitalbazaar/ed25519-verification-key-2018": "^3.1.1",
-    "@digitalbazaar/jws-linked-data-signature": "^1.0.1",
-    "esm": "^3.2.25",
-    "jsonld": "^5.2.0"
+    "@digitalbazaar/ed25519-verification-key-2018": "^4.0.0",
+    "@digitalbazaar/ed25519-verification-key-2020": "^4.0.0",
+    "@digitalbazaar/jws-linked-data-signature": "^2.0.0",
+    "base58-universal": "^2.0.0",
+    "ed25519-signature-2018-context": "^1.1.0",
+    "ed25519-signature-2020-context": "^1.1.0",
+    "jsonld": "^6.0.0"
   },
   "devDependencies": {
-    "@transmute/jsonld-document-loader": "^0.2.0",
-    "chai": "^4.2.0",
-    "cross-env": "^7.0.2",
-    "did-context": "^3.0.0",
-    "ed25519-signature-2018-context": "^1.0.1",
-    "eslint": "^7.6.0",
-    "eslint-config-digitalbazaar": "^2.6.1",
-    "eslint-plugin-jsdoc": "^32.3.0",
-    "jsonld-signatures": "^9.0.2",
-    "karma": "^5.1.1",
+    "c8": "^7.11.3",
+    "chai": "^4.3.6",
+    "credentials-context": "^2.0.0",
+    "cross-env": "^7.0.3",
+    "did-context": "^3.1.1",
+    "eslint": "^8.17.0",
+    "eslint-config-digitalbazaar": "^3.0.0",
+    "eslint-plugin-jsdoc": "^39.3.2",
+    "eslint-plugin-unicorn": "^42.0.0",
+    "jsonld-signatures": "^10.0.0",
+    "karma": "^6.3.20",
     "karma-chai": "^0.1.0",
-    "karma-chrome-launcher": "^3.1.0",
+    "karma-chrome-launcher": "^3.1.1",
     "karma-mocha": "^2.0.1",
     "karma-mocha-reporter": "^2.2.5",
-    "karma-sourcemap-loader": "^0.3.7",
-    "karma-webpack": "^4.0.2",
-    "mocha": "^8.1.1",
+    "karma-sourcemap-loader": "^0.3.8",
+    "karma-webpack": "^5.0.0",
+    "mocha": "^10.0.0",
     "mocha-lcov-reporter": "^1.3.0",
-    "nyc": "^15.1.0",
-    "webpack": "^4.44.1"
+    "webpack": "^5.73.0"
   },
-  "nyc": {
-    "exclude": [
-      "test"
-    ],
+  "c8": {
     "reporter": [
-      "html",
-      "text-summary"
+      "lcov",
+      "text-summary",
+      "text"
     ]
   },
-  "browser": {
-    "buffer": false,
-    "crypto": false,
-    "util": false
-  },
   "engines": {
-    "node": ">=12"
+    "node": ">=14"
   },
   "keywords": [
     "Decentralized",
     "Linked Data"
   ],
   "scripts": {
-    "test": "npm run lint && npm run test-node && npm run test-karma",
-    "test-karma": "karma start karma.conf.js",
-    "test-node": "cross-env NODE_ENV=test mocha -r esm --preserve-symlinks -t 30000 -R ${REPORTER:-spec} test/*.spec.js",
-    "coverage": "cross-env NODE_ENV=test nyc --reporter=lcov --reporter=text-summary npm run test-node",
-    "coverage-ci": "cross-env NODE_ENV=test nyc --reporter=lcovonly npm run test-node",
-    "coverage-report": "nyc report",
+    "test": "npm run test-node",
+    "test-karma": "karma start test/karma.conf.cjs",
+    "test-node": "cross-env NODE_ENV=test mocha --preserve-symlinks -t 30000 -R ${REPORTER:-spec} test/*.spec.js",
+    "coverage": "cross-env NODE_ENV=test c8 npm run test-node",
+    "coverage-ci": "cross-env NODE_ENV=test c8 --reporter=lcovonly --reporter=text-summary --reporter=text npm run test-node",
+    "coverage-report": "c8 report",
     "lint": "eslint ."
   }
 }

package/CHANGELOG.md

@@ -1,19 +0,0 @@
-# @digitalbazaar/ed25519-signature-2018 Changelog
-
-## 2.0.0 - 2021-04-12
-
-### Changed
-- **BREAKING**: Update to `jsonld-signatures` v9 dependency (which removes the
-  `verificationMethod` param from suite constructor. It is now strictly
-  initialized from `key.id` or `signer.id`. Also increases validation on either
-  key or signer/verifier parameters.)
-- Enable this suite to enforce compatible contexts on `sign()`.
-
-### Fixed
-- Add missing `signer` and `verifier` parameters to the `LinkedDataSignature`
-  constructor. This issue caused `this.signer` in subclasses to be `undefined`.
-
-## 1.0.0 - 2021-03-18
-
-### Added
-- Initial files extracted from https://github.com/digitalbazaar/jsonld-signatures.

package/lib/main.js

@@ -1,7 +0,0 @@
-/*!
- * Copyright (c) 2020-2021 Digital Bazaar, Inc. All rights reserved.
- */
-import suiteContext from 'ed25519-signature-2018-context';
-
-export {Ed25519Signature2018} from './Ed25519Signature2018.js';
-export {suiteContext};