-
Notifications
You must be signed in to change notification settings - Fork 201
fix(ssh): repair mangled PEM private keys before parsing #1147
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 all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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
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.
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.
For an encrypted OpenSSH key whose line breaks became literal
\n, this path repairs the PEM but then discards it becausessh2.parseKey(repaired, undefined)fails without a passphrase, and the non-PKCS#8 fallback returns the original mangled text. In the first-party auth flow, that same literal-\nform is not reliably detected as encrypted beforeresolveKeyForAuthis called, so the user never gets a passphrase retry with the repaired key even thoughnormalizePrivateKeyForSsh2(mangled, passphrase)would work. Please keep or surface the repaired candidate for encrypted non-PKCS#8 keys instead of falling back to the unrepaired input when the only missing piece is a passphrase.Useful? React with 👍 / 👎.
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.
Verified. The repaired candidate was indeed being discarded, but the reason there's no passphrase retry is one layer up:
isKeyEncrypted()couldn't read the cipher from the mangled OpenSSH blob — the literal\ncorrupts the base64 decode of theopenssh-key-v1header — so the key was routed to the unencrypted branch and never prompted. Surfacing the repaired candidate alone wouldn't help, sinceresolveKeyForAuthre-validates without a passphrase and drops it.Fixed in 81e02ca by repairing the PEM framing before reading the cipher name in
isKeyEncrypted, so the key is detected as encrypted and reaches the passphrase prompt — wherenormalizePrivateKeyForSsh2(key, passphrase)already repairs and validates it (exactly the path you noted would work). Added a regression test: a literal-\nencrypted OpenSSH key now triggers exactly one prompt and parses with the passphrase.