Merge pull request #33 from zkemail/circuit/add-range-check

Add range check for usernameIndex and fromIndex
zkemail · Sep 9, 2024 · bfda11b · bfda11b
2 parents d52b5a0 + dd039d9
commit bfda11b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/packages/circuits/src/twitter.circom b/packages/circuits/src/twitter.circom
@@ -60,6 +60,10 @@ template TwitterVerifier(maxHeadersLength, maxBodyLength, n, k, exposeFrom) {
     if (exposeFrom) {
         signal input fromEmailIndex;
 
+        // Assert fromEmailIndex < emailHeaderLength
+        signal isFromIndexValid <== LessThan(log2Ceil(maxHeadersLength))([fromEmailIndex, emailHeaderLength]);
+        isFromIndexValid === 1;
+
         signal (fromEmailFound, fromEmailReveal[maxHeadersLength]) <== FromAddrRegex(maxHeadersLength)(emailHeader);
         fromEmailFound === 1;
 
@@ -75,6 +79,10 @@ template TwitterVerifier(maxHeadersLength, maxBodyLength, n, k, exposeFrom) {
     signal (twitterFound, twitterReveal[maxBodyLength]) <== TwitterResetRegex(maxBodyLength)(emailBody);
     twitterFound === 1;
 
+    // Assert twitterUsernameIndex < emailBodyLength
+    signal isTwitterIndexValid <== LessThan(log2Ceil(maxBodyLength))([twitterUsernameIndex, emailBodyLength]);
+    isTwitterIndexValid === 1;
+
     // Pack the username to int
     var maxTwitterUsernameLength = 21;
     signal twitterUsernamePacks[1] <== PackRegexReveal(maxBodyLength, maxTwitterUsernameLength)(twitterReveal, twitterUsernameIndex);

diff --git a/packages/circuits/tests/twitter.test.ts b/packages/circuits/tests/twitter.test.ts
@@ -60,6 +60,21 @@ describe("Twitter email test", function () {
     twitterVerifierInputs.twitterUsernameIndex = (Number((await twitterVerifierInputs).twitterUsernameIndex) + 1).toString();
 
     expect.assertions(1);
+
+    try {
+      const witness = await circuit.calculateWitness(twitterVerifierInputs);
+      await circuit.checkConstraints(witness);
+    } catch (error) {
+      expect((error as Error).message).toMatch("Assert Failed");
+    }
+  })
+
+  it("should fail if the twitterUsernameIndex is out of bounds", async function () {
+    const twitterVerifierInputs = await generateTwitterVerifierCircuitInputs(rawEmail, ethAddress);
+    twitterVerifierInputs.twitterUsernameIndex = (twitterVerifierInputs.emailBodyLength! + 1).toString();
+
+    expect.assertions(1);
+
     try {
       const witness = await circuit.calculateWitness(twitterVerifierInputs);
       await circuit.checkConstraints(witness);