Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DRAFT] ✨ Log extra JWT claims in AuditTrail #189

Draft
wants to merge 1 commit into
base: stable/1.1.x
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions vng_api_common/audittrails/migrations/0015_auto_20220111_1523.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Generated by Django 2.2.25 on 2022-01-11 15:23

import django.contrib.postgres.fields
from django.db import migrations, models

import vng_api_common.fields


class Migration(migrations.Migration):

dependencies = [
("audittrails", "0014_auto_20210323_1654"),
]

operations = [
migrations.AddField(
model_name="audittrail",
name="afdeling",
field=models.CharField(
blank=True,
help_text="De afdeling waartoe de gebruiker behoort.",
max_length=255,
verbose_name="afdeling",
),
),
migrations.AddField(
model_name="audittrail",
name="bedrijf",
field=models.CharField(
blank=True,
help_text="Bedrijf waartoe de gebruiker behoort.",
max_length=255,
verbose_name="bedrijf",
),
),
migrations.AddField(
model_name="audittrail",
name="kvk",
field=vng_api_common.fields.RSINField(
blank=True,
help_text="KVK nummer van het bedrijf waartoe de gebruiker behoort.",
max_length=9,
verbose_name="kvk nummer",
),
),
migrations.AddField(
model_name="audittrail",
name="rollen",
field=django.contrib.postgres.fields.ArrayField(
base_field=models.CharField(max_length=255),
default=list,
help_text="Komma-gescheiden lijst van rollen van de gebruiker.",
size=None,
verbose_name="rollen",
),
),
]
27 changes: 26 additions & 1 deletion vng_api_common/audittrails/models.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
import uuid

from django.contrib.postgres.fields import JSONField
from django.contrib.postgres.fields import ArrayField, JSONField
from django.contrib.postgres.indexes import GinIndex
from django.core.serializers.json import DjangoJSONEncoder
from django.core.validators import MaxValueValidator, MinValueValidator
from django.db import models
from django.utils.translation import ugettext_lazy as _

from vng_api_common.fields import RSINField

from ..constants import ComponentTypes
from ..descriptors import GegevensGroepType

Expand Down Expand Up @@ -91,6 +93,29 @@ class AuditTrail(models.Model):
blank=True,
help_text=_("Toelichting waarom de handeling is uitgevoerd."),
)
rollen = ArrayField(
models.CharField(max_length=255),
default=list,
verbose_name=_("rollen"),
help_text=_("Komma-gescheiden lijst van rollen van de gebruiker."),
)
afdeling = models.CharField(
max_length=255,
blank=True,
verbose_name=_("afdeling"),
help_text=_("De afdeling waartoe de gebruiker behoort."),
)
bedrijf = models.CharField(
max_length=255,
blank=True,
verbose_name=_("bedrijf"),
help_text=_("Bedrijf waartoe de gebruiker behoort."),
)
kvk = RSINField(
blank=True,
verbose_name=_("kvk nummer"),
help_text=_("KVK nummer van het bedrijf waartoe de gebruiker behoort."),
)
wijzigingen = GegevensGroepType(
{"oud": oud, "nieuw": nieuw}, optional=["oud", "nieuw"], none_for_empty=True
)
Expand Down
8 changes: 8 additions & 0 deletions vng_api_common/audittrails/viewsets.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ def create_audittrail(

user_id = jwt_auth.payload.get("user_id") or ""
user_representation = jwt_auth.payload.get("user_representation") or ""
roles = jwt_auth.payload.get("roles") or []
department = jwt_auth.payload.get("department") or ""
company = jwt_auth.payload.get("company") or ""
kvk = jwt_auth.payload.get("kvk") or ""

toelichting = get_header(self.request, "X-Audit-Toelichting") or ""

Expand All @@ -78,6 +82,10 @@ def create_audittrail(
actie_weergave=CommonResourceAction.labels.get(action, ""),
gebruikers_id=user_id,
gebruikers_weergave=user_representation,
rollen=roles,
afdeling=department,
bedrijf=company,
kvk=kvk,
resultaat=status_code,
hoofd_object=main_object,
resource=self.basename,
Expand Down