fix(secrets): Reduce keychain unlock prompts on MacOS #2394
Conversation
This file contains 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
Signed-off-by: Timothy Johnson <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2394 +/- ##
========================================
Coverage 91.28% 91.28%
========================================
Files 638 638
Lines 18208 18208
Branches 3930 3822 -108
========================================
Hits 16621 16621
Misses 1586 1586
Partials 1 1 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Timothy Johnson <[email protected]>
t1m0thyj
force-pushed
the
fix/macos-keychain-prompts
branch
from
5ac932d to
9475e16
Compare
Signed-off-by: Timothy Johnson <[email protected]>
t1m0thyj
force-pushed
the
fix/macos-keychain-prompts
branch
from
45d2bc0 to
7c0a0d7
Compare
traeok
approved these changes
Dec 23, 2024
There was a problem hiding this comment.
Changes make sense to me, thanks for the fix @t1m0thyj - pretty cool that fmutex leverages the scope of the guard to auto-release the lock 😋
As discussed offline, failing tests are related to glibc segfault with ava - once workerThreads: false is added, the stages will pass. Thanks for looking into this as well!
Signed-off-by: Timothy Johnson <[email protected]>
Signed-off-by: Timothy Johnson <[email protected]>
t1m0thyj
force-pushed
the
fix/macos-keychain-prompts
branch
from
0104a49 to
fadf4e8
Compare
t1m0thyj
added
the
needs-ported
|
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.
What It Does
Reduces the number of keychain unlock prompts on MacOS for simultaneous access to secrets by the same process.
As a security feature, MacOS always re-prompts for keychain access after a secret has been modified by another process. This is why after running
zowe config securewhich updates credentials usingnode, you get a prompt for Zowe Explorer (the VS Code extension host process) to access credentials.Suppose there are 3 VS Code instances open: A, B, and C. Currently when a vault change event is triggered, all 3 instances attempt to access the keychain simultaneously and Mac users will see 3 keychain prompts (ouch).
By adding a mutex associated with the calling process, we can make B & C wait to access credentials until A has finished accessing them. Now Mac users will see just 1 keychain prompt (0 would be ideal but 1 is way better than 3).
How to Test
This PR can only be tested on MacOS since the issue is OS-specific:
keyring.nodeartifact and copy it into your ZE prebuilds folder.xattr -d com.apple.quarantine *.nodezowe config securecommand and press Enter repeatedly to skip all prompts.Review Checklist
I certify that I have:
Additional Comments