Files
leocrm/app/core/visibility.py
T
Agent Zero abbe7a18fc fix(audit): P0-P3 audit fixes — 838 ruff errors → 0, 30 F821 bugs fixed, 118 files changed
- P0: hooks.py 3-tuple fix, trigger_dispatcher Contract, contacts/plugin unregister_actions_by_owner
- P0: 5 test files — check_permission mocks removed, hardcoded DB credential → env var
- P1: attachment_service DmsFile via Contract helper, restore_registry/history_hooks dedup
- P1: mail/plugin restore unregister, mcp_client datetime.now(UTC), saved_views/filters patterns
- P1: ProtectedRoute fail-closed, 13 test assertion fixes (bcrypt, DB-URLs, SECRET_KEYs)
- P2: deprecated notifications → post_system_message (3 files), forgejo Base, report_generator lazy import
- P2: webhooks permissions, deps.py/roles.py plugin perms removed, import_export default
- P2: address/tags/entity_links patterns removed, worker.py Contract-Umgehungen fixed
- P2: 28 frontend TODOs (hardcoded constants, deprecated notification API)
- P3: dead code, duplicates, deprecated imports, private attr, __import__ inline
- P3: 8 frontend TODOs (LucideIcons, inline styles, XSS, i18n)
- ruff: 838 → 0 (612 auto-fix + 246 manual + 27 F821 regression fix)
- F821: 30 → 0 (AutomationDefinition, DmsFile, user_id, Path, Any, String)
- Contract-Umgehungen: 2 neue gefunden (worker.py:169, worker.py:280) und gefixt
2026-08-16 01:17:18 +02:00

318 lines
10 KiB
Python

"""Visibility filter helper — applies row-level security to SQLAlchemy queries.
This is the core function that ALL routes use to filter queries based on
the current user's permissions. It works alongside PostgreSQL RLS as a
Defense-in-Depth layer.
Usage:
from app.core.visibility import apply_visibility_filter
@router.get("/contacts")
async def list_contacts(db, current_user):
query = select(Contact).where(Contact.tenant_id == tenant_id)
query = await apply_visibility_filter(
db, query, "contact", Contact, user_id, tenant_id
)
result = await db.execute(query)
...
Architecture:
- System admin → no filter (sees everything)
- Non-admin → filter by: owner_id = user OR owner_id IS NULL OR shared via entity_permissions
- Uses EXISTS subquery for performance (better than IN)
- Works with any entity type that has owner_id column
"""
from __future__ import annotations
import logging
import uuid
from typing import Any
from sqlalchemy import and_, not_, or_, select, text
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.orm import DeclarativeBase
from app.models.entity_permission import EntityPermission
from app.models.group import UserGroup
from app.models.user import UserTenant
logger = logging.getLogger(__name__)
from app.core.permissions import PERM_RANK as _PERM_RANK # noqa: E402
def _rank(level: str) -> int:
return _PERM_RANK.get(level, 0)
async def _get_user_principals(
db: AsyncSession,
user_id: uuid.UUID,
tenant_id: uuid.UUID,
) -> tuple[list[uuid.UUID], uuid.UUID | None]:
"""Get user's group IDs and role ID for permission resolution.
Uses request-level ContextVar cache when available (set in deps.py).
Falls back to DB query when ContextVar is not set (e.g. worker, tests).
"""
from app.core.principals import get_principals
cached = get_principals()
if cached is not None and cached.user_id == user_id and cached.tenant_id == tenant_id:
return cached.group_ids, cached.role_id
# Fallback: load from DB (worker, tests, non-request context)
groups_q = await db.execute(
select(UserGroup.group_id)
.where(UserGroup.user_id == user_id)
.where(UserGroup.tenant_id == tenant_id)
)
group_ids = [row[0] for row in groups_q]
role_q = await db.execute(
select(UserTenant.role_id)
.where(UserTenant.user_id == user_id)
.where(UserTenant.tenant_id == tenant_id)
)
role_id = role_q.scalar_one_or_none()
return group_ids, role_id
async def apply_visibility_filter(
db: AsyncSession,
query: Any,
entity_type: str,
model: type[DeclarativeBase],
user_id: uuid.UUID,
tenant_id: uuid.UUID,
is_system_admin: bool = False,
) -> Any:
"""Apply row-level visibility filter to a SQLAlchemy query.
This function modifies the query to only return rows that the user
is allowed to see based on:
1. System admin → no filter (sees everything)
2. Owner → rows where owner_id = user_id
3. Tenant-owned → rows where owner_id IS NULL
4. Shared → rows with entity_permissions entry for this user/group/role
Args:
db: Database session
query: SQLAlchemy select() query to filter
entity_type: Entity type string (e.g. 'contact', 'address')
model: SQLAlchemy model class (must have owner_id column)
user_id: Current user's UUID
tenant_id: Current tenant's UUID
is_system_admin: Whether user is system admin
Returns:
Modified query with visibility filter applied
"""
if is_system_admin:
return query # System admin sees everything
# Defense-in-Depth: Always filter by tenant_id first (P0.4 fix)
# This ensures cross-tenant data is never returned even if RLS is bypassed
if hasattr(model, 'tenant_id'):
query = query.where(model.tenant_id == tenant_id)
# Get user's groups and role
group_ids, role_id = await _get_user_principals(db, user_id, tenant_id)
# Build principal conditions for entity_permissions EXISTS subquery
principal_conditions = [
and_(
EntityPermission.principal_type == "user",
EntityPermission.principal_id == user_id,
),
]
if group_ids:
principal_conditions.append(
and_(
EntityPermission.principal_type == "group",
EntityPermission.principal_id.in_(group_ids),
)
)
if role_id:
principal_conditions.append(
and_(
EntityPermission.principal_type == "role",
EntityPermission.principal_id == role_id,
)
)
# Build EXISTS subquery for shared entities
# Uses EXISTS instead of IN for better PostgreSQL optimization
shared_exists = (
select(EntityPermission.id)
.where(EntityPermission.entity_type == entity_type)
.where(EntityPermission.entity_id == model.id)
.where(EntityPermission.tenant_id == tenant_id)
.where(EntityPermission.permission_level != "none")
.where(
or_(
EntityPermission.expires_at.is_(None),
EntityPermission.expires_at > text("NOW()"),
)
)
.where(or_(*principal_conditions))
.exists()
)
# Apply filter: owner OR tenant-owned OR shared
visibility_condition = or_(
model.owner_id == user_id, # Own entities
model.owner_id.is_(None), # Tenant-owned entities
shared_exists, # Shared via entity_permissions
)
# ─── ABAC Policy Layer ──────────────────────────────────────────
# Load enabled entity policies for this entity_type + tenant and
# apply them as an additional visibility layer:
# (owner OR tenant-owned OR shared OR allow-matched) AND NOT (deny-matched)
from app.models.entity_policy import EntityPolicy
from app.services.policy_service import build_sql_condition
policy_stmt = (
select(EntityPolicy)
.where(EntityPolicy.tenant_id == tenant_id)
.where(EntityPolicy.entity_type == entity_type)
.where(EntityPolicy.enabled == True) # noqa: E712
.order_by(EntityPolicy.priority.desc())
)
policy_result = await db.execute(policy_stmt)
all_policies = policy_result.scalars().all()
# Filter policies applicable to this user (user / group / role principals)
applicable_policies: list[EntityPolicy] = []
for policy in all_policies:
if policy.principal_type == "user" and policy.principal_id == user_id:
applicable_policies.append(policy)
elif policy.principal_type == "group" and policy.principal_id in group_ids:
applicable_policies.append(policy)
elif (
policy.principal_type == "role"
and role_id is not None
and policy.principal_id == role_id
):
applicable_policies.append(policy)
if applicable_policies:
allow_clauses: list[Any] = []
deny_clauses: list[Any] = []
for policy in applicable_policies:
if not policy.conditions:
# Policy without conditions matches all rows
if policy.effect == "allow":
allow_clauses.append(text("1 = 1"))
else:
deny_clauses.append(text("1 = 1"))
continue
condition = build_sql_condition(
policy.conditions, model, entity_type=entity_type
)
if condition is None:
continue
if policy.effect == "allow":
allow_clauses.append(condition)
else:
deny_clauses.append(condition)
# allow: OR-join — expands visibility beyond owner/shared
if allow_clauses:
visibility_condition = or_(visibility_condition, *allow_clauses)
# deny: NOT — excludes matching rows (deny takes precedence)
if deny_clauses:
visibility_condition = and_(
visibility_condition,
not_(or_(*deny_clauses)),
)
return query.where(visibility_condition)
async def check_single_entity_access(
db: AsyncSession,
entity_type: str,
entity_id: uuid.UUID,
user_id: uuid.UUID,
tenant_id: uuid.UUID,
required_level: str = "read",
is_system_admin: bool = False,
) -> bool:
"""Check if user has at least the required access level on a single entity.
Used for GET/PUT/DELETE on individual entities.
"""
if is_system_admin:
return True
from app.services.entity_permission_service import get_effective_access
access = await get_effective_access(
db, tenant_id, user_id, entity_type, entity_id
)
return _rank(access) >= _rank(required_level)
async def filter_response_fields(
data: dict[str, Any],
field_permissions: dict[str, dict[str, str]],
module: str,
is_system_admin: bool = False,
) -> dict[str, Any]:
"""Filter response fields based on field-level permissions.
Removes fields marked as 'hidden', keeps others.
This is a convenience wrapper that can be used in any route.
"""
if is_system_admin:
return data
module_perms = field_permissions.get(module, {})
if not module_perms:
return data
return {
key: value
for key, value in data.items()
if module_perms.get(key, "read") != "hidden"
}
async def apply_visibility_filter_cached(
db: AsyncSession,
redis: Any,
query: Any,
entity_type: str,
model: type[DeclarativeBase],
user_id: uuid.UUID,
tenant_id: uuid.UUID,
is_system_admin: bool = False,
) -> Any:
"""Apply visibility filter using cached visible IDs from Redis.
This is an alternative to apply_visibility_filter() that uses
pre-computed visible IDs from Redis cache for better performance.
Use this for list queries where you need maximum performance.
"""
if is_system_admin:
return query
from app.services.entity_permission_service import get_cached_visible_ids
visible_ids, _ = await get_cached_visible_ids(
db, redis, tenant_id, user_id, entity_type
)
if not visible_ids:
# No visible entities — return empty result
return query.where(text("1 = 0"))
return query.where(model.id.in_(list(visible_ids)))