(Update Other: README) readme and .github

更新了README和贡献说明
This commit is contained in:
Medicean 2016-12-24 14:21:47 +08:00
parent f5b76ecacb
commit 07bcbdc98c
3 changed files with 25 additions and 32 deletions

View File

@ -27,7 +27,7 @@ CONTRIBUTING to VulApps
> 一律采取小写
>
> 唯一编号推荐使用 uuid4 `$ python -c "print __import__('uuid').uuid4()"`
> 唯一编号使用阿拉伯数字
```
.
@ -43,13 +43,13 @@ CONTRIBUTING to VulApps
│   ├── README.md
│   └── bash
│   ├── README.md
│   ├── 7d116603-c066-4821-8a5f-5dc0d39d71c7
│   └── 1d7b5557-e074-4114-ace5-50c110032cb5
│   ├── 1
│   └── 2
└── s
├── README.md
└── struts2
├── README.md
└── 3f9af03f-3800-4f4e-807f-19c05f94e9d1
└── 1
```
### <a name="files"></a>漏洞环境文件说明
@ -60,11 +60,13 @@ CONTRIBUTING to VulApps
├── poc.py 检测插件
├── exp.py 漏洞利用程序
├── Dockerfile
└── src 构建所需要的配置文件(超过 10MB 的请使用外链推荐7牛)
└── src 构建所需要的配置文件(**超过 10MB 的请使用外链**推荐7牛)
├── ...
└── ...
```
**源码包强烈建议使用外链,通过 wget 方式下载到容器中Github 单仓库限制1GB**
### <a name="commit"></a>Commit 规范
Commit 分为标题和主体两部分,标题要求必须要简洁明了。对标题的详细补充在主体中体现,如果标题已经充分表达出提交者的意思,主体可省略。

View File

@ -1,19 +1,22 @@
<!--
首先非常感谢您能参与到 VulApps 这个开源项目当中来。
首先非常感谢您能参与到 VulApps 这个开源项目当中来,为你无私奉献的开源精神点赞
在提 PR 之前,需要你先确认一下下列基础信息
但是在提 PR 之前,我需要你先确认一下下面的基础信息
如果你选中了某一项,可以把该行前面的 `[ ]` 改成 `[x]`
-->
- [ ] 每个 Commit 都符合 CONTRIBUTING 中提到的规范(https://github.com/Medicean/VulApps/blob/master/.github/CONTRIBUTING.md#commit)
- [ ] PR 中提到的所有环境都在测试构建成功
- [ ] 每个目录中的 README 的索引我也同步更新了
- [ ] 所涉及到的每个目录中的 README 的索引我也同步更新了
---
**本 PR 都主要是属于哪一类的呢?**
<!--
请删除不符合的选项,并勾选符合的选项
-->
- [ ] 修复已有环境 Bug
- [ ] 新增环境

View File

@ -1,6 +1,6 @@
# VulApps
收集各种漏洞环境,为方便使用,统一采用 Dockerfile 形式。
收集各种漏洞环境,为方便使用,统一采用 Dockerfile 形式。同时也收集了安全工具环境。
> 喜欢请点 Star如果不打算贡献千万别 Fork
@ -10,9 +10,13 @@
## 获取并使用相关镜像
> 直接使用 docker 命令拉取相关镜像,并启动。需要查看相关环境的 tag 可以直接在 dockerhub 查看或在具体的漏洞目录下查看 README 文件。
> 直接使用 docker 命令拉取相关镜像,并启动。
以 Struts2 S2-037 漏洞环境为例:
**需要查看相关环境的 tag 在Github具体的漏洞目录下查看 README 文件**
### 以 Struts2 S2-037 漏洞环境为例:
通过 S2-037漏洞环境的 [README文件](./s/struts2/s2-037/README.md) 得知 tag 为 `s_struts2_s2-037`
1. 获取镜像:
@ -28,27 +32,7 @@ docker pull medicean/vulapps:s_struts2_s2-037
docker run -d -p 80:8080 medicean/vulapps:s_struts2_s2-037
```
> 说明:
>
> -d 表示守护形式后台一直运行该容器
>
> -p 80:8080 Dockerfile 中暴露了容器的 8080 端口,将其映射到本机的 80 端口
>
> 其它选项请根据自己实际情况运行。
## 镜像 Tag 及路径命名规则
1. 路径
`/组件首字母/组件名/具体漏洞名`
2. Tag
**路径名全小写,路径分割符一率替换为下划线**
**例如:**
Struts2 S2-037 漏洞环境,路径为 [/s/struts2/s2-037](./s/struts2/s2-037) , 所以 Tag 为:`s_struts2_s2-037`
访问 `http://127.0.0.1/` 即可访问启动好的 s2-037 环境,快拿出 exp 工具尝试一下吧。
## 组件首字母
@ -63,6 +47,10 @@ docker run -d -p 80:8080 medicean/vulapps:s_struts2_s2-037
* [W](#w)
* [Z](#z)
## 安全工具环境
* [巡风](./toos/xunfeng/)
## 漏洞环境
### [B](./b/)<div id="b"></div>