misp-modules 3.0.0__tar.gz → 3.0.1__tar.gz

{misp_modules-3.0.0 → misp_modules-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: misp-modules
-Version: 3.0.0
+Version: 3.0.1
 Summary: MISP modules are autonomous modules that can be used for expansion and other services in MISP
 License: AGPL-3.0-only
 Author: Alexandre Dulaunoy
@@ -63,7 +63,6 @@ Requires-Dist: pytesseract ; extra == "all"
 Requires-Dist: python-docx ; extra == "all"
 Requires-Dist: python-pptx ; extra == "all"
 Requires-Dist: pyzbar ; extra == "all"
-Requires-Dist: redis
 Requires-Dist: requests[security] ; extra == "all"
 Requires-Dist: setuptools
 Requires-Dist: setuptools ; extra == "all"

{misp_modules-3.0.0 → misp_modules-3.0.1}/misp_modules/__init__.py

@@ -19,6 +19,7 @@
 import enum
 import importlib
 import importlib.abc
+import importlib.metadata
 import importlib.resources
 import importlib.util
 import pathlib
@@ -43,6 +44,14 @@ class ModuleType(enum.Enum):
     ACTION_MOD = "action_mod"
 
 
+def get_version() -> str:
+    """Return the version."""
+    try:
+        return importlib.metadata.version("misp-modules")
+    except importlib.metadata.PackageNotFoundError:
+        raise ValueError
+
+
 def is_valid_module(module: importlib.abc.Traversable) -> bool:
     """Whether the reference is a valid module file."""
     if not module.is_file():
@@ -65,15 +74,6 @@ def is_valid_module_type(module_type: importlib.abc.Traversable) -> bool:
     return True
 
 
-def iterate_helpers(
-    helpers_dir: typing.Union[importlib.abc.Traversable, pathlib.Path],
-) -> typing.Generator[importlib.abc.Traversable, None, None]:
-    """Iterate helpers and return helper references."""
-    for helper in helpers_dir.iterdir():
-        if is_valid_module(helper):
-            yield helper
-
-
 def iterate_modules(
     modules_dir: typing.Union[importlib.abc.Traversable, pathlib.Path],
 ) -> typing.Generator[tuple[importlib.abc.Traversable, importlib.abc.Traversable], None, None]:

{misp_modules-3.0.0 → misp_modules-3.0.1}/misp_modules/__main__.py

@@ -114,11 +114,22 @@ def init_logger(debug: bool = False) -> None:
     LOGGER.addHandler(handler)
 
 
-class Healthcheck(tornado.web.RequestHandler):
-    """Healthcheck handler."""
+class VersionCheck(tornado.web.RequestHandler):
+    """VersionCheck handler."""
 
     def get(self):
-        LOGGER.debug("MISP Healthcheck request")
+        LOGGER.debug("VersionCheck request")
+        try:
+            self.write(orjson.dumps({"version": misp_modules.get_version()}))
+        except ValueError:
+            self.send_error(500)
+
+
+class HealthCheck(tornado.web.RequestHandler):
+    """HealthCheck handler."""
+
+    def get(self):
+        LOGGER.debug("Healthcheck request")
         self.write(b'{"status": true}')
 
 
@@ -143,7 +154,7 @@ class ListModules(tornado.web.RequestHandler):
         )
 
     def get(self):
-        LOGGER.debug("MISP ListModules request")
+        LOGGER.debug("ListModules request")
         if not self.CACHE:
             self.CACHE = self._build_handlers_data()
         self.write(self.CACHE)
@@ -159,7 +170,7 @@ class QueryModule(tornado.web.RequestHandler):
 
     @tornado_concurrent.run_on_executor
     def run_request(self, module_name, json_payload, dict_payload):
-        LOGGER.debug("MISP QueryModule %s request %s", module_name, json_payload)
+        LOGGER.debug("QueryModule %s request %s", module_name, json_payload)
         try:
             response = MODULES_HANDLERS[module_name].dict_handler(request=dict_payload)
         except AttributeError:
@@ -211,22 +222,6 @@ def main():
     # Load libraries as root modules
     misp_modules.promote_lib_to_root()
 
-    # Load helpers
-    for helper in misp_modules.iterate_helpers(
-        importlib.resources.files(__package__).joinpath(misp_modules.HELPERS_DIR)
-    ):
-        helper_name = os.path.splitext(helper.name)[0]
-        absolute_helper_name = ".".join([__package__, misp_modules.HELPERS_DIR, helper_name])
-        try:
-            imported_helper = importlib.import_module(absolute_helper_name)
-            if test_error := imported_helper.selftest():
-                raise ImportError(test_error)
-        except ImportError as e:
-            LOGGER.warning("Helper %s failed: %s", helper_name, e)
-            continue
-        HELPERS_HANDLERS[helper_name] = imported_helper
-        LOGGER.info("Helper %s loaded", helper_name)
-
     # Load modules
     for module_type, module in misp_modules.iterate_modules(
         importlib.resources.files(__package__).joinpath(misp_modules.MODULES_DIR)
@@ -262,7 +257,8 @@ def main():
                 [
                     (r"/modules", ListModules),
                     (r"/query", QueryModule),
-                    (r"/healthcheck", Healthcheck),
+                    (r"/healthcheck", HealthCheck),
+                    (r"/version", VersionCheck),
                 ]
             ),
             max_buffer_size=MAX_BUFFER_SIZE,

{misp_modules-3.0.0 → misp_modules-3.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "misp-modules"
-version = "3.0.0"
+version = "3.0.1"
 description = "MISP modules are autonomous modules that can be used for expansion and other services in MISP"
 authors = [
     {name = "Alexandre Dulaunoy", email = "alexandre.dulaunoy@circl.lu"}
@@ -20,7 +20,6 @@ dependencies = [
     ## core dependencies
     "orjson",
     "psutil",
-    "redis",
     "tornado",
     ## minimum dependencies
     "beautifulsoup4",

misp_modules-3.0.0/misp_modules/helpers/cache.py

@@ -1,99 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
-# MISP modules helper - cache
-#
-# Copyright (C) 2016 Alexandre Dulaunoy
-# Copyright (C) 2016 CIRCL - Computer Incident Response Center Luxembourg
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import hashlib
-import os
-import typing
-
-import redis
-
-DEFAULT_HOST = "127.0.0.1"
-DEFAULT_PORT = 6379
-DEFAULT_DATABASE = 0
-DEFAULT_TIMEOUT = 5
-
-
-def create_connection(timeout: int = DEFAULT_TIMEOUT, **kwargs) -> redis.Redis:
-    return redis.Redis(
-        host=os.getenv("REDIS_BACKEND", DEFAULT_HOST),
-        password=os.getenv("REDIS_PW"),
-        port=int(os.getenv("REDIS_PORT", DEFAULT_PORT)),
-        db=int(os.getenv("REDIS_DATABASE", DEFAULT_DATABASE)),
-        socket_timeout=timeout,
-        socket_connect_timeout=timeout,
-        **kwargs,
-    )
-
-
-def selftest(enable: bool = True) -> typing.Union[str, None]:
-    if not enable:
-        return None
-    try:
-        r = create_connection(timeout=3)
-        r.ping()
-    except Exception:
-        return "Redis not running or not installed. Helper will be disabled."
-    else:
-        return None
-
-
-def get(modulename=None, query=None, value=None, debug=False):
-    if modulename is None or query is None:
-        return False
-    r = create_connection(decode_responses=True)
-    h = hashlib.sha1()
-    h.update(query.encode("UTF-8"))
-    hv = h.hexdigest()
-    key = "m:{}:{}".format(modulename, hv)
-
-    if not r.exists(key):
-        if debug:
-            print("Key {} added in cache".format(key))
-        r.setex(key, 86400, value)
-    else:
-        if debug:
-            print("Cache hit with Key {}".format(key))
-
-    return r.get(key)
-
-
-def flush():
-    r = create_connection(decode_responses=True)
-    return r.flushdb()
-
-
-if __name__ == "__main__":
-    import sys
-
-    if selftest() is not None:
-        sys.exit()
-    else:
-        print("Selftest ok")
-    v = get(modulename="testmodule", query="abcdef", value="barfoo", debug=True)
-    if v == "barfoo":
-        print("Cache ok")
-    v = get(modulename="testmodule", query="abcdef")
-    print(v)
-    v = get(modulename="testmodule")
-    if not v:
-        print("Failed ok")
-    if flush():
-        print("Cache flushed ok")