-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
fix(ssh): wrap agent signers to continue to next identity on signing failure #3401
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
Open
Jason-Shen2
wants to merge
3
commits into
wavetermdev:main
Choose a base branch
from
Jason-Shen2:fix/ssh-agent-failover-signer
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+87
−1
Open
Changes from all commits
Commits
Show all changes
3 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| // Copyright 2025, Command Line Inc. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package remote | ||
|
|
||
| import ( | ||
| "context" | ||
| "io" | ||
|
|
||
| "github.com/wavetermdev/waveterm/pkg/blocklogger" | ||
| "golang.org/x/crypto/ssh" | ||
| ) | ||
|
|
||
| // failoverSigner wraps an ssh.Signer to implement SSH agent identity failover. | ||
| // When signing with one agent identity fails, instead of aborting the entire | ||
| // authentication attempt, it produces a synthesized invalid signature that | ||
| // causes the SSH client to try the next available identity, matching OpenSSH's | ||
| // default multi-identity authentication behavior. It implements both | ||
| // ssh.Signer and ssh.AlgorithmSigner. | ||
| type failoverSigner struct { | ||
| signer ssh.Signer | ||
| connCtx context.Context | ||
| } | ||
|
|
||
| // PublicKey returns the public key associated with the wrapped signer. | ||
| // It implements ssh.Signer. | ||
| func (f failoverSigner) PublicKey() ssh.PublicKey { | ||
| return f.signer.PublicKey() | ||
| } | ||
|
|
||
| // Sign signs the given data using the wrapped signer. If signing succeeds, the | ||
| // valid signature is returned. If signing fails (e.g. because the agent cannot | ||
| // authenticate with this particular identity), the error is logged via | ||
| // blocklogger and an invalid placeholder signature is returned instead of an | ||
| // error, allowing the SSH client to proceed to the next offered identity. | ||
| // It implements ssh.Signer. | ||
| func (f failoverSigner) Sign(rand io.Reader, data []byte) (*ssh.Signature, error) { | ||
| sig, err := f.signer.Sign(rand, data) | ||
| if err == nil { | ||
| return sig, nil | ||
| } | ||
| blocklogger.Infof(f.connCtx, "[conndebug] agent signing failed for key %s %s (%v); continuing with next identity\n", | ||
| f.signer.PublicKey().Type(), ssh.FingerprintSHA256(f.signer.PublicKey()), err) | ||
| return f.invalidSignature(f.signer.PublicKey().Type()), nil | ||
| } | ||
|
|
||
| // SignWithAlgorithm signs the given data using the wrapped signer with the | ||
| // requested signature algorithm. If the wrapped signer supports | ||
| // ssh.AlgorithmSigner, the algorithm is forwarded; if signing fails in that | ||
| // case an invalid signature with the requested algorithm format is returned. | ||
| // If the wrapped signer does not implement ssh.AlgorithmSigner, it falls back | ||
| // to Sign. It implements ssh.AlgorithmSigner. | ||
| func (f failoverSigner) SignWithAlgorithm(rand io.Reader, data []byte, algorithm string) (*ssh.Signature, error) { | ||
| if as, ok := f.signer.(ssh.AlgorithmSigner); ok { | ||
| sig, err := as.SignWithAlgorithm(rand, data, algorithm) | ||
| if err == nil { | ||
| return sig, nil | ||
| } | ||
| blocklogger.Infof(f.connCtx, "[conndebug] agent signing failed for key %s %s (%v); continuing with next identity\n", | ||
| f.signer.PublicKey().Type(), ssh.FingerprintSHA256(f.signer.PublicKey()), err) | ||
| return f.invalidSignature(algorithm), nil | ||
| } | ||
| return f.Sign(rand, data) | ||
| } | ||
|
|
||
| // invalidSignature constructs a placeholder ssh.Signature with the given | ||
| // format and an obviously-invalid blob. Returning this sentinel signature | ||
| // instead of propagating the signing error causes the SSH client to skip | ||
| // this identity and move on to the next one offered by the agent. | ||
| func (f failoverSigner) invalidSignature(format string) *ssh.Signature { | ||
| return &ssh.Signature{ | ||
| Format: format, | ||
| Blob: []byte("invalid-signature-identity-skipped"), | ||
| } | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.