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

Use image loader when loading corrupted resources #3

Merged
merged 1 commit into from
Aug 3, 2024

Conversation

2lambda123
Copy link
Owner

@2lambda123 2lambda123 commented Aug 3, 2024

When the resource tree doesn't have expected depth, we use different path to load resources which didn't use loader but calculated offset from RVA on it's own resulting in underflows on integers and completely bogus offsets. Even though offsets are still kinda bogus, they make sense and are within the file itself after this change.

Example file: f39f1ad9f97766618826d47c2d32529425e773659f5577fea06a82e21f13b064

Description

Related Issue

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (non-breaking change that does not add functionality or fix an issue)

Checklist:

  • I have read the Code of Conduct
  • I have updated the documentation accordingly.
  • All commits are GPG signed

Summary by Sourcery

Use image loader for calculating offsets when loading corrupted resources to prevent integer underflows and ensure offsets are within the file.

Bug Fixes:

  • Fix resource loading to use image loader for calculating offsets, preventing integer underflows and invalid offsets.

Summary by CodeRabbit

  • Bug Fixes
    • Improved accuracy of resource offset calculations, enhancing overall resource loading reliability.

When the resource tree doesn't have expected depth, we use different
path to load resources which didn't use loader but calculated offset
from RVA on it's own resulting in underflows on integers and completely
bogus offsets. Even though offsets are still kinda bogus, they make
sense and are within the file itself after this change.

Example file: f39f1ad9f97766618826d47c2d32529425e773659f5577fea06a82e21f13b064
Copy link

Unable to locate .performanceTestingBot config file

Copy link

Processing PR updates...

Copy link

cr-gpt bot commented Aug 3, 2024

Seems you are using me but didn't get OPENAI_API_KEY seted in Variables/Secrets for this repo. you could follow readme for more information

Copy link

@gitginie gitginie bot left a comment

Choose a reason for hiding this comment

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

@2lambda123
Thank you for your contribution to this repository! We appreciate your effort in opening pull request.
Happy coding!

Copy link

git-greetings bot commented Aug 3, 2024

Thanks @2lambda123 for opening this PR!

For COLLABORATOR only :

  • To add labels, comment on the issue
    /label add label1,label2,label3

  • To remove labels, comment on the issue
    /label remove label1,label2,label3

Copy link

quine-bot bot commented Aug 3, 2024

👋 Figuring out if a PR is useful is hard, hopefully this will help.

  • @2lambda123 has been on GitHub since 2019 and in that time has had 2453 public PRs merged
  • Don't you recognize them? They've been here before 🎉
  • Here's a good example of their work: HeyGenClone
  • From looking at their profile, they seem to be good with C++ and Python.

Their most recently public accepted PR is: #1

Copy link

coderabbitai bot commented Aug 3, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent update enhances the loadResourceNodes function in the PeFormat class by refining how resource offsets are calculated. The previous method, which directly calculated offsets using relative virtual addresses, has been replaced with a method call to getValidOffsetFromRva(). This change improves code clarity and maintainability, suggesting a more reliable approach to handling offsets, while preserving the overall logic of the function.

Changes

Files Change Summary
src/fileformat/file_format/pe/pe_format.cpp Modified loadResourceNodes function to use getImageLoader().getValidOffsetFromRva() for offset calculation, enhancing clarity and maintainability.

Poem

🐇 In the code where offsets play,
A rabbit hops and finds the way.
With clearer paths and logic bright,
We celebrate this coding light!
So here’s to changes, big and small,
Making our code the best of all! 🌟


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@labels-and-badges labels-and-badges bot added NO JIRA This PR does not have a Jira Ticket PR:size/XS Denotes a Pull Request that changes 0-9 lines. labels Aug 3, 2024
Copy link

git-greetings bot commented Aug 3, 2024

PR Details of @2lambda123 in avast-retdec :

OPEN CLOSED TOTAL
1 2 3

Comment on lines 1652 to 1656
auto resource = std::make_unique<Resource>();
resource->setOffset(leaf->getOffsetToData() - rva + formatParser->getResourceDirectoryOffset());
resource->setOffset(getImageLoader().getValidOffsetFromRva(leaf->getOffsetToData()));
resource->setSizeInFile(leaf->getSize());
resource->load(this);
resourceTable->addResource(std::move(resource));

Choose a reason for hiding this comment

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

The code does not handle potential exceptions that might be thrown by getValidOffsetFromRva, getSize, or load methods. If any of these methods throw an exception, it could lead to resource leaks or inconsistent state.

Recommended Solution:
Wrap the code in a try-catch block to handle potential exceptions and ensure that resources are properly managed in case of an error.

Copy link

sourcery-ai bot commented Aug 3, 2024

Reviewer's Guide by Sourcery

This pull request addresses an issue with loading corrupted resources by changing the offset calculation method. Instead of manually calculating offsets, the code now uses the image loader's getValidOffsetFromRva method. This change prevents integer underflows and ensures that offsets remain within the file boundaries.

File-Level Changes

Files Changes
src/fileformat/file_format/pe/pe_format.cpp Updated the resource loading mechanism to use the image loader for calculating valid offsets, preventing underflows and ensuring offsets are within the file.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@2lambda123 2lambda123 merged commit 05a4595 into master Aug 3, 2024
14 of 27 checks passed
Copy link

@gitginie gitginie bot left a comment

Choose a reason for hiding this comment

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

@2lambda123
Thank you for your contribution to this repository! We appreciate your effort in closing pull request.
Happy coding!

Copy link

@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 @2lambda123 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a brief inline comment explaining why getValidOffsetFromRva() is used instead of the previous calculation method.
  • Please provide more details on how to use the example file mentioned (f39f1ad9f97766618826d47c2d32529425e773659f5577fea06a82e21f13b064) to reproduce the issue and verify the fix.
  • The PR template checkboxes are not filled out. Please complete this information to clarify the nature and impact of your changes.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: 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 to tell me if it was helpful.

Copy link

codeautopilot bot commented Aug 3, 2024

PR summary

This Pull Request addresses an issue with loading corrupted resources in the PE file format. Previously, when the resource tree did not have the expected depth, the code calculated offsets from RVA manually, leading to integer underflows and invalid offsets. The change ensures that the image loader is used to obtain valid offsets, which are within the file itself, even if they are still somewhat incorrect. This improves the robustness of the resource loading process for corrupted files.

Suggestion

Consider adding unit tests to verify the behavior of the new offset calculation method, especially with corrupted resource trees. This will help ensure that the changes work as expected and prevent regressions in the future.

Disclaimer: This comment was entirely generated using AI. Be aware that the information provided may be incorrect.

Current plan usage: 6.86%

Have feedback or need help?
Discord
Documentation
[email protected]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NO JIRA This PR does not have a Jira Ticket PR:size/XS Denotes a Pull Request that changes 0-9 lines. size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants