Skip to content

Commit

Permalink
Merge pull request #338 from future-architect/update-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
kotakanbe authored Feb 14, 2017
2 parents 6e08bd2 + 492753d commit c05d8a3
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Vuls est un outil crée pour palier aux problèmes listés ci-dessus. Voici ses
# Caractéristiques principales

- Recherche de vulnérabilités sur des serveurs Linux
- Supporte Ubuntu, Debian, CentOS, Amazon Linux, RHEL
- Supporte Ubuntu, Debian, CentOS, Amazon Linux, RHEL, Raspbian
- Cloud, auto-hébergement, Docker
- Scan d'intergiciels non inclus dans le gestionnaire de paquets de l'OS
- Scan d'intergiciels, de libraries de language de programmation et framework pour des vulnérabilités
Expand Down
11 changes: 7 additions & 4 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Vulsは上に挙げた手動運用での課題を解決するツールであり
# Main Features

- Linuxサーバに存在する脆弱性をスキャン
- Ubuntu, Debian, CentOS, Amazon Linux, RHELに対応
- Ubuntu, Debian, CentOS, Amazon Linux, RHEL, Raspbianに対応
- クラウド、オンプレミス、Docker
- OSパッケージ管理対象外のミドルウェアをスキャン
- プログラミング言語のライブラリやフレームワーク、ミドルウェアの脆弱性スキャン
Expand Down Expand Up @@ -348,7 +348,7 @@ Vulsをスキャン対象サーバにデプロイする。Vulsはローカルホ
----
# Performance Considerations
- Ubuntu, Debian
- Ubuntu, Debian, Raspbian
`apt-get changelog`でアップデート対象のパッケージのチェンジログを取得し、含まれるCVE IDをパースする。
アップデート対象のパッケージが沢山ある場合、チェンジログの取得に時間がかかるので、初回のスキャンは遅い。
ただ、2回目以降はキャッシュしたchangelogを使うので速くなる。
Expand All @@ -367,6 +367,7 @@ Vulsをスキャン対象サーバにデプロイする。Vulsはローカルホ
| Amazon | 速い |
| RHEL | 速い |
| FreeBSD | 速い |
| Raspbian | 初回は遅い / 2回目以降速い |
----
Expand Down Expand Up @@ -394,6 +395,7 @@ web/app server in the same configuration under the load balancer
| CentOS | 5, 6, 7|
| Amazon Linux| All|
| FreeBSD | 10|
| Raspbian | Wheezy, Jessie |
----
Expand Down Expand Up @@ -610,9 +612,9 @@ configtest:
```
vuls ALL=(root) NOPASSWD: /usr/bin/yum
```
- Ubuntu, Debian
- Ubuntu, Debian, Raspbian
```
vuls ALL=(root) NOPASSWD: /usr/bin/apt-get, /usr/bin/apt-cache
vuls ALL=(root) NOPASSWD: /usr/bin/apt-get
```
- Amazon Linux, FreeBSDはRoot権限なしでスキャン可能
Expand All @@ -631,6 +633,7 @@ Prepareサブコマンドは、Vuls内部で利用する以下のパッケージ
| Amazon | All | - |
| RHEL | 5, 6, 7 | - |
| FreeBSD | 10 | - |
| Raspbian | Wheezy, Jessie | - |
```
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Vuls is a tool created to solve the problems listed above. It has the following
# Main Features

- Scan for any vulnerabilities in Linux/FreeBSD Server
- Supports Ubuntu, Debian, CentOS, Amazon Linux, RHEL, FreeBSD
- Supports Ubuntu, Debian, CentOS, Amazon Linux, RHEL, FreeBSD and Raspbian
- Cloud, on-premise, Docker
- Scan middleware that are not included in OS package management
- Scan middleware, programming language libraries and framework for vulnerability
Expand Down Expand Up @@ -343,7 +343,7 @@ On the aggregation server, you can refer to the scanning result of each scan tar
----
# Performance Considerations
- On Ubuntu and Debian
- On Ubuntu, Debian and Raspbian
Vuls issues `apt-get changelog` for each upgradable packages and parse the changelog.
`apt-get changelog` is slow and resource usage is heavy when there are many updatable packages on target server.
Vuls stores these changelogs to KVS([boltdb](https://github.com/boltdb/bolt)).
Expand All @@ -364,6 +364,7 @@ High speed scan and resource usage is light because Vuls can get CVE IDs by usin
| Amazon | Fast |
| RHEL | Fast |
| FreeBSD | Fast |
| Raspbian | First time: Slow / From the second time: Fast |
----
Expand Down Expand Up @@ -395,6 +396,7 @@ If there is a staging environment with the same configuration as the production
| CentOS | 5, 6, 7|
| Amazon Linux| All|
| FreeBSD | 10|
| Raspbian | Wheezy, Jessie |
----
Expand Down Expand Up @@ -609,13 +611,13 @@ configtest:
And also, configtest subcommand checks sudo settings on target servers whether Vuls is able to SUDO with nopassword via SSH.
Example of /etc/sudoers on target servers
- CentOS, RHEL
- CentOS and RHEL
```
vuls ALL=(root) NOPASSWD: /usr/bin/yum
```
- Ubuntu, Debian
- Ubuntu, Debian and Raspbian
```
vuls ALL=(root) NOPASSWD: /usr/bin/apt-get, /usr/bin/apt-cache
vuls ALL=(root) NOPASSWD: /usr/bin/apt-get
```
- It is possible to scan without root privilege for Amazon Linux, FreeBSD.
Expand All @@ -636,6 +638,7 @@ Prepare subcommand installs required packages on each server.
| Amazon | All | - |
| RHEL | 5, 6, 7 | - |
| FreeBSD | 10 | - |
| Raspbian | Wheezy, Jessie | - |
```
Expand Down

0 comments on commit c05d8a3

Please sign in to comment.