README
🚀 MobSF-MCP
MobSF MCP是基于Node.js的模型上下文协议实现,专为移动安全框架(MobSF)打造。它提供了标准化接口,可将MobSF的安全分析能力集成到自动化工作流和第三方工具中。
🚀 快速开始
MobSF MCP是一个基于Node.js的模型上下文协议实现,用于移动安全框架(MobSF)。它为将MobSF的安全分析功能集成到自动化工作流和第三方工具中提供了标准化接口。
✨ 主要特性
- 提供标准化接口,便于将MobSF安全分析能力集成到自动化工作流和第三方工具。
- 支持多种API接口,可进行文件上传、扫描日志获取、报告生成等操作。
📦 安装指南
安装依赖
克隆仓库或导航到mobsf-mcp目录,然后安装依赖:
npm install -g mobsf-mcp
配置环境变量并启动服务器
以管理员身份打开PowerShell,然后执行以下命令:
$env:MOBSF_URL="http://localhost:8000";
$env:MOBSF_API_KEY="your_api_key_here";
npx mobsf-mcp
📚 详细文档
📂 API参考
可用端点
| 端点 | 描述 | 参数 |
|------|-------------|------------|
| uploadFile | 上传移动应用文件(APK、IPA或APPX)进行安全分析 | file:要上传的文件路径 |
| getScanLogs | 获取已分析应用的详细扫描日志 | hash:扫描的MD5哈希值 |
| getJsonReport | 获取完整的JSON安全分析报告 | hash:扫描的MD5哈希值 |
| getJsonReportSection | 获取报告的特定部分 | hash:MD5哈希值,section:部分名称 |
| getJsonReportSections | 列出所有可用的报告部分 | hash:扫描的MD5哈希值 |
| getRecentScans | 获取最近的安全扫描列表 | page:页码,pageSize:每页结果数 |
| searchScanResult | 根据各种条件搜索扫描结果 | query:搜索词(哈希/名称/包名) |
| deleteScan | 删除扫描结果 | hash:扫描的MD5哈希值 |
| getScorecard | 获取应用安全评分卡 | hash:扫描的MD5哈希值 |
| generatePdfReport | 生成PDF安全报告 | hash:扫描的MD5哈希值 |
| viewSource | 查看分析中的源文件 | hash:MD5哈希值,file:文件路径,type:文件类型 |
| getScanTasks | 获取扫描任务队列(异步扫描队列) | 无 |
| compareApps | 比较两个扫描结果 | hash1:第一次扫描的哈希值,hash2:第二次扫描的哈希值 |
| suppressByRule | 按规则ID抑制发现结果 | hash:MD5哈希值,type:代码/清单,rule:规则ID |
| suppressByFiles | 按文件抑制发现结果 | hash:MD5哈希值,type:代码,rule:规则ID |
| listSuppressions | 查看扫描抑制情况 | hash:扫描的MD5哈希值 |
| deleteSuppression | 删除抑制设置 | hash:MD5哈希值,type:代码/清单,rule:规则ID,kind:规则/文件 |
| listAllHashes | 获取所有报告的MD5哈希值 | page:页码,pageSize:每页结果数 |
JSON报告部分
使用getJsonReportSection时,可获取以下部分:
基本信息
version:MobSF版本title:报告标题file_name:分析的文件名app_name:应用名称app_type:应用类型size:文件大小md5、sha1、sha256:文件哈希值package_name:应用包名
应用组件
main_activity:主活动名称exported_activities:导出活动列表browsable_activities:可浏览活动列表activities:所有活动receivers:广播接收器providers:内容提供者services:服务libraries:原生库
安全分析
target_sdk、max_sdk、min_sdk:SDK版本version_name、version_code:应用版本信息permissions:声明的权限malware_permissions:潜在危险权限certificate_analysis:证书安全分析manifest_analysis:AndroidManifest.xml分析network_security:网络安全配置binary_analysis:二进制文件分析code_analysis:源代码安全分析niap_analysis:NIAP合规性分析
额外分析
permission_mapping:权限使用映射urls、domains、emails:提取的字符串firebase_urls:Firebase URL分析exported_count:导出组件数量apkid:APK标识符信息behaviour:应用行为分析trackers:跟踪库检测playstore_details:Google Play商店详情secrets:检测到的秘密/密钥logs:分析日志sbom:软件物料清单average_cvss:平均CVSS分数appsec:应用安全分数virus_total:VirusTotal扫描结果
🖥️ VSCode Cline扩展配置
要在VSCode中使用cline扩展与本项目配合使用,请在cline配置文件中添加以下配置:
{
"mcpServers": {
"MobSF MCP Server": {
"disabled": false,
"timeout": 60,
"command": "Nodejs\\node.exe",
"args": [
"index.js"
],
"env": {
"MOBSF_URL": "http://localhost:8000",
"MOBSF_API_KEY": "your_api_key_here"
},
"transportType": "stdio"
}
}
}
⚠️ 重要提示
请根据您的系统调整Node.js可执行文件的路径(例如
C:\\Program Files\\nodejs\\node.exe),并确保在配置中填写实际的MOBSF_API_KEY。
⚠️ 免责声明和法律声明
本工具专为安全研究人员、渗透测试人员和开发人员设计,仅用于合法用途。其主要目的在于协助进行以下工作:
- 对您自己的应用程序进行安全评估。
- 对您已获得明确测试许可的应用程序进行测试。
- 用于研究和教育目的。
严禁进行以下使用:
- 任何恶意或有害活动。
- 未经授权访问系统或数据。
- 在未获得适当授权的情况下测试应用程序。
- 任何非法活动或违反法律的行为。
使用本工具即表示您同意:
- 仅将其用于合法和授权目的。
- 对自己的行为承担全部责任。
- 遵守所有适用的法律法规。
- 使开发者和贡献者免受任何索赔。
📄 许可证
本项目采用Apache 2.0许可证 - 详情请参阅LICENSE文件。
Scan to join WeChat group