179 lines
7.1 KiB
Python
179 lines
7.1 KiB
Python
"""authentik expression policy evaluator"""
|
|
import re
|
|
from ipaddress import ip_address, ip_network
|
|
from textwrap import indent
|
|
from typing import Any, Iterable, Optional
|
|
|
|
from django.core.exceptions import FieldError
|
|
from django_otp import devices_for_user
|
|
from rest_framework.serializers import ValidationError
|
|
from sentry_sdk.hub import Hub
|
|
from sentry_sdk.tracing import Span
|
|
from structlog.stdlib import get_logger
|
|
|
|
from authentik.core.models import User
|
|
from authentik.events.models import Event
|
|
from authentik.lib.utils.http import get_http_session
|
|
from authentik.policies.types import PolicyRequest
|
|
|
|
LOGGER = get_logger()
|
|
|
|
|
|
class BaseEvaluator:
|
|
"""Validate and evaluate python-based expressions"""
|
|
|
|
# Globals that can be used by function
|
|
_globals: dict[str, Any]
|
|
# Context passed as locals to exec()
|
|
_context: dict[str, Any]
|
|
|
|
# Filename used for exec
|
|
_filename: str
|
|
|
|
def __init__(self, filename: Optional[str] = None):
|
|
self._filename = filename if filename else "BaseEvaluator"
|
|
# update website/docs/expressions/_objects.md
|
|
# update website/docs/expressions/_functions.md
|
|
self._globals = {
|
|
"regex_match": BaseEvaluator.expr_regex_match,
|
|
"regex_replace": BaseEvaluator.expr_regex_replace,
|
|
"list_flatten": BaseEvaluator.expr_flatten,
|
|
"ak_is_group_member": BaseEvaluator.expr_is_group_member,
|
|
"ak_user_by": BaseEvaluator.expr_user_by,
|
|
"ak_user_has_authenticator": BaseEvaluator.expr_func_user_has_authenticator,
|
|
"ak_create_event": self.expr_event_create,
|
|
"ak_logger": get_logger(self._filename),
|
|
"requests": get_http_session(),
|
|
"ip_address": ip_address,
|
|
"ip_network": ip_network,
|
|
}
|
|
self._context = {}
|
|
|
|
@staticmethod
|
|
def expr_flatten(value: list[Any] | Any) -> Optional[Any]:
|
|
"""Flatten `value` if its a list"""
|
|
if isinstance(value, list):
|
|
if len(value) < 1:
|
|
return None
|
|
return value[0]
|
|
return value
|
|
|
|
@staticmethod
|
|
def expr_regex_match(value: Any, regex: str) -> bool:
|
|
"""Expression Filter to run re.search"""
|
|
return re.search(regex, value) is not None
|
|
|
|
@staticmethod
|
|
def expr_regex_replace(value: Any, regex: str, repl: str) -> str:
|
|
"""Expression Filter to run re.sub"""
|
|
return re.sub(regex, repl, value)
|
|
|
|
@staticmethod
|
|
def expr_is_group_member(user: User, **group_filters) -> bool:
|
|
"""Check if `user` is member of group with name `group_name`"""
|
|
return user.ak_groups.filter(**group_filters).exists()
|
|
|
|
@staticmethod
|
|
def expr_user_by(**filters) -> Optional[User]:
|
|
"""Get user by filters"""
|
|
try:
|
|
users = User.objects.filter(**filters)
|
|
if users:
|
|
return users.first()
|
|
return None
|
|
except FieldError:
|
|
return None
|
|
|
|
@staticmethod
|
|
def expr_func_user_has_authenticator(user: User, device_type: Optional[str] = None) -> bool:
|
|
"""Check if a user has any authenticator devices, optionally matching *device_type*"""
|
|
user_devices = devices_for_user(user)
|
|
if device_type:
|
|
for device in user_devices:
|
|
device_class = device.__class__.__name__.lower().replace("device", "")
|
|
if device_class == device_type:
|
|
return True
|
|
return False
|
|
return len(list(user_devices)) > 0
|
|
|
|
def expr_event_create(self, action: str, **kwargs):
|
|
"""Create event with supplied data and try to extract as much relevant data
|
|
from the context"""
|
|
# If the result was a complex variable, we don't want to re-use it
|
|
self._context.pop("result", None)
|
|
self._context.pop("handler", None)
|
|
kwargs["context"] = self._context
|
|
event = Event.new(
|
|
action,
|
|
app=self._filename,
|
|
**kwargs,
|
|
)
|
|
if "request" in self._context and isinstance(self._context["request"], PolicyRequest):
|
|
policy_request: PolicyRequest = self._context["request"]
|
|
if policy_request.http_request:
|
|
event.from_http(policy_request)
|
|
return
|
|
event.save()
|
|
|
|
def wrap_expression(self, expression: str, params: Iterable[str]) -> str:
|
|
"""Wrap expression in a function, call it, and save the result as `result`"""
|
|
handler_signature = ",".join(params)
|
|
full_expression = ""
|
|
full_expression += f"def handler({handler_signature}):\n"
|
|
full_expression += indent(expression, " ")
|
|
full_expression += f"\nresult = handler({handler_signature})"
|
|
return full_expression
|
|
|
|
def evaluate(self, expression_source: str) -> Any:
|
|
"""Parse and evaluate expression. If the syntax is incorrect, a SyntaxError is raised.
|
|
If any exception is raised during execution, it is raised.
|
|
The result is returned without any type-checking."""
|
|
with Hub.current.start_span(op="authentik.lib.evaluator.evaluate") as span:
|
|
span: Span
|
|
span.description = self._filename
|
|
span.set_data("expression", expression_source)
|
|
param_keys = self._context.keys()
|
|
try:
|
|
ast_obj = compile(
|
|
self.wrap_expression(expression_source, param_keys),
|
|
self._filename,
|
|
"exec",
|
|
)
|
|
except (SyntaxError, ValueError) as exc:
|
|
self.handle_error(exc, expression_source)
|
|
raise exc
|
|
try:
|
|
_locals = self._context
|
|
# Yes this is an exec, yes it is potentially bad. Since we limit what variables are
|
|
# available here, and these policies can only be edited by admins, this is a risk
|
|
# we're willing to take.
|
|
# pylint: disable=exec-used
|
|
exec(ast_obj, self._globals, _locals) # nosec # noqa
|
|
result = _locals["result"]
|
|
except Exception as exc:
|
|
# So, this is a bit questionable. Essentially, we are edit the stacktrace
|
|
# so the user only sees information relevant to them
|
|
# and none of our surrounding error handling
|
|
exc.__traceback__ = exc.__traceback__.tb_next
|
|
self.handle_error(exc, expression_source)
|
|
raise exc
|
|
return result
|
|
|
|
# pylint: disable=unused-argument
|
|
def handle_error(self, exc: Exception, expression_source: str): # pragma: no cover
|
|
"""Exception Handler"""
|
|
LOGGER.warning("Expression error", exc=exc)
|
|
|
|
def validate(self, expression: str) -> bool:
|
|
"""Validate expression's syntax, raise ValidationError if Syntax is invalid"""
|
|
param_keys = self._context.keys()
|
|
try:
|
|
compile(
|
|
self.wrap_expression(expression, param_keys),
|
|
self._filename,
|
|
"exec",
|
|
)
|
|
return True
|
|
except (ValueError, SyntaxError) as exc:
|
|
raise ValidationError(f"Expression Syntax Error: {str(exc)}") from exc
|