[V3] Upgrade ACC-based encryption + JWT signing #145

hwrdtm · 2023-06-14T23:08:24Z

What

Closes LIT-804.
Closes LIT-695.
Related to LIT-951.

⚠️ This is a massive PR. Brace yourself with some 🍿 and 🍵 !! ⚠️

This PR:

Deserves a major version bump. We are completely overhauling the ACC-based encryption and JWT signing schemes with new schemes, and are bringing in a number of incompatible changes.
ID-based encryption: This new scheme is also known as Timelock Encryption, or TimeCrypt, where there exists an Identity Parameter, and the signature over it is a decryption key over a ciphertext that has been generated with this Identity Parameter. In other words, signature shares - with the Identity Parameter as the signature payload - are combined into a signature, and this signature can be used to decrypt an associated ciphertext. Read more in the spec here: https://www.notion.so/litprotocol/Switch-from-Signcryption-to-BLS-signature-is-key-scheme-b75c21927ed64511b523c8a93b870a65.
- Note that the encryption step is non-interactive and happens entirely client-side.
ACC-based JWT Signing (V2): This new scheme simplifies the overall flow by baking into each dapp endpoint the required access control conditions directly. This means that there is no "store signing condition" step as dapp developers just write it into their dapp code and an additional check against the access control condition is performed there. When clients request for a signed JWT with claims of the specified access control condition, the signature of this JWT is only provided when the nodes determine that the user satisfy this access control condition. Read more in the spec here: https://www.notion.so/litprotocol/ACC-based-JWT-signing-V2-a4db1446bac54eea90b7ab08e5455246.
The BLS WASM (bls-sdk.ts) is entirely replaced with new code. Unit tests are added to this package.
The SDK no longer supports the jalapeno network moving forward. Developers can use the old SDK versions to continue using the old encryption and JWT signing schemes. serrano network is the new default.
Updated crypto package to be a lightweight wrapper over bls-sdk package with minor conversion logic.
Updated encryption package to replace the old encryption + JWT signing logic with the new schemes. This is becoming more a helper library over lit-node-client-nodejs and crypto.
Refactored params-validators to use a plugin-based approach with various *Validators.
Updated all manual tests in apps/html to use the new ID-based encryption and JWT signing schemes. You will notice quite a few test cases are removed since we no longer need to store encryption keys, or store signing conditions respectively.
demo-encrypt-decrypt-react:
- Turned this into a TS project.
- Updated this demo to use the new ID-based encryption scheme - just a encryptString and decryptToString call.
Implement demo-locked-express-app to demo the new JWT signing flow. Instructions in its README.md.
Made use of generics in a number of places, eg. IEither, SuccessNodePromises and benchmark()

Testing

A large number of HTML manual tests have been tested (against local network)
E2E tests pass
Unit tests pass

TODO

Re-test demo-encrypt-decrypt-react after rebasing
Re-test demo-locked-express-app after rebasing
Update demo-encrypt-decrypt-react/package.json to use newly published SDK version.
Update demo-locked-express-app/package.json to use newly published SDK version.
Remove support for serrano too and introduce cayenne as the new default.

vercel · 2023-06-14T23:08:27Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
html-test-app-lit-js-sdk-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 11, 2023 5:44pm

hwrdtm · 2023-06-14T23:09:54Z

packages/bls-sdk/src/lib/bls-sdk.d.ts

@@ -0,0 +1,47 @@
+/**


the types don't seem to be linking properly...

hwrdtm · 2023-06-21T01:15:36Z

cypress/e2e/spec.cy.ts

-      await savedParams.litNodeClient.saveEncryptionKey({
+describe('Encrypt and Decrypt', () => {
+  it('encrypts', async () => {
+    cy.window().then(async () => {


I'm not sure why, but without wrapping each functionality with this cy.window() the wasm is undefined and not initialized

hwrdtm · 2023-06-24T18:11:05Z

apps/demo-encrypt-decrypt-react/package.json

@@ -4,13 +4,18 @@
  "private": true,
  "dependencies": {
    "@lit-protocol/lit-node-client": "^2.1.158",


TODO: need to update version once published.

hwrdtm · 2023-06-24T18:11:25Z

apps/demo-locked-express-app/package.json

+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "@lit-protocol/lit-node-client-nodejs": "file:../../packages/lit-node-client-nodejs",


TODO: need to update version once published.

hwrdtm · 2023-06-25T00:02:42Z

Not sure why CI is failing, can't repro locally too with npx nx run auth-helpers:test

apps/demo-locked-express-app/index.ts

apps/demo-encrypt-decrypt-react/src/App.tsx

apps/demo-locked-express-app/index.ts

Ansonhkg · 2023-06-26T22:07:29Z

packages/auth-browser/src/lib/chains/sol.ts

@@ -105,9 +106,11 @@ export const checkAndSignSolAuthMessage = async (): Promise<AuthSig> => {

  try {
    // when it's not in local storage, it's a string
+    // @ts-ignore


We probably want to refactor the IEither type at some point so we don't have to do this

sarahzdev · 2023-07-06T17:47:15Z

packages/bls-sdk/src/lib/bls-sdk.spec.ts

+    ];
+
+    // execute
+    const plaintext = blsSdk.verify_and_decrypt_with_signature_shares(


(can't seem to comment on the packages/bls-sdk/src/lib/bls-sdk.ts file directly)

maybe we should strive to keep casing consistent across the sdk

…instead of throwing

…e-client-nodejs package

…st arrayify utf-16 strings

…press-app

joshLong145 · 2023-08-22T16:09:57Z

Closing as functionality has been merged into: https://github.com/LIT-Protocol/js-sdk/tree/feat/SDK-V3

hwrdtm self-assigned this Jun 14, 2023

hwrdtm commented Jun 14, 2023

View reviewed changes

packages/bls-sdk/src/lib/bls-sdk.d.ts

@@ -0,0 +1,47 @@

/**

Copy link

Contributor Author

hwrdtm Jun 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the types don't seem to be linking properly...

vercel bot deployed to Preview June 16, 2023 03:18 View deployment

vercel bot deployed to Preview June 16, 2023 23:56 View deployment

vercel bot deployed to Preview June 17, 2023 00:11 View deployment

vercel bot deployed to Preview June 21, 2023 01:10 View deployment

hwrdtm commented Jun 21, 2023

View reviewed changes

vercel bot deployed to Preview June 24, 2023 17:13 View deployment

hwrdtm commented Jun 24, 2023

View reviewed changes

vercel bot deployed to Preview June 24, 2023 18:44 View deployment

hwrdtm force-pushed the hwrdtm/upgrade-acc-based-decryption-signing branch from da294a2 to 958d035 Compare June 24, 2023 23:32

vercel bot deployed to Preview June 24, 2023 23:32 View deployment

hwrdtm force-pushed the hwrdtm/upgrade-acc-based-decryption-signing branch from 958d035 to 014d8d8 Compare June 24, 2023 23:33

vercel bot deployed to Preview June 24, 2023 23:34 View deployment

hwrdtm changed the title ~~Upgrade ACC-based encryption + signing~~ Upgrade ACC-based encryption + JWT signing Jun 24, 2023

hwrdtm marked this pull request as ready for review June 24, 2023 23:55

hwrdtm requested review from Ansonhkg, glitch003, DashKash54, sarahzdev and joshLong145 June 24, 2023 23:57

Ansonhkg reviewed Jun 26, 2023

View reviewed changes

glitch003 previously approved these changes Jun 29, 2023

View reviewed changes

hwrdtm force-pushed the hwrdtm/upgrade-acc-based-decryption-signing branch from 014d8d8 to 52732ad Compare June 29, 2023 16:48

vercel bot deployed to Preview June 29, 2023 16:48 View deployment

sarahzdev reviewed Jul 6, 2023

View reviewed changes

hwrdtm force-pushed the hwrdtm/upgrade-acc-based-decryption-signing branch from 52732ad to 5acdc3e Compare July 7, 2023 03:35

vercel bot deployed to Preview July 7, 2023 03:35 View deployment

hwrdtm added 22 commits July 11, 2023 10:43

Use generics in IEither

c51cf9a

Refactor param validation, add coverage, use IEither to return error …

a4f6b2b

…instead of throwing

Fix map

d9d782f

Fix crypto package logic + tests

f2212fc

Update encryption helpers and integrate new BLS encryption to lit-nod…

4fe63af

…e-client-nodejs package

Remove jalapeno support and make serrano the default

dde3868

Build fixes + bug fixes

3df13fb

Make demo app use TS

17b1558

Use better names, fixes

7dc7d04

Fix bug, make errors more verbose

a9bd44d

Update encryption logic in demo app

c67df58

Couple of important bug fixes + tidy up

cda0f1d

Demo using human-readable strings

802851e

Update comments and JSDocs

3e5b46a

Fix bugs, update all e2e & manual tests, simplify encryptString to ju…

4d751ad

…st arrayify utf-16 strings

Update bls-sdk,crypto with verify_signature, implement demo-locked-ex…

4bb0a14

…press-app

Add getSignedToken + verification to e2e tests

ae35bcd

Update manual_tests for signed JWT tests

ff937b5

Cleanup

85f7671

Fix types

60b621b

Use cayenne as default

af3f59b

Update to cayenne contracts

9ad5af3

hwrdtm force-pushed the hwrdtm/upgrade-acc-based-decryption-signing branch from 10dd561 to 9ad5af3 Compare July 11, 2023 17:43

vercel bot deployed to Preview July 11, 2023 17:44 View deployment

Ansonhkg changed the title ~~Upgrade ACC-based encryption + JWT signing~~ [V3] Upgrade ACC-based encryption + JWT signing Jul 17, 2023

hwrdtm dismissed glitch003’s stale review via 9ad5af3 August 10, 2023 18:23

joshLong145 closed this Aug 22, 2023

joshLong145 mentioned this pull request Aug 22, 2023

[version 3.0.0] Major version bump #199

Closed

joshLong145 mentioned this pull request Nov 25, 2023

[version 3.0.0] Major version bump #266

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[V3] Upgrade ACC-based encryption + JWT signing #145

[V3] Upgrade ACC-based encryption + JWT signing #145

hwrdtm commented Jun 14, 2023 •

edited

Loading

vercel bot commented Jun 14, 2023 •

edited

Loading

hwrdtm Jun 14, 2023

hwrdtm Jun 21, 2023

hwrdtm Jun 24, 2023

hwrdtm Jun 24, 2023

hwrdtm commented Jun 25, 2023

Ansonhkg Jun 26, 2023

sarahzdev Jul 6, 2023 •

edited

Loading

joshLong145 commented Aug 22, 2023

[V3] Upgrade ACC-based encryption + JWT signing #145

[V3] Upgrade ACC-based encryption + JWT signing #145

Conversation

hwrdtm commented Jun 14, 2023 • edited Loading

What

Testing

TODO

vercel bot commented Jun 14, 2023 • edited Loading

hwrdtm Jun 14, 2023

Choose a reason for hiding this comment

hwrdtm Jun 21, 2023

Choose a reason for hiding this comment

hwrdtm Jun 24, 2023

Choose a reason for hiding this comment

hwrdtm Jun 24, 2023

Choose a reason for hiding this comment

hwrdtm commented Jun 25, 2023

Ansonhkg Jun 26, 2023

Choose a reason for hiding this comment

sarahzdev Jul 6, 2023 • edited Loading

Choose a reason for hiding this comment

joshLong145 commented Aug 22, 2023

hwrdtm commented Jun 14, 2023 •

edited

Loading

vercel bot commented Jun 14, 2023 •

edited

Loading

sarahzdev Jul 6, 2023 •

edited

Loading