Merges API and Manager to IntelMQ project.

Author: gethvi

.github/workflows/codespell.yml

@@ -18,14 +18,13 @@ on:
 jobs:
   codespell:
     name: Find and notify about common misspellings
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     # This should not fail the whole workflow run
     continue-on-error: true
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-    - name: Install codespell
-      run: pip install "codespell==2.2.4"
-    - name: Run codespell
-      run: /home/runner/.local/bin/codespell
+      - name: "Checkout repository"
+        uses: actions/checkout@v3
+
+      - name: "Check codespell"
+        uses: codespell-project/actions-codespell@v2

.github/workflows/unittests.yml

@@ -62,7 +62,7 @@ jobs:
       run: bash .github/workflows/scripts/setup-full.sh
 
     - name: Install test dependencies
-      run: pip install pytest-cov Cerberus requests_mock coverage
+      run: pip install pytest-cov Cerberus requests_mock coverage httpx pycodestyle
 
     - name: Install dependencies
       if: ${{ matrix.type == 'basic' }}

contrib/malware_name_mapping/README.md

@@ -25,7 +25,7 @@ Additional optional rules
 
 ### Malpedia rules
 
-The rules imported from Malpedia can be used optionally with the flag `--include-malpedia`. Note, that this data is CC BY-NC-SA 3.0 and not CC0, so any comercial usage, including usage in commercial organizations, is not allowed.
+The rules imported from Malpedia can be used optionally with the flag `--include-malpedia`. Note, that this data is CC BY-NC-SA 3.0 and not CC0, so any commercial usage, including usage in commercial organizations, is not allowed.
 
 ### MISP galaxy rules
 

debian/changelog

@@ -451,6 +451,6 @@ intelmq (1.0.0~dev4~alpha2) UNRELEASED; urgency=low
 intelmq (1.0.0~dev4~alpha1) UNRELEASED; urgency=low
 
   * source package automatically created by stdeb 0.8.5,
-    with a bunch of manual tweeking.
+    with a bunch of manual tweaking.
 
  -- Sascha Wilde <[email protected]>  Wed, 23 Mar 2016 18:44:26 +0000

docs/overview.md

@@ -92,7 +92,7 @@ intelmq-mailgen](https://github.com/Intevation/intelmq-mailgen)
 
 A web application helping CERTs to enable members of their constituency to self-administrate how they get warnings related to their network objects (IP addresses, IP ranges, autonomous systems, domains). *tuency* is developed by [Intevation](https://intevation.de/) for [CERT.at](https://cert.at).
 
-If features organizational hierarchies, contact roles, self-administration and network objects per organization (Autonomous systems, network ranges, (sub)domains, RIPE organization handles). A network object claiming and approval process prevents abuse. An hierarchical rule-system on the network objects allow fine-grained settings. The tagging system for contacts and organization complement the contact-management features of the portal. Authentication is based on keycloak, which enables the re-use of the user accounts in the portal. The integrated API enables IntelMQ to query the portal for the right abuse contact and notification settings with the `intelmq.bots.experts.tuency.expert` expert bot.
+If features organizational hierarchies, contact roles, self-administration and network objects per organization (Autonomous systems, network ranges, (sub)domains, RIPE organization handles). A network object claiming and approval process prevents abuse. An hierarchical rule-system on the network objects allow fine-grained settings. The tagging system for contacts and organization complement the contact-management features of the portal. Authentication is based on keycloak, which enables the reuse of the user accounts in the portal. The integrated API enables IntelMQ to query the portal for the right abuse contact and notification settings with the `intelmq.bots.experts.tuency.expert` expert bot.
 
 ![Tuency Netobjects Overview](https://gitlab.com/intevation/tuency/tuency/-/raw/64b95ec0/docs/images/netobjects.png)
 

intelmq/__main__.py

@@ -0,0 +1,72 @@
+import argparse
+import getpass
+import sys
+
+import uvicorn
+
+from intelmq.api.config import Config
+from intelmq.api.session import SessionStore
+from intelmq.lib import utils
+
+
+def server_start(host: str = None, port: int = None, debug: bool = False, *args, **kwargs):
+    server_settings = utils.get_server_settings()
+    host = host if host is not None else server_settings.get("host", "0.0.0.0")
+    port = int(port) if port is not None else int(server_settings.get("port", 8080))
+
+    return uvicorn.run(
+        "intelmq.server:app",
+        host=host,
+        reload=debug,
+        port=port,
+        workers=1,
+    )
+
+
+def server_adduser(username: str, password: str = None, *args, **kwargs):
+    api_config: Config = Config()
+
+    if api_config.session_store is None:
+        print("Could not add user- no session store configured in configuration!", file=sys.stderr)
+        exit(1)
+
+    session_store = SessionStore(str(api_config.session_store), api_config.session_duration)
+    password = getpass.getpass() if password is None else password
+    session_store.add_user(username, password)
+    print(f"Added user {username} to intelmq session file.")
+
+
+def main():
+    parser = argparse.ArgumentParser(prog="intelmq", usage="intelmq [OPTIONS] COMMAND")
+    parser.set_defaults(func=(lambda *_, **__: parser.print_help())) # wrapper to accept args and kwargs
+    parser._optionals.title = "Options"
+    parser.add_argument("--version", action="store_true", help="print version and exit", default=None)
+    commands = parser.add_subparsers(metavar="", title="Commands")
+
+    # intelmq server
+    srv_parser = commands.add_parser("server", help="server subcommands", usage="intelmq server [COMMAND]")
+    srv_parser.set_defaults(func=(lambda *_, **__: srv_parser.print_help())) # wrapper to accept args and kwargs
+    srv_parser._optionals.title = "Options"
+    srv_subcommands = srv_parser.add_subparsers(metavar="", title="Commands")
+
+    # intelmq server start
+    srv_start = srv_subcommands.add_parser("start", help="start the server", usage="intelmq server start [OPTIONS]")
+    srv_start.set_defaults(func=server_start)
+    srv_start._optionals.title = "Options"
+    srv_start.add_argument("--debug", action="store_true", dest="debug", default=None)
+    srv_start.add_argument("--host", type=str, dest="host")
+    srv_start.add_argument("--port", type=int, dest="port")
+
+    # intelmq server adduser
+    srv_adduser = srv_subcommands.add_parser("adduser", help="adds new user", usage="intelmq server adduser [OPTIONS]")
+    srv_adduser.set_defaults(func=server_adduser)
+    srv_adduser._optionals.title = "Options"
+    srv_adduser.add_argument('--username', required=True, help='The username of the account.', type=str)
+    srv_adduser.add_argument('--password', required=False, help='The password of the account.', type=str)
+
+    args = parser.parse_args()
+    return args.func(**vars(args))
+
+
+if __name__ == "__main__":
+    main()

intelmq/api/__init__.py

@@ -0,0 +1,61 @@
+"""Configuration for IntelMQ Manager
+
+SPDX-FileCopyrightText: 2020 Intevation GmbH <https://intevation.de>
+SPDX-License-Identifier: AGPL-3.0-or-later
+
+Funding: of initial version by SUNET
+Author(s):
+  * Bernhard Herzog <[email protected]>
+"""
+
+from typing import List, Optional
+from pathlib import Path
+from intelmq.lib import utils
+
+
+class Config:
+
+    """Configuration settings for IntelMQ Manager"""
+
+    intelmq_ctl_cmd: List[str] = ["sudo", "-u", "intelmq", "/usr/local/bin/intelmqctl"]
+
+    allowed_path: Path = Path("/opt/intelmq/var/lib/bots/")
+
+    session_store: Optional[Path] = None
+
+    session_duration: int = 24 * 3600
+
+    allow_origins: List[str] = ['*']
+
+    enable_webgui: bool = True
+
+    host: str = "0.0.0.0"
+
+    port: int = 8080
+
+    def __init__(self):
+        server_settings = utils.get_server_settings()
+
+        if "intelmq_ctl_cmd" in server_settings:
+            self.intelmq_ctl_cmd = server_settings["intelmq_ctl_cmd"]
+
+        if "allowed_path" in server_settings:
+            self.allowed_path = Path(server_settings["allowed_path"])
+
+        if "session_store" in server_settings:
+            self.session_store = Path(server_settings["session_store"])
+
+        if "session_duration" in server_settings:
+            self.session_duration = int(server_settings["session_duration"])
+
+        if "allow_origins" in server_settings:
+            self.allow_origins = server_settings['allow_origins']
+
+        if "enable_webgui" in server_settings:
+            self.enable_webgui = server_settings["enable_webgui"]
+
+        if "host" in server_settings:
+            self.host = server_settings["host"]
+
+        if "port" in server_settings:
+            self.host = server_settings["port"]

intelmq/api/config.py

@@ -0,0 +1,62 @@
+"""Dependencies of the API endpoints, in the FastAPI style
+
+SPDX-FileCopyrightText: 2022 CERT.at GmbH <https://cert.at>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+
+import typing
+from typing import Generic, Optional, TypeVar
+
+from fastapi import Depends, Header, HTTPException, Response, status
+
+import intelmq.api.config
+import intelmq.api.session as session
+
+T = TypeVar("T")
+
+
+class OneTimeDependency(Generic[T]):
+    """Allows one-time explicit initialization of the dependency,
+        and then returning it on every usage.
+
+        It emulates the previous behavior that used global variables"""
+
+    def __init__(self) -> None:
+        self._value: Optional[T] = None
+
+    def initialize(self, value: T) -> None:
+        self._value = value
+
+    def __call__(self) -> Optional[T]:
+        return self._value
+
+
+api_config = OneTimeDependency[intelmq.api.config.Config]()
+session_store = OneTimeDependency[session.SessionStore]()
+
+
+def cached_response(max_age: int):
+    """Adds the cache headers to the response"""
+    def _cached_response(response: Response):
+        response.headers["cache-control"] = f"max-age={max_age}"
+    return _cached_response
+
+
+def token_authorization(authorization: typing.Union[str, None] = Header(default=None),
+                        session: session.SessionStore = Depends(session_store)):
+    if session is not None:
+        if not authorization or not session.verify_token(authorization):
+            raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED, detail={
+                                "Authentication Required":
+                                    "Please provide valid Token verification credentials"
+                                })
+
+
+def startup(config: intelmq.api.config.Config):
+    """A starting point to one-time initialization of necessary dependencies. This needs to
+        be called by the application on the startup."""
+    api_config.initialize(config)
+    session_file = config.session_store
+    if session_file is not None:
+        session_store.initialize(session.SessionStore(str(session_file),
+                                                      config.session_duration))

intelmq/api/dependencies.py

@@ -0,0 +1,25 @@
+"""Exception handlers for API
+
+SPDX-FileCopyrightText: 2022 CERT.at GmbH <https://cert.at>
+SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+
+from fastapi import FastAPI, Request, status
+from fastapi.responses import JSONResponse
+from starlette.exceptions import HTTPException as StarletteHTTPException
+
+import intelmq.api.runctl as runctl
+
+
+def ctl_error_handler(request: Request, exc: runctl.IntelMQCtlError):
+    return JSONResponse(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=exc.error_dict)
+
+
+def handle_generic_error(request: Request, exc: StarletteHTTPException):
+    return JSONResponse(status_code=exc.status_code, content={"error": exc.detail})
+
+
+def register(app: FastAPI):
+    """A hook to register handlers in the app. Need to be called before startup"""
+    app.add_exception_handler(runctl.IntelMQCtlError, ctl_error_handler)
+    app.add_exception_handler(StarletteHTTPException, handle_generic_error)