Include api key in header instead of in the URL - #4240
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @SandyTao520, 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!
This pull request refactors how the API key is sent for model check requests, moving it from the URL query string to an HTTP header. This change is a security improvement, making the API key less susceptible to exposure through logs or browser history, and adheres to Google's recommended authentication practices.
Highlights
- Security Enhancement: The API key for Google Generative Language API requests is no longer included directly in the URL as a query parameter. This improves security by preventing the key from being logged in web server access logs or browser history.
- API Key Transmission Method: The API key is now securely transmitted in the
x-goog-api-keyHTTP header for all requests made to thegenerativelanguage.googleapis.comendpoint, aligning with recommended best practices for API key usage.
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 is currently in preview and 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 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 correctly refactors the model check request to send the API key in the x-goog-api-key header instead of the URL query string. This change aligns with security best practices by preventing the API key from being exposed in URLs, which could be logged or otherwise compromised. The implementation is clean and correctly targeted at the direct fetch call in modelCheck.ts. The change is a valuable security improvement, and the implementation is solid.
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x' artifact from the main CI run. |
mattKorwel
left a comment
There was a problem hiding this comment.
This seems like a solid change. It does seem like the kind of thing that might expose an edge case? Lets just make sure to watch for bugs related to this. LGTM
TLDR
For security, it's better not to include the key parameter in the URL.
Dive Deeper
Per https://cloud.google.com/docs/authentication/api-keys-use#using-with-rest, it's better to include API key in the header.
Reviewer Test Plan
Use Sherlog or Proxy to see the model check request no longer includes the key parameter.
Testing Matrix
Linked issues / bugs
N/A