This is the test suite for the W3C Verifiable Credentials Data Model (VCDM) v2.0 specification.
This test suite provides interoperability tests for verifiable credential processors (issuers/verifiers) that support the W3C Verifiable Credentials Data Model v2.0.
npm iIn order to integrate with this test suite, you will need to use a VC-API compatible issuer and verifier that is capable of issuing and verifying verifiable credentials and verifiable presentations. If your implementation is not VC-API compatible, it is possible to "wrap" the implementation in a minimal VC-API implementation. Example code for which is available at https://github.com/Wind4Greg/Server-for-VCs
The issuer endpoint will need to conform to the VC Issuer API.
A request to issue a credential (/credentials/issue) will look like this:
{
"credential": {
"@context": [
"https://www.w3.org/ns/credentials/v2",
"https://www.w3.org/ns/credentials/examples/v2"
],
"id": "http://university.example/credentials/1872",
"type": ["VerifiableCredential", "ExampleAlumniCredential"],
"issuer": "https://university.example/issuers/565049",
"validFrom": "2023-07-01T19:23:24Z",
"credentialSubject": {
"id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
"alumniOf": {
"id": "did:example:c276e12ec21ebfeb1f712ebc6f1",
"name": "Example University"
}
},
},
"options": {}
}The response from a call to issue a credential (/credentials/issue) will
look like this:
{
"verifiableCredential": {
"@context": [
"https://www.w3.org/ns/credentials/v2",
"https://www.w3.org/ns/credentials/examples/v2"
],
"id": "http://university.example/credentials/1872",
"type": ["VerifiableCredential", "ExampleAlumniCredential"],
"issuer": "https://university.example/issuers/565049",
"validFrom": "2023-07-01T19:23:24Z",
"credentialSubject": {
"id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
"alumniOf": {
"id": "did:example:c276e12ec21ebfeb1f712ebc6f1",
"name": "Example University"
}
},
"proof": {
"type": "DataIntegrityProof",
"cryptosuite": "eddsa-2022",
"created": "2023-06-18T21:19:10Z",
"proofPurpose": "assertionMethod",
"verificationMethod": "https://university.example/issuers/565049#key-1",
"proofValue": "zQeVbY4oey...V6doDwLWx"
}
}
}The credential verifier endpoint will need to conform to the VC Verifier API.
A request to the verifier endpoint (/credentials/verify) for a credential
will look like this:
{
"verifiableCredential": {
"@context": [
"https://www.w3.org/ns/credentials/v2",
"https://www.w3.org/ns/credentials/examples/v2"
],
"id": "http://university.example/credentials/1872",
"type": ["VerifiableCredential", "ExampleAlumniCredential"],
"issuer": "https://university.example/issuers/565049",
"validFrom": "2023-07-01T19:23:24Z",
"credentialSubject": {
"id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
"alumniOf": {
"id": "did:example:c276e12ec21ebfeb1f712ebc6f1",
"name": "Example University"
}
},
"proof": {
"type": "DataIntegrityProof",
"cryptosuite": "eddsa-2022",
"created": "2023-06-18T21:19:10Z",
"proofPurpose": "assertionMethod",
"verificationMethod": "https://university.example/issuers/565049#key-1",
"proofValue": "zQeVbY4oey...V6doDwLWx"
}
},
"options": {}
}
A response from the verifier endpoint (/credentials/verify) for a
verifiable credential might look like this (only HTTP response codes are
checked):
{
"checks": ["proof"],
"warnings": ["invalid-uri"],
"errors": ["invalid proof"]
}The presentation verifier endpoint will need to conform to the VC Verifier API.
A request to the verifier endpoint for a presentation (/presentations/verify)
will look like this:
{
"verifiablePresentation": {
"@context": ["https://www.w3.org/ns/credentials/v2"],
"type": ["VerifiablePresentation"],
"holder": "did:example:holder123456789",
"verifiableCredential": [{
"@context": [
"https://www.w3.org/ns/credentials/v2",
"https://www.w3.org/ns/credentials/examples/v2"
],
"id": "http://university.example/credentials/1872",
"type": ["VerifiableCredential", "ExampleAlumniCredential"],
"issuer": "https://university.example/issuers/565049",
"validFrom": "2023-07-01T19:23:24Z",
"credentialSubject": {
"id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
"alumniOf": {
"id": "did:example:c276e12ec21ebfeb1f712ebc6f1",
"name": "Example University"
}
},
"proof": {
"type": "DataIntegrityProof",
"cryptosuite": "eddsa-2022",
"created": "2023-06-18T21:19:10Z",
"proofPurpose": "assertionMethod",
"verificationMethod": "https://university.example/issuers/565049#key-1",
"proofValue": "zQeVbY4oey...V6doDwLWx"
}
}],
"proof": {
"type": "DataIntegrityProof",
"cryptosuite": "eddsa-2022",
"challenge": "08cf4ce0-2bd0-11ee-8622-83054936f200",
"domain": "example.com",
"created": "2023-06-18T21:19:10Z",
"proofPurpose": "assertionMethod",
"verificationMethod": "did:example:holder123456789#key-1",
"proofValue": "zQeVbY4y...oDwLWxV6d"
}
},
"options": {
"challenge": "secret",
"domain": "example.com"
}
}A response from the verifier endpoint (/credentials/verify) for a
verifiable presentation might look like this (only HTTP response codes are
checked):
{
"checks": ["proof"],
"warnings": ["invalid-uri"],
"errors": ["invalid proof"]
}Implementations are expected to not error when any of the following context files are used in a verifiable credential or a verifiable presentation:
- VC 2.0 Context - https://www.w3.org/ns/credentials/v2
- VC Examples Context - https://www.w3.org/ns/credentials/examples/v2
npm test:::note If no implementation configuration file is provided, the test suite will not fail and will use an internal default configuration instead. :::
Please create a new folder in the root directory of the test suite, name it implementations. After that, inside the ./implementations folder, you can add new implementation configuration files.
To add your implementation to this test suite You will need to add 3 endpoints to your implementation manifest.
- A credentials issuer endpoint (
/credentials/issue) in theissuersproperty. - A credentials verifier endpoint (
/credentials/verify) in theverifiersproperty. - A presentations verifier endpoint (
/presentations/verify) in thevpVerifiersproperty.
:::note These endpoints above are using example path, your endpoints can be different. :::
All endpoints will need the tag vc2.0. A simplified manifest will roughly
look like the following:
{
"name": "My Company",
"implementation": "My implementation",
"issuers": [{
"id": "did:web:example.com",
"endpoint": "https://issuer.mycompany.com/credentials/issue",
"method": "POST",
"tags": ["vc2.0"]
}],
"verifiers": [{
"id": "did:web:example.com",
"endpoint": "https://verifier.mycompany.com/credentials/verify",
"method": "POST",
"tags": ["vc2.0"]
}],
"vpVerifiers": [{
"id": "did:web:example.com",
"endpoint": "https://verifier.mycompany.com/presentations/verify",
"method": "POST",
"tags": ["vc2.0"]
}]
}This example above is for a set of unauthenticated endpoints. You may add zcap or oauth2 authentication to your endpoints.
To test implementations with endpoints running locally, create a configuration file named localConfig.cjs in the root directory of the test suite. localConfig.cjs should export a json object. Add the property implementations to the exported object. implementations should be an array of objects such as the one below:
// localConfig.cjs defining local implementations
module.exports = {
"implementations": [
{
"name": "My Company",
"implementation": "My implementation",
"issuers": [{
"id": "did:web:example.com",
"endpoint": "http://localhost:3332/credentials/issue",
"method": "POST",
"tags": ["vc2.0"]
}],
"verifiers": [{
"id": "did:web:example.com",
"endpoint": "http://localhost:3332/credentials/verify",
"method": "POST",
"tags": ["vc2.0"]
}],
"vpVerifiers": [{
"id": "did:web:example.com",
"endpoint": "http://localhost:3332/presentations/verify",
"method": "POST",
"tags": ["vc2.0"]
}]
}
];
};After adding the config file, only implementations in localConfig.cjs will run.
See the CONTRIBUTING.md file in the w3c/vc-test-suite-implementations repo.
Pull Requests are welcome!