Jan 14, 2025 · Jan 9, 2025
diff --git a/cli/ssh.go b/cli/ssh.go
 func (r*RootCmd)ssh()*serpent.Command {
 var (
 stdiobool
 hostPrefixstring
 forwardAgentbool
 forwardGPGbool
 identityAgentstring
 parsedEnv=append(parsedEnv, [2]string{k,v})
 }

 workspace,workspaceAgent,err:=getWorkspaceAndAgent(ctx,inv,client,!disableAutostart,inv.Args[0])
 namedWorkspace:=strings.TrimPrefix(inv.Args[0],hostPrefix)
 // Support "--" as a delimiter between owner and workspace name
 namedWorkspace=strings.Replace(namedWorkspace,"--","/",1)

 workspace,workspaceAgent,err:=getWorkspaceAndAgent(ctx,inv,client,!disableAutostart,namedWorkspace)
 iferr!=nil {
 returnerr
 }
 Description:"Specifies whether to emit SSH output over stdin/stdout.",
 Value:serpent.BoolOf(&stdio),
 },
 {
 Flag:"ssh-host-prefix",
 Env:"CODER_SSH_SSH_HOST_PREFIX",
 Description:"Strip this prefix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command.",
 Value:serpent.StringOf(&hostPrefix),
 },
 {
 Flag:"forward-agent",
 FlagShorthand:"A",
diff --git a/cli/ssh_test.go b/cli/ssh_test.go
 })
 }
 })

 t.Run("SSHHostPrefix",func(t*testing.T) {
 t.Parallel()
 client,workspace,agentToken:=setupWorkspaceForAgent(t)
 _,_=tGoContext(t,func(ctx context.Context) {
 // Run this async so the SSH command has to wait for
 // the build and agent to connect!
 _=agenttest.New(t,client.URL,agentToken)
 <-ctx.Done()
 })

 clientOutput,clientInput:=io.Pipe()
 serverOutput,serverInput:=io.Pipe()
 deferfunc() {
 for_,c:=range []io.Closer{clientOutput,clientInput,serverOutput,serverInput} {
 _=c.Close()
 }
 }()

 ctx,cancel:=context.WithTimeout(context.Background(),testutil.WaitLong)
 defercancel()

 user,err:=client.User(ctx,codersdk.Me)
 require.NoError(t,err)

 inv,root:=clitest.New(t,"ssh","--stdio","--ssh-host-prefix","coder.dummy.com--",fmt.Sprintf("coder.dummy.com--%s--%s",user.Username,workspace.Name))
 clitest.SetupConfig(t,client,root)
 inv.Stdin=clientOutput
 inv.Stdout=serverInput
 inv.Stderr=io.Discard

 cmdDone:=tGo(t,func() {
 err:=inv.WithContext(ctx).Run()
 assert.NoError(t,err)
 })

 conn,channels,requests,err:=ssh.NewClientConn(&stdioConn{
 Reader:serverOutput,
 Writer:clientInput,
 },"",&ssh.ClientConfig{
 // #nosec
 HostKeyCallback:ssh.InsecureIgnoreHostKey(),
 })
 require.NoError(t,err)
 deferconn.Close()

 sshClient:=ssh.NewClient(conn,channels,requests)
 session,err:=sshClient.NewSession()
 require.NoError(t,err)
 defersession.Close()

 command:="sh -c exit"
 ifruntime.GOOS=="windows" {
 command="cmd.exe /c exit"
 }
 err=session.Run(command)
 require.NoError(t,err)
 err=sshClient.Close()
 require.NoError(t,err)
 _=clientOutput.Close()

 <-cmdDone
 })
 }

 //nolint:paralleltest // This test uses t.Setenv, parent test MUST NOT be parallel.
diff --git a/cli/testdata/coder_ssh_--help.golden b/cli/testdata/coder_ssh_--help.golden
  -R, --remote-forward string-array, $CODER_SSH_REMOTE_FORWARD
          Enable remote port forwarding (remote_port:local_address:local_port).

      --ssh-host-prefix string, $CODER_SSH_SSH_HOST_PREFIX
          Strip this prefix from the provided hostname to determine the
          workspace name. This is useful when used as part of an OpenSSH proxy
          command.

      --stdio bool, $CODER_SSH_STDIO
          Specifies whether to emit SSH output over stdin/stdout.

diff --git a/docs/reference/cli/ssh.md b/docs/reference/cli/ssh.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -61,6 +61,7 @@ var (
		func (rRootCmd)ssh()serpent.Command {
		var (
		stdiobool
		hostPrefixstring
		forwardAgentbool
		forwardGPGbool
		identityAgentstring
Expand DownExpand Up		@@ -195,7 +196,11 @@ func (r RootCmd) ssh() serpent.Command {
		parsedEnv=append(parsedEnv, [2]string{k,v})
		}

		workspace,workspaceAgent,err:=getWorkspaceAndAgent(ctx,inv,client,!disableAutostart,inv.Args[0])
		namedWorkspace:=strings.TrimPrefix(inv.Args[0],hostPrefix)
		// Support "--" as a delimiter between owner and workspace name
		namedWorkspace=strings.Replace(namedWorkspace,"--","/",1)

		workspace,workspaceAgent,err:=getWorkspaceAndAgent(ctx,inv,client,!disableAutostart,namedWorkspace)
		iferr!=nil {
		returnerr
		}
Expand DownExpand Up		@@ -509,6 +514,12 @@ func (r RootCmd) ssh() serpent.Command {
		Description:"Specifies whether to emit SSH output over stdin/stdout.",
		Value:serpent.BoolOf(&stdio),
		},
		{
		Flag:"ssh-host-prefix",
		Env:"CODER_SSH_SSH_HOST_PREFIX",
		Description:"Strip this prefix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command.",
		Value:serpent.StringOf(&hostPrefix),
		},
		{
		Flag:"forward-agent",
		FlagShorthand:"A",
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1568,6 +1568,69 @@ func TestSSH(t *testing.T) {
		})
		}
		})

		t.Run("SSHHostPrefix",func(t*testing.T) {
		t.Parallel()
		client,workspace,agentToken:=setupWorkspaceForAgent(t)
		_,_=tGoContext(t,func(ctx context.Context) {
		// Run this async so the SSH command has to wait for
		// the build and agent to connect!
		_=agenttest.New(t,client.URL,agentToken)
		<-ctx.Done()
		})

		clientOutput,clientInput:=io.Pipe()
		serverOutput,serverInput:=io.Pipe()
		deferfunc() {
		for_,c:=range []io.Closer{clientOutput,clientInput,serverOutput,serverInput} {
		_=c.Close()
		}
		}()

		ctx,cancel:=context.WithTimeout(context.Background(),testutil.WaitLong)
		defercancel()

		user,err:=client.User(ctx,codersdk.Me)
		require.NoError(t,err)

		inv,root:=clitest.New(t,"ssh","--stdio","--ssh-host-prefix","coder.dummy.com--",fmt.Sprintf("coder.dummy.com--%s--%s",user.Username,workspace.Name))
		clitest.SetupConfig(t,client,root)
		inv.Stdin=clientOutput
		inv.Stdout=serverInput
		inv.Stderr=io.Discard

		cmdDone:=tGo(t,func() {
		err:=inv.WithContext(ctx).Run()
		assert.NoError(t,err)
		})

		conn,channels,requests,err:=ssh.NewClientConn(&stdioConn{
		Reader:serverOutput,
		Writer:clientInput,
		},"",&ssh.ClientConfig{
		// #nosec
		HostKeyCallback:ssh.InsecureIgnoreHostKey(),
		})
		require.NoError(t,err)
		deferconn.Close()

		sshClient:=ssh.NewClient(conn,channels,requests)
		session,err:=sshClient.NewSession()
		require.NoError(t,err)
		defersession.Close()

		command:="sh -c exit"
		ifruntime.GOOS=="windows" {
		command="cmd.exe /c exit"
		}
		err=session.Run(command)
		require.NoError(t,err)
		err=sshClient.Close()
		require.NoError(t,err)
		_=clientOutput.Close()

		<-cmdDone
		})
		}

		//nolint:paralleltest // This test uses t.Setenv, parent test MUST NOT be parallel.
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -45,6 +45,11 @@ OPTIONS:
		-R, --remote-forward string-array, $CODER_SSH_REMOTE_FORWARD
		Enable remote port forwarding (remote_port:local_address:local_port).

		--ssh-host-prefix string, $CODER_SSH_SSH_HOST_PREFIX
		Strip this prefix from the provided hostname to determine the
		workspace name. This is useful when used as part of an OpenSSH proxy
		command.

		--stdio bool, $CODER_SSH_STDIO
		Specifies whether to emit SSH output over stdin/stdout.

Expand Down