mmisp-lib 0.1.2__tar.gz → 0.1.4__tar.gz

{mmisp_lib-0.1.2 → mmisp_lib-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mmisp-lib
-Version: 0.1.2
+Version: 0.1.4
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 Requires-Dist: fastapi==0.104.1

{mmisp_lib-0.1.2 → mmisp_lib-0.1.4}/pyproject.toml

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

{mmisp_lib-0.1.2 → mmisp_lib-0.1.4}/src/mmisp/api_schemas/auth_keys/search_auth_keys_body.py

@@ -1,9 +1,9 @@
-from pydantic import BaseModel
+from pydantic import BaseModel, PositiveInt, conint
 
 
 class SearchAuthKeyBody(BaseModel):
-    page: int | None = 0
-    limit: int | None = 25
+    page: PositiveInt | None = 1
+    limit: conint(gt=0, lt=500) | None = 25  # type: ignore
     id: str | None = None
     uuid: str | None = None
     authkey_start: str | None = None

mmisp_lib-0.1.4/src/mmisp/db/models/role.py

@@ -0,0 +1,34 @@
+from typing import Self
+
+from sqlalchemy import Boolean, Column, DateTime, Integer, String
+
+from mmisp.lib.permissions import Permission
+
+from ..database import Base
+
+RoleAttrs = {
+    "__tablename__": "roles",
+    "id": Column(Integer, primary_key=True, nullable=False),
+    "name": Column(String(255), nullable=False),
+    "created": Column(DateTime, default=None),
+    "modified": Column(DateTime, default=None),
+    "default_role": Column(Boolean, nullable=False, default=False),
+    "memory_limit": Column(String(255), default=""),
+    "max_execution_time": Column(String(255), default=""),
+    "restricted_to_site_admin": Column(Boolean, nullable=False, default=False),
+    "enforce_rate_limit": Column(Boolean, nullable=False, default=False),
+    "rate_limit_count": Column(Integer, nullable=False, default=0),
+} | {f"perm_{x.value}": Column(Boolean, default=False) for x in Permission}
+
+RoleModel = type("RoleModel", (Base,), RoleAttrs)
+
+
+class Role(RoleModel):
+    def get_permissions(self: Self) -> set[Permission]:
+        d: list[Permission] = []
+
+        for key in self.__mapper__.c.keys():
+            if key.startswith("perm_") and getattr(self, key):
+                d.append(Permission(key[len("perm_") :]))
+
+        return set(d)

mmisp_lib-0.1.4/src/mmisp/lib/permissions.py

@@ -0,0 +1,54 @@
+from enum import StrEnum
+
+
+class Permission(StrEnum):
+    ADD = "add"
+    MODIFY = "modify"
+    """Manage Own Events."""
+    MODIFY_ORG = "modify_org"
+    """Manage Organisation Events."""
+    PUBLISH = "publish"
+    """Publish Organisation Events."""
+    DELEGATE = "delegate"
+    """Allow users to create delegation requests for their own org only events to trusted third parties."""
+    SYNC = "sync"
+    """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."""
+    ADMIN = "admin"
+    """Limited organisation admin - create, manage users of their own organisation."""
+    AUDIT = "audit"
+    """Access to the audit logs of the user\'s organisation."""
+    AUTH = "auth"
+    """Users with this permission have access to authenticating via their Auth keys,
+    granting them access to the API."""
+    SITE_ADMIN = "site_admin"
+    """Unrestricted access to any data and functionality on this instance."""
+    REGEXP_ACCESS = "regexp_access"
+    """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."""
+    TAGGER = "tagger"
+    """Users with roles that include this permission can attach
+    or detach existing tags to and from events/attributes."""
+    TEMPLATE = "template"
+    """Create or modify templates, to be used when populating events."""
+    SHARING_GROUP = "sharing_group"
+    """Permission to create or modify sharing groups."""
+    TAG_EDITOR = "tag_editor"
+    """This permission gives users the ability to create tags."""
+    SIGHTING = "sighting"
+    """Permits the user to push feedback on attributes into MISP by providing sightings."""
+    OBJECT_TEMPLATE = "object_template"
+    """Create or modify MISP Object templates."""
+    PUBLISH_ZMQ = "publish_zmq"
+    """Allow users to publish data to the ZMQ pubsub channel via the publish event to ZMQ button."""
+    PUBLISH_KAFKA = "publish_kafka"
+    """Allow users to publish data to Kafka via the publish event to Kafka button."""
+    DECAYING = "decaying"
+    """Create or modify MISP Decaying Models."""
+    GALAXY_EDITOR = "galaxy_editor"
+    """Create or modify MISP Galaxies and MISP Galaxies Clusters."""
+    WARNINGLIST = "warninglist"
+    """Allow to manage warninglists."""
+    VIEW_FEED_CORRELATIONS = "view_feed_correlations"
+    """Allow the viewing of feed correlations. Enabling this can come at a performance cost."""

{mmisp_lib-0.1.2 → mmisp_lib-0.1.4}/src/mmisp_lib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mmisp-lib
-Version: 0.1.2
+Version: 0.1.4
 Requires-Python: >=3.11.0
 Description-Content-Type: text/markdown
 Requires-Dist: fastapi==0.104.1

{mmisp_lib-0.1.2 → mmisp_lib-0.1.4}/src/mmisp_lib.egg-info/SOURCES.txt

@@ -157,6 +157,7 @@ src/mmisp/db/models/user_setting.py
 src/mmisp/db/models/warninglist.py
 src/mmisp/lib/__init__.py
 src/mmisp/lib/attributes.py
+src/mmisp/lib/permissions.py
 src/mmisp_lib.egg-info/PKG-INFO
 src/mmisp_lib.egg-info/SOURCES.txt
 src/mmisp_lib.egg-info/dependency_links.txt

mmisp_lib-0.1.2/src/mmisp/db/models/role.py

@@ -1,42 +0,0 @@
-from sqlalchemy import Boolean, Column, DateTime, Integer, String
-
-from ..database import Base
-
-
-class Role(Base):
-    __tablename__ = "roles"
-
-    id = Column(Integer, primary_key=True, nullable=False)
-    name = Column(String(255), nullable=False)
-    created = Column(DateTime, default=None)
-    modified = Column(DateTime, default=None)
-    perm_add = Column(Boolean, default=False)
-    perm_modify = Column(Boolean, default=False)
-    perm_modify_org = Column(Boolean, default=False)
-    perm_publish = Column(Boolean, default=False)
-    perm_delegate = Column(Boolean, nullable=False, default=False)
-    perm_sync = Column(Boolean, default=False)
-    perm_admin = Column(Boolean, default=False)
-    perm_audit = Column(Boolean, default=False)
-    perm_full = Column(Boolean, default=False)
-    perm_auth = Column(Boolean, nullable=False, default=False)
-    perm_site_admin = Column(Boolean, nullable=False, default=False)
-    perm_regexp_access = Column(Boolean, nullable=False, default=False)
-    perm_tagger = Column(Boolean, nullable=False, default=False)
-    perm_template = Column(Boolean, nullable=False, default=False)
-    perm_sharing_group = Column(Boolean, nullable=False, default=False)
-    perm_tag_editor = Column(Boolean, nullable=False, default=False)
-    perm_sighting = Column(Boolean, nullable=False, default=False)
-    perm_object_template = Column(Boolean, nullable=False, default=False)
-    default_role = Column(Boolean, nullable=False, default=False)
-    memory_limit = Column(String(255), default="")
-    max_execution_time = Column(String(255), default="")
-    restricted_to_site_admin = Column(Boolean, nullable=False, default=False)
-    perm_publish_zmq = Column(Boolean, nullable=False, default=False)
-    perm_publish_kafka = Column(Boolean, nullable=False, default=False)
-    perm_decaying = Column(Boolean, nullable=False, default=False)
-    enforce_rate_limit = Column(Boolean, nullable=False, default=False)
-    rate_limit_count = Column(Integer, nullable=False, default=0)
-    perm_galaxy_editor = Column(Boolean, default=False)
-    perm_warninglist = Column(Boolean, default=False)
-    perm_view_feed_correlations = Column(Boolean, default=False)