Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #17 +/- ##
=======================================
Coverage 96.90% 96.90%
=======================================
Files 76 76
Lines 1650 1650
=======================================
Hits 1599 1599
Misses 51 51 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances security documentation and automates signed releases by updating the CLI README, adding a SECURITY guide, and refactoring the release tool configuration and workflow to handle commit/tag signing, version bumps, crate publishing, and attestations.
- Introduce SECURITY.md and update README.md with details on signed binaries and build attestations.
- Simplify
.release.tomlto defer git/tag/publish to GitHub Actions. - Revamp
.github/workflows/release.ymlto include checkout token, version‐bump commits, crate publishing, and attestation steps.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| crates/cli/README.md | Added signed‐binary notice; reformatted email/security sections with numbered best practices. |
| SECURITY.md | New file describing release verification, signatures, attestations, and best practices. |
| .release.toml | Disabled manual signing/tag/publish options, delegating to the GitHub workflow. |
| .github/workflows/release.yml | Added checkout token, renamed steps, committed version bump, published crates, and attestations. |
Comments suppressed due to low confidence (1)
crates/cli/README.md:309
- Change 'employes' to 'employs' and consider capitalizing 'Klirr' for consistency.
Therefor, klirr employes these best practices to keep your _App Password_ safe:
Comment on lines
+303
to
314
| > Klirr's email feature is safe to use. Klirr uses strong encryption and employes | ||
| > all IT security best practices to keep your _App Password_ safe. | ||
| > It is crucual that an attack does not get access to your _App Password_ since email | ||
| > services does not allow users to limit the scope and permission of the _App Password_, with it | ||
| > and attacker can read all your emails and send emails to anyone impersonating you! | ||
|
|
||
| Therefor, klirr employes these best practices to keep your _App Password_ safe: | ||
| 1. Key-Derivation: Klirr does not use your encryption password directly, first it's run through a [Hash based Key-Derivation-Function](https://en.wikipedia.org/wiki/HKDF) using a application unique `INFO` (see 'How Should You Introduce Randomness into HKDF?' section of [this blog post](https://soatok.blog/2021/11/17/understanding-hkdf/)) and cryptographically secure random generated [`SALT`](https://en.wikipedia.org/wiki/Salt\_(cryptography)), this forms a strong and unique `EncryptionKey` | ||
| 2. Advanced Encryption: Klirr uses [AES (Advanced Encryption Standard)] encryption with 256 bits strength, encrypted using the `EncryptionKey` from last step. | ||
| 3. Zeroisation: Klirr uses [Zeroisation](https://en.wikipedia.org/wiki/Zeroisation) to eagerly erase sensitive secrets from memory. | ||
|
|
||
| You can review how klirr employes these safety measures in the [encryption folder of the code](crates/core/src/logic/encryption). |
There was a problem hiding this comment.
Correct the spelling of 'employes' to 'employs'.
| 0. Zeroisation: Klirr uses [Zeroisation](https://en.wikipedia.org/wiki/Zeroisation) to eagerly erase sensitive secrets from memory. | ||
| > Klirr's email feature is safe to use. Klirr uses strong encryption and employes | ||
| > all IT security best practices to keep your _App Password_ safe. | ||
| > It is crucual that an attack does not get access to your _App Password_ since email |
There was a problem hiding this comment.
Fix the typo 'crucual' to 'crucial'.
Suggested change
| > It is crucual that an attack does not get access to your _App Password_ since email | |
| > It is crucial that an attack does not get access to your _App Password_ since email |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
signing of commits and tags.