credential-bbs #1408

veromassera · 2024-08-05T23:36:51Z

What issue is this PR fixing

This plugin implements a verifiable credential provider with BBS signature.
This provider enables the issuing of credentials and the generation of presentations from BBS signatures.

It also offers the ability to verify credentials and presentations.

This type of credential allows the holder to share credentials containing only a selected portion of the original VC data through selective disclosure, giving the holders real control over which data is shared.

The plugin extends the Veramo agent with the functionality of createSelectiveDisclosureCredentialBbs and verifyDerivedProofBbs.

This implementation is built on top of the jsonld-signatures-bbs libraries provided by mattrglobal https://github.com/mattrglobal/jsonld-signatures-bbs

Quality

Check all that apply:

I want these changes to be integrated
I successfully ran pnpm i, pnpm build, pnpm test, pnpm test:browser locally.
I allow my PR to be updated by the reviewers (to speed up the review process).
I added unit tests.
I added integration tests.
I did not add automated tests because _________, and I am aware that a PR without tests will likely get rejected.

codecov-commenter · 2024-08-06T16:33:42Z

Codecov Report

Attention: Patch coverage is 71.77673% with 359 lines in your changes missing coverage. Please review.

Project coverage is 88.89%. Comparing base (dbb2880) to head (6077e92).

Files with missing lines	Patch %	Lines
packages/credential-bbs/src/custom-key-manager.ts	49.37%	122 Missing ⚠️
packages/credential-bbs/src/types.ts	0.00%	74 Missing ⚠️
...ckages/credential-bbs/src/CredentialProviderBBS.ts	81.81%	58 Missing ⚠️
...ckages/credential-bbs/src/bbs-credential-module.ts	80.29%	53 Missing ⚠️
packages/credential-bbs/src/index.ts	0.00%	16 Missing ⚠️
...kages/credential-bbs/src/suites/BbsBlsSignature.ts	90.74%	10 Missing ⚠️
.../credential-bbs/src/module-types/jsonld/index.d.ts	0.00%	8 Missing ⚠️
packages/credential-bbs/src/bbs-suites.ts	87.27%	7 Missing ⚠️
packages/credential-bbs/src/bbs-suite-loader.ts	87.50%	5 Missing ⚠️
...edential-bbs/src/bbs-selective-diclosure-plugin.ts	92.15%	4 Missing ⚠️
... and 1 more

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #1408      +/-   ##
==========================================
- Coverage   89.69%   88.89%   -0.81%     
==========================================
  Files         177      189      +12     
  Lines       26937    28209    +1272     
  Branches     2228     2337     +109     
==========================================
+ Hits        24161    25076     +915     
- Misses       2776     3133     +357

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

veromassera · 2024-08-06T17:29:14Z

Hi @nickreynolds.
The tests ran successfully, however, other tests unrelated to this PR are failing.
There's a timeout in 'browser tests' and another failure in 'REST integration tests › DID discovery › should discover did by alias and profile vc'

How do we proceed?

nickreynolds · 2024-08-08T16:53:25Z

@veromassera the test failure appears related to a dependency issue in browser.

Module not found: Error: Can't resolve 'vm' in '/home/runner/work/veramo/veramo/node_modules/.pnpm/[email protected]/node_modules/asn1.js/lib/asn1'

I see that the package you're relying on that brings in this dependency should work in all environments, but there might be some resolution issue that needs to be addressed. Perhaps @mirceanis has more insight

veromassera · 2024-08-08T17:11:57Z

Hi @nickreynolds . You're right. I only saw the timeout log.

veromassera · 2024-08-14T11:55:16Z

Hey @nickreynolds, any updates on this? Did you get a chance to look it over? Does the implementation and design of the plugin look good to you?"

nickreynolds · 2024-08-19T15:48:58Z

@veromassera the implementation and design looks pretty much good, but we haven't had a chance to look into the dependency issue yet. Hopefully we can sometime this week, but if you make any progress on it, let us know

nickreynolds · 2024-08-19T23:58:25Z

@veromassera I took a quick look. Didn't find the solution, but I did notice that your pnpm lockfile is generated with an incorrect version of pnpm. Make sure you're using pnpm v9

veromassera · 2024-08-21T16:05:43Z

Hi @nickreynolds.

I've been reviewing the package.json configuration and I believe I've resolved the asn1 error. Please verify if the fix is correct.

However, another error still remains: 'Conflicting values for 'process.env.NODE_ENV'.
I believe this issue is beyond my scope and might be related to some pipeline configuration.
Regards

veromassera · 2024-08-28T13:48:44Z

Hi @nickreynolds ,

I've tried everything I can think of to get the tests to pass, but I haven't been successful.

In fact, to try and isolate the issues, I created a new PR called 'PR generated to test if all tests work' that has no code differences from the Next branch. I ran the tests on GitHub and they're failing as well. :(

I would appreciate it if you could take a look at the tests when you have a chance, as I'm stuck at this point

nickreynolds · 2024-09-05T13:06:20Z

@veromassera the tests failing on next have been fixed, so you should feel free to rebase this branch and see if your tests pass

veromassera · 2024-09-05T15:08:11Z

Hi @nickreynolds , here's something I don't know why it's happening... just in case you can help me.

In the "PR generated to test if all tests work" there is an error that also occurs in the credential-bbs PR, related to process.node_env in the "browser_test" tests

The big difference is that after that error in your PR the entire test suite is then executed, but in my PR (credential-bbs) the tests are not executed.

Any suggestions? It must be related to React Native compatibility)

nickreynolds · 2024-09-05T15:27:38Z

@veromassera the error about ReactDOM.render being deprecated does not cause issues and can be ignored (but I can put up a PR to remove that error anyways). I believe the process.env error is the only one you should be concerned with since that's the only difference in the logs

veromassera · 2024-09-05T15:51:47Z

The process env error also occurs in the next branch... and in PR generated to test if all tests work
You can see it here
https://github.com/decentralized-identity/veramo/actions/runs/10721883324/job/29731621266?pr=1417

line 143 of "run browser test" log

However, after that error, the tests run on your branches and are not executed on the credential-bbs PR.

stale · 2024-11-09T02:13:53Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

veromassera · 2025-01-09T18:32:21Z

Hi @nickreynolds ,

I've tried everything I can think of to get the tests to pass, but I haven't been successful.

In fact, to try and isolate the issues, I created a new PR called 'PR generated to test if all tests work' that has no code differences from the Next branch. I ran the tests on GitHub and they're failing as well. :(

I would appreciate it if you could take a look at the tests when you have a chance, as I'm stuck at this point

@nickreynolds @mirceanis
Hi guys, how are you? Long time no see!

I'm trying to get back to the credential-bbs PR (#1408), trying to see if the dependency error no longer exists with the new code updates.
I synced the repo, and I'm still getting errors in the test-browser.

Also, to rule out possible errors in my code, I synced the "Test next" PR (#1436). It's a PR with no changes, just one character in the readme. I'm using it to run continuous integration tests, and this PR, which has no changes, is also failing in the test-browser.
Could you please review it?

Once the next code passes all the tests, I'll sync my code again and see if all the tests pass in my PR. Does that sound good?

I hope you're all doing well. Best regards,

nickreynolds · 2025-01-09T21:20:37Z

hey @veromassera , I'm going to try to take a look at this sometime in the next few days. Your approach sounds good though and thanks for sticking with this! I will get back to you soon

nickreynolds · 2025-01-13T16:21:40Z

@veromassera we merged a PR that should fix the issue you were seeing on the test deployment, so you should be unblocked now. Let me know if you still see issues

veromassera · 2025-01-13T21:01:59Z

@veromassera the tests failing on next have been fixed, so you should feel free to rebase this branch and see if your tests pass

Hi @nickreynolds, this is amazing.
Fortunately, it worked.
All the tests passed.
In this PR, there is the package for BBS credentials. There are also several tests for you to verify the functionality.
I hope you find it useful and wish to proceed with the merge

veromassera · 2025-01-17T13:35:14Z

Hi @nickreynolds , how are you?
I have a question... I don't need to do anything else, right?
Now it's up to you to merge this PR or not?
I just want to confirm that you are aware that the PR compiles and passes all the tests correctly.
Just having some kind of acknowledgment from you is enough for me. Best regards.

nickreynolds · 2025-01-17T16:21:46Z

@veromassera Mircea is reviewing this PR and will likely have some feedback for changes. I also was going to ask you to update the test-react-app so that it includes creating and verifying a BBS+ credential, so that we are sure this package works in browser.

we will also need to check that it works on React Native, but we can do that outside of this repository.

veromassera · 2025-01-17T17:55:26Z

Okay, I will add the tests inside test-react-app

nickreynolds · 2025-01-17T21:22:09Z

packages/credential-bbs/src/custom-key-manager.ts

+    }
+  }
+
+  async keyManagerGetKey({ kid }: IKeyManagerGetArgs) {


@veromassera could you explain why this method is needed? The name is a bit confusing and it lacks a return type. If it's really necessary, we should probably just update the key-manager plugin instead of creating a 1-off

I was just reviewing that name.
I’m about to change it to BBSKeyManager.
Just to provide context on where it is used.
The reason I created it is because I need the private key in the getSuiteForSigning method of VeramoBbsBlsSignature.
On the other hand, if I remember correctly (I developed this quite some time ago), in the KeyManagementSystem class, the sign method retrieves the manageKey from the keyStore, but then goes through a series of nested if statements where it checks the type, and that is not scaling correctly for BBS type keys.
My intention was to deliver the BBS package with this CustomKeyManager, since from this extension I’m creating, I cannot modify the sign method of KeyManagementSystem because it belongs to the core of VERAMO. "I didn't want the need for a change in the core to block me.
I’m about to submit some changes where I added tests in react-app.
Among these changes, I am modifying that name from CustomKeyManager to BBSKeyManager.
If you don’t want me to submit it, please let me know soon. Thank you.

nickreynolds · 2025-01-17T21:38:42Z

packages/credential-bbs/src/__tests__/issue-verify-flow-bbs.test.ts

+
+        ],
+      })
+    issuer = await agent.didManagerGetByAlias({ alias: 'sepolia_1' })


how do the issuer and holder have bbs keys?

The CreateKey of the KeyManagementSystem from Veramo has a switch for the key type, and that also doesn't scale well for BBS type keys. For that reason, when creating the keys, I modified the code to include the BBS type in the switch. However, I did not include that in the BBS credentials package

I used the class I created called 'MIALocalSourceKeyManagementSystem' extending from LocalSourceKeyManagementSystem. I am attaching it.
mia-local-source-kms.zip

veromassera · 2025-01-20T14:45:11Z

hi @nickreynolds .
I just pushed some changes to the PR branch. I changed the name of key manager and added integration tests

veromassera added 19 commits September 5, 2024 10:40

credential-bbs

2acf5ad

add lock file

abf79ae

skip database ignore

452fc08

undo select test

3e99057

console log in server to debug database path

5acb7be

log path

ebe487d

path fixed

0033b28

fixed

da09cd4

reprocess jobs

cb47f9c

reprocess jobs

7bd2d46

upgrade pnpm

0eb178b

vm setting

dc5e9ec

install vm-browserify

89baa3d

clean warnings

088fc94

browserify

8ff5e09

clean resolve

4dda794

reprocess

9006e44

reprocess

3230d76

readme

00c7a3f

veromassera force-pushed the credential-bbs branch from f48ec4f to 00c7a3f Compare September 5, 2024 13:44

stale bot added the wontfix This will not be worked on label Nov 9, 2024

stale bot closed this Nov 16, 2024

mirceanis added pinned don't close this just for being stale and removed wontfix This will not be worked on labels Nov 17, 2024

mirceanis reopened this Nov 17, 2024

veromassera added 6 commits January 3, 2025 21:29

Merge remote-tracking branch 'upstream/next' into credential-bbs

8b26374

reprocess

dff6c2f

replace pnpm-lock

9083b77

update imports

37a8d90

upgrade ethers version

39ba4e7

reprocess

fc551a5

Merge remote-tracking branch 'upstream/next' into credential-bbs

6077e92

nickreynolds requested review from mirceanis and nickreynolds January 16, 2025 01:57

nickreynolds reviewed Jan 17, 2025

View reviewed changes

rename key-manager and add integration tests

58329f5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

credential-bbs #1408

credential-bbs #1408

veromassera commented Aug 5, 2024

codecov-commenter commented Aug 6, 2024 •

edited

Loading

veromassera commented Aug 6, 2024

nickreynolds commented Aug 8, 2024

veromassera commented Aug 8, 2024

veromassera commented Aug 14, 2024

nickreynolds commented Aug 19, 2024

nickreynolds commented Aug 19, 2024

veromassera commented Aug 21, 2024

veromassera commented Aug 28, 2024

nickreynolds commented Sep 5, 2024

veromassera commented Sep 5, 2024 •

edited

Loading

nickreynolds commented Sep 5, 2024

veromassera commented Sep 5, 2024

stale bot commented Nov 9, 2024

veromassera commented Jan 9, 2025 •

edited

Loading

nickreynolds commented Jan 9, 2025

nickreynolds commented Jan 13, 2025

veromassera commented Jan 13, 2025

veromassera commented Jan 17, 2025

nickreynolds commented Jan 17, 2025

veromassera commented Jan 17, 2025

nickreynolds Jan 17, 2025

veromassera Jan 17, 2025

nickreynolds Jan 17, 2025 •

edited

Loading

veromassera Jan 17, 2025

veromassera Jan 17, 2025

veromassera commented Jan 20, 2025

credential-bbs #1408

Are you sure you want to change the base?

credential-bbs #1408

Conversation

veromassera commented Aug 5, 2024

What issue is this PR fixing

Quality

codecov-commenter commented Aug 6, 2024 • edited Loading

Codecov Report

veromassera commented Aug 6, 2024

nickreynolds commented Aug 8, 2024

veromassera commented Aug 8, 2024

veromassera commented Aug 14, 2024

nickreynolds commented Aug 19, 2024

nickreynolds commented Aug 19, 2024

veromassera commented Aug 21, 2024

veromassera commented Aug 28, 2024

nickreynolds commented Sep 5, 2024

veromassera commented Sep 5, 2024 • edited Loading

nickreynolds commented Sep 5, 2024

veromassera commented Sep 5, 2024

stale bot commented Nov 9, 2024

veromassera commented Jan 9, 2025 • edited Loading

nickreynolds commented Jan 9, 2025

nickreynolds commented Jan 13, 2025

veromassera commented Jan 13, 2025

veromassera commented Jan 17, 2025

nickreynolds commented Jan 17, 2025

veromassera commented Jan 17, 2025

nickreynolds Jan 17, 2025

Choose a reason for hiding this comment

veromassera Jan 17, 2025

Choose a reason for hiding this comment

nickreynolds Jan 17, 2025 • edited Loading

Choose a reason for hiding this comment

veromassera Jan 17, 2025

Choose a reason for hiding this comment

veromassera Jan 17, 2025

Choose a reason for hiding this comment

veromassera commented Jan 20, 2025

codecov-commenter commented Aug 6, 2024 •

edited

Loading

veromassera commented Sep 5, 2024 •

edited

Loading

veromassera commented Jan 9, 2025 •

edited

Loading

nickreynolds Jan 17, 2025 •

edited

Loading