sraverify 0.1.0__py3-none-any.whl

sraverify/services/waf/checks/sra_waf_09.py

@@ -0,0 +1,95 @@
+from typing import Dict, List, Any
+from sraverify.services.waf.base import WAFCheck
+
+class SRA_WAF_09(WAFCheck):
+    def __init__(self):
+        super().__init__()
+        self.resource_type = "AWS::WAFv2::WebACL"
+        self.check_id = "SRA-WAF-09"
+        self.check_name = "WAF Web ACLs should have logging enabled"
+        self.description = "Ensures that all WAF Web ACLs have logging enabled to capture traffic analysis data"
+        self.severity = "MEDIUM"
+        self.check_logic = "Lists all WAF Web ACLs and verifies each has logging configuration enabled"
+
+    def execute(self) -> List[Dict[str, Any]]:
+        # Check both regional and global (CloudFront) Web ACLs
+        scopes = [("REGIONAL", self.regions), ("CLOUDFRONT", ["us-east-1"])]
+        
+        for scope, regions in scopes:
+            for region in regions:
+                web_acls_response = self.get_web_acls(region, scope)
+
+                if "Error" in web_acls_response:
+                    self.findings.append(self.create_finding(
+                        status="ERROR",
+                        region=region,
+                        resource_id=None,
+                        actual_value=web_acls_response["Error"].get("Message", "Unknown error"),
+                        remediation="Check IAM permissions for WAF API access"
+                    ))
+                    continue
+
+                web_acls = web_acls_response.get("WebACLs", [])
+
+                if not web_acls:
+                    self.findings.append(self.create_finding(
+                        status="PASS",
+                        region=region,
+                        resource_id=f"No {scope} Web ACLs",
+                        actual_value=f"No {scope} WAF Web ACLs found",
+                        remediation="No action needed"
+                    ))
+                    continue
+
+                for web_acl in web_acls:
+                    web_acl_arn = web_acl.get("ARN")
+                    web_acl_name = web_acl.get("Name")
+                    web_acl_id = web_acl.get("Id")
+                    
+                    client = self.get_client(region)
+                    if not client:
+                        continue
+
+                    logging_response = client.get_logging_configuration(web_acl_arn)
+
+                    if "Error" in logging_response:
+                        self.findings.append(self.create_finding(
+                            status="ERROR",
+                            region=region,
+                            resource_id=web_acl_name or web_acl_id,
+                            actual_value=logging_response["Error"].get("Message", "Unknown error"),
+                            remediation="Check IAM permissions for WAF logging configuration access"
+                        ))
+                        continue
+
+                    logging_config = logging_response.get("LoggingConfiguration")
+
+                    if logging_config:
+                        log_destinations = logging_config.get("LogDestinationConfigs", [])
+                        if log_destinations:
+                            destinations_str = ", ".join(log_destinations)
+                            self.findings.append(self.create_finding(
+                                status="PASS",
+                                region=region,
+                                resource_id=web_acl_name or web_acl_id,
+                                actual_value=f"Logging enabled to: {destinations_str}",
+                                remediation="No action needed"
+                            ))
+                        else:
+                            self.findings.append(self.create_finding(
+                                status="FAIL",
+                                region=region,
+                                resource_id=web_acl_name or web_acl_id,
+                                actual_value="Logging configuration exists but no destinations configured",
+                                remediation="Configure logging destinations for this WAF Web ACL using CloudWatch Logs, S3, or Kinesis Data Firehose"
+                            ))
+                    else:
+                        self.findings.append(self.create_finding(
+                            status="FAIL",
+                            region=region,
+                            resource_id=web_acl_name or web_acl_id,
+                            actual_value="No logging configuration found",
+                            remediation="Enable logging for this WAF Web ACL using CloudWatch Logs, S3, or Kinesis Data Firehose"
+                        ))
+
+        return self.findings

sraverify/services/waf/client.py

@@ -0,0 +1,109 @@
+from typing import Dict, List, Optional, Any
+import boto3
+from botocore.exceptions import ClientError
+from sraverify.core.logging import logger
+
+class WAFClient:
+    def __init__(self, region: str, session: Optional[boto3.Session] = None):
+        self.region = region
+        self.session = session or boto3.Session()
+        self.cloudfront_client = self.session.client('cloudfront', region_name='us-east-1')  # CloudFront is global
+        self.elbv2_client = self.session.client('elbv2', region_name=region)
+        self.wafv2_client = self.session.client('wafv2', region_name=region)
+        self.apigateway_client = self.session.client('apigateway', region_name=region)
+        self.appsync_client = self.session.client('appsync', region_name=region)
+        self.cognito_idp_client = self.session.client('cognito-idp', region_name=region)
+        self.apprunner_client = self.session.client('apprunner', region_name=region)
+        self.ec2_client = self.session.client('ec2', region_name=region)
+        self.amplify_client = self.session.client('amplify', region_name=region)
+
+    def list_distributions(self) -> Dict[str, Any]:
+        try:
+            return self.cloudfront_client.list_distributions()
+        except ClientError as e:
+            logger.error(f"Error listing CloudFront distributions: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def describe_load_balancers(self) -> Dict[str, Any]:
+        try:
+            return self.elbv2_client.describe_load_balancers()
+        except ClientError as e:
+            logger.error(f"Error describing load balancers in {self.region}: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def get_rest_apis(self) -> Dict[str, Any]:
+        try:
+            return self.apigateway_client.get_rest_apis()
+        except ClientError as e:
+            logger.error(f"Error getting REST APIs in {self.region}: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def get_stages(self, rest_api_id: str) -> Dict[str, Any]:
+        try:
+            return self.apigateway_client.get_stages(restApiId=rest_api_id)
+        except ClientError as e:
+            logger.error(f"Error getting stages for REST API {rest_api_id} in {self.region}: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def list_graphql_apis(self) -> Dict[str, Any]:
+        try:
+            return self.appsync_client.list_graphql_apis()
+        except ClientError as e:
+            logger.error(f"Error listing GraphQL APIs in {self.region}: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def list_user_pools(self) -> Dict[str, Any]:
+        try:
+            return self.cognito_idp_client.list_user_pools(MaxResults=60)
+        except ClientError as e:
+            logger.error(f"Error listing user pools in {self.region}: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def list_services(self) -> Dict[str, Any]:
+        try:
+            return self.apprunner_client.list_services()
+        except ClientError as e:
+            logger.error(f"Error listing App Runner services in {self.region}: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def describe_verified_access_instances(self) -> Dict[str, Any]:
+        try:
+            return self.ec2_client.describe_verified_access_instances()
+        except ClientError as e:
+            logger.error(f"Error describing Verified Access instances in {self.region}: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def list_apps(self) -> Dict[str, Any]:
+        try:
+            return self.amplify_client.list_apps()
+        except ClientError as e:
+            logger.error(f"Error listing Amplify apps in {self.region}: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def list_web_acls(self, scope: str = "REGIONAL") -> Dict[str, Any]:
+        try:
+            return self.wafv2_client.list_web_acls(Scope=scope)
+        except ClientError as e:
+            logger.error(f"Error listing Web ACLs in {self.region}: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def get_logging_configuration(self, resource_arn: str) -> Dict[str, Any]:
+        try:
+            return self.wafv2_client.get_logging_configuration(ResourceArn=resource_arn)
+        except ClientError as e:
+            if e.response['Error']['Code'] == 'WAFNonexistentItemException':
+                return {"LoggingConfiguration": None}
+            logger.error(f"Error getting logging configuration for {resource_arn}: {e}")
+            return {"Error": {"Message": str(e)}}
+
+    def get_web_acl_for_resource(self, resource_arn: str) -> Dict[str, Any]:
+        try:
+            return self.wafv2_client.get_web_acl_for_resource(ResourceArn=resource_arn)
+        except ClientError as e:
+            if e.response['Error']['Code'] == 'WAFNonexistentItemException':
+                return {"WebACL": None}
+            elif e.response['Error']['Code'] == 'AccessDeniedException':
+                logger.error(f"Access denied getting web ACL for resource {resource_arn}: {e}")
+                return {"Error": {"Code": "AccessDeniedException", "Message": str(e)}}
+            logger.error(f"Error getting web ACL for resource {resource_arn}: {e}")
+            return {"Error": {"Message": str(e)}}

sraverify/utils/__init__.py

@@ -0,0 +1,3 @@
+"""
+Utility functions for the SRA Verify framework.
+"""

sraverify/utils/banner.py

@@ -0,0 +1,65 @@
+"""
+Banner display for SRA Verify tool.
+"""
+from colorama import Fore, Style
+import datetime
+import boto3
+from typing import Optional, List, Dict, Any
+
+
+def print_banner(profile: str, region: str, session: boto3.Session = None, 
+                 regions: Optional[List[str]] = None, account_type: str = 'all',
+                 checks_count: int = 0, output_file: str = None, role: Optional[str] = None):
+    """
+    Print the SRAVerify banner and initial execution information.
+    
+    Args:
+        profile: AWS profile name
+        region: AWS region name
+        session: AWS session
+        regions: List of AWS regions to check
+        account_type: Type of accounts to run checks against
+        checks_count: Number of checks to run
+        output_file: Output file name
+        role: ARN of IAM role being assumed
+    """
+    # ASCII art banner - using raw string to avoid escape sequence issues
+    print(fr"""
+                    _____ _____         ___       ___        _  __       
+                   / ____|  __ \     /\ \  \     /  /       (_)/ _|      
+                  | (___ | |__) |   /  \ \  \   /  /__  _ __ _| |_ _   _ 
+                   \___ \|  _  /   / /\ \ \   v   / _ \| '__| |  _| | | |
+                   ____) | | \ \  / ____ \ \     /  __/| |  | | | | |_| |
+                  |_____/|_|  \_\/_/    \_\ \___/ \___||_|  |_|_|  \__, |
+                                                                   __/ |
+                                                                  |___/ {Fore.BLUE}
+                        the security reference architecture verifier tool{Style.RESET_ALL}
+    """)
+
+    print(f"{Fore.YELLOW}Date: {datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}{Style.RESET_ALL}\n")
+
+    # Print AWS credentials information
+    print("-> Using the AWS credentials below:")
+    print(f"  · AWS-CLI Profile: {profile or 'default'}")
+    print(f"  · AWS Region: {region}")
+    
+    if session:
+        try:
+            sts = session.client('sts')
+            caller_identity = sts.get_caller_identity()
+            print(f"  · AWS Account: {caller_identity['Account']}")
+            print(f"  · User Id: {caller_identity['UserId']}")
+            print(f"  · Caller Identity ARN: {caller_identity['Arn']}")
+        except Exception as e:
+            print(f"  · Unable to retrieve identity information: {str(e)}")
+    
+    # Print scan information
+    print("\n-> Starting SRA Verify scan...")
+    if role:
+        print(f"  · Assuming Role: {role}")
+    print(f"  · Regions: {', '.join(regions) if regions else 'all enabled regions'}")
+    print(f"  · Account Type: {account_type}")
+    print(f"  · Checks: {checks_count}")
+    if output_file:
+        print(f"  · Output: {output_file}")
+    print()

sraverify/utils/outputs.py

@@ -0,0 +1,57 @@
+"""
+Output handling for sraverify scan results.
+"""
+import csv
+from typing import List, Dict, Any
+
+# Required fields as per developer guide
+REQUIRED_FIELDS = [
+    'AccountId',
+    'AccountName',
+    'Region',
+    'CheckId',
+    'Status',
+    'Severity',
+    'Title',
+    'Description',
+    'ResourceId',
+    'ResourceType',
+    'CheckedValue',
+    'ActualValue',
+    'Remediation',
+    'Service',
+    'CheckLogic',
+    'AccountType'  # Changed from CheckType to AccountType
+]
+
+
+def write_csv_output(findings: List[Dict[str, Any]], output_file: str):
+    """
+    Write scan findings to a CSV file ensuring all required fields are present.
+    
+    Args:
+        findings: List of finding dictionaries
+        output_file: Path to output CSV file
+    """
+    # Always create the CSV file, even if there are no findings
+    if not findings:
+        findings = []
+    
+    # Ensure each finding has all required fields
+    for finding in findings:
+        for field in REQUIRED_FIELDS:
+            if field not in finding:
+                finding[field] = ''  # Add empty string for missing fields
+        
+        # Handle the case where a finding might have CheckType but not AccountType
+        if 'CheckType' in finding and 'AccountType' not in finding:
+            finding['AccountType'] = finding['CheckType']
+            del finding['CheckType']
+    
+    with open(output_file, 'w', newline='') as csvfile:
+        writer = csv.DictWriter(csvfile, fieldnames=REQUIRED_FIELDS)
+        writer.writeheader()
+        for finding in findings:
+            # Only write the required fields, in the correct order
+            row = {field: finding.get(field, '') for field in REQUIRED_FIELDS}
+            writer.writerow(row)

sraverify/utils/progress.py

@@ -0,0 +1,97 @@
+"""
+Progress tracking for scan operations.
+"""
+import time
+from typing import Optional
+from colorama import Fore, Style
+
+class ScanProgress:
+    """Progress tracker for scan operations."""
+    
+    SPINNER = ['/', '-', '\\', '|']
+    
+    def __init__(self, total_checks: int):
+        """
+        Initialize the progress tracker.
+        
+        Args:
+            total_checks: The total number of checks to be performed
+        
+        Raises:
+            ValueError: If total_checks is less than or equal to 0
+        """
+        if total_checks <= 0:
+            raise ValueError("total_checks must be greater than 0")
+        self.total_checks = total_checks
+        self.completed_checks = 0
+        self.start_time = time.time()
+        self.current_service: Optional[str] = None
+        self.spinner_index = 0
+        self.last_print_time = 0
+        self.print_interval = 0.1  # Update display every 0.1 seconds
+    
+    @property
+    def progress(self) -> float:
+        """
+        Calculate the progress percentage.
+        
+        Returns:
+            Progress percentage
+        """
+        return (self.completed_checks / self.total_checks * 100)
+    
+    @property
+    def duration(self) -> str:
+        """
+        Calculate the elapsed time in minutes:seconds format.
+        
+        Returns:
+            Elapsed time string
+        """
+        elapsed = int(time.time() - self.start_time)
+        minutes = elapsed // 60
+        seconds = elapsed % 60
+        return f"{minutes}:{seconds:02d}"
+    
+    def update(self, service: str):
+        """
+        Update the current service being scanned.
+        
+        Args:
+            service: Service name
+        """
+        self.current_service = service
+        self.print_progress()
+        
+    def increment(self):
+        """Increment the completed checks counter."""
+        self.completed_checks += 1
+        self.spinner_index = (self.spinner_index + 1) % len(self.SPINNER)
+        self.print_progress()
+        
+    def print_progress(self):
+        """Print the current progress status with rate limiting."""
+        current_time = time.time()
+        # Only update display if enough time has passed since last update
+        if current_time - self.last_print_time >= self.print_interval:
+            self._do_print()
+            self.last_print_time = current_time
+
+    def _do_print(self):
+        """Actually perform the progress printing."""
+        spinner = self.SPINNER[self.spinner_index]
+        
+        # Calculate the width of the progress bar (50 characters)
+        bar_width = 50
+        filled_length = int(self.progress / 100 * bar_width)
+        bar = '=' * filled_length + ' ' * (bar_width - filled_length)
+        
+        # Format the progress bar with current status
+        print(f"{Fore.BLUE}\r-> Scanning {self.current_service} service {Style.RESET_ALL} |{bar}| {spinner} "
+              f"{self.completed_checks}/{self.total_checks} "
+              f"[{self.progress:.0f}%] in {self.duration}", 
+              end="", flush=True)
+    
+    def finish(self):
+        """Complete the progress display with a newline."""
+        print()  # Print newline to finish the progress display

sraverify-0.1.0.dist-info/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.