Win Cli MCP Server

🚀 Windows CLI 服務器配置與 API 文檔

本項目聚焦於 Windows CLI 服務器的配置與 API 管理，通過合理的配置文件設置和豐富的 API 接口，實現安全、高效的命令執行和連接管理。

🚀 快速開始

本項目的核心配置存儲在 config.json 文件中，下面將詳細介紹其結構和各字段含義。

✨ 主要特性

• 安全防護：具備命令注入防護、目錄限制和超時控制等多層安全保護機制。
• 靈活配置：支持對安全設置、日誌記錄和 SSH 連接等進行靈活配置。
• 豐富 API：提供命令執行和連接管理等核心 API 函數，方便進行本地和遠程操作。

📦 安裝指南

暫未提及安裝步驟，可根據實際情況補充。

💻 使用示例

基礎用法

# 執行本地命令示例
import requests

# 假設 API 地址為 http://localhost:8080/api/v1/commands
url = 'http://localhost:8080/api/v1/commands'
data = {
    "command": "dir"
}
response = requests.post(url, json=data)
print(response.json())

高級用法

# 執行遠程 SSH 命令示例
import requests

# 假設 API 地址為 http://localhost:8080/api/v1/commands
url = 'http://localhost:8080/api/v1/ssh_connections/execute'
data = {
    "connectionId": "my_connection",
    "command": "ls -l"
}
response = requests.post(url, json=data)
print(response.json())

📚 詳細文檔

配置文件結構

項目的核心配置存儲在 config.json 文件中，包含以下關鍵字段：

安全設置（security）

• blockedCommands：禁用危險命令列表（默認包括：rm, del, format）。
• blockedArguments：禁止使用的參數列表（默認包括危險標誌選項）。
• enableInjectionProtection：是否啟用防止命令注入功能（默認開啟）。
• restrictWorkingDirectory：是否限制命令執行目錄到指定路徑（默認開啟）。
• commandLengthLimit：命令的最大允許長度（默認：2000 字符）。
• commandTimeout：命令的最長執行時間（默認：30 秒）。

日誌設置（logging）

• logCommands：是否記錄命令歷史（默認開啟）。
• logPath：日誌文件保存路徑（默認：./logs/commands.log）。

SSH 連接配置（sshConfig）

• 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.