mmisp-lib 0.1.9__tar.gz → 0.1.11__tar.gz

{mmisp_lib-0.1.9 → mmisp_lib-0.1.11}/PKG-INFO

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

{mmisp_lib-0.1.9 → mmisp_lib-0.1.11}/pyproject.toml

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

mmisp_lib-0.1.11/src/mmisp/api_schemas/attributes.py

@@ -0,0 +1,440 @@
+from typing import Annotated, Any, Dict, Optional
+
+from pydantic import BaseModel, Field, root_validator, validator
+
+from mmisp.lib.attributes import (
+    AttributeCategories,
+    default_category,
+    inverted_categories,
+    literal_valid_attribute_types,
+    mapper_val_safe_clsname,
+    to_ids,
+)
+
+
+class GetAttributeTag(BaseModel):
+    id: str
+    name: str
+    colour: str
+    numerical_value: int | None = None
+    is_galaxy: bool
+    local: bool
+
+
+class SearchAttributesObject(BaseModel):
+    id: str
+    distribution: str
+    sharing_group_id: str
+
+
+class SearchAttributesEvent(BaseModel):
+    id: str
+    org_id: str
+    distribution: str
+    info: str
+    orgc_id: str
+    uuid: str
+
+
+class SearchAttributesAttributesDetails(BaseModel):
+    id: str
+    event_id: str | None = None
+    object_id: str | None = None
+    object_relation: str | None = None
+    category: str
+    type: str
+    value: str
+    to_ids: bool
+    uuid: str
+    timestamp: str
+    distribution: str
+    sharing_group_id: str | None = None
+    comment: str | None = None
+    deleted: bool
+    disable_correlation: bool
+    first_seen: str | None = None
+    last_seen: str | None = None
+    Event: SearchAttributesEvent | None = None
+    Object: SearchAttributesObject | None = None
+    Tag: list[GetAttributeTag] = []
+
+
+class SearchAttributesAttributes(BaseModel):
+    Attribute: list[SearchAttributesAttributesDetails]
+
+
+class SearchAttributesResponse(BaseModel):
+    response: SearchAttributesAttributes
+
+
+class SearchAttributesModelOverridesBaseScoreConfig(BaseModel):
+    estimative_language_confidence_in_analytic_judgment: Annotated[
+        int, Field(alias="estimative-language:confidence-in-analytic-judgment")
+    ]
+    estimative_language_likelihood_probability: Annotated[
+        int, Field(alias="estimative-language:likelihood-probability")
+    ]
+    phishing_psychological_acceptability: Annotated[int, Field(alias="phishing:psychological-acceptability")]
+    phishing_state: Annotated[int, Field(alias="phishing:state")]
+
+
+class SearchAttributesModelOverrides(BaseModel):
+    lifetime: int
+    decay_speed: int
+    threshold: int
+    default_base_score: int
+    base_score_config: SearchAttributesModelOverridesBaseScoreConfig
+
+
+class SearchAttributesBody(BaseModel):
+    returnFormat: str = "json"
+    page: int | None = None
+    limit: int | None = None
+    value: str | None = None
+    value1: str | None = None
+    value2: str | None = None
+    type: str | None = None
+    category: str | None = None
+    org: str | None = None
+    tags: list[str] | None = None
+    from_: str | None = None
+    to: str | None = None
+    last: int | None = None
+    eventid: str | None = None
+    with_attachments: Annotated[bool | None, Field(alias="withAttachments")] = None
+    uuid: str | None = None
+    publish_timestamp: str | None = None
+    published: bool | None = None
+    timestamp: str | None = None
+    attribute_timestamp: str | None = None
+    enforce_warninglist: Annotated[bool | None, Field(alias="enforceWarninglist")]
+    to_ids: bool | None = None
+    deleted: bool | None = None
+    event_timestamp: str | None = None
+    threat_level_id: str | None = None
+    eventinfo: str | None = None
+    sharinggroup: list[str] | None = None
+    decaying_model: Annotated[str | None, Field(alias="decayingModel")] = None
+    score: str | None = None
+    first_seen: str | None = None
+    last_seen: str | None = None
+    include_event_uuid: Annotated[bool | None, Field(alias="includeEventUuid")] = None
+    include_event_tags: Annotated[bool | None, Field(alias="includeEventTags")] = None
+    include_proposals: Annotated[bool | None, Field(alias="includeProposals")] = None
+    requested_attributes: list[str] | None = None
+    include_context: Annotated[bool | None, Field(alias="includeContext")] = None
+    headerless: bool | None = None
+    include_warninglist_hits: Annotated[bool | None, Field(alias="includeWarninglistHits")] = None
+    attack_galaxy: Annotated[str | None, Field(alias="attackGalaxy")] = None
+    object_relation: str | None = None
+    include_sightings: Annotated[bool | None, Field(alias="includeSightings")] = None
+    include_correlations: Annotated[bool | None, Field(alias="includeCorrelations")] = None
+    model_overrides: Annotated[SearchAttributesModelOverrides | None, Field(alias="modelOverrides")] = None
+    include_decay_score: Annotated[bool | None, Field(alias="includeDecayScore")] = None
+    include_full_model: Annotated[bool | None, Field(alias="includeFullModel")] = None
+    exclude_decayed: Annotated[bool | None, Field(alias="excludeDecayed")] = None
+
+    class Config:
+        orm_mode = True
+
+
+class RestoreAttributeResponse(BaseModel):
+    id: str
+    event_id: str
+    object_id: str
+    object_relation: str
+    category: str
+    type: str
+    value: str
+    to_ids: bool
+    uuid: str
+    timestamp: str
+    distribution: str
+    sharing_group_id: str
+    comment: str
+    deleted: bool
+    disable_correlation: bool
+    first_seen: str
+    last_seen: str
+    event_uuid: str  # new
+
+    class Config:
+        orm_mode = True
+
+
+class GetDescribeTypesAttributes(BaseModel):
+    sane_defaults: dict = {}
+    for k, v in to_ids.items():
+        sane_defaults.update(
+            {
+                k: {
+                    "default_category": default_category[k],
+                    "to_ids": v,
+                }
+            }
+        )
+
+    types: list[str] = list(mapper_val_safe_clsname.keys())
+
+    categories: list[str] = [member.value for member in AttributeCategories]
+
+    category_type_mappings: dict = inverted_categories
+
+
+class GetDescribeTypesResponse(BaseModel):
+    result: GetDescribeTypesAttributes
+
+    class Config:
+        orm_mode = True
+
+
+class GetAttributeAttributes(BaseModel):
+    id: str
+    event_id: str
+    object_id: str
+    object_relation: Optional[str] = Field(..., nullable=True)
+    category: str
+    type: str
+    value: str
+    to_ids: bool
+    uuid: str
+    timestamp: str
+    distribution: str
+    sharing_group_id: str
+    comment: str | None = None
+    deleted: bool
+    disable_correlation: bool
+    first_seen: Optional[str] = Field(..., nullable=True)
+    last_seen: Optional[str] = Field(..., nullable=True)
+    event_uuid: str
+    tag: list[GetAttributeTag] | None = None
+
+
+class GetAttributeResponse(BaseModel):
+    Attribute: GetAttributeAttributes
+
+    class Config:
+        orm_mode = True
+
+
+class GetAllAttributesResponse(BaseModel):
+    id: str
+    event_id: str | None = None
+    object_id: str | None = None
+    object_relation: str | None = None
+    category: str | None = None
+    type: str
+    value1: str | None = None
+    value2: str | None = None
+    to_ids: bool | None = None
+    uuid: 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
+    disable_correlation: bool | None = None
+    first_seen: str | None = None
+    last_seen: str | None = None
+    value: str | 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 Config:
+        orm_mode = True
+
+
+class EditAttributeTag(BaseModel):
+    id: str
+    name: str
+    colour: str
+    exportable: str
+    user_id: str
+    hide_tag: bool
+    numerical_value: int
+    is_galaxy: bool
+    is_costum_galaxy: bool
+    local_only: bool
+
+
+class EditAttributeAttributes(BaseModel):
+    id: str
+    event_id: str
+    object_id: str
+    object_relation: str | None = None
+    category: str
+    type: str
+    value: str
+    to_ids: bool
+    uuid: str
+    timestamp: str
+    distribution: str
+    sharing_group_id: str
+    comment: str | None = None
+    deleted: bool
+    disable_correlation: bool
+    first_seen: str | None = None
+    last_seen: str | None = None
+    tag: list[EditAttributeTag]
+
+
+class EditAttributeResponse(BaseModel):
+    Attribute: EditAttributeAttributes
+
+    class Config:
+        orm_mode = True
+
+
+class EditAttributeBody(BaseModel):
+    type: str | None = None
+    value: str | None = None
+    value1: str | None = None
+    value2: str | None = None
+    object_id: str | None = None
+    object_relation: str | None = None
+    category: str | None = None
+    to_ids: bool | None = None
+    uuid: 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
+    disable_correlation: bool | None = None
+    first_seen: str | None = None
+    last_seen: str | None = None
+
+    class Config:
+        orm_mode = True
+
+
+class DeleteSelectedAttributeResponse(BaseModel):
+    saved: bool
+    success: bool
+    name: str
+    message: str
+    url: str
+    id: str
+
+    class Config:
+        orm_mode = True
+
+
+class DeleteSelectedAttributeBody(BaseModel):
+    id: str  # id = "all" deletes all attributes in the event
+    allow_hard_delete: bool | None = None
+
+    class Config:
+        orm_mode = True
+
+
+class DeleteAttributeResponse(BaseModel):
+    message: str
+
+    class Config:
+        orm_mode = True
+
+
+class AddRemoveTagAttributeResponse(BaseModel):
+    saved: bool
+    success: Optional[str]
+    check_publish: Optional[bool]
+    errors: Optional[str]
+
+    class Config:
+        orm_mode = True
+
+
+class AddAttributeAttributes(BaseModel):
+    id: str
+    event_id: str
+    object_id: str
+    object_relation: Optional[str] = Field(..., nullable=True)
+    category: str
+    type: str
+    value: str
+    value1: str
+    value2: str
+    to_ids: bool
+    uuid: str
+    timestamp: str
+    distribution: str
+    sharing_group_id: str
+    comment: str | None = None
+    deleted: bool
+    disable_correlation: bool
+    first_seen: str | None = None
+    last_seen: str | None = None
+    attribute_tag: list[str] | None = Field(default_factory=list, alias="AttributeTag")
+
+
+class AddAttributeResponse(BaseModel):
+    Attribute: AddAttributeAttributes
+
+    class Config:
+        orm_mode = True
+
+
+class AddAttributeBody(BaseModel):
+    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
+    object_relation: str | None = None
+    category: str | None = None
+    to_ids: bool | None = None
+    uuid: 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
+    disable_correlation: bool | None = None
+    first_seen: str | None = None
+    last_seen: str | None = None
+
+    @root_validator
+    def ensure_value_or_value1_is_set(cls, data: dict[str, Any]) -> Optional[dict[str, Any]]:  # noqa: ANN101
+        required_values: list[str] = [str(data.get("value")), str(data.get("value1"))]
+        if all(item is None for item in required_values):
+            raise ValueError("value or value1 has to be set")
+        return data
+
+
+GetAttributeStatisticsTypesResponseAttrs = {x: Field(default=None) for x in mapper_val_safe_clsname.keys()}
+GetAttributeStatisticsTypesResponseAttrs["__annotations__"] = {x: str | None for x in mapper_val_safe_clsname.keys()}
+GetAttributeStatisticsTypesResponse = type(
+    "GetAttributeStatisticsTypesResponse", (BaseModel,), GetAttributeStatisticsTypesResponseAttrs
+)
+
+
+class GetAttributeStatisticsCategoriesResponse(BaseModel):
+    antivirus_detection: str = Field(alias="Antivirus detection")
+    artifacts_dropped: str = Field(alias="Artifacts dropped")
+    attribution: str = Field(alias="Attribution")
+    external_analysis: str = Field(alias="External analysis")
+    financial_fraud: str = Field(alias="Financial fraud")
+    internal_reference: str = Field(alias="Internal reference")
+    network_activity: str = Field(alias="Network activity")
+    other: str = Field(alias="Other")
+    payload_delivery: str = Field(alias="Payload delivery")
+    payload_installation: str = Field(alias="Payload installation")
+    payload_type: str = Field(alias="Payload type")
+    persistence_mechanism: str = Field(alias="Persistence mechanism")
+    person: str = Field(alias="Person")
+    social_network: str = Field(alias="Social network")
+    support__tool: str = Field(alias="Support Tool")
+    targeting_data: str = Field(alias="Targeting data")
+
+    class Config:
+        orm_mode = True

mmisp_lib-0.1.11/src/mmisp/api_schemas/auth_keys.py

@@ -0,0 +1,123 @@
+from datetime import datetime
+
+from pydantic import BaseModel, PositiveInt, conint
+
+
+class SearchGetAuthKeysResponseItemUser(BaseModel):
+    id: str
+    email: str
+
+
+class ViewAuthKeyResponseWrapper(BaseModel):
+    id: str
+    uuid: str
+    authkey_start: str
+    authkey_end: str
+    created: datetime
+    expiration: int
+    read_only: bool
+    user_id: str
+    comment: str
+    allowed_ips: list[str] | None = None
+    unique_ips: list[str] | None = []
+
+
+class ViewAuthKeysResponse(BaseModel):
+    AuthKey: ViewAuthKeyResponseWrapper
+    User: SearchGetAuthKeysResponseItemUser
+
+
+class SearchGetAuthKeysResponseItemAuthKey(BaseModel):
+    id: str
+    uuid: str
+    authkey_start: str
+    authkey_end: str
+    created: str
+    expiration: str
+    read_only: bool
+    user_id: str
+    comment: str | None
+    allowed_ips: list[str] | None = None
+    unique_ips: list[str] | None = []
+
+
+class SearchGetAuthKeysResponseItem(BaseModel):
+    AuthKey: SearchGetAuthKeysResponseItemAuthKey
+    User: SearchGetAuthKeysResponseItemUser
+
+    class Config:
+        orm_mode = True
+
+
+class SearchAuthKeyBody(BaseModel):
+    page: PositiveInt = 1
+    limit: conint(gt=0, lt=500) = 25  # type: ignore
+    id: str | None = None
+    uuid: str | None = None
+    authkey_start: str | None = None
+    authkey_end: str | None = None
+    created: str | None = None
+    expiration: str | None = None
+    read_only: bool | None = None
+    user_id: str | None = None
+    comment: str | None = None
+    allowed_ips: str | list[str] | None = None
+    last_used: str | None = None  # deprecated
+
+
+class EditAuthKeyResponseAuthKey(BaseModel):
+    id: str
+    uuid: str
+    authkey_start: str
+    authkey_end: str
+    created: str
+    expiration: str
+    read_only: bool
+    user_id: str
+    comment: str
+    allowed_ips: str | None = None
+
+
+class EditAuthKeyResponseUser(BaseModel):
+    id: str
+    org_id: str
+
+
+class EditAuthKeyResponse(BaseModel):
+    AuthKey: EditAuthKeyResponseAuthKey
+    User: EditAuthKeyResponseUser
+
+
+class EditAuthKeyBody(BaseModel):
+    read_only: bool | None = None
+    comment: str | None = None
+    allowed_ips: list[str] | None = None
+    expiration: int | None = None
+
+
+class AddAuthKeyResponseAuthKey(BaseModel):
+    id: str
+    uuid: str
+    authkey_start: str
+    authkey_end: str
+    created: str
+    expiration: str | None = "0"
+    read_only: bool
+    user_id: str
+    comment: str | None = None
+    allowed_ips: list[str] | None = None
+    unique_ips: list[str]
+    authkey_raw: str
+
+
+class AddAuthKeyResponse(BaseModel):
+    AuthKey: AddAuthKeyResponseAuthKey
+
+
+class AddAuthKeyBody(BaseModel):
+    uuid: str | None = None
+    read_only: bool | None = None
+    user_id: int | None = None
+    comment: str | None = None
+    allowed_ips: list[str] | None = None
+    expiration: int | str | None = 0

mmisp_lib-0.1.9/src/mmisp/api_schemas/authentication/start_login_response.py → mmisp_lib-0.1.11/src/mmisp/api_schemas/authentication.py

@@ -3,9 +3,8 @@ from enum import Enum
 from pydantic import BaseModel
 
 
-class LoginType(Enum):
-    PASSWORD = "password"
-    IDENTITY_PROVIDER = "idp"
+class TokenResponse(BaseModel):
+    token: str
 
 
 class IdentityProviderInfo(BaseModel):
@@ -16,6 +15,24 @@ class IdentityProviderInfo(BaseModel):
         orm_mode = True
 
 
+class LoginType(Enum):
+    PASSWORD = "password"
+    IDENTITY_PROVIDER = "idp"
+
+
+class StartLoginBody(BaseModel):
+    email: str
+
+
+class PasswordLoginBody(BaseModel):
+    email: str
+    password: str
+
+
+class ExchangeTokenLoginBody(BaseModel):
+    exchangeToken: str
+
+
 class StartLoginResponse(BaseModel):
     loginType: LoginType
     identityProviders: list[IdentityProviderInfo] = []

mmisp_lib-0.1.9/src/mmisp/api_schemas/tags/get_tag_response.py → mmisp_lib-0.1.11/src/mmisp/api_schemas/common.py

@@ -13,19 +13,3 @@ class TagAttributesResponse(BaseModel):
     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