howler-api 3.2.0.dev585__tar.gz → 3.2.0.dev595__tar.gz

{howler_api-3.2.0.dev585 → howler_api-3.2.0.dev595}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 3.2.0.dev585
+Version: 3.2.0.dev595
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs
@@ -29,7 +29,7 @@ Requires-Dist: elasticsearch (==8.19.3)
 Requires-Dist: flasgger (>=0.9.7.1,<0.10.0.0)
 Requires-Dist: flask (==3.1.3)
 Requires-Dist: flask-caching (==2.3.1)
-Requires-Dist: gevent (==23.9.1)
+Requires-Dist: gevent (>=25.9.1,<26.0.0)
 Requires-Dist: gunicorn (==23.0.0)
 Requires-Dist: luqum (>=1.0.0,<2.0.0)
 Requires-Dist: mergedeep (>=1.3.4,<2.0.0)

{howler_api-3.2.0.dev585 → howler_api-3.2.0.dev595}/howler/actions/demote.py

@@ -9,7 +9,7 @@ from howler.odm.models.howler_data import (
     Assessment,
     AssessmentEscalationMap,
     Escalation,
-    HitStatus,
+    Status,
 )
 from howler.odm.models.user import User
 from howler.utils.str_utils import sanitize_lucene_query
@@ -96,7 +96,7 @@ def execute(
                         "howler.assignment",
                         user.get("uname", "automation") if user else "automation",
                     ),
-                    odm_helper.update("howler.status", HitStatus.RESOLVED),
+                    odm_helper.update("howler.status", Status.RESOLVED),
                 ],
             )
 

{howler_api-3.2.0.dev585 → howler_api-3.2.0.dev595}/howler/actions/transition.py

@@ -8,8 +8,8 @@ from howler.helper.workflow import Workflow, WorkflowException
 from howler.odm.models.action import VALID_TRIGGERS
 from howler.odm.models.howler_data import (
     Assessment,
-    HitStatus,
     HitStatusTransition,
+    Status,
     Vote,
 )
 from howler.odm.models.user import User
@@ -180,15 +180,13 @@ def specification():
         "steps": [
             {
                 "args": {"status": []},
-                "options": {"status": HitStatus.list()},
+                "options": {"status": Status.list()},
                 "validation": {"error": {"query": "-howler.status:$status"}},
             },
             {
                 "args": {"transition": []},
                 "options": {
-                    "transition": {
-                        f"status:{status}": hit_service.get_transitions(status) for status in HitStatus.list()
-                    },
+                    "transition": {f"status:{status}": hit_service.get_transitions(status) for status in Status.list()},
                 },
             },
             {

{howler_api-3.2.0.dev585 → howler_api-3.2.0.dev595}/howler/api/__init__.py

@@ -24,7 +24,8 @@ logger = get_logger(__file__)
 
 def make_subapi_blueprint(name, api_version=1):
     """Create a flask Blueprint for a subapi in a standard way."""
-    return Blueprint(name, name, url_prefix="/".join([API_PREFIX, f"v{api_version}", name]))
+    full_name = f"v{api_version}_{name}"
+    return Blueprint(full_name, full_name, url_prefix="/".join([API_PREFIX, f"v{api_version}", name]))
 
 
 def _make_api_response(

howler_api-3.2.0.dev595/howler/api/v1/__init__.py

@@ -0,0 +1,44 @@
+from flask import Blueprint
+
+from howler.api import ok
+from howler.security import api_login
+from howler.services import docs_service
+
+API_PREFIX = "/api/v1"
+apiv1 = Blueprint("apiv1", __name__, url_prefix=API_PREFIX)
+apiv1._doc = "Api Documentation Version 1"  # type: ignore[attr-defined] # type: ignore
+
+
+@apiv1.route("/")
+@api_login(audit=False, required_priv=["R", "W"], required_type=["user", "admin"])
+def get_api_documentation(**kwargs):
+    """Full API doc.
+
+    Loop through all registered API paths and display their documentation.
+    Returns a list of API definition.
+
+    Variables:
+    None
+
+    Arguments:
+    None
+
+    Result Example:
+    [
+        {
+            'name': "Api Doc",                  # Name of the api
+            'path': "/api/path/<variable>/",    # API path
+            'ui_only': false,                   # Is UI only API
+            'methods': ["GET", "POST"],         # Allowed HTTP methods
+            'description': "API doc.",          # API documentation
+            'id': "api_doc",                    # Unique ID for the API
+            'function': "apiv1.api_doc",        # Function called in the code
+            'protected': False,                 # Does the API require login?
+            'required_type': ['user'],           # Type of users allowed to use API
+            'complete' : True                   # Is the API stable?
+        },
+    ]
+    """
+    user_types = kwargs["user"]["type"]
+
+    return ok(docs_service.build_route_docs("v1", user_types))

{howler_api-3.2.0.dev585 → howler_api-3.2.0.dev595}/howler/api/v1/action.py

@@ -231,8 +231,7 @@ def execute_action(id: str, **kwargs) -> Response:
     if not isinstance(execute_req, dict):
         return bad_request(err="Incorrect data structure!")
 
-    action: Action = datastore().action.get(id)
-
+    action = datastore().action.get(id)
     if not action:
         return not_found(err="The specified action does not exist")
 

{howler_api-3.2.0.dev585 → howler_api-3.2.0.dev595}/howler/api/v1/analytic.py

@@ -15,11 +15,9 @@ from howler.common.exceptions import HowlerException
 from howler.common.loader import datastore
 from howler.common.logging import get_logger
 from howler.common.swagger import generate_swagger_docs
-from howler.cronjobs.rules import register_rules
 from howler.datastore.exceptions import DataStoreException
 from howler.datastore.operations import OdmHelper
 from howler.odm.models.analytic import Analytic, Comment, Notebook, TriageOptions
-from howler.odm.models.template import Template
 from howler.odm.models.user import User
 from howler.security import api_login
 from howler.services import analytic_service, user_service
@@ -104,7 +102,8 @@ def update_analytic(id: str, user: User, **kwargs):
     """
     storage = datastore()
 
-    if not storage.analytic.exists(id):
+    existing_analytic = storage.analytic.get(id)
+    if not existing_analytic:
         return not_found(err="This analytic does not exist")
 
     new_data = request.json
@@ -113,8 +112,6 @@ def update_analytic(id: str, user: User, **kwargs):
         return bad_request(err="You must provide updated data.")
 
     try:
-        existing_analytic: Analytic = storage.analytic.get_if_exists(id)
-
         existing_analytic.description = new_data.get("description", existing_analytic.description)
 
         if existing_analytic.triage_settings is not None:
@@ -126,21 +123,8 @@ def update_analytic(id: str, user: User, **kwargs):
             {**existing_triage_data, **new_data.get("triage_settings", {})}
         )
 
-        updated_rule = False
-        if existing_analytic.rule_type:
-            updated_rule = existing_analytic.rule != new_data.get(
-                "rule", existing_analytic.rule
-            ) or existing_analytic.rule_crontab != new_data.get("rule_crontab", existing_analytic.rule_crontab)
-
-            existing_analytic.rule = new_data.get("rule", existing_analytic.rule)
-            existing_analytic.rule_crontab = new_data.get("rule_crontab", existing_analytic.rule_crontab)
-
         storage.analytic.save(existing_analytic.analytic_id, existing_analytic)
 
-        if updated_rule:
-            # The registration process automatically deletes and resets the rule cronjob
-            register_rules(existing_analytic)
-
         return ok(existing_analytic)
     except HowlerException as e:
         return bad_request(err=str(e))
@@ -169,62 +153,7 @@ def create_rule(user: User, **kwargs):
         ...analytic     # The created analytic rule
     }
     """
-    storage = datastore()
-
-    new_data: Optional[dict[str, Any]] = request.json
-
-    if not new_data:
-        return bad_request(err="You must provide rule data.")
-
-    required_keys = {
-        "name",
-        "description",
-        "rule",
-        "rule_type",
-        "rule_crontab",
-    }
-
-    for key in required_keys:
-        if key not in new_data or not new_data[key]:
-            return bad_request(err=f"You must provide a {key} for your rule.")
-
-    extra_keys = set(new_data.keys()) - required_keys
-
-    if len(extra_keys) > 0:
-        return bad_request(err=f"Additional fields ({', '.join(extra_keys)}) are not permitted.")
-
-    new_analytic = Analytic(
-        {
-            **new_data,
-            "tags": ["rule"],
-            "owner": user["uname"],
-            "contributors": [user["uname"]],
-            "detections": ["Rule"],
-        }
-    )
-
-    new_template = Template(
-        {
-            "analytic": new_data["name"],
-            "detection": "Rule",
-            "type": "global",
-            "owner": user["uname"],
-            # TODO: Allow custom keys
-            "keys": ["event.kind", "event.module", "event.reason", "event.type"],
-        }
-    )
-
-    try:
-        storage.analytic.save(new_analytic.analytic_id, new_analytic)
-        # Have to commit so the analytic is available during registration
-        storage.analytic.commit()
-        register_rules(new_analytic)
-
-        storage.template.save(new_template.template_id, new_template)
-
-        return ok(new_analytic)
-    except HowlerException as e:
-        return bad_request(err=str(e))
+    raise NotImplementedError()
 
 
 @generate_swagger_docs()
@@ -248,23 +177,7 @@ def delete_rule(id: str, user: User, **kwargs):
     {
     }
     """
-    if not analytic_service.does_analytic_exist(id):
-        return not_found(err=f"Analytic {id} does not exist")
-
-    analytic = analytic_service.get_analytic(id, as_odm=True)
-
-    if not analytic.rule:
-        return bad_request(err="This is not a rule analytic, and cannot be deleted.")
-
-    if user["uname"] != analytic.owner and "admin" not in user["type"]:
-        return forbidden(err="You cannot delete this analytic.")
-
-    try:
-        datastore().analytic.delete(analytic.analytic_id)
-    except DataStoreException as e:
-        return bad_request(err=str(e))
-
-    return no_content()
+    raise NotImplementedError()
 
 
 @generate_swagger_docs()
@@ -557,7 +470,7 @@ def set_analytic_owner(id: str, user: dict[str, Any], **kwargs):
 @generate_swagger_docs()
 @analytic_api.route("/<id>/favourite", methods=["POST"])
 @api_login(required_priv=["R", "W"])
-def set_as_favourite(id, **kwargs):
+def set_as_favourite(id: str, user: User | None, **kwargs):
     """Add an analytic to a list of the user's favourites
 
     Variables:
@@ -576,16 +489,17 @@ def set_as_favourite(id, **kwargs):
     """
     storage = datastore()
 
-    existing_analytic: Analytic = storage.analytic.get_if_exists(id)
+    existing_analytic = storage.analytic.get(id)
     if not existing_analytic:
         return not_found(err="This analytic does not exist")
 
-    try:
-        current_user = storage.user.get_if_exists(kwargs["user"]["uname"])
+    if not user:
+        return forbidden(err="User was not found.")
 
-        current_user.favourite_analytics.append(id)
+    try:
+        user.favourite_analytics.append(id)
 
-        storage.user.save(current_user["uname"], current_user)
+        storage.user.save(user.uname, user)
 
         return ok()
     except ValueError as e:
@@ -595,7 +509,7 @@ def set_as_favourite(id, **kwargs):
 @generate_swagger_docs()
 @analytic_api.route("/<id>/favourite", methods=["DELETE"])
 @api_login(required_priv=["R", "W"])
-def remove_as_favourite(id, **kwargs):
+def remove_as_favourite(id: str, user: User | None, **kwargs):
     """Remove an analytic from a list of the user's favourites
 
     Variables:
@@ -614,12 +528,13 @@ def remove_as_favourite(id, **kwargs):
     if not storage.analytic.exists(id):
         return not_found(err="This analytic does not exist")
 
-    try:
-        current_user = storage.user.get_if_exists(kwargs["user"]["uname"])
+    if not user:
+        return forbidden(err="User was not found.")
 
-        current_user["favourite_analytics"] = list(filter(lambda f: f != id, current_user.favourite_analytics))
+    try:
+        user.favourite_analytics = list(filter(lambda f: f != id, user.favourite_analytics))
 
-        storage.user.save(current_user["uname"], current_user)
+        storage.user.save(user.uname, user)
 
         return no_content()
     except ValueError as e:

{howler_api-3.2.0.dev585 → howler_api-3.2.0.dev595}/howler/api/v1/hit.py

@@ -147,11 +147,9 @@ def delete_hits(user: User, **kwargs):
     None
 
     Data Block:
-    {
-        [
-            hitId, hitId, hitId
-        ]
-    }
+    [
+        hitId, hitId, hitId
+    ]
 
     Result Example:
     {
@@ -166,17 +164,11 @@ def delete_hits(user: User, **kwargs):
     if "admin" not in user["type"]:
         return forbidden(err="Cannot delete hit, only admin is allowed to delete")
 
+    hit_ids = list(set(hit_ids))
     non_existing_hit_ids = [hit_id for hit_id in hit_ids if not hit_service.exists(hit_id)]
 
-    if len(non_existing_hit_ids) == 1:
-        return not_found(err=f"Hit id {non_existing_hit_ids[0]} does not exist.")
-
-    if len(non_existing_hit_ids) > 1:
-        return not_found(err=f"Hit ids {', '.join(non_existing_hit_ids)} do not exist.")
-
-    for hit_id in hit_ids:
-        if not hit_service.exists(hit_id):
-            return not_found(err=f"Hit id {hit_id} does not exist.")
+    if non_existing_hit_ids:
+        return not_found(err=f"Hit id(s) {', '.join(non_existing_hit_ids)} do not exist.")
 
     hit_service.delete_hits(hit_ids)
 
@@ -247,7 +239,7 @@ def validate_hits(**kwargs):
 
 @generate_swagger_docs()
 @hit_api.route("/<id>", methods=["GET"])
-@api_login(audit=False, required_priv=["R"])
+@api_login(audit=True, required_priv=["R"])
 @add_etag(getter=hit_service.get_hit)
 def get_hit(id: str, server_version: str, **kwargs):
     """Get a hit.
@@ -522,7 +514,7 @@ def add_label(id, label_set, user, **kwargs):
         "success": True             # Adding the label succeeded
     }
     """
-    if not hit_service.does_hit_exist(id):
+    if not hit_service.exists(id):
         return not_found(err=f"Hit {id} does not exist")
 
     existing_hit: Hit = hit_service.get_hit(id, as_odm=True)
@@ -586,7 +578,7 @@ def remove_labels(id, label_set, user, **kwargs):
         "success": True             # Removing the labels succeeded
     }
     """
-    if not hit_service.does_hit_exist(id):
+    if not hit_service.exists(id):
         return not_found(err=f"Hit {id} does not exist")
 
     if f"howler.labels.{label_set}" not in hit_service.get_hit(id, as_odm=True).flat_fields():
@@ -803,7 +795,7 @@ def edit_comment(id: str, comment_id: str, user: dict[str, Any], **kwargs):
     if len(comment_value) > MAX_COMMENT_LEN:
         return bad_request(err="Comment is too long.")
 
-    if not hit_service.does_hit_exist(id):
+    if not hit_service.exists(id):
         return not_found(err=f"Hit {id} does not exist")
 
     hit: Hit = kwargs["cached_hit"]
@@ -864,7 +856,7 @@ def delete_comments(id: str, user: User, **kwargs):
         ...hit            # The new data for the hit
     }
     """
-    if not hit_service.does_hit_exist(id):
+    if not hit_service.exists(id):
         return not_found(err=f"Hit {id} does not exist")
 
     comment_ids: list[str] = request.json or []
@@ -984,199 +976,3 @@ def remove_react_comment(id: str, comment_id: str, user: dict[str, Any], **kwarg
     new_hit, version = hit_service.save_hit(hit, version=kwargs.get("server_version"))
 
     return ok(new_hit), version
-
-
-@generate_swagger_docs()
-@hit_api.route("/bundle", methods=["POST"])
-@api_login(audit=False, required_priv=["W"])
-def create_bundle(user: User, **kwargs):
-    """Create a new bundle
-
-    Variables:
-    None
-
-    Arguments:
-    None
-
-    Data Block:
-    {
-        "bundle": {
-            ...hit          # A howler hit that will be used as a template for this new bundle
-        },
-        "hits": [...ids]    # A list of existing howler hits to add as children to the new bundle
-    }
-
-    Result Example:
-    {
-        ...hit      # The created bundle
-    }
-    """
-    data = request.json
-    if not isinstance(data, dict):
-        return bad_request(err="Invalid data format")
-
-    bundle_hit: Optional[dict[str, Any]] = data.get("bundle")
-
-    if bundle_hit is None:
-        return bad_request(err="You did not provide a bundle hit.")
-
-    try:
-        odm, _ = hit_service.convert_hit(bundle_hit, unique=True)
-        odm.howler.is_bundle = True
-
-        child_hits = data.get("hits", [])
-
-        if len(odm.howler.hits) < 1 and len(child_hits) < 1:
-            return bad_request(err="You did not provide any child hits.")
-
-        for hit_id in child_hits:
-            if hit_id not in odm.howler.hits:
-                odm.howler.hits.append(hit_id)
-
-        hit_service.create_hit(odm.howler.id, odm, user=user.uname)
-        analytic_service.save_from_hit(odm, user)
-
-        for hit_id in odm.howler.hits:
-            child_hit: Hit = hit_service.get_hit(hit_id, as_odm=True)
-
-            if child_hit.howler.is_bundle:
-                return bad_request(
-                    err=f"You cannot specify a bundle as a child of another bundle - {child_hit.howler.id} is a bundle."
-                )
-
-            child_hit.howler.bundles.append(odm.howler.id)
-            datastore().hit.save(child_hit.howler.id, child_hit)
-
-        return created(odm)
-    except HowlerException as e:
-        return bad_request(err=str(e))
-
-
-@generate_swagger_docs()
-@hit_api.route("/bundle/<id>", methods=["PUT"])
-@api_login(audit=False, required_priv=["W"])
-@add_etag(getter=hit_service.get_hit, check_if_match=False)
-def update_bundle(id, **kwargs):
-    """Update a hit's child hits. Can be used to convert an existing hit into a bundle, or to update an existing bundle.
-
-    Variables:
-    id  => The ID of the bundle to update
-
-    Arguments:
-    None
-
-    Data Block:
-    [
-        ...ids
-    ]
-
-    Result Example:
-    {
-        ...hit      # The updated bundle
-    }
-    """
-    bundle_hit: Hit = cast(Hit, kwargs.get("cached_hit", None))
-    if not bundle_hit:
-        return not_found(err="This bundle does not exist.")
-
-    hit_ids = request.json
-    if not isinstance(hit_ids, list):
-        return bad_request(err="Invalid data format")
-
-    new_hit_list = bundle_hit.howler.as_primitives().get("hits", [])
-    if bundle_hit.howler.is_bundle:
-        for hit_id in hit_ids:
-            if hit_id not in new_hit_list:
-                new_hit_list.append(hit_id)
-            else:
-                return conflict(err=f"The hit {hit_id} is already in the bundle {bundle_hit.howler.id}.")
-    else:
-        new_hit_list = hit_ids
-
-    bundle_hit.howler.hits = new_hit_list
-    bundle_hit.howler.is_bundle = True
-
-    try:
-        for hit_id in new_hit_list:
-            child_hit: Hit = hit_service.get_hit(hit_id, as_odm=True)
-
-            if child_hit.howler.is_bundle:
-                return bad_request(
-                    err=f"You cannot specify a bundle as a child of another bundle - {child_hit.howler.id} is a bundle."
-                )
-
-            new_bundle_list = child_hit.howler.as_primitives().get("bundles", [])
-            new_bundle_list.append(bundle_hit.howler.id)
-            child_hit.howler.bundles = new_bundle_list
-            datastore().hit.save(child_hit.howler.id, child_hit)
-
-        datastore().hit.save(bundle_hit.howler.id, bundle_hit)
-
-        return ok(bundle_hit)
-    except HowlerException as e:
-        return bad_request(err=str(e))
-
-
-@generate_swagger_docs()
-@hit_api.route("/bundle/<id>", methods=["DELETE"])
-@api_login(audit=False, required_priv=["W"])
-@add_etag(getter=hit_service.get_hit, check_if_match=False)
-def remove_bundle_children(id, **kwargs):
-    """Remove a bundle's child hits.
-
-    Can be used to convert an existing bundle back into a normal hit, or to remove a subset of
-    existing hits from the bundle.
-
-    Variables:
-    id  => The ID of the bundle to update
-
-    Arguments:
-    None
-
-    Data Block:
-    [
-        ...ids OR '*'   # A list of ids to remove, or a single '*' to remove all
-    ]
-
-    Result Example:
-    {
-        ...hit      # The updated hit
-    }
-    """
-    bundle_hit = kwargs.get("cached_hit", None)
-    if not bundle_hit:
-        return not_found(err="This bundle does not exist.")
-
-    hit_ids = request.json
-    if not isinstance(hit_ids, list):
-        return bad_request(err="Invalid data format")
-
-    new_hit_list = bundle_hit.howler.get("hits", [])
-    if bundle_hit.howler.is_bundle:
-        if hit_ids == ["*"]:
-            hit_ids = new_hit_list
-            new_hit_list = []
-        else:
-            new_hit_list = [_id for _id in new_hit_list if _id not in hit_ids]
-    else:
-        return bad_request(err="The specified hit must be a bundle.")
-
-    bundle_hit.howler.hits = new_hit_list
-    bundle_hit.howler.is_bundle = len(new_hit_list) > 0
-
-    try:
-        for hit_id in hit_ids:
-            child_hit: Hit = hit_service.get_hit(hit_id, as_odm=True)
-
-            try:
-                child_hit.howler.bundles.remove(bundle_hit.howler.id)
-            except ValueError:
-                logger.warning("Bundle isn't included in child %s!", bundle_hit.howler.id)
-
-            datastore().hit.save(child_hit.howler.id, child_hit)
-
-        datastore().hit.save(bundle_hit.howler.id, bundle_hit)
-
-        return ok(bundle_hit)
-    except HowlerException as e:
-        return bad_request(err=str(e))

{howler_api-3.2.0.dev585 → howler_api-3.2.0.dev595}/howler/api/v1/tool.py

@@ -94,7 +94,6 @@ def create_one_or_many_hits(tool_name: str, user: User, **kwargs):  # noqa: C901
 
     out: list[dict[str, Any]] = []
     odms = []
-    bundle_hit: Optional[Hit] = None
     for hit in hits:
         cur_id = get_random_id()
         cur_time = now_as_iso()
@@ -138,12 +137,7 @@ def create_one_or_many_hits(tool_name: str, user: User, **kwargs):  # noqa: C901
         try:
             odm, warns = hit_service.convert_hit(obj, unique=True, ignore_extra_values=ignore_extra_values)
 
-            if odm.howler.is_bundle and bundle_hit is None:
-                bundle_hit = odm
-            elif odm.howler.is_bundle:
-                return bad_request(err="You can only specify one bundle hit!")
-            else:
-                odms.append(odm)
+            odms.append(odm)
 
             out.append(
                 {
@@ -162,20 +156,9 @@ def create_one_or_many_hits(tool_name: str, user: User, **kwargs):  # noqa: C901
         return bad_request(out, warnings=warnings, err="No valid hits were provided")
     else:
         for odm in odms:
-            if bundle_hit is not None:
-                bundle_hit.howler.hits.append(odm.howler.id)
-                bundle_hit.howler.bundle_size += 1
-                odm.howler.bundles.append(bundle_hit.howler.id)
-
             hit_service.create_hit(odm.howler.id, odm, user=user.uname)
-
             analytic_service.save_from_hit(odm, user)
 
-        if bundle_hit:
-            hit_service.create_hit(bundle_hit.howler.id, bundle_hit, user=user.uname)
-
-            analytic_service.save_from_hit(bundle_hit, user)
-
         datastore().hit.commit()
 
         action_service.bulk_execute_on_query(f"howler.id:({' OR '.join(entry['id'] for entry in out)})", user=user)

{howler_api-3.2.0.dev585 → howler_api-3.2.0.dev595}/howler/api/v1/user.py

@@ -321,7 +321,7 @@ def get_user_avatar(username, **_):
     "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD..."
     """
     storage = datastore()
-    avatar: str = storage.user_avatar.get(username)
+    avatar = storage.user_avatar.get(username)
 
     if avatar:
         resp = ok(avatar)