Skip to content

Refactor entropy detection logic and improve traversal #299

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.

Sign up for GitHub

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
Sejusahu011 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refactor entropy detection logic and improve traversal #299

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 72 additions & 74 deletions backend/app/scanners/entropy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import math
import re
import os
from collections import Counter
from pathlib import Path
from typing import List
Expand Down Expand Up @@ -45,82 +46,79 @@ def is_allowlisted(token: str) -> bool:

def run_entropy(repo_dir: Path) -> List[Finding]:
findings: List[Finding] = []

ignored_dirs = {
"node_modules", "venv", ".venv", "build", "dist", "target", ".next",
".cache", "coverage", "vendor", "__pycache__", ".git",
".idea", ".vscode", ".tox", ".pytest_cache", ".mypy_cache",
".ruff_cache", "bin", "obj", "out", "tmp"
}

ignored_extensions = {
".png",
".jpg",
".jpeg",
".gif",
".ico",
".svg",
".zip",
".tar",
".gz",
".mp4",
".pdf",
".woff",
".woff2",
".eot",
".ttf",
".png", ".jpg", ".jpeg", ".gif", ".ico", ".svg", ".zip",
".tar", ".gz", ".mp4", ".pdf", ".woff", ".woff2", ".eot", ".ttf",
}

for file_path in repo_dir.rglob("*"):
if (
not file_path.is_file()
or file_path.suffix.lower() in ignored_extensions
or ".git" in file_path.parts
):
continue

try:
content = file_path.read_text(encoding="utf-8", errors="ignore")
except Exception:
continue

lines = content.splitlines()
for line_idx, line in enumerate(lines, start=1):
for match in STRING_LITERAL_REGEX.finditer(line):
token = match.group(2)

if is_allowlisted(token):
continue

entropy_score = calculate_shannon_entropy(token)
if entropy_score > 4.0:
relative_path = str(file_path.relative_to(repo_dir))
finding_id = (
f"entropy:high-entropy-string:{relative_path}:{line_idx}"
)
severity = "HIGH"

raw_data_for_extractor = {
"id": finding_id,
"severity": severity,
"location": {"path": relative_path},
"metadata": {"cwe_category": "CWE-798"},
}

ml_features = extract_features(
raw_data_for_extractor, scanner_name="entropy"
)

findings.append(
Finding(
id=finding_id,
category="secret",
severity=severity,
title="High Entropy String Detected",
description=f"Potential hardcoded secret or token discovered (Entropy: {entropy_score:.2f})",
location=Location(
path=relative_path,
start_line=line_idx,
end_line=line_idx,
),
metadata={
"engine": "entropy",
"entropy_score": entropy_score,
"token_preview": token[:10],
},
features=ml_features,
# Using os.walk for memory-efficient directory traversal
for root, dirs, files in os.walk(repo_dir):
# Prune the ignored directories in-place to skip them entirely
dirs[:] = [d for d in dirs if d not in ignored_dirs]

for file_name in files:
file_path = Path(root) / file_name

# Extension check
if file_path.suffix.lower() in ignored_extensions:
continue

try:
content = file_path.read_text(encoding="utf-8", errors="ignore")
except Exception:
continue

lines = content.splitlines()
for line_idx, line in enumerate(lines, start=1):
for match in STRING_LITERAL_REGEX.finditer(line):
token = match.group(2)

if is_allowlisted(token):
continue

entropy_score = calculate_shannon_entropy(token)
if entropy_score > 4.0:
relative_path = str(file_path.relative_to(repo_dir))
finding_id = f"entropy:high-entropy-string:{relative_path}:{line_idx}"
severity = "HIGH"

raw_data_for_extractor = {
"id": finding_id,
"severity": severity,
"location": {"path": relative_path},
"metadata": {"cwe_category": "CWE-798"},
}

ml_features = extract_features(
raw_data_for_extractor, scanner_name="entropy"
)

findings.append(
Finding(
id=finding_id,
category="secret",
severity=severity,
title="High Entropy String Detected",
description=f"Potential hardcoded secret or token discovered (Entropy: {entropy_score:.2f})",
location=Location(
path=relative_path,
start_line=line_idx,
end_line=line_idx,
),
metadata={
"engine": "entropy",
"entropy_score": entropy_score,
"token_preview": token[:10],
},
features=ml_features,
)
)
)
return findings
Loading