|
| 1 | +"""RAC Provider API Views""" |
| 2 | +from typing import Optional |
| 3 | + |
| 4 | +from django.core.cache import cache |
| 5 | +from django.db.models import QuerySet |
| 6 | +from django.urls import reverse |
| 7 | +from drf_spectacular.types import OpenApiTypes |
| 8 | +from drf_spectacular.utils import OpenApiParameter, OpenApiResponse, extend_schema |
| 9 | +from rest_framework.fields import SerializerMethodField |
| 10 | +from rest_framework.request import Request |
| 11 | +from rest_framework.response import Response |
| 12 | +from rest_framework.serializers import ModelSerializer |
| 13 | +from rest_framework.viewsets import ModelViewSet |
| 14 | +from structlog.stdlib import get_logger |
| 15 | + |
| 16 | +from authentik.core.api.used_by import UsedByMixin |
| 17 | +from authentik.core.models import Provider |
| 18 | +from authentik.enterprise.providers.rac.api.providers import RACProviderSerializer |
| 19 | +from authentik.enterprise.providers.rac.models import Endpoint |
| 20 | +from authentik.policies.engine import PolicyEngine |
| 21 | +from authentik.rbac.filters import ObjectFilter |
| 22 | + |
| 23 | +LOGGER = get_logger() |
| 24 | + |
| 25 | + |
| 26 | +def user_endpoint_cache_key(user_pk: str) -> str: |
| 27 | + """Cache key where endpoint list for user is saved""" |
| 28 | + return f"goauthentik.io/providers/rac/endpoint_access/{user_pk}" |
| 29 | + |
| 30 | + |
| 31 | +class EndpointSerializer(ModelSerializer): |
| 32 | + """Endpoint Serializer""" |
| 33 | + |
| 34 | + provider_obj = RACProviderSerializer(source="provider", read_only=True) |
| 35 | + launch_url = SerializerMethodField() |
| 36 | + |
| 37 | + def get_launch_url(self, endpoint: Endpoint) -> Optional[str]: |
| 38 | + """Build actual launch URL (the provider itself does not have one, just |
| 39 | + individual endpoints)""" |
| 40 | + try: |
| 41 | + # pylint: disable=no-member |
| 42 | + return reverse( |
| 43 | + "authentik_providers_rac:start", |
| 44 | + kwargs={"app": endpoint.provider.application.slug, "endpoint": endpoint.pk}, |
| 45 | + ) |
| 46 | + except Provider.application.RelatedObjectDoesNotExist: |
| 47 | + return None |
| 48 | + |
| 49 | + class Meta: |
| 50 | + model = Endpoint |
| 51 | + fields = [ |
| 52 | + "pk", |
| 53 | + "name", |
| 54 | + "provider", |
| 55 | + "provider_obj", |
| 56 | + "protocol", |
| 57 | + "host", |
| 58 | + "settings", |
| 59 | + "property_mappings", |
| 60 | + "auth_mode", |
| 61 | + "launch_url", |
| 62 | + ] |
| 63 | + |
| 64 | + |
| 65 | +class EndpointViewSet(UsedByMixin, ModelViewSet): |
| 66 | + """Endpoint Viewset""" |
| 67 | + |
| 68 | + queryset = Endpoint.objects.all() |
| 69 | + serializer_class = EndpointSerializer |
| 70 | + filterset_fields = ["name", "provider"] |
| 71 | + search_fields = ["name", "protocol"] |
| 72 | + ordering = ["name", "protocol"] |
| 73 | + |
| 74 | + def _filter_queryset_for_list(self, queryset: QuerySet) -> QuerySet: |
| 75 | + """Custom filter_queryset method which ignores guardian, but still supports sorting""" |
| 76 | + for backend in list(self.filter_backends): |
| 77 | + if backend == ObjectFilter: |
| 78 | + continue |
| 79 | + queryset = backend().filter_queryset(self.request, queryset, self) |
| 80 | + return queryset |
| 81 | + |
| 82 | + def _get_allowed_endpoints(self, queryset: QuerySet) -> list[Endpoint]: |
| 83 | + endpoints = [] |
| 84 | + for endpoint in queryset: |
| 85 | + engine = PolicyEngine(endpoint, self.request.user, self.request) |
| 86 | + engine.build() |
| 87 | + if engine.passing: |
| 88 | + endpoints.append(endpoint) |
| 89 | + return endpoints |
| 90 | + |
| 91 | + @extend_schema( |
| 92 | + parameters=[ |
| 93 | + OpenApiParameter( |
| 94 | + "search", |
| 95 | + OpenApiTypes.STR, |
| 96 | + ), |
| 97 | + OpenApiParameter( |
| 98 | + name="superuser_full_list", |
| 99 | + location=OpenApiParameter.QUERY, |
| 100 | + type=OpenApiTypes.BOOL, |
| 101 | + ), |
| 102 | + ], |
| 103 | + responses={ |
| 104 | + 200: EndpointSerializer(many=True), |
| 105 | + 400: OpenApiResponse(description="Bad request"), |
| 106 | + }, |
| 107 | + ) |
| 108 | + def list(self, request: Request, *args, **kwargs) -> Response: |
| 109 | + """List accessible endpoints""" |
| 110 | + should_cache = request.GET.get("search", "") == "" |
| 111 | + |
| 112 | + superuser_full_list = str(request.GET.get("superuser_full_list", "false")).lower() == "true" |
| 113 | + if superuser_full_list and request.user.is_superuser: |
| 114 | + return super().list(request) |
| 115 | + |
| 116 | + queryset = self._filter_queryset_for_list(self.get_queryset()) |
| 117 | + self.paginate_queryset(queryset) |
| 118 | + |
| 119 | + allowed_endpoints = [] |
| 120 | + if not should_cache: |
| 121 | + allowed_endpoints = self._get_allowed_endpoints(queryset) |
| 122 | + if should_cache: |
| 123 | + allowed_endpoints = cache.get(user_endpoint_cache_key(self.request.user.pk)) |
| 124 | + if not allowed_endpoints: |
| 125 | + LOGGER.debug("Caching allowed endpoint list") |
| 126 | + allowed_endpoints = self._get_allowed_endpoints(queryset) |
| 127 | + cache.set( |
| 128 | + user_endpoint_cache_key(self.request.user.pk), |
| 129 | + allowed_endpoints, |
| 130 | + timeout=86400, |
| 131 | + ) |
| 132 | + serializer = self.get_serializer(allowed_endpoints, many=True) |
| 133 | + return self.get_paginated_response(serializer.data) |
0 commit comments