Skip to content

Commit c9f80e9

Browse files
authored
Update README.md
1 parent 8cef44e commit c9f80e9

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

+26-2
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,47 @@
11
# VulnAlerts - Customized CVE Alerts straight to your Slack Channel
22

33
## How to Use?
4-
- Fork the project.
54
- [Create an Incoming Webhook on Slack](https://slack.com/intl/en-in/help/articles/115005265063-Incoming-WebHooks-for-Slack)
65
- Goto Repository Settings -> Secrets -> Add a New Secret
76
- Enter ```SLACK_WEBHOOK``` in the Secret Name and your slack webhook in the value.
87
- Add CPEs of the products that you want to monitor for vulnerabilities in the **cpe.txt** file. [NVD CPE Search](https://nvd.nist.gov/products/cpe/search)
8+
- Create new workflow in .github/workflows/alerts.yml
9+
```
10+
name: VulnAlerts
11+
12+
on:
13+
schedule:
14+
- cron: '15 * */1 * *'
15+
16+
jobs:
17+
alert:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@master
21+
- uses: y-mehta/vulnalerts@master
22+
env:
23+
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
24+
- name: done
25+
run: echo 'done'
26+
```
27+
928
- That's it. You'll receive daily alerts on the selected slack channel.
1029

1130
Note: No need to enter full CPE unless you want to monitor specific version. ```apple:icloud``` or ```atlassian:sourcetree``` will do the job.
1231

13-
- Action Schedule can be changed in ```.github/workflows/alert.yml``` if needed. Follow crontab format(@daily,@monthly etc. aren't supported by Github Actions)
32+
- Action Schedule can be changed in ```.github/workflows/alerts.yml``` if needed. Follow crontab format(@daily,@monthly etc. aren't supported by Github Actions)
1433

1534
## How it Works?
1635
- GitHub Actions WorkFlow is automatically triggered based on schedule.
1736
- [CVE-Recent JSON Vulnerability Feed](https://nvd.nist.gov/feeds/json/cve/1.1/nvdcve-1.1-recent.json.gz) is fetched from the NVD.
1837
- The JSON feed is processed to check if any CPEs mentioned in **cpe.txt** are present in the Feed.
1938
- After processing is done, It'll send the message to Slack Incoming Webhook.
2039

40+
## Sample Alert:
41+
42+
![image](https://user-images.githubusercontent.com/24428063/72280765-19bf9380-365f-11ea-84d3-395a78343f3e.png)
43+
44+
2145
## Security Warning
2246
- Don't hardcode your Slack Incoming Webhook URL into the python file.
2347

0 commit comments

Comments
 (0)