160 lines
5.9 KiB
Python
160 lines
5.9 KiB
Python
"""authentik policy engine"""
|
|
from multiprocessing import Pipe, current_process
|
|
from multiprocessing.connection import Connection
|
|
from typing import Iterator, Optional
|
|
|
|
from django.core.cache import cache
|
|
from django.http import HttpRequest
|
|
from sentry_sdk.hub import Hub
|
|
from sentry_sdk.tracing import Span
|
|
from structlog.stdlib import BoundLogger, get_logger
|
|
|
|
from authentik.core.models import User
|
|
from authentik.policies.models import (
|
|
Policy,
|
|
PolicyBinding,
|
|
PolicyBindingModel,
|
|
PolicyEngineMode,
|
|
)
|
|
from authentik.policies.process import PolicyProcess, cache_key
|
|
from authentik.policies.types import PolicyRequest, PolicyResult
|
|
|
|
CURRENT_PROCESS = current_process()
|
|
|
|
|
|
class PolicyProcessInfo:
|
|
"""Dataclass to hold all information and communication channels to a process"""
|
|
|
|
process: PolicyProcess
|
|
connection: Connection
|
|
result: Optional[PolicyResult]
|
|
binding: PolicyBinding
|
|
|
|
def __init__(
|
|
self, process: PolicyProcess, connection: Connection, binding: PolicyBinding
|
|
):
|
|
self.process = process
|
|
self.connection = connection
|
|
self.binding = binding
|
|
self.result = None
|
|
|
|
|
|
class PolicyEngine:
|
|
"""Orchestrate policy checking, launch tasks and return result"""
|
|
|
|
use_cache: bool
|
|
request: PolicyRequest
|
|
|
|
logger: BoundLogger
|
|
mode: PolicyEngineMode
|
|
# Allow objects with no policies attached to pass
|
|
empty_result: bool
|
|
|
|
__pbm: PolicyBindingModel
|
|
__cached_policies: list[PolicyResult]
|
|
__processes: list[PolicyProcessInfo]
|
|
|
|
__expected_result_count: int
|
|
|
|
def __init__(
|
|
self, pbm: PolicyBindingModel, user: User, request: HttpRequest = None
|
|
):
|
|
self.logger = get_logger().bind()
|
|
self.mode = pbm.policy_engine_mode
|
|
# For backwards compatibility, set empty_result to true
|
|
# objects with no policies attached will pass.
|
|
self.empty_result = True
|
|
if not isinstance(pbm, PolicyBindingModel): # pragma: no cover
|
|
raise ValueError(f"{pbm} is not instance of PolicyBindingModel")
|
|
self.__pbm = pbm
|
|
self.request = PolicyRequest(user)
|
|
self.request.obj = pbm
|
|
if request:
|
|
self.request.set_http_request(request)
|
|
self.__cached_policies = []
|
|
self.__processes = []
|
|
self.use_cache = True
|
|
self.__expected_result_count = 0
|
|
|
|
def _iter_bindings(self) -> Iterator[PolicyBinding]:
|
|
"""Make sure all Policies are their respective classes"""
|
|
return (
|
|
PolicyBinding.objects.filter(target=self.__pbm, enabled=True)
|
|
.order_by("order")
|
|
.iterator()
|
|
)
|
|
|
|
def _check_policy_type(self, policy: Policy):
|
|
"""Check policy type, make sure it's not the root class as that has no logic implemented"""
|
|
# pyright: reportGeneralTypeIssues=false
|
|
if policy.__class__ == Policy:
|
|
raise TypeError(f"Policy '{policy}' is root type")
|
|
|
|
def build(self) -> "PolicyEngine":
|
|
"""Build wrapper which monitors performance"""
|
|
with Hub.current.start_span(op="policy.engine.build") as span:
|
|
span: Span
|
|
span.set_data("pbm", self.__pbm)
|
|
span.set_data("request", self.request)
|
|
for binding in self._iter_bindings():
|
|
self.__expected_result_count += 1
|
|
|
|
self._check_policy_type(binding.policy)
|
|
key = cache_key(binding, self.request)
|
|
cached_policy = cache.get(key, None)
|
|
if cached_policy and self.use_cache:
|
|
self.logger.debug(
|
|
"P_ENG: Taking result from cache",
|
|
policy=binding.policy,
|
|
cache_key=key,
|
|
)
|
|
self.__cached_policies.append(cached_policy)
|
|
continue
|
|
self.logger.debug("P_ENG: Evaluating policy", policy=binding.policy)
|
|
our_end, task_end = Pipe(False)
|
|
task = PolicyProcess(binding, self.request, task_end)
|
|
task.daemon = False
|
|
self.logger.debug("P_ENG: Starting Process", policy=binding.policy)
|
|
if not CURRENT_PROCESS._config.get("daemon"):
|
|
task.run()
|
|
else:
|
|
task.start()
|
|
self.__processes.append(
|
|
PolicyProcessInfo(process=task, connection=our_end, binding=binding)
|
|
)
|
|
# If all policies are cached, we have an empty list here.
|
|
for proc_info in self.__processes:
|
|
if proc_info.process.is_alive():
|
|
proc_info.process.join(proc_info.binding.timeout)
|
|
# Only call .recv() if no result is saved, otherwise we just deadlock here
|
|
if not proc_info.result:
|
|
proc_info.result = proc_info.connection.recv()
|
|
return self
|
|
|
|
@property
|
|
def result(self) -> PolicyResult:
|
|
"""Get policy-checking result"""
|
|
process_results: list[PolicyResult] = [
|
|
x.result for x in self.__processes if x.result
|
|
]
|
|
all_results = list(process_results + self.__cached_policies)
|
|
if len(all_results) < self.__expected_result_count: # pragma: no cover
|
|
raise AssertionError("Got less results than polices")
|
|
# No results, no policies attached -> passing
|
|
if len(all_results) == 0:
|
|
return PolicyResult(self.empty_result)
|
|
passing = False
|
|
if self.mode == PolicyEngineMode.MODE_ALL:
|
|
passing = all(x.passing for x in all_results)
|
|
if self.mode == PolicyEngineMode.MODE_ANY:
|
|
passing = any(x.passing for x in all_results)
|
|
result = PolicyResult(passing)
|
|
result.source_results = all_results
|
|
result.messages = tuple(y for x in all_results for y in x.messages)
|
|
return result
|
|
|
|
@property
|
|
def passing(self) -> bool:
|
|
"""Only get true/false if user passes"""
|
|
return self.result.passing
|