scythe-ttp 0.16.1__py3-none-any.whl → 0.17.1__py3-none-any.whl

scythe/cli/main.py

@@ -68,6 +68,19 @@ def check_version_in_response_header(args) -> bool:
 def scythe_test_definition(args) -> bool:
     # TODO: implement your test using Scythe primitives.
     # Example placeholder that simply passes.
+    
+    # Example usage with TTPExecutor:
+    # from scythe.core.executor import TTPExecutor
+    # executor = TTPExecutor(ttp=my_ttp, target_url=args.url)
+    # executor.run()
+    # return executor.was_successful()  # Returns True if all results matched expectations
+    
+    # Example usage with JourneyExecutor:
+    # from scythe.journeys.executor import JourneyExecutor
+    # executor = JourneyExecutor(journey=my_journey, target_url=args.url)
+    # executor.run()
+    # return executor.was_successful()  # Returns True if journey succeeded as expected
+    
     return True
 
 
@@ -83,6 +96,138 @@ def main():
         dest='gate_versions',
         help='Gate versions to test against')
 
+    # Core Application Parameters
+    parser.add_argument(
+        '--protocol',
+        default='https',
+        choices=['http', 'https'],
+        help='Protocol to use (http/https, default: https)')
+    parser.add_argument(
+        '--port',
+        type=int,
+        help='Port number for the target application')
+
+    # Authentication Parameters
+    parser.add_argument(
+        '--username',
+        help='Username for authentication')
+    parser.add_argument(
+        '--password',
+        help='Password for authentication')
+    parser.add_argument(
+        '--token',
+        help='Bearer token or API key')
+    parser.add_argument(
+        '--auth-type',
+        choices=['basic', 'bearer', 'form'],
+        help='Authentication method (basic, bearer, form, etc.)')
+    parser.add_argument(
+        '--credentials-file',
+        help='Path to file containing multiple user credentials')
+
+    # Test Data Parameters
+    parser.add_argument(
+        '--users-file',
+        help='Path to CSV file containing user data')
+    parser.add_argument(
+        '--emails-file',
+        help='Path to text file containing email addresses')
+    parser.add_argument(
+        '--payload-file',
+        help='Path to file containing test payloads')
+    parser.add_argument(
+        '--data-file',
+        help='Generic path to test data file')
+
+    # Execution Control Parameters
+    parser.add_argument(
+        '--batch-size',
+        type=int,
+        default=10,
+        help='Number of operations per batch (default: 10)')
+    parser.add_argument(
+        '--max-batches',
+        type=int,
+        help='Maximum number of batches to run')
+    parser.add_argument(
+        '--workers',
+        type=int,
+        help='Number of concurrent workers/threads')
+    parser.add_argument(
+        '--replications',
+        type=int,
+        help='Number of test replications for load testing')
+    parser.add_argument(
+        '--timeout',
+        type=int,
+        help='Request timeout in seconds')
+    parser.add_argument(
+        '--delay',
+        type=float,
+        help='Delay between requests in seconds')
+
+    # Browser/Execution Parameters
+    parser.add_argument(
+        '--headless',
+        action='store_true',
+        help='Run browser in headless mode (flag)')
+    parser.add_argument(
+        '--browser',
+        choices=['chrome', 'firefox', 'safari', 'edge'],
+        help='Browser type (chrome, firefox, etc.)')
+    parser.add_argument(
+        '--user-agent',
+        help='Custom user agent string')
+    parser.add_argument(
+        '--proxy',
+        help='Proxy server URL')
+    parser.add_argument(
+        '--proxy-file',
+        help='Path to file containing proxy list')
+
+    # Output and Reporting Parameters
+    parser.add_argument(
+        '--output-dir',
+        help='Directory for output files')
+    parser.add_argument(
+        '--report-format',
+        choices=['json', 'csv', 'html'],
+        help='Report format (json, csv, html)')
+    parser.add_argument(
+        '--log-level',
+        choices=['debug', 'info', 'warning', 'error'],
+        help='Logging level (debug, info, warning, error)')
+    parser.add_argument(
+        '--verbose',
+        action='store_true',
+        help='Enable verbose output (flag)')
+    parser.add_argument(
+        '--silent',
+        action='store_true',
+        help='Suppress output except errors (flag)')
+
+    # Test Control Parameters
+    parser.add_argument(
+        '--fail-fast',
+        action='store_true',
+        help='Stop immediately on first failure (flag)')
+    parser.add_argument(
+        '--dry-run',
+        action='store_true',
+        help='Validate configuration without executing tests (flag)')
+    parser.add_argument(
+        '--test-type',
+        choices=['load', 'security', 'functional'],
+        help='Type of test to run (load, security, functional)')
+    parser.add_argument(
+        '--iterations',
+        type=int,
+        help='Number of test iterations')
+    parser.add_argument(
+        '--duration',
+        type=int,
+        help='Test duration in seconds')
+
     args = parser.parse_args()
 
     if check_url_available(args.url):

scythe/core/executor.py

@@ -40,6 +40,7 @@ class TTPExecutor:
         self.driver = None
         self.results = []
         self.header_extractor = HeaderExtractor()
+        self.has_test_failures = False  # Track if any test had unexpected results
 
     def _setup_driver(self):
         """Initializes the WebDriver."""
@@ -134,10 +135,12 @@ class TTPExecutor:
                         else:
                             version_info = f" | Version: {target_version}" if target_version else ""
                             self.logger.warning(f"UNEXPECTED SUCCESS: '{payload}' (expected to fail){version_info}")
+                            self.has_test_failures = True  # Mark as failure when result differs from expected
                     else:
                         consecutive_failures += 1
                         if self.ttp.expected_result:
                             self.logger.info(f"EXPECTED FAILURE: '{payload}' (security control working)")
+                            self.has_test_failures = True  # Mark as failure when result differs from expected
                         else:
                             self.logger.info(f"EXPECTED FAILURE: '{payload}'")
 
@@ -212,3 +215,18 @@ class TTPExecutor:
                 self.logger.info("No successes detected (expected to find vulnerabilities).")
             else:
                 self.logger.info("No successes detected (security controls working as expected).")
+        
+        # Log overall test status
+        if self.has_test_failures:
+            self.logger.error("\n✗ TEST FAILED: One or more test results differed from expected")
+        else:
+            self.logger.info("\n✓ TEST PASSED: All test results matched expectations")
+    
+    def was_successful(self) -> bool:
+        """
+        Check if all test results matched expectations.
+        
+        Returns:
+            True if all test results matched expectations, False otherwise
+        """
+        return not self.has_test_failures

scythe/journeys/executor.py

@@ -406,6 +406,12 @@ class JourneyExecutor:
         else:
             self.logger.info("\nNo X-SCYTHE-TARGET-VERSION headers detected in responses.")
         
+        # Log overall test status (similar to TTPExecutor)
+        if self.was_successful():
+            self.logger.info("\n✓ TEST PASSED: Journey results matched expectations")
+        else:
+            self.logger.error("\n✗ TEST FAILED: Journey results differed from expected")
+        
         self.logger.info("="*60)
     
     def get_results(self) -> Optional[Dict[str, Any]]:

{scythe_ttp-0.16.1.dist-info → scythe_ttp-0.17.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scythe-ttp
-Version: 0.16.1
+Version: 0.17.1
 Summary: An extensible framework for emulating attacker TTPs with Selenium.
 Author-email: EpykLab <cyber@epyklab.com>
 Classifier: Programming Language :: Python :: 3
@@ -35,6 +35,7 @@ Requires-Dist: urllib3==2.4.0
 Requires-Dist: websocket-client==1.8.0
 Requires-Dist: wsproto==1.2.0
 Requires-Dist: typer
+Requires-Dist: shellingham
 Dynamic: license-file
 
 <h1 align="center">Scythe</h1>

{scythe_ttp-0.16.1.dist-info → scythe_ttp-0.17.1.dist-info}/RECORD

@@ -11,15 +11,15 @@ scythe/behaviors/human.py,sha256=1PqYvE7cnxlj-KDmDIr3uzfWHvDAbbxQxJ0V0iTl9yo,102
 scythe/behaviors/machine.py,sha256=NDMUq3mDhpCvujzAFxhn2eSVq78-J-LSBhIcvHkzKXo,4624
 scythe/behaviors/stealth.py,sha256=xv7MrPQgRCdCUJyYTcXV2aasWZoAw8rAQWg-AuQVb7U,15278
 scythe/cli/__init__.py,sha256=9EVxmFiWsAoqWJ6br1bc3BxlA71JyOQP28fUHhX2k7E,43
-scythe/cli/main.py,sha256=-PXmdzYzlS5KWndVd35CoxAK17wxfLEmF_KUotJrHc0,21373
+scythe/cli/main.py,sha256=DFvOB39tX4FeiOxitJwXfq28J13GjewBZ9gOA_0HOjI,26003
 scythe/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scythe/core/executor.py,sha256=x1w2nByVu2G70sh7t0kOh6urlrTm_r_pbk0S7v1Ov28,9736
+scythe/core/executor.py,sha256=C3FkW-DNugv82T0_ky-3zAvHV_hFwVSHrX2nzgAcmAI,10588
 scythe/core/headers.py,sha256=AokCQ3F5QGUcfoK7iO57hA1HHL4IznZeWV464_MqYcE,16670
 scythe/core/ttp.py,sha256=Xw9GgptYsjZ-pMLdyPv64bhiwGKobrXHdF32pjIY7OU,3102
 scythe/journeys/__init__.py,sha256=Odi8NhRg7Hefmo1EJj1guakrCSPhsuus4i-_62uUUjs,654
 scythe/journeys/actions.py,sha256=k9WjfGR1nhJWyhDU_lHr7vFy5qAl7hyyV6kCL7ZQRMo,37479
 scythe/journeys/base.py,sha256=vXIgEnSW__iYTriBbuMG4l_XCM96xojJH_fyFScKoBY,24969
-scythe/journeys/executor.py,sha256=_q2hzl4G9iv07I6NVMtNaK3O8QGLDwLNMiaxIle-nsY,24654
+scythe/journeys/executor.py,sha256=uJkjO3PALSLZh3IOSxgX18gRJX_Bck3gW9OClusiQeE,24949
 scythe/orchestrators/__init__.py,sha256=_vemcXjKbB1jI0F2dPA0F1zNsyUekjcXImLDUDhWDN0,560
 scythe/orchestrators/base.py,sha256=YOZV0ewlzJ49H08P_LKnimutUms8NnDrQprFpSKhOeM,13595
 scythe/orchestrators/batch.py,sha256=FpK501kk-earJzz6v7dcuw2y708rTvt_IMH_5qjKdrc,26635
@@ -32,9 +32,9 @@ scythe/ttps/web/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scythe/ttps/web/login_bruteforce.py,sha256=D4G8zB_nU9LD5w3Vv2ABTuOl4XTeg2BgZwYMObt4JJw,2488
 scythe/ttps/web/sql_injection.py,sha256=aWk4DFePbtFDsieOOj03Ux-5OiykyOs2_d_3SvWMOVE,2910
 scythe/ttps/web/uuid_guessing.py,sha256=JwNt_9HVynMWFPPU6UGJFcpxvMVDsvc_wAnJVtcYbps,1235
-scythe_ttp-0.16.1.dist-info/licenses/LICENSE,sha256=B7iB4Fv6zDQolC7IgqNF8F4GEp_DLe2jrPPuR_MYMOM,1064
-scythe_ttp-0.16.1.dist-info/METADATA,sha256=LxmrtQniVraYXKXFAlrTE66DYvHC-vGQNp6Wk6HmCDA,30161
-scythe_ttp-0.16.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scythe_ttp-0.16.1.dist-info/entry_points.txt,sha256=rAAsFBcCm0OX3I4uRyclfx4YJGoTuumZKY43HN7R5Ro,48
-scythe_ttp-0.16.1.dist-info/top_level.txt,sha256=BCKTrPuVvmLyhOR07C1ggOh6sU7g2LoVvwDMn46O55Y,7
-scythe_ttp-0.16.1.dist-info/RECORD,,
+scythe_ttp-0.17.1.dist-info/licenses/LICENSE,sha256=B7iB4Fv6zDQolC7IgqNF8F4GEp_DLe2jrPPuR_MYMOM,1064
+scythe_ttp-0.17.1.dist-info/METADATA,sha256=bZTf4pApqa3-NNPv6PkktiBPKSgiOOhjv0a7DJmn7To,30188
+scythe_ttp-0.17.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scythe_ttp-0.17.1.dist-info/entry_points.txt,sha256=rAAsFBcCm0OX3I4uRyclfx4YJGoTuumZKY43HN7R5Ro,48
+scythe_ttp-0.17.1.dist-info/top_level.txt,sha256=BCKTrPuVvmLyhOR07C1ggOh6sU7g2LoVvwDMn46O55Y,7
+scythe_ttp-0.17.1.dist-info/RECORD,,