feat: Add user scoped git ssh keys (#834)

2025-07-06 15:41:45 +00:00 · 2022-04-05 19:18:26 -05:00
parent 1e9e5f7c76
commit 9da17be61e
19 changed files with 924 additions and 2 deletions
--- a/coderd/gitsshkey_test.go
+++ b/coderd/gitsshkey_test.go
@ -0,0 +1,129 @@
+package coderd_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/google/uuid"
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/coderd/coderdtest"
+	"github.com/coder/coder/coderd/gitsshkey"
+	"github.com/coder/coder/codersdk"
+	"github.com/coder/coder/provisioner/echo"
+	"github.com/coder/coder/provisionersdk/proto"
+)
+
+func TestGitSSHKey(t *testing.T) {
+	t.Parallel()
+	t.Run("None", func(t *testing.T) {
+		t.Parallel()
+		ctx := context.Background()
+		client := coderdtest.New(t, nil)
+		res := coderdtest.CreateFirstUser(t, client)
+		key, err := client.GitSSHKey(ctx, res.UserID)
+		require.NoError(t, err)
+		require.NotEmpty(t, key.PublicKey)
+	})
+	t.Run("Ed25519", func(t *testing.T) {
+		t.Parallel()
+		ctx := context.Background()
+		client := coderdtest.New(t, &coderdtest.Options{
+			SSHKeygenAlgorithm: gitsshkey.AlgorithmEd25519,
+		})
+		res := coderdtest.CreateFirstUser(t, client)
+		key, err := client.GitSSHKey(ctx, res.UserID)
+		require.NoError(t, err)
+		require.NotEmpty(t, key.PublicKey)
+	})
+	t.Run("ECDSA", func(t *testing.T) {
+		t.Parallel()
+		ctx := context.Background()
+		client := coderdtest.New(t, &coderdtest.Options{
+			SSHKeygenAlgorithm: gitsshkey.AlgorithmECDSA,
+		})
+		res := coderdtest.CreateFirstUser(t, client)
+		key, err := client.GitSSHKey(ctx, res.UserID)
+		require.NoError(t, err)
+		require.NotEmpty(t, key.PublicKey)
+	})
+	t.Run("RSA4096", func(t *testing.T) {
+		t.Parallel()
+		ctx := context.Background()
+		client := coderdtest.New(t, &coderdtest.Options{
+			SSHKeygenAlgorithm: gitsshkey.AlgorithmRSA4096,
+		})
+		res := coderdtest.CreateFirstUser(t, client)
+		key, err := client.GitSSHKey(ctx, res.UserID)
+		require.NoError(t, err)
+		require.NotEmpty(t, key.PublicKey)
+	})
+	t.Run("Regenerate", func(t *testing.T) {
+		t.Parallel()
+		ctx := context.Background()
+		client := coderdtest.New(t, &coderdtest.Options{
+			SSHKeygenAlgorithm: gitsshkey.AlgorithmEd25519,
+		})
+		res := coderdtest.CreateFirstUser(t, client)
+		key1, err := client.GitSSHKey(ctx, res.UserID)
+		require.NoError(t, err)
+		require.NotEmpty(t, key1.PublicKey)
+		key2, err := client.RegenerateGitSSHKey(ctx, res.UserID)
+		require.NoError(t, err)
+		require.Greater(t, key2.UpdatedAt, key1.UpdatedAt)
+		require.NotEmpty(t, key2.PublicKey)
+		require.NotEqual(t, key2.PublicKey, key1.PublicKey)
+	})
+}
+
+func TestAgentGitSSHKey(t *testing.T) {
+	t.Parallel()
+
+	agentClient := func(algo gitsshkey.Algorithm) *codersdk.Client {
+		client := coderdtest.New(t, &coderdtest.Options{
+			SSHKeygenAlgorithm: algo,
+		})
+		user := coderdtest.CreateFirstUser(t, client)
+		daemonCloser := coderdtest.NewProvisionerDaemon(t, client)
+		authToken := uuid.NewString()
+		version := coderdtest.CreateProjectVersion(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: "example",
+							Type: "aws_instance",
+							Agent: &proto.Agent{
+								Id: uuid.NewString(),
+								Auth: &proto.Agent_Token{
+									Token: authToken,
+								},
+							},
+						}},
+					},
+				},
+			}},
+		})
+		project := coderdtest.CreateProject(t, client, user.OrganizationID, version.ID)
+		coderdtest.AwaitProjectVersionJob(t, client, version.ID)
+		workspace := coderdtest.CreateWorkspace(t, client, codersdk.Me, project.ID)
+		coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
+		daemonCloser.Close()
+
+		agentClient := codersdk.New(client.URL)
+		agentClient.SessionToken = authToken
+
+		return agentClient
+	}
+
+	t.Run("AgentKey", func(t *testing.T) {
+		t.Parallel()
+		ctx := context.Background()
+		client := agentClient(gitsshkey.AlgorithmEd25519)
+		agentKey, err := client.AgentGitSSHKey(ctx)
+		require.NoError(t, err)
+		require.NotEmpty(t, agentKey.PrivateKey)
+	})
+}