When `DisableUserSecretFilePath` is set, coderd strips file targets while building the agent manifest: env-only secrets are unchanged, dual-target secrets keep the env var with an empty file path, and file-only secrets are omitted so their plaintext never crosses DRPC. Stored paths stay in the database and reappear on the next manifest fetch once the option is cleared. Agents converge on reconnect; no protobuf, provisioner, or agent-side changes are needed, and files already written to workspace disks are left alone. Also exposes the positive capability as the `user-secret-file-path-enabled` embedded metadata tag, which the next PR in the stack consumes in the dashboard. Builds on #28518. Refs #27488. Reviewed and updated by Coder Agents on behalf of @dylanhuff-at-coder.
144 lines
3.8 KiB
Go
144 lines
3.8 KiB
Go
package agentapi
|
|
|
|
import (
|
|
"fmt"
|
|
"net/url"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
agentproto "github.com/coder/coder/v2/agent/proto"
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/workspaceapps/appurl"
|
|
)
|
|
|
|
func Test_dbUserSecretsToProto(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
secrets := []database.UserSecret{
|
|
{Name: "env-only", EnvName: "ENV_ONLY", Value: "env-val", Enabled: true},
|
|
{Name: "file-only", FilePath: "~/.ssh/id_rsa", Value: "file-val", Enabled: true},
|
|
{Name: "dual", EnvName: "DUAL_ENV", FilePath: "/etc/dual", Value: "dual-val", Enabled: true},
|
|
{Name: "disabled", EnvName: "DISABLED_ENV", FilePath: "/etc/disabled", Value: "disabled-val"},
|
|
}
|
|
|
|
cases := []struct {
|
|
name string
|
|
policy userSecretFilePathPolicy
|
|
expected []*agentproto.WorkspaceSecret
|
|
}{
|
|
{
|
|
name: "FilePathAllowed",
|
|
policy: userSecretFilePathAllowed,
|
|
expected: []*agentproto.WorkspaceSecret{
|
|
{EnvName: "ENV_ONLY", Value: []byte("env-val")},
|
|
{FilePath: "~/.ssh/id_rsa", Value: []byte("file-val")},
|
|
{EnvName: "DUAL_ENV", FilePath: "/etc/dual", Value: []byte("dual-val")},
|
|
},
|
|
},
|
|
{
|
|
name: "FilePathBlocked",
|
|
policy: userSecretFilePathBlocked,
|
|
expected: []*agentproto.WorkspaceSecret{
|
|
{EnvName: "ENV_ONLY", Value: []byte("env-val")},
|
|
{EnvName: "DUAL_ENV", Value: []byte("dual-val")},
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, c := range cases {
|
|
t.Run(c.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
got := dbUserSecretsToProto(secrets, c.policy)
|
|
require.Len(t, got, len(c.expected))
|
|
for i, want := range c.expected {
|
|
require.Equal(t, want.EnvName, got[i].EnvName, "secret %d env_name", i)
|
|
require.Equal(t, want.FilePath, got[i].FilePath, "secret %d file_path", i)
|
|
require.Equal(t, want.Value, got[i].Value, "secret %d value", i)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_vscodeProxyURI(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
coderAccessURL, err := url.Parse("https://coder.com")
|
|
require.NoError(t, err)
|
|
|
|
accessURLWithPort, err := url.Parse("https://coder.com:8080")
|
|
require.NoError(t, err)
|
|
|
|
basicApp := appurl.ApplicationURL{
|
|
Prefix: "prefix",
|
|
AppSlugOrPort: "slug",
|
|
AgentName: "agent",
|
|
WorkspaceName: "workspace",
|
|
Username: "user",
|
|
}
|
|
|
|
cases := []struct {
|
|
Name string
|
|
App appurl.ApplicationURL
|
|
AccessURL *url.URL
|
|
AppHostname string
|
|
Expected string
|
|
}{
|
|
{
|
|
Name: "NoHostname",
|
|
AccessURL: coderAccessURL,
|
|
AppHostname: "",
|
|
App: basicApp,
|
|
Expected: "",
|
|
},
|
|
{
|
|
Name: "NoHostnameAccessURLPort",
|
|
AccessURL: accessURLWithPort,
|
|
AppHostname: "",
|
|
App: basicApp,
|
|
Expected: "",
|
|
},
|
|
{
|
|
Name: "Hostname",
|
|
AccessURL: coderAccessURL,
|
|
AppHostname: "*.apps.coder.com",
|
|
App: basicApp,
|
|
Expected: fmt.Sprintf("https://%s.apps.coder.com", basicApp.String()),
|
|
},
|
|
{
|
|
Name: "HostnameWithAccessURLPort",
|
|
AccessURL: accessURLWithPort,
|
|
AppHostname: "*.apps.coder.com",
|
|
App: basicApp,
|
|
Expected: fmt.Sprintf("https://%s.apps.coder.com:%s", basicApp.String(), accessURLWithPort.Port()),
|
|
},
|
|
{
|
|
Name: "HostnameWithPort",
|
|
AccessURL: coderAccessURL,
|
|
AppHostname: "*.apps.coder.com:4444",
|
|
App: basicApp,
|
|
Expected: fmt.Sprintf("https://%s.apps.coder.com:%s", basicApp.String(), "4444"),
|
|
},
|
|
{
|
|
// Port from hostname takes precedence over access url port.
|
|
Name: "HostnameWithPortAccessURLWithPort",
|
|
AccessURL: accessURLWithPort,
|
|
AppHostname: "*.apps.coder.com:4444",
|
|
App: basicApp,
|
|
Expected: fmt.Sprintf("https://%s.apps.coder.com:%s", basicApp.String(), "4444"),
|
|
},
|
|
}
|
|
|
|
for _, c := range cases {
|
|
t.Run(c.Name, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
require.NotNilf(t, c.AccessURL, "AccessURL is required")
|
|
|
|
output := vscodeProxyURI(c.App, c.AccessURL, c.AppHostname)
|
|
require.Equal(t, c.Expected, output)
|
|
})
|
|
}
|
|
}
|