## 1.2.0 - 2024-09-27 (#29)

* ## 1.2.0 - 2024-09-27 ### Added - Added `_sd_decoy` option to specify number of decoy element to add. ### Deprecated - Deprecated `_decoyCount` option. ### Fixed - Fixed `DisclosureFrame` type definition not to use `unknown`. * Fix src/common.spec.ts imports --------- Co-authored-by: Linas Išganaitis <linas.isganaitis@meeco.me>
Meeco · Oct 1, 2024 · 96057a5 · 96057a5
1 parent c5206ea
commit 96057a5
Show file tree

Hide file tree

Showing 8 changed files with 324 additions and 295 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project (loosely) adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.2.0 - 2024-09-27
+
+### Added
+
+- Added `_sd_decoy` option to specify number of decoy element to add.
+
+### Deprecated
+
+- Deprecated `_decoyCount` option.
+
+### Fixed
+
+- Fixed `DisclosureFrame` type definition not to use `unknown`.
+
 ## 1.1.0 - 2024-08-14
 
 ### Added

diff --git a/README.md b/README.md
@@ -45,14 +45,14 @@ To issue or pack claims into a valid SD-JWT we use Disclosure Frame to define wh
 It follows the following format:
 ```typescript
 type ArrayIndex = number;
-type DisclosureFrame = {
-  [key: string | ArrayIndex]: DisclosureFrame | unknown;
-  _sd?: Array<string | ArrayIndex>;
-  _decoyCount?: number;
+type DisclosureFrameSDAttributes = { _sd?: Array<string | ArrayIndex>; _sd_decoy?: number };
+export type DisclosureFrame =
+  | ({ [key: string | ArrayIndex]: DisclosureFrame } & DisclosureFrameSDAttributes)
+  | DisclosureFrameSDAttributes;
 };
 ```
 
-`_decoyCount` is an optional property that defines the number of decoy digests to add.
+`_sd_decoy` is an optional property that defines the number of decoy digests to add.
 
 ### Examples:
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@meeco/sd-jwt",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "SD-JWT implementation in typescript",
   "scripts": {
     "build": "tsc",
@@ -54,22 +54,22 @@
   "author": "Meeco",
   "devDependencies": {
     "@eslint/eslintrc": "^3.1.0",
-    "@eslint/js": "^9.9.0",
-    "@types/jest": "^29.5.5",
-    "@typescript-eslint/eslint-plugin": "^8.1.0",
-    "@typescript-eslint/parser": "^8.1.0",
-    "esbuild": "^0.23.0",
-    "eslint": "^9.9.0",
+    "@eslint/js": "^9.11.1",
+    "@types/jest": "^29.5.13",
+    "@typescript-eslint/eslint-plugin": "^8.7.0",
+    "@typescript-eslint/parser": "^8.7.0",
+    "esbuild": "^0.24.0",
+    "eslint": "^9.11.1",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.2.1",
     "globals": "^15.9.0",
     "jest": "^29.7.0",
-    "jose": "^5.6.3",
+    "jose": "^5.9.3",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.3.3",
-    "ts-jest": "^29.2.4",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.5.4"
+    "typescript": "^5.6.2"
   }
 }
diff --git a/src/common.spec.ts b/src/common.spec.ts
@@ -10,6 +10,7 @@ import {
   loadVerifiedContents,
 } from './test-utils/helpers';
 import { INVALID_JWT } from './test-utils/params';
+import { DisclosureFrame } from './types';
 
 const examples = getExamples();
 
@@ -74,7 +75,7 @@ describe('packSDJWT', () => {
 
   it('should be able to pack a simple claim', async () => {
     const claims = { id: 123 };
-    const disclosureFrame = { _sd: ['id'] };
+    const disclosureFrame: DisclosureFrame = { _sd: ['id'] };
     const { claims: result, disclosures } = await packSDJWT(claims, disclosureFrame, hasher, { generateSalt });
 
     const disclosureArray = ['salt', 'id', 123];
@@ -87,7 +88,7 @@ describe('packSDJWT', () => {
 
   it('should be able to pack an array', async () => {
     const claims = { items: [1, 2, 3] };
-    const disclosureFrame = {
+    const disclosureFrame: DisclosureFrame = {
       items: { _sd: [0, 1] },
     };
     const { claims: result, disclosures } = await packSDJWT(claims, disclosureFrame, hasher, { generateSalt });
@@ -104,7 +105,7 @@ describe('packSDJWT', () => {
 
   it('should be able to recursively pack an array', async () => {
     const claims = { items: [1, 2, { id: 123 }] };
-    const disclosureFrame = {
+    const disclosureFrame: DisclosureFrame = {
       items: {
         _sd: [0, 2],
         2: { _sd: ['id'] },
@@ -128,7 +129,7 @@ describe('packSDJWT', () => {
 
   it('should be able to pack nested object', async () => {
     const claims = { items: { sub: { iss: 1, aud: 2 } } };
-    const disclosureFrame = {
+    const disclosureFrame: DisclosureFrame = {
       items: {
         sub: {
           _sd: ['iss'],
@@ -157,7 +158,7 @@ describe('packSDJWT', () => {
     const claims = {
       items: [[1, 2], 3],
     };
-    const disclosureFrame = {
+    const disclosureFrame: DisclosureFrame = {
       items: {
         _sd: [0],
         0: { _sd: [0, 1] },
@@ -300,7 +301,16 @@ describe('packSDJWT', () => {
   describe('decoys', () => {
     it('should be able to generate decoys', async () => {
       const claims = { id: 123 };
-      const disclosureFrame = { _sd: ['id'], _decoyCount: 5 };
+      const disclosureFrame: DisclosureFrame = { _sd: ['id'], _sd_decoy: 5 };
+      const { claims: result, disclosures } = await packSDJWT(claims, disclosureFrame, hasher, { generateSalt });
+
+      expect(disclosures.length).toBe(1);
+      expect(result._sd.length).toBe(6);
+    });
+
+    it('still supports old _decoyCount parameter', async () => {
+      const claims = { id: 123 };
+      const disclosureFrame: DisclosureFrame = { _sd: ['id'], _decoyCount: 5 };
       const { claims: result, disclosures } = await packSDJWT(claims, disclosureFrame, hasher, { generateSalt });
 
       expect(disclosures.length).toBe(1);
@@ -309,16 +319,23 @@ describe('packSDJWT', () => {
 
     it('should be able to generate decoys in an array', async () => {
       const claims = { arr: [1, 2, 3] };
-      const disclosureFrame = { arr: { _sd: [0, 1, 2], _decoyCount: 5 } };
+      const disclosureFrame: DisclosureFrame = { arr: { _sd: [0, 1, 2], _sd_decoy: 5 } };
       const { claims: result, disclosures } = await packSDJWT(claims, disclosureFrame, hasher, { generateSalt });
 
       expect(disclosures.length).toBe(3);
       expect(result.arr.length).toBe(8);
     });
 
+    it('throws error if both _sd_decoy and _decoyCount are provided', () => {
+      const claims = { id: 123 };
+      const disclosureFrame: DisclosureFrame = { _sd: ['id'], _sd_decoy: 1, _decoyCount: 2 };
+
+      expect(packSDJWT(claims, disclosureFrame, hasher, { generateSalt })).rejects.toThrow();
+    });
+
     it('should throw an error when provided with a negative decoy count', () => {
       const claims = { id: 123 };
-      const disclosureFrame = { _sd: ['id'], _decoyCount: -5 };
+      const disclosureFrame = { _sd: ['id'], _sd_decoy: -5 };
 
       expect(packSDJWT(claims, disclosureFrame, hasher, { generateSalt })).rejects.toThrow();
     });

diff --git a/src/common.ts b/src/common.ts
@@ -1,4 +1,11 @@
-import { DEFAULT_SD_HASH_ALG, FORMAT_SEPARATOR, SD_DECOY_COUNT, SD_DIGEST, SD_HASH_ALG } from './constants.js';
+import {
+  DEFAULT_SD_HASH_ALG,
+  FORMAT_SEPARATOR,
+  SD_DECOY,
+  SD_DECOY_COUNT,
+  SD_DIGEST,
+  SD_HASH_ALG,
+} from './constants.js';
 import { PackSDJWTError, SDJWTInvalidFormatError } from './errors.js';
 import {
   createDecoy,
@@ -100,6 +107,10 @@ export const packSDJWT: PackSDJWT = async (claims, disclosureFrame, hasher, opti
     throw new PackSDJWTError('no claims found');
   }
 
+  if (SD_DECOY in disclosureFrame && SD_DECOY_COUNT in disclosureFrame) {
+    throw new PackSDJWTError(`${SD_DECOY} and ${SD_DECOY_COUNT} parameters cannot be used together`);
+  }
+
   const sd = disclosureFrame[SD_DIGEST];
 
   let packedClaims;
@@ -110,7 +121,7 @@ export const packSDJWT: PackSDJWT = async (claims, disclosureFrame, hasher, opti
     const recursivelyPackedClaims = {};
 
     for (const key in disclosureFrame) {
-      if (key !== SD_DIGEST && key !== SD_DECOY_COUNT) {
+      if (key !== SD_DIGEST && key !== SD_DECOY && key !== SD_DECOY_COUNT) {
         const idx = parseInt(key);
         const packed = await packSDJWT(claims[idx], disclosureFrame[idx] as DisclosureFrame, hasher, options);
         recursivelyPackedClaims[idx] = packed.claims;
@@ -129,15 +140,19 @@ export const packSDJWT: PackSDJWT = async (claims, disclosureFrame, hasher, opti
       }
     }
 
-    const decoys = createDecoy(disclosureFrame[SD_DECOY_COUNT], hasher, options?.generateSalt);
+    const decoys = createDecoy(
+      disclosureFrame[SD_DECOY] || disclosureFrame[SD_DECOY_COUNT],
+      hasher,
+      options?.generateSalt,
+    );
     decoys.forEach((decoy) => {
       packedClaims.push({ '...': decoy });
     });
   } else {
     packedClaims = {};
     const recursivelyPackedClaims = {};
     for (const key in disclosureFrame) {
-      if (key !== SD_DIGEST && key !== SD_DECOY_COUNT) {
+      if (key !== SD_DIGEST && key !== SD_DECOY && key !== SD_DECOY_COUNT) {
         const packed = await packSDJWT(claims[key], disclosureFrame[key] as DisclosureFrame, hasher, options);
         recursivelyPackedClaims[key] = packed.claims;
         disclosures = disclosures.concat(packed.disclosures);
@@ -157,7 +172,11 @@ export const packSDJWT: PackSDJWT = async (claims, disclosureFrame, hasher, opti
       }
     }
 
-    const decoys = createDecoy(disclosureFrame[SD_DECOY_COUNT], hasher, options?.generateSalt);
+    const decoys = createDecoy(
+      disclosureFrame[SD_DECOY] || disclosureFrame[SD_DECOY_COUNT],
+      hasher,
+      options?.generateSalt,
+    );
     decoys.forEach((decoy) => {
       _sd.push(decoy);
     });

diff --git a/src/constants.ts b/src/constants.ts
@@ -1,6 +1,10 @@
 export const SD_DIGEST = '_sd';
 export const SD_HASH_ALG = '_sd_alg';
+/**
+ * @deprecated use SD_DECOY instead.
+ */
 export const SD_DECOY_COUNT = '_decoyCount';
+export const SD_DECOY = '_sd_decoy';
 export const DEFAULT_SD_HASH_ALG = 'sha-256';
 export const FORMAT_SEPARATOR = '~';
 export const KB_JWT_TYPE_HEADER = 'kb+jwt';

diff --git a/src/types.ts b/src/types.ts
@@ -118,15 +118,21 @@ export interface DisclosureClaim {
 }
 
 type ArrayIndex = number;
-export type DisclosureFrame = {
-  [key: string | ArrayIndex]: DisclosureFrame | unknown;
+type DisclosureFrameSDAttributes = {
   _sd?: Array<string | ArrayIndex>;
+  _sd_decoy?: number;
+  /**
+   * @deprecated use _sd_decoy instead.
+   */
   _decoyCount?: number;
 };
+export type DisclosureFrame =
+  | ({ [key: string | ArrayIndex]: DisclosureFrame } & DisclosureFrameSDAttributes)
+  | DisclosureFrameSDAttributes;
 
 export type PackedClaims = {
   _sd?: Array<string>;
-  [key: string]: any | unknown;
+  [key: string]: any;
 };
 
 export type SelectiveDiscloseableArrayItem = {
@@ -136,11 +142,15 @@ export type SelectiveDiscloseableArrayItem = {
   '...': SelectiveDisclosableClaims | any;
 };
 
-export type SelectiveDisclosableClaims = {
+type SelectiveDisclosableClaimsSDAttributes = {
   // disclosure.string
   _sd?: string;
-  [key: string]: SelectiveDisclosableClaims | Array<SelectiveDiscloseableArrayItem | any> | unknown;
 };
+export type SelectiveDisclosableClaims =
+  | ({
+      [key: string]: SelectiveDisclosableClaims | Array<SelectiveDiscloseableArrayItem | any>;
+    } & SelectiveDisclosableClaimsSDAttributes)
+  | SelectiveDisclosableClaimsSDAttributes;
 
 export type DisclosureMap = {
   [sdDigest: string]: {
@@ -159,7 +169,7 @@ export type GetHasher = (hashAlg: string) => Promise<Hasher>;
 export type Signer = (header: JWTHeaderParameters, payload: JWTPayload) => Promise<string>;
 export type Verifier = (data: string) => Promise<boolean>;
 export type KeyBindingVerifier = (data: string, key: JWK) => Promise<boolean>;
-export type SaltGenerator = (size) => string;
+export type SaltGenerator = (size: number) => string;
 
 export interface IssueSDJWTOptions {
   signer: Signer;