mmisp-lib 0.10.1__tar.gz → 0.11.0__tar.gz

{mmisp_lib-0.10.1/src/mmisp_lib.egg-info → mmisp_lib-0.11.0}/PKG-INFO

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

{mmisp_lib-0.10.1 → mmisp_lib-0.11.0}/pyproject.toml

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

{mmisp_lib-0.10.1 → mmisp_lib-0.11.0}/src/mmisp/api_schemas/attribute_common.py

@@ -2,10 +2,11 @@ from datetime import datetime
 from typing import Any, Self, Type
 from uuid import UUID
 
-from pydantic import BaseModel, field_serializer, field_validator
+from pydantic import BaseModel, field_serializer, field_validator, model_validator
 
 from mmisp.lib.attributes import (
     AttributeCategories,
+    AttributeType,
     literal_valid_attribute_types,
 )
 from mmisp.lib.distribution import AttributeDistributionLevels
@@ -46,3 +47,13 @@ class CommonAttribute(BaseModel):
         if value == "":
             return None
         return value
+
+    @model_validator(mode="after")
+    def check_type_value(self: Self) -> Self:
+        # get validator from attribute type
+        at = AttributeType.map_dbkey_attributetype[self.type]
+        validator = at.validator
+        if not validator(self.value):
+            raise ValueError(f"{self.value} is not compatible with attribute type {self.type}")
+
+        return self

{mmisp_lib-0.10.1 → mmisp_lib-0.11.0}/src/mmisp/api_schemas/attributes.py

@@ -6,6 +6,7 @@ from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_valid
 from mmisp.api_schemas.attribute_common import CommonAttribute
 from mmisp.lib.attributes import (
     AttributeCategories,
+    AttributeType,
     default_category,
     inverted_categories,
     literal_valid_attribute_types,
@@ -34,6 +35,7 @@ class SearchAttributesEvent(BaseModel):
     id: int
     org_id: int
     distribution: EventDistributionLevels
+    user_id: int
     info: str
     orgc_id: int
     uuid: str
@@ -385,8 +387,13 @@ class AddAttributeBody(BaseModel):
 
     @model_validator(mode="after")
     def ensure_value_or_value1_is_set(self: Self) -> Self:
-        if self.value is None and self.value1 is None:
-            raise ValueError("value or value1 has to be set")
+        if self.value is None:
+            if self.value1 is None:
+                raise ValueError("value or value1 has to be set")
+            if self.value2 is not None:
+                self.value = f"{self.value1}|{self.value2}"
+            else:
+                self.value = f"{self.value1}"
         return self
 
     @field_serializer("timestamp")
@@ -395,13 +402,23 @@ class AddAttributeBody(BaseModel):
             return None
         return int(timestamp.timestamp())
 
-    @field_validator("first_seen", mode="before")
+    @field_validator("first_seen", "value", "value1", "value2", mode="before")
     @classmethod
     def empty_string_to_none(cls: Type[Self], value: Any) -> Any:
         if value == "":
             return None
         return value
 
+    @model_validator(mode="after")
+    def check_type_value(self: Self) -> Self:
+        # get validator from attribute type
+        at = AttributeType.map_dbkey_attributetype[self.type]
+        validator = at.validator
+        if not validator(self.value):
+            raise ValueError(f"{self.value} is not compatible with attribute type {self.type}")
+
+        return self
+
 
 GetAttributeStatisticsTypesResponseAttrs = {x: Field(default=None) for x in mapper_val_safe_clsname.keys()}
 GetAttributeStatisticsTypesResponseAttrs["__annotations__"] = {

{mmisp_lib-0.10.1 → mmisp_lib-0.11.0}/src/mmisp/api_schemas/events.py

@@ -9,7 +9,7 @@ from mmisp.api_schemas.attribute_common import CommonAttribute
 from mmisp.api_schemas.galaxy_common import CommonGalaxy, CommonGalaxyCluster, GalaxyClusterMeta
 from mmisp.api_schemas.organisations import Organisation
 from mmisp.api_schemas.sharing_groups import EventSharingGroupResponse, MinimalSharingGroup
-from mmisp.lib.distribution import AttributeDistributionLevels
+from mmisp.lib.distribution import AttributeDistributionLevels, EventDistributionLevels
 
 
 class GetAllEventsGalaxyClusterGalaxy(CommonGalaxy):
@@ -24,7 +24,7 @@ class AddEditGetEventGalaxyClusterRelationTag(BaseModel):
     org_id: int
     user_id: int
     hide_tag: bool
-    numerical_value: str
+    numerical_value: int
     is_galaxy: bool
     is_custom_galaxy: bool
     local_only: bool
@@ -52,6 +52,8 @@ class GetAllEventsGalaxyCluster(CommonGalaxyCluster):
 
 
 class AddEditGetEventGalaxyCluster(CommonGalaxyCluster):
+    meta: dict[str, list]
+
     GalaxyClusterRelation: list[AddEditGetEventGalaxyClusterRelation] = []
     Org: Organisation | None = None
     Orgc: Organisation | None = None
@@ -206,7 +208,7 @@ class AddEditGetEventRelatedEvent(BaseModel):
 
 
 class AddEditGetEventDetails(BaseModel):
-    id: int
+    id: int | None = None
     orgc_id: int
     org_id: int
     date: str
@@ -216,18 +218,18 @@ class AddEditGetEventDetails(BaseModel):
     uuid: str
     attribute_count: int
     analysis: str | int
-    timestamp: datetime
-    distribution: AttributeDistributionLevels
+    timestamp: datetime | None = None
+    distribution: EventDistributionLevels
     proposal_email_lock: bool
     locked: bool
-    publish_timestamp: datetime
+    publish_timestamp: datetime | None = None
     sharing_group_id: int | None = None
     disable_correlation: bool
-    extends_uuid: str
+    extends_uuid: str | None = None
     protected: bool | None = None
     event_creator_email: str | None = None
-    Org: AddEditGetEventOrg
-    Orgc: AddEditGetEventOrg
+    Org: AddEditGetEventOrg | None = None
+    Orgc: AddEditGetEventOrg | None = None
     Attribute: list[AddEditGetEventAttribute] = []
     ShadowAttribute: list[AddEditGetEventShadowAttribute] = []
     RelatedEvent: list[AddEditGetEventRelatedEvent] = []
@@ -239,7 +241,9 @@ class AddEditGetEventDetails(BaseModel):
     sharing_group: EventSharingGroupResponse | None = Field(alias="SharingGroup", default=None)
 
     @field_serializer("timestamp", "publish_timestamp")
-    def serialize_timestamp(self: Self, timestamp: datetime, _: Any) -> int:
+    def serialize_timestamp(self: Self, timestamp: datetime | None, _: Any) -> int | None:
+        if timestamp is None:
+            return None
         return int(timestamp.timestamp())
 
 
@@ -391,6 +395,7 @@ class IndexEventsBody(BaseModel):
     hasproposal: str | None = None
     timestamp: datetime | None = None
     publish_timestamp: datetime | None = None
+    published: bool | None = None
     searchDatefrom: str | None = None
     searchDateuntil: str | None = None
 

{mmisp_lib-0.10.1 → mmisp_lib-0.11.0}/src/mmisp/api_schemas/galaxies.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from typing import Any, Literal
 from uuid import UUID
 
@@ -5,7 +6,7 @@ from pydantic import BaseModel, ConfigDict, Field
 
 from mmisp.api_schemas.common import TagAttributesResponse
 from mmisp.api_schemas.events import AddEditGetEventGalaxyClusterRelation, GetAllEventsGalaxyClusterGalaxy
-from mmisp.api_schemas.galaxy_common import CommonGalaxy, CommonGalaxyCluster, GetAllSearchGalaxiesAttributes
+from mmisp.api_schemas.galaxy_common import CommonGalaxy, CommonGalaxyCluster
 from mmisp.api_schemas.organisations import Organisation
 from mmisp.lib.distribution import GalaxyDistributionLevels
 
@@ -25,6 +26,26 @@ class ImportGalaxy(BaseModel):
     orgc_id: Literal[0] = 0
 
 
+class RestSearchGalaxyBody(BaseModel):
+    id: int
+    uuid: UUID | None = None
+    name: str | None = None
+    type: str | None = None
+    description: str | None = None
+    version: str | None = None
+    icon: str | None = None
+    namespace: str | None = None
+    enabled: bool = False
+    enable: bool | None = None
+    local_only: bool | None = None
+    default: bool | None = None
+    org_id: int | None = None
+    orgc_id: int | None = None
+    created: datetime | None = None
+    modified: datetime | None = None
+    distribution: GalaxyDistributionLevels | None = None
+
+
 class SearchGalaxiesBody(BaseModel):
     id: int | None = None
     uuid: str | None = None
@@ -71,12 +92,12 @@ class ImportGalaxyBody(BaseModel):
 
 
 class GetAllSearchGalaxiesResponse(BaseModel):
-    Galaxy: GetAllSearchGalaxiesAttributes
+    Galaxy: RestSearchGalaxyBody
     model_config = ConfigDict(from_attributes=True)
 
 
 class GetGalaxyResponse(BaseModel):
-    Galaxy: GetAllSearchGalaxiesAttributes
+    Galaxy: RestSearchGalaxyBody
     GalaxyCluster: list[GetGalaxyClusterResponse]
     model_config = ConfigDict(from_attributes=True)
 
@@ -107,7 +128,7 @@ class ExportGalaxyClusterResponse(BaseModel):
     default: bool
     locked: bool
     extends_uuid: str
-    extends_version: int
+    extends_version: int | None
     published: bool
     deleted: bool
     GalaxyElement: list[ExportGalaxyGalaxyElement]
@@ -150,7 +171,7 @@ class GalaxyClustersViewResponse(BaseModel):
     default: bool
     locked: bool
     extends_uuid: str
-    extends_version: int
+    extends_version: int | None
     published: bool
     deleted: bool
     GalaxyElement: list[ExportGalaxyGalaxyElement]

mmisp_lib-0.11.0/src/mmisp/api_schemas/galaxy_clusters.py

@@ -0,0 +1,232 @@
+from typing import Literal, Optional
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from mmisp.api_schemas.common import NoneTag, TagAttributesResponse
+from mmisp.api_schemas.events import AddEditGetEventGalaxyClusterRelation, GetAllEventsGalaxyClusterGalaxy
+from mmisp.api_schemas.galaxies import ExportGalaxyGalaxyElement, RestSearchGalaxyBody
+from mmisp.api_schemas.galaxy_common import (
+    ShortCommonGalaxy,
+    ShortCommonGalaxyCluster,
+)
+from mmisp.api_schemas.organisations import GetOrganisationElement
+from mmisp.lib.distribution import DistributionLevels, GalaxyDistributionLevels
+
+
+class IndexGalaxyCluster(BaseModel):
+    Galaxy: ShortCommonGalaxy
+    GalaxyCluster: ShortCommonGalaxyCluster
+
+
+class ImportGalaxyClusterValueMeta(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+    type: list[str] | None = None
+    complexity: str | None = None
+    effectiveness: str | None = None
+    country: str | None = None
+    possible_issues: str | None = None
+    colour: str | None = None
+    motive: str | None = None
+    impact: str | None = None
+    refs: list[str] | None = None
+    synonyms: list[str] | None = None
+    status: str | None = None
+    date: str | None = None
+    encryption: str | None = None
+    extensions: list[str] | None = None
+    ransomnotes: list[str] | None = None
+    official_refs: list[str] | None = Field(None, validation_alias="official-refs")
+
+
+class ImportGalaxyClusterValueRelated(BaseModel):
+    dest_uuid: UUID = Field(validation_alias="dest-uuid")
+    type: str
+
+
+class ImportGalaxyClusterValue(BaseModel):
+    value: str
+    uuid: UUID
+    related: list[ImportGalaxyClusterValueRelated] | None = None
+    description: str = ""
+    revoked: bool | None = None
+    meta: ImportGalaxyClusterValueMeta | None = None
+
+
+class ImportGalaxyCluster(BaseModel):
+    description: str
+    type: str
+    version: int
+    name: str
+    uuid: UUID
+    values: list[ImportGalaxyClusterValue]
+    authors: list[str]
+    source: str
+    category: str
+
+    distribution: Literal[3] = 3
+
+
+class GetGalaxyClusterResponse(BaseModel):
+    id: int | None = None
+    uuid: str | None = None
+    collection_uuid: str
+    type: str
+    value: str
+    tag_name: str
+    description: str
+    galaxy_id: int
+    source: str
+    authors: list[str]
+    version: int
+    distribution: GalaxyDistributionLevels
+    sharing_group_id: int | None
+    org_id: int
+    orgc_id: int
+    default: bool
+    locked: bool
+    extends_uuid: Literal[""] | UUID | None
+    extends_version: int | None
+    published: bool
+    deleted: bool
+    RelationshipInbound: list[str] = Field(default_factory=list)
+    TargetingClusterRelation: list[str] = Field(default_factory=list)
+    GalaxyElement: list[ExportGalaxyGalaxyElement]
+    Galaxy: GetAllEventsGalaxyClusterGalaxy | None = None
+    GalaxyClusterRelation: list[AddEditGetEventGalaxyClusterRelation] = []
+    Org: GetOrganisationElement | None = None
+    Orgc: GetOrganisationElement | None = None
+
+
+class GalaxyClusterResponse(BaseModel):
+    GalaxyCluster: GetGalaxyClusterResponse
+    Tag: NoneTag | TagAttributesResponse = Field(default_factory=NoneTag)
+
+
+class AddGalaxyElement(BaseModel):
+    key: str
+    value: str
+
+
+class AddUpdateGalaxyElement(BaseModel):
+    id: int | None = None
+    galaxy_cluster_id: int | None = None
+    key: str
+    value: str
+
+
+class AddGalaxyClusterRequest(BaseModel):
+    uuid: str | None = None
+    value: str
+    description: str
+    source: str
+    authors: list[str]
+    org_id: int | None = None
+    orgc_id: int | None = None
+    distribution: DistributionLevels
+    locked: bool = False
+    GalaxyElement: list[AddGalaxyElement]
+
+
+class PutGalaxyClusterRequest(BaseModel):
+    id: int | None = None
+    uuid: str | None = None
+    collection_uuid: UUID | Literal[""] | None = None
+    type: str | None = None
+    value: str | None = None
+    tag_name: str | None = None
+    description: str | None = None
+    galaxy_id: int | None = None
+    source: str | None = None
+    authors: list[str] | None = None
+    version: int | None = None
+    distribution: DistributionLevels
+    sharing_group_id: int | None = None
+    org_id: int | None = None
+    orgc_id: int | None = None
+    default: bool | None = None
+    locked: bool | None = None
+    extends_uuid: str | None = None
+    extends_version: str | None = None
+    published: bool | None = None
+    deleted: bool | None = None
+    GalaxyElement: list[AddUpdateGalaxyElement] | None = None
+
+
+class AddGalaxyClusterResponse(BaseModel):
+    pass
+
+
+class GalaxyClusterRelation(BaseModel):
+    id: int
+    galaxy_cluster_id: int
+    referenced_galaxy_cluster_id: int
+    referenced_galaxy_cluster_uuid: str
+    referenced_galaxy_cluster_type: str
+    galaxy_cluster_uuid: str
+    distribution: str
+    sharing_group_id: int | None = None
+    default: bool
+
+
+_GalaxyClusterRelation = GalaxyClusterRelation
+
+
+class SearchGalaxyClusterGalaxyClustersDetails(BaseModel):
+    # if minimal is set, only uuid, version and Galaxy is returned
+
+    id: int | None = None
+    uuid: str
+    collection_uuid: str | None = None
+    type: str | None = None
+    value: str | None = None
+    tag_name: str | None = None
+    description: str | None = None
+    galaxy_id: int | None = None
+    source: str | None = None
+    authors: list[str] | None = None
+    version: str | int
+    distribution: str | int | None = None
+    sharing_group_id: int | None = None
+    org_id: int | None = None
+    orgc_id: int | None = None
+    default: bool | None = None
+    locked: bool | None = None
+    extends_uuid: str | None = None
+    extends_version: str | None = None
+    published: bool | None = None
+    deleted: bool | None = None
+    GalaxyElement: Optional[list[ExportGalaxyGalaxyElement]] = None
+    Galaxy: RestSearchGalaxyBody
+    GalaxyClusterRelation: list[_GalaxyClusterRelation] | None = None
+    Org: GetOrganisationElement | None = None
+    Orgc: GetOrganisationElement | None = None
+
+
+class SearchGalaxyClusterGalaxyClusters(BaseModel):
+    GalaxyCluster: SearchGalaxyClusterGalaxyClustersDetails
+
+
+class GalaxyClusterSearchResponse(BaseModel):
+    response: list[SearchGalaxyClusterGalaxyClusters]
+
+
+class GalaxyClusterSearchBody(BaseModel):
+    limit: int | None = None
+    page: int | None = None
+    id: list[int] | None = None
+    uuid: list[str] | None = None
+    galaxy_id: int | None = None
+    galaxy_uuid: str | None = None
+    published: bool | None = None
+    value: str | None = None
+    extends_uuid: str | None = None
+    extends_version: str | None = None
+    version: int | None = None
+    distribution: int | None = None
+    org_id: int | None = None
+    orgc_id: int | None = None
+    tag_name: str | None = None
+    custom: bool | None = None  # not sure if bool
+    minimal: bool | None = None

{mmisp_lib-0.10.1 → mmisp_lib-0.11.0}/src/mmisp/api_schemas/galaxy_common.py

@@ -7,6 +7,42 @@ from pydantic import BaseModel, Field, field_serializer
 from mmisp.lib.distribution import GalaxyDistributionLevels
 
 
+class ShortCommonGalaxy(BaseModel):
+    id: int
+    uuid: UUID
+    name: str
+    type: str
+    description: str
+    version: str | int
+    namespace: str
+    kill_chain_order: str | None = None
+    default: bool
+
+
+class ShortCommonGalaxyCluster(BaseModel):
+    id: int
+    uuid: UUID
+    collection_uuid: UUID | Literal[""]
+    type: str
+    value: str
+    tag_name: str
+    description: str
+    galaxy_id: int
+    source: str
+    authors: list[str]
+    version: str | int
+    distribution: GalaxyDistributionLevels | None = None
+    sharing_group_id: int | None = None
+    org_id: int
+    orgc_id: int
+    default: bool | None = None
+    locked: bool | None = None
+    extends_uuid: UUID | Literal[""] | None = None
+    extends_version: str | int | None = None
+    published: bool | None = None
+    deleted: bool | None = None
+
+
 class CommonGalaxy(BaseModel):
     id: int
     uuid: UUID
@@ -42,7 +78,7 @@ class GalaxyClusterMeta(BaseModel):
 class CommonGalaxyCluster(BaseModel):
     id: int
     uuid: UUID
-    collection_uuid: UUID | Literal[""]
+    collection_uuid: Literal[""] | UUID
     type: str
     value: str
     tag_name: str
@@ -57,7 +93,7 @@ class CommonGalaxyCluster(BaseModel):
     orgc_id: int
     default: bool | None = None
     locked: bool | None = None
-    extends_uuid: UUID | Literal[""] | None = None
+    extends_uuid: Literal[""] | UUID | None = None
     extends_version: str | int | None = None
     published: bool | None = None
     deleted: bool | None = None

{mmisp_lib-0.10.1 → mmisp_lib-0.11.0}/src/mmisp/api_schemas/object_templates.py

@@ -2,21 +2,26 @@ from uuid import UUID
 
 from pydantic import BaseModel, ConfigDict, Field
 
+from mmisp.lib.attributes import (
+    AttributeCategories,
+    literal_valid_attribute_types,
+)
+
 
 class CommonObjectTemplateElement(BaseModel):
     ui_priority: int = Field(..., alias="ui-priority")
-    categories: list
-    sane_default: list
-    values_list: list
     description: str
-    disable_correlation: bool | None
-    multiple: bool
+    categories: list[AttributeCategories] = []
+    sane_default: list[str] = []
+    values_list: list[str] = []
+    disable_correlation: bool | None = None
+    multiple: bool = False
 
 
 class ImportObjectTemplateElement(CommonObjectTemplateElement):
-    misp_attribute: str = Field(..., alias="misp-attribute")
-    recommended: bool
-    to_ids: bool
+    misp_attribute: literal_valid_attribute_types = Field(..., alias="misp-attribute")
+    recommended: bool = False
+    to_ids: bool = True
 
 
 class ObjectTemplatesRequirements(BaseModel):

{mmisp_lib-0.10.1 → mmisp_lib-0.11.0}/src/mmisp/api_schemas/objects.py

@@ -108,12 +108,12 @@ class ObjectSearchResponse(BaseModel):
 
 
 class ObjectCreateBody(BaseModel):
-    name: str = Field(min_length=1)
+    name: str | None = None
     meta_category: str | None = None
     description: str | None = None
     distribution: AttributeDistributionLevels | None = None
-    sharing_group_id: int
-    comment: str = Field(min_length=1)
+    sharing_group_id: int = 0
+    comment: str = ""
     deleted: bool | None = None
     first_seen: int | None = None
     last_seen: int | None = None

{mmisp_lib-0.10.1 → mmisp_lib-0.11.0}/src/mmisp/api_schemas/organisations.py

@@ -1,7 +1,8 @@
 from datetime import datetime
-from typing import Self
+from typing import Any, Literal, Self, Type
+from uuid import UUID
 
-from pydantic import BaseModel, field_serializer
+from pydantic import BaseModel, field_serializer, field_validator
 
 
 class BaseOrganisation(BaseModel):
@@ -10,7 +11,7 @@ class BaseOrganisation(BaseModel):
     nationality: str | None = None
     sector: str | None = None
     type: str | None = None
-    uuid: str | None = None
+    uuid: UUID | None = None
 
 
 class Organisation(BaseOrganisation):
@@ -29,13 +30,13 @@ class Organisation(BaseOrganisation):
         return value.strftime("%Y-%m-%d %H:%M:%S")
 
 
-class GetOrganisationResponse(BaseModel):
+class GetOrganisationElement(BaseModel):
     id: int
     name: str
     nationality: str | None = None
     sector: str | None = None
     type: str | None = None
-    uuid: str | None = None
+    uuid: UUID | Literal["0"] | None = None
     # the fallback GENERIC_MISP_ORGANISATION doesn't have this property
     # str is needed because its returned as string
     date_created: datetime | None = None
@@ -44,7 +45,7 @@ class GetOrganisationResponse(BaseModel):
     created_by: int
     contacts: str | None = None
     local: bool
-    restricted_to_domain: list | str | None = None
+    restricted_to_domain: list[str] | None = None
     landingpage: str | None = None
 
     @field_serializer("date_created", "date_modified")
@@ -53,8 +54,19 @@ class GetOrganisationResponse(BaseModel):
             return ""
         return value.strftime("%Y-%m-%d %H:%M:%S")
 
+    @field_validator("restricted_to_domain", mode="before")
+    @classmethod
+    def ensure_list(cls: Type[Self], v: Any) -> Any:
+        if not isinstance(v, list):
+            return [v]
+        return v
+
 
-class GetAllOrganisationsOrganisation(GetOrganisationResponse):
+class GetOrganisationResponse(BaseModel):
+    Organisation: GetOrganisationElement
+
+
+class GetAllOrganisationsOrganisation(GetOrganisationElement):
     user_count: int
     created_by_email: str
 
@@ -95,7 +107,8 @@ class OrganisationUsersResponse(BaseModel):
 
 
 class AddOrganisation(BaseModel):
-    id: int
+    id: int | None = None
+    uuid: UUID | None = None
     name: str
     description: str | None = None
     type: str
@@ -105,7 +118,7 @@ class AddOrganisation(BaseModel):
     contacts: str | None = None
     local: bool
     """organisation gains access to the local instance, otherwise treated as external"""
-    restricted_to_domain: list[str] | None = None
+    restricted_to_domain: list[str] | str | None = None
     landingpage: str | None = None