mmisp-lib 0.2.0__tar.gz → 0.3.0__tar.gz

{mmisp_lib-0.2.0 → mmisp_lib-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mmisp-lib
-Version: 0.2.0
+Version: 0.3.0
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -20,6 +20,7 @@ Requires-Dist: bcrypt==4.1.2
 Requires-Dist: nanoid==2.0.0
 Requires-Dist: cryptography==42.0.5
 Requires-Dist: jinja2~=3.1.4
+Requires-Dist: fire
 Provides-Extra: dev
 Requires-Dist: ruff>=0.3.7; extra == "dev"
 Requires-Dist: mypy==1.8.0; extra == "dev"
@@ -30,6 +31,8 @@ Requires-Dist: pytest-asyncio==0.23.5.post1; extra == "dev"
 Requires-Dist: pytest-cov==4.1.0; extra == "dev"
 Requires-Dist: respx==0.20.2; extra == "dev"
 Requires-Dist: mysql-connector-python==8.3.0; extra == "dev"
+Requires-Dist: icecream; extra == "dev"
+Requires-Dist: asyncio; extra == "dev"
 
 # Modern MISP - API
 
@@ -47,6 +50,9 @@ Create a file called `.env` and copy the contents of `.env.example` into it. Fin
 
 You should now be able to access the api on `localhost:4000`.
 
+To use the commandline tool run `python .\src\mmisp\commandline_tool\main.py --h` from the base directory to view all commands. For detailed information of all commands: `python .\src\mmisp\commandline_tool\main.py --help`.
+For setting up the DB use the commandline tool option for setup and then create your user account. In case you have not created a new organisation yet, please add your account to the setup basic organisation: ghost_org.
+
 Run tests using `make test` (local database container required running) or `make test/lite`.
 
 ## Setting up your IDE

{mmisp_lib-0.2.0 → mmisp_lib-0.3.0}/README.md

@@ -14,6 +14,9 @@ Create a file called `.env` and copy the contents of `.env.example` into it. Fin
 
 You should now be able to access the api on `localhost:4000`.
 
+To use the commandline tool run `python .\src\mmisp\commandline_tool\main.py --h` from the base directory to view all commands. For detailed information of all commands: `python .\src\mmisp\commandline_tool\main.py --help`.
+For setting up the DB use the commandline tool option for setup and then create your user account. In case you have not created a new organisation yet, please add your account to the setup basic organisation: ghost_org.
+
 Run tests using `make test` (local database container required running) or `make test/lite`.
 
 ## Setting up your IDE

{mmisp_lib-0.2.0 → mmisp_lib-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mmisp-lib"
-version = "0.2.0"
+version = "0.3.0"
 description = ""
 authors = []
 readme = "README.md"
@@ -24,6 +24,7 @@ dependencies = [
   "nanoid==2.0.0",
   "cryptography==42.0.5",
   "jinja2~=3.1.4",
+  "fire",
 ]
 
 
@@ -38,6 +39,8 @@ dev = [
   "pytest-cov==4.1.0",
   "respx==0.20.2",
   "mysql-connector-python==8.3.0",
+  "icecream",
+  "asyncio",
 ]
 
 [tool.setuptools.package-data]
@@ -58,6 +61,9 @@ unsafe-fixes = true
 select = ["E", "F", "W", "I", "ICN", "ANN"]
 ignore = ["ANN002", "ANN003", "ANN401"]
 
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["ANN001", "ANN201", "ANN202", "S101"]
+
 [tool.coverage.run]
 concurrency = ["greenlet", "thread"]
 include = [

{mmisp_lib-0.2.0 → mmisp_lib-0.3.0}/src/mmisp/api_schemas/auth_keys.py

@@ -1,6 +1,7 @@
 from datetime import datetime
+from typing import List, Self, Union
 
-from pydantic import BaseModel, PositiveInt, conint
+from pydantic import BaseModel, PositiveInt, conint, validator
 
 
 class SearchGetAuthKeysResponseItemUser(BaseModel):
@@ -41,6 +42,21 @@ class SearchGetAuthKeysResponseItemAuthKey(BaseModel):
     unique_ips: list[str] | None = []
 
 
+class SearchGetAuthKeysResponseAuthKey(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 = []
+    last_used: str | None = None
+
+
 class SearchGetAuthKeysResponseItem(BaseModel):
     AuthKey: SearchGetAuthKeysResponseItemAuthKey
     User: SearchGetAuthKeysResponseItemUser
@@ -49,6 +65,14 @@ class SearchGetAuthKeysResponseItem(BaseModel):
         orm_mode = True
 
 
+class SearchGetAuthKeysResponse(BaseModel):
+    AuthKey: SearchGetAuthKeysResponseAuthKey
+    User: SearchGetAuthKeysResponseItemUser
+
+    class Config:
+        orm_mode = True
+
+
 class SearchAuthKeyBody(BaseModel):
     page: PositiveInt = 1
     limit: conint(gt=0, lt=500) = 25  # type: ignore
@@ -78,6 +102,20 @@ class EditAuthKeyResponseAuthKey(BaseModel):
     allowed_ips: str | None = None
 
 
+class EditAuthKeyResponseCompleteAuthKey(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
+    unique_ips: list[str] | None = None
+
+
 class EditAuthKeyResponseUser(BaseModel):
     id: str
     org_id: str
@@ -88,11 +126,22 @@ class EditAuthKeyResponse(BaseModel):
     User: EditAuthKeyResponseUser
 
 
+class EditAuthKeyResponseCompl(BaseModel):
+    AuthKey: EditAuthKeyResponseCompleteAuthKey
+    User: EditAuthKeyResponseUser
+
+
 class EditAuthKeyBody(BaseModel):
     read_only: bool | None = None
     comment: str | None = None
-    allowed_ips: list[str] | None = None
-    expiration: int | None = None
+    allowed_ips: Union[str, List[str]] | None = None
+    expiration: str | None = None
+
+    @validator("allowed_ips", pre=True)
+    def ensure_list(cls: Self, v: str | List[str]) -> List[str]:
+        if isinstance(v, str):
+            return [v]
+        return v
 
 
 class AddAuthKeyResponseAuthKey(BaseModel):

mmisp_lib-0.3.0/src/mmisp/api_schemas/authentication.py

@@ -0,0 +1,89 @@
+from enum import Enum
+
+from pydantic import BaseModel
+
+
+class TokenResponse(BaseModel):
+    token: str
+
+
+class ChangeLoginInfoResponse(BaseModel):
+    successful: bool
+
+
+class IdentityProviderBody(BaseModel):
+    name: str
+    org_id: str
+    active: bool
+    base_url: str
+    client_id: str
+    client_secret: str
+    scope: str | None = None
+
+
+class IdentityProviderCallbackBody(BaseModel):
+    code: str
+    redirect_uri: str
+
+
+class IdentityProviderEditBody(BaseModel):
+    name: str | None = None
+    org_id: str | None = None
+    active: bool | None = None
+    base_url: str | None = None
+    client_id: str | None = None
+    client_secret: str | None = None
+    scope: str | None = None
+
+
+class GetIdentityProviderResponse(BaseModel):
+    id: str
+    name: str
+    org_id: str
+    active: bool
+    base_url: str
+    client_id: str
+    client_secret: str
+    scope: str | None = None
+
+
+class IdentityProviderInfo(BaseModel):
+    id: str
+    name: str
+    url: str | None = None
+
+    class Config:
+        orm_mode = True
+
+
+class LoginType(Enum):
+    PASSWORD = "password"
+    IDENTITY_PROVIDER = "idp"
+
+
+class StartLoginBody(BaseModel):
+    email: str
+
+
+class PasswordLoginBody(BaseModel):
+    email: str
+    password: str
+
+
+class SetPasswordBody(BaseModel):
+    password: str
+
+
+class ChangePasswordBody(BaseModel):
+    email: str
+    password: str
+    oldPassword: str | None = None
+
+
+class ExchangeTokenLoginBody(BaseModel):
+    exchangeToken: str
+
+
+class StartLoginResponse(BaseModel):
+    loginType: LoginType
+    identityProviders: list[IdentityProviderInfo] = []

{mmisp_lib-0.2.0 → mmisp_lib-0.3.0}/src/mmisp/api_schemas/events.py

@@ -23,6 +23,46 @@ class AddEditGetEventGalaxyClusterMeta(BaseModel):
     kill_chain: str | None = None
 
 
+class FreeTextImportWorkerData(BaseModel):
+    data: str
+
+
+class FreeTextImportWorkerUser(BaseModel):
+    user_id: int
+
+
+class FreeTextImportWorkerBody(BaseModel):
+    user: FreeTextImportWorkerUser
+    data: FreeTextImportWorkerData
+
+    class Config:
+        orm_mode = True
+
+
+class AddAttributeViaFreeTextImportEventResponse(BaseModel):
+    comment: str | None = None
+    value: str
+    original_value: str
+    to_ids: str
+    type: str
+    category: str
+    distribution: str
+
+    class Config:
+        orm_mode = True
+
+
+class AddAttributeViaFreeTextImportEventAttributes(BaseModel):
+    value: str
+
+
+class AddAttributeViaFreeTextImportEventBody(BaseModel):
+    Attribute: AddAttributeViaFreeTextImportEventAttributes
+
+    class Config:
+        orm_mode = True
+
+
 class GetAllEventsGalaxyCluster(BaseModel):
     id: str
     uuid: str
@@ -130,7 +170,7 @@ class AddEditGetEventGalaxy(BaseModel):
 class AddEditGetEventOrg(BaseModel):
     id: str
     name: str
-    uuid: str
+    uuid: str | None = None
     local: bool | None = None
 
 
@@ -254,7 +294,7 @@ class AddEditGetEventResponse(BaseModel):
 class GetAllEventsOrg(BaseModel):
     id: str
     name: str
-    uuid: str
+    uuid: str | None = None
 
 
 class UnpublishEventResponse(BaseModel):
@@ -416,8 +456,8 @@ class GetAllEventsEventTag(BaseModel):
     event_id: str
     tag_id: str
     local: bool
-    relationship_type: str
-    Tag: GetAllEventsEventTagTag
+    relationship_type: str | None = None
+    Tag: GetAllEventsEventTagTag | None = None
 
 
 class GetAllEventsResponse(BaseModel):
@@ -440,7 +480,7 @@ class GetAllEventsResponse(BaseModel):
     sighting_timestamp: str
     disable_correlation: bool
     extends_uuid: str
-    event_creator_email: str  # omitted
+    event_creator_email: str | None = None  # omitted
     protected: str | None = None
     Org: GetAllEventsOrg
     Orgc: GetAllEventsOrg
@@ -451,22 +491,6 @@ class GetAllEventsResponse(BaseModel):
         orm_mode = True
 
 
-class FreeTextImportWorkerData(BaseModel):
-    data: str
-
-
-class FreeTextImportWorkerUser(BaseModel):
-    user_id: int
-
-
-class FreeTextImportWorkerBody(BaseModel):
-    user: FreeTextImportWorkerUser
-    data: FreeTextImportWorkerData
-
-    class Config:
-        orm_mode = True
-
-
 class EditEventBody(BaseModel):
     info: str | None = None
     org_id: str | None = None
@@ -546,30 +570,6 @@ class AddEventTag(BaseModel):
     name: str
 
 
-class AddAttributeViaFreeTextImportEventResponse(BaseModel):
-    comment: str | None = None
-    value: str
-    original_value: str
-    to_ids: str
-    type: str
-    category: str
-    distribution: str
-
-    class Config:
-        orm_mode = True
-
-
-class AddAttributeViaFreeTextImportEventAttributes(BaseModel):
-    value: str
-
-
-class AddAttributeViaFreeTextImportEventBody(BaseModel):
-    Attribute: AddAttributeViaFreeTextImportEventAttributes
-
-    class Config:
-        orm_mode = True
-
-
 class AddEditGetEventRelatedEventAttributesOrg(BaseModel):
     id: str
     name: str

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

@@ -0,0 +1,64 @@
+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.galaxies import ExportGalaxyGalaxyElement, GetAllSearchGalaxiesAttributes
+from mmisp.api_schemas.organisations import GetOrganisationResponse
+from mmisp.api_schemas.organisations.organisation import Organisation
+
+
+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
+    Galaxy: GetAllSearchGalaxiesAttributes
+    GalaxyElement: list[ExportGalaxyGalaxyElement]
+    Org: GetOrganisationResponse
+    Orgc: GetOrganisationResponse
+
+
+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

mmisp_lib-0.3.0/src/mmisp/api_schemas/jobs.py

@@ -0,0 +1,52 @@
+from pydantic import BaseModel
+
+
+class FreeTextProcessID(BaseModel):
+    id: str
+
+
+class FreeTextImportWorkerData(BaseModel):
+    data: str
+
+
+class FreeTextImportWorkerUser(BaseModel):
+    user_id: int
+
+
+class FreeTextImportWorkerBody(BaseModel):
+    user: FreeTextImportWorkerUser
+    data: FreeTextImportWorkerData
+
+    class Config:
+        orm_mode = True
+
+
+class AddAttributeViaFreeTextImportEventResponse(BaseModel):
+    event_id: str
+    value: str
+    original_value: str
+    to_ids: str
+    type: str
+    category: str
+    distribution: str
+
+    class Config:
+        orm_mode = True
+
+
+class AddAttributeViaFreeTextImportEventBody(BaseModel):
+    value: str
+    returnMetaAttributes: bool
+
+    class Config:
+        orm_mode = True
+
+
+class AttributeType(BaseModel):
+    types: list[str]
+    default_type: str
+    value: str
+
+
+class ProcessFreeTextResponse(BaseModel):
+    attributes: list[AttributeType]

mmisp_lib-0.3.0/src/mmisp/api_schemas/organisations.py

@@ -0,0 +1,126 @@
+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
+
+
+class GetOrganisationResponse(BaseModel):
+    id: str
+    name: str
+    date_created: datetime
+    date_modified: datetime
+    description: str | None = None
+    type: str | None = None
+    nationality: str | None = None
+    sector: str | None = None
+    created_by: str
+    uuid: str | None = None
+    contacts: str | None = None
+    local: bool
+    restricted_to_domain: str | None = None
+    landingpage: str | None = None
+
+
+class GetAllOrganisationsOrganisation(BaseModel):
+    id: str
+    name: str
+    date_created: datetime
+    date_modified: datetime
+    description: str | None = None
+    type: str | None = None
+    nationality: str | None = None
+    sector: str | None = None
+    created_by: str
+    uuid: str | None = None
+    contacts: str | None = None
+    local: bool
+    restricted_to_domain: str | None = None
+    landingpage: str | None = None
+    user_count: int
+    created_by_email: str
+
+
+class GetAllOrganisationResponse(BaseModel):
+    Organisation: GetAllOrganisationsOrganisation
+
+
+class DeleteForceUpdateOrganisationResponse(BaseModel):
+    saved: bool | None = None
+    success: bool | None = None
+    name: str
+    message: str
+    url: str
+
+    class Config:
+        orm_mode = True
+
+
+class OrganisationUsersResponse(BaseModel):
+    id: int
+    name: str
+    date_created: datetime | None = None
+    date_modified: datetime | None = None
+    description: str | None = None
+    type: str | None = None
+    nationality: str | None = None
+    sector: str | None = None
+    created_by: int | None = None
+    uuid: str | None = None
+    contacts: str | None = None
+    local: bool | None = None
+    restricted_to_domain: str | None = None
+    landingpage: str | None = None
+
+
+class AddOrganisation(BaseModel):
+    id: str
+    name: str
+    description: str | None = None
+    type: str
+    nationality: str | None = None
+    sector: str | None = None
+    created_by: 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
+
+
+class EditOrganisation(BaseModel):
+    name: str
+    description: str | None = None
+    type: str
+    nationality: str | None = None
+    sector: str | None = None
+    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