feat: support w3c revocation #2072

GHkrishna · 2024-10-29T08:12:32Z

What

This PR introduces support for W3C credential revocation. The following changes have been made:

Refactor functionality for Verify Credential and Verify Presentation.
Integrated with the Bit String Status List for checking and updating credential status.

How

Revocation Flow: Implemented the revocation flow by checking a credential status and updating the credential issuance process to handle revocable credentials.
Integration: Integrated the new revocation features with the existing system, ensuring compatibility and proper handling of revoked credentials.

TO DO:

Validation of revocable Bitstring Status List Entry in a w3cCredential
Create and maintain BitstringStatusList Credential~
- Update signature related models
  ~~- [ ] Keep track of occupied and/or free spaces in the BSLC~~
  ~~- [ ] Endpoints to create and post(host) a BitstringStatusList Credential~~
Issue a revocable credential (including BitStringStatusListEntry)
- Update issuance related models
- Ability to accept a revocable credential (without modifying existing BSLC).
  (However, ability to verify signature of fetched credential is required)
  ~~- [ ] Update records as per occupied (both locally as well as on the server)~~
  ~~- [ ] Revoking(change status of) a w3cCredential (issued by issuer or others capable of revoking the credential)~~
Revocation notification: Ability to notify holder about change in status
Add tags, etc in revocable credentials?
(Might add some related taxs)
Add test cases

changeset-bot · 2024-10-29T08:12:35Z

⚠️ No Changeset found

Latest commit: 3ab1d73

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

GHkrishna · 2024-10-29T08:14:13Z

Hello @TimoGlastra, wanting to create a separate PR for w3c revocation, due to some conflicts in the original PR #2024 .
The work until now, I have updated with the origin authors name.

I'll start with integrating the changes you suggested

packages/core/src/modules/vc/W3cCredentialService.ts

...ules/vc/models/credential/w3c-credential-status/bitstring-status-list/BitStringStatusList.ts

GHkrishna · 2025-02-13T15:03:40Z

Some concerns:

Where to manage occupied/empty index?
Should credo create/update BSLC?
During revocation how to manage indexes to revoke?

Current approach:

Do we need to do this?

GHkrishna · 2025-04-07T18:48:55Z

As per the discussion in the community call(with @TimoGlastra and @genaris ), the index allocation logic and the logic to revoke credential should be part of the revokers preference and credo must only be responsible for signing the BitSting status list credential and issuing a revocable credential containing a valid credential status property.

Apologies as the PR is getting de-prioritized from my end. Looking forward to your reviews

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

Signed-off-by: Krishna Waske <[email protected]> feat: support w3c revocation Signed-off-by: Krishna Waske <[email protected]> chore: verify credential status Signed-off-by: Krishna Waske <[email protected]> chore: rearrange files Signed-off-by: Krishna Waske <[email protected]> chore: remove unnecessary code from credentials API Signed-off-by: Krishna Waske <[email protected]> chore: remove unnecessary code from credentials API Signed-off-by: Krishna Waske <[email protected]> chore: remove bitstring specific credential status from jsonld cred formats Signed-off-by: Krishna Waske <[email protected]> chore: add appropriate format based error Signed-off-by: Krishna Waske <[email protected]> chore: rename symbol Signed-off-by: Krishna Waske <[email protected]> chore: update folder name Signed-off-by: Krishna Waske <[email protected]> fix: typing and other minor issues while verifying Bitstring status list credential Signed-off-by: Krishna Waske <[email protected]> chore: add named imports from pako Signed-off-by: Krishna Waske <[email protected]> chore: update error for verifying bit string status list credential Signed-off-by: Krishna Waske <[email protected]> chore: move validate status logic to libraries Signed-off-by: Krishna Waske <[email protected]> refactor: Invalidate array of bitStringStatusListCredential Signed-off-by: Krishna Waske <[email protected]> refactor: export files from index Signed-off-by: Krishna Waske <[email protected]> refactor: separate bitstring statuslist and bitstring status list credential Signed-off-by: Krishna Waske <[email protected]> feat: add CredentialStatusBasedOnType Signed-off-by: Krishna Waske <[email protected]> reactor: remove duplicate code Signed-off-by: Krishna Waske <[email protected]> chore: add comment Signed-off-by: Krishna Waske <[email protected]> fix: add credential status compare while verifyReceivedCredentialMatchesRequest Signed-off-by: Krishna Waske <[email protected]> fix: remove credentialStatus from unsupported fields while accepting request Signed-off-by: Krishna Waske <[email protected]> fix: imports Signed-off-by: Krishna Waske <[email protected]> chore: update imports Signed-off-by: Krishna Waske <[email protected]> fix: imports Signed-off-by: Krishna Waske <[email protected]> chore: update minor type changes Signed-off-by: Krishna Waske <[email protected]> fix: remove unnecessary tranformation Signed-off-by: Krishna Waske <[email protected]> fix: verification of bitstring status list credential after fetching Signed-off-by: Krishna Waske <[email protected]> chore: push pnpm-lock file Signed-off-by: Krishna Waske <[email protected]> fix: take claimformat from options instead of from credential record, which might not always be present Signed-off-by: Krishna Waske <[email protected]> fix: completed TODO Signed-off-by: Krishna Waske <[email protected]> fix: check signature of fetched credential, w3cjwt support Signed-off-by: Krishna Waske <[email protected]>

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

…ocation separated from credo Signed-off-by: Krishna Waske <[email protected]>

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

GHkrishna · 2025-05-19T05:10:27Z

Hello @genaris @TimoGlastra
Need your feedback on the PR, since, it has a risk of getting stale.

I understand you guys are quite occupied with all the interesting work going on in credo. Since this PR is quite raw, your feedback is quite essential to accommodate changes based on them.

Thank you once again.

genaris

Thanks @GHkrishna ! In general it looks good to me, as it is a good first step to support Bitstring Status lists.

I think it would be good to add some tests as well.

...ules/vc/models/credential/w3c-credential-status/bitstring-status-list/BitStringStatusList.ts

packages/didcomm/src/modules/credentials/formats/jsonld/JsonLdCredentialFormat.ts

genaris · 2025-06-05T12:56:44Z

packages/core/package.json

    "lru_map": "^0.4.1",
    "make-error": "^1.3.6",
    "object-inspect": "^1.10.3",
+    "pako": "^2.1.0",


Does pako work fine in react native? How does it compare with other modules such as fflate? I'm asking this because we want core to be as smaller as possible and it looks like pako is a bit heavy.

Okay, that's a good suggestion, I'm all in on keeping core as small as possible,
Pako did work fine with an android device.
I was not aware about fflate, will have a look at it.

Pako is also used by SD-JWT JS library, works in react native, and since we already depend on it is maybe not a bad choice. I have no idea on the size .

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

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

GHkrishna · 2025-06-07T11:01:02Z

I think it would be good to add some tests as well.

Yes sure, I just wanted to make sure, we are on the right track before starting with the test cases. I think this is a good time to start now.

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

GHkrishna · 2025-06-23T04:54:51Z

Ariel, currently I'm adding testcases for revocable credential in addition to that of the existing ones(non-revocable w3c) instead of replacing/editing them.

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

TimoGlastra · 2024-12-22T11:46:56Z

...ules/vc/models/credential/w3c-credential-status/bitstring-status-list/BitStringStatusList.ts

+  'revocation' = 'revocation',
+  'suspension' = 'suspension',


Suggested change

'revocation' = 'revocation',

'suspension' = 'suspension',

Revocation = 'revocation',

Suspension = 'suspension',

TimoGlastra · 2024-12-22T11:47:55Z

...ules/vc/models/credential/w3c-credential-status/bitstring-status-list/BitStringStatusList.ts

+// // Define an interface for the `credential` object that uses `CredentialSubject`
+// export interface Credential {
+//   credentialSubject: CredentialSubject
+// }
+
+// // Use the `Credential` interface within `BitStringStatusListCredential`
+// export interface BitStringStatusListCredential {
+//   credential: Credential
+// }


Can you remove unused code?

TimoGlastra · 2024-12-22T11:48:48Z

...ules/vc/models/credential/w3c-credential-status/bitstring-status-list/BitStringStatusList.ts

+    })
+  }
+
+  @IsString()


This shouldn't be a string? It's an object right?

TimoGlastra · 2024-12-22T11:50:13Z

...ls/credential/w3c-credential-status/bitstring-status-list/VerifyBitStringCredentialStatus.ts

+  }
+
+  try {
+    return (await response.json()) as BitStringStatusListCredential


The bitstrintstatuslistcredential is a class. We should transform and validate the json to a class instance

TimoGlastra · 2024-12-22T11:50:58Z

packages/core/src/modules/vc/jwt-vc/W3cJwtCredentialService.ts

+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  public async revokeCredential(_agentContext: AgentContext, _options: RevokeCredentialOptions) {
+    // revoke jwt cred
+    throw new CredoError(`Revocation support not implemented for jwtVc`)


Why add these methods if both jwt and jsonld are not implemented?

TimoGlastra · 2025-08-14T13:36:52Z

packages/core/package.json

    "lru_map": "^0.4.1",
    "make-error": "^1.3.6",
    "object-inspect": "^1.10.3",
+    "pako": "^2.1.0",


Pako is also used by SD-JWT JS library, works in react native, and since we already depend on it is maybe not a bad choice. I have no idea on the size .

TimoGlastra · 2025-09-25T13:40:57Z

@GHkrishna could you update the PR with the latest main, and fix the CI tests?

genaris mentioned this pull request Nov 21, 2024

feat: support w3c revocation #2024

Closed

GHkrishna marked this pull request as ready for review December 3, 2024 03:19

GHkrishna force-pushed the feat/support-w3c-revocation branch from b2e1d60 to 078c43c Compare December 3, 2024 03:23

GHkrishna marked this pull request as draft December 4, 2024 05:16

GHkrishna marked this pull request as ready for review December 22, 2024 09:24

GHkrishna marked this pull request as draft December 23, 2024 04:36

sairanjit suggested changes Dec 24, 2024

View reviewed changes

packages/core/src/modules/vc/W3cCredentialService.ts Outdated Show resolved Hide resolved

...ules/vc/models/credential/w3c-credential-status/bitstring-status-list/BitStringStatusList.ts Outdated Show resolved Hide resolved

GHkrishna force-pushed the feat/support-w3c-revocation branch from 535cdbd to f5671a7 Compare January 13, 2025 05:38

GHkrishna marked this pull request as ready for review March 27, 2025 13:30

GHkrishna requested a review from a team as a code owner March 27, 2025 13:30

GHkrishna force-pushed the feat/support-w3c-revocation branch from 9786c84 to 22a8462 Compare April 7, 2025 18:32

GHkrishna and others added 8 commits April 9, 2025 03:21

chore: add missing test script in package-core

10c8696

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

Merge branch 'openwallet-foundation:main' into main

c6d050d

fix: rebasing conflicts

c50074e

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

fix: as discussed in the call we would need to keep the logic for rev…

60dd875

…ocation separated from credo Signed-off-by: Krishna Waske <[email protected]>

fix: as discussed in the call we would need to keep the logic for rev…

178ca90

…ocation separated from credo Signed-off-by: Krishna Waske <[email protected]>

chore: remove comments

59f49ed

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

fix: remove unnecessay imports

748731e

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

GHkrishna force-pushed the feat/support-w3c-revocation branch from f44a16a to 748731e Compare April 17, 2025 18:12

GHkrishna mentioned this pull request Apr 24, 2025

W3C revocation raise PR to credo-ts credebl/platform#970

Open

3 tasks

TimoGlastra requested review from TimoGlastra and genaris April 24, 2025 13:51

genaris requested changes Jun 5, 2025

View reviewed changes

fix: consistency with other interface

2941920

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

GHkrishna added 3 commits June 7, 2025 16:20

fix: expose CredentialStatusBasedOnType to easily access it

6fdad0f

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

chore: remove commented code

5454eda

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

Merge branch 'main' into feat/support-w3c-revocation

3f4e03b

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

GHkrishna added 2 commits June 23, 2025 10:17

fix: import path change

8c2dc94

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

fix: add and fix existing test cases

1100c63

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

GHkrishna added 2 commits June 23, 2025 10:54

fix: package lock

05ea39e

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

fix: linting issues

3ab1d73

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

TimoGlastra reviewed Sep 25, 2025

View reviewed changes

feat: support w3c revocation #2072

Are you sure you want to change the base?

feat: support w3c revocation #2072

Uh oh!

Conversation

GHkrishna commented Oct 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

How

TO DO:

Uh oh!

changeset-bot bot commented Oct 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

GHkrishna commented Oct 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GHkrishna commented Feb 13, 2025

Some concerns:

Current approach:

Do we need to do this?

Uh oh!

GHkrishna commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GHkrishna commented May 19, 2025

Uh oh!

genaris left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GHkrishna Jun 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

GHkrishna commented Jun 7, 2025

Uh oh!

GHkrishna commented Jun 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TimoGlastra commented Sep 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

GHkrishna commented Oct 29, 2024 •

edited

Loading

changeset-bot bot commented Oct 29, 2024 •

edited

Loading

GHkrishna commented Oct 29, 2024 •

edited

Loading

GHkrishna commented Apr 7, 2025 •

edited

Loading

GHkrishna Jun 7, 2025 •

edited

Loading