scythe-ttp 0.11.0__tar.gz → 0.12.1__tar.gz

{scythe_ttp-0.11.0/scythe_ttp.egg-info → scythe_ttp-0.12.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scythe-ttp
-Version: 0.11.0
+Version: 0.12.1
 Summary: An extensible framework for emulating attacker TTPs with Selenium.
 Home-page: https://github.com/EpykLab/scythe
 Author: EpykLab
@@ -169,6 +169,26 @@ file_upload_ttp = FileUploadTTP(
 
 ### Installation
 
+#### If you would like to use as a library:
+
+setup the virtual environment
+```bash
+python3 -m venv venv
+
+# source the venv
+# bash,zsh: source venv/bin/activate
+# fish: source venv/bin/activate.fish
+```
+
+install the package
+```bash
+# in an activated venv
+
+pip3 install scythe-ttp
+```
+
+#### If you would like like to contribute:
+
 1. Clone the repository:
    ```bash
    git clone https://github.com/EpykLab/scythe.git
@@ -458,11 +478,11 @@ from scythe.core.executor import TTPExecutor
 class MyTTP(TTP):
     def get_payloads(self):
         yield "test_payload"
-    
+
     def execute_step(self, driver, payload):
         driver.get("http://your-app.com/login")
         # ... test logic ...
-    
+
     def verify_result(self, driver):
         return "welcome" in driver.page_source
 
@@ -523,7 +543,7 @@ from typing import Generator, Any
 
 class CustomBusinessLogicTTP(TTP):
     """Test specific business logic under adverse conditions."""
-    
+
     def __init__(self, business_scenarios: list, expected_result: bool = True):
         super().__init__(
             name="Business Logic Test",
@@ -531,28 +551,28 @@ class CustomBusinessLogicTTP(TTP):
             expected_result=expected_result
         )
         self.scenarios = business_scenarios
-    
+
     def get_payloads(self) -> Generator[Any, None, None]:
         for scenario in self.scenarios:
             yield scenario
-    
+
     def execute_step(self, driver, payload):
         # Implement your specific business logic testing
         # This could involve API calls, database interactions, etc.
         pass
-    
+
     def verify_result(self, driver) -> bool:
         # Verify the business logic behaved correctly
         return self.check_business_rules(driver)
 
 class CustomWorkflowAction(Action):
     """Custom action for specific workflow steps."""
-    
+
     def __init__(self, workflow_step: str, parameters: dict):
         super().__init__(f"Custom {workflow_step}", f"Execute {workflow_step}")
         self.workflow_step = workflow_step
         self.parameters = parameters
-    
+
     def execute(self, driver, context):
         # Implement custom workflow logic
         return self.perform_workflow_step(driver, context)
@@ -569,12 +589,12 @@ ecommerce_suite = [
     payment_security_test,      # Test payment form security
     user_data_protection_test,  # Test PII protection
     session_management_test,    # Test session security
-    
+
     # Load testing
     product_catalog_load_test,  # High-traffic product browsing
     checkout_process_load_test, # Concurrent checkout processes
     search_functionality_test,  # Search under load
-    
+
     # Workflow testing
     complete_purchase_journey,  # End-to-end purchase flow
     return_process_journey,     # Product return workflow
@@ -647,30 +667,30 @@ def analyze_test_results(orchestration_result):
     print("="*60)
     print("COMPREHENSIVE TEST ANALYSIS")
     print("="*60)
-    
+
     print(f"Total Executions: {orchestration_result.total_executions}")
     print(f"Success Rate: {orchestration_result.success_rate:.1f}%")
     print(f"Average Execution Time: {orchestration_result.average_execution_time:.2f}s")
-    
+
     # Performance metrics
     if orchestration_result.metadata.get('performance_stats'):
         stats = orchestration_result.metadata['performance_stats']
         print(f"Peak Response Time: {stats.get('peak_response_time', 'N/A')}")
         print(f"95th Percentile: {stats.get('p95_response_time', 'N/A')}")
-    
+
     # Geographic distribution (if applicable)
     if orchestration_result.metadata.get('distribution_stats'):
         dist = orchestration_result.metadata['distribution_stats']
         print("Geographic Distribution:")
         for location, count in dist.get('location_usage', {}).items():
             print(f"  {location}: {count} executions")
-    
+
     # Error analysis
     if orchestration_result.errors:
         print(f"\nErrors Encountered: {len(orchestration_result.errors)}")
         for i, error in enumerate(orchestration_result.errors[:5], 1):
             print(f"  {i}. {error}")
-    
+
     print("="*60)
 
 # Use with any orchestration result

{scythe_ttp-0.11.0 → scythe_ttp-0.12.1}/README.md

@@ -122,6 +122,26 @@ file_upload_ttp = FileUploadTTP(
 
 ### Installation
 
+#### If you would like to use as a library:
+
+setup the virtual environment
+```bash
+python3 -m venv venv
+
+# source the venv
+# bash,zsh: source venv/bin/activate
+# fish: source venv/bin/activate.fish
+```
+
+install the package
+```bash
+# in an activated venv
+
+pip3 install scythe-ttp
+```
+
+#### If you would like like to contribute:
+
 1. Clone the repository:
    ```bash
    git clone https://github.com/EpykLab/scythe.git
@@ -411,11 +431,11 @@ from scythe.core.executor import TTPExecutor
 class MyTTP(TTP):
     def get_payloads(self):
         yield "test_payload"
-    
+
     def execute_step(self, driver, payload):
         driver.get("http://your-app.com/login")
         # ... test logic ...
-    
+
     def verify_result(self, driver):
         return "welcome" in driver.page_source
 
@@ -476,7 +496,7 @@ from typing import Generator, Any
 
 class CustomBusinessLogicTTP(TTP):
     """Test specific business logic under adverse conditions."""
-    
+
     def __init__(self, business_scenarios: list, expected_result: bool = True):
         super().__init__(
             name="Business Logic Test",
@@ -484,28 +504,28 @@ class CustomBusinessLogicTTP(TTP):
             expected_result=expected_result
         )
         self.scenarios = business_scenarios
-    
+
     def get_payloads(self) -> Generator[Any, None, None]:
         for scenario in self.scenarios:
             yield scenario
-    
+
     def execute_step(self, driver, payload):
         # Implement your specific business logic testing
         # This could involve API calls, database interactions, etc.
         pass
-    
+
     def verify_result(self, driver) -> bool:
         # Verify the business logic behaved correctly
         return self.check_business_rules(driver)
 
 class CustomWorkflowAction(Action):
     """Custom action for specific workflow steps."""
-    
+
     def __init__(self, workflow_step: str, parameters: dict):
         super().__init__(f"Custom {workflow_step}", f"Execute {workflow_step}")
         self.workflow_step = workflow_step
         self.parameters = parameters
-    
+
     def execute(self, driver, context):
         # Implement custom workflow logic
         return self.perform_workflow_step(driver, context)
@@ -522,12 +542,12 @@ ecommerce_suite = [
     payment_security_test,      # Test payment form security
     user_data_protection_test,  # Test PII protection
     session_management_test,    # Test session security
-    
+
     # Load testing
     product_catalog_load_test,  # High-traffic product browsing
     checkout_process_load_test, # Concurrent checkout processes
     search_functionality_test,  # Search under load
-    
+
     # Workflow testing
     complete_purchase_journey,  # End-to-end purchase flow
     return_process_journey,     # Product return workflow
@@ -600,30 +620,30 @@ def analyze_test_results(orchestration_result):
     print("="*60)
     print("COMPREHENSIVE TEST ANALYSIS")
     print("="*60)
-    
+
     print(f"Total Executions: {orchestration_result.total_executions}")
     print(f"Success Rate: {orchestration_result.success_rate:.1f}%")
     print(f"Average Execution Time: {orchestration_result.average_execution_time:.2f}s")
-    
+
     # Performance metrics
     if orchestration_result.metadata.get('performance_stats'):
         stats = orchestration_result.metadata['performance_stats']
         print(f"Peak Response Time: {stats.get('peak_response_time', 'N/A')}")
         print(f"95th Percentile: {stats.get('p95_response_time', 'N/A')}")
-    
+
     # Geographic distribution (if applicable)
     if orchestration_result.metadata.get('distribution_stats'):
         dist = orchestration_result.metadata['distribution_stats']
         print("Geographic Distribution:")
         for location, count in dist.get('location_usage', {}).items():
             print(f"  {location}: {count} executions")
-    
+
     # Error analysis
     if orchestration_result.errors:
         print(f"\nErrors Encountered: {len(orchestration_result.errors)}")
         for i, error in enumerate(orchestration_result.errors[:5], 1):
             print(f"  {i}. {error}")
-    
+
     print("="*60)
 
 # Use with any orchestration result
@@ -724,4 +744,4 @@ This architecture supports testing scenarios from simple security checks to comp
 
 ---
 
-**Scythe**: Comprehensive adverse conditions testing for robust, reliable systems.
+**Scythe**: Comprehensive adverse conditions testing for robust, reliable systems.

scythe_ttp-0.12.1/VERSION

@@ -0,0 +1 @@
+0.12.2

{scythe_ttp-0.11.0 → scythe_ttp-0.12.1}/scythe/core/headers.py

@@ -8,23 +8,23 @@ from selenium.webdriver.chrome.options import Options
 class HeaderExtractor:
     """
     Utility class for extracting HTTP response headers from WebDriver sessions.
-    
+
     Specifically designed to capture the X-SCYTHE-TARGET-VERSION header
     that indicates the version of the web application being tested.
     """
-    
-    SCYTHE_VERSION_HEADER = "X-SCYTHE-TARGET-VERSION"
-    
+
+    SCYTHE_VERSION_HEADER = "X-Scythe-Target-Version"
+
     def __init__(self):
         self.logger = logging.getLogger("HeaderExtractor")
-    
+
     @staticmethod
     def enable_logging_for_driver(chrome_options: Options) -> None:
         """
         Enable performance logging capabilities for Chrome WebDriver.
-        
+
         This must be called during WebDriver setup to capture network logs.
-        
+
         Args:
             chrome_options: Chrome options object to modify
         """
@@ -32,15 +32,15 @@ class HeaderExtractor:
         chrome_options.add_argument("--enable-logging")
         chrome_options.add_argument("--log-level=0")
         chrome_options.set_capability("goog:loggingPrefs", {"performance": "ALL"})
-    
+
     def extract_target_version(self, driver: WebDriver, target_url: Optional[str] = None) -> Optional[str]:
         """
         Extract the X-SCYTHE-TARGET-VERSION header from the most recent HTTP response.
-        
+
         Args:
             driver: WebDriver instance with performance logging enabled
             target_url: Optional URL to filter responses for (if None, uses any response)
-            
+
         Returns:
             Version string if header found, None otherwise
         """
@@ -49,77 +49,77 @@ class HeaderExtractor:
             if not hasattr(driver, 'get_log'):
                 self.logger.warning("WebDriver does not support get_log method")
                 return None
-            
+
             logs = getattr(driver, 'get_log')('performance')
-            
+
             # Look for Network.responseReceived events
             for log_entry in reversed(logs):  # Start with most recent
                 try:
                     message = log_entry.get('message', {})
                     if isinstance(message, str):
                         message = json.loads(message)
-                    
+
                     method = message.get('message', {}).get('method', '')
                     params = message.get('message', {}).get('params', {})
-                    
+
                     if method == 'Network.responseReceived':
                         response = params.get('response', {})
                         headers = response.get('headers', {})
                         response_url = response.get('url', '')
-                        
+
                         # Filter by target URL if specified
                         if target_url and target_url not in response_url:
                             continue
-                        
+
                         # Look for the version header (case-insensitive)
                         version = self._find_version_header(headers)
                         if version:
                             self.logger.debug(f"Found target version '{version}' in response from {response_url}")
                             return version
-                            
+
                 except (json.JSONDecodeError, KeyError, AttributeError) as e:
                     self.logger.debug(f"Error parsing log entry: {e}")
                     continue
-            
+
             self.logger.debug("No X-SCYTHE-TARGET-VERSION header found in network logs")
             return None
-            
+
         except Exception as e:
             self.logger.warning(f"Failed to extract target version from logs: {e}")
             return None
-    
+
     def _find_version_header(self, headers: Dict[str, Any]) -> Optional[str]:
         """
         Find the version header in a case-insensitive manner.
-        
+
         Args:
             headers: Dictionary of HTTP headers
-            
+
         Returns:
             Version string if found, None otherwise
         """
         # Check for exact case match first
         if self.SCYTHE_VERSION_HEADER in headers:
             return str(headers[self.SCYTHE_VERSION_HEADER]).strip()
-        
+
         # Check case-insensitive
         header_lower = self.SCYTHE_VERSION_HEADER.lower()
         for header_name, header_value in headers.items():
             if header_name.lower() == header_lower:
                 return str(header_value).strip()
-        
+
         return None
-    
+
     def extract_all_headers(self, driver: WebDriver, target_url: Optional[str] = None) -> Dict[str, str]:
         """
         Extract all headers from the most recent HTTP response.
-        
+
         Useful for debugging or when additional headers might be needed.
-        
+
         Args:
             driver: WebDriver instance with performance logging enabled
             target_url: Optional URL to filter responses for
-            
+
         Returns:
             Dictionary of headers from the most recent response
         """
@@ -128,67 +128,67 @@ class HeaderExtractor:
             if not hasattr(driver, 'get_log'):
                 self.logger.warning("WebDriver does not support get_log method")
                 return {}
-            
+
             logs = getattr(driver, 'get_log')('performance')
-            
+
             for log_entry in reversed(logs):
                 try:
                     message = log_entry.get('message', {})
                     if isinstance(message, str):
                         message = json.loads(message)
-                    
+
                     method = message.get('message', {}).get('method', '')
                     params = message.get('message', {}).get('params', {})
-                    
+
                     if method == 'Network.responseReceived':
                         response = params.get('response', {})
                         headers = response.get('headers', {})
                         response_url = response.get('url', '')
-                        
+
                         # Filter by target URL if specified
                         if target_url and target_url not in response_url:
                             continue
-                        
+
                         # Convert all header values to strings
                         return {k: str(v) for k, v in headers.items()}
-                        
+
                 except (json.JSONDecodeError, KeyError, AttributeError):
                     continue
-            
+
             return {}
-            
+
         except Exception as e:
             self.logger.warning(f"Failed to extract headers from logs: {e}")
             return {}
-    
+
     def get_version_summary(self, results: list) -> Dict[str, Any]:
         """
         Analyze version information across multiple test results.
-        
+
         Args:
             results: List of result dictionaries containing version information
-            
+
         Returns:
             Dictionary with version analysis summary
         """
         versions = []
         results_with_version = 0
-        
+
         for result in results:
             version = result.get('target_version')
             if version:
                 versions.append(version)
                 results_with_version += 1
-        
+
         summary = {
             'total_results': len(results),
             'results_with_version': results_with_version,
             'unique_versions': list(set(versions)) if versions else [],
             'version_counts': {}
         }
-        
+
         # Count occurrences of each version
         for version in versions:
             summary['version_counts'][version] = summary['version_counts'].get(version, 0) + 1
-        
-        return summary
+
+        return summary

{scythe_ttp-0.11.0 → scythe_ttp-0.12.1/scythe_ttp.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scythe-ttp
-Version: 0.11.0
+Version: 0.12.1
 Summary: An extensible framework for emulating attacker TTPs with Selenium.
 Home-page: https://github.com/EpykLab/scythe
 Author: EpykLab
@@ -169,6 +169,26 @@ file_upload_ttp = FileUploadTTP(
 
 ### Installation
 
+#### If you would like to use as a library:
+
+setup the virtual environment
+```bash
+python3 -m venv venv
+
+# source the venv
+# bash,zsh: source venv/bin/activate
+# fish: source venv/bin/activate.fish
+```
+
+install the package
+```bash
+# in an activated venv
+
+pip3 install scythe-ttp
+```
+
+#### If you would like like to contribute:
+
 1. Clone the repository:
    ```bash
    git clone https://github.com/EpykLab/scythe.git
@@ -458,11 +478,11 @@ from scythe.core.executor import TTPExecutor
 class MyTTP(TTP):
     def get_payloads(self):
         yield "test_payload"
-    
+
     def execute_step(self, driver, payload):
         driver.get("http://your-app.com/login")
         # ... test logic ...
-    
+
     def verify_result(self, driver):
         return "welcome" in driver.page_source
 
@@ -523,7 +543,7 @@ from typing import Generator, Any
 
 class CustomBusinessLogicTTP(TTP):
     """Test specific business logic under adverse conditions."""
-    
+
     def __init__(self, business_scenarios: list, expected_result: bool = True):
         super().__init__(
             name="Business Logic Test",
@@ -531,28 +551,28 @@ class CustomBusinessLogicTTP(TTP):
             expected_result=expected_result
         )
         self.scenarios = business_scenarios
-    
+
     def get_payloads(self) -> Generator[Any, None, None]:
         for scenario in self.scenarios:
             yield scenario
-    
+
     def execute_step(self, driver, payload):
         # Implement your specific business logic testing
         # This could involve API calls, database interactions, etc.
         pass
-    
+
     def verify_result(self, driver) -> bool:
         # Verify the business logic behaved correctly
         return self.check_business_rules(driver)
 
 class CustomWorkflowAction(Action):
     """Custom action for specific workflow steps."""
-    
+
     def __init__(self, workflow_step: str, parameters: dict):
         super().__init__(f"Custom {workflow_step}", f"Execute {workflow_step}")
         self.workflow_step = workflow_step
         self.parameters = parameters
-    
+
     def execute(self, driver, context):
         # Implement custom workflow logic
         return self.perform_workflow_step(driver, context)
@@ -569,12 +589,12 @@ ecommerce_suite = [
     payment_security_test,      # Test payment form security
     user_data_protection_test,  # Test PII protection
     session_management_test,    # Test session security
-    
+
     # Load testing
     product_catalog_load_test,  # High-traffic product browsing
     checkout_process_load_test, # Concurrent checkout processes
     search_functionality_test,  # Search under load
-    
+
     # Workflow testing
     complete_purchase_journey,  # End-to-end purchase flow
     return_process_journey,     # Product return workflow
@@ -647,30 +667,30 @@ def analyze_test_results(orchestration_result):
     print("="*60)
     print("COMPREHENSIVE TEST ANALYSIS")
     print("="*60)
-    
+
     print(f"Total Executions: {orchestration_result.total_executions}")
     print(f"Success Rate: {orchestration_result.success_rate:.1f}%")
     print(f"Average Execution Time: {orchestration_result.average_execution_time:.2f}s")
-    
+
     # Performance metrics
     if orchestration_result.metadata.get('performance_stats'):
         stats = orchestration_result.metadata['performance_stats']
         print(f"Peak Response Time: {stats.get('peak_response_time', 'N/A')}")
         print(f"95th Percentile: {stats.get('p95_response_time', 'N/A')}")
-    
+
     # Geographic distribution (if applicable)
     if orchestration_result.metadata.get('distribution_stats'):
         dist = orchestration_result.metadata['distribution_stats']
         print("Geographic Distribution:")
         for location, count in dist.get('location_usage', {}).items():
             print(f"  {location}: {count} executions")
-    
+
     # Error analysis
     if orchestration_result.errors:
         print(f"\nErrors Encountered: {len(orchestration_result.errors)}")
         for i, error in enumerate(orchestration_result.errors[:5], 1):
             print(f"  {i}. {error}")
-    
+
     print("="*60)
 
 # Use with any orchestration result

{scythe_ttp-0.11.0 → scythe_ttp-0.12.1}/setup.py

@@ -8,7 +8,7 @@ with open("./requirements.txt", "r", encoding="utf-8") as f:
 
 setuptools.setup(
     name="scythe-ttp",
-    version="0.11.0",
+    version="0.12.1",
     author="EpykLab",
     author_email="cyber@epyklab.com",
     description="An extensible framework for emulating attacker TTPs with Selenium.",

scythe_ttp-0.11.0/VERSION

@@ -1 +0,0 @@
-0.12.1