-
Notifications
You must be signed in to change notification settings - Fork 3.6k
fix(keyring): stop concurrent writers wiping the shared secrets file #5436
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
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f597778
fix(keyring): stop concurrent writers wiping the shared secrets file
senamakel 66bd6b3
fix(keyring): lock legacy migration reads
senamakel e566e86
fix(keyring): serialize corrupt reads and retry temp files
senamakel 51d691c
fix(keyring): compile race-safe file writes
senamakel b2ec573
merge: resolve keyring store.rs/README conflicts with main
senamakel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
The error text claims the file was moved even when the quarantine fails.
quarantine_corruptreturnsNonewhen the rename fails, and that result is discarded. The error message then states "it was moved aside rather than overwritten" while the corrupt file is still in place. A user who follows the message looks for a.corrupt.file that does not exist.Branch on the returned
Optionand report the actual outcome.🛠️ Proposed fix
Err(e) if for_write => { - file_store::quarantine_corrupt(&self.path, "json"); - Err(KeyringError::Backend(format!( - "dev-keychain.json at {} could not be parsed ({e}); it was moved aside \ - rather than overwritten", - self.path.display() - ))) + let outcome = match file_store::quarantine_corrupt(&self.path, "json") { + Some(target) => format!("it was moved to {}", target.display()), + None => "it could not be moved aside and is still in place".to_string(), + }; + Err(KeyringError::Backend(format!( + "dev-keychain.json at {} could not be parsed ({e}); {outcome} \ + rather than overwritten", + self.path.display() + ))) }The existing test asserts on the substring "moved aside", so update
file_backend_set_refuses_to_overwrite_an_unparseable_fileinsrc/openhuman/security/keyring/tests.rsto match the new wording.🤖 Prompt for AI Agents