feat(compliance): add name for each compliance (#7920)

Co-authored-by: Pepe Fagoaga <pepe@prowler.com>

Author: pedrooot

api/CHANGELOG.md

@@ -6,6 +6,7 @@ All notable changes to the **Prowler API** are documented in this file.
 
 ### Added
 - Default JWT keys are generated and stored if they are missing from configuration [(#8655)](https://github.com/prowler-cloud/prowler/pull/8655)
+- `compliance_name` for each compliance [(#7920)](https://github.com/prowler-cloud/prowler/pull/7920)
 
 ### Changed
 - Now the MANAGE_ACCOUNT permission is required to modify or read user permissions instead of MANAGE_USERS [(#8281)](https://github.com/prowler-cloud/prowler/pull/8281)

api/src/backend/api/compliance.py

@@ -225,6 +225,7 @@ def generate_compliance_overview_template(prowler_compliance: dict):
             # Build compliance dictionary
             compliance_dict = {
                 "framework": compliance_data.Framework,
+                "name": compliance_data.Name,
                 "version": compliance_data.Version,
                 "provider": provider_type,
                 "description": compliance_data.Description,

api/src/backend/api/specs/v1.yaml

@@ -182,6 +182,7 @@ paths:
             type: string
             enum:
             - id
+            - compliance_name
             - framework_description
             - name
             - framework
@@ -8739,6 +8740,8 @@ components:
           properties:
             id:
               type: string
+            compliance_name:
+              type: string
             framework_description:
               type: string
             name:
@@ -8752,6 +8755,7 @@ components:
             attributes: {}
           required:
           - id
+          - compliance_name
           - framework_description
           - name
           - framework

api/src/backend/api/tests/test_compliance.py

@@ -239,6 +239,7 @@ def test_generate_compliance_overview_template(self, mock_provider_choices):
             Framework="Framework 1",
             Version="1.0",
             Description="Description of compliance1",
+            Name="Compliance 1",
         )
         prowler_compliance = {"aws": {"compliance1": compliance1}}
 
@@ -248,6 +249,7 @@ def test_generate_compliance_overview_template(self, mock_provider_choices):
             "aws": {
                 "compliance1": {
                     "framework": "Framework 1",
+                    "name": "Compliance 1",
                     "version": "1.0",
                     "provider": "aws",
                     "description": "Description of compliance1",

api/src/backend/api/v1/serializers.py

@@ -1959,6 +1959,7 @@ class JSONAPIMeta:
 
 class ComplianceOverviewAttributesSerializer(serializers.Serializer):
     id = serializers.CharField()
+    compliance_name = serializers.CharField()
     framework_description = serializers.CharField()
     name = serializers.CharField()
     framework = serializers.CharField()

api/src/backend/api/v1/views.py

@@ -3545,6 +3545,7 @@ def attributes(self, request):
                     ),
                     "name": requirement.get("name", ""),
                     "framework": compliance_framework.get("framework", ""),
+                    "compliance_name": compliance_framework.get("name", ""),
                     "version": compliance_framework.get("version", ""),
                     "description": requirement.get("description", ""),
                     "attributes": base_attributes,

prowler/CHANGELOG.md

@@ -7,6 +7,7 @@ All notable changes to the **Prowler SDK** are documented in this file.
 ### Added
 - Support for AdditionalURLs in outputs [(#8651)](https://github.com/prowler-cloud/prowler/pull/8651)
 - Support for markdown metadata fields in Dashboard [(#8667)](https://github.com/prowler-cloud/prowler/pull/8667)
+- Add explicit "name" field for each compliance framework and include "FRAMEWORK" and "NAME" in CSV output [(#7920)](https://github.com/prowler-cloud/prowler/pull/7920)
 
 ### Changed
 - Update AWS Neptune service metadata to new format [(#8494)](https://github.com/prowler-cloud/prowler/pull/8494)

prowler/compliance/aws/aws_account_security_onboarding_aws.json

@@ -1,5 +1,6 @@
 {
   "Framework": "AWS-Account-Security-Onboarding",
+  "Name": "AWS Account Security Onboarding",
   "Version": "",
   "Provider": "AWS",
   "Description": "Checklist when onboarding new AWS Accounts to existing AWS Organization.",

prowler/compliance/aws/aws_audit_manager_control_tower_guardrails_aws.json

@@ -1,5 +1,6 @@
 {
   "Framework": "AWS-Audit-Manager-Control-Tower-Guardrails",
+  "Name": "AWS Audit Manager Control Tower Guardrails",
   "Version": "",
   "Provider": "AWS",
   "Description": "AWS Control Tower is a management and governance service that you can use to navigate through the setup process and governance requirements that are involved in creating a multi-account AWS environment.",

prowler/compliance/aws/aws_foundational_security_best_practices_aws.json

@@ -1,5 +1,6 @@
 {
   "Framework": "AWS-Foundational-Security-Best-Practices",
+  "Name": "AWS Foundational Security Best Practices",
   "Version": "",
   "Provider": "AWS",
   "Description": "The AWS Foundational Security Best Practices standard is a set of controls that detect when your deployed accounts and resources deviate from security best practices.",
@@ -4730,4 +4731,4 @@
       ]
     }
   ]
-}
+}