- Notifications
You must be signed in to change notification settings - Fork928
feat: Add SSH agent forwarding support to coder agent#1548
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
11 commits Select commitHold shift + click to select a range
54b74f7 feat: Add SSH agent forwarding support to coder agent
mafredri3df1a08 feat: Add forward agent flag to `coder ssh`
mafredri51c4128 refactor: Share setup between SSH tests, sync goroutines
mafredri8f0d454 feat: Add test for `coder ssh --forward-agent`
mafredrice9c05d fix: Fix TestSSH/ImmediateExit flakyness with sleep
mafredrif1596de fix: Fix ForwardAgent test on macOS
mafredri5044d11 fix: Fix test flakes and implement Deans suggestion for helpers
mafredrie754672 fix: Add example to config-ssh
mafredri8d3df94 fix: Ignore closed errors in test
mafredriea46d7b fix: Allow forwarding agent via -A
mafredri326b942 Update cli/ssh_test.go
mafredriFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
10 changes: 10 additions & 0 deletionsagent/agent.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
5 changes: 5 additions & 0 deletionscli/configssh.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
16 changes: 15 additions & 1 deletioncli/ssh.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
249 changes: 181 additions & 68 deletionscli/ssh_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,14 @@ | ||
| package cli_test | ||
| import ( | ||
| "context" | ||
| "crypto/ecdsa" | ||
| "crypto/elliptic" | ||
| "crypto/rand" | ||
| "errors" | ||
| "io" | ||
| "net" | ||
| "path/filepath" | ||
| "runtime" | ||
| "testing" | ||
| "time" | ||
| @@ -11,9 +17,11 @@ import ( | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "golang.org/x/crypto/ssh" | ||
| gosshagent "golang.org/x/crypto/ssh/agent" | ||
| "cdr.dev/slog" | ||
| "cdr.dev/slog/sloggers/slogtest" | ||
| "github.com/coder/coder/agent" | ||
| "github.com/coder/coder/cli/clitest" | ||
| "github.com/coder/coder/coderd/coderdtest" | ||
| @@ -23,49 +31,53 @@ import ( | ||
| "github.com/coder/coder/pty/ptytest" | ||
| ) | ||
| func setupWorkspaceForSSH(t *testing.T) (*codersdk.Client, codersdk.Workspace, string) { | ||
| t.Helper() | ||
| client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true}) | ||
mafredri marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| user := coderdtest.CreateFirstUser(t, client) | ||
| agentToken := uuid.NewString() | ||
| version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{ | ||
| Parse: echo.ParseComplete, | ||
| ProvisionDryRun: echo.ProvisionComplete, | ||
| Provision: []*proto.Provision_Response{{ | ||
| Type: &proto.Provision_Response_Complete{ | ||
| Complete: &proto.Provision_Complete{ | ||
| Resources: []*proto.Resource{{ | ||
| Name: "dev", | ||
| Type: "google_compute_instance", | ||
| Agents: []*proto.Agent{{ | ||
| Id: uuid.NewString(), | ||
| Auth: &proto.Agent_Token{ | ||
| Token: agentToken, | ||
| }, | ||
| }}, | ||
| }}, | ||
| }, | ||
| }, | ||
| }}, | ||
| }) | ||
| coderdtest.AwaitTemplateVersionJob(t, client, version.ID) | ||
| template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID) | ||
| workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID) | ||
| return client, workspace, agentToken | ||
| } | ||
| func TestSSH(t *testing.T) { | ||
| t.Parallel() | ||
| t.Run("ImmediateExit", func(t *testing.T) { | ||
| t.Parallel() | ||
| client, workspace, agentToken := setupWorkspaceForSSH(t) | ||
| cmd, root := clitest.New(t, "ssh", workspace.Name) | ||
| clitest.SetupConfig(t, client, root) | ||
| pty := ptytest.New(t) | ||
| cmd.SetIn(pty.Input()) | ||
| cmd.SetErr(pty.Output()) | ||
| cmd.SetOut(pty.Output()) | ||
| cmdDone := tGo(t, func() { | ||
| err := cmd.Execute() | ||
| assert.NoError(t, err) | ||
| }) | ||
| pty.ExpectMatch("Waiting") | ||
| coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID) | ||
| agentClient := codersdk.New(client.URL) | ||
| @@ -76,39 +88,16 @@ func TestSSH(t *testing.T) { | ||
| t.Cleanup(func() { | ||
| _ = agentCloser.Close() | ||
| }) | ||
| // Shells on Mac, Windows, and Linux all exit shells with the "exit" command. | ||
| pty.WriteLine("exit") | ||
| <-cmdDone | ||
| }) | ||
| t.Run("Stdio", func(t *testing.T) { | ||
| t.Parallel() | ||
| client, workspace, agentToken := setupWorkspaceForSSH(t) | ||
| _, _ = tGoContext(t, func(ctx context.Context) { | ||
| // Run this async so the SSH command has to wait for | ||
| // the build and agent to connect! | ||
| coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID) | ||
| @@ -117,25 +106,22 @@ func TestSSH(t *testing.T) { | ||
| agentCloser := agent.New(agentClient.ListenWorkspaceAgent, &agent.Options{ | ||
| Logger: slogtest.Make(t, nil).Leveled(slog.LevelDebug), | ||
| }) | ||
| <-ctx.Done() | ||
| _ = agentCloser.Close() | ||
| }) | ||
| clientOutput, clientInput := io.Pipe() | ||
| serverOutput, serverInput := io.Pipe() | ||
| cmd, root := clitest.New(t, "ssh", "--stdio", workspace.Name) | ||
| clitest.SetupConfig(t, client, root) | ||
| cmd.SetIn(clientOutput) | ||
| cmd.SetOut(serverInput) | ||
| cmd.SetErr(io.Discard) | ||
| cmdDone := tGo(t, func() { | ||
| err := cmd.Execute() | ||
| assert.NoError(t, err) | ||
| }) | ||
| conn, channels, requests, err := ssh.NewClientConn(&stdioConn{ | ||
| Reader: serverOutput, | ||
| @@ -157,8 +143,135 @@ func TestSSH(t *testing.T) { | ||
| err = sshClient.Close() | ||
| require.NoError(t, err) | ||
| _ = clientOutput.Close() | ||
| <-cmdDone | ||
| }) | ||
| //nolint:paralleltest // Disabled due to use of t.Setenv. | ||
| t.Run("ForwardAgent", func(t *testing.T) { | ||
| if runtime.GOOS == "windows" { | ||
| t.Skip("Test not supported on windows") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. remark, non-blocking: recent versions of Windows do include SSH (source) but it's probably a ghastly can of worms to open! So agreed, let's leave this non-Windows for now. 😅 | ||
| } | ||
| client, workspace, agentToken := setupWorkspaceForSSH(t) | ||
| _, _ = tGoContext(t, func(ctx context.Context) { | ||
| // Run this async so the SSH command has to wait for | ||
| // the build and agent to connect! | ||
| coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID) | ||
| agentClient := codersdk.New(client.URL) | ||
| agentClient.SessionToken = agentToken | ||
| agentCloser := agent.New(agentClient.ListenWorkspaceAgent, &agent.Options{ | ||
| Logger: slogtest.Make(t, nil).Leveled(slog.LevelDebug), | ||
| }) | ||
| <-ctx.Done() | ||
| _ = agentCloser.Close() | ||
| }) | ||
| // Generate private key. | ||
| privateKey, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader) | ||
| require.NoError(t, err) | ||
| kr := gosshagent.NewKeyring() | ||
| kr.Add(gosshagent.AddedKey{ | ||
| PrivateKey: privateKey, | ||
| }) | ||
| // Start up ssh agent listening on unix socket. | ||
| tmpdir := t.TempDir() | ||
| agentSock := filepath.Join(tmpdir, "agent.sock") | ||
| l, err := net.Listen("unix", agentSock) | ||
| require.NoError(t, err) | ||
| defer l.Close() | ||
| _ = tGo(t, func() { | ||
| for { | ||
| fd, err := l.Accept() | ||
| if err != nil { | ||
| if !errors.Is(err, net.ErrClosed) { | ||
| t.Logf("accept error: %v", err) | ||
| } | ||
| return | ||
| } | ||
| err = gosshagent.ServeAgent(kr, fd) | ||
| if !errors.Is(err, io.EOF) { | ||
| assert.NoError(t, err) | ||
| } | ||
| } | ||
| }) | ||
| t.Setenv("SSH_AUTH_SOCK", agentSock) | ||
| cmd, root := clitest.New(t, | ||
| "ssh", | ||
| workspace.Name, | ||
| "--forward-agent", | ||
| ) | ||
| clitest.SetupConfig(t, client, root) | ||
| pty := ptytest.New(t) | ||
| cmd.SetIn(pty.Input()) | ||
| cmd.SetOut(pty.Output()) | ||
| cmd.SetErr(io.Discard) | ||
| cmdDone := tGo(t, func() { | ||
| err := cmd.Execute() | ||
| assert.NoError(t, err) | ||
| }) | ||
| // Ensure that SSH_AUTH_SOCK is set. | ||
| // Linux: /tmp/auth-agent3167016167/listener.sock | ||
| // macOS: /var/folders/ng/m1q0wft14hj0t3rtjxrdnzsr0000gn/T/auth-agent3245553419/listener.sock | ||
| pty.WriteLine("env") | ||
| pty.ExpectMatch("SSH_AUTH_SOCK=") | ||
| // Ensure that ssh-add lists our key. | ||
| pty.WriteLine("ssh-add -L") | ||
| keys, err := kr.List() | ||
| require.NoError(t, err) | ||
| pty.ExpectMatch(keys[0].String()) | ||
| // And we're done. | ||
| pty.WriteLine("exit") | ||
| <-cmdDone | ||
| }) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. praise: This is such a cool test. | ||
| } | ||
| // tGoContext runs fn in a goroutine passing a context that will be | ||
| // canceled on test completion and wait until fn has finished executing. | ||
| // Done and cancel are returned for optionally waiting until completion | ||
| // or early cancellation. | ||
| // | ||
| // NOTE(mafredri): This could be moved to a helper library. | ||
| func tGoContext(t *testing.T, fn func(context.Context)) (done <-chan struct{}, cancel context.CancelFunc) { | ||
| t.Helper() | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| doneC := make(chan struct{}) | ||
| t.Cleanup(func() { | ||
| cancel() | ||
| <-done | ||
| }) | ||
| go func() { | ||
| fn(ctx) | ||
| close(doneC) | ||
| }() | ||
| return doneC, cancel | ||
| } | ||
| // tGo runs fn in a goroutine and waits until fn has completed before | ||
| // test completion. Done is returned for optionally waiting for fn to | ||
| // exit. | ||
| // | ||
| // NOTE(mafredri): This could be moved to a helper library. | ||
| func tGo(t *testing.T, fn func()) (done <-chan struct{}) { | ||
| t.Helper() | ||
| doneC := make(chan struct{}) | ||
| t.Cleanup(func() { | ||
| <-doneC | ||
| }) | ||
Comment on lines +266 to 268 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. note: I wasn't sure of this so I had to remind myself -- reading from a closed channel will immediately return the zero value of the channel type, and not block. https://go.dev/play/p/PIS5JU1Lbgz So this is fine, this won't cause | ||
| go func() { | ||
| fn() | ||
| close(doneC) | ||
| }() | ||
| return doneC | ||
| } | ||
| type stdioConn struct { | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.