better keypair auth error message #913
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughRefactors body hash validation in handleKeypairAuth to compute the request body hash once for POST requests when a bodyHash is present, compares it to the token’s bodyHash, and throws a detailed error on mismatch with updated documentation link. Other logic remains unchanged. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant C as Client
participant S as Server
participant A as Auth Middleware
participant H as BodyHash Calculator
participant T as Token (bodyHash)
C->>S: HTTP Request (may be POST)
S->>A: Invoke handleKeypairAuth
alt POST with bodyHash in payload
A->>H: Compute request body hash
H-->>A: bodyHash(request)
A->>T: Compare bodyHash(request) vs token.bodyHash
alt Hash mismatch
A-->>S: Throw error (includes both hashes, v2 docs URL)
S-->>C: 4xx Error
else Hash match
A-->>S: Auth continues
S-->>C: Proceed
end
else Non-POST or no bodyHash
A-->>S: Skip body hash validation
S-->>C: Proceed
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes ✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/server/middleware/auth.ts (1)
513-517: Make hashing robust and stable (handle undefined/raw body, avoid stringify pitfalls)JSON.stringify(req.body) can be undefined or reorder keys; prefer raw bytes when available and fall back safely to strings/JSON. Consider:
// Replace implementation of hashRequestBody: const hashRequestBody = (req: FastifyRequest): string => { const rawBody = (req as any).rawBody; // if using fastify-raw-body or equivalent if (Buffer.isBuffer(rawBody)) { return createHash("sha256").update(rawBody).digest("hex"); } const bodyStr = typeof rawBody === "string" ? rawBody : typeof req.body === "string" ? req.body : JSON.stringify(req.body ?? {}); return createHash("sha256").update(bodyStr, "utf8").digest("hex"); };
🧹 Nitpick comments (1)
src/server/middleware/auth.ts (1)
334-340: Optional: use constant‑time comparison for hashesMitigate timing side-channels when comparing hashes.
- Add import:
import { createHash, timingSafeEqual } from "node:crypto";- Compare using Buffers:
const a = Buffer.from(computedBodyHash, "hex"); const b = Buffer.from(payload.bodyHash, "hex"); const equal = a.length === b.length && timingSafeEqual(a, b); if (!equal) { error = "The request body does not match the hash in the token. See: https://portal.thirdweb.com/engine/v2/features/keypair-authentication"; throw new Error(error); }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
src/server/middleware/auth.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: build
- GitHub Check: lint
🔇 Additional comments (1)
src/server/middleware/auth.ts (1)
334-340: Docs URL Verified
The v2 docs page exists and includes the bodyHash validation section as expected.
Comment on lines
+334
to
340
| if (req.method === "POST" && payload?.bodyHash) { | ||
| const computedBodyHash = hashRequestBody(req); | ||
| if (computedBodyHash !== payload.bodyHash) { | ||
| error = `The request body does not match the hash in the access token. See: https://portal.thirdweb.com/engine/v2/features/keypair-authentication. [hash in access token: ${payload.bodyHash}, hash computed from request: ${computedBodyHash}]`; | ||
| throw error; | ||
| } | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Harden bodyHash validation: handle empty bodies, avoid echoing hashes, support more HTTP methods, and throw Error objects
- JSON.stringify(undefined) can throw via createHash.update; guard for missing/empty body.
- Returning both hashes in the client-visible error leaks unnecessary detail.
- Restricting to POST misses PUT/PATCH/DELETE with bodies.
- Prefer throwing Error objects over strings for consistency.
Apply this diff within this block:
- // If `bodyHash` is provided, it must match a hash of the POST request body.
- if (req.method === "POST" && payload?.bodyHash) {
- const computedBodyHash = hashRequestBody(req);
- if (computedBodyHash !== payload.bodyHash) {
- error = `The request body does not match the hash in the access token. See: https://portal.thirdweb.com/engine/v2/features/keypair-authentication. [hash in access token: ${payload.bodyHash}, hash computed from request: ${computedBodyHash}]`;
- throw error;
- }
- }
+ // If `bodyHash` is provided, it must match a hash of the request body.
+ if (payload?.bodyHash && ["POST", "PUT", "PATCH", "DELETE"].includes(req.method)) {
+ const hasBody =
+ typeof req.body === "string" ||
+ (req.body !== null &&
+ typeof req.body === "object" &&
+ Object.keys(req.body as Record<string, unknown>).length > 0);
+ if (!hasBody) {
+ error =
+ 'Request body is missing or empty while the token includes a "bodyHash". See: https://portal.thirdweb.com/engine/v2/features/keypair-authentication';
+ throw new Error(error);
+ }
+ const computedBodyHash = hashRequestBody(req);
+ if (computedBodyHash !== payload.bodyHash) {
+ error =
+ "The request body does not match the hash in the token. See: https://portal.thirdweb.com/engine/v2/features/keypair-authentication";
+ throw new Error(error);
+ }
+ }📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| if (req.method === "POST" && payload?.bodyHash) { | |
| const computedBodyHash = hashRequestBody(req); | |
| if (computedBodyHash !== payload.bodyHash) { | |
| error = `The request body does not match the hash in the access token. See: https://portal.thirdweb.com/engine/v2/features/keypair-authentication. [hash in access token: ${payload.bodyHash}, hash computed from request: ${computedBodyHash}]`; | |
| throw error; | |
| } | |
| } | |
| // If `bodyHash` is provided, it must match a hash of the request body. | |
| if (payload?.bodyHash && ["POST", "PUT", "PATCH", "DELETE"].includes(req.method)) { | |
| const hasBody = | |
| typeof req.body === "string" || | |
| (req.body !== null && | |
| typeof req.body === "object" && | |
| Object.keys(req.body as Record<string, unknown>).length > 0); | |
| if (!hasBody) { | |
| error = | |
| 'Request body is missing or empty while the token includes a "bodyHash". See: https://portal.thirdweb.com/engine/v2/features/keypair-authentication'; | |
| throw new Error(error); | |
| } | |
| const computedBodyHash = hashRequestBody(req); | |
| if (computedBodyHash !== payload.bodyHash) { | |
| error = | |
| "The request body does not match the hash in the token. See: https://portal.thirdweb.com/engine/v2/features/keypair-authentication"; | |
| throw new Error(error); | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR-Codex overview
This PR improves error handling in the
auth.tsmiddleware by refining the hash comparison logic for POST requests. It adds detailed information to the error message, including both the hash from the access token and the computed hash from the request.Detailed summary
bodyHash.computedBodyHashto store the hash of the request body.Summary by CodeRabbit