AWS 安全组可视化工具技术文档

本文档旨在帮助用户安装、使用以及详细了解 AWS 安全组可视化工具（aws-security-viz）。以下是文章的内容概览：

1. 安装指南

要安装 aws-security-viz，请运行以下命令：

$ gem install aws_security_viz

确保已安装 Graphviz。可以使用 Homebrew 在 macOS 上安装：

$ brew install graphviz

2. 项目使用说明

aws-security-viz 可以将 AWS EC2 安全组的配置可视化。以下是基本的使用方法：

使用 AWS 密钥直接生成图形

$ aws_security_viz -a your_aws_key -s your_aws_secret_key -f viz.svg --color=true

使用现有的 security_groups.json 文件生成图形

$ aws_security_viz -o data/security_groups.json -f viz.svg --color

生成网页视图

$ aws_security_viz -a your_aws_key -s your_aws_secret_key -f aws.json --renderer navigator

这会生成两个文件：aws.json 和 navigator.html。生成的图形可以在 Web 服务器上查看，例如使用以下命令启动 Ruby HTTP 服务器：

$ ruby -run -e httpd -- -p 3000

然后在浏览器中访问 http://localhost:3000/navigator.html#aws.json。

3. 项目 API 使用文档

aws-security-viz 提供了多种命令行选项，以下是一些常用的选项：

Options:
  -a, --access-key=<s>       AWS 访问密钥
  -s, --secret-key=<s>       AWS 私钥
  -e, --session-token=<s>    AWS 会话令牌
  -r, --region=<s>           AWS 查询区域（默认：us-east-1）
  -v, --vpc-id=<s>           AWS VPC ID
  -o, --source-file=<s>      包含安全组的 JSON 源文件
  -f, --filename=<s>         输出文件名（默认：aws-security-viz.png）
  -c, --config=<s>           配置文件（opts.yml）（默认：opts.yml）
  -l, --color                为节点边缘着色
  -u, --source-filter=<s>    源过滤器
  -t, --target-filter=<s>    目标过滤器
  --serve=<i>                在指定的端口上启动 HTTP 服务器
  -h, --help                 显示此消息

4. 项目安装方式

aws-security-viz 可以通过以下两种方式进行安装：

Ruby Gem 安装

如前所述，使用以下命令安装：

$ gem install aws_security_viz

Docker 容器使用

如果您不想安装依赖和 Ruby 库，可以使用 Docker 容器执行 aws-security-viz。以下是步骤：

1. 克隆此仓库，在控制台中打开。
2. 构建 Docker 容器：

$ docker build -t sec-viz .

3. 使用 aws-vault（推荐）或直接传递 AWS 凭据作为参数运行 Docker。

docker run -i -e AWS_REGION -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY -e AWS_SESSION_TOKEN -e AWS_SECURITY_TOKEN --rm -t -p 3000:3000 -v (pwd)/aws-viz:/aws-security-viz --name sec-viz sec-viz /usr/local/bundle/bin/aws_security_viz --renderer navigator --serve 3000

您可以在本地浏览器中通过 http://localhost:3000/navigator.html#aws-security-viz.png 访问。

以上就是 aws-security-viz 的技术文档，希望对您有所帮助。