Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
[bug] - add context timeout to ssh verification (#3161)
ahravc549b5bd150e
diff --git a/pkg/detectors/privatekey/privatekey.go b/pkg/detectors/privatekey/privatekey.goindex b9519c369..1aa306559 100644--- a/pkg/detectors/privatekey/privatekey.go+++ b/pkg/detectors/privatekey/privatekey.go@@ -109,7 +109,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (resultwg.Add(1)go func() {defer wg.Done()- user, err := verifyGitHubUser(parsedKey)+ user, err := verifyGitHubUser(ctx, parsedKey)if err != nil && !errors.Is(err, errPermissionDenied) {verificationErrors.Add(err)}@@ -122,7 +122,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (resultwg.Add(1)go func() {defer wg.Done()- user, err := verifyGitLabUser(parsedKey)+ user, err := verifyGitLabUser(ctx, parsedKey)if err != nil && !errors.Is(err, errPermissionDenied) {verificationErrors.Add(err)}diff --git a/pkg/detectors/privatekey/ssh.go b/pkg/detectors/privatekey/ssh.goindex ccf3bdb1b..44ccf616f 100644--- a/pkg/detectors/privatekey/ssh.go+++ b/pkg/detectors/privatekey/ssh.go@@ -2,6 +2,7 @@ package privatekeyimport ("bytes"+ "context""errors""fmt""net"@@ -26,7 +27,7 @@ var gitlabFingerprints = map[string]string{"SHA256:ROQFvPThGrW4RuWLoL9tq9I9zJ42fK4XywyRtbOz/EQ": "RSA",}-func firstResponseFromSSH(parsedKey any, username, hostport string) (string, error) {+func firstResponseFromSSH(ctx context.Context, parsedKey any, username, hostport string) (string, error) {signer, err := ssh.NewSignerFromKey(parsedKey)if err != nil {return "", err@@ -58,7 +59,7 @@ func firstResponseFromSSH(parsedKey any, username, hostport string) (string, err},}- client, err := ssh.Dial("tcp", hostport, config)+ client, err := sshDialWithContext(ctx, "tcp", hostport, config)if err != nil {if strings.Contains(err.Error(), "unable to authenticate") {return "", errPermissionDenied@@ -85,10 +86,27 @@ func firstResponseFromSSH(parsedKey any, username, hostport string) (string, errreturn output.String(), err}+func sshDialWithContext(ctx context.Context, network, addr string, config *ssh.ClientConfig) (*ssh.Client, error) {+ d := net.Dialer{Timeout: config.Timeout}+ conn, err := d.DialContext(ctx, network, addr)+ if err != nil {+ return nil, fmt.Errorf("error dialing %s: %w", addr, err)+ }++ ncc, chans, reqs, err := ssh.NewClientConn(conn, addr, config)+ if err != nil {+ conn.Close()+ return nil, fmt.Errorf("error creating SSH connection to %s: %w", addr, err)+ }++ client := ssh.NewClient(ncc, chans, reqs)+ return client, nil+}+var errPermissionDenied = errors.New("permission denied")-func verifyGitHubUser(parsedKey any) (*string, error) {- output, err := firstResponseFromSSH(parsedKey, "git", "github.com:22")+func verifyGitHubUser(ctx context.Context, parsedKey any) (*string, error) {+ output, err := firstResponseFromSSH(ctx, parsedKey, "git", "github.com:22")if err != nil {return nil, err}@@ -105,8 +123,8 @@ func verifyGitHubUser(parsedKey any) (*string, error) {return nil, nil}-func verifyGitLabUser(parsedKey any) (*string, error) {- output, err := firstResponseFromSSH(parsedKey, "git", "gitlab.com:22")+func verifyGitLabUser(ctx context.Context, parsedKey any) (*string, error) {+ output, err := firstResponseFromSSH(ctx, parsedKey, "git", "gitlab.com:22")if err != nil {return nil, err}diff --git a/pkg/detectors/privatekey/ssh_test.go b/pkg/detectors/privatekey/ssh_test.goindex 9dbb6bd6f..bd90968b4 100644--- a/pkg/detectors/privatekey/ssh_test.go+++ b/pkg/detectors/privatekey/ssh_test.go@@ -5,8 +5,9 @@ import ("testing""time"- "github.com/trufflesecurity/trufflehog/v3/pkg/common""golang.org/x/crypto/ssh"++ "github.com/trufflesecurity/trufflehog/v3/pkg/common")func TestFirstResponseFromSSH(t *testing.T) {@@ -23,7 +24,7 @@ func TestFirstResponseFromSSH(t *testing.T) {t.Fatalf("could not parse test secret: %s", err)}- output, err := firstResponseFromSSH(parsedKey, "git", "github.com:22")+ output, err := firstResponseFromSSH(ctx, parsedKey, "git", "github.com:22")if err != nil {t.Fail()}