mmisp-lib 0.8.0__tar.gz → 0.8.2__tar.gz

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mmisp-lib
-Version: 0.8.0
+Version: 0.8.2
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 License-File: LICENSE

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mmisp-lib"
-version = "0.8.0"
+version = "0.8.2"
 description = ""
 authors = []
 readme = "README.md"

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/api_schemas/organisations.py

@@ -23,7 +23,7 @@ class Organisation(BaseOrganisation):
     contacts: str | None = None
     local: bool
     """organisation gains access to the local instance, otherwise treated as external"""
-    restricted_to_domain: str | list | None = None
+    restricted_to_domain: list | str | None = None
     landingpage: str | None = None
 
     class Config:
@@ -45,7 +45,7 @@ class GetOrganisationResponse(BaseModel):
     created_by: str
     contacts: str | None = None
     local: bool
-    restricted_to_domain: str | list | None = None
+    restricted_to_domain: list | str | None = None
     landingpage: str | None = None
 
     def dict(self: Self, *args, **kwargs) -> dict:
@@ -90,7 +90,7 @@ class OrganisationUsersResponse(BaseModel):
     uuid: str | None = None
     contacts: str | None = None
     local: bool | None = None
-    restricted_to_domain: str | list | None = None
+    restricted_to_domain: list | str | None = None
     landingpage: str | None = None
 
 
@@ -105,7 +105,7 @@ class AddOrganisation(BaseModel):
     contacts: str | None = None
     local: bool
     """organisation gains access to the local instance, otherwise treated as external"""
-    restricted_to_domain: str | None = None
+    restricted_to_domain: list[str] | None = None
     landingpage: str | None = None
 
     class Config:
@@ -121,7 +121,7 @@ class EditOrganisation(BaseModel):
     contacts: str | None = None
     local: bool
     """organisation gains access to the local instance, otherwise treated as external"""
-    restricted_to_domain: str | None = None
+    restricted_to_domain: list[str] | None = None
     landingpage: str | None = None
 
     class Config:

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/api_schemas/sharing_groups.py

@@ -1,3 +1,4 @@
+import uuid
 from datetime import datetime
 
 from pydantic import BaseModel, Field
@@ -22,6 +23,28 @@ class SharingGroup(BaseModel):
     roaming: bool
 
 
+#    org_count: int = 0
+
+
+class ShortSharingGroup(BaseModel):
+    id: int
+    name: str
+    releasability: str
+    description: str
+    uuid: str
+    active: bool
+    local: bool
+    roaming: bool
+
+    org_count: int = 0
+
+
+class ShortOrganisation(BaseModel):
+    id: int
+    name: str
+    uuid: uuid.UUID
+
+
 class SharingGroupServer(BaseModel):
     id: int
     sharing_group_id: int
@@ -81,12 +104,39 @@ class ViewUpdateSharingGroupLegacyResponseSharingGroupOrgItem(BaseModel):
     Organisation: ViewUpdateSharingGroupLegacyResponseOrganisationInfo
 
 
-class ViewUpdateSharingGroupLegacyResponse(BaseModel):
+class SharingGroupResponse(BaseModel):
+    SharingGroup: ShortSharingGroup
+    Organisation: ShortOrganisation
+    SharingGroupOrg: list[ViewUpdateSharingGroupLegacyResponseSharingGroupOrgItem]
+    SharingGroupServer: list[ViewUpdateSharingGroupLegacyResponseSharingGroupServerItem]
+
+    editable: bool | None = None
+    deletable: bool | None = None
+
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
+
+class SingleSharingGroupResponse(BaseModel):
     SharingGroup: SharingGroup
     Organisation: Organisation
     SharingGroupOrg: list[ViewUpdateSharingGroupLegacyResponseSharingGroupOrgItem]
     SharingGroupServer: list[ViewUpdateSharingGroupLegacyResponseSharingGroupServerItem]
 
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
+
+class ViewUpdateSharingGroupLegacyResponse(SharingGroupResponse):
+    pass
+
+
+class GetSharingGroupsIndex(BaseModel):
+    response: list[SharingGroupResponse]
+
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
 
 class UpdateSharingGroupLegacyBody(BaseModel):
     id: int | None = None

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/commandline_tool/main.py

@@ -43,7 +43,7 @@ async def create_organisation(
     sector: str | None = None,
     contacts_email: str | None = None,
     local: bool | None = None,
-    restricted_domain: str | None = None,
+    restricted_domain: list[str] | None = None,
     landingpage: str | None = None,
 ) -> str:
     """create-organisation <name> [-admin_email <admin_email>] [- description <description>] [-type <type>]
@@ -115,7 +115,7 @@ async def edit_organisation(
     sector: str | None = None,
     contacts_email: str | None = None,
     local: bool | None = None,
-    restricted_domain: str | None = None,
+    restricted_domain: list[str] | None = None,
     landingpage: str | None = None,
 ) -> str:
     """edit-organisation <organisation> [-new_name <new_name>] [-admin_email <admin_email>] [-description <description>]

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/commandline_tool/organisation.py

@@ -18,7 +18,7 @@ async def create(
     sector: str | None,
     contacts_email: str | None,
     local: bool | None,
-    restricted_domain: str | None,
+    restricted_domain: list[str] | None,
     landingpage: str | None,
 ) -> None:
     organisation = Organisation()
@@ -67,7 +67,7 @@ async def edit_organisation(
     sector: str | None,
     contacts_email: str | None,
     local: bool | None,
-    restricted_domain: str | None,
+    restricted_domain: list[str] | None,
     landingpage: str | None,
 ) -> None:
     if isinstance(organisation, str):
@@ -109,7 +109,7 @@ async def set_attributes(
     sector: str | None,
     contacts_email: str | None,
     local: bool | None,
-    restricted_domain: str | None,
+    restricted_domain: list[str] | None,
     landingpage: str | None,
 ) -> None:
     if name is not None:

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/db/config.py

@@ -10,33 +10,38 @@ The following environment variables are supported:
 """
 
 import logging
-from dataclasses import dataclass
 from os import getenv
 
 from dotenv import load_dotenv
+from pydantic import BaseSettings, Field, root_validator
 
 
-@dataclass
-class DatabaseConfig:
-    DATABASE_URL: str
-    DEBUG: bool
-    RETRY_SLEEP: int
-    MAX_RETRIES: int
+class DatabaseConfig(BaseSettings):
+    DATABASE_URL: str | None = None
+    DEBUG: bool = False
+    RETRY_SLEEP: int = Field(5, env="DB_RETRY")
+    MAX_RETRIES: int = Field(100, env="DB_MAX_RETRIES")
+    CONNECTION_INIT: bool = True
     DB_LOGLEVEL: str | None = None
 
+    @root_validator(skip_on_failure=True)
+    def require_db_url_or_no_connection(cls: "DatabaseConfig", values: dict) -> dict:
+        db_url = values.get("DATABASE_URL")
+        connection_init = values.get("CONNECTION_INIT")
+        if db_url is None and connection_init:
+            raise ValueError("Environment variable DATABASE_URL is required when CONNECTION_INIT is not False")
+
+        return values
+
 
 load_dotenv(getenv("ENV_FILE", ".env"))
 
 
-config: DatabaseConfig = DatabaseConfig(
-    DATABASE_URL=getenv("DATABASE_URL", ""),
-    DEBUG=bool(getenv("DEBUG", False)),
-    RETRY_SLEEP=int(getenv("DB_RETRY", 5)),
-    MAX_RETRIES=int(getenv("DB_MAX_RETRIES", 100)),
-    DB_LOGLEVEL=getenv("DB_LOGLEVEL", None),
-)
+config: DatabaseConfig = DatabaseConfig()
+
 sqlalchemy_logger = logging.getLogger("sqlalchemy.engine")
 sqlalchemy_logger.setLevel(logging.WARNING)
+
 if config.DEBUG:
     sqlalchemy_logger.setLevel(logging.INFO)
 

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/db/database.py

@@ -114,4 +114,6 @@ async def create_all_models() -> None:
     await sessionmanager.create_all()
 
 
-sessionmanager = DatabaseSessionManager()
+sessionmanager = None
+if config.CONNECTION_INIT:
+    sessionmanager = DatabaseSessionManager()

mmisp_lib-0.8.2/src/mmisp/db/list_json_type.py

@@ -0,0 +1,31 @@
+import json
+from typing import Any, Self
+
+from sqlalchemy.engine import Dialect
+from sqlalchemy.types import Text, TypeDecorator
+
+
+class DBListJson(TypeDecorator):
+    impl = Text
+
+    def load_dialect_impl(self: Self, dialect: Dialect) -> Any:
+        return dialect.type_descriptor(Text)
+
+    def process_bind_param(self: Self, value: Any, dialect: Dialect) -> str | None:
+        """Handle value before getting into the DB"""
+        if value is None:
+            return None
+        if not isinstance(value, list):
+            raise ValueError("this type should only be used for lists")
+        return json.dumps(value)
+
+    def process_result_value(self: Self, value: Any, dialect: Dialect) -> list | None:
+        """Handle values from the database"""
+        if value is None:
+            return None
+
+        res = json.loads(value)
+        if not isinstance(res, list):
+            raise ValueError("this type should only be used for lists")
+
+        return res

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/db/models/galaxy_cluster.py

@@ -1,10 +1,7 @@
-import json
-from typing import Self
-
 from sqlalchemy import Boolean, ForeignKey, Integer, String, Text
-from sqlalchemy.ext.hybrid import hybrid_property
 from sqlalchemy.orm import relationship
 
+from mmisp.db.list_json_type import DBListJson
 from mmisp.db.mixins import DictMixin, UpdateMixin
 from mmisp.db.mypy import Mapped, mapped_column
 from mmisp.db.uuid_type import DBUUID
@@ -28,7 +25,7 @@ class GalaxyCluster(Base, UpdateMixin, DictMixin):
         Integer, ForeignKey(Galaxy.id, ondelete="CASCADE"), nullable=False, index=True
     )
     source: Mapped[str] = mapped_column(String(255), nullable=False, default="")
-    _authors: Mapped[str] = mapped_column("authors", Text, nullable=False)
+    authors: Mapped[list[str]] = mapped_column(DBListJson, nullable=False)
     version: Mapped[int] = mapped_column(Integer, default=0, index=True)
     distribution: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
     sharing_group_id: Mapped[int] = mapped_column(Integer, index=True, nullable=True, default=None)
@@ -75,20 +72,6 @@ class GalaxyCluster(Base, UpdateMixin, DictMixin):
         uselist=False,
     )  # type:ignore[assignment,var-annotated]
 
-    def __init__(self: Self, *arg, **kwargs) -> None:
-        if "authors" in kwargs:
-            self._authors = json.dumps(kwargs["authors"])
-            del kwargs["authors"]
-        super().__init__(*arg, **kwargs)
-
-    @hybrid_property
-    def authors(self: Self) -> list[str]:
-        return json.loads(self._authors)
-
-    @authors.setter  # type: ignore[no-redef]
-    def authors(self: Self, value: list[str]) -> None:
-        self._authors = json.dumps(value)
-
 
 class GalaxyElement(Base, DictMixin, UpdateMixin):
     __tablename__ = "galaxy_elements"

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/db/models/organisation.py

@@ -3,6 +3,7 @@ from datetime import datetime
 from sqlalchemy import Boolean, DateTime, Integer, String, Text
 from sqlalchemy.orm import relationship
 
+from mmisp.db.list_json_type import DBListJson
 from mmisp.db.mixins import DictMixin
 from mmisp.db.mypy import Mapped, mapped_column
 
@@ -26,7 +27,7 @@ class Organisation(Base, DictMixin):
     uuid: Mapped[str] = mapped_column(String(255), unique=True)
     contacts: Mapped[str] = mapped_column(Text)
     local: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
-    restricted_to_domain: Mapped[str] = mapped_column(Text)
+    restricted_to_domain: Mapped[list[str]] = mapped_column(DBListJson)
     landingpage: Mapped[str] = mapped_column(Text)
 
     # Relationship to users

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/db/models/server.py

@@ -1,12 +1,13 @@
 from sqlalchemy import Boolean, Integer, String, Text
 from sqlalchemy.orm import relationship
 
+from mmisp.db.mixins import DictMixin
 from mmisp.db.mypy import Mapped, mapped_column
 
 from ..database import Base
 
 
-class Server(Base):
+class Server(Base, DictMixin):
     __tablename__ = "servers"
 
     id: Mapped[int] = mapped_column(Integer, primary_key=True, nullable=False)

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/db/models/sharing_group.py

@@ -1,6 +1,7 @@
 from datetime import datetime
 
 from sqlalchemy import Boolean, DateTime, Integer, String, Text
+from sqlalchemy.orm import relationship
 
 from mmisp.db.mixins import DictMixin
 from mmisp.db.mypy import Mapped, mapped_column
@@ -18,7 +19,7 @@ class SharingGroup(Base, DictMixin):
     description = mapped_column(Text, nullable=False, default="")
     uuid = mapped_column(String(40), unique=True, default=uuid, nullable=False)
     organisation_uuid = mapped_column(String(40), nullable=False)
-    org_id = mapped_column(Integer, nullable=False, index=True)
+    org_id = mapped_column(Integer, nullable=False, index=True)  # the organisation that created the sharing group
     sync_user_id = mapped_column(Integer, nullable=False, default=0, index=True)
     active = mapped_column(Boolean, nullable=False, default=False)
     created = mapped_column(DateTime, default=datetime.utcnow, nullable=False)
@@ -26,6 +27,34 @@ class SharingGroup(Base, DictMixin):
     local = mapped_column(Boolean, nullable=False, default=True)
     roaming = mapped_column(Boolean, default=False, nullable=False)
 
+    creator_org = relationship(
+        "Organisation",
+        primaryjoin="SharingGroup.org_id == Organisation.id",
+        lazy="raise_on_sql",
+        foreign_keys="SharingGroup.org_id",
+    )  # type:ignore[assignment,var-annotated]
+    organisations = relationship(
+        "Organisation",
+        primaryjoin="SharingGroup.id == SharingGroupOrg.sharing_group_id",
+        secondary="sharing_group_orgs",
+        secondaryjoin="SharingGroupOrg.org_id == Organisation.id",
+        lazy="raise_on_sql",
+        viewonly=True,
+    )
+
+    sharing_group_orgs = relationship(
+        "SharingGroupOrg",
+        primaryjoin="SharingGroup.id == SharingGroupOrg.sharing_group_id",
+        lazy="raise_on_sql",
+        foreign_keys="SharingGroupOrg.sharing_group_id",
+    )  # type:ignore[assignment,var-annotated]
+    sharing_group_servers = relationship(
+        "SharingGroupServer",
+        primaryjoin="SharingGroup.id == SharingGroupServer.sharing_group_id",
+        lazy="raise_on_sql",
+        foreign_keys="SharingGroupServer.sharing_group_id",
+    )  # type:ignore[assignment,var-annotated]
+
 
 class SharingGroupOrg(Base, DictMixin):
     __tablename__ = "sharing_group_orgs"
@@ -35,6 +64,13 @@ class SharingGroupOrg(Base, DictMixin):
     org_id = mapped_column(Integer, index=True, nullable=False)
     extend = mapped_column(Boolean, default=False, nullable=False)
 
+    organisation = relationship(
+        "Organisation",
+        primaryjoin="SharingGroupOrg.org_id == Organisation.id",
+        lazy="raise_on_sql",
+        foreign_keys="SharingGroupOrg.org_id",
+    )  # type:ignore[assignment,var-annotated]
+
 
 class SharingGroupServer(Base, DictMixin):
     __tablename__ = "sharing_group_servers"
@@ -43,3 +79,10 @@ class SharingGroupServer(Base, DictMixin):
     sharing_group_id = mapped_column(Integer, index=True, nullable=False)
     server_id = mapped_column(Integer, index=True, nullable=False)
     all_orgs = mapped_column(Boolean, index=True, nullable=False, default=False)
+
+    server = relationship(
+        "Server",
+        primaryjoin="SharingGroupServer.server_id == Server.id",
+        lazy="raise_on_sql",
+        foreign_keys="SharingGroupServer.server_id",
+    )  # type:ignore[assignment,var-annotated]

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/tests/compatibility_helpers.py

@@ -1,3 +1,5 @@
+import json
+
 import httpx
 from deepdiff import DeepDiff
 from icecream import ic
@@ -62,4 +64,15 @@ def get_legacy_modern_diff(http_method, path, body, auth_key, client, preprocess
         if diff["dictionary_item_removed"] == {}:
             del diff["dictionary_item_removed"]
 
+    # somehow misp manages to maintain the json encoded restricted_to_domain str in GalaxyCluster only.
+    # we will ignore this, this is too broken
+    if diff.get("type_changes", False):
+        diff["type_changes"] = {
+            k: v
+            for k, v in diff["type_changes"].items()
+            if not ("restricted_to_domain" in k and v["new_value"] == json.dumps(v["old_value"]))
+        }
+        if diff["type_changes"] == {}:
+            del diff["type_changes"]
+
     return diff

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp/tests/generators/model_generators/organisation_generator.py

@@ -15,6 +15,6 @@ def generate_organisation() -> Organisation:
         created_by=0,
         contacts="Test Org\r\nBuilding 42\r\nAdenauerring 7\r\n76131 Karlsruhe\r\nGermany",
         local=True,
-        restricted_to_domain="",
+        restricted_to_domain=[],
         landingpage="",
     )

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp_lib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mmisp-lib
-Version: 0.8.0
+Version: 0.8.2
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 License-File: LICENSE

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/src/mmisp_lib.egg-info/SOURCES.txt

@@ -45,6 +45,7 @@ src/mmisp/db/all_models.py
 src/mmisp/db/config.py
 src/mmisp/db/database.py
 src/mmisp/db/lib.py
+src/mmisp/db/list_json_type.py
 src/mmisp/db/mixins.py
 src/mmisp/db/mypy.py
 src/mmisp/db/print_changes.py

{mmisp_lib-0.8.0 → mmisp_lib-0.8.2}/tests/test_commandline_tool.py

@@ -55,7 +55,7 @@ async def test_create_organisation(db, site_admin_user) -> None:
     sector = time_now
     contacts_email = time_now
     local = False
-    restricted_domain = False
+    restricted_domain: list[str] = []
     landingpage = time_now
     await main.create_organisation(
         name, admin_email, description, type, nationality, sector, contacts_email, local, restricted_domain, landingpage
@@ -157,7 +157,7 @@ async def test_edit_organisation(db, organisation, site_admin_user) -> None:
     new_sector = time_now
     new_contacts_email = time_now
     new_local = False
-    new_restricted_domain = "{}"
+    new_restricted_domain: list[str] = []
     new_landingpage = time_now
     await main.edit_organisation(
         organisation.name,
@@ -181,7 +181,7 @@ async def test_edit_organisation(db, organisation, site_admin_user) -> None:
     assert organisation.sector == new_sector
     assert organisation.contacts == new_contacts_email
     assert bool(organisation.local) is new_local
-    assert str(organisation.restricted_to_domain) == new_restricted_domain
+    assert organisation.restricted_to_domain == new_restricted_domain
     assert organisation.landingpage == new_landingpage
 
     try: