Fix assigning not null-terminated string.

[likema]

The result buffer of ACE_TEXT_RegQueryValueEx may not be null-terminated.

This bug can be also reproduced on 6.5.x branch.

Summary by CodeRabbit

• Refactor
  • Enhanced the handling of configuration settings to improve overall stability and performance.

[jwillemsen]

Please extend one of the unit tests under ACE/tests with a reproducer

[likema]

Please extend one of the unit tests under ACE/tests with a reproducer

It may not be do it easily.

https://docs.microsoft.com/en-us/windows/win32/api/winreg/nf-winreg-regqueryvalueexa#remarks shows

If the data has the REG_SZ, REG_MULTI_SZ or REG_EXPAND_SZ type, the string may not have been stored with the proper terminating null characters. Therefore, even if the function returns ERROR_SUCCESS, the application should ensure that the string is properly terminated before using it; otherwise, it may overwrite a buffer. (Note that REG_MULTI_SZ strings should have two terminating null characters.) One way an application can en`sure that the string is properly terminated is to use RegGetValue, which adds terminating null characters if needed.

[coderabbitai]

Walkthrough

The change updates the get_string_value method in the ACE_Configuration_Win32Registry class within the ACE configuration file. Instead of assigning the string value directly from the buffer, the new implementation calls the set method with the buffer data, its length, and a boolean flag. This adjustment revises how the string is processed, potentially enhancing memory management and string handling.

Changes

File Path	Change Summary
ACE/.../Configuration.cpp	Updated get_string_value: replaced direct assignment (value = buffer.get()) with a call to value.set(buffer.get(), buffer_length, true). Also updated the method signature accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Registry
    participant Buffer
    participant Value

    Caller->>Registry: get_string_value(key, name, value)
    Registry->>Buffer: get() 
    Buffer-->>Registry: returns data
    Registry->>Value: set(data, buffer_length, true)
    Value-->>Registry: updated value stored

Loading

Poem

I am a bunny, hopping with delight,
Code changes shining ever so bright.
From a simple assign to a careful set,
Memory and safety now firmly met.
I nibble on carrots and cheer every byte!
🐇✨

✨ 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.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6c3ca3f and 051347a.

📒 Files selected for processing (1)

• ACE/ace/Configuration.cpp (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Codacy Static Code Analysis

[coderabbitai]

⚠️ Potential issue

Improved string handling to prevent buffer overruns.

The change from direct buffer assignment to using set with explicit length and null-termination flag is a critical security improvement. This fixes potential buffer overruns that could occur when RegQueryValueEx returns non-null-terminated strings, which is a documented behavior for REG_SZ, REG_MULTI_SZ, and REG_EXPAND_SZ value types.