107 lines
		
	
	
		
			3.9 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			107 lines
		
	
	
		
			3.9 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
"""passbook policy engine"""
 | 
						|
from multiprocessing import Pipe
 | 
						|
from multiprocessing.connection import Connection
 | 
						|
from typing import List, Tuple
 | 
						|
 | 
						|
from django.core.cache import cache
 | 
						|
from django.http import HttpRequest
 | 
						|
from structlog import get_logger
 | 
						|
 | 
						|
from passbook.core.models import Policy, User
 | 
						|
from passbook.policies.process import PolicyProcess, cache_key
 | 
						|
from passbook.policies.struct import PolicyRequest, PolicyResult
 | 
						|
 | 
						|
LOGGER = get_logger()
 | 
						|
 | 
						|
class PolicyProcessInfo:
 | 
						|
    """Dataclass to hold all information and communication channels to a process"""
 | 
						|
 | 
						|
    process: PolicyProcess
 | 
						|
    connection: Connection
 | 
						|
    result: PolicyResult = None
 | 
						|
    policy: Policy
 | 
						|
 | 
						|
    def __init__(self, process: PolicyProcess, connection: Connection, policy: Policy):
 | 
						|
        self.process = process
 | 
						|
        self.connection = connection
 | 
						|
        self.policy = policy
 | 
						|
 | 
						|
class PolicyEngine:
 | 
						|
    """Orchestrate policy checking, launch tasks and return result"""
 | 
						|
 | 
						|
    policies: List[Policy] = []
 | 
						|
    __request: HttpRequest
 | 
						|
    __user: User
 | 
						|
 | 
						|
    __processes: List[PolicyProcessInfo] = []
 | 
						|
 | 
						|
    def __init__(self, policies, user: User = None, request: HttpRequest = None):
 | 
						|
        self.policies = policies
 | 
						|
        self.__request = request
 | 
						|
        self.__user = user
 | 
						|
        self.__processes = []
 | 
						|
 | 
						|
    def for_user(self, user: User) -> 'PolicyEngine':
 | 
						|
        """Check policies for user"""
 | 
						|
        self.__user = user
 | 
						|
        return self
 | 
						|
 | 
						|
    def with_request(self, request: HttpRequest) -> 'PolicyEngine':
 | 
						|
        """Set request"""
 | 
						|
        self.__request = request
 | 
						|
        return self
 | 
						|
 | 
						|
    def _select_subclasses(self) -> List[Policy]:
 | 
						|
        """Make sure all Policies are their respective classes"""
 | 
						|
        return Policy.objects \
 | 
						|
            .filter(pk__in=[x.pk for x in self.policies]) \
 | 
						|
            .select_subclasses() \
 | 
						|
            .order_by('order')
 | 
						|
 | 
						|
    def build(self) -> 'PolicyEngine':
 | 
						|
        """Build task group"""
 | 
						|
        if not self.__user:
 | 
						|
            raise ValueError("User not set.")
 | 
						|
        cached_policies = []
 | 
						|
        request = PolicyRequest(self.__user)
 | 
						|
        request.http_request = self.__request
 | 
						|
        for policy in self._select_subclasses():
 | 
						|
            cached_policy = cache.get(cache_key(policy, self.__user), None)
 | 
						|
            if cached_policy:
 | 
						|
                LOGGER.debug("Taking result from cache", policy=policy)
 | 
						|
                cached_policies.append(cached_policy)
 | 
						|
            else:
 | 
						|
                LOGGER.debug("Evaluating policy", policy=policy)
 | 
						|
                our_end, task_end = Pipe(False)
 | 
						|
                task = PolicyProcess(policy, request, task_end)
 | 
						|
                LOGGER.debug("Starting Process", for_policy=policy)
 | 
						|
                task.start()
 | 
						|
                self.__processes.append(PolicyProcessInfo(process=task,
 | 
						|
                                                          connection=our_end, policy=policy))
 | 
						|
        # If all policies are cached, we have an empty list here.
 | 
						|
        for proc_info in self.__processes:
 | 
						|
            proc_info.process.join(proc_info.policy.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) -> Tuple[bool, List[str]]:
 | 
						|
        """Get policy-checking result"""
 | 
						|
        messages: List[str] = []
 | 
						|
        for proc_info in self.__processes:
 | 
						|
            # passing = (policy_action == Policy.ACTION_ALLOW and policy_result) or \
 | 
						|
            #           (policy_action == Policy.ACTION_DENY and not policy_result)
 | 
						|
            LOGGER.debug("Result", passing=proc_info.result.passing)
 | 
						|
            if proc_info.result.messages:
 | 
						|
                messages += proc_info.result.messages
 | 
						|
            if not proc_info.result.passing:
 | 
						|
                return False, messages
 | 
						|
        return True, messages
 | 
						|
 | 
						|
    @property
 | 
						|
    def passing(self) -> bool:
 | 
						|
        """Only get true/false if user passes"""
 | 
						|
        return self.result[0]
 |