mitre/heimdall

必须阅读：此软件包已被取代

此仓库已被 https://github.com/*** 替代，请相应更新所有链接。

!Docker 拉取量 !Docker 云构建状态

Heimdall

Heimdall是InSpec评估和配置文件的集中可视化服务器。

描述

Heimdall支持通过便捷的界面查看InSpec配置文件和评估结果。可通过curl自动化数据上传，并作为InSpec流水线阶段后的步骤添加。

Heimdall与Heimdall-Lite对比

MITRE Heimdall有两个版本：完整版https://github.com/mitre/heimdall/%E5%92%8Chttps://github.com/mitre/heimdall-lite/%E3%80%82%E4%B8%A4%E8%80%85%E9%92%88%E5%AF%B9%E4%B8%8D%E5%90%8C%E9%9C%80%E6%B1%82%E5%92%8C%E4%BD%BF%E7%94%A8%E5%9C%BA%E6%99%AF%E8%AE%BE%E8%AE%A1%E3%80%82

使用场景

特性

安装

Heimdall支持通过RPM包、Docker和Chef Habitat（即将推出）运行。生产环境安装建议使用这三种方法之一。最新构建发布于packackager.io、https://hub.docker.com/r/mitre/heimdall%E5%92%8CChef Habitat（即将推出）。

使用Docker运行

由于Heimdall至少需要数据库服务，因此使用Docker Compose。

设置Docker容器（全新安装）

1. 安装Docker
2. 通过git clone https://github.com/mitre/heimdall.git下载Heimdall
3. 导航到包含docker-compose.yml的基础文件夹
4. 在Heimdall源代码目录的终端窗口中运行以下命令：
   1. ./setup-docker-secrets.sh
   2. 可选： 通过编辑docker-compose.yml并将HEIMDALL_RELATIVE_URL_ROOT更改为自定义路径（例如/heimdall）来设置自定义根URL
   3. docker-compose up -d
   4. docker-compose run --rm web rake db:create db:migrate
5. 导航至http://127.0.0.1:3000

管理Docker容器

以下命令用于管理Docker容器中的数据：

• docker-compose run --rm web rake db:reset 此命令将销毁并重建数据库
• docker-compose run --rm web rake db:migrate 更新数据库
• docker-compose run --rm web rake data:migrate 更新数据库

运行Docker容器

确保至少运行过一次设置步骤！

1. 在终端窗口中运行以下命令：
   • docker-compose up -d
2. 在Web浏览器中访问127.0.0.1:3000

更新Docker容器

通过以下命令获取新版本的Docker容器：

bash
docker-compose pull
docker-compose up -d
docker-compose run web rake db:migrate
docker-compose run web rake data:migrate

此操作将获取最新版本的容器，如有更新则重新部署，然后应用任何数据库迁移（如适用）。此操作不应丢失数据。

停止容器

docker-compose down # 从启动时的源代码目录运行

使用Heimdall

入门

安装Heimdall后，需创建第一个账户。默认情况下，此账户拥有完整的admin权限，可创建其他用户并授予角色、“圈子”（组）和团队访问权限。通过选择“创建账户”并登录即可添加第一个用户。

通过CURL远程上传和流水线集成

要通过curl上传，需API密钥。API密钥位于个人资料页面，可通过点击右上角的用户名然后选择“个人资料”访问。

最基本的上传API需要三个参数：文件、电子邮件地址和API密钥：

bash
curl -F "file=@文件路径" -F "email=邮箱" -F "api_key=API密钥" http://localhost:3000/evaluation_upload_api

如为圈子所有者或成员，可通过添加圈子名称参数将评估添加到指定圈子：

bash
curl -F "file=@文件路径" -F "email=邮箱" -F "api_key=API密钥" -F "circle=圈子名称" http://localhost:3000/evaluation_upload_api

还可添加主机名、UUID、FISMA系统和环境参数（环境需为['sandbox', 'dev', 'test', 'impl', 'prod']之一）：

bash
curl -F "file=@文件路径" -F "email=邮箱" -F "api_key=API密钥" -F "hostname=主机名" -F "uuid=UUID" -F "fisma system=FISMA" -F "environment=test" http://localhost:3000/evaluation_upload_api

配置

容器配置详见docker-compose.yml：

• 从相对URL托管容器：编辑docker-compose.yml中的RAILS_RELATIVE_URL_ROOT行
• 切换到开发模式：在docker-compose.yml中设置RAILS_ENV=development

版本控制

本项目使用语义化版本控制策略。

许可和声明

© 2018-2019 The MITRE Corporation. 批准公开发布；分发不受限制。案例编号18-3678。

MITRE特此授予根据本项目包含的LICENSE.md文件中提供的许可条款允许的范围内使用、复制、分发、修改和以其他方式利用本软件的明确书面许可。

本软件是为美国根据合同编号HHSM-500-2012-00008I生产的，受《联邦采购条例》第52.227-14条“数据通用权利”的约束。除授予美国或根据该条款代表美国***行事的人员的使用外，未经The MITRE Corporation的明确书面许可，不得授权其他使用。