@sphereon/ssi-sdk.vc-status-list 0.34.0 → 0.34.1-feature.SSISDK.17.bitstring.sl.11

package/src/functions.ts

@@ -1,8 +1,8 @@
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import {
   CredentialMapper,
-  DocumentFormat,
   type CredentialProofFormat,
+  DocumentFormat,
   type StatusListCredential,
   StatusListDriverType,
   StatusListType,
@@ -10,14 +10,20 @@ import {
 } from '@sphereon/ssi-types'
 import type { CredentialStatus, DIDDocument, IAgentContext, ICredentialPlugin, ProofFormat as VeramoProofFormat } from '@veramo/core'
 
+import { IAddStatusListArgs, IBitstringStatusListEntryEntity, IStatusListEntryEntity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
+
 import { checkStatus } from '@sphereon/vc-status-list'
 
 // @ts-ignore
 import { CredentialJwtOrJSON, StatusMethod } from 'credential-status'
 import {
+  BitstringStatus,
+  BitstringStatusListEntryCredentialStatus,
   CreateNewStatusListFuncArgs,
   Status2021,
+  StatusList2021EntryCredentialStatus,
   StatusList2021ToVerifiableCredentialArgs,
+  StatusListOAuthEntryCredentialStatus,
   StatusListResult,
   StatusOAuth,
   UpdateStatusListFromEncodedListArgs,
@@ -117,7 +123,7 @@ export async function checkStatusForCredential(args: {
     return { verified: true }
   }
   if ('credentialStatus' in uniform && uniform.credentialStatus) {
-    if (uniform.credentialStatus.type === 'StatusList2021Entry') {
+    if (uniform.credentialStatus.type === 'StatusList2021Entry' || uniform.credentialStatus.type === 'BitstringStatusListEntry') {
       return checkStatus({ ...args, verifyStatusListCredential, verifyMatchingIssuers })
     } else if (args?.errorUnknownListType) {
       const error = `Credential status type ${uniform.credentialStatus.type} is not supported, and check status has been configured to not allow for that`
@@ -136,7 +142,7 @@ export async function simpleCheckStatusFromStatusListUrl(args: {
   type?: StatusListType | 'StatusList2021Entry'
   id?: string
   statusListIndex: string
-}): Promise<number | Status2021 | StatusOAuth> {
+}): Promise<number | Status2021 | StatusOAuth | BitstringStatus> {
   return checkStatusIndexFromStatusListCredential({
     ...args,
     statusListCredential: await fetchStatusListCredential(args),
@@ -145,11 +151,12 @@ export async function simpleCheckStatusFromStatusListUrl(args: {
 
 export async function checkStatusIndexFromStatusListCredential(args: {
   statusListCredential: StatusListCredential
-  statusPurpose?: StatusPurpose2021
-  type?: StatusListType | 'StatusList2021Entry'
+  statusPurpose?: StatusPurpose2021 | string | string[]
+  type?: StatusListType | 'StatusList2021Entry' | 'BitstringStatusListEntry'
   id?: string
   statusListIndex: string | number
-}): Promise<number | Status2021 | StatusOAuth> {
+  bitsPerStatus?: number
+}): Promise<number | Status2021 | StatusOAuth | BitstringStatus> {
   const statusListType: StatusListType = determineStatusListType(args.statusListCredential)
   const implementation = getStatusListImplementation(statusListType)
   return implementation.checkStatusIndex(args)
@@ -174,13 +181,18 @@ export async function updateStatusIndexFromStatusListCredential(
   return implementation.updateStatusListIndex(args, context)
 }
 
-// Keeping helper function for backward compatibility
-export async function statusListCredentialToDetails(args: {
+export async function statusListCredentialToDetails({
+  correlationId,
+  driverType,
+  statusListCredential,
+  bitsPerStatus,
+}: {
   statusListCredential: StatusListCredential
   correlationId?: string
   driverType?: StatusListDriverType
-}): Promise<StatusListResult> {
-  const credential = getAssertedValue('statusListCredential', args.statusListCredential)
+  bitsPerStatus?: number
+}): Promise<StatusListResult & Partial<IAddStatusListArgs>> {
+  const credential = getAssertedValue('statusListCredential', statusListCredential)
 
   let statusListType: StatusListType | undefined
   const documentFormat = CredentialMapper.detectDocumentType(credential)
@@ -197,7 +209,7 @@ export async function statusListCredentialToDetails(args: {
   }
   if (!statusListType) {
     const uniform = CredentialMapper.toUniformCredential(credential)
-    const type = uniform.type.find((t) => t.includes('StatusList2021') || t.includes('OAuth2StatusList'))
+    const type = uniform.type.find((t) => t.includes('StatusList2021') || t.includes('OAuth2StatusList') || t.includes('BitstringStatusList'))
     if (!type) {
       throw new Error('Invalid status list credential type')
     }
@@ -205,10 +217,34 @@ export async function statusListCredentialToDetails(args: {
   }
 
   const implementation = getStatusListImplementation(statusListType)
-  return await implementation.toStatusListDetails({
+
+  // The implementation should now return all the type-specific fields needed for the entity
+  const result = await implementation.toStatusListDetails({
     statusListPayload: credential,
-    correlationId: args.correlationId,
-    driverType: args.driverType,
+    correlationId: correlationId,
+    driverType: driverType,
+    bitsPerStatus: bitsPerStatus,
+  })
+
+  return result
+}
+
+export async function createCredentialStatusFromStatusList(args: {
+  statusList: StatusListEntity
+  statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity
+  statusListIndex: number
+}): Promise<StatusList2021EntryCredentialStatus | StatusListOAuthEntryCredentialStatus | BitstringStatusListEntryCredentialStatus> {
+  const { statusList, statusListEntry, statusListIndex } = args
+
+  // Determine the status list type and delegate to appropriate implementation
+  const statusListType = determineStatusListType(statusList.statusListCredential!)
+  const implementation = getStatusListImplementation(statusListType)
+
+  // Each implementation should have a method to create credential status
+  return implementation.createCredentialStatus({
+    statusList,
+    statusListEntry,
+    statusListIndex,
   })
 }
 

package/src/impl/BitstringStatusListImplementation.ts

@@ -0,0 +1,347 @@
+import type { IAgentContext, ICredentialPlugin, ProofFormat as VeramoProofFormat } from '@veramo/core'
+import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
+
+import {
+  CredentialMapper,
+  type CredentialProofFormat,
+  DocumentFormat,
+  type IIssuer,
+  type StatusListCredential,
+  StatusListType,
+} from '@sphereon/ssi-types'
+
+import type { IBitstringStatusListImplementationResult, IStatusList } from './IStatusList'
+import {
+  BitstringStatus,
+  BitstringStatusListEntryCredentialStatus,
+  CheckStatusIndexArgs,
+  CreateStatusListArgs,
+  StatusListResult,
+  ToStatusListDetailsArgs,
+  UpdateStatusListFromEncodedListArgs,
+  UpdateStatusListIndexArgs,
+} from '../types'
+
+import { assertValidProofType, ensureDate, getAssertedProperty, getAssertedValue, getAssertedValues } from '../utils'
+import { BitstringStatusListCredential } from '../types/BitstringStatusList'
+import { BitstreamStatusList, BitstringStatusPurpose, createStatusListCredential } from '@4sure-tech/vc-bitstring-status-lists'
+import { BitstringStatusListEntity, IBitstringStatusListEntryEntity, IStatusListEntryEntity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
+
+export const DEFAULT_LIST_LENGTH = 131072 // W3C spec minimum
+export const DEFAULT_PROOF_FORMAT = 'lds' as CredentialProofFormat
+export const DEFAULT_STATUS_PURPOSE: BitstringStatusPurpose = 'revocation'
+
+export class BitstringStatusListImplementation implements IStatusList {
+  async createNewStatusList(
+    args: CreateStatusListArgs,
+    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  ): Promise<StatusListResult> {
+    if (!args.bitstringStatusList) {
+      throw new Error('BitstringStatusList options are required for type BitstringStatusList')
+    }
+
+    const length = args?.length ?? DEFAULT_LIST_LENGTH
+    const proofFormat: CredentialProofFormat = args?.proofFormat ?? DEFAULT_PROOF_FORMAT
+    assertValidProofType(StatusListType.BitstringStatusList, proofFormat)
+    const veramoProofFormat: VeramoProofFormat = proofFormat as VeramoProofFormat
+
+    const { issuer, id } = args
+    const correlationId = getAssertedValue('correlationId', args.correlationId)
+    const { statusPurpose, bitsPerStatus, validFrom, validUntil, ttl } = args.bitstringStatusList
+    const statusListCredential = await this.createVerifiableCredential(
+      {
+        ...args,
+        proofFormat: veramoProofFormat,
+        statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
+        validFrom: ensureDate(validFrom),
+        validUntil: ensureDate(validUntil),
+        ttl,
+      },
+      context,
+    )
+
+    return {
+      encodedList: statusListCredential.credentialSubject.encodedList,
+      statusListCredential: statusListCredential,
+      bitstringStatusList: {
+        statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
+        ...(statusListCredential.validFrom && { validFrom: new Date(statusListCredential.validFrom) }),
+        ...(statusListCredential.validUntil && { validUntil: new Date(statusListCredential.validUntil) }),
+        ttl,
+        bitsPerStatus,
+      },
+      length,
+      type: StatusListType.BitstringStatusList,
+      proofFormat,
+      id,
+      correlationId,
+      issuer,
+      statuslistContentType: this.buildContentType(proofFormat),
+    }
+  }
+
+  async updateStatusListIndex(
+    args: UpdateStatusListIndexArgs,
+    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  ): Promise<StatusListResult> {
+    if (!args.bitsPerStatus || args.bitsPerStatus < 1) {
+      return Promise.reject('bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (updateStatusListIndex)')
+    }
+
+    const credential = args.statusListCredential
+    const uniform = CredentialMapper.toUniformCredential(credential)
+    const { issuer, credentialSubject } = uniform
+    const id = getAssertedValue('id', uniform.id)
+    const origEncodedList = getAssertedProperty('encodedList', credentialSubject)
+
+    const index = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
+    const statusList: BitstreamStatusList = await BitstreamStatusList.decode({ encodedList: origEncodedList, statusSize: args.bitsPerStatus })
+    statusList.setStatus(index, args.value)
+
+    const proofFormat = CredentialMapper.detectDocumentType(credential) === DocumentFormat.JWT ? 'jwt' : 'lds'
+
+    const credSubject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject
+
+    const statusPurpose = getAssertedProperty('statusPurpose', credSubject)
+
+    const validFrom = uniform.validFrom ? new Date(uniform.validFrom) : undefined
+    const validUntil = uniform.validUntil ? new Date(uniform.validUntil) : undefined
+    const ttl = credSubject.ttl
+
+    const updatedCredential = await this.createVerifiableCredential(
+      {
+        ...args,
+        id,
+        issuer,
+        statusList,
+        proofFormat: proofFormat,
+        statusPurpose,
+        ttl,
+        validFrom,
+        validUntil,
+      },
+      context,
+    )
+
+    return {
+      statusListCredential: updatedCredential,
+      encodedList: updatedCredential.credentialSubject.encodedList,
+      bitstringStatusList: {
+        statusPurpose,
+        ...(updatedCredential.validFrom && { validFrom: new Date(updatedCredential.validFrom) }),
+        ...(updatedCredential.validUntil && { validUntil: new Date(updatedCredential.validUntil) }),
+        bitsPerStatus: args.bitsPerStatus,
+        ttl,
+      },
+      length: statusList.getLength(),
+      type: StatusListType.BitstringStatusList,
+      proofFormat: proofFormat,
+      id,
+      issuer,
+      statuslistContentType: this.buildContentType(proofFormat),
+    }
+  }
+
+  async updateStatusListFromEncodedList(
+    args: UpdateStatusListFromEncodedListArgs,
+    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  ): Promise<StatusListResult> {
+    if (!args.bitstringStatusList) {
+      throw new Error('bitstringStatusList options required for type BitstringStatusList')
+    }
+
+    if (args.bitstringStatusList.bitsPerStatus < 1) {
+      return Promise.reject('bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (updateStatusListFromEncodedList)')
+    }
+
+    const { statusPurpose, bitsPerStatus, ttl, validFrom, validUntil } = args.bitstringStatusList
+
+    const proofFormat: CredentialProofFormat = args?.proofFormat ?? DEFAULT_PROOF_FORMAT
+    assertValidProofType(StatusListType.BitstringStatusList, proofFormat)
+    const veramoProofFormat: VeramoProofFormat = proofFormat as VeramoProofFormat
+
+    const { issuer, id } = getAssertedValues(args)
+    const statusList: BitstreamStatusList = await BitstreamStatusList.decode({ encodedList: args.encodedList, statusSize: bitsPerStatus })
+    const index = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
+    statusList.setStatus(index, args.value)
+
+    const credential = await this.createVerifiableCredential(
+      {
+        id,
+        issuer,
+        statusList,
+        proofFormat: veramoProofFormat,
+        keyRef: args.keyRef,
+        statusPurpose,
+        validFrom: ensureDate(validFrom),
+        validUntil: ensureDate(validUntil),
+        ttl,
+      },
+      context,
+    )
+
+    return {
+      type: StatusListType.BitstringStatusList,
+      statusListCredential: credential,
+      encodedList: credential.credentialSubject.encodedList,
+      bitstringStatusList: {
+        statusPurpose,
+        bitsPerStatus,
+        ...(credential.validFrom && { validFrom: new Date(credential.validFrom) }),
+        ...(credential.validUntil && { validUntil: new Date(credential.validUntil) }),
+        ttl,
+      },
+      length: statusList.getLength(),
+      proofFormat: args.proofFormat ?? 'lds',
+      id: id,
+      issuer: issuer,
+      statuslistContentType: this.buildContentType(proofFormat),
+    }
+  }
+
+  async checkStatusIndex(args: CheckStatusIndexArgs): Promise<BitstringStatus> {
+    if (!args.bitsPerStatus || args.bitsPerStatus < 1) {
+      return Promise.reject('bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (checkStatusIndex)')
+    }
+
+    const uniform = CredentialMapper.toUniformCredential(args.statusListCredential)
+    const { credentialSubject } = uniform
+    const encodedList = getAssertedProperty('encodedList', credentialSubject)
+
+    const statusSize = args.bitsPerStatus
+    const statusList = await BitstreamStatusList.decode({ encodedList, statusSize })
+
+    const numIndex = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
+    if (statusList.getLength() <= numIndex) {
+      throw new Error(`Status list index out of bounds, has ${statusList.getLength()} entries, requested ${numIndex}`)
+    }
+    return statusList.getStatus(numIndex)
+  }
+
+  async toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult & IBitstringStatusListImplementationResult> {
+    const { statusListPayload, bitsPerStatus } = args
+    if (!bitsPerStatus || bitsPerStatus < 1) {
+      return Promise.reject('bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (toStatusListDetails)')
+    }
+
+    const uniform = CredentialMapper.toUniformCredential(statusListPayload)
+    const { issuer, credentialSubject } = uniform
+    const id = getAssertedValue('id', uniform.id)
+    const encodedList = getAssertedProperty('encodedList', credentialSubject)
+    const proofFormat: CredentialProofFormat = CredentialMapper.detectDocumentType(statusListPayload) === DocumentFormat.JWT ? 'jwt' : 'lds'
+    const credSubject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject
+    const statusPurpose = getAssertedProperty('statusPurpose', credSubject)
+    const validFrom = uniform.validFrom ? new Date(uniform.validFrom) : undefined
+    const validUntil = uniform.validUntil ? new Date(uniform.validUntil) : undefined
+    const ttl = credSubject.ttl
+    const statuslistLength: number = BitstreamStatusList.getStatusListLength(encodedList, bitsPerStatus)
+
+    return {
+      // Base implementation fields
+      id,
+      encodedList,
+      issuer,
+      type: StatusListType.BitstringStatusList,
+      proofFormat,
+      length: statuslistLength,
+      statusListCredential: statusListPayload,
+      statuslistContentType: this.buildContentType(proofFormat),
+      correlationId: args.correlationId, // FIXME these do not need to be inside the impl
+      driverType: args.driverType, // FIXME these do not need to be inside the impl
+
+      // Flattened Bitstring-specific fields
+      statusPurpose,
+      bitsPerStatus,
+      ...(validFrom && { validFrom }),
+      ...(validUntil && { validUntil }),
+      ...(ttl && { ttl }),
+
+      // Legacy nested structure for backward compatibility
+      bitstringStatusList: {
+        statusPurpose,
+        bitsPerStatus,
+        ...(validFrom && { validFrom }),
+        ...(validUntil && { validUntil }),
+        ...(ttl && { ttl }),
+      },
+
+      // Optional fields from args
+      ...(args.correlationId && { correlationId: args.correlationId }),
+      ...(args.driverType && { driverType: args.driverType }),
+    }
+  }
+
+  async createCredentialStatus(args: {
+    statusList: StatusListEntity
+    statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity
+    statusListIndex: number
+  }): Promise<BitstringStatusListEntryCredentialStatus> {
+    const { statusList, statusListEntry, statusListIndex } = args
+
+    // Type guard to ensure we have a bitstring entry
+    const isBitstringEntry = (entry: IStatusListEntryEntity | IBitstringStatusListEntryEntity): entry is IBitstringStatusListEntryEntity => {
+      return 'statusPurpose' in entry
+    }
+
+    if (!isBitstringEntry(statusListEntry)) {
+      throw new Error('Expected bitstring status list entry for bitstring status list')
+    }
+
+    // Cast to BitstringStatusListEntity to access specific properties
+    const bitstringStatusList = statusList as BitstringStatusListEntity
+
+    return {
+      id: `${statusList.id}#${statusListIndex}`,
+      type: 'BitstringStatusListEntry',
+      statusPurpose: statusListEntry.statusPurpose,
+      statusListIndex: '' + statusListIndex,
+      statusListCredential: statusList.id,
+      bitsPerStatus: bitstringStatusList.bitsPerStatus,
+    } satisfies BitstringStatusListEntryCredentialStatus
+  }
+
+  private async createVerifiableCredential(
+    args: {
+      id: string
+      issuer: string | IIssuer
+      statusList?: BitstreamStatusList
+      proofFormat: VeramoProofFormat
+      statusPurpose: BitstringStatusPurpose
+      validFrom?: Date
+      validUntil?: Date
+      ttl?: number
+      keyRef?: string
+    },
+    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  ): Promise<BitstringStatusListCredential> {
+    const identifier = await context.agent.identifierManagedGet({
+      identifier: typeof args.issuer === 'string' ? args.issuer : args.issuer.id,
+      vmRelationship: 'assertionMethod',
+      offlineWhenNoDIDRegistered: true,
+    })
+
+    const unsignedCredential = await createStatusListCredential(args)
+
+    const verifiableCredential = await context.agent.createVerifiableCredential({
+      credential: unsignedCredential,
+      keyRef: args.keyRef ?? identifier.kmsKeyRef,
+      proofFormat: args.proofFormat,
+      fetchRemoteContexts: true,
+    })
+
+    return CredentialMapper.toWrappedVerifiableCredential(verifiableCredential as StatusListCredential).original as BitstringStatusListCredential
+  }
+
+  private buildContentType(proofFormat: CredentialProofFormat | undefined) {
+    switch (proofFormat) {
+      case 'jwt':
+        return `application/statuslist+jwt`
+      case 'cbor':
+        return `application/statuslist+cwt`
+      case 'lds':
+        return 'application/statuslist+ld+json'
+      default:
+        throw Error(`Unsupported content type '${proofFormat}' for status lists`)
+    }
+  }
+}

package/src/impl/IStatusList.ts

@@ -1,15 +1,30 @@
 import type { IAgentContext, ICredentialPlugin } from '@veramo/core'
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
-import type {
+import {
+  BitstringStatus,
+  BitstringStatusListEntryCredentialStatus,
   CheckStatusIndexArgs,
   CreateStatusListArgs,
   Status2021,
+  StatusList2021EntryCredentialStatus,
+  StatusListOAuthEntryCredentialStatus,
   StatusListResult,
   StatusOAuth,
   ToStatusListDetailsArgs,
   UpdateStatusListFromEncodedListArgs,
   UpdateStatusListIndexArgs,
 } from '../types'
+import { BitstringStatusPurpose } from '@4sure-tech/vc-bitstring-status-lists'
+import {
+  CredentialProofFormat,
+  IIssuer,
+  StatusListCredential,
+  StatusListDriverType,
+  StatusListIndexingDirection,
+  StatusListType,
+  StatusPurpose2021,
+} from '@sphereon/ssi-types'
+import { IBitstringStatusListEntryEntity, IStatusListEntryEntity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
 
 export interface IStatusList {
   /**
@@ -33,10 +48,57 @@ export interface IStatusList {
   /**
    * Checks the status at a given index in the status list
    */
-  checkStatusIndex(args: CheckStatusIndexArgs): Promise<number | Status2021 | StatusOAuth>
+  checkStatusIndex(args: CheckStatusIndexArgs): Promise<number | Status2021 | StatusOAuth | BitstringStatus>
 
   /**
-   * Collects the status list details
+   * Collects the status list details - returns flattened entity data ready for storage
    */
-  toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult>
+  toStatusListDetails(
+    args: ToStatusListDetailsArgs,
+  ): Promise<
+    StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)
+  >
+
+  /**
+   * Creates a credential status object from a status list and entry
+   */
+  createCredentialStatus(args: {
+    statusList: StatusListEntity
+    statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity
+    statusListIndex: number
+  }): Promise<StatusList2021EntryCredentialStatus | StatusListOAuthEntryCredentialStatus | BitstringStatusListEntryCredentialStatus>
+}
+
+export interface IStatusListImplementationResult {
+  id: string
+  encodedList: string
+  issuer: string | IIssuer
+  type: StatusListType
+  proofFormat: CredentialProofFormat
+  length: number
+  statusListCredential: StatusListCredential
+  statuslistContentType: string
+  correlationId?: string
+  driverType?: StatusListDriverType
+}
+
+export interface IStatusList2021ImplementationResult extends IStatusListImplementationResult {
+  type: StatusListType.StatusList2021
+  indexingDirection: StatusListIndexingDirection
+  statusPurpose: StatusPurpose2021
+}
+
+export interface IOAuthStatusListImplementationResult extends IStatusListImplementationResult {
+  type: StatusListType.OAuthStatusList
+  bitsPerStatus: number
+  expiresAt?: Date
+}
+
+export interface IBitstringStatusListImplementationResult extends IStatusListImplementationResult {
+  type: StatusListType.BitstringStatusList
+  statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
+  bitsPerStatus?: number
+  validFrom?: Date
+  validUntil?: Date
+  ttl?: number
 }