core: Initial RBAC (#6806)
* rename consent permission Signed-off-by: Jens Langhammer <jens@goauthentik.io> * the user version Signed-off-by: Jens Langhammer <jens@goauthentik.io> t Signed-off-by: Jens Langhammer <jens@goauthentik.io> * initial role Signed-off-by: Jens Langhammer <jens@goauthentik.io> * start form Signed-off-by: Jens Langhammer <jens@goauthentik.io> * some minor table refactoring Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix user, add assign Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add roles ui Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix backend Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add assign API for roles Signed-off-by: Jens Langhammer <jens@goauthentik.io> * start adding toggle buttons Signed-off-by: Jens Langhammer <jens@goauthentik.io> * start view page Signed-off-by: Jens Langhammer <jens@goauthentik.io> * exclude add_ permission for per-object perms Signed-off-by: Jens Langhammer <jens@goauthentik.io> * small cleanup Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add permission list for roles Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make sidebar update Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix page header not re-rendering? Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fixup Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add search Signed-off-by: Jens Langhammer <jens@goauthentik.io> * show first category in table groupBy except when its empty Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make model and object PK optional but required together Signed-off-by: Jens Langhammer <jens@goauthentik.io> * allow for setting global perms Signed-off-by: Jens Langhammer <jens@goauthentik.io> * exclude non-authentik permissions Signed-off-by: Jens Langhammer <jens@goauthentik.io> * exclude models which aren't allowed (base models etc) Signed-off-by: Jens Langhammer <jens@goauthentik.io> * ensure all models have verbose_name set, exclude some more internal objects Signed-off-by: Jens Langhammer <jens@goauthentik.io> * lint fix Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix role perm assign Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add unasign for global perms Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add meta changes Signed-off-by: Jens Langhammer <jens@goauthentik.io> * clear modal state after submit Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add roles to our group Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix duplicate url names Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make recursive group query more usable Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add name field to role itself and move group creation to signal Signed-off-by: Jens Langhammer <jens@goauthentik.io> * start sync Signed-off-by: Jens Langhammer <jens@goauthentik.io> * move rbac stuff to separate django app Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix lint and such Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix go Signed-off-by: Jens Langhammer <jens@goauthentik.io> * update Signed-off-by: Jens Langhammer <jens@goauthentik.io> * start API changes Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add more API tests Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make admin interface not require superuser for now, improve error handling Signed-off-by: Jens Langhammer <jens@goauthentik.io> * replace some IsAdminUser where applicable Signed-off-by: Jens Langhammer <jens@goauthentik.io> * migrate flow inspector perms to actual permission Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix license not being a serializermodel Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add permission modal to models without view page Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add additional permissions to assign/unassign permissions Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add action to unassign user permissions Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add permissions tab to remaining view pages Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix flow inspector permission check Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix codecov config? Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add more API tests Signed-off-by: Jens Langhammer <jens@goauthentik.io> * ensure viewsets have an order set Signed-off-by: Jens Langhammer <jens@goauthentik.io> * hopefully the last api name change Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make perm modal less confusing Signed-off-by: Jens Langhammer <jens@goauthentik.io> * start user view permission page Signed-off-by: Jens Langhammer <jens@goauthentik.io> * only make delete bulk form expandable if usedBy is set Signed-off-by: Jens Langhammer <jens@goauthentik.io> * expand permission tables Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add more things Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add user global permission table Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix lint Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix tests' url names Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add tests for assign perms Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add unassign tests Signed-off-by: Jens Langhammer <jens@goauthentik.io> * rebuild permissions Signed-off-by: Jens Langhammer <jens@goauthentik.io> * prevent assigning/unassigning permissions to internal service accounts Signed-off-by: Jens Langhammer <jens@goauthentik.io> * only enable default api browser in debug Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix role object permissions showing duplicate Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix role link on role object permissions table Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix object permission modal having duplicate close buttons Signed-off-by: Jens Langhammer <jens@goauthentik.io> * return error if user has no global perm and no object perms also improve error display on table Signed-off-by: Jens Langhammer <jens@goauthentik.io> * small optimisation Signed-off-by: Jens Langhammer <jens@goauthentik.io> * optimise even more Signed-off-by: Jens Langhammer <jens@goauthentik.io> * update locale Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add system permission for non-object permissions Signed-off-by: Jens Langhammer <jens@goauthentik.io> * allow access to admin interface based on perm Signed-off-by: Jens Langhammer <jens@goauthentik.io> * clean Signed-off-by: Jens Langhammer <jens@goauthentik.io> * don't exclude base models Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
0
authentik/rbac/__init__.py
Normal file
0
authentik/rbac/__init__.py
Normal file
0
authentik/rbac/api/__init__.py
Normal file
0
authentik/rbac/api/__init__.py
Normal file
130
authentik/rbac/api/rbac.py
Normal file
130
authentik/rbac/api/rbac.py
Normal file
@ -0,0 +1,130 @@
|
||||
"""common RBAC serializers"""
|
||||
from django.apps import apps
|
||||
from django.contrib.auth.models import Permission
|
||||
from django.db.models import QuerySet
|
||||
from django_filters.filters import ModelChoiceFilter
|
||||
from django_filters.filterset import FilterSet
|
||||
from rest_framework.exceptions import ValidationError
|
||||
from rest_framework.fields import (
|
||||
CharField,
|
||||
ChoiceField,
|
||||
ListField,
|
||||
ReadOnlyField,
|
||||
SerializerMethodField,
|
||||
)
|
||||
from rest_framework.serializers import ModelSerializer
|
||||
from rest_framework.viewsets import ReadOnlyModelViewSet
|
||||
|
||||
from authentik.core.api.utils import PassiveSerializer
|
||||
from authentik.core.models import User
|
||||
from authentik.lib.validators import RequiredTogetherValidator
|
||||
from authentik.policies.event_matcher.models import model_choices
|
||||
from authentik.rbac.models import Role
|
||||
|
||||
|
||||
class PermissionSerializer(ModelSerializer):
|
||||
"""Global permission"""
|
||||
|
||||
app_label = ReadOnlyField(source="content_type.app_label")
|
||||
app_label_verbose = SerializerMethodField()
|
||||
model = ReadOnlyField(source="content_type.model")
|
||||
model_verbose = SerializerMethodField()
|
||||
|
||||
def get_app_label_verbose(self, instance: Permission) -> str:
|
||||
"""Human-readable app label"""
|
||||
return apps.get_app_config(instance.content_type.app_label).verbose_name
|
||||
|
||||
def get_model_verbose(self, instance: Permission) -> str:
|
||||
"""Human-readable model name"""
|
||||
return apps.get_model(
|
||||
instance.content_type.app_label, instance.content_type.model
|
||||
)._meta.verbose_name
|
||||
|
||||
class Meta:
|
||||
model = Permission
|
||||
fields = [
|
||||
"id",
|
||||
"name",
|
||||
"codename",
|
||||
"model",
|
||||
"app_label",
|
||||
"app_label_verbose",
|
||||
"model_verbose",
|
||||
]
|
||||
|
||||
|
||||
class PermissionFilter(FilterSet):
|
||||
"""Filter permissions"""
|
||||
|
||||
role = ModelChoiceFilter(queryset=Role.objects.all(), method="filter_role")
|
||||
user = ModelChoiceFilter(queryset=User.objects.all())
|
||||
|
||||
def filter_role(self, queryset: QuerySet, name, value: Role) -> QuerySet:
|
||||
"""Filter permissions based on role"""
|
||||
return queryset.filter(group__role=value)
|
||||
|
||||
class Meta:
|
||||
model = Permission
|
||||
fields = [
|
||||
"codename",
|
||||
"content_type__model",
|
||||
"content_type__app_label",
|
||||
"role",
|
||||
"user",
|
||||
]
|
||||
|
||||
|
||||
class RBACPermissionViewSet(ReadOnlyModelViewSet):
|
||||
"""Read-only list of all permissions, filterable by model and app"""
|
||||
|
||||
queryset = Permission.objects.none()
|
||||
serializer_class = PermissionSerializer
|
||||
ordering = ["name"]
|
||||
filterset_class = PermissionFilter
|
||||
search_fields = [
|
||||
"codename",
|
||||
"content_type__model",
|
||||
"content_type__app_label",
|
||||
]
|
||||
|
||||
def get_queryset(self) -> QuerySet:
|
||||
return (
|
||||
Permission.objects.all()
|
||||
.select_related("content_type")
|
||||
.filter(
|
||||
content_type__app_label__startswith="authentik",
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
class PermissionAssignSerializer(PassiveSerializer):
|
||||
"""Request to assign a new permission"""
|
||||
|
||||
permissions = ListField(child=CharField())
|
||||
model = ChoiceField(choices=model_choices(), required=False)
|
||||
object_pk = CharField(required=False)
|
||||
|
||||
validators = [RequiredTogetherValidator(fields=["model", "object_pk"])]
|
||||
|
||||
def validate(self, attrs: dict) -> dict:
|
||||
model_instance = None
|
||||
# Check if we're setting an object-level perm or global
|
||||
model = attrs.get("model")
|
||||
object_pk = attrs.get("object_pk")
|
||||
if model and object_pk:
|
||||
model = apps.get_model(attrs["model"])
|
||||
model_instance = model.objects.filter(pk=attrs["object_pk"]).first()
|
||||
attrs["model_instance"] = model_instance
|
||||
if attrs.get("model"):
|
||||
return attrs
|
||||
permissions = attrs.get("permissions", [])
|
||||
if not all("." in perm for perm in permissions):
|
||||
raise ValidationError(
|
||||
{
|
||||
"permissions": (
|
||||
"When assigning global permissions, codename must be given as "
|
||||
"app_label.codename"
|
||||
)
|
||||
}
|
||||
)
|
||||
return attrs
|
||||
123
authentik/rbac/api/rbac_assigned_by_roles.py
Normal file
123
authentik/rbac/api/rbac_assigned_by_roles.py
Normal file
@ -0,0 +1,123 @@
|
||||
"""common RBAC serializers"""
|
||||
from django.db.models import Q, QuerySet
|
||||
from django.db.transaction import atomic
|
||||
from django_filters.filters import CharFilter, ChoiceFilter
|
||||
from django_filters.filterset import FilterSet
|
||||
from drf_spectacular.utils import OpenApiResponse, extend_schema
|
||||
from guardian.models import GroupObjectPermission
|
||||
from guardian.shortcuts import assign_perm, remove_perm
|
||||
from rest_framework.decorators import action
|
||||
from rest_framework.fields import CharField, ReadOnlyField
|
||||
from rest_framework.mixins import ListModelMixin
|
||||
from rest_framework.request import Request
|
||||
from rest_framework.response import Response
|
||||
from rest_framework.serializers import ModelSerializer
|
||||
from rest_framework.viewsets import GenericViewSet
|
||||
|
||||
from authentik.api.decorators import permission_required
|
||||
from authentik.core.api.utils import PassiveSerializer
|
||||
from authentik.policies.event_matcher.models import model_choices
|
||||
from authentik.rbac.api.rbac import PermissionAssignSerializer
|
||||
from authentik.rbac.models import Role
|
||||
|
||||
|
||||
class RoleObjectPermissionSerializer(ModelSerializer):
|
||||
"""Role-bound object level permission"""
|
||||
|
||||
app_label = ReadOnlyField(source="content_type.app_label")
|
||||
model = ReadOnlyField(source="content_type.model")
|
||||
codename = ReadOnlyField(source="permission.codename")
|
||||
name = ReadOnlyField(source="permission.name")
|
||||
object_pk = ReadOnlyField()
|
||||
|
||||
class Meta:
|
||||
model = GroupObjectPermission
|
||||
fields = ["id", "codename", "model", "app_label", "object_pk", "name"]
|
||||
|
||||
|
||||
class RoleAssignedObjectPermissionSerializer(PassiveSerializer):
|
||||
"""Roles assigned object permission serializer"""
|
||||
|
||||
role_pk = CharField(source="group.role.pk", read_only=True)
|
||||
name = CharField(source="group.name", read_only=True)
|
||||
permissions = RoleObjectPermissionSerializer(
|
||||
many=True, source="group.groupobjectpermission_set"
|
||||
)
|
||||
|
||||
class Meta:
|
||||
model = Role
|
||||
fields = ["role_pk", "name", "permissions"]
|
||||
|
||||
|
||||
class RoleAssignedPermissionFilter(FilterSet):
|
||||
"""Role Assigned permission filter"""
|
||||
|
||||
model = ChoiceFilter(choices=model_choices(), method="filter_model", required=True)
|
||||
object_pk = CharFilter(method="filter_object_pk")
|
||||
|
||||
def filter_model(self, queryset: QuerySet, name, value: str) -> QuerySet:
|
||||
"""Filter by object type"""
|
||||
app, _, model = value.partition(".")
|
||||
return queryset.filter(
|
||||
Q(
|
||||
group__permissions__content_type__app_label=app,
|
||||
group__permissions__content_type__model=model,
|
||||
)
|
||||
| Q(
|
||||
group__groupobjectpermission__permission__content_type__app_label=app,
|
||||
group__groupobjectpermission__permission__content_type__model=model,
|
||||
)
|
||||
).distinct()
|
||||
|
||||
def filter_object_pk(self, queryset: QuerySet, name, value: str) -> QuerySet:
|
||||
"""Filter by object primary key"""
|
||||
return queryset.filter(Q(group__groupobjectpermission__object_pk=value)).distinct()
|
||||
|
||||
|
||||
class RoleAssignedPermissionViewSet(ListModelMixin, GenericViewSet):
|
||||
"""Get assigned object permissions for a single object"""
|
||||
|
||||
serializer_class = RoleAssignedObjectPermissionSerializer
|
||||
ordering = ["name"]
|
||||
# The filtering is done in the filterset,
|
||||
# which has a required filter that does the heavy lifting
|
||||
queryset = Role.objects.all()
|
||||
filterset_class = RoleAssignedPermissionFilter
|
||||
|
||||
@permission_required("authentik_rbac.assign_role_permissions")
|
||||
@extend_schema(
|
||||
request=PermissionAssignSerializer(),
|
||||
responses={
|
||||
204: OpenApiResponse(description="Successfully assigned"),
|
||||
},
|
||||
)
|
||||
@action(methods=["POST"], detail=True, pagination_class=None, filter_backends=[])
|
||||
def assign(self, request: Request, *args, **kwargs) -> Response:
|
||||
"""Assign permission(s) to role. When `object_pk` is set, the permissions
|
||||
are only assigned to the specific object, otherwise they are assigned globally."""
|
||||
role: Role = self.get_object()
|
||||
data = PermissionAssignSerializer(data=request.data)
|
||||
data.is_valid(raise_exception=True)
|
||||
with atomic():
|
||||
for perm in data.validated_data["permissions"]:
|
||||
assign_perm(perm, role.group, data.validated_data["model_instance"])
|
||||
return Response(status=204)
|
||||
|
||||
@permission_required("authentik_rbac.unassign_role_permissions")
|
||||
@extend_schema(
|
||||
request=PermissionAssignSerializer(),
|
||||
responses={
|
||||
204: OpenApiResponse(description="Successfully unassigned"),
|
||||
},
|
||||
)
|
||||
@action(methods=["PATCH"], detail=True, pagination_class=None, filter_backends=[])
|
||||
def unassign(self, request: Request, *args, **kwargs) -> Response:
|
||||
"""Unassign permission(s) to role. When `object_pk` is set, the permissions
|
||||
are only assigned to the specific object, otherwise they are assigned globally."""
|
||||
role: Role = self.get_object()
|
||||
data = PermissionAssignSerializer(data=request.data)
|
||||
data.is_valid(raise_exception=True)
|
||||
with atomic():
|
||||
for perm in data.validated_data["permissions"]:
|
||||
remove_perm(perm, role.group, data.validated_data["model_instance"])
|
||||
return Response(status=204)
|
||||
129
authentik/rbac/api/rbac_assigned_by_users.py
Normal file
129
authentik/rbac/api/rbac_assigned_by_users.py
Normal file
@ -0,0 +1,129 @@
|
||||
"""common RBAC serializers"""
|
||||
from django.db.models import Q, QuerySet
|
||||
from django.db.transaction import atomic
|
||||
from django_filters.filters import CharFilter, ChoiceFilter
|
||||
from django_filters.filterset import FilterSet
|
||||
from drf_spectacular.utils import OpenApiResponse, extend_schema
|
||||
from guardian.models import UserObjectPermission
|
||||
from guardian.shortcuts import assign_perm, remove_perm
|
||||
from rest_framework.decorators import action
|
||||
from rest_framework.exceptions import ValidationError
|
||||
from rest_framework.fields import BooleanField, ReadOnlyField
|
||||
from rest_framework.mixins import ListModelMixin
|
||||
from rest_framework.request import Request
|
||||
from rest_framework.response import Response
|
||||
from rest_framework.serializers import ModelSerializer
|
||||
from rest_framework.viewsets import GenericViewSet
|
||||
|
||||
from authentik.api.decorators import permission_required
|
||||
from authentik.core.api.groups import GroupMemberSerializer
|
||||
from authentik.core.models import User, UserTypes
|
||||
from authentik.policies.event_matcher.models import model_choices
|
||||
from authentik.rbac.api.rbac import PermissionAssignSerializer
|
||||
|
||||
|
||||
class UserObjectPermissionSerializer(ModelSerializer):
|
||||
"""User-bound object level permission"""
|
||||
|
||||
app_label = ReadOnlyField(source="content_type.app_label")
|
||||
model = ReadOnlyField(source="content_type.model")
|
||||
codename = ReadOnlyField(source="permission.codename")
|
||||
name = ReadOnlyField(source="permission.name")
|
||||
object_pk = ReadOnlyField()
|
||||
|
||||
class Meta:
|
||||
model = UserObjectPermission
|
||||
fields = ["id", "codename", "model", "app_label", "object_pk", "name"]
|
||||
|
||||
|
||||
class UserAssignedObjectPermissionSerializer(GroupMemberSerializer):
|
||||
"""Users assigned object permission serializer"""
|
||||
|
||||
permissions = UserObjectPermissionSerializer(many=True, source="userobjectpermission_set")
|
||||
is_superuser = BooleanField()
|
||||
|
||||
class Meta:
|
||||
model = GroupMemberSerializer.Meta.model
|
||||
fields = GroupMemberSerializer.Meta.fields + ["permissions", "is_superuser"]
|
||||
|
||||
|
||||
class UserAssignedPermissionFilter(FilterSet):
|
||||
"""Assigned permission filter"""
|
||||
|
||||
model = ChoiceFilter(choices=model_choices(), method="filter_model", required=True)
|
||||
object_pk = CharFilter(method="filter_object_pk")
|
||||
|
||||
def filter_model(self, queryset: QuerySet, name, value: str) -> QuerySet:
|
||||
"""Filter by object type"""
|
||||
app, _, model = value.partition(".")
|
||||
return queryset.filter(
|
||||
Q(
|
||||
user_permissions__content_type__app_label=app,
|
||||
user_permissions__content_type__model=model,
|
||||
)
|
||||
| Q(
|
||||
userobjectpermission__permission__content_type__app_label=app,
|
||||
userobjectpermission__permission__content_type__model=model,
|
||||
)
|
||||
| Q(ak_groups__is_superuser=True)
|
||||
).distinct()
|
||||
|
||||
def filter_object_pk(self, queryset: QuerySet, name, value: str) -> QuerySet:
|
||||
"""Filter by object primary key"""
|
||||
return queryset.filter(
|
||||
Q(userobjectpermission__object_pk=value) | Q(ak_groups__is_superuser=True),
|
||||
).distinct()
|
||||
|
||||
|
||||
class UserAssignedPermissionViewSet(ListModelMixin, GenericViewSet):
|
||||
"""Get assigned object permissions for a single object"""
|
||||
|
||||
serializer_class = UserAssignedObjectPermissionSerializer
|
||||
ordering = ["username"]
|
||||
# The filtering is done in the filterset,
|
||||
# which has a required filter that does the heavy lifting
|
||||
queryset = User.objects.all()
|
||||
filterset_class = UserAssignedPermissionFilter
|
||||
|
||||
@permission_required("authentik_core.assign_user_permissions")
|
||||
@extend_schema(
|
||||
request=PermissionAssignSerializer(),
|
||||
responses={
|
||||
204: OpenApiResponse(description="Successfully assigned"),
|
||||
},
|
||||
)
|
||||
@action(methods=["POST"], detail=True, pagination_class=None, filter_backends=[])
|
||||
def assign(self, request: Request, *args, **kwargs) -> Response:
|
||||
"""Assign permission(s) to user"""
|
||||
user: User = self.get_object()
|
||||
if user.type == UserTypes.INTERNAL_SERVICE_ACCOUNT:
|
||||
raise ValidationError("Permissions cannot be assigned to an internal service account.")
|
||||
data = PermissionAssignSerializer(data=request.data)
|
||||
data.is_valid(raise_exception=True)
|
||||
with atomic():
|
||||
for perm in data.validated_data["permissions"]:
|
||||
assign_perm(perm, user, data.validated_data["model_instance"])
|
||||
return Response(status=204)
|
||||
|
||||
@permission_required("authentik_core.unassign_user_permissions")
|
||||
@extend_schema(
|
||||
request=PermissionAssignSerializer(),
|
||||
responses={
|
||||
204: OpenApiResponse(description="Successfully unassigned"),
|
||||
},
|
||||
)
|
||||
@action(methods=["PATCH"], detail=True, pagination_class=None, filter_backends=[])
|
||||
def unassign(self, request: Request, *args, **kwargs) -> Response:
|
||||
"""Unassign permission(s) to user. When `object_pk` is set, the permissions
|
||||
are only assigned to the specific object, otherwise they are assigned globally."""
|
||||
user: User = self.get_object()
|
||||
if user.type == UserTypes.INTERNAL_SERVICE_ACCOUNT:
|
||||
raise ValidationError(
|
||||
"Permissions cannot be unassigned from an internal service account."
|
||||
)
|
||||
data = PermissionAssignSerializer(data=request.data)
|
||||
data.is_valid(raise_exception=True)
|
||||
with atomic():
|
||||
for perm in data.validated_data["permissions"]:
|
||||
remove_perm(perm, user, data.validated_data["model_instance"])
|
||||
return Response(status=204)
|
||||
71
authentik/rbac/api/rbac_roles.py
Normal file
71
authentik/rbac/api/rbac_roles.py
Normal file
@ -0,0 +1,71 @@
|
||||
"""common RBAC serializers"""
|
||||
from typing import Optional
|
||||
|
||||
from django.apps import apps
|
||||
from django_filters.filters import UUIDFilter
|
||||
from django_filters.filterset import FilterSet
|
||||
from guardian.models import GroupObjectPermission
|
||||
from guardian.shortcuts import get_objects_for_group
|
||||
from rest_framework.fields import SerializerMethodField
|
||||
from rest_framework.mixins import ListModelMixin
|
||||
from rest_framework.viewsets import GenericViewSet
|
||||
|
||||
from authentik.api.pagination import SmallerPagination
|
||||
from authentik.rbac.api.rbac_assigned_by_roles import RoleObjectPermissionSerializer
|
||||
|
||||
|
||||
class ExtraRoleObjectPermissionSerializer(RoleObjectPermissionSerializer):
|
||||
"""User permission with additional object-related data"""
|
||||
|
||||
app_label_verbose = SerializerMethodField()
|
||||
model_verbose = SerializerMethodField()
|
||||
|
||||
object_description = SerializerMethodField()
|
||||
|
||||
def get_app_label_verbose(self, instance: GroupObjectPermission) -> str:
|
||||
"""Get app label from permission's model"""
|
||||
return apps.get_app_config(instance.content_type.app_label).verbose_name
|
||||
|
||||
def get_model_verbose(self, instance: GroupObjectPermission) -> str:
|
||||
"""Get model label from permission's model"""
|
||||
return apps.get_model(
|
||||
instance.content_type.app_label, instance.content_type.model
|
||||
)._meta.verbose_name
|
||||
|
||||
def get_object_description(self, instance: GroupObjectPermission) -> Optional[str]:
|
||||
"""Get model description from attached model. This operation takes at least
|
||||
one additional query, and the description is only shown if the user/role has the
|
||||
view_ permission on the object"""
|
||||
app_label = instance.content_type.app_label
|
||||
model = instance.content_type.model
|
||||
model_class = apps.get_model(app_label, model)
|
||||
objects = get_objects_for_group(instance.group, f"{app_label}.view_{model}", model_class)
|
||||
obj = objects.first()
|
||||
if not obj:
|
||||
return None
|
||||
return str(obj)
|
||||
|
||||
class Meta(RoleObjectPermissionSerializer.Meta):
|
||||
fields = RoleObjectPermissionSerializer.Meta.fields + [
|
||||
"app_label_verbose",
|
||||
"model_verbose",
|
||||
"object_description",
|
||||
]
|
||||
|
||||
|
||||
class RolePermissionFilter(FilterSet):
|
||||
"""Role permission filter"""
|
||||
|
||||
uuid = UUIDFilter("group__role__uuid", required=True)
|
||||
|
||||
|
||||
class RolePermissionViewSet(ListModelMixin, GenericViewSet):
|
||||
"""Get a role's assigned object permissions"""
|
||||
|
||||
serializer_class = ExtraRoleObjectPermissionSerializer
|
||||
ordering = ["group__role__name"]
|
||||
pagination_class = SmallerPagination
|
||||
# The filtering is done in the filterset,
|
||||
# which has a required filter that does the heavy lifting
|
||||
queryset = GroupObjectPermission.objects.select_related("content_type", "group__role").all()
|
||||
filterset_class = RolePermissionFilter
|
||||
71
authentik/rbac/api/rbac_users.py
Normal file
71
authentik/rbac/api/rbac_users.py
Normal file
@ -0,0 +1,71 @@
|
||||
"""common RBAC serializers"""
|
||||
from typing import Optional
|
||||
|
||||
from django.apps import apps
|
||||
from django_filters.filters import NumberFilter
|
||||
from django_filters.filterset import FilterSet
|
||||
from guardian.models import UserObjectPermission
|
||||
from guardian.shortcuts import get_objects_for_user
|
||||
from rest_framework.fields import SerializerMethodField
|
||||
from rest_framework.mixins import ListModelMixin
|
||||
from rest_framework.viewsets import GenericViewSet
|
||||
|
||||
from authentik.api.pagination import SmallerPagination
|
||||
from authentik.rbac.api.rbac_assigned_by_users import UserObjectPermissionSerializer
|
||||
|
||||
|
||||
class ExtraUserObjectPermissionSerializer(UserObjectPermissionSerializer):
|
||||
"""User permission with additional object-related data"""
|
||||
|
||||
app_label_verbose = SerializerMethodField()
|
||||
model_verbose = SerializerMethodField()
|
||||
|
||||
object_description = SerializerMethodField()
|
||||
|
||||
def get_app_label_verbose(self, instance: UserObjectPermission) -> str:
|
||||
"""Get app label from permission's model"""
|
||||
return apps.get_app_config(instance.content_type.app_label).verbose_name
|
||||
|
||||
def get_model_verbose(self, instance: UserObjectPermission) -> str:
|
||||
"""Get model label from permission's model"""
|
||||
return apps.get_model(
|
||||
instance.content_type.app_label, instance.content_type.model
|
||||
)._meta.verbose_name
|
||||
|
||||
def get_object_description(self, instance: UserObjectPermission) -> Optional[str]:
|
||||
"""Get model description from attached model. This operation takes at least
|
||||
one additional query, and the description is only shown if the user/role has the
|
||||
view_ permission on the object"""
|
||||
app_label = instance.content_type.app_label
|
||||
model = instance.content_type.model
|
||||
model_class = apps.get_model(app_label, model)
|
||||
objects = get_objects_for_user(instance.user, f"{app_label}.view_{model}", model_class)
|
||||
obj = objects.first()
|
||||
if not obj:
|
||||
return None
|
||||
return str(obj)
|
||||
|
||||
class Meta(UserObjectPermissionSerializer.Meta):
|
||||
fields = UserObjectPermissionSerializer.Meta.fields + [
|
||||
"app_label_verbose",
|
||||
"model_verbose",
|
||||
"object_description",
|
||||
]
|
||||
|
||||
|
||||
class UserPermissionFilter(FilterSet):
|
||||
"""User-assigned permission filter"""
|
||||
|
||||
user_id = NumberFilter("user__id", required=True)
|
||||
|
||||
|
||||
class UserPermissionViewSet(ListModelMixin, GenericViewSet):
|
||||
"""Get a users's assigned object permissions"""
|
||||
|
||||
serializer_class = ExtraUserObjectPermissionSerializer
|
||||
ordering = ["user__username"]
|
||||
pagination_class = SmallerPagination
|
||||
# The filtering is done in the filterset,
|
||||
# which has a required filter that does the heavy lifting
|
||||
queryset = UserObjectPermission.objects.select_related("content_type", "user").all()
|
||||
filterset_class = UserPermissionFilter
|
||||
24
authentik/rbac/api/roles.py
Normal file
24
authentik/rbac/api/roles.py
Normal file
@ -0,0 +1,24 @@
|
||||
"""RBAC Roles"""
|
||||
from rest_framework.serializers import ModelSerializer
|
||||
from rest_framework.viewsets import ModelViewSet
|
||||
|
||||
from authentik.core.api.used_by import UsedByMixin
|
||||
from authentik.rbac.models import Role
|
||||
|
||||
|
||||
class RoleSerializer(ModelSerializer):
|
||||
"""Role serializer"""
|
||||
|
||||
class Meta:
|
||||
model = Role
|
||||
fields = ["pk", "name"]
|
||||
|
||||
|
||||
class RoleViewSet(UsedByMixin, ModelViewSet):
|
||||
"""Role viewset"""
|
||||
|
||||
serializer_class = RoleSerializer
|
||||
queryset = Role.objects.all()
|
||||
search_fields = ["group__name"]
|
||||
ordering = ["group__name"]
|
||||
filterset_fields = ["group__name"]
|
||||
15
authentik/rbac/apps.py
Normal file
15
authentik/rbac/apps.py
Normal file
@ -0,0 +1,15 @@
|
||||
"""authentik rbac app config"""
|
||||
from authentik.blueprints.apps import ManagedAppConfig
|
||||
|
||||
|
||||
class AuthentikRBACConfig(ManagedAppConfig):
|
||||
"""authentik rbac app config"""
|
||||
|
||||
name = "authentik.rbac"
|
||||
label = "authentik_rbac"
|
||||
verbose_name = "authentik RBAC"
|
||||
default = True
|
||||
|
||||
def reconcile_load_rbac_signals(self):
|
||||
"""Load rbac signals"""
|
||||
self.import_module("authentik.rbac.signals")
|
||||
26
authentik/rbac/filters.py
Normal file
26
authentik/rbac/filters.py
Normal file
@ -0,0 +1,26 @@
|
||||
"""RBAC API Filter"""
|
||||
from django.db.models import QuerySet
|
||||
from rest_framework.exceptions import PermissionDenied
|
||||
from rest_framework.request import Request
|
||||
from rest_framework_guardian.filters import ObjectPermissionsFilter
|
||||
|
||||
|
||||
class ObjectFilter(ObjectPermissionsFilter):
|
||||
"""Object permission filter that grants global permission higher priority than
|
||||
per-object permissions"""
|
||||
|
||||
def filter_queryset(self, request: Request, queryset: QuerySet, view) -> QuerySet:
|
||||
permission = self.perm_format % {
|
||||
"app_label": queryset.model._meta.app_label,
|
||||
"model_name": queryset.model._meta.model_name,
|
||||
}
|
||||
# having the global permission set on a user has higher priority than
|
||||
# per-object permissions
|
||||
if request.user.has_perm(permission):
|
||||
return queryset
|
||||
queryset = super().filter_queryset(request, queryset, view)
|
||||
if not queryset.exists():
|
||||
# User doesn't have direct permission to all objects
|
||||
# and also no object permissions assigned (directly or via role)
|
||||
raise PermissionDenied()
|
||||
return queryset
|
||||
47
authentik/rbac/migrations/0001_initial.py
Normal file
47
authentik/rbac/migrations/0001_initial.py
Normal file
@ -0,0 +1,47 @@
|
||||
# Generated by Django 4.2.6 on 2023-10-11 13:37
|
||||
|
||||
import uuid
|
||||
|
||||
import django.db.models.deletion
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
initial = True
|
||||
|
||||
dependencies = [
|
||||
("auth", "0012_alter_user_first_name_max_length"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name="Role",
|
||||
fields=[
|
||||
(
|
||||
"uuid",
|
||||
models.UUIDField(
|
||||
default=uuid.uuid4,
|
||||
editable=False,
|
||||
primary_key=True,
|
||||
serialize=False,
|
||||
unique=True,
|
||||
),
|
||||
),
|
||||
("name", models.TextField(max_length=150, unique=True)),
|
||||
(
|
||||
"group",
|
||||
models.OneToOneField(
|
||||
on_delete=django.db.models.deletion.CASCADE, to="auth.group"
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"verbose_name": "Role",
|
||||
"verbose_name_plural": "Roles",
|
||||
"permissions": [
|
||||
("assign_role_permissions", "Can assign permissions to users"),
|
||||
("unassign_role_permissions", "Can unassign permissions from users"),
|
||||
],
|
||||
},
|
||||
),
|
||||
]
|
||||
33
authentik/rbac/migrations/0002_systempermission.py
Normal file
33
authentik/rbac/migrations/0002_systempermission.py
Normal file
@ -0,0 +1,33 @@
|
||||
# Generated by Django 4.2.6 on 2023-10-12 15:26
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
dependencies = [
|
||||
("authentik_rbac", "0001_initial"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name="SystemPermission",
|
||||
fields=[
|
||||
(
|
||||
"id",
|
||||
models.AutoField(
|
||||
auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"permissions": [
|
||||
("view_system_info", "Can view system info"),
|
||||
("view_system_tasks", "Can view system tasks"),
|
||||
("run_system_tasks", "Can run system tasks"),
|
||||
("access_admin_interface", "Can access admin interface"),
|
||||
],
|
||||
"managed": False,
|
||||
"default_permissions": (),
|
||||
},
|
||||
),
|
||||
]
|
||||
0
authentik/rbac/migrations/__init__.py
Normal file
0
authentik/rbac/migrations/__init__.py
Normal file
73
authentik/rbac/models.py
Normal file
73
authentik/rbac/models.py
Normal file
@ -0,0 +1,73 @@
|
||||
"""RBAC models"""
|
||||
from typing import Optional
|
||||
from uuid import uuid4
|
||||
|
||||
from django.db import models
|
||||
from django.db.transaction import atomic
|
||||
from django.utils.translation import gettext_lazy as _
|
||||
from guardian.shortcuts import assign_perm
|
||||
from rest_framework.serializers import BaseSerializer
|
||||
|
||||
from authentik.lib.models import SerializerModel
|
||||
|
||||
|
||||
class Role(SerializerModel):
|
||||
"""RBAC role, which can have different permissions (both global and per-object) attached
|
||||
to it."""
|
||||
|
||||
uuid = models.UUIDField(default=uuid4, editable=False, unique=True, primary_key=True)
|
||||
# Due to the way django and django-guardian work, this is somewhat of a hack.
|
||||
# Django and django-guardian allow for setting permissions on users and groups, but they
|
||||
# only allow for a custom user object, not a custom group object, which is why
|
||||
# we have both authentik and django groups. With this model, we use the inbuilt group system
|
||||
# for RBAC. This means that every Role needs a single django group that its assigned to
|
||||
# which will hold all of the actual permissions
|
||||
# The main advantage of that is that all the permission checking just works out of the box,
|
||||
# as these permissions are checked by default by django and most other libraries that build
|
||||
# on top of django
|
||||
group = models.OneToOneField("auth.Group", on_delete=models.CASCADE)
|
||||
|
||||
# name field has the same constraints as the group model
|
||||
name = models.TextField(max_length=150, unique=True)
|
||||
|
||||
def assign_permission(self, *perms: str, obj: Optional[models.Model] = None):
|
||||
"""Assign permission to role, can handle multiple permissions,
|
||||
but when assigning multiple permissions to an object the permissions
|
||||
must all belong to the object given"""
|
||||
with atomic():
|
||||
for perm in perms:
|
||||
assign_perm(perm, self.group, obj)
|
||||
|
||||
@property
|
||||
def serializer(self) -> type[BaseSerializer]:
|
||||
from authentik.rbac.api.roles import RoleSerializer
|
||||
|
||||
return RoleSerializer
|
||||
|
||||
def __str__(self) -> str:
|
||||
return f"Role {self.name}"
|
||||
|
||||
class Meta:
|
||||
verbose_name = _("Role")
|
||||
verbose_name_plural = _("Roles")
|
||||
permissions = [
|
||||
("assign_role_permissions", _("Can assign permissions to users")),
|
||||
("unassign_role_permissions", _("Can unassign permissions from users")),
|
||||
]
|
||||
|
||||
|
||||
class SystemPermission(models.Model):
|
||||
"""System-wide permissions that are not related to any direct
|
||||
database model"""
|
||||
|
||||
class Meta:
|
||||
managed = False
|
||||
default_permissions = ()
|
||||
verbose_name = _("System permission")
|
||||
verbose_name_plural = _("System permissions")
|
||||
permissions = [
|
||||
("view_system_info", _("Can view system info")),
|
||||
("view_system_tasks", _("Can view system tasks")),
|
||||
("run_system_tasks", _("Can run system tasks")),
|
||||
("access_admin_interface", _("Can access admin interface")),
|
||||
]
|
||||
30
authentik/rbac/permissions.py
Normal file
30
authentik/rbac/permissions.py
Normal file
@ -0,0 +1,30 @@
|
||||
"""RBAC Permissions"""
|
||||
from django.db.models import Model
|
||||
from rest_framework.permissions import BasePermission, DjangoObjectPermissions
|
||||
from rest_framework.request import Request
|
||||
|
||||
|
||||
class ObjectPermissions(DjangoObjectPermissions):
|
||||
"""RBAC Permissions"""
|
||||
|
||||
def has_object_permission(self, request: Request, view, obj: Model):
|
||||
queryset = self._queryset(view)
|
||||
model_cls = queryset.model
|
||||
perms = self.get_required_object_permissions(request.method, model_cls)
|
||||
# Rank global permissions higher than per-object permissions
|
||||
if request.user.has_perms(perms):
|
||||
return True
|
||||
return super().has_object_permission(request, view, obj)
|
||||
|
||||
|
||||
# pylint: disable=invalid-name
|
||||
def HasPermission(*perm: str) -> type[BasePermission]:
|
||||
"""Permission checker for any non-object permissions, returns
|
||||
a BasePermission class that can be used with rest_framework"""
|
||||
|
||||
# pylint: disable=missing-class-docstring, invalid-name
|
||||
class checker(BasePermission):
|
||||
def has_permission(self, request: Request, view):
|
||||
return bool(request.user and request.user.has_perms(perm))
|
||||
|
||||
return checker
|
||||
67
authentik/rbac/signals.py
Normal file
67
authentik/rbac/signals.py
Normal file
@ -0,0 +1,67 @@
|
||||
"""rbac signals"""
|
||||
from django.contrib.auth.models import Group as DjangoGroup
|
||||
from django.db.models.signals import m2m_changed, pre_save
|
||||
from django.db.transaction import atomic
|
||||
from django.dispatch import receiver
|
||||
from structlog.stdlib import get_logger
|
||||
|
||||
from authentik.core.models import Group
|
||||
from authentik.rbac.models import Role
|
||||
|
||||
LOGGER = get_logger()
|
||||
|
||||
|
||||
@receiver(pre_save, sender=Role)
|
||||
def rbac_role_pre_save(sender: type[Role], instance: Role, **_):
|
||||
"""Ensure role has a group object created for it"""
|
||||
if hasattr(instance, "group"):
|
||||
return
|
||||
group, _ = DjangoGroup.objects.get_or_create(name=instance.name)
|
||||
instance.group = group
|
||||
|
||||
|
||||
@receiver(m2m_changed, sender=Group.roles.through)
|
||||
def rbac_group_role_m2m(sender: type[Group], action: str, instance: Group, reverse: bool, **_):
|
||||
"""RBAC: Sync group members into roles when roles are assigned"""
|
||||
if action not in ["post_add", "post_remove", "post_clear"]:
|
||||
return
|
||||
with atomic():
|
||||
group_users = list(
|
||||
instance.children_recursive()
|
||||
.exclude(users__isnull=True)
|
||||
.values_list("users", flat=True)
|
||||
)
|
||||
if not group_users:
|
||||
return
|
||||
for role in instance.roles.all():
|
||||
role: Role
|
||||
role.group.user_set.set(group_users)
|
||||
LOGGER.debug("Updated users in group", group=instance)
|
||||
|
||||
|
||||
# pylint: disable=no-member
|
||||
@receiver(m2m_changed, sender=Group.users.through)
|
||||
def rbac_group_users_m2m(
|
||||
sender: type[Group], action: str, instance: Group, pk_set: set, reverse: bool, **_
|
||||
):
|
||||
"""Handle Group/User m2m and mirror it to roles"""
|
||||
if action not in ["post_add", "post_remove"]:
|
||||
return
|
||||
# reverse: instance is a Group, pk_set is a list of user pks
|
||||
# non-reverse: instance is a User, pk_set is a list of groups
|
||||
with atomic():
|
||||
if reverse:
|
||||
for role in instance.roles.all():
|
||||
role: Role
|
||||
if action == "post_add":
|
||||
role.group.user_set.add(*pk_set)
|
||||
elif action == "post_remove":
|
||||
role.group.user_set.remove(*pk_set)
|
||||
else:
|
||||
for group in Group.objects.filter(pk__in=pk_set):
|
||||
for role in group.roles.all():
|
||||
role: Role
|
||||
if action == "post_add":
|
||||
role.group.user_set.add(instance)
|
||||
elif action == "post_remove":
|
||||
role.group.user_set.remove(instance)
|
||||
0
authentik/rbac/tests/__init__.py
Normal file
0
authentik/rbac/tests/__init__.py
Normal file
151
authentik/rbac/tests/test_api_assigned_by_roles.py
Normal file
151
authentik/rbac/tests/test_api_assigned_by_roles.py
Normal file
@ -0,0 +1,151 @@
|
||||
"""Test RoleAssignedPermissionViewSet api"""
|
||||
from django.urls import reverse
|
||||
from rest_framework.test import APITestCase
|
||||
|
||||
from authentik.core.models import Group
|
||||
from authentik.core.tests.utils import create_test_admin_user, create_test_user
|
||||
from authentik.lib.generators import generate_id
|
||||
from authentik.rbac.api.rbac_assigned_by_roles import RoleAssignedObjectPermissionSerializer
|
||||
from authentik.rbac.models import Role
|
||||
from authentik.stages.invitation.models import Invitation
|
||||
|
||||
|
||||
class TestRBACRoleAPI(APITestCase):
|
||||
"""Test RoleAssignedPermissionViewSet api"""
|
||||
|
||||
def setUp(self) -> None:
|
||||
self.superuser = create_test_admin_user()
|
||||
|
||||
self.user = create_test_user()
|
||||
self.role = Role.objects.create(name=generate_id())
|
||||
self.group = Group.objects.create(name=generate_id())
|
||||
self.group.roles.add(self.role)
|
||||
self.group.users.add(self.user)
|
||||
|
||||
def test_filter_assigned(self):
|
||||
"""Test RoleAssignedPermissionViewSet's filters"""
|
||||
inv = Invitation.objects.create(
|
||||
name=generate_id(),
|
||||
created_by=self.superuser,
|
||||
)
|
||||
self.role.assign_permission("authentik_stages_invitation.view_invitation", obj=inv)
|
||||
# self.user doesn't have permissions to see their (object) permissions
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.get(
|
||||
reverse("authentik_api:permissions-assigned-by-roles-list"),
|
||||
{
|
||||
"model": "authentik_stages_invitation.invitation",
|
||||
"object_pk": str(inv.pk),
|
||||
"ordering": "pk",
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 200)
|
||||
self.assertJSONEqual(
|
||||
res.content.decode(),
|
||||
{
|
||||
"pagination": {
|
||||
"next": 0,
|
||||
"previous": 0,
|
||||
"count": 1,
|
||||
"current": 1,
|
||||
"total_pages": 1,
|
||||
"start_index": 1,
|
||||
"end_index": 1,
|
||||
},
|
||||
"results": [
|
||||
RoleAssignedObjectPermissionSerializer(instance=self.role).data,
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
def test_assign_global(self):
|
||||
"""Test permission assign"""
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.post(
|
||||
reverse(
|
||||
"authentik_api:permissions-assigned-by-roles-assign",
|
||||
kwargs={
|
||||
"pk": self.role.pk,
|
||||
},
|
||||
),
|
||||
{
|
||||
"permissions": ["authentik_stages_invitation.view_invitation"],
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 204)
|
||||
self.assertTrue(self.user.has_perm("authentik_stages_invitation.view_invitation"))
|
||||
|
||||
def test_assign_object(self):
|
||||
"""Test permission assign (object)"""
|
||||
inv = Invitation.objects.create(
|
||||
name=generate_id(),
|
||||
created_by=self.superuser,
|
||||
)
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.post(
|
||||
reverse(
|
||||
"authentik_api:permissions-assigned-by-roles-assign",
|
||||
kwargs={
|
||||
"pk": self.role.pk,
|
||||
},
|
||||
),
|
||||
{
|
||||
"permissions": ["authentik_stages_invitation.view_invitation"],
|
||||
"model": "authentik_stages_invitation.invitation",
|
||||
"object_pk": str(inv.pk),
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 204)
|
||||
self.assertTrue(
|
||||
self.user.has_perm(
|
||||
"authentik_stages_invitation.view_invitation",
|
||||
inv,
|
||||
)
|
||||
)
|
||||
|
||||
def test_unassign_global(self):
|
||||
"""Test permission unassign"""
|
||||
self.role.assign_permission("authentik_stages_invitation.view_invitation")
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.patch(
|
||||
reverse(
|
||||
"authentik_api:permissions-assigned-by-roles-unassign",
|
||||
kwargs={
|
||||
"pk": str(self.role.pk),
|
||||
},
|
||||
),
|
||||
{
|
||||
"permissions": ["authentik_stages_invitation.view_invitation"],
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 204)
|
||||
self.assertFalse(self.user.has_perm("authentik_stages_invitation.view_invitation"))
|
||||
|
||||
def test_unassign_object(self):
|
||||
"""Test permission unassign (object)"""
|
||||
inv = Invitation.objects.create(
|
||||
name=generate_id(),
|
||||
created_by=self.superuser,
|
||||
)
|
||||
self.role.assign_permission("authentik_stages_invitation.view_invitation", obj=inv)
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.patch(
|
||||
reverse(
|
||||
"authentik_api:permissions-assigned-by-roles-unassign",
|
||||
kwargs={
|
||||
"pk": str(self.role.pk),
|
||||
},
|
||||
),
|
||||
{
|
||||
"permissions": ["authentik_stages_invitation.view_invitation"],
|
||||
"model": "authentik_stages_invitation.invitation",
|
||||
"object_pk": str(inv.pk),
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 204)
|
||||
self.assertFalse(
|
||||
self.user.has_perm(
|
||||
"authentik_stages_invitation.view_invitation",
|
||||
inv,
|
||||
)
|
||||
)
|
||||
196
authentik/rbac/tests/test_api_assigned_by_users.py
Normal file
196
authentik/rbac/tests/test_api_assigned_by_users.py
Normal file
@ -0,0 +1,196 @@
|
||||
"""Test UserAssignedPermissionViewSet api"""
|
||||
from django.urls import reverse
|
||||
from guardian.shortcuts import assign_perm
|
||||
from rest_framework.test import APITestCase
|
||||
|
||||
from authentik.core.models import Group, UserTypes
|
||||
from authentik.core.tests.utils import create_test_admin_user, create_test_user
|
||||
from authentik.lib.generators import generate_id
|
||||
from authentik.rbac.api.rbac_assigned_by_users import UserAssignedObjectPermissionSerializer
|
||||
from authentik.rbac.models import Role
|
||||
from authentik.stages.invitation.models import Invitation
|
||||
|
||||
|
||||
class TestRBACUserAPI(APITestCase):
|
||||
"""Test UserAssignedPermissionViewSet api"""
|
||||
|
||||
def setUp(self) -> None:
|
||||
self.superuser = create_test_admin_user()
|
||||
|
||||
self.user = create_test_user()
|
||||
self.role = Role.objects.create(name=generate_id())
|
||||
self.group = Group.objects.create(name=generate_id())
|
||||
self.group.roles.add(self.role)
|
||||
self.group.users.add(self.user)
|
||||
|
||||
def test_filter_assigned(self):
|
||||
"""Test UserAssignedPermissionViewSet's filters"""
|
||||
inv = Invitation.objects.create(
|
||||
name=generate_id(),
|
||||
created_by=self.superuser,
|
||||
)
|
||||
assign_perm("authentik_stages_invitation.view_invitation", self.user, inv)
|
||||
# self.user doesn't have permissions to see their (object) permissions
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.get(
|
||||
reverse("authentik_api:permissions-assigned-by-users-list"),
|
||||
{
|
||||
"model": "authentik_stages_invitation.invitation",
|
||||
"object_pk": str(inv.pk),
|
||||
"ordering": "pk",
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 200)
|
||||
self.assertJSONEqual(
|
||||
res.content.decode(),
|
||||
{
|
||||
"pagination": {
|
||||
"next": 0,
|
||||
"previous": 0,
|
||||
"count": 2,
|
||||
"current": 1,
|
||||
"total_pages": 1,
|
||||
"start_index": 1,
|
||||
"end_index": 2,
|
||||
},
|
||||
"results": sorted(
|
||||
[
|
||||
UserAssignedObjectPermissionSerializer(instance=self.user).data,
|
||||
UserAssignedObjectPermissionSerializer(instance=self.superuser).data,
|
||||
],
|
||||
key=lambda u: u["pk"],
|
||||
),
|
||||
},
|
||||
)
|
||||
|
||||
def test_assign_global(self):
|
||||
"""Test permission assign"""
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.post(
|
||||
reverse(
|
||||
"authentik_api:permissions-assigned-by-users-assign",
|
||||
kwargs={
|
||||
"pk": self.user.pk,
|
||||
},
|
||||
),
|
||||
{
|
||||
"permissions": ["authentik_stages_invitation.view_invitation"],
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 204)
|
||||
self.assertTrue(self.user.has_perm("authentik_stages_invitation.view_invitation"))
|
||||
|
||||
def test_assign_global_internal_sa(self):
|
||||
"""Test permission assign (to internal service account)"""
|
||||
self.client.force_login(self.superuser)
|
||||
self.user.type = UserTypes.INTERNAL_SERVICE_ACCOUNT
|
||||
self.user.save()
|
||||
res = self.client.post(
|
||||
reverse(
|
||||
"authentik_api:permissions-assigned-by-users-assign",
|
||||
kwargs={
|
||||
"pk": self.user.pk,
|
||||
},
|
||||
),
|
||||
{
|
||||
"permissions": ["authentik_stages_invitation.view_invitation"],
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 400)
|
||||
self.assertFalse(self.user.has_perm("authentik_stages_invitation.view_invitation"))
|
||||
|
||||
def test_assign_object(self):
|
||||
"""Test permission assign (object)"""
|
||||
inv = Invitation.objects.create(
|
||||
name=generate_id(),
|
||||
created_by=self.superuser,
|
||||
)
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.post(
|
||||
reverse(
|
||||
"authentik_api:permissions-assigned-by-users-assign",
|
||||
kwargs={
|
||||
"pk": self.user.pk,
|
||||
},
|
||||
),
|
||||
{
|
||||
"permissions": ["authentik_stages_invitation.view_invitation"],
|
||||
"model": "authentik_stages_invitation.invitation",
|
||||
"object_pk": str(inv.pk),
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 204)
|
||||
self.assertTrue(
|
||||
self.user.has_perm(
|
||||
"authentik_stages_invitation.view_invitation",
|
||||
inv,
|
||||
)
|
||||
)
|
||||
|
||||
def test_unassign_global(self):
|
||||
"""Test permission unassign"""
|
||||
assign_perm("authentik_stages_invitation.view_invitation", self.user)
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.patch(
|
||||
reverse(
|
||||
"authentik_api:permissions-assigned-by-users-unassign",
|
||||
kwargs={
|
||||
"pk": self.user.pk,
|
||||
},
|
||||
),
|
||||
{
|
||||
"permissions": ["authentik_stages_invitation.view_invitation"],
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 204)
|
||||
self.assertFalse(self.user.has_perm("authentik_stages_invitation.view_invitation"))
|
||||
|
||||
def test_unassign_global_internal_sa(self):
|
||||
"""Test permission unassign (from internal service account)"""
|
||||
self.client.force_login(self.superuser)
|
||||
self.user.type = UserTypes.INTERNAL_SERVICE_ACCOUNT
|
||||
self.user.save()
|
||||
assign_perm("authentik_stages_invitation.view_invitation", self.user)
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.patch(
|
||||
reverse(
|
||||
"authentik_api:permissions-assigned-by-users-unassign",
|
||||
kwargs={
|
||||
"pk": self.user.pk,
|
||||
},
|
||||
),
|
||||
{
|
||||
"permissions": ["authentik_stages_invitation.view_invitation"],
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 400)
|
||||
self.assertTrue(self.user.has_perm("authentik_stages_invitation.view_invitation"))
|
||||
|
||||
def test_unassign_object(self):
|
||||
"""Test permission unassign (object)"""
|
||||
inv = Invitation.objects.create(
|
||||
name=generate_id(),
|
||||
created_by=self.superuser,
|
||||
)
|
||||
assign_perm("authentik_stages_invitation.view_invitation", self.user, inv)
|
||||
self.client.force_login(self.superuser)
|
||||
res = self.client.patch(
|
||||
reverse(
|
||||
"authentik_api:permissions-assigned-by-users-unassign",
|
||||
kwargs={
|
||||
"pk": self.user.pk,
|
||||
},
|
||||
),
|
||||
{
|
||||
"permissions": ["authentik_stages_invitation.view_invitation"],
|
||||
"model": "authentik_stages_invitation.invitation",
|
||||
"object_pk": str(inv.pk),
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 204)
|
||||
self.assertFalse(
|
||||
self.user.has_perm(
|
||||
"authentik_stages_invitation.view_invitation",
|
||||
inv,
|
||||
)
|
||||
)
|
||||
122
authentik/rbac/tests/test_api_filters.py
Normal file
122
authentik/rbac/tests/test_api_filters.py
Normal file
@ -0,0 +1,122 @@
|
||||
"""RBAC role tests"""
|
||||
from django.urls import reverse
|
||||
from rest_framework.test import APITestCase
|
||||
|
||||
from authentik.core.models import Group
|
||||
from authentik.core.tests.utils import create_test_admin_user, create_test_user
|
||||
from authentik.lib.generators import generate_id
|
||||
from authentik.rbac.models import Role
|
||||
from authentik.stages.invitation.api import InvitationSerializer
|
||||
from authentik.stages.invitation.models import Invitation
|
||||
|
||||
|
||||
class TestAPIPerms(APITestCase):
|
||||
"""Test API Permission and filtering"""
|
||||
|
||||
def setUp(self) -> None:
|
||||
self.superuser = create_test_admin_user()
|
||||
|
||||
self.user = create_test_user()
|
||||
self.role = Role.objects.create(name=generate_id())
|
||||
self.group = Group.objects.create(name=generate_id())
|
||||
self.group.roles.add(self.role)
|
||||
self.group.users.add(self.user)
|
||||
|
||||
def test_list_simple(self):
|
||||
"""Test list (single object, role has global permission)"""
|
||||
self.client.force_login(self.user)
|
||||
self.role.assign_permission("authentik_stages_invitation.view_invitation")
|
||||
|
||||
Invitation.objects.all().delete()
|
||||
inv = Invitation.objects.create(
|
||||
name=generate_id(),
|
||||
created_by=self.superuser,
|
||||
)
|
||||
res = self.client.get(reverse("authentik_api:invitation-list"))
|
||||
self.assertEqual(res.status_code, 200)
|
||||
self.assertJSONEqual(
|
||||
res.content.decode(),
|
||||
{
|
||||
"pagination": {
|
||||
"next": 0,
|
||||
"previous": 0,
|
||||
"count": 1,
|
||||
"current": 1,
|
||||
"total_pages": 1,
|
||||
"start_index": 1,
|
||||
"end_index": 1,
|
||||
},
|
||||
"results": [
|
||||
InvitationSerializer(instance=inv).data,
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
def test_list_object_perm(self):
|
||||
"""Test list"""
|
||||
self.client.force_login(self.user)
|
||||
|
||||
Invitation.objects.all().delete()
|
||||
Invitation.objects.create(
|
||||
name=generate_id(),
|
||||
created_by=self.superuser,
|
||||
)
|
||||
inv2 = Invitation.objects.create(
|
||||
name=generate_id(),
|
||||
created_by=self.superuser,
|
||||
)
|
||||
self.role.assign_permission("authentik_stages_invitation.view_invitation", obj=inv2)
|
||||
|
||||
res = self.client.get(reverse("authentik_api:invitation-list"))
|
||||
self.assertEqual(res.status_code, 200)
|
||||
self.assertJSONEqual(
|
||||
res.content.decode(),
|
||||
{
|
||||
"pagination": {
|
||||
"next": 0,
|
||||
"previous": 0,
|
||||
"count": 1,
|
||||
"current": 1,
|
||||
"total_pages": 1,
|
||||
"start_index": 1,
|
||||
"end_index": 1,
|
||||
},
|
||||
"results": [
|
||||
InvitationSerializer(instance=inv2).data,
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
def test_list_denied(self):
|
||||
"""Test list without adding permission"""
|
||||
self.client.force_login(self.user)
|
||||
|
||||
res = self.client.get(reverse("authentik_api:invitation-list"))
|
||||
self.assertEqual(res.status_code, 403)
|
||||
self.assertJSONEqual(
|
||||
res.content.decode(),
|
||||
{"detail": "You do not have permission to perform this action."},
|
||||
)
|
||||
|
||||
def test_create_simple(self):
|
||||
"""Test create with permission"""
|
||||
self.client.force_login(self.user)
|
||||
self.role.assign_permission("authentik_stages_invitation.add_invitation")
|
||||
res = self.client.post(
|
||||
reverse("authentik_api:invitation-list"),
|
||||
data={
|
||||
"name": generate_id(),
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 201)
|
||||
|
||||
def test_create_simple_denied(self):
|
||||
"""Test create without assigning permission"""
|
||||
self.client.force_login(self.user)
|
||||
res = self.client.post(
|
||||
reverse("authentik_api:invitation-list"),
|
||||
data={
|
||||
"name": generate_id(),
|
||||
},
|
||||
)
|
||||
self.assertEqual(res.status_code, 403)
|
||||
35
authentik/rbac/tests/test_roles.py
Normal file
35
authentik/rbac/tests/test_roles.py
Normal file
@ -0,0 +1,35 @@
|
||||
"""RBAC role tests"""
|
||||
from rest_framework.test import APITestCase
|
||||
|
||||
from authentik.core.models import Group
|
||||
from authentik.core.tests.utils import create_test_admin_user
|
||||
from authentik.lib.generators import generate_id
|
||||
from authentik.rbac.models import Role
|
||||
|
||||
|
||||
class TestRoles(APITestCase):
|
||||
"""Test roles"""
|
||||
|
||||
def test_role_create(self):
|
||||
"""Test creation"""
|
||||
user = create_test_admin_user()
|
||||
group = Group.objects.create(name=generate_id())
|
||||
role = Role.objects.create(name=generate_id())
|
||||
role.assign_permission("authentik_core.view_application")
|
||||
group.roles.add(role)
|
||||
group.users.add(user)
|
||||
self.assertEqual(list(role.group.user_set.all()), [user])
|
||||
self.assertTrue(user.has_perm("authentik_core.view_application"))
|
||||
|
||||
def test_role_create_remove(self):
|
||||
"""Test creation and remove"""
|
||||
user = create_test_admin_user()
|
||||
group = Group.objects.create(name=generate_id())
|
||||
role = Role.objects.create(name=generate_id())
|
||||
role.assign_permission("authentik_core.view_application")
|
||||
group.roles.add(role)
|
||||
group.users.add(user)
|
||||
self.assertEqual(list(role.group.user_set.all()), [user])
|
||||
self.assertTrue(user.has_perm("authentik_core.view_application"))
|
||||
user.delete()
|
||||
self.assertEqual(list(role.group.user_set.all()), [])
|
||||
24
authentik/rbac/urls.py
Normal file
24
authentik/rbac/urls.py
Normal file
@ -0,0 +1,24 @@
|
||||
"""RBAC API urls"""
|
||||
from authentik.rbac.api.rbac import RBACPermissionViewSet
|
||||
from authentik.rbac.api.rbac_assigned_by_roles import RoleAssignedPermissionViewSet
|
||||
from authentik.rbac.api.rbac_assigned_by_users import UserAssignedPermissionViewSet
|
||||
from authentik.rbac.api.rbac_roles import RolePermissionViewSet
|
||||
from authentik.rbac.api.rbac_users import UserPermissionViewSet
|
||||
from authentik.rbac.api.roles import RoleViewSet
|
||||
|
||||
api_urlpatterns = [
|
||||
(
|
||||
"rbac/permissions/assigned_by_users",
|
||||
UserAssignedPermissionViewSet,
|
||||
"permissions-assigned-by-users",
|
||||
),
|
||||
(
|
||||
"rbac/permissions/assigned_by_roles",
|
||||
RoleAssignedPermissionViewSet,
|
||||
"permissions-assigned-by-roles",
|
||||
),
|
||||
("rbac/permissions/users", UserPermissionViewSet, "permissions-users"),
|
||||
("rbac/permissions/roles", RolePermissionViewSet, "permissions-roles"),
|
||||
("rbac/permissions", RBACPermissionViewSet),
|
||||
("rbac/roles", RoleViewSet),
|
||||
]
|
||||
Reference in New Issue
Block a user