Function mergeSSHOptions

cli/configssh.go:576–635

(
	user sshConfigOptions, coderd codersdk.SSHConfigResponse, globalConfigPath, coderBinaryPath string,
)

}

func mergeSSHOptions(
	user sshConfigOptions, coderd codersdk.SSHConfigResponse, globalConfigPath, coderBinaryPath string,
) (
	sshConfigOptions, error,
) {
	if err := coderd.Validate(); err != nil {
		return sshConfigOptions{}, xerrors.Errorf("invalid ssh config from coderd: %w", err)
	}

	// Write agent configuration.
	defaultOptions := []string{
		"ConnectTimeout=0",
		"StrictHostKeyChecking=no",
		// Without this, the "REMOTE HOST IDENTITY CHANGED"
		// message will appear.
		"UserKnownHostsFile=/dev/null",
		// This disables the "Warning: Permanently added 'hostname' (RSA) to the list of known hosts."
		// message from appearing on every SSH. This happens because we ignore the known hosts.
		"LogLevel ERROR",
	}

	// Create a copy of the options so we can modify them.
	configOptions := user
	configOptions.sshOptions = nil

	configOptions.globalConfigPath = globalConfigPath
	configOptions.coderBinaryPath = coderBinaryPath
	// user config takes precedence
	if user.userHostPrefix == "" {
		configOptions.userHostPrefix = coderd.HostnamePrefix
	}
	if user.hostnameSuffix == "" {
		configOptions.hostnameSuffix = coderd.HostnameSuffix
	}

	// User options first (SSH only uses the first
	// option unless it can be given multiple times)
	for _, opt := range user.sshOptions {
		err := configOptions.addOptions(opt)
		if err != nil {
			return sshConfigOptions{}, xerrors.Errorf("add flag config option %q: %w", opt, err)
		}
	}

	// Deployment options second, allow them to
	// override standard options.
	for k, v := range coderd.SSHConfigOptions {
		opt := fmt.Sprintf("%s %s", k, v)
		err := configOptions.addOptions(opt)
		if err != nil {
			return sshConfigOptions{}, xerrors.Errorf("add coderd config option %q: %w", opt, err)
		}
	}

	// Finally, add the standard options.
	if err := configOptions.addOptions(defaultOptions...); err != nil {
		return sshConfigOptions{}, err
	}