Add initial statements to sd suite.

w3c · Nov 14, 2024 · fdff03a · fdff03a
1 parent e644d74
commit fdff03a
Showing 1 changed file with 161 additions and 0 deletions.
diff --git a/tests/suites/algorithms-sd.js b/tests/suites/algorithms-sd.js
@@ -0,0 +1,161 @@
+/*!
+ * Copyright 2024 Digital Bazaar, Inc.
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+export function sd2023Algorithms({
+  credential,
+  verifiers,
+  mandatoryPointers,
+  selectivePointers,
+  keyTypes,
+  suiteName,
+  vcVersion,
+  setup = _setup
+}) {
+  return describe(`${suiteName} - Algorithms - VC ${vcVersion}`, function() {
+    this.matrix = true;
+    this.report = true;
+    this.implemented = [];
+    this.rowLabel = 'Test Name';
+    this.columnLabel = 'Implementation';
+    const credentials = new Map(keyTypes.map(kt => [kt, null]));
+    before(async function() {
+      for(const keyType of keyTypes) {
+        credentials.set(keyType, await setup({
+          suiteName,
+          keyType,
+          credential,
+          mandatoryPointers,
+          selectivePointers
+        }));
+      }
+    });
+    for(const [name, {endpoints}] of verifiers) {
+      const [verifier] = endpoints;
+      for(const keyType of keyTypes) {
+        this.implemented.push(`${name}: ${keyType}`);
+        describe(`${name}: ${keyType}`, function() {
+          beforeEach(function() {
+            this.currentTest.cell = {
+              rowId: this.currentTest.title,
+              columnId: this.currentTest.parent.title
+            };
+          });
+          it('If source has an id that is not a blank node identifier, set ' +
+          'selection.id to its value. Note: All non-blank node identifiers ' +
+          'in the path of any JSON Pointer MUST be included in the ' +
+          'selection, this includes any root document identifier.',
+          async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#jsonpointertopaths:~:text=If%20source%20has%20an%20id%20that%20is%20not%20a%20blank%20node%20identifier%2C%20set%20selection.id%20to%20its%20value.%20Note%3A%20All%20non%2Dblank%20node%20identifiers%20in%20the%20path%20of%20any%20JSON%20Pointer%20MUST%20be%20included%20in%20the%20selection%2C%20this%20includes%20any%20root%20document%20identifier.';
+          });
+          it('If source.type is set, set selection.type to its value. ' +
+          'Note: The selection MUST include all types in the path of any ' +
+          'JSON Pointer, including any root document type.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=If%20source.type%20is%20set%2C%20set%20selection.type%20to%20its%20value.%20Note%3A%20The%20selection%20MUST%20include%20all%20types%20in%20the%20path%20of%20any%20JSON%20Pointer%2C%20including%20any%20root%20document%20type.';
+          });
+          it('Set value to parentValue.path. If value is now undefined, an ' +
+          'error MUST be raised and SHOULD convey an error type of ' +
+          'PROOF_GENERATION_ERROR, indicating that the JSON pointer does ' +
+          'not match the given document.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=Set%20value%20to%20parentValue.path.%20If%20value%20is%20now%20undefined%2C%20an%20error%20MUST%20be%20raised%20and%20SHOULD%20convey%20an%20error%20type%20of%20PROOF_GENERATION_ERROR%2C%20indicating%20that%20the%20JSON%20pointer%20does%20not%20match%20the%20given%20document.';
+          });
+          it('CBOR-encode components per [RFC8949] where CBOR tagging MUST ' +
+          'NOT be used on any of the components. Append the produced encoded ' +
+          'value to proofValue.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=and%20mandatoryPointers.-,CBOR%2Dencode%20components%20per%20%5BRFC8949%5D%20where%20CBOR%20tagging%20MUST,-NOT%20be%20used';
+          });
+          it('If the proofValue string does not start with u, indicating ' +
+          'that it is a multibase-base64url-no-pad-encoded value, an error ' +
+          'MUST be raised and SHOULD convey an error type of ' +
+          'PROOF_VERIFICATION_ERROR.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=produced%20as%20output.-,If%20the%20proofValue%20string%20does%20not%20start%20with%20u%2C%20indicating%20that%20it%20is%20a%20multibase%2Dbase64url%2Dno%2Dpad%2Dencoded%20value%2C%20an%20error%20MUST%20be%20raised%20and%20SHOULD%20convey%20an%20error%20type%20of%20PROOF_VERIFICATION_ERROR.,-Initialize%20decodedProofValue%20to';
+          });
+          it('If the decodedProofValue does not start with the ECDSA-SD ' +
+          'base proof header bytes 0xd9, 0x5d, and 0x00, an error MUST be ' +
+          'raised and SHOULD convey an error type of PROOF_VERIFICATION_ERROR.',
+          async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=If%20the%20decodedProofValue%20does%20not%20start%20with%20the%20ECDSA%2DSD%20base%20proof%20header%20bytes%200xd9%2C%200x5d%2C%20and%200x00%2C%20an%20error%20MUST%20be%20raised%20and%20SHOULD%20convey%20an%20error%20type%20of%20PROOF_VERIFICATION_ERROR.';
+          });
+          it('CBOR-encode components per [RFC8949] where CBOR tagging MUST ' +
+          'NOT be used on any of the components. Append the produced ' +
+          'encoded value to proofValue.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=and%20mandatoryIndexes.-,CBOR%2Dencode%20components%20per%20%5BRFC8949%5D%20where%20CBOR%20tagging%20MUST%20NOT%20be%20used%20on%20any%20of%20the%20components.%20Append%20the%20produced%20encoded%20value%20to%20proofValue.,-Return%20the%20derived';
+          });
+          it('If the proofValue string does not start with u, indicating ' +
+          'that it is a multibase-base64url-no-pad-encoded value, an error ' +
+          'MUST be raised and SHOULD convey an error type of ' +
+          'PROOF_VERIFICATION_ERROR.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=labelMap%22%2C%20and%20%22mandatoryIndexes%22.-,If%20the%20proofValue%20string%20does%20not%20start%20with%20u%2C%20indicating%20that%20it%20is%20a%20multibase%2Dbase64url%2Dno%2Dpad%2Dencoded%20value%2C%20an%20error%20MUST%20be%20raised%20and%20SHOULD%20convey%20an%20error%20type%20of%20PROOF_VERIFICATION_ERROR.,-Initialize%20decodedProofValue%20to';
+          });
+          it('If the decodedProofValue does not start with the ECDSA-SD ' +
+          'disclosure proof header bytes 0xd9, 0x5d, and 0x01, an error ' +
+          'MUST be raised and SHOULD convey an error type of ' +
+          'PROOF_VERIFICATION_ERROR.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=If%20the%20decodedProofValue%20does%20not%20start%20with%20the%20ECDSA%2DSD%20disclosure%20proof%20header%20bytes%200xd9%2C%200x5d%2C%20and%200x01%2C%20an%20error%20MUST%20be%20raised%20and%20SHOULD%20convey%20an%20error%20type%20of%20PROOF_VERIFICATION_ERROR.';
+          });
+          it('If the result is not an array of the following five elements ' +
+          '— a byte array of length 64; a byte array of length 36; an array ' +
+          'of byte arrays, each of length 64; a map of integers to byte ' +
+          'arrays, each of length 32; and an array of integers — an error ' +
+          'MUST be raised and SHOULD convey an error type of ' +
+          'PROOF_VERIFICATION_ERROR.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=array%20of%20integers%20%E2%80%94-,an%20error%20MUST%20be%20raised%20and%20SHOULD%20convey%20an%20error%20type%20of%20PROOF_VERIFICATION_ERROR.,-Replace%20the%20fourth';
+          });
+          it('The transformation options MUST contain a type identifier for ' +
+          'the cryptographic suite (type), a cryptosuite identifier ' +
+          '(cryptosuite), and a verification method (verificationMethod).',
+          async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=The%20transformation%20options%20MUST%20contain%20a%20type%20identifier%20for%20the%20cryptographic%20suite%20(type)%2C%20a%20cryptosuite%20identifier%20(cryptosuite)%2C%20and%20a%20verification%20method%20(verificationMethod).';
+          });
+          it('The transformation options MUST contain an array of mandatory ' +
+          'JSON pointers (mandatoryPointers) and MAY contain additional ' +
+          'options, such as a JSON-LD document loader.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=The%20transformation%20options%20MUST%20contain%20an%20array%20of%20mandatory%20JSON%20pointers%20(mandatoryPointers)%20and%20MAY%20contain%20additional%20options%2C%20such%20as%20a%20JSON%2DLD%20document%20loader.';
+          });
+          it('Whenever this algorithm encodes strings, it MUST use UTF-8 ' +
+          'encoding.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=produced%20as%20output.-,Whenever%20this%20algorithm%20encodes%20strings%2C%20it%20MUST%20use%20UTF%2D8%20encoding.,-Initialize%20hmac%20to';
+          });
+          it('Per the recommendations of [RFC2104], the HMAC key MUST be the ' +
+          'same length as the digest size; for SHA-256, this is 256 bits or ' +
+          '32 bytes.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#selective-disclosure-functions:~:text=Per%20the%20recommendations%20of%20%5BRFC2104%5D%2C%20the%20HMAC%20key%20MUST%20be%20the%20same%20length%20as%20the%20digest%20size%3B%20for%20SHA%2D256%2C%20this%20is%20256%20bits%20or%2032%20bytes.';
+          });
+          it('The proof options MUST contain a type identifier for the ' +
+          'cryptographic suite (type) and MUST contain a cryptosuite ' +
+          'identifier (cryptosuite).', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#base-proof-configuration-ecdsa-sd-2023';
+          });
+          it('If proofConfig.type is not set to DataIntegrityProof and/or ' +
+          'proofConfig.cryptosuite is not set to ecdsa-sd-2023, an error ' +
+          'MUST be raised and SHOULD convey an error type of ' +
+          'PROOF_GENERATION_ERROR.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#base-proof-configuration-ecdsa-sd-2023:~:text=If%20proofConfig.type%20is%20not%20set%20to%20DataIntegrityProof%20and/or%20proofConfig.cryptosuite%20is%20not%20set%20to%20ecdsa%2Dsd%2D2023%2C%20an%20error%20MUST%20be%20raised%20and%20SHOULD%20convey%20an%20error%20type%20of%20PROOF_GENERATION_ERROR.';
+          });
+          it('If proofConfig.created is set and if the value is not a valid ' +
+          '[XMLSCHEMA11-2] datetime, an error MUST be raised and SHOULD ' +
+          'convey an error type of PROOF_GENERATION_ERROR.', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#base-proof-configuration-ecdsa-sd-2023';
+          });
+          it('The proof options MUST contain a type identifier for the ' +
+          'cryptographic suite (type) and MAY contain a cryptosuite ' +
+          'identifier (cryptosuite).', async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#base-proof-serialization-ecdsa-sd-2023';
+          });
+          it('If the length of signatures does not match the length of ' +
+          'nonMandatory, an error MUST be raised and SHOULD convey an ' +
+          'error type of PROOF_VERIFICATION_ERROR, indicating that the ' +
+          'signature count does not match the non-mandatory message count.',
+          async function() {
+            this.test.link = 'https://w3c.github.io/vc-di-ecdsa/#base-proof-serialization-ecdsa-sd-2023:~:text=If%20the%20length%20of%20signatures%20does%20not%20match%20the%20length%20of%20nonMandatory%2C%20an%20error%20MUST%20be%20raised%20and%20SHOULD%20convey%20an%20error%20type%20of%20PROOF_VERIFICATION_ERROR%2C%20indicating%20that%20the%20signature%20count%20does%20not%20match%20the%20non%2Dmandatory%20message%20count.';
+          });
+        });
+      }
+    }
+  });
+}
+
+function _setup() {
+
+}