Files
AEmotionStudio-ComfyUI-Disc…/discordsend_utils/github_integration.py
T
google-labs-jules[bot] e1f9b50c3d Sentinel: Fix GitHub repo traversal vulnerability
Prevent arbitrary file write and repo traversal by strictly validating
`github_repo` and `file_path` inputs in `update_github_cdn_urls`.

Added `validate_github_repo` and `validate_file_path` functions to
enforce strict whitelisting of characters and reject path traversal sequences.
Added comprehensive unit tests in `tests/test_github_validation.py`.
2026-01-19 01:25:52 +00:00

182 lines
6.6 KiB
Python

"""
GitHub Integration Utilities for ComfyUI-DiscordSend
Handles updating GitHub repositories with Discord CDN URLs.
"""
import base64
import time
import re
from typing import List, Optional, Tuple
import requests
def validate_github_repo(repo: str) -> bool:
"""
Validate GitHub repository format (username/repo).
Strictly enforces alphanumeric, hyphens, underscores, and periods.
Prevents path traversal and injection.
"""
if not repo:
return False
# Pattern: username/repo
# GitHub usernames: alphanumeric, hyphens (max 39 chars)
# Repo names: alphanumeric, hyphens, periods, underscores
pattern = r"^[a-zA-Z0-9-]+/[\w.-]+$"
return bool(re.match(pattern, repo))
def validate_file_path(path: str) -> bool:
"""
Validate file path for GitHub API.
Prevents path traversal (..) and absolute paths.
"""
if not path:
return False
# Prevent traversal
if ".." in path:
return False
# Prevent absolute paths (GitHub API treats paths as relative to root)
if path.startswith("/"):
return False
return True
def update_github_cdn_urls(
github_repo: str,
github_token: str,
file_path: str,
cdn_urls: List[Tuple[str, str]],
commit_message: Optional[str] = None
) -> Tuple[bool, str]:
"""
Update a file in a GitHub repository with Discord CDN URLs.
Args:
github_repo: The GitHub repository (format: username/repo)
github_token: The GitHub personal access token for authentication
file_path: The path to the file within the repository to update
cdn_urls: List of (filename, url) tuples containing Discord CDN URLs
commit_message: Optional commit message, defaults to a standard message
Returns:
Tuple of (success, message) where success is a boolean and message is a status message
"""
# Validate required parameters
if not github_repo:
return False, "Missing GitHub repository name"
if not github_token:
return False, "Missing GitHub personal access token"
if not file_path:
return False, "Missing file path in repository"
if not cdn_urls:
return False, "No CDN URLs to update"
# Strictly validate repository format to prevent traversal/injection
if not validate_github_repo(github_repo):
return False, f"Invalid GitHub repository format: {github_repo}. Expected format: username/repo (alphanumeric, hyphens, periods, underscores only)"
# Strictly validate file path to prevent traversal
if not validate_file_path(file_path):
return False, f"Invalid file path: {file_path}. Path traversal (..) and absolute paths are not allowed."
# Setup API endpoint
api_url = f"https://api.github.com/repos/{github_repo}/contents/{file_path}"
headers = {
"Authorization": f"token {github_token}",
"Accept": "application/vnd.github.v3+json"
}
try:
# Check if file exists and get its SHA
file_sha = None
current_content = ""
response = requests.get(api_url, headers=headers, timeout=30)
if response.status_code == 200:
file_data = response.json()
file_sha = file_data.get("sha")
# Get current content
if file_data.get("content"):
current_content = base64.b64decode(file_data["content"]).decode("utf-8")
elif response.status_code == 404:
pass # File doesn't exist, will create new
else:
# Sanitize response text
error_details = response.text
if github_token and github_token in error_details:
error_details = error_details.replace(github_token, "[REDACTED_TOKEN]")
return False, f"Error checking GitHub file: {response.status_code} - {error_details}"
# Prepare file content
timestamp = time.strftime("%Y-%m-%d %H:%M:%S")
# Merge with existing content if present
existing_urls = {}
if current_content:
for line in current_content.splitlines():
if ": https://" in line and "cdn.discordapp.com" in line:
parts = line.split(": ", 1)
if len(parts) == 2:
name_part = parts[0]
# Remove numbering if present
if ". " in name_part:
name_part = name_part.split(". ", 1)[1]
existing_urls[name_part] = parts[1]
# Add new URLs (overwrites duplicates)
for filename, url in cdn_urls:
existing_urls[filename] = url
# Format content
new_content = f"# Discord CDN URLs\nLast updated: {timestamp}\n\n"
for i, (filename, url) in enumerate(existing_urls.items(), 1):
new_content += f"{i}. {filename}: {url}\n"
# Set commit message
if not commit_message:
commit_message = f"Update Discord CDN URLs - {timestamp}"
# Prepare request data
data = {
"message": commit_message,
"content": base64.b64encode(new_content.encode("utf-8")).decode("utf-8"),
}
if file_sha:
data["sha"] = file_sha
# Create/update file
response = requests.put(api_url, headers=headers, json=data, timeout=30)
if response.status_code in [200, 201]:
return True, f"Successfully updated GitHub file with {len(cdn_urls)} Discord CDN URLs"
else:
# Sanitize response text to ensure no token leakage
error_details = response.text
if github_token and github_token in error_details:
error_details = error_details.replace(github_token, "[REDACTED_TOKEN]")
return False, f"Error updating GitHub file: {response.status_code} - {error_details}"
except requests.exceptions.Timeout:
return False, "GitHub API request timed out"
except requests.exceptions.RequestException as e:
# Scrub token from error messages
error_message = str(e)
if github_token and github_token in error_message:
error_message = error_message.replace(github_token, "[REDACTED_TOKEN]")
return False, f"GitHub API request failed: {error_message}"
except Exception as e:
error_message = str(e)
if github_token and github_token in error_message:
error_message = error_message.replace(github_token, "[REDACTED_TOKEN]")
return False, f"Exception during GitHub update: {error_message}"