Skip to content

Add cli_append() as safer CLI string handler.#83

Open
acutetech wants to merge 1 commit intodevfrom
cli_append
Open

Add cli_append() as safer CLI string handler.#83
acutetech wants to merge 1 commit intodevfrom
cli_append

Conversation

@acutetech
Copy link

Also, modified .gitignore so it stops tracking we2_image_gen_local_dpd/secureboot_tool/* build artifacts.

…stop saving we2_image_gen_local_dpd/secureboot_tool/*
@gemini-code-assist
Copy link

Summary of Changes

Hello @acutetech, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the robustness of the command-line interface (CLI) by introducing a safer string handling mechanism. A new cli_append() function has been implemented and integrated throughout the CLI command files, replacing less safe snprintf() patterns to prevent buffer overflows. Additionally, the .gitignore configuration was updated to prevent tracking of build artifacts from the secureboot tool, contributing to a cleaner and more focused repository.

Highlights

  • Safer CLI String Handling: Introduced a new utility function, cli_append(), to safely append formatted strings to CLI output buffers, preventing potential buffer overflows by managing the buffer pointer and remaining length.
  • Refactored CLI Output: Replaced numerous direct snprintf() calls with the new cli_append() function across various CLI command implementations, enhancing robustness and safety in string manipulation.
  • Gitignore Update: Modified the .gitignore file to exclude build artifacts (e.g., .crt, .txt, .log files) generated by the secureboot_tool within the we2_image_gen_local_dpd directory, cleaning up the repository.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • .gitignore
    • Added new ignore rules for .crt, .txt, and .log files within the we2_image_gen_local_dpd/secureboot_tool/ directory.
  • EPII_CM55M_APP_S/app/ww_projects/ww500_md/CLI-FATFS-commands.c
    • Replaced multiple instances of snprintf with cli_append for safer string formatting in FATFS-related CLI commands.
  • EPII_CM55M_APP_S/app/ww_projects/ww500_md/CLI-commands.c
    • Implemented the cli_append function to provide a safer method for appending formatted strings to CLI output buffers.
    • Replaced numerous snprintf calls with cli_append across various CLI command handlers.
    • Removed a redundant blank line.
  • EPII_CM55M_APP_S/app/ww_projects/ww500_md/CLI-commands.h
    • Declared the new cli_append function prototype.
  • we2_image_gen_local_dpd/secureboot_tool/cert/ICVSBContent_Cert.txt
    • Removed the file, as it is now ignored by .gitignore.
Activity
  • No specific activity (comments, reviews) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

The pull request successfully introduces cli_append() as a safer alternative for appending strings to CLI output buffers, which helps prevent buffer overflows and simplifies pointer management. I have identified several issues regarding consistency in the use of the new function, a missing header for variadic arguments, and some indentation inconsistencies.

// for some reason this returns 0 always, so no point in printing it:
// uxTaskGetTaskNumber(internalStates[i].task_id)
pcWriteBuffer += snprintf(pcWriteBuffer, xWriteBufferLen, "%s\t%d\t%s\t%d",
snprintf(pcWriteBuffer, xWriteBufferLen, "%s\t%d\t%s\t%d",

Choose a reason for hiding this comment

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

medium

For consistency with the PR's objective and to ensure safe buffer handling, cli_append should be used here instead of snprintf directly.

		cli_append(&pcWriteBuffer, &xWriteBufferLen, "%s\t%d\t%s\t%d",

Choose a reason for hiding this comment

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

@charles is this comment still relevant?

Copy link
Author

Choose a reason for hiding this comment

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

I have implemented this (perhaps in later branches/commits).

Copy link

@victor-wildlife victor-wildlife left a comment

Choose a reason for hiding this comment

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

not tracking the built artifacts will remove+60,000 lines of code, huge win. The intern pointed out a couple of suggestions, pleasse address them and let me know if there are any issues

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