diff options
| author | Paul Buetow <paul@buetow.org> | 2026-03-03 11:11:46 +0200 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2026-03-03 11:11:46 +0200 |
| commit | 36286212ca5a6e7de85fd05338ca70194707841f (patch) | |
| tree | b08931749c2fa424e59029f5864802795201944e /internal/ssh/client | |
| parent | 2de007f9ef8ae2724b9fbe2808ee25cbfe4ca876 (diff) | |
Add auth-key fast reconnect integration coverage
Diffstat (limited to 'internal/ssh/client')
| -rw-r--r-- | internal/ssh/client/authmethods.go | 77 | ||||
| -rw-r--r-- | internal/ssh/client/authmethods_test.go | 100 |
2 files changed, 121 insertions, 56 deletions
diff --git a/internal/ssh/client/authmethods.go b/internal/ssh/client/authmethods.go index a414ade..7ac4d0c 100644 --- a/internal/ssh/client/authmethods.go +++ b/internal/ssh/client/authmethods.go @@ -12,8 +12,8 @@ import ( ) var ( - privateKeyAuthMethod = ssh.PrivateKey - agentAuthMethod = ssh.AgentWithKeyIndex + privateKeySigner = ssh.PrivateKeySigner + agentSigners = ssh.AgentSignersWithKeyIndex ) // InitSSHAuthMethods initialises all known SSH auth methods on the client side. @@ -31,21 +31,6 @@ func InitSSHAuthMethods(sshAuthMethods []gossh.AuthMethod, return initKnownHostsAuthMethods(trustAllHosts, throttleCh, privateKeyPath, agentKeyIndex) } -func initIntegrationTestKnownHostsAuthMethods() []gossh.AuthMethod { - var sshAuthMethods []gossh.AuthMethod - privateKeyPath := "./id_rsa" - - GeneratePrivatePublicKeyPairIfNotExists(privateKeyPath, 4096) - authMethod, err := ssh.PrivateKey(privateKeyPath) - if err != nil { - dlog.Client.FatalPanic("Unable to use private SSH key", privateKeyPath, err) - } - - sshAuthMethods = append(sshAuthMethods, authMethod) - dlog.Client.Debug("initKnownHostsAuthMethods", "Added private key auth method", privateKeyPath) - return sshAuthMethods -} - func initKnownHostsAuthMethods(trustAllHosts bool, throttleCh chan struct{}, privateKeyPath string, agentKeyIndex int) ([]gossh.AuthMethod, HostKeyCallback) { @@ -62,7 +47,10 @@ func initKnownHostsAuthMethods(trustAllHosts bool, throttleCh chan struct{}, dlog.Client.Debug("initKnownHostsAuthMethods", "Added known hosts file path", knownHostsFile) if config.Env("DTAIL_INTEGRATION_TEST_RUN_MODE") { - return initIntegrationTestKnownHostsAuthMethods(), knownHostsCallback + if privateKeyPath == "" { + privateKeyPath = "./id_rsa" + } + GeneratePrivatePublicKeyPairIfNotExists(privateKeyPath, 4096) } sshAuthMethods := collectKnownHostsAuthMethods(privateKeyPath, agentKeyIndex) @@ -74,7 +62,15 @@ func initKnownHostsAuthMethods(trustAllHosts bool, throttleCh chan struct{}, } func collectKnownHostsAuthMethods(privateKeyPath string, agentKeyIndex int) []gossh.AuthMethod { - var sshAuthMethods []gossh.AuthMethod + signers := collectKnownHostsSigners(privateKeyPath, agentKeyIndex) + if len(signers) == 0 { + return nil + } + return []gossh.AuthMethod{gossh.PublicKeys(signers...)} +} + +func collectKnownHostsSigners(privateKeyPath string, agentKeyIndex int) []gossh.Signer { + var signers []gossh.Signer home := os.Getenv("HOME") defaultPrivateKeyPaths := []string{ @@ -83,13 +79,32 @@ func collectKnownHostsAuthMethods(privateKeyPath string, agentKeyIndex int) []go home + "/.ssh/id_ecdsa", home + "/.ssh/id_ed25519", } + if config.Env("DTAIL_INTEGRATION_TEST_RUN_MODE") { + defaultPrivateKeyPaths = append([]string{"./id_rsa"}, defaultPrivateKeyPaths...) + } if privateKeyPath == "" { privateKeyPath = defaultPrivateKeyPaths[0] } addedPrivateKeyPaths := make(map[string]bool, len(defaultPrivateKeyPaths)+1) - addPrivateKeyAuthMethod := func(path string) { + addedPublicKeys := make(map[string]bool, len(defaultPrivateKeyPaths)+1) + addSigner := func(source string, signer gossh.Signer) { + if signer == nil { + return + } + + pubKey := string(signer.PublicKey().Marshal()) + if addedPublicKeys[pubKey] { + dlog.Client.Debug("initKnownHostsAuthMethods", "Skipping duplicate signer", source) + return + } + + addedPublicKeys[pubKey] = true + signers = append(signers, signer) + dlog.Client.Debug("initKnownHostsAuthMethods", "Added signer", source) + } + addPrivateKeySigner := func(path string) { if path == "" { return } @@ -97,33 +112,33 @@ func collectKnownHostsAuthMethods(privateKeyPath string, agentKeyIndex int) []go return } - authMethod, err := privateKeyAuthMethod(path) + signer, err := privateKeySigner(path) if err != nil { - dlog.Client.Debug("initKnownHostsAuthMethods", "Unable to use private key", path, err) + dlog.Client.Debug("initKnownHostsAuthMethods", "Unable to load private key signer", path, err) return } - sshAuthMethods = append(sshAuthMethods, authMethod) addedPrivateKeyPaths[path] = true - dlog.Client.Debug("initKnownHostsAuthMethods", "Added private key auth method", path) + addSigner(path, signer) } // First, the explicit auth key path (or default ~/.ssh/id_rsa). - addPrivateKeyAuthMethod(privateKeyPath) + addPrivateKeySigner(privateKeyPath) // Second, SSH agent (YubiKey-backed keys are typically exposed here). - authMethod, err := agentAuthMethod(agentKeyIndex) + loadedAgentSigners, err := agentSigners(agentKeyIndex) if err == nil { - sshAuthMethods = append(sshAuthMethods, authMethod) - dlog.Client.Debug("initKnownHostsAuthMethods", "Added SSH agent auth method") + for i, signer := range loadedAgentSigners { + addSigner(fmt.Sprintf("agent:%d:%d", agentKeyIndex, i), signer) + } } else { - dlog.Client.Debug("initKnownHostsAuthMethods", "Unable to init SSH Agent auth method", err) + dlog.Client.Debug("initKnownHostsAuthMethods", "Unable to load SSH agent signers", err) } // Third, additional default private key paths. for _, path := range defaultPrivateKeyPaths { - addPrivateKeyAuthMethod(path) + addPrivateKeySigner(path) } - return sshAuthMethods + return signers } diff --git a/internal/ssh/client/authmethods_test.go b/internal/ssh/client/authmethods_test.go index 04751f5..e1e92b0 100644 --- a/internal/ssh/client/authmethods_test.go +++ b/internal/ssh/client/authmethods_test.go @@ -2,6 +2,7 @@ package client import ( "fmt" + "io" "reflect" "testing" @@ -10,42 +11,84 @@ import ( gossh "golang.org/x/crypto/ssh" ) +type mockPublicKey struct { + id string +} + +func (k *mockPublicKey) Type() string { + return "ssh-rsa" +} + +func (k *mockPublicKey) Marshal() []byte { + return []byte(k.id) +} + +func (k *mockPublicKey) Verify(_ []byte, _ *gossh.Signature) error { + return nil +} + +type mockSigner struct { + key gossh.PublicKey +} + +func newMockSigner(id string) gossh.Signer { + return &mockSigner{key: &mockPublicKey{id: id}} +} + +func (s *mockSigner) PublicKey() gossh.PublicKey { + return s.key +} + +func (s *mockSigner) Sign(_ io.Reader, _ []byte) (*gossh.Signature, error) { + return &gossh.Signature{ + Format: "ssh-rsa", + Blob: []byte("sig"), + }, nil +} + func TestCollectKnownHostsAuthMethodsOrder(t *testing.T) { homeDir := "/tmp/dtail-auth-order" t.Setenv("HOME", homeDir) - originalPrivateKeyAuthMethod := privateKeyAuthMethod - originalAgentAuthMethod := agentAuthMethod + originalPrivateKeySigner := privateKeySigner + originalAgentSigners := agentSigners originalLogger := dlog.Client dlog.Client = &dlog.DLog{} t.Cleanup(func() { - privateKeyAuthMethod = originalPrivateKeyAuthMethod - agentAuthMethod = originalAgentAuthMethod + privateKeySigner = originalPrivateKeySigner + agentSigners = originalAgentSigners dlog.Client = originalLogger }) var callOrder []string - successfulPrivateKeys := map[string]bool{ - "/custom/id_fast": true, - homeDir + "/.ssh/id_rsa": true, - homeDir + "/.ssh/id_dsa": true, + successfulPrivateKeys := map[string]gossh.Signer{ + "/custom/id_fast": newMockSigner("custom"), + homeDir + "/.ssh/id_rsa": newMockSigner("default-rsa"), + homeDir + "/.ssh/id_dsa": newMockSigner("default-dsa"), } - privateKeyAuthMethod = func(path string) (gossh.AuthMethod, error) { + privateKeySigner = func(path string) (gossh.Signer, error) { callOrder = append(callOrder, "private:"+path) - if !successfulPrivateKeys[path] { + signer, found := successfulPrivateKeys[path] + if !found { return nil, fmt.Errorf("missing private key: %s", path) } - return gossh.Password(path), nil + return signer, nil } - agentAuthMethod = func(keyIndex int) (gossh.AuthMethod, error) { + agentSigners = func(keyIndex int) ([]gossh.Signer, error) { callOrder = append(callOrder, fmt.Sprintf("agent:%d", keyIndex)) - return gossh.Password("agent"), nil + return []gossh.Signer{newMockSigner("agent")}, nil } methods := collectKnownHostsAuthMethods("/custom/id_fast", 7) - if len(methods) != 4 { - t.Fatalf("Expected 4 auth methods, got %d", len(methods)) + if len(methods) != 1 { + t.Fatalf("Expected 1 auth method, got %d", len(methods)) + } + + callOrder = nil + signers := collectKnownHostsSigners("/custom/id_fast", 7) + if len(signers) != 4 { + t.Fatalf("Expected 4 signers, got %d", len(signers)) } expectedOrder := []string{ @@ -65,32 +108,39 @@ func TestCollectKnownHostsAuthMethodsSkipsDuplicateDefaultPath(t *testing.T) { homeDir := "/tmp/dtail-auth-dedupe" t.Setenv("HOME", homeDir) - originalPrivateKeyAuthMethod := privateKeyAuthMethod - originalAgentAuthMethod := agentAuthMethod + originalPrivateKeySigner := privateKeySigner + originalAgentSigners := agentSigners originalLogger := dlog.Client dlog.Client = &dlog.DLog{} t.Cleanup(func() { - privateKeyAuthMethod = originalPrivateKeyAuthMethod - agentAuthMethod = originalAgentAuthMethod + privateKeySigner = originalPrivateKeySigner + agentSigners = originalAgentSigners dlog.Client = originalLogger }) + sharedSigner := newMockSigner("shared") var callOrder []string - privateKeyAuthMethod = func(path string) (gossh.AuthMethod, error) { + privateKeySigner = func(path string) (gossh.Signer, error) { callOrder = append(callOrder, "private:"+path) if path == homeDir+"/.ssh/id_rsa" { - return gossh.Password(path), nil + return sharedSigner, nil } return nil, fmt.Errorf("missing private key: %s", path) } - agentAuthMethod = func(keyIndex int) (gossh.AuthMethod, error) { + agentSigners = func(keyIndex int) ([]gossh.Signer, error) { callOrder = append(callOrder, fmt.Sprintf("agent:%d", keyIndex)) - return gossh.Password("agent"), nil + return []gossh.Signer{sharedSigner}, nil } methods := collectKnownHostsAuthMethods(homeDir+"/.ssh/id_rsa", 2) - if len(methods) != 2 { - t.Fatalf("Expected 2 auth methods, got %d", len(methods)) + if len(methods) != 1 { + t.Fatalf("Expected 1 auth method, got %d", len(methods)) + } + + callOrder = nil + signers := collectKnownHostsSigners(homeDir+"/.ssh/id_rsa", 2) + if len(signers) != 1 { + t.Fatalf("Expected duplicate keys to collapse to 1 signer, got %d", len(signers)) } expectedOrder := []string{ |
