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

Allow the usage of git-trailers for changelog messages #165

Merged
merged 3 commits into from
Sep 3, 2024

Conversation

poljar
Copy link
Collaborator

@poljar poljar commented Jul 29, 2024

This PR modifies the way git-cliff parses commits and produces changelog entries, please take a look at the updated CONTRIBUTING.md file for more info.

In short, it allows us to write a commit like this:

fix: Use a constant-time Base64 encoder for secret key material

This patch fixes a security issue around a side-channel vulnerability[1]
when decoding secret key material using Base64.

In some circumstances an attacker can obtain information about secret
secret key material via a controlled-channel and side-channel attack.

This patch avoids the side-channel by switching to the base64ct crate
for the encoding, and more importantly, the decoding of secret key
material.

Security-Impact: Low
CVE: CVE-2024-40640
GitHub-Advisory: GHSA-j8cm-g7r6-hfpq

Changelog: Use a constant-time Base64 encoder for secret key material
to mitigate side-channel attacks leaking secret key material.

To produce a changelog entry like this:

### Security

- Use a constant-time Base64 encoder for secret key material to mitigate
  side-channel attacks leaking secret key material.
  (Low, [CVE-2024-40640](https://www.cve.org/CVERecord?id=CVE-2024-40640), [GHSA-j8cm-g7r6-hfpq](https://github.com/matrix-org/vodozemac/security/advisories/GHSA-j8cm-g7r6-hfpq))

@Hywan
Copy link
Member

Hywan commented Aug 8, 2024

Looks great.

@poljar poljar marked this pull request as ready for review August 8, 2024 12:41
@poljar poljar requested a review from dkasak as a code owner August 8, 2024 12:41
Copy link
Member

@bnjbvr bnjbvr left a comment

Choose a reason for hiding this comment

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

looks good!

CONTRIBUTING.md Outdated Show resolved Hide resolved
@poljar
Copy link
Collaborator Author

poljar commented Sep 2, 2024

@dkasak do you want to take a look at this or should I merge?

@codecov-commenter
Copy link

codecov-commenter commented Sep 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.55%. Comparing base (72f4235) to head (baf9cc9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #165   +/-   ##
=======================================
  Coverage   90.55%   90.55%           
=======================================
  Files          34       34           
  Lines        1906     1906           
=======================================
  Hits         1726     1726           
  Misses        180      180           

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

@poljar
Copy link
Collaborator Author

poljar commented Sep 3, 2024

image

Copy link
Member

@bnjbvr bnjbvr left a comment

Choose a reason for hiding this comment

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

🚢 :shipit: 🐑 🥳

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@dkasak dkasak left a comment

Choose a reason for hiding this comment

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

Looks good. Left some suggested rephrasings.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
cliff.toml Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@poljar poljar force-pushed the poljar/cliff-trailers branch 3 times, most recently from 6f41ca2 to baf9cc9 Compare September 3, 2024 10:57
@poljar poljar merged commit 1ab6f75 into main Sep 3, 2024
33 checks passed
@poljar poljar deleted the poljar/cliff-trailers branch September 3, 2024 11:02
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.

5 participants