mirror of
https://github.com/goauthentik/authentik
synced 2026-04-26 01:25:02 +02:00
Compare commits
236 Commits
admin/vers
...
playwright
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7614b8c608 | ||
|
|
99fa5ec7cc | ||
|
|
2800211dd0 | ||
|
|
2d5247f1bc | ||
|
|
2c2d7c38d2 | ||
|
|
d3963172cc | ||
|
|
08abe34b81 | ||
|
|
47263aef3f | ||
|
|
162934679d | ||
|
|
1903c35ee0 | ||
|
|
b97635f710 | ||
|
|
fd1f65eefc | ||
|
|
1e8eff4cb2 | ||
|
|
cfe113b36a | ||
|
|
90274b357a | ||
|
|
9848e4fbe0 | ||
|
|
a9deefe481 | ||
|
|
d29896cfe1 | ||
|
|
30670bb547 | ||
|
|
0f64471115 | ||
|
|
249b22963a | ||
|
|
b3a513273b | ||
|
|
7ca013d527 | ||
|
|
2e65e307fe | ||
|
|
0c07bad6f6 | ||
|
|
eb1c56dbeb | ||
|
|
766a294e55 | ||
|
|
db84a29ad7 | ||
|
|
58e65e4612 | ||
|
|
95b2d15476 | ||
|
|
2bdc5ef8b1 | ||
|
|
83cae926f7 | ||
|
|
213cf44928 | ||
|
|
3c97b081b0 | ||
|
|
ba725365ec | ||
|
|
e5e9708ec2 | ||
|
|
6a604e42ca | ||
|
|
ab1f87cfd6 | ||
|
|
de9b795c97 | ||
|
|
0377e3593e | ||
|
|
951c24dab5 | ||
|
|
707eca883e | ||
|
|
8bc64ea478 | ||
|
|
8b1240ff0b | ||
|
|
56ff8b1f97 | ||
|
|
cf26aace7b | ||
|
|
46021e904a | ||
|
|
a47196776d | ||
|
|
58ce20c840 | ||
|
|
29b0177235 | ||
|
|
f15ddfcccd | ||
|
|
7e4bdac093 | ||
|
|
5f16ea4718 | ||
|
|
d50a266d74 | ||
|
|
41ebfa24da | ||
|
|
8b7cc18988 | ||
|
|
e780b7d519 | ||
|
|
25894592ae | ||
|
|
5021d08c69 | ||
|
|
cb74b47674 | ||
|
|
aafd81ca09 | ||
|
|
a4f8e15f91 | ||
|
|
0c20169739 | ||
|
|
24ca89c439 | ||
|
|
0352d31af0 | ||
|
|
5bdbf06351 | ||
|
|
b3f1e7b1a2 | ||
|
|
2dfda8833d | ||
|
|
9094b30860 | ||
|
|
7e52e932fc | ||
|
|
b5fc28a3fd | ||
|
|
df49dd4ec8 | ||
|
|
3f4c58a05b | ||
|
|
46c9bfb0aa | ||
|
|
6d325d566c | ||
|
|
5689336f61 | ||
|
|
e04ca70cb2 | ||
|
|
6a5342f621 | ||
|
|
e250c8f514 | ||
|
|
a4e7aa0adc | ||
|
|
ac79acd2bc | ||
|
|
1aea4ad8d0 | ||
|
|
9591ea0bbc | ||
|
|
f5af58ac68 | ||
|
|
84a8e3128d | ||
|
|
747f80e60b | ||
|
|
c17e36e71c | ||
|
|
a299bae007 | ||
|
|
790ee2d16f | ||
|
|
7ebc585cde | ||
|
|
e5dfe3e64a | ||
|
|
0aeaa82b67 | ||
|
|
a3b59bb178 | ||
|
|
47a5582b47 | ||
|
|
fe4bc7d067 | ||
|
|
c17c7891b0 | ||
|
|
1eabd8ebae | ||
|
|
a2c5a36d0a | ||
|
|
3741d91386 | ||
|
|
44716a3c1e | ||
|
|
074af4e7a8 | ||
|
|
e3c68c69cc | ||
|
|
6cb8a1c10e | ||
|
|
b775e3ff20 | ||
|
|
41416f4d16 | ||
|
|
b94b281fa4 | ||
|
|
832777d966 | ||
|
|
3c8bd93b3a | ||
|
|
6c09255118 | ||
|
|
2e4c645f7e | ||
|
|
29f20a4829 | ||
|
|
95d8cd4ea1 | ||
|
|
90fe8a1a22 | ||
|
|
3ae2831cbe | ||
|
|
199e317846 | ||
|
|
2093147f7f | ||
|
|
0bc72574ca | ||
|
|
f3960374ad | ||
|
|
4d23fac934 | ||
|
|
925ac2f7c7 | ||
|
|
480a14a066 | ||
|
|
d71f5a2969 | ||
|
|
ca75862dcb | ||
|
|
61c3c32fc0 | ||
|
|
c7e932c0f3 | ||
|
|
1a2afe6176 | ||
|
|
d7e914975b | ||
|
|
7d635f73eb | ||
|
|
4ea0b9608f | ||
|
|
c0e62d14cb | ||
|
|
b541f0fa1d | ||
|
|
4a933b814f | ||
|
|
236a6e0176 | ||
|
|
f00772faf1 | ||
|
|
068bd34392 | ||
|
|
4161a678b8 | ||
|
|
bafe8a5104 | ||
|
|
f4079a9e0d | ||
|
|
62a6101ecb | ||
|
|
0820e34301 | ||
|
|
25ee8b8b5f | ||
|
|
c876b28fff | ||
|
|
7b3b9901a0 | ||
|
|
6c56d612cf | ||
|
|
cc11daa7fa | ||
|
|
6ea8eb84a2 | ||
|
|
c21e920a3f | ||
|
|
872704c2ab | ||
|
|
05a6238741 | ||
|
|
8a125d5ee8 | ||
|
|
902d1dd9a1 | ||
|
|
87ab3ed8a4 | ||
|
|
ae7261b75e | ||
|
|
0d60b2830c | ||
|
|
8766191d67 | ||
|
|
df3ae0d1da | ||
|
|
e280159946 | ||
|
|
35de683959 | ||
|
|
7d82fb7069 | ||
|
|
06d4f17743 | ||
|
|
9153cfe83c | ||
|
|
709cf785a9 | ||
|
|
db70211754 | ||
|
|
31510bb276 | ||
|
|
4bc6ba3dbe | ||
|
|
125af7daf5 | ||
|
|
130d0235d4 | ||
|
|
6ba97cba5a | ||
|
|
7aac9dea53 | ||
|
|
3f41588dc9 | ||
|
|
9caf08637e | ||
|
|
3f2f5ba31a | ||
|
|
ca48a6de48 | ||
|
|
6c951efd61 | ||
|
|
6b5da70673 | ||
|
|
32501266d5 | ||
|
|
5d6a2d27eb | ||
|
|
7b8426b292 | ||
|
|
fd8d5952d5 | ||
|
|
bb1e16a3f8 | ||
|
|
09a4f2c9b6 | ||
|
|
ac2873e6f4 | ||
|
|
6d68844270 | ||
|
|
2a65579182 | ||
|
|
11203f79d1 | ||
|
|
b670362168 | ||
|
|
24ae1c8b03 | ||
|
|
7a4c6b9b50 | ||
|
|
f1684882c5 | ||
|
|
615cb4f9fb | ||
|
|
bbfee74cd2 | ||
|
|
af2885ab12 | ||
|
|
29799e95ce | ||
|
|
b6568f322b | ||
|
|
d9bad736b5 | ||
|
|
1d57307891 | ||
|
|
be27635788 | ||
|
|
8373072654 | ||
|
|
b6c05f6852 | ||
|
|
26766360d5 | ||
|
|
9d7c733024 | ||
|
|
caecf5961d | ||
|
|
4b211190b6 | ||
|
|
2f22012f0f | ||
|
|
10dffd8d13 | ||
|
|
21a73fe58c | ||
|
|
b0b915061e | ||
|
|
6bcb758daa | ||
|
|
b051c59ec4 | ||
|
|
35df455e3a | ||
|
|
eb19e53bf3 | ||
|
|
3badf80295 | ||
|
|
b038e479e2 | ||
|
|
faaf4842a5 | ||
|
|
89ef57c68d | ||
|
|
c3515299d1 | ||
|
|
f8ff48fed9 | ||
|
|
dcf40690e9 | ||
|
|
4b37829f67 | ||
|
|
bf050e19b0 | ||
|
|
8eedfe5c4e | ||
|
|
33f83bec46 | ||
|
|
b93a450b38 | ||
|
|
6c169ce6a6 | ||
|
|
d53bb73c91 | ||
|
|
a182d7671e | ||
|
|
9941cec71f | ||
|
|
458344638f | ||
|
|
11ffd672ca | ||
|
|
4ebbf5b097 | ||
|
|
1bf5688ec6 | ||
|
|
9f1e6b3ba4 | ||
|
|
93ec4b3c17 | ||
|
|
477fc11148 | ||
|
|
4265e7b0af | ||
|
|
41df11d5dc |
@@ -1,5 +1,5 @@
|
|||||||
[bumpversion]
|
[bumpversion]
|
||||||
current_version = 2025.6.3
|
current_version = 2025.6.4
|
||||||
tag = True
|
tag = True
|
||||||
commit = True
|
commit = True
|
||||||
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<rc_t>[a-zA-Z-]+)(?P<rc_n>[1-9]\\d*))?
|
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<rc_t>[a-zA-Z-]+)(?P<rc_n>[1-9]\\d*))?
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
|
|||||||
GITHUB_OUTPUT=/dev/stdout \
|
GITHUB_OUTPUT=/dev/stdout \
|
||||||
GITHUB_REF=ref \
|
GITHUB_REF=ref \
|
||||||
GITHUB_SHA=sha \
|
GITHUB_SHA=sha \
|
||||||
IMAGE_NAME=ghcr.io/goauthentik/server,beryju/authentik \
|
IMAGE_NAME=ghcr.io/goauthentik/server,authentik/server \
|
||||||
GITHUB_REPOSITORY=goauthentik/authentik \
|
GITHUB_REPOSITORY=goauthentik/authentik \
|
||||||
python $SCRIPT_DIR/push_vars.py
|
python $SCRIPT_DIR/push_vars.py
|
||||||
|
|
||||||
@@ -12,7 +12,7 @@ GITHUB_OUTPUT=/dev/stdout \
|
|||||||
GITHUB_OUTPUT=/dev/stdout \
|
GITHUB_OUTPUT=/dev/stdout \
|
||||||
GITHUB_REF=ref \
|
GITHUB_REF=ref \
|
||||||
GITHUB_SHA=sha \
|
GITHUB_SHA=sha \
|
||||||
IMAGE_NAME=ghcr.io/goauthentik/server,beryju/authentik \
|
IMAGE_NAME=ghcr.io/goauthentik/server,authentik/server \
|
||||||
GITHUB_REPOSITORY=goauthentik/authentik \
|
GITHUB_REPOSITORY=goauthentik/authentik \
|
||||||
DOCKER_USERNAME=foo \
|
DOCKER_USERNAME=foo \
|
||||||
python $SCRIPT_DIR/push_vars.py
|
python $SCRIPT_DIR/push_vars.py
|
||||||
|
|||||||
94
.github/workflows/ci-api-docs.yml
vendored
Normal file
94
.github/workflows/ci-api-docs.yml
vendored
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
name: authentik-ci-api-docs
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
- next
|
||||||
|
- version-*
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
- version-*
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
command:
|
||||||
|
- prettier-check
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Install Dependencies
|
||||||
|
working-directory: website/
|
||||||
|
run: npm ci
|
||||||
|
- name: Lint
|
||||||
|
working-directory: website/
|
||||||
|
run: npm run ${{ matrix.command }}
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: website/package.json
|
||||||
|
cache: "npm"
|
||||||
|
cache-dependency-path: website/package-lock.json
|
||||||
|
- working-directory: website/
|
||||||
|
name: Install Dependencies
|
||||||
|
run: npm ci
|
||||||
|
- uses: actions/cache@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
${{ github.workspace }}/website/api/.docusaurus
|
||||||
|
${{ github.workspace }}/website/api/**/.cache
|
||||||
|
key: |
|
||||||
|
${{ runner.os }}-docusaurus-${{ hashFiles('**/package-lock.json') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-docusaurus-${{ hashFiles('**/package-lock.json') }}
|
||||||
|
- name: Build API Docs via Docusaurus
|
||||||
|
working-directory: website
|
||||||
|
env:
|
||||||
|
NODE_ENV: production
|
||||||
|
run: npm run build -w api
|
||||||
|
- uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: api-docs
|
||||||
|
path: website/api/build
|
||||||
|
retention-days: 7
|
||||||
|
deploy:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs:
|
||||||
|
- lint
|
||||||
|
- build
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/download-artifact@v5
|
||||||
|
with:
|
||||||
|
name: api-docs
|
||||||
|
path: website/api/build
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: website/package.json
|
||||||
|
cache: "npm"
|
||||||
|
cache-dependency-path: website/package-lock.json
|
||||||
|
- name: Deploy Netlify (Production)
|
||||||
|
working-directory: website/api
|
||||||
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||||
|
env:
|
||||||
|
NETLIFY_SITE_ID: authentik-api-docs.netlify.app
|
||||||
|
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
||||||
|
run: npx netlify deploy --no-build --prod
|
||||||
|
- name: Deploy Netlify (Preview)
|
||||||
|
if: github.event_name == 'pull_request' || github.ref != 'refs/heads/main'
|
||||||
|
working-directory: website/api
|
||||||
|
env:
|
||||||
|
NETLIFY_SITE_ID: authentik-api-docs.netlify.app
|
||||||
|
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
||||||
|
run: |
|
||||||
|
if [ -n "${VAR}" ]; then
|
||||||
|
npx netlify deploy --no-build --alias=deploy-preview-${{ github.event.number }}
|
||||||
|
fi
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
name: authentik-ci-website
|
name: authentik-ci-docs
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
@@ -18,17 +18,18 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
command:
|
command:
|
||||||
- lint:lockfile
|
|
||||||
- prettier-check
|
- prettier-check
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- working-directory: website/
|
- name: Install dependencies
|
||||||
|
working-directory: website/
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- name: Lint
|
- name: Lint
|
||||||
working-directory: website/
|
working-directory: website/
|
||||||
run: npm run ${{ matrix.command }}
|
run: npm run ${{ matrix.command }}
|
||||||
test:
|
build-docs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v4
|
||||||
@@ -37,19 +38,14 @@ jobs:
|
|||||||
cache: "npm"
|
cache: "npm"
|
||||||
cache-dependency-path: website/package-lock.json
|
cache-dependency-path: website/package-lock.json
|
||||||
- working-directory: website/
|
- working-directory: website/
|
||||||
|
name: Install Dependencies
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- name: test
|
- name: Build Documentation via Docusaurus
|
||||||
working-directory: website/
|
working-directory: website/
|
||||||
run: npm test
|
run: npm run build
|
||||||
build:
|
build-integrations:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
name: ${{ matrix.job }}
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
job:
|
|
||||||
- build
|
|
||||||
- build:integrations
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v4
|
||||||
@@ -58,10 +54,11 @@ jobs:
|
|||||||
cache: "npm"
|
cache: "npm"
|
||||||
cache-dependency-path: website/package-lock.json
|
cache-dependency-path: website/package-lock.json
|
||||||
- working-directory: website/
|
- working-directory: website/
|
||||||
|
name: Install Dependencies
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- name: build
|
- name: Build Integrations via Docusaurus
|
||||||
working-directory: website/
|
working-directory: website/
|
||||||
run: npm run ${{ matrix.job }}
|
run: npm run build -w integrations
|
||||||
build-container:
|
build-container:
|
||||||
if: ${{ github.repository != 'goauthentik/authentik-internal' }}
|
if: ${{ github.repository != 'goauthentik/authentik-internal' }}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -115,8 +112,8 @@ jobs:
|
|||||||
if: always()
|
if: always()
|
||||||
needs:
|
needs:
|
||||||
- lint
|
- lint
|
||||||
- test
|
- build-docs
|
||||||
- build
|
- build-integrations
|
||||||
- build-container
|
- build-container
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
14
.github/workflows/release-publish.yml
vendored
14
.github/workflows/release-publish.yml
vendored
@@ -16,7 +16,7 @@ jobs:
|
|||||||
id-token: write
|
id-token: write
|
||||||
attestations: write
|
attestations: write
|
||||||
with:
|
with:
|
||||||
image_name: ghcr.io/goauthentik/server,beryju/authentik
|
image_name: ghcr.io/goauthentik/server,authentik/server
|
||||||
release: true
|
release: true
|
||||||
registry_dockerhub: true
|
registry_dockerhub: true
|
||||||
registry_ghcr: true
|
registry_ghcr: true
|
||||||
@@ -38,7 +38,7 @@ jobs:
|
|||||||
uses: ./.github/actions/docker-push-variables
|
uses: ./.github/actions/docker-push-variables
|
||||||
id: ev
|
id: ev
|
||||||
env:
|
env:
|
||||||
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
DOCKER_USERNAME: ${{ secrets.DOCKER_CORP_USERNAME }}
|
||||||
with:
|
with:
|
||||||
image-name: ghcr.io/goauthentik/docs
|
image-name: ghcr.io/goauthentik/docs
|
||||||
- name: Login to GitHub Container Registry
|
- name: Login to GitHub Container Registry
|
||||||
@@ -92,9 +92,9 @@ jobs:
|
|||||||
uses: ./.github/actions/docker-push-variables
|
uses: ./.github/actions/docker-push-variables
|
||||||
id: ev
|
id: ev
|
||||||
env:
|
env:
|
||||||
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
DOCKER_USERNAME: ${{ secrets.DOCKER_CORP_USERNAME }}
|
||||||
with:
|
with:
|
||||||
image-name: ghcr.io/goauthentik/${{ matrix.type }},beryju/authentik-${{ matrix.type }}
|
image-name: ghcr.io/goauthentik/${{ matrix.type }},authentik/${{ matrix.type }}
|
||||||
- name: make empty clients
|
- name: make empty clients
|
||||||
run: |
|
run: |
|
||||||
mkdir -p ./gen-ts-api
|
mkdir -p ./gen-ts-api
|
||||||
@@ -102,8 +102,8 @@ jobs:
|
|||||||
- name: Docker Login Registry
|
- name: Docker Login Registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@v3
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.DOCKER_USERNAME }}
|
username: ${{ secrets.DOCKER_CORP_USERNAME }}
|
||||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
password: ${{ secrets.DOCKER_CORP_PASSWORD }}
|
||||||
- name: Login to GitHub Container Registry
|
- name: Login to GitHub Container Registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@v3
|
||||||
with:
|
with:
|
||||||
@@ -220,7 +220,7 @@ jobs:
|
|||||||
uses: ./.github/actions/docker-push-variables
|
uses: ./.github/actions/docker-push-variables
|
||||||
id: ev
|
id: ev
|
||||||
env:
|
env:
|
||||||
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
DOCKER_USERNAME: ${{ secrets.DOCKER_CORP_USERNAME }}
|
||||||
with:
|
with:
|
||||||
image-name: ghcr.io/goauthentik/server
|
image-name: ghcr.io/goauthentik/server
|
||||||
- name: Get static files from docker image
|
- name: Get static files from docker image
|
||||||
|
|||||||
5
.gitignore
vendored
5
.gitignore
vendored
@@ -100,9 +100,6 @@ ipython_config.py
|
|||||||
# pyenv
|
# pyenv
|
||||||
.python-version
|
.python-version
|
||||||
|
|
||||||
# celery beat schedule file
|
|
||||||
celerybeat-schedule
|
|
||||||
|
|
||||||
# SageMath parsed files
|
# SageMath parsed files
|
||||||
*.sage.py
|
*.sage.py
|
||||||
|
|
||||||
@@ -166,8 +163,6 @@ dmypy.json
|
|||||||
|
|
||||||
# pyenv
|
# pyenv
|
||||||
|
|
||||||
# celery beat schedule file
|
|
||||||
|
|
||||||
# SageMath parsed files
|
# SageMath parsed files
|
||||||
|
|
||||||
# Environments
|
# Environments
|
||||||
|
|||||||
@@ -10,7 +10,8 @@ coverage
|
|||||||
dist
|
dist
|
||||||
out
|
out
|
||||||
.docusaurus
|
.docusaurus
|
||||||
website/docs/developer-docs/api/**/*
|
# TODO Replace after moving website to docs
|
||||||
|
website/api/reference
|
||||||
|
|
||||||
## Environment
|
## Environment
|
||||||
*.env
|
*.env
|
||||||
|
|||||||
11
.vscode/settings.json
vendored
11
.vscode/settings.json
vendored
@@ -7,7 +7,10 @@
|
|||||||
"!Enumerate sequence",
|
"!Enumerate sequence",
|
||||||
"!Env scalar",
|
"!Env scalar",
|
||||||
"!Env sequence",
|
"!Env sequence",
|
||||||
|
"!File scalar",
|
||||||
|
"!File sequence",
|
||||||
"!Find sequence",
|
"!Find sequence",
|
||||||
|
"!FindObject sequence",
|
||||||
"!Format sequence",
|
"!Format sequence",
|
||||||
"!If sequence",
|
"!If sequence",
|
||||||
"!Index scalar",
|
"!Index scalar",
|
||||||
@@ -31,6 +34,10 @@
|
|||||||
"ignoreCase": false
|
"ignoreCase": false
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"go.testFlags": ["-count=1"],
|
"go.testFlags": [
|
||||||
"github-actions.workflows.pinned.workflows": [".github/workflows/ci-main.yml"]
|
"-count=1"
|
||||||
|
],
|
||||||
|
"github-actions.workflows.pinned.workflows": [
|
||||||
|
".github/workflows/ci-main.yml"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
44
.vscode/tasks.json
vendored
44
.vscode/tasks.json
vendored
@@ -4,12 +4,7 @@
|
|||||||
{
|
{
|
||||||
"label": "authentik/core: make",
|
"label": "authentik/core: make",
|
||||||
"command": "uv",
|
"command": "uv",
|
||||||
"args": [
|
"args": ["run", "make", "lint-fix", "lint"],
|
||||||
"run",
|
|
||||||
"make",
|
|
||||||
"lint-fix",
|
|
||||||
"lint"
|
|
||||||
],
|
|
||||||
"presentation": {
|
"presentation": {
|
||||||
"panel": "new"
|
"panel": "new"
|
||||||
},
|
},
|
||||||
@@ -18,11 +13,7 @@
|
|||||||
{
|
{
|
||||||
"label": "authentik/core: run",
|
"label": "authentik/core: run",
|
||||||
"command": "uv",
|
"command": "uv",
|
||||||
"args": [
|
"args": ["run", "ak", "server"],
|
||||||
"run",
|
|
||||||
"ak",
|
|
||||||
"server"
|
|
||||||
],
|
|
||||||
"group": "build",
|
"group": "build",
|
||||||
"presentation": {
|
"presentation": {
|
||||||
"panel": "dedicated",
|
"panel": "dedicated",
|
||||||
@@ -32,17 +23,13 @@
|
|||||||
{
|
{
|
||||||
"label": "authentik/web: make",
|
"label": "authentik/web: make",
|
||||||
"command": "make",
|
"command": "make",
|
||||||
"args": [
|
"args": ["web"],
|
||||||
"web"
|
|
||||||
],
|
|
||||||
"group": "build"
|
"group": "build"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "authentik/web: watch",
|
"label": "authentik/web: watch",
|
||||||
"command": "make",
|
"command": "make",
|
||||||
"args": [
|
"args": ["web-watch"],
|
||||||
"web-watch"
|
|
||||||
],
|
|
||||||
"group": "build",
|
"group": "build",
|
||||||
"presentation": {
|
"presentation": {
|
||||||
"panel": "dedicated",
|
"panel": "dedicated",
|
||||||
@@ -52,26 +39,19 @@
|
|||||||
{
|
{
|
||||||
"label": "authentik: install",
|
"label": "authentik: install",
|
||||||
"command": "make",
|
"command": "make",
|
||||||
"args": [
|
"args": ["install", "-j4"],
|
||||||
"install",
|
|
||||||
"-j4"
|
|
||||||
],
|
|
||||||
"group": "build"
|
"group": "build"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "authentik/website: make",
|
"label": "authentik/docs: make",
|
||||||
"command": "make",
|
"command": "make",
|
||||||
"args": [
|
"args": ["docs"],
|
||||||
"website"
|
|
||||||
],
|
|
||||||
"group": "build"
|
"group": "build"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "authentik/website: watch",
|
"label": "authentik/docs: watch",
|
||||||
"command": "make",
|
"command": "make",
|
||||||
"args": [
|
"args": ["docs-watch"],
|
||||||
"website-watch"
|
|
||||||
],
|
|
||||||
"group": "build",
|
"group": "build",
|
||||||
"presentation": {
|
"presentation": {
|
||||||
"panel": "dedicated",
|
"panel": "dedicated",
|
||||||
@@ -81,11 +61,7 @@
|
|||||||
{
|
{
|
||||||
"label": "authentik/api: generate",
|
"label": "authentik/api: generate",
|
||||||
"command": "uv",
|
"command": "uv",
|
||||||
"args": [
|
"args": ["run", "make", "gen"],
|
||||||
"run",
|
|
||||||
"make",
|
|
||||||
"gen"
|
|
||||||
],
|
|
||||||
"group": "build"
|
"group": "build"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
72
CODEOWNERS
72
CODEOWNERS
@@ -1,39 +1,49 @@
|
|||||||
# Fallback
|
# Fallback
|
||||||
* @goauthentik/backend @goauthentik/frontend
|
* @goauthentik/backend @goauthentik/frontend
|
||||||
# Backend
|
# Backend
|
||||||
authentik/ @goauthentik/backend
|
authentik/ @goauthentik/backend
|
||||||
blueprints/ @goauthentik/backend
|
blueprints/ @goauthentik/backend
|
||||||
cmd/ @goauthentik/backend
|
cmd/ @goauthentik/backend
|
||||||
internal/ @goauthentik/backend
|
internal/ @goauthentik/backend
|
||||||
lifecycle/ @goauthentik/backend
|
lifecycle/ @goauthentik/backend
|
||||||
schemas/ @goauthentik/backend
|
schemas/ @goauthentik/backend
|
||||||
scripts/ @goauthentik/backend
|
scripts/ @goauthentik/backend
|
||||||
tests/ @goauthentik/backend
|
tests/ @goauthentik/backend
|
||||||
pyproject.toml @goauthentik/backend
|
pyproject.toml @goauthentik/backend
|
||||||
uv.lock @goauthentik/backend
|
uv.lock @goauthentik/backend
|
||||||
go.mod @goauthentik/backend
|
go.mod @goauthentik/backend
|
||||||
go.sum @goauthentik/backend
|
go.sum @goauthentik/backend
|
||||||
# Infrastructure
|
# Infrastructure
|
||||||
.github/ @goauthentik/infrastructure
|
.github/ @goauthentik/infrastructure
|
||||||
lifecycle/aws/ @goauthentik/infrastructure
|
lifecycle/aws/ @goauthentik/infrastructure
|
||||||
Dockerfile @goauthentik/infrastructure
|
Dockerfile @goauthentik/infrastructure
|
||||||
*Dockerfile @goauthentik/infrastructure
|
*Dockerfile @goauthentik/infrastructure
|
||||||
.dockerignore @goauthentik/infrastructure
|
.dockerignore @goauthentik/infrastructure
|
||||||
docker-compose.yml @goauthentik/infrastructure
|
docker-compose.yml @goauthentik/infrastructure
|
||||||
Makefile @goauthentik/infrastructure
|
Makefile @goauthentik/infrastructure
|
||||||
.editorconfig @goauthentik/infrastructure
|
.editorconfig @goauthentik/infrastructure
|
||||||
CODEOWNERS @goauthentik/infrastructure
|
CODEOWNERS @goauthentik/infrastructure
|
||||||
|
# Backend packages
|
||||||
|
packages/django-dramatiq-postgres @goauthentik/backend
|
||||||
# Web packages
|
# Web packages
|
||||||
packages/ @goauthentik/frontend
|
packages/docusaurus-config @goauthentik/frontend
|
||||||
|
packages/esbuild-plugin-live-reload @goauthentik/frontend
|
||||||
|
packages/eslint-config @goauthentik/frontend
|
||||||
|
packages/prettier-config @goauthentik/frontend
|
||||||
|
packages/tsconfig @goauthentik/frontend
|
||||||
# Web
|
# Web
|
||||||
web/ @goauthentik/frontend
|
web/ @goauthentik/frontend
|
||||||
tests/wdio/ @goauthentik/frontend
|
tests/wdio/ @goauthentik/frontend
|
||||||
# Locale
|
# Locale
|
||||||
locale/ @goauthentik/backend @goauthentik/frontend
|
locale/ @goauthentik/backend @goauthentik/frontend
|
||||||
web/xliff/ @goauthentik/backend @goauthentik/frontend
|
web/xliff/ @goauthentik/backend @goauthentik/frontend
|
||||||
# Docs & Website
|
# Docs & Website
|
||||||
website/ @goauthentik/docs
|
docs/ @goauthentik/docs
|
||||||
CODE_OF_CONDUCT.md @goauthentik/docs
|
# TODO Remove after moving website to docs
|
||||||
|
website/ @goauthentik/docs
|
||||||
|
CODE_OF_CONDUCT.md @goauthentik/docs
|
||||||
# Security
|
# Security
|
||||||
SECURITY.md @goauthentik/security @goauthentik/docs
|
SECURITY.md @goauthentik/security @goauthentik/docs
|
||||||
website/docs/security/ @goauthentik/security @goauthentik/docs
|
# TODO Remove after moving website to docs
|
||||||
|
website/security/ @goauthentik/security @goauthentik/docs
|
||||||
|
docs/security/ @goauthentik/security @goauthentik/docs
|
||||||
|
|||||||
22
Dockerfile
22
Dockerfile
@@ -14,10 +14,11 @@ RUN --mount=type=bind,target=/work/web/package.json,src=./web/package.json \
|
|||||||
--mount=type=bind,target=/work/web/packages/sfe/package.json,src=./web/packages/sfe/package.json \
|
--mount=type=bind,target=/work/web/packages/sfe/package.json,src=./web/packages/sfe/package.json \
|
||||||
--mount=type=bind,target=/work/web/scripts,src=./web/scripts \
|
--mount=type=bind,target=/work/web/scripts,src=./web/scripts \
|
||||||
--mount=type=cache,id=npm-ak,sharing=shared,target=/root/.npm \
|
--mount=type=cache,id=npm-ak,sharing=shared,target=/root/.npm \
|
||||||
npm ci --include=dev
|
npm ci
|
||||||
|
|
||||||
COPY ./package.json /work
|
COPY ./package.json /work
|
||||||
COPY ./web /work/web/
|
COPY ./web /work/web/
|
||||||
|
# TODO: Update this after moving website to docs
|
||||||
COPY ./website /work/website/
|
COPY ./website /work/website/
|
||||||
COPY ./gen-ts-api /work/web/node_modules/@goauthentik/api
|
COPY ./gen-ts-api /work/web/node_modules/@goauthentik/api
|
||||||
|
|
||||||
@@ -75,7 +76,7 @@ RUN --mount=type=secret,id=GEOIPUPDATE_ACCOUNT_ID \
|
|||||||
/bin/sh -c "GEOIPUPDATE_LICENSE_KEY_FILE=/run/secrets/GEOIPUPDATE_LICENSE_KEY /usr/bin/entry.sh || echo 'Failed to get GeoIP database, disabling'; exit 0"
|
/bin/sh -c "GEOIPUPDATE_LICENSE_KEY_FILE=/run/secrets/GEOIPUPDATE_LICENSE_KEY /usr/bin/entry.sh || echo 'Failed to get GeoIP database, disabling'; exit 0"
|
||||||
|
|
||||||
# Stage 4: Download uv
|
# Stage 4: Download uv
|
||||||
FROM ghcr.io/astral-sh/uv:0.7.21 AS uv
|
FROM ghcr.io/astral-sh/uv:0.8.5 AS uv
|
||||||
# Stage 5: Base python image
|
# Stage 5: Base python image
|
||||||
FROM ghcr.io/goauthentik/fips-python:3.13.5-slim-bookworm-fips AS python-base
|
FROM ghcr.io/goauthentik/fips-python:3.13.5-slim-bookworm-fips AS python-base
|
||||||
|
|
||||||
@@ -122,6 +123,7 @@ ENV UV_NO_BINARY_PACKAGE="cryptography lxml python-kadmin-rs xmlsec"
|
|||||||
|
|
||||||
RUN --mount=type=bind,target=pyproject.toml,src=pyproject.toml \
|
RUN --mount=type=bind,target=pyproject.toml,src=pyproject.toml \
|
||||||
--mount=type=bind,target=uv.lock,src=uv.lock \
|
--mount=type=bind,target=uv.lock,src=uv.lock \
|
||||||
|
--mount=type=bind,target=packages,src=packages \
|
||||||
--mount=type=cache,target=/root/.cache/uv \
|
--mount=type=cache,target=/root/.cache/uv \
|
||||||
uv sync --frozen --no-install-project --no-dev
|
uv sync --frozen --no-install-project --no-dev
|
||||||
|
|
||||||
@@ -132,11 +134,16 @@ ARG VERSION
|
|||||||
ARG GIT_BUILD_HASH
|
ARG GIT_BUILD_HASH
|
||||||
ENV GIT_BUILD_HASH=$GIT_BUILD_HASH
|
ENV GIT_BUILD_HASH=$GIT_BUILD_HASH
|
||||||
|
|
||||||
LABEL org.opencontainers.image.url=https://goauthentik.io
|
LABEL org.opencontainers.image.authors="Authentik Security Inc." \
|
||||||
LABEL org.opencontainers.image.description="goauthentik.io Main server image, see https://goauthentik.io for more info."
|
org.opencontainers.image.description="goauthentik.io Main server image, see https://goauthentik.io for more info." \
|
||||||
LABEL org.opencontainers.image.source=https://github.com/goauthentik/authentik
|
org.opencontainers.image.documentation="https://docs.goauthentik.io" \
|
||||||
LABEL org.opencontainers.image.version=${VERSION}
|
org.opencontainers.image.licenses="https://github.com/goauthentik/authentik/blob/main/LICENSE" \
|
||||||
LABEL org.opencontainers.image.revision=${GIT_BUILD_HASH}
|
org.opencontainers.image.revision=${GIT_BUILD_HASH} \
|
||||||
|
org.opencontainers.image.source="https://github.com/goauthentik/authentik" \
|
||||||
|
org.opencontainers.image.title="authentik server image" \
|
||||||
|
org.opencontainers.image.url="https://goauthentik.io" \
|
||||||
|
org.opencontainers.image.vendor="Authentik Security Inc." \
|
||||||
|
org.opencontainers.image.version=${VERSION}
|
||||||
|
|
||||||
WORKDIR /
|
WORKDIR /
|
||||||
|
|
||||||
@@ -167,6 +174,7 @@ COPY ./blueprints /blueprints
|
|||||||
COPY ./lifecycle/ /lifecycle
|
COPY ./lifecycle/ /lifecycle
|
||||||
COPY ./authentik/sources/kerberos/krb5.conf /etc/krb5.conf
|
COPY ./authentik/sources/kerberos/krb5.conf /etc/krb5.conf
|
||||||
COPY --from=go-builder /go/authentik /bin/authentik
|
COPY --from=go-builder /go/authentik /bin/authentik
|
||||||
|
COPY ./packages/ /ak-root/packages
|
||||||
COPY --from=python-deps /ak-root/.venv /ak-root/.venv
|
COPY --from=python-deps /ak-root/.venv /ak-root/.venv
|
||||||
COPY --from=node-builder /work/web/dist/ /web/dist/
|
COPY --from=node-builder /work/web/dist/ /web/dist/
|
||||||
COPY --from=node-builder /work/web/authentik/ /web/authentik/
|
COPY --from=node-builder /work/web/authentik/ /web/authentik/
|
||||||
|
|||||||
25
Makefile
25
Makefile
@@ -6,7 +6,7 @@ PWD = $(shell pwd)
|
|||||||
UID = $(shell id -u)
|
UID = $(shell id -u)
|
||||||
GID = $(shell id -g)
|
GID = $(shell id -g)
|
||||||
NPM_VERSION = $(shell python -m scripts.generate_semver)
|
NPM_VERSION = $(shell python -m scripts.generate_semver)
|
||||||
PY_SOURCES = authentik tests scripts lifecycle .github
|
PY_SOURCES = authentik packages tests scripts lifecycle .github
|
||||||
DOCKER_IMAGE ?= "authentik:test"
|
DOCKER_IMAGE ?= "authentik:test"
|
||||||
|
|
||||||
GEN_API_TS = gen-ts-api
|
GEN_API_TS = gen-ts-api
|
||||||
@@ -59,9 +59,12 @@ i18n-extract: core-i18n-extract web-i18n-extract ## Extract strings that requir
|
|||||||
aws-cfn:
|
aws-cfn:
|
||||||
cd lifecycle/aws && npm run aws-cfn
|
cd lifecycle/aws && npm run aws-cfn
|
||||||
|
|
||||||
run: ## Run the main authentik server process
|
run-server: ## Run the main authentik server process
|
||||||
uv run ak server
|
uv run ak server
|
||||||
|
|
||||||
|
run-worker: ## Run the main authentik worker process
|
||||||
|
uv run ak worker
|
||||||
|
|
||||||
core-i18n-extract:
|
core-i18n-extract:
|
||||||
uv run ak makemessages \
|
uv run ak makemessages \
|
||||||
--add-location file \
|
--add-location file \
|
||||||
@@ -121,7 +124,7 @@ gen-diff: ## (Release) generate the changelog diff between the current schema a
|
|||||||
sed -i 's/}/}/g' diff.md
|
sed -i 's/}/}/g' diff.md
|
||||||
npx prettier --write diff.md
|
npx prettier --write diff.md
|
||||||
|
|
||||||
gen-clean-ts: ## Remove generated API client for Typescript
|
gen-clean-ts: ## Remove generated API client for TypeScript
|
||||||
rm -rf ${PWD}/${GEN_API_TS}/
|
rm -rf ${PWD}/${GEN_API_TS}/
|
||||||
rm -rf ${PWD}/web/node_modules/@goauthentik/api/
|
rm -rf ${PWD}/web/node_modules/@goauthentik/api/
|
||||||
|
|
||||||
@@ -243,12 +246,24 @@ docs-build:
|
|||||||
docs-watch: ## Build and watch the topics documentation
|
docs-watch: ## Build and watch the topics documentation
|
||||||
npm run start --prefix website
|
npm run start --prefix website
|
||||||
|
|
||||||
docs-integrations-build:
|
integrations: docs-lint-fix integrations-build ## Fix formatting issues in the integrations source code, lint the code, and compile it
|
||||||
|
|
||||||
|
integrations-build:
|
||||||
npm run build --prefix website -w integrations
|
npm run build --prefix website -w integrations
|
||||||
|
|
||||||
docs-integrations-watch: ## Build and watch the Integrations documentation
|
integrations-watch: ## Build and watch the Integrations documentation
|
||||||
npm run start --prefix website -w integrations
|
npm run start --prefix website -w integrations
|
||||||
|
|
||||||
|
docs-api-build:
|
||||||
|
npm run build --prefix website -w api
|
||||||
|
|
||||||
|
docs-api-watch: ## Build and watch the API documentation
|
||||||
|
npm run build:api --prefix website -w api
|
||||||
|
npm run start --prefix website -w api
|
||||||
|
|
||||||
|
docs-api-clean: ## Clean generated API documentation
|
||||||
|
npm run build:api:clean --prefix website -w api
|
||||||
|
|
||||||
#########################
|
#########################
|
||||||
## Docker
|
## Docker
|
||||||
#########################
|
#########################
|
||||||
|
|||||||
@@ -9,8 +9,8 @@
|
|||||||
[](https://github.com/goauthentik/authentik/actions/workflows/ci-outpost.yml)
|
[](https://github.com/goauthentik/authentik/actions/workflows/ci-outpost.yml)
|
||||||
[](https://github.com/goauthentik/authentik/actions/workflows/ci-web.yml)
|
[](https://github.com/goauthentik/authentik/actions/workflows/ci-web.yml)
|
||||||
[](https://codecov.io/gh/goauthentik/authentik)
|
[](https://codecov.io/gh/goauthentik/authentik)
|
||||||

|

|
||||||

|

|
||||||
[](https://www.transifex.com/authentik/authentik/)
|
[](https://www.transifex.com/authentik/authentik/)
|
||||||
|
|
||||||
## What is authentik?
|
## What is authentik?
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
from os import environ
|
from os import environ
|
||||||
|
|
||||||
__version__ = "2025.6.3"
|
__version__ = "2025.6.4"
|
||||||
ENV_GIT_HASH_KEY = "GIT_BUILD_HASH"
|
ENV_GIT_HASH_KEY = "GIT_BUILD_HASH"
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ class VersionSerializer(PassiveSerializer):
|
|||||||
return __version__
|
return __version__
|
||||||
version_in_cache = cache.get(VERSION_CACHE_KEY)
|
version_in_cache = cache.get(VERSION_CACHE_KEY)
|
||||||
if not version_in_cache: # pragma: no cover
|
if not version_in_cache: # pragma: no cover
|
||||||
update_latest_version.delay()
|
update_latest_version.send()
|
||||||
return __version__
|
return __version__
|
||||||
return version_in_cache
|
return version_in_cache
|
||||||
|
|
||||||
|
|||||||
@@ -1,57 +0,0 @@
|
|||||||
"""authentik administration overview"""
|
|
||||||
|
|
||||||
from socket import gethostname
|
|
||||||
|
|
||||||
from django.conf import settings
|
|
||||||
from drf_spectacular.utils import extend_schema, inline_serializer
|
|
||||||
from packaging.version import parse
|
|
||||||
from rest_framework.fields import BooleanField, CharField
|
|
||||||
from rest_framework.request import Request
|
|
||||||
from rest_framework.response import Response
|
|
||||||
from rest_framework.views import APIView
|
|
||||||
|
|
||||||
from authentik import get_full_version
|
|
||||||
from authentik.rbac.permissions import HasPermission
|
|
||||||
from authentik.root.celery import CELERY_APP
|
|
||||||
|
|
||||||
|
|
||||||
class WorkerView(APIView):
|
|
||||||
"""Get currently connected worker count."""
|
|
||||||
|
|
||||||
permission_classes = [HasPermission("authentik_rbac.view_system_info")]
|
|
||||||
|
|
||||||
@extend_schema(
|
|
||||||
responses=inline_serializer(
|
|
||||||
"Worker",
|
|
||||||
fields={
|
|
||||||
"worker_id": CharField(),
|
|
||||||
"version": CharField(),
|
|
||||||
"version_matching": BooleanField(),
|
|
||||||
},
|
|
||||||
many=True,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
def get(self, request: Request) -> Response:
|
|
||||||
"""Get currently connected worker count."""
|
|
||||||
raw: list[dict[str, dict]] = CELERY_APP.control.ping(timeout=0.5)
|
|
||||||
our_version = parse(get_full_version())
|
|
||||||
response = []
|
|
||||||
for worker in raw:
|
|
||||||
key = list(worker.keys())[0]
|
|
||||||
version = worker[key].get("version")
|
|
||||||
version_matching = False
|
|
||||||
if version:
|
|
||||||
version_matching = parse(version) == our_version
|
|
||||||
response.append(
|
|
||||||
{"worker_id": key, "version": version, "version_matching": version_matching}
|
|
||||||
)
|
|
||||||
# In debug we run with `task_always_eager`, so tasks are ran on the main process
|
|
||||||
if settings.DEBUG: # pragma: no cover
|
|
||||||
response.append(
|
|
||||||
{
|
|
||||||
"worker_id": f"authentik-debug@{gethostname()}",
|
|
||||||
"version": get_full_version(),
|
|
||||||
"version_matching": True,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
return Response(response)
|
|
||||||
@@ -3,6 +3,9 @@
|
|||||||
from prometheus_client import Info
|
from prometheus_client import Info
|
||||||
|
|
||||||
from authentik.blueprints.apps import ManagedAppConfig
|
from authentik.blueprints.apps import ManagedAppConfig
|
||||||
|
from authentik.lib.config import CONFIG
|
||||||
|
from authentik.lib.utils.time import fqdn_rand
|
||||||
|
from authentik.tasks.schedules.common import ScheduleSpec
|
||||||
|
|
||||||
PROM_INFO = Info("authentik_version", "Currently running authentik version")
|
PROM_INFO = Info("authentik_version", "Currently running authentik version")
|
||||||
|
|
||||||
@@ -30,3 +33,15 @@ class AuthentikAdminConfig(ManagedAppConfig):
|
|||||||
notification_version = notification.event.context["new_version"]
|
notification_version = notification.event.context["new_version"]
|
||||||
if LOCAL_VERSION >= parse(notification_version):
|
if LOCAL_VERSION >= parse(notification_version):
|
||||||
notification.delete()
|
notification.delete()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def global_schedule_specs(self) -> list[ScheduleSpec]:
|
||||||
|
from authentik.admin.tasks import update_latest_version
|
||||||
|
|
||||||
|
return [
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=update_latest_version,
|
||||||
|
crontab=f"{fqdn_rand('admin_latest_version')} * * * *",
|
||||||
|
paused=CONFIG.get_bool("disable_update_check"),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|||||||
@@ -1,15 +0,0 @@
|
|||||||
"""authentik admin settings"""
|
|
||||||
|
|
||||||
from celery.schedules import crontab
|
|
||||||
from django_tenants.utils import get_public_schema_name
|
|
||||||
|
|
||||||
from authentik.lib.utils.time import fqdn_rand
|
|
||||||
|
|
||||||
CELERY_BEAT_SCHEDULE = {
|
|
||||||
"admin_latest_version": {
|
|
||||||
"task": "authentik.admin.tasks.update_latest_version",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("admin_latest_version"), hour="*"),
|
|
||||||
"tenant_schemas": [get_public_schema_name()],
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
"""admin signals"""
|
|
||||||
|
|
||||||
from django.dispatch import receiver
|
|
||||||
from packaging.version import parse
|
|
||||||
from prometheus_client import Gauge
|
|
||||||
|
|
||||||
from authentik import get_full_version
|
|
||||||
from authentik.root.celery import CELERY_APP
|
|
||||||
from authentik.root.monitoring import monitoring_set
|
|
||||||
|
|
||||||
GAUGE_WORKERS = Gauge(
|
|
||||||
"authentik_admin_workers",
|
|
||||||
"Currently connected workers, their versions and if they are the same version as authentik",
|
|
||||||
["version", "version_matched"],
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
_version = parse(get_full_version())
|
|
||||||
|
|
||||||
|
|
||||||
@receiver(monitoring_set)
|
|
||||||
def monitoring_set_workers(sender, **kwargs):
|
|
||||||
"""Set worker gauge"""
|
|
||||||
raw: list[dict[str, dict]] = CELERY_APP.control.ping(timeout=0.5)
|
|
||||||
worker_version_count = {}
|
|
||||||
for worker in raw:
|
|
||||||
key = list(worker.keys())[0]
|
|
||||||
version = worker[key].get("version")
|
|
||||||
version_matching = False
|
|
||||||
if version:
|
|
||||||
version_matching = parse(version) == _version
|
|
||||||
worker_version_count.setdefault(version, {"count": 0, "matching": version_matching})
|
|
||||||
worker_version_count[version]["count"] += 1
|
|
||||||
for version, stats in worker_version_count.items():
|
|
||||||
GAUGE_WORKERS.labels(version, stats["matching"]).set(stats["count"])
|
|
||||||
@@ -2,6 +2,8 @@
|
|||||||
|
|
||||||
from django.core.cache import cache
|
from django.core.cache import cache
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from django_dramatiq_postgres.middleware import CurrentTask
|
||||||
|
from dramatiq import actor
|
||||||
from packaging.version import parse
|
from packaging.version import parse
|
||||||
from requests import RequestException
|
from requests import RequestException
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
@@ -9,10 +11,9 @@ from structlog.stdlib import get_logger
|
|||||||
from authentik import __version__, get_build_hash
|
from authentik import __version__, get_build_hash
|
||||||
from authentik.admin.apps import PROM_INFO
|
from authentik.admin.apps import PROM_INFO
|
||||||
from authentik.events.models import Event, EventAction
|
from authentik.events.models import Event, EventAction
|
||||||
from authentik.events.system_tasks import SystemTask, TaskStatus, prefill_task
|
|
||||||
from authentik.lib.config import CONFIG
|
from authentik.lib.config import CONFIG
|
||||||
from authentik.lib.utils.http import get_http_session
|
from authentik.lib.utils.http import get_http_session
|
||||||
from authentik.root.celery import CELERY_APP
|
from authentik.tasks.models import Task
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
VERSION_NULL = "0.0.0"
|
VERSION_NULL = "0.0.0"
|
||||||
@@ -32,13 +33,12 @@ def _set_prom_info():
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(bind=True, base=SystemTask)
|
@actor(description=_("Update latest version info."))
|
||||||
@prefill_task
|
def update_latest_version():
|
||||||
def update_latest_version(self: SystemTask):
|
self: Task = CurrentTask.get_task()
|
||||||
"""Update latest version info"""
|
|
||||||
if CONFIG.get_bool("disable_update_check"):
|
if CONFIG.get_bool("disable_update_check"):
|
||||||
cache.set(VERSION_CACHE_KEY, VERSION_NULL, VERSION_CACHE_TIMEOUT)
|
cache.set(VERSION_CACHE_KEY, VERSION_NULL, VERSION_CACHE_TIMEOUT)
|
||||||
self.set_status(TaskStatus.WARNING, "Version check disabled.")
|
self.info("Version check disabled.")
|
||||||
return
|
return
|
||||||
try:
|
try:
|
||||||
response = get_http_session().get(
|
response = get_http_session().get(
|
||||||
@@ -48,7 +48,7 @@ def update_latest_version(self: SystemTask):
|
|||||||
data = response.json()
|
data = response.json()
|
||||||
upstream_version = data.get("stable", {}).get("version")
|
upstream_version = data.get("stable", {}).get("version")
|
||||||
cache.set(VERSION_CACHE_KEY, upstream_version, VERSION_CACHE_TIMEOUT)
|
cache.set(VERSION_CACHE_KEY, upstream_version, VERSION_CACHE_TIMEOUT)
|
||||||
self.set_status(TaskStatus.SUCCESSFUL, "Successfully updated latest Version")
|
self.info("Successfully updated latest Version")
|
||||||
_set_prom_info()
|
_set_prom_info()
|
||||||
# Check if upstream version is newer than what we're running,
|
# Check if upstream version is newer than what we're running,
|
||||||
# and if no event exists yet, create one.
|
# and if no event exists yet, create one.
|
||||||
@@ -71,7 +71,7 @@ def update_latest_version(self: SystemTask):
|
|||||||
).save()
|
).save()
|
||||||
except (RequestException, IndexError) as exc:
|
except (RequestException, IndexError) as exc:
|
||||||
cache.set(VERSION_CACHE_KEY, VERSION_NULL, VERSION_CACHE_TIMEOUT)
|
cache.set(VERSION_CACHE_KEY, VERSION_NULL, VERSION_CACHE_TIMEOUT)
|
||||||
self.set_error(exc)
|
raise exc
|
||||||
|
|
||||||
|
|
||||||
_set_prom_info()
|
_set_prom_info()
|
||||||
|
|||||||
@@ -29,13 +29,6 @@ class TestAdminAPI(TestCase):
|
|||||||
body = loads(response.content)
|
body = loads(response.content)
|
||||||
self.assertEqual(body["version_current"], __version__)
|
self.assertEqual(body["version_current"], __version__)
|
||||||
|
|
||||||
def test_workers(self):
|
|
||||||
"""Test Workers API"""
|
|
||||||
response = self.client.get(reverse("authentik_api:admin_workers"))
|
|
||||||
self.assertEqual(response.status_code, 200)
|
|
||||||
body = loads(response.content)
|
|
||||||
self.assertEqual(len(body), 0)
|
|
||||||
|
|
||||||
def test_apps(self):
|
def test_apps(self):
|
||||||
"""Test apps API"""
|
"""Test apps API"""
|
||||||
response = self.client.get(reverse("authentik_api:apps-list"))
|
response = self.client.get(reverse("authentik_api:apps-list"))
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ class TestAdminTasks(TestCase):
|
|||||||
"""Test Update checker with valid response"""
|
"""Test Update checker with valid response"""
|
||||||
with Mocker() as mocker, CONFIG.patch("disable_update_check", False):
|
with Mocker() as mocker, CONFIG.patch("disable_update_check", False):
|
||||||
mocker.get("https://version.goauthentik.io/version.json", json=RESPONSE_VALID)
|
mocker.get("https://version.goauthentik.io/version.json", json=RESPONSE_VALID)
|
||||||
update_latest_version.delay().get()
|
update_latest_version.send()
|
||||||
self.assertEqual(cache.get(VERSION_CACHE_KEY), "99999999.9999999")
|
self.assertEqual(cache.get(VERSION_CACHE_KEY), "99999999.9999999")
|
||||||
self.assertTrue(
|
self.assertTrue(
|
||||||
Event.objects.filter(
|
Event.objects.filter(
|
||||||
@@ -40,7 +40,7 @@ class TestAdminTasks(TestCase):
|
|||||||
).exists()
|
).exists()
|
||||||
)
|
)
|
||||||
# test that a consecutive check doesn't create a duplicate event
|
# test that a consecutive check doesn't create a duplicate event
|
||||||
update_latest_version.delay().get()
|
update_latest_version.send()
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
len(
|
len(
|
||||||
Event.objects.filter(
|
Event.objects.filter(
|
||||||
@@ -56,7 +56,7 @@ class TestAdminTasks(TestCase):
|
|||||||
"""Test Update checker with invalid response"""
|
"""Test Update checker with invalid response"""
|
||||||
with Mocker() as mocker:
|
with Mocker() as mocker:
|
||||||
mocker.get("https://version.goauthentik.io/version.json", status_code=400)
|
mocker.get("https://version.goauthentik.io/version.json", status_code=400)
|
||||||
update_latest_version.delay().get()
|
update_latest_version.send()
|
||||||
self.assertEqual(cache.get(VERSION_CACHE_KEY), "0.0.0")
|
self.assertEqual(cache.get(VERSION_CACHE_KEY), "0.0.0")
|
||||||
self.assertFalse(
|
self.assertFalse(
|
||||||
Event.objects.filter(
|
Event.objects.filter(
|
||||||
@@ -67,14 +67,15 @@ class TestAdminTasks(TestCase):
|
|||||||
def test_version_disabled(self):
|
def test_version_disabled(self):
|
||||||
"""Test Update checker while its disabled"""
|
"""Test Update checker while its disabled"""
|
||||||
with CONFIG.patch("disable_update_check", True):
|
with CONFIG.patch("disable_update_check", True):
|
||||||
update_latest_version.delay().get()
|
update_latest_version.send()
|
||||||
self.assertEqual(cache.get(VERSION_CACHE_KEY), "0.0.0")
|
self.assertEqual(cache.get(VERSION_CACHE_KEY), "0.0.0")
|
||||||
|
|
||||||
def test_clear_update_notifications(self):
|
def test_clear_update_notifications(self):
|
||||||
"""Test clear of previous notification"""
|
"""Test clear of previous notification"""
|
||||||
admin_config = apps.get_app_config("authentik_admin")
|
admin_config = apps.get_app_config("authentik_admin")
|
||||||
Event.objects.create(
|
Event.objects.create(
|
||||||
action=EventAction.UPDATE_AVAILABLE, context={"new_version": "99999999.9999999.9999999"}
|
action=EventAction.UPDATE_AVAILABLE,
|
||||||
|
context={"new_version": "99999999.9999999.9999999"},
|
||||||
)
|
)
|
||||||
Event.objects.create(action=EventAction.UPDATE_AVAILABLE, context={"new_version": "1.1.1"})
|
Event.objects.create(action=EventAction.UPDATE_AVAILABLE, context={"new_version": "1.1.1"})
|
||||||
Event.objects.create(action=EventAction.UPDATE_AVAILABLE, context={})
|
Event.objects.create(action=EventAction.UPDATE_AVAILABLE, context={})
|
||||||
|
|||||||
@@ -6,13 +6,11 @@ from authentik.admin.api.meta import AppsViewSet, ModelViewSet
|
|||||||
from authentik.admin.api.system import SystemView
|
from authentik.admin.api.system import SystemView
|
||||||
from authentik.admin.api.version import VersionView
|
from authentik.admin.api.version import VersionView
|
||||||
from authentik.admin.api.version_history import VersionHistoryViewSet
|
from authentik.admin.api.version_history import VersionHistoryViewSet
|
||||||
from authentik.admin.api.workers import WorkerView
|
|
||||||
|
|
||||||
api_urlpatterns = [
|
api_urlpatterns = [
|
||||||
("admin/apps", AppsViewSet, "apps"),
|
("admin/apps", AppsViewSet, "apps"),
|
||||||
("admin/models", ModelViewSet, "models"),
|
("admin/models", ModelViewSet, "models"),
|
||||||
path("admin/version/", VersionView.as_view(), name="admin_version"),
|
path("admin/version/", VersionView.as_view(), name="admin_version"),
|
||||||
("admin/version/history", VersionHistoryViewSet, "version_history"),
|
("admin/version/history", VersionHistoryViewSet, "version_history"),
|
||||||
path("admin/workers/", WorkerView.as_view(), name="admin_workers"),
|
|
||||||
path("admin/system/", SystemView.as_view(), name="admin_system"),
|
path("admin/system/", SystemView.as_view(), name="admin_system"),
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ class BlueprintInstanceSerializer(ModelSerializer):
|
|||||||
"""Ensure the path (if set) specified is retrievable"""
|
"""Ensure the path (if set) specified is retrievable"""
|
||||||
if path == "" or path.startswith(OCI_PREFIX):
|
if path == "" or path.startswith(OCI_PREFIX):
|
||||||
return path
|
return path
|
||||||
files: list[dict] = blueprints_find_dict.delay().get()
|
files: list[dict] = blueprints_find_dict.send().get_result(block=True)
|
||||||
if path not in [file["path"] for file in files]:
|
if path not in [file["path"] for file in files]:
|
||||||
raise ValidationError(_("Blueprint file does not exist"))
|
raise ValidationError(_("Blueprint file does not exist"))
|
||||||
return path
|
return path
|
||||||
@@ -115,7 +115,7 @@ class BlueprintInstanceViewSet(UsedByMixin, ModelViewSet):
|
|||||||
@action(detail=False, pagination_class=None, filter_backends=[])
|
@action(detail=False, pagination_class=None, filter_backends=[])
|
||||||
def available(self, request: Request) -> Response:
|
def available(self, request: Request) -> Response:
|
||||||
"""Get blueprints"""
|
"""Get blueprints"""
|
||||||
files: list[dict] = blueprints_find_dict.delay().get()
|
files: list[dict] = blueprints_find_dict.send().get_result(block=True)
|
||||||
return Response(files)
|
return Response(files)
|
||||||
|
|
||||||
@permission_required("authentik_blueprints.view_blueprintinstance")
|
@permission_required("authentik_blueprints.view_blueprintinstance")
|
||||||
@@ -129,5 +129,5 @@ class BlueprintInstanceViewSet(UsedByMixin, ModelViewSet):
|
|||||||
def apply(self, request: Request, *args, **kwargs) -> Response:
|
def apply(self, request: Request, *args, **kwargs) -> Response:
|
||||||
"""Apply a blueprint"""
|
"""Apply a blueprint"""
|
||||||
blueprint = self.get_object()
|
blueprint = self.get_object()
|
||||||
apply_blueprint.delay(str(blueprint.pk)).get()
|
apply_blueprint.send_with_options(args=(blueprint.pk,), rel_obj=blueprint)
|
||||||
return self.retrieve(request, *args, **kwargs)
|
return self.retrieve(request, *args, **kwargs)
|
||||||
|
|||||||
@@ -6,9 +6,12 @@ from inspect import ismethod
|
|||||||
|
|
||||||
from django.apps import AppConfig
|
from django.apps import AppConfig
|
||||||
from django.db import DatabaseError, InternalError, ProgrammingError
|
from django.db import DatabaseError, InternalError, ProgrammingError
|
||||||
|
from dramatiq.broker import get_broker
|
||||||
from structlog.stdlib import BoundLogger, get_logger
|
from structlog.stdlib import BoundLogger, get_logger
|
||||||
|
|
||||||
|
from authentik.lib.utils.time import fqdn_rand
|
||||||
from authentik.root.signals import startup
|
from authentik.root.signals import startup
|
||||||
|
from authentik.tasks.schedules.common import ScheduleSpec
|
||||||
|
|
||||||
|
|
||||||
class ManagedAppConfig(AppConfig):
|
class ManagedAppConfig(AppConfig):
|
||||||
@@ -34,7 +37,7 @@ class ManagedAppConfig(AppConfig):
|
|||||||
|
|
||||||
def import_related(self):
|
def import_related(self):
|
||||||
"""Automatically import related modules which rely on just being imported
|
"""Automatically import related modules which rely on just being imported
|
||||||
to register themselves (mainly django signals and celery tasks)"""
|
to register themselves (mainly django signals and tasks)"""
|
||||||
|
|
||||||
def import_relative(rel_module: str):
|
def import_relative(rel_module: str):
|
||||||
try:
|
try:
|
||||||
@@ -80,6 +83,16 @@ class ManagedAppConfig(AppConfig):
|
|||||||
func._authentik_managed_reconcile = ManagedAppConfig.RECONCILE_GLOBAL_CATEGORY
|
func._authentik_managed_reconcile = ManagedAppConfig.RECONCILE_GLOBAL_CATEGORY
|
||||||
return func
|
return func
|
||||||
|
|
||||||
|
@property
|
||||||
|
def tenant_schedule_specs(self) -> list[ScheduleSpec]:
|
||||||
|
"""Get a list of schedule specs that must exist in each tenant"""
|
||||||
|
return []
|
||||||
|
|
||||||
|
@property
|
||||||
|
def global_schedule_specs(self) -> list[ScheduleSpec]:
|
||||||
|
"""Get a list of schedule specs that must exist in the default tenant"""
|
||||||
|
return []
|
||||||
|
|
||||||
def _reconcile_tenant(self) -> None:
|
def _reconcile_tenant(self) -> None:
|
||||||
"""reconcile ourselves for tenanted methods"""
|
"""reconcile ourselves for tenanted methods"""
|
||||||
from authentik.tenants.models import Tenant
|
from authentik.tenants.models import Tenant
|
||||||
@@ -100,8 +113,12 @@ class ManagedAppConfig(AppConfig):
|
|||||||
"""
|
"""
|
||||||
from django_tenants.utils import get_public_schema_name, schema_context
|
from django_tenants.utils import get_public_schema_name, schema_context
|
||||||
|
|
||||||
with schema_context(get_public_schema_name()):
|
try:
|
||||||
self._reconcile(self.RECONCILE_GLOBAL_CATEGORY)
|
with schema_context(get_public_schema_name()):
|
||||||
|
self._reconcile(self.RECONCILE_GLOBAL_CATEGORY)
|
||||||
|
except (DatabaseError, ProgrammingError, InternalError) as exc:
|
||||||
|
self.logger.debug("Failed to access database to run reconcile", exc=exc)
|
||||||
|
return
|
||||||
|
|
||||||
|
|
||||||
class AuthentikBlueprintsConfig(ManagedAppConfig):
|
class AuthentikBlueprintsConfig(ManagedAppConfig):
|
||||||
@@ -112,19 +129,29 @@ class AuthentikBlueprintsConfig(ManagedAppConfig):
|
|||||||
verbose_name = "authentik Blueprints"
|
verbose_name = "authentik Blueprints"
|
||||||
default = True
|
default = True
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_global
|
|
||||||
def load_blueprints_v1_tasks(self):
|
|
||||||
"""Load v1 tasks"""
|
|
||||||
self.import_module("authentik.blueprints.v1.tasks")
|
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_tenant
|
|
||||||
def blueprints_discovery(self):
|
|
||||||
"""Run blueprint discovery"""
|
|
||||||
from authentik.blueprints.v1.tasks import blueprints_discovery, clear_failed_blueprints
|
|
||||||
|
|
||||||
blueprints_discovery.delay()
|
|
||||||
clear_failed_blueprints.delay()
|
|
||||||
|
|
||||||
def import_models(self):
|
def import_models(self):
|
||||||
super().import_models()
|
super().import_models()
|
||||||
self.import_module("authentik.blueprints.v1.meta.apply_blueprint")
|
self.import_module("authentik.blueprints.v1.meta.apply_blueprint")
|
||||||
|
|
||||||
|
@ManagedAppConfig.reconcile_global
|
||||||
|
def tasks_middlewares(self):
|
||||||
|
from authentik.blueprints.v1.tasks import BlueprintWatcherMiddleware
|
||||||
|
|
||||||
|
get_broker().add_middleware(BlueprintWatcherMiddleware())
|
||||||
|
|
||||||
|
@property
|
||||||
|
def tenant_schedule_specs(self) -> list[ScheduleSpec]:
|
||||||
|
from authentik.blueprints.v1.tasks import blueprints_discovery, clear_failed_blueprints
|
||||||
|
|
||||||
|
return [
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=blueprints_discovery,
|
||||||
|
crontab=f"{fqdn_rand('blueprints_v1_discover')} * * * *",
|
||||||
|
send_on_startup=True,
|
||||||
|
),
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=clear_failed_blueprints,
|
||||||
|
crontab=f"{fqdn_rand('blueprints_v1_cleanup')} * * * *",
|
||||||
|
send_on_startup=True,
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from uuid import uuid4
|
from uuid import uuid4
|
||||||
|
|
||||||
|
from django.contrib.contenttypes.fields import GenericRelation
|
||||||
from django.contrib.postgres.fields import ArrayField
|
from django.contrib.postgres.fields import ArrayField
|
||||||
from django.db import models
|
from django.db import models
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
@@ -71,6 +72,13 @@ class BlueprintInstance(SerializerModel, ManagedModel, CreatedUpdatedModel):
|
|||||||
enabled = models.BooleanField(default=True)
|
enabled = models.BooleanField(default=True)
|
||||||
managed_models = ArrayField(models.TextField(), default=list)
|
managed_models = ArrayField(models.TextField(), default=list)
|
||||||
|
|
||||||
|
# Manual link to tasks instead of using TasksModel because of loop imports
|
||||||
|
tasks = GenericRelation(
|
||||||
|
"authentik_tasks.Task",
|
||||||
|
content_type_field="rel_obj_content_type",
|
||||||
|
object_id_field="rel_obj_id",
|
||||||
|
)
|
||||||
|
|
||||||
class Meta:
|
class Meta:
|
||||||
verbose_name = _("Blueprint Instance")
|
verbose_name = _("Blueprint Instance")
|
||||||
verbose_name_plural = _("Blueprint Instances")
|
verbose_name_plural = _("Blueprint Instances")
|
||||||
|
|||||||
@@ -1,18 +0,0 @@
|
|||||||
"""blueprint Settings"""
|
|
||||||
|
|
||||||
from celery.schedules import crontab
|
|
||||||
|
|
||||||
from authentik.lib.utils.time import fqdn_rand
|
|
||||||
|
|
||||||
CELERY_BEAT_SCHEDULE = {
|
|
||||||
"blueprints_v1_discover": {
|
|
||||||
"task": "authentik.blueprints.v1.tasks.blueprints_discovery",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("blueprints_v1_discover"), hour="*"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
},
|
|
||||||
"blueprints_v1_cleanup": {
|
|
||||||
"task": "authentik.blueprints.v1.tasks.clear_failed_blueprints",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("blueprints_v1_cleanup"), hour="*"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
2
authentik/blueprints/tasks.py
Normal file
2
authentik/blueprints/tasks.py
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
# Import all v1 tasks for auto task discovery
|
||||||
|
from authentik.blueprints.v1.tasks import * # noqa: F403
|
||||||
44
authentik/blueprints/tests/fixtures/tags.yaml
vendored
44
authentik/blueprints/tests/fixtures/tags.yaml
vendored
@@ -12,8 +12,8 @@ context:
|
|||||||
context1: context-nested-value
|
context1: context-nested-value
|
||||||
context2: !Context context1
|
context2: !Context context1
|
||||||
entries:
|
entries:
|
||||||
- model: !Format ["%s", authentik_sources_oauth.oauthsource]
|
- model: !Format ["%%s", authentik_sources_oauth.oauthsource]
|
||||||
state: !Format ["%s", present]
|
state: !Format ["%%s", present]
|
||||||
identifiers:
|
identifiers:
|
||||||
slug: test
|
slug: test
|
||||||
attrs:
|
attrs:
|
||||||
@@ -27,20 +27,23 @@ entries:
|
|||||||
[slug, default-source-authentication],
|
[slug, default-source-authentication],
|
||||||
]
|
]
|
||||||
enrollment_flow:
|
enrollment_flow:
|
||||||
!Find [!Format ["%s", authentik_flows.Flow], [slug, default-source-enrollment]]
|
!Find [!Format ["%%s", authentik_flows.Flow], [slug, default-source-enrollment]]
|
||||||
- attrs:
|
- attrs:
|
||||||
expression: return True
|
expression: return True
|
||||||
identifiers:
|
identifiers:
|
||||||
name: !Format [foo-%s-%s-%s, !Context foo, !Context bar, qux]
|
name: !Format [foo-%%s-%%s-%%s, !Context foo, !Context bar, qux]
|
||||||
id: policy
|
id: policy
|
||||||
model: authentik_policies_expression.expressionpolicy
|
model: authentik_policies_expression.expressionpolicy
|
||||||
- attrs:
|
- attrs:
|
||||||
attributes:
|
attributes:
|
||||||
env_null: !Env [bar-baz, null]
|
env_null: !Env [bar-baz, null]
|
||||||
|
file_content: !File '%(file_name)s'
|
||||||
|
file_default: !File ['%(file_default_name)s', 'default']
|
||||||
|
file_non_existent: !File '/does-not-exist'
|
||||||
json_parse: !ParseJSON '{"foo": "bar"}'
|
json_parse: !ParseJSON '{"foo": "bar"}'
|
||||||
policy_pk1:
|
policy_pk1:
|
||||||
!Format [
|
!Format [
|
||||||
"%s-%s",
|
"%%s-%%s",
|
||||||
!Find [
|
!Find [
|
||||||
authentik_policies_expression.expressionpolicy,
|
authentik_policies_expression.expressionpolicy,
|
||||||
[
|
[
|
||||||
@@ -51,29 +54,29 @@ entries:
|
|||||||
],
|
],
|
||||||
suffix,
|
suffix,
|
||||||
]
|
]
|
||||||
policy_pk2: !Format ["%s-%s", !KeyOf policy, suffix]
|
policy_pk2: !Format ["%%s-%%s", !KeyOf policy, suffix]
|
||||||
boolAnd:
|
boolAnd:
|
||||||
!Condition [AND, !Context foo, !Format ["%s", "a_string"], 1]
|
!Condition [AND, !Context foo, !Format ["%%s", "a_string"], 1]
|
||||||
boolNand:
|
boolNand:
|
||||||
!Condition [NAND, !Context foo, !Format ["%s", "a_string"], 1]
|
!Condition [NAND, !Context foo, !Format ["%%s", "a_string"], 1]
|
||||||
boolOr:
|
boolOr:
|
||||||
!Condition [
|
!Condition [
|
||||||
OR,
|
OR,
|
||||||
!Context foo,
|
!Context foo,
|
||||||
!Format ["%s", "a_string"],
|
!Format ["%%s", "a_string"],
|
||||||
null,
|
null,
|
||||||
]
|
]
|
||||||
boolNor:
|
boolNor:
|
||||||
!Condition [
|
!Condition [
|
||||||
NOR,
|
NOR,
|
||||||
!Context foo,
|
!Context foo,
|
||||||
!Format ["%s", "a_string"],
|
!Format ["%%s", "a_string"],
|
||||||
null,
|
null,
|
||||||
]
|
]
|
||||||
boolXor:
|
boolXor:
|
||||||
!Condition [XOR, !Context foo, !Format ["%s", "a_string"], 1]
|
!Condition [XOR, !Context foo, !Format ["%%s", "a_string"], 1]
|
||||||
boolXnor:
|
boolXnor:
|
||||||
!Condition [XNOR, !Context foo, !Format ["%s", "a_string"], 1]
|
!Condition [XNOR, !Context foo, !Format ["%%s", "a_string"], 1]
|
||||||
boolComplex:
|
boolComplex:
|
||||||
!Condition [
|
!Condition [
|
||||||
XNOR,
|
XNOR,
|
||||||
@@ -89,7 +92,7 @@ entries:
|
|||||||
{
|
{
|
||||||
with: { keys: "and_values" },
|
with: { keys: "and_values" },
|
||||||
and_nested_custom_tags:
|
and_nested_custom_tags:
|
||||||
!Format ["foo-%s", !Context foo],
|
!Format ["foo-%%s", !Context foo],
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
null,
|
null,
|
||||||
@@ -98,7 +101,7 @@ entries:
|
|||||||
!If [
|
!If [
|
||||||
!Condition [AND, false],
|
!Condition [AND, false],
|
||||||
null,
|
null,
|
||||||
[list, with, items, !Format ["foo-%s", !Context foo]],
|
[list, with, items, !Format ["foo-%%s", !Context foo]],
|
||||||
]
|
]
|
||||||
if_true_simple: !If [!Context foo, true, text]
|
if_true_simple: !If [!Context foo, true, text]
|
||||||
if_short: !If [!Context foo]
|
if_short: !If [!Context foo]
|
||||||
@@ -106,22 +109,22 @@ entries:
|
|||||||
enumerate_mapping_to_mapping: !Enumerate [
|
enumerate_mapping_to_mapping: !Enumerate [
|
||||||
!Context mapping,
|
!Context mapping,
|
||||||
MAP,
|
MAP,
|
||||||
[!Format ["prefix-%s", !Index 0], !Format ["other-prefix-%s", !Value 0]]
|
[!Format ["prefix-%%s", !Index 0], !Format ["other-prefix-%%s", !Value 0]]
|
||||||
]
|
]
|
||||||
enumerate_mapping_to_sequence: !Enumerate [
|
enumerate_mapping_to_sequence: !Enumerate [
|
||||||
!Context mapping,
|
!Context mapping,
|
||||||
SEQ,
|
SEQ,
|
||||||
!Format ["prefixed-pair-%s-%s", !Index 0, !Value 0]
|
!Format ["prefixed-pair-%%s-%%s", !Index 0, !Value 0]
|
||||||
]
|
]
|
||||||
enumerate_sequence_to_sequence: !Enumerate [
|
enumerate_sequence_to_sequence: !Enumerate [
|
||||||
!Context sequence,
|
!Context sequence,
|
||||||
SEQ,
|
SEQ,
|
||||||
!Format ["prefixed-items-%s-%s", !Index 0, !Value 0]
|
!Format ["prefixed-items-%%s-%%s", !Index 0, !Value 0]
|
||||||
]
|
]
|
||||||
enumerate_sequence_to_mapping: !Enumerate [
|
enumerate_sequence_to_mapping: !Enumerate [
|
||||||
!Context sequence,
|
!Context sequence,
|
||||||
MAP,
|
MAP,
|
||||||
[!Format ["index: %d", !Index 0], !Value 0]
|
[!Format ["index: %%d", !Index 0], !Value 0]
|
||||||
]
|
]
|
||||||
nested_complex_enumeration: !Enumerate [
|
nested_complex_enumeration: !Enumerate [
|
||||||
!Context sequence,
|
!Context sequence,
|
||||||
@@ -132,9 +135,9 @@ entries:
|
|||||||
!Context mapping,
|
!Context mapping,
|
||||||
MAP,
|
MAP,
|
||||||
[
|
[
|
||||||
!Format ["%s", !Index 0],
|
!Format ["%%s", !Index 0],
|
||||||
[
|
[
|
||||||
!Enumerate [!Value 2, SEQ, !Format ["prefixed-%s", !Value 0]],
|
!Enumerate [!Value 2, SEQ, !Format ["prefixed-%%s", !Value 0]],
|
||||||
{
|
{
|
||||||
outer_value: !Value 1,
|
outer_value: !Value 1,
|
||||||
outer_index: !Index 1,
|
outer_index: !Index 1,
|
||||||
@@ -151,6 +154,7 @@ entries:
|
|||||||
at_index_sequence_default: !AtIndex [!Context sequence, 100, "non existent"]
|
at_index_sequence_default: !AtIndex [!Context sequence, 100, "non existent"]
|
||||||
at_index_mapping: !AtIndex [!Context mapping, "key2"]
|
at_index_mapping: !AtIndex [!Context mapping, "key2"]
|
||||||
at_index_mapping_default: !AtIndex [!Context mapping, "invalid", "non existent"]
|
at_index_mapping_default: !AtIndex [!Context mapping, "invalid", "non existent"]
|
||||||
|
find_object: !AtIndex [!FindObject [authentik_providers_oauth2.scopemapping, [scope_name, openid]], managed]
|
||||||
identifiers:
|
identifiers:
|
||||||
name: test
|
name: test
|
||||||
conditions:
|
conditions:
|
||||||
|
|||||||
@@ -1,9 +1,11 @@
|
|||||||
"""Test blueprints v1"""
|
"""Test blueprints v1"""
|
||||||
|
|
||||||
from os import environ
|
from os import chmod, environ, unlink, write
|
||||||
|
from tempfile import mkstemp
|
||||||
|
|
||||||
from django.test import TransactionTestCase
|
from django.test import TransactionTestCase
|
||||||
|
|
||||||
|
from authentik.blueprints.tests import apply_blueprint
|
||||||
from authentik.blueprints.v1.exporter import FlowExporter
|
from authentik.blueprints.v1.exporter import FlowExporter
|
||||||
from authentik.blueprints.v1.importer import Importer, transaction_rollback
|
from authentik.blueprints.v1.importer import Importer, transaction_rollback
|
||||||
from authentik.core.models import Group
|
from authentik.core.models import Group
|
||||||
@@ -126,102 +128,119 @@ class TestBlueprintsV1(TransactionTestCase):
|
|||||||
|
|
||||||
self.assertEqual(Prompt.objects.filter(field_key="username").count(), count_before)
|
self.assertEqual(Prompt.objects.filter(field_key="username").count(), count_before)
|
||||||
|
|
||||||
|
@apply_blueprint("system/providers-oauth2.yaml")
|
||||||
def test_import_yaml_tags(self):
|
def test_import_yaml_tags(self):
|
||||||
"""Test some yaml tags"""
|
"""Test some yaml tags"""
|
||||||
ExpressionPolicy.objects.filter(name="foo-bar-baz-qux").delete()
|
ExpressionPolicy.objects.filter(name="foo-bar-baz-qux").delete()
|
||||||
Group.objects.filter(name="test").delete()
|
Group.objects.filter(name="test").delete()
|
||||||
environ["foo"] = generate_id()
|
environ["foo"] = generate_id()
|
||||||
importer = Importer.from_string(load_fixture("fixtures/tags.yaml"), {"bar": "baz"})
|
file, file_name = mkstemp()
|
||||||
|
write(file, b"foo")
|
||||||
|
_, file_default_name = mkstemp()
|
||||||
|
chmod(file_default_name, 0o000) # Remove all permissions so we can't read the file
|
||||||
|
importer = Importer.from_string(
|
||||||
|
load_fixture(
|
||||||
|
"fixtures/tags.yaml",
|
||||||
|
file_name=file_name,
|
||||||
|
file_default_name=file_default_name,
|
||||||
|
),
|
||||||
|
{"bar": "baz"},
|
||||||
|
)
|
||||||
self.assertTrue(importer.validate()[0])
|
self.assertTrue(importer.validate()[0])
|
||||||
self.assertTrue(importer.apply())
|
self.assertTrue(importer.apply())
|
||||||
policy = ExpressionPolicy.objects.filter(name="foo-bar-baz-qux").first()
|
policy = ExpressionPolicy.objects.filter(name="foo-bar-baz-qux").first()
|
||||||
self.assertTrue(policy)
|
self.assertTrue(policy)
|
||||||
self.assertTrue(
|
group = Group.objects.filter(name="test").first()
|
||||||
Group.objects.filter(
|
self.assertIsNotNone(group)
|
||||||
attributes={
|
self.assertEqual(
|
||||||
"policy_pk1": str(policy.pk) + "-suffix",
|
group.attributes,
|
||||||
"policy_pk2": str(policy.pk) + "-suffix",
|
{
|
||||||
"boolAnd": True,
|
"policy_pk1": str(policy.pk) + "-suffix",
|
||||||
"boolNand": False,
|
"policy_pk2": str(policy.pk) + "-suffix",
|
||||||
"boolOr": True,
|
"boolAnd": True,
|
||||||
"boolNor": False,
|
"boolNand": False,
|
||||||
"boolXor": True,
|
"boolOr": True,
|
||||||
"boolXnor": False,
|
"boolNor": False,
|
||||||
"boolComplex": True,
|
"boolXor": True,
|
||||||
"if_true_complex": {
|
"boolXnor": False,
|
||||||
"dictionary": {
|
"boolComplex": True,
|
||||||
"with": {"keys": "and_values"},
|
"if_true_complex": {
|
||||||
"and_nested_custom_tags": "foo-bar",
|
"dictionary": {
|
||||||
}
|
"with": {"keys": "and_values"},
|
||||||
|
"and_nested_custom_tags": "foo-bar",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"if_false_complex": ["list", "with", "items", "foo-bar"],
|
||||||
|
"if_true_simple": True,
|
||||||
|
"if_short": True,
|
||||||
|
"if_false_simple": 2,
|
||||||
|
"enumerate_mapping_to_mapping": {
|
||||||
|
"prefix-key1": "other-prefix-value",
|
||||||
|
"prefix-key2": "other-prefix-2",
|
||||||
|
},
|
||||||
|
"enumerate_mapping_to_sequence": [
|
||||||
|
"prefixed-pair-key1-value",
|
||||||
|
"prefixed-pair-key2-2",
|
||||||
|
],
|
||||||
|
"enumerate_sequence_to_sequence": [
|
||||||
|
"prefixed-items-0-foo",
|
||||||
|
"prefixed-items-1-bar",
|
||||||
|
],
|
||||||
|
"enumerate_sequence_to_mapping": {"index: 0": "foo", "index: 1": "bar"},
|
||||||
|
"nested_complex_enumeration": {
|
||||||
|
"0": {
|
||||||
|
"key1": [
|
||||||
|
["prefixed-f", "prefixed-o", "prefixed-o"],
|
||||||
|
{
|
||||||
|
"outer_value": "foo",
|
||||||
|
"outer_index": 0,
|
||||||
|
"middle_value": "value",
|
||||||
|
"middle_index": "key1",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"key2": [
|
||||||
|
["prefixed-f", "prefixed-o", "prefixed-o"],
|
||||||
|
{
|
||||||
|
"outer_value": "foo",
|
||||||
|
"outer_index": 0,
|
||||||
|
"middle_value": 2,
|
||||||
|
"middle_index": "key2",
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
"if_false_complex": ["list", "with", "items", "foo-bar"],
|
"1": {
|
||||||
"if_true_simple": True,
|
"key1": [
|
||||||
"if_short": True,
|
["prefixed-b", "prefixed-a", "prefixed-r"],
|
||||||
"if_false_simple": 2,
|
{
|
||||||
"enumerate_mapping_to_mapping": {
|
"outer_value": "bar",
|
||||||
"prefix-key1": "other-prefix-value",
|
"outer_index": 1,
|
||||||
"prefix-key2": "other-prefix-2",
|
"middle_value": "value",
|
||||||
|
"middle_index": "key1",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"key2": [
|
||||||
|
["prefixed-b", "prefixed-a", "prefixed-r"],
|
||||||
|
{
|
||||||
|
"outer_value": "bar",
|
||||||
|
"outer_index": 1,
|
||||||
|
"middle_value": 2,
|
||||||
|
"middle_index": "key2",
|
||||||
|
},
|
||||||
|
],
|
||||||
},
|
},
|
||||||
"enumerate_mapping_to_sequence": [
|
},
|
||||||
"prefixed-pair-key1-value",
|
"nested_context": "context-nested-value",
|
||||||
"prefixed-pair-key2-2",
|
"env_null": None,
|
||||||
],
|
"file_content": "foo",
|
||||||
"enumerate_sequence_to_sequence": [
|
"file_default": "default",
|
||||||
"prefixed-items-0-foo",
|
"file_non_existent": None,
|
||||||
"prefixed-items-1-bar",
|
"json_parse": {"foo": "bar"},
|
||||||
],
|
"at_index_sequence": "foo",
|
||||||
"enumerate_sequence_to_mapping": {"index: 0": "foo", "index: 1": "bar"},
|
"at_index_sequence_default": "non existent",
|
||||||
"nested_complex_enumeration": {
|
"at_index_mapping": 2,
|
||||||
"0": {
|
"at_index_mapping_default": "non existent",
|
||||||
"key1": [
|
"find_object": "goauthentik.io/providers/oauth2/scope-openid",
|
||||||
["prefixed-f", "prefixed-o", "prefixed-o"],
|
},
|
||||||
{
|
|
||||||
"outer_value": "foo",
|
|
||||||
"outer_index": 0,
|
|
||||||
"middle_value": "value",
|
|
||||||
"middle_index": "key1",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
"key2": [
|
|
||||||
["prefixed-f", "prefixed-o", "prefixed-o"],
|
|
||||||
{
|
|
||||||
"outer_value": "foo",
|
|
||||||
"outer_index": 0,
|
|
||||||
"middle_value": 2,
|
|
||||||
"middle_index": "key2",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
"1": {
|
|
||||||
"key1": [
|
|
||||||
["prefixed-b", "prefixed-a", "prefixed-r"],
|
|
||||||
{
|
|
||||||
"outer_value": "bar",
|
|
||||||
"outer_index": 1,
|
|
||||||
"middle_value": "value",
|
|
||||||
"middle_index": "key1",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
"key2": [
|
|
||||||
["prefixed-b", "prefixed-a", "prefixed-r"],
|
|
||||||
{
|
|
||||||
"outer_value": "bar",
|
|
||||||
"outer_index": 1,
|
|
||||||
"middle_value": 2,
|
|
||||||
"middle_index": "key2",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
"nested_context": "context-nested-value",
|
|
||||||
"env_null": None,
|
|
||||||
"json_parse": {"foo": "bar"},
|
|
||||||
"at_index_sequence": "foo",
|
|
||||||
"at_index_sequence_default": "non existent",
|
|
||||||
"at_index_mapping": 2,
|
|
||||||
"at_index_mapping_default": "non existent",
|
|
||||||
}
|
|
||||||
).exists()
|
|
||||||
)
|
)
|
||||||
self.assertTrue(
|
self.assertTrue(
|
||||||
OAuthSource.objects.filter(
|
OAuthSource.objects.filter(
|
||||||
@@ -229,6 +248,8 @@ class TestBlueprintsV1(TransactionTestCase):
|
|||||||
consumer_key=environ["foo"],
|
consumer_key=environ["foo"],
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
unlink(file_name)
|
||||||
|
unlink(file_default_name)
|
||||||
|
|
||||||
def test_export_validate_import_policies(self):
|
def test_export_validate_import_policies(self):
|
||||||
"""Test export and validate it"""
|
"""Test export and validate it"""
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ class TestBlueprintsV1Tasks(TransactionTestCase):
|
|||||||
file.seek(0)
|
file.seek(0)
|
||||||
file_hash = sha512(file.read().encode()).hexdigest()
|
file_hash = sha512(file.read().encode()).hexdigest()
|
||||||
file.flush()
|
file.flush()
|
||||||
blueprints_discovery()
|
blueprints_discovery.send()
|
||||||
instance = BlueprintInstance.objects.filter(name=blueprint_id).first()
|
instance = BlueprintInstance.objects.filter(name=blueprint_id).first()
|
||||||
self.assertEqual(instance.last_applied_hash, file_hash)
|
self.assertEqual(instance.last_applied_hash, file_hash)
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
@@ -82,7 +82,7 @@ class TestBlueprintsV1Tasks(TransactionTestCase):
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
file.flush()
|
file.flush()
|
||||||
blueprints_discovery()
|
blueprints_discovery.send()
|
||||||
blueprint = BlueprintInstance.objects.filter(name="foo").first()
|
blueprint = BlueprintInstance.objects.filter(name="foo").first()
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
blueprint.last_applied_hash,
|
blueprint.last_applied_hash,
|
||||||
@@ -107,7 +107,7 @@ class TestBlueprintsV1Tasks(TransactionTestCase):
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
file.flush()
|
file.flush()
|
||||||
blueprints_discovery()
|
blueprints_discovery.send()
|
||||||
blueprint.refresh_from_db()
|
blueprint.refresh_from_db()
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
blueprint.last_applied_hash,
|
blueprint.last_applied_hash,
|
||||||
|
|||||||
@@ -18,12 +18,15 @@ from django.db.models import Model, Q
|
|||||||
from rest_framework.exceptions import ValidationError
|
from rest_framework.exceptions import ValidationError
|
||||||
from rest_framework.fields import Field
|
from rest_framework.fields import Field
|
||||||
from rest_framework.serializers import Serializer
|
from rest_framework.serializers import Serializer
|
||||||
|
from structlog.stdlib import get_logger
|
||||||
from yaml import SafeDumper, SafeLoader, ScalarNode, SequenceNode
|
from yaml import SafeDumper, SafeLoader, ScalarNode, SequenceNode
|
||||||
|
|
||||||
from authentik.lib.models import SerializerModel
|
from authentik.lib.models import SerializerModel
|
||||||
from authentik.lib.sentry import SentryIgnoredException
|
from authentik.lib.sentry import SentryIgnoredException
|
||||||
from authentik.policies.models import PolicyBindingModel
|
from authentik.policies.models import PolicyBindingModel
|
||||||
|
|
||||||
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
class UNSET:
|
class UNSET:
|
||||||
"""Used to test whether a key has not been set."""
|
"""Used to test whether a key has not been set."""
|
||||||
@@ -268,6 +271,34 @@ class Env(YAMLTag):
|
|||||||
return getenv(self.key) or self.default
|
return getenv(self.key) or self.default
|
||||||
|
|
||||||
|
|
||||||
|
class File(YAMLTag):
|
||||||
|
"""Lookup file with optional default"""
|
||||||
|
|
||||||
|
path: str
|
||||||
|
default: Any | None
|
||||||
|
|
||||||
|
def __init__(self, loader: "BlueprintLoader", node: ScalarNode | SequenceNode) -> None:
|
||||||
|
super().__init__()
|
||||||
|
self.default = None
|
||||||
|
if isinstance(node, ScalarNode):
|
||||||
|
self.path = node.value
|
||||||
|
if isinstance(node, SequenceNode):
|
||||||
|
self.path = loader.construct_object(node.value[0])
|
||||||
|
self.default = loader.construct_object(node.value[1])
|
||||||
|
|
||||||
|
def resolve(self, entry: BlueprintEntry, blueprint: Blueprint) -> Any:
|
||||||
|
try:
|
||||||
|
with open(self.path, encoding="utf8") as _file:
|
||||||
|
return _file.read().strip()
|
||||||
|
except OSError as exc:
|
||||||
|
LOGGER.warning(
|
||||||
|
"Failed to read file. Falling back to default value",
|
||||||
|
path=self.path,
|
||||||
|
exc=exc,
|
||||||
|
)
|
||||||
|
return self.default
|
||||||
|
|
||||||
|
|
||||||
class Context(YAMLTag):
|
class Context(YAMLTag):
|
||||||
"""Lookup key from instance context"""
|
"""Lookup key from instance context"""
|
||||||
|
|
||||||
@@ -336,7 +367,7 @@ class Format(YAMLTag):
|
|||||||
|
|
||||||
|
|
||||||
class Find(YAMLTag):
|
class Find(YAMLTag):
|
||||||
"""Find any object"""
|
"""Find any object primary key"""
|
||||||
|
|
||||||
model_name: str | YAMLTag
|
model_name: str | YAMLTag
|
||||||
conditions: list[list]
|
conditions: list[list]
|
||||||
@@ -351,7 +382,7 @@ class Find(YAMLTag):
|
|||||||
values.append(loader.construct_object(node_values))
|
values.append(loader.construct_object(node_values))
|
||||||
self.conditions.append(values)
|
self.conditions.append(values)
|
||||||
|
|
||||||
def resolve(self, entry: BlueprintEntry, blueprint: Blueprint) -> Any:
|
def _get_instance(self, entry: BlueprintEntry, blueprint: Blueprint) -> Any:
|
||||||
if isinstance(self.model_name, YAMLTag):
|
if isinstance(self.model_name, YAMLTag):
|
||||||
model_name = self.model_name.resolve(entry, blueprint)
|
model_name = self.model_name.resolve(entry, blueprint)
|
||||||
else:
|
else:
|
||||||
@@ -373,12 +404,29 @@ class Find(YAMLTag):
|
|||||||
else:
|
else:
|
||||||
query_value = cond[1]
|
query_value = cond[1]
|
||||||
query &= Q(**{query_key: query_value})
|
query &= Q(**{query_key: query_value})
|
||||||
instance = model_class.objects.filter(query).first()
|
return model_class.objects.filter(query).first()
|
||||||
|
|
||||||
|
def resolve(self, entry: BlueprintEntry, blueprint: Blueprint) -> Any:
|
||||||
|
instance = self._get_instance(entry, blueprint)
|
||||||
if instance:
|
if instance:
|
||||||
return instance.pk
|
return instance.pk
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
class FindObject(Find):
|
||||||
|
"""Find any object"""
|
||||||
|
|
||||||
|
def resolve(self, entry: BlueprintEntry, blueprint: Blueprint) -> Any:
|
||||||
|
instance = self._get_instance(entry, blueprint)
|
||||||
|
if not instance:
|
||||||
|
return None
|
||||||
|
if not isinstance(instance, SerializerModel):
|
||||||
|
raise EntryInvalidError.from_entry(
|
||||||
|
f"Model {self.model_name} is not resolvable through FindObject", entry
|
||||||
|
)
|
||||||
|
return instance.serializer(instance=instance).data
|
||||||
|
|
||||||
|
|
||||||
class Condition(YAMLTag):
|
class Condition(YAMLTag):
|
||||||
"""Convert all values to a single boolean"""
|
"""Convert all values to a single boolean"""
|
||||||
|
|
||||||
@@ -674,11 +722,13 @@ class BlueprintLoader(SafeLoader):
|
|||||||
super().__init__(*args, **kwargs)
|
super().__init__(*args, **kwargs)
|
||||||
self.add_constructor("!KeyOf", KeyOf)
|
self.add_constructor("!KeyOf", KeyOf)
|
||||||
self.add_constructor("!Find", Find)
|
self.add_constructor("!Find", Find)
|
||||||
|
self.add_constructor("!FindObject", FindObject)
|
||||||
self.add_constructor("!Context", Context)
|
self.add_constructor("!Context", Context)
|
||||||
self.add_constructor("!Format", Format)
|
self.add_constructor("!Format", Format)
|
||||||
self.add_constructor("!Condition", Condition)
|
self.add_constructor("!Condition", Condition)
|
||||||
self.add_constructor("!If", If)
|
self.add_constructor("!If", If)
|
||||||
self.add_constructor("!Env", Env)
|
self.add_constructor("!Env", Env)
|
||||||
|
self.add_constructor("!File", File)
|
||||||
self.add_constructor("!Enumerate", Enumerate)
|
self.add_constructor("!Enumerate", Enumerate)
|
||||||
self.add_constructor("!Value", Value)
|
self.add_constructor("!Value", Value)
|
||||||
self.add_constructor("!Index", Index)
|
self.add_constructor("!Index", Index)
|
||||||
|
|||||||
@@ -57,7 +57,6 @@ from authentik.enterprise.stages.authenticator_endpoint_gdtc.models import (
|
|||||||
EndpointDeviceConnection,
|
EndpointDeviceConnection,
|
||||||
)
|
)
|
||||||
from authentik.events.logs import LogEvent, capture_logs
|
from authentik.events.logs import LogEvent, capture_logs
|
||||||
from authentik.events.models import SystemTask
|
|
||||||
from authentik.events.utils import cleanse_dict
|
from authentik.events.utils import cleanse_dict
|
||||||
from authentik.flows.models import FlowToken, Stage
|
from authentik.flows.models import FlowToken, Stage
|
||||||
from authentik.lib.models import SerializerModel
|
from authentik.lib.models import SerializerModel
|
||||||
@@ -77,6 +76,7 @@ from authentik.providers.scim.models import SCIMProviderGroup, SCIMProviderUser
|
|||||||
from authentik.rbac.models import Role
|
from authentik.rbac.models import Role
|
||||||
from authentik.sources.scim.models import SCIMSourceGroup, SCIMSourceUser
|
from authentik.sources.scim.models import SCIMSourceGroup, SCIMSourceUser
|
||||||
from authentik.stages.authenticator_webauthn.models import WebAuthnDeviceType
|
from authentik.stages.authenticator_webauthn.models import WebAuthnDeviceType
|
||||||
|
from authentik.tasks.models import Task
|
||||||
from authentik.tenants.models import Tenant
|
from authentik.tenants.models import Tenant
|
||||||
|
|
||||||
# Context set when the serializer is created in a blueprint context
|
# Context set when the serializer is created in a blueprint context
|
||||||
@@ -118,7 +118,7 @@ def excluded_models() -> list[type[Model]]:
|
|||||||
SCIMProviderGroup,
|
SCIMProviderGroup,
|
||||||
SCIMProviderUser,
|
SCIMProviderUser,
|
||||||
Tenant,
|
Tenant,
|
||||||
SystemTask,
|
Task,
|
||||||
ConnectionToken,
|
ConnectionToken,
|
||||||
AuthorizationCode,
|
AuthorizationCode,
|
||||||
AccessToken,
|
AccessToken,
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ class ApplyBlueprintMetaSerializer(PassiveSerializer):
|
|||||||
return MetaResult()
|
return MetaResult()
|
||||||
LOGGER.debug("Applying blueprint from meta model", blueprint=self.blueprint_instance)
|
LOGGER.debug("Applying blueprint from meta model", blueprint=self.blueprint_instance)
|
||||||
|
|
||||||
apply_blueprint(str(self.blueprint_instance.pk))
|
apply_blueprint(self.blueprint_instance.pk)
|
||||||
return MetaResult()
|
return MetaResult()
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -4,12 +4,17 @@ from dataclasses import asdict, dataclass, field
|
|||||||
from hashlib import sha512
|
from hashlib import sha512
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from sys import platform
|
from sys import platform
|
||||||
|
from uuid import UUID
|
||||||
|
|
||||||
from dacite.core import from_dict
|
from dacite.core import from_dict
|
||||||
|
from django.conf import settings
|
||||||
from django.db import DatabaseError, InternalError, ProgrammingError
|
from django.db import DatabaseError, InternalError, ProgrammingError
|
||||||
from django.utils.text import slugify
|
from django.utils.text import slugify
|
||||||
from django.utils.timezone import now
|
from django.utils.timezone import now
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from django_dramatiq_postgres.middleware import CurrentTask, CurrentTaskNotFound
|
||||||
|
from dramatiq.actor import actor
|
||||||
|
from dramatiq.middleware import Middleware
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
from watchdog.events import (
|
from watchdog.events import (
|
||||||
FileCreatedEvent,
|
FileCreatedEvent,
|
||||||
@@ -31,15 +36,13 @@ from authentik.blueprints.v1.importer import Importer
|
|||||||
from authentik.blueprints.v1.labels import LABEL_AUTHENTIK_INSTANTIATE
|
from authentik.blueprints.v1.labels import LABEL_AUTHENTIK_INSTANTIATE
|
||||||
from authentik.blueprints.v1.oci import OCI_PREFIX
|
from authentik.blueprints.v1.oci import OCI_PREFIX
|
||||||
from authentik.events.logs import capture_logs
|
from authentik.events.logs import capture_logs
|
||||||
from authentik.events.models import TaskStatus
|
|
||||||
from authentik.events.system_tasks import SystemTask, prefill_task
|
|
||||||
from authentik.events.utils import sanitize_dict
|
from authentik.events.utils import sanitize_dict
|
||||||
from authentik.lib.config import CONFIG
|
from authentik.lib.config import CONFIG
|
||||||
from authentik.root.celery import CELERY_APP
|
from authentik.tasks.models import Task
|
||||||
|
from authentik.tasks.schedules.models import Schedule
|
||||||
from authentik.tenants.models import Tenant
|
from authentik.tenants.models import Tenant
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
_file_watcher_started = False
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
@@ -53,22 +56,21 @@ class BlueprintFile:
|
|||||||
meta: BlueprintMetadata | None = field(default=None)
|
meta: BlueprintMetadata | None = field(default=None)
|
||||||
|
|
||||||
|
|
||||||
def start_blueprint_watcher():
|
class BlueprintWatcherMiddleware(Middleware):
|
||||||
"""Start blueprint watcher, if it's not running already."""
|
def start_blueprint_watcher(self):
|
||||||
# This function might be called twice since it's called on celery startup
|
"""Start blueprint watcher"""
|
||||||
|
observer = Observer()
|
||||||
|
kwargs = {}
|
||||||
|
if platform.startswith("linux"):
|
||||||
|
kwargs["event_filter"] = (FileCreatedEvent, FileModifiedEvent)
|
||||||
|
observer.schedule(
|
||||||
|
BlueprintEventHandler(), CONFIG.get("blueprints_dir"), recursive=True, **kwargs
|
||||||
|
)
|
||||||
|
observer.start()
|
||||||
|
|
||||||
global _file_watcher_started # noqa: PLW0603
|
def after_worker_boot(self, broker, worker):
|
||||||
if _file_watcher_started:
|
if not settings.TEST:
|
||||||
return
|
self.start_blueprint_watcher()
|
||||||
observer = Observer()
|
|
||||||
kwargs = {}
|
|
||||||
if platform.startswith("linux"):
|
|
||||||
kwargs["event_filter"] = (FileCreatedEvent, FileModifiedEvent)
|
|
||||||
observer.schedule(
|
|
||||||
BlueprintEventHandler(), CONFIG.get("blueprints_dir"), recursive=True, **kwargs
|
|
||||||
)
|
|
||||||
observer.start()
|
|
||||||
_file_watcher_started = True
|
|
||||||
|
|
||||||
|
|
||||||
class BlueprintEventHandler(FileSystemEventHandler):
|
class BlueprintEventHandler(FileSystemEventHandler):
|
||||||
@@ -92,7 +94,7 @@ class BlueprintEventHandler(FileSystemEventHandler):
|
|||||||
LOGGER.debug("new blueprint file created, starting discovery")
|
LOGGER.debug("new blueprint file created, starting discovery")
|
||||||
for tenant in Tenant.objects.filter(ready=True):
|
for tenant in Tenant.objects.filter(ready=True):
|
||||||
with tenant:
|
with tenant:
|
||||||
blueprints_discovery.delay()
|
Schedule.dispatch_by_actor(blueprints_discovery)
|
||||||
|
|
||||||
def on_modified(self, event: FileSystemEvent):
|
def on_modified(self, event: FileSystemEvent):
|
||||||
"""Process file modification"""
|
"""Process file modification"""
|
||||||
@@ -103,14 +105,14 @@ class BlueprintEventHandler(FileSystemEventHandler):
|
|||||||
with tenant:
|
with tenant:
|
||||||
for instance in BlueprintInstance.objects.filter(path=rel_path, enabled=True):
|
for instance in BlueprintInstance.objects.filter(path=rel_path, enabled=True):
|
||||||
LOGGER.debug("modified blueprint file, starting apply", instance=instance)
|
LOGGER.debug("modified blueprint file, starting apply", instance=instance)
|
||||||
apply_blueprint.delay(instance.pk.hex)
|
apply_blueprint.send_with_options(args=(instance.pk,), rel_obj=instance)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(
|
@actor(
|
||||||
|
description=_("Find blueprints as `blueprints_find` does, but return a safe dict."),
|
||||||
throws=(DatabaseError, ProgrammingError, InternalError),
|
throws=(DatabaseError, ProgrammingError, InternalError),
|
||||||
)
|
)
|
||||||
def blueprints_find_dict():
|
def blueprints_find_dict():
|
||||||
"""Find blueprints as `blueprints_find` does, but return a safe dict"""
|
|
||||||
blueprints = []
|
blueprints = []
|
||||||
for blueprint in blueprints_find():
|
for blueprint in blueprints_find():
|
||||||
blueprints.append(sanitize_dict(asdict(blueprint)))
|
blueprints.append(sanitize_dict(asdict(blueprint)))
|
||||||
@@ -146,21 +148,19 @@ def blueprints_find() -> list[BlueprintFile]:
|
|||||||
return blueprints
|
return blueprints
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(
|
@actor(
|
||||||
throws=(DatabaseError, ProgrammingError, InternalError), base=SystemTask, bind=True
|
description=_("Find blueprints and check if they need to be created in the database."),
|
||||||
|
throws=(DatabaseError, ProgrammingError, InternalError),
|
||||||
)
|
)
|
||||||
@prefill_task
|
def blueprints_discovery(path: str | None = None):
|
||||||
def blueprints_discovery(self: SystemTask, path: str | None = None):
|
self: Task = CurrentTask.get_task()
|
||||||
"""Find blueprints and check if they need to be created in the database"""
|
|
||||||
count = 0
|
count = 0
|
||||||
for blueprint in blueprints_find():
|
for blueprint in blueprints_find():
|
||||||
if path and blueprint.path != path:
|
if path and blueprint.path != path:
|
||||||
continue
|
continue
|
||||||
check_blueprint_v1_file(blueprint)
|
check_blueprint_v1_file(blueprint)
|
||||||
count += 1
|
count += 1
|
||||||
self.set_status(
|
self.info(f"Successfully imported {count} files.")
|
||||||
TaskStatus.SUCCESSFUL, _("Successfully imported {count} files.".format(count=count))
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def check_blueprint_v1_file(blueprint: BlueprintFile):
|
def check_blueprint_v1_file(blueprint: BlueprintFile):
|
||||||
@@ -187,22 +187,26 @@ def check_blueprint_v1_file(blueprint: BlueprintFile):
|
|||||||
)
|
)
|
||||||
if instance.last_applied_hash != blueprint.hash:
|
if instance.last_applied_hash != blueprint.hash:
|
||||||
LOGGER.info("Applying blueprint due to changed file", instance=instance, path=instance.path)
|
LOGGER.info("Applying blueprint due to changed file", instance=instance, path=instance.path)
|
||||||
apply_blueprint.delay(str(instance.pk))
|
apply_blueprint.send_with_options(args=(instance.pk,), rel_obj=instance)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(
|
@actor(description=_("Apply single blueprint."))
|
||||||
bind=True,
|
def apply_blueprint(instance_pk: UUID):
|
||||||
base=SystemTask,
|
try:
|
||||||
)
|
self: Task = CurrentTask.get_task()
|
||||||
def apply_blueprint(self: SystemTask, instance_pk: str):
|
except CurrentTaskNotFound:
|
||||||
"""Apply single blueprint"""
|
self = Task()
|
||||||
self.save_on_success = False
|
self.set_uid(str(instance_pk))
|
||||||
instance: BlueprintInstance | None = None
|
instance: BlueprintInstance | None = None
|
||||||
try:
|
try:
|
||||||
instance: BlueprintInstance = BlueprintInstance.objects.filter(pk=instance_pk).first()
|
instance: BlueprintInstance = BlueprintInstance.objects.filter(pk=instance_pk).first()
|
||||||
if not instance or not instance.enabled:
|
if not instance:
|
||||||
|
self.warning(f"Could not find blueprint {instance_pk}, skipping")
|
||||||
return
|
return
|
||||||
self.set_uid(slugify(instance.name))
|
self.set_uid(slugify(instance.name))
|
||||||
|
if not instance.enabled:
|
||||||
|
self.info(f"Blueprint {instance.name} is disabled, skipping")
|
||||||
|
return
|
||||||
blueprint_content = instance.retrieve()
|
blueprint_content = instance.retrieve()
|
||||||
file_hash = sha512(blueprint_content.encode()).hexdigest()
|
file_hash = sha512(blueprint_content.encode()).hexdigest()
|
||||||
importer = Importer.from_string(blueprint_content, instance.context)
|
importer = Importer.from_string(blueprint_content, instance.context)
|
||||||
@@ -212,19 +216,18 @@ def apply_blueprint(self: SystemTask, instance_pk: str):
|
|||||||
if not valid:
|
if not valid:
|
||||||
instance.status = BlueprintInstanceStatus.ERROR
|
instance.status = BlueprintInstanceStatus.ERROR
|
||||||
instance.save()
|
instance.save()
|
||||||
self.set_status(TaskStatus.ERROR, *logs)
|
self.logs(logs)
|
||||||
return
|
return
|
||||||
with capture_logs() as logs:
|
with capture_logs() as logs:
|
||||||
applied = importer.apply()
|
applied = importer.apply()
|
||||||
if not applied:
|
if not applied:
|
||||||
instance.status = BlueprintInstanceStatus.ERROR
|
instance.status = BlueprintInstanceStatus.ERROR
|
||||||
instance.save()
|
instance.save()
|
||||||
self.set_status(TaskStatus.ERROR, *logs)
|
self.logs(logs)
|
||||||
return
|
return
|
||||||
instance.status = BlueprintInstanceStatus.SUCCESSFUL
|
instance.status = BlueprintInstanceStatus.SUCCESSFUL
|
||||||
instance.last_applied_hash = file_hash
|
instance.last_applied_hash = file_hash
|
||||||
instance.last_applied = now()
|
instance.last_applied = now()
|
||||||
self.set_status(TaskStatus.SUCCESSFUL)
|
|
||||||
except (
|
except (
|
||||||
OSError,
|
OSError,
|
||||||
DatabaseError,
|
DatabaseError,
|
||||||
@@ -235,15 +238,14 @@ def apply_blueprint(self: SystemTask, instance_pk: str):
|
|||||||
) as exc:
|
) as exc:
|
||||||
if instance:
|
if instance:
|
||||||
instance.status = BlueprintInstanceStatus.ERROR
|
instance.status = BlueprintInstanceStatus.ERROR
|
||||||
self.set_error(exc)
|
self.error(exc)
|
||||||
finally:
|
finally:
|
||||||
if instance:
|
if instance:
|
||||||
instance.save()
|
instance.save()
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task()
|
@actor(description=_("Remove blueprints which couldn't be fetched."))
|
||||||
def clear_failed_blueprints():
|
def clear_failed_blueprints():
|
||||||
"""Remove blueprints which couldn't be fetched"""
|
|
||||||
# Exclude OCI blueprints as those might be temporarily unavailable
|
# Exclude OCI blueprints as those might be temporarily unavailable
|
||||||
for blueprint in BlueprintInstance.objects.exclude(path__startswith=OCI_PREFIX):
|
for blueprint in BlueprintInstance.objects.exclude(path__startswith=OCI_PREFIX):
|
||||||
try:
|
try:
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ class AuthentikBrandsConfig(ManagedAppConfig):
|
|||||||
name = "authentik.brands"
|
name = "authentik.brands"
|
||||||
label = "authentik_brands"
|
label = "authentik_brands"
|
||||||
verbose_name = "authentik Brands"
|
verbose_name = "authentik Brands"
|
||||||
|
default = True
|
||||||
mountpoints = {
|
mountpoints = {
|
||||||
"authentik.brands.urls_root": "",
|
"authentik.brands.urls_root": "",
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -49,11 +49,28 @@ class GroupMemberSerializer(ModelSerializer):
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
class GroupChildSerializer(ModelSerializer):
|
||||||
|
"""Stripped down group serializer to show relevant children for groups"""
|
||||||
|
|
||||||
|
attributes = JSONDictField(required=False)
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
model = Group
|
||||||
|
fields = [
|
||||||
|
"pk",
|
||||||
|
"name",
|
||||||
|
"is_superuser",
|
||||||
|
"attributes",
|
||||||
|
"group_uuid",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
class GroupSerializer(ModelSerializer):
|
class GroupSerializer(ModelSerializer):
|
||||||
"""Group Serializer"""
|
"""Group Serializer"""
|
||||||
|
|
||||||
attributes = JSONDictField(required=False)
|
attributes = JSONDictField(required=False)
|
||||||
users_obj = SerializerMethodField(allow_null=True)
|
users_obj = SerializerMethodField(allow_null=True)
|
||||||
|
children_obj = SerializerMethodField(allow_null=True)
|
||||||
roles_obj = ListSerializer(
|
roles_obj = ListSerializer(
|
||||||
child=RoleSerializer(),
|
child=RoleSerializer(),
|
||||||
read_only=True,
|
read_only=True,
|
||||||
@@ -61,7 +78,6 @@ class GroupSerializer(ModelSerializer):
|
|||||||
required=False,
|
required=False,
|
||||||
)
|
)
|
||||||
parent_name = CharField(source="parent.name", read_only=True, allow_null=True)
|
parent_name = CharField(source="parent.name", read_only=True, allow_null=True)
|
||||||
|
|
||||||
num_pk = IntegerField(read_only=True)
|
num_pk = IntegerField(read_only=True)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@@ -71,12 +87,25 @@ class GroupSerializer(ModelSerializer):
|
|||||||
return True
|
return True
|
||||||
return str(request.query_params.get("include_users", "true")).lower() == "true"
|
return str(request.query_params.get("include_users", "true")).lower() == "true"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def _should_include_children(self) -> bool:
|
||||||
|
request: Request = self.context.get("request", None)
|
||||||
|
if not request:
|
||||||
|
return True
|
||||||
|
return str(request.query_params.get("include_children", "false")).lower() == "true"
|
||||||
|
|
||||||
@extend_schema_field(GroupMemberSerializer(many=True))
|
@extend_schema_field(GroupMemberSerializer(many=True))
|
||||||
def get_users_obj(self, instance: Group) -> list[GroupMemberSerializer] | None:
|
def get_users_obj(self, instance: Group) -> list[GroupMemberSerializer] | None:
|
||||||
if not self._should_include_users:
|
if not self._should_include_users:
|
||||||
return None
|
return None
|
||||||
return GroupMemberSerializer(instance.users, many=True).data
|
return GroupMemberSerializer(instance.users, many=True).data
|
||||||
|
|
||||||
|
@extend_schema_field(GroupChildSerializer(many=True))
|
||||||
|
def get_children_obj(self, instance: Group) -> list[GroupChildSerializer] | None:
|
||||||
|
if not self._should_include_children:
|
||||||
|
return None
|
||||||
|
return GroupChildSerializer(instance.children, many=True).data
|
||||||
|
|
||||||
def validate_parent(self, parent: Group | None):
|
def validate_parent(self, parent: Group | None):
|
||||||
"""Validate group parent (if set), ensuring the parent isn't itself"""
|
"""Validate group parent (if set), ensuring the parent isn't itself"""
|
||||||
if not self.instance or not parent:
|
if not self.instance or not parent:
|
||||||
@@ -126,11 +155,17 @@ class GroupSerializer(ModelSerializer):
|
|||||||
"attributes",
|
"attributes",
|
||||||
"roles",
|
"roles",
|
||||||
"roles_obj",
|
"roles_obj",
|
||||||
|
"children",
|
||||||
|
"children_obj",
|
||||||
]
|
]
|
||||||
extra_kwargs = {
|
extra_kwargs = {
|
||||||
"users": {
|
"users": {
|
||||||
"default": list,
|
"default": list,
|
||||||
},
|
},
|
||||||
|
"children": {
|
||||||
|
"required": False,
|
||||||
|
"default": list,
|
||||||
|
},
|
||||||
# TODO: This field isn't unique on the database which is hard to backport
|
# TODO: This field isn't unique on the database which is hard to backport
|
||||||
# hence we just validate the uniqueness here
|
# hence we just validate the uniqueness here
|
||||||
"name": {"validators": [UniqueValidator(Group.objects.all())]},
|
"name": {"validators": [UniqueValidator(Group.objects.all())]},
|
||||||
@@ -203,11 +238,15 @@ class GroupViewSet(UsedByMixin, ModelViewSet):
|
|||||||
Prefetch("users", queryset=User.objects.all().only("id"))
|
Prefetch("users", queryset=User.objects.all().only("id"))
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if self.serializer_class(context={"request": self.request})._should_include_children:
|
||||||
|
base_qs = base_qs.prefetch_related("children")
|
||||||
|
|
||||||
return base_qs
|
return base_qs
|
||||||
|
|
||||||
@extend_schema(
|
@extend_schema(
|
||||||
parameters=[
|
parameters=[
|
||||||
OpenApiParameter("include_users", bool, default=True),
|
OpenApiParameter("include_users", bool, default=True),
|
||||||
|
OpenApiParameter("include_children", bool, default=False),
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
def list(self, request, *args, **kwargs):
|
def list(self, request, *args, **kwargs):
|
||||||
@@ -216,6 +255,7 @@ class GroupViewSet(UsedByMixin, ModelViewSet):
|
|||||||
@extend_schema(
|
@extend_schema(
|
||||||
parameters=[
|
parameters=[
|
||||||
OpenApiParameter("include_users", bool, default=True),
|
OpenApiParameter("include_users", bool, default=True),
|
||||||
|
OpenApiParameter("include_children", bool, default=False),
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
def retrieve(self, request, *args, **kwargs):
|
def retrieve(self, request, *args, **kwargs):
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ from json import loads
|
|||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from django.contrib.auth import update_session_auth_hash
|
from django.contrib.auth import update_session_auth_hash
|
||||||
from django.contrib.auth.models import Permission
|
from django.contrib.auth.models import AnonymousUser, Permission
|
||||||
from django.db.transaction import atomic
|
from django.db.transaction import atomic
|
||||||
from django.db.utils import IntegrityError
|
from django.db.utils import IntegrityError
|
||||||
from django.urls import reverse_lazy
|
from django.urls import reverse_lazy
|
||||||
@@ -16,6 +16,7 @@ from django.utils.translation import gettext as _
|
|||||||
from django_filters.filters import (
|
from django_filters.filters import (
|
||||||
BooleanFilter,
|
BooleanFilter,
|
||||||
CharFilter,
|
CharFilter,
|
||||||
|
IsoDateTimeFilter,
|
||||||
ModelMultipleChoiceFilter,
|
ModelMultipleChoiceFilter,
|
||||||
MultipleChoiceFilter,
|
MultipleChoiceFilter,
|
||||||
UUIDFilter,
|
UUIDFilter,
|
||||||
@@ -241,6 +242,7 @@ class UserSerializer(ModelSerializer):
|
|||||||
"type",
|
"type",
|
||||||
"uuid",
|
"uuid",
|
||||||
"password_change_date",
|
"password_change_date",
|
||||||
|
"last_updated",
|
||||||
]
|
]
|
||||||
extra_kwargs = {
|
extra_kwargs = {
|
||||||
"name": {"allow_blank": True},
|
"name": {"allow_blank": True},
|
||||||
@@ -331,6 +333,14 @@ class UsersFilter(FilterSet):
|
|||||||
method="filter_attributes",
|
method="filter_attributes",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
date_joined__lt = IsoDateTimeFilter(field_name="date_joined", lookup_expr="lt")
|
||||||
|
date_joined = IsoDateTimeFilter(field_name="date_joined")
|
||||||
|
date_joined__gt = IsoDateTimeFilter(field_name="date_joined", lookup_expr="gt")
|
||||||
|
|
||||||
|
last_updated__lt = IsoDateTimeFilter(field_name="last_updated", lookup_expr="lt")
|
||||||
|
last_updated = IsoDateTimeFilter(field_name="last_updated")
|
||||||
|
last_updated__gt = IsoDateTimeFilter(field_name="last_updated", lookup_expr="gt")
|
||||||
|
|
||||||
is_superuser = BooleanFilter(field_name="ak_groups", method="filter_is_superuser")
|
is_superuser = BooleanFilter(field_name="ak_groups", method="filter_is_superuser")
|
||||||
uuid = UUIDFilter(field_name="uuid")
|
uuid = UUIDFilter(field_name="uuid")
|
||||||
|
|
||||||
@@ -376,6 +386,8 @@ class UsersFilter(FilterSet):
|
|||||||
fields = [
|
fields = [
|
||||||
"username",
|
"username",
|
||||||
"email",
|
"email",
|
||||||
|
"date_joined",
|
||||||
|
"last_updated",
|
||||||
"name",
|
"name",
|
||||||
"is_active",
|
"is_active",
|
||||||
"is_superuser",
|
"is_superuser",
|
||||||
@@ -390,10 +402,19 @@ class UserViewSet(UsedByMixin, ModelViewSet):
|
|||||||
"""User Viewset"""
|
"""User Viewset"""
|
||||||
|
|
||||||
queryset = User.objects.none()
|
queryset = User.objects.none()
|
||||||
ordering = ["username"]
|
ordering = ["username", "date_joined", "last_updated"]
|
||||||
serializer_class = UserSerializer
|
serializer_class = UserSerializer
|
||||||
filterset_class = UsersFilter
|
filterset_class = UsersFilter
|
||||||
search_fields = ["username", "name", "is_active", "email", "uuid", "attributes"]
|
search_fields = [
|
||||||
|
"username",
|
||||||
|
"name",
|
||||||
|
"is_active",
|
||||||
|
"email",
|
||||||
|
"uuid",
|
||||||
|
"attributes",
|
||||||
|
"date_joined",
|
||||||
|
"last_updated",
|
||||||
|
]
|
||||||
|
|
||||||
def get_ql_fields(self):
|
def get_ql_fields(self):
|
||||||
from djangoql.schema import BoolField, StrField
|
from djangoql.schema import BoolField, StrField
|
||||||
@@ -435,6 +456,7 @@ class UserViewSet(UsedByMixin, ModelViewSet):
|
|||||||
user: User = self.get_object()
|
user: User = self.get_object()
|
||||||
planner = FlowPlanner(flow)
|
planner = FlowPlanner(flow)
|
||||||
planner.allow_empty_flows = True
|
planner.allow_empty_flows = True
|
||||||
|
self.request._request.user = AnonymousUser()
|
||||||
try:
|
try:
|
||||||
plan = planner.plan(
|
plan = planner.plan(
|
||||||
self.request._request,
|
self.request._request,
|
||||||
|
|||||||
@@ -1,8 +1,7 @@
|
|||||||
"""authentik core app config"""
|
"""authentik core app config"""
|
||||||
|
|
||||||
from django.conf import settings
|
|
||||||
|
|
||||||
from authentik.blueprints.apps import ManagedAppConfig
|
from authentik.blueprints.apps import ManagedAppConfig
|
||||||
|
from authentik.tasks.schedules.common import ScheduleSpec
|
||||||
|
|
||||||
|
|
||||||
class AuthentikCoreConfig(ManagedAppConfig):
|
class AuthentikCoreConfig(ManagedAppConfig):
|
||||||
@@ -14,14 +13,6 @@ class AuthentikCoreConfig(ManagedAppConfig):
|
|||||||
mountpoint = ""
|
mountpoint = ""
|
||||||
default = True
|
default = True
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_global
|
|
||||||
def debug_worker_hook(self):
|
|
||||||
"""Dispatch startup tasks inline when debugging"""
|
|
||||||
if settings.DEBUG:
|
|
||||||
from authentik.root.celery import worker_ready_hook
|
|
||||||
|
|
||||||
worker_ready_hook()
|
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_tenant
|
@ManagedAppConfig.reconcile_tenant
|
||||||
def source_inbuilt(self):
|
def source_inbuilt(self):
|
||||||
"""Reconcile inbuilt source"""
|
"""Reconcile inbuilt source"""
|
||||||
@@ -34,3 +25,18 @@ class AuthentikCoreConfig(ManagedAppConfig):
|
|||||||
},
|
},
|
||||||
managed=Source.MANAGED_INBUILT,
|
managed=Source.MANAGED_INBUILT,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def tenant_schedule_specs(self) -> list[ScheduleSpec]:
|
||||||
|
from authentik.core.tasks import clean_expired_models, clean_temporary_users
|
||||||
|
|
||||||
|
return [
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=clean_expired_models,
|
||||||
|
crontab="2-59/5 * * * *",
|
||||||
|
),
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=clean_temporary_users,
|
||||||
|
crontab="9-59/5 * * * *",
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
"""Run bootstrap tasks"""
|
|
||||||
|
|
||||||
from django.core.management.base import BaseCommand
|
|
||||||
from django_tenants.utils import get_public_schema_name
|
|
||||||
|
|
||||||
from authentik.root.celery import _get_startup_tasks_all_tenants, _get_startup_tasks_default_tenant
|
|
||||||
from authentik.tenants.models import Tenant
|
|
||||||
|
|
||||||
|
|
||||||
class Command(BaseCommand):
|
|
||||||
"""Run bootstrap tasks to ensure certain objects are created"""
|
|
||||||
|
|
||||||
def handle(self, **options):
|
|
||||||
for task in _get_startup_tasks_default_tenant():
|
|
||||||
with Tenant.objects.get(schema_name=get_public_schema_name()):
|
|
||||||
task()
|
|
||||||
|
|
||||||
for task in _get_startup_tasks_all_tenants():
|
|
||||||
for tenant in Tenant.objects.filter(ready=True):
|
|
||||||
with tenant:
|
|
||||||
task()
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
"""Run worker"""
|
|
||||||
|
|
||||||
from sys import exit as sysexit
|
|
||||||
from tempfile import tempdir
|
|
||||||
|
|
||||||
from celery.apps.worker import Worker
|
|
||||||
from django.core.management.base import BaseCommand
|
|
||||||
from django.db import close_old_connections
|
|
||||||
from structlog.stdlib import get_logger
|
|
||||||
|
|
||||||
from authentik.lib.config import CONFIG
|
|
||||||
from authentik.lib.debug import start_debug_server
|
|
||||||
from authentik.root.celery import CELERY_APP
|
|
||||||
|
|
||||||
LOGGER = get_logger()
|
|
||||||
|
|
||||||
|
|
||||||
class Command(BaseCommand):
|
|
||||||
"""Run worker"""
|
|
||||||
|
|
||||||
def add_arguments(self, parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"-b",
|
|
||||||
"--beat",
|
|
||||||
action="store_false",
|
|
||||||
help="When set, this worker will _not_ run Beat (scheduled) tasks",
|
|
||||||
)
|
|
||||||
|
|
||||||
def handle(self, **options):
|
|
||||||
LOGGER.debug("Celery options", **options)
|
|
||||||
close_old_connections()
|
|
||||||
start_debug_server()
|
|
||||||
worker: Worker = CELERY_APP.Worker(
|
|
||||||
no_color=False,
|
|
||||||
quiet=True,
|
|
||||||
optimization="fair",
|
|
||||||
autoscale=(CONFIG.get_int("worker.concurrency"), 1),
|
|
||||||
task_events=True,
|
|
||||||
beat=options.get("beat", True),
|
|
||||||
schedule_filename=f"{tempdir}/celerybeat-schedule",
|
|
||||||
queues=["authentik", "authentik_scheduled", "authentik_events"],
|
|
||||||
)
|
|
||||||
for task in CELERY_APP.tasks:
|
|
||||||
LOGGER.debug("Registered task", task=task)
|
|
||||||
|
|
||||||
worker.start()
|
|
||||||
sysexit(worker.exitcode)
|
|
||||||
@@ -5,6 +5,7 @@ from contextvars import ContextVar
|
|||||||
from functools import partial
|
from functools import partial
|
||||||
from uuid import uuid4
|
from uuid import uuid4
|
||||||
|
|
||||||
|
from django.contrib.auth import logout
|
||||||
from django.contrib.auth.models import AnonymousUser
|
from django.contrib.auth.models import AnonymousUser
|
||||||
from django.core.exceptions import ImproperlyConfigured
|
from django.core.exceptions import ImproperlyConfigured
|
||||||
from django.http import HttpRequest, HttpResponse
|
from django.http import HttpRequest, HttpResponse
|
||||||
@@ -58,6 +59,11 @@ class AuthenticationMiddleware(MiddlewareMixin):
|
|||||||
request.user = SimpleLazyObject(lambda: get_user(request))
|
request.user = SimpleLazyObject(lambda: get_user(request))
|
||||||
request.auser = partial(aget_user, request)
|
request.auser = partial(aget_user, request)
|
||||||
|
|
||||||
|
user = request.user
|
||||||
|
if user and user.is_authenticated and not user.is_active:
|
||||||
|
logout(request)
|
||||||
|
raise AssertionError()
|
||||||
|
|
||||||
|
|
||||||
class ImpersonateMiddleware:
|
class ImpersonateMiddleware:
|
||||||
"""Middleware to impersonate users"""
|
"""Middleware to impersonate users"""
|
||||||
|
|||||||
27
authentik/core/migrations/0050_user_last_updated_and_more.py
Normal file
27
authentik/core/migrations/0050_user_last_updated_and_more.py
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# Generated by Django 5.1.11 on 2025-07-15 15:21
|
||||||
|
|
||||||
|
from django.db import migrations, models
|
||||||
|
|
||||||
|
|
||||||
|
class Migration(migrations.Migration):
|
||||||
|
|
||||||
|
dependencies = [
|
||||||
|
("auth", "0012_alter_user_first_name_max_length"),
|
||||||
|
("authentik_core", "0049_alter_token_options"),
|
||||||
|
]
|
||||||
|
|
||||||
|
operations = [
|
||||||
|
migrations.AddField(
|
||||||
|
model_name="user",
|
||||||
|
name="last_updated",
|
||||||
|
field=models.DateTimeField(auto_now=True),
|
||||||
|
),
|
||||||
|
migrations.AddIndex(
|
||||||
|
model_name="user",
|
||||||
|
index=models.Index(fields=["last_updated"], name="authentik_c_last_up_ed7486_idx"),
|
||||||
|
),
|
||||||
|
migrations.AddIndex(
|
||||||
|
model_name="user",
|
||||||
|
index=models.Index(fields=["date_joined"], name="authentik_c_date_jo_58c256_idx"),
|
||||||
|
),
|
||||||
|
]
|
||||||
@@ -274,6 +274,8 @@ class User(SerializerModel, GuardianUserMixin, AttributesMixin, AbstractUser):
|
|||||||
ak_groups = models.ManyToManyField("Group", related_name="users")
|
ak_groups = models.ManyToManyField("Group", related_name="users")
|
||||||
password_change_date = models.DateTimeField(auto_now_add=True)
|
password_change_date = models.DateTimeField(auto_now_add=True)
|
||||||
|
|
||||||
|
last_updated = models.DateTimeField(auto_now=True)
|
||||||
|
|
||||||
objects = UserManager()
|
objects = UserManager()
|
||||||
|
|
||||||
class Meta:
|
class Meta:
|
||||||
@@ -293,6 +295,8 @@ class User(SerializerModel, GuardianUserMixin, AttributesMixin, AbstractUser):
|
|||||||
models.Index(fields=["uuid"]),
|
models.Index(fields=["uuid"]),
|
||||||
models.Index(fields=["path"]),
|
models.Index(fields=["path"]),
|
||||||
models.Index(fields=["type"]),
|
models.Index(fields=["type"]),
|
||||||
|
models.Index(fields=["date_joined"]),
|
||||||
|
models.Index(fields=["last_updated"]),
|
||||||
]
|
]
|
||||||
|
|
||||||
def __str__(self):
|
def __str__(self):
|
||||||
|
|||||||
@@ -79,8 +79,8 @@ class SourceFlowManager:
|
|||||||
|
|
||||||
identifier: str
|
identifier: str
|
||||||
|
|
||||||
user_connection_type: type[UserSourceConnection] = UserSourceConnection
|
user_connection_type: type[UserSourceConnection]
|
||||||
group_connection_type: type[GroupSourceConnection] = GroupSourceConnection
|
group_connection_type: type[GroupSourceConnection]
|
||||||
|
|
||||||
user_info: dict[str, Any]
|
user_info: dict[str, Any]
|
||||||
policy_context: dict[str, Any]
|
policy_context: dict[str, Any]
|
||||||
|
|||||||
@@ -3,6 +3,9 @@
|
|||||||
from datetime import datetime, timedelta
|
from datetime import datetime, timedelta
|
||||||
|
|
||||||
from django.utils.timezone import now
|
from django.utils.timezone import now
|
||||||
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from django_dramatiq_postgres.middleware import CurrentTask
|
||||||
|
from dramatiq.actor import actor
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
|
|
||||||
from authentik.core.models import (
|
from authentik.core.models import (
|
||||||
@@ -11,17 +14,14 @@ from authentik.core.models import (
|
|||||||
ExpiringModel,
|
ExpiringModel,
|
||||||
User,
|
User,
|
||||||
)
|
)
|
||||||
from authentik.events.system_tasks import SystemTask, TaskStatus, prefill_task
|
from authentik.tasks.models import Task
|
||||||
from authentik.root.celery import CELERY_APP
|
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(bind=True, base=SystemTask)
|
@actor(description=_("Remove expired objects."))
|
||||||
@prefill_task
|
def clean_expired_models():
|
||||||
def clean_expired_models(self: SystemTask):
|
self: Task = CurrentTask.get_task()
|
||||||
"""Remove expired objects"""
|
|
||||||
messages = []
|
|
||||||
for cls in ExpiringModel.__subclasses__():
|
for cls in ExpiringModel.__subclasses__():
|
||||||
cls: ExpiringModel
|
cls: ExpiringModel
|
||||||
objects = (
|
objects = (
|
||||||
@@ -31,16 +31,13 @@ def clean_expired_models(self: SystemTask):
|
|||||||
for obj in objects:
|
for obj in objects:
|
||||||
obj.expire_action()
|
obj.expire_action()
|
||||||
LOGGER.debug("Expired models", model=cls, amount=amount)
|
LOGGER.debug("Expired models", model=cls, amount=amount)
|
||||||
messages.append(f"Expired {amount} {cls._meta.verbose_name_plural}")
|
self.info(f"Expired {amount} {cls._meta.verbose_name_plural}")
|
||||||
self.set_status(TaskStatus.SUCCESSFUL, *messages)
|
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(bind=True, base=SystemTask)
|
@actor(description=_("Remove temporary users created by SAML Sources."))
|
||||||
@prefill_task
|
def clean_temporary_users():
|
||||||
def clean_temporary_users(self: SystemTask):
|
self: Task = CurrentTask.get_task()
|
||||||
"""Remove temporary users created by SAML Sources"""
|
|
||||||
_now = datetime.now()
|
_now = datetime.now()
|
||||||
messages = []
|
|
||||||
deleted_users = 0
|
deleted_users = 0
|
||||||
for user in User.objects.filter(**{f"attributes__{USER_ATTRIBUTE_GENERATED}": True}):
|
for user in User.objects.filter(**{f"attributes__{USER_ATTRIBUTE_GENERATED}": True}):
|
||||||
if not user.attributes.get(USER_ATTRIBUTE_EXPIRES):
|
if not user.attributes.get(USER_ATTRIBUTE_EXPIRES):
|
||||||
@@ -52,5 +49,4 @@ def clean_temporary_users(self: SystemTask):
|
|||||||
LOGGER.debug("User is expired and will be deleted.", user=user, delta=delta)
|
LOGGER.debug("User is expired and will be deleted.", user=user, delta=delta)
|
||||||
user.delete()
|
user.delete()
|
||||||
deleted_users += 1
|
deleted_users += 1
|
||||||
messages.append(f"Successfully deleted {deleted_users} users.")
|
self.info(f"Successfully deleted {deleted_users} users.")
|
||||||
self.set_status(TaskStatus.SUCCESSFUL, *messages)
|
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ class TestTasks(APITestCase):
|
|||||||
expires=now(), user=get_anonymous_user(), intent=TokenIntents.INTENT_API
|
expires=now(), user=get_anonymous_user(), intent=TokenIntents.INTENT_API
|
||||||
)
|
)
|
||||||
key = token.key
|
key = token.key
|
||||||
clean_expired_models.delay().get()
|
clean_expired_models.send()
|
||||||
token.refresh_from_db()
|
token.refresh_from_db()
|
||||||
self.assertNotEqual(key, token.key)
|
self.assertNotEqual(key, token.key)
|
||||||
|
|
||||||
@@ -50,5 +50,5 @@ class TestTasks(APITestCase):
|
|||||||
USER_ATTRIBUTE_EXPIRES: mktime(now().timetuple()),
|
USER_ATTRIBUTE_EXPIRES: mktime(now().timetuple()),
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
clean_temporary_users.delay().get()
|
clean_temporary_users.send()
|
||||||
self.assertFalse(User.objects.filter(username=username))
|
self.assertFalse(User.objects.filter(username=username))
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ from authentik.core.tests.utils import (
|
|||||||
create_test_flow,
|
create_test_flow,
|
||||||
create_test_user,
|
create_test_user,
|
||||||
)
|
)
|
||||||
from authentik.flows.models import FlowDesignation
|
from authentik.flows.models import FlowAuthenticationRequirement, FlowDesignation
|
||||||
from authentik.lib.generators import generate_id, generate_key
|
from authentik.lib.generators import generate_id, generate_key
|
||||||
from authentik.stages.email.models import EmailStage
|
from authentik.stages.email.models import EmailStage
|
||||||
|
|
||||||
@@ -103,8 +103,11 @@ class TestUsersAPI(APITestCase):
|
|||||||
self.assertTrue(self.admin.check_password(new_pw))
|
self.assertTrue(self.admin.check_password(new_pw))
|
||||||
|
|
||||||
def test_recovery(self):
|
def test_recovery(self):
|
||||||
"""Test user recovery link (no recovery flow set)"""
|
"""Test user recovery link"""
|
||||||
flow = create_test_flow(FlowDesignation.RECOVERY)
|
flow = create_test_flow(
|
||||||
|
FlowDesignation.RECOVERY,
|
||||||
|
authentication=FlowAuthenticationRequirement.REQUIRE_UNAUTHENTICATED,
|
||||||
|
)
|
||||||
brand: Brand = create_test_brand()
|
brand: Brand = create_test_brand()
|
||||||
brand.flow_recovery = flow
|
brand.flow_recovery = flow
|
||||||
brand.save()
|
brand.save()
|
||||||
@@ -387,3 +390,72 @@ class TestUsersAPI(APITestCase):
|
|||||||
self.assertFalse(
|
self.assertFalse(
|
||||||
AuthenticatedSession.objects.filter(session__session_key=session_id).exists()
|
AuthenticatedSession.objects.filter(session__session_key=session_id).exists()
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def test_sort_by_last_updated(self):
|
||||||
|
"""Test API sorting by last_updated"""
|
||||||
|
User.objects.all().delete()
|
||||||
|
admin = create_test_admin_user()
|
||||||
|
self.client.force_login(admin)
|
||||||
|
|
||||||
|
user = create_test_user()
|
||||||
|
admin.first_name = "Sample change"
|
||||||
|
admin.last_name = "To trigger an update"
|
||||||
|
admin.save()
|
||||||
|
|
||||||
|
# Ascending
|
||||||
|
response = self.client.get(
|
||||||
|
reverse("authentik_api:user-list"),
|
||||||
|
data={
|
||||||
|
"ordering": "last_updated",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
self.assertEqual(response.status_code, 200)
|
||||||
|
|
||||||
|
body = loads(response.content)
|
||||||
|
self.assertEqual(len(body["results"]), 2)
|
||||||
|
self.assertEqual(body["results"][0]["pk"], user.pk)
|
||||||
|
|
||||||
|
# Descending
|
||||||
|
response = self.client.get(
|
||||||
|
reverse("authentik_api:user-list"),
|
||||||
|
data={
|
||||||
|
"ordering": "-last_updated",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
self.assertEqual(response.status_code, 200)
|
||||||
|
|
||||||
|
body = loads(response.content)
|
||||||
|
self.assertEqual(len(body["results"]), 2)
|
||||||
|
self.assertEqual(body["results"][0]["pk"], admin.pk)
|
||||||
|
|
||||||
|
def test_sort_by_date_joined(self):
|
||||||
|
"""Test API sorting by date_joined"""
|
||||||
|
User.objects.all().delete()
|
||||||
|
admin = create_test_admin_user()
|
||||||
|
self.client.force_login(admin)
|
||||||
|
|
||||||
|
user = create_test_user()
|
||||||
|
|
||||||
|
response = self.client.get(
|
||||||
|
reverse("authentik_api:user-list"),
|
||||||
|
data={
|
||||||
|
"ordering": "date_joined",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
self.assertEqual(response.status_code, 200)
|
||||||
|
|
||||||
|
body = loads(response.content)
|
||||||
|
self.assertEqual(len(body["results"]), 2)
|
||||||
|
self.assertEqual(body["results"][0]["pk"], admin.pk)
|
||||||
|
|
||||||
|
response = self.client.get(
|
||||||
|
reverse("authentik_api:user-list"),
|
||||||
|
data={
|
||||||
|
"ordering": "-date_joined",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
self.assertEqual(response.status_code, 200)
|
||||||
|
|
||||||
|
body = loads(response.content)
|
||||||
|
self.assertEqual(len(body["results"]), 2)
|
||||||
|
self.assertEqual(body["results"][0]["pk"], user.pk)
|
||||||
|
|||||||
@@ -4,6 +4,8 @@ from datetime import UTC, datetime
|
|||||||
|
|
||||||
from authentik.blueprints.apps import ManagedAppConfig
|
from authentik.blueprints.apps import ManagedAppConfig
|
||||||
from authentik.lib.generators import generate_id
|
from authentik.lib.generators import generate_id
|
||||||
|
from authentik.lib.utils.time import fqdn_rand
|
||||||
|
from authentik.tasks.schedules.common import ScheduleSpec
|
||||||
|
|
||||||
MANAGED_KEY = "goauthentik.io/crypto/jwt-managed"
|
MANAGED_KEY = "goauthentik.io/crypto/jwt-managed"
|
||||||
|
|
||||||
@@ -67,3 +69,14 @@ class AuthentikCryptoConfig(ManagedAppConfig):
|
|||||||
"key_data": builder.private_key,
|
"key_data": builder.private_key,
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def tenant_schedule_specs(self) -> list[ScheduleSpec]:
|
||||||
|
from authentik.crypto.tasks import certificate_discovery
|
||||||
|
|
||||||
|
return [
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=certificate_discovery,
|
||||||
|
crontab=f"{fqdn_rand('crypto_certificate_discovery')} * * * *",
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|||||||
@@ -1,13 +0,0 @@
|
|||||||
"""Crypto task Settings"""
|
|
||||||
|
|
||||||
from celery.schedules import crontab
|
|
||||||
|
|
||||||
from authentik.lib.utils.time import fqdn_rand
|
|
||||||
|
|
||||||
CELERY_BEAT_SCHEDULE = {
|
|
||||||
"crypto_certificate_discovery": {
|
|
||||||
"task": "authentik.crypto.tasks.certificate_discovery",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("crypto_certificate_discovery"), hour="*"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
@@ -7,13 +7,13 @@ from cryptography.hazmat.backends import default_backend
|
|||||||
from cryptography.hazmat.primitives.serialization import load_pem_private_key
|
from cryptography.hazmat.primitives.serialization import load_pem_private_key
|
||||||
from cryptography.x509.base import load_pem_x509_certificate
|
from cryptography.x509.base import load_pem_x509_certificate
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from django_dramatiq_postgres.middleware import CurrentTask
|
||||||
|
from dramatiq.actor import actor
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
|
|
||||||
from authentik.crypto.models import CertificateKeyPair
|
from authentik.crypto.models import CertificateKeyPair
|
||||||
from authentik.events.models import TaskStatus
|
|
||||||
from authentik.events.system_tasks import SystemTask, prefill_task
|
|
||||||
from authentik.lib.config import CONFIG
|
from authentik.lib.config import CONFIG
|
||||||
from authentik.root.celery import CELERY_APP
|
from authentik.tasks.models import Task
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
@@ -36,10 +36,9 @@ def ensure_certificate_valid(body: str):
|
|||||||
return body
|
return body
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(bind=True, base=SystemTask)
|
@actor(description=_("Discover, import and update certificates from the filesystem."))
|
||||||
@prefill_task
|
def certificate_discovery():
|
||||||
def certificate_discovery(self: SystemTask):
|
self: Task = CurrentTask.get_task()
|
||||||
"""Discover, import and update certificates from the filesystem"""
|
|
||||||
certs = {}
|
certs = {}
|
||||||
private_keys = {}
|
private_keys = {}
|
||||||
discovered = 0
|
discovered = 0
|
||||||
@@ -84,6 +83,4 @@ def certificate_discovery(self: SystemTask):
|
|||||||
dirty = True
|
dirty = True
|
||||||
if dirty:
|
if dirty:
|
||||||
cert.save()
|
cert.save()
|
||||||
self.set_status(
|
self.info(f"Successfully imported {discovered} files.")
|
||||||
TaskStatus.SUCCESSFUL, _("Successfully imported {count} files.".format(count=discovered))
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -338,7 +338,7 @@ class TestCrypto(APITestCase):
|
|||||||
with open(f"{temp_dir}/foo.bar/privkey.pem", "w+", encoding="utf-8") as _key:
|
with open(f"{temp_dir}/foo.bar/privkey.pem", "w+", encoding="utf-8") as _key:
|
||||||
_key.write(builder.private_key)
|
_key.write(builder.private_key)
|
||||||
with CONFIG.patch("cert_discovery_dir", temp_dir):
|
with CONFIG.patch("cert_discovery_dir", temp_dir):
|
||||||
certificate_discovery()
|
certificate_discovery.send()
|
||||||
keypair: CertificateKeyPair = CertificateKeyPair.objects.filter(
|
keypair: CertificateKeyPair = CertificateKeyPair.objects.filter(
|
||||||
managed=MANAGED_DISCOVERED % "foo"
|
managed=MANAGED_DISCOVERED % "foo"
|
||||||
).first()
|
).first()
|
||||||
|
|||||||
@@ -3,6 +3,8 @@
|
|||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
|
|
||||||
from authentik.blueprints.apps import ManagedAppConfig
|
from authentik.blueprints.apps import ManagedAppConfig
|
||||||
|
from authentik.lib.utils.time import fqdn_rand
|
||||||
|
from authentik.tasks.schedules.common import ScheduleSpec
|
||||||
|
|
||||||
|
|
||||||
class EnterpriseConfig(ManagedAppConfig):
|
class EnterpriseConfig(ManagedAppConfig):
|
||||||
@@ -26,3 +28,14 @@ class AuthentikEnterpriseConfig(EnterpriseConfig):
|
|||||||
from authentik.enterprise.license import LicenseKey
|
from authentik.enterprise.license import LicenseKey
|
||||||
|
|
||||||
return LicenseKey.cached_summary().status.is_valid
|
return LicenseKey.cached_summary().status.is_valid
|
||||||
|
|
||||||
|
@property
|
||||||
|
def tenant_schedule_specs(self) -> list[ScheduleSpec]:
|
||||||
|
from authentik.enterprise.tasks import enterprise_update_usage
|
||||||
|
|
||||||
|
return [
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=enterprise_update_usage,
|
||||||
|
crontab=f"{fqdn_rand('enterprise_update_usage')} */2 * * *",
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|||||||
@@ -55,6 +55,7 @@ class TestEnterpriseAudit(APITestCase):
|
|||||||
self.assertIsNotNone(event)
|
self.assertIsNotNone(event)
|
||||||
self.assertIsNotNone(event.context["diff"])
|
self.assertIsNotNone(event.context["diff"])
|
||||||
diff = event.context["diff"]
|
diff = event.context["diff"]
|
||||||
|
diff.pop("last_updated")
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
diff,
|
diff,
|
||||||
{
|
{
|
||||||
@@ -116,6 +117,7 @@ class TestEnterpriseAudit(APITestCase):
|
|||||||
self.assertIsNotNone(event)
|
self.assertIsNotNone(event)
|
||||||
self.assertIsNotNone(event.context["diff"])
|
self.assertIsNotNone(event.context["diff"])
|
||||||
diff = event.context["diff"]
|
diff = event.context["diff"]
|
||||||
|
diff.pop("last_updated")
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
diff,
|
diff,
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
"""authentik Unique Password policy app config"""
|
"""authentik Unique Password policy app config"""
|
||||||
|
|
||||||
from authentik.enterprise.apps import EnterpriseConfig
|
from authentik.enterprise.apps import EnterpriseConfig
|
||||||
|
from authentik.lib.utils.time import fqdn_rand
|
||||||
|
from authentik.tasks.schedules.common import ScheduleSpec
|
||||||
|
|
||||||
|
|
||||||
class AuthentikEnterprisePoliciesUniquePasswordConfig(EnterpriseConfig):
|
class AuthentikEnterprisePoliciesUniquePasswordConfig(EnterpriseConfig):
|
||||||
@@ -8,3 +10,21 @@ class AuthentikEnterprisePoliciesUniquePasswordConfig(EnterpriseConfig):
|
|||||||
label = "authentik_policies_unique_password"
|
label = "authentik_policies_unique_password"
|
||||||
verbose_name = "authentik Enterprise.Policies.Unique Password"
|
verbose_name = "authentik Enterprise.Policies.Unique Password"
|
||||||
default = True
|
default = True
|
||||||
|
|
||||||
|
@property
|
||||||
|
def tenant_schedule_specs(self) -> list[ScheduleSpec]:
|
||||||
|
from authentik.enterprise.policies.unique_password.tasks import (
|
||||||
|
check_and_purge_password_history,
|
||||||
|
trim_password_histories,
|
||||||
|
)
|
||||||
|
|
||||||
|
return [
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=trim_password_histories,
|
||||||
|
crontab=f"{fqdn_rand('policies_unique_password_trim')} */12 * * *",
|
||||||
|
),
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=check_and_purge_password_history,
|
||||||
|
crontab=f"{fqdn_rand('policies_unique_password_purge')} */24 * * *",
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|||||||
@@ -1,20 +0,0 @@
|
|||||||
"""Unique Password Policy settings"""
|
|
||||||
|
|
||||||
from celery.schedules import crontab
|
|
||||||
|
|
||||||
from authentik.lib.utils.time import fqdn_rand
|
|
||||||
|
|
||||||
CELERY_BEAT_SCHEDULE = {
|
|
||||||
"policies_unique_password_trim_history": {
|
|
||||||
"task": "authentik.enterprise.policies.unique_password.tasks.trim_password_histories",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("policies_unique_password_trim"), hour="*/12"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
},
|
|
||||||
"policies_unique_password_check_purge": {
|
|
||||||
"task": (
|
|
||||||
"authentik.enterprise.policies.unique_password.tasks.check_and_purge_password_history"
|
|
||||||
),
|
|
||||||
"schedule": crontab(minute=fqdn_rand("policies_unique_password_purge"), hour="*/24"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
@@ -1,35 +1,37 @@
|
|||||||
from django.db.models.aggregates import Count
|
from django.db.models.aggregates import Count
|
||||||
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from django_dramatiq_postgres.middleware import CurrentTask
|
||||||
|
from dramatiq.actor import actor
|
||||||
from structlog import get_logger
|
from structlog import get_logger
|
||||||
|
|
||||||
from authentik.enterprise.policies.unique_password.models import (
|
from authentik.enterprise.policies.unique_password.models import (
|
||||||
UniquePasswordPolicy,
|
UniquePasswordPolicy,
|
||||||
UserPasswordHistory,
|
UserPasswordHistory,
|
||||||
)
|
)
|
||||||
from authentik.events.system_tasks import SystemTask, TaskStatus, prefill_task
|
from authentik.tasks.models import Task
|
||||||
from authentik.root.celery import CELERY_APP
|
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(bind=True, base=SystemTask)
|
@actor(
|
||||||
@prefill_task
|
description=_(
|
||||||
def check_and_purge_password_history(self: SystemTask):
|
"Check if any UniquePasswordPolicy exists, and if not, purge the password history table."
|
||||||
"""Check if any UniquePasswordPolicy exists, and if not, purge the password history table.
|
)
|
||||||
This is run on a schedule instead of being triggered by policy binding deletion.
|
)
|
||||||
"""
|
def check_and_purge_password_history():
|
||||||
|
self: Task = CurrentTask.get_task()
|
||||||
|
|
||||||
if not UniquePasswordPolicy.objects.exists():
|
if not UniquePasswordPolicy.objects.exists():
|
||||||
UserPasswordHistory.objects.all().delete()
|
UserPasswordHistory.objects.all().delete()
|
||||||
LOGGER.debug("Purged UserPasswordHistory table as no policies are in use")
|
LOGGER.debug("Purged UserPasswordHistory table as no policies are in use")
|
||||||
self.set_status(TaskStatus.SUCCESSFUL, "Successfully purged UserPasswordHistory")
|
self.info("Successfully purged UserPasswordHistory")
|
||||||
return
|
return
|
||||||
|
|
||||||
self.set_status(
|
self.info("Not purging password histories, a unique password policy exists")
|
||||||
TaskStatus.SUCCESSFUL, "Not purging password histories, a unique password policy exists"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(bind=True, base=SystemTask)
|
@actor(description=_("Remove user password history that are too old."))
|
||||||
def trim_password_histories(self: SystemTask):
|
def trim_password_histories():
|
||||||
"""Removes rows from UserPasswordHistory older than
|
"""Removes rows from UserPasswordHistory older than
|
||||||
the `n` most recent entries.
|
the `n` most recent entries.
|
||||||
|
|
||||||
@@ -37,6 +39,8 @@ def trim_password_histories(self: SystemTask):
|
|||||||
UniquePasswordPolicy policies.
|
UniquePasswordPolicy policies.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
self: Task = CurrentTask.get_task()
|
||||||
|
|
||||||
# No policy, we'll let the cleanup above do its thing
|
# No policy, we'll let the cleanup above do its thing
|
||||||
if not UniquePasswordPolicy.objects.exists():
|
if not UniquePasswordPolicy.objects.exists():
|
||||||
return
|
return
|
||||||
@@ -63,4 +67,4 @@ def trim_password_histories(self: SystemTask):
|
|||||||
|
|
||||||
num_deleted, _ = UserPasswordHistory.objects.exclude(pk__in=all_pks_to_keep).delete()
|
num_deleted, _ = UserPasswordHistory.objects.exclude(pk__in=all_pks_to_keep).delete()
|
||||||
LOGGER.debug("Deleted stale password history records", count=num_deleted)
|
LOGGER.debug("Deleted stale password history records", count=num_deleted)
|
||||||
self.set_status(TaskStatus.SUCCESSFUL, f"Delete {num_deleted} stale password history records")
|
self.info(f"Delete {num_deleted} stale password history records")
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ class TestCheckAndPurgePasswordHistory(TestCase):
|
|||||||
self.assertTrue(UserPasswordHistory.objects.exists())
|
self.assertTrue(UserPasswordHistory.objects.exists())
|
||||||
|
|
||||||
# Run the task - should purge since no policy is in use
|
# Run the task - should purge since no policy is in use
|
||||||
check_and_purge_password_history()
|
check_and_purge_password_history.send()
|
||||||
|
|
||||||
# Verify the table is empty
|
# Verify the table is empty
|
||||||
self.assertFalse(UserPasswordHistory.objects.exists())
|
self.assertFalse(UserPasswordHistory.objects.exists())
|
||||||
@@ -99,7 +99,7 @@ class TestCheckAndPurgePasswordHistory(TestCase):
|
|||||||
self.assertTrue(UserPasswordHistory.objects.exists())
|
self.assertTrue(UserPasswordHistory.objects.exists())
|
||||||
|
|
||||||
# Run the task - should NOT purge since a policy is in use
|
# Run the task - should NOT purge since a policy is in use
|
||||||
check_and_purge_password_history()
|
check_and_purge_password_history.send()
|
||||||
|
|
||||||
# Verify the entries still exist
|
# Verify the entries still exist
|
||||||
self.assertTrue(UserPasswordHistory.objects.exists())
|
self.assertTrue(UserPasswordHistory.objects.exists())
|
||||||
@@ -142,7 +142,7 @@ class TestTrimPasswordHistory(TestCase):
|
|||||||
enabled=True,
|
enabled=True,
|
||||||
order=0,
|
order=0,
|
||||||
)
|
)
|
||||||
trim_password_histories.delay()
|
trim_password_histories.send()
|
||||||
user_pwd_history_qs = UserPasswordHistory.objects.filter(user=self.user)
|
user_pwd_history_qs = UserPasswordHistory.objects.filter(user=self.user)
|
||||||
self.assertEqual(len(user_pwd_history_qs), 1)
|
self.assertEqual(len(user_pwd_history_qs), 1)
|
||||||
|
|
||||||
@@ -159,7 +159,7 @@ class TestTrimPasswordHistory(TestCase):
|
|||||||
enabled=False,
|
enabled=False,
|
||||||
order=0,
|
order=0,
|
||||||
)
|
)
|
||||||
trim_password_histories.delay()
|
trim_password_histories.send()
|
||||||
self.assertTrue(UserPasswordHistory.objects.filter(user=self.user).exists())
|
self.assertTrue(UserPasswordHistory.objects.filter(user=self.user).exists())
|
||||||
|
|
||||||
def test_trim_password_history_fewer_records_than_maximum_is_no_op(self):
|
def test_trim_password_history_fewer_records_than_maximum_is_no_op(self):
|
||||||
@@ -174,5 +174,5 @@ class TestTrimPasswordHistory(TestCase):
|
|||||||
enabled=True,
|
enabled=True,
|
||||||
order=0,
|
order=0,
|
||||||
)
|
)
|
||||||
trim_password_histories.delay()
|
trim_password_histories.send()
|
||||||
self.assertTrue(UserPasswordHistory.objects.filter(user=self.user).exists())
|
self.assertTrue(UserPasswordHistory.objects.filter(user=self.user).exists())
|
||||||
|
|||||||
@@ -55,5 +55,5 @@ class GoogleWorkspaceProviderViewSet(OutgoingSyncProviderStatusMixin, UsedByMixi
|
|||||||
]
|
]
|
||||||
search_fields = ["name"]
|
search_fields = ["name"]
|
||||||
ordering = ["name"]
|
ordering = ["name"]
|
||||||
sync_single_task = google_workspace_sync
|
sync_task = google_workspace_sync
|
||||||
sync_objects_task = google_workspace_sync_objects
|
sync_objects_task = google_workspace_sync_objects
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ from django.db import models
|
|||||||
from django.db.models import QuerySet
|
from django.db.models import QuerySet
|
||||||
from django.templatetags.static import static
|
from django.templatetags.static import static
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from dramatiq.actor import Actor
|
||||||
from google.oauth2.service_account import Credentials
|
from google.oauth2.service_account import Credentials
|
||||||
from rest_framework.serializers import Serializer
|
from rest_framework.serializers import Serializer
|
||||||
|
|
||||||
@@ -110,6 +111,12 @@ class GoogleWorkspaceProvider(OutgoingSyncProvider, BackchannelProvider):
|
|||||||
help_text=_("Property mappings used for group creation/updating."),
|
help_text=_("Property mappings used for group creation/updating."),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def sync_actor(self) -> Actor:
|
||||||
|
from authentik.enterprise.providers.google_workspace.tasks import google_workspace_sync
|
||||||
|
|
||||||
|
return google_workspace_sync
|
||||||
|
|
||||||
def client_for_model(
|
def client_for_model(
|
||||||
self,
|
self,
|
||||||
model: type[User | Group | GoogleWorkspaceProviderUser | GoogleWorkspaceProviderGroup],
|
model: type[User | Group | GoogleWorkspaceProviderUser | GoogleWorkspaceProviderGroup],
|
||||||
|
|||||||
@@ -1,13 +0,0 @@
|
|||||||
"""Google workspace provider task Settings"""
|
|
||||||
|
|
||||||
from celery.schedules import crontab
|
|
||||||
|
|
||||||
from authentik.lib.utils.time import fqdn_rand
|
|
||||||
|
|
||||||
CELERY_BEAT_SCHEDULE = {
|
|
||||||
"providers_google_workspace_sync": {
|
|
||||||
"task": "authentik.enterprise.providers.google_workspace.tasks.google_workspace_sync_all",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("google_workspace_sync_all"), hour="*/4"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
@@ -2,15 +2,13 @@
|
|||||||
|
|
||||||
from authentik.enterprise.providers.google_workspace.models import GoogleWorkspaceProvider
|
from authentik.enterprise.providers.google_workspace.models import GoogleWorkspaceProvider
|
||||||
from authentik.enterprise.providers.google_workspace.tasks import (
|
from authentik.enterprise.providers.google_workspace.tasks import (
|
||||||
google_workspace_sync,
|
google_workspace_sync_direct_dispatch,
|
||||||
google_workspace_sync_direct,
|
google_workspace_sync_m2m_dispatch,
|
||||||
google_workspace_sync_m2m,
|
|
||||||
)
|
)
|
||||||
from authentik.lib.sync.outgoing.signals import register_signals
|
from authentik.lib.sync.outgoing.signals import register_signals
|
||||||
|
|
||||||
register_signals(
|
register_signals(
|
||||||
GoogleWorkspaceProvider,
|
GoogleWorkspaceProvider,
|
||||||
task_sync_single=google_workspace_sync,
|
task_sync_direct_dispatch=google_workspace_sync_direct_dispatch,
|
||||||
task_sync_direct=google_workspace_sync_direct,
|
task_sync_m2m_dispatch=google_workspace_sync_m2m_dispatch,
|
||||||
task_sync_m2m=google_workspace_sync_m2m,
|
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,37 +1,48 @@
|
|||||||
"""Google Provider tasks"""
|
"""Google Provider tasks"""
|
||||||
|
|
||||||
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from dramatiq.actor import actor
|
||||||
|
|
||||||
from authentik.enterprise.providers.google_workspace.models import GoogleWorkspaceProvider
|
from authentik.enterprise.providers.google_workspace.models import GoogleWorkspaceProvider
|
||||||
from authentik.events.system_tasks import SystemTask
|
|
||||||
from authentik.lib.sync.outgoing.exceptions import TransientSyncException
|
|
||||||
from authentik.lib.sync.outgoing.tasks import SyncTasks
|
from authentik.lib.sync.outgoing.tasks import SyncTasks
|
||||||
from authentik.root.celery import CELERY_APP
|
|
||||||
|
|
||||||
sync_tasks = SyncTasks(GoogleWorkspaceProvider)
|
sync_tasks = SyncTasks(GoogleWorkspaceProvider)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(autoretry_for=(TransientSyncException,), retry_backoff=True)
|
@actor(description=_("Sync Google Workspace provider objects."))
|
||||||
def google_workspace_sync_objects(*args, **kwargs):
|
def google_workspace_sync_objects(*args, **kwargs):
|
||||||
return sync_tasks.sync_objects(*args, **kwargs)
|
return sync_tasks.sync_objects(*args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(
|
@actor(description=_("Full sync for Google Workspace provider."))
|
||||||
base=SystemTask, bind=True, autoretry_for=(TransientSyncException,), retry_backoff=True
|
def google_workspace_sync(provider_pk: int, *args, **kwargs):
|
||||||
)
|
|
||||||
def google_workspace_sync(self, provider_pk: int, *args, **kwargs):
|
|
||||||
"""Run full sync for Google Workspace provider"""
|
"""Run full sync for Google Workspace provider"""
|
||||||
return sync_tasks.sync_single(self, provider_pk, google_workspace_sync_objects)
|
return sync_tasks.sync(provider_pk, google_workspace_sync_objects)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task()
|
@actor(description=_("Sync a direct object (user, group) for Google Workspace provider."))
|
||||||
def google_workspace_sync_all():
|
|
||||||
return sync_tasks.sync_all(google_workspace_sync)
|
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(autoretry_for=(TransientSyncException,), retry_backoff=True)
|
|
||||||
def google_workspace_sync_direct(*args, **kwargs):
|
def google_workspace_sync_direct(*args, **kwargs):
|
||||||
return sync_tasks.sync_signal_direct(*args, **kwargs)
|
return sync_tasks.sync_signal_direct(*args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(autoretry_for=(TransientSyncException,), retry_backoff=True)
|
@actor(
|
||||||
|
description=_(
|
||||||
|
"Dispatch syncs for a direct object (user, group) for Google Workspace providers."
|
||||||
|
)
|
||||||
|
)
|
||||||
|
def google_workspace_sync_direct_dispatch(*args, **kwargs):
|
||||||
|
return sync_tasks.sync_signal_direct_dispatch(google_workspace_sync_direct, *args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
|
@actor(description=_("Sync a related object (memberships) for Google Workspace provider."))
|
||||||
def google_workspace_sync_m2m(*args, **kwargs):
|
def google_workspace_sync_m2m(*args, **kwargs):
|
||||||
return sync_tasks.sync_signal_m2m(*args, **kwargs)
|
return sync_tasks.sync_signal_m2m(*args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
|
@actor(
|
||||||
|
description=_(
|
||||||
|
"Dispatch syncs for a related object (memberships) for Google Workspace providers."
|
||||||
|
)
|
||||||
|
)
|
||||||
|
def google_workspace_sync_m2m_dispatch(*args, **kwargs):
|
||||||
|
return sync_tasks.sync_signal_m2m_dispatch(google_workspace_sync_m2m, *args, **kwargs)
|
||||||
|
|||||||
@@ -324,7 +324,7 @@ class GoogleWorkspaceGroupTests(TestCase):
|
|||||||
"authentik.enterprise.providers.google_workspace.models.GoogleWorkspaceProvider.google_credentials",
|
"authentik.enterprise.providers.google_workspace.models.GoogleWorkspaceProvider.google_credentials",
|
||||||
MagicMock(return_value={"developerKey": self.api_key, "http": http}),
|
MagicMock(return_value={"developerKey": self.api_key, "http": http}),
|
||||||
):
|
):
|
||||||
google_workspace_sync.delay(self.provider.pk).get()
|
google_workspace_sync.send(self.provider.pk).get_result()
|
||||||
self.assertTrue(
|
self.assertTrue(
|
||||||
GoogleWorkspaceProviderGroup.objects.filter(
|
GoogleWorkspaceProviderGroup.objects.filter(
|
||||||
group=different_group, provider=self.provider
|
group=different_group, provider=self.provider
|
||||||
|
|||||||
@@ -302,7 +302,7 @@ class GoogleWorkspaceUserTests(TestCase):
|
|||||||
"authentik.enterprise.providers.google_workspace.models.GoogleWorkspaceProvider.google_credentials",
|
"authentik.enterprise.providers.google_workspace.models.GoogleWorkspaceProvider.google_credentials",
|
||||||
MagicMock(return_value={"developerKey": self.api_key, "http": http}),
|
MagicMock(return_value={"developerKey": self.api_key, "http": http}),
|
||||||
):
|
):
|
||||||
google_workspace_sync.delay(self.provider.pk).get()
|
google_workspace_sync.send(self.provider.pk).get_result()
|
||||||
self.assertTrue(
|
self.assertTrue(
|
||||||
GoogleWorkspaceProviderUser.objects.filter(
|
GoogleWorkspaceProviderUser.objects.filter(
|
||||||
user=different_user, provider=self.provider
|
user=different_user, provider=self.provider
|
||||||
|
|||||||
@@ -53,5 +53,5 @@ class MicrosoftEntraProviderViewSet(OutgoingSyncProviderStatusMixin, UsedByMixin
|
|||||||
]
|
]
|
||||||
search_fields = ["name"]
|
search_fields = ["name"]
|
||||||
ordering = ["name"]
|
ordering = ["name"]
|
||||||
sync_single_task = microsoft_entra_sync
|
sync_task = microsoft_entra_sync
|
||||||
sync_objects_task = microsoft_entra_sync_objects
|
sync_objects_task = microsoft_entra_sync_objects
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ from django.db import models
|
|||||||
from django.db.models import QuerySet
|
from django.db.models import QuerySet
|
||||||
from django.templatetags.static import static
|
from django.templatetags.static import static
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from dramatiq.actor import Actor
|
||||||
from rest_framework.serializers import Serializer
|
from rest_framework.serializers import Serializer
|
||||||
|
|
||||||
from authentik.core.models import (
|
from authentik.core.models import (
|
||||||
@@ -99,6 +100,12 @@ class MicrosoftEntraProvider(OutgoingSyncProvider, BackchannelProvider):
|
|||||||
help_text=_("Property mappings used for group creation/updating."),
|
help_text=_("Property mappings used for group creation/updating."),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def sync_actor(self) -> Actor:
|
||||||
|
from authentik.enterprise.providers.microsoft_entra.tasks import microsoft_entra_sync
|
||||||
|
|
||||||
|
return microsoft_entra_sync
|
||||||
|
|
||||||
def client_for_model(
|
def client_for_model(
|
||||||
self,
|
self,
|
||||||
model: type[User | Group | MicrosoftEntraProviderUser | MicrosoftEntraProviderGroup],
|
model: type[User | Group | MicrosoftEntraProviderUser | MicrosoftEntraProviderGroup],
|
||||||
|
|||||||
@@ -1,13 +0,0 @@
|
|||||||
"""Microsoft Entra provider task Settings"""
|
|
||||||
|
|
||||||
from celery.schedules import crontab
|
|
||||||
|
|
||||||
from authentik.lib.utils.time import fqdn_rand
|
|
||||||
|
|
||||||
CELERY_BEAT_SCHEDULE = {
|
|
||||||
"providers_microsoft_entra_sync": {
|
|
||||||
"task": "authentik.enterprise.providers.microsoft_entra.tasks.microsoft_entra_sync_all",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("microsoft_entra_sync_all"), hour="*/4"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
@@ -2,15 +2,13 @@
|
|||||||
|
|
||||||
from authentik.enterprise.providers.microsoft_entra.models import MicrosoftEntraProvider
|
from authentik.enterprise.providers.microsoft_entra.models import MicrosoftEntraProvider
|
||||||
from authentik.enterprise.providers.microsoft_entra.tasks import (
|
from authentik.enterprise.providers.microsoft_entra.tasks import (
|
||||||
microsoft_entra_sync,
|
microsoft_entra_sync_direct_dispatch,
|
||||||
microsoft_entra_sync_direct,
|
microsoft_entra_sync_m2m_dispatch,
|
||||||
microsoft_entra_sync_m2m,
|
|
||||||
)
|
)
|
||||||
from authentik.lib.sync.outgoing.signals import register_signals
|
from authentik.lib.sync.outgoing.signals import register_signals
|
||||||
|
|
||||||
register_signals(
|
register_signals(
|
||||||
MicrosoftEntraProvider,
|
MicrosoftEntraProvider,
|
||||||
task_sync_single=microsoft_entra_sync,
|
task_sync_direct_dispatch=microsoft_entra_sync_direct_dispatch,
|
||||||
task_sync_direct=microsoft_entra_sync_direct,
|
task_sync_m2m_dispatch=microsoft_entra_sync_m2m_dispatch,
|
||||||
task_sync_m2m=microsoft_entra_sync_m2m,
|
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,37 +1,46 @@
|
|||||||
"""Microsoft Entra Provider tasks"""
|
"""Microsoft Entra Provider tasks"""
|
||||||
|
|
||||||
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from dramatiq.actor import actor
|
||||||
|
|
||||||
from authentik.enterprise.providers.microsoft_entra.models import MicrosoftEntraProvider
|
from authentik.enterprise.providers.microsoft_entra.models import MicrosoftEntraProvider
|
||||||
from authentik.events.system_tasks import SystemTask
|
|
||||||
from authentik.lib.sync.outgoing.exceptions import TransientSyncException
|
|
||||||
from authentik.lib.sync.outgoing.tasks import SyncTasks
|
from authentik.lib.sync.outgoing.tasks import SyncTasks
|
||||||
from authentik.root.celery import CELERY_APP
|
|
||||||
|
|
||||||
sync_tasks = SyncTasks(MicrosoftEntraProvider)
|
sync_tasks = SyncTasks(MicrosoftEntraProvider)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(autoretry_for=(TransientSyncException,), retry_backoff=True)
|
@actor(description=_("Sync Microsoft Entra provider objects."))
|
||||||
def microsoft_entra_sync_objects(*args, **kwargs):
|
def microsoft_entra_sync_objects(*args, **kwargs):
|
||||||
return sync_tasks.sync_objects(*args, **kwargs)
|
return sync_tasks.sync_objects(*args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(
|
@actor(description=_("Full sync for Microsoft Entra provider."))
|
||||||
base=SystemTask, bind=True, autoretry_for=(TransientSyncException,), retry_backoff=True
|
def microsoft_entra_sync(provider_pk: int, *args, **kwargs):
|
||||||
)
|
|
||||||
def microsoft_entra_sync(self, provider_pk: int, *args, **kwargs):
|
|
||||||
"""Run full sync for Microsoft Entra provider"""
|
"""Run full sync for Microsoft Entra provider"""
|
||||||
return sync_tasks.sync_single(self, provider_pk, microsoft_entra_sync_objects)
|
return sync_tasks.sync(provider_pk, microsoft_entra_sync_objects)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task()
|
@actor(description=_("Sync a direct object (user, group) for Microsoft Entra provider."))
|
||||||
def microsoft_entra_sync_all():
|
|
||||||
return sync_tasks.sync_all(microsoft_entra_sync)
|
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(autoretry_for=(TransientSyncException,), retry_backoff=True)
|
|
||||||
def microsoft_entra_sync_direct(*args, **kwargs):
|
def microsoft_entra_sync_direct(*args, **kwargs):
|
||||||
return sync_tasks.sync_signal_direct(*args, **kwargs)
|
return sync_tasks.sync_signal_direct(*args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(autoretry_for=(TransientSyncException,), retry_backoff=True)
|
@actor(
|
||||||
|
description=_("Dispatch syncs for a direct object (user, group) for Microsoft Entra providers.")
|
||||||
|
)
|
||||||
|
def microsoft_entra_sync_direct_dispatch(*args, **kwargs):
|
||||||
|
return sync_tasks.sync_signal_direct_dispatch(microsoft_entra_sync_direct, *args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
|
@actor(description=_("Sync a related object (memberships) for Microsoft Entra provider."))
|
||||||
def microsoft_entra_sync_m2m(*args, **kwargs):
|
def microsoft_entra_sync_m2m(*args, **kwargs):
|
||||||
return sync_tasks.sync_signal_m2m(*args, **kwargs)
|
return sync_tasks.sync_signal_m2m(*args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
|
@actor(
|
||||||
|
description=_(
|
||||||
|
"Dispatch syncs for a related object (memberships) for Microsoft Entra providers."
|
||||||
|
)
|
||||||
|
)
|
||||||
|
def microsoft_entra_sync_m2m_dispatch(*args, **kwargs):
|
||||||
|
return sync_tasks.sync_signal_m2m_dispatch(microsoft_entra_sync_m2m, *args, **kwargs)
|
||||||
|
|||||||
@@ -252,9 +252,13 @@ class MicrosoftEntraGroupTests(TestCase):
|
|||||||
member_add.assert_called_once()
|
member_add.assert_called_once()
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
member_add.call_args[0][0].odata_id,
|
member_add.call_args[0][0].odata_id,
|
||||||
f"https://graph.microsoft.com/v1.0/directoryObjects/{MicrosoftEntraProviderUser.objects.filter(
|
f"https://graph.microsoft.com/v1.0/directoryObjects/{
|
||||||
|
MicrosoftEntraProviderUser.objects.filter(
|
||||||
provider=self.provider,
|
provider=self.provider,
|
||||||
).first().microsoft_id}",
|
)
|
||||||
|
.first()
|
||||||
|
.microsoft_id
|
||||||
|
}",
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_group_create_member_remove(self):
|
def test_group_create_member_remove(self):
|
||||||
@@ -311,9 +315,13 @@ class MicrosoftEntraGroupTests(TestCase):
|
|||||||
member_add.assert_called_once()
|
member_add.assert_called_once()
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
member_add.call_args[0][0].odata_id,
|
member_add.call_args[0][0].odata_id,
|
||||||
f"https://graph.microsoft.com/v1.0/directoryObjects/{MicrosoftEntraProviderUser.objects.filter(
|
f"https://graph.microsoft.com/v1.0/directoryObjects/{
|
||||||
|
MicrosoftEntraProviderUser.objects.filter(
|
||||||
provider=self.provider,
|
provider=self.provider,
|
||||||
).first().microsoft_id}",
|
)
|
||||||
|
.first()
|
||||||
|
.microsoft_id
|
||||||
|
}",
|
||||||
)
|
)
|
||||||
member_remove.assert_called_once()
|
member_remove.assert_called_once()
|
||||||
|
|
||||||
@@ -413,7 +421,7 @@ class MicrosoftEntraGroupTests(TestCase):
|
|||||||
),
|
),
|
||||||
) as group_list,
|
) as group_list,
|
||||||
):
|
):
|
||||||
microsoft_entra_sync.delay(self.provider.pk).get()
|
microsoft_entra_sync.send(self.provider.pk).get_result()
|
||||||
self.assertTrue(
|
self.assertTrue(
|
||||||
MicrosoftEntraProviderGroup.objects.filter(
|
MicrosoftEntraProviderGroup.objects.filter(
|
||||||
group=different_group, provider=self.provider
|
group=different_group, provider=self.provider
|
||||||
|
|||||||
@@ -397,7 +397,7 @@ class MicrosoftEntraUserTests(APITestCase):
|
|||||||
AsyncMock(return_value=GroupCollectionResponse(value=[])),
|
AsyncMock(return_value=GroupCollectionResponse(value=[])),
|
||||||
),
|
),
|
||||||
):
|
):
|
||||||
microsoft_entra_sync.delay(self.provider.pk).get()
|
microsoft_entra_sync.send(self.provider.pk).get_result()
|
||||||
self.assertTrue(
|
self.assertTrue(
|
||||||
MicrosoftEntraProviderUser.objects.filter(
|
MicrosoftEntraProviderUser.objects.filter(
|
||||||
user=different_user, provider=self.provider
|
user=different_user, provider=self.provider
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ from authentik.crypto.models import CertificateKeyPair
|
|||||||
from authentik.lib.models import CreatedUpdatedModel
|
from authentik.lib.models import CreatedUpdatedModel
|
||||||
from authentik.lib.utils.time import timedelta_from_string, timedelta_string_validator
|
from authentik.lib.utils.time import timedelta_from_string, timedelta_string_validator
|
||||||
from authentik.providers.oauth2.models import JWTAlgorithms, OAuth2Provider
|
from authentik.providers.oauth2.models import JWTAlgorithms, OAuth2Provider
|
||||||
|
from authentik.tasks.models import TasksModel
|
||||||
|
|
||||||
|
|
||||||
class EventTypes(models.TextChoices):
|
class EventTypes(models.TextChoices):
|
||||||
@@ -42,7 +43,7 @@ class SSFEventStatus(models.TextChoices):
|
|||||||
SENT = "sent"
|
SENT = "sent"
|
||||||
|
|
||||||
|
|
||||||
class SSFProvider(BackchannelProvider):
|
class SSFProvider(TasksModel, BackchannelProvider):
|
||||||
"""Shared Signals Framework provider to allow applications to
|
"""Shared Signals Framework provider to allow applications to
|
||||||
receive user events from authentik."""
|
receive user events from authentik."""
|
||||||
|
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ from authentik.enterprise.providers.ssf.models import (
|
|||||||
EventTypes,
|
EventTypes,
|
||||||
SSFProvider,
|
SSFProvider,
|
||||||
)
|
)
|
||||||
from authentik.enterprise.providers.ssf.tasks import send_ssf_event
|
from authentik.enterprise.providers.ssf.tasks import send_ssf_events
|
||||||
from authentik.events.middleware import audit_ignore
|
from authentik.events.middleware import audit_ignore
|
||||||
from authentik.stages.authenticator.models import Device
|
from authentik.stages.authenticator.models import Device
|
||||||
from authentik.stages.authenticator_duo.models import DuoDevice
|
from authentik.stages.authenticator_duo.models import DuoDevice
|
||||||
@@ -66,7 +66,7 @@ def ssf_user_session_delete_session_revoked(sender, instance: AuthenticatedSessi
|
|||||||
|
|
||||||
As this signal is also triggered with a regular logout, we can't be sure
|
As this signal is also triggered with a regular logout, we can't be sure
|
||||||
if the session has been deleted by an admin or by the user themselves."""
|
if the session has been deleted by an admin or by the user themselves."""
|
||||||
send_ssf_event(
|
send_ssf_events(
|
||||||
EventTypes.CAEP_SESSION_REVOKED,
|
EventTypes.CAEP_SESSION_REVOKED,
|
||||||
{
|
{
|
||||||
"initiating_entity": "user",
|
"initiating_entity": "user",
|
||||||
@@ -88,7 +88,7 @@ def ssf_user_session_delete_session_revoked(sender, instance: AuthenticatedSessi
|
|||||||
@receiver(password_changed)
|
@receiver(password_changed)
|
||||||
def ssf_password_changed_cred_change(sender, user: User, password: str | None, **_):
|
def ssf_password_changed_cred_change(sender, user: User, password: str | None, **_):
|
||||||
"""Credential change trigger (password changed)"""
|
"""Credential change trigger (password changed)"""
|
||||||
send_ssf_event(
|
send_ssf_events(
|
||||||
EventTypes.CAEP_CREDENTIAL_CHANGE,
|
EventTypes.CAEP_CREDENTIAL_CHANGE,
|
||||||
{
|
{
|
||||||
"credential_type": "password",
|
"credential_type": "password",
|
||||||
@@ -126,7 +126,7 @@ def ssf_device_post_save(sender: type[Model], instance: Device, created: bool, *
|
|||||||
}
|
}
|
||||||
if isinstance(instance, WebAuthnDevice) and instance.aaguid != UNKNOWN_DEVICE_TYPE_AAGUID:
|
if isinstance(instance, WebAuthnDevice) and instance.aaguid != UNKNOWN_DEVICE_TYPE_AAGUID:
|
||||||
data["fido2_aaguid"] = instance.aaguid
|
data["fido2_aaguid"] = instance.aaguid
|
||||||
send_ssf_event(
|
send_ssf_events(
|
||||||
EventTypes.CAEP_CREDENTIAL_CHANGE,
|
EventTypes.CAEP_CREDENTIAL_CHANGE,
|
||||||
data,
|
data,
|
||||||
sub_id={
|
sub_id={
|
||||||
@@ -153,7 +153,7 @@ def ssf_device_post_delete(sender: type[Model], instance: Device, **_):
|
|||||||
}
|
}
|
||||||
if isinstance(instance, WebAuthnDevice) and instance.aaguid != UNKNOWN_DEVICE_TYPE_AAGUID:
|
if isinstance(instance, WebAuthnDevice) and instance.aaguid != UNKNOWN_DEVICE_TYPE_AAGUID:
|
||||||
data["fido2_aaguid"] = instance.aaguid
|
data["fido2_aaguid"] = instance.aaguid
|
||||||
send_ssf_event(
|
send_ssf_events(
|
||||||
EventTypes.CAEP_CREDENTIAL_CHANGE,
|
EventTypes.CAEP_CREDENTIAL_CHANGE,
|
||||||
data,
|
data,
|
||||||
sub_id={
|
sub_id={
|
||||||
|
|||||||
@@ -1,7 +1,11 @@
|
|||||||
from celery import group
|
from typing import Any
|
||||||
|
from uuid import UUID
|
||||||
|
|
||||||
from django.http import HttpRequest
|
from django.http import HttpRequest
|
||||||
from django.utils.timezone import now
|
from django.utils.timezone import now
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from django_dramatiq_postgres.middleware import CurrentTask
|
||||||
|
from dramatiq.actor import actor
|
||||||
from requests.exceptions import RequestException
|
from requests.exceptions import RequestException
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
|
|
||||||
@@ -13,19 +17,16 @@ from authentik.enterprise.providers.ssf.models import (
|
|||||||
Stream,
|
Stream,
|
||||||
StreamEvent,
|
StreamEvent,
|
||||||
)
|
)
|
||||||
from authentik.events.logs import LogEvent
|
|
||||||
from authentik.events.models import TaskStatus
|
|
||||||
from authentik.events.system_tasks import SystemTask
|
|
||||||
from authentik.lib.utils.http import get_http_session
|
from authentik.lib.utils.http import get_http_session
|
||||||
from authentik.lib.utils.time import timedelta_from_string
|
from authentik.lib.utils.time import timedelta_from_string
|
||||||
from authentik.policies.engine import PolicyEngine
|
from authentik.policies.engine import PolicyEngine
|
||||||
from authentik.root.celery import CELERY_APP
|
from authentik.tasks.models import Task
|
||||||
|
|
||||||
session = get_http_session()
|
session = get_http_session()
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
def send_ssf_event(
|
def send_ssf_events(
|
||||||
event_type: EventTypes,
|
event_type: EventTypes,
|
||||||
data: dict,
|
data: dict,
|
||||||
stream_filter: dict | None = None,
|
stream_filter: dict | None = None,
|
||||||
@@ -33,7 +34,7 @@ def send_ssf_event(
|
|||||||
**extra_data,
|
**extra_data,
|
||||||
):
|
):
|
||||||
"""Wrapper to send an SSF event to multiple streams"""
|
"""Wrapper to send an SSF event to multiple streams"""
|
||||||
payload = []
|
events_data = {}
|
||||||
if not stream_filter:
|
if not stream_filter:
|
||||||
stream_filter = {}
|
stream_filter = {}
|
||||||
stream_filter["events_requested__contains"] = [event_type]
|
stream_filter["events_requested__contains"] = [event_type]
|
||||||
@@ -41,16 +42,22 @@ def send_ssf_event(
|
|||||||
extra_data.setdefault("txn", request.request_id)
|
extra_data.setdefault("txn", request.request_id)
|
||||||
for stream in Stream.objects.filter(**stream_filter):
|
for stream in Stream.objects.filter(**stream_filter):
|
||||||
event_data = stream.prepare_event_payload(event_type, data, **extra_data)
|
event_data = stream.prepare_event_payload(event_type, data, **extra_data)
|
||||||
payload.append((str(stream.uuid), event_data))
|
events_data[stream.uuid] = event_data
|
||||||
return _send_ssf_event.delay(payload)
|
ssf_events_dispatch.send(events_data)
|
||||||
|
|
||||||
|
|
||||||
def _check_app_access(stream_uuid: str, event_data: dict) -> bool:
|
@actor(description=_("Dispatch SSF events."))
|
||||||
|
def ssf_events_dispatch(events_data: dict[str, dict[str, Any]]):
|
||||||
|
for stream_uuid, event_data in events_data.items():
|
||||||
|
stream = Stream.objects.filter(pk=stream_uuid).first()
|
||||||
|
if not stream:
|
||||||
|
continue
|
||||||
|
send_ssf_event.send_with_options(args=(stream_uuid, event_data), rel_obj=stream.provider)
|
||||||
|
|
||||||
|
|
||||||
|
def _check_app_access(stream: Stream, event_data: dict) -> bool:
|
||||||
"""Check if event is related to user and if so, check
|
"""Check if event is related to user and if so, check
|
||||||
if the user has access to the application"""
|
if the user has access to the application"""
|
||||||
stream = Stream.objects.filter(pk=stream_uuid).first()
|
|
||||||
if not stream:
|
|
||||||
return False
|
|
||||||
# `event_data` is a dict version of a StreamEvent
|
# `event_data` is a dict version of a StreamEvent
|
||||||
sub_id = event_data.get("payload", {}).get("sub_id", {})
|
sub_id = event_data.get("payload", {}).get("sub_id", {})
|
||||||
email = sub_id.get("user", {}).get("email", None)
|
email = sub_id.get("user", {}).get("email", None)
|
||||||
@@ -65,42 +72,22 @@ def _check_app_access(stream_uuid: str, event_data: dict) -> bool:
|
|||||||
return engine.passing
|
return engine.passing
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task()
|
@actor(description=_("Send an SSF event."))
|
||||||
def _send_ssf_event(event_data: list[tuple[str, dict]]):
|
def send_ssf_event(stream_uuid: UUID, event_data: dict[str, Any]):
|
||||||
tasks = []
|
self: Task = CurrentTask.get_task()
|
||||||
for stream, data in event_data:
|
|
||||||
if not _check_app_access(stream, data):
|
|
||||||
continue
|
|
||||||
event = StreamEvent.objects.create(**data)
|
|
||||||
tasks.extend(send_single_ssf_event(stream, str(event.uuid)))
|
|
||||||
main_task = group(*tasks)
|
|
||||||
main_task()
|
|
||||||
|
|
||||||
|
stream = Stream.objects.filter(pk=stream_uuid).first()
|
||||||
def send_single_ssf_event(stream_id: str, evt_id: str):
|
|
||||||
stream = Stream.objects.filter(pk=stream_id).first()
|
|
||||||
if not stream:
|
if not stream:
|
||||||
return
|
return
|
||||||
event = StreamEvent.objects.filter(pk=evt_id).first()
|
if not _check_app_access(stream, event_data):
|
||||||
if not event:
|
|
||||||
return
|
return
|
||||||
|
event = StreamEvent.objects.create(**event_data)
|
||||||
|
self.set_uid(event.pk)
|
||||||
if event.status == SSFEventStatus.SENT:
|
if event.status == SSFEventStatus.SENT:
|
||||||
return
|
return
|
||||||
if stream.delivery_method == DeliveryMethods.RISC_PUSH:
|
if stream.delivery_method != DeliveryMethods.RISC_PUSH:
|
||||||
return [ssf_push_event.si(str(event.pk))]
|
|
||||||
return []
|
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(bind=True, base=SystemTask)
|
|
||||||
def ssf_push_event(self: SystemTask, event_id: str):
|
|
||||||
self.save_on_success = False
|
|
||||||
event = StreamEvent.objects.filter(pk=event_id).first()
|
|
||||||
if not event:
|
|
||||||
return
|
|
||||||
self.set_uid(event_id)
|
|
||||||
if event.status == SSFEventStatus.SENT:
|
|
||||||
self.set_status(TaskStatus.SUCCESSFUL)
|
|
||||||
return
|
return
|
||||||
|
|
||||||
try:
|
try:
|
||||||
response = session.post(
|
response = session.post(
|
||||||
event.stream.endpoint_url,
|
event.stream.endpoint_url,
|
||||||
@@ -110,26 +97,17 @@ def ssf_push_event(self: SystemTask, event_id: str):
|
|||||||
response.raise_for_status()
|
response.raise_for_status()
|
||||||
event.status = SSFEventStatus.SENT
|
event.status = SSFEventStatus.SENT
|
||||||
event.save()
|
event.save()
|
||||||
self.set_status(TaskStatus.SUCCESSFUL)
|
|
||||||
return
|
return
|
||||||
except RequestException as exc:
|
except RequestException as exc:
|
||||||
LOGGER.warning("Failed to send SSF event", exc=exc)
|
LOGGER.warning("Failed to send SSF event", exc=exc)
|
||||||
self.set_status(TaskStatus.ERROR)
|
|
||||||
attrs = {}
|
attrs = {}
|
||||||
if exc.response:
|
if exc.response:
|
||||||
attrs["response"] = {
|
attrs["response"] = {
|
||||||
"content": exc.response.text,
|
"content": exc.response.text,
|
||||||
"status": exc.response.status_code,
|
"status": exc.response.status_code,
|
||||||
}
|
}
|
||||||
self.set_error(
|
self.warning(exc)
|
||||||
exc,
|
self.warning("Failed to send request", **attrs)
|
||||||
LogEvent(
|
|
||||||
_("Failed to send request"),
|
|
||||||
log_level="warning",
|
|
||||||
logger=self.__name__,
|
|
||||||
attributes=attrs,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
# Re-up the expiry of the stream event
|
# Re-up the expiry of the stream event
|
||||||
event.expires = now() + timedelta_from_string(event.stream.provider.event_retention)
|
event.expires = now() + timedelta_from_string(event.stream.provider.event_retention)
|
||||||
event.status = SSFEventStatus.PENDING_FAILED
|
event.status = SSFEventStatus.PENDING_FAILED
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ from authentik.enterprise.providers.ssf.models import (
|
|||||||
SSFProvider,
|
SSFProvider,
|
||||||
Stream,
|
Stream,
|
||||||
)
|
)
|
||||||
from authentik.enterprise.providers.ssf.tasks import send_ssf_event
|
from authentik.enterprise.providers.ssf.tasks import send_ssf_events
|
||||||
from authentik.enterprise.providers.ssf.views.base import SSFView
|
from authentik.enterprise.providers.ssf.views.base import SSFView
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
@@ -109,7 +109,7 @@ class StreamView(SSFView):
|
|||||||
"User does not have permission to create stream for this provider."
|
"User does not have permission to create stream for this provider."
|
||||||
)
|
)
|
||||||
instance: Stream = stream.save(provider=self.provider)
|
instance: Stream = stream.save(provider=self.provider)
|
||||||
send_ssf_event(
|
send_ssf_events(
|
||||||
EventTypes.SET_VERIFICATION,
|
EventTypes.SET_VERIFICATION,
|
||||||
{
|
{
|
||||||
"state": None,
|
"state": None,
|
||||||
|
|||||||
@@ -1,17 +1,5 @@
|
|||||||
"""Enterprise additional settings"""
|
"""Enterprise additional settings"""
|
||||||
|
|
||||||
from celery.schedules import crontab
|
|
||||||
|
|
||||||
from authentik.lib.utils.time import fqdn_rand
|
|
||||||
|
|
||||||
CELERY_BEAT_SCHEDULE = {
|
|
||||||
"enterprise_update_usage": {
|
|
||||||
"task": "authentik.enterprise.tasks.enterprise_update_usage",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("enterprise_update_usage"), hour="*/2"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
TENANT_APPS = [
|
TENANT_APPS = [
|
||||||
"authentik.enterprise.audit",
|
"authentik.enterprise.audit",
|
||||||
"authentik.enterprise.policies.unique_password",
|
"authentik.enterprise.policies.unique_password",
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ from django.utils.timezone import get_current_timezone
|
|||||||
from authentik.enterprise.license import CACHE_KEY_ENTERPRISE_LICENSE
|
from authentik.enterprise.license import CACHE_KEY_ENTERPRISE_LICENSE
|
||||||
from authentik.enterprise.models import License
|
from authentik.enterprise.models import License
|
||||||
from authentik.enterprise.tasks import enterprise_update_usage
|
from authentik.enterprise.tasks import enterprise_update_usage
|
||||||
|
from authentik.tasks.schedules.models import Schedule
|
||||||
|
|
||||||
|
|
||||||
@receiver(pre_save, sender=License)
|
@receiver(pre_save, sender=License)
|
||||||
@@ -26,7 +27,7 @@ def pre_save_license(sender: type[License], instance: License, **_):
|
|||||||
def post_save_license(sender: type[License], instance: License, **_):
|
def post_save_license(sender: type[License], instance: License, **_):
|
||||||
"""Trigger license usage calculation when license is saved"""
|
"""Trigger license usage calculation when license is saved"""
|
||||||
cache.delete(CACHE_KEY_ENTERPRISE_LICENSE)
|
cache.delete(CACHE_KEY_ENTERPRISE_LICENSE)
|
||||||
enterprise_update_usage.delay()
|
Schedule.dispatch_by_actor(enterprise_update_usage)
|
||||||
|
|
||||||
|
|
||||||
@receiver(post_delete, sender=License)
|
@receiver(post_delete, sender=License)
|
||||||
|
|||||||
@@ -1,14 +1,11 @@
|
|||||||
"""Enterprise tasks"""
|
"""Enterprise tasks"""
|
||||||
|
|
||||||
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from dramatiq.actor import actor
|
||||||
|
|
||||||
from authentik.enterprise.license import LicenseKey
|
from authentik.enterprise.license import LicenseKey
|
||||||
from authentik.events.models import TaskStatus
|
|
||||||
from authentik.events.system_tasks import SystemTask, prefill_task
|
|
||||||
from authentik.root.celery import CELERY_APP
|
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(bind=True, base=SystemTask)
|
@actor(description=_("Update enterprise license status."))
|
||||||
@prefill_task
|
def enterprise_update_usage():
|
||||||
def enterprise_update_usage(self: SystemTask):
|
|
||||||
"""Update enterprise license status"""
|
|
||||||
LicenseKey.get_total().record_usage()
|
LicenseKey.get_total().record_usage()
|
||||||
self.set_status(TaskStatus.SUCCESSFUL)
|
|
||||||
|
|||||||
@@ -1,104 +0,0 @@
|
|||||||
"""Tasks API"""
|
|
||||||
|
|
||||||
from importlib import import_module
|
|
||||||
|
|
||||||
from django.contrib import messages
|
|
||||||
from django.utils.translation import gettext_lazy as _
|
|
||||||
from drf_spectacular.types import OpenApiTypes
|
|
||||||
from drf_spectacular.utils import OpenApiResponse, extend_schema
|
|
||||||
from rest_framework.decorators import action
|
|
||||||
from rest_framework.fields import (
|
|
||||||
CharField,
|
|
||||||
ChoiceField,
|
|
||||||
DateTimeField,
|
|
||||||
FloatField,
|
|
||||||
SerializerMethodField,
|
|
||||||
)
|
|
||||||
from rest_framework.request import Request
|
|
||||||
from rest_framework.response import Response
|
|
||||||
from rest_framework.viewsets import ReadOnlyModelViewSet
|
|
||||||
from structlog.stdlib import get_logger
|
|
||||||
|
|
||||||
from authentik.core.api.utils import ModelSerializer
|
|
||||||
from authentik.events.logs import LogEventSerializer
|
|
||||||
from authentik.events.models import SystemTask, TaskStatus
|
|
||||||
from authentik.rbac.decorators import permission_required
|
|
||||||
|
|
||||||
LOGGER = get_logger()
|
|
||||||
|
|
||||||
|
|
||||||
class SystemTaskSerializer(ModelSerializer):
|
|
||||||
"""Serialize TaskInfo and TaskResult"""
|
|
||||||
|
|
||||||
name = CharField()
|
|
||||||
full_name = SerializerMethodField()
|
|
||||||
uid = CharField(required=False)
|
|
||||||
description = CharField()
|
|
||||||
start_timestamp = DateTimeField(read_only=True)
|
|
||||||
finish_timestamp = DateTimeField(read_only=True)
|
|
||||||
duration = FloatField(read_only=True)
|
|
||||||
|
|
||||||
status = ChoiceField(choices=[(x.value, x.name) for x in TaskStatus])
|
|
||||||
messages = LogEventSerializer(many=True)
|
|
||||||
|
|
||||||
def get_full_name(self, instance: SystemTask) -> str:
|
|
||||||
"""Get full name with UID"""
|
|
||||||
if instance.uid:
|
|
||||||
return f"{instance.name}:{instance.uid}"
|
|
||||||
return instance.name
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
model = SystemTask
|
|
||||||
fields = [
|
|
||||||
"uuid",
|
|
||||||
"name",
|
|
||||||
"full_name",
|
|
||||||
"uid",
|
|
||||||
"description",
|
|
||||||
"start_timestamp",
|
|
||||||
"finish_timestamp",
|
|
||||||
"duration",
|
|
||||||
"status",
|
|
||||||
"messages",
|
|
||||||
"expires",
|
|
||||||
"expiring",
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
class SystemTaskViewSet(ReadOnlyModelViewSet):
|
|
||||||
"""Read-only view set that returns all background tasks"""
|
|
||||||
|
|
||||||
queryset = SystemTask.objects.all()
|
|
||||||
serializer_class = SystemTaskSerializer
|
|
||||||
filterset_fields = ["name", "uid", "status"]
|
|
||||||
ordering = ["name", "uid", "status"]
|
|
||||||
search_fields = ["name", "description", "uid", "status"]
|
|
||||||
|
|
||||||
@permission_required(None, ["authentik_events.run_task"])
|
|
||||||
@extend_schema(
|
|
||||||
request=OpenApiTypes.NONE,
|
|
||||||
responses={
|
|
||||||
204: OpenApiResponse(description="Task retried successfully"),
|
|
||||||
404: OpenApiResponse(description="Task not found"),
|
|
||||||
500: OpenApiResponse(description="Failed to retry task"),
|
|
||||||
},
|
|
||||||
)
|
|
||||||
@action(detail=True, methods=["POST"], permission_classes=[])
|
|
||||||
def run(self, request: Request, pk=None) -> Response:
|
|
||||||
"""Run task"""
|
|
||||||
task: SystemTask = self.get_object()
|
|
||||||
try:
|
|
||||||
task_module = import_module(task.task_call_module)
|
|
||||||
task_func = getattr(task_module, task.task_call_func)
|
|
||||||
LOGGER.info("Running task", task=task_func)
|
|
||||||
task_func.delay(*task.task_call_args, **task.task_call_kwargs)
|
|
||||||
messages.success(
|
|
||||||
self.request,
|
|
||||||
_("Successfully started task {name}.".format_map({"name": task.name})),
|
|
||||||
)
|
|
||||||
return Response(status=204)
|
|
||||||
except (ImportError, AttributeError) as exc: # pragma: no cover
|
|
||||||
LOGGER.warning("Failed to run task, remove state", task=task.name, exc=exc)
|
|
||||||
# if we get an import error, the module path has probably changed
|
|
||||||
task.delete()
|
|
||||||
return Response(status=500)
|
|
||||||
@@ -1,12 +1,11 @@
|
|||||||
"""authentik events app"""
|
"""authentik events app"""
|
||||||
|
|
||||||
from celery.schedules import crontab
|
|
||||||
from prometheus_client import Gauge, Histogram
|
from prometheus_client import Gauge, Histogram
|
||||||
|
|
||||||
from authentik.blueprints.apps import ManagedAppConfig
|
from authentik.blueprints.apps import ManagedAppConfig
|
||||||
from authentik.lib.config import CONFIG, ENV_PREFIX
|
from authentik.lib.config import CONFIG, ENV_PREFIX
|
||||||
from authentik.lib.utils.reflection import path_to_class
|
from authentik.lib.utils.time import fqdn_rand
|
||||||
from authentik.root.celery import CELERY_APP
|
from authentik.tasks.schedules.common import ScheduleSpec
|
||||||
|
|
||||||
# TODO: Deprecated metric - remove in 2024.2 or later
|
# TODO: Deprecated metric - remove in 2024.2 or later
|
||||||
GAUGE_TASKS = Gauge(
|
GAUGE_TASKS = Gauge(
|
||||||
@@ -35,6 +34,17 @@ class AuthentikEventsConfig(ManagedAppConfig):
|
|||||||
verbose_name = "authentik Events"
|
verbose_name = "authentik Events"
|
||||||
default = True
|
default = True
|
||||||
|
|
||||||
|
@property
|
||||||
|
def tenant_schedule_specs(self) -> list[ScheduleSpec]:
|
||||||
|
from authentik.events.tasks import notification_cleanup
|
||||||
|
|
||||||
|
return [
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=notification_cleanup,
|
||||||
|
crontab=f"{fqdn_rand('notification_cleanup')} */8 * * *",
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_global
|
@ManagedAppConfig.reconcile_global
|
||||||
def check_deprecations(self):
|
def check_deprecations(self):
|
||||||
"""Check for config deprecations"""
|
"""Check for config deprecations"""
|
||||||
@@ -56,41 +66,3 @@ class AuthentikEventsConfig(ManagedAppConfig):
|
|||||||
replacement_env=replace_env,
|
replacement_env=replace_env,
|
||||||
message=msg,
|
message=msg,
|
||||||
).save()
|
).save()
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_tenant
|
|
||||||
def prefill_tasks(self):
|
|
||||||
"""Prefill tasks"""
|
|
||||||
from authentik.events.models import SystemTask
|
|
||||||
from authentik.events.system_tasks import _prefill_tasks
|
|
||||||
|
|
||||||
for task in _prefill_tasks:
|
|
||||||
if SystemTask.objects.filter(name=task.name).exists():
|
|
||||||
continue
|
|
||||||
task.save()
|
|
||||||
self.logger.debug("prefilled task", task_name=task.name)
|
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_tenant
|
|
||||||
def run_scheduled_tasks(self):
|
|
||||||
"""Run schedule tasks which are behind schedule (only applies
|
|
||||||
to tasks of which we keep metrics)"""
|
|
||||||
from authentik.events.models import TaskStatus
|
|
||||||
from authentik.events.system_tasks import SystemTask as CelerySystemTask
|
|
||||||
|
|
||||||
for task in CELERY_APP.conf["beat_schedule"].values():
|
|
||||||
schedule = task["schedule"]
|
|
||||||
if not isinstance(schedule, crontab):
|
|
||||||
continue
|
|
||||||
task_class: CelerySystemTask = path_to_class(task["task"])
|
|
||||||
if not isinstance(task_class, CelerySystemTask):
|
|
||||||
continue
|
|
||||||
db_task = task_class.db()
|
|
||||||
if not db_task:
|
|
||||||
continue
|
|
||||||
due, _ = schedule.is_due(db_task.finish_timestamp)
|
|
||||||
if due or db_task.status == TaskStatus.UNKNOWN:
|
|
||||||
self.logger.debug("Running past-due scheduled task", task=task["task"])
|
|
||||||
task_class.apply_async(
|
|
||||||
args=task.get("args", None),
|
|
||||||
kwargs=task.get("kwargs", None),
|
|
||||||
**task.get("options", {}),
|
|
||||||
)
|
|
||||||
|
|||||||
22
authentik/events/migrations/0011_alter_systemtask_options.py
Normal file
22
authentik/events/migrations/0011_alter_systemtask_options.py
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# Generated by Django 5.1.11 on 2025-06-24 15:36
|
||||||
|
|
||||||
|
from django.db import migrations
|
||||||
|
|
||||||
|
|
||||||
|
class Migration(migrations.Migration):
|
||||||
|
|
||||||
|
dependencies = [
|
||||||
|
("authentik_events", "0010_rename_group_notificationrule_destination_group_and_more"),
|
||||||
|
]
|
||||||
|
|
||||||
|
operations = [
|
||||||
|
migrations.AlterModelOptions(
|
||||||
|
name="systemtask",
|
||||||
|
options={
|
||||||
|
"default_permissions": (),
|
||||||
|
"permissions": (),
|
||||||
|
"verbose_name": "System Task",
|
||||||
|
"verbose_name_plural": "System Tasks",
|
||||||
|
},
|
||||||
|
),
|
||||||
|
]
|
||||||
@@ -5,12 +5,11 @@ from datetime import timedelta
|
|||||||
from difflib import get_close_matches
|
from difflib import get_close_matches
|
||||||
from functools import lru_cache
|
from functools import lru_cache
|
||||||
from inspect import currentframe
|
from inspect import currentframe
|
||||||
from smtplib import SMTPException
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
from uuid import uuid4
|
from uuid import uuid4
|
||||||
|
|
||||||
from django.apps import apps
|
from django.apps import apps
|
||||||
from django.db import connection, models
|
from django.db import models
|
||||||
from django.http import HttpRequest
|
from django.http import HttpRequest
|
||||||
from django.http.request import QueryDict
|
from django.http.request import QueryDict
|
||||||
from django.utils.timezone import now
|
from django.utils.timezone import now
|
||||||
@@ -27,7 +26,6 @@ from authentik.core.middleware import (
|
|||||||
SESSION_KEY_IMPERSONATE_USER,
|
SESSION_KEY_IMPERSONATE_USER,
|
||||||
)
|
)
|
||||||
from authentik.core.models import ExpiringModel, Group, PropertyMapping, User
|
from authentik.core.models import ExpiringModel, Group, PropertyMapping, User
|
||||||
from authentik.events.apps import GAUGE_TASKS, SYSTEM_TASK_STATUS, SYSTEM_TASK_TIME
|
|
||||||
from authentik.events.context_processors.base import get_context_processors
|
from authentik.events.context_processors.base import get_context_processors
|
||||||
from authentik.events.utils import (
|
from authentik.events.utils import (
|
||||||
cleanse_dict,
|
cleanse_dict,
|
||||||
@@ -44,6 +42,7 @@ from authentik.lib.utils.time import timedelta_from_string
|
|||||||
from authentik.policies.models import PolicyBindingModel
|
from authentik.policies.models import PolicyBindingModel
|
||||||
from authentik.root.middleware import ClientIPMiddleware
|
from authentik.root.middleware import ClientIPMiddleware
|
||||||
from authentik.stages.email.utils import TemplateEmailMessage
|
from authentik.stages.email.utils import TemplateEmailMessage
|
||||||
|
from authentik.tasks.models import TasksModel
|
||||||
from authentik.tenants.models import Tenant
|
from authentik.tenants.models import Tenant
|
||||||
from authentik.tenants.utils import get_current_tenant
|
from authentik.tenants.utils import get_current_tenant
|
||||||
|
|
||||||
@@ -274,7 +273,8 @@ class Event(SerializerModel, ExpiringModel):
|
|||||||
models.Index(fields=["created"]),
|
models.Index(fields=["created"]),
|
||||||
models.Index(fields=["client_ip"]),
|
models.Index(fields=["client_ip"]),
|
||||||
models.Index(
|
models.Index(
|
||||||
models.F("context__authorized_application"), name="authentik_e_ctx_app__idx"
|
models.F("context__authorized_application"),
|
||||||
|
name="authentik_e_ctx_app__idx",
|
||||||
),
|
),
|
||||||
]
|
]
|
||||||
|
|
||||||
@@ -288,7 +288,7 @@ class TransportMode(models.TextChoices):
|
|||||||
EMAIL = "email", _("Email")
|
EMAIL = "email", _("Email")
|
||||||
|
|
||||||
|
|
||||||
class NotificationTransport(SerializerModel):
|
class NotificationTransport(TasksModel, SerializerModel):
|
||||||
"""Action which is executed when a Rule matches"""
|
"""Action which is executed when a Rule matches"""
|
||||||
|
|
||||||
uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4)
|
uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4)
|
||||||
@@ -453,6 +453,8 @@ class NotificationTransport(SerializerModel):
|
|||||||
|
|
||||||
def send_email(self, notification: "Notification") -> list[str]:
|
def send_email(self, notification: "Notification") -> list[str]:
|
||||||
"""Send notification via global email configuration"""
|
"""Send notification via global email configuration"""
|
||||||
|
from authentik.stages.email.tasks import send_mail
|
||||||
|
|
||||||
if notification.user.email.strip() == "":
|
if notification.user.email.strip() == "":
|
||||||
LOGGER.info(
|
LOGGER.info(
|
||||||
"Discarding notification as user has no email address",
|
"Discarding notification as user has no email address",
|
||||||
@@ -494,17 +496,14 @@ class NotificationTransport(SerializerModel):
|
|||||||
template_name="email/event_notification.html",
|
template_name="email/event_notification.html",
|
||||||
template_context=context,
|
template_context=context,
|
||||||
)
|
)
|
||||||
# Email is sent directly here, as the call to send() should have been from a task.
|
send_mail.send_with_options(args=(mail.__dict__,), rel_obj=self)
|
||||||
try:
|
return []
|
||||||
from authentik.stages.email.tasks import send_mail
|
|
||||||
|
|
||||||
return send_mail(mail.__dict__)
|
|
||||||
except (SMTPException, ConnectionError, OSError) as exc:
|
|
||||||
raise NotificationTransportError(exc) from exc
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def serializer(self) -> type[Serializer]:
|
def serializer(self) -> type[Serializer]:
|
||||||
from authentik.events.api.notification_transports import NotificationTransportSerializer
|
from authentik.events.api.notification_transports import (
|
||||||
|
NotificationTransportSerializer,
|
||||||
|
)
|
||||||
|
|
||||||
return NotificationTransportSerializer
|
return NotificationTransportSerializer
|
||||||
|
|
||||||
@@ -554,7 +553,7 @@ class Notification(SerializerModel):
|
|||||||
verbose_name_plural = _("Notifications")
|
verbose_name_plural = _("Notifications")
|
||||||
|
|
||||||
|
|
||||||
class NotificationRule(SerializerModel, PolicyBindingModel):
|
class NotificationRule(TasksModel, SerializerModel, PolicyBindingModel):
|
||||||
"""Decide when to create a Notification based on policies attached to this object."""
|
"""Decide when to create a Notification based on policies attached to this object."""
|
||||||
|
|
||||||
name = models.TextField(unique=True)
|
name = models.TextField(unique=True)
|
||||||
@@ -618,7 +617,9 @@ class NotificationWebhookMapping(PropertyMapping):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def serializer(self) -> type[type[Serializer]]:
|
def serializer(self) -> type[type[Serializer]]:
|
||||||
from authentik.events.api.notification_mappings import NotificationWebhookMappingSerializer
|
from authentik.events.api.notification_mappings import (
|
||||||
|
NotificationWebhookMappingSerializer,
|
||||||
|
)
|
||||||
|
|
||||||
return NotificationWebhookMappingSerializer
|
return NotificationWebhookMappingSerializer
|
||||||
|
|
||||||
@@ -631,7 +632,7 @@ class NotificationWebhookMapping(PropertyMapping):
|
|||||||
|
|
||||||
|
|
||||||
class TaskStatus(models.TextChoices):
|
class TaskStatus(models.TextChoices):
|
||||||
"""Possible states of tasks"""
|
"""DEPRECATED do not use"""
|
||||||
|
|
||||||
UNKNOWN = "unknown"
|
UNKNOWN = "unknown"
|
||||||
SUCCESSFUL = "successful"
|
SUCCESSFUL = "successful"
|
||||||
@@ -639,8 +640,8 @@ class TaskStatus(models.TextChoices):
|
|||||||
ERROR = "error"
|
ERROR = "error"
|
||||||
|
|
||||||
|
|
||||||
class SystemTask(SerializerModel, ExpiringModel):
|
class SystemTask(ExpiringModel):
|
||||||
"""Info about a system task running in the background along with details to restart the task"""
|
"""DEPRECATED do not use"""
|
||||||
|
|
||||||
uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4)
|
uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4)
|
||||||
name = models.TextField()
|
name = models.TextField()
|
||||||
@@ -660,41 +661,13 @@ class SystemTask(SerializerModel, ExpiringModel):
|
|||||||
task_call_args = models.JSONField(default=list)
|
task_call_args = models.JSONField(default=list)
|
||||||
task_call_kwargs = models.JSONField(default=dict)
|
task_call_kwargs = models.JSONField(default=dict)
|
||||||
|
|
||||||
@property
|
|
||||||
def serializer(self) -> type[Serializer]:
|
|
||||||
from authentik.events.api.tasks import SystemTaskSerializer
|
|
||||||
|
|
||||||
return SystemTaskSerializer
|
|
||||||
|
|
||||||
def update_metrics(self):
|
|
||||||
"""Update prometheus metrics"""
|
|
||||||
# TODO: Deprecated metric - remove in 2024.2 or later
|
|
||||||
GAUGE_TASKS.labels(
|
|
||||||
tenant=connection.schema_name,
|
|
||||||
task_name=self.name,
|
|
||||||
task_uid=self.uid or "",
|
|
||||||
status=self.status.lower(),
|
|
||||||
).set(self.duration)
|
|
||||||
SYSTEM_TASK_TIME.labels(
|
|
||||||
tenant=connection.schema_name,
|
|
||||||
task_name=self.name,
|
|
||||||
task_uid=self.uid or "",
|
|
||||||
).observe(self.duration)
|
|
||||||
SYSTEM_TASK_STATUS.labels(
|
|
||||||
tenant=connection.schema_name,
|
|
||||||
task_name=self.name,
|
|
||||||
task_uid=self.uid or "",
|
|
||||||
status=self.status.lower(),
|
|
||||||
).inc()
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
def __str__(self) -> str:
|
||||||
return f"System Task {self.name}"
|
return f"System Task {self.name}"
|
||||||
|
|
||||||
class Meta:
|
class Meta:
|
||||||
unique_together = (("name", "uid"),)
|
unique_together = (("name", "uid"),)
|
||||||
# Remove "add", "change" and "delete" permissions as those are not used
|
default_permissions = ()
|
||||||
default_permissions = ["view"]
|
permissions = ()
|
||||||
permissions = [("run_task", _("Run task"))]
|
|
||||||
verbose_name = _("System Task")
|
verbose_name = _("System Task")
|
||||||
verbose_name_plural = _("System Tasks")
|
verbose_name_plural = _("System Tasks")
|
||||||
indexes = ExpiringModel.Meta.indexes
|
indexes = ExpiringModel.Meta.indexes
|
||||||
|
|||||||
@@ -1,13 +0,0 @@
|
|||||||
"""Event Settings"""
|
|
||||||
|
|
||||||
from celery.schedules import crontab
|
|
||||||
|
|
||||||
from authentik.lib.utils.time import fqdn_rand
|
|
||||||
|
|
||||||
CELERY_BEAT_SCHEDULE = {
|
|
||||||
"events_notification_cleanup": {
|
|
||||||
"task": "authentik.events.tasks.notification_cleanup",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("notification_cleanup"), hour="*/8"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
@@ -12,13 +12,10 @@ from rest_framework.request import Request
|
|||||||
|
|
||||||
from authentik.core.models import AuthenticatedSession, User
|
from authentik.core.models import AuthenticatedSession, User
|
||||||
from authentik.core.signals import login_failed, password_changed
|
from authentik.core.signals import login_failed, password_changed
|
||||||
from authentik.events.apps import SYSTEM_TASK_STATUS
|
from authentik.events.models import Event, EventAction
|
||||||
from authentik.events.models import Event, EventAction, SystemTask
|
|
||||||
from authentik.events.tasks import event_notification_handler, gdpr_cleanup
|
|
||||||
from authentik.flows.models import Stage
|
from authentik.flows.models import Stage
|
||||||
from authentik.flows.planner import PLAN_CONTEXT_OUTPOST, PLAN_CONTEXT_SOURCE, FlowPlan
|
from authentik.flows.planner import PLAN_CONTEXT_OUTPOST, PLAN_CONTEXT_SOURCE, FlowPlan
|
||||||
from authentik.flows.views.executor import SESSION_KEY_PLAN
|
from authentik.flows.views.executor import SESSION_KEY_PLAN
|
||||||
from authentik.root.monitoring import monitoring_set
|
|
||||||
from authentik.stages.invitation.models import Invitation
|
from authentik.stages.invitation.models import Invitation
|
||||||
from authentik.stages.invitation.signals import invitation_used
|
from authentik.stages.invitation.signals import invitation_used
|
||||||
from authentik.stages.password.stage import PLAN_CONTEXT_METHOD, PLAN_CONTEXT_METHOD_ARGS
|
from authentik.stages.password.stage import PLAN_CONTEXT_METHOD, PLAN_CONTEXT_METHOD_ARGS
|
||||||
@@ -114,19 +111,15 @@ def on_password_changed(sender, user: User, password: str, request: HttpRequest
|
|||||||
@receiver(post_save, sender=Event)
|
@receiver(post_save, sender=Event)
|
||||||
def event_post_save_notification(sender, instance: Event, **_):
|
def event_post_save_notification(sender, instance: Event, **_):
|
||||||
"""Start task to check if any policies trigger an notification on this event"""
|
"""Start task to check if any policies trigger an notification on this event"""
|
||||||
event_notification_handler.delay(instance.event_uuid.hex)
|
from authentik.events.tasks import event_trigger_dispatch
|
||||||
|
|
||||||
|
event_trigger_dispatch.send(instance.event_uuid)
|
||||||
|
|
||||||
|
|
||||||
@receiver(pre_delete, sender=User)
|
@receiver(pre_delete, sender=User)
|
||||||
def event_user_pre_delete_cleanup(sender, instance: User, **_):
|
def event_user_pre_delete_cleanup(sender, instance: User, **_):
|
||||||
"""If gdpr_compliance is enabled, remove all the user's events"""
|
"""If gdpr_compliance is enabled, remove all the user's events"""
|
||||||
|
from authentik.events.tasks import gdpr_cleanup
|
||||||
|
|
||||||
if get_current_tenant().gdpr_compliance:
|
if get_current_tenant().gdpr_compliance:
|
||||||
gdpr_cleanup.delay(instance.pk)
|
gdpr_cleanup.send(instance.pk)
|
||||||
|
|
||||||
|
|
||||||
@receiver(monitoring_set)
|
|
||||||
def monitoring_system_task(sender, **_):
|
|
||||||
"""Update metrics when task is saved"""
|
|
||||||
SYSTEM_TASK_STATUS.clear()
|
|
||||||
for task in SystemTask.objects.all():
|
|
||||||
task.update_metrics()
|
|
||||||
|
|||||||
@@ -1,156 +0,0 @@
|
|||||||
"""Monitored tasks"""
|
|
||||||
|
|
||||||
from datetime import datetime, timedelta
|
|
||||||
from time import perf_counter
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
from django.utils.timezone import now
|
|
||||||
from django.utils.translation import gettext_lazy as _
|
|
||||||
from structlog.stdlib import BoundLogger, get_logger
|
|
||||||
from tenant_schemas_celery.task import TenantTask
|
|
||||||
|
|
||||||
from authentik.events.logs import LogEvent
|
|
||||||
from authentik.events.models import Event, EventAction, TaskStatus
|
|
||||||
from authentik.events.models import SystemTask as DBSystemTask
|
|
||||||
from authentik.events.utils import sanitize_item
|
|
||||||
from authentik.lib.utils.errors import exception_to_string
|
|
||||||
|
|
||||||
|
|
||||||
class SystemTask(TenantTask):
|
|
||||||
"""Task which can save its state to the cache"""
|
|
||||||
|
|
||||||
logger: BoundLogger
|
|
||||||
|
|
||||||
# For tasks that should only be listed if they failed, set this to False
|
|
||||||
save_on_success: bool
|
|
||||||
|
|
||||||
_status: TaskStatus
|
|
||||||
_messages: list[LogEvent]
|
|
||||||
|
|
||||||
_uid: str | None
|
|
||||||
# Precise start time from perf_counter
|
|
||||||
_start_precise: float | None = None
|
|
||||||
_start: datetime | None = None
|
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs) -> None:
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
self._status = TaskStatus.SUCCESSFUL
|
|
||||||
self.save_on_success = True
|
|
||||||
self._uid = None
|
|
||||||
self._status = None
|
|
||||||
self._messages = []
|
|
||||||
self.result_timeout_hours = 6
|
|
||||||
|
|
||||||
def set_uid(self, uid: str):
|
|
||||||
"""Set UID, so in the case of an unexpected error its saved correctly"""
|
|
||||||
self._uid = uid
|
|
||||||
|
|
||||||
def set_status(self, status: TaskStatus, *messages: LogEvent):
|
|
||||||
"""Set result for current run, will overwrite previous result."""
|
|
||||||
self._status = status
|
|
||||||
self._messages = list(messages)
|
|
||||||
for idx, msg in enumerate(self._messages):
|
|
||||||
if not isinstance(msg, LogEvent):
|
|
||||||
self._messages[idx] = LogEvent(msg, logger=self.__name__, log_level="info")
|
|
||||||
|
|
||||||
def set_error(self, exception: Exception, *messages: LogEvent):
|
|
||||||
"""Set result to error and save exception"""
|
|
||||||
self._status = TaskStatus.ERROR
|
|
||||||
self._messages = list(messages)
|
|
||||||
self._messages.extend(
|
|
||||||
[LogEvent(exception_to_string(exception), logger=self.__name__, log_level="error")]
|
|
||||||
)
|
|
||||||
|
|
||||||
def before_start(self, task_id, args, kwargs):
|
|
||||||
self._start_precise = perf_counter()
|
|
||||||
self._start = now()
|
|
||||||
self.logger = get_logger().bind(task_id=task_id)
|
|
||||||
return super().before_start(task_id, args, kwargs)
|
|
||||||
|
|
||||||
def db(self) -> DBSystemTask | None:
|
|
||||||
"""Get DB object for latest task"""
|
|
||||||
return DBSystemTask.objects.filter(
|
|
||||||
name=self.__name__,
|
|
||||||
uid=self._uid,
|
|
||||||
).first()
|
|
||||||
|
|
||||||
def after_return(self, status, retval, task_id, args: list[Any], kwargs: dict[str, Any], einfo):
|
|
||||||
super().after_return(status, retval, task_id, args, kwargs, einfo=einfo)
|
|
||||||
if not self._status:
|
|
||||||
return
|
|
||||||
if self._status == TaskStatus.SUCCESSFUL and not self.save_on_success:
|
|
||||||
DBSystemTask.objects.filter(
|
|
||||||
name=self.__name__,
|
|
||||||
uid=self._uid,
|
|
||||||
).delete()
|
|
||||||
return
|
|
||||||
DBSystemTask.objects.update_or_create(
|
|
||||||
name=self.__name__,
|
|
||||||
uid=self._uid,
|
|
||||||
defaults={
|
|
||||||
"description": self.__doc__,
|
|
||||||
"start_timestamp": self._start or now(),
|
|
||||||
"finish_timestamp": now(),
|
|
||||||
"duration": max(perf_counter() - self._start_precise, 0),
|
|
||||||
"task_call_module": self.__module__,
|
|
||||||
"task_call_func": self.__name__,
|
|
||||||
"task_call_args": sanitize_item(args),
|
|
||||||
"task_call_kwargs": sanitize_item(kwargs),
|
|
||||||
"status": self._status,
|
|
||||||
"messages": sanitize_item(self._messages),
|
|
||||||
"expires": now() + timedelta(hours=self.result_timeout_hours),
|
|
||||||
"expiring": True,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
def on_failure(self, exc, task_id, args, kwargs, einfo):
|
|
||||||
super().on_failure(exc, task_id, args, kwargs, einfo=einfo)
|
|
||||||
if not self._status:
|
|
||||||
self.set_error(exc)
|
|
||||||
DBSystemTask.objects.update_or_create(
|
|
||||||
name=self.__name__,
|
|
||||||
uid=self._uid,
|
|
||||||
defaults={
|
|
||||||
"description": self.__doc__,
|
|
||||||
"start_timestamp": self._start or now(),
|
|
||||||
"finish_timestamp": now(),
|
|
||||||
"duration": max(perf_counter() - self._start_precise, 0),
|
|
||||||
"task_call_module": self.__module__,
|
|
||||||
"task_call_func": self.__name__,
|
|
||||||
"task_call_args": sanitize_item(args),
|
|
||||||
"task_call_kwargs": sanitize_item(kwargs),
|
|
||||||
"status": self._status,
|
|
||||||
"messages": sanitize_item(self._messages),
|
|
||||||
"expires": now() + timedelta(hours=self.result_timeout_hours + 3),
|
|
||||||
"expiring": True,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
Event.new(
|
|
||||||
EventAction.SYSTEM_TASK_EXCEPTION,
|
|
||||||
message=f"Task {self.__name__} encountered an error",
|
|
||||||
).with_exception(exc).save()
|
|
||||||
|
|
||||||
def run(self, *args, **kwargs):
|
|
||||||
raise NotImplementedError
|
|
||||||
|
|
||||||
|
|
||||||
def prefill_task(func):
|
|
||||||
"""Ensure a task's details are always in cache, so it can always be triggered via API"""
|
|
||||||
_prefill_tasks.append(
|
|
||||||
DBSystemTask(
|
|
||||||
name=func.__name__,
|
|
||||||
description=func.__doc__,
|
|
||||||
start_timestamp=now(),
|
|
||||||
finish_timestamp=now(),
|
|
||||||
status=TaskStatus.UNKNOWN,
|
|
||||||
messages=sanitize_item([_("Task has not been run yet.")]),
|
|
||||||
task_call_module=func.__module__,
|
|
||||||
task_call_func=func.__name__,
|
|
||||||
expiring=False,
|
|
||||||
duration=0,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
return func
|
|
||||||
|
|
||||||
|
|
||||||
_prefill_tasks = []
|
|
||||||
@@ -1,41 +1,49 @@
|
|||||||
"""Event notification tasks"""
|
"""Event notification tasks"""
|
||||||
|
|
||||||
|
from uuid import UUID
|
||||||
|
|
||||||
from django.db.models.query_utils import Q
|
from django.db.models.query_utils import Q
|
||||||
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from django_dramatiq_postgres.middleware import CurrentTask
|
||||||
|
from dramatiq.actor import actor
|
||||||
from guardian.shortcuts import get_anonymous_user
|
from guardian.shortcuts import get_anonymous_user
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
|
|
||||||
from authentik.core.expression.exceptions import PropertyMappingExpressionException
|
|
||||||
from authentik.core.models import User
|
from authentik.core.models import User
|
||||||
from authentik.events.models import (
|
from authentik.events.models import (
|
||||||
Event,
|
Event,
|
||||||
Notification,
|
Notification,
|
||||||
NotificationRule,
|
NotificationRule,
|
||||||
NotificationTransport,
|
NotificationTransport,
|
||||||
NotificationTransportError,
|
|
||||||
TaskStatus,
|
|
||||||
)
|
)
|
||||||
from authentik.events.system_tasks import SystemTask, prefill_task
|
|
||||||
from authentik.policies.engine import PolicyEngine
|
from authentik.policies.engine import PolicyEngine
|
||||||
from authentik.policies.models import PolicyBinding, PolicyEngineMode
|
from authentik.policies.models import PolicyBinding, PolicyEngineMode
|
||||||
from authentik.root.celery import CELERY_APP
|
from authentik.tasks.models import Task
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task()
|
@actor(description=_("Dispatch new event notifications."))
|
||||||
def event_notification_handler(event_uuid: str):
|
def event_trigger_dispatch(event_uuid: UUID):
|
||||||
"""Start task for each trigger definition"""
|
|
||||||
for trigger in NotificationRule.objects.all():
|
for trigger in NotificationRule.objects.all():
|
||||||
event_trigger_handler.apply_async(args=[event_uuid, trigger.name], queue="authentik_events")
|
event_trigger_handler.send_with_options(args=(event_uuid, trigger.name), rel_obj=trigger)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task()
|
@actor(
|
||||||
def event_trigger_handler(event_uuid: str, trigger_name: str):
|
description=_(
|
||||||
|
"Check if policies attached to NotificationRule match event "
|
||||||
|
"and dispatch notification tasks."
|
||||||
|
)
|
||||||
|
)
|
||||||
|
def event_trigger_handler(event_uuid: UUID, trigger_name: str):
|
||||||
"""Check if policies attached to NotificationRule match event"""
|
"""Check if policies attached to NotificationRule match event"""
|
||||||
|
self: Task = CurrentTask.get_task()
|
||||||
|
|
||||||
event: Event = Event.objects.filter(event_uuid=event_uuid).first()
|
event: Event = Event.objects.filter(event_uuid=event_uuid).first()
|
||||||
if not event:
|
if not event:
|
||||||
LOGGER.warning("event doesn't exist yet or anymore", event_uuid=event_uuid)
|
self.warning("event doesn't exist yet or anymore", event_uuid=event_uuid)
|
||||||
return
|
return
|
||||||
|
|
||||||
trigger: NotificationRule | None = NotificationRule.objects.filter(name=trigger_name).first()
|
trigger: NotificationRule | None = NotificationRule.objects.filter(name=trigger_name).first()
|
||||||
if not trigger:
|
if not trigger:
|
||||||
return
|
return
|
||||||
@@ -71,57 +79,46 @@ def event_trigger_handler(event_uuid: str, trigger_name: str):
|
|||||||
|
|
||||||
LOGGER.debug("e(trigger): event trigger matched", trigger=trigger)
|
LOGGER.debug("e(trigger): event trigger matched", trigger=trigger)
|
||||||
# Create the notification objects
|
# Create the notification objects
|
||||||
|
count = 0
|
||||||
for transport in trigger.transports.all():
|
for transport in trigger.transports.all():
|
||||||
for user in trigger.destination_users(event):
|
for user in trigger.destination_users(event):
|
||||||
LOGGER.debug("created notification")
|
notification_transport.send_with_options(
|
||||||
notification_transport.apply_async(
|
args=(
|
||||||
args=[
|
|
||||||
transport.pk,
|
transport.pk,
|
||||||
str(event.pk),
|
event.pk,
|
||||||
user.pk,
|
user.pk,
|
||||||
str(trigger.pk),
|
trigger.pk,
|
||||||
],
|
),
|
||||||
queue="authentik_events",
|
rel_obj=transport,
|
||||||
)
|
)
|
||||||
|
count += 1
|
||||||
if transport.send_once:
|
if transport.send_once:
|
||||||
break
|
break
|
||||||
|
self.info(f"Created {count} notification tasks")
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(
|
@actor(description=_("Send notification."))
|
||||||
bind=True,
|
def notification_transport(transport_pk: int, event_pk: str, user_pk: int, trigger_pk: str):
|
||||||
autoretry_for=(NotificationTransportError,),
|
|
||||||
retry_backoff=True,
|
|
||||||
base=SystemTask,
|
|
||||||
)
|
|
||||||
def notification_transport(
|
|
||||||
self: SystemTask, transport_pk: int, event_pk: str, user_pk: int, trigger_pk: str
|
|
||||||
):
|
|
||||||
"""Send notification over specified transport"""
|
"""Send notification over specified transport"""
|
||||||
self.save_on_success = False
|
event = Event.objects.filter(pk=event_pk).first()
|
||||||
try:
|
if not event:
|
||||||
event = Event.objects.filter(pk=event_pk).first()
|
return
|
||||||
if not event:
|
user = User.objects.filter(pk=user_pk).first()
|
||||||
return
|
if not user:
|
||||||
user = User.objects.filter(pk=user_pk).first()
|
return
|
||||||
if not user:
|
trigger = NotificationRule.objects.filter(pk=trigger_pk).first()
|
||||||
return
|
if not trigger:
|
||||||
trigger = NotificationRule.objects.filter(pk=trigger_pk).first()
|
return
|
||||||
if not trigger:
|
notification = Notification(
|
||||||
return
|
severity=trigger.severity, body=event.summary, event=event, user=user
|
||||||
notification = Notification(
|
)
|
||||||
severity=trigger.severity, body=event.summary, event=event, user=user
|
transport: NotificationTransport = NotificationTransport.objects.filter(pk=transport_pk).first()
|
||||||
)
|
if not transport:
|
||||||
transport = NotificationTransport.objects.filter(pk=transport_pk).first()
|
return
|
||||||
if not transport:
|
transport.send(notification)
|
||||||
return
|
|
||||||
transport.send(notification)
|
|
||||||
self.set_status(TaskStatus.SUCCESSFUL)
|
|
||||||
except (NotificationTransportError, PropertyMappingExpressionException) as exc:
|
|
||||||
self.set_error(exc)
|
|
||||||
raise exc
|
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task()
|
@actor(description=_("Cleanup events for GDPR compliance."))
|
||||||
def gdpr_cleanup(user_pk: int):
|
def gdpr_cleanup(user_pk: int):
|
||||||
"""cleanup events from gdpr_compliance"""
|
"""cleanup events from gdpr_compliance"""
|
||||||
events = Event.objects.filter(user__pk=user_pk)
|
events = Event.objects.filter(user__pk=user_pk)
|
||||||
@@ -129,12 +126,12 @@ def gdpr_cleanup(user_pk: int):
|
|||||||
events.delete()
|
events.delete()
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(bind=True, base=SystemTask)
|
@actor(description=_("Cleanup seen notifications and notifications whose event expired."))
|
||||||
@prefill_task
|
def notification_cleanup():
|
||||||
def notification_cleanup(self: SystemTask):
|
|
||||||
"""Cleanup seen notifications and notifications whose event expired."""
|
"""Cleanup seen notifications and notifications whose event expired."""
|
||||||
|
self: Task = CurrentTask.get_task()
|
||||||
notifications = Notification.objects.filter(Q(event=None) | Q(seen=True))
|
notifications = Notification.objects.filter(Q(event=None) | Q(seen=True))
|
||||||
amount = notifications.count()
|
amount = notifications.count()
|
||||||
notifications.delete()
|
notifications.delete()
|
||||||
LOGGER.debug("Expired notifications", amount=amount)
|
LOGGER.debug("Expired notifications", amount=amount)
|
||||||
self.set_status(TaskStatus.SUCCESSFUL, f"Expired {amount} Notifications")
|
self.info(f"Expired {amount} Notifications")
|
||||||
|
|||||||
@@ -1,103 +0,0 @@
|
|||||||
"""Test Monitored tasks"""
|
|
||||||
|
|
||||||
from json import loads
|
|
||||||
|
|
||||||
from django.urls import reverse
|
|
||||||
from rest_framework.test import APITestCase
|
|
||||||
|
|
||||||
from authentik.core.tasks import clean_expired_models
|
|
||||||
from authentik.core.tests.utils import create_test_admin_user
|
|
||||||
from authentik.events.models import SystemTask as DBSystemTask
|
|
||||||
from authentik.events.models import TaskStatus
|
|
||||||
from authentik.events.system_tasks import SystemTask
|
|
||||||
from authentik.lib.generators import generate_id
|
|
||||||
from authentik.root.celery import CELERY_APP
|
|
||||||
|
|
||||||
|
|
||||||
class TestSystemTasks(APITestCase):
|
|
||||||
"""Test Monitored tasks"""
|
|
||||||
|
|
||||||
def setUp(self):
|
|
||||||
super().setUp()
|
|
||||||
self.user = create_test_admin_user()
|
|
||||||
self.client.force_login(self.user)
|
|
||||||
|
|
||||||
def test_failed_successful_remove_state(self):
|
|
||||||
"""Test that a task with `save_on_success` set to `False` that failed saves
|
|
||||||
a state, and upon successful completion will delete the state"""
|
|
||||||
should_fail = True
|
|
||||||
uid = generate_id()
|
|
||||||
|
|
||||||
@CELERY_APP.task(
|
|
||||||
bind=True,
|
|
||||||
base=SystemTask,
|
|
||||||
)
|
|
||||||
def test_task(self: SystemTask):
|
|
||||||
self.save_on_success = False
|
|
||||||
self.set_uid(uid)
|
|
||||||
self.set_status(TaskStatus.ERROR if should_fail else TaskStatus.SUCCESSFUL)
|
|
||||||
|
|
||||||
# First test successful run
|
|
||||||
should_fail = False
|
|
||||||
test_task.delay().get()
|
|
||||||
self.assertIsNone(DBSystemTask.objects.filter(name="test_task", uid=uid).first())
|
|
||||||
|
|
||||||
# Then test failed
|
|
||||||
should_fail = True
|
|
||||||
test_task.delay().get()
|
|
||||||
task = DBSystemTask.objects.filter(name="test_task", uid=uid).first()
|
|
||||||
self.assertEqual(task.status, TaskStatus.ERROR)
|
|
||||||
|
|
||||||
# Then after that, the state should be removed
|
|
||||||
should_fail = False
|
|
||||||
test_task.delay().get()
|
|
||||||
self.assertIsNone(DBSystemTask.objects.filter(name="test_task", uid=uid).first())
|
|
||||||
|
|
||||||
def test_tasks(self):
|
|
||||||
"""Test Task API"""
|
|
||||||
clean_expired_models.delay().get()
|
|
||||||
response = self.client.get(reverse("authentik_api:systemtask-list"))
|
|
||||||
self.assertEqual(response.status_code, 200)
|
|
||||||
body = loads(response.content)
|
|
||||||
self.assertTrue(any(task["name"] == "clean_expired_models" for task in body["results"]))
|
|
||||||
|
|
||||||
def test_tasks_single(self):
|
|
||||||
"""Test Task API (read single)"""
|
|
||||||
clean_expired_models.delay().get()
|
|
||||||
task = DBSystemTask.objects.filter(name="clean_expired_models").first()
|
|
||||||
response = self.client.get(
|
|
||||||
reverse(
|
|
||||||
"authentik_api:systemtask-detail",
|
|
||||||
kwargs={"pk": str(task.pk)},
|
|
||||||
)
|
|
||||||
)
|
|
||||||
self.assertEqual(response.status_code, 200)
|
|
||||||
body = loads(response.content)
|
|
||||||
self.assertEqual(body["status"], TaskStatus.SUCCESSFUL.value)
|
|
||||||
self.assertEqual(body["name"], "clean_expired_models")
|
|
||||||
response = self.client.get(
|
|
||||||
reverse("authentik_api:systemtask-detail", kwargs={"pk": "qwerqwer"})
|
|
||||||
)
|
|
||||||
self.assertEqual(response.status_code, 404)
|
|
||||||
|
|
||||||
def test_tasks_run(self):
|
|
||||||
"""Test Task API (run)"""
|
|
||||||
clean_expired_models.delay().get()
|
|
||||||
task = DBSystemTask.objects.filter(name="clean_expired_models").first()
|
|
||||||
response = self.client.post(
|
|
||||||
reverse(
|
|
||||||
"authentik_api:systemtask-run",
|
|
||||||
kwargs={"pk": str(task.pk)},
|
|
||||||
)
|
|
||||||
)
|
|
||||||
self.assertEqual(response.status_code, 204)
|
|
||||||
|
|
||||||
def test_tasks_run_404(self):
|
|
||||||
"""Test Task API (run, 404)"""
|
|
||||||
response = self.client.post(
|
|
||||||
reverse(
|
|
||||||
"authentik_api:systemtask-run",
|
|
||||||
kwargs={"pk": "qwerqewrqrqewrqewr"},
|
|
||||||
)
|
|
||||||
)
|
|
||||||
self.assertEqual(response.status_code, 404)
|
|
||||||
@@ -5,13 +5,11 @@ from authentik.events.api.notification_mappings import NotificationWebhookMappin
|
|||||||
from authentik.events.api.notification_rules import NotificationRuleViewSet
|
from authentik.events.api.notification_rules import NotificationRuleViewSet
|
||||||
from authentik.events.api.notification_transports import NotificationTransportViewSet
|
from authentik.events.api.notification_transports import NotificationTransportViewSet
|
||||||
from authentik.events.api.notifications import NotificationViewSet
|
from authentik.events.api.notifications import NotificationViewSet
|
||||||
from authentik.events.api.tasks import SystemTaskViewSet
|
|
||||||
|
|
||||||
api_urlpatterns = [
|
api_urlpatterns = [
|
||||||
("events/events", EventViewSet),
|
("events/events", EventViewSet),
|
||||||
("events/notifications", NotificationViewSet),
|
("events/notifications", NotificationViewSet),
|
||||||
("events/transports", NotificationTransportViewSet),
|
("events/transports", NotificationTransportViewSet),
|
||||||
("events/rules", NotificationRuleViewSet),
|
("events/rules", NotificationRuleViewSet),
|
||||||
("events/system_tasks", SystemTaskViewSet),
|
|
||||||
("propertymappings/notification", NotificationWebhookMappingViewSet),
|
("propertymappings/notification", NotificationWebhookMappingViewSet),
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -301,6 +301,7 @@ class SessionEndStage(ChallengeStageView):
|
|||||||
"flow_slug": self.request.brand.flow_invalidation.slug,
|
"flow_slug": self.request.brand.flow_invalidation.slug,
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
return SessionEndChallenge(data=data)
|
return SessionEndChallenge(data=data)
|
||||||
|
|
||||||
# This can never be reached since this challenge is created on demand and only the
|
# This can never be reached since this challenge is created on demand and only the
|
||||||
|
|||||||
@@ -41,8 +41,7 @@ REDIS_ENV_KEYS = [
|
|||||||
# Old key -> new key
|
# Old key -> new key
|
||||||
DEPRECATIONS = {
|
DEPRECATIONS = {
|
||||||
"geoip": "events.context_processors.geoip",
|
"geoip": "events.context_processors.geoip",
|
||||||
"redis.broker_url": "broker.url",
|
"worker.concurrency": "worker.threads",
|
||||||
"redis.broker_transport_options": "broker.transport_options",
|
|
||||||
"redis.cache_timeout": "cache.timeout",
|
"redis.cache_timeout": "cache.timeout",
|
||||||
"redis.cache_timeout_flows": "cache.timeout_flows",
|
"redis.cache_timeout_flows": "cache.timeout_flows",
|
||||||
"redis.cache_timeout_policies": "cache.timeout_policies",
|
"redis.cache_timeout_policies": "cache.timeout_policies",
|
||||||
@@ -367,6 +366,8 @@ def django_db_config(config: ConfigLoader | None = None) -> dict:
|
|||||||
# See https://github.com/goauthentik/authentik/issues/14320
|
# See https://github.com/goauthentik/authentik/issues/14320
|
||||||
pool_options = False
|
pool_options = False
|
||||||
|
|
||||||
|
conn_options = config.get_dict_from_b64_json("postgresql.conn_options", default={})
|
||||||
|
|
||||||
db = {
|
db = {
|
||||||
"default": {
|
"default": {
|
||||||
"ENGINE": "authentik.root.db",
|
"ENGINE": "authentik.root.db",
|
||||||
@@ -381,6 +382,7 @@ def django_db_config(config: ConfigLoader | None = None) -> dict:
|
|||||||
"sslcert": config.get("postgresql.sslcert"),
|
"sslcert": config.get("postgresql.sslcert"),
|
||||||
"sslkey": config.get("postgresql.sslkey"),
|
"sslkey": config.get("postgresql.sslkey"),
|
||||||
"pool": pool_options,
|
"pool": pool_options,
|
||||||
|
**conn_options,
|
||||||
},
|
},
|
||||||
"CONN_MAX_AGE": config.get_optional_int("postgresql.conn_max_age", 0),
|
"CONN_MAX_AGE": config.get_optional_int("postgresql.conn_max_age", 0),
|
||||||
"CONN_HEALTH_CHECKS": config.get_bool("postgresql.conn_health_checks", False),
|
"CONN_HEALTH_CHECKS": config.get_bool("postgresql.conn_health_checks", False),
|
||||||
@@ -410,8 +412,14 @@ def django_db_config(config: ConfigLoader | None = None) -> dict:
|
|||||||
if conn_max_age is not UNSET:
|
if conn_max_age is not UNSET:
|
||||||
db["default"]["CONN_MAX_AGE"] = conn_max_age
|
db["default"]["CONN_MAX_AGE"] = conn_max_age
|
||||||
|
|
||||||
|
all_replica_conn_options = config.get_dict_from_b64_json(
|
||||||
|
"postgresql.replica_conn_options",
|
||||||
|
default={},
|
||||||
|
)
|
||||||
|
|
||||||
for replica in config.get_keys("postgresql.read_replicas"):
|
for replica in config.get_keys("postgresql.read_replicas"):
|
||||||
_database = deepcopy(db["default"])
|
_database = deepcopy(db["default"])
|
||||||
|
|
||||||
for setting, current_value in db["default"].items():
|
for setting, current_value in db["default"].items():
|
||||||
if isinstance(current_value, dict):
|
if isinstance(current_value, dict):
|
||||||
continue
|
continue
|
||||||
@@ -420,12 +428,23 @@ def django_db_config(config: ConfigLoader | None = None) -> dict:
|
|||||||
)
|
)
|
||||||
if override is not UNSET:
|
if override is not UNSET:
|
||||||
_database[setting] = override
|
_database[setting] = override
|
||||||
|
|
||||||
|
for option in conn_options.keys():
|
||||||
|
_database["OPTIONS"].pop(option, None)
|
||||||
|
|
||||||
for setting in db["default"]["OPTIONS"].keys():
|
for setting in db["default"]["OPTIONS"].keys():
|
||||||
override = config.get(
|
override = config.get(
|
||||||
f"postgresql.read_replicas.{replica}.{setting.lower()}", default=UNSET
|
f"postgresql.read_replicas.{replica}.{setting.lower()}", default=UNSET
|
||||||
)
|
)
|
||||||
if override is not UNSET:
|
if override is not UNSET:
|
||||||
_database["OPTIONS"][setting] = override
|
_database["OPTIONS"][setting] = override
|
||||||
|
|
||||||
|
_database["OPTIONS"].update(all_replica_conn_options)
|
||||||
|
replica_conn_options = config.get_dict_from_b64_json(
|
||||||
|
f"postgresql.read_replicas.{replica}.conn_options", default={}
|
||||||
|
)
|
||||||
|
_database["OPTIONS"].update(replica_conn_options)
|
||||||
|
|
||||||
db[f"replica_{replica}"] = _database
|
db[f"replica_{replica}"] = _database
|
||||||
return db
|
return db
|
||||||
|
|
||||||
|
|||||||
@@ -21,6 +21,10 @@ def start_debug_server(**kwargs) -> bool:
|
|||||||
|
|
||||||
listen: str = CONFIG.get("listen.listen_debug_py", "127.0.0.1:9901")
|
listen: str = CONFIG.get("listen.listen_debug_py", "127.0.0.1:9901")
|
||||||
host, _, port = listen.rpartition(":")
|
host, _, port = listen.rpartition(":")
|
||||||
debugpy.listen((host, int(port)), **kwargs) # nosec
|
try:
|
||||||
|
debugpy.listen((host, int(port)), **kwargs) # nosec
|
||||||
|
except RuntimeError:
|
||||||
|
LOGGER.warning("Could not start debug server. Continuing without")
|
||||||
|
return False
|
||||||
LOGGER.debug("Starting debug server", host=host, port=port)
|
LOGGER.debug("Starting debug server", host=host, port=port)
|
||||||
return True
|
return True
|
||||||
|
|||||||
@@ -8,9 +8,9 @@
|
|||||||
# make gen-dev-config
|
# make gen-dev-config
|
||||||
# ```
|
# ```
|
||||||
#
|
#
|
||||||
# You may edit the generated file to override the configuration below.
|
# You may edit the generated file to override the configuration below.
|
||||||
#
|
#
|
||||||
# When making modifying the default configuration file,
|
# When making modifying the default configuration file,
|
||||||
# ensure that the corresponding documentation is updated to match.
|
# ensure that the corresponding documentation is updated to match.
|
||||||
#
|
#
|
||||||
# @see {@link ../../website/docs/install-config/configuration/configuration.mdx Configuration documentation} for more information.
|
# @see {@link ../../website/docs/install-config/configuration/configuration.mdx Configuration documentation} for more information.
|
||||||
@@ -57,10 +57,6 @@ redis:
|
|||||||
tls_reqs: "none"
|
tls_reqs: "none"
|
||||||
tls_ca_cert: null
|
tls_ca_cert: null
|
||||||
|
|
||||||
# broker:
|
|
||||||
# url: ""
|
|
||||||
# transport_options: ""
|
|
||||||
|
|
||||||
http_timeout: 30
|
http_timeout: 30
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
@@ -72,10 +68,6 @@ cache:
|
|||||||
# channel:
|
# channel:
|
||||||
# url: ""
|
# url: ""
|
||||||
|
|
||||||
# result_backend:
|
|
||||||
# url: ""
|
|
||||||
# transport_options: ""
|
|
||||||
|
|
||||||
debug: false
|
debug: false
|
||||||
debugger: false
|
debugger: false
|
||||||
|
|
||||||
@@ -157,7 +149,14 @@ web:
|
|||||||
path: /
|
path: /
|
||||||
|
|
||||||
worker:
|
worker:
|
||||||
concurrency: 2
|
processes: 1
|
||||||
|
threads: 2
|
||||||
|
consumer_listen_timeout: "seconds=30"
|
||||||
|
task_max_retries: 20
|
||||||
|
task_default_time_limit: "minutes=10"
|
||||||
|
task_purge_interval: "days=1"
|
||||||
|
task_expiration: "days=30"
|
||||||
|
scheduler_interval: "seconds=60"
|
||||||
|
|
||||||
storage:
|
storage:
|
||||||
media:
|
media:
|
||||||
|
|||||||
@@ -88,7 +88,6 @@ def get_logger_config():
|
|||||||
"authentik": global_level,
|
"authentik": global_level,
|
||||||
"django": "WARNING",
|
"django": "WARNING",
|
||||||
"django.request": "ERROR",
|
"django.request": "ERROR",
|
||||||
"celery": "WARNING",
|
|
||||||
"selenium": "WARNING",
|
"selenium": "WARNING",
|
||||||
"docker": "WARNING",
|
"docker": "WARNING",
|
||||||
"urllib3": "WARNING",
|
"urllib3": "WARNING",
|
||||||
|
|||||||
@@ -3,8 +3,6 @@
|
|||||||
from asyncio.exceptions import CancelledError
|
from asyncio.exceptions import CancelledError
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from billiard.exceptions import SoftTimeLimitExceeded, WorkerLostError
|
|
||||||
from celery.exceptions import CeleryError
|
|
||||||
from channels_redis.core import ChannelFull
|
from channels_redis.core import ChannelFull
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from django.core.exceptions import ImproperlyConfigured, SuspiciousOperation, ValidationError
|
from django.core.exceptions import ImproperlyConfigured, SuspiciousOperation, ValidationError
|
||||||
@@ -22,7 +20,6 @@ from sentry_sdk import HttpTransport, get_current_scope
|
|||||||
from sentry_sdk import init as sentry_sdk_init
|
from sentry_sdk import init as sentry_sdk_init
|
||||||
from sentry_sdk.api import set_tag
|
from sentry_sdk.api import set_tag
|
||||||
from sentry_sdk.integrations.argv import ArgvIntegration
|
from sentry_sdk.integrations.argv import ArgvIntegration
|
||||||
from sentry_sdk.integrations.celery import CeleryIntegration
|
|
||||||
from sentry_sdk.integrations.django import DjangoIntegration
|
from sentry_sdk.integrations.django import DjangoIntegration
|
||||||
from sentry_sdk.integrations.redis import RedisIntegration
|
from sentry_sdk.integrations.redis import RedisIntegration
|
||||||
from sentry_sdk.integrations.socket import SocketIntegration
|
from sentry_sdk.integrations.socket import SocketIntegration
|
||||||
@@ -71,10 +68,6 @@ ignored_classes = (
|
|||||||
LocalProtocolError,
|
LocalProtocolError,
|
||||||
# rest_framework error
|
# rest_framework error
|
||||||
APIException,
|
APIException,
|
||||||
# celery errors
|
|
||||||
WorkerLostError,
|
|
||||||
CeleryError,
|
|
||||||
SoftTimeLimitExceeded,
|
|
||||||
# custom baseclass
|
# custom baseclass
|
||||||
SentryIgnoredException,
|
SentryIgnoredException,
|
||||||
# ldap errors
|
# ldap errors
|
||||||
@@ -115,7 +108,6 @@ def sentry_init(**sentry_init_kwargs):
|
|||||||
ArgvIntegration(),
|
ArgvIntegration(),
|
||||||
StdlibIntegration(),
|
StdlibIntegration(),
|
||||||
DjangoIntegration(transaction_style="function_name", cache_spans=True),
|
DjangoIntegration(transaction_style="function_name", cache_spans=True),
|
||||||
CeleryIntegration(),
|
|
||||||
RedisIntegration(),
|
RedisIntegration(),
|
||||||
ThreadingIntegration(propagate_hub=True),
|
ThreadingIntegration(propagate_hub=True),
|
||||||
SocketIntegration(),
|
SocketIntegration(),
|
||||||
@@ -160,14 +152,11 @@ def before_send(event: dict, hint: dict) -> dict | None:
|
|||||||
return None
|
return None
|
||||||
if "logger" in event:
|
if "logger" in event:
|
||||||
if event["logger"] in [
|
if event["logger"] in [
|
||||||
"kombu",
|
|
||||||
"asyncio",
|
"asyncio",
|
||||||
"multiprocessing",
|
"multiprocessing",
|
||||||
"django_redis",
|
"django_redis",
|
||||||
"django.security.DisallowedHost",
|
"django.security.DisallowedHost",
|
||||||
"django_redis.cache",
|
"django_redis.cache",
|
||||||
"celery.backends.redis",
|
|
||||||
"celery.worker",
|
|
||||||
"paramiko.transport",
|
"paramiko.transport",
|
||||||
]:
|
]:
|
||||||
return None
|
return None
|
||||||
|
|||||||
12
authentik/lib/sync/api.py
Normal file
12
authentik/lib/sync/api.py
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
from rest_framework.fields import BooleanField, ChoiceField, DateTimeField
|
||||||
|
|
||||||
|
from authentik.core.api.utils import PassiveSerializer
|
||||||
|
from authentik.tasks.models import TaskStatus
|
||||||
|
|
||||||
|
|
||||||
|
class SyncStatusSerializer(PassiveSerializer):
|
||||||
|
"""Provider/source sync status"""
|
||||||
|
|
||||||
|
is_running = BooleanField()
|
||||||
|
last_successful_sync = DateTimeField(required=False)
|
||||||
|
last_sync_status = ChoiceField(required=False, choices=TaskStatus.choices)
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Sync constants"""
|
"""Sync constants"""
|
||||||
|
|
||||||
PAGE_SIZE = 100
|
PAGE_SIZE = 100
|
||||||
PAGE_TIMEOUT = 60 * 60 * 0.5 # Half an hour
|
PAGE_TIMEOUT_MS = 60 * 60 * 0.5 * 1000 # Half an hour
|
||||||
HTTP_CONFLICT = 409
|
HTTP_CONFLICT = 409
|
||||||
HTTP_NO_CONTENT = 204
|
HTTP_NO_CONTENT = 204
|
||||||
HTTP_SERVICE_UNAVAILABLE = 503
|
HTTP_SERVICE_UNAVAILABLE = 503
|
||||||
|
|||||||
@@ -1,7 +1,5 @@
|
|||||||
from celery import Task
|
from dramatiq.actor import Actor
|
||||||
from django.utils.text import slugify
|
from drf_spectacular.utils import extend_schema
|
||||||
from drf_spectacular.utils import OpenApiResponse, extend_schema
|
|
||||||
from guardian.shortcuts import get_objects_for_user
|
|
||||||
from rest_framework.decorators import action
|
from rest_framework.decorators import action
|
||||||
from rest_framework.fields import BooleanField, CharField, ChoiceField
|
from rest_framework.fields import BooleanField, CharField, ChoiceField
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
@@ -9,18 +7,12 @@ from rest_framework.response import Response
|
|||||||
|
|
||||||
from authentik.core.api.utils import ModelSerializer, PassiveSerializer
|
from authentik.core.api.utils import ModelSerializer, PassiveSerializer
|
||||||
from authentik.core.models import Group, User
|
from authentik.core.models import Group, User
|
||||||
from authentik.events.api.tasks import SystemTaskSerializer
|
from authentik.events.logs import LogEventSerializer
|
||||||
from authentik.events.logs import LogEvent, LogEventSerializer
|
from authentik.lib.sync.api import SyncStatusSerializer
|
||||||
from authentik.lib.sync.outgoing.models import OutgoingSyncProvider
|
from authentik.lib.sync.outgoing.models import OutgoingSyncProvider
|
||||||
from authentik.lib.utils.reflection import class_to_path
|
from authentik.lib.utils.reflection import class_to_path
|
||||||
from authentik.rbac.filters import ObjectFilter
|
from authentik.rbac.filters import ObjectFilter
|
||||||
|
from authentik.tasks.models import Task, TaskStatus
|
||||||
|
|
||||||
class SyncStatusSerializer(PassiveSerializer):
|
|
||||||
"""Provider sync status"""
|
|
||||||
|
|
||||||
is_running = BooleanField(read_only=True)
|
|
||||||
tasks = SystemTaskSerializer(many=True, read_only=True)
|
|
||||||
|
|
||||||
|
|
||||||
class SyncObjectSerializer(PassiveSerializer):
|
class SyncObjectSerializer(PassiveSerializer):
|
||||||
@@ -45,15 +37,10 @@ class SyncObjectResultSerializer(PassiveSerializer):
|
|||||||
class OutgoingSyncProviderStatusMixin:
|
class OutgoingSyncProviderStatusMixin:
|
||||||
"""Common API Endpoints for Outgoing sync providers"""
|
"""Common API Endpoints for Outgoing sync providers"""
|
||||||
|
|
||||||
sync_single_task: type[Task] = None
|
sync_task: Actor
|
||||||
sync_objects_task: type[Task] = None
|
sync_objects_task: Actor
|
||||||
|
|
||||||
@extend_schema(
|
@extend_schema(responses={200: SyncStatusSerializer()})
|
||||||
responses={
|
|
||||||
200: SyncStatusSerializer(),
|
|
||||||
404: OpenApiResponse(description="Task not found"),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
@action(
|
@action(
|
||||||
methods=["GET"],
|
methods=["GET"],
|
||||||
detail=True,
|
detail=True,
|
||||||
@@ -64,18 +51,39 @@ class OutgoingSyncProviderStatusMixin:
|
|||||||
def sync_status(self, request: Request, pk: int) -> Response:
|
def sync_status(self, request: Request, pk: int) -> Response:
|
||||||
"""Get provider's sync status"""
|
"""Get provider's sync status"""
|
||||||
provider: OutgoingSyncProvider = self.get_object()
|
provider: OutgoingSyncProvider = self.get_object()
|
||||||
tasks = list(
|
|
||||||
get_objects_for_user(request.user, "authentik_events.view_systemtask").filter(
|
status = {}
|
||||||
name=self.sync_single_task.__name__,
|
|
||||||
uid=slugify(provider.name),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
with provider.sync_lock as lock_acquired:
|
with provider.sync_lock as lock_acquired:
|
||||||
status = {
|
# If we could not acquire the lock, it means a task is using it, and thus is running
|
||||||
"tasks": tasks,
|
status["is_running"] = not lock_acquired
|
||||||
# If we could not acquire the lock, it means a task is using it, and thus is running
|
|
||||||
"is_running": not lock_acquired,
|
sync_schedule = None
|
||||||
}
|
for schedule in provider.schedules.all():
|
||||||
|
if schedule.actor_name == self.sync_task.actor_name:
|
||||||
|
sync_schedule = schedule
|
||||||
|
|
||||||
|
if not sync_schedule:
|
||||||
|
return Response(SyncStatusSerializer(status).data)
|
||||||
|
|
||||||
|
last_task: Task = (
|
||||||
|
sync_schedule.tasks.exclude(
|
||||||
|
aggregated_status__in=(TaskStatus.CONSUMED, TaskStatus.QUEUED)
|
||||||
|
)
|
||||||
|
.order_by("-mtime")
|
||||||
|
.first()
|
||||||
|
)
|
||||||
|
last_successful_task: Task = (
|
||||||
|
sync_schedule.tasks.filter(aggregated_status__in=(TaskStatus.DONE, TaskStatus.INFO))
|
||||||
|
.order_by("-mtime")
|
||||||
|
.first()
|
||||||
|
)
|
||||||
|
|
||||||
|
if last_task:
|
||||||
|
status["last_sync_status"] = last_task.aggregated_status
|
||||||
|
if last_successful_task:
|
||||||
|
status["last_successful_sync"] = last_successful_task.mtime
|
||||||
|
|
||||||
return Response(SyncStatusSerializer(status).data)
|
return Response(SyncStatusSerializer(status).data)
|
||||||
|
|
||||||
@extend_schema(
|
@extend_schema(
|
||||||
@@ -94,14 +102,20 @@ class OutgoingSyncProviderStatusMixin:
|
|||||||
provider: OutgoingSyncProvider = self.get_object()
|
provider: OutgoingSyncProvider = self.get_object()
|
||||||
params = SyncObjectSerializer(data=request.data)
|
params = SyncObjectSerializer(data=request.data)
|
||||||
params.is_valid(raise_exception=True)
|
params.is_valid(raise_exception=True)
|
||||||
res: list[LogEvent] = self.sync_objects_task.delay(
|
msg = self.sync_objects_task.send_with_options(
|
||||||
params.validated_data["sync_object_model"],
|
kwargs={
|
||||||
page=1,
|
"object_type": params.validated_data["sync_object_model"],
|
||||||
provider_pk=provider.pk,
|
"page": 1,
|
||||||
pk=params.validated_data["sync_object_id"],
|
"provider_pk": provider.pk,
|
||||||
override_dry_run=params.validated_data["override_dry_run"],
|
"override_dry_run": params.validated_data["override_dry_run"],
|
||||||
).get()
|
"pk": params.validated_data["sync_object_id"],
|
||||||
return Response(SyncObjectResultSerializer(instance={"messages": res}).data)
|
},
|
||||||
|
rel_obj=provider,
|
||||||
|
)
|
||||||
|
msg.get_result(block=True)
|
||||||
|
task: Task = msg.options["task"]
|
||||||
|
task.refresh_from_db()
|
||||||
|
return Response(SyncObjectResultSerializer(instance={"messages": task._messages}).data)
|
||||||
|
|
||||||
|
|
||||||
class OutgoingSyncConnectionCreateMixin:
|
class OutgoingSyncConnectionCreateMixin:
|
||||||
|
|||||||
@@ -1,12 +1,18 @@
|
|||||||
from typing import Any, Self
|
from typing import Any, Self
|
||||||
|
|
||||||
import pglock
|
import pglock
|
||||||
|
from django.core.paginator import Paginator
|
||||||
from django.db import connection, models
|
from django.db import connection, models
|
||||||
from django.db.models import Model, QuerySet, TextChoices
|
from django.db.models import Model, QuerySet, TextChoices
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
|
from dramatiq.actor import Actor
|
||||||
|
|
||||||
from authentik.core.models import Group, User
|
from authentik.core.models import Group, User
|
||||||
|
from authentik.lib.sync.outgoing import PAGE_SIZE, PAGE_TIMEOUT_MS
|
||||||
from authentik.lib.sync.outgoing.base import BaseOutgoingSyncClient
|
from authentik.lib.sync.outgoing.base import BaseOutgoingSyncClient
|
||||||
|
from authentik.lib.utils.time import fqdn_rand
|
||||||
|
from authentik.tasks.schedules.common import ScheduleSpec
|
||||||
|
from authentik.tasks.schedules.models import ScheduledModel
|
||||||
|
|
||||||
|
|
||||||
class OutgoingSyncDeleteAction(TextChoices):
|
class OutgoingSyncDeleteAction(TextChoices):
|
||||||
@@ -18,7 +24,7 @@ class OutgoingSyncDeleteAction(TextChoices):
|
|||||||
SUSPEND = "suspend"
|
SUSPEND = "suspend"
|
||||||
|
|
||||||
|
|
||||||
class OutgoingSyncProvider(Model):
|
class OutgoingSyncProvider(ScheduledModel, Model):
|
||||||
"""Base abstract models for providers implementing outgoing sync"""
|
"""Base abstract models for providers implementing outgoing sync"""
|
||||||
|
|
||||||
dry_run = models.BooleanField(
|
dry_run = models.BooleanField(
|
||||||
@@ -39,6 +45,19 @@ class OutgoingSyncProvider(Model):
|
|||||||
def get_object_qs[T: User | Group](self, type: type[T]) -> QuerySet[T]:
|
def get_object_qs[T: User | Group](self, type: type[T]) -> QuerySet[T]:
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
|
def get_paginator[T: User | Group](self, type: type[T]) -> Paginator:
|
||||||
|
return Paginator(self.get_object_qs(type), PAGE_SIZE)
|
||||||
|
|
||||||
|
def get_object_sync_time_limit_ms[T: User | Group](self, type: type[T]) -> int:
|
||||||
|
num_pages: int = self.get_paginator(type).num_pages
|
||||||
|
return int(num_pages * PAGE_TIMEOUT_MS * 1.5)
|
||||||
|
|
||||||
|
def get_sync_time_limit_ms(self) -> int:
|
||||||
|
return int(
|
||||||
|
(self.get_object_sync_time_limit_ms(User) + self.get_object_sync_time_limit_ms(Group))
|
||||||
|
* 1.5
|
||||||
|
)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def sync_lock(self) -> pglock.advisory:
|
def sync_lock(self) -> pglock.advisory:
|
||||||
"""Postgres lock for syncing to prevent multiple parallel syncs happening"""
|
"""Postgres lock for syncing to prevent multiple parallel syncs happening"""
|
||||||
@@ -47,3 +66,22 @@ class OutgoingSyncProvider(Model):
|
|||||||
timeout=0,
|
timeout=0,
|
||||||
side_effect=pglock.Return,
|
side_effect=pglock.Return,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def sync_actor(self) -> Actor:
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
@property
|
||||||
|
def schedule_specs(self) -> list[ScheduleSpec]:
|
||||||
|
return [
|
||||||
|
ScheduleSpec(
|
||||||
|
actor=self.sync_actor,
|
||||||
|
uid=self.name,
|
||||||
|
args=(self.pk,),
|
||||||
|
options={
|
||||||
|
"time_limit": self.get_sync_time_limit_ms(),
|
||||||
|
},
|
||||||
|
send_on_save=True,
|
||||||
|
crontab=f"{fqdn_rand(self.pk)} */4 * * *",
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|||||||
@@ -1,12 +1,8 @@
|
|||||||
from collections.abc import Callable
|
|
||||||
|
|
||||||
from django.core.paginator import Paginator
|
|
||||||
from django.db.models import Model
|
from django.db.models import Model
|
||||||
from django.db.models.query import Q
|
|
||||||
from django.db.models.signals import m2m_changed, post_save, pre_delete
|
from django.db.models.signals import m2m_changed, post_save, pre_delete
|
||||||
|
from dramatiq.actor import Actor
|
||||||
|
|
||||||
from authentik.core.models import Group, User
|
from authentik.core.models import Group, User
|
||||||
from authentik.lib.sync.outgoing import PAGE_SIZE, PAGE_TIMEOUT
|
|
||||||
from authentik.lib.sync.outgoing.base import Direction
|
from authentik.lib.sync.outgoing.base import Direction
|
||||||
from authentik.lib.sync.outgoing.models import OutgoingSyncProvider
|
from authentik.lib.sync.outgoing.models import OutgoingSyncProvider
|
||||||
from authentik.lib.utils.reflection import class_to_path
|
from authentik.lib.utils.reflection import class_to_path
|
||||||
@@ -14,45 +10,30 @@ from authentik.lib.utils.reflection import class_to_path
|
|||||||
|
|
||||||
def register_signals(
|
def register_signals(
|
||||||
provider_type: type[OutgoingSyncProvider],
|
provider_type: type[OutgoingSyncProvider],
|
||||||
task_sync_single: Callable[[int], None],
|
task_sync_direct_dispatch: Actor[[str, str | int, str], None],
|
||||||
task_sync_direct: Callable[[int], None],
|
task_sync_m2m_dispatch: Actor[[str, str, list[str], bool], None],
|
||||||
task_sync_m2m: Callable[[int], None],
|
|
||||||
):
|
):
|
||||||
"""Register sync signals"""
|
"""Register sync signals"""
|
||||||
uid = class_to_path(provider_type)
|
uid = class_to_path(provider_type)
|
||||||
|
|
||||||
def post_save_provider(sender: type[Model], instance: OutgoingSyncProvider, created: bool, **_):
|
|
||||||
"""Trigger sync when Provider is saved"""
|
|
||||||
users_paginator = Paginator(instance.get_object_qs(User), PAGE_SIZE)
|
|
||||||
groups_paginator = Paginator(instance.get_object_qs(Group), PAGE_SIZE)
|
|
||||||
soft_time_limit = (users_paginator.num_pages + groups_paginator.num_pages) * PAGE_TIMEOUT
|
|
||||||
time_limit = soft_time_limit * 1.5
|
|
||||||
task_sync_single.apply_async(
|
|
||||||
(instance.pk,), time_limit=int(time_limit), soft_time_limit=int(soft_time_limit)
|
|
||||||
)
|
|
||||||
|
|
||||||
post_save.connect(post_save_provider, provider_type, dispatch_uid=uid, weak=False)
|
|
||||||
|
|
||||||
def model_post_save(sender: type[Model], instance: User | Group, created: bool, **_):
|
def model_post_save(sender: type[Model], instance: User | Group, created: bool, **_):
|
||||||
"""Post save handler"""
|
"""Post save handler"""
|
||||||
if not provider_type.objects.filter(
|
task_sync_direct_dispatch.send(
|
||||||
Q(backchannel_application__isnull=False) | Q(application__isnull=False)
|
class_to_path(instance.__class__),
|
||||||
).exists():
|
instance.pk,
|
||||||
return
|
Direction.add.value,
|
||||||
task_sync_direct.delay(class_to_path(instance.__class__), instance.pk, Direction.add.value)
|
)
|
||||||
|
|
||||||
post_save.connect(model_post_save, User, dispatch_uid=uid, weak=False)
|
post_save.connect(model_post_save, User, dispatch_uid=uid, weak=False)
|
||||||
post_save.connect(model_post_save, Group, dispatch_uid=uid, weak=False)
|
post_save.connect(model_post_save, Group, dispatch_uid=uid, weak=False)
|
||||||
|
|
||||||
def model_pre_delete(sender: type[Model], instance: User | Group, **_):
|
def model_pre_delete(sender: type[Model], instance: User | Group, **_):
|
||||||
"""Pre-delete handler"""
|
"""Pre-delete handler"""
|
||||||
if not provider_type.objects.filter(
|
task_sync_direct_dispatch.send(
|
||||||
Q(backchannel_application__isnull=False) | Q(application__isnull=False)
|
class_to_path(instance.__class__),
|
||||||
).exists():
|
instance.pk,
|
||||||
return
|
Direction.remove.value,
|
||||||
task_sync_direct.delay(
|
)
|
||||||
class_to_path(instance.__class__), instance.pk, Direction.remove.value
|
|
||||||
).get(propagate=False)
|
|
||||||
|
|
||||||
pre_delete.connect(model_pre_delete, User, dispatch_uid=uid, weak=False)
|
pre_delete.connect(model_pre_delete, User, dispatch_uid=uid, weak=False)
|
||||||
pre_delete.connect(model_pre_delete, Group, dispatch_uid=uid, weak=False)
|
pre_delete.connect(model_pre_delete, Group, dispatch_uid=uid, weak=False)
|
||||||
@@ -63,16 +44,6 @@ def register_signals(
|
|||||||
"""Sync group membership"""
|
"""Sync group membership"""
|
||||||
if action not in ["post_add", "post_remove"]:
|
if action not in ["post_add", "post_remove"]:
|
||||||
return
|
return
|
||||||
if not provider_type.objects.filter(
|
task_sync_m2m_dispatch.send(instance.pk, action, list(pk_set), reverse)
|
||||||
Q(backchannel_application__isnull=False) | Q(application__isnull=False)
|
|
||||||
).exists():
|
|
||||||
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
|
|
||||||
if reverse:
|
|
||||||
task_sync_m2m.delay(str(instance.pk), action, list(pk_set))
|
|
||||||
else:
|
|
||||||
for group_pk in pk_set:
|
|
||||||
task_sync_m2m.delay(group_pk, action, [instance.pk])
|
|
||||||
|
|
||||||
m2m_changed.connect(model_m2m_changed, User.ak_groups.through, dispatch_uid=uid, weak=False)
|
m2m_changed.connect(model_m2m_changed, User.ak_groups.through, dispatch_uid=uid, weak=False)
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user