ElectricEye 项目使用教程

ElectricEye 项目使用教程

ElectricEye ElectricEye is a multi-cloud, multi-SaaS Python CLI tool for Asset Management, Security Posture Management & Attack Surface Monitoring supporting 100s of services and evaluations to harden your CSP & SaaS environments with controls mapped to over 20 industry, regulatory, and best practice controls frameworks 项目地址: https://gitcode.com/gh_mirrors/el/ElectricEye

1. 项目目录结构及介绍

ElectricEye 项目是一个用于多云和多重SaaS的资产管理和安全态势管理工具。以下是项目的目录结构及其简要介绍：

ElectricEye/
├── .github/                # GitHub 工作流和其他相关文件
├── cloudformation/         # CloudFormation 模板和相关文件
├── docs/                   # 项目文档
├── eeauditor/              # ElectricEye 审计器的核心代码
├── policies/               # 策略和权限设置文件
├── screenshots/            # 屏幕截图和架构图
├── .gitignore              # Git 忽略文件
├── Dockerfile              # Docker 构建文件
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目自述文件
├── requirements-dev.txt    # 开发环境依赖
├── requirements-docker.txt # Docker 容器依赖
├── requirements.txt        # 项目依赖

2. 项目的启动文件介绍

ElectricEye 项目的启动主要通过 eeauditor/controller.py 文件进行。该文件是项目的控制中心，用于运行指定的审计器、审计项以及输出结果。

启动文件的基本使用方法如下：

python3 eeauditor/controller.py [选项]

以下是可选参数的简要说明：

• -t, --target-provider: 指定要审计的云服务提供商，如 AWS、Azure、GCP 等。
• -a, --auditor-name: 指定要运行的审计器名称。
• -c, --check-name: 指定要运行的特定审计项。
• -d, --delay: 审计器之间的延时时间，用于避免速率限制。
• -o, --outputs: 指定输出结果的形式，如 CSV、PostgreSQL 等。
• -of, --output-file: 指定输出文件的名称。
• --help: 显示帮助信息。

3. 项目的配置文件介绍

ElectricEye 项目的配置主要通过 external_providers.toml 文件进行。该文件包含了多云账户、多区域、凭证和输出等具体配置信息。

配置文件的基本结构如下：

# external_providers.toml

[aws]
default_region = "us-west-2"
Credential = "default"

[aws][ Credential ]
aws_access_key_id = "your_access_key"
aws_secret_access_key = "your_secret_key"

[gcp]
default_region = "us-central1"
Credential = "default"

[gcp][ Credential ]
service_account_file = "/path/to/service-account-file.json"

# 更多配置...

在配置文件中，您可以按照需要添加或修改云服务提供商的配置信息，包括默认区域、凭证等。确保正确配置凭证，以便 ElectricEye 能够访问您的云服务资源。

ElectricEye ElectricEye is a multi-cloud, multi-SaaS Python CLI tool for Asset Management, Security Posture Management & Attack Surface Monitoring supporting 100s of services and evaluations to harden your CSP & SaaS environments with controls mapped to over 20 industry, regulatory, and best practice controls frameworks 项目地址: https://gitcode.com/gh_mirrors/el/ElectricEye