mmisp-lib 0.1.0__py3-none-any.whl

mmisp/api_schemas/taxonomies/get_taxonomy_tags_response.py

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

mmisp/api_schemas/user_settings/get_uid_user_setting_response.py

@@ -0,0 +1,21 @@
+from pydantic import BaseModel
+
+
+class Position(BaseModel):
+    x: str
+    y: str
+    width: str
+    height: str
+
+
+class Value(BaseModel):
+    widget: str
+    position: Position
+
+
+class GetUserSettingResponse(BaseModel):
+    id: str
+    setting: str
+    value: str
+    user_id: str
+    timestamp: str

mmisp/api_schemas/user_settings/get_user_settings_response.py

@@ -0,0 +1,13 @@
+from pydantic import BaseModel
+
+
+class UserSettingSchema(BaseModel):
+    id: str
+    setting: str
+    value: dict | list
+    user_id: str
+    timestamp: str
+
+
+class UserSettingResponse(BaseModel):
+    UserSetting: UserSettingSchema

mmisp/api_schemas/user_settings/search_user_setting_body.py

@@ -0,0 +1,7 @@
+from pydantic import BaseModel
+
+
+class SearchUserSettingBody(BaseModel):
+    id: str | None = None
+    setting: str | None = None
+    user_id: str | None = None

mmisp/api_schemas/user_settings/search_user_setting_response.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel
+
+from .get_uid_user_setting_response import Value
+
+
+class SearchUserSettingResponse(BaseModel):
+    id: str
+    setting: str
+    value: Value
+    user_id: str
+    timestamp: str

mmisp/api_schemas/user_settings/set_user_setting_body.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class SetUserSettingBody(BaseModel):
+    value: dict | list

mmisp/api_schemas/user_settings/set_user_setting_response.py

@@ -0,0 +1,13 @@
+from pydantic import BaseModel
+
+
+class SetUserSettingResponseUserSetting(BaseModel):
+    id: str
+    setting: str
+    value: dict | list
+    user_id: str
+    timestamp: str
+
+
+class SetUserSettingResponse(BaseModel):
+    UserSetting: SetUserSettingResponseUserSetting

mmisp/api_schemas/user_settings/view_user_setting_response.py

@@ -0,0 +1,13 @@
+from pydantic import BaseModel
+
+
+class ViewUserSettingResponseUserSetting(BaseModel):
+    id: str
+    setting: str
+    value: dict | list
+    user_id: str
+    timestamp: str
+
+
+class ViewUserSettingResponse(BaseModel):
+    UserSetting: ViewUserSettingResponseUserSetting

mmisp/api_schemas/users/user.py

@@ -0,0 +1,42 @@
+from datetime import datetime
+
+from pydantic import BaseModel
+
+
+class User(BaseModel):
+    id: str
+    org_id: str
+    email: str
+    autoalert: bool
+    invited_by: str
+    gpgkey: str
+    certif_public: str
+    termsaccepted: bool
+    role_id: str
+    change_pw: bool
+    contactalert: bool
+    disabled: bool
+    expiration: datetime
+    current_login: str
+    """time in seconds"""
+    last_login: str
+    """time in seconds"""
+    force_logout: bool
+    date_created: str
+    """time in seconds"""
+    date_modified: str
+    """time in seconds"""
+    external_auth_required: bool
+    external_auth_key: str
+    last_api_access: str
+    """time in seconds"""
+    notification_daily: bool
+    notification_weekly: bool
+    notification_monthly: bool
+    totp: str | None = None
+    hotp_counter: str | None = None
+    last_pw_change: str
+    """time in seconds"""
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/users/users_view_me_response.py

@@ -0,0 +1,12 @@
+from pydantic import BaseModel
+
+from ..organisations.organisation import Organisation
+from ..roles.role import Role
+from .user import User
+
+
+class UsersViewMeResponse(BaseModel):
+    User: User
+    Role: Role
+    UserSetting: list = []
+    Organisation: Organisation

mmisp/api_schemas/warninglists/check_value_warninglists_body.py

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

mmisp/api_schemas/warninglists/check_value_warninglists_response.py

@@ -0,0 +1,14 @@
+from pydantic import BaseModel
+
+
+class NameWarninglist(BaseModel):
+    id: str
+    name: str
+    matched: str
+
+
+class CheckValueResponse(BaseModel):
+    value: list[NameWarninglist]
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/warninglists/create_warninglist_body.py

@@ -0,0 +1,220 @@
+from enum import Enum
+
+from pydantic import BaseModel, Field
+
+
+class WarninglistListType(str, Enum):
+    CIDR = "cidr"
+    HOSTNAME = "hostname"
+    STRING = "string"
+    SUBSTRING = "substring"
+    REGEX = "regex"
+
+
+class WarninglistCategory(str, Enum):
+    FALSE_POSITIVE = "False positive"
+    KNOWN_IDENTIFIER = "Known identifier"
+
+
+class ValidAttribute(str, Enum):
+    MD5 = "md5"
+    SHA12SHA256 = "sha12sha256"
+    FILENAME = "filename"
+    PDB = "pdb"
+    FILENAME_MD5 = "filename|md5"
+    FILENAME_SHA1 = "filename|sha1"
+    FILENAME_SHA256 = "filename|sha256"
+    IP_SRC = "ip-src"
+    IP_DST = "ip-dst"
+    HOSTNAME = "hostname"
+    DOMAIN = "domain"
+    DOMAIN_IP = "domain|ip"
+    EMAIL = "email"
+    EMAIL_SRC = "email-src"
+    EPPN = "eppn"
+    EMAIL_DST = "email-dst"
+    EMAIL_SUBJECT = "email-subject"
+    EMAIL_ATTACHMENT = "email-attachment"
+    EMAIL_BODY = "email-body"
+    FLOAT = "float"
+    GIT_COMMIT_ID = "git-commit-id"
+    URL = "url"
+    HTTP_METHOD = "http-method"
+    USER_AGENT = "user-agent"
+    JA3_FINGERPRINT_MD5 = "ja3-fingerprint-md5"
+    JARM_FINGERPRINT = "jarm-fingerprint"
+    FAVICON_MMH3 = "favicon-mmh3"
+    HASSH_MD5 = "hassh-md5"
+    HASSHSERVER_MD5 = "hasshserver-md5"
+    REGKEY = "regkey"
+    REGKEY_VALUE = "regkey|value"
+    AS = "AS"
+    SNORT = "snort"
+    BRO = "bro"
+    ZEEK = "zeek"
+    COMMUNITY_ID = "community-id"
+    PATTERN_IN_FILE = "pattern-in-file"
+    PATTERN_IN_TRAFFIC = "pattern-in-traffic"
+    PATTERN_IN_MEMORY = "pattern-in-memory"
+    FILENAME_PATTERN = "filename-pattern"
+    PGP_PUBLIC_KEY = "pgp-public-key"
+    PGP_PRIVATE_KEY = "pgp-private-key"
+    SSH_FINGERPRINT = "ssh-fingerprint"
+    YARA = "yara"
+    STIX2_PATTERN = "stix2-pattern"
+    SIGMA = "sigma"
+    GENE = "gene"
+    KUSTO_QUERY = "kusto-query"
+    MIME_TYPE = "mime-type"
+    IDENTITY_CARD_NUMBER = "identity-card-number"
+    COOKIE = "cookie"
+    VULNERABILITY = "vulnerability"
+    CPE = "cpe"
+    WEAKNESS = "weakness"
+    ATTACHMENT = "attachment"
+    MALWARE_SAMPLE = "malware-sample"
+    LINK = "link"
+    COMMENT = "comment"
+    TEXT = "text"
+    HEX = "hex"
+    OTHER = "other"
+    NAMED_PIPE = "named pipe"
+    MUTEX = "mutex"
+    PROCESS_STATE = "process-state"
+    TARGET_USER = "target-user"
+    TARGET_EMAIL = "target-email"
+    TARGET_MACHINE = "target-machine"
+    TARGET_ORG = "target-org"
+    TARGET_LOCATION = "target-location"
+    TARGET_EXTERNAL = "target-external"
+    BTC = "btc"
+    DASH = "dash"
+    XMR = "xmr"
+    IBAN = "iban"
+    BIC = "bic"
+    BANK_ACCOUNT_NR = "bank-account-nr"
+    ABA_RTN = "aba-rtn"
+    BIN = "bin"
+    CC_NUMBER = "cc-number"
+    PRTN = "prtn"
+    PHONE_NUMBER = "phone-number"
+    THREAT_ACTOR = "threat-actor"
+    CAMPAIGN_NAME = "campaign-name"
+    CAMPAIGN_ID = "campaign-id"
+    MALWARE_TYPE = "malware-type"
+    URI = "uri"
+    AUTHENTIHASH = "authentihash"
+    VHASH = "vhash"
+    SSDEEP = "ssdeep"
+    IMPHASH = "imphash"
+    TELFHASH = "telfhash"
+    PEHASH = "pehash"
+    IMPFUZZY = "impfuzzy"
+    SHA224 = "sha224"
+    SHA384 = "sha384"
+    SHA512 = "sha512"
+    SHA512_224 = "sha512/224"
+    SHA512_256 = "sha512/256"
+    SHA3_224 = "sha3-224"
+    SHA3_256 = "sha3-256"
+    SHA3_384 = "sha3-384"
+    SHA3_512 = "sha3-512"
+    TLSH = "tlsh"
+    CDHASH = "cdhash"
+    FILENAME_AUTHENTIHASH = "filename|authentihash"
+    FILENAME_VHASH = "filename|vhash"
+    FILENAME_SSDEEP = "filename|ssdeep"
+    FILENAME_IMPHASH = "filename|imphash"
+    FILENAME_IMPFUZZY = "filename|impfuzzy"
+    FILENAME_PEHASH = "filename|pehash"
+    ILENAME_SHA224 = "ilename|sha224"
+    FILENAME_SHA384 = "filename|sha384"
+    FILENAME_SHA512 = "filename|sha512"
+    FILENAME_SHA512_224 = "filename|sha512/224"
+    FILENAME_SHA512_256 = "filename|sha512/256"
+    FILENAME_SHA3_224 = "filename|sha3-224"
+    FILENAME_SHA3_256 = "filename|sha3-256"
+    FILENAME_SHA3_384 = "filename|sha3-384"
+    FILENAME_SHA3_512 = "filename|sha3-512"
+    FILENAME_TLSH = "filename|tlsh"
+    WINDOWS_SCHEDULED_TASK = "windows-scheduled-task"
+    WINDOWS_SERVICE_NAME = "windows-service-name"
+    WINDOWS_SERVICE_DISPLAYNAME = "windows-service-displayname"
+    WHOIS_REGISTRANT_EMAIL = "whois-registrant-email"
+    WHOIS_REGISTRANT_PHONE = "whois-registrant-phone"
+    WHOIS_REGISTRANT_NAME = "whois-registrant-name"
+    WHOIS_REGISTRANT_ORG = "whois-registrant-org"
+    WHOIS_REGISTRAR = "whois-registrar"
+    WHOIS_CREATION_DATE = "whois-creation-date"
+    X509_FINGERPRINT_SHA1 = "x509-fingerprint-sha1"
+    X509_FINGERPRINT_MD5 = "x509-fingerprint-md5"
+    X509_FINGERPRINT_SHA256 = "x509-fingerprint-sha256"
+    DNS_SOA_EMAIL = "dns-soa-email"
+    SIZE_IN_BYTES = "size-in-bytes"
+    COUNTER = "counter"
+    DATETIME = "datetime"
+    PORT = "port"
+    IP_DST_PORT = "ip-dst|port"
+    IP_SRC_PORT = "ip-src|port"
+    HOSTNAME_PORT = "hostname|port"
+    MAC_ADDRESS = "mac-address"
+    MAC_EUI_64 = "mac-eui-64"
+    EMAIL_DST_DISPLAY_NAME = "email-dst-display-name"
+    EMAIL_SRC_DISPLAY_NAME = "email-src-display-name"
+    EMAIL_HEADER = "email-header"
+    EMAIL_REPLY_TO = "email-reply-to"
+    EMAIL_X_MAILER = "email-x-mailer"
+    EMAIL_MIME_BOUNDARY = "email-mime-boundary"
+    EMAIL_THREAD_INDEX = "email-thread-index"
+    EMAIL_MESSAGE_ID = "email-message-id"
+    GITHUB_USERNAME = "github-username"
+    GITHUB_REPOSITORY = "github-repository"
+    GITHUB_ORGANISATION = "github-organisation"
+    JABBER_ID = "jabber-id"
+    TWITTER_ID = "twitter-id"
+    DKIM = "dkim"
+    DKIM_SIGNATURE = "dkim-signature"
+    FIRST_NAME = "first-name"
+    MIDDLE_NAME = "middle-name"
+    LAST_NAME = "last-name"
+    FULL_NAME = "full-name"
+    DATE_OF_BIRTH = "date-of-birth"
+    PLACE_OF_BIRTH = "place-of-birth"
+    GENDER = "gender"
+    PASSPORT_NUMBER = "passport-number"
+    PASSPORT_COUNTRY = "passport-country"
+    PASSPORT_EXPIRATION = "passport-expiration"
+    REDRESS_NUMBER = "redress-number"
+    NATIONALITY = "nationality"
+    VISA_NUMBER = "visa-number"
+    ISSUE_DATE_OF_THE_VISA = "issue-date-of-the-visa"
+    PRIMARY_RESIDENCE = "primary-residence"
+    COUNTRY_OF_RESIDENCE = "country-of-residence"
+    SPECIAL_SERVICE_REQUEST = "special-service-request"
+    FREQUENT_FLYER_NUMBER = "frequent-flyer-number"
+    TRAVEL_DETAILS = "travel-details"
+    PAYMENT_DETAILS = "payment-details"
+    PLACE_PORT_OF_ORIGINAL_EMBARKATION = "place-port-of-original-embarkation"
+    PLACE_PORT_OF_CLEARANCE = "place-port-of-clearance"
+    PLACE_PORT_OF_ONWARD_FOREIGN_DESTINATION = "place-port-of-onward-foreign-destination"
+    PASSENGER_NAME_RECORD_LOCATOR_NUMBER = "passenger-name-record-locator-number"
+    MOBILE_APPLICATION_ID = "mobile-application-id"
+    AZURE_APPLICATION_ID = "azure-application-id"
+    CHROME_EXTENSION_ID = "chrome-extension-id"
+    CORTEX = "cortex"
+    BOOLEAN = "boolean"
+    ANONYMISED = "anonymised"
+
+
+class CreateWarninglistBody(BaseModel):
+    name: str = Field(min_length=1, max_length=255)
+    type: WarninglistListType
+    description: str = Field(min_length=1, max_length=65535)
+    enabled: bool
+    default: bool
+    category: WarninglistCategory
+    valid_attributes: list[ValidAttribute]
+    values: str = Field(min_length=1, max_length=65535)
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/warninglists/delete_warninglist_response.py

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

mmisp/api_schemas/warninglists/get_selected_all_warninglists_response.py

@@ -0,0 +1,14 @@
+from pydantic import BaseModel
+
+from mmisp.api_schemas.warninglists.warninglist_response import WarninglistAttributes
+
+
+class WarninglistsResponse(BaseModel):
+    Warninglist: WarninglistAttributes
+
+
+class GetSelectedAllWarninglistsResponse(BaseModel):
+    Warninglists: list[WarninglistsResponse]
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/warninglists/get_selected_warninglists_body.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+
+
+class GetSelectedWarninglistsBody(BaseModel):
+    value: str | None = None
+    enabled: bool | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/warninglists/toggle_enable_warninglists_body.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel
+
+
+class ToggleEnableWarninglistsBody(BaseModel):
+    id: str | list[str]
+    name: str | list[str]
+    enabled: bool
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/warninglists/toggle_enable_warninglists_response.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel
+
+
+class ToggleEnableWarninglistsResponse(BaseModel):
+    saved: bool
+    success: str | None = None
+    errors: str | None = None
+
+    class Config:
+        orm_mode = True

mmisp/api_schemas/warninglists/warninglist_response.py

@@ -0,0 +1,42 @@
+from pydantic import BaseModel, Field
+
+
+class WarninglistEntryResponse(BaseModel):
+    id: str
+    value: str = Field(max_length=65535)
+    warninglist_id: str
+    comment: str | None = None
+
+
+class WarninglistTypeResponse(BaseModel):
+    id: str
+    type: str
+    warninglist_id: str
+
+
+class WarninglistBaseResponse(BaseModel):
+    id: str
+    name: str = Field(max_length=255)
+    type: str
+    description: str = Field(max_length=65535)
+    version: str
+    enabled: bool
+    default: bool
+    category: str
+
+
+class WarninglistAttributes(WarninglistBaseResponse):
+    warninglist_entry_count: str
+    valid_attributes: str
+
+
+class WarninglistAttributesResponse(WarninglistBaseResponse):
+    WarninglistEntry: list[WarninglistEntryResponse] | None = None
+    WarninglistType: list[WarninglistTypeResponse] | None = None
+
+
+class WarninglistResponse(BaseModel):
+    Warninglist: WarninglistAttributesResponse
+
+    class Config:
+        orm_mode = True

mmisp/db/config.py

@@ -0,0 +1,17 @@
+from os import getenv
+
+from dotenv import load_dotenv
+
+from dataclasses import dataclass
+
+@dataclass
+class DatabaseConfig:
+    DATABASE_URL: str
+
+
+load_dotenv(getenv("ENV_FILE", ".env"))
+
+
+config: DatabaseConfig = DatabaseConfig(
+    DATABASE_URL=getenv("DATABASE_URL", "")
+)

mmisp/db/database.py

@@ -0,0 +1,42 @@
+from functools import wraps
+from typing import Any, Callable, TypeAlias
+
+from sqlalchemy.engine.url import make_url
+from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
+from sqlalchemy.orm import declarative_base, sessionmaker
+from sqlalchemy.pool import NullPool
+
+from mmisp.db.config import config
+
+Session: TypeAlias = AsyncSession
+
+url = make_url(config.DATABASE_URL)
+engine = create_async_engine(url, poolclass=NullPool)
+async_session = sessionmaker(autoflush=False, expire_on_commit=False, class_=AsyncSession, bind=engine)
+
+Base = declarative_base()
+
+
+def get_db() -> Session:
+    return async_session()
+
+
+def with_session_management(fn: Callable) -> Callable:
+    @wraps(fn)
+    async def wrapper(*args, **kwargs) -> Any:
+        db: Session = kwargs.pop("db")
+        output: Any = None
+
+        try:
+            output = await fn(*args, **kwargs, db=db)
+        finally:
+            await db.close()
+
+        return output
+
+    return wrapper
+
+
+async def create_all_models() -> None:
+    async with engine.begin() as db:
+        await db.run_sync(Base.metadata.create_all)