Verifiable Credential Library

The Verifiable Credential Library provides a Core Service of the EBSI platform providing the capability of creating W3C credentials ready for signing and validating W3C Verifiable Credentials. This library has followed W3C Recommendation 19 November 2019.

Table of Contents

1. Installing
2. Example
3. Linting
4. Auditing
5. Testing
6. Licensing

Installing

Using npm:

$ npm i --save @cef-ebsi/verifiable-credential

Using yarn:

$ yarn add @cef-ebsi/verifiable-credential

Example

import {
  createCredential,
  createVerifiableCredential,
  validateVerifiableCredential,
  RequiredProof,
  SignatureValue,
} from "@cef-ebsi/verifiable-credential";

const credential = createCredential({
  credentialSubject: { name: "alice" },
  issuer: "did:ebsifnmt:zsSgDXeYPhZ3AuKhTFneDf1",
});

console.log(credential);
/*
{
  "@context": [
    "https://www.w3.org/2018/credentials/v1",
    "https://EBSI-WEBSITE.EU/schemas/vc/2019/v1#",
    "https://EBSI-WEBSITE.EU/schemas/eidas/2019/v1#",
  ],
  type: "VerifiableCredential",
  issuanceDate: "2020-11-23T00:00:00Z",
  credentialSubject: {
    name: "alice"
  },
  issuer: "did:ebsifnmt:zsSgDXeYPhZ3AuKhTFneDf1"
}
*/

const requiredProof: RequiredProof = {
  type: "EcdsaSecp256k1Signature2019",
  proofPurpose: "assertionMethod",
  verificationMethod: "did:ebsifnmt:zwDb6tWecUjaoShWYx9fmqZ#eidasKey",
};

const signatureValue: SignatureValue = {
  proofValue:
    "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NkstUiJ9..xSfnO21PsmCPgLkE34wZQ5mLOcRmb4NPiBSKw3EULCBZiVSWrR_VhddwMuyydBwkimA04f2NJQofD3gF3t5tuAE",
  proofValueName: "jws",
};

const vc = createVerifiableCredential(
  credential,
  requiredProof,
  requiredProof,
  signatureValue
);

console.log(vc);

/*
{
  "@context": [
    "https://www.w3.org/2018/credentials/v1",
    "https://EBSI-WEBSITE.EU/schemas/vc/2019/v1#",
    "https://EBSI-WEBSITE.EU/schemas/eidas/2019/v1#",
  ],
  type: "VerifiableCredential",
  issuanceDate: "2020-11-23T00:00:00Z",
  credentialSubject: {
    name: "alice"
  },
  issuer: "did:ebsifnmt:zsSgDXeYPhZ3AuKhTFneDf1",
  "proof": {
    "type": "EcdsaSecp256k1Signature2019",
    "created": "2020-11-12T12:08:08.163Z",
    "proofPurpose": "assertionMethod",
    "verificationMethod": "did:ebsifnmt:zwDb6tWecUjaoShWYx9fmqZ#eidasKey",
    "jws": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NkstUiJ9..xSfnO21PsmCPgLkE34wZQ5mLOcRmb4NPiBSKw3EULCBZiVSWrR_VhddwMuyydBwkimA04f2NJQofD3gF3t5tuAE"
  }
}
*/

validateVerifiableCredential(vc, {
  tirUrl: "https://api.preprod.ebsi.eu/trusted-issuers-registry/v2/issuers",
  resolver: "https://api.preprod.ebsi.eu/did-registry/v2/identifiers",
}); // should not throw

Linting

$ yarn lint

Auditing

$ yarn run audit

Testing

# unit tests
$ yarn test

Licensing

Copyright (c) 2019 European Commission
Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in compliance with the Licence. You may obtain a copy of the Licence at:

• https://joinup.ec.europa.eu/page/eupl-text-11-12

Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence.