fix: typing and other minor issues while verifying Bitstring status list credential

Signed-off-by: Krishna Waske <[email protected]>

Author: GHkrishna

packages/core/src/modules/vc/models/credential/w3c-credential-status/W3cCredentialStatus.ts

@@ -1,15 +1,22 @@
 import { plainToInstance } from 'class-transformer'
-import { IsString, validateOrReject } from 'class-validator'
+import { IsEnum, IsString, validateOrReject } from 'class-validator'
 
 import { AgentContext } from '../../../../../agent/context'
 import { CredoError } from '../../../../../error'
 import { IsUri } from '../../../../../utils/validators'
 
+import { BitStringStatusListEntry } from './bitstring-status-list/BitStringStatusList'
+import { verifyBitStringCredentialStatus } from './bitstring-status-list/VerifyBitStringCredentialStatus'
+
 export interface W3cCredentialStatusOptions {
   id: string
   type: string
 }
 
+export enum W3cCredentialStatusSupportedTypes {
+  BitstringStatusListEntry = 'BitstringStatusListEntry',
+}
+
 export class W3cCredentialStatus {
   public constructor(options: W3cCredentialStatusOptions) {
     if (options) {
@@ -23,6 +30,7 @@ export class W3cCredentialStatus {
   public id!: string
 
   @IsString()
+  @IsEnum(W3cCredentialStatusSupportedTypes, { message: 'Invalid credential status type' })
   public type!: string
 }
 
@@ -31,15 +39,43 @@ export const validateStatus = async (
   status: W3cCredentialStatus | W3cCredentialStatus[],
   agentContext: AgentContext
 ): Promise<boolean> => {
-  const entry = plainToInstance(W3cCredentialStatus, status)
+  let entry
+
+  if (Array.isArray(status)) {
+    agentContext.config.logger.debug('Credential status type is array')
+    throw new CredoError(
+      'Invalid credential status type. Currently only a single credentialStatus is supported per credential'
+    )
+  } else entry = status
+
+  switch (entry.type) {
+    case W3cCredentialStatusSupportedTypes.BitstringStatusListEntry:
+      agentContext.config.logger.debug('Credential status type is BitstringStatusListEntry')
+      entry = plainToInstance(BitStringStatusListEntry, entry)
+      break
+    default:
+      throw new CredoError(
+        `Invalid credential status type. Supported types are: ${Object.values(W3cCredentialStatusSupportedTypes).join(
+          ', '
+        )}`
+      )
+  }
 
   try {
     await validateOrReject(entry)
+    switch (entry.type) {
+      case W3cCredentialStatusSupportedTypes.BitstringStatusListEntry:
+        await verifyBitStringCredentialStatus(entry, agentContext)
+        break
+      default:
+        throw new CredoError(
+          `Invalid credential status type. Supported types are: ${Object.values(W3cCredentialStatusSupportedTypes).join(
+            ', '
+          )}`
+        )
+    }
     return true
   } catch (errors) {
-    agentContext.config.logger.debug(`Credential status validation failed: ${errors}`, {
-      stack: errors,
-    })
-    throw new CredoError(`Invalid credential status type: ${errors}`)
+    throw new CredoError(`Error while validating credential status`, errors)
   }
 }

packages/core/src/modules/vc/models/credential/w3c-credential-status/bitstring-status-list/BitStringStatusList.ts

@@ -2,13 +2,13 @@ import { Type } from 'class-transformer'
 import { IsEnum, IsNumber, IsString } from 'class-validator'
 
 import { JsonLdCredentialDetail, W3cCredentialSubject } from '../../../../../..'
-import { W3cCredential } from '../../W3cCredential'
+import { W3cCredential, W3cCredentialOptions } from '../../W3cCredential'
 import { W3cCredentialStatus } from '../W3cCredentialStatus'
 
 // The purpose can be anything apart from this as well
 export enum BitstringStatusListCredentialStatusPurpose {
-  'revocation' = 'revocation',
-  'suspension' = 'suspension',
+  Revocation = 'revocation',
+  Suspension = 'suspension',
 }
 
 export interface BitStringStatusListMessageOptions {
@@ -36,16 +36,23 @@ export class BitStringStatusListMessage {
   [key: string]: unknown | undefined
 }
 
+/**
+ * Status list Entry, used to check status of a credential being issued or verified during presentaton.
+ *
+ * @see https://www.w3.org/TR/vc-bitstring-status-list/#bitstringstatuslistentry
+ */
 export class BitStringStatusListEntry extends W3cCredentialStatus {
-  public constructor(options: {
-    id: string
-    serviceEndpoint: string
-    recipientKeys: string[]
-    routingKeys?: string[]
-    accept?: string[]
-    priority?: number
-  }) {
+  public constructor(options: IBitStringStatusListEntryOptions) {
     super({ ...options, type: BitStringStatusListEntry.type })
+
+    if (options) {
+      this.statusPurpose = options.statusPurpose
+      this.statusListCredential = options.statusListCredential
+      this.statusListIndex = options.statusListIndex
+
+      if (options.statusSize) this.statusSize = options.statusSize
+      if (options.statusMessage) this.statusMessage = options.statusMessage
+    }
   }
   public static type = 'BitstringStatusListEntry'
 
@@ -75,12 +82,11 @@ export interface BitStringStatusListStatusMessage {
   [key: string]: unknown
 }
 
-export interface IBitStringStatusListCredentialStatus {
+export interface IBitStringStatusListEntryOptions {
   id: string
-  // Since currenlty we are only trying to support 'BitStringStatusListEntry'
   type: 'BitstringStatusListEntry'
   statusPurpose: BitstringStatusListCredentialStatusPurpose
-  // Unique identifier for the specific credential
+  // Unique identifier for specific credential
   statusListIndex: string
   // Must be url referencing to a VC of type 'BitstringStatusListCredential'
   statusListCredential: string
@@ -105,28 +111,33 @@ export class BitStringStatusListCredentialDetail extends JsonLdCredentialDetail
   public credential!: BitStringStatusListCredentialStatus
 }
 
+/**
+ * StatusListCredential describes the format of the verifiable credential that encapsulates the status list.
+ *
+ * @see https://www.w3.org/TR/vc-bitstring-status-list/#bitstringstatuslistcredential
+ */
 export class BitStringStatusListCredential extends W3cCredential {
-  public constructor(options: {
-    id: string
-    serviceEndpoint: string
-    recipientKeys: string[]
-    routingKeys?: string[] | undefined
-    accept?: string[]
-    priority?: number
-    issuer: string
-    issuanceDate: string
-    credentialSubject: BitStringStatusListCredentialSubject
-  }) {
+  public constructor(options: IBitStringStatusListCredentialOptions) {
     super({
       ...options,
-      type: ['VerifiableCredential', BitStringStatusListEntry.type],
+      type: BitStringStatusListCredential.type,
     })
+
+    if (options) {
+      this.credentialSubject = options.credentialSubject
+    }
   }
+  public static type = ['VerifiableCredential', 'BitstringStatusListCredential']
 
   @IsString()
   public credentialSubject!: BitStringStatusListCredentialSubject
 }
 
+export interface IBitStringStatusListCredentialOptions extends Omit<W3cCredentialOptions, 'credentialStatus'> {
+  type: ['VerifiableCredential', 'BitstringStatusListCredential']
+  credentialSubject: BitStringStatusListCredentialSubject
+}
+
 // Define an interface for `credentialSubject`
 export interface BitStringStatusListCredentialSubject extends W3cCredentialSubject {
   type: 'BitstringStatusList'

packages/core/src/modules/vc/models/credential/w3c-credential-status/bitstring-status-list/VerifyBitStringCredentialStatus.ts

@@ -1,10 +1,9 @@
-import type { BitStringStatusListCredentialStatus, BitStringStatusListCredential } from './BitStringStatusList'
+import type { BitStringStatusListCredential, BitStringStatusListEntry } from './BitStringStatusList'
 import type { AgentContext } from '../../../../../../agent/context'
 
 import * as pako from 'pako'
 
 import { CredoError } from '../../../../../../error'
-import { validateStatus } from '../W3cCredentialStatus'
 
 // Function to fetch and parse the bit string status list credential
 const fetchBitStringStatusListCredential = async (
@@ -14,7 +13,7 @@ const fetchBitStringStatusListCredential = async (
   const response = await agentContext.config.agentDependencies.fetch(url, { method: 'GET' })
 
   if (!response.ok) {
-    throw new CredoError(`Failed to fetch bit string status list. HTTP Status: ${response.status}`)
+    throw new CredoError(`Failed to fetch BitStringStatusListCredential status list. HTTP Status: ${response.status}`)
   }
 
   try {
@@ -25,24 +24,14 @@ const fetchBitStringStatusListCredential = async (
 }
 
 export const verifyBitStringCredentialStatus = async (
-  credential: BitStringStatusListCredentialStatus,
+  credentialStatus: BitStringStatusListEntry,
   agentContext: AgentContext
 ) => {
-  const { credentialStatus } = credential
-
   if (Array.isArray(credentialStatus)) {
-    throw new CredoError('Verifying credential status as an array for JSON-LD credentials is currently not supported')
-  }
-
-  if (!credentialStatus || credentialStatus.statusListIndex === undefined) {
-    throw new CredoError('Invalid credential status format')
-  }
-
-  // Validate credentialStatus using the class-based approach
-  const isValid = await validateStatus(credentialStatus, agentContext)
-
-  if (!isValid) {
-    throw new CredoError('Invalid credential status type. Expected BitstringStatusList')
+    agentContext.config.logger.debug('Credential status type is array')
+    throw new CredoError(
+      'Invalid credential status type. Currently only a single BitstringStatusListEntry is supported per credential'
+    )
   }
 
   // Fetch the bit string status list credential