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(secrets): Multiple matching groups are being caught as regex separated by | sign #6967

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

Conversation

pazbechor
Copy link
Contributor

@pazbechor pazbechor commented Jan 24, 2025

User description

… (in multiline policy) captured, so matching group will be the match & empty matching as only one pattern caught the secret

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

New/Edited policies (Delete if not relevant)

Description

Include a description of what makes it a violation and any relevant external links.

Fix

How does someone fix the issue in code and/or in runtime?

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my feature, policy, or fix is effective and works
  • New and existing tests pass locally with my changes

Generated description

Below is a concise technical summary of the changes proposed in this PR:

Enhances the CustomRegexDetector class to handle multiple matching groups in multiline regex patterns. Introduces a new method _extract_real_regex_match to extract the first non-empty match from a tuple of regex matches. Updates type hints to accommodate the new functionality.

TopicDetails
Regex Match Handling Improves the handling of multiple matching groups in multiline regex patterns for secret detection
Modified files (1)
  • checkov/secrets/plugins/custom_regex_detector.py
Latest Contributors(2)
UserCommitDate
omryMenfix-secrets-fix-find-l...November 21, 2024
RabeaZrfix-secrets-multiline-...November 21, 2024
Type Annotations Updates type hints to support the new regex match handling functionality
Modified files (1)
  • checkov/secrets/plugins/custom_regex_detector.py
Latest Contributors(2)
UserCommitDate
omryMenfix-secrets-fix-find-l...November 21, 2024
RabeaZrfix-secrets-multiline-...November 21, 2024
This pull request is reviewed by Baz. Join @pazbechor and the rest of your team on (Baz).

… (in multiline policy) captured, so matching group will be the match & empty matching as only one pattern caught the secret
@pazbechor pazbechor changed the title fix(secrets) Multiple matching groups are being caught as regex separated by | sign fix(secrets): Multiple matching groups are being caught as regex separated by | sign Jan 24, 2025
if isinstance(regex_matches, tuple):
for match in regex_matches:
if match:
return match
Copy link
Contributor

Choose a reason for hiding this comment

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

what happens if there are multiple capturing groups and the resulting tuple has multiple values? will you just take the first value? why?

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.

4 participants