`zk-jwt` Refactor by shreyas-londhe · Pull Request #2 · zkemail/openai-jwt

shreyas-londhe · 2024-09-11T07:02:24Z

This PR refactors and adds docs and helper functions.

shreyas-londhe · 2024-10-12T15:04:53Z

packages/contracts/src/utils/JwtVerifier.sol

+    bytes32 publicKeyHash; // Hash of the DKIM public key used in email/proof
+    uint timestamp; // Timestamp of the email
+    string maskedCommand; // Masked command of the email
+    bytes32 emailNullifier; // Nullifier of the email to prevent its reuse.


Suggested change

bytes32 emailNullifier; // Nullifier of the email to prevent its reuse.

bytes32 jwtNullifier; // Nullifier of the jwt to prevent its reuse.

@shreyas-londhe I've not dared to make any changes here in order to be compatible with EmailProof already in use.
If this change is made, it will not be possible to use the existing Verifier and JwtVerifier in the same interface with IVerifier used in ether-email-auth. cc: @SoraSuegami

shreyas-londhe · 2024-10-12T15:05:16Z

packages/contracts/src/utils/JwtVerifier.sol

+import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
+import { strings } from "solidity-stringutils/src/strings.sol";
+
+struct EmailProof {


Should be JwtProof

@shreyas-londhe Same reason the above

shreyas-londhe · 2024-10-12T15:05:59Z

packages/contracts/src/utils/JwtVerifier.sol

+import { strings } from "solidity-stringutils/src/strings.sol";
+
+struct EmailProof {
+    string domainName; // Domain name of the sender's email


Can you mention what the domainName in this case is -> [kid, iss, azp]?

@shreyas-londhe kid, iss, and azp are concatenated as a string with | as the delimiter. I'll update the comment.

shreyas-londhe · 2024-10-12T15:06:39Z

packages/contracts/src/utils/JwtVerifier.sol

+
+struct EmailProof {
+    string domainName; // Domain name of the sender's email
+    bytes32 publicKeyHash; // Hash of the DKIM public key used in email/proof


Can you update the comment appropriately?

@shreyas-londhe Thank you point out it. I'll update it.

shreyas-londhe · 2024-10-12T15:07:14Z

packages/contracts/src/utils/JwtVerifier.sol

+struct EmailProof {
+    string domainName; // Domain name of the sender's email
+    bytes32 publicKeyHash; // Hash of the DKIM public key used in email/proof
+    uint timestamp; // Timestamp of the email


Should be timestamp of JWT

shreyas-londhe · 2024-10-12T15:07:40Z

packages/contracts/src/utils/JwtVerifier.sol

+    bytes32 emailNullifier; // Nullifier of the email to prevent its reuse.
+    bytes32 accountSalt; // Create2 salt of the account
+    bool isCodeExist; // Check if the account code is exist
+    bytes proof; // ZK Proof of Email


should be of jwt

shreyas-londhe · 2024-10-12T15:08:14Z

packages/contracts/src/utils/JwtVerifier.sol

+        uint256[ISS_FIELDS + COMMAND_FIELDS + AZP_FIELDS + 6] memory pubSignals;
+
+        // string[] = [kid, iss, azp]
+        string[] memory parts = this.stringToArray(proof.domainName);


Can you please explain how this encodes the inputs?

@shreyas-londhe I added the comments

shreyas-londhe · 2024-10-12T15:09:07Z

packages/contracts/src/utils/JwtRegistry.sol

+    function isDKIMPublicKeyHashValid(
+        string memory domainName,
+        bytes32 publicKeyHash
+    ) public view returns (bool) {
+        string[] memory parts = this.stringToArray(domainName);
+        string memory kidAndIss = string(abi.encode(parts[0], "|", parts[1]));
+        return dkimRegistry.isDKIMPublicKeyHashValid(kidAndIss, publicKeyHash) 
+          && whitelistedClients[parts[2]];
+    }


This is not a DKIM public key, it's a JWT verification public key

@shreyas-londhe function names, etc. have not been changed to make the interface match the previous DKIMRegistry. @SoraSuegami

shreyas-londhe · 2024-10-12T15:09:50Z

packages/contracts/src/utils/JwtRegistry.sol

+    /// @notice Sets a public key hash for a `kis|iss` string  after validating the provided signature.
+    /// @param domainName The domain name contains kis, iss and azp fields.
+    /// @param publicKeyHash The public key hash to set.
+    /// @dev This function requires that the public key hash is not already set or revoked.
+    function setDKIMPublicKeyHash(
+        string memory domainName,
+        bytes32 publicKeyHash
+    ) public {
+        require(bytes(domainName).length != 0, "Invalid domain name");
+        require(publicKeyHash != bytes32(0), "Invalid public key hash");
+        string[] memory parts = this.stringToArray(domainName);
+        string memory kidAndIss = string(abi.encode(parts[0], "|", parts[1]));
+        require(
+            isDKIMPublicKeyHashValid(domainName, publicKeyHash) == false,
+            "publicKeyHash is already set"
+        );
+        require(
+            dkimRegistry.revokedDKIMPublicKeyHashes(publicKeyHash) == false,
+            "publicKeyHash is revoked"
+        );
+
+        dkimRegistry.setDKIMPublicKeyHash(kidAndIss, publicKeyHash);
+        // Register azp


Can you please not use DKIM as we are not using it?

@shreyas-londhe I am doing this to match the logic with using the previous registry. does this mean I should store the public key hash in a different way?

shreyas-londhe · 2024-10-12T15:10:26Z

packages/contracts/src/utils/JwtRegistry.sol

+    function setDKIMPublicKeyHash(
+        string memory domainName,
+        bytes32 publicKeyHash
+    ) public {


Can you make this function onlyOwner?

@shreyas-londhe Sure thing

…efactor

feat: jwt-verifier working w/ tests

26a0e65

shreyas-londhe had a problem deploying to development September 11, 2024 14:56 — with GitHub Actions Failure

chore: updated gh workflow

f533983

shreyas-londhe had a problem deploying to development September 11, 2024 15:02 — with GitHub Actions Failure

chore: updated gh workflow

e0448ea

shreyas-londhe had a problem deploying to development September 11, 2024 15:09 — with GitHub Actions Failure

chore: updated workflow

cce19d5

shreyas-londhe had a problem deploying to development September 13, 2024 09:43 — with GitHub Actions Failure

shreyas-londhe added 3 commits September 17, 2024 15:19

feat: modifier helper functions to output jwt indices

6383f63

feat: added checks for jwt header params

635a58d

chore: updated workflow name

3bb1a3f

shreyas-londhe had a problem deploying to development September 17, 2024 09:51 — with GitHub Actions Failure

shreyas-londhe added 4 commits September 17, 2024 15:32

feat: added a check for unique 'command' key in payload

ae9f8a3

feat: added sample frontend to generate auth jwt

97ee4a8

feat: added azp check

9aee0fe

feat: added command check

a6656a0

shreyas-londhe had a problem deploying to development September 23, 2024 09:35 — with GitHub Actions Failure

chore: updated the workflow file

8d7a3d0

shreyas-londhe had a problem deploying to development September 23, 2024 09:48 — with GitHub Actions Failure

chore: updated the workflow file

e7665e1

shreyas-londhe had a problem deploying to development September 23, 2024 10:51 — with GitHub Actions Failure

shreyas-londhe had a problem deploying to development September 23, 2024 10:53 — with GitHub Actions Failure

chore: updated the workflow file

dbf5595

shreyas-londhe had a problem deploying to development October 12, 2024 14:06 — with GitHub Actions Failure

add deploy instructions to contract readme and fix .env.sample

9d3566f

Divide-By-0 had a problem deploying to development October 12, 2024 14:08 — with GitHub Actions Failure

Update verifier name and prover

7caa7ce

SoraSuegami had a problem deploying to development October 12, 2024 14:12 — with GitHub Actions Failure

updated base sep deploy address again

6e2631a

Divide-By-0 had a problem deploying to development October 12, 2024 14:20 — with GitHub Actions Failure

Divide-By-0 and others added 4 commits October 12, 2024 21:21

added sepolia dkimregistry address

a82e69b

Merge branch 'feat/prover' into feat/refactor

f6f7d5e

Add docs into Deploy_jwtRegistry.s.sol

008631d

Add Deploy_jwtVerifier.s.sol

f04645d

shreyas-londhe commented Oct 12, 2024

View reviewed changes

wshino and others added 14 commits October 13, 2024 01:07

Add Deploy_jwtVerifier.s.sol

d31bb35

fix: proof gen working on frontend

019169b

chore: minor refactor

b7c3f00

chore: update prover

18641b7

chore: update modal

28c8a95

chore: update modal

64c5f9c

feat: complete e2e demo flow

d691c6d

chore: Fix linting errors

36335fb

chore: add declaration file for @zk-email/relayer-utils

65fb469

chore: update yarn.lock file

e3756f3

Add onlyOwner modifier

fc82187

Merge branch 'feat/refactor' of github.com:zkemail/zk-jwt into feat/r…

57ff775

…efactor

Update integration tests using dynamic proof and pub signals

d967e67

Fix maskedCommand

27b1093

	bytes32 emailNullifier; // Nullifier of the email to prevent its reuse.
	bytes32 jwtNullifier; // Nullifier of the jwt to prevent its reuse.

Conversation

shreyas-londhe commented Sep 11, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wshino Oct 14, 2024 • 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!

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!

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

wshino Oct 14, 2024 •

edited

Loading