Windows CLI 服务器配置与 API 文档

配置文件结构

项目的核心配置存储在 config.json 文件中，包含以下关键字段：

• security
  安全设置：

  • blockedCommands: 禁用危险命令列表（默认包括：rm, del, format）
  • blockedArguments: 禁止使用的参数列表（默认包括危险标志选项）
  • enableInjectionProtection: 是否启用防止命令注入功能（默认开启）
  • restrictWorkingDirectory: 是否限制命令执行目录到指定路径（默认开启）
  • commandLengthLimit: 命令的最大允许长度（默认：2000 字符）
  • commandTimeout: 命令的最长执行时间（默认：30 秒）

• logging
  日志设置：

  • logCommands: 是否记录命令历史（默认开启）
  • logPath: 日志文件保存路径（默认：./logs/commands.log）

• sshConfig
  SSH 连接配置：

  • defaultTimeout: 默认连接超时时间（默认：10 秒）
  • maxConcurrentSessions: 最大并发 SSH 会话数（默认：5）
  • connectionConfigs: 存储所有已配置的 SSH 连接信息

核心 API 函数

命令执行

• executeCommand
  执行本地命令。
  输入：

  • command: 要执行的命令字符串（必须）
  • workingDirectory: 可选执行目录，默认当前目录
    输出：
  • 成功时返回 { success: true, output: String }
  • 失败时返回 { success: false, error: String }

• executeSshCommand
  执行远程 SSH 命令。
  输入：

  • connectionId: 连接标识符（必须）
  • command: 要执行的命令字符串（必须）
    输出：
  • 成功时返回 { success: true, output: String }
  • 失败时返回 { success: false, error: String }

连接管理

• addSshConnection
  添加新的 SSH 连接。
  输入：

  • connectionId: 连接标识符（必须）
  • host: 目标主机地址（必须）
  • port: 连接端口，默认 22
  • username: 用户名（必须）
  • password: 密码或私钥路径（可选，推荐使用密钥认证）
    输出：
  • 成功时返回 { success: true }
  • 失败时返回 { success: false, error: String }

• removeSshConnection
  删除指定的 SSH 连接。
  输入：

  • connectionId: 连接标识符（必须）
    输出：
  • 成功时返回 { success: true }
  • 失败时返回 { success: false, error: String }

资源 URI 定义

所有资源通过 RESTful API 接口访问，统一路径为 /api/v1/：

• /commands
  管理本地命令执行。支持 POST 请求提交新命令。

• /ssh_connections
  管理 SSH 连接配置。支持 GET（获取所有连接）、POST（添加新连接）、DELETE（删除指定连接）操作。

安全注意事项

内置保护机制

1. 命令注入防护：
   默认启用多层过滤机制，防止恶意代码注入攻击。

2. 目录限制：
   所有命令执行均限制在预设的安全目录内，防止越界访问。

3. 超时控制：
   长时间未响应的任务将自动终止，避免占用过多资源。

安全警告

• 禁止在不可信环境中直接使用用户输入作为命令参数。
• 保持定期更新 SSH 连接凭证，避免密码泄露风险。
• 建议启用额外的身份验证措施（如双因素认证）以增强安全性。

许可证

本项目遵循 MIT 许可证协议：

MIT License

Copyright (c) [年份] [作者姓名]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.