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

package/src/impl/BitstringStatusListImplementation.ts

@@ -1,7 +1,6 @@
 import type { IAgentContext, ICredentialPlugin, ProofFormat as VeramoProofFormat } from '@veramo/core'
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import {
-  type BitstringStatusPurpose,
   CredentialMapper,
   type CredentialProofFormat,
   DocumentFormat,
@@ -13,7 +12,6 @@ import {
 import type { IStatusList } from './IStatusList'
 import {
   BitstringStatus,
-  BitstringStatusResult,
   CheckStatusIndexArgs,
   CreateStatusListArgs,
   StatusListResult,
@@ -23,12 +21,11 @@ import {
 } from '../types'
 
 import { assertValidProofType, getAssertedProperty, getAssertedValue, getAssertedValues } from '../utils'
-import { createList, decodeList } from '@digitalbazaar/vc-bitstring-status-list'
-import { IBitstringStatusList } from '../types/BitstringStatusList'
+import { BitstringStatusListCredential } from '../types/BitstringStatusList'
+import { BitstreamStatusList, BitstringStatusPurpose, createStatusListCredential } from '@4sure-tech/vc-bitstring-status-lists'
 
 export const DEFAULT_LIST_LENGTH = 131072 // W3C spec minimum
 export const DEFAULT_PROOF_FORMAT = 'lds' as CredentialProofFormat
-export const DEFAULT_STATUS_SIZE = 1
 export const DEFAULT_STATUS_PURPOSE: BitstringStatusPurpose = 'revocation'
 
 export class BitstringStatusListImplementation implements IStatusList {
@@ -47,29 +44,28 @@ export class BitstringStatusListImplementation implements IStatusList {
 
     const { issuer, id } = args
     const correlationId = getAssertedValue('correlationId', args.correlationId)
-    const { statusPurpose, statusSize, statusMessage, ttl } = args.bitstringStatusList
-    const list = (await createList({ length })) as IBitstringStatusList
-    const encodedList = await list.encode()
-
+    const { statusPurpose, bitsPerStatus, validFrom, validUntil, ttl } = args.bitstringStatusList
     const statusListCredential = await this.createVerifiableCredential(
       {
         ...args,
-        encodedList,
         proofFormat: veramoProofFormat,
         statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
-        statusSize: statusSize ?? DEFAULT_STATUS_SIZE,
-        statusMessage: statusMessage,
+        validFrom,
+        validUntil,
         ttl,
       },
       context,
     )
 
     return {
-      encodedList,
+      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,
@@ -85,6 +81,10 @@ export class BitstringStatusListImplementation implements IStatusList {
     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
@@ -92,9 +92,8 @@ export class BitstringStatusListImplementation implements IStatusList {
     const origEncodedList = getAssertedProperty('encodedList', credentialSubject)
 
     const index = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
-    const statusList = (await decodeList({ encodedList: origEncodedList })) as IBitstringStatusList
-    statusList.setStatus(index, args.value != 0)
-    const encodedList = await statusList.encode()
+    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'
 
@@ -111,7 +110,7 @@ export class BitstringStatusListImplementation implements IStatusList {
         ...args,
         id,
         issuer,
-        encodedList,
+        statusList,
         proofFormat: proofFormat,
         statusPurpose,
         ttl,
@@ -123,14 +122,15 @@ export class BitstringStatusListImplementation implements IStatusList {
 
     return {
       statusListCredential: updatedCredential,
-      encodedList,
+      encodedList: updatedCredential.credentialSubject.encodedList,
       bitstringStatusList: {
         statusPurpose,
-        validFrom,
-        validUntil,
+        ...(updatedCredential.validFrom && { validFrom: new Date(updatedCredential.validFrom) }),
+        ...(updatedCredential.validUntil && { validUntil: new Date(updatedCredential.validUntil) }),
+        bitsPerStatus: args.bitsPerStatus,
         ttl,
       },
-      length: statusList.length - 1,
+      length: statusList.getLength(),
       type: StatusListType.BitstringStatusList,
       proofFormat: proofFormat,
       id,
@@ -146,28 +146,30 @@ export class BitstringStatusListImplementation implements IStatusList {
     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 = (await decodeList({ encodedList: args.encodedList })) as IBitstringStatusList
+    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 newEncodedList = await statusList.encode()
-    const { statusPurpose, statusSize, statusMessage, ttl, validFrom, validUntil } = args.bitstringStatusList
-
     const credential = await this.createVerifiableCredential(
       {
         id,
         issuer,
-        encodedList: newEncodedList,
+        statusList,
         proofFormat: veramoProofFormat,
         keyRef: args.keyRef,
         statusPurpose,
-        statusSize,
-        statusMessage,
         validFrom,
         validUntil,
         ttl,
@@ -178,14 +180,15 @@ export class BitstringStatusListImplementation implements IStatusList {
     return {
       type: StatusListType.BitstringStatusList,
       statusListCredential: credential,
-      encodedList: newEncodedList,
+      encodedList: credential.credentialSubject.encodedList,
       bitstringStatusList: {
         statusPurpose,
-        validFrom,
-        validUntil,
+        bitsPerStatus,
+        ...(credential.validFrom && { validFrom: new Date(credential.validFrom) }),
+        ...(credential.validUntil && { validUntil: new Date(credential.validUntil) }),
         ttl,
       },
-      length: statusList.length,
+      length: statusList.getLength(),
       proofFormat: args.proofFormat ?? 'lds',
       id: id,
       issuer: issuer,
@@ -193,33 +196,31 @@ export class BitstringStatusListImplementation implements IStatusList {
     }
   }
 
-  async checkStatusIndex(args: CheckStatusIndexArgs): Promise<BitstringStatusResult> {
+  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 subject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject
-    const messageList = (subject as any).statusMessage as Array<Partial<BitstringStatus>>
+    const statusSize = args.bitsPerStatus
+    const statusList = await BitstreamStatusList.decode({ encodedList, statusSize })
 
     const numIndex = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
-    const hexIndex = `0x${numIndex.toString(16)}`
-    const statusMessage = messageList.find((statMsg) => statMsg.status === hexIndex)
-
-    const statusList = (await decodeList({ encodedList })) as IBitstringStatusList
-    if (statusList.length <= numIndex) {
-      throw new Error(`Status list index out of bounds, has ${messageList.length} messages, requested ${numIndex}`)
+    if (statusList.getLength() <= numIndex) {
+      throw new Error(`Status list index out of bounds, has ${statusList.getLength()} entries, requested ${numIndex}`)
     }
-    const value = statusList.getStatus(numIndex)
-    return {
-      index: numIndex,
-      status: hexIndex,
-      message: statusMessage?.message,
-      set: value,
-    } satisfies BitstringStatusResult
+    return statusList.getStatus(numIndex)
   }
 
   async toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult> {
-    const { statusListPayload } = args
+    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)
@@ -230,7 +231,7 @@ export class BitstringStatusListImplementation implements IStatusList {
     const validFrom = uniform.validFrom ? new Date(uniform.validFrom) : undefined
     const validUntil = uniform.validUntil ? new Date(uniform.validUntil) : undefined
     const ttl = credSubject.ttl
-    const list = (await decodeList({ encodedList })) as IBitstringStatusList
+    const statuslistLength: number = BitstreamStatusList.getStatusListLength(encodedList, bitsPerStatus)
 
     return {
       id,
@@ -238,11 +239,12 @@ export class BitstringStatusListImplementation implements IStatusList {
       issuer,
       type: StatusListType.BitstringStatusList,
       proofFormat,
-      length: list.length,
+      length: statuslistLength,
       statusListCredential: statusListPayload,
       statuslistContentType: this.buildContentType(proofFormat),
       bitstringStatusList: {
         statusPurpose,
+        bitsPerStatus,
         validFrom,
         validUntil,
         ttl,
@@ -256,67 +258,32 @@ export class BitstringStatusListImplementation implements IStatusList {
     args: {
       id: string
       issuer: string | IIssuer
-      encodedList: string
+      statusList?: BitstreamStatusList
       proofFormat: VeramoProofFormat
       statusPurpose: BitstringStatusPurpose
-      statusSize?: number
-      statusMessage?: Array<BitstringStatus>
       validFrom?: Date
       validUntil?: Date
       ttl?: number
       keyRef?: string
     },
     context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
-  ): Promise<StatusListCredential> {
+  ): Promise<BitstringStatusListCredential> {
     const identifier = await context.agent.identifierManagedGet({
       identifier: typeof args.issuer === 'string' ? args.issuer : args.issuer.id,
       vmRelationship: 'assertionMethod',
       offlineWhenNoDIDRegistered: true,
     })
 
-    const credentialSubject: any = {
-      id: args.id,
-      type: 'BitstringStatusList',
-      statusPurpose: args.statusPurpose,
-      encodedList: args.encodedList,
-    }
-
-    if (args.statusSize && args.statusSize > 1) {
-      credentialSubject.statusSize = args.statusSize
-    }
-
-    if (args.statusMessage) {
-      credentialSubject.statusMessage = args.statusMessage
-    }
-
-    if (args.validFrom) {
-      credentialSubject.validFrom = args.validFrom
-    }
-
-    if (args.validUntil) {
-      credentialSubject.validUntil = args.validUntil
-    }
-
-    if (args.ttl) {
-      credentialSubject.ttl = args.ttl
-    }
-
-    const credential = {
-      '@context': ['https://www.w3.org/2018/credentials/v1', 'https://www.w3.org/ns/credentials/status/v1'],
-      id: args.id,
-      issuer: args.issuer,
-      type: ['VerifiableCredential', 'BitstringStatusListCredential'],
-      credentialSubject,
-    }
+    const unsignedCredential = await createStatusListCredential(args)
 
     const verifiableCredential = await context.agent.createVerifiableCredential({
-      credential,
+      credential: unsignedCredential,
       keyRef: args.keyRef ?? identifier.kmsKeyRef,
       proofFormat: args.proofFormat,
       fetchRemoteContexts: true,
     })
 
-    return CredentialMapper.toWrappedVerifiableCredential(verifiableCredential as StatusListCredential).original as StatusListCredential
+    return CredentialMapper.toWrappedVerifiableCredential(verifiableCredential as StatusListCredential).original as BitstringStatusListCredential
   }
 
   private buildContentType(proofFormat: CredentialProofFormat | undefined) {

package/src/impl/IStatusList.ts

@@ -1,7 +1,7 @@
 import type { IAgentContext, ICredentialPlugin } from '@veramo/core'
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import {
-  BitstringStatusResult,
+  BitstringStatus,
   CheckStatusIndexArgs,
   CreateStatusListArgs,
   Status2021,
@@ -34,7 +34,7 @@ export interface IStatusList {
   /**
    * Checks the status at a given index in the status list
    */
-  checkStatusIndex(args: CheckStatusIndexArgs): Promise<number | Status2021 | StatusOAuth | BitstringStatusResult>
+  checkStatusIndex(args: CheckStatusIndexArgs): Promise<number | Status2021 | StatusOAuth | BitstringStatus>
 
   /**
    * Collects the status list details

package/src/impl/OAuthStatusList.ts

@@ -113,8 +113,7 @@ export class OAuthStatusListImplementation implements IStatusList {
 
     const listToUpdate = StatusList.decompressStatusList(args.encodedList, bitsPerStatus ?? DEFAULT_BITS_PER_STATUS)
     const index = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
-    // FIXME: See above.
-    listToUpdate.setStatus(index, args.value ? 1 : 0)
+    listToUpdate.setStatus(index, args.value)
 
     const { statusListCredential, encodedList } = await this.createSignedStatusList(
       proofFormat ?? DEFAULT_PROOF_FORMAT,

package/src/impl/StatusList2021.ts

@@ -126,7 +126,7 @@ export class StatusList2021Implementation implements IStatusList {
     const { issuer, id } = getAssertedValues(args)
     const statusList = await StatusList.decode({ encodedList: args.encodedList })
     const index = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
-    statusList.setStatus(index, args.value)
+    statusList.setStatus(index, args.value !== 0)
 
     const newEncodedList = await statusList.encode()
     const credential = await this.createVerifiableCredential(

package/src/types/BitstringStatusList.ts

@@ -1,42 +1,4 @@
-export type BitstringConstructorOptions = {
-  length?: number
-  buffer?: Uint8Array
-  leftToRightIndexing?: boolean
-  littleEndianBits?: boolean // deprecated
-}
+import { StatusListCredential } from '@sphereon/ssi-types'
+import { BitstringStatusListCredentialUnsigned } from '../../../../../vc-bitstring-status-lists'
 
-export type IBitstring = {
-  bits: Uint8Array
-  length: number
-  leftToRightIndexing: boolean
-
-  set(position: number, on: boolean): void
-  get(position: number): boolean
-  encodeBits(): Promise<string>
-  compressBits(): Promise<Uint8Array>
-}
-
-export type BitstringStatic = {
-  new (options?: BitstringConstructorOptions): IBitstring
-  decodeBits(options: { encoded: string }): Promise<Uint8Array>
-  uncompressBits(options: { compressed: Uint8Array }): Promise<Uint8Array>
-}
-
-export type BitstringStatusListConstructorOptions = {
-  length?: number
-  buffer?: Uint8Array
-}
-
-export type IBitstringStatusList = {
-  bitstring: IBitstring
-  length: number
-
-  setStatus(index: number, status: boolean): void
-  getStatus(index: number): boolean
-  encode(): Promise<string>
-}
-
-export type BitstringStatusListStatic = {
-  new (options?: BitstringStatusListConstructorOptions): IBitstringStatusList
-  decode(options: { encodedList: string }): Promise<IBitstringStatusList>
-}
+export type BitstringStatusListCredential = BitstringStatusListCredentialUnsigned & StatusListCredential

package/src/types/index.ts

@@ -1,6 +1,5 @@
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import {
-  BitstringStatusPurpose,
   type CredentialProofFormat,
   type ICredential,
   type ICredentialStatus,
@@ -27,6 +26,7 @@ import { DataSource } from 'typeorm'
 import type { BitsPerStatus } from '@sd-jwt/jwt-status-list'
 import type { SdJwtVcPayload } from '@sd-jwt/sd-jwt-vc'
 import type { StatusListOpts } from '@sphereon/oid4vci-common'
+import { BitstringStatusPurpose } from '@4sure-tech/vc-bitstring-status-lists'
 
 export enum StatusOAuth {
   Valid = 0,
@@ -39,19 +39,7 @@ export enum Status2021 {
   Invalid = 1,
 }
 
-export type BitstringStatus = {
-  status: string
-  message?: string
-  [x: string]: any
-}
-
-export type BitstringStatusResult = BitstringStatus & {
-  index: number
-  status: string
-  set: boolean
-  message?: string
-  [x: string]: any
-}
+export type BitstringStatus = number
 
 export type StatusList2021Args = {
   indexingDirection: StatusListIndexingDirection
@@ -66,8 +54,7 @@ export type OAuthStatusListArgs = {
 
 export type BitstringStatusListArgs = {
   statusPurpose: BitstringStatusPurpose
-  statusSize?: number
-  statusMessage?: Array<BitstringStatus>
+  bitsPerStatus: number
   ttl?: number
   validFrom?: Date
   validUntil?: Date
@@ -83,6 +70,7 @@ export type BaseCreateNewStatusListArgs = {
   keyRef?: string
   statusList2021?: StatusList2021Args
   oauthStatusList?: OAuthStatusListArgs
+  bitstringStatusList?: BitstringStatusListArgs
   driverType?: StatusListDriverType
 }
 
@@ -97,8 +85,7 @@ export type UpdateOAuthStatusListArgs = {
 
 export type UpdateBitstringStatusListArgs = {
   statusPurpose: BitstringStatusPurpose
-  statusSize?: number
-  statusMessage?: Array<BitstringStatus>
+  bitsPerStatus: number
   validFrom?: Date
   validUntil?: Date
   ttl?: number
@@ -107,7 +94,7 @@ export type UpdateBitstringStatusListArgs = {
 export interface UpdateStatusListFromEncodedListArgs {
   type?: StatusListType
   statusListIndex: number | string
-  value: boolean
+  value: number
   proofFormat?: CredentialProofFormat
   keyRef?: string
   correlationId?: string
@@ -157,6 +144,7 @@ interface OAuthStatusDetails {
 
 interface BitstringStatusDetails {
   statusPurpose: BitstringStatusPurpose
+  bitsPerStatus: number
   validFrom?: Date
   validUntil?: Date
   ttl?: number
@@ -182,7 +170,7 @@ export interface BitstringStatusListEntryCredentialStatus extends ICredentialSta
   statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
   statusListIndex: string
   statusListCredential: string
-  statusSize?: number
+  bitsPerStatus?: number
   statusMessage?: Array<BitstringStatus>
   statusReference?: string | string[]
 }
@@ -213,6 +201,7 @@ export interface UpdateStatusListIndexArgs {
   statusListCredential: StatusListCredential // | CompactJWT
   statusListIndex: number | string
   value: number | Status2021 | StatusOAuth | BitstringStatus
+  bitsPerStatus?: number
   keyRef?: string
   expiresAt?: Date
 }
@@ -220,12 +209,14 @@ export interface UpdateStatusListIndexArgs {
 export interface CheckStatusIndexArgs {
   statusListCredential: StatusListCredential // | CompactJWT
   statusListIndex: string | number
+  bitsPerStatus?: number
 }
 
 export interface ToStatusListDetailsArgs {
   statusListPayload: StatusListCredential
   correlationId?: string
   driverType?: StatusListDriverType
+  bitsPerStatus?: number
 }
 
 /**

package/src/utils.ts

@@ -11,7 +11,7 @@ import { jwtDecode } from 'jwt-decode'
 
 export function getAssertedStatusListType(type?: StatusListType) {
   const assertedType = type ?? StatusListType.StatusList2021
-  if (![StatusListType.StatusList2021, StatusListType.OAuthStatusList].includes(assertedType)) {
+  if (![StatusListType.StatusList2021, StatusListType.OAuthStatusList, StatusListType.BitstringStatusList].includes(assertedType)) {
     throw Error(`StatusList type ${assertedType} is not supported (yet)`)
   }
   return assertedType
@@ -41,6 +41,7 @@ export function getAssertedProperty<T extends object>(propertyName: string, obj:
 const ValidProofTypeMap = new Map<StatusListType, CredentialProofFormat[]>([
   [StatusListType.StatusList2021, ['jwt', 'lds']],
   [StatusListType.OAuthStatusList, ['jwt', 'cbor']],
+  [StatusListType.BitstringStatusList, ['lds']],
 ])
 
 export function assertValidProofType(type: StatusListType, proofFormat: CredentialProofFormat) {