将 SSH 配置文件解析为结构化 JSON 数据-js教程-PHP中文网

将 SSH 配置文件解析为结构化 JSON 数据

本文介绍如何安全、准确地将 OpenSSH 的 .ssh/config 文件转换为标准 JSON 格式，强调使用成熟库（如 ssh-config）的必要性，并提供轻量级手动解析的参考实现与关键注意事项。

本文介绍如何安全、准确地将 openssh 的 `.ssh/config` 文件转换为标准 json 格式，强调使用成熟库（如 `ssh-config`）的必要性，并提供轻量级手动解析的参考实现与关键注意事项。

在日常开发与运维中，我们常需程序化读取 .ssh/config 文件（例如动态切换 Git 账户、构建 CI/CD 凭据管理模块）。但直接用字符串分割 + reduce 手动解析存在严重隐患：SSH 配置语法远比表面复杂——关键字不区分大小写（如 hostname 和 HostName 等效）、值可能含空格或引号（如 IdentityFile ~/.ssh/"id_rsa (work)"）、支持多参数（ProxyCommand nc -X 5 -x proxy:1080 %h %p）、存在 Match 块触发新作用域，且注释仅在行首 # 才生效（Host example.com # inline comment 是合法配置）。

✅ 强烈推荐：使用专业解析库
NPM 生态中成熟的 ssh-config 库已完整覆盖 RFC 与 OpenSSH 实现细节。安装后一行即可获得标准化对象：

npm install ssh-config

import fs from 'fs';
import sshConfig from 'ssh-config';

const configText = fs.readFileSync(`${process.env.HOME}/.ssh/config`, 'utf8');
const parsed = sshConfig.parse(configText);

// 转为符合需求的 JSON 数组（每个 Host 对应一个对象）
const hosts = parsed.filter(block => block.type === 'host').map(block => {
  const obj = {};
  block.config.forEach(({ key, value }) => {
    // 自动标准化 key 名（转驼峰或全小写均可，此处保留原始大小写）
    obj[key] = value;
  });
  return obj;
});

console.log(JSON.stringify(hosts, null, 2));

⚠️ 若必须手动解析（如无依赖场景），请严格遵循以下原则：

Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据，从示例 JSON 生成 schema，并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载

跳过空行与真注释：仅当 line.trim().startsWith('#') 时忽略；
按块切分逻辑：以 Host 或 Match 开头的行标志新配置块起始；
键值对健壮提取：使用正则 /^(\w+)\s+(.+)$/.exec(line) 捕获首个单词为 key，剩余内容为 value（保留内部空格与引号）；
避免 split(' ')：它会错误切割带空格的路径或用户名。

以下是简化但更可靠的纯逻辑实现（仍不替代生产环境中的 ssh-config）：

function parseSshConfig(content) {
  const lines = content.trim().split('\n');
  const sections = [];
  let current = null;

  for (const line of lines) {
    const trimmed = line.trim();
    // 跳过空行和行首注释
    if (!trimmed || trimmed.startsWith('#')) continue;

    const match = /^(\w+)\s+(.+)$/.exec(trimmed);
    if (!match) continue;

    const [_, key, value] = match;
    const normalizedKey = key.charAt(0).toUpperCase() + key.slice(1).toLowerCase(); // 简单标准化

    // 新 Host 或 Match 块开始
    if (normalizedKey === 'Host' || normalizedKey === 'Match') {
      current = { [normalizedKey]: value };
      sections.push(current);
    } else if (current) {
      current[normalizedKey] = value;
    }
  }

  return sections;
}

// 使用示例
const config = `# Personal account
Host github.com-user1
   HostName github.com
   User git
   IdentityFile ~/.ssh/id_rsa_user1
# Official account
Host github.com-user2
   HostName github.com
   User git
   IdentityFile ~/.ssh/id_rsa_user2`;

console.log(JSON.stringify(parseSshConfig(config), null, 2));

? 总结：