Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kotakanbe committed Oct 26, 2017
1 parent eb2acaf commit 5c84ebe
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 5 deletions.
14 changes: 12 additions & 2 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -676,6 +676,7 @@ $ vuls discover 172.31.4.0/24
[slack]
hookURL = "https://hooks.slack.com/services/abc123/defghijklmnopqrstuvwxyz"
#legacyToken = "xoxp-11111111111-222222222222-3333333333"
channel = "#channel-name"
#channel = "${servername}"
iconEmoji = ":ghost:"
Expand Down Expand Up @@ -740,8 +741,17 @@ host = "172.31.4.82"
notifyUsers = ["@username"]
```
- hookURL : Incoming webhook's URL (legacyTokenが設定されている場合、hookURLは無視される。)
- legacyToken : slack legacy token (https://api.slack.com/custom-integrations/legacy-tokens)
- hookURL or legacyToken
どちらか一方を指定する。
もし脆弱性が沢山有る場合はlegacyTokenの利用をおすすめする。legacyTokenはSlackのスレッド形式でポストされる。
スキャンサーバ単位で集約されるのでSlack通知が氾濫しない。
- hookURL : Incoming webhook's URL (legacyTokenが設定されている場合、hookURLは無視される。)
![Vuls-slack](img/vuls-slack-en.png)
- legacyToken : slack legacy token (https://api.slack.com/custom-integrations/legacy-tokens)
![Vuls-slack-thread](https://user-images.githubusercontent.com/8997330/31842418-02b703f2-b629-11e7-8ec3-beda5d3a397e.png)
- channel : channel name.
channelに`${servername}`を指定すると、結果レポートをサーバごとに別チャネルにすることが出来る。
以下のサンプルでは、`#server1`チャネルと`#server2`チャネルに送信される。スキャン前にチャネルを作成する必要がある。
Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,7 @@ $ vuls discover 172.31.4.0/24
[slack]
hookURL = "https://hooks.slack.com/services/abc123/defghijklmnopqrstuvwxyz"
#legacyToken = "xoxp-11111111111-222222222222-3333333333"
channel = "#channel-name"
#channel = "${servername}"
iconEmoji = ":ghost:"
Expand Down Expand Up @@ -756,13 +757,19 @@ You can customize your configuration using this template.
notifyUsers = ["@username"]
```
- hookURL : Incoming webhook's URL (hookURL is ignored when legacyToken is set.)
- legacyToken : slack legacy token (https://api.slack.com/custom-integrations/legacy-tokens)
- hookURL or legacyToken.
If there are a lot of vulnerabilities, it is better to use legacyToken since the Slack notification will be flooded.
- hookURL : Incoming webhook's URL (hookURL is ignored when legacyToken is set.)
![Vuls-slack](img/vuls-slack-en.png)
- legacyToken : slack legacy token (https://api.slack.com/custom-integrations/legacy-tokens)
![Vuls-slack-thread](https://user-images.githubusercontent.com/8997330/31842418-02b703f2-b629-11e7-8ec3-beda5d3a397e.png)
- channel : channel name.
If you set `${servername}` to channel, the report will be sent to each channel.
In the following example, the report will be sent to the `#server1` and `#server2`.
Be sure to create these channels before scanning.
**if legacyToken is set, you must set up an existing channel**
```
[slack]
channel = "${servername}"
Expand Down
1 change: 1 addition & 0 deletions commands/discover.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ func printConfigToml(ips []string) (err error) {
const tomlTemplate = `
[slack]
hookURL = "https://hooks.slack.com/services/abc123/defghijklmnopqrstuvwxyz"
#legacyToken = "xoxp-11111111111-222222222222-3333333333"
channel = "#channel-name"
#channel = "${servername}"
iconEmoji = ":ghost:"
Expand Down

0 comments on commit 5c84ebe

Please sign in to comment.