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

Fixed possible access to unallocated memory in MPRESS unpacker #1

Merged
merged 1 commit into from
Aug 3, 2024

Conversation

2lambda123
Copy link
Owner

@2lambda123 2lambda123 commented Aug 3, 2024

If the size of data is less than 0x1000 then we can possibly underflow unsigned int and access unallocated data.

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

Fix potential memory access issue in the MPRESS unpacker by adjusting the calculation of the maximum address to prevent underflow.

Bug Fixes:

  • Prevent possible access to unallocated memory in the MPRESS unpacker by ensuring the buffer size does not underflow.

Summary by CodeRabbit

  • Bug Fixes
    • Improved the stability of the jump and call fixing logic to prevent potential underflow issues, enhancing overall performance.

If the size of data is less than 0x1000 then we can possibly underflow
unsigned int and access unallocated data.
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

Unable to locate .performanceTestingBot config file

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

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

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 2452 public PRs merged
  • They haven't contributed to this repo 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: 2lambda123/Accenture-sfmc-devtools#104

Copy link

Processing PR updates...

Copy link

git-greetings bot commented Aug 3, 2024

First PR by @2lambda123

PR Details of @2lambda123 in avast-retdec :

OPEN CLOSED TOTAL
1 0 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 changes enhance the robustness of the fixJumpsAndCalls method in the MpressPlugin class. By modifying the calculation of the maxAddr variable to use std::max, the code now prevents negative values from causing potential underflow issues. This adjustment ensures that the logic for fixing jumps and calls is more stable, improving overall performance and reliability.

Changes

Files Change Summary
src/unpackertool/plugins/mpress/mpress.cpp Updated calculation of maxAddr in fixJumpsAndCalls method to prevent underflow issues.

Poem

🌟 In the land of bytes where the rabbits play,
A fix was made, hip-hip-hooray!
With maxAddr now safe, no more fright,
Jumping and calling in the code feels just right.
So here’s to the changes, let’s hop and cheer,
For stable jumps that bring us near! 🐇✨


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.

Copy link

sourcery-ai bot commented Aug 3, 2024

Reviewer's Guide by Sourcery

This pull request addresses a potential issue in the MPRESS unpacker where accessing unallocated memory could occur if the buffer size is less than 0x1000. The fix involves modifying the calculation of the maxAddr variable to use std::max, ensuring that the result does not underflow.


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.

@@ -234,7 +234,7 @@ std::uint32_t MpressPlugin::getFixStub()
void MpressPlugin::fixJumpsAndCalls(DynamicBuffer& buffer)
{
std::uint32_t pos = 0;
std::uint32_t maxAddr = buffer.getRealDataSize() - 0x1000;
std::uint32_t maxAddr = std::max(0, static_cast<std::int32_t>(buffer.getRealDataSize()) - 0x1000);

Choose a reason for hiding this comment

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

The calculation of maxAddr is problematic. The use of std::max(0, static_cast<std::int32_t>(buffer.getRealDataSize()) - 0x1000) is incorrect because std::max expects both arguments to be of the same type. Here, the first argument is an int and the second is an std::int32_t. This can lead to unexpected behavior or even bugs.

Recommended Solution: Ensure both arguments to std::max are of the same type, preferably std::int32_t in this context.

@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
@2lambda123 2lambda123 merged commit 4b1b4fa into master Aug 3, 2024
16 of 28 checks passed
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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

@@ -234,7 +234,7 @@ std::uint32_t MpressPlugin::getFixStub()
void MpressPlugin::fixJumpsAndCalls(DynamicBuffer& buffer)
{
std::uint32_t pos = 0;
std::uint32_t maxAddr = buffer.getRealDataSize() - 0x1000;
std::uint32_t maxAddr = std::max(0, static_cast<std::int32_t>(buffer.getRealDataSize()) - 0x1000);
Copy link

Choose a reason for hiding this comment

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

suggestion: Consider defining 0x1000 as a named constant for improved readability and maintainability.

Using a named constant would make the code more self-documenting and easier to update if this value needs to change in the future.

Suggested change
std::uint32_t maxAddr = std::max(0, static_cast<std::int32_t>(buffer.getRealDataSize()) - 0x1000);
constexpr std::uint32_t PAGE_SIZE = 0x1000;
std::uint32_t maxAddr = std::max(0, static_cast<std::int32_t>(buffer.getRealDataSize()) - PAGE_SIZE);

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

codeautopilot bot commented Aug 3, 2024

PR summary

This Pull Request addresses a potential bug in the MPRESS unpacker where accessing unallocated memory could occur if the data size is less than 0x1000. The fix involves ensuring that the calculation of maxAddr does not underflow by using std::max to compare the result with zero.

Suggestion

Consider adding a unit test to verify that the function behaves correctly when buffer.getRealDataSize() is less than 0x1000. This will help ensure that the fix works as intended and prevent future regressions.

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

Current plan usage: 6.55%

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