mmisp-lib 0.1.0__py3-none-any.whl

mmisp/api_schemas/events/search_events_body.py

@@ -0,0 +1,43 @@
+from pydantic import BaseModel
+
+
+class SearchEventsBody(BaseModel):
+    returnFormat: str
+    page: int | None = None
+    limit: int | None = None
+    value: str | None = None
+    type: str | None = None
+    category: str | None = None
+    org: str | None = None
+    tags: list[str] | None = None
+    event_tags: list[str] | None = None
+    searchall: str | None = None
+    from_: str | None = None
+    to: str | None = None
+    last: int | None = None
+    eventid: str | None = None
+    withAttachments: bool | None = None
+    sharinggroup: list[str] | None = None
+    metadata: bool | None = None
+    uuid: str | None = None
+    publish_timestamp: str | None = None
+    timestamp: str | None = None
+    published: bool | None = None
+    enforceWarninglist: bool | None = None
+    sgReferenceOnly: bool | None = None
+    requested_attributes: list[str] | None = None
+    includeContext: bool | None = None
+    headerless: bool | None = None
+    includeWarninglistHits: bool | None = None
+    attackGalaxy: str | None = None
+    to_ids: bool | None = None
+    deleted: bool | None = None
+    excludeLocalTags: bool | None = None
+    date: str | None = None
+    includeSightingdb: bool | None = None
+    tag: str | None = None
+    object_relation: str | None = None
+    threat_level_id: str | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/events/search_events_response.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel
+
+from .add_edit_get_event_response import AddEditGetEventResponse
+
+
+class SearchEventsResponse(BaseModel):
+    response: list[AddEditGetEventResponse]
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/events/unpublish_event_response.py

@@ -0,0 +1,13 @@
+from pydantic import BaseModel
+
+
+class UnpublishEventResponse(BaseModel):
+    saved: bool | None = None
+    success: bool | None = None
+    name: str
+    message: str
+    url: str
+    id: str | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/feeds/cache_feed_response.py

@@ -0,0 +1,12 @@
+from pydantic import BaseModel
+
+
+class FeedCacheResponse(BaseModel):
+    name: str
+    message: str
+    url: str
+    saved: bool
+    success: bool
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/feeds/create_feed_body.py

@@ -0,0 +1,30 @@
+from pydantic import BaseModel, Field
+
+
+class FeedCreateBody(BaseModel):
+    name: str = Field(min_length=1)
+    provider: str = Field(min_length=1)
+    url: str = Field(min_length=1)
+    rules: str | None = None
+    enabled: bool | None = None
+    distribution: str | None = None
+    sharing_group_id: str | None = None
+    tag_id: str | None = None
+    default: bool | None = None
+    source_format: str | None = None
+    fixed_event: bool | None = None
+    delta_merge: bool | None = None
+    event_id: str | None = None
+    publish: bool | None = None
+    override_ids: bool | None = None
+    settings: str | None = None
+    input_source: str | None = None
+    delete_local_file: bool | None = None
+    lookup_visible: bool | None = None
+    headers: str | None = None
+    caching_enabled: bool | None = None
+    force_to_ids: bool | None = None
+    orgc_id: str | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/feeds/enable_disable_feed_response.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel
+
+
+class FeedEnableDisableResponse(BaseModel):
+    name: str
+    message: str
+    url: str
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/feeds/fetch_feeds_response.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+
+
+class FeedFetchResponse(BaseModel):
+    result: str
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/feeds/get_feed_response.py

@@ -0,0 +1,47 @@
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, validator
+
+
+class FeedAttributesResponse(BaseModel):
+    id: str
+    name: str
+    provider: str
+    url: str
+    rules: str | None = None
+    enabled: bool | None = None
+    distribution: str
+    sharing_group_id: str | None = None
+    tag_id: str
+    default: bool | None = None
+    source_format: str | None = None
+    fixed_event: bool
+    delta_merge: bool
+    event_id: str
+    publish: bool
+    override_ids: bool
+    settings: str | None = None
+    input_source: str
+    delete_local_file: bool | None = None
+    lookup_visible: bool | None = None
+    headers: str | None = None
+    caching_enabled: bool
+    force_to_ids: bool
+    orgc_id: str
+
+    @validator("sharing_group_id", always=True)
+    def check_sharing_group_id(cls, 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 FeedResponse(BaseModel):
+    Feed: FeedAttributesResponse
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/feeds/toggle_feed_body.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+
+
+class FeedToggleBody(BaseModel):
+    enable: bool
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/feeds/update_feed_body.py

@@ -0,0 +1,30 @@
+from pydantic import BaseModel
+
+
+class FeedUpdateBody(BaseModel):
+    name: str | None = None
+    provider: str | None = None
+    url: str | None = None
+    rules: str | None = None
+    enabled: bool | None = None
+    distribution: str | None = None
+    sharing_group_id: str | None = None
+    tag_id: str | None = None
+    default: bool | None = None
+    source_format: str | None = None
+    fixed_event: bool | None = None
+    delta_merge: bool | None = None
+    event_id: str | None = None
+    publish: bool | None = None
+    override_ids: bool | None = None
+    settings: str | None = None
+    input_source: str | None = None
+    delete_local_file: bool | None = None
+    lookup_visible: bool | None = None
+    headers: str | None = None
+    caching_enabled: bool | None = None
+    force_to_ids: bool | None = None
+    orgc_id: str | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/galaxies/attach_galaxy_cluster_body.py

@@ -0,0 +1,12 @@
+from pydantic import BaseModel
+
+
+class AttachClusterGalaxyAttributes(BaseModel):
+    target_id: int
+
+
+class AttachClusterGalaxyBody(BaseModel):
+    Galaxy: AttachClusterGalaxyAttributes
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/galaxies/attach_galaxy_cluster_response.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel
+
+
+class AttachClusterGalaxyResponse(BaseModel):
+    saved: bool
+    success: str
+    check_publish: bool
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/galaxies/delete_force_update_import_galaxy_response.py

@@ -0,0 +1,12 @@
+from pydantic import BaseModel
+
+
+class DeleteForceUpdateImportGalaxyResponse(BaseModel):
+    saved: bool | None = None
+    success: bool | None = None
+    name: str
+    message: str
+    url: str
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/galaxies/export_galaxies_body.py

@@ -0,0 +1,16 @@
+from pydantic import BaseModel
+
+
+class ExportGalaxyAttributes(BaseModel):
+    default: bool
+    custom: bool | None = None
+    distribution: str
+    format: str | None = None
+    download: bool | None = None
+
+
+class ExportGalaxyBody(BaseModel):
+    Galaxy: ExportGalaxyAttributes
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/galaxies/export_galaxies_response.py

@@ -0,0 +1,44 @@
+from pydantic import BaseModel
+
+from mmisp.api_schemas.events.add_edit_get_event_response import AddEditGetEventGalaxyClusterRelation
+from mmisp.api_schemas.events.get_all_events_response import GetAllEventsGalaxyClusterGalaxy
+from mmisp.api_schemas.organisations.organisation import Organisation
+
+
+class ExportGalaxyGalaxyElement(BaseModel):
+    id: str | None = None
+    galaxy_cluster_id: str | None = None
+    key: str
+    value: str
+
+
+class ExportGalaxyClusterResponse(BaseModel):
+    id: str
+    uuid: str
+    collection_uuid: str
+    type: str
+    value: str
+    tag_name: str
+    description: str
+    galaxy_id: str
+    source: str
+    authors: list[str]
+    version: str
+    distribution: str
+    sharing_group_id: str
+    org_id: str
+    orgc_id: str
+    default: bool
+    locked: bool
+    extends_uuid: str
+    extends_version: str
+    published: bool
+    deleted: bool
+    GalaxyElement: list[ExportGalaxyGalaxyElement]
+    Galaxy: GetAllEventsGalaxyClusterGalaxy
+    GalaxyClusterRelation: list[AddEditGetEventGalaxyClusterRelation] = []
+    Org: Organisation
+    Orgc: Organisation
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/galaxies/galaxy_schema.py

@@ -0,0 +1,18 @@
+from typing import List
+
+from pydantic import BaseModel
+
+
+class GalaxySchema(BaseModel):
+    id: str
+    uuid: str
+    name: str
+    type: str
+    description: str
+    version: str
+    icon: str
+    namespace: str
+    kill_chain_order: List[str]
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/galaxies/get_all_search_galaxies_response.py

@@ -0,0 +1,22 @@
+from pydantic import BaseModel
+
+
+class GetAllSearchGalaxiesAttributes(BaseModel):
+    id: str
+    uuid: str
+    name: str
+    type: str
+    description: str
+    version: str
+    icon: str
+    namespace: str
+    kill_chain_order: str | None = None
+    enabled: bool
+    local_only: bool
+
+
+class GetAllSearchGalaxiesResponse(BaseModel):
+    Galaxy: GetAllSearchGalaxiesAttributes
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/galaxies/get_galaxy_response.py

@@ -0,0 +1,37 @@
+from pydantic import BaseModel
+
+from .export_galaxies_response import ExportGalaxyGalaxyElement
+from .get_all_search_galaxies_response import GetAllSearchGalaxiesAttributes
+
+
+class GetGalaxyClusterResponse(BaseModel):
+    id: str | None = None
+    uuid: str | None = None
+    collection_uuid: str
+    type: str
+    value: str
+    tag_name: str
+    description: str
+    galaxy_id: str
+    source: str
+    authors: list[str]
+    version: str
+    distribution: str
+    sharing_group_id: str
+    org_id: str
+    orgc_id: str
+    default: bool
+    locked: bool
+    extends_uuid: str
+    extends_version: str
+    published: bool
+    deleted: bool
+    GalaxyElement: list[ExportGalaxyGalaxyElement]
+
+
+class GetGalaxyResponse(BaseModel):
+    Galaxy: GetAllSearchGalaxiesAttributes
+    GalaxyCluster: list[GetGalaxyClusterResponse]
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/galaxies/import_galaxies_body.py

@@ -0,0 +1,15 @@
+from pydantic import BaseModel
+
+from .get_galaxy_response import GetGalaxyClusterResponse
+
+
+class ImportGalaxyGalaxy(BaseModel):
+    uuid: str
+
+
+class ImportGalaxyBody(BaseModel):
+    GalaxyCluster: GetGalaxyClusterResponse
+    Galaxy: ImportGalaxyGalaxy
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/galaxies/search_galaxies_body.py

@@ -0,0 +1,22 @@
+from pydantic import BaseModel
+
+
+class SearchGalaxiesbyValue(BaseModel):
+    value: str
+
+
+class SearchGalaxiesBody(BaseModel):
+    id: str | None = None
+    uuid: str | 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
+    kill_chain_order: str | None = None
+    enabled: bool | None = None
+    local_only: bool | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/noticelists/get_all_noticelist_response.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel
+
+from mmisp.api_schemas.noticelists.get_noticelist_response import NoticelistAttributes
+
+
+class GetAllNoticelists(BaseModel):
+    Noticelist: NoticelistAttributes
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/noticelists/get_noticelist_response.py

@@ -0,0 +1,38 @@
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class Data(BaseModel):
+    scope: str | list[str] | None
+    field: str | list[str] | None
+    value: str | list[str] | None
+    tags: str | list[str] | None
+    message: str | Any
+
+
+class NoticelistEntryResponse(BaseModel):
+    id: str
+    noticelist_id: str
+    data: Data
+
+
+class NoticelistAttributes(BaseModel):
+    id: str
+    name: str
+    expanded_name: str
+    ref: list[str]
+    geographical_area: list[str]
+    version: str
+    enabled: bool
+
+
+class NoticelistAttributesResponse(NoticelistAttributes):
+    NoticelistEntry: list[NoticelistEntryResponse]
+
+
+class NoticelistResponse(BaseModel):
+    Noticelist: NoticelistAttributesResponse
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/objects/create_object_body.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel, Field
+
+from mmisp.api_schemas.attributes.add_attribute_body import AddAttributeBody
+
+
+class ObjectCreateBody(BaseModel):
+    name: str = Field(min_length=1)
+    meta_category: str | None = None
+    description: str | None = None
+    distribution: str | None = None
+    sharing_group_id: str = Field(min_length=1)
+    comment: str = Field(min_length=1)
+    deleted: bool | None = None
+    first_seen: str | None = None
+    last_seen: str | None = None
+    Attribute: list[AddAttributeBody] | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/objects/get_object_response.py

@@ -0,0 +1,50 @@
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, validator
+
+from mmisp.api_schemas.attributes.get_all_attributes_response import GetAllAttributesResponse
+from mmisp.api_schemas.events.get_event_response import ObjectEventResponse
+
+
+class ObjectWithAttributesResponse(BaseModel):
+    id: str
+    uuid: str
+    name: str
+    meta_category: str | None = None
+    description: str | None = None
+    template_uuid: str | None = None
+    template_version: str | None = None
+    event_id: str | None = None
+    timestamp: str | None = None
+    distribution: str | None = None
+    sharing_group_id: str | None = None
+    comment: str | None = None
+    deleted: bool | None = None
+    first_seen: str | None = None
+    last_seen: str | None = None
+    Attribute: list[GetAllAttributesResponse] | None = None
+    Event: ObjectEventResponse | None = None
+
+    @validator("sharing_group_id", always=True)
+    def check_sharing_group_id(cls, 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 ObjectResponse(BaseModel):
+    Object: ObjectWithAttributesResponse
+
+    class Config:
+        orm_mode = True
+
+
+class ObjectSearchResponse(BaseModel):
+    response: list[ObjectResponse]
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/objects/search_objects_body.py

@@ -0,0 +1,49 @@
+from typing import Any
+
+from pydantic import BaseModel, validator
+
+
+class ObjectSearchBody(BaseModel):
+    object_name: str | None = None
+    object_template_uuid: str | None = None
+    object_template_version: str | None = None
+    event_id: str | None = None
+    category: str | None = None
+    comment: str | None = None
+    first_seen: str | None = None
+    last_seen: str | None = None
+    quick_filter: str | None = None
+    timestamp: str | None = None
+    event_info: str | None = None
+    from_: str | None = None  # 'from' is a reserved word in Python, so an underscore is added
+    to: str | None = None
+    date: str | None = None
+    last: str | None = None
+    event_timestamp: str | None = None
+    org_id: str | None = None
+    uuid: str | None = None
+    value1: str | None = None
+    value2: str | None = None
+    type: str | None = None
+    object_relation: str | None = None
+    attribute_timestamp: str | None = None
+    to_ids: bool | None = None
+    published: bool | None = None
+    deleted: bool | None = None
+    return_format: str | None = "json"
+    limit: str | None = "25"
+
+    @validator("limit")
+    def check_limit(cls, value: Any) -> str:  # noqa: ANN101
+        if value:
+            try:
+                limit_int = int(value)
+            except ValueError:
+                raise ValueError("'limit' must be a valid integer")
+
+            if not 1 <= limit_int <= 500:
+                raise ValueError("'limit' must be between 1 and 500")
+        return value
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/organisations/organisation.py

@@ -0,0 +1,24 @@
+from datetime import datetime
+
+from pydantic import BaseModel
+
+
+class Organisation(BaseModel):
+    id: str
+    name: str
+    date_created: datetime
+    date_modified: datetime
+    description: str | None = None
+    type: str
+    nationality: str | None = None
+    sector: str | None = None
+    created_by: str
+    uuid: str
+    contacts: str | None = None
+    local: bool
+    """organisation gains access to the local instance, otherwise treated as external"""
+    restricted_to_domain: str | None = None
+    landingpage: str | None = None
+
+    class Config:
+        orm_mode = True