enterprise: add full audit log [AUTH-458] by BeryJu · Pull Request #8177 · goauthentik/authentik

BeryJu · 2024-01-15T16:39:36Z

Details

Audit logging that shows which fields were changed

needs:

Testing
more sanitization
potentially replacing deepdiff with a simpler diff
Some way to ignore certain model fields being changed (last_login and password on user for example since they have dedicated events (login and password_set))

Checklist

Local tests pass (ak test authentik/)
The code has been formatted (make lint-fix)

If an API change has been made

The API schema has been updated (make gen-build)

If changes to the frontend have been made

The code has been formatted (make web)
The translation files have been updated (make i18n-extract)

If applicable

The documentation has been updated
The documentation has been formatted (make website)

notion-workspace · 2024-01-15T16:39:40Z

Full audit logging

netlify · 2024-01-15T16:39:41Z

✅ Deploy Preview for authentik-storybook canceled.

Name	Link
🔨 Latest commit	`a3a2f4c`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/65b014f80794740007b85a23

codecov · 2024-01-15T16:52:02Z

Codecov Report

Attention: 7 lines in your changes are missing coverage. Please review.

Comparison is base (862aece) 92.32% compared to head (a3a2f4c) 92.31%.
Report is 5 commits behind head on main.

Files	Patch %	Lines
authentik/enterprise/audit/middleware.py	92.59%	6 Missing ⚠️
authentik/root/settings.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8177      +/-   ##
==========================================
- Coverage   92.32%   92.31%   -0.01%     
==========================================
  Files         625      626       +1     
  Lines       30832    30916      +84     
==========================================
+ Hits        28465    28541      +76     
- Misses       2367     2375       +8

Flag	Coverage Δ
e2e	`50.63% <88.78%> (+0.09%)`	⬆️
integration	`26.16% <4.67%> (-0.07%)`	⬇️
unit	`89.59% <92.52%> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

netlify · 2024-01-16T10:44:35Z

✅ Deploy Preview for authentik ready!

Name	Link
🔨 Latest commit	`ba4fc73`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik/deploys/65afe593b614bd00088485de
😎 Deploy Preview	https://deploy-preview-8177--authentik.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

authentik/policies/tests/test_process.py

github-actions · 2024-01-16T23:14:55Z

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-enterprise-events-audit-log-1706040553-a3a2f4c
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

For arm64, use these values:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-enterprise-events-audit-log-1706040553-a3a2f4c-arm64
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
image:
    repository: ghcr.io/goauthentik/dev-server
    tag: gh-enterprise-events-audit-log-1706040553-a3a2f4c

For arm64, use these values:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
image:
    repository: ghcr.io/goauthentik/dev-server
    tag: gh-enterprise-events-audit-log-1706040553-a3a2f4c-arm64

Afterwards, run the upgrade commands from the latest release notes.

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

authentik/enterprise/apps.py

authentik/enterprise/audit/apps.py

authentik/enterprise/apps.py

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* main: (109 commits) translate: Updates for file web/xliff/en.xlf in fr (#8296) translate: Updates for file locale/en/LC_MESSAGES/django.po in fr (#8295) website: update wording (#8290) enterrpise: exclude inactive users from license (#8294) web: bump API Client version (#8292) core: compile backend translations (#8291) events: migrate SystemTasks to DB (#8159) web/admin: fix footer links not being parsed on settings page (#8289) root: fix system check warnings (#8277) web: bump API Client version (#8288) enterprise: add full audit log [AUTH-458] (#8177) web: bump the esbuild group in /web with 2 updates (#8282) web: bump the sentry group in /web with 1 update (#8281) web: bump @codemirror/lang-html from 6.4.7 to 6.4.8 in /web (#8283) core: bump bandit from 1.7.6 to 1.7.7 (#8285) core: bump selenium from 4.16.0 to 4.17.2 (#8284) core: bump github.com/go-openapi/runtime from 0.26.2 to 0.27.0 (#8287) core: bump github.com/google/uuid from 1.5.0 to 1.6.0 (#8286) website/docs: Improve example nginx reverse proxy config (#8160) translate: Updates for file web/xliff/en.xlf in zh_CN (#8274) ...

* main: (76 commits) core: compile backend translations (#8311) translate: Updates for file web/xliff/en.xlf in zh-Hans (#8304) translate: Updates for file web/xliff/en.xlf in zh_CN (#8305) translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#8300) translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#8301) events: fix missing labels on prometheus metrics (#8309) core: bump goauthentik.io/api/v3 from 3.2023106.4 to 3.2023106.5 (#8302) web: bump the wdio group in /tests/wdio with 4 updates (#8303) web: restore test anchor tag (#8298) translate: Updates for file web/xliff/en.xlf in fr (#8296) translate: Updates for file locale/en/LC_MESSAGES/django.po in fr (#8295) website: update wording (#8290) enterrpise: exclude inactive users from license (#8294) web: bump API Client version (#8292) core: compile backend translations (#8291) events: migrate SystemTasks to DB (#8159) web/admin: fix footer links not being parsed on settings page (#8289) root: fix system check warnings (#8277) web: bump API Client version (#8288) enterprise: add full audit log [AUTH-458] (#8177) ...

BeryJu requested review from a team as code owners January 15, 2024 16:39

github-advanced-security bot found potential problems Jan 16, 2024

View reviewed changes

authentik/policies/tests/test_process.py Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Jan 16, 2024

View reviewed changes

authentik/policies/tests/test_process.py Fixed Show fixed Hide fixed

BeryJu force-pushed the enterprise/events/audit-log branch from 79c4c79 to b3d9acc Compare January 16, 2024 13:34

BeryJu requested a review from a team as a code owner January 16, 2024 16:35

rissson self-requested a review January 17, 2024 17:19

BeryJu added 18 commits January 23, 2024 17:10

enterprise: add full audit log

b8e2eab

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

delegate enabled check to apps

3f3957f

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

move audit middleware to separate app

162af83

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

cleanse before diff

c344f41

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

make cleanse include a hash of the values

06456bf

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

fix sentry error during lint

aa2a66a

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

format

e930d68

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

fix tests?

581d2fe

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

only use start of hash

0855010

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

don't use deepdiff

75ff7ff

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

add diff ui

2336944

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

fix info for dict

09ce29b

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

update release notes

b9bd670

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

enable audit logging for tests

db045c6

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

fix startup with tests

b02a344

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

lint

858d5a5

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

include first 4 chars of raw value?

da5b151

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

only log asterisks

ba4fc73

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

BeryJu force-pushed the enterprise/events/audit-log branch from 27e4496 to ba4fc73 Compare January 23, 2024 16:13

rissson requested changes Jan 23, 2024

View reviewed changes

authentik/enterprise/apps.py Outdated Show resolved Hide resolved

authentik/enterprise/audit/apps.py Outdated Show resolved Hide resolved

authentik/enterprise/audit/apps.py Show resolved Hide resolved

authentik/enterprise/apps.py Show resolved Hide resolved

fixup

8d8d54a

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

BeryJu requested a review from rissson January 23, 2024 17:18

fix tests

a3a2f4c

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

rissson approved these changes Jan 24, 2024

View reviewed changes

BeryJu merged commit 4184f8a into main Jan 24, 2024

BeryJu deleted the enterprise/events/audit-log branch January 24, 2024 10:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

enterprise: add full audit log [AUTH-458]#8177

enterprise: add full audit log [AUTH-458]#8177
BeryJu merged 20 commits intomainfrom
enterprise/events/audit-log

BeryJu commented Jan 15, 2024 •

edited

Loading

Uh oh!

notion-workspace bot commented Jan 15, 2024

Uh oh!

netlify bot commented Jan 15, 2024 •

edited

Loading

Uh oh!

codecov bot commented Jan 15, 2024 •

edited

Loading

Uh oh!

netlify bot commented Jan 16, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 16, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

BeryJu commented Jan 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Checklist

Uh oh!

notion-workspace bot commented Jan 15, 2024

Uh oh!

netlify bot commented Jan 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-storybook canceled.

Uh oh!

codecov bot commented Jan 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

netlify bot commented Jan 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik ready!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

BeryJu commented Jan 15, 2024 •

edited

Loading

netlify bot commented Jan 15, 2024 •

edited

Loading

codecov bot commented Jan 15, 2024 •

edited

Loading

netlify bot commented Jan 16, 2024 •

edited

Loading

github-actions bot commented Jan 16, 2024 •

edited

Loading