Auth DRF
Serializers
rn_forge.django.auth.drf.serializers
DRF serializers for standard Django auth models.
ContentTypeSerializer
Bases: ModelSerializer
Serializer for content types referenced by permissions.
GroupSerializer
Bases: ModelSerializer
Serializer for Django groups.
PermissionSerializer
Bases: ModelSerializer
Serializer for Django permissions.
UserSerializer
Bases: ModelSerializer
Serializer for the active Django user model.
Views
rn_forge.django.auth.drf.views
Auth-aware DRF view mixins and base views.
AuthorizedAPIView
Bases: BaseAPIView
API view that requires the permission its permission_key and action map to.
Checked by :class:~rn_forge.django.auth.drf.authorization.PermissionKeyPermission.
drf_request
property
Return self.request narrowed to a DRF request.
get_request_auth()
Return the current request auth payload.
get_request_data(key=None, default=None)
Return request data, or one body value when key is provided.
get_request_param(key, default=None)
Return a query parameter or default_value.
get_request_string(key, default=None)
Return a query/body value as a string.
get_request_user()
Return the current authenticated request user.
get_request_value(key, default=None)
Return a request-body value or default_value.
AuthorizedModelViewSet
Bases: BaseModelViewSet
Model viewset that requires the permission its permission_key and action map to.
Checked by :class:~rn_forge.django.auth.drf.authorization.PermissionKeyPermission.
drf_request
property
Return self.request narrowed to a DRF request.
filter_queryset(queryset)
Apply parent filters plus rn-forge's date-range active filter.
get_audit_user_identifier()
Return the actor identifier used for create/update audit fields.
get_request_auth()
Return the current request auth payload.
get_request_data(key=None, default=None)
Return request data, or one body value when key is provided.
get_request_param(key, default=None)
Return a query parameter or default_value.
get_request_string(key, default=None)
Return a query/body value as a string.
get_request_user()
Return the current authenticated request user.
get_request_value(key, default=None)
Return a request-body value or default_value.
partial_update(request, *args, **kwargs)
Apply a merge patch.
Raises:
| Type | Description |
|---|---|
UnsupportedMediaType
|
The media type is not
|
PreconditionRequired
|
A required |
MalformedPrecondition
|
|
VersionConflict
|
|
InvalidMergePatch
|
The body is not a JSON object (422). |
ValidationError
|
The merged document is invalid (422). |
perform_create(serializer)
Populate audit fields before DRF persists a new model instance.
perform_update(serializer)
Populate update audit fields before DRF persists an existing model instance.
prepare_create_data(validated_data)
Populate create audit fields on one validated serializer row.
prepare_update_data(validated_data)
Populate update audit fields on one validated serializer row.
retrieve(request, *args, **kwargs)
Return the instance, with an ETag when it is versioned.
GroupViewSet
Bases: AuthorizedModelViewSet
Auth group management viewset.
drf_request
property
Return self.request narrowed to a DRF request.
filter_queryset(queryset)
Apply parent filters plus rn-forge's date-range active filter.
get_audit_user_identifier()
Return the actor identifier used for create/update audit fields.
get_request_auth()
Return the current request auth payload.
get_request_data(key=None, default=None)
Return request data, or one body value when key is provided.
get_request_param(key, default=None)
Return a query parameter or default_value.
get_request_string(key, default=None)
Return a query/body value as a string.
get_request_user()
Return the current authenticated request user.
get_request_value(key, default=None)
Return a request-body value or default_value.
partial_update(request, *args, **kwargs)
Apply a merge patch.
Raises:
| Type | Description |
|---|---|
UnsupportedMediaType
|
The media type is not
|
PreconditionRequired
|
A required |
MalformedPrecondition
|
|
VersionConflict
|
|
InvalidMergePatch
|
The body is not a JSON object (422). |
ValidationError
|
The merged document is invalid (422). |
perform_create(serializer)
Populate audit fields before DRF persists a new model instance.
perform_update(serializer)
Populate update audit fields before DRF persists an existing model instance.
prepare_create_data(validated_data)
Populate create audit fields on one validated serializer row.
prepare_update_data(validated_data)
Populate update audit fields on one validated serializer row.
retrieve(request, *args, **kwargs)
Return the instance, with an ETag when it is versioned.
PermissionViewSet
Bases: AuthorizedModelViewSet
Auth permission management viewset.
drf_request
property
Return self.request narrowed to a DRF request.
filter_queryset(queryset)
Apply parent filters plus rn-forge's date-range active filter.
get_audit_user_identifier()
Return the actor identifier used for create/update audit fields.
get_request_auth()
Return the current request auth payload.
get_request_data(key=None, default=None)
Return request data, or one body value when key is provided.
get_request_param(key, default=None)
Return a query parameter or default_value.
get_request_string(key, default=None)
Return a query/body value as a string.
get_request_user()
Return the current authenticated request user.
get_request_value(key, default=None)
Return a request-body value or default_value.
partial_update(request, *args, **kwargs)
Apply a merge patch.
Raises:
| Type | Description |
|---|---|
UnsupportedMediaType
|
The media type is not
|
PreconditionRequired
|
A required |
MalformedPrecondition
|
|
VersionConflict
|
|
InvalidMergePatch
|
The body is not a JSON object (422). |
ValidationError
|
The merged document is invalid (422). |
perform_create(serializer)
Populate audit fields before DRF persists a new model instance.
perform_update(serializer)
Populate update audit fields before DRF persists an existing model instance.
prepare_create_data(validated_data)
Populate create audit fields on one validated serializer row.
prepare_update_data(validated_data)
Populate update audit fields on one validated serializer row.
retrieve(request, *args, **kwargs)
Return the instance, with an ETag when it is versioned.
UserViewSet
Bases: AuthorizedModelViewSet
Auth user management viewset.
drf_request
property
Return self.request narrowed to a DRF request.
filter_queryset(queryset)
Apply parent filters plus rn-forge's date-range active filter.
get_audit_user_identifier()
Return the actor identifier used for create/update audit fields.
get_request_auth()
Return the current request auth payload.
get_request_data(key=None, default=None)
Return request data, or one body value when key is provided.
get_request_param(key, default=None)
Return a query parameter or default_value.
get_request_string(key, default=None)
Return a query/body value as a string.
get_request_user()
Return the current authenticated request user.
get_request_value(key, default=None)
Return a request-body value or default_value.
partial_update(request, *args, **kwargs)
Apply a merge patch.
Raises:
| Type | Description |
|---|---|
UnsupportedMediaType
|
The media type is not
|
PreconditionRequired
|
A required |
MalformedPrecondition
|
|
VersionConflict
|
|
InvalidMergePatch
|
The body is not a JSON object (422). |
ValidationError
|
The merged document is invalid (422). |
perform_create(serializer)
Populate audit fields before DRF persists a new model instance.
perform_update(serializer)
Populate update audit fields before DRF persists an existing model instance.
prepare_create_data(validated_data)
Populate create audit fields on one validated serializer row.
prepare_update_data(validated_data)
Populate update audit fields on one validated serializer row.
retrieve(request, *args, **kwargs)
Return the instance, with an ETag when it is versioned.
Session authentication
rn_forge.django.auth.drf.session
Session authentication for DRF: the login session as a :class:~rn_forge.auth.Principal.
PrincipalSessionAuthentication
Bases: BaseAuthentication
Authenticate the login session into a mechanism="session" principal.
Subclass and set sessions, typically to sessions_for(config) of the
:class:~rn_forge.django.auth.routes.AuthRoutesConfig given to
auth_urlpatterns. request.auth is the session's
:class:~rn_forge.auth.SessionInfo. The read extends the idle timeout.
A request with an Authorization header is never authenticated here:
list a bearer class first and the header alone decides, so an invalid token
is a 401 even with a valid session cookie.
An unsafe method also passes the CSRF check of
:func:~rn_forge.django.auth.csrf.enforce_csrf; a failure is the 403
csrf-failed problem.
As the first authentication class of a view, an unauthenticated request is
a 401 problem with no WWW-Authenticate header, provided the view
uses :func:~rn_forge.django.drf.exceptions.problem_details_exception_handler.
A bearer class first keeps the Bearer challenge.
sessions_for(config)
A :class:Sessions with the same collaborators and timeouts as the routes of config.
Authorization
rn_forge.django.auth.drf.authorization
DRF permission and resource-policy hooks over :mod:rn_forge.auth.
PermissionKeyPermission
Bases: BasePermission
Require the permission key a view's action maps to.
The view declares permission_key and, optionally,
permission_action_map. The requirement is
:func:rn_forge.auth.requirement_for of the key and the view's action (the
HTTP method, lowercased, outside a viewset), checked against the request's
:class:~rn_forge.auth.Principal. A view without a permission_key
requires only an authenticated principal. A request without a principal is
denied.
ResourcePolicyViewMixin
Bases: GenericAPIView
Apply a :class:~rn_forge.auth.ResourcePolicy to a generic view.
:meth:get_queryset is narrowed by resource_policy.scope, so list
results, their counts and their pages contain only permitted rows, and a
detail lookup of any other row is a 404. :meth:get_object then asks
resource_policy.allows and raises 403 when it is denied, or 404
when policy_hides_existence is true.
Attributes:
| Name | Type | Description |
|---|---|---|
resource_policy |
ResourcePolicy[Any, QuerySet[Any]]
|
The policy. Required. |
policy_hides_existence |
bool
|
Report a denied object as |
Urls
rn_forge.django.auth.urls
Auth URLconf for reusable rn-forge Django auth views.