chrore: Align request headers #25
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Caution Review failedThe pull request is closed. WalkthroughReplaces static API signature auth with per-request nonce-based HMAC signing. Updates ApiClient public methods to accept nonces, adds timestamp and request ID headers, and introduces signature computation helpers. Integrates nonce generation into store API calls. Adds uuid dependency. Updates tests to reflect removed apiSignature option. Changes
Sequence Diagram(s)sequenceDiagram
participant Store as useApiStore
participant Client as ApiClient
participant Crypto as HMAC/SHA256
participant UUID as uuid.v4
participant Server as API
Store->>Client: createNonce()
Client->>Crypto: random bytes (crypto.getRandomValues)
Crypto-->>Client: 16-byte hex nonce
Store->>Client: get/post(url, nonce, [body])
Client->>UUID: v4()
UUID-->>Client: requestId
Client->>Crypto: sha256(body) + canonical string
Crypto-->>Client: HMAC-SHA256 signature
Client->>Server: HTTP GET/POST with headers\nX-Request-ID, X-API-Timestamp, X-API-Nonce, X-API-Signature
Server-->>Client: 200/304 + data/ETag
Client-->>Store: data (cached on 304)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (4)
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @gocanto, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
I've implemented a new request signing mechanism within the ApiClient to bolster API security. This change introduces a robust way to authenticate and ensure the integrity of all outgoing API requests. The core idea is to generate a unique signature for each request, incorporating details like a nonce and a timestamp, which the server can then use to verify the request's authenticity and detect any tampering. This significantly enhances the security posture of our API interactions.
Highlights
- Enhanced API Security: I've implemented a comprehensive request signing mechanism using HMAC-SHA256 to authenticate and verify the integrity of API requests. This ensures that all outgoing requests are secure and untampered.
- Dynamic Signature Generation: New utility methods such as
getNonce,sha256Hex,hmacSha256Hex,sortedQuery, andgetSignaturehave been introduced. These methods work together to dynamically compute and append theX-API-Signatureheader for bothGETandPOSTrequests. - Standardized Request Headers: The
createHeadersmethod has been updated to include essential metadata headers:X-API-Nonce,X-Request-ID, andX-API-Timestamp. These headers provide crucial information for server-side validation of the request signature.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds request signing logic to the API client. However, the current implementation has a critical security flaw: the nonce and timestamp are generated only once when the client is instantiated and are reused for all subsequent requests. This makes the application vulnerable to replay attacks. Additionally, the HMAC signature is being generated using the public API key as the secret, instead of what appears to be the intended API secret stored in apiSignature. I've added detailed comments on how to resolve these issues.
Summary by CodeRabbit