auth-helpers package with SessionCapabilityObject #88

hwrdtm · 2023-04-26T01:31:03Z

What

Closes LIT-247

Apologies for the big PR! If you want I can break it down into smaller chunks.

This PR:

Introduces a new auth-helpers package that contains an abstraction over various session capability object implementations - today, we will roll out with using a SIWE ReCap based implementation that implements ISessionCapabilityObject.
Introduce ILitResource which is an abstraction over any LIT-related logical resource, and LitAbility which is a specific action upon a LIT resource. For a user to make a request, they will couple them together as a LitResourceAbilityRequest - we check for compatibility on the SDK and Rust node side, so that you can't logically do a decryption ability over a Rate Limit Increase NFT resource.
Made lit-node-client-nodejs use stronger types and fix usages of session sigs here and there.
- Store walletSig (auth sigs)
Integrate getSessionSigs to use auth-helpers session capability object generation / verification.
Allow passing optional statement to AuthCallbackParams

Examples:

Creating an ACC LIT resource and then requesting to perform the signing operation over it, by generating session sigs with the SDK, which the SDK will generate a session capability object with wildcard abilities for this specific ACC resource (*/*):

    const litResource = new LitAccessControlConditionResource(hashedResourceId);

    let sessionSigs = savedParams.litNodeClient.getSessionSigs({
      chain: 'ethereum',
      resourceAbilityRequests: [
        {
          resource: litResource,
          ability: LitAbility.AccessControlConditionSigning,
        },
      ],
    });

TODO

Test against Rust node validation logic (locally)
Use siwe-recap at 0.0.2-alpha.0
Update to use more descriptive resource prefixes

Testing

Manually tested from OAuth PKP repo, works as intended.

E2E:

yarn tools --dev --apps
yarn tools --test --e2e html

Packages:

npx nx run lit-node-client-nodejs:test
npx nx run auth-helpers:test

vercel · 2023-04-26T01:31:07Z

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	May 16, 2023 6:43pm

hwrdtm

Apologies for the big PR! If anyone wants I can break it down further.

hwrdtm · 2023-05-06T00:09:27Z

packages/auth-helpers/src/lib/models.ts

+/**
+ * These are the user-facing abilities that can be granted to a session.
+ */
+export enum LitAbility {


New concept that I'm introducing to SDK users.

hwrdtm · 2023-05-06T00:10:02Z

packages/auth-helpers/src/lib/models.ts

+  LitAction = 'lit-la',
+}
+
+export interface ISessionCapabilityObject {


Abstraction over any concrete session capability object implementation.

hwrdtm · 2023-05-06T00:10:44Z

packages/auth-helpers/src/lib/models.ts

+  addAllCapabilitiesForResource(litResource: ILitResource): void;
+}
+
+export interface ILitResource {


abstraction over any LIT-related logical resource.

hwrdtm · 2023-05-06T00:11:29Z

packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts

+  }
+
+  get statement(): string {
+    return sanitizeSiweMessage(this.#inner.statement);


Needed until spruceid/recap-ts#11 is done.

hwrdtm · 2023-05-06T00:13:10Z

packages/auth-helpers/src/lib/session-capability-object.ts

@@ -0,0 +1,32 @@
+import { SiweMessage } from 'siwe';


this file contains entry points to getting session capability objects, that are all currently implemented by Recap.

hwrdtm · 2023-05-06T00:14:24Z

packages/types/src/lib/interfaces.ts

+   * @example If you want to request the ability to decrypt an access control condition, then you would pass
+   * [{ resource: new LitAccessControlConditionResource('someResource), ability: LitAbility.AccessControlConditionDecryption }]
+   */
+  resourceAbilityRequests: LitResourceAbilityRequest[];


breaking change, but, as discussed we will proceed like so with heads up to users and that's it.

I wanted to introduce LitResource and LitAbility to better separate those two concepts, rather than have everything be encoded into a single string and parsing in a way that is (IMO) less legible.

tsconfig.json

packages/auth-helpers/src/lib/models.ts

joshLong145 · 2023-05-08T12:55:23Z

packages/auth-helpers/src/lib/recap/recap-session-capability-object.ts

+  }
+
+  static extract(siwe: SiweMessage): RecapSessionCapabilityObject {
+    const recap = Recap.extract_and_verify(siwe);


can verification fail?

packages/auth-helpers/src/lib/models.ts

packages/auth-helpers/src/lib/recap/recap-session-capability-object.spec.ts

packages/auth-helpers/src/lib/recap/utils.ts

Ansonhkg

lgtm! can we also update this repo readme with simple instructions on why and how to use it, example code etc.? also a changelog for the breaking change

Ansonhkg

love it btw!

hwrdtm · 2023-05-12T03:20:46Z

lgtm! can we also update this repo readme with simple instructions on why and how to use it, example code etc.? also a changelog for the breaking change

I can do changelog but I plan to update our website docs soon anyways, so I'll just do it there. I don't think the root README.md is the best place for it.

hwrdtm · 2023-05-13T01:22:45Z

@Ansonhkg node side changes have been merged per https://github.com/LIT-Protocol/lit-assets/pull/149 and this PR is ready to go. Let's merge and publish this. Docs will come shortly after.

…emented by SIWE ReCap

We need to use :// to separate scheme from path-absolute, and the letter * is not permitted per the ABNF grammar for the IRI scheme.

…arams

The asterisk in the line above will cover all packages already.

Ansonhkg · 2023-05-17T15:14:40Z

@hwrdtm Published to latest 2.1.166

hwrdtm self-assigned this Apr 26, 2023

vercel bot deployed to Preview April 28, 2023 00:44 View deployment

hwrdtm mentioned this pull request Apr 28, 2023

Make session signatures compatible with SIWE ReCap #18

Closed

vercel bot deployed to Preview May 1, 2023 15:39 View deployment

vercel bot deployed to Preview May 1, 2023 19:54 View deployment

vercel bot deployed to Preview May 5, 2023 22:49 View deployment

hwrdtm force-pushed the feature/lit-247-sdk-make-sessionsigs-compliant-with-siwe branch from 0f57082 to bd066b7 Compare May 6, 2023 00:04

vercel bot deployed to Preview May 6, 2023 00:05 View deployment

hwrdtm commented May 6, 2023

View reviewed changes

hwrdtm marked this pull request as ready for review May 6, 2023 00:16

vercel bot deployed to Preview May 6, 2023 00:18 View deployment

hwrdtm requested review from Ansonhkg, glitch003, sarahzdev, joshLong145 and DashKash54 May 6, 2023 00:32

joshLong145 approved these changes May 8, 2023

View reviewed changes

Ansonhkg reviewed May 8, 2023

View reviewed changes

packages/auth-helpers/src/lib/recap/recap-session-capability-object.spec.ts Outdated Show resolved Hide resolved

Ansonhkg reviewed May 8, 2023

View reviewed changes

packages/auth-helpers/src/lib/recap/utils.ts Outdated Show resolved Hide resolved

Ansonhkg reviewed May 8, 2023

View reviewed changes

Ansonhkg approved these changes May 8, 2023

View reviewed changes

sarahzdev approved these changes May 11, 2023

View reviewed changes

hwrdtm force-pushed the feature/lit-247-sdk-make-sessionsigs-compliant-with-siwe branch from bcd82bf to 24f8f67 Compare May 12, 2023 03:01

vercel bot deployed to Preview May 12, 2023 03:01 View deployment

vercel bot deployed to Preview May 12, 2023 03:15 View deployment

vercel bot deployed to Preview May 12, 2023 03:25 View deployment

vercel bot deployed to Preview May 12, 2023 04:17 View deployment

hwrdtm requested a review from Ansonhkg May 13, 2023 01:22

hwrdtm added 24 commits May 16, 2023 11:43

Create auth-helpers package with SessionCapabilityObject that is impl…

4b40974

…emented by SIWE ReCap

Rename SessionCapabilityObjectImpl to ISessionCapabilityObject

fda4ebe

Update auth-helpers API

5c988fb

Use more suitable namespaces

2831a60

Use interface + parent class

b4d5a7f

Implement support for wildcards

81da566

Integrate auth-helpers with lit-node-client-nodejs

9255750

Fix session keys and related methods

44de693

Add types to getSessionSigs

9ef6cff

Add SessionSigsMap type

5d29fe7

Remove LitResourcePrefix.Wildcard, fix valid IRI syntax

b82bea4

We need to use :// to separate scheme from path-absolute, and the letter * is not permitted per the ABNF grammar for the IRI scheme.

Sanitize the SIWE statement, pass optional statement to AuthCallbackP…

50d7953

…arams

Add sanitize utility

291de9b

Refactor + fix bug using SiweMessage.validate

ed71db6

Fix bug where nx cannot find paths

a99812d

The asterisk in the line above will cover all packages already.

Misc. stuff

1ca51e8

Fix tests

3d992ab

Fix e2e tests

db1ed06

Remove test-1 from bad rebase

55eed2b

Address PR feedback

256092f

Upgrade siwe-recap version

fc1e00f

Tidy up

62e7761

Update changelog

28c4997

Update lit resource prefixes

e2f1137

hwrdtm force-pushed the feature/lit-247-sdk-make-sessionsigs-compliant-with-siwe branch from 458ef0f to e2f1137 Compare May 16, 2023 18:43

vercel bot deployed to Preview May 16, 2023 18:43 View deployment

Ansonhkg merged commit 253c432 into master May 17, 2023
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

auth-helpers package with SessionCapabilityObject #88

auth-helpers package with SessionCapabilityObject #88

hwrdtm commented Apr 26, 2023 •

edited

Loading

vercel bot commented Apr 26, 2023 •

edited

Loading

hwrdtm left a comment

hwrdtm May 6, 2023

hwrdtm May 6, 2023

hwrdtm May 6, 2023

hwrdtm May 6, 2023

hwrdtm May 6, 2023

hwrdtm May 6, 2023

hwrdtm May 6, 2023

joshLong145 May 8, 2023

hwrdtm May 12, 2023

Ansonhkg left a comment •

edited

Loading

Ansonhkg left a comment

hwrdtm commented May 12, 2023

hwrdtm commented May 13, 2023

Ansonhkg commented May 17, 2023

auth-helpers package with SessionCapabilityObject #88

auth-helpers package with SessionCapabilityObject #88

Conversation

hwrdtm commented Apr 26, 2023 • edited Loading

What

Examples:

TODO

Testing

vercel bot commented Apr 26, 2023 • edited Loading

hwrdtm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ansonhkg left a comment • edited Loading

Choose a reason for hiding this comment

Ansonhkg left a comment

Choose a reason for hiding this comment

hwrdtm commented May 12, 2023

hwrdtm commented May 13, 2023

Ansonhkg commented May 17, 2023

hwrdtm commented Apr 26, 2023 •

edited

Loading

vercel bot commented Apr 26, 2023 •

edited

Loading

Ansonhkg left a comment •

edited

Loading