[local-app] auto-establish SSH connection

Author: csweichel

components/local-app/BUILD.yaml

@@ -6,6 +6,7 @@ packages:
         - go.sum
         - "**/*.go"
       deps:
+        - components/supervisor-api/go:lib
         - components/gitpod-protocol/go:lib
       config:
         packaging: app

components/local-app/cmd/debug/main.go

@@ -21,13 +21,13 @@ import (
 )
 
 func main() {
-	keyring.MockInit()
 	app := cli.App{
 		Name: "local-app-debug",
 		Commands: []*cli.Command{
 			{
 				Name: "login",
 				Action: func(c *cli.Context) error {
+					keyring.MockInit()
 					_, err := auth.Login(context.Background(), auth.LoginOpts{
 						GitpodURL: c.String("gitpod-host"),
 					})
@@ -49,7 +49,10 @@ func main() {
 			{
 				Name: "run",
 				Action: func(c *cli.Context) error {
-					return run(c.String("gitpod-host"))
+					if c.Bool("mock-keyring") {
+						keyring.MockInit()
+					}
+					return run(c.String("gitpod-host"), c.String("token"), c.String("ssh_config"))
 				},
 				Flags: []cli.Flag{
 					&cli.StringFlag{
@@ -58,6 +61,18 @@ func main() {
 						},
 						Name: "gitpod-host",
 					},
+					&cli.StringFlag{
+						Name: "token",
+						EnvVars: []string{
+							"GITPOD_TOKEN",
+						},
+					},
+					&cli.PathFlag{
+						Name: "ssh_config",
+					},
+					&cli.BoolFlag{
+						Name: "mock-keyring",
+					},
 				},
 			},
 		},
@@ -68,15 +83,26 @@ func main() {
 	}
 }
 
-func run(host string) error {
-	tkn, err := auth.GetToken()
+func run(host, token, sshConfig string) error {
+	if token != "" {
+		auth.SetToken(host, token)
+	}
+
+	tkn, err := auth.GetToken(host)
 	if errors.Is(err, keyring.ErrNotFound) {
 		tkn, err = auth.Login(context.Background(), auth.LoginOpts{GitpodURL: host})
 	}
 	if err != nil {
 		return err
 	}
 
+	cb := bastion.CompositeCallbacks{
+		&logCallbacks{},
+	}
+	if sshConfig != "" {
+		cb = append(cb, &bastion.SSHConfigWritingCallback{Path: sshConfig})
+	}
+
 	wshost := host
 	wshost = strings.ReplaceAll(wshost, "https://", "wss://")
 	wshost = strings.ReplaceAll(wshost, "http://", "ws://")
@@ -89,7 +115,7 @@ func run(host string) error {
 	if err != nil {
 		return err
 	}
-	b := bastion.New(client, &logCallbacks{})
+	b := bastion.New(client, cb)
 	return b.Run()
 }
 

components/local-app/go.mod

@@ -4,12 +4,17 @@ go 1.16
 
 require (
 	github.com/gitpod-io/gitpod/gitpod-protocol v0.0.0-00010101000000-000000000000
-	github.com/jpillora/chisel v1.7.6 // indirect
+	github.com/gitpod-io/gitpod/supervisor/api v0.0.0-00010101000000-000000000000
+	github.com/jpillora/chisel v1.7.6
+	github.com/kevinburke/ssh_config v1.1.0 // indirect
 	github.com/pkg/browser v0.0.0-20210115035449-ce105d075bb4 // indirect
 	github.com/sirupsen/logrus v1.7.0
 	github.com/urfave/cli/v2 v2.3.0
 	github.com/zalando/go-keyring v0.1.1
 	golang.org/x/sys v0.0.0-20210403161142-5e06dd20ab57 // indirect
+	google.golang.org/grpc v1.36.0
 )
 
 replace github.com/gitpod-io/gitpod/gitpod-protocol => ../gitpod-protocol/go // leeway
+
+replace github.com/gitpod-io/gitpod/supervisor/api => ../supervisor-api/go // leeway

components/local-app/go.sum

@@ -20,12 +20,16 @@ import (
 
 const (
 	keyringService = "gitpod-io"
-	keyringUser    = "token"
 )
 
+// SetToken returns the persisted Gitpod token
+func SetToken(host, token string) error {
+	return keyring.Set(keyringService, host, token)
+}
+
 // GetToken returns the persisted Gitpod token
-func GetToken() (token string, err error) {
-	return keyring.Get(keyringService, keyringUser)
+func GetToken(host string) (token string, err error) {
+	return keyring.Get(keyringService, host)
 }
 
 // LoginOpts configure the login process
@@ -106,7 +110,7 @@ func Login(ctx context.Context, opts LoginOpts) (token string, err error) {
 	}
 	token = string(tkn)
 
-	err = keyring.Set(keyringService, keyringUser, token)
+	err = keyring.Set(keyringService, baseURL, token)
 	if err != nil {
 		return "", err
 	}