mantis_api_client 5.3.0__tar.gz → 5.4.0__tar.gz

{mantis_api_client-5.3.0 → mantis_api_client-5.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mantis_api_client
-Version: 5.3.0
+Version: 5.4.0
 Summary: M&NTIS Platform client API
 License: MIT
 Author: AMOSSYS

{mantis_api_client-5.3.0 → mantis_api_client-5.4.0}/mantis_api_client/cli_parser/account_parser.py

@@ -32,7 +32,7 @@ from mantis_api_client.utils import colored
 class Version:
     def __init__(self, str_vers: str) -> None:
         try:
-            self.major, self.minor, self.patch = str_vers.split(".")
+            self.major, self.minor, self.patch = str_vers.split(".", 2)
         except Exception as e:
             raise Exception(
                 "Bad version format for '{}': 'X.Y.Z' expected. Error: {}".format(
@@ -123,6 +123,31 @@ def status_handler(args: Any) -> None:  # noqa: C901
                 )
             )
 
+    # User API
+    print("  [+] Backoffice API")
+    print("    [+] address: {}".format(mantis_api_client_config.user_api_url))
+    try:
+        user_api_version = user_api.get_version()
+        user_vers = Version(str_vers=user_api_version)
+    except requests.exceptions.ConnectionError:
+        exit_code = 1
+        print("    [-] API status: " + colored("not running !", "white", "on_red"))
+    else:
+        print("    [+] API status: " + colored("OK", "grey", "on_green"))
+        print("    [+] version: {}".format(user_api_version))
+        if user_vers.major != client_vers.major:
+            exit_code = 1
+            print(
+                "    [-] "
+                + colored(
+                    "Error: User API major version ({}) mismatchs with mantis_api_client major version ({})".format(
+                        user_vers.major, client_vers.major
+                    ),
+                    "white",
+                    "on_red",
+                )
+            )
+
     if exit_code != 0:
         sys.exit(exit_code)
 
@@ -144,25 +169,42 @@ def info_handler(args: Any) -> None:  # noqa: C901
     access_token = jwt.get_unverified_claims(active_tokens["access_token"])
     id_token = jwt.get_unverified_claims(active_tokens["id_token"])
 
-    user_groups = id_token.get("groups")
-
+    sub_orgs = user_api.fetch_current_seats()
+    sub_membership: dict[str, list[dict]] = {}
+    sub_default_ws = get_oidc_client().get_default_workspace()
     # Handle case where the user pertains to an organization
-    if user_groups is not None:
-        default_group = get_oidc_client().get_default_workspace()
-        groups_comma_sep = ", ".join(user_groups)
-        if default_group:
-            # mark default group bold
-            groups_comma_sep = groups_comma_sep.replace(
-                default_group, f"[bold]{default_group}[/bold]"
-            )
+    if sub_orgs:
+        sub_wss = user_api.fetch_current_workspaces()
+        for sub_org in sub_orgs:
+            sub_org_wss: list[dict] = []
+            sub_membership[sub_org["name"]] = sub_org_wss
+            for sub_ws in sub_wss:
+                if sub_org["id"] == sub_ws["organization_id"]:
+                    sub_org_wss.append(sub_ws)
 
     sorted_scopes = ", ".join(sorted(access_token["scope"].split()))
 
     print(f"[+] Connected to {active_profile_domain}")
     print(f"  [+] Username: {id_token['preferred_username']}")
     print(f"  [+] Email: {id_token.get('email', 'N/A')}")
-    if user_groups is not None:
-        rprint(rf"  \[+] Group membership: {groups_comma_sep}")
+    if sub_orgs:
+
+        def hl_activated_ws(ws: dict) -> str:
+            if ws["id"] == sub_default_ws:
+                return f"[bold]{ws['name']}[/bold]"
+            return ws["name"]
+
+        rprint(
+            r"  \[+] Organization membership: {}".format(
+                ", ".join(
+                    "{} ({})".format(
+                        org,
+                        ", ".join(map(hl_activated_ws, org_wss)),
+                    )
+                    for org, org_wss in sub_membership.items()
+                )
+            )
+        )
     print(f"  [+] Scopes: {sorted_scopes}")
 
 

{mantis_api_client-5.3.0 → mantis_api_client-5.4.0}/mantis_api_client/cli_parser/attack_parser.py

@@ -95,7 +95,7 @@ def _attack_create_or_run_lab(args: Any, do_run: bool = True):
 
     # Retrieve associated group id
     if workspace_id is None:
-        print(colored("Your subscription level does not permit to launch labs", "red"))
+        print(colored("You have to specify a workspace with --workspace", "yellow"))
         sys.exit(1)
 
     # Safety checks
@@ -246,7 +246,7 @@ def add_attack_parser(root_parser: argparse.ArgumentParser, subparsers: Any) ->
         help="Allows to define the unit scenario to create_lab for a unit attack",
     )
     parser_attack_create_lab.add_argument(
-        "--workspace_id",
+        "--workspace",
         dest="workspace_id",
         help="The group name that have ownership on lab",
     )
@@ -280,7 +280,7 @@ def add_attack_parser(root_parser: argparse.ArgumentParser, subparsers: Any) ->
         help="Allows to define the unit scenario to run for a unit attack",
     )
     parser_attack_run_lab.add_argument(
-        "--workspace_id",
+        "--workspace",
         dest="workspace_id",
         help="The group name that have ownership on lab",
     )

{mantis_api_client-5.3.0 → mantis_api_client-5.4.0}/mantis_api_client/cli_parser/bas_parser.py

@@ -13,7 +13,6 @@ from mantis_scenario_model.api_scenario_model import LabListReply
 from mantis_scenario_model.lab_config_model import ContentType
 from mantis_scenario_model.lab_config_model import LabConfig
 from mantis_scenario_model.lab_model import Lab
-from mantis_scenario_model.lab_model import ScenarioExecutionStatus
 
 from cr_api_client import redteam_api
 from mantis_api_client import scenario_api
@@ -113,7 +112,6 @@ def bas_create_handler(args: Any) -> None:
             wait_lab(
                 lab_id,
                 quiet=True,
-                exit_on_status=[ScenarioExecutionStatus.scenario_execution],
             )
 
     except Exception as e:
@@ -129,7 +127,7 @@ def bas_create_handler(args: Any) -> None:
         unset_current_lab()
 
     print(
-        f"[hint] You can retrieve BAS agent download URLs with: '$ mantis bas info {lab_id}'"
+        f"[hint] Once an agent has been executed, retrieve its session with: '$ mantis bas info {lab_id}'"
     )
 
 
@@ -239,7 +237,7 @@ def show_available_attacks(session_id: str, filter_tactic: str, filter_technique
     for attack in attacks:
 
         # Check if the attack is runnable
-        if attack["status"] != "runnable":
+        if attack["status"] not in ["runnable", "failed"]:
             continue
 
         # Check if the attack is BAS compatible
@@ -308,8 +306,14 @@ def show_available_attacks(session_id: str, filter_tactic: str, filter_technique
         )
         mitre_attack_infos = f"{technique_id} [{mitre_attack_tactics}]"
 
+        # Retrieve potential attack parameters that user can control
+        parameters = ""
+        attack_info = scenario_api.fetch_attack_by_name(attack['worker']['name'])
+        if attack_info.options:
+            parameters = f" - \033[1mparameters\033[0m: {', '.join(attack_info.options)}"
+
         print(
-            f"  - \033[1mattack_name\033[0m: {attack['worker']['name']:<30} - \033[1mATT&CK\033[0m: {mitre_attack_infos:<18} - \033[1mdescription\033[0m: {attack['worker']['title']} - \033[1mattack_parameters\033[0m:{attack_values}"
+            f"  - \033[1mname\033[0m: {attack['worker']['name']:<30} - \033[1mATT&CK\033[0m: {mitre_attack_infos:<18} - \033[1mdescription\033[0m: {attack['worker']['title']:<30} - \033[1mvalues\033[0m:{attack_values}{parameters}"
         )
 
 
@@ -523,6 +527,15 @@ def bas_attack_run_handler(args: Any) -> None:
 
     params = parse_vars(params)
 
+    # Retrieve potential attack parameters that user can control, and
+    # check that the attack accepts those parameters
+    attack_info = scenario_api.fetch_attack_by_name(attack_name)
+
+    for key in params.keys():
+        if key not in attack_info.options:
+            print(colored(f"Parameter '{key}' is not in the supported parameter list. Supported parameters are: {', '.join(attack_info.options)}", "red"))
+            sys.exit(1)
+
     # Retrieve matching bas lab
     lab_id = find_bas_lab_from_session_id(session_id)
 
@@ -687,7 +700,7 @@ def add_bas_parser(root_parser: argparse.ArgumentParser, subparsers: Any) -> Non
     )
     parser_bas_create.set_defaults(func=bas_create_handler)
     parser_bas_create.add_argument(
-        "--workspace_id",
+        "--workspace",
         dest="workspace_id",
         help="The workspace ID on which you want to create the BAS lab infrastructure",
     )

{mantis_api_client-5.3.0 → mantis_api_client-5.4.0}/mantis_api_client/cli_parser/basebox_parser.py

@@ -90,7 +90,7 @@ def _basebox_create_or_run_lab(args: Any, do_run: bool = True):
 
     # Retrieve associated group id
     if workspace_id is None:
-        print(colored("Your subscription level does not permit to launch labs", "red"))
+        print(colored("You have to specify a workspace with --workspace", "yellow"))
         sys.exit(1)
 
     # Manage lab configuration
@@ -203,7 +203,7 @@ def add_basebox_parser(
         help="Do not keep the lab up after basebox execution (False by default)",
     )
     parser_basebox_create_lab.add_argument(
-        "--workspace_id",
+        "--workspace",
         dest="workspace_id",
         help="The group ID that have ownership on lab",
     )
@@ -230,7 +230,7 @@ def add_basebox_parser(
         help="Do not keep the lab up after basebox execution (False by default)",
     )
     parser_basebox_run_lab.add_argument(
-        "--workspace_id",
+        "--workspace",
         dest="workspace_id",
         help="The group ID that have ownership on lab",
     )

{mantis_api_client-5.3.0 → mantis_api_client-5.4.0}/mantis_api_client/cli_parser/scenario_parser.py

@@ -95,7 +95,7 @@ def _scenario_create_or_run_lab(args: Any, do_run: bool = True):
 
     # Retrieve associated group id
     if workspace_id is None:
-        print(colored("Your subscription level does not permit to launch labs", "red"))
+        print(colored("You have to specify a workspace with --workspace", "yellow"))
         sys.exit(1)
 
     # Manage lab configuration
@@ -226,7 +226,7 @@ def add_scenario_parser(
         "scenario_name", type=str, help="The scenario name"
     )
     parser_scenario_create_lab.add_argument(
-        "--workspace_id",
+        "--workspace",
         dest="workspace_id",
         help="The group ID that have ownership on lab",
     )
@@ -263,7 +263,7 @@ def add_scenario_parser(
         "scenario_name", type=str, help="The scenario name"
     )
     parser_scenario_run_lab.add_argument(
-        "--workspace_id",
+        "--workspace",
         dest="workspace_id",
         help="The group ID that have ownership on lab",
     )

{mantis_api_client-5.3.0 → mantis_api_client-5.4.0}/mantis_api_client/cli_parser/topology_parser.py

@@ -82,7 +82,7 @@ def _topology_create_or_run_lab(args: Any, do_run: bool = True):
 
     # Retrieve associated group id
     if workspace_id is None:
-        print(colored("Your subscription level does not permit to launch labs", "red"))
+        print(colored("You have to specify a workspace with --workspace", "yellow"))
         sys.exit(1)
 
     # Manage lab configuration
@@ -198,7 +198,7 @@ def add_topology_parser(
         help="Do not keep the lab up after topology execution (False by default)",
     )
     parser_topology_create_lab.add_argument(
-        "--workspace_id",
+        "--workspace",
         dest="workspace_id",
         help="The group ID that have ownership on lab",
     )
@@ -227,7 +227,7 @@ def add_topology_parser(
         help="Do not keep the lab up after topology execution (False by default)",
     )
     parser_topology_run_lab.add_argument(
-        "--workspace_id",
+        "--workspace",
         dest="workspace_id",
         help="The group ID that have ownership on lab",
     )

{mantis_api_client-5.3.0 → mantis_api_client-5.4.0}/mantis_api_client/user_api.py

@@ -75,14 +75,14 @@ def _handle_error(
 
 def get_version() -> str:
     """
-    Return publish API version.
+    Return User API version.
 
     :return: The version number is a string
     """
     result = authorize(_get)("/version")
 
     if result.status_code != 200:
-        _handle_error(result, "Cannot retrieve scenario API version")
+        _handle_error(result, "Cannot retrieve User API version")
 
     return result.json()
 

{mantis_api_client-5.3.0 → mantis_api_client-5.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mantis_api_client"
-version = "5.3.0"
+version = "5.4.0"
 description = "M&NTIS Platform client API"
 readme = "README.md"
 authors = ["AMOSSYS"]