feat(pip): Prepare for PyPI (#1531)

tests/lib/check/check_test.py

@@ -0,0 +1,180 @@
+import os
+
+from prowler.lib.check.check import (
+    exclude_checks_to_run,
+    exclude_services_to_run,
+    parse_checks_from_file,
+)
+from prowler.lib.check.models import load_check_metadata
+
+
+class Test_Check:
+    def test_load_check_metadata(self):
+        test_cases = [
+            {
+                "input": {
+                    "metadata_path": f"{os.path.dirname(os.path.realpath(__file__))}/fixtures/metadata.json",
+                },
+                "expected": {
+                    "CheckID": "iam_disable_30_days_credentials",
+                    "CheckTitle": "Ensure credentials unused for 30 days or greater are disabled",
+                    "ServiceName": "iam",
+                    "Severity": "low",
+                },
+            }
+        ]
+        for test in test_cases:
+            metadata_path = test["input"]["metadata_path"]
+            check_metadata = load_check_metadata(metadata_path)
+            assert check_metadata.CheckID == test["expected"]["CheckID"]
+            assert check_metadata.CheckTitle == test["expected"]["CheckTitle"]
+            assert check_metadata.ServiceName == test["expected"]["ServiceName"]
+            assert check_metadata.Severity == test["expected"]["Severity"]
+
+    def test_parse_checks_from_file(self):
+        test_cases = [
+            {
+                "input": {
+                    "path": f"{os.path.dirname(os.path.realpath(__file__))}/fixtures/checklistA.json",
+                    "provider": "aws",
+                },
+                "expected": {"check11", "check12", "check7777"},
+            }
+        ]
+        for test in test_cases:
+            check_file = test["input"]["path"]
+            provider = test["input"]["provider"]
+            assert parse_checks_from_file(check_file, provider) == test["expected"]
+
+    def test_exclude_checks_to_run(self):
+        test_cases = [
+            {
+                "input": {
+                    "check_list": {"check12", "check11", "extra72", "check13"},
+                    "excluded_checks": {"check12", "check13"},
+                },
+                "expected": {"check11", "extra72"},
+            },
+            {
+                "input": {
+                    "check_list": {"check112", "check11", "extra72", "check13"},
+                    "excluded_checks": {"check12", "check13", "check14"},
+                },
+                "expected": {"check112", "check11", "extra72"},
+            },
+        ]
+        for test in test_cases:
+            check_list = test["input"]["check_list"]
+            excluded_checks = test["input"]["excluded_checks"]
+            assert (
+                exclude_checks_to_run(check_list, excluded_checks) == test["expected"]
+            )
+
+    def test_exclude_services_to_run(self):
+        test_cases = [
+            {
+                "input": {
+                    "checks_to_run": {
+                        "iam_disable_30_days_credentials",
+                        "iam_disable_90_days_credentials",
+                    },
+                    "excluded_services": {"ec2"},
+                    "provider": "aws",
+                },
+                "expected": {
+                    "iam_disable_30_days_credentials",
+                    "iam_disable_90_days_credentials",
+                },
+            },
+            {
+                "input": {
+                    "checks_to_run": {
+                        "iam_disable_30_days_credentials",
+                        "iam_disable_90_days_credentials",
+                    },
+                    "excluded_services": {"iam"},
+                    "provider": "aws",
+                },
+                "expected": set(),
+            },
+        ]
+        for test in test_cases:
+            excluded_services = test["input"]["excluded_services"]
+            checks_to_run = test["input"]["checks_to_run"]
+            provider = test["input"]["provider"]
+            assert (
+                exclude_services_to_run(checks_to_run, excluded_services, provider)
+                == test["expected"]
+            )
+
+    # def test_parse_checks_from_compliance_framework_two(self):
+    #     test_case = {
+    #         "input": {"compliance_frameworks": ["cis_v1.4_aws", "ens_v3_aws"]},
+    #         "expected": {
+    #             "vpc_flow_logs_enabled",
+    #             "ec2_ebs_snapshot_encryption",
+    #             "iam_user_mfa_enabled_console_access",
+    #             "cloudtrail_multi_region_enabled",
+    #             "ec2_elbv2_insecure_ssl_ciphers",
+    #             "guardduty_is_enabled",
+    #             "s3_bucket_default_encryption",
+    #             "cloudfront_distributions_https_enabled",
+    #             "iam_avoid_root_usage",
+    #             "s3_bucket_secure_transport_policy",
+    #         },
+    #     }
+    #     with mock.patch(
+    #         "prowler.lib.check.check.compliance_specification_dir_path",
+    #         new=f"{os.path.dirname(os.path.realpath(__file__))}/fixtures",
+    #     ):
+    #         provider = "aws"
+    #         bulk_compliance_frameworks = bulk_load_compliance_frameworks(provider)
+    #         compliance_frameworks = test_case["input"]["compliance_frameworks"]
+    #         assert (
+    #             parse_checks_from_compliance_framework(
+    #                 compliance_frameworks, bulk_compliance_frameworks
+    #             )
+    #             == test_case["expected"]
+    #         )
+
+    # def test_parse_checks_from_compliance_framework_one(self):
+    #     test_case = {
+    #         "input": {"compliance_frameworks": ["cis_v1.4_aws"]},
+    #         "expected": {
+    #             "iam_user_mfa_enabled_console_access",
+    #             "s3_bucket_default_encryption",
+    #             "iam_avoid_root_usage",
+    #         },
+    #     }
+    #     with mock.patch(
+    #         "prowler.lib.check.check.compliance_specification_dir",
+    #         new=f"{os.path.dirname(os.path.realpath(__file__))}/fixtures",
+    #     ):
+    #         provider = "aws"
+    #         bulk_compliance_frameworks = bulk_load_compliance_frameworks(provider)
+    #         compliance_frameworks = test_case["input"]["compliance_frameworks"]
+    #         assert (
+    #             parse_checks_from_compliance_framework(
+    #                 compliance_frameworks, bulk_compliance_frameworks
+    #             )
+    #             == test_case["expected"]
+    #         )
+
+    # def test_parse_checks_from_compliance_framework_no_compliance(self):
+    #     test_case = {
+    #         "input": {"compliance_frameworks": []},
+    #         "expected": set(),
+    #     }
+    #     with mock.patch(
+    #         "prowler.lib.check.check.compliance_specification_dir",
+    #         new=f"{os.path.dirname(os.path.realpath(__file__))}/fixtures",
+    #     ):
+    #         provider = "aws"
+    #         bulk_compliance_frameworks = bulk_load_compliance_frameworks(provider)
+    #         compliance_frameworks = test_case["input"]["compliance_frameworks"]
+    #         assert (
+    #             parse_checks_from_compliance_framework(
+    #                 compliance_frameworks, bulk_compliance_frameworks
+    #             )
+    #             == test_case["expected"]
+    #         )

tests/lib/check/fixtures/aws/cis_v1.4_aws.json

@@ -0,0 +1,82 @@
+{
+  "Framework": "CIS",
+  "Provider": "AWS",
+  "Version": "1.4",
+  "Requirements": [
+    {
+      "Id": "1.4",
+      "Description": "Ensure no 'root' user account access key exists (Automated)",
+      "Attributes": [
+        {
+          "Section": "1. Identity and Access Management (IAM)",
+          "Level": [
+            "level1"
+          ],
+          "Rationale": "Removing access keys associated with the 'root' user account limits vectors by which the account can be compromised. Additionally, removing the 'root' access keys encourages the creation and use of role based accounts that are least privileged.",
+          "Guidance": "The 'root' user account is the most privileged user in an AWS account. AWS Access Keys provide programmatic access to a given AWS account. It is recommended that all access keys associated with the 'root' user account be removed.",
+          "Additional information": "IAM User account \"root\" for us-gov cloud regions is not enabled by default. However, on request to AWS support enables 'root' access only through access-keys (CLI, API methods) for us-gov cloud region.",
+          "References": [
+            "CCE-78910-7",
+            "https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html",
+            "https://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html",
+            "https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetAccountSummary.html",
+            "https://aws.amazon.com/blogs/security/an-easier-way-to-determine-the-presence-of-aws-account-access-keys/"
+          ]
+        }
+      ],
+      "Checks": [
+        "iam_avoid_root_usage"
+      ]
+    },
+    {
+      "Id": "1.10",
+      "Description": "Ensure multi-factor authentication (MFA) is enabled for all IAM users that have a console password (Automated)",
+      "Attributes": [
+        {
+          "Section": "1. Identity and Access Management (IAM)",
+          "Level": [
+            "level1"
+          ],
+          "Guidance": "Multi-Factor Authentication (MFA) adds an extra layer of authentication assurance beyond traditional credentials. With MFA enabled, when a user signs in to the AWS Console, they will be prompted for their user name and password as well as for an authentication code from their physical or virtual MFA token. It is recommended that MFA be enabled for all accounts that have a console password.",
+          "Rationale": "Enabling MFA provides increased security for console access as it requires the authenticating principal to possess a device that displays a time-sensitive key and have knowledge of a credential.",
+          "Impact": "AWS will soon end support for SMS multi-factor authentication (MFA). New customers are not allowed to use this feature. We recommend that existing customers switch to one of the following alternative methods of MFA.",
+          "Additional information": "Forced IAM User Self-Service Remediation. Amazon has published a pattern that forces users to self-service setup MFA before they have access to their complete permissions set. Until they complete this step, they cannot access their full permissions. This pattern can be used on new AWS accounts. It can also be used on existing accounts - it is recommended users are given instructions and a grace period to accomplish MFA enrollment before active enforcement on existing AWS accounts.",
+          "References": [
+            "CCE-78901-6",
+            "https://tools.ietf.org/html/rfc6238",
+            "https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html",
+            "https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#enable-mfa-for-privileged-users",
+            "https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_enable_virtual.html",
+            "https://blogs.aws.amazon.com/security/post/Tx2SJJYE082KBUK/How-to-Delegate-Management-of-Multi-Factor-Authentication-to-AWS-IAM-Users"
+          ]
+        }
+      ],
+      "Checks": [
+        "iam_user_mfa_enabled_console_access"
+      ]
+    },
+    {
+      "Id": "2.1.1",
+      "Description": "Ensure all S3 buckets employ encryption-at-rest (Automated)",
+      "Attributes": [
+        {
+          "Section": "2. Storage",
+          "Level": [
+            "level2"
+          ],
+          "Guidance": "Amazon S3 provides a variety of no, or low, cost encryption options to protect data at rest.",
+          "Rationale": "Encrypting data at rest reduces the likelihood that it is unintentionally exposed and can nullify the impact of disclosure if the encryption remains unbroken.",
+          "Impact": "Amazon S3 buckets with default bucket encryption using SSE-KMS cannot be used as destination buckets for Amazon S3 server access logging. Only SSE-S3 default encryption is supported for server access log destination buckets.",
+          "Additional information": "S3 bucket encryption only applies to objects as they are placed in the bucket. Enabling S3 bucket encryption does not encrypt objects previously stored within the bucket",
+          "References": [
+            "https://docs.aws.amazon.com/AmazonS3/latest/user-guide/default-bucket-encryption.html",
+            "https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-related-resources"
+          ]
+        }
+      ],
+      "Checks": [
+        "s3_bucket_default_encryption"
+      ]
+    }
+  ]
+}

tests/lib/check/fixtures/aws/ens_v3_aws.json

@@ -0,0 +1,82 @@
+{
+  "Framework": "ENS",
+  "Version": "3",
+  "Requirements": [
+    {
+      "Id": "op.mon.1",
+      "Description": "Detección de intrusión",
+      "Attributes": [
+        {
+          "Marco": "operacional",
+          "Categoria": "monitorización del sistema",
+          "Descripcion_Control": "- En ausencia de otras herramientas de terceros, habilitar Amazon GuarDuty para la detección de amenazas e intrusiones..- Activar el servicio de eventos AWS CloudTrail para todas las regiones..- Activar el servicio VPC FlowLogs..-Deberá habilitarse Amazon GuardDuty para todas las regiones tanto en la cuenta raíz como en las cuentas miembro de un entorno multi-cuenta..-Todas las cuentas miembro deberán estar añadidas para la supervisión bajo la cuenta raíz..-La adminsitración de Amazon GuardDuty quedará delegada exclusivamente a la cuenta de seguridad para garantizar una correcta asignación de los roles para este servicio.",
+          "Nivel": [
+            "bajo",
+            "medio",
+            "alto"
+          ],
+          "Dimensiones": [
+            "confidencialidad",
+            "integridad",
+            "trazabilidad",
+            "autenticidad",
+            "disponibilidad"
+          ]
+        }
+      ],
+      "Checks": [
+        "guardduty_is_enabled",
+        "cloudtrail_multi_region_enabled",
+        "vpc_flow_logs_enabled",
+        "guardduty_is_enabled"
+      ]
+    },
+    {
+      "Id": "op.mon.3",
+      "Description": "Protección de la integridad y de la autenticidad",
+      "Attributes": [
+        {
+          "Marco": "operacional",
+          "Categoria": "protección de las comunicaciones",
+          "Descripcion_Control": "- Habilitar TLS en los balanceadores de carga ELB.- Evitar el uso de protocolos de cifrado inseguros en la conexión TLS entre clientes y balanceadores de carga.- Asegurar que los Buckets de almacenamiento S3 apliquen cifrado para la transferencia de datos empleando TLS.- Asegurar que la distribución entre frontales CloudFront y sus orígenes únicamente emplee tráfico HTTPS.",
+          "Nivel": [
+            "bajo",
+            "medio",
+            "alto"
+          ],
+          "Dimensiones": [
+            "integridad",
+            "autenticidad"
+          ]
+        }
+      ],
+      "Checks": [
+        "ec2_elbv2_insecure_ssl_ciphers",
+        "ec2_elbv2_insecure_ssl_ciphers",
+        "s3_bucket_secure_transport_policy",
+        "cloudfront_distributions_https_enabled"
+      ]
+    },
+    {
+      "Id": "mp.si.2.r2.1",
+      "Description": "Copias de seguridad",
+      "Attributes": [
+        {
+          "Marco": "medidas de protección",
+          "Categoria": "protección de los soportes de información",
+          "Descripcion_Control": "Se deberá asegurar el cifrado de las copias de seguridad de EBS.",
+          "Nivel": [
+            "alto"
+          ],
+          "Dimensiones": [
+            "confidencialidad",
+            "integridad"
+          ]
+        }
+      ],
+      "Checks": [
+        "ec2_ebs_snapshot_encryption"
+      ]
+    }
+  ]
+}

tests/lib/check/fixtures/checklistA.json

@@ -0,0 +1,7 @@
+{
+  "aws": [
+    "check11",
+    "check12",
+    "check7777"
+  ]
+}

tests/lib/check/fixtures/groupsA.json

@@ -0,0 +1,18 @@
+{
+  "aws": {
+    "gdpr": {
+      "checks": [
+        "check11",
+        "check12"
+      ],
+      "description": "GDPR Readiness"
+    },
+    "iam": {
+      "checks": [
+        "iam_disable_30_days_credentials",
+        "iam_disable_90_days_credentials"
+      ],
+      "description": "Identity and Access Management"
+    }
+  }
+}

tests/lib/check/fixtures/metadata.json

@@ -0,0 +1,58 @@
+{
+  "Categories": [
+    "cat1",
+    "cat2"
+  ],
+  "CheckID": "iam_disable_30_days_credentials",
+  "CheckTitle": "Ensure credentials unused for 30 days or greater are disabled",
+  "CheckType": [
+    "Software and Configuration Checks"
+  ],
+  "Compliance": [
+    {
+      "Control": [
+        "4.4"
+      ],
+      "Framework": "CIS-AWS",
+      "Group": [
+        "level1",
+        "level2"
+      ],
+      "Version": "1.4"
+    }
+  ],
+  "DependsOn": [
+    "othercheck1",
+    "othercheck2"
+  ],
+  "Description": "Ensure credentials unused for 30 days or greater are disabled",
+  "Notes": "additional information",
+  "Provider": "aws",
+  "RelatedTo": [
+    "othercheck3",
+    "othercheck4"
+  ],
+  "RelatedUrl": "https://serviceofficialsiteorpageforthissubject",
+  "Remediation": {
+    "Code": {
+      "CLI": "cli command or URL to the cli command location.",
+      "NativeIaC": "code or URL to the code location.",
+      "Other": "cli command or URL to the cli command location.",
+      "Terraform": "code or URL to the code location."
+    },
+    "Recommendation": {
+      "Text": "Run sudo yum update and cross your fingers and toes.",
+      "Url": "https://myfp.com/recommendations/dangerous_things_and_how_to_fix_them.html"
+    }
+  },
+  "ResourceIdTemplate": "arn:partition:service:region:account-id:resource-id",
+  "ResourceType": "AwsIamAccessAnalyzer",
+  "Risk": "Risk associated.",
+  "ServiceName": "iam",
+  "Severity": "low",
+  "SubServiceName": "accessanalyzer",
+  "Tags": {
+    "Tag1Key": "value",
+    "Tag2Key": "value"
+  }
+}