clue-api 1.3.0.dev87__tar.gz → 1.3.0.dev92__tar.gz

{clue_api-1.3.0.dev87 → clue_api-1.3.0.dev92}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clue-api
-Version: 1.3.0.dev87
+Version: 1.3.0.dev92
 Summary: Clue distributed enrichment service
 License: MIT
 License-File: LICENSE

{clue_api-1.3.0.dev87 → clue_api-1.3.0.dev92}/clue/app.py

@@ -1,3 +1,5 @@
+import warnings
+
 from gevent import monkey
 
 monkey.patch_all()
@@ -10,16 +12,25 @@ from dotenv import load_dotenv
 
 load_dotenv()
 
-# We append the plugin directory for howler to the python part
-PLUGIN_PATH = Path(os.environ.get("CLUE_PLUGIN_DIRECTORY", "/etc/clue/plugins"))
-sys.path.insert(0, str(PLUGIN_PATH))
+# We append the extension directory for howler to the python part
+EXTENSION_PATH = Path(
+    os.environ.get("CLUE_EXTENSION_PATH", os.environ.get("CLUE_PLUGIN_DIRECTORY", "/etc/clue/extensions"))
+)
+if not EXTENSION_PATH.exists():
+    if "CLUE_EXTENSION_PATH" not in os.environ and "CLUE_PLUGIN_DIRECTORY" not in os.environ:
+        warnings.warn(
+            f"{EXTENSION_PATH} doesn't exist, using legacy extension path /etc/clue/plugins", DeprecationWarning
+        )
+        EXTENSION_PATH = Path("/etc/clue/plugins")
+
+sys.path.insert(0, str(EXTENSION_PATH))
 
 from clue.config import DEBUG, SECRET_KEY, cache, config
 
-if config.api.debug and PLUGIN_PATH.exists():
-    for _plugin in PLUGIN_PATH.iterdir():
+if config.api.debug and EXTENSION_PATH.exists():
+    for _extension in EXTENSION_PATH.iterdir():
         sys.path.append(
-            str(Path(os.path.realpath(_plugin)) / f"../.venv/lib/python3.{sys.version_info.minor}/site-packages")
+            str(Path(os.path.realpath(_extension)) / f"../.venv/lib/python3.{sys.version_info.minor}/site-packages")
         )
 
 import logging
@@ -121,12 +132,15 @@ app.register_blueprint(registration_api)
 app.register_blueprint(static_api)
 
 
-logger.info("Checking plugins for additional routes")
-for plugin in get_extensions():
-    if not plugin.modules.routes:
+logger.info("Checking extensions for additional routes")
+for extension in get_extensions():
+    if extension.modules.init:
+        extension.modules.init(flask_app=app)
+
+    if not extension.modules.routes:
         continue
 
-    for route in cast(list[Blueprint], plugin.modules.routes):
+    for route in cast(list[Blueprint], extension.modules.routes):
         logger.info("Enabling additional endpoint: %s", route.url_prefix)
         app.register_blueprint(route)
 

clue_api-1.3.0.dev92/clue/constants/supported_types.py

@@ -0,0 +1,71 @@
+from clue.common.logging import get_logger
+from clue.common.regex import (
+    DOMAIN_ONLY_REGEX,
+    EMAIL_PATH_REGEX,
+    EMAIL_REGEX,
+    HBS_AGENT_ID_REGEX,
+    IPV4_ONLY_REGEX,
+    IPV6_ONLY_REGEX,
+    MD5_REGEX,
+    PORT_REGEX,
+    SHA1_REGEX,
+    SHA256_REGEX,
+    URI_ONLY,
+    UUID4_REGEX,
+)
+
+logger = get_logger(__file__)
+
+SUPPORTED_TYPES = {
+    "ipv4": IPV4_ONLY_REGEX,
+    "ipv6": IPV6_ONLY_REGEX,
+    # We don't auto-detect ip types, as it's redundant with ipv4/v6. This is just a convenience/backwards compat thing
+    "ip": None,
+    "domain": DOMAIN_ONLY_REGEX,
+    "port": PORT_REGEX,
+    "url": URI_ONLY,
+    "userid": None,
+    "user_agent": None,
+    "email_address": EMAIL_REGEX,
+    "email_id": None,
+    "email_path": EMAIL_PATH_REGEX,
+    "md5": MD5_REGEX,
+    "sha1": SHA1_REGEX,
+    "sha256": SHA256_REGEX,
+    "hbs_oid": None,
+    "hbs_agent_id": HBS_AGENT_ID_REGEX,
+    "telemetry": None,
+    "howler_id": None,
+    "hostname": None,
+    "tenant-id": UUID4_REGEX,
+}
+
+
+def add_supported_type(type: str, regex: str | None = None, namespace: str | None = None):
+    r"""Add a supported type to the SUPPORTED_TYPES registry.
+
+    This function registers a new type with an optional regex pattern for validation.
+    The type can be added to either the default namespace or a custom namespace.
+
+    Args:
+        type (str): The name of the type to be added.
+        regex (str | None, optional): A regex pattern for validating the type. Defaults to None.
+        namespace (str | None, optional): The namespace for the type. If None, adds to default namespace.
+            Defaults to None.
+
+    Returns:
+        None
+
+    Examples:
+        >>> add_supported_type("email", r"^[\w\.-]+@[\w\.-]+\.\w+$")
+        >>> add_supported_type("custom_id", r"^\d{5}$", namespace="myapp")
+    """
+    if not namespace:
+        logger.info("Adding new type %s to the default namespace with regex %s", type, regex)
+        SUPPORTED_TYPES[type] = regex
+    else:
+        logger.info("Adding type %s to namespace %s with regex %s", type, namespace, regex)
+        SUPPORTED_TYPES[f"{namespace}/{type}"] = regex
+
+
+CASE_INSENSITIVE_TYPES = ["ip", "domain", "port", "tenant-id", "hbs_oid", "hbs_agent_id"]

{clue_api-1.3.0.dev87 → clue_api-1.3.0.dev92}/clue/extensions/config.py

@@ -21,6 +21,7 @@ logger.addHandler(console)
 class Modules(BaseModel):
     "A list of components exposed for use in Clue by this plugin."
 
+    init: ImportString | None = None
     routes: list[ImportString] = []
     obo_module: ImportString | None = None
 

{clue_api-1.3.0.dev87 → clue_api-1.3.0.dev92}/pyproject.toml

@@ -142,7 +142,7 @@ log_cli_level = "WARN"
 [tool.poetry]
 package-mode = true
 name = "clue-api"
-version = "1.3.0.dev87"
+version = "1.3.0.dev92"
 description = "Clue distributed enrichment service"
 authors = ["Canadian Centre for Cyber Security <contact@cyber.gc.ca>"]
 license = "MIT"

clue_api-1.3.0.dev87/clue/constants/supported_types.py

@@ -1,40 +0,0 @@
-from clue.common.regex import (
-    DOMAIN_ONLY_REGEX,
-    EMAIL_PATH_REGEX,
-    EMAIL_REGEX,
-    HBS_AGENT_ID_REGEX,
-    IPV4_ONLY_REGEX,
-    IPV6_ONLY_REGEX,
-    MD5_REGEX,
-    PORT_REGEX,
-    SHA1_REGEX,
-    SHA256_REGEX,
-    URI_ONLY,
-    UUID4_REGEX,
-)
-
-SUPPORTED_TYPES = {
-    "ipv4": IPV4_ONLY_REGEX,
-    "ipv6": IPV6_ONLY_REGEX,
-    # We don't auto-detect ip types, as it's redundant with ipv4/v6. This is just a convenience/backwards compat thing
-    "ip": None,
-    "domain": DOMAIN_ONLY_REGEX,
-    "port": PORT_REGEX,
-    "url": URI_ONLY,
-    "userid": None,
-    "user_agent": None,
-    "email_address": EMAIL_REGEX,
-    "email_id": None,
-    "email_path": EMAIL_PATH_REGEX,
-    "md5": MD5_REGEX,
-    "sha1": SHA1_REGEX,
-    "sha256": SHA256_REGEX,
-    "hbs_oid": None,
-    "hbs_agent_id": HBS_AGENT_ID_REGEX,
-    "telemetry": None,
-    "howler_id": None,
-    "hostname": None,
-    "tenant-id": UUID4_REGEX,
-}
-
-CASE_INSENSITIVE_TYPES = ["ip", "domain", "port", "tenant-id", "hbs_oid", "hbs_agent_id"]