Merge pull request #3012 from carapace-sh/ssh-config-include

ssh: support `Include` directive

Author: rsteube

completers/common/scp_completer/cmd/root.go

@@ -74,7 +74,11 @@ func init() {
 		carapace.ActionMultiParts(":", func(c carapace.Context) carapace.Action {
 			switch len(c.Parts) {
 			case 0:
-				return net.ActionHosts().Invoke(c).Merge(carapace.ActionFiles().Invoke(c)).ToA().NoSpace()
+				return carapace.Batch(
+					net.ActionHosts(),
+					ssh.ActionHosts(rootCmd.Flag("F").Value.String()).Style("yellow"),
+					carapace.ActionFiles(),
+				).ToA().NoSpace()
 			default:
 				return carapace.ActionValues()
 			}

completers/common/ssh_completer/cmd/root.go

@@ -104,12 +104,16 @@ func init() {
 
 	carapace.Gen(rootCmd).PositionalCompletion(
 		carapace.ActionCallback(func(c carapace.Context) carapace.Action {
+			action := carapace.Batch(
+				net.ActionHosts(),
+				ssh.ActionHosts(rootCmd.Flag("F").Value.String()).Style("yellow"),
+			).ToA()
+
 			if strings.Contains(c.Value, "@") {
 				prefix := strings.SplitN(c.Value, "@", 2)[0]
-				return net.ActionHosts().Invoke(c).Prefix(prefix + "@").ToA()
-			} else {
-				return net.ActionHosts()
+				action = action.Prefix(prefix + "@")
 			}
+			return action
 		}),
 	)
 }

go.mod

@@ -18,7 +18,10 @@ require (
 
 require (
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/kevinburke/ssh_config v1.4.0
 	github.com/stretchr/testify v1.8.1 // indirect
 )
 
 replace github.com/spf13/pflag => github.com/carapace-sh/carapace-pflag v1.0.0
+
+replace github.com/kevinburke/ssh_config => github.com/carapace-sh/ssh_config v1.4.1-0.20251016142129-177d27a2d08a

go.sum

@@ -10,6 +10,8 @@ github.com/carapace-sh/carapace-shlex v1.1.0 h1:58QSJTUxghpa/rEn6+Z9UM/Hy0ipVHDU
 github.com/carapace-sh/carapace-shlex v1.1.0/go.mod h1:lJ4ZsdxytE0wHJ8Ta9S7Qq0XpjgjU0mdfCqiI2FHx7M=
 github.com/carapace-sh/carapace-spec v1.3.4 h1:uNGRIP1XX68xl7rvXfpnVsDJh5ct+X1fFTswZ1IFXbQ=
 github.com/carapace-sh/carapace-spec v1.3.4/go.mod h1:zyc8AB5LiJ1g2apoejms+CHOVZKSVra4tefyWL5nU9s=
+github.com/carapace-sh/ssh_config v1.4.1-0.20251016142129-177d27a2d08a h1:00oRlK/Mk5oYS0lh/X2bmgLeO9fuoE8B/8i1gQuJpaE=
+github.com/carapace-sh/ssh_config v1.4.1-0.20251016142129-177d27a2d08a/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M=
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=

internal/actions/net/ssh/ssh.go

@@ -7,7 +7,6 @@ import (
 	"strings"
 
 	"github.com/carapace-sh/carapace"
-	"github.com/carapace-sh/carapace-bin/internal/actions/net/ssh"
 	"github.com/carapace-sh/carapace/pkg/execlog"
 	"github.com/carapace-sh/carapace/pkg/style"
 )
@@ -39,9 +38,8 @@ func ActionHosts() carapace.Action {
 				batch = append(batch, carapace.ActionMessage(err.Error()))
 			}
 		}
-		batch = append(batch, ssh.ActionHosts().Style(style.Yellow).Suppress(`open .*/.ssh/config: no such file or directory`))
 		return batch.ToA()
-	}).Tag("hosts")
+	}).Tag("known hosts")
 }
 
 type IncludedDevices struct {
@@ -179,7 +177,7 @@ func ActionBssids() carapace.Action {
 
 			vals := make([]string, 0)
 			for _, line := range lines[:len(lines)-1] {
-				mac := strings.Replace(line[:22], `\:`, `:`, -1)
+				mac := strings.ReplaceAll(line[:22], `\:`, `:`)
 				splitted := strings.Split(line[23:], ":")
 				if name := splitted[0]; name != "" {
 					vals = append(vals, mac, splitted[0], styleForBars(splitted[1]))
@@ -201,7 +199,7 @@ func ActionSsids() carapace.Action {
 
 			vals := make([]string, 0)
 			for _, line := range lines[:len(lines)-1] {
-				mac := strings.Replace(line[:22], `\:`, `:`, -1)
+				mac := strings.ReplaceAll(line[:22], `\:`, `:`)
 				splitted := strings.Split(line[23:], ":")
 				if name := splitted[0]; name != "" {
 					vals = append(vals, splitted[0], mac, styleForBars(splitted[1]))

pkg/actions/net/net.go

@@ -1,43 +1,31 @@
 package ssh
 
 import (
-	"bufio"
-	"os"
 	"strings"
 
 	"github.com/carapace-sh/carapace"
-	"github.com/carapace-sh/carapace-bin/internal/actions/net/ssh"
+	"github.com/kevinburke/ssh_config"
 )
 
 // ActionHosts completes ssh hosts
-func ActionHosts() carapace.Action {
+func ActionHosts(config string) carapace.Action {
 	return carapace.ActionCallback(func(c carapace.Context) carapace.Action {
-		path, err := c.Abs("~/.ssh/config")
-		if err != nil {
-			return carapace.ActionValues()
+		settings := ssh_config.DefaultUserSettings
+		if config != "" {
+			// TODO this skips the system config
+			settings.ConfigFinder(func() string {
+				return config
+			})
 		}
 
-		file, err := os.Open(path)
-		if err != nil {
-			return carapace.ActionMessage(err.Error())
-		}
-		defer file.Close()
-
 		vals := make([]string, 0)
-		scanner := bufio.NewScanner(file)
-		for scanner.Scan() {
-			if line := scanner.Text(); strings.HasPrefix(line, "Host ") {
-				for _, field := range strings.Fields(strings.TrimPrefix(line, "Host ")) {
-					if !strings.ContainsAny(field, `\*{}[]+`) {
-						vals = append(vals, field)
-					}
+		for _, host := range settings.GetHosts() {
+			for _, pattern := range host.Patterns {
+				if s := strings.ReplaceAll(pattern.String(), `\`, ""); !strings.ContainsAny(s, `+*?()|[]{}^$!`) {
+					vals = append(vals, s)
 				}
 			}
 		}
 		return carapace.ActionValues(vals...)
 	}).Tag("ssh hosts")
 }
-
-func init() {
-	ssh.ActionHosts = ActionHosts
-}