Skip to content
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

Fix for code scanning alert no. 29: Prototype-polluting assignment #7028

Merged
merged 2 commits into from
Mar 13, 2025

Conversation

ardatan
Copy link
Owner

@ardatan ardatan commented Mar 13, 2025

Potential fix for https://github.com/ardatan/graphql-tools/security/code-scanning/29

To fix the prototype pollution vulnerability, we need to ensure that the typeName and fieldName values cannot be special property names like __proto__, constructor, or prototype. We can achieve this by adding a validation step before using these values to delete properties from the result object.

The best way to fix this problem without changing existing functionality is to add a check to ensure that typeName and fieldName are not one of the special property names. If they are, we should skip the deletion operation.

Suggested fixes powered by Copilot Autofix. Review carefully before merging.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
@ardatan ardatan changed the title Potential fix for code scanning alert no. 29: Prototype-polluting assignment Fix for code scanning alert no. 29: Prototype-polluting assignment Mar 13, 2025
Copy link
Contributor

coderabbitai bot commented Mar 13, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced the merging process with stricter validations to safeguard essential properties, preventing unintended modifications and potential prototype pollution for improved stability and security.

Walkthrough

The pull request enhances the mergeResolvers function by adding a conditional check to prevent the deletion of reserved JavaScript properties (__proto__, constructor, and prototype). The control flow now uses a continue statement when either the typeName or fieldName from the exclusions array matches these names. This safeguards the integrity of the merged resolver object without changing the overall structure or public API.

Changes

File Change Summary
packages/merge/src/merge-resolvers.ts Added a conditional check in the mergeResolvers function to skip deletion logic for reserved properties (__proto__, constructor, prototype).
.changeset/dark-crabs-glow.md Added an entry indicating a patch for @graphql-tools/merge, noting the prevention of prototype polluting assignments.

Possibly related PRs

Poem

I'm a little rabbit in the code burrow,
Watching changes hop in with a vibrant flow.
Reserved names stay safe from deletion’s bite,
In our merge, they shine so bright.
Hoppy cheers for safe code tonight! 🐰

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.

packages/merge/src/merge-resolvers.ts

Oops! Something went wrong! :(

ESLint: 9.22.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 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 68f5bc2 and d2b263d.

📒 Files selected for processing (2)
  • .changeset/dark-crabs-glow.md (1 hunks)
  • packages/merge/src/merge-resolvers.ts (1 hunks)

🪧 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 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.

@ardatan ardatan marked this pull request as ready for review March 13, 2025 12:38
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/merge/src/merge-resolvers.ts (1)

75-77: Good security fix for prototype pollution vulnerability.

This change effectively addresses the prototype pollution vulnerability by preventing the deletion of special JavaScript properties (__proto__, constructor, and prototype) from the merged result object. The solution aligns perfectly with the PR objective of fixing code scanning alert no. 29.

One small suggestion for improvement: consider extracting the array of protected property names into a constant to avoid repeating it twice in the conditional check, improving maintainability.

+const PROTECTED_PROPS = ['__proto__', 'constructor', 'prototype'];
 if (options?.exclusions) {
   for (const exclusion of options.exclusions) {
     const [typeName, fieldName] = exclusion.split('.');
-    if (['__proto__', 'constructor', 'prototype'].includes(typeName) || ['__proto__', 'constructor', 'prototype'].includes(fieldName)) {
+    if (PROTECTED_PROPS.includes(typeName) || PROTECTED_PROPS.includes(fieldName)) {
       continue;
     }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 784c2be and 68f5bc2.

📒 Files selected for processing (1)
  • packages/merge/src/merge-resolvers.ts (1 hunks)

@theguild-bot
Copy link
Collaborator

theguild-bot commented Mar 13, 2025

🚀 Snapshot Release (alpha)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package Version Info
@graphql-tools/executor-urql-exchange 1.0.18-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
@graphql-tools/graphql-tag-pluck 8.3.18-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
graphql-tools 9.0.17-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
@graphql-tools/load 8.0.18-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
@graphql-tools/code-file-loader 8.1.19-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
@graphql-tools/git-loader 8.0.23-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
@graphql-tools/github-loader 8.0.19-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
@graphql-tools/merge 9.0.23-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
@graphql-tools/mock 9.0.21-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
@graphql-tools/node-require 7.0.19-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
@graphql-tools/relay-operation-optimizer 7.0.18-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎
@graphql-tools/schema 10.0.22-alpha-20250313124350-d2b263d5c7f8376f95fa3c5bf725e4b6815da646 npm ↗︎ unpkg ↗︎

Verified

This commit was signed with the committer’s verified signature.
ardatan Arda TANRIKULU
Copy link

changeset-bot bot commented Mar 13, 2025

🦋 Changeset detected

Latest commit: d2b263d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
@graphql-tools/merge Patch
@graphql-tools/schema Patch
graphql-tools Patch
@graphql-tools/load Patch
@graphql-tools/mock Patch
@graphql-tools/node-require Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@ardatan ardatan merged commit 4899c62 into master Mar 13, 2025
2 of 4 checks passed
@ardatan ardatan deleted the alert-autofix-29 branch March 13, 2025 12:42
Copy link
Contributor

💻 Website Preview

The latest changes are available as preview in: https://c14c0c7c.graphql-tools.pages.dev

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.

None yet

2 participants