MSTICPy 项目使用教程

MSTICPy 项目使用教程

msticpy Microsoft Threat Intelligence Security Tools 项目地址: https://gitcode.com/gh_mirrors/ms/msticpy

1. 项目的目录结构及介绍

MSTICPy 是一个开源的 Python 库，用于信息安全调查和分析。项目目录结构如下：

• .azurepipelines: 存储与 Azure pipelines 相关的配置文件。
• .ci_config: 持续集成配置文件。
• .devcontainer: 开发容器配置。
• .github: GitHub 仓库配置文件，包括分支保护规则、工作流等。
• .schemas: 数据模式定义文件。
• conda: Conda 环境配置文件。
• docs: 项目文档，包括示例笔记本和用户指南。
• msticpy: 包含 MSTICPy 库的源代码。
• tests: 单元测试文件。
• tools: 辅助工具脚本。
• .gitignore: Git 忽略文件列表。
• .pre-commit-config.yaml: 预提交钩子配置。
• .pylintrc: PyLint 配置文件。
• .readthedocs.yaml: ReadTheDocs 配置文件。
• CITATION.cff: 项目引用信息。
• CONTRIBUTING.md: 贡献者指南。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包时包含的文件列表。
• NOTICE.txt: 通知文件。
• README.md: 项目说明文件。
• SECURITY.md: 安全策略文件。
• azure-pipelines-1.yml 和 azure-pipelines.yml: Azure pipelines 工作流文件。

2. 项目的启动文件介绍

MSTICPy 的启动主要是通过安装库来完成的。安装 MSTICPy 的核心功能可以使用以下命令：

pip install msticpy

如果你在使用 MSTICPy 时需要与 Azure Sentinel 集成，你可以安装包含额外功能的版本：

pip install msticpy[azsentinel]

或者，如果你想安装最新的开发版本，可以使用以下命令：

pip install git+https://github.com/microsoft/msticpy

启动文件通常是 msticpy.py，它是库的主入口点。在这个文件中，你会找到库的初始化和配置加载逻辑。

3. 项目的配置文件介绍

MSTICPy 的配置文件主要包括以下几个：

• msticpyconfig.yaml: MSTICPy 的主配置文件，用于设置查询参数、数据源、API密钥等。
• pyproject.toml: 包含项目元数据和依赖关系的配置文件。
• pytest.ini: PyTest 配置文件，用于设置单元测试的参数。

配置文件 msticpyconfig.yaml 示例内容如下：

QueryProvider:
  DefaultProvider: LogAnalytics
  Providers:
    LogAnalytics:
      WorkspaceId: <your-workspace-id>
      TenantId: <your-tenant-id>
      QueryTimeout: 60
ThreatIntelligence:
  TIPrivider:
    AlienVaultOTX:
      ApiKey: <your-api-key>
    IBMXForce:
      ApiKey: <your-api-key>
    VirusTotal:
      ApiKey: <your-api-key>

在配置文件中，你需要根据实际情况替换 <your-workspace-id>、<your-tenant-id> 和 <your-api-key> 等占位符为实际的值。

请确保将这些配置文件放在合适的位置，并在使用 MSTICPy 前正确配置。

msticpy Microsoft Threat Intelligence Security Tools 项目地址: https://gitcode.com/gh_mirrors/ms/msticpy