fix: database query built from user-controlled sources

[odaysec]

/kind bug /kind feature

The safest approach is to only allow table names that match a trusted, known set of pod names, or at minimum validate that the input conforms precisely to the naming rules of expected tables (e.g., by a regular expression matching only valid table names consisting of alphanumeric characters and underscores, starting with a letter, and of reasonable length). This should be done before inserting the value as an identifier into the SQL string.

To implement this in the current file (cmd/metrics-scraper/app/routes/metrics/handlerqueries.go), we need to:

• Add a validation function (e.g., isValidTableName) to check that sanitizedPodName matches a safe pattern (like ^[a-zA-Z_][a-zA-Z0-9_]{0,63}$).
• Refuse to run the query and return an error to the client if the table name fails validation.
• Import the regexp package for pattern matching.
• Apply this validation in queryMetricNames before using the table name.

[gemini-code-assist[bot]]

Summary of Changes

Hello @odaysec, I'm Gemini Code Assist[^1]! 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 addresses a critical security vulnerability by implementing stringent input validation for database table names that are constructed from user-controlled input. By introducing a regular expression-based validation function, the changes ensure that only safely formatted table names are used in SQL queries, thereby preventing SQL injection attacks and significantly enhancing the application's security posture.

Highlights

• Security Fix: Implemented input validation for database table names to prevent potential SQL injection vulnerabilities arising from user-controlled sources.
• New Validation Function: Introduced a new isValidTableName function that uses a regular expression to ensure table names conform to a safe and expected identifier pattern.
• Robust Error Handling: Added error handling within queryMetricNames to return a 400 Bad Request response if an invalid table name is detected during validation.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

[^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.

[karmada-bot]

Welcome @odaysec! It looks like this is your first PR to karmada-io/dashboard 🎉

[RainbowMango]

@odaysec Thank you for doing this. Just out of curiosity, how do you find this? Are you evaluating the security of this project or something?

[RainbowMango]

cc @warjiang

[warjiang]

@odaysec thanks for your kindly remind for the potential security problems, the changes in the PR would make the metrics-scraper safer then before, but I think maybe we can migrate from raw sql query to orm framework like gorm、ent etc. any ideas? Btw, there is no doubt that your contribution still make sense ~

[karmada-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: poratoes Once this PR has been reviewed and has the lgtm label, please assign warjiang for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment