scythe-ttp 0.17.5__py3-none-any.whl → 0.17.7__py3-none-any.whl

scythe/cli/main.py

@@ -68,20 +68,46 @@ 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)
+    # from scythe.ttps.web.login_bruteforce import LoginBruteforceTTP
+    #
+    # ttp = LoginBruteforceTTP(
+    #     payloads=['admin', 'root', 'test'],
+    #     expected_result=False  # Expect security controls to block attempts
+    # )
+    # executor = TTPExecutor(ttp=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)
+    # from scythe.journeys.base import Journey, Step
+    # from scythe.journeys.actions import NavigateAction, FillFormAction, ClickAction
+    #
+    # journey = Journey(
+    #     name="Login Journey",
+    #     description="Test user login flow",
+    #     expected_result=True  # Expect journey to succeed
+    # )
+    # journey.add_step(Step("Navigate").add_action(NavigateAction(url=args.url)))
+    # executor = JourneyExecutor(journey=journey, target_url=args.url)
     # executor.run()
     # return executor.was_successful()  # Returns True if journey succeeded as expected
-    
-    return True
+
+    # Example usage with Orchestrators:
+    # from scythe.orchestrators.scale import ScaleOrchestrator
+    # from scythe.orchestrators.base import OrchestrationStrategy
+    #
+    # orchestrator = ScaleOrchestrator(
+    #     strategy=OrchestrationStrategy.PARALLEL,
+    #     max_workers=10
+    # )
+    # result = orchestrator.orchestrate_ttp(ttp=my_ttp, target_url=args.url, replications=100)
+    # return orchestrator.exit_code(result) == 0  # Returns True if all executions succeeded
+
+    return executor.exit_code() # assumes executor var
 
 
 def main():
@@ -233,14 +259,14 @@ def main():
     if check_url_available(args.url):
         if args.gate_versions:
             if check_version_in_response_header(args):
-                ok = scythe_test_definition(args)
-                sys.exit(0 if ok else 1)
+                exit_code = scythe_test_definition(args)
+                sys.exit(exit_code)
             else:
                 print("No compatible version found in response header.")
                 sys.exit(1)
         else:
-            ok = scythe_test_definition(args)
-            sys.exit(0 if ok else 1)
+            exit_code = scythe_test_definition(args)
+            sys.exit(exit_code)
     else:
         print("URL not available.")
         sys.exit(1)
@@ -254,6 +280,13 @@ class ScytheCLIError(Exception):
     pass
 
 
+class ExitWithCode(Exception):
+    """Exception to exit with a specific code from within Typer commands."""
+    def __init__(self, code: int):
+        self.code = code
+        super().__init__()
+
+
 def _find_project_root(start: Optional[str] = None) -> Optional[str]:
     """Walk upwards from start (or cwd) to find a directory containing .scythe."""
     cur = os.path.abspath(start or os.getcwd())
@@ -702,7 +735,10 @@ def main(argv: Optional[List[str]] = None) -> int:
         code, output, version = _run_test(project_root, name, extra)
         _record_run(project_root, name, code, output, version)
         print(output)
-        return code
+        # Raise exception to propagate exit code through Typer
+        if code != 0:
+            raise ExitWithCode(code)
+        return 0
 
     db_app = typer.Typer(
         no_args_is_help=True,
@@ -737,8 +773,10 @@ def main(argv: Optional[List[str]] = None) -> int:
     app.add_typer(db_app, name="db")
 
     try:
-        rv = app()
-        return int(rv) if isinstance(rv, int) else 0
+        app()
+        return 0
+    except ExitWithCode as e:
+        return e.code
     except ScytheCLIError as e:
         print(f"Error: {e}", file=sys.stderr)
         return 2

scythe/core/executor.py

@@ -344,3 +344,12 @@ class TTPExecutor:
             True if all test results matched expectations, False otherwise
         """
         return not self.has_test_failures
+    
+    def exit_code(self) -> int:
+        """
+        Get the exit code for this test execution.
+        
+        Returns:
+            0 if test was successful (results matched expectations), 1 otherwise
+        """
+        return 0 if self.was_successful() else 1

scythe/journeys/executor.py

@@ -463,6 +463,15 @@ class JourneyExecutor:
         actual = self.execution_results.get('overall_success', False)
         expected = self.execution_results.get('expected_result', True)
         return actual == expected
+    
+    def exit_code(self) -> int:
+        """
+        Get the exit code for this journey execution.
+        
+        Returns:
+            0 if journey was successful (results matched expectations), 1 otherwise
+        """
+        return 0 if self.was_successful() else 1
 
 
 class JourneyRunner:

scythe/orchestrators/base.py

@@ -281,6 +281,24 @@ class Orchestrator(ABC):
                 self.logger.warning(f"  ... and {len(result.errors) - 3} more errors")
         
         self.logger.info("="*60)
+    
+    def exit_code(self, result: OrchestrationResult) -> int:
+        """
+        Get the exit code for an orchestration result.
+        
+        An orchestration is considered successful if all executions completed
+        successfully (matching their expected results).
+        
+        Args:
+            result: OrchestrationResult to evaluate
+            
+        Returns:
+            0 if all executions were successful, 1 otherwise
+        """
+        # Check if any executions failed or if there were errors
+        if result.failed_executions > 0 or len(result.errors) > 0:
+            return 1
+        return 0
 
 
 class ExecutionContext:

{scythe_ttp-0.17.5.dist-info → scythe_ttp-0.17.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scythe-ttp
-Version: 0.17.5
+Version: 0.17.7
 Summary: An extensible framework for emulating attacker TTPs with Selenium.
 Author-email: EpykLab <cyber@epyklab.com>
 Classifier: Programming Language :: Python :: 3

{scythe_ttp-0.17.5.dist-info → scythe_ttp-0.17.7.dist-info}/RECORD

@@ -11,17 +11,17 @@ 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=DFvOB39tX4FeiOxitJwXfq28J13GjewBZ9gOA_0HOjI,26003
+scythe/cli/main.py,sha256=4Hcx0TkuTMC3gX3Z7k8ZgusW5TfbeJaCJpvczqu9LVU,27481
 scythe/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scythe/core/executor.py,sha256=FTuhvWiNOsN1LZ4scEsVGDXx9D3yF3tiAoDt-HW2QRI,16038
+scythe/core/executor.py,sha256=F8r_t5vSvsxNuUFx-Y0JzSe051cj_w42iyZrS7wocb4,16306
 scythe/core/headers.py,sha256=AokCQ3F5QGUcfoK7iO57hA1HHL4IznZeWV464_MqYcE,16670
 scythe/core/ttp.py,sha256=tEYIhDdr8kcwQrlcfVmdeLFiAfOvc0BhPOVxPh8TiWo,5676
 scythe/journeys/__init__.py,sha256=Odi8NhRg7Hefmo1EJj1guakrCSPhsuus4i-_62uUUjs,654
 scythe/journeys/actions.py,sha256=URr53p1GQxSIBZo0IubchQ1dlfvnPHgCtmkRfLSoi7A,40333
 scythe/journeys/base.py,sha256=vXIgEnSW__iYTriBbuMG4l_XCM96xojJH_fyFScKoBY,24969
-scythe/journeys/executor.py,sha256=uJkjO3PALSLZh3IOSxgX18gRJX_Bck3gW9OClusiQeE,24949
+scythe/journeys/executor.py,sha256=wSAFFU9qwyYA2Q_5TZBUDgafVb1slwvj0VNJ7cR46FE,25223
 scythe/orchestrators/__init__.py,sha256=_vemcXjKbB1jI0F2dPA0F1zNsyUekjcXImLDUDhWDN0,560
-scythe/orchestrators/base.py,sha256=YOZV0ewlzJ49H08P_LKnimutUms8NnDrQprFpSKhOeM,13595
+scythe/orchestrators/base.py,sha256=oZ68VmX18mBITvFUXfHJYvIE20PCfEAKrsikdr6_0Qg,14219
 scythe/orchestrators/batch.py,sha256=FpK501kk-earJzz6v7dcuw2y708rTvt_IMH_5qjKdrc,26635
 scythe/orchestrators/distributed.py,sha256=ts19NZzPfr0ouFbUFrktPO-iL5jBNB57mcOh0eDJDmE,33554
 scythe/orchestrators/scale.py,sha256=l2-4U6ISeBDBZz7CG6ef9W-zyF6LiAM4uXXKlfczLB0,21394
@@ -32,9 +32,9 @@ scythe/ttps/web/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scythe/ttps/web/login_bruteforce.py,sha256=ybmN2Vl9-p58YbOchirY1193GvlaTmUTW1qlluN_l3I,7816
 scythe/ttps/web/sql_injection.py,sha256=rIRHaRUilSrMA5q5MO1RqR6-TM_fRIiCanPaFz5wKKs,11712
 scythe/ttps/web/uuid_guessing.py,sha256=JwNt_9HVynMWFPPU6UGJFcpxvMVDsvc_wAnJVtcYbps,1235
-scythe_ttp-0.17.5.dist-info/licenses/LICENSE,sha256=B7iB4Fv6zDQolC7IgqNF8F4GEp_DLe2jrPPuR_MYMOM,1064
-scythe_ttp-0.17.5.dist-info/METADATA,sha256=ipDl_VEN5UOjhta5W1YdPcMlGE0p5-QXhs4_CjZ-DhI,30188
-scythe_ttp-0.17.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scythe_ttp-0.17.5.dist-info/entry_points.txt,sha256=rAAsFBcCm0OX3I4uRyclfx4YJGoTuumZKY43HN7R5Ro,48
-scythe_ttp-0.17.5.dist-info/top_level.txt,sha256=BCKTrPuVvmLyhOR07C1ggOh6sU7g2LoVvwDMn46O55Y,7
-scythe_ttp-0.17.5.dist-info/RECORD,,
+scythe_ttp-0.17.7.dist-info/licenses/LICENSE,sha256=B7iB4Fv6zDQolC7IgqNF8F4GEp_DLe2jrPPuR_MYMOM,1064
+scythe_ttp-0.17.7.dist-info/METADATA,sha256=pgGUSFXUFO_HBHx1OqyLlOZDZQhDTsgoNKB5QJYw2iM,30188
+scythe_ttp-0.17.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scythe_ttp-0.17.7.dist-info/entry_points.txt,sha256=rAAsFBcCm0OX3I4uRyclfx4YJGoTuumZKY43HN7R5Ro,48
+scythe_ttp-0.17.7.dist-info/top_level.txt,sha256=BCKTrPuVvmLyhOR07C1ggOh6sU7g2LoVvwDMn46O55Y,7
+scythe_ttp-0.17.7.dist-info/RECORD,,