Windows CLI 工具文档

介绍

该工具提供了一个基于 Windows 的命令行接口 (CLI) 解决方案，支持多种功能，包括命令执行、命令历史记录获取以及通过 SSH 远程执行命令。以下是详细的技术规格和使用说明。

文档内容

工具概览

• execute_command: 在指定的 Shell 环境中执行命令。
• get_command_history: 获取已执行的命令历史记录。
• ssh_execute: 通过 SSH 协议在远程设备上执行命令。
• ssh_disconnect: 断开与远程 SSH 服务器的连接。

技术规格

execute_command

• 输入参数:

  • shell: 指定 Shell 类型（"powershell"、"cmd" 或 "gitbash"）。
  • command: 需要执行的具体命令。
  • workingDir（可选）: 指定工作目录，默认为当前目录。

• 输出:

  • 成功执行命令：返回命令的输出结果。
  • 执行失败：返回错误信息。

get_command_history

• 输入参数:

  • limit（可选数字）: 设置获取的历史记录数量上限。

• 输出:

  • 返回包含时间戳的命令历史记录及其对应的输出结果。

ssh_execute

• 输入参数:

  • connectionId: 指定要使用的 SSH 连接标识符。
  • command: 在远程设备上执行的具体命令。

• 输出:

  • 成功执行：返回命令的输出结果。
  • 执行失败：返回错误信息。

ssh_disconnect

• 输入参数:

  • connectionId: 指定要断开的 SSH 连接标识符。

• 输出:

  • 返回确认消息，表明连接已成功断开。

安全注意事项

• 命令控制: 基于可执行文件名称和完整路径来阻止特定命令。
• 大小写不敏感: 对于如 "DEL.EXE" 或 "del.cmd" 等不同大小写的命令进行统一处理。
• 智能路径解析: 防止通过替换路径等方式绕过命令限制。
• 内容分析: 通过分析命令内容避免误报，例如即使 "rm" 被阻止，"warm_dir" 仍可正常执行。
• 危险参数拦截: 对可能带来风险的命令参数进行拦截。
• 注入防护: 可选功能，用于防止命令注入攻击。
• 目录验证: 确保工作目录在允许的路径范围内。
• 长度限制: 默认情况下对命令长度进行限制。
• 进程终止: 确保 Shell 进程能够被正确终止。
• 输入验证: 所有输入均需经过验证后才能执行。
• 环境变量和文件访问: 在受控的允许路径内，可能需要限制对敏感目录和环境信息的访问。

许可证

本项目采用 MIT 许可证，详细内容请参阅 LICENSE 文件。