You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
404StarLink/detail/veinmind-tools.md

120 lines
5.0 KiB

## veinmind-tools <https://github.com/chaitin/veinmind-tools>
<!--auto_detail_badge_begin_0b490ffb61b26b45de3ea5d7dd8a582e-->
![Language](https://img.shields.io/badge/Language-Golang/Python-blue)
![Author](https://img.shields.io/badge/Author-长亭科技-orange)
![GitHub stars](https://img.shields.io/github/stars/chaitin/veinmind-tools.svg?style=flat&logo=github)
![Version](https://img.shields.io/badge/Version-V2.1.0-red)
![Time](https://img.shields.io/badge/Join-20220316-green)
<!--auto_detail_badge_end_fef74f2d7ea73fcc43ff78e05b1e7451-->
veinmind-tools 是由长亭科技自研,基于 <a href="https://github.com/chaitin/libveinmind">veinmind-sdk</a> 打造的容器安全工具集
veinmind, 中文名为<b>问脉</b>,寓意 <b>容器安全见筋脉,望闻问切治病害。</b> 旨在成为云原生领域的一剂良方
## 🔥 Demo
![](https://veinmind-cache.oss-cn-hangzhou.aliyuncs.com/img/index.gif)
## 🕹 快速开始
### 1. 确保机器上正确安装 docker
```
docker info
```
### 2. 安装 [veinmind-runner](https://github.com/chaitin/veinmind-tools/tree/master/veinmind-runner) 镜像
```
docker pull veinmind/veinmind-runner:latest
```
### 3. 下载 [veinmind-runner](https://github.com/chaitin/veinmind-tools/tree/master/veinmind-runner) 平行容器启动脚本
```
wget -q https://download.veinmind.tech/scripts/veinmind-runner-parallel-container-run.sh -O run.sh && chmod +x run.sh
```
### 4. 快速扫描本地镜像
```
./run.sh scan image
```
## 🔨 工具列表
| 工具 | 功能 |
|-----------------------------------------------------------|-----------------|
| [veinmind-runner](veinmind-runner/README.md) | 扫描工具运行宿主 |
| [veinmind-malicious](plugins/go/veinmind-malicious) | 扫描镜像中的恶意文件 |
| [veinmind-weakpass](plugins/go/veinmind-weakpass) | 扫描 镜像/容器 中的弱口令 |
| [veinmind-log4j2](plugins/go/veinmind-log4j2) | 扫描镜像中的log4j2漏洞 |
| [veinmind-sensitive](plugins/python/veinmind-sensitive) | 扫描镜像中的敏感信息 |
| [veinmind-backdoor](plugins/python/veinmind-backdoor) | 扫描镜像中的后门 |
| [veinmind-history](plugins/python/veinmind-history) | 扫描镜像中的异常历史命令 |
| [veinmind-vuln](plugins/go/veinmind-vuln) | 扫描镜像中的资产信息和漏洞 |
| [veinmind-webshell](plugins/go/veinmind-webshell) | 扫描镜像中的 Webshell |
| [veinmind-unsafe-mount](plugins/go/veinmind-unsafe-mount) | 扫描容器中的不安全挂载目录 |
| [veinmind-iac](plugins/go/veinmind-iac) | 扫描IaC文件 |
PS: 目前所有工具均已支持平行容器的方式运行
## 🧑💻 编写插件
可以通过 example 快速创建一个 veinmind-tools 插件, 具体查看 [veinmind-example](example/)
## ☁ 云原生设施兼容性
| 名称 | 类别 | 是否兼容 |
|-------------------------------------------------------------|-------|------|
| [Jenkins](https://github.com/chaitin/veinmind-jenkins) | CI/CD | ✔ |
| Gitlab CI | CI/CD | ✔ |
| [Github Action](https://github.com/chaitin/veinmind-action) | CI/CD | ✔ |
| DockerHub | 镜像仓库 | ✔ |
| Docker Registry | 镜像仓库 | ✔ |
| Harbor | 镜像仓库 | ✔ |
| Docker | 容器运行时 | ✔ |
| Containerd | 容器运行时 | ✔ |
## 🛴 工作原理
![](https://github.com/chaitin/veinmind-tools/raw/master/docs/architecture.png)
<!--auto_detail_active_begin_e1c6fb434b6f0baf6912c7a1934f772b-->
## 项目相关
## 最近更新
#### [v2.1.0] - 2023-03-27
**更新**
- 支持使用 openai 分析扫描结果
#### [v2.0.7] - 2023-03-24
**更新**
- 新增 veinmind-minio 插件
#### [v2.0.1] - 2023-02-15
**Feature**
- 支持 arm64 构建
**Fix**
- 修复 Makefile
- 修复 veinmind-iac 文件识别问题
- 修复 veinmind-sensitive 扫描过慢问题
#### [v2.0.0] - 2023-02-10
**Feature**
- runner cmd优化: 协议化扫描对象
- runner 支持插件参数自定义
- runner 支持扫描 tar 类型镜像
- 插件报告输出优化:支持 cli/json/htm
- script.sh => makefile
- 新增 veinmind-esclate 逃逸检测插件
- veinmind-asset 升级为 veinmind-vuln,支持漏洞扫描
- iac 支持扫描 kubernetes
#### [v1.7.0] - 2023-01-17
**Feature**
- veinmind-sensitive 使用 golang 进行开发
- 基于 remote.Image 直接扫描仓库镜像
- 新增 veinmind-vuln 插件
- 重构 veinmind-runner 命令行使用方式
<!--auto_detail_active_end_f9cf7911015e9913b7e691a7a5878527-->