Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

feat: Enable arbitrary SSH options passed via config-ssh #410

Merged
merged 4 commits into from
Aug 9, 2021
Merged

feat: Enable arbitrary SSH options passed via config-ssh #410

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e071f1c
feat: Add option to disable SSH connection cache
kylecarbs Aug 9, 2021
33e15b3
Refactor to enable arbitrary options
kylecarbs Aug 9, 2021
840bf99
Generate docs
kylecarbs Aug 9, 2021
4410549
Add comment for duplicated values
kylecarbs Aug 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions internal/cmd/configssh.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,24 @@ const sshEndToken = "# ------------END-CODER-ENTERPRISE------------"
func configSSHCmd() *cobra.Command {
var (
configpath string
noCache = false
remove = false
)

cmd := &cobra.Command{
Use: "config-ssh",
Short: "Configure SSH to access Coder workspaces",
Long: "Inject the proper OpenSSH configuration into your local SSH config file.",
RunE: configSSH(&configpath, &remove),
RunE: configSSH(&configpath, &remove, &noCache),
}
cmd.Flags().StringVar(&configpath, "filepath", filepath.Join("~", ".ssh", "config"), "override the default path of your ssh config file")
cmd.Flags().BoolVar(&noCache, "no-cache", false, "disable ssh connection caching")
cmd.Flags().BoolVar(&remove, "remove", false, "remove the auto-generated Coder ssh config")

return cmd
}

func configSSH(configpath *string, remove *bool) func(cmd *cobra.Command, _ []string) error {
func configSSH(configpath *string, remove *bool, noCache *bool) func(cmd *cobra.Command, _ []string) error {
return func(cmd *cobra.Command, _ []string) error {
ctx := cmd.Context()
usr, err := user.Current()
Expand Down Expand Up @@ -118,7 +120,7 @@ func configSSH(configpath *string, remove *bool) func(cmd *cobra.Command, _ []st
return xerrors.Errorf("Failed to get executable path: %w", err)
}

newConfig := makeNewConfigs(binPath, workspacesWithProviders, privateKeyFilepath)
newConfig := makeNewConfigs(binPath, workspacesWithProviders, privateKeyFilepath, *noCache)

err = os.MkdirAll(filepath.Dir(*configpath), os.ModePerm)
if err != nil {
Expand Down Expand Up @@ -226,7 +228,7 @@ func writeSSHKey(ctx context.Context, client coder.Client, privateKeyPath string
return ioutil.WriteFile(privateKeyPath, []byte(key.PrivateKey), 0600)
}

func makeNewConfigs(binPath string, workspaces []coderutil.WorkspaceWithWorkspaceProvider, privateKeyFilepath string) string {
func makeNewConfigs(binPath string, workspaces []coderutil.WorkspaceWithWorkspaceProvider, privateKeyFilepath string, noCache bool) string {
newConfig := fmt.Sprintf("\n%s\n%s\n\n", sshStartToken, sshStartMessage)

sort.Slice(workspaces, func(i, j int) bool { return workspaces[i].Workspace.Name < workspaces[j].Workspace.Name })
Expand All @@ -240,14 +242,14 @@ func makeNewConfigs(binPath string, workspaces []coderutil.WorkspaceWithWorkspac
continue
}

newConfig += makeSSHConfig(binPath, workspace.Workspace.Name, privateKeyFilepath)
newConfig += makeSSHConfig(binPath, workspace.Workspace.Name, privateKeyFilepath, noCache)
}
newConfig += fmt.Sprintf("\n%s\n", sshEndToken)

return newConfig
}

func makeSSHConfig(binPath, workspaceName, privateKeyFilepath string) string {
func makeSSHConfig(binPath, workspaceName, privateKeyFilepath string, noCache bool) string {
entry := fmt.Sprintf(
`Host coder.%s
HostName coder.%s
Expand All @@ -258,7 +260,7 @@ func makeSSHConfig(binPath, workspaceName, privateKeyFilepath string) string {
IdentityFile="%s"
`, workspaceName, workspaceName, binPath, workspaceName, privateKeyFilepath)

if runtime.GOOS == "linux" || runtime.GOOS == "darwin" {
if !noCache && (runtime.GOOS == "linux" || runtime.GOOS == "darwin") {
entry += ` ControlMaster auto
ControlPath ~/.ssh/.connection-%r@%h:%p
ControlPersist 600
Expand Down