mantis_api_client 5.5.0__py3-none-any.whl

mantis_api_client/user_api.py

@@ -0,0 +1,282 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from typing import Any
+
+import requests
+
+from mantis_api_client.config import mantis_api_client_config
+from mantis_api_client.oidc import authorize
+
+# -------------------------------------------------------------------------- #
+# Internal helpers
+# -------------------------------------------------------------------------- #
+
+
+def _get(route: str, **kwargs: Any) -> requests.Response:
+    return requests.get(
+        f"{mantis_api_client_config.user_api_url}{route}",
+        verify=mantis_api_client_config.cacert,
+        cert=(mantis_api_client_config.cert, mantis_api_client_config.key),
+        **kwargs,
+    )
+
+
+def _post(route: str, **kwargs: Any) -> requests.Response:
+    return requests.post(
+        f"{mantis_api_client_config.user_api_url}{route}",
+        verify=mantis_api_client_config.cacert,
+        cert=(mantis_api_client_config.cert, mantis_api_client_config.key),
+        **kwargs,
+    )
+
+
+def _put(route: str, **kwargs: Any) -> requests.Response:
+    return requests.put(
+        f"{mantis_api_client_config.user_api_url}{route}",
+        verify=mantis_api_client_config.cacert,
+        cert=(mantis_api_client_config.cert, mantis_api_client_config.key),
+        **kwargs,
+    )
+
+
+def _delete(route: str, **kwargs: Any) -> requests.Response:
+    return requests.delete(
+        f"{mantis_api_client_config.user_api_url}{route}",
+        verify=mantis_api_client_config.cacert,
+        cert=(mantis_api_client_config.cert, mantis_api_client_config.key),
+        **kwargs,
+    )
+
+
+def _handle_error(
+    result: requests.Response, context_error_msg: str
+) -> requests.Response:
+    error_msg = ""
+    if result.headers.get("content-type") == "application/json":
+        error_data = result.json()
+        for k in ("message", "detail"):
+            if k in error_data:
+                error_msg = error_data[k]
+                break
+    if not error_msg:
+        error_msg = result.text
+
+    raise Exception(
+        f"{context_error_msg}. "
+        f"Status code: '{result.status_code}'.\n"
+        f"Error message: '{error_msg}'."
+    )
+
+
+# -------------------------------------------------------------------------- #
+# Internal helpers
+# -------------------------------------------------------------------------- #
+
+
+def get_version() -> str:
+    """
+    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 User API version")
+
+    return result.json()
+
+
+# -------------------------------------------------------------------------- #
+# User API (users)
+# -------------------------------------------------------------------------- #
+
+
+# def fetch_users() -> Any:
+#     """Fetch users of the current organization."""
+#     result = authorize(_get)("/users")
+
+#     if result.status_code != 200:
+#         _handle_error(result, "Cannot retrieve user list from User API")
+#     else:
+#         data = result.json()
+
+#     return data
+
+
+def fetch_current_user() -> Any:
+    """Fetch current user information."""
+    result = authorize(_get)("/my/self")
+
+    if result.status_code != 200:
+        _handle_error(result, "Cannot retrieve current user from User API")
+    else:
+        data = result.json()
+
+    return data
+
+
+def fetch_user(user_id: str) -> Any:
+    """Fetch information for a specific user."""
+    result = authorize(_get)(f"/users/{user_id}")
+
+    if result.status_code != 200:
+        _handle_error(
+            result,
+            f"Cannot retrieve user info for user_id '{user_id}' from User API",
+        )
+    else:
+        data = result.json()
+
+    return data
+
+
+# -------------------------------------------------------------------------- #
+# User API (seats)
+# -------------------------------------------------------------------------- #
+
+
+def fetch_current_seats() -> Any:
+    """Fetch seats of the current user."""
+    result = authorize(_get)("/my/organizations")
+
+    if result.status_code != 200:
+        _handle_error(result, "Cannot retrieve current seat from User API")
+    else:
+        data = result.json()
+
+    return data
+
+
+def fetch_current_workspaces() -> list:
+    """Fetch workspaces of the current user."""
+    result = authorize(_get)("/my/workspaces")
+
+    if result.status_code != 200:
+        _handle_error(result, "Cannot retrieve current workspaces from User API")
+    else:
+        data = result.json()
+
+    return data
+
+
+# -------------------------------------------------------------------------- #
+# User API (organizations)
+# -------------------------------------------------------------------------- #
+
+
+def fetch_organization(organization_id: str) -> Any:
+    """Fetch information for a specific organization."""
+    result = authorize(_get)(f"/organizations/{organization_id}")
+
+    if result.status_code != 200:
+        _handle_error(
+            result,
+            f"Cannot retrieve organization for organization_id {organization_id} from User API",
+        )
+    else:
+        data = result.json()
+
+    return data
+
+
+def get_organization_workspaces(organization_id: str) -> list[dict]:
+    """Retrieve workspaces from an organization ID."""
+
+    result = authorize(_get)(f"/organization/{organization_id}/workspaces")
+
+    if result.status_code != 200:
+        _handle_error(
+            result,
+            f"Cannot retrieve workspaces from organization ID '{organization_id}' from User API",
+        )
+    else:
+        data = result.json()
+
+    return data
+
+
+def get_plan(plan_id: str) -> dict:
+    """Retrieve plan information for a specific plan ID."""
+
+    result = authorize(_get)(f"/plans/{plan_id}")
+
+    if result.status_code != 200:
+        _handle_error(
+            result,
+            f"Cannot retrieve plan info for plan ID '{plan_id}' from User API",
+        )
+    else:
+        data = result.json()
+
+    return data
+
+
+def get_plan_limits(plan_id: str) -> dict:
+    """Retrieve plan limits for a specific plan ID."""
+
+    result = authorize(_get)(f"/plans/{plan_id}/limits")
+
+    if result.status_code != 200:
+        _handle_error(
+            result,
+            f"Cannot retrieve plan limits for plan ID '{plan_id}' from User API",
+        )
+    else:
+        data = result.json()
+
+    return data
+
+
+def get_credits_list(organization_id: str) -> dict:
+    """Retrieve credits list for a specific organization ID."""
+
+    result = authorize(_get)(
+        "/credits",
+        params={"organization_id": organization_id},
+    )
+
+    if result.status_code != 200:
+        _handle_error(
+            result,
+            f"Cannot retrieve credits list for organization ID '{organization_id}' from User API",
+        )
+    else:
+        data = result.json()
+
+    return data
+
+
+def get_consumption_history(organization_id: str) -> dict:
+    """Retrieve consumption history for a specific organization ID."""
+
+    result = authorize(_get)(
+        "/history",
+        params={"organization_id": organization_id},
+    )
+
+    if result.status_code != 200:
+        _handle_error(
+            result,
+            f"Cannot retrieve consumption history for organization ID '{organization_id}' from User API",
+        )
+    else:
+        data = result.json()
+
+    return data
+
+
+def get_subject_roles() -> dict[str, list[dict]]:
+    """Retrieve subject roles."""
+
+    result = authorize(_get)("/my/roles")
+
+    if result.status_code != "200":
+        _handle_error(
+            result,
+            "Cannot retrieve subject roles from User API",
+        )
+    else:
+        data = result.json()
+
+    return data

mantis_api_client/utils.py

@@ -0,0 +1,130 @@
+# -*- coding: utf-8 -*-
+import json
+import time
+from datetime import datetime
+from typing import Dict
+from typing import List
+from typing import Optional
+
+from alive_progress import alive_bar
+from mantis_scenario_model.lab_model import ScenarioExecutionStatus
+from urllib3.exceptions import NewConnectionError
+
+from mantis_api_client import scenario_api
+
+try:
+    from colorama import init
+    from termcolor import colored
+
+    HAS_COLOUR = True
+except ImportError:
+    HAS_COLOUR = False
+
+# Initialize colorama
+if HAS_COLOUR:
+    init(autoreset=True)
+else:
+    # Override colored function to return first argument
+    def colored(text: object, *args: Any, **kwargs: Any) -> str:  # type: ignore # noqa
+        return str(text)
+
+
+def wait_lab(
+    lab_id: str,
+    quiet: bool = False,
+    exit_on_status: Optional[List[ScenarioExecutionStatus]] = None,
+) -> None:
+    """
+    - exit_on_status: allow to break the wait loop if current status matches one of the
+    """
+
+    if exit_on_status is None:
+        exit_on_status = []
+
+    notifications_output: List[Dict[str, str]] = []
+
+    if not quiet:
+        print("[+] Notifications:")
+
+    with alive_bar(
+        refresh_secs=0.08,
+        spinner=None,
+        enrich_print=False,
+        stats=False,
+        monitor=False,
+        theme="classic",
+    ) as bar:
+        nb_requests_failed = 0
+        while True:
+            in_error = False
+
+            time.sleep(1)
+
+            # Retrieve current lab status and associated
+            # notifications. Only display error message if it occurs
+            # multiple times.
+            try:
+                lab = scenario_api.fetch_lab(lab_id)
+            except NewConnectionError as e:
+                in_error = True
+                nb_requests_failed += 1
+                if nb_requests_failed > 10:
+                    print(e)
+            except Exception as e:
+                in_error = True
+                nb_requests_failed += 1
+                if nb_requests_failed > 10:
+                    print(e)
+
+            # Exit in case of multiple failures when fetching lab status
+            if nb_requests_failed > 10:
+                break
+
+            if in_error:
+                continue
+
+            if not quiet:
+                # Retrieve lab notifications
+                notifications = scenario_api.fetch_lab_notifications(lab_id)
+
+                # Only display new notifications
+                new_output = notifications[len(notifications_output) :]
+                for event in new_output:
+                    event = json.loads(event)
+                    data = event["event_data"]
+                    iso_str = event["event_datetime"]
+                    dtime = datetime.fromisoformat(iso_str).strftime(
+                        "%Y-%m-%d %H:%M:%S"
+                    )
+                    print(f"⚡ {dtime} UTC - {data}")
+                notifications_output = notifications
+
+            # Display current macro step (deploy, provisioning, attack, etc.)
+            if "status" in lab:
+                bar.text(lab["status"])
+                if lab["status"].rstrip() == "PAUSE":
+                    with bar.pause():
+                        print("Press Enter to continue the scenario...")
+                        input()
+                        scenario_api.resume_lab(lab_id)
+                        lab = scenario_api.fetch_lab(lab_id)
+            else:
+                bar()
+
+            # Condition to break loop: the scenario execution
+            # has finished, either because it has been cancelled or
+            # because it has successfully finished
+            if "status" in lab and lab["status"] in [
+                ScenarioExecutionStatus.scenario_finished.value,
+                ScenarioExecutionStatus.completed.value,
+                ScenarioExecutionStatus.cancelled.value,
+                ScenarioExecutionStatus.error.value,
+            ]:
+                break
+
+            # Exit on specific statuses decided by the current function caller
+            if "status" in lab and lab["status"] in [s.value for s in exit_on_status]:
+                break
+
+    if not quiet:
+        print("[+] Lab content has been completed")

mantis_api_client-5.5.0.dist-info/AUTHORS

@@ -0,0 +1 @@
+Created by Amossys <contact@amossys.fr>

mantis_api_client-5.5.0.dist-info/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016-2021 AMOSSYS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mantis_api_client-5.5.0.dist-info/METADATA

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: mantis_api_client
+Version: 5.5.0
+Summary: M&NTIS Platform client API
+License: MIT
+Author: AMOSSYS
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: alive-progress (>=3.1.5,<4.0.0)
+Requires-Dist: argcomplete (>=1.12.1,<1.13.0)
+Requires-Dist: colorama (>=0.4.4,<0.5.0)
+Requires-Dist: cr-api-client (>=5.0.26,<6.0.0)
+Requires-Dist: mantis-authz (>=0.2.3,<1.0.0)
+Requires-Dist: mantis-catalog (>=0.1.2,<0.2.0)
+Requires-Dist: mantis-logger (>=0.2.0,<0.3.0)
+Requires-Dist: mantis-models (>=3.4.11,<4.0.0)
+Requires-Dist: omegaconf (>=2.2.2,<3.0.0)
+Requires-Dist: pydantic (>=2.10.3,<3.0.0)
+Requires-Dist: requests (>=2.24.0,<3.0.0)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Requires-Dist: rich_argparse (>=1.5.2,<2.0.0)
+Requires-Dist: ruamel-yaml (>=0.16.10,<0.17.0)
+Requires-Dist: ruamel.yaml (>=0.16.10,<0.17.0)
+Requires-Dist: termcolor (>=1.1.0,<1.2.0)
+Description-Content-Type: text/markdown
+
+# M&NTIS Platform client API
+

mantis_api_client-5.5.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+mantis_api_client/__init__.py,sha256=a0qcQBVKkpnLmwNU6jpqAPYR0_9rDCg-8seK-9uu1AY,581
+mantis_api_client/cli_parser/account_parser.py,sha256=wUosGQ8Jadnjd_526kLRgxVIJZx4MULO4fbLBpnOTJk,15369
+mantis_api_client/cli_parser/attack_parser.py,sha256=ol0biecEO0yOx6RvYWoHTBCf3LMa9wrBVYQjlSkhmQo,10143
+mantis_api_client/cli_parser/bas_parser.py,sha256=T7ARupf5-KaE7R-CsBtgf2Y15rkv2aR1g47wpm1wfHQ,39484
+mantis_api_client/cli_parser/basebox_parser.py,sha256=56ZvZe96TZm44wHd9lCmkOq_Dvi7-PmsTUYl1e8HtnY,8267
+mantis_api_client/cli_parser/dataset_parser.py,sha256=T4e7lN6Qh6FryKtb-DzNj0dO-jiC5sgMBxVT3b1I8G0,6469
+mantis_api_client/cli_parser/lab_parser.py,sha256=5lV5ESqtj0yz4PUb85O0ANx2z7JbzAYAhMKMYxvUJTU,24542
+mantis_api_client/cli_parser/labs_parser.py,sha256=HcC_gCCd7okHU6pjZaHZOhU7vpfBjXQub6WQeL4AOeE,3057
+mantis_api_client/cli_parser/log_collector_parser.py,sha256=MtWJLiI_64B306qgLIs9oPwywYcF_ndulykyMtdvTy0,2316
+mantis_api_client/cli_parser/redteam_parser.py,sha256=go0dBgWVrRnqOyJ0sfaX5FfqSlQfq-qvNl-nAOifUJE,11187
+mantis_api_client/cli_parser/scenario_parser.py,sha256=axlTdcwWp3x9N_ZvhWfPOD9W42gmnhct1l9_2lQzfA4,9918
+mantis_api_client/cli_parser/signature_parser.py,sha256=XIRu4MSfVbrmS2-gMP0Vi63Fp0HTX5z4yHcgs0gmhqg,4774
+mantis_api_client/cli_parser/topology_parser.py,sha256=Opvk02bG_8slkCWNSf9hLofklXcDH9w4G5D8Wz9Uke8,7919
+mantis_api_client/cli_parser/user_parser.py,sha256=oa414THhg8HWetDYCMs3_XHTKBPpe3UnH5bTBWZ066Y,7256
+mantis_api_client/config.py,sha256=eCXId_C0Xe-KAey8irnN4Dk8FCGmppL1XqguuvLdn04,2588
+mantis_api_client/dataset_api.py,sha256=n30NjHOc7OnbX_p1sFAFgvKCbTYHoFR0sxIkmeVYaNc,9008
+mantis_api_client/exceptions.py,sha256=EbfPig5Mu0aa8iqqILmOIjbfcFm3nfUhebeNYbHGe68,1187
+mantis_api_client/mantis.py,sha256=f0LTOM8XdzXWePUPhZmn9sseLgly50GrrLOfTb5485w,5949
+mantis_api_client/oidc.py,sha256=-H3-hlWbS7N44ZbgQvf6fkLFyzovaMTCaKQS5OCetYE,10756
+mantis_api_client/scenario_api.py,sha256=es7btbpVkfIMnVmtNqSSLhuSwNEfxov6nfwoSYkrgTc,31306
+mantis_api_client/user_api.py,sha256=IXJ3sOlWPgWJUhfV08qsWO7dIfUDdIbDTAGOjRx-gxY,7588
+mantis_api_client/utils.py,sha256=d5TxLzofDcK4WbgTrm8mz5_M9Wvuq-ANgsjZIhbzQIU,4182
+mantis_api_client-5.5.0.dist-info/AUTHORS,sha256=cZG0yas_cZYZStWPnFCG3wL9kNtihpB7rONDqqOhCk8,40
+mantis_api_client-5.5.0.dist-info/LICENSE,sha256=8sBbPetGUTlhPzK-BXmdnV_hadvwFxL77L4WsghguvI,1056
+mantis_api_client-5.5.0.dist-info/METADATA,sha256=pLixUQ828NKxK54fFXVo-Yehan_3HKexi4OLxSILgQQ,1242
+mantis_api_client-5.5.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+mantis_api_client-5.5.0.dist-info/entry_points.txt,sha256=h3Qq03yHa0O9niMtTDGIj7hE2SqXbZBR3Bt7kkQSIJs,56
+mantis_api_client-5.5.0.dist-info/RECORD,,

mantis_api_client-5.5.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any

mantis_api_client-5.5.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+mantis=mantis_api_client.mantis:main
+