@zkproofport-app/sdk 0.5.0-beta.2 → 0.5.0-beta.3

package/dist/index.js

@@ -126,8 +126,10 @@ const CIRCUIT_METADATA = {
     oidc_domain_attestation: {
         name: 'OIDC Domain',
         description: 'Prove email domain affiliation via OIDC JWT',
-        publicInputsCount: 148,
-        publicInputNames: ['pubkey_modulus_limbs', 'domain', 'scope', 'nullifier', 'provider'],
+        // v2: 148 v1 fields, then aud_hash (32), nonce_mode (1), nonce_binding
+        // (32), now (1). oidc-domain-attestation/src/main.nr.
+        publicInputsCount: 214,
+        publicInputNames: ['pubkey_modulus_limbs', 'domain', 'scope', 'nullifier', 'provider', 'aud_hash', 'nonce_mode', 'nonce_binding', 'now'],
     },
     // Planned circuit — the identifier is reserved and the circuit exists, but it
     // is not officially supported yet. See CIRCUIT_SUPPORT_STATUS in ./circuits.
@@ -1141,9 +1143,11 @@ async function fetchVerificationKey(circuit, timeoutMs) {
  * Needs no setup from the caller: the verifier ships with this SDK and is
  * loaded on first use.
  *
- * For `oidc_domain_attestation` it first checks the proof's RSA key against the
- * provider's published JWKS (core's `checkOidcProviderKey`); a key the provider
- * does not publish, or a JWKS that cannot be fetched, is `{ valid: false }`.
+ * For `oidc_domain_attestation` it first checks the token's audience, nonce and
+ * time (core's `checkOidcPolicy`, against `options.request` when given) and the
+ * proof's RSA key against the provider's published JWKS (core's
+ * `checkOidcProviderKey`); any refusal, or a JWKS that cannot be fetched, is
+ * `{ valid: false }`.
  *
  * @param circuit - Canonical circuit identifier
  * @param proof - Proof bytes as hex, WITHOUT public inputs (as the relay sends it)
@@ -1171,7 +1175,7 @@ async function verifyProofOffChain(circuit, proof, publicInputs, options = {}) {
     // their trust anchor as a public input the prover chooses. For OIDC that is
     // the RSA key -- see core's oidcProviderKeys. Checked here so a dApp that
     // verifies off-chain gets the same answer as one that verifies on-chain.
-    const issuer = await core.checkProofIssuer(circuit, publicInputs);
+    const issuer = await core.checkProofIssuer(circuit, publicInputs, { request: options.request });
     if (!issuer.ok) {
         return { valid: false, error: issuer.error };
     }
@@ -1313,6 +1317,13 @@ class ProofportSDK {
      */
     constructor(config = {}) {
         this.pendingRequests = new Map();
+        /**
+         * requestId -> scope of the relay requests this instance created, so that
+         * verifyResponse* can check an OIDC proof's request-bound nonce without the
+         * dApp passing the request back in. Oldest entries go first past
+         * {@link ProofportSDK.MAX_REMEMBERED_RELAY_REQUESTS}.
+         */
+        this.relayRequests = new Map();
         this.signer = null;
         this.socket = null;
         /**
@@ -1874,9 +1885,49 @@ class ProofportSDK {
      * }
      * ```
      */
-    async verifyOnChain(circuit, proof, publicInputs, providerOrSigner) {
+    async verifyOnChain(circuit, proof, publicInputs, providerOrSigner, options = {}) {
         const parsedProof = core.parseProofForOnChain(proof, publicInputs, publicInputs.length);
-        return core.verifyProofOnChain(circuit, parsedProof, providerOrSigner, this.verifierTarget(circuit));
+        return core.verifyProofOnChain(circuit, parsedProof, providerOrSigner, this.verifierTarget(circuit), undefined, {
+            request: options.request,
+        });
+    }
+    /**
+     * The request an `oidc_domain_attestation` response answers: the one the
+     * caller passed, else the relay request this instance created under the
+     * response's requestId. `{ error }` when there is none, or when the two
+     * disagree -- an OIDC proof made with a request-bound nonce is only
+     * meaningful against the request it was bound to, so a response this SDK
+     * cannot place is refused rather than checked without it.
+     */
+    oidcRequestFor(response, explicit) {
+        if (explicit !== undefined) {
+            if (explicit === null || typeof explicit !== 'object' || explicit.requestId !== response.requestId) {
+                return {
+                    error: `The request passed in (${JSON.stringify(explicit?.requestId)}) is not the one this response answers (${JSON.stringify(response.requestId)}).`,
+                };
+            }
+            return { request: explicit };
+        }
+        const remembered = this.relayRequests.get(response.requestId);
+        if (!remembered) {
+            return {
+                error: `No request ${JSON.stringify(response.requestId)} was created by this SDK instance, so the OIDC proof's ` +
+                    'nonce cannot be checked against it. Pass { request: { scope, requestId } } -- the scope and relay ' +
+                    'requestId of the request you created.',
+            };
+        }
+        return { request: remembered };
+    }
+    /** @internal Remember a relay request's scope for verifyResponse*. */
+    rememberRelayRequest(requestId, scope) {
+        if (typeof requestId !== 'string' || typeof scope !== 'string')
+            return;
+        this.relayRequests.delete(requestId);
+        this.relayRequests.set(requestId, { scope, requestId });
+        while (this.relayRequests.size > ProofportSDK.MAX_REMEMBERED_RELAY_REQUESTS) {
+            const oldest = this.relayRequests.keys().next().value;
+            this.relayRequests.delete(oldest);
+        }
     }
     /**
      * The verifier for a circuit: the one the dApp configured, otherwise the
@@ -1903,6 +1954,9 @@ class ProofportSDK {
      *
      * @param response - ProofResponse object from parseResponse()
      * @param providerOrSigner - ethers v6 Provider or Signer (defaults to base mainnet public RPC)
+     * @param options.request - For `oidc_domain_attestation`: the `{ scope, requestId }`
+     *   the response answers. Not needed for a relay request this SDK instance
+     *   created; an OIDC response this instance cannot place is refused without it.
      *
      * @returns Promise resolving to verification result with valid boolean and optional error message
      *
@@ -1929,10 +1983,17 @@ class ProofportSDK {
      * });
      * ```
      */
-    async verifyResponseOnChain(response, providerOrSigner) {
+    async verifyResponseOnChain(response, providerOrSigner, options = {}) {
         if (response.status !== 'completed' || !response.proof || !response.publicInputs) {
             return { valid: false, error: 'Invalid or incomplete response' };
         }
+        let request;
+        if (response.circuit === 'oidc_domain_attestation') {
+            const found = this.oidcRequestFor(response, options.request);
+            if ('error' in found)
+                return { valid: false, error: found.error };
+            request = found.request;
+        }
         const parsedProof = core.parseProofForOnChain(response.proof, response.publicInputs, response.publicInputs.length);
         // The response's verifierAddress and chainId are a claim to check, never
         // the contract to call: whoever wrote the response would otherwise pick
@@ -1941,7 +2002,7 @@ class ProofportSDK {
         return core.verifyProofOnChain(response.circuit, parsedProof, providerOrSigner, this.verifierTarget(response.circuit), {
             verifierAddress: response.verifierAddress,
             chainId: response.chainId,
-        });
+        }, { request });
     }
     /**
      * Verifies a proof response off-chain, against the circuit's verification key.
@@ -1971,7 +2032,14 @@ class ProofportSDK {
         if (response.status !== 'completed' || !response.proof || !response.publicInputs) {
             return { valid: false, error: 'Invalid or incomplete response' };
         }
-        return verifyProofOffChain(response.circuit, response.proof, response.publicInputs, options);
+        let request;
+        if (response.circuit === 'oidc_domain_attestation') {
+            const found = this.oidcRequestFor(response, options?.request);
+            if ('error' in found)
+                return { valid: false, error: found.error };
+            request = found.request;
+        }
+        return verifyProofOffChain(response.circuit, response.proof, response.publicInputs, { ...options, request });
     }
     // ============ Utility Methods ============
     /**
@@ -2410,7 +2478,9 @@ class ProofportSDK {
             const error = await response.json().catch(() => ({ error: `HTTP ${response.status}` }));
             throw new Error(error.error || `Relay request failed: HTTP ${response.status}`);
         }
-        return await response.json();
+        const created = await response.json();
+        this.rememberRelayRequest(created.requestId, scope);
+        return created;
     }
     /**
      * Polls the relay for proof result status.
@@ -2693,6 +2763,8 @@ class ProofportSDK {
         return core.extractDomainFromPublicInputs(publicInputs, circuit);
     }
 }
+/** Bound on {@link relayRequests}; a dApp that verifies later can pass the request explicitly. */
+ProofportSDK.MAX_REMEMBERED_RELAY_REQUESTS = 1000;
 /**
  * How each circuit's request is built and checked. Keyed by circuit id and
  * exhaustive over it, so a new circuit is a compile error here instead of
@@ -2721,14 +2793,46 @@ Object.defineProperty(exports, "MDL_KR_PUBLIC_INPUT_LAYOUT", {
     enumerable: true,
     get: function () { return core.MDL_KR_PUBLIC_INPUT_LAYOUT; }
 });
+Object.defineProperty(exports, "OIDC_ALLOWED_AUDIENCES", {
+    enumerable: true,
+    get: function () { return core.OIDC_ALLOWED_AUDIENCES; }
+});
 Object.defineProperty(exports, "OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT", {
     enumerable: true,
     get: function () { return core.OIDC_DOMAIN_ATTESTATION_PUBLIC_INPUT_LAYOUT; }
 });
+Object.defineProperty(exports, "OIDC_NONCE_DOMAIN", {
+    enumerable: true,
+    get: function () { return core.OIDC_NONCE_DOMAIN; }
+});
+Object.defineProperty(exports, "OIDC_NOW_MAX_AGE_SECONDS", {
+    enumerable: true,
+    get: function () { return core.OIDC_NOW_MAX_AGE_SECONDS; }
+});
+Object.defineProperty(exports, "OIDC_NOW_MAX_FUTURE_SECONDS", {
+    enumerable: true,
+    get: function () { return core.OIDC_NOW_MAX_FUTURE_SECONDS; }
+});
+Object.defineProperty(exports, "OIDC_V1_PUBLIC_INPUT_COUNT", {
+    enumerable: true,
+    get: function () { return core.OIDC_V1_PUBLIC_INPUT_COUNT; }
+});
+Object.defineProperty(exports, "OIDC_V2_PUBLIC_INPUT_COUNT", {
+    enumerable: true,
+    get: function () { return core.OIDC_V2_PUBLIC_INPUT_COUNT; }
+});
 Object.defineProperty(exports, "PINNED_VERIFIERS", {
     enumerable: true,
     get: function () { return core.PINNED_VERIFIERS; }
 });
+Object.defineProperty(exports, "checkOidcPolicy", {
+    enumerable: true,
+    get: function () { return core.checkOidcPolicy; }
+});
+Object.defineProperty(exports, "deriveOidcNonceBinding", {
+    enumerable: true,
+    get: function () { return core.deriveOidcNonceBinding; }
+});
 Object.defineProperty(exports, "extractDomainFromPublicInputs", {
     enumerable: true,
     get: function () { return core.extractDomainFromPublicInputs; }
@@ -2745,6 +2849,10 @@ Object.defineProperty(exports, "getPinnedVerifier", {
     enumerable: true,
     get: function () { return core.getPinnedVerifier; }
 });
+Object.defineProperty(exports, "oidcAudienceHash", {
+    enumerable: true,
+    get: function () { return core.oidcAudienceHash; }
+});
 Object.defineProperty(exports, "ALL_CIRCUIT_IDS", {
     enumerable: true,
     get: function () { return circuits.ALL_CIRCUIT_IDS; }