这是indexloc提供的服务,不要输入任何密码
Skip to content

Updated modules/processors/frame/core.py to fix security vulnerability [python.lang.security.audit.non-literal-import.non-literal-import] #1285

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

kira-offgrid
Copy link

@kira-offgrid kira-offgrid commented May 16, 2025

Context and Purpose:

        This PR automatically remediates a security vulnerability:
        - **Description:** Untrusted user input in `importlib.import_module()` function allows an attacker to load arbitrary code. Avoid dynamic values in `importlib.import_module()` or use a whitelist to prevent running untrusted code.
        - **Rule ID:** python.lang.security.audit.non-literal-import.non-literal-import
        - **Severity:** MEDIUM
        - **File:** modules/processors/frame/core.py
        - **Lines Affected:** 23 - 23

        This change is necessary to protect the application from potential security risks associated with this vulnerability.

        **Solution Implemented:**

        The automated remediation process has applied the necessary changes to the affected code in `modules/processors/frame/core.py` to resolve the identified issue.

        Please review the changes to ensure they are correct and integrate as expected.

Summary by Sourcery

Mitigate a security vulnerability in dynamic module imports by enforcing a whitelist and replacing direct importlib calls with a safe import wrapper

Bug Fixes:

  • Prevent arbitrary code loading via importlib.import_module by enforcing a whitelist for frame processor modules

Enhancements:

  • Add ALLOWED_MODULES whitelist and safe_import_module function with logging for unauthorized import attempts
  • Replace importlib.import_module usage in load_frame_processor_module with safe_import_module to enforce validation

Copy link
Contributor

sourcery-ai bot commented May 16, 2025

Reviewer's Guide

This PR secures dynamic imports in modules/processors/frame/core.py by introducing a whitelist-driven safe_import_module function and replacing direct importlib.import_module calls with it; reviewers should also flag and consolidate redundant definitions.

File-Level Changes

Change Details Files
Introduced whitelist-based safe dynamic import mechanism
  • Imported typing Set and Optional
  • Defined ALLOWED_MODULES set
  • Implemented safe_import_module with whitelist check and warning log
modules/processors/frame/core.py
Replaced dynamic import usage with safe_import_module
  • Changed importlib.import_module call to safe_import_module in load_frame_processor_module
modules/processors/frame/core.py
Duplicated safe_import_module and whitelist definitions
  • Multiple identical blocks of ALLOWED_MODULES and safe_import_module were inserted
  • Suggest consolidating to a single definition
modules/processors/frame/core.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @kira-offgrid - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • safe_import_module calls itself recursively (link)

  • There are multiple duplicated definitions of ALLOWED_MODULES and safe_import_module; consolidate them into a single definition at the top.

  • The safe_import_module function currently calls itself recursively—replace that with importlib.import_module to actually load the module.

  • load_frame_processor_module should handle the None case returned by safe_import_module to avoid unexpected attribute checks on None.

Here's what I looked at during the review
  • 🔴 General issues: 1 blocking issue, 2 other issues
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +25 to +26
if module_name in ALLOWED_MODULES:
return safe_import_module(module_name)
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (bug_risk): safe_import_module calls itself recursively

This causes infinite recursion; use importlib.import_module(module_name) instead of calling safe_import_module.

Suggested change
if module_name in ALLOWED_MODULES:
return safe_import_module(module_name)
if module_name in ALLOWED_MODULES:
return importlib.import_module(module_name)

@@ -1,12 +1,129 @@
import sys
import importlib
from typing import Set, Optional

# Define a whitelist of allowed modules that can be dynamically imported
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Duplicate whitelist and function definitions

Consolidate the repeated whitelist and safe_import_module definitions into a single implementation to simplify maintenance and avoid confusion.

@@ -20,7 +137,7 @@

def load_frame_processor_module(frame_processor: str) -> Any:
try:
frame_processor_module = importlib.import_module(f'modules.processors.frame.{frame_processor}')
frame_processor_module = safe_import_module(f'modules.processors.frame.{frame_processor}')
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (bug_risk): Handle None return from safe_import_module

Check frame_processor_module for None before using it to avoid an AttributeError.

Suggested change
frame_processor_module = safe_import_module(f'modules.processors.frame.{frame_processor}')
frame_processor_module = safe_import_module(f'modules.processors.frame.{frame_processor}')
if frame_processor_module is None:
sys.exit(f"Failed to load frame processor module: modules.processors.frame.{frame_processor}")

Comment on lines +27 to +30
else:
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (code-quality): Remove unnecessary else after guard condition (remove-unnecessary-else)

Suggested change
else:
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None

Comment on lines +57 to +60
else:
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (code-quality): Remove unnecessary else after guard condition (remove-unnecessary-else)

Suggested change
else:
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None

Comment on lines +92 to +95
else:
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (code-quality): Remove unnecessary else after guard condition (remove-unnecessary-else)

Suggested change
else:
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None

Comment on lines +122 to +125
else:
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (code-quality): Remove unnecessary else after guard condition (remove-unnecessary-else)

Suggested change
else:
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None
# Log the attempt to import a non-whitelisted module
print(f"Warning: Attempted to import non-whitelisted module: {module_name}")
return None

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