Skip to content

Revert "Add condition to avoid secret names that contain forward slashes" #3403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

maidul98
Copy link
Collaborator

@maidul98 maidul98 commented Apr 12, 2025

Reverts #3392

Summary by CodeRabbit

  • New Features
    • Secret names now allow forward slashes, offering greater flexibility in naming while continuing to restrict spaces and colons.

Copy link

coderabbitai bot commented Apr 12, 2025

Walkthrough

The pull request modifies the SecretNameSchema within the backend/src/server/lib/schemas.ts file by removing the validation check that disallowed forward slashes in the secret name. Previously, the schema enforced three refinement checks: one to prevent spaces, another to disallow colons, and a third to forbid forward slashes. The update retains the checks for spaces and colons while eliminating the requirement to exclude forward slashes. This change adjusts the validation criteria for the SecretNameSchema by broadening the range of acceptable characters in the secret name.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

backend/src/server/lib/schemas.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "@typescript-eslint/eslint-plugin".

(The package "@typescript-eslint/eslint-plugin" was not found when loaded as a Node module from the directory "/backend".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install @typescript-eslint/eslint-plugin@latest --save-dev

The plugin "@typescript-eslint/eslint-plugin" was referenced from the config file in "backend/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cdc364d and 2023173.

📒 Files selected for processing (1)
  • backend/src/server/lib/schemas.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Check TS and Lint
  • GitHub Check: Run integration test
🔇 Additional comments (1)
backend/src/server/lib/schemas.ts (1)

45-48:

❓ Verification inconclusive

Validation rule for forward slashes removed from SecretNameSchema

This change removes the validation rule that previously disallowed forward slashes in secret names, while maintaining the rules against spaces and colons. This allows users to create secret names with hierarchical paths (e.g., "api/keys/development").

Note that this is a revert of PR #3392 which had added the forward slash restriction. Make sure that any system components that process or store these secret names can properly handle forward slashes without path traversal or other security issues.


🏁 Script executed:

#!/bin/bash
# Check if there are any existing tests that might be affected by this change
echo "Searching for tests related to secret name validation:"
rg -l "SecretNameSchema" --glob "**/*.test.ts" --glob "**/*.spec.ts"

# Look for any error handlers or security measures related to path handling
echo "Checking if forward slashes in secret names might create path traversal vulnerabilities:"
rg "secretName.*path|path.*secretName" --glob "**/*.ts"

Length of output: 634


Revert of forward slash restriction for SecretNameSchema – Verify Safety Across Components

The change now only enforces that secret names do not contain spaces or colons, allowing forward slashes to support hierarchical names (e.g., "api/keys/development"). Since this reverts the earlier restriction from PR #3392, please ensure that all system components processing secret names handle forward slashes securely to prevent path traversal or related vulnerabilities. In particular, review the logic in frontend/src/components/permissions/AccessTree/utils/createFolderNode.ts and any other dependent modules for safe handling of these inputs. If tests for secret name validation aren’t already covering scenarios with forward slashes, consider adding them to validate proper behavior.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

This PR reverts a validation rule that prevented forward slashes in secret names, which was originally added to avoid API failures.

  • Removes validation in backend/src/server/lib/schemas.ts that prevented forward slashes in secret names
  • Reintroduces potential API failures when secret names with slashes are used as path parameters
  • Affects endpoints like 'secrets/raw/secret/name/with/slashes' which can break when secret names contain slashes
  • Could lead to runtime errors when users create secrets with forward slashes that pass initial validation
  • Impacts API functionality where secret names are used in URL paths

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant