PurpleCloud 项目使用教程

PurpleCloud 项目使用教程

PurpleCloud A little tool to play with Azure Identity - Azure Active Directory lab creation tool 项目地址: https://gitcode.com/gh_mirrors/pu/PurpleCloud

1. 项目目录结构及介绍

PurpleCloud 项目的目录结构如下：

PurpleCloud/
├── attack_scripts/
├── docs/
├── generators/
├── images/
├── shared/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── mkdocs.yml

目录结构介绍

• attack_scripts/: 包含与攻击相关的脚本。
• docs/: 包含项目的文档文件。
• generators/: 包含用于生成 Terraform 配置的 Python 脚本。
• images/: 包含项目使用的图片文件。
• shared/: 包含共享的资源文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的许可证文件。
• README.md: 项目的介绍和使用说明。
• mkdocs.yml: MkDocs 配置文件，用于生成项目文档。

2. 项目启动文件介绍

PurpleCloud 项目的启动文件主要是 generators/ 目录下的 Python 脚本。这些脚本用于生成 Terraform 配置文件，从而启动 Azure 安全实验室。

主要启动文件

• generators/sentinel.py: 用于生成 Azure Sentinel 安全实验室的 Terraform 配置。
• generators/ad.py: 用于生成 Active Directory 实验室的 Terraform 配置。
• generators/managed_identity.py: 用于生成 Azure Managed Identity 实验室的 Terraform 配置。

启动步骤

1. 运行 generators/sentinel.py 脚本生成 Azure Sentinel 实验室的 Terraform 配置。
2. 使用 Terraform 工具初始化和应用生成的配置文件，启动实验室环境。

3. 项目配置文件介绍

PurpleCloud 项目的配置文件主要包括 mkdocs.yml 和 README.md。

mkdocs.yml

mkdocs.yml 是 MkDocs 的配置文件，用于生成项目的文档网站。该文件定义了文档的结构、主题和其他相关配置。

README.md

README.md 是项目的介绍和使用说明文件。它包含了项目的概述、安装步骤、使用方法和常见问题解答等内容。

配置文件示例

# mkdocs.yml 示例
site_name: PurpleCloud Documentation
nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - Generators:
    - Azure Sentinel: generators/sentinel.md
    - Active Directory: generators/ad.md
    - Managed Identity: generators/managed_identity.md
theme: readthedocs

# README.md 示例

## PurpleCloud 项目介绍

PurpleCloud 是一个用于创建 Azure 安全实验室的工具。它通过生成 Terraform 配置文件来快速搭建 Azure 安全环境。

### 主要功能

- 生成 Azure Sentinel 安全实验室
- 生成 Active Directory 实验室
- 生成 Azure Managed Identity 实验室

### 安装步骤

1. 克隆项目仓库
2. 安装依赖
3. 运行生成器脚本

### 使用方法

1. 运行 `generators/sentinel.py` 生成 Terraform 配置
2. 使用 Terraform 工具启动实验室环境

通过以上步骤，您可以快速了解 PurpleCloud 项目的目录结构、启动文件和配置文件，并开始使用该项目创建 Azure 安全实验室。

PurpleCloud A little tool to play with Azure Identity - Azure Active Directory lab creation tool 项目地址: https://gitcode.com/gh_mirrors/pu/PurpleCloud