Add security considerations

[stevehansen]

Summary

• document SQL injection risk when passing untrusted view names

Testing

• dotnet test

[gemini-code-assist]

Hello @stevehansen, I'm Gemini Code Assist¹! 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!

Summary of Changes

Hello! Gemini here, providing a summary of this pull request to help everyone quickly understand the changes. This PR, authored by @stevehansen, focuses on enhancing the documentation for the sql-inliner tool. The primary goal is to explicitly call out a potential security risk related to SQL injection when using untrusted input for view names. The changes involve adding a new section to the README.md file to inform users about this consideration and advise on mitigation steps.

Highlights

• Security Documentation: Adds a new section to the README specifically addressing security considerations, particularly the risk of SQL injection.
• SQL Injection Risk: Highlights that interpolating untrusted view names directly into SQL queries can lead to SQL injection vulnerabilities.
• Mitigation Advice: Provides guidance to users to only use trusted view names or sanitize input before using the tool.

Changelog

• README.md
  • Added a new 'Security considerations' section.
  • Documented the potential SQL injection risk when using untrusted view names.
  • Provided advice on mitigating the security risk.

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.

---

View names flow in,
Check their source, trust is key,
Code safe, injection flee.

Footnotes

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request makes a valuable contribution by adding a "Security considerations" section to the README.md. The new section clearly and accurately documents a potential SQL injection risk when untrusted view names are used with sql-inliner. The explanation of the risk and the recommended mitigation strategies are well-articulated. This is an important update for user awareness and security.

No style guide was provided, but the changes adhere to common Markdown best practices.

Summary of Findings

• Security Documentation: The pull request commendably adds a crucial "Security considerations" section to the README.md. This section clearly outlines the SQL injection risk associated with using untrusted view names and provides actionable advice for mitigation. This is a valuable addition for users of sql-inliner.
• Markdown Formatting (Minor Improvement): The added documentation is well-formatted. A newline character was also added at the end of the file (implicitly by adding new content after the previous last line), which is good practice for text files. This was not commented on directly as it's a low-severity improvement and review settings focus on medium severity or higher.
• Clarity and Phrasing (Minor Observation): In README.md (lines 43-45), the sentence: "The tool is normally executed by a trusted user who also specifies the connection string, so the risk is low, but only supply view names from trusted sources or sanitize them before running the tool." is clear and conveys the necessary information. For potential future refinement, it could be slightly rephrased to separate the risk context from the imperative advice more distinctly, possibly enhancing flow. However, the current phrasing is perfectly understandable and effective. This is a low-severity stylistic observation and was not commented on directly due to review settings.

Merge Readiness

The changes in this pull request are clear, correct, and significantly improve the documentation by highlighting important security considerations. The code is in good shape to be merged. As a reviewer, I am not authorized to approve the pull request, but based on this review, I recommend it for merging after any standard internal review processes are complete.