Skip to content

A modern platform for visual, flexible, and extensible graph-based investigations. For cybersecurity analysts and investigators.

refactor(core): use permissions in base service

dextmorgnc7275594cbcc
diff --git a/flowsint-core/src/flowsint_core/core/repositories/analysis_repository.py b/flowsint-core/src/flowsint_core/core/repositories/analysis_repository.py
index 2b6fc31c..d8b27365 100644
--- a/flowsint-core/src/flowsint_core/core/repositories/analysis_repository.py
+++ b/flowsint-core/src/flowsint_core/core/repositories/analysis_repository.py
@@ -2,7 +2,7 @@
from typing import List, Optional
from uuid import UUID
-from ..models import Analysis, InvestigationUserRole
+from ..models import Analysis
from ..types import Role
from .base import BaseRepository
@@ -13,22 +13,7 @@ class AnalysisRepository(BaseRepository[Analysis]):
def get_accessible_by_user(
self, user_id: UUID, allowed_roles: Optional[List[Role]] = None
) -> List[Analysis]:
- if allowed_roles is None:
- allowed_roles = [Role.OWNER, Role.EDITOR, Role.VIEWER]
-
- # Get all investigation IDs accessible by this user
- role_entries = (
- self._db.query(InvestigationUserRole)
- .filter(InvestigationUserRole.user_id == user_id)
- .all()
- )
- inv_ids = set()
- for entry in role_entries:
- for role in entry.roles:
- if role in allowed_roles:
- inv_ids.add(entry.investigation_id)
- break
-
+ inv_ids = self._get_accessible_investigation_ids(user_id, allowed_roles)
if not inv_ids:
return []
diff --git a/flowsint-core/src/flowsint_core/core/repositories/base.py b/flowsint-core/src/flowsint_core/core/repositories/base.py
index 1989ef98..e8fef10b 100644
--- a/flowsint-core/src/flowsint_core/core/repositories/base.py
+++ b/flowsint-core/src/flowsint_core/core/repositories/base.py
@@ -1,9 +1,12 @@
"""Base repository providing common database operations."""
-from typing import Generic, List, Optional, Type, TypeVar
+from typing import Generic, List, Optional, Set, Type, TypeVar
from uuid import UUID
from sqlalchemy.orm import Session
+from ..models import InvestigationUserRole
+from ..types import Role
+
T = TypeVar("T")
@@ -15,6 +18,24 @@ class BaseRepository(Generic[T]):
def __init__(self, db: Session):
self._db = db
+ def _get_accessible_investigation_ids(
+ self, user_id: UUID, allowed_roles: Optional[List[Role]] = None
+ ) -> Set[UUID]:
+ if allowed_roles is None:
+ allowed_roles = [Role.OWNER, Role.EDITOR, Role.VIEWER]
+ role_entries = (
+ self._db.query(InvestigationUserRole)
+ .filter(InvestigationUserRole.user_id == user_id)
+ .all()
+ )
+ inv_ids = set()
+ for entry in role_entries:
+ for role in entry.roles:
+ if role in allowed_roles:
+ inv_ids.add(entry.investigation_id)
+ break
+ return inv_ids
+
def get_by_id(self, id: UUID) -> Optional[T]:
return self._db.query(self.model).filter(self.model.id == id).first()
diff --git a/flowsint-core/src/flowsint_core/core/repositories/investigation_repository.py b/flowsint-core/src/flowsint_core/core/repositories/investigation_repository.py
index 5b932ec0..40de3857 100644
--- a/flowsint-core/src/flowsint_core/core/repositories/investigation_repository.py
+++ b/flowsint-core/src/flowsint_core/core/repositories/investigation_repository.py
@@ -15,29 +15,14 @@ class InvestigationRepository(BaseRepository[Investigation]):
def get_accessible_by_user(
self, user_id: UUID, allowed_roles: Optional[List[Role]] = None
) -> List[Investigation]:
- query = self._db.query(Investigation).join(
- InvestigationUserRole,
- InvestigationUserRole.investigation_id == Investigation.id,
- )
- query = query.filter(InvestigationUserRole.user_id == user_id)
-
- if allowed_roles:
- # Filter by checking if user has any matching role
- role_entries = (
- self._db.query(InvestigationUserRole)
- .filter(InvestigationUserRole.user_id == user_id)
- .all()
- )
- inv_ids = set()
- for entry in role_entries:
- for role in entry.roles:
- if role in allowed_roles:
- inv_ids.add(entry.investigation_id)
- break
- query = query.filter(Investigation.id.in_(inv_ids))
+ inv_ids = self._get_accessible_investigation_ids(user_id, allowed_roles)
+ if not inv_ids:
+ return []
return (
- query.options(
+ self._db.query(Investigation)
+ .filter(Investigation.id.in_(inv_ids))
+ .options(
selectinload(Investigation.sketches),
selectinload(Investigation.analyses),
selectinload(Investigation.owner),
diff --git a/flowsint-core/src/flowsint_core/core/repositories/key_repository.py b/flowsint-core/src/flowsint_core/core/repositories/key_repository.py
index f4954150..6839a88f 100644
--- a/flowsint-core/src/flowsint_core/core/repositories/key_repository.py
+++ b/flowsint-core/src/flowsint_core/core/repositories/key_repository.py
@@ -1,10 +1,15 @@
"""Repository for Key model."""
+
from typing import List, Optional
from uuid import UUID
+from sqlalchemy import exists
+
from ..models import Key
from .base import BaseRepository
+CHAT_KEY_NAMES = ["MISTRAL_API_KEY"]
+
class KeyRepository(BaseRepository[Key]):
model = Key
@@ -12,11 +17,22 @@ class KeyRepository(BaseRepository[Key]):
def get_by_owner(self, owner_id: UUID) -> List[Key]:
return self._db.query(Key).filter(Key.owner_id == owner_id).all()
- def get_by_id_and_owner(
- self, key_id: UUID, owner_id: UUID
- ) -> Optional[Key]:
+ def get_by_name_and_owner(self, owner_id: UUID, name: str) -> Key | None:
+ return (
+ self._db.query(Key)
+ .filter(Key.owner_id == owner_id)
+ .filter(Key.name == name)
+ .first()
+ )
+
+ def get_by_id_and_owner(self, key_id: UUID, owner_id: UUID) -> Optional[Key]:
return (
self._db.query(Key)
.filter(Key.id == key_id, Key.owner_id == owner_id)
.first()
)
+
+ def chat_key_exist(self, owner_id: UUID) -> bool:
+ return self._db.query(
+ exists().where(Key.owner_id == owner_id, Key.name.in_(CHAT_KEY_NAMES))
+ ).scalar()
diff --git a/flowsint-core/src/flowsint_core/core/repositories/scan_repository.py b/flowsint-core/src/flowsint_core/core/repositories/scan_repository.py
index f35b2385..6bb7c73e 100644
--- a/flowsint-core/src/flowsint_core/core/repositories/scan_repository.py
+++ b/flowsint-core/src/flowsint_core/core/repositories/scan_repository.py
@@ -1,9 +1,9 @@
"""Repository for Scan model."""
+
from typing import List
from uuid import UUID
-from ..models import Scan, Sketch, InvestigationUserRole
-from ..types import Role
+from ..models import Scan, Sketch
from .base import BaseRepository
@@ -11,28 +11,43 @@ class ScanRepository(BaseRepository[Scan]):
model = Scan
def get_accessible_by_user(self, user_id: UUID) -> List[Scan]:
- allowed_roles = [Role.OWNER, Role.EDITOR, Role.VIEWER]
+ inv_ids = self._get_accessible_investigation_ids(user_id)
+ if not inv_ids:
+ return []
- # Get investigation IDs accessible by user
- role_entries = (
- self._db.query(InvestigationUserRole)
- .filter(InvestigationUserRole.user_id == user_id)
+ return (
+ self._db.query(Scan)
+ .join(Sketch, Sketch.id == Scan.sketch_id)
+ .filter(Sketch.investigation_id.in_(inv_ids))
.all()
)
- inv_ids = set()
- for entry in role_entries:
- for role in entry.roles:
- if role in allowed_roles:
- inv_ids.add(entry.investigation_id)
- break
+ def get_accessible_by_sketch_id(self, user_id: UUID, sketch_id: UUID) -> List[Scan]:
+ inv_ids = self._get_accessible_investigation_ids(user_id)
if not inv_ids:
return []
return (
self._db.query(Scan)
.join(Sketch, Sketch.id == Scan.sketch_id)
- .filter(Sketch.investigation_id.in_(inv_ids))
- .distinct()
+ .filter(Sketch.investigation_id.in_(inv_ids), Sketch.id == sketch_id)
+ .all()
+ )
+
+ def get_accessible_by_status_and_sketch_id(
+ self, user_id: UUID, sketch_id: UUID, status: str
+ ) -> List[Scan]:
+ inv_ids = self._get_accessible_investigation_ids(user_id)
+ if not inv_ids:
+ return []
+
+ return (
+ self._db.query(Scan)
+ .join(Sketch, Sketch.id == Scan.sketch_id)
+ .filter(
+ Sketch.investigation_id.in_(inv_ids),
+ Sketch.id == sketch_id,
+ Scan.status == status,
+ )
.all()
)
diff --git a/flowsint-core/src/flowsint_core/core/services/__init__.py b/flowsint-core/src/flowsint_core/core/services/__init__.py
index 11510fc2..46a32fcc 100644
--- a/flowsint-core/src/flowsint_core/core/services/__init__.py
+++ b/flowsint-core/src/flowsint_core/core/services/__init__.py
@@ -5,30 +5,40 @@ This module provides business logic services that encapsulate database operation
and domain logic, enabling cleaner route handlers and better testability.
"""
+from .analysis_service import AnalysisService, create_analysis_service
+from .auth_service import AuthService, create_auth_service
+from .base import BaseService
+from .chat_service import ChatService, create_chat_service
+from .custom_type_service import CustomTypeService, create_custom_type_service
+from .enricher_service import EnricherService, create_enricher_service
+from .enricher_template_service import (
+ EnricherTemplateService,
+ create_enricher_template_service,
+)
from .exceptions import (
- ServiceError,
+ AuthenticationError,
+ ConflictError,
+ DatabaseError,
NotFoundError,
PermissionDeniedError,
+ ServiceError,
ValidationError,
- DatabaseError,
- AuthenticationError,
- ConflictError,
)
-from .base import BaseService
-from .auth_service import AuthService, create_auth_service
-from .key_service import KeyService, create_key_service
+from .flow_service import FlowService, create_flow_service
from .investigation_service import InvestigationService, create_investigation_service
-from .sketch_service import SketchService, create_sketch_service
-from .analysis_service import AnalysisService, create_analysis_service
-from .chat_service import ChatService, create_chat_service
-from .scan_service import ScanService, create_scan_service
+from .key_service import create_key_service, keyService
from .log_service import LogService, create_log_service
-from .flow_service import FlowService, create_flow_service
-from .custom_type_service import CustomTypeService, create_custom_type_service
-from .type_registry_service import TypeRegistryService, create_type_registry_service, local_type_resolver
-from .enricher_service import EnricherService, create_enricher_service
-from .enricher_template_service import EnricherTemplateService, create_enricher_template_service
-from .template_generator_service import TemplateGeneratorService, create_template_generator_service
+from .scan_service import ScanService, create_scan_service
+from .sketch_service import SketchService, create_sketch_service
+from .template_generator_service import (
+ TemplateGeneratorService,
+ create_template_generator_service,
+)
+from .type_registry_service import (
+ TypeRegistryService,
+ create_type_registry_service,
+ local_type_resolver,
+)
from .vault_service import VaultService, create_vault_service
__all__ = [
@@ -45,7 +55,7 @@ __all__ = [
# Services - Phase 1
"AuthService",
"create_auth_service",
- "KeyService",
+ "keyService",
"create_key_service",
# Services - Phase 2
"InvestigationService",
diff --git a/flowsint-core/src/flowsint_core/core/services/key_service.py b/flowsint-core/src/flowsint_core/core/services/key_service.py
index f00e3446..6b247dd5 100644
--- a/flowsint-core/src/flowsint_core/core/services/key_service.py
+++ b/flowsint-core/src/flowsint_core/core/services/key_service.py
@@ -10,10 +10,10 @@ from sqlalchemy.orm import Session
from ..models import Key
from ..repositories import KeyRepository
from .base import BaseService
-from .exceptions import NotFoundError, DatabaseError
+from .exceptions import DatabaseError, NotFoundError
-class KeyService(BaseService):
+class keyService(BaseService):
"""
Service for API key management with encryption via Vault.
"""
@@ -26,6 +26,9 @@ class KeyService(BaseService):
def get_keys_for_user(self, user_id: UUID) -> List[Key]:
return self._key_repo.get_by_owner(user_id)
+ def get_key_by_owner_and_name(self, user_id: UUID, name: str) -> Key | None:
+ return self._key_repo.get_by_name_and_owner(user_id, name)
+
def get_key_by_id(self, key_id: UUID, user_id: UUID) -> Key:
key = self._key_repo.get_by_id_and_owner(key_id, user_id)
if not key:
@@ -34,7 +37,9 @@ class KeyService(BaseService):
def create_key(self, name: str, key_value: str, user_id: UUID) -> Key:
try:
- key = self._vault_service.set_secret(user_id, vault_ref=name, plain_key=key_value)
+ key = self._vault_service.set_secret(
+ user_id, vault_ref=name, plain_key=key_value
+ )
if not key:
raise DatabaseError("An error occurred creating the key")
return key
@@ -49,11 +54,14 @@ class KeyService(BaseService):
def get_decrypted_key(self, name_or_id: str, user_id: UUID) -> Optional[str]:
return self._vault_service.get_secret(user_id, name_or_id)
+ def chat_key_exist(self, user_id: UUID) -> bool:
+ return self._key_repo.chat_key_exist(user_id)
+
-def create_key_service(db: Session) -> KeyService:
+def create_key_service(db: Session) -> keyService:
from .vault_service import VaultService
- return KeyService(
+ return keyService(
db=db,
key_repo=KeyRepository(db),
vault_service=VaultService(db=db),
diff --git a/flowsint-core/src/flowsint_core/core/services/scan_service.py b/flowsint-core/src/flowsint_core/core/services/scan_service.py
index 2f082550..0353b271 100644
--- a/flowsint-core/src/flowsint_core/core/services/scan_service.py
+++ b/flowsint-core/src/flowsint_core/core/services/scan_service.py
@@ -8,7 +8,7 @@ from uuid import UUID
from sqlalchemy.orm import Session
from ..models import Scan
-from ..repositories import ScanRepository, SketchRepository, InvestigationRepository
+from ..repositories import InvestigationRepository, ScanRepository, SketchRepository
from .base import BaseService
from .exceptions import NotFoundError, PermissionDeniedError
@@ -34,6 +34,18 @@ class ScanService(BaseService):
def get_accessible_scans(self, user_id: UUID) -> List[Scan]:
return self._scan_repo.get_accessible_by_user(user_id)
+ def get_accessible_scans_by_sketch_id(
+ self, user_id: UUID, sketch_id: UUID
+ ) -> List[Scan]:
+ return self._scan_repo.get_accessible_by_sketch_id(user_id, sketch_id)
+
+ def get_accessible_scans_by_status_and_sketch_id(
+ self, user_id: UUID, sketch_id: UUID, status: str
+ ) -> List[Scan]:
+ return self._scan_repo.get_accessible_by_status_and_sketch_id(
+ user_id, sketch_id, status
+ )
+
def get_by_id(self, scan_id: UUID, user_id: UUID) -> Scan:
scan = self._scan_repo.get_by_id(scan_id)
if not scan: