TruAge Credential Verifier (@digitalbazaar/truage-credential-verifier)

TruAge Verifiable Credential Verifier.

Table of Contents

• Background
• Security
• Install
• Usage
• Contribute
• Commercial Support
• License

Background

TBD

Security

TBD

Install

• Browsers and Node.js 20+ are supported.

To install from NPM:

npm install @digitalbazaar/truage-credential-verifier

To install locally (for development):

git clone https://github.com/digitalbazaar/truage-credential-verifier.git
cd truage-credential-verifier
npm install

Usage

To verify a TruAge token, which is a CBOR-LD-encoded Verifiable Credential of type OverAgeTokenCredential using the (using the https://w3id.org/age/v1 JSON-LD context):

import {verifyQrCodeText} from '@digitalbazaar/truage-credential-verifier';

const qrCodeText = 'VP1-B3ECQDIYACEMHIGDODB6KQAMDCELBIGDQQIBVAADIXHBIQX2PFCEVATORHCCS2LYYOKSRQ5AYSYMLMGTEEHEVWGF6DDCBRQCYIF5DCQDI3YNUWHN53SMBYY75SQPJQUBD73YL5OH3DDLALMINCE55XRFBEUS2SCJY52BAXJE3TKYA6I6SSVHDX4CF4LWYVZFDXPMQ536WBAMMFAYZAQAVQIXNAFIOG5RWAVVT5UYU32LAGAUXMSXZUJL3GLMGCMPGWKFOWUNW44G66WBC5UAVBY3WGYCWWPWTCTPJMAYCS5SK7GRFPMZNQYJR42ZIV22RW3TQ33YYOWBBQ3AYQIMJ5IQYRJMFO6WZAUA2IAAVDBVBQZAYNRFHVWIFAGRAAFQYPQKRQ3SYHN5AAAKG3JGL6G7AC3LL7YEC7KLUV7BHOTPEOYX6P53HWMLQH42P4XYY6YY3U53CG7OG7XUBKMZU6B7DTQ2GNJKDME26GUGADCKBKGFCDJSV4LGSDCSBUZBBZFNRRKECDECACWBC5UAVBY3WGYCWWPWTCTPJMAYCS5SK7GRFPMZNQYJR42ZIV22RW3TQ33Y';

const result = await verifyQrCodeText({qrCodeText});

console.log('result', result);

// result is an object with these properties:
// verified: boolean
//   true - The VC was parsed and the signature passed, but check `issuer`!
//   false - Something failed, see 'error' field for more details
// error: object, only present if verification failed
//   message - A description of the error
//   errors - An optional array of additional error objects
// credential: object, the VC that was parsed and verified, if verified is true
// issuer: string, the ID of the issuer that MUST be checked against the allow
//   list from TruAge before using the VC
// overAge: integer, the parsed over age value, e.g., 21
// verificationDetails: object, developer verification debugging details

Contribute

See the contribute file!

PRs accepted.

If editing the Readme, please conform to the standard-readme specification.

Commercial Support

Commercial support for this library is available upon request from Digital Bazaar: [email protected]

License

New BSD License (3-clause) © 2024 Digital Bazaar