Merge pull request #1434 from smallstep/herman/fix-windows-ssh-config-path

Ensure `HOMEDRIVE` is used when locating SSH config file location

Author: hslatman

internal/sshutil/pipe.go

@@ -14,8 +14,16 @@ const (
 )
 
 func determineWindowsPipeName() string {
-	homePath := os.Getenv("HOMEPATH") // TODO(hs): add default if not set?
-	sshAgentConfigFile := filepath.Join(homePath, ".ssh", "config")
+	var (
+		homeDrive = "C:"
+		homePath  = os.Getenv("HOMEPATH")
+	)
+
+	if hd := os.Getenv("HOMEDRIVE"); hd != "" {
+		homeDrive = hd
+	}
+
+	sshAgentConfigFile := filepath.Join(homeDrive, homePath, ".ssh", "config")
 
 	if pipeName := readWindowsPipeNameFrom(sshAgentConfigFile); pipeName != "" {
 		return pipeName
@@ -34,7 +42,7 @@ func readWindowsPipeNameFrom(configFile string) (pipeName string) {
 	if err == nil {
 		sc := bufio.NewScanner(file)
 		for sc.Scan() {
-			line := sc.Text()
+			line := strings.TrimSpace(sc.Text())
 			if len(line) > 15 && strings.HasPrefix(line, "IdentityAgent") {
 				pipeName = re2.ReplaceAllString(re.ReplaceAllString(line[14:], "\\"), "")
 				break

internal/sshutil/pipe_test.go

@@ -16,11 +16,13 @@ func TestDeterminesWindowsPipeName(t *testing.T) {
 
 	t.Run("valid-config-file", func(t *testing.T) {
 		dir := t.TempDir()
-		file := filepath.Join(dir, ".ssh", "config")
+		file := filepath.Join(dir, "Users", "username", ".ssh", "config")
 
-		t.Setenv("HOMEPATH", dir)
-		err := os.Mkdir(filepath.Join(dir, ".ssh"), 0777)
+		t.Setenv("HOMEDRIVE", dir)
+		t.Setenv("HOMEPATH", filepath.Join("Users", "username"))
+		err := os.MkdirAll(filepath.Dir(file), 0777)
 		require.NoError(t, err)
+
 		err = os.WriteFile(file, []byte(`IdentityAgent \\.\\pipe\\pageant.user.abcd`), 0600)
 		require.NoError(t, err)
 
@@ -29,10 +31,11 @@ func TestDeterminesWindowsPipeName(t *testing.T) {
 
 	t.Run("invalid-config-file", func(t *testing.T) {
 		dir := t.TempDir()
-		file := filepath.Join(dir, ".ssh", "config")
+		file := filepath.Join(dir, "Users", "username", ".ssh", "config")
 
-		t.Setenv("HOMEPATH", dir)
-		err := os.Mkdir(filepath.Join(dir, ".ssh"), 0777)
+		t.Setenv("HOMEDRIVE", dir)
+		t.Setenv("HOMEPATH", filepath.Join("Users", "username"))
+		err := os.MkdirAll(filepath.Dir(file), 0777)
 		require.NoError(t, err)
 		err = os.WriteFile(file, []byte(`NoIdentityAgent \\.\\pipe\\pageant.user.abcd`), 0600)
 		require.NoError(t, err)