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

better and secure file handling #33

Merged
merged 3 commits into from
Jan 6, 2025
Merged

better and secure file handling #33

merged 3 commits into from
Jan 6, 2025

Conversation

skerbis
Copy link
Member

@skerbis skerbis commented Jan 6, 2025

Summary by CodeRabbit

  • Security Improvements

    • Enhanced file upload validation by checking MIME types
    • Improved file handling with unique temporary filename generation
  • Bug Fixes

    • Prevented potential file overwrite issues during upload and download processes

Copy link
Contributor

coderabbitai bot commented Jan 6, 2025

Warning

Rate limit exceeded

@skerbis has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 13 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between aa84b11 and 0da29fd.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • lib/zip_install.php (2 hunks)

Walkthrough

The pull request introduces enhanced file upload validation and improved temporary filename generation in the lib/zip_install.php file. The changes focus on adding MIME type validation for uploaded files, restricting uploads to 'application/zip' and 'application/octet-stream' types. Additionally, the temporary filename generation is updated to use uniqid(), ensuring unique filenames for both uploaded and downloaded files, which prevents potential file overwrites.

Changes

File Change Summary
lib/zip_install.php - Added MIME type validation for file uploads
- Restricted file uploads to 'application/zip' and 'application/octet-stream' types
- Updated temporary filename generation using uniqid()

Possibly related PRs

  • stan comments #32: Modification of the handleFileUpload method in lib/zip_install.php, which is directly connected to the file upload validation changes in this PR.

Poem

🐰 A Rabbit's Ode to File Upload Care 🔒

Zip files dancing, MIME types in check,
Unique names spawned with each tech trek,
No more temp conflicts, no file overlap,
Security's guardian, avoiding each trap!

Hop hop, code safe! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 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
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: 2

🔭 Outside diff range comments (1)
lib/zip_install.php (1)

Line range hint 141-187: Protect against ZIP slip and path traversal vulnerabilities

The ZIP extraction process is vulnerable to directory traversal attacks. Add validation for extracted filenames:

 for ($i = 0; $i < $zip->numFiles; $i++) {
     /** @var array{name: string, index: int, size: int, mtime: int, crc: int, comp_size: int, comp_method: int} $stat */
     $stat = $zip->statIndex($i);
     $filename = $stat['name'];
+    
+    // Protect against ZIP slip
+    $realPath = realpath($extractPath . $filename);
+    if ($realPath === false || !str_starts_with($realPath, realpath($extractPath))) {
+        throw new Exception(rex_i18n::msg('zip_install_security_warning'));
+    }

     if ($i == 0) {
         // First entry must be a directory

Also, consider:

  1. Implementing file size limits for extracted files
  2. Adding timeout for extraction process
  3. Improving cleanup error handling
🧹 Nitpick comments (1)
lib/zip_install.php (1)

Line range hint 1-359: Consider implementing comprehensive file handling security

While the changes improve file handling, consider implementing a dedicated secure file handling class that encapsulates all security measures:

  1. File validation (MIME, extension, content)
  2. Secure temporary file management
  3. ZIP security (slip protection, size limits)
  4. Cleanup management

This would improve maintainability and ensure consistent security across the codebase.

Would you like me to provide an example implementation of such a class?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6b6c044 and aa84b11.

📒 Files selected for processing (1)
  • lib/zip_install.php (2 hunks)
🔇 Additional comments (1)
lib/zip_install.php (1)

123-123: Apply secure filename generation for downloads

Similar to the upload file handling, replace uniqid() with cryptographically secure random filename generation.


// Check filesize
$maxSize = $this->addon->getConfig('upload_max_size', 20) * 1024 * 1024; // Convert MB to bytes
if ($uploadedFile['size'] > $maxSize) {
return rex_view::error(rex_i18n::msg('zip_install_size_error', $this->addon->getConfig('upload_max_size', 20)));
}

$tmpFile = $this->tmpFolder . '/temp.zip';
$tmpFile = $this->tmpFolder . '/' . uniqid('upload_') . '.zip'; // Generate unique filename
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Use cryptographically secure random filenames

Using uniqid() for filename generation is not cryptographically secure and could be predictable. Consider using random_bytes() for better security:

-$tmpFile = $this->tmpFolder . '/' . uniqid('upload_') . '.zip';
+$tmpFile = $this->tmpFolder . '/' . 'upload_' . bin2hex(random_bytes(16)) . '.zip';

Also, consider implementing exclusive file creation to prevent race conditions:

$tmpFile = tempnam($this->tmpFolder, 'upload_');
if ($tmpFile === false) {
    throw new Exception(rex_i18n::msg('zip_install_temp_file_failed'));
}
rename($tmpFile, $tmpFile . '.zip');
$tmpFile .= '.zip';

Comment on lines 62 to 67
// Check mime type
$allowedMimeTypes = ['application/zip', 'application/octet-stream'];
if (!in_array($uploadedFile['type'], $allowedMimeTypes)) {
return rex_view::error(rex_i18n::msg('zip_install_mime_error'));
}

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Enhance file validation security

While MIME type validation is a good start, it's insufficient as MIME types can be easily spoofed. Consider implementing additional security measures:

  1. Validate file extension (e.g., .zip)
  2. Verify file content using ZipArchive::open() before moving the file
  3. Consider using fileinfo extension to detect actual MIME type:
 // Check mime type
 $allowedMimeTypes = ['application/zip', 'application/octet-stream'];
-if (!in_array($uploadedFile['type'], $allowedMimeTypes)) {
+
+// Verify file extension
+if (!preg_match('/\.zip$/i', $uploadedFile['name'])) {
+    return rex_view::error(rex_i18n::msg('zip_install_invalid_extension'));
+}
+
+// Check actual MIME type using fileinfo
+$finfo = new finfo(FILEINFO_MIME_TYPE);
+$mimeType = $finfo->file($uploadedFile['tmp_name']);
+if (!in_array($mimeType, $allowedMimeTypes)) {
     return rex_view::error(rex_i18n::msg('zip_install_mime_error'));
 }
+
+// Verify ZIP structure
+$zip = new ZipArchive();
+if ($zip->open($uploadedFile['tmp_name']) !== true) {
+    return rex_view::error(rex_i18n::msg('zip_install_invalid_zip'));
+}
+$zip->close();
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Check mime type
$allowedMimeTypes = ['application/zip', 'application/octet-stream'];
if (!in_array($uploadedFile['type'], $allowedMimeTypes)) {
return rex_view::error(rex_i18n::msg('zip_install_mime_error'));
}
// Check mime type
$allowedMimeTypes = ['application/zip', 'application/octet-stream'];
// Verify file extension
if (!preg_match('/\.zip$/i', $uploadedFile['name'])) {
return rex_view::error(rex_i18n::msg('zip_install_invalid_extension'));
}
// Check actual MIME type using fileinfo
$finfo = new finfo(FILEINFO_MIME_TYPE);
$mimeType = $finfo->file($uploadedFile['tmp_name']);
if (!in_array($mimeType, $allowedMimeTypes)) {
return rex_view::error(rex_i18n::msg('zip_install_mime_error'));
}
// Verify ZIP structure
$zip = new ZipArchive();
if ($zip->open($uploadedFile['tmp_name']) !== true) {
return rex_view::error(rex_i18n::msg('zip_install_invalid_zip'));
}
$zip->close();

@skerbis skerbis merged commit 3f20fa4 into main Jan 6, 2025
1 check passed
@alxndr-w alxndr-w deleted the skerbis-patch-3 branch January 7, 2025 01:02
@alxndr-w alxndr-w added this to the 2.0.0 milestone Jan 7, 2025
@coderabbitai coderabbitai bot mentioned this pull request Jan 8, 2025
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.

2 participants