Skip to content

Fix: regex vulnerable to super-linear runtime due to excessive backtracking #1851

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

Merged
merged 1 commit into from
Jan 27, 2025

Conversation

jaybuidl
Copy link
Member

@jaybuidl jaybuidl commented Jan 27, 2025

Flagged here: https://sonarcloud.io/project/security_hotspots?id=kleros_kleros-v2&branch=dev&issueStatuses=OPEN%2CCONFIRMED&sinceLeakPeriod=true&tab=code


PR-Codex overview

This PR updates the regular expression used to validate numeric values in the commify function within the web/src/utils/commify.ts file to ensure it correctly matches integers and decimals.

Detailed summary

  • Changed the regex in the conditional check from /^-?[0-9]*\.?[0-9]*$/ to /^-?\d+(\.\d+)?$/ for improved validation of numeric formats.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • Bug Fixes
    • Improved number input validation to prevent invalid number formats
    • Enhanced input parsing to require at least one digit in numeric inputs

Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

Walkthrough

The pull request introduces a modification to the regular expression validation in the commify utility function within the web application. The updated regex pattern improves input validation by ensuring that the input contains at least one digit, preventing edge cases like inputs with only a decimal point or leading zeros without significant digits.

Changes

File Change Summary
web/src/utils/commify.ts Updated regex pattern from /-?[0-9]*\.?[0-9]*$/ to /-?\d+(\.\d+)?$/ to enforce more strict number input validation

Poem

🐰 A Regex Rabbit's Delight

Digits dance, no empty plight,
Decimal points now shine so bright,
No zeros leading, no lone dot's flight,
Commify's magic takes pure delight!

🔢✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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. (Beta)
  • @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 or @coderabbitai title 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

netlify bot commented Jan 27, 2025

Deploy Preview for kleros-v2-testnet ready!

Name Link
🔨 Latest commit f191315
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet/deploys/67979269cf9c3b0008aa2cce
😎 Deploy Preview https://deploy-preview-1851--kleros-v2-testnet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for kleros-v2-neo ready!

Name Link
🔨 Latest commit f191315
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-neo/deploys/679792694f8eef0008aa117f
😎 Deploy Preview https://deploy-preview-1851--kleros-v2-neo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codeclimate bot commented Jan 27, 2025

Code Climate has analyzed commit f191315 and detected 0 issues on this pull request.

View more on Code Climate.

Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for kleros-v2-university ready!

Name Link
🔨 Latest commit f191315
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-university/deploys/679792694fb08e00085b02b3
😎 Deploy Preview https://deploy-preview-1851--kleros-v2-university.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for kleros-v2-testnet-devtools ready!

Name Link
🔨 Latest commit f191315
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet-devtools/deploys/6797926913193f00080e0ab6
😎 Deploy Preview https://deploy-preview-1851--kleros-v2-testnet-devtools.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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 (2)
web/src/utils/commify.ts (2)

4-6: Consider adding input length validation.

While the regex is now safe from catastrophic backtracking, it might be good to add a maximum length check for the input to prevent unnecessarily processing very long strings.

 export function commify(value: string | number): string {
   const comps = String(value).split(".");
 
+  // Reject unreasonably long inputs (e.g., > 256 chars)
+  if (String(value).length > 256) {
+    return "0";
+  }
+
   if (!String(value).match(/^-?\d+(\.\d+)?$/)) {
     return "0";
   }

Line range hint 1-52: Consider using built-in number formatting.

For better maintainability and localization support, consider using Intl.NumberFormat instead of custom string manipulation.

 export function commify(value: string | number): string {
+  // Validate input first
   const comps = String(value).split(".");
   if (!String(value).match(/^-?\d+(\.\d+)?$/)) {
     return "0";
   }
 
-  // Make sure we have at least one whole digit (0 if none)
-  let whole = comps[0];
-  // ... rest of the current implementation
-
-  return negative + formatted.join(",") + suffix;
+  // Parse and format the number
+  const num = parseFloat(String(value));
+  return new Intl.NumberFormat('en-US', {
+    minimumFractionDigits: comps[1]?.length || 0,
+    maximumFractionDigits: comps[1]?.length || 0,
+  }).format(num);
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e18c73c and f191315.

📒 Files selected for processing (1)
  • web/src/utils/commify.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (16)
  • GitHub Check: Redirect rules - kleros-v2-university
  • GitHub Check: Header rules - kleros-v2-university
  • GitHub Check: Pages changed - kleros-v2-university
  • GitHub Check: Redirect rules - kleros-v2-neo
  • GitHub Check: Header rules - kleros-v2-neo
  • GitHub Check: Pages changed - kleros-v2-neo
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: contracts-testing
  • GitHub Check: dependency-review
  • GitHub Check: Analyze (javascript)
  • GitHub Check: SonarCloud
🔇 Additional comments (1)
web/src/utils/commify.ts (1)

4-4: Approve: Regex pattern fixed to prevent catastrophic backtracking.

The new regex pattern /^-?\d+(\.\d+)?$/ effectively addresses the security vulnerability by:

  • Using + quantifier instead of * to prevent empty matches
  • Properly grouping the decimal part
  • Anchoring at both ends with ^ and $

Let's verify the fix prevents catastrophic backtracking with various inputs:

✅ Verification successful

✅ Verified: New regex pattern is secure and performs efficiently

The verification confirms the pattern /^-?\d+(\.\d+)?$/ successfully prevents catastrophic backtracking, processing both valid and invalid inputs (up to 1000 characters) in under 10ms total.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Create a test file to verify the regex performance
cat << 'EOF' > test.js
const regex = /^-?\d+(\.\d+)?$/;
const inputs = [
  "1234.56",           // Valid number
  "000000000",         // Many leading zeros
  "............",      // Many dots
  "1".repeat(1000),    // Long valid input
  ".".repeat(1000),    // Long invalid input
];

console.time('regex');
inputs.forEach(input => {
  console.log(`Testing: ${input.slice(0, 20)}... (length: ${input.length})`);
  console.log(`Result: ${regex.test(input)}`);
});
console.timeEnd('regex');
EOF

# Run the test
node test.js

Length of output: 302

@jaybuidl jaybuidl merged commit ec16bb7 into dev Jan 27, 2025
27 checks passed
@jaybuidl jaybuidl deleted the fix/regex-dos branch January 27, 2025 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant