mmisp-lib 0.8.3__tar.gz → 0.9.0__tar.gz

{mmisp_lib-0.8.3 → mmisp_lib-0.9.0}/PKG-INFO

@@ -1,10 +1,10 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mmisp-lib
-Version: 0.8.3
+Version: 0.9.0
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastapi==0.104.1
+Requires-Dist: fastapi>=0.104.1
 Requires-Dist: SQLAlchemy[asyncio]~=1.4.46
 Requires-Dist: pydantic==1.10.13
 Requires-Dist: uvicorn==0.24.0.post1
@@ -36,6 +36,7 @@ Requires-Dist: icecream; extra == "dev"
 Requires-Dist: asyncio; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Requires-Dist: build; extra == "dev"
+Dynamic: license-file
 
 # Modern MISP - API
 

{mmisp_lib-0.8.3 → mmisp_lib-0.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mmisp-lib"
-version = "0.8.3"
+version = "0.9.0"
 description = ""
 authors = []
 readme = "README.md"
@@ -8,7 +8,7 @@ requires-python = ">=3.11.0"
 
 
 dependencies = [
-  "fastapi==0.104.1",
+  "fastapi>=0.104.1",
   "SQLAlchemy[asyncio]~=1.4.46",
   "pydantic==1.10.13",
   "uvicorn==0.24.0.post1",

{mmisp_lib-0.8.3 → mmisp_lib-0.9.0}/src/mmisp/api_schemas/attributes.py

@@ -1,6 +1,6 @@
-from typing import Annotated, Any, Dict, Optional, Type
+from typing import Annotated, Any, Optional, Type
 
-from pydantic import BaseModel, Field, root_validator, validator
+from pydantic import BaseModel, Field, root_validator
 
 from mmisp.lib.attributes import (
     AttributeCategories,
@@ -10,6 +10,7 @@ from mmisp.lib.attributes import (
     mapper_val_safe_clsname,
     to_ids,
 )
+from mmisp.lib.distribution import AttributeDistributionLevels
 
 
 class GetAttributeTag(BaseModel):
@@ -48,7 +49,7 @@ class SearchAttributesAttributesDetails(BaseModel):
     to_ids: bool
     uuid: str
     timestamp: str
-    distribution: str
+    distribution: AttributeDistributionLevels
     sharing_group_id: int | None = None
     comment: str | None = None
     deleted: bool
@@ -155,7 +156,7 @@ class RestoreAttributeResponse(BaseModel):
     to_ids: bool
     uuid: str
     timestamp: str
-    distribution: str
+    distribution: AttributeDistributionLevels
     sharing_group_id: int
     comment: str
     deleted: bool
@@ -200,7 +201,7 @@ class GetAttributeAttributes(BaseModel):
     to_ids: bool
     uuid: str
     timestamp: str
-    distribution: str
+    distribution: AttributeDistributionLevels
     sharing_group_id: int
     comment: str | None = None
     deleted: bool = False
@@ -231,7 +232,7 @@ class GetAllAttributesResponse(BaseModel):
     to_ids: bool | None = None
     uuid: str | None = None
     timestamp: str | None = None
-    distribution: str | None = None
+    distribution: AttributeDistributionLevels | None = None
     sharing_group_id: int | None = None
     comment: str | None = None
     deleted: bool | None = None
@@ -240,18 +241,18 @@ class GetAllAttributesResponse(BaseModel):
     last_seen: str | None = None
     value: str | None = None
 
-    @validator("sharing_group_id", always=True, allow_reuse=True)
-    @classmethod
-    def check_sharing_group_id(
-        cls: Type["GetAllAttributesResponse"], value: Any, values: Dict[str, Any]
-    ) -> Optional[int]:  # noqa: ANN101
-        """
-        If distribution equals 4, sharing_group_id will be shown.
-        """
-        distribution = values.get("distribution", None)
-        if distribution == "4" and value is not None:
-            return value
-        return None
+    #    @validator("sharing_group_id", always=True, allow_reuse=True)
+    #    @classmethod
+    #    def check_sharing_group_id(
+    #        cls: Type["GetAllAttributesResponse"], value: Any, values: Dict[str, Any]
+    #    ) -> Optional[int]:  # noqa: ANN101
+    #        """
+    #        If distribution equals 4, sharing_group_id will be shown.
+    #        """
+    #        distribution = values.get("distribution", None)
+    #        if distribution == "4" and value is not None:
+    #            return value
+    #        return None
 
     class Config:
         orm_mode = True
@@ -281,7 +282,7 @@ class EditAttributeAttributes(BaseModel):
     to_ids: bool
     uuid: str
     timestamp: str
-    distribution: str
+    distribution: AttributeDistributionLevels
     sharing_group_id: int
     comment: str | None = None
     deleted: bool
@@ -309,7 +310,7 @@ class EditAttributeBody(BaseModel):
     to_ids: bool | None = None
     uuid: str | None = None
     timestamp: str | None = None
-    distribution: str | None = None
+    distribution: AttributeDistributionLevels | None = None
     sharing_group_id: int | None = None
     comment: str | None = None
     deleted: bool | None = None
@@ -327,15 +328,7 @@ class DeleteSelectedAttributeResponse(BaseModel):
     name: str
     message: str
     url: str
-    id: int
-
-    class Config:
-        orm_mode = True
-
-
-class DeleteSelectedAttributeBody(BaseModel):
-    id: str  # ids can be space separated, id = "all" deletes all attributes in the event
-    allow_hard_delete: bool | None = None
+    id: str
 
     class Config:
         orm_mode = True
@@ -371,7 +364,7 @@ class AddAttributeAttributes(BaseModel):
     to_ids: bool
     uuid: str
     timestamp: str
-    distribution: str
+    distribution: AttributeDistributionLevels
     sharing_group_id: int
     comment: str | None = None
     deleted: bool
@@ -400,7 +393,7 @@ class AddAttributeBody(BaseModel):
     to_ids: bool | None = None
     uuid: str | None = None
     timestamp: str | None = None
-    distribution: str | None = None
+    distribution: AttributeDistributionLevels | None = None
     sharing_group_id: int | None = None
     comment: str | None = None
     deleted: bool | None = None

mmisp_lib-0.9.0/src/mmisp/api_schemas/common.py

@@ -0,0 +1,53 @@
+from datetime import datetime
+
+from pydantic import BaseModel
+
+
+class TagAttributesResponse(BaseModel):
+    id: int
+    name: str
+    colour: str
+    exportable: bool
+    org_id: int | None = None
+    user_id: int | None = None
+    hide_tag: bool | None = None
+    numerical_value: str | None = None
+    is_galaxy: bool | None = None
+    is_custom_galaxy: bool | None = None
+    local_only: bool | None = None
+
+
+class User(BaseModel):
+    id: int
+    org_id: int
+    email: str
+    autoalert: bool
+    invited_by: int
+    gpgkey: str | None = None
+    certif_public: str | None = None
+    termsaccepted: bool
+    role_id: int
+    change_pw: bool
+    contactalert: bool
+    disabled: bool
+    expiration: datetime | int | None = None
+    current_login: int
+    """time in seconds"""
+    last_login: int
+    """time in seconds"""
+    force_logout: bool
+    date_created: int
+    """time in seconds"""
+    date_modified: int
+    """time in seconds"""
+    external_auth_required: bool
+    external_auth_key: str | None = None
+    last_api_access: int
+    """time in seconds"""
+    notification_daily: bool
+    notification_weekly: bool
+    notification_monthly: bool
+    totp: str | None = None
+    hotp_counter: int | None = None
+    last_pw_change: int | None = None
+    """time in seconds"""

{mmisp_lib-0.8.3 → mmisp_lib-0.9.0}/src/mmisp/api_schemas/events.py

@@ -1,9 +1,10 @@
+import uuid
 from datetime import datetime
-from typing import Any, Type
 
-from pydantic import BaseModel, PositiveInt, conint, validator
+from pydantic import BaseModel, Field, PositiveInt, conint
 
 from mmisp.api_schemas.organisations import Organisation
+from mmisp.api_schemas.sharing_groups import EventSharingGroupResponse, MinimalSharingGroup
 from mmisp.lib.distribution import DistributionLevels
 
 
@@ -224,6 +225,7 @@ class AddEditGetEventAttribute(BaseModel):
     first_seen: str | None = None
     last_seen: str | None = None
     Galaxy: list[AddEditGetEventGalaxy] = []
+    sharing_group: EventSharingGroupResponse | None = Field(alias="SharingGroup", default=None)
     ShadowAttribute: list[str] = []
     Tag: list[AddEditGetEventTag] = []
 
@@ -314,7 +316,7 @@ class AddEditGetEventDetails(BaseModel):
     disable_correlation: bool
     extends_uuid: str
     protected: bool | None = None
-    event_creator_email: str
+    event_creator_email: str | None = None
     Org: AddEditGetEventOrg
     Orgc: AddEditGetEventOrg
     Attribute: list[AddEditGetEventAttribute] = []
@@ -325,7 +327,7 @@ class AddEditGetEventDetails(BaseModel):
     EventReport: list[AddEditGetEventEventReport] = []
     CryptographicKey: list[str] = []
     Tag: list[AddEditGetEventTag] = []
-
+    sharing_group: EventSharingGroupResponse | None = Field(alias="SharingGroup", default=None)
     #    @validator("uuid", "extends_uuid", pre=True)
     #    @classmethod
     #    def uuid_empty_str(cls: Type["AddEditGetEventDetails"], value: Any) -> Any:  # noqa: ANN102
@@ -343,12 +345,13 @@ class AddEditGetEventDetails(BaseModel):
     #
     #        return value
 
-    @validator("sharing_group_id", pre=True)
-    @classmethod
-    def zero_sharing_group_id_to_none(cls: Type["AddEditGetEventDetails"], value: Any) -> Any:  # noqa: ANN102
-        if value is not None and value == 0:
-            return None
-        return value
+
+#    @validator("sharing_group_id", pre=True)
+#    @classmethod
+#    def zero_sharing_group_id_to_none(cls: Type["AddEditGetEventDetails"], value: Any) -> Any:  # noqa: ANN102
+#        if value is not None and value == 0:
+#            return "0"
+#        return value
 
 
 class AddEditGetEventResponse(BaseModel):
@@ -370,7 +373,7 @@ class UnpublishEventResponse(BaseModel):
     name: str
     message: str
     url: str
-    id: int | None = None
+    id: uuid.UUID | int | None = None
 
     class Config:
         orm_mode = True
@@ -431,21 +434,21 @@ class PublishEventResponse(BaseModel):
     name: str
     message: str
     url: str
-    id: int | None = None
+    id: uuid.UUID | int | None = None
 
     class Config:
         orm_mode = True
 
 
 class GetAllEventsEventTagTag(BaseModel):
-    id: int
+    id: uuid.UUID | int
     name: str
     colour: str
     is_galaxy: bool
 
 
 class IndexEventsEventTag(BaseModel):
-    id: int
+    id: uuid.UUID | int
     event_id: int
     tag_id: int
     local: bool
@@ -512,15 +515,15 @@ class IndexEventsBody(BaseModel):
 
 
 class ObjectEventResponse(BaseModel):
-    id: int
+    id: uuid.UUID | int
     info: str
     org_id: int | None = None
     orgc_id: int | None = None
 
 
 class GetAllEventsEventTag(BaseModel):
-    id: int
-    event_id: int
+    id: uuid.UUID | int
+    event_id: uuid.UUID | int
     tag_id: int
     local: bool
     relationship_type: bool | str | None = None
@@ -548,7 +551,8 @@ class GetAllEventsResponse(BaseModel):
     disable_correlation: bool
     extends_uuid: str
     event_creator_email: str | None = None  # omitted
-    protected: str | None = None
+    protected: bool | None = None
+    SharingGroup: MinimalSharingGroup | None = None
     Org: GetAllEventsOrg
     Orgc: GetAllEventsOrg
     GalaxyCluster: list[GetAllEventsGalaxyCluster]
@@ -578,7 +582,7 @@ class EditEventBody(BaseModel):
     disable_correlation: bool | None = None
     extends_uuid: str | None = None
     event_creator_email: str | None = None
-    protected: str | None = None
+    protected: bool | None = None
     cryptographic_key: str | None = None
 
     class Config:
@@ -591,7 +595,7 @@ class DeleteEventResponse(BaseModel):
     name: str
     message: str
     url: str
-    id: int
+    id: uuid.UUID | int
     errors: str | None = None
 
     class Config:
@@ -627,10 +631,7 @@ class AddEventBody(BaseModel):
     sighting_timestamp: str | None = None
     disable_correlation: bool | None = None
     extends_uuid: str | None = None
-    protected: str | None = None
-
-    class Config:
-        orm_mode = True
+    protected: bool | None = None
 
 
 class AddEventTag(BaseModel):

mmisp_lib-0.9.0/src/mmisp/api_schemas/roles.py

@@ -0,0 +1,205 @@
+from datetime import datetime
+from typing import Any, Self
+
+from pydantic import BaseModel
+
+from mmisp.lib.permissions import Permission
+
+
+class HasPermission(BaseModel):
+    perm_add: bool | None = None
+    perm_modify: bool | None = None
+    perm_modify_org: bool | None = None
+    perm_publish: bool | None = None
+    perm_delegate: bool | None = None
+    perm_sync: bool | None = None
+    perm_admin: bool | None = None
+    perm_audit: bool | None = None
+    perm_auth: bool | None = None
+    perm_site_admin: bool | None = None
+    perm_regexp_access: bool | None = None
+    perm_tagger: bool | None = None
+    perm_template: bool | None = None
+    perm_sharing_group: bool | None = None
+    perm_tag_editor: bool | None = None
+    perm_sighting: bool | None = None
+    perm_object_template: bool | None = None
+    perm_publish_zmq: bool | None = None
+    perm_publish_kafka: bool | None = None
+    perm_decaying: bool | None = None
+    perm_galaxy_editor: bool | None = None
+    perm_warninglist: bool | None = None
+    perm_view_feed_correlations: bool | None = None
+    perm_skip_otp: bool | None = None
+    perm_server_sign: bool | None = None
+    perm_analyst_data: bool | None = None
+    perm_sync_authoritative: bool | None = None
+    perm_sync_internal: bool | None = None
+
+
+class Role(HasPermission):
+    id: int
+    name: str
+    created: datetime | str | None = None
+    modified: datetime | str | None = None
+    default_role: bool
+    memory_limit: str | None
+    max_execution_time: str | None
+    restricted_to_site_admin: bool
+    enforce_rate_limit: bool
+    rate_limit_count: str  # number as string
+    permission: str | None  # number as string
+    permission_description: str | None
+
+
+class RoleUsersResponse(HasPermission):
+    id: int
+    name: str
+    created: datetime | str | None = None
+    modified: datetime | str | None = None
+    default_role: bool | None = None
+    memory_limit: str | None = None
+    max_execution_time: str | None = None
+    restricted_to_site_admin: bool | None = None
+    enforce_rate_limit: bool | None = None
+    rate_limit_count: str | None = None  # number as string
+
+
+class RoleAttributeResponse(HasPermission):
+    id: int
+    name: str
+    created: datetime | str | None = None
+    modified: datetime | str | None = None
+    default_role: bool
+    memory_limit: str | None
+    max_execution_time: str | None
+    restricted_to_site_admin: bool
+    enforce_rate_limit: bool
+    rate_limit_count: int
+    permission: int | None = None
+    permission_description: str | None = None
+    default: bool | None = False
+
+
+class GetRolesResponse(BaseModel):
+    Role: RoleAttributeResponse
+
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
+
+class GetRoleResponse(BaseModel):
+    Role: RoleAttributeResponse | None = None
+
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
+
+class AddRoleBody(HasPermission):
+    name: str
+    default_role: bool
+    memory_limit: str | None = None
+    max_execution_time: str | None = None
+    restricted_to_site_admin: bool
+    enforce_rate_limit: bool
+    rate_limit_count: int
+
+
+class AddRoleResponse(BaseModel):
+    Role: RoleAttributeResponse
+    created: bool
+    message: str
+
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
+
+class DeleteRoleResponse(BaseModel):
+    Role: RoleAttributeResponse | None = None
+    saved: bool
+    success: bool | None = None
+    name: str
+    message: str
+    url: str
+    id: int
+    errors: str | None = None
+
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
+
+class EditRoleBody(HasPermission):
+    name: str | None = None
+    default_role: bool | None = None
+    memory_limit: str | None = None
+    max_execution_time: str | None = None
+    restricted_to_site_admin: bool | None = None
+    enforce_rate_limit: bool | None = None
+
+
+class EditRoleResponse(BaseModel):
+    Role: RoleAttributeResponse
+
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
+    def dict(self: Self, **kwargs) -> dict[str, Any]:
+        data = super().dict(**kwargs)
+        if "Role" in data:
+            data["Role"].pop("default", None)
+        return data
+
+
+class ReinstateRoleResponse(BaseModel):
+    Role: RoleAttributeResponse
+    success: bool
+    message: str
+    url: str
+    id: int
+
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
+
+class FilterRoleBody(BaseModel):
+    # filter can be expanded by adding more criteria to filter for
+    permissions: list[Permission] | None = None
+
+
+class FilterRoleResponse(BaseModel):
+    Role: RoleAttributeResponse
+
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
+
+class EditUserRoleBody(BaseModel):
+    role_id: int
+
+
+class EditUserRoleResponse(BaseModel):
+    saved: bool
+    success: bool | None = None
+    name: str
+    message: str
+    url: str
+    id: int
+    Role: str | None = None
+
+
+class GetUserRoleResponse(BaseModel):
+    user_id: int
+
+
+class DefaultRoleResponse(BaseModel):
+    Role: RoleAttributeResponse | None = None
+    saved: bool
+    success: bool | None = None
+    name: str
+    message: str
+    url: str
+    id: int
+    errors: str | None = None
+
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}

{mmisp_lib-0.8.3 → mmisp_lib-0.9.0}/src/mmisp/api_schemas/sharing_groups.py

@@ -26,6 +26,12 @@ class SharingGroup(BaseModel):
 #    org_count: int = 0
 
 
+class MinimalSharingGroup(BaseModel):
+    id: int
+    name: str
+    uuid: str
+
+
 class ShortSharingGroup(BaseModel):
     id: int
     name: str
@@ -59,6 +65,16 @@ class SharingGroupOrg(BaseModel):
     extend: bool
 
 
+class SharingGroupOrgWithOrganisation(SharingGroupOrg):
+    Organisation: ShortOrganisation
+
+
+class EventSharingGroupResponse(SharingGroup):
+    Organisation: ShortOrganisation
+    SharingGroupOrg: list[SharingGroupOrgWithOrganisation]
+    SharingGroupServer: list
+
+
 class GetAllSharingGroupsResponseResponseItemSharingGroup(BaseModel):
     id: int
     uuid: str
@@ -89,10 +105,13 @@ class ViewUpdateSharingGroupLegacyResponseSharingGroupServerItem(BaseModel):
     Server: ViewUpdateSharingGroupLegacyResponseServerInfo
 
 
-class ViewUpdateSharingGroupLegacyResponseOrganisationInfo(BaseModel):
+class SharingGroupOrgOrganisationIndexInfo(BaseModel):
     id: int
     uuid: str
     name: str
+
+
+class ViewUpdateSharingGroupLegacyResponseOrganisationInfo(SharingGroupOrgOrganisationIndexInfo):
     local: bool
 
 
@@ -104,15 +123,36 @@ class ViewUpdateSharingGroupLegacyResponseSharingGroupOrgItem(BaseModel):
     Organisation: ViewUpdateSharingGroupLegacyResponseOrganisationInfo
 
 
+class SharingGroupOrgIndexItem(BaseModel):
+    id: int
+    sharing_group_id: int
+    org_id: int
+    extend: bool
+    Organisation: SharingGroupOrgOrganisationIndexInfo
+
+
 class SharingGroupResponse(BaseModel):
+    editable: bool | None = None
+    deletable: bool | None = None
+
     SharingGroup: ShortSharingGroup
     Organisation: ShortOrganisation
     SharingGroupOrg: list[ViewUpdateSharingGroupLegacyResponseSharingGroupOrgItem]
     SharingGroupServer: list[ViewUpdateSharingGroupLegacyResponseSharingGroupServerItem]
 
+    class Config:
+        json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
+
+
+class SharingGroupIndexResponse(BaseModel):
     editable: bool | None = None
     deletable: bool | None = None
 
+    SharingGroup: ShortSharingGroup
+    Organisation: ShortOrganisation
+    SharingGroupOrg: list[SharingGroupOrgIndexItem]
+    SharingGroupServer: list[ViewUpdateSharingGroupLegacyResponseSharingGroupServerItem]
+
     class Config:
         json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}
 
@@ -132,7 +172,7 @@ class ViewUpdateSharingGroupLegacyResponse(SharingGroupResponse):
 
 
 class GetSharingGroupsIndex(BaseModel):
-    response: list[SharingGroupResponse]
+    response: list[SharingGroupIndexResponse]
 
     class Config:
         json_encoders = {datetime: lambda v: v.strftime("%Y-%m-%d %H:%M:%S")}