Thales Ciphertrust Manager Mcp Server

CipherTrust Manager MCP 服务

本项目实现了一个独立开发的 CipherTrust MCP（Model Context Protocol）服务，可让 Claude 或 Cursor 等 AI 助手通过 ksctl CLI 与 CipherTrust Manager 资源交互。

目录

• 重要声明
• 功能
• 前置条件
• 安装
• 配置
• 使用方法
• 测试
• 与 AI 助手集成
• 环境变量
• 故障排除
• 项目结构
• 贡献
• 法律声明
• 许可证

重要声明

这是一个独立的开源项目。请注意：

• ⚠️ Thales 不提供官方支持
• ✅ 使用公开 API 和有文档说明的接口
• 🔧 由独立团队维护
• 📝 使用风险自负——请在您的环境中充分测试
• 💼 不提供担保——完整条款请参阅许可证

如需 CipherTrust Manager 的官方支持，请直接联系 Thales。

功能

MCP 服务提供一组工具和端点，供客户端（如 Claude Desktop 和 Cursor）与 CipherTrust 资源交互。支持的操作包括：

• 密钥管理
• CTE 客户端管理
• 用户管理
• 连接管理
• 以及更多

优势：

• 为 AI 助手提供统一界面，以便与 CipherTrust Manager 交互
• 支持密钥管理、连接管理、CTE 客户端管理等
• 通过 stdin/stdout 进行 JSON-RPC 通信
• 可通过环境变量配置

前置条件

• Git
• Python 3.11 或更高版本
• 用于依赖管理的 uv
• 可访问 CipherTrust Manager 实例
• 有效的 CipherTrust Manager 凭据

安装 Git（Windows）

如果尚未在 Windows 上安装 Git，请按以下步骤操作：

• 下载并安装 Git for Windows：https://git-scm.com/download/win
• 或通过 winget 安装：

  winget install --id Git.Git -e --source winget
  

• 验证安装——打开 PowerShell 并执行：

  git --version
  

  您应该能看到已安装的 Git 版本。

安装 Python 和 uv

方法 1：手动安装

1. 下载 Python

# Open PowerShell as Administrator (optional)
cd $env:USERPROFILE\Downloads
Invoke-WebRequest -Uri "https://www.python.org/ftp/python/3.12.4/python-3.12.4-amd64.exe" -OutFile "python-installer.exe"

2. 运行安装程序

.\python-installer.exe /quiet InstallAllUsers=1 PrependPath=1 Include_test=0

3. 验证安装

打开新的终端并运行：

python --version
pip --version

4. 安装 uv

pip install uv
uv --version

5. 克隆仓库

git clone https://github.com/sanyambassi/ciphertrust-manager-mcp-server.git
cd ciphertrust-manager-mcp-server

6. 创建虚拟环境并安装依赖项

uv venv
.venv\Scripts\activate
uv pip install -e .

方法 2：使用 winget（Windows）

1. 使用 winget 安装 Python

winget install --id Python.Python.3.12 --source winget --accept-package-agreements --accept-source-agreements

2. 关闭并重新打开 PowerShell

这样可确保 Python 已添加到 PATH 中。

3. 验证安装

python --version
pip --version

4. 安装 uv

pip install uv
uv --version

5. 克隆仓库

git clone https://github.com/sanyambassi/ciphertrust-manager-mcp-server.git
cd ciphertrust-manager-mcp-server

6. 创建虚拟环境并安装依赖项

uv venv
.venv\Scripts\activate
uv pip install -e .

配置

（可选）复制并编辑示例环境文件

.env 示例：

cp .env.example .env
# Edit .env with your CipherTrust Manager details

您也可以直接将这些变量设为环境变量，而不使用 .env 文件。

.env 内容示例：

CIPHERTRUST_URL=https://your-ciphertrust-manager.example.com
CIPHERTRUST_USER=admin
CIPHERTRUST_PASSWORD=your-password-here
CIPHERTRUST_NOSSLVERIFY=true

使用方法

**⚠️ 重要提示：**启动前，请确保环境变量或 .env 中包含有效的 CipherTrust Manager URL。

运行 CipherTrust MCP Server 主要有两种方式：

方法 1：直接执行

uv run ciphertrust-mcp-server

这会运行 ciphertrust_mcp_server/__main__.py 中的 main() 函数。

方法 2：以模块方式执行

uv run python -m ciphertrust_mcp_server.__main__

测试

本项目提供全面的测试能力，包括使用 Model Context Protocol Inspector 和 Python 单元测试。

快速测试

# Manual JSON-RPC testing (direct stdin/stdout)
uv run ciphertrust-mcp-server
# Then send JSON-RPC commands (see TESTING.md for details)

# Interactive UI (Inspector 2.5+). Open the printed URL; it includes MCP_INSPECTOR_API_TOKEN.
npx @modelcontextprotocol/inspector uv run --no-sync ciphertrust-mcp-server

# Quick CLI testing
# Get tools
npx @modelcontextprotocol/inspector --cli --config tests/mcp_inspector_config.json --server ciphertrust-local --method tools/list --format json
# Get system information
npx @modelcontextprotocol/inspector --cli --config tests/mcp_inspector_config.json --server ciphertrust-local --method tools/call --tool-name system_information --tool-arg action=get --format json
# Get 2 keys
npx @modelcontextprotocol/inspector --cli --config tests/mcp_inspector_config.json --server ciphertrust-local --method tools/call --tool-name key_management --tool-arg action=list --tool-arg limit=2 --format json

可用的测试方法

• 🔧 手动 JSON-RPC 测试：通过 stdin/stdout 直接通信，用于调试和开发
• 🖥️ 交互式 UI 测试：通过可视化 Web 界面进行手动测试和调试
• ⚡ CLI 自动化测试：通过命令行自动化集成 CI/CD
• 🧪 Python 单元测试：对服务组件进行全面的单元测试
• 🔗 集成测试：使用真实的 CipherTrust Manager 实例进行端到端测试

NPM 脚本

npm run test:inspector:ui     # Open Inspector UI (uses project .env)
npm run test:inspector:cli    # List tools via Inspector CLI
npm run test:python          # Run Python unit tests
npm run test:full           # Run complete test suite

全面测试指南

📖 详细的测试说明请参阅 TESTING.md

🔧 AI 助手提示词示例请参阅 EXAMPLE_PROMPTS.md

测试指南涵盖：

• 完整的设置和配置
• 高级测试场景

示例提示词包括：

• 密钥管理操作
• 用户和群组管理
• 系统和服务管理
• 集群管理
• 许可证管理
• CTE 操作
• 加密操作
• 以及更多实用场景

与 AI 助手集成

与 Cursor 搭配使用

1. 配置 Cursor

• 前往 Settings > MCP Tools > Add Custom MCP
• 在配置文件中添加以下内容（例如 mcp.json）：

{
  "mcpServers": {
    "ciphertrust": {
      "command": "Path to your project folder/ciphertrust-manager-mcp-server/.venv/bin/ciphertrust-mcp-server",
      "args": [],
      "env": {
        "CIPHERTRUST_URL": "https://your-ciphertrust.example.com",
        "CIPHERTRUST_USER": "admin",
        "CIPHERTRUST_PASSWORD": "your-password-here"
      }
    }
  }
}

在 Windows 上，使用 .venv\Scripts\ciphertrust-mcp-server.exe 路径，并将反斜杠写成两个：

{
  "mcpServers": {
    "ciphertrust": {
      "command": "C:\\path\\to\\ciphertrust-manager-mcp-server\\.venv\\Scripts\\ciphertrust-mcp-server",
      "args": [],
      "env": {
        "CIPHERTRUST_URL": "https://your-ciphertrust.example.com",
        "CIPHERTRUST_USER": "admin",
        "CIPHERTRUST_PASSWORD": "your-password-here"
      }
    }
  }
}

2. 应用配置

在 Cursor 中禁用后重新启用 CipherTrust MCP 服务，以应用更改。

与 Claude Desktop 搭配使用

1. 找到或创建 Claude Desktop 配置文件：

• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Roaming\Claude\claude_desktop_config.json

2. 添加或更新 MCP 服务配置：

macOS/Linux 示例：

{
  "mcpServers": {
    "ciphertrust": {
      "command": "/absolute/path/to/ciphertrust-manager-mcp-server/.venv/bin/ciphertrust-mcp-server",
      "env": {
        "CIPHERTRUST_URL": "https://your-ciphertrust.example.com",
        "CIPHERTRUST_USER": "admin",
        "CIPHERTRUST_PASSWORD": "your-password-here"
      }
    }
  }
}

Windows 示例：

{
  "mcpServers": {
    "ciphertrust": {
      "command": "C:\\absolute\\path\\to\\ciphertrust-manager-mcp-server\\.venv\\Scripts\\ciphertrust-mcp-server",
      "env": {
        "CIPHERTRUST_URL": "https://your-ciphertrust.example.com",
        "CIPHERTRUST_USER": "admin",
        "CIPHERTRUST_PASSWORD": "your-password-here"
      }
    }
  }
}

请调整路径，使其与你的实际项目位置和环境相匹配。

3. 重启 Claude Desktop

重启 Claude Desktop 以应用更改。

环境变量

在 shell 中设置这些变量，或将其写入项目根目录下的 .env 文件：

变量名称	描述	必填/默认值
CIPHERTRUST_URL	CipherTrust Manager URL（http/https）	必填
CIPHERTRUST_USER	CipherTrust Manager 用户名	必填
CIPHERTRUST_PASSWORD	CipherTrust Manager 密码	必填
CIPHERTRUST_NOSSLVERIFY	禁用 SSL 验证（true/false）	false
CIPHERTRUST_TIMEOUT	CipherTrust 请求超时时间（秒）	30
CIPHERTRUST_DOMAIN	默认 CipherTrust 域	root
CIPHERTRUST_AUTH_DOMAIN	身份验证域	root
KSCTL_PATH	ksctl 二进制文件的路径	~/.ciphertrust-mcp/ksctl
KSCTL_CONFIG_PATH	ksctl 配置文件的路径	~/.ksctl/config.yaml
LOG_LEVEL	日志级别（DEBUG、INFO）	INFO

.env 文件示例：

CIPHERTRUST_URL=https://your-ciphertrust.example.com
CIPHERTRUST_USER=admin
CIPHERTRUST_PASSWORD=yourpassword
CIPHERTRUST_NOSSLVERIFY=false
CIPHERTRUST_TIMEOUT=30
CIPHERTRUST_DOMAIN=root
CIPHERTRUST_AUTH_DOMAIN=root
KSCTL_PATH=
KSCTL_CONFIG_PATH=
LOG_LEVEL=INFO

故障排除

成功启动日志：

• 此服务旨在由 MCP 客户端（如 Claude Desktop 或 Cursor）作为子进程运行，并通过 stdin/stdout 使用 JSON-RPC 通信。
• 你将在 AI 助手的 MCP 日志中看到类似以下的日志输出：

2025-06-16 02:22:30,462 - ciphertrust_mcp_server.server - INFO - Starting ciphertrust-manager v0.2.0
2025-06-16 02:22:30,838 - ciphertrust_mcp_server.server - INFO - Successfully connected to CipherTrust Manager
2025-06-16 02:22:30,838 - ciphertrust_mcp_server.server - INFO - MCP server ready and waiting for JSON-RPC messages on stdin...

依赖项

pyproject.toml 文件包含以下依赖项：

• mcp>=2.1.1,<3
• pydantic>=2.12.0
• pydantic-settings>=2.0.0
• httpx>=0.27.0
• python-dotenv>=1.0.0

如果遇到问题，请确保所有依赖项均已安装并更新至最新版本。

项目结构

ciphertrust-manager-mcp-server/
├── src
│   ├── ciphertrust_mcp_server/     # Main server code
├── tests/                      	# Testing configuration and unit tests
│   ├── mcp_inspector_config.json
│   ├── test_scenarios.json
│   ├── test_server.py
│   └── test_integration_simple.py
├── scripts/                    	# Testing and utility scripts
│   ├── test_with_inspector.bat
│   ├── test_with_inspector.sh
│   └── run_tests.py
├── docs/                      		# Additional documentation
│   ├── TESTING.md
│   ├── EXAMPLE_PROMPTS.md
│   └── TOOLS.md
├── README.md                   	# This file
├── pyproject.toml             		# Python dependencies
└── package.json               		# Node.js dependencies for testing

贡献

欢迎贡献！欢迎提交 Pull Request。虽然这个项目最初是一个个人项目，但你的贡献能让它对所有人都更有帮助。

法律声明

商标声明

CipherTrust® 及相关商标均为 Thales Group 及其子公司的财产。本项目与 Thales Group 无关联，也未获其认可或赞助。

免责声明

本软件按“原样”提供，不提供任何形式的保证。使用风险由你自行承担。

支持

这是一个独立项目。如需 CipherTrust Manager 官方支持，请直接联系 Thales。如需反馈此非官方 MCP 服务的问题，请使用 GitHub 问题跟踪器。

许可证

本项目采用 MIT 许可证授权。详情请参阅 LICENSE 文件。

---