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

Normalize Risks and stop using Priority while creating tickets #43

Open
wants to merge 10 commits into
base: dev
Choose a base branch
from
Open
4 changes: 3 additions & 1 deletion deployment/configs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
"enabled": false,
"server": "https://issues.example.com",
"issue_type": "Task",
"text_field_character_limit": 32767
"text_field_character_limit": 32767,
"risk_field_id": "",
"risk_field_param": "",
},
"slack": {
"enabled": true,
Expand Down
8 changes: 8 additions & 0 deletions hammer/library/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,14 @@ def enabled(self):
def text_field_character_limit(self):
return self._config.get("text_field_character_limit", 0)

@property
def risk_field_id(self):
return self._config.get("risk_field_id", "")

@property
def risk_field_param(self):
return self._config.get("risk_field_param", "")

def __getattr__(self, key):
""" Search for any attribute in config, if not found - raise exception """
if key in self._config:
Expand Down
28 changes: 20 additions & 8 deletions hammer/library/jiraoperations.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,23 @@
import logging
import urllib3


from collections import namedtuple
from jira import JIRA
from jira import JIRAError
from library.utility import empty_converter


NewIssue = namedtuple('NewIssue', [
'ticket_id',
'ticket_assignee_id'
])
])

risk_priority_mapping = {
"Critical": "Blocker",
"High": "Critical",
"Medium": "Major",
"Low": "Minor",
"Information": "Trivial"
}


class JiraReporting(object):
Expand All @@ -23,7 +29,7 @@ def __init__(self, config):

def add_issue(self,
issue_summary, issue_description,
priority, labels,
risk, labels,
account_id,
owner=None,
bu=None, product=None,
Expand All @@ -42,9 +48,15 @@ def add_issue(self,
"summary": issue_summary,
"description": issue_description,
"issuetype": {"name": self.config.jira.issue_type},
"priority": {"name": priority},
"labels": labels
"labels": labels,
"priority": {"name": risk_priority_mapping[risk]},
}

if self.config.jira.risk_field_id:
issue_data[self.config.jira.risk_field_id] = {
self.config.jira.risk_field_param: risk
}

ticket_id = self.jira.create_ticket(issue_data)

parent_ticket_id = self.config.owners.ticket_parent(
Expand Down Expand Up @@ -330,8 +342,8 @@ def add_comment(self, ticket_id, comment):
def add_watcher(self, ticket_id, user):
"""
Adding jira ticket watcher.
:param ticket_id: jira ticket id

:param ticket_id: jira ticket id
:param user: watcher user id
:return: nothing
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,10 @@ def create_tickets_ebs_public_snapshots(self):
issue_summary = (f"EBS public snapshot '{snapshot_id}' "
f"in '{account_name} / {account_id}' account{' [' + bu + ']' if bu else ''}")

issue_risk = "High"
issue_description = (
f"The EBS volume snapshot is marked as public.\n\n"
f"*Risk*: High\n\n"
f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*AccountID*: {account_id}\n"
f"*Region*: {region}\n"
Expand All @@ -120,7 +121,7 @@ def create_tickets_ebs_public_snapshots(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority="Major", labels=["public_snapshots"],
risk=issue_risk, labels=["public_snapshots"],
owner=owner,
account_id=account_id,
bu=bu, product=product,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,10 @@ def create_jira_ticket(self):

create_date = dateutil.parser.parse(issue.issue_details.create_date).replace(tzinfo=None).isoformat(' ', 'minutes')
last_used = dateutil.parser.parse(issue.issue_details.last_used).replace(tzinfo=None).isoformat(' ', 'minutes')
issue_risk = "Low"
issue_description = (
f"IAM access key has not been used for {self.config.iamUserInactiveKeys.inactive_criteria_days.days} days.\n\n"
f"*Risk*: Low\n\n"
f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*Account ID*: {account_id}\n"
f"*User Name*: {username}\n"
Expand All @@ -94,7 +95,7 @@ def create_jira_ticket(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority="Major", labels=["inactive-iam-keys"],
risk=issue_risk, labels=["inactive-iam-keys"],
account_id=account_id,
)
except Exception:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,10 @@ def create_jira_ticket(self):
f"in '{account_name} / {account_id}' account")

create_date = dateutil.parser.parse(issue.issue_details.create_date).replace(tzinfo=None).isoformat(' ', 'minutes')
issue_risk = "Low"
issue_description = (
f"IAM access key has not been rotated for {self.config.iamUserKeysRotation.rotation_criteria_days.days} days.\n\n"
f"*Risk*: Low\n\n"
f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*Account ID*: {account_id}\n"
f"*User Name*: {username}\n"
Expand All @@ -92,7 +93,7 @@ def create_jira_ticket(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority="Major", labels=["iam-key-rotation"],
risk=issue_risk, labels=["iam-key-rotation"],
account_id=account_id,
)
except Exception:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,13 @@ def create_tickets_public_ami(self):
issue_summary = (f"AMI '{ami_id}' with public access "
f"in '{account_name} / {account_id}' account{' [' + bu + ']' if bu else ''}")

issue_risk = "High"

issue_description = (
f"AMI allows public access.\n\n"
f"*Threat*: "
f" .\n\n"
f"*Risk*: High\n\n"
f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*Account ID*: {account_id}\n"
f"*Region*: {ami_region}\n"
Expand All @@ -120,7 +122,7 @@ def create_tickets_public_ami(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority="Major", labels=["public-ami"],
risk=issue_risk, labels=["public-ami"],
owner=owner,
account_id=account_id,
bu=bu, product=product,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,11 @@ def create_tickets_rds_public_snapshots(self):
issue_summary = (f"RDS public snapshot '{snapshot_id}'"
f"in '{account_name} / {account_id}' account{' [' + bu + ']' if bu else ''}")

issue_risk = "High"

issue_description = (
f"The RDS snapshot is marked as public.\n\n"
f"*Risk*: High\n\n"
f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*Account ID*: {account_id}\n"
f"*Region*: {region}\n"
Expand All @@ -117,7 +119,7 @@ def create_tickets_rds_public_snapshots(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority="Major", labels=["rds-public-snapshots"],
risk=issue_risk, labels=["rds-public-snapshots"],
owner=owner,
account_id=account_id,
bu=bu, product=product,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,16 @@ def create_tickets_rds_unencrypted_instances(self):
issue_summary = (f"RDS unencrypted instance '{instance_name}'"
f"in '{account_name} / {account_id}' account{' [' + bu + ']' if bu else ''}")

issue_risk = "High"

issue_description = (
f"The RDS instance is unencrypted.\n\n"
f"*Threat*: "
f"Based on data protection policies, data that is classified as sensitive information or "
f"intellectual property of the organization needs to be encrypted. Additionally, as part of the "
f"initiative of Encryption Everywhere, it is necessary to encrypt the data in order to ensure the "
f"confidentiality and integrity of the data.\n\n"
f"*Risk*: High\n\n"
f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*Account ID*: {account_id}\n"
f"*Region*: {region}\n"
Expand All @@ -114,7 +116,7 @@ def create_tickets_rds_unencrypted_instances(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority="Major", labels=["rds-unencrypted-instances"],
risk=issue_risk, labels=["rds-unencrypted-instances"],
owner=owner,
account_id=account_id,
bu=bu, product=product,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,16 @@ def create_tickets_s3_unencrypted_buckets(self):
issue_summary = (f"S3 bucket '{bucket_name}' unencrypted "
f"in '{account_name} / {account_id}' account{' [' + bu + ']' if bu else ''}")

issue_risk = "High"

issue_description = (
f"Bucket is unencrypted.\n\n"
f"*Threat*: "
f"Based on data protection policies, data that is classified as sensitive information or "
f"intellectual property of the organization needs to be encrypted. Additionally, as part of the "
f"initiative of Encryption Everywhere, it is necessary to encrypt the data in order to ensure the "
f"confidentiality and integrity of the data.\n\n"
f"*Risk*: High\n\n"
f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*Account ID*: {account_id}\n"
f"*S3 Bucket name*: {bucket_name}\n"
Expand All @@ -127,7 +129,7 @@ def create_tickets_s3_unencrypted_buckets(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority="Major", labels=["s3-unencrypted"],
risk=issue_risk, labels=["s3-unencrypted"],
owner=owner,
account_id=account_id,
bu=bu, product=product,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,13 @@ def create_tickets_s3buckets(self):
issue_summary = (f"S3 bucket '{bucket_name}' with public acl "
f"in '{account_name} / {account_id}' account{' [' + bu + ']' if bu else ''}")

issue_risk = "High"

issue_description = (
f"Bucket ACL allows unrestricted public access.\n\n"
f"*Threat*: "
f"This creates potential security vulnerabilities by allowing anyone to add, modify, or remove items in a bucket.\n\n"
f"*Risk*: High\n\n"
f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*Account ID*: {account_id}\n"
f"*S3 Bucket name*: {bucket_name}\n"
Expand Down Expand Up @@ -139,7 +141,7 @@ def create_tickets_s3buckets(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority="Major", labels=["publics3"],
risk=issue_risk, labels=["publics3"],
owner=owner,
account_id=account_id,
bu=bu, product=product,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,13 @@ def create_tickets_s3buckets(self):
issue_summary = (f"S3 bucket '{bucket_name}' with public policy "
f"in '{account_name} / {account_id}' account{' [' + bu + ']' if bu else ''}")

issue_risk = "High"

issue_description = (
f"Bucket policy allows unrestricted public access.\n\n"
f"*Threat*: "
f"This creates potential security vulnerabilities by allowing anyone to add, modify, or remove items in a bucket.\n\n"
f"*Risk*: High\n\n"
f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*Account ID*: {account_id}\n"
f"*S3 Bucket name*: {bucket_name}\n"
Expand All @@ -142,7 +144,7 @@ def create_tickets_s3buckets(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority="Major", labels=["publics3"],
risk=issue_risk, labels=["publics3"],
owner=owner,
account_id=account_id,
bu=bu, product=product,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,9 @@ def create_tickets_securitygroups(self):

open_port_details = self.build_open_ports_table_jira(issue.issue_details.perms)

account_details = (f"*Risk*: High\n\n"
issue_risk = "High"

account_details = (f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*Account ID*: {account_id}\n"
f"*SG Name*: {group_name}\n"
Expand Down Expand Up @@ -360,7 +362,6 @@ def create_tickets_securitygroups(self):
source_description = "allows access from some definite public ip addresses or networks"

if sg_public:
priority = "Critical"
summary_status = "Internet"
issue_description = (f"Security group has EC2 instances in public subnets "
f"with public IP address attached and "
Expand All @@ -379,7 +380,6 @@ def create_tickets_securitygroups(self):
f"critical services.\n"
)
elif sg_blind_public:
priority = "Critical"
summary_status = "Internet"
issue_description = (f"Security group has EC2 instances in private subnets "
f"with public IP address attached and "
Expand All @@ -393,7 +393,6 @@ def create_tickets_securitygroups(self):
f"instances when someone is probing the public IP of the instances. "
f"However, there will be no return traffic due to the lack of an IGW.\n")
elif not sg_in_use:
priority = "Minor"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue_risk should be Low here.

summary_status = "Unused"
issue_description = (f"Security group has no EC2 instances attached and "
f"{source_description} "
Expand All @@ -404,7 +403,6 @@ def create_tickets_securitygroups(self):
f"opportunities for malicious activity (hacking, denial-of-service attacks, "
f"loss of data).\n")
else:
priority = "Major"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue_risk = Medium

summary_status = "Intranet"
issue_description = (
f"Security group has EC2 instances in in private subnets and "
Expand Down Expand Up @@ -455,7 +453,7 @@ def create_tickets_securitygroups(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority=priority, labels=["insecure-services"],
risk=issue_risk, labels=["insecure-services"],
owner=owner,
account_id=account_id,
bu=bu, product=product,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,13 @@ def create_tickets_sqs_policy(self):
f"in '{account_name} / {account_id}' account, '{queue_region}' region"
f"{' [' + bu + ']' if bu else ''}")

issue_risk = "High"

issue_description = (
f"Queue policy allows unrestricted public access.\n\n"
f"*Threat*: "
f"This creates potential security vulnerabilities by allowing anyone to add, modify, or remove items in a SQS.\n\n"
f"*Risk*: High\n\n"
f"*Risk*: {issue_risk}\n\n"
f"*Account Name*: {account_name}\n"
f"*Account ID*: {account_id}\n"
f"*SQS queue url*: {queue_url}\n"
Expand Down Expand Up @@ -146,7 +148,7 @@ def create_tickets_sqs_policy(self):
try:
response = jira.add_issue(
issue_summary=issue_summary, issue_description=issue_description,
priority="Major", labels=["publicsqs"],
risk=issue_risk, labels=["publicsqs"],
owner=owner,
account_id=account_id,
bu=bu, product=product,
Expand Down