Options
All
  • Public
  • Public/Protected
  • All
Menu

digital-covid-certificate-lib

Digital Covid Certificate Lib (DccLib)

DccLib is a TypeScript library that decodes and verifies the European Digital Covid Certificate (Eudcc) in modern web browsers. For now, the library has only been tested in Firefox with the Swiss Covid Certificate. In theory, the library should also be compatible with DCCs from other countries as long as they follow the Eudcc specification and the provided singing keys are valid.

This work is primarily intended for educational purposes. In fact, the project was part of an internal hackathon at the University of Basel.

  • TsDocs
  • Demo
    • The demo is not very user-friendly... Sorry for that, but have a look at the console to interact directly with your certificate.
  • Example Projects
    • jswebpack is a sample project using JavaScript and Webpack.
    • tsreact is a sample project using TypeScript and React.

List of all features:

  • decode the Eudcc
  • dereference the EU eHealthNetwork Digitial Covid Certificate [value sets]
  • load and verify the DCC Signing Keys from a JSON Web Token (JWT)
  • verify a x509 Certificate Trust Chain
  • verify a DCC

Installation

npm i digital-covid-certificate-lib

Examples

The following two examples show how to decode and verify the validity of a DCC.

Example 1

  • Stepwise decode a DCC
  • Access some sample properties from a Eudcc instance
  • Load the DCC keys from a JWT
  • Verify the DCC key JWT signature and the certificate chain
  • Verify the DCC
import {
  Base45Decoder,
  CborDecoder, ChKeyStore,
  CoseDecoder,
  DccBase45,
  Jwt,
  Verifier,
  ZlibDecoder,
  CH_KEYS_UPDATE_LIST_JWT, CH_ROOT_CERTIFICATE
} from "digital-covid-certificate-lib";

const validVaccinationCert = "HC1:NCFK60DG0/3WUWGSLKH47GO0Y%5S.PK%96L79CK-500XK0JCV496F3PYJ-982F3:OR2B8Y50.FK6ZK7:EDOLOPCO8F6%E3.DA%EOPC1G72A6YM86G7/F6/G80X6H%6946746T%6C46/96SF60R6FN8UPC0JCZ69FVCPD0LVC6JD846Y96C463W5307+EDG8F3I80/D6$CBECSUER:C2$NS346$C2%E9VC- CSUE145GB8JA5B$D% D3IA4W5646646-96:96.JCP9EJY8L/5M/5546.96SF63KC.SC4KCD3DX47B46IL6646H*6Z/ER2DD46JH8946JPCT3E5JDLA7$Q69464W51S6..DX%DZJC2/DYOA$$E5$C JC3/D9Z95LEZED1ECW.C8WE2OA3ZAGY8MPCG/DU2DRB8MTA8+9$PC5$CUZC$$5Y$5FBB*10GBH A81QK UV-$SOGD1APAB4$5UV C-EWB4T*6H%QV/DAP9L7J3Y4O/WVI5IW3672HO-HV16IW3JHV-FI%WJCPBI8QTE008I+FPR01MYFA6EBN2SR3H+4KH1M9RCIM2 VV15REG 516N93SS70RBUCH-RJM2JMULZ6*/HBBW7W7:S2BU7T6PRTMF4ALUNEXH3P7 LE0YF0TGE461PBK9TD68HDIT4AIFD9NH14V%GBCONJOV$KN  C+3U-IT$SE-A2V+9UO9WYRJ4HN+M/Z5W$QEDT/8C:88OQ4DXOBBIQ453863NPW0EJXG8$GH1T 38C*UI6T /FCDC%6VLNOA6W6BEYJJUH2Z-SOJO1D7JMALD8 $1%5B.GH$7AQOHZ:K3BNO1"
const dccBase45 = new DccBase45(validVaccinationCert)
const dccZlib = Base45Decoder.decode(dccBase45)
const dccCbor = ZlibDecoder.decode(dccZlib);
const dccCose = CborDecoder.decode(dccCbor)
const eudcc = CoseDecoder.decode(dccCose)

console.log(eudcc.person.familyName)
console.log(eudcc.person.dateOfBirth)

if (eudcc instanceof VaccinationCertificate) {
  console.log(eudcc.infromation.vaccinationCountry)
} else if (eudcc instanceof TestCertificate) {
  console.log(eudcc.infromation.testResult)
} else if (eudcc instanceof RecoveryCertificate) {
  console.log(eudcc.infromation.firstPositiveTestDate)
}

const keystore = new ChKeyStore()
await keystore.loadKeys(
        {
          jwt: new Jwt(CH_KEYS_UPDATE_LIST_JWT),
          verifySignature: true,
          rootCertificate: CH_ROOT_CERTIFICATE
        }
)


const kId = dccCose.getSignedHeaderAsJson().kid
const publicKey = await keystore.getKey(kId)
const valid = await Verifier.verify(publicKey,
        {
          name: "RSA-PSS",
          saltLength: 32,
        },
        dccCose
)

Example 2

  • Create a chain decoder
  • Load the DCC keys from JWT
  • Verify the DCC
// same imports as for example 1

const validVaccinationCert = "HC1:NCFK60DG0/3WUWGSLKH47GO0Y%5S.PK%96L79CK-500XK0JCV496F3PYJ-982F3:OR2B8Y50.FK6ZK7:EDOLOPCO8F6%E3.DA%EOPC1G72A6YM86G7/F6/G80X6H%6946746T%6C46/96SF60R6FN8UPC0JCZ69FVCPD0LVC6JD846Y96C463W5307+EDG8F3I80/D6$CBECSUER:C2$NS346$C2%E9VC- CSUE145GB8JA5B$D% D3IA4W5646646-96:96.JCP9EJY8L/5M/5546.96SF63KC.SC4KCD3DX47B46IL6646H*6Z/ER2DD46JH8946JPCT3E5JDLA7$Q69464W51S6..DX%DZJC2/DYOA$$E5$C JC3/D9Z95LEZED1ECW.C8WE2OA3ZAGY8MPCG/DU2DRB8MTA8+9$PC5$CUZC$$5Y$5FBB*10GBH A81QK UV-$SOGD1APAB4$5UV C-EWB4T*6H%QV/DAP9L7J3Y4O/WVI5IW3672HO-HV16IW3JHV-FI%WJCPBI8QTE008I+FPR01MYFA6EBN2SR3H+4KH1M9RCIM2 VV15REG 516N93SS70RBUCH-RJM2JMULZ6*/HBBW7W7:S2BU7T6PRTMF4ALUNEXH3P7 LE0YF0TGE461PBK9TD68HDIT4AIFD9NH14V%GBCONJOV$KN  C+3U-IT$SE-A2V+9UO9WYRJ4HN+M/Z5W$QEDT/8C:88OQ4DXOBBIQ453863NPW0EJXG8$GH1T 38C*UI6T /FCDC%6VLNOA6W6BEYJJUH2Z-SOJO1D7JMALD8 $1%5B.GH$7AQOHZ:K3BNO1"

const coseChainDecoder = (cert: string) => CborDecoder.decode(ZlibDecoder.decode(Base45Decoder.decode(new DccBase45(cert))))
const dccCose = coseChainDecoder(validVaccinationCert)

const keystore = new ChKeyStore()
await keystore.loadKeys(
        {
          jwt: new Jwt(CH_KEYS_UPDATE_LIST_JWT),
          verifySignature: false,
        }
)

const kId = dccCose.getSignedHeaderAsJson().kid
const publicKey = await keystore.getKey(kId)
const valid = await Verifier.verify(publicKey,
        {
          name: "RSA-PSS",
          saltLength: 32,
        },
        dccCose
)

Generated using TypeDoc