Skip to content

Have CI's cargo audit ignore RUSTSEC-2021-0125 #2898

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

Merged

Conversation

tnull
Copy link
Contributor

@tnull tnull commented Feb 16, 2024

Closes #2896.

This advisory is only relevant for a downstream dependency of criterion, which we currently don't want to bump in order to continue benchmarking with our MSRV 1.63.0.

We therefore just add it to our ignore list for now.

Copy link

coderabbitai bot commented Feb 16, 2024

Walkthrough

The update introduces an ignore parameter to the workflow configuration, specifically ignoring the advisory RUSTSEC-2021-0145 related to the atty package. This change aims to bypass the audit check for a known unaligned read issue in atty, acknowledging its potential impact on Windows systems and the package's unmaintained status.

Changes

File Change Summary
.github/workflows/audit.yml Added ignore parameter for RUSTSEC-2021-0145

Assessment against linked issues

Objective Addressed Explanation
Identify and address potential unaligned read issue (RUSTSEC-2021-0145)
Acknowledge the issue is marked as unsound (RUSTSEC-2021-0145) Ignoring an issue in CI does not equate to acknowledging its nature or impact in the code or documentation.
Note the issue affects Windows systems (RUSTSEC-2021-0145) Ignoring the issue does not address or note its specific impact on Windows systems.
Highlight the pointer is unlikely to be unaligned unless a custom global allocator is used (RUSTSEC-2021-0145) The change does not address or highlight conditions leading to unaligned pointer dereferences.
Emphasize atty is currently unmaintained (RUSTSEC-2021-0145) The workflow change does not provide information on the maintenance status of atty.
Suggest possible alternatives such as std::io::IsTerminal and is-terminal crates (RUSTSEC-2021-0145) The modification does not suggest alternatives to atty.

Poem

In the realm of code, where bytes align,
A rabbit hopped, by design.
🐇💻 Ignoring flaws, it made a tweak,
With caution, lest the system leak.

"Fear not," it said, "for progress calls,
We jump o'er hurdles, patch the walls."
🌟 In digital fields, it danced with grace,
Leaving footprints, in cyberspace.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3fd4b39 and 080aa59.
Files selected for processing (1)
  • .github/workflows/audit.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/audit.yml

This advisory is only relevant for a downstream dependency of
`criterion`, which we currently don't want to bump in order to continue
benchmarking with our MSRV 1.63.0.

We therefore just add it to our ignore list for now.
@tnull tnull force-pushed the 2024-02-ignore-RUSTSEC-2021-0145 branch from 080aa59 to 9aa6ddb Compare February 19, 2024 09:00
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6fa1cb2 and 9aa6ddb.
Files selected for processing (1)
  • .github/workflows/audit.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/audit.yml

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3fd4b39) 89.11% compared to head (9aa6ddb) 89.18%.
Report is 9 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2898      +/-   ##
==========================================
+ Coverage   89.11%   89.18%   +0.06%     
==========================================
  Files         115      115              
  Lines       94232    94686     +454     
  Branches    94232    94686     +454     
==========================================
+ Hits        83978    84442     +464     
+ Misses       7781     7771      -10     
  Partials     2473     2473              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@TheBlueMatt TheBlueMatt left a comment

Choose a reason for hiding this comment

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

Thanks. Just an ignore + comment so no need to wait on another reviewer.

@TheBlueMatt TheBlueMatt merged commit a854ccb into lightningdevkit:main Feb 20, 2024
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.

RUSTSEC-2021-0145: Potential unaligned read
3 participants