feat(rds): Add RDS certificate expiration check (#4002)

Co-authored-by: Sergio <sergio@prowler.com>
This commit is contained in:
madereddy
2024-05-20 10:41:38 -04:00
committed by GitHub
parent 73b3484ce8
commit 12f9f8a044
6 changed files with 859 additions and 0 deletions
@@ -0,0 +1,659 @@
from datetime import datetime
from unittest import mock
import botocore
from dateutil import relativedelta
from moto import mock_aws
from pytz import utc
from prowler.providers.aws.services.rds.rds_service import DBInstance
AWS_ACCOUNT_NUMBER_CON = "123456789012"
AWS_REGION = "us-east-1"
make_api_call = botocore.client.BaseClient._make_api_call
def mock_make_api_call(self, operation_name, kwarg):
if operation_name == "DescribeDBEngineVersions":
return {
"DBEngineVersions": [
{
"Engine": "mysql",
"EngineVersion": "8.0.32",
"DBEngineDescription": "description",
"DBEngineVersionDescription": "description",
},
]
}
return make_api_call(self, operation_name, kwarg)
@mock.patch("botocore.client.BaseClient._make_api_call", new=mock_make_api_call)
class Test_rds_instance_certificate_expiration:
@mock_aws
def test_rds_no_instances(self):
rds_client = mock.MagicMock
rds_client.db_instances = []
with mock.patch(
"prowler.providers.aws.services.rds.rds_service.RDS",
new=rds_client,
), mock.patch(
"prowler.providers.aws.services.rds.rds_client.rds_client",
new=rds_client,
):
# Test Check
from prowler.providers.aws.services.rds.rds_instance_certificate_expiration.rds_instance_certificate_expiration import (
rds_instance_certificate_expiration,
)
check = rds_instance_certificate_expiration()
result = check.execute()
assert len(result) == 0
@mock_aws
def test_rds_certificate_expired(self):
valid_from = datetime.now(utc) - relativedelta.relativedelta(months=7)
valid_till = datetime.now(utc) - relativedelta.relativedelta(months=7)
customer_override_valid = datetime.now(utc) - relativedelta.relativedelta(
months=7
)
rds_client = mock.MagicMock
rds_client.db_instances = []
rds_client.db_instances = [
DBInstance(
id="db-master-1",
arn=f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1",
engine="aurora-postgresql",
engine_version="aurora14",
status="available",
public=False,
encrypted=True,
deletion_protection=True,
auto_minor_version_upgrade=False,
multi_az=True,
region=AWS_REGION,
ca_cert="rds-ca-rsa2048-g1",
cert=[
{
"CertificateIdentifier": "rds-ca-rsa2048-g1",
"CertificateType": "CA",
"ValidFrom": f"{valid_from}",
"ValidTill": f"{valid_till}",
"CustomerOverride": False,
"CustomerOverrideValidTill": f"{customer_override_valid}",
}
],
)
]
with mock.patch(
"prowler.providers.aws.services.rds.rds_service.RDS",
new=rds_client,
), mock.patch(
"prowler.providers.aws.services.rds.rds_client.rds_client",
new=rds_client,
):
# Test Check
from prowler.providers.aws.services.rds.rds_instance_certificate_expiration.rds_instance_certificate_expiration import (
rds_instance_certificate_expiration,
)
check = rds_instance_certificate_expiration()
result = check.execute()
assert len(result) == 1
assert result[0].status == "FAIL"
assert result[0].check_metadata.Severity == "critical"
assert (
result[0].status_extended
== "RDS Instance db-master-1 certificate has expired."
)
assert result[0].resource_id == "db-master-1"
assert result[0].region == AWS_REGION
assert (
result[0].resource_arn
== f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1"
)
assert result[0].resource_tags == []
@mock_aws
def test_rds_certificate_not_expired(self):
valid_from = datetime.now(utc) - relativedelta.relativedelta(months=7)
valid_till = datetime.now(utc) + relativedelta.relativedelta(months=7)
customer_override_valid = datetime.now(utc) + relativedelta.relativedelta(
months=7
)
rds_client = mock.MagicMock
rds_client.db_instances = []
rds_client.db_instances = [
DBInstance(
id="db-master-1",
arn=f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1",
engine="aurora-postgresql",
engine_version="aurora14",
status="available",
public=False,
encrypted=True,
deletion_protection=True,
auto_minor_version_upgrade=False,
multi_az=True,
region=AWS_REGION,
ca_cert="rds-ca-rsa2048-g1",
cert=[
{
"CertificateIdentifier": "rds-ca-rsa2048-g1",
"CertificateType": "CA",
"ValidFrom": f"{valid_from}",
"ValidTill": f"{valid_till}",
"CustomerOverride": False,
"CustomerOverrideValidTill": f"{customer_override_valid}",
}
],
)
]
with mock.patch(
"prowler.providers.aws.services.rds.rds_service.RDS",
new=rds_client,
), mock.patch(
"prowler.providers.aws.services.rds.rds_client.rds_client",
new=rds_client,
):
# Test Check
from prowler.providers.aws.services.rds.rds_instance_certificate_expiration.rds_instance_certificate_expiration import (
rds_instance_certificate_expiration,
)
check = rds_instance_certificate_expiration()
result = check.execute()
assert len(result) == 1
assert result[0].status == "PASS"
assert result[0].check_metadata.Severity == "informational"
assert (
result[0].status_extended
== "RDS Instance db-master-1 certificate has over 6 months of validity left."
)
assert result[0].resource_id == "db-master-1"
assert result[0].region == AWS_REGION
assert (
result[0].resource_arn
== f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1"
)
assert result[0].resource_tags == []
@mock_aws
def test_rds_certificate_between_three_and_six_months(self):
valid_from = datetime.now(utc) - relativedelta.relativedelta(months=7)
valid_till = datetime.now(utc) + relativedelta.relativedelta(months=4)
customer_override_valid = datetime.now(utc) + relativedelta.relativedelta(
months=4
)
rds_client = mock.MagicMock
rds_client.db_instances = []
rds_client.db_instances = [
DBInstance(
id="db-master-1",
arn=f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1",
engine="aurora-postgresql",
engine_version="aurora14",
status="available",
public=False,
encrypted=True,
deletion_protection=True,
auto_minor_version_upgrade=False,
multi_az=True,
region=AWS_REGION,
ca_cert="rds-ca-rsa2048-g1",
cert=[
{
"CertificateIdentifier": "rds-ca-rsa2048-g1",
"CertificateType": "CA",
"ValidFrom": f"{valid_from}",
"ValidTill": f"{valid_till}",
"CustomerOverride": False,
"CustomerOverrideValidTill": f"{customer_override_valid}",
}
],
)
]
with mock.patch(
"prowler.providers.aws.services.rds.rds_service.RDS",
new=rds_client,
), mock.patch(
"prowler.providers.aws.services.rds.rds_client.rds_client",
new=rds_client,
):
# Test Check
from prowler.providers.aws.services.rds.rds_instance_certificate_expiration.rds_instance_certificate_expiration import (
rds_instance_certificate_expiration,
)
check = rds_instance_certificate_expiration()
result = check.execute()
assert len(result) == 1
assert result[0].status == "PASS"
assert result[0].check_metadata.Severity == "low"
assert (
result[0].status_extended
== "RDS Instance db-master-1 certificate has between 3 and 6 months of validity."
)
assert result[0].resource_id == "db-master-1"
assert result[0].region == AWS_REGION
assert (
result[0].resource_arn
== f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1"
)
assert result[0].resource_tags == []
@mock_aws
def test_rds_certificate_less_than_three_months(self):
valid_from = datetime.now(utc) - relativedelta.relativedelta(months=7)
valid_till = datetime.now(utc) + relativedelta.relativedelta(months=3)
customer_override_valid = datetime.now(utc) + relativedelta.relativedelta(
months=3
)
rds_client = mock.MagicMock
rds_client.db_instances = []
rds_client.db_instances = [
DBInstance(
id="db-master-1",
arn=f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1",
engine="aurora-postgresql",
engine_version="aurora14",
status="available",
public=False,
encrypted=True,
deletion_protection=True,
auto_minor_version_upgrade=False,
multi_az=True,
region=AWS_REGION,
ca_cert="rds-ca-rsa2048-g1",
cert=[
{
"CertificateIdentifier": "rds-ca-rsa2048-g1",
"CertificateType": "CA",
"ValidFrom": f"{valid_from}",
"ValidTill": f"{valid_till}",
"CustomerOverride": False,
"CustomerOverrideValidTill": f"{customer_override_valid}",
}
],
)
]
with mock.patch(
"prowler.providers.aws.services.rds.rds_service.RDS",
new=rds_client,
), mock.patch(
"prowler.providers.aws.services.rds.rds_client.rds_client",
new=rds_client,
):
# Test Check
from prowler.providers.aws.services.rds.rds_instance_certificate_expiration.rds_instance_certificate_expiration import (
rds_instance_certificate_expiration,
)
check = rds_instance_certificate_expiration()
result = check.execute()
assert len(result) == 1
assert result[0].status == "FAIL"
assert result[0].check_metadata.Severity == "medium"
assert (
result[0].status_extended
== "RDS Instance db-master-1 certificate less than 3 months of validity."
)
assert result[0].resource_id == "db-master-1"
assert result[0].region == AWS_REGION
assert (
result[0].resource_arn
== f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1"
)
assert result[0].resource_tags == []
@mock_aws
def test_custom_rds_certificate_over_six_months(self):
valid_from = datetime.now(utc) - relativedelta.relativedelta(months=7)
valid_till = datetime.now(utc) + relativedelta.relativedelta(months=7)
customer_override_valid = datetime.now(utc) + relativedelta.relativedelta(
months=7
)
rds_client = mock.MagicMock
rds_client.db_instances = []
rds_client.db_instances = [
DBInstance(
id="db-master-1",
arn=f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1",
engine="aurora-postgresql",
engine_version="aurora14",
status="available",
public=False,
encrypted=True,
deletion_protection=True,
auto_minor_version_upgrade=False,
multi_az=True,
region=AWS_REGION,
ca_cert="rds-ca-rsa2048-g1",
cert=[
{
"CertificateIdentifier": "rds-ca-rsa2048-g1",
"CertificateType": "CA",
"ValidFrom": f"{valid_from}",
"ValidTill": f"{valid_till}",
"CustomerOverride": True,
"CustomerOverrideValidTill": f"{customer_override_valid}",
}
],
)
]
with mock.patch(
"prowler.providers.aws.services.rds.rds_service.RDS",
new=rds_client,
), mock.patch(
"prowler.providers.aws.services.rds.rds_client.rds_client",
new=rds_client,
):
# Test Check
from prowler.providers.aws.services.rds.rds_instance_certificate_expiration.rds_instance_certificate_expiration import (
rds_instance_certificate_expiration,
)
check = rds_instance_certificate_expiration()
result = check.execute()
assert len(result) == 1
assert result[0].status == "PASS"
assert result[0].check_metadata.Severity == "informational"
assert (
result[0].status_extended
== "RDS Instance db-master-1 custom certificate has over 6 months of validity left."
)
assert result[0].resource_id == "db-master-1"
assert result[0].region == AWS_REGION
assert (
result[0].resource_arn
== f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1"
)
assert result[0].resource_tags == []
@mock_aws
def test_custom_rds_certificate_between_three_and_six_months(self):
valid_from = datetime.now(utc) - relativedelta.relativedelta(months=7)
valid_till = datetime.now(utc) + relativedelta.relativedelta(months=4)
customer_override_valid = datetime.now(utc) + relativedelta.relativedelta(
months=4
)
rds_client = mock.MagicMock
rds_client.db_instances = []
rds_client.db_instances = [
DBInstance(
id="db-master-1",
arn=f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1",
engine="aurora-postgresql",
engine_version="aurora14",
status="available",
public=False,
encrypted=True,
deletion_protection=True,
auto_minor_version_upgrade=False,
multi_az=True,
region=AWS_REGION,
ca_cert="rds-ca-rsa2048-g1",
cert=[
{
"CertificateIdentifier": "rds-ca-rsa2048-g1",
"CertificateType": "CA",
"ValidFrom": f"{valid_from}",
"ValidTill": f"{valid_till}",
"CustomerOverride": True,
"CustomerOverrideValidTill": f"{customer_override_valid}",
}
],
)
]
with mock.patch(
"prowler.providers.aws.services.rds.rds_service.RDS",
new=rds_client,
), mock.patch(
"prowler.providers.aws.services.rds.rds_client.rds_client",
new=rds_client,
):
# Test Check
from prowler.providers.aws.services.rds.rds_instance_certificate_expiration.rds_instance_certificate_expiration import (
rds_instance_certificate_expiration,
)
check = rds_instance_certificate_expiration()
result = check.execute()
assert len(result) == 1
assert result[0].status == "PASS"
assert result[0].check_metadata.Severity == "low"
assert (
result[0].status_extended
== "RDS Instance db-master-1 custom certificate has between 3 and 6 months of validity."
)
assert result[0].resource_id == "db-master-1"
assert result[0].region == AWS_REGION
assert (
result[0].resource_arn
== f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1"
)
assert result[0].resource_tags == []
@mock_aws
def test_custom_rds_certificate_less_than_three_months(self):
valid_from = datetime.now(utc) - relativedelta.relativedelta(months=7)
valid_till = datetime.now(utc) + relativedelta.relativedelta(months=3)
customer_override_valid = datetime.now(utc) + relativedelta.relativedelta(
months=3
)
rds_client = mock.MagicMock
rds_client.db_instances = []
rds_client.db_instances = [
DBInstance(
id="db-master-1",
arn=f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1",
engine="aurora-postgresql",
engine_version="aurora14",
status="available",
public=False,
encrypted=True,
deletion_protection=True,
auto_minor_version_upgrade=False,
multi_az=True,
region=AWS_REGION,
ca_cert="rds-ca-rsa2048-g1",
cert=[
{
"CertificateIdentifier": "rds-ca-rsa2048-g1",
"CertificateType": "CA",
"ValidFrom": f"{valid_from}",
"ValidTill": f"{valid_till}",
"CustomerOverride": True,
"CustomerOverrideValidTill": f"{customer_override_valid}",
}
],
)
]
with mock.patch(
"prowler.providers.aws.services.rds.rds_service.RDS",
new=rds_client,
), mock.patch(
"prowler.providers.aws.services.rds.rds_client.rds_client",
new=rds_client,
):
# Test Check
from prowler.providers.aws.services.rds.rds_instance_certificate_expiration.rds_instance_certificate_expiration import (
rds_instance_certificate_expiration,
)
check = rds_instance_certificate_expiration()
result = check.execute()
assert len(result) == 1
assert result[0].status == "FAIL"
assert result[0].check_metadata.Severity == "medium"
assert (
result[0].status_extended
== "RDS Instance db-master-1 custom certificate less than 3 months of validity."
)
assert result[0].resource_id == "db-master-1"
assert result[0].region == AWS_REGION
assert (
result[0].resource_arn
== f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1"
)
assert result[0].resource_tags == []
@mock_aws
def test_custom_rds_certificate_less_than_one_month(self):
valid_from = datetime.now(utc) - relativedelta.relativedelta(months=7)
valid_till = datetime.now(utc) + relativedelta.relativedelta(weeks=2)
customer_override_valid = datetime.now(utc) + relativedelta.relativedelta(
weeks=2
)
rds_client = mock.MagicMock
rds_client.db_instances = []
rds_client.db_instances = [
DBInstance(
id="db-master-1",
arn=f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1",
engine="aurora-postgresql",
engine_version="aurora14",
status="available",
public=False,
encrypted=True,
deletion_protection=True,
auto_minor_version_upgrade=False,
multi_az=True,
region=AWS_REGION,
ca_cert="rds-ca-rsa2048-g1",
cert=[
{
"CertificateIdentifier": "rds-ca-rsa2048-g1",
"CertificateType": "CA",
"ValidFrom": f"{valid_from}",
"ValidTill": f"{valid_till}",
"CustomerOverride": True,
"CustomerOverrideValidTill": f"{customer_override_valid}",
}
],
)
]
with mock.patch(
"prowler.providers.aws.services.rds.rds_service.RDS",
new=rds_client,
), mock.patch(
"prowler.providers.aws.services.rds.rds_client.rds_client",
new=rds_client,
):
# Test Check
from prowler.providers.aws.services.rds.rds_instance_certificate_expiration.rds_instance_certificate_expiration import (
rds_instance_certificate_expiration,
)
check = rds_instance_certificate_expiration()
result = check.execute()
assert len(result) == 1
assert result[0].status == "FAIL"
assert result[0].check_metadata.Severity == "high"
assert (
result[0].status_extended
== "RDS Instance db-master-1 custom certificate less than 1 month of validity."
)
assert result[0].resource_id == "db-master-1"
assert result[0].region == AWS_REGION
assert (
result[0].resource_arn
== f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1"
)
assert result[0].resource_tags == []
@mock_aws
def test_custom_rds_certificate_expired(self):
valid_from = datetime.now(utc) - relativedelta.relativedelta(months=7)
valid_till = datetime.now(utc) - relativedelta.relativedelta(months=7)
customer_override_valid = datetime.now(utc) - relativedelta.relativedelta(
months=7
)
rds_client = mock.MagicMock
rds_client.db_instances = []
rds_client.db_instances = [
DBInstance(
id="db-master-1",
arn=f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1",
engine="aurora-postgresql",
engine_version="aurora14",
status="available",
public=False,
encrypted=True,
deletion_protection=True,
auto_minor_version_upgrade=False,
multi_az=True,
region=AWS_REGION,
ca_cert="rds-ca-rsa2048-g1",
cert=[
{
"CertificateIdentifier": "rds-ca-rsa2048-g1",
"CertificateType": "CA",
"ValidFrom": f"{valid_from}",
"ValidTill": f"{valid_till}",
"CustomerOverride": True,
"CustomerOverrideValidTill": f"{customer_override_valid}",
}
],
)
]
with mock.patch(
"prowler.providers.aws.services.rds.rds_service.RDS",
new=rds_client,
), mock.patch(
"prowler.providers.aws.services.rds.rds_client.rds_client",
new=rds_client,
):
# Test Check
from prowler.providers.aws.services.rds.rds_instance_certificate_expiration.rds_instance_certificate_expiration import (
rds_instance_certificate_expiration,
)
check = rds_instance_certificate_expiration()
result = check.execute()
assert len(result) == 1
assert result[0].status == "FAIL"
assert result[0].check_metadata.Severity == "critical"
assert (
result[0].status_extended
== "RDS Instance db-master-1 custom certificate has expired."
)
assert result[0].resource_id == "db-master-1"
assert result[0].region == AWS_REGION
assert (
result[0].resource_arn
== f"arn:aws:rds:{AWS_REGION}:{AWS_ACCOUNT_NUMBER_CON}:db:db-master-1"
)
assert result[0].resource_tags == []
@@ -1,3 +1,4 @@
from datetime import datetime
from unittest.mock import patch
import botocore
@@ -154,6 +155,33 @@ class Test_RDS_Service:
if parameter["ParameterName"] == "rds.force_ssl":
assert parameter["ParameterValue"] == "1"
@mock_aws
def test__describe_db_certificate__(self):
conn = client("rds", region_name=AWS_REGION_US_EAST_1)
conn.create_db_parameter_group(
DBParameterGroupName="test",
DBParameterGroupFamily="default.postgres9.3",
Description="test parameter group",
)
conn.create_db_instance(
DBInstanceIdentifier="db-master-1",
AllocatedStorage=10,
Engine="postgres",
DBName="staging-postgres",
DBInstanceClass="db.m1.small",
DBParameterGroupName="test",
CACertificateIdentifier="rds-cert-2015",
)
# RDS client for this test class
aws_provider = set_mocked_aws_provider([AWS_REGION_US_EAST_1])
rds = RDS(aws_provider)
assert len(rds.db_instances) == 1
assert rds.db_instances[0].id == "db-master-1"
assert rds.db_instances[0].region == AWS_REGION_US_EAST_1
for cert in rds.db_instances[0].cert:
assert cert["ValidTill"] < datetime.now()
# Test RDS Describe DB Snapshots
@mock_aws
def test__describe_db_snapshots__(self):