mmisp-lib 0.1.0__py3-none-any.whl

mmisp/api_schemas/roles/role.py

@@ -0,0 +1,71 @@
+from datetime import datetime
+
+from pydantic import BaseModel
+
+
+class Role(BaseModel):
+    id: str
+    name: str
+    created: datetime
+    modified: datetime
+    perm_add: bool
+    perm_modify: bool
+    """Manage Own Events."""
+    perm_modify_org: bool
+    """Manage Organisation Events."""
+    perm_publish: bool
+    """Publish Organisation Events."""
+    perm_delegate: bool
+    """Allow users to create delegation requests for their own org only events to trusted third parties."""
+    perm_sync: bool
+    """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."""
+    perm_admin: bool
+    """Limited organisation admin - create, manage users of their own organisation."""
+    perm_audit: bool
+    """Access to the audit logs of the user\'s organisation."""
+    perm_auth: bool
+    """Users with this permission have access to authenticating via their Auth keys,
+    granting them access to the API."""
+    perm_site_admin: bool
+    """Unrestricted access to any data and functionality on this instance."""
+    perm_regexp_access: bool
+    """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."""
+    perm_tagger: bool
+    """Users with roles that include this permission can attach
+    or detach existing tags to and from events/attributes."""
+    perm_template: bool
+    """Create or modify templates, to be used when populating events."""
+    perm_sharing_group: bool
+    """Permission to create or modify sharing groups."""
+    perm_tag_editor: bool
+    """This permission gives users the ability to create tags."""
+    perm_sighting: bool
+    """Permits the user to push feedback on attributes into MISP by providing sightings."""
+    perm_object_template: bool
+    """Create or modify MISP Object templates."""
+    default_role: bool
+    memory_limit: str
+    max_execution_time: str
+    restricted_to_site_admin: bool
+    perm_publish_zmq: bool
+    """Allow users to publish data to the ZMQ pubsub channel via the publish event to ZMQ button."""
+    perm_publish_kafka: bool
+    """Allow users to publish data to Kafka via the publish event to Kafka button."""
+    perm_decaying: bool
+    """Create or modify MISP Decaying Models."""
+    enforce_rate_limit: bool
+    rate_limit_count: str  # number as string
+    perm_galaxy_editor: bool
+    """Create or modify MISP Galaxies and MISP Galaxies Clusters."""
+    perm_warninglist: bool
+    """Allow to manage warninglists."""
+    perm_view_feed_correlations: bool
+    """Allow the viewing of feed correlations. Enabling this can come at a performance cost."""
+    permission: str | None  # number as string
+    permission_description: str | None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/sharing_groups/add_org_to_sharing_group_body.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class AddOrgToSharingGroupBody(BaseModel):
+    organisationId: str
+    extend: bool | None = None

mmisp/api_schemas/sharing_groups/add_org_to_sharing_group_legacy_body.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class AddOrgToSharingGroupLegacyBody(BaseModel):
+    extend: bool | None = None

mmisp/api_schemas/sharing_groups/add_server_to_sharing_group_body.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class AddServerToSharingGroupBody(BaseModel):
+    serverId: str
+    all_orgs: bool | None = None

mmisp/api_schemas/sharing_groups/add_server_to_sharing_group_legacy_body.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class AddServerToSharingGroupLegacyBody(BaseModel):
+    all_orgs: bool | None = None

mmisp/api_schemas/sharing_groups/create_sharing_group_body.py

@@ -0,0 +1,12 @@
+from pydantic import BaseModel, Field
+
+
+class CreateSharingGroupBody(BaseModel):
+    uuid: str | None = None
+    name: str = Field(max_length=255)
+    description: str | None = Field(default=None, max_length=65535)
+    releasability: str = Field(max_length=65535)
+    organisation_uuid: str | None = Field(default=None, max_length=36)
+    active: bool | None = None
+    roaming: bool | None = None
+    local: bool | None = None

mmisp/api_schemas/sharing_groups/create_sharing_group_legacy_body.py

@@ -0,0 +1,23 @@
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+
+class CreateSharingGroupLegacyBody(BaseModel):
+    uuid: str | None = None
+    name: str = Field(max_length=255)
+    description: str | None = Field(default=None, max_length=65535)
+    releasability: str | None = Field(default=None, max_length=65535)
+    local: bool | None = None
+    active: bool | None = None
+    org_count: str | None = None
+    """attribute will be ignored"""
+    organisation_uuid: str | None = Field(default=None, max_length=36)
+    org_id: str | None = Field(default=None, max_length=10)
+    sync_user_id: str | None = Field(default=None, max_length=10)
+    """attribute will be ignored"""
+    created: datetime | None = None
+    """attribute will be ignored"""
+    modified: datetime | None = None
+    """attribute will be ignored"""
+    roaming: bool | None = None

mmisp/api_schemas/sharing_groups/create_sharing_group_legacy_response.py

@@ -0,0 +1,18 @@
+from pydantic import BaseModel
+
+from .sharing_group import SharingGroup
+from .sharing_group_org import SharingGroupOrg
+from .sharing_group_server import SharingGroupServer
+
+
+class CreateSharingGroupLegacyResponseOrganisationInfo(BaseModel):
+    id: str
+    name: str
+    uuid: str
+
+
+class CreateSharingGroupLegacyResponse(BaseModel):
+    SharingGroup: SharingGroup
+    Organisation: CreateSharingGroupLegacyResponseOrganisationInfo
+    SharingGroupOrg: list[SharingGroupOrg]
+    SharingGroupServer: list[SharingGroupServer]

mmisp/api_schemas/sharing_groups/delete_sharing_group_legacy_response.py

@@ -0,0 +1,5 @@
+from ..standard_status_response import StandardStatusResponse
+
+
+class DeleteSharingGroupLegacyResponse(StandardStatusResponse):
+    id: str

mmisp/api_schemas/sharing_groups/get_all_sharing_groups_response.py

@@ -0,0 +1,53 @@
+from pydantic import BaseModel
+
+
+class GetAllSharingGroupsResponseResponseItemSharingGroup(BaseModel):
+    id: str
+    uuid: str
+    name: str
+    description: str
+    releasability: str
+    local: bool
+    active: bool
+    roaming: bool
+    org_count: str
+
+
+class GetAllSharingGroupsResponseOrganisationInfo(BaseModel):
+    id: str
+    uuid: str
+    name: str
+
+
+class GetAllSharingGroupsResponseResponseItemSharingGroupOrgItem(BaseModel):
+    id: str
+    sharing_group_id: str
+    org_id: str
+    extend: bool
+    Organisation: GetAllSharingGroupsResponseOrganisationInfo
+
+
+class GetAllSharingGroupsResponseResponseItemSharingGroupServerItemServer(BaseModel):
+    id: str
+    name: str
+    url: str
+
+
+class GetAllSharingGroupsResponseResponseItemSharingGroupServerItem(BaseModel):
+    server_id: str
+    sharing_group_id: str
+    all_orgs: bool
+    Server: GetAllSharingGroupsResponseResponseItemSharingGroupServerItemServer
+
+
+class GetAllSharingGroupsResponseResponseItem(BaseModel):
+    SharingGroup: GetAllSharingGroupsResponseResponseItemSharingGroup
+    Organisation: GetAllSharingGroupsResponseOrganisationInfo
+    SharingGroupOrg: list[GetAllSharingGroupsResponseResponseItemSharingGroupOrgItem]
+    SharingGroupServer: list[GetAllSharingGroupsResponseResponseItemSharingGroupServerItem]
+    editable: bool
+    deletable: bool
+
+
+class GetAllSharingGroupsResponse(BaseModel):
+    response: list[GetAllSharingGroupsResponseResponseItem]

mmisp/api_schemas/sharing_groups/get_sharing_group_info_response.py

@@ -0,0 +1,44 @@
+from pydantic import BaseModel
+
+from ..organisations.organisation import Organisation
+from .sharing_group import SharingGroup
+
+
+class GetSharingGroupInfoResponseSharingGroupInfo(SharingGroup):
+    org_count: int
+
+
+class GetSharingGroupInfoResponseOrganisationInfo(BaseModel):
+    id: str
+    uuid: str
+    name: str
+    local: bool
+
+
+class GetSharingGroupInfoResponseSharingGroupOrgItem(BaseModel):
+    id: str
+    sharing_group_id: str
+    org_id: str
+    extend: bool
+    Organisation: GetSharingGroupInfoResponseOrganisationInfo
+
+
+class GetSharingGroupInfoResponseServerInfo(BaseModel):
+    id: str
+    name: str
+    url: str
+
+
+class GetSharingGroupInfoResponseSharingGroupServerItem(BaseModel):
+    id: str
+    sharing_group_id: str
+    server_id: str
+    all_orgs: bool
+    Server: GetSharingGroupInfoResponseServerInfo
+
+
+class GetSharingGroupInfoResponse(BaseModel):
+    SharingGroup: GetSharingGroupInfoResponseSharingGroupInfo
+    Organisation: Organisation
+    SharingGroupOrg: list[GetSharingGroupInfoResponseSharingGroupOrgItem]
+    SharingGroupServer: list[GetSharingGroupInfoResponseSharingGroupServerItem]

mmisp/api_schemas/sharing_groups/sharing_group.py

@@ -0,0 +1,19 @@
+from datetime import datetime
+
+from pydantic import BaseModel
+
+
+class SharingGroup(BaseModel):
+    id: str
+    name: str
+    releasability: str
+    description: str
+    uuid: str
+    organisation_uuid: str
+    org_id: str
+    sync_user_id: str
+    active: bool
+    created: datetime
+    modified: datetime
+    local: bool
+    roaming: bool

mmisp/api_schemas/sharing_groups/sharing_group_org.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+
+
+class SharingGroupOrg(BaseModel):
+    id: str
+    sharing_group_id: str
+    org_id: str
+    extend: bool

mmisp/api_schemas/sharing_groups/sharing_group_server.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel
+
+
+class SharingGroupServer(BaseModel):
+    id: str
+    sharing_group_id: str
+    server_id: str
+    all_orgs: bool

mmisp/api_schemas/sharing_groups/update_sharing_group_body.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, Field
+
+
+class UpdateSharingGroupBody(BaseModel):
+    name: str = Field(default=None, max_length=255)
+    description: str | None = Field(default=None, max_length=65535)
+    releasability: str = Field(default=None, max_length=65535)
+    active: bool | None = None
+    roaming: bool | None = None
+    local: bool | None = None

mmisp/api_schemas/sharing_groups/update_sharing_group_legacy_body.py

@@ -0,0 +1,28 @@
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+
+class UpdateSharingGroupLegacyBody(BaseModel):
+    id: str | None = None
+    """attribute will be ignored"""
+    uuid: str | None = Field(default=None, max_length=36)
+    """attribute will be ignored"""
+    name: str = Field(max_length=255)
+    description: str | None = Field(default=None, max_length=65535)
+    releasability: str | None = Field(default=None, max_length=65535)
+    local: bool | None = None
+    active: bool | None = None
+    org_count: str | None = None
+    """attribute will be ignored"""
+    organisation_uuid: str | None = Field(default=None, max_length=36)
+    """attribute will be ignored"""
+    org_id: str | None = Field(default=None, max_length=10)
+    """attribute will be ignored"""
+    sync_user_id: str | None = Field(default=None, max_length=10)
+    """attribute will be ignored"""
+    created: datetime | None = None
+    """attribute will be ignored"""
+    modified: datetime | None = None
+    """attribute will be ignored"""
+    roaming: bool | None = None

mmisp/api_schemas/sharing_groups/view_update_sharing_group_legacy_response.py

@@ -0,0 +1,40 @@
+from pydantic import BaseModel
+
+from ..organisations.organisation import Organisation
+from .sharing_group import SharingGroup
+
+
+class ViewUpdateSharingGroupLegacyResponseOrganisationInfo(BaseModel):
+    id: str
+    uuid: str
+    name: str
+    local: bool
+
+
+class ViewUpdateSharingGroupLegacyResponseSharingGroupOrgItem(BaseModel):
+    id: str
+    sharing_group_id: str
+    org_id: str
+    extend: bool
+    Organisation: ViewUpdateSharingGroupLegacyResponseOrganisationInfo
+
+
+class ViewUpdateSharingGroupLegacyResponseServerInfo(BaseModel):
+    id: str
+    name: str
+    url: str
+
+
+class ViewUpdateSharingGroupLegacyResponseSharingGroupServerItem(BaseModel):
+    id: str
+    sharing_group_id: str
+    server_id: str
+    all_orgs: bool
+    Server: ViewUpdateSharingGroupLegacyResponseServerInfo
+
+
+class ViewUpdateSharingGroupLegacyResponse(BaseModel):
+    SharingGroup: SharingGroup
+    Organisation: Organisation
+    SharingGroupOrg: list[ViewUpdateSharingGroupLegacyResponseSharingGroupOrgItem]
+    SharingGroupServer: list[ViewUpdateSharingGroupLegacyResponseSharingGroupServerItem]

mmisp/api_schemas/sightings/create_sighting_body.py

@@ -0,0 +1,49 @@
+from typing import Any
+
+from pydantic import BaseModel, validator
+
+
+class SightingFiltersBody(BaseModel):
+    value1: str | None = None
+    value2: str | None = None
+    type: str | None = None
+    category: str | None = None
+    from_: str | None = None  # 'from' is a reserved word in Python, so an underscore is added
+    to: str | None = None
+    last: str | None = None
+    timestamp: str | None = None
+    event_id: str | None = None
+    uuid: str | None = None
+    attribute_timestamp: str | None = None
+    to_ids: bool | None = None
+    deleted: bool | None = None
+    event_timestamp: str | None = None
+    eventinfo: str | None = None
+    sharinggroup: list[str] | None = None
+    first_seen: str | None = None
+    last_seen: str | None = None
+    requested_attributes: list[str] | None = None
+    returnFormat: str | None = "json"
+    limit: str | None = "25"
+
+    @validator("limit")
+    def check_limit(cls, value: Any) -> str:  # noqa: ANN101
+        if value is not None:
+            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 SightingCreateBody(BaseModel):
+    values: list[str]
+    source: str | None = None
+    timestamp: str | None = None
+    filters: SightingFiltersBody | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/sightings/get_sighting_response.py

@@ -0,0 +1,27 @@
+from pydantic import BaseModel
+
+
+class SightingOrganisationResponse(BaseModel):
+    id: str
+    uuid: str
+    name: str
+
+
+class SightingAttributesResponse(BaseModel):
+    id: str
+    uuid: str
+    attribute_id: str
+    attribute_uuid: str
+    event_id: str | None = None
+    org_id: str | None = None
+    date_sighting: str | None = None
+    source: str | None = None
+    type: str | None = None
+    Organisation: SightingOrganisationResponse | None = None
+
+
+class SightingsGetResponse(BaseModel):
+    sightings: list[SightingAttributesResponse]
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/standard_status_response.py

@@ -0,0 +1,13 @@
+from pydantic import BaseModel
+
+
+class StandardStatusResponse(BaseModel):
+    saved: bool
+    success: bool
+    name: str
+    message: str
+    url: str
+
+
+class StandardStatusIdentifiedResponse(StandardStatusResponse):
+    id: str

mmisp/api_schemas/tags/create_tag_body.py

@@ -0,0 +1,15 @@
+from pydantic import BaseModel, Field
+
+
+class TagCreateBody(BaseModel):
+    name: str = Field(min_length=1)
+    colour: str = Field(min_length=7, max_length=7)
+    exportable: bool
+    org_id: str | None = None
+    user_id: str | None = None
+    hide_tag: bool | None = None
+    numerical_value: str | None = None
+    local_only: bool | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/tags/delete_tag_response.py

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

mmisp/api_schemas/tags/get_tag_response.py

@@ -0,0 +1,31 @@
+from pydantic import BaseModel
+
+
+class TagAttributesResponse(BaseModel):
+    id: str
+    name: str
+    colour: str
+    exportable: bool
+    org_id: str | None = None
+    user_id: str | 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 TagViewResponse(TagAttributesResponse):
+    count: int
+    attribute_count: int
+
+
+class TagResponse(BaseModel):
+    Tag: TagAttributesResponse
+
+
+class TagGetResponse(BaseModel):
+    Tag: list[TagAttributesResponse]
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/tags/search_tags_response.py

@@ -0,0 +1,26 @@
+from pydantic import BaseModel
+
+from mmisp.api_schemas.tags.get_tag_response import TagAttributesResponse
+from mmisp.api_schemas.taxonomies.export_taxonomies_response import TaxonomyPredicateSchema
+from mmisp.api_schemas.taxonomies.get_taxonomy_response import TaxonomyView
+
+
+class TaxonomyPredicateResponse(TaxonomyPredicateSchema):
+    id: str
+    taxonomy_id: str
+    colour: str
+    exclusive: bool
+    numerical_value: int
+
+
+class TagCombinedModel(BaseModel):
+    Tag: TagAttributesResponse
+    Taxonomy: TaxonomyView
+    TaxonomyPredicate: TaxonomyPredicateResponse
+
+
+class TagSearchResponse(BaseModel):
+    response: list[TagCombinedModel]
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/tags/update_tag_body.py

@@ -0,0 +1,15 @@
+from pydantic import BaseModel
+
+
+class TagUpdateBody(BaseModel):
+    name: str | None = None
+    colour: str | None = None
+    exportable: bool | None = None
+    org_id: str | None = None
+    user_id: str | None = None
+    hide_tag: bool | None = None
+    numerical_value: str | None = None
+    local_only: bool | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/taxonomies/export_taxonomies_response.py

@@ -0,0 +1,30 @@
+from pydantic import BaseModel
+
+
+class TaxonomyPredicateSchema(BaseModel):
+    value: str
+    expanded: str
+    description: str
+
+
+class ExportTaxonomyEntry(BaseModel):
+    value: str
+    expanded: str
+    description: str
+
+
+class TaxonomyValueSchema(BaseModel):
+    predicate: str
+    entry: list[ExportTaxonomyEntry]
+
+
+class ExportTaxonomyResponse(BaseModel):
+    namespace: str
+    description: str
+    version: int
+    exclusive: bool
+    predicates: list[TaxonomyPredicateSchema]
+    values: list[TaxonomyValueSchema]
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/taxonomies/get_taxonomy_by_id_response.py

@@ -0,0 +1,30 @@
+from pydantic import BaseModel
+
+from mmisp.api_schemas.tags.get_tag_response import TagAttributesResponse
+
+
+class TaxonomyEntrySchema(BaseModel):
+    tag: str
+    expanded: str
+    exclusive_predicate: bool
+    description: str
+    existing_tag: bool | TagAttributesResponse
+
+
+class GetIdTaxonomyResponse(BaseModel):
+    id: str
+    namespace: str
+    description: str
+    version: str
+    enabled: bool
+    exclusive: bool
+    required: bool
+    highlighted: bool
+    entries: list[TaxonomyEntrySchema]
+
+    class Config:
+        orm_mode = True
+
+
+class GetIdTaxonomyResponseWrapper(BaseModel):
+    Taxonomy: GetIdTaxonomyResponse

mmisp/api_schemas/taxonomies/get_taxonomy_response.py

@@ -0,0 +1,21 @@
+from pydantic import BaseModel
+
+
+class TaxonomyView(BaseModel):
+    id: str
+    namespace: str
+    description: str
+    version: str
+    enabled: bool
+    exclusive: bool
+    required: bool
+    highlighted: bool
+
+
+class ViewTaxonomyResponse(BaseModel):
+    Taxonomy: TaxonomyView
+    total_count: int
+    current_count: int
+
+    class Config:
+        orm_mode = True