howler-api 3.0.0.dev350__tar.gz → 3.0.0.dev361__tar.gz

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 3.0.0.dev350
+Version: 3.0.0.dev361
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/howler/actions/__init__.py

@@ -74,7 +74,7 @@ def __sanitize_report(report: list[dict[str, Any]]) -> list[dict[str, Any]]:
 def execute(
     operation_id: str,
     query: str,
-    user: User,
+    user: User | None,
     request_id: Optional[str] = None,
     **kwargs,
 ) -> list[dict[str, Any]]:
@@ -117,7 +117,8 @@ def execute(
             }
         ]
 
-    missing_roles = set(operation.specification()["roles"]) - set(user["type"])
+    user_roles: set[str] = set(user["type"] if user else [])
+    missing_roles = set(operation.specification()["roles"]) - user_roles
     if missing_roles:
         return [
             {

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/howler/api/v1/action.py

@@ -237,7 +237,7 @@ def execute_action(id: str, **kwargs) -> Response:
         return not_found(err="The specified action does not exist")
 
     reports: dict[str, list[dict]] = {}
-    current_user = kwargs.get("user", None)
+    current_user: User | None = kwargs.get("user", None)
 
     for operation in action.operations:
         op_data = json.loads(operation["data_json"])
@@ -333,7 +333,7 @@ def execute_operations(**kwargs) -> Response:
         return bad_request(err="Incorrect data structure!")
 
     reports: dict[str, list[dict]] = {}
-    current_user = kwargs.get("user", None)
+    current_user: User | None = kwargs.get("user", None)
     operations = execute_req["operations"]
 
     operation_ids = [o["operation_id"] for o in operations]

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/howler/api/v1/configs.py

@@ -1,8 +1,11 @@
+from typing import cast
+
 from flask import request
 
 import howler.services.config_service as config_service
 from howler.api import make_subapi_blueprint, ok
 from howler.common.swagger import generate_swagger_docs
+from howler.odm.models.user import User
 from howler.security.utils import get_disco_url
 
 SUB_API = "configs"
@@ -49,7 +52,7 @@ def configs(**kwargs):
     """
     return ok(
         config_service.get_configuration(
-            user=kwargs.get("user", None),
+            user=cast(User | None, kwargs.get("user", None)),
             discovery_url=get_disco_url(request.environ.get("HTTP_REFERER")),
         )
     )

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/howler/api/v1/hit.py

@@ -1072,7 +1072,7 @@ def update_bundle(id, **kwargs):
         ...hit      # The updated bundle
     }
     """
-    bundle_hit: Hit = kwargs.get("cached_hit", None)
+    bundle_hit: Hit = cast(Hit, kwargs.get("cached_hit", None))
     if not bundle_hit:
         return not_found(err="This bundle does not exist.")
 

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/howler/api/v1/user.py

@@ -1,6 +1,6 @@
 import re
 from hashlib import sha256
-from typing import Any, Optional
+from typing import Any, Optional, cast
 
 from flask import request
 
@@ -128,7 +128,9 @@ def add_user_account(username, **_):
         data["name"] = data["uname"]
 
     # Add dynamic classification group
-    data["classification"] = user_service.get_dynamic_classification(data.get("classification", None), data["email"])
+    data["classification"] = user_service.get_dynamic_classification(
+        cast(str | None, data.get("classification", None)), data["email"]
+    )
 
     # Clear non user account data
     avatar = data.pop("avatar", None)

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/howler/common/README.md

@@ -44,25 +44,6 @@ This file provides utility functions to merge dictionaries together, find the di
 
     Where as the unflatten does the invert by taking the dotted notation and transforming it back to it's original multiple level dictionary.
 
-## hexdump.py
-
-This file provide functions to take a binary data blob and transform it into and hexadecimal dump of its bytes. The `dump(buf)` function only outputs the bytes where as the `hexdump(buf)` function outputs also the offsets and some trimmed down ascii representation.
-
-`dump("HTTP/1.1 404 Not\r\nCont")`
-
-    48 54 54 50 2F 31 2E 31 20 34 30 34 20 4E 6F 74 20 46 6F 75 6E 64 0D 0A 43 6F 6E 74
-
-`hexdump("HTTP/1.1 404 Not\r\nCont")`
-
-    00000000:  48 54 54 50 2F 31 2E 31 20 34 30 34 20 4E 6F 74  HTTP/1.1 404 Not
-    00000010:  20 46 6F 75 6E 64 0D 0A 43 6F 6E 74              Found..Cont
-
-## iprange.py
-
-This file provides you with a RangeTable class that let's you determine if and IP is part of a certain CIDR definition. It also provides to quick function that let you determine if an IP is in a private CIDR (`is_private(ip)`) or if an IP is in a reserved CIDR (`is_reserved(ip)`).
-
-*Note*: only IPV4 IPs are supported.
-
 ## isotime.py
 
 This file provides you which methods to transform date into strings or epoch values. It support local, ISO and epoch time. It also makes sure that the local and ISO time get up to a microsecond precision.

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/howler/helper/oauth.py

@@ -61,7 +61,7 @@ def parse_profile(profile: dict[str, Any], provider_config: OAuthProvider) -> di
         uname = profile.get("uname", profile.get("preferred_username", email_adr))
 
         # Did we default to email?
-        if uname is not None and uname.lower() == email_adr.lower():
+        if email_adr is not None and uname is not None and uname.lower() == email_adr.lower():
             # 1. Use provided regex matcher
             if provider_config.uid_regex:
                 match = re.match(provider_config.uid_regex, uname)

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/howler/services/config_service.py

@@ -61,7 +61,7 @@ def _get_apikey_max_duration():
         return amount, unit
 
 
-def get_configuration(user: User, **kwargs):
+def get_configuration(user: User | None, **kwargs):
     """Get system configration data for the Howler API
 
     Args:

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/howler/services/user_service.py

@@ -314,7 +314,7 @@ def save_user_account(username: str, data: dict[str, Any], user: dict[str, Any])
     return storage.user.save(username, data)
 
 
-def get_dynamic_classification(current_c12n: str, email: str) -> str:
+def get_dynamic_classification(current_c12n: str | None, email: str) -> str | None:
     """Get the classification of the user
 
     Args:
@@ -327,4 +327,5 @@ def get_dynamic_classification(current_c12n: str, email: str) -> str:
     if CLASSIFICATION.dynamic_groups and email:
         dyn_group = email.upper().split("@")[1]
         return CLASSIFICATION.build_user_classification(current_c12n, f"{CLASSIFICATION.UNRESTRICTED}//{dyn_group}")
+
     return current_c12n

{howler_api-3.0.0.dev350 → howler_api-3.0.0.dev361}/pyproject.toml

@@ -148,7 +148,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-api"
-version = "3.0.0.dev350"
+version = "3.0.0.dev361"
 description = "Howler - API server"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",

howler_api-3.0.0.dev350/howler/common/hexdump.py

@@ -1,48 +0,0 @@
-import binascii
-
-from howler.utils.chunk import chunk
-
-FILTER = b"".join([bytes([x]) if x in range(32, 127) else b"." for x in range(256)])
-
-
-def dump(binary: bytes, size: int = 2, sep: bytes = b" ") -> bytes:
-    "Convert a binary file into a hexadecimal representation"
-    hexstr = binascii.hexlify(binary)
-    return sep.join(chunk(hexstr, size))
-
-
-def hexdump(
-    binary: bytes,
-    length: int = 16,
-    indent: str = "",
-    indent_size: int = 0,
-    newline: str = "\n",
-    prefix_offset: int = 0,
-) -> str:
-    """Create a string buffer that shows the given data in hexdump format.
-
-    src -> source buffer
-    length = 16 -> number of bytes per line
-    indent = "" -> indentation before each lines
-    indent_size = 0 -> number of time to repeat that indentation
-    newline = "\n" -> chars used as newline char
-
-    Example of output:
-    00000000:  48 54 54 50 2F 31 2E 31 20 34 30 34 20 4E 6F 74  HTTP/1.1 404 Not
-    00000010:  20 46 6F 75 6E 64 0D 0A 43 6F 6E 74              Found..Cont
-    ...
-    """
-    generator = chunk(binary, length)
-    line_frmt = "%%s%%08X:  %%-%ss   %%s" % ((length * 3) - 1)
-
-    out = [
-        line_frmt
-        % (
-            indent * indent_size,
-            prefix_offset + (addr * length),
-            dump(d).decode(),
-            d.translate(FILTER).decode(),
-        )
-        for addr, d in enumerate(generator)
-    ]
-    return newline.join(out)

howler_api-3.0.0.dev350/howler/common/iprange.py

@@ -1,171 +0,0 @@
-from math import log
-from socket import inet_aton
-from struct import pack, unpack
-
-from howler.common.exceptions import InvalidRangeException
-
-# If you are tempted to extend this module to add support for IPv6 (or some
-# similar invasive change) take a look at using PySubnetTree and extending it
-# to allow arbitrary ranges instead.
-
-
-def _convert(ip):
-    return unpack("!I", inet_aton(ip))[0]
-
-
-def _next(lower, upper):
-    size = 2
-    while lower + size - 1 <= upper and _valid(lower, lower + size - 1):
-        size *= 2
-
-    return int(size / 2)
-
-
-def _valid(lower, upper):
-    return lower & (upper - lower) == 0
-
-
-# noinspection PyPep8Naming
-class _dict(dict):  # noqa: N801
-    pass
-
-
-def ip_to_int(ip):
-    if isinstance(ip, int):
-        return ip
-
-    return _convert(ip)
-
-
-# noinspection PyTypeChecker
-class RangeTable(object):
-    """Efficient storage of IPv4 ranges and lookup of IPv4 addresses."""
-
-    def __init__(self):
-        self.clear()
-        self._trie = _dict()
-
-    def _add_cidr(self, lower, upper, value):
-        if not _valid(lower, upper):
-            # The public add_range method should ensure this never happens.
-            raise InvalidRangeException("invalid range: %d-%d" % (lower, upper))
-
-        size = upper - lower
-        points = 3 - int(log(size + 1, 256))
-
-        lower = self._to_path(lower)
-        upper = self._to_path(upper)
-
-        for x in range(lower[points], upper[points] + 1):
-            self._add_path(lower[:points] + (x,), value)
-
-    def _add_path(self, path, value):
-        trie = self._trie
-        for point in path[:-1]:
-            d = trie.get(point, _dict())
-            if not isinstance(d, _dict):
-                prev = d
-                d = _dict()
-                d.update({x: prev for x in range(256)})
-            trie[point] = d
-            trie = d
-        trie[path[-1]] = value
-
-    def _add_range(self, lower, upper, value):
-        while lower <= upper:
-            size = _next(lower, upper)
-            self._add_cidr(lower, lower + size - 1, value)
-            lower += size
-
-    def _follow_path(self, path):
-        entry = self._trie
-        while isinstance(entry, _dict):
-            entry = entry.get(path[0], None)
-            path = path[1:]
-        return entry
-
-    @staticmethod
-    def _to_path(integer):
-        return unpack("B" * 4, pack("!I", integer))
-
-    def __getitem__(self, key):
-        return self._follow_path(self._to_path(ip_to_int(key)))
-
-    def __setitem__(self, key, value):
-        if isinstance(key, int):
-            self._add_cidr(key, key, value)
-            return
-
-        span = key.split("-", 1)
-        if len(span) == 1:
-            span = key.split("/", 1)
-        if len(span) == 1:
-            span.append(span[0])
-
-        span[0] = _convert(span[0].strip())
-        if span[1].find(".") == -1:
-            mask = 2 ** (32 - int(span[1])) - 1
-            span[0] -= span[0] & mask
-            span[1] = span[0] | mask
-        else:
-            span[1] = _convert(span[1].strip())
-
-        self._add_range(span[0], span[1], value)
-
-    def add_range(self, lower, upper, value):
-        lower = ip_to_int(lower)
-        upper = ip_to_int(upper)
-
-        self._add_range(lower, upper, value)
-
-        while lower <= upper:
-            size = _next(lower, upper)
-            self._add_cidr(lower, lower + size - 1, value)
-            lower += size
-
-    def clear(self):
-        self._trie = _dict()  # pylint:disable=W0201
-
-    def dump(self):
-        from pprint import pformat
-
-        return pformat(self._trie)
-
-
-PRIVATE_NETWORKS = [
-    "10.0.0.0/8",
-    "172.16.0.0/12",
-    "192.168.0.0/16",
-]
-
-RESERVED_NETWORKS = [
-    "0.0.0.0/8",
-    "100.64.0.0/10",
-    "127.0.0.0/8",
-    "169.254.0.0/16",
-    "192.0.0.0/24",
-    "192.0.2.0/24",
-    "192.88.99.0/24",
-    "198.18.0.0/15",
-    "198.51.100.0/24",
-    "203.0.113.0/24",
-    "240.0.0.0/4",
-    "224.0.0.0/4",
-    "255.255.255.255/32",
-]
-
-_private_ips = RangeTable()
-for cidr in PRIVATE_NETWORKS:
-    _private_ips[cidr] = True
-
-_reserved_ips = RangeTable()
-for cidr in RESERVED_NETWORKS:
-    _reserved_ips[cidr] = True
-
-
-def is_ip_private(ip):
-    return _private_ips[ip] or False
-
-
-def is_ip_reserved(ip):
-    return _private_ips[ip] or _reserved_ips[ip] or False