def run(self, params={}):
resource_helper = ResourceHelper(self.connection.session, self.logger)
tag_name = params.get("name")
tag_type = params.get("type")
endpoint = endpoints.Tag.tags(self.connection.console_url)
self.logger.info("Using %s ..." % endpoint)
tags = resource_helper.paged_resource_request(endpoint=endpoint)
if tag_name == '':
tag_name = None
if tag_type == '':
tag_type = None
if tag_name or tag_type:
regex = re.compile(tag_name, re.IGNORECASE)
filtered_tags = []
for t in tags:
if tag_name and tag_type:
if (regex.match(t['name'])) and (t['type'] == tag_type):
filtered_tags.append(t)
else:
if (regex.match(t['name'])) or (t['type'] == tag_type):
filtered_tags.append(t)
self.logger.info("Returning %d tags based on filters..." %
(len(filtered_tags)))
tags = filtered_tags
return {"tags": tags}
def run(self, params={}):
# Generate unique identifier for report names
identifier = uuid.uuid4()
scan_id = params.get(Input.SCAN_ID)
# Report to collect site ID and asset IDs of scan
report_payload = {
'name': f"Rapid7-ScanAssets-InsightConnect-{identifier}",
'format': 'sql-query',
'query': 'SELECT site_id, asset_id '
'FROM dim_site_scan AS dss '
'JOIN dim_asset_scan AS das ON das.scan_id = dss.scan_id',
'version': '2.3.0',
'scope': {'scan': scan_id}
}
report_contents = util.adhoc_sql_report(self.connection, self.logger, report_payload)
self.logger.info(f"Processing Assets of Scan ID {scan_id}")
# Extract site ID and asset IDs
scan_asset_ids = set()
scan_site_id = None
try:
csv_report = csv.DictReader(io.StringIO(report_contents['raw'].decode('utf-8')))
except Exception as e:
raise PluginException(cause=f"Error: Failed to process query response for assets returned for "
f"scan ID {scan_id}.",
assistance=f"Exception returned was {e}")
for row in csv_report:
scan_asset_ids.add(int(row["asset_id"]))
# Assign site ID for scan
if scan_site_id is None:
scan_site_id = row["site_id"]
# Get assets of site of scan
resource_helper = ResourceHelper(self.connection.session, self.logger)
search_criteria = {
"filters": [
{
"field": "site-id",
"operator": "in",
"values": [scan_site_id]
}
],
"match": "all"
}
self.logger.info("Performing filtered asset search with criteria %s" % search_criteria)
endpoint = endpoints.Asset.search(self.connection.console_url)
site_assets = resource_helper.paged_resource_request(endpoint=endpoint,
method='post',
payload=search_criteria)
# Filter assets to specific scan assets
filtered_assets = [asset for asset in site_assets if asset["id"] in scan_asset_ids]
return {Output.ASSETS: filtered_assets}
def run(self, params={}):
resource_helper = ResourceHelper(self.connection.session, self.logger)
site_id = params.get('id')
state = params.get('active')
params = {"active": state}
#
# If a filter was provided, first get the site name because it's not provided
# in the results from the site scans endpoint and this action should be
# consistent even when the API is not.
#
if site_id:
endpoint = endpoints.Site.sites(self.connection.console_url,
site_id)
response = resource_helper.resource_request(endpoint)
site_name = response['name']
endpoint = endpoints.Scan.site_scans(self.connection.console_url,
site_id)
else:
site_name = None
endpoint = endpoints.Scan.scans(self.connection.console_url)
response = resource_helper.paged_resource_request(endpoint=endpoint,
params=params)
# Add the name and ID if necessary
if site_id:
for r in response:
r['siteId'] = site_id
r['siteName'] = site_name
return {"scans": response}
def run(self, params={}):
resource_helper = ResourceHelper(self.connection.session, self.logger)
cve_id = params.get('cve_id')
endpoint = endpoints.Vulnerability.vulnerability_checks(
self.connection.console_url)
self.logger.info(f"Using {endpoint}...")
params = {"search": cve_id}
results = resource_helper.paged_resource_request(endpoint=endpoint,
method='get',
params=params)
# Get unique vulnerability IDs
vuln_ids = set()
for r in results:
vuln_ids.add(r['vulnerability'])
self.logger.info(
f"Received {len(vuln_ids)} vulnerability IDs from search, getting details..."
)
# Get vulnerability details
vulns = []
for v in vuln_ids:
endpoint = endpoints.Vulnerability.vulnerability(
self.connection.console_url, v)
response = resource_helper.resource_request(endpoint=endpoint)
vulns.append(response)
return {"vulnerabilities": vulns}
def run(self, params={}):
resource_helper = ResourceHelper(self.connection.session, self.logger)
search_criteria = params.get('searchCriteria')
self.logger.info("Performing filtered asset search with criteria %s" %
search_criteria)
endpoint = endpoints.Asset.search(self.connection.console_url)
response = resource_helper.paged_resource_request(
endpoint=endpoint, method='post', payload=search_criteria)
return {"assets": response}
def get_sites_within_scope(self, site_regex):
resource_helper = ResourceHelper(self.connection.session, self.logger)
endpoint = endpoints.Site.sites(self.connection.console_url)
sites = resource_helper.paged_resource_request(endpoint=endpoint)
# Filter sites by regex
regex = re.compile(site_regex, re.IGNORECASE)
site_ids = []
for s in sites:
if regex.match(s['name']):
site_ids.append(s['id'])
self.logger.info(f"Identified {len(site_ids)} sites within trigger scope based on regular expression filter")
return site_ids
def run(self, params={}):
resource_helper = ResourceHelper(self.connection.session, self.logger)
endpoint = endpoints.User.users(self.connection.console_url)
self.logger.info("Using %s ..." % endpoint)
response = resource_helper.paged_resource_request(endpoint)
# Filter response
name = params.get('name')
login = params.get('login')
if name and (name != ''):
name_regex = re.compile(name, re.IGNORECASE)
response = [r for r in response if name_regex.match(r['name'])]
if login and (login != ''):
name_regex = re.compile(login, re.IGNORECASE)
response = [r for r in response if name_regex.match(r['login'])]
self.logger.info(
f"Returning {len(response)} results based on filter...")
return {"users": response}
def run(self, params={}):
resource_helper = ResourceHelper(self.connection.session, self.logger)
name = params.get("name")
endpoint = endpoints.AssetGroup.asset_groups(self.connection.console_url)
self.logger.info("Using %s ..." % endpoint)
groups = resource_helper.paged_resource_request(endpoint=endpoint)
if name == '':
name = None
if name:
regex = re.compile(name, re.IGNORECASE)
filtered_groups = []
for g in groups:
if regex.match(g['name']):
filtered_groups.append(g)
self.logger.info("Returning %d asset groups based on filters..." % (len(filtered_groups)))
groups = filtered_groups
return {"asset_groups": groups}
def run(self, params={}):
resource_helper = ResourceHelper(self.connection.session, self.logger)
name = params.get("name")
endpoint = endpoints.Site.sites(self.connection.console_url)
self.logger.info("Using %s ..." % endpoint)
sites = resource_helper.paged_resource_request(endpoint=endpoint)
if name == '':
name = None
if name:
regex = re.compile(name, re.IGNORECASE)
filtered_sites = []
for s in sites:
if regex.match(s['name']):
filtered_sites.append(s)
self.logger.info("Returning %d sites based on filters..." % (len(filtered_sites)))
sites = filtered_sites
return {"sites": sites}