Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Notifications API #18

Closed
mackhendricks opened this issue Jan 2, 2017 · 3 comments
Closed

Add Notifications API #18

mackhendricks opened this issue Jan 2, 2017 · 3 comments
Assignees

Comments

@mackhendricks
Copy link
Contributor

The Notifications API will be used to notify a SOC User that a Threat was received with a particular Threat Level. The following components will need to be changed:

Metron Threat Intel Configs:

  • parser/enrichment/triage_configs

Please use the issue # to commit any changes. This will allow us to track the commits related to this Issue

@mackhendricks
Copy link
Contributor Author

The Notification endpoint has been added to master trunk, but it doesn't send an email ( /api/notification/email). Please download our master, find the issue and fix it.

In regards to SMS, the /api/notification/sms I don't see any parameters being parsed. We should be parsing SMS phone number and Message, which should contain a link to login to review the threat.

The above endpoints are great for having a generic way to send notifications. But, when sending this from Metron we should just be POSTing the Company, Site, Score to the /api/notification API and you should figure out who should be notified based on the users notification settings.

@mackhendricks
Copy link
Contributor Author

Here's more detail on how we should be handling alerts coming from metron using the /api/metron/alerts URL.

We just need the threat id, company id, site id and score so that we can figure out who needs to be notified. So, above class needs to be changed so that it looks up the user that should be notified and notify that user. So, I would like to see a test where we send

/api/metron/alerts this payload

{

“threat_id": "ASnFODKFNDSK-23DSJO”,
“company_id” : “Flyball-Labs”,
“site_id” : “Site 1”,
“score” : 15

}

Then we should fire off a notification to users that are attached to the company id and/or site. The notification should either be an Email or SMS based on their notification preferences.

@mackhendricks
Copy link
Contributor Author

Per our conversation, we agreed to change the payload to being the complete threat intel message. So, the /api/metron/alerts payload will just contain

{

"message":

}

devopsec added a commit to devopsec/threatdetectionservice that referenced this issue Jan 30, 2017
… entire notifications endpoint solution including email and sms capabilities and many improvements to current api, including but not limited to creation of REST utility classes and abstraction classes, decoupling of a few interfaces (company in specific) and a decorator utility class w/ async decorator method.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants