Skip to content

Commit

Permalink
Update issuer tests to run all implementations with ecdsa-rdfc-2019
Browse files Browse the repository at this point in the history 
tag and include key type in the names.
  • Loading branch information
@JSAssassin
JSAssassin committed Nov 17, 2023
1 parent a89165d commit 5deb1ba
Show file tree
Hide file tree
Showing 5 changed files with 130 additions and 100 deletions.
12 changes: 8 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@ to your implementation manifest.
- A credential issuer endpoint (/credentials/issue) in the `issuers` property.
- A credential verifier endpoint (/credentials/verify) in the `verifiers` property.

All endpoints will need one of the following cryptosuite tags `ecdsa-rdfc-2019`,
`ecdsa-jcs-2019` and/or `ecdsa-sd-2023` along with the keyType `P-256` or `P-384`
the implementation supports.
All endpoints will require one of the following cryptosuite tags `ecdsa-rdfc-2019`,
`ecdsa-jcs-2019`, and/or `ecdsa-sd-2023` specified along with
the keyType `P-256` or `P-384` the implementation supports.

NOTE: The tests for `ecdsa-jcs-2019` are TBA.

A simplified manifest would look like this:

Expand Down Expand Up @@ -71,7 +73,9 @@ A simplified manifest would look like this:
"id": "",
"endpoint": "https://mycompany.example/credentials/verify",
"method": "POST",
"tags": ["ecdsa-rdfc-2019", "ecdsa-jcs-2019", "ecdsa-sd-2023"]
"tags": [
"ecdsa-rdfc-2019", "ecdsa-jcs-2019", "ecdsa-sd-2023"
]
}]
}
```
Expand Down
204 changes: 110 additions & 94 deletions tests/10-rdfc-create.js
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
/*!
* Copyright 2023 Digital Bazaar, Inc. All Rights Reserved
*/
import {createInitialVc, getKeyType} from './helpers.js';
import {
shouldBeBs58, shouldBeMulticodecEncoded, verificationSuccess
} from './assertions.js';
import chai from 'chai';
import {
checkDataIntegrityProofFormat
} from 'data-integrity-test-suite-assertion';
import {createInitialVc} from './helpers.js';
import {documentLoader} from './documentLoader.js';
import {endpoints} from 'vc-test-suite-implementations';
import {validVc as vc} from './validVc.js';
Expand All @@ -31,103 +31,119 @@ describe('ecdsa-rdfc-2019 (create)', function() {
this.rowLabel = 'Test Name';
this.columnLabel = 'Implementation';
for(const [name, {endpoints, implementation}] of match) {
describe(name, function() {
const [issuer] = endpoints;
const verifier = implementation.verifiers.find(
v => v.tags.has(tag));
let issuedVc;
let proofs;
const verificationMethodDocuments = [];
before(async function() {
issuedVc = await createInitialVc({issuer, vc});
proofs = Array.isArray(issuedVc?.proof) ? issuedVc.proof :
[issuedVc?.proof];
const verificationMethods = proofs.map(
proof => proof.verificationMethod);
for(const verificationMethod of verificationMethods) {
const verificationMethodDocument = await documentLoader({
url: verificationMethod
});
verificationMethodDocuments.push(verificationMethodDocument);
}
});
it('The field "cryptosuite" MUST be "ecdsa-rdfc-2019", ' +
'"ecdsa-jcs-2019" or "ecdsa-sd-2023".', function() {
this.test.cell = {columnId: name, rowId: this.test.title};
const cryptosuite = [
'ecdsa-rdfc-2019', 'ecdsa-jcs-2019', 'ecdsa-sd-2023'
];
proofs.some(
proof => cryptosuite.includes(proof?.cryptosuite)
).should.equal(true, 'Expected at least one proof to have ' +
'"cryptosuite" property "ecdsa-rdfc-2019", "ecdsa-jcs-2019" ' +
'or "ecdsa-sd-2023".'
);
});
it('The "proof" MUST verify when using a conformant verifier.',
async function() {
this.test.cell = {columnId: name, rowId: this.test.title};
should.exist(verifier, 'Expected implementation to have a VC ' +
'HTTP API compatible verifier.');
verificationSuccess({credential: issuedVc, verifier});
for(const endpoint of endpoints) {
const tags = endpoint.settings.tags;
const keyType = getKeyType(tags);
describe(`${name}: ${keyType}`, function() {
const issuer = endpoint;
const verifier = implementation.verifiers.find(
v => v.tags.has(tag));
let issuedVc;
let proofs;
const verificationMethodDocuments = [];
before(async function() {
issuedVc = await createInitialVc({issuer, vc});
proofs = Array.isArray(issuedVc?.proof) ? issuedVc.proof :
[issuedVc?.proof];
const verificationMethods = proofs.map(
proof => proof.verificationMethod);
for(const verificationMethod of verificationMethods) {
const verificationMethodDocument = await documentLoader({
url: verificationMethod
});
verificationMethodDocuments.push(verificationMethodDocument);
}
});
it.only('The field "cryptosuite" MUST be "ecdsa-rdfc-2019", ' +
'"ecdsa-jcs-2019" or "ecdsa-sd-2023".', function() {
this.test.cell = {
columnId: `${name}: ${keyType}`, rowId: this.test.title
};
const cryptosuite = [
'ecdsa-rdfc-2019', 'ecdsa-jcs-2019', 'ecdsa-sd-2023'
];
proofs.some(
proof => cryptosuite.includes(proof?.cryptosuite)
).should.equal(true, 'Expected at least one proof to have ' +
'"cryptosuite" property "ecdsa-rdfc-2019", "ecdsa-jcs-2019" ' +
'or "ecdsa-sd-2023".'
);
});
it('The "proof.proofPurpose" field MUST match the verification ' +
'relationship expressed by the verification method controller.',
async function() {
this.test.cell = {columnId: name, rowId: this.test.title};
verificationMethodDocuments.should.not.eql([], 'Expected ' +
'at least one "verificationMethodDocument".');
verificationMethodDocuments.some(
verificationMethodDocument =>
verificationMethodDocument?.type === 'Multikey'
).should.equal(true, 'Expected at least one proof to have "type" ' +
'property value "Multikey".'
);
const controllerDocuments = [];
for(const verificationMethodDocument of verificationMethodDocuments) {
const controllerDocument = await documentLoader({
url: verificationMethodDocument.controller
it('The "proof" MUST verify when using a conformant verifier.',
async function() {
this.test.cell = {
columnId: `${name}: ${keyType}`, rowId: this.test.title
};
should.exist(verifier, 'Expected implementation to have a VC ' +
'HTTP API compatible verifier.');
verificationSuccess({credential: issuedVc, verifier});
});
controllerDocuments.push(controllerDocument);
}
proofs.some(
proof => controllerDocuments.some(controllerDocument =>
controllerDocument.hasOwnProperty(proof.proofPurpose))
).should.equal(true, 'Expected "proof.proofPurpose" field ' +
'to match the verification method controller.'
);
});
it('Dereferencing "verificationMethod" MUST result in an object ' +
'containing a type property with "Multikey" value.',
async function() {
this.test.cell = {columnId: name, rowId: this.test.title};
verificationMethodDocuments.should.not.eql([], 'Expected ' +
'at least one "verificationMethodDocument".');
verificationMethodDocuments.some(
verificationMethodDocument =>
verificationMethodDocument?.type === 'Multikey'
).should.equal(true, 'Expected at least one proof to have "type" ' +
'property value "Multikey".'
);
});
it('The "publicKeyMultibase" property of the verification method ' +
'MUST be public key encoded according to MULTICODEC and formatted ' +
'according to MULTIBASE.', async function() {
this.test.cell = {columnId: name, rowId: this.test.title};
verificationMethodDocuments.should.not.eql([], 'Expected ' +
'"verificationMethodDocuments" to not be empty.');
verificationMethodDocuments.some(
verificationMethodDocument => {
const multibase = 'z';
const {publicKeyMultibase} = verificationMethodDocument;
return publicKeyMultibase.startsWith(multibase) &&
shouldBeBs58(publicKeyMultibase) &&
shouldBeMulticodecEncoded(publicKeyMultibase);
it('The "proof.proofPurpose" field MUST match the verification ' +
'relationship expressed by the verification method controller.',
async function() {
this.test.cell = {
columnId: `${name}: ${keyType}`, rowId: this.test.title
};
verificationMethodDocuments.should.not.eql([], 'Expected ' +
'at least one "verificationMethodDocument".');
verificationMethodDocuments.some(
verificationMethodDocument =>
verificationMethodDocument?.type === 'Multikey'
).should.equal(true, 'Expected at least one proof to have "type" ' +
'property value "Multikey".'
);
const controllerDocuments = [];
for(
const verificationMethodDocument of verificationMethodDocuments
) {
const controllerDocument = await documentLoader({
url: verificationMethodDocument.controller
});
controllerDocuments.push(controllerDocument);
}
).should.equal(true, 'Expected at "publicKeyMultibase" to to be ' +
'MULTIBASE formatted and MULTICODEC encoded.');
proofs.some(
proof => controllerDocuments.some(controllerDocument =>
controllerDocument.hasOwnProperty(proof.proofPurpose))
).should.equal(true, 'Expected "proof.proofPurpose" field ' +
'to match the verification method controller.'
);
});
it('Dereferencing "verificationMethod" MUST result in an object ' +
'containing a type property with "Multikey" value.',
async function() {
this.test.cell = {
columnId: `${name}: ${keyType}`, rowId: this.test.title
};
verificationMethodDocuments.should.not.eql([], 'Expected ' +
'at least one "verificationMethodDocument".');
verificationMethodDocuments.some(
verificationMethodDocument =>
verificationMethodDocument?.type === 'Multikey'
).should.equal(true, 'Expected at least one proof to have "type" ' +
'property value "Multikey".'
);
});
it('The "publicKeyMultibase" property of the verification method ' +
'MUST be public key encoded according to MULTICODEC and ' +
'formatted according to MULTIBASE.', async function() {
this.test.cell = {
columnId: `${name}: ${keyType}`, rowId: this.test.title
};
verificationMethodDocuments.should.not.eql([], 'Expected ' +
'"verificationMethodDocuments" to not be empty.');
verificationMethodDocuments.some(
verificationMethodDocument => {
const multibase = 'z';
const {publicKeyMultibase} = verificationMethodDocument;
return publicKeyMultibase.startsWith(multibase) &&
shouldBeBs58(publicKeyMultibase) &&
shouldBeMulticodecEncoded(publicKeyMultibase);
}
).should.equal(true, 'Expected at "publicKeyMultibase" to to be ' +
'MULTIBASE formatted and MULTICODEC encoded.');
});
});
});
}
}
});
});
2 changes: 1 addition & 1 deletion tests/20-rdfc-verify.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const {match} = endpoints.filterByTag({
property: 'verifiers'
});

describe('ecdsa-rdfc-2019 (verify)', function() {
describe.skip('ecdsa-rdfc-2019 (verify)', function() {
let credential;
beforeEach(async function() {
const {match} = endpoints.filterByTag({
Expand Down
2 changes: 1 addition & 1 deletion tests/30-rdfc-interop.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const {
match: verifierMatches
} = endpoints.filterByTag({tags: [tag], property: 'verifiers'});

describe('ecdsa-rdfc-2019 (interop)', function() {
describe.skip('ecdsa-rdfc-2019 (interop)', function() {
// this will tell the report
// to make an interop matrix with this suite
this.matrix = true;
Expand Down
10 changes: 10 additions & 0 deletions tests/helpers.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,13 @@ export const multibaseMultikeyHeaderP256 =

export const multibaseMultikeyHeaderP384 =
SUPPORTED_BASE58_ECDSA_MULTIKEY_HEADERS.get('P-384');

export function getKeyType(tags) {
const supportedKeyTypes = ['P-256', 'P-384'];
for(const keyType of supportedKeyTypes) {
if(tags.includes(keyType)) {
return keyType;
}
}
return null;
}

0 comments on commit 5deb1ba

Please sign in to comment.