You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+26-2
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,47 @@
1
1
# VulnAlerts - Customized CVE Alerts straight to your Slack Channel
2
2
3
3
## How to Use?
4
-
- Fork the project.
5
4
-[Create an Incoming Webhook on Slack](https://slack.com/intl/en-in/help/articles/115005265063-Incoming-WebHooks-for-Slack)
6
5
- Goto Repository Settings -> Secrets -> Add a New Secret
7
6
- Enter ```SLACK_WEBHOOK``` in the Secret Name and your slack webhook in the value.
8
7
- 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
+
9
28
- That's it. You'll receive daily alerts on the selected slack channel.
10
29
11
30
Note: No need to enter full CPE unless you want to monitor specific version. ```apple:icloud``` or ```atlassian:sourcetree``` will do the job.
12
31
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)
14
33
15
34
## How it Works?
16
35
- GitHub Actions WorkFlow is automatically triggered based on schedule.
17
36
-[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.
18
37
- The JSON feed is processed to check if any CPEs mentioned in **cpe.txt** are present in the Feed.
19
38
- After processing is done, It'll send the message to Slack Incoming Webhook.
0 commit comments