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

Fix 'Assertion failed' in softhsm2-dump-file when encountering a zero-length element #761

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

dogo42
Copy link

@dogo42 dogo42 commented Nov 12, 2024

softhsm2-dump-file dies when it encounters a zero-length element
like CKA_SUBJECT in imported keypairs, but tries to treat the
element as std::vector.

Example output:

...
00 00 00 00 00 00 01 01 CKA_SUBJECT
00 00 00 00 00 00 00 03 byte string attribute
00 00 00 00 00 00 00 00 (length 0)
/usr/include/c++/11/bits/stl_vector.h:1045: std::vector<_Tp, _Alloc>::reference std::vector<_Tp, _Alloc>::operator[](std::vector<_Tp, _Alloc>::size_type) [with _Tp = unsigned char; _Alloc = std::allocator; std::vector<_Tp, _Alloc>::reference = unsigned char&; std::vector<_Tp, _Alloc>::size_type = long unsigned int]: Assertion '__n < this->size()' failed.

Program received signal SIGABRT, Aborted.

Summary by CodeRabbit

  • Bug Fixes
    • Improved memory allocation and error handling for byte and attribute map processing
    • Enhanced safety checks when reading attribute data with zero length

…_SUBJECT is in imported keypairs

Example output:

00 00 00 00 00 00 01 01 CKA_SUBJECT
00 00 00 00 00 00 00 03 byte string attribute
00 00 00 00 00 00 00 00 (length 0)
/usr/include/c++/11/bits/stl_vector.h:1045: std::vector<_Tp, _Alloc>::reference std::vector<_Tp, _Alloc>::operator[](std::vector<_Tp, _Alloc>::size_type) [with _Tp = unsigned char; _Alloc = std::allocator<unsigned char>; std::vector<_Tp, _Alloc>::reference = unsigned char&; std::vector<_Tp, _Alloc>::size_type = long unsigned int]: Assertion '__n < this->size()' failed.
…e-fix

Fix 'Assertion failed' when encountering zero-length element like CKA…
Co-authored-by: Björn Svensson <bjorn.a.svensson@est.tech>
@jschlyter jschlyter added the bug Some isn't right label Dec 17, 2024
Co-authored-by: Björn Svensson <bjorn.a.svensson@est.tech>
@jschlyter jschlyter requested a review from a team as a code owner January 27, 2025 09:45
Copy link

coderabbitai bot commented Jan 27, 2025

Walkthrough

The changes focus on improving the attribute handling in the softhsm2-dump-file.cpp source file. The modifications involve more robust memory allocation and reading logic for BYTES_ATTR and ATTRMAP_ATTR types. The code now checks the length of attributes before allocating memory, preventing unnecessary allocations and potential errors when dealing with zero-length attributes.

Changes

File Change Summary
src/bin/dump/softhsm2-dump-file.cpp Improved attribute handling for BYTES_ATTR and ATTRMAP_ATTR by adding length checks before memory allocation and reading

Poem

🐰 A Rabbit's Ode to Memory Wisdom 🧠

Bytes and attrs, once wild and free,
Now checked with care, no memory spree
Zero lengths shall not pass
Allocation now has class
Safer code, hip-hip-hooray for me!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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

@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: 0

🧹 Nitpick comments (2)
src/bin/dump/softhsm2-dump-file.cpp (2)

440-448: LGTM! The fix prevents assertion failures for zero-length elements.

The changes correctly handle zero-length elements by avoiding unnecessary vector allocation.

However, the brace style needs to be adjusted to match the project's conventions.

-			if (len > 0)
-			{
+			if (len > 0)
+			{

467-476: LGTM! The fix prevents assertion failures for zero-length elements.

The changes correctly handle zero-length elements by avoiding unnecessary vector allocation.

The brace style and indentation need to be adjusted:

-			if (len > 0)
-			{
+			if (len > 0)
+			{
 				std::vector<Attribute> value;
 				if (!readMap(stream, len, value))
 				{
 					corrupt(stream);
 					return;
 				}
 				dumpMap(value);
-			}	
+			}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 913e7bf and d1c2ccf.

📒 Files selected for processing (1)
  • src/bin/dump/softhsm2-dump-file.cpp (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Windows (x86, openssl)
  • GitHub Check: Windows (x64, botan)
  • GitHub Check: macOS (botan)
  • GitHub Check: Windows (x64, openssl)
  • GitHub Check: Linux (botan)
  • GitHub Check: macOS (openssl)
  • GitHub Check: Linux (openssl)
🔇 Additional comments (1)
src/bin/dump/softhsm2-dump-file.cpp (1)

Line range hint 440-476: Overall changes look good and effectively fix the issue.

The changes consistently handle zero-length elements for both BYTES_ATTR and ATTRMAP_ATTR types by:

  1. Checking the length before allocating vectors
  2. Only performing operations when length > 0
  3. Maintaining existing error handling patterns

This effectively fixes the assertion failure mentioned in the PR description while keeping the code maintainable.

@jschlyter jschlyter requested a review from bjosv January 27, 2025 09:49
Copy link
Contributor

@bjosv bjosv left a comment

Choose a reason for hiding this comment

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

LGTM, but with same nitpick comments as coderabbitai

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Some isn't right
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants