https://github.com/li0ard/vds
simple library for ICAO Visible Digital Seals (VDS). supports browsers, node, bun and more!
https://github.com/li0ard/vds
bsi emrtd icao icao-9303 idb mrtd passport vds visibledigitalseal
Last synced: 5 months ago
JSON representation
simple library for ICAO Visible Digital Seals (VDS). supports browsers, node, bun and more!
- Host: GitHub
- URL: https://github.com/li0ard/vds
- Owner: li0ard
- License: mit
- Created: 2025-12-07T18:10:04.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-01-02T08:54:35.000Z (5 months ago)
- Last Synced: 2026-01-08T07:39:07.123Z (5 months ago)
- Topics: bsi, emrtd, icao, icao-9303, idb, mrtd, passport, vds, visibledigitalseal
- Language: TypeScript
- Homepage: https://li0ard.is-cool.dev/vds
- Size: 57.6 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
@li0ard/vds
simple library for visible digital seals (VDS)
docs
## Features
- Simple: Hides decoding process and provides simple and modern API
- Type-Safe: Most of the APIs are strictly typed to help your workflow
- Compliance: Fully complies with ICAO 9303, BSI TR-03137 and other standards
- Supports Bun, Node.js, Deno, Browsers, Cloudflare Workers
- Supports many curves from [`@noble/curves`](https://github.com/paulmillr/noble-curves/)
## Installation
```bash
# from NPM
npm i @li0ard/vds
# from JSR
bunx jsr add @li0ard/vds
```
## Usage
### Parse digital seal
```ts
import { Seal } from "@li0ard/vds";
const seal = Buffer.from("DC03....", "hex");
const decodedSeal = Seal.decode(seal);
console.log(decodedSeal);
```
### Verify digital seal
```ts
import { Seal, Verifier } from "@li0ard/vds";
import { brainpoolP256r1 } from "@noble/curves/misc.js";
const publicKey = Buffer.from("0408....", "hex");
const verifier = new Verifier(brainpoolP256r1, publicKey);
const seal = Buffer.from("DC03....", "hex");
const decodedSeal = Seal.decode(seal);
console.log(verifier.verifySeal(decodedSeal));
```
### Map VDS with schema
```ts
import { Seal, VDSDocument, VDSProp, decodeSeal, FeatureCoding, encodeSeal } from "@li0ard/vds";
@VDSDocument({ documentRef: 0x5e03, version: 4 })
class ICAOEmergencyTravelDocument {
@VDSProp({ tag: 2, coding: FeatureCoding.MRZ })
mrz!: string;
}
const seal = Buffer.from("DC03....", "hex");
const decodedSeal = Seal.decode(seal);
const mapped = decodeSeal(decodedSeal, ICAOEmergencyTravelDocument);
console.log(mapped);
// Also serialize back
console.log(encodeSeal(mapped));
```
### Parse ICAO barcode (IDB)
```ts
import { ICAOBarcode } from "@li0ard/vds";
const barcode = "RDB1B...";
const decodedBarcode = ICAOBarcode.decode(barcode);
console.log(decodedBarcode);
```
### Verify ICAO barcode (IDB)
```ts
import { ICAOBarcode, Verifier } from "@li0ard/vds";
import { brainpoolP256r1 } from "@noble/curves/misc.js";
const publicKey = Buffer.from("0408....", "hex");
const verifier = new Verifier(brainpoolP256r1, publicKey);
const barcode = "RDB1B...";
const decodedBarcode = ICAOBarcode.decode(barcode);
console.log(verifier.verifyBarcode(decodedBarcode));
```
## Links
- [vdstools](https://github.com/tsenger/vdstools) - An Open Source Kotlin Implementation of VDS and IDB (greatly inspired)
- [ICAO 9303](https://icao.int/publications/doc-series/doc-9303) - Specifications to VDS
- [BSI TR-03137](https://bsi.bund.de/DE/Themen/Unternehmen-und-Organisationen/Standards-und-Zertifizierung/Technische-Richtlinien/TR-nach-Thema-sortiert/tr03137/tr03137_node.html) - Specifications to VDS (with example documents)
- [ICAO TR "ICAO Datastructure for Barcode"](https://www2023.icao.int/Security/FAL/TRIP/PublishingImages/Pages/Publications/ICAO%20TR%20-%20ICAO%20Datastructure%20for%20Barcode.pdf) - Specifications to IDB