Function parseSSHConfig

src/utils/ssh-config-parser.ts:111–211

(
  hostAlias: string,
  configPath: string,
  options: { requireUser?: boolean } = {}
)

  options: { requireUser: false }
): SSHConfigLookupResult | null;
export function parseSSHConfig(
  hostAlias: string,
  configPath: string,
  options: { requireUser?: boolean } = {}
): SSHConfigLookupResult | null {
  const { requireUser = true } = options;

  // Resolve symlinks in the config path (important for Windows where .ssh may be a junction)
  const sshConfigPath = resolveSymlink(configPath);

  // Check if SSH config file exists
  if (!isFile(sshConfigPath)) {
    return null;
  }

  try {
    // Read and parse SSH config file
    const configContent = readFileSync(sshConfigPath, 'utf8');
    const config = SSHConfig.parse(configContent);

    // Find configuration for the specified host
    const hostConfig = config.compute(hostAlias);

    // Check if we have a valid config (not just Include directives). A host counts as
    // configured if it sets any meaningful directive — not only HostName/User — since
    // ProxyJump aliases often define just Port/IdentityFile/ProxyJump and inherit the
    // hostname (the alias) and username (from the target).
    if (
      !hostConfig ||
      (!hostConfig.HostName && !hostConfig.User && !hostConfig.Port && !hostConfig.IdentityFile && !hostConfig.ProxyJump)
    ) {
      return null;
    }

    // Extract SSH configuration parameters
    const sshConfig: Partial<SSHConfigLookupResult> = {};

    // Host (required)
    if (hostConfig.HostName) {
      sshConfig.host = hostConfig.HostName;
    } else {
      // If no HostName specified, use the host alias itself
      sshConfig.host = hostAlias;
    }

    // Port (optional, default will be 22)
    if (hostConfig.Port) {
      sshConfig.port = parseInt(hostConfig.Port, 10);
    }

    // User (required)
    if (hostConfig.User) {
      sshConfig.username = hostConfig.User;
    }

    // IdentityFile (private key)
    if (hostConfig.IdentityFile) {
      // SSH config can have multiple IdentityFile entries, take the first one