mmisp-lib 0.1.3__tar.gz → 0.1.5__tar.gz

mmisp_lib-0.1.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Konstantin Zangerle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.1
 Name: mmisp-lib
-Version: 0.1.3
+Version: 0.1.5
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: fastapi==0.104.1
 Requires-Dist: SQLAlchemy[asyncio]==1.4.46
 Requires-Dist: pydantic==1.10.13

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/pyproject.toml

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

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/src/mmisp/api_schemas/attributes/add_attribute_body.py

@@ -2,11 +2,13 @@ from typing import Any, Optional
 
 from pydantic import BaseModel, root_validator
 
+from mmisp.lib.attributes import literal_valid_attribute_types
+
 
 class AddAttributeBody(BaseModel):
-    type: str
-    value: Optional[str]
-    value1: Optional[str]
+    type: literal_valid_attribute_types
+    value: str | None = None
+    value1: str | None = None
     value2: str | None = None
     event_id: str | None = None
     object_id: str | None = None
@@ -29,6 +31,3 @@ class AddAttributeBody(BaseModel):
         if all(item is None for item in required_values):
             raise ValueError("value or value1 has to be set")
         return data
-
-    class Config:
-        orm_mode = True

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/src/mmisp/api_schemas/attributes/add_attribute_response.py

@@ -18,12 +18,12 @@ class AddAttributeAttributes(BaseModel):
     timestamp: str
     distribution: str
     sharing_group_id: str
-    comment: str
+    comment: str | None = None
     deleted: bool
     disable_correlation: bool
-    first_seen: Optional[str] = Field(..., nullable=True)
-    last_seen: Optional[str] = Field(..., nullable=True)
-    attribute_tag: list[str] = Field([], alias="AttributeTag")
+    first_seen: str | None = None
+    last_seen: str | None = None
+    attribute_tag: list[str] | None = Field(default_factory=list, alias="AttributeTag")
 
 
 class AddAttributeResponse(BaseModel):

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/src/mmisp/api_schemas/objects/create_object_body.py

@@ -14,6 +14,3 @@ class ObjectCreateBody(BaseModel):
     first_seen: str | None = None
     last_seen: str | None = None
     Attribute: list[AddAttributeBody] | None = None
-
-    class Config:
-        orm_mode = True

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/src/mmisp/api_schemas/objects/get_object_response.py

@@ -1,6 +1,6 @@
 from typing import Any, Dict, Optional
 
-from pydantic import BaseModel, validator
+from pydantic import BaseModel, Field, validator
 
 from mmisp.api_schemas.attributes.get_all_attributes_response import GetAllAttributesResponse
 from mmisp.api_schemas.events.get_event_response import ObjectEventResponse
@@ -22,7 +22,7 @@ class ObjectWithAttributesResponse(BaseModel):
     deleted: bool | None = None
     first_seen: str | None = None
     last_seen: str | None = None
-    Attribute: list[GetAllAttributesResponse] | None = None
+    attributes: list[GetAllAttributesResponse] | None = Field(alias="Attribute", default=None)
     Event: ObjectEventResponse | None = None
 
     @validator("sharing_group_id", always=True)
@@ -35,16 +35,13 @@ class ObjectWithAttributesResponse(BaseModel):
             return value
         return None
 
+    class Config:
+        allow_population_by_field_name = True
+
 
 class ObjectResponse(BaseModel):
     Object: ObjectWithAttributesResponse
 
-    class Config:
-        orm_mode = True
-
 
 class ObjectSearchResponse(BaseModel):
     response: list[ObjectResponse]
-
-    class Config:
-        orm_mode = True

mmisp_lib-0.1.5/src/mmisp/db/mixins.py

@@ -0,0 +1,17 @@
+from typing import Self
+
+from sqlalchemy import inspect
+from sqlalchemy.ext.hybrid import hybrid_property
+
+
+class DictMixin:
+    def asdict(self: Self) -> dict:
+        d = {}
+        for key in self.__mapper__.c.keys():
+            if not key.startswith("_"):
+                d[key] = getattr(self, key)
+
+        for key, prop in inspect(self.__class__).all_orm_descriptors.items():
+            if isinstance(prop, hybrid_property):
+                d[key] = getattr(self, key)
+        return d

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/src/mmisp/db/models/attribute.py

@@ -1,10 +1,11 @@
 from typing import Self, Type
 
-from sqlalchemy import BigInteger, Boolean, Column, ForeignKey, Integer, String, Text, inspect
+from sqlalchemy import BigInteger, Boolean, Column, ForeignKey, Integer, String, Text
 from sqlalchemy.ext.hybrid import hybrid_property
 from sqlalchemy.orm import relationship
 from sqlalchemy.orm.decl_api import DeclarativeMeta
 
+from mmisp.db.mixins import DictMixin
 from mmisp.lib.attributes import categories, default_category, mapper_safe_clsname_val, to_ids
 from mmisp.util.uuid import uuid
 
@@ -13,19 +14,6 @@ from .event import Event
 from .tag import Tag
 
 
-class DictMixin:
-    def asdict(self: Self) -> dict:
-        d = {}
-        for key in self.__mapper__.c.keys():
-            if not key.startswith("_"):
-                d[key] = getattr(self, key)
-
-        for key, prop in inspect(self.__class__).all_orm_descriptors.items():
-            if isinstance(prop, hybrid_property):
-                d[key] = getattr(self, key)
-        return d
-
-
 class Attribute(Base, DictMixin):
     __tablename__ = "attributes"
 
@@ -50,6 +38,17 @@ class Attribute(Base, DictMixin):
 
     event = relationship("Event", back_populates="attributes", lazy="joined")
 
+    __mapper_args__ = {"polymorphic_on": "type"}
+
+    def __init__(self: Self, *arg, **kwargs) -> None:
+        if kwargs["value1"] is None:
+            split_val = kwargs["value"].split("|", 1)
+            kwargs["value1"] = split_val[0]
+            if len(split_val) == 2:
+                kwargs["value2"] = split_val[1]
+
+        super().__init__(*arg, **kwargs)
+
     @property
     def event_uuid(self: "Attribute") -> str:
         return self.event.uuid
@@ -83,7 +82,7 @@ class AttributeMeta(DeclarativeMeta):
         key = clsname[len("Attribute") :]
         dct["default_category"] = default_category[mapper_safe_clsname_val[key]]
         dct["categories"] = categories[mapper_safe_clsname_val[key]]
-        dct["to_ids"] = to_ids[mapper_safe_clsname_val[key]]
+        dct["default_to_ids"] = to_ids[mapper_safe_clsname_val[key]]
         dct["__mapper_args__"] = {"polymorphic_identity": mapper_safe_clsname_val[key]}
         return super().__new__(cls, clsname, bases, dct)
 

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/src/mmisp/db/models/organisation.py

@@ -2,12 +2,13 @@ from datetime import datetime
 
 from sqlalchemy import Boolean, Column, DateTime, Integer, String, Text
 
+from mmisp.db.mixins import DictMixin
 from mmisp.util.uuid import uuid
 
 from ..database import Base
 
 
-class Organisation(Base):
+class Organisation(Base, DictMixin):
     __tablename__ = "organisations"
 
     id = Column(Integer, primary_key=True, nullable=False)

mmisp_lib-0.1.5/src/mmisp/db/models/role.py

@@ -0,0 +1,34 @@
+from typing import Self
+
+from sqlalchemy import Boolean, Column, DateTime, Integer, String
+
+from mmisp.lib.permissions import Permission
+
+from ..database import Base
+
+RoleAttrs = {
+    "__tablename__": "roles",
+    "id": Column(Integer, primary_key=True, nullable=False),
+    "name": Column(String(255), nullable=False),
+    "created": Column(DateTime, default=None),
+    "modified": Column(DateTime, default=None),
+    "default_role": Column(Boolean, nullable=False, default=False),
+    "memory_limit": Column(String(255), default=""),
+    "max_execution_time": Column(String(255), default=""),
+    "restricted_to_site_admin": Column(Boolean, nullable=False, default=False),
+    "enforce_rate_limit": Column(Boolean, nullable=False, default=False),
+    "rate_limit_count": Column(Integer, nullable=False, default=0),
+} | {f"perm_{x.value}": Column(Boolean, default=False) for x in Permission}
+
+RoleModel = type("RoleModel", (Base,), RoleAttrs)
+
+
+class Role(RoleModel):
+    def get_permissions(self: Self) -> set[Permission]:
+        d: list[Permission] = []
+
+        for key in self.__mapper__.c.keys():
+            if key.startswith("perm_") and getattr(self, key):
+                d.append(Permission(key[len("perm_") :]))
+
+        return set(d)

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/src/mmisp/db/models/sharing_group.py

@@ -2,12 +2,13 @@ from datetime import datetime
 
 from sqlalchemy import Boolean, Column, DateTime, Integer, String, Text
 
+from mmisp.db.mixins import DictMixin
 from mmisp.util.uuid import uuid
 
 from ..database import Base
 
 
-class SharingGroup(Base):
+class SharingGroup(Base, DictMixin):
     __tablename__ = "sharing_groups"
 
     id = Column(Integer, primary_key=True, nullable=False)
@@ -25,7 +26,7 @@ class SharingGroup(Base):
     roaming = Column(Boolean, default=False, nullable=False)
 
 
-class SharingGroupOrg(Base):
+class SharingGroupOrg(Base, DictMixin):
     __tablename__ = "sharing_group_orgs"
 
     id = Column(Integer, primary_key=True, nullable=False)
@@ -34,7 +35,7 @@ class SharingGroupOrg(Base):
     extend = Column(Boolean, default=False, nullable=False)
 
 
-class SharingGroupServer(Base):
+class SharingGroupServer(Base, DictMixin):
     __tablename__ = "sharing_group_servers"
 
     id = Column(Integer, primary_key=True, nullable=False)

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/src/mmisp/lib/attributes.py

@@ -1,8 +1,9 @@
 from collections import defaultdict
-from enum import Enum
+from enum import StrEnum
+from typing import Literal, Union
 
 
-class AttributeCategories(Enum):
+class AttributeCategories(StrEnum):
     PAYLOAD_DELIVERY = "Payload delivery"
     ARTIFACTS_DROPPED = "Artifacts dropped"
     PAYLOAD_INSTALLATION = "Payload installation"
@@ -213,7 +214,7 @@ mapper_val_safe_clsname = {
 }
 
 mapper_safe_clsname_val = dict((v, k) for k, v in mapper_val_safe_clsname.items())
-
+literal_valid_attribute_types = Union[*[Literal[k] for k in mapper_val_safe_clsname.keys()]]
 
 default_category = {
     "md5": AttributeCategories.PAYLOAD_DELIVERY,

mmisp_lib-0.1.5/src/mmisp/lib/permissions.py

@@ -0,0 +1,54 @@
+from enum import StrEnum
+
+
+class Permission(StrEnum):
+    ADD = "add"
+    MODIFY = "modify"
+    """Manage Own Events."""
+    MODIFY_ORG = "modify_org"
+    """Manage Organisation Events."""
+    PUBLISH = "publish"
+    """Publish Organisation Events."""
+    DELEGATE = "delegate"
+    """Allow users to create delegation requests for their own org only events to trusted third parties."""
+    SYNC = "sync"
+    """Synchronisation permission, can be used to connect two MISP instances create data on behalf of other users.
+    Make sure that the role with this permission has also access to tagging and tag editing rights."""
+    ADMIN = "admin"
+    """Limited organisation admin - create, manage users of their own organisation."""
+    AUDIT = "audit"
+    """Access to the audit logs of the user\'s organisation."""
+    AUTH = "auth"
+    """Users with this permission have access to authenticating via their Auth keys,
+    granting them access to the API."""
+    SITE_ADMIN = "site_admin"
+    """Unrestricted access to any data and functionality on this instance."""
+    REGEXP_ACCESS = "regexp_access"
+    """Users with this role can modify the regex rules affecting how data is fed into MISP.
+    Make sure that caution is advised with handing out roles that include this permission,
+    user controlled executed regexes are dangerous."""
+    TAGGER = "tagger"
+    """Users with roles that include this permission can attach
+    or detach existing tags to and from events/attributes."""
+    TEMPLATE = "template"
+    """Create or modify templates, to be used when populating events."""
+    SHARING_GROUP = "sharing_group"
+    """Permission to create or modify sharing groups."""
+    TAG_EDITOR = "tag_editor"
+    """This permission gives users the ability to create tags."""
+    SIGHTING = "sighting"
+    """Permits the user to push feedback on attributes into MISP by providing sightings."""
+    OBJECT_TEMPLATE = "object_template"
+    """Create or modify MISP Object templates."""
+    PUBLISH_ZMQ = "publish_zmq"
+    """Allow users to publish data to the ZMQ pubsub channel via the publish event to ZMQ button."""
+    PUBLISH_KAFKA = "publish_kafka"
+    """Allow users to publish data to Kafka via the publish event to Kafka button."""
+    DECAYING = "decaying"
+    """Create or modify MISP Decaying Models."""
+    GALAXY_EDITOR = "galaxy_editor"
+    """Create or modify MISP Galaxies and MISP Galaxies Clusters."""
+    WARNINGLIST = "warninglist"
+    """Allow to manage warninglists."""
+    VIEW_FEED_CORRELATIONS = "view_feed_correlations"
+    """Allow the viewing of feed correlations. Enabling this can come at a performance cost."""

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/src/mmisp_lib.egg-info/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.1
 Name: mmisp-lib
-Version: 0.1.3
+Version: 0.1.5
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: fastapi==0.104.1
 Requires-Dist: SQLAlchemy[asyncio]==1.4.46
 Requires-Dist: pydantic==1.10.13

{mmisp_lib-0.1.3 → mmisp_lib-0.1.5}/src/mmisp_lib.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 README.md
 pyproject.toml
 src/mmisp/api_schemas/__init__.py
@@ -134,6 +135,7 @@ src/mmisp/api_schemas/warninglists/warninglist_response.py
 src/mmisp/db/__init__.py
 src/mmisp/db/config.py
 src/mmisp/db/database.py
+src/mmisp/db/mixins.py
 src/mmisp/db/print_changes.py
 src/mmisp/db/models/__init__.py
 src/mmisp/db/models/attribute.py
@@ -157,6 +159,7 @@ src/mmisp/db/models/user_setting.py
 src/mmisp/db/models/warninglist.py
 src/mmisp/lib/__init__.py
 src/mmisp/lib/attributes.py
+src/mmisp/lib/permissions.py
 src/mmisp_lib.egg-info/PKG-INFO
 src/mmisp_lib.egg-info/SOURCES.txt
 src/mmisp_lib.egg-info/dependency_links.txt

mmisp_lib-0.1.3/src/mmisp/db/models/role.py

@@ -1,42 +0,0 @@
-from sqlalchemy import Boolean, Column, DateTime, Integer, String
-
-from ..database import Base
-
-
-class Role(Base):
-    __tablename__ = "roles"
-
-    id = Column(Integer, primary_key=True, nullable=False)
-    name = Column(String(255), nullable=False)
-    created = Column(DateTime, default=None)
-    modified = Column(DateTime, default=None)
-    perm_add = Column(Boolean, default=False)
-    perm_modify = Column(Boolean, default=False)
-    perm_modify_org = Column(Boolean, default=False)
-    perm_publish = Column(Boolean, default=False)
-    perm_delegate = Column(Boolean, nullable=False, default=False)
-    perm_sync = Column(Boolean, default=False)
-    perm_admin = Column(Boolean, default=False)
-    perm_audit = Column(Boolean, default=False)
-    perm_full = Column(Boolean, default=False)
-    perm_auth = Column(Boolean, nullable=False, default=False)
-    perm_site_admin = Column(Boolean, nullable=False, default=False)
-    perm_regexp_access = Column(Boolean, nullable=False, default=False)
-    perm_tagger = Column(Boolean, nullable=False, default=False)
-    perm_template = Column(Boolean, nullable=False, default=False)
-    perm_sharing_group = Column(Boolean, nullable=False, default=False)
-    perm_tag_editor = Column(Boolean, nullable=False, default=False)
-    perm_sighting = Column(Boolean, nullable=False, default=False)
-    perm_object_template = Column(Boolean, nullable=False, default=False)
-    default_role = Column(Boolean, nullable=False, default=False)
-    memory_limit = Column(String(255), default="")
-    max_execution_time = Column(String(255), default="")
-    restricted_to_site_admin = Column(Boolean, nullable=False, default=False)
-    perm_publish_zmq = Column(Boolean, nullable=False, default=False)
-    perm_publish_kafka = Column(Boolean, nullable=False, default=False)
-    perm_decaying = Column(Boolean, nullable=False, default=False)
-    enforce_rate_limit = Column(Boolean, nullable=False, default=False)
-    rate_limit_count = Column(Integer, nullable=False, default=0)
-    perm_galaxy_editor = Column(Boolean, default=False)
-    perm_warninglist = Column(Boolean, default=False)
-    perm_view_feed_correlations = Column(Boolean, default=False)