JHUAPL/icsfeedparser
1
0
Fork 0
mirror of https://github.com/JHUAPL/icsfeedparser.git synced 2026-01-07 20:03:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

Initial Upload of project

Browse Source
This commit is contained in:
Charles Frick
2022-09-13 10:06:10 -04:00
committed by GitHub
commit 60c92e638d
5 changed files with 728 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

201
LICENSE Normal file
View File

@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2022 Frick, Charles K., Jr.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

46
README.md Normal file
View File

@@ -0,0 +1,46 @@
# ICSFeedParser
## Description
This is a simple feed meant to monitor the CISA ICS alert feed RSS stream, investigate the alerts and their reference pages, and then query against a keyword list of vendors/products of interest to a particular community. The initial use case is to have this run automatically at an ISAC/ISAO in order to reduce the manual workload of monitoring the feed.
## Getting started
1. `python3 -m pip install -r requirements.txt`
2. Run `icsfeedparser.py` to generate `config.ini`, `vendors.txt`, `equipment.txt` and `notification_recipients.txt`.
3. Adjust `config.ini` based on the labels inside. See below for more details on each configuration value.
4. Add the vendors to monitor to `vendors.txt`, with one vendor on each line. Do the same with the equipment/model numbers to monitor for in `equipment.txt` and the email addresses of who to notify upon a discovered vulnerability to `notification_recipients.txt`.
5. Run `icsfeedparser.py` to receive notifications (such as a cronjob).
## Configuring ICSFeedParser
When initially running ICSFeedParser, it will create a `config.ini` with many settings that can be edited. These settings are as follows:
### Mail Settings
`use email notifications` - Whether to send out emails when a vulnerability is found. Set this to "True" if you would like to send emails, and "False" if you do not.
`mail server` - The mail server to use for sending notification emails.
`mail server port` - The port to communicate to the mail server with for sending notification emails.
`mail uses ssl encryption` - Set to "True" if the mail server uses SSL encryption. This is generally the case when the mail server port is 465.
`smtp username` - The username for logging into the mail server. Make this blank if there is no authentication needed.
`smtp password` - The password for logging into the mail server. Make this blank if there is no authentication needed.
`notification from email address` - The email address notifications should come from.
### Slack Settings
`use slack notifications` - Whether to send out a Slack message when a vulnerability is found. "True" if you would like to use Slack, "False" if you do not.
`slack webhook url` - The webhook URL for ICSFeedParser to talk to Slack with. See [this guide](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack) for how to get this URL.
### Notifier Settings
`days back to check` - The number of days backwards that should be checked when running this script to check for vulnerabilities. For example, if this is set to "3", this script will notify users for every vulnerability from the past 3 days that is applicable your vendors and/or equipment.
## License
Apache 2.0

20
email_template.html Normal file
View File

@@ -0,0 +1,20 @@
<!-- This file does NOT need to be included when distributing. It is just used to make making make_html() easier -->
<html>
<head>
<div style="text-align: center">
<h1 style="color: red">ATTENTION: The following alert references your specified vendors AND products!</h1>
<h1>{title} ({entry_id})</h1>
</div>
</head>
<body>
<div style="text-align: center">
<h3 style="font-weight: normal">Published: {date_published}</h3>
<h2 style="font-weight: normal; color: darkred">CVSS Score: {score}</h2>
<h2 style="font-weight: normal">Attention: {attention}</h2>
<h2 style="font-weight: normal">Affected Product: {equipment} from {vendor}</h2>
<h2 style="font-weight: normal">Vulnerabilities: {vulnerabilities}</h2>
<h3 style="font-weight: normal">{summary}</h3>
<a href="{link}"><h2 style="font-weight: normal">View ICS Page</h2></a>
</div>
</body>
</html>

456
icsfeedparser.py Normal file
View File

@@ -0,0 +1,456 @@
# Simple python script to parse the cisa ics alert feed
# DISCLAIMER
# The script developed by JHU/APL for the demonstration are not “turn key” and are
# not safe for deployment without being tailored to production infrastructure. These
# files are not being delivered as software and are not appropriate for direct use on any
# production networks. JHU/APL assumes no liability for the direct use of these files and
# they are provided strictly as a reference implementation.
#
# NO WARRANTY, NO LIABILITY. THIS MATERIAL IS PROVIDED “AS IS.” JHU/APL MAKES NO
# REPRESENTATION OR WARRANTY WITH RESPECT TO THE PERFORMANCE OF THE MATERIALS, INCLUDING
# THEIR SAFETY, EFFECTIVENESS, OR COMMERCIAL VIABILITY, AND DISCLAIMS ALL WARRANTIES IN
# THE MATERIAL, WHETHER EXPRESS OR IMPLIED, INCLUDING (BUT NOT LIMITED TO) ANY AND ALL
# IMPLIED WARRANTIES OF PERFORMANCE, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
# AND NON-INFRINGEMENT OF INTELLECTUAL PROPERTY OR OTHER THIRD PARTY RIGHTS. ANY USER OF
# THE MATERIAL ASSUMES THE ENTIRE RISK AND LIABILITY FOR USING THE MATERIAL. IN NO EVENT
# SHALL JHU/APL BE LIABLE TO ANY USER OF THE MATERIAL FOR ANY ACTUAL, INDIRECT,
# CONSEQUENTIAL, SPECIAL OR OTHER DAMAGES ARISING FROM THE USE OF, OR INABILITY TO USE,
# THE MATERIAL, INCLUDING, BUT NOT LIMITED TO, ANY DAMAGES FOR LOST PROFITS.
from datetime import datetime
import configparser
import os
from typing import List
import feedparser
from bs4 import BeautifulSoup
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
import smtplib
import requests
import bleach
CONFIG = None
DOUBLE_MATCH_WARNING = "ATTENTION: The following alert references your specified vendors AND products!"
# Class to store feed data
class ICSFeedData:
entry = None
entry_id = ""
date_published = None
is_old = False
has_data = False
cvss_score = ""
attention = ""
vendor = ""
equipment = ""
vulns = ""
def __init__(self, entry, max_hours_back):
# Note: Although feedparser does its own sanitizing, best we play it safe and use a known good one like
# bleach throughout here
self.entry = entry
# Bleach only prevents unsafe tags. We need to manually remove the <p> here to better display to the user.
self.entry.summary = bleach.clean(self.entry.summary.replace("<p>", "").replace("</p>", ""))
if len(self.entry.summary.split("\n")) > 3:
self.entry.summary = "" # Empty summary if it's too long (comes from a mistake in the feed)
entry.link = bleach.clean(entry.link.lower())
link = entry.link
link_split = link.split('icsa-', 1)
if len(link_split) == 2:
self.entry_id = 'icsa-' + link_split[1]
else:
link_split = link.split('icsma-', 1)
self.entry_id = 'icsma-' + link_split[1]
self.entry_id = self.entry_id.upper()
# Get the time published, and don't retrieve further if the date is too far in the past
entry.published = bleach.clean(entry.published)
self.date_published = datetime.strptime(entry.published, "%a, %d %b %Y %H:%M:%S %Z")
now = datetime.now()
diff = now - self.date_published
hours_since = diff.total_seconds() / 60 / 60
if hours_since > max_hours_back:
self.is_old = True
else:
# Retrieve main page and fetch information
entry_page = requests.get(link)
entry_soup = BeautifulSoup(entry_page.content, 'html.parser')
tags = entry_soup.find_all()
for tag in tags:
# Search on the actual page for data, since <meta> tags are inconsistent
# (see https://www.cisa.gov/uscert/ics/advisories/icsa-22-181-03 as an example of a bad meta tag)
if "1. EXECUTIVE SUMMARY" == tag.text:
info_tag = tag.next_sibling.next_element
for list_item in info_tag:
if hasattr(list_item, "text") and list_item.text != "":
text = bleach.clean(list_item.text)
if "CVSS" in text:
self.cvss_score = text.split(" ")[-1]
elif "ATTENTION: " in text:
self.attention = text[len("ATTENTION: "):]
elif "Vendor: " in text:
self.vendor = text[len("Vendor: "):]
elif "Equipment: " in text:
self.equipment = text[len("Equipment: "):]
elif "Vulnerabilities: " in text:
self.vulns = text[len("Vulnerabilities: "):]
elif "Vulnerability: " in text:
self.vulns = text[len("Vulnerability: "):]
self.has_data = self.cvss_score and self.attention and self.vendor and self.equipment and self.vulns
def data_applicable(self, equipment_list: List[str], vendors_list: List[str]) -> int:
"""Check if Vulnerability Applicable.
Checks if this vulnerability is in the list of equipment and/or vendors.
Args:
equipment_list: String list of equipment to check against
vendors_list: List of vendors to check against
Returns:
0 if this data is not in either list, 1 if this data is in only the vendor list or equipment list, and
2 if it's in both lists.
"""
score = 0
for e in equipment_list:
if e.lower() in self.equipment.lower():
score += 1
break
for v in vendors_list:
if v.lower() in self.vendor.lower():
score += 1
break
return score
def get_severity(self):
scores = self.cvss_score.split(".")
major_score = int(scores[0])
if major_score < 4:
return "Low"
elif major_score < 7:
return "Medium"
elif major_score < 9:
return "High"
return "Critical"
def __repr__(self):
out = "-" * 8 + self.entry.title + " ({})".format(self.entry_id) + "-" * 8
if self.has_data:
out += "\nPublished: " + self.entry.published + " at: " + self.entry.link
out += "\nCVSS Score: " + self.cvss_score + " ({} Severity)".format(self.get_severity())
out += "\nAttention: " + self.attention
out += "\nVendor Affected: " + self.vendor
out += "\nEquipment Affected: " + self.equipment
out += "\nVulnerabilities: " + self.vulns
if self.entry.summary:
out += "\nSummary: " + self.entry.summary
out += "\nLink to ICS Page: " + self.entry.link
elif self.is_old:
out += "\nNo Data! Did not obtain data due to this entry having been created too long ago!"
else:
out += "\nNo Data! Failed to retrieve it!"
return out
def make_slack_message(data: ICSFeedData, double_matches: bool) -> dict:
"""Make Slack Text from ICSFeedData.
Translates an ICSFeedData instance into a string formatted as a Slack message.
Args:
data: An ICSFeedData representing an ICS report.
double_matches: Whether or not to include an extra warning that this warning is very applicable.
Returns:
A dictionary representing JSON to be sent to Slack's API.
"""
blocks = []
cvss_str = ""
is_critical = data.get_severity() == "Critical"
is_high_or_critical = data.get_severity() == "High" or is_critical
if is_critical:
cvss_str += "!" * 16 + " "
if is_high_or_critical:
cvss_str += "*"
cvss_str += "CVSS Score: " + data.cvss_score + " ({} Severity)".format(data.get_severity())
if is_high_or_critical:
cvss_str += "*"
if is_critical:
cvss_str += " " + "!" * 16
double_match_str = "*" + DOUBLE_MATCH_WARNING + "*\n" if double_matches else ""
blocks.append({
"type": "section",
"text": {
"type": "mrkdwn",
"text": "*" + data.entry.title + " ({})".format(data.entry_id) + "*\n" + double_match_str
+ cvss_str
}
})
body = ""
body += "\nPublished: " + data.entry.published
body += "\nAttention: " + data.attention
body += "\nVendor Affected: " + data.vendor
body += "\nEquipment Affected: " + data.equipment
body += "\nVulnerabilities: " + data.vulns
if data.entry.summary:
body += "\nSummary: " + data.entry.summary
body += "\n<{link}|ICS Page>".format(link=data.entry.link)
blocks.append({
"type": "section",
"text": {
"type": "mrkdwn",
"text": body
}
})
return {"blocks": blocks}
def make_html(data: ICSFeedData, double_matches: bool) -> str:
"""Make HTML from ICSFeedData.
Translates an ICSFeedData instance into an alright-looking HTML document.
Args:
data: An ICSFeedData representing an ICS report.
double_matches: Whether or not to include an extra warning that this vulnerability is very applicable.
Returns:
A string of an HTML document to be sent via email.
"""
html = '<html><head><div style="text-align: center">'
if double_matches:
html += \
'<h1 style="color: red">{double_warning}</h1>'.format(double_warning=DOUBLE_MATCH_WARNING)
html += '<h1>{title} ({entry_id})</h1>'.format(title=data.entry.title, entry_id=data.entry_id)
html += '</div></head>'
html += """
<body>
<div style="text-align: center">
<h3 style="font-weight: normal">Published: {date_published}</h3>
<h2 style="font-weight: normal; color: darkred">CVSS Score: {score}</h2>
<h2 style="font-weight: normal">Attention: {attention}</h2>
<h2 style="font-weight: normal">Affected Product: {equipment} from {vendor}</h2>
<h2 style="font-weight: normal">Vulnerabilities: {vulnerabilities}</h2>
<h3 style="font-weight: normal">{summary}</h3>
<a href="{link}"><h2 style="font-weight: normal">View ICS Page</h2></a>
</div>
</body>
</html>
""".format(date_published=data.date_published, score=data.cvss_score, attention=data.attention,
equipment=data.equipment, vendor=data.vendor, vulnerabilities=data.vulns, summary=data.entry.summary,
link=data.entry.link)
return html
def notify_of_vuln(feed_data: ICSFeedData, double_matches: bool):
"""Notify of Vulnerability.
Notifies the end user(s) of a vulnerability.
Args:
feed_data: The ICSFeedData instance to report.
double_matches: Whether both the equipment and vendor matched up during checking
"""
plain_text = ""
if double_matches:
plain_text += DOUBLE_MATCH_WARNING + "\n"
plain_text += feed_data.__repr__() + "\n"
if CONFIG["use_emails"]:
try:
msgs = []
for receiver in CONFIG["receivers"]:
msg = MIMEMultipart("alternative")
msg["Subject"] = "Vulnerability Notification"
msg["From"] = CONFIG["from_address"]
msg["To"] = receiver
html = make_html(feed_data, double_matches)
msg.attach(MIMEText(plain_text, "plain"))
msg.attach(MIMEText(html, "html"))
msgs.append(msg)
if CONFIG["mail_ssl"]:
smtp = smtplib.SMTP_SSL(host=CONFIG["mail_server"], port=CONFIG["mail_server_port"])
else:
smtp = smtplib.SMTP(host=CONFIG["mail_server"], port=CONFIG["mail_server_port"])
smtp.starttls()
if CONFIG["username"] and CONFIG["password"]:
smtp.login(CONFIG["username"], CONFIG["password"])
for msg in msgs:
smtp.send_message(msg, CONFIG["from_address"], msg["To"])
smtp.quit()
except smtplib.SMTPException as e:
print("Error while sending emails!")
print(e)
if CONFIG["use_slack"]:
requests.post(CONFIG["slack_url"],
json=make_slack_message(feed_data, double_matches), verify=False)
def get_entries_for_past_hours(hours_back: int) -> List[ICSFeedData]:
"""Get Entries for Past Hours.
Gets all the entries in the ICS feed from the past hours_back hours.
Args:
hours_back: The amount of hours to look back.
Returns:
A list of ICSFeedData instances containing all the vulnerability reports from the past hours_back hours.
"""
entries = []
icsa = feedparser.parse('https://www.cisa.gov/uscert/ics/advisories/advisories.xml')
icsa_entries = icsa.entries
for entry_in in icsa_entries:
data = ICSFeedData(entry_in, hours_back)
if data.has_data or not data.is_old:
entries.append(data)
else: # Break if we created an old instance
break
return entries
def get_valid_lines(file_name: str) -> List[str]:
"""Get All Good Lines.
Gets all lines from file_name that aren't empty.
Args:
file_name: File name to retrieve lines from.
Returns:
A list of non-empty lines from file_name.
"""
with open(file_name, "r") as f:
lines_raw = f.read().strip().replace("\r", "").split("\n")
good_lines = []
for line in lines_raw:
line = line.strip()
if len(line) > 0:
good_lines.append(line)
return good_lines
def fetch_config() -> dict:
"""Fetch Config.
Fetches the config from config.ini and returns a dictionary from it for ICSFeedParser to use.
Returns:
The aforementioned dictionary.
"""
config_dict = {}
config = configparser.ConfigParser()
config.read("config.ini")
config_dict["use_emails"] = config["Mail Settings"].getboolean("use email notifications", fallback=True)
config_dict["use_slack"] = config["Slack Settings"].getboolean("use slack notifications", fallback=True)
config_dict["mail_server"] = config["Mail Settings"]["mail server"]
config_dict["mail_server_port"] = config["Mail Settings"].getint("mail server port", fallback=25)
config_dict["mail_ssl"] = config["Mail Settings"].getboolean("mail uses ssl encryption",
fallback=config_dict["mail_server_port"] == 465)
config_dict["from_address"] = config["Mail Settings"]["notification from email address"]
config_dict["username"] = config["Mail Settings"]["smtp username"]
config_dict["password"] = config["Mail Settings"]["smtp password"]
config_dict["hours_back_to_check"] = \
config["Notifier Settings"].getint("days back to check", fallback=1) * 24 + 0.1
config_dict["receivers"] = get_valid_lines("notification_recipients.txt")
config_dict["vendors"] = get_valid_lines("vendors.txt")
config_dict["equipment"] = get_valid_lines("equipment.txt")
config_dict["slack_url"] = config["Slack Settings"]["slack webhook url"]
if config_dict["use_emails"]:
for receiver in config_dict["receivers"]:
if "@example.com" in receiver:
print("You cannot send emails to users at example.com!")
exit(1)
if config_dict["use_slack"] and config_dict["slack_url"] == "https://hooks.slack.com/services/YOUR/HOOK/HERE":
print("Please set the Slack URL to something other than the example URL!")
exit(1)
return config_dict
def check_write_config() -> bool:
"""Write Config.
Writes the default config file if it doesn't already exist.
Returns:
True if the config was written, False if it was already there.
"""
to_ret = False
if not os.path.exists("config.ini"):
config = configparser.ConfigParser()
config["Mail Settings"] = {
"Use Email Notifications": "True",
"Mail Server": "mail.jhuapl.edu",
"Mail Server Port": "25",
"Mail Uses SSL Encryption": "false",
"SMTP Username": "ENTER USERNAME HERE, OR LEAVE BLANK IF AUTHENTICATION IS NOT NEEDED",
"SMTP Password": "ENTER PASSWORD HERE, OR LEAVE BLANK IF AUTHENTICATION IS NOT NEEDED",
"Notification From Email Address": "ICSFeedAlerts@alerts.jhuapl.edu"
}
config["Slack Settings"] = {
"Use Slack Notifications": "True",
"Slack Webhook URL": "https://hooks.slack.com/services/YOUR/HOOK/HERE"
}
config["Notifier Settings"] = {
"Days Back to Check": "1",
}
with open("config.ini", "w") as f:
config.write(f)
print("Wrote config file for editing.")
to_ret = True
if not os.path.exists("vendors.txt"):
with open("vendors.txt", "w") as f:
f.write("Example Vendor. Change Me!\nAnother Vendor! Change Me as well!")
print("Wrote vendors.txt file for editing.")
to_ret = True
if not os.path.exists("equipment.txt"):
with open("equipment.txt", "w") as f:
f.write("MODEL1-CHANGEME\nCHANGEMETOO")
print("Wrote equipment.txt file for editing.")
to_ret = True
if not os.path.exists("notification_recipients.txt"):
with open("notification_recipients.txt", "w") as f:
f.write("alice@example.com\nbob@example.com")
print("Wrote notification_recipients.txt file for editing.")
to_ret = True
return to_ret
def main():
"""Main Function."""
print("Fetching entries...")
entries = get_entries_for_past_hours(CONFIG["hours_back_to_check"])
print("Checking entries and notifying...")
for e in entries:
applicable = e.data_applicable(CONFIG["equipment"], CONFIG["vendors"])
if applicable:
notify_of_vuln(e, applicable == 2)
if __name__ == "__main__":
print("Loading Config...")
if check_write_config():
print("Wrote configuration files! Please edit them as needed!")
exit()
else:
CONFIG = fetch_config()
main()

5
requirements.txt Normal file
View File

@@ -0,0 +1,5 @@
feedparser
requests
bs4
requests
bleach