@gwydion-id/icao-9303-models 0.1.0 → 0.1.2

package/README.md

@@ -7,7 +7,7 @@
 
 > A collection of exports to represent and use [ICAO Document 9303 machine-readable travel documents (MRTDs)][icao9303].
 
-[![REUSE status](https://api.reuse.software/badge/github.com/Gwydion-ID/icao-9303-models)](https://api.reuse.software/info/github.com/Gwydion-ID/icao-9303-models)
+[![REUSE status](https://api.reuse.software/badge/github.com/gwydion-id/icao-9303-models)](https://api.reuse.software/info/github.com/gwydion-id/icao-9303-models)
 
 ## Provided exports
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gwydion-id/icao-9303-models",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "A collection of exports to represent and use ICAO Document 9303 machine-readable travel documents (MRTDs).",
   "type": "module",
   "main": "./src/index.js",
@@ -10,8 +10,15 @@
   "scripts": {
     "test": "node --test tests/**/*.test.js"
   },
-  "keywords": ["icao", "icao9303", "mrz", "mrtd", "vds", "identity", "passport"],
+  "keywords": [
+    "icao",
+    "icao9303",
+    "mrz",
+    "mrtd",
+    "vds",
+    "identity",
+    "passport"
+  ],
   "author": "Don Geronimo",
   "license": "LGPL-3.0-or-later"
 }
-

package/src/digitalsealv3.js

@@ -9,6 +9,7 @@ import { VDS_SIGNATURE_MARKER } from "./utilities/vds-signature-marker.js";
 import { setSignatureZone } from "./utilities/set-signature-zone.js";
 import { VDS_VERSION_3 } from "./utilities/vds-version-3.js";
 import { IcaoDate } from "./utilities/icao-date.js";
+import { getHash } from "./utilities/get-hash.js";
 
 /**
  * Stores properties and methods for ICAO 9303 visible digital seals (VDSs)
@@ -355,5 +356,16 @@ export class DigitalSealV3 {
     start = this.#setMessage(start, value);
     this.signatureData = setSignatureZone(start, value);
   }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await getHash(this.unsignedSeal, algorithm);
+    return output;
+  }
 }
 

package/src/digitalsealv4.js

@@ -11,6 +11,7 @@ import { lengthToDERLength } from "./utilities/length-to-der-length.js";
 import { derLengthToLength } from "./utilities/der-length-to-length.js";
 import { setSignatureZone } from "./utilities/set-signature-zone.js";
 import { IcaoDate } from "./utilities/icao-date.js";
+import { getHash } from "./utilities/get-hash.js";
 
 /**
  * Stores properties and methods for ICAO 9303 visible digital seals (VDSs)
@@ -365,5 +366,16 @@ export class DigitalSealV4 {
     start = this.#setMessage(start, value);
     this.signatureData = setSignatureZone(start, value);
   }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await getHash(this.unsignedSeal, algorithm);
+    return output;
+  }
 }
 

package/src/index.js

@@ -4,7 +4,7 @@
 // Utility exports
 export { NATIONALITY_CODES } from './utilities/nationality-codes.js';
 export { IcaoDate } from './utilities/icao-date.js';
-export { dateToBytes } from './utilities/dates-to-bytes.js';
+export { dateToBytes } from './utilities/date-to-bytes.js';
 export { bytesToDate } from './utilities/bytes-to-date.js';
 export { c40Decode } from './utilities/c40-decode.js';
 export { c40Encode } from './utilities/c40-encode.js';

package/src/mrvadocumentwithvds3.js

@@ -555,5 +555,16 @@ export class MRVADocumentWithVDS3 {
    * @param { number[] } value
    */
   set signedSeal(value) { this.#digitalseal.signedSeal = value; }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await this.#digitalseal.getHash(algorithm);
+    return output;
+  }
 }
 

package/src/mrvadocumentwithvds4.js

@@ -555,5 +555,16 @@ export class MRVADocumentWithVDS4 {
    * @param { number[] } value
    */
   set signedSeal(value) { this.#digitalseal.signedSeal = value; }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await this.#digitalseal.getHash(algorithm);
+    return output;
+  }
 }
 

package/src/mrvbdocumentwithvds3.js

@@ -556,5 +556,16 @@ export class MRVBDocumentWithVDS3 {
    * @param { number[] } value
    */
   set signedSeal(value) { this.#digitalseal.signedSeal = value; }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await this.#digitalseal.getHash(algorithm);
+    return output;
+  }
 }
 

package/src/mrvbdocumentwithvds4.js

@@ -556,5 +556,16 @@ export class MRVBDocumentWithVDS4 {
    * @param { number[] } value
    */
   set signedSeal(value) { this.#digitalseal.signedSeal = value; }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await this.#digitalseal.getHash(algorithm);
+    return output;
+  }
 }
 

package/src/td1documentwithvds3.js

@@ -475,5 +475,16 @@ export class TD1DocumentWithVDS3 {
    * @param { number[] } value
    */
   set signedSeal(value) { this.#digitalseal.signedSeal = value; }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await this.#digitalseal.getHash(algorithm);
+    return output;
+  }
 }
 

package/src/td1documentwithvds4.js

@@ -475,5 +475,16 @@ export class TD1DocumentWithVDS4 {
    * @param { number[] } value
    */
   set signedSeal(value) { this.#digitalseal.signedSeal = value; }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await this.#digitalseal.getHash(algorithm);
+    return output;
+  }
 }
 

package/src/td2documentwithvds3.js

@@ -462,5 +462,16 @@ export class TD2DocumentWithVDS3 {
    * @param { number[] } value
    */
   set signedSeal(value) { this.#digitalseal.signedSeal = value; }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await this.#digitalseal.getHash(algorithm);
+    return output;
+  }
 }
 

package/src/td2documentwithvds4.js

@@ -462,5 +462,16 @@ export class TD2DocumentWithVDS4 {
    * @param { number[] } value
    */
   set signedSeal(value) { this.#digitalseal.signedSeal = value; }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await this.#digitalseal.getHash(algorithm);
+    return output;
+  }
 }
 

package/src/td3documentwithvds3.js

@@ -462,5 +462,16 @@ export class TD3DocumentWithVDS3 {
    * @param { number[] } value
    */
   set signedSeal(value) { this.#digitalseal.signedSeal = value; }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await this.#digitalseal.getHash(algorithm);
+    return output;
+  }
 }
 

package/src/td3documentwithvds4.js

@@ -462,5 +462,16 @@ export class TD3DocumentWithVDS4 {
    * @param { number[] } value
    */
   set signedSeal(value) { this.#digitalseal.signedSeal = value; }
+
+  /**
+   * Get a hash of the VDS for use in signing and verification operations.
+   * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+   *     Web Crypto API supported hash function string.
+   * @returns { Promise<number[]> }
+   */
+  async getHash(algorithm = 'SHA-256') {
+    const output = await this.#digitalseal.getHash(algorithm);
+    return output;
+  }
 }
 

package/src/utilities/get-hash.js

@@ -0,0 +1,22 @@
+// SPDX-FileCopyrightText: 2026 Don Geronimo <https://sentamal.in>
+// SPDX-License-Identifier: LGPL-3.0-or-later
+
+/**
+ * Get a hash of the VDS for use in signing and verification operations.
+ *
+ * @async
+ * @param { number[] } byteArray
+ * @param { 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' } [algorithm = 'SHA-256'] - A
+ *     Web Crypto API supported hash function string
+ * @returns { Promise<number[]> }
+ */
+export async function getHash(byteArray, algorithm = 'SHA-256') {
+  const cryptoObject = globalThis.crypto;
+  if (!cryptoObject?.subtle) {
+    throw new Error('Web Crypto API is unavailable; ensure you are running in Node.js or in a Secure Context (HTTPS).');
+  }
+  const bytes = new Uint8Array(byteArray);
+  const hashBuffer = await cryptoObject.subtle.digest(algorithm, bytes);
+  return Array.from(new Uint8Array(hashBuffer));
+}
+

package/tests/models/digitalsealv4.test.js

@@ -19,11 +19,17 @@ const signedSeal = [ 0xdc, 0x03, 0xd9, 0xc5, 0xd9, 0xca, 0xc8, 0xa7, 0x3a, 0x99,
                      0xfe, 0x15, 0xf6, 0x8d, 0xdd, 0x68, 0x18, 0xaf, 0x5a, 0x7b, 0xaf, 0x21, 0xca, 0x7c, 0xfc, 0x7e,
                      0xb3, 0xbe ]
 
+const sealHash = [ 0x02, 0x81, 0x9b, 0x0d, 0xd7, 0x08, 0x6f, 0x79,
+                   0x87, 0xf4, 0xb9, 0xa3, 0x23, 0xa3, 0x37, 0x58,
+                   0xea, 0xd3, 0xa5, 0x63, 0x87, 0x28, 0x98, 0xef,
+                   0x0c, 0x9a, 0xa1, 0xca, 0x20, 0xce, 0x7e, 0xa8 ]
+
 describe('Visible Digital Seal version 4', () => {
 
   describe('Import exemplary raw data from documentation [REF ICAO 9303 Part 7 Appendix E]', () => {
-    it('should equal the values from exemplary VDS in Appendix E-2.', () => {
+    it('should equal the values from exemplary VDS in Appendix E-2.', async () => {
       const document = new DigitalSealV4({ signedSeal: signedSeal });
+      const hash = await document.getHash();
       assert.deepStrictEqual(document.authorityCode, 'UTO');
       assert.deepStrictEqual(document.identifierCode, 'UTTS');
       assert.deepStrictEqual(document.certReference,'5B');
@@ -37,11 +43,12 @@ describe('Visible Digital Seal version 4', () => {
       assert.deepStrictEqual(document.features.get(3), [ 2 ]);
       assert.deepStrictEqual(document.features.get(4), [ 0x5a, 0x00, 0x00 ]);
       assert.deepStrictEqual(c40Decode(document.features.get(5)), 'ABC424242');
+      assert.deepStrictEqual(hash, sealHash);
     });
   });
 
   describe('Use properties to reconstruct the exemplary raw data from documentation [REF ICAO 9303 Part 7 Appendix E]', () => {
-    it('should equal the exemplary raw data from documentation in Appendix E-2.', () => {
+    it('should equal the exemplary raw data from documentation in Appendix E-2.', async () => {
       const document = new DigitalSealV4({
         authorityCode: 'UTO',
 	identifierCode: 'UTTS',
@@ -59,7 +66,9 @@ describe('Visible Digital Seal version 4', () => {
                                  0x91, 0xbe, 0xb1, 0x19, 0x7b, 0xed, 0x97, 0xad, 0xf2, 0xff, 0x89, 0xe0, 0xa3, 0x44, 0x51, 0x2b,
                                  0x7b, 0x01, 0x36, 0xc4, 0x40, 0x50, 0xf1, 0x17, 0xe5, 0x07, 0xbc, 0x2a, 0x78, 0x2f, 0xfe, 0x15,
                                  0xf6, 0x8d, 0xdd, 0x68, 0x18, 0xaf, 0x5a, 0x7b, 0xaf, 0x21, 0xca, 0x7c, 0xfc, 0x7e, 0xb3, 0xbe ];
+      const hash = await document.getHash();
       assert.deepStrictEqual(document.signedSeal, signedSeal);
+      assert.deepStrictEqual(hash, sealHash);
     });
   });