Compare commits
60 Commits
web/cleanu
...
version/20
Author | SHA1 | Date | |
---|---|---|---|
1c03cfa906 | |||
e2dbab5bca | |||
3a6c42fefb | |||
6bb180f94e | |||
03dea17519 | |||
49d83f11bd | |||
5f0af81e4d | |||
63591e1710 | |||
6503a7b048 | |||
7e244e0679 | |||
c1998bf3f2 | |||
83372618a8 | |||
89a876e141 | |||
26d6e8bc5c | |||
d9dc373170 | |||
4ec37c5239 | |||
a9cfa6fe35 | |||
5ac5084149 | |||
eda38a30b1 | |||
9b84bf7174 | |||
f74549be6d | |||
76f4d7fb0a | |||
d1cf1dd083 | |||
2835fbd390 | |||
76ad2c8925 | |||
2270629fdc | |||
43a629efc1 | |||
4044e52403 | |||
aa7c846467 | |||
8ab7f4073b | |||
a05856c2ef | |||
9e9154e04a | |||
32549066c0 | |||
5ed3e879a2 | |||
4e4923ad0e | |||
0302d147e9 | |||
8256f1897d | |||
16d321835d | |||
f34612efe6 | |||
e82f147130 | |||
0ea6ad8eea | |||
f731443220 | |||
b70a66cde5 | |||
b733dbbcb0 | |||
e34d4c0669 | |||
310983a4d0 | |||
47b0fc86f7 | |||
b6e961b1f3 | |||
874d7ff320 | |||
e4a5bc9df6 | |||
318e0cf9f8 | |||
bd0815d894 | |||
af35ecfe66 | |||
0c05cd64bb | |||
cb80b76490 | |||
061d4bc758 | |||
8ff27f69e1 | |||
045cd98276 | |||
b520843984 | |||
92216e4ea8 |
@ -1,5 +1,5 @@
|
|||||||
[bumpversion]
|
[bumpversion]
|
||||||
current_version = 2024.10.0
|
current_version = 2024.2.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*))?
|
||||||
@ -17,14 +17,10 @@ optional_value = final
|
|||||||
|
|
||||||
[bumpversion:file:pyproject.toml]
|
[bumpversion:file:pyproject.toml]
|
||||||
|
|
||||||
[bumpversion:file:package.json]
|
|
||||||
|
|
||||||
[bumpversion:file:docker-compose.yml]
|
[bumpversion:file:docker-compose.yml]
|
||||||
|
|
||||||
[bumpversion:file:schema.yml]
|
[bumpversion:file:schema.yml]
|
||||||
|
|
||||||
[bumpversion:file:blueprints/schema.json]
|
|
||||||
|
|
||||||
[bumpversion:file:authentik/__init__.py]
|
[bumpversion:file:authentik/__init__.py]
|
||||||
|
|
||||||
[bumpversion:file:internal/constants/constants.go]
|
[bumpversion:file:internal/constants/constants.go]
|
||||||
|
2
.github/FUNDING.yml
vendored
2
.github/FUNDING.yml
vendored
@ -1 +1 @@
|
|||||||
custom: https://goauthentik.io/pricing/
|
github: [BeryJu]
|
||||||
|
2
.github/ISSUE_TEMPLATE/question.md
vendored
2
.github/ISSUE_TEMPLATE/question.md
vendored
@ -9,7 +9,7 @@ assignees: ""
|
|||||||
**Describe your question/**
|
**Describe your question/**
|
||||||
A clear and concise description of what you're trying to do.
|
A clear and concise description of what you're trying to do.
|
||||||
|
|
||||||
**Relevant info**
|
**Relevant infos**
|
||||||
i.e. Version of other software you're using, specifics of your setup
|
i.e. Version of other software you're using, specifics of your setup
|
||||||
|
|
||||||
**Screenshots**
|
**Screenshots**
|
||||||
|
@ -54,7 +54,6 @@ runs:
|
|||||||
authentik:
|
authentik:
|
||||||
outposts:
|
outposts:
|
||||||
container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
|
container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
|
||||||
global:
|
|
||||||
image:
|
image:
|
||||||
repository: ghcr.io/goauthentik/dev-server
|
repository: ghcr.io/goauthentik/dev-server
|
||||||
tag: ${{ inputs.tag }}
|
tag: ${{ inputs.tag }}
|
||||||
@ -66,7 +65,6 @@ runs:
|
|||||||
authentik:
|
authentik:
|
||||||
outposts:
|
outposts:
|
||||||
container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
|
container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
|
||||||
global:
|
|
||||||
image:
|
image:
|
||||||
repository: ghcr.io/goauthentik/dev-server
|
repository: ghcr.io/goauthentik/dev-server
|
||||||
tag: ${{ inputs.tag }}-arm64
|
tag: ${{ inputs.tag }}-arm64
|
||||||
|
@ -29,15 +29,9 @@ outputs:
|
|||||||
imageTags:
|
imageTags:
|
||||||
description: "Docker image tags"
|
description: "Docker image tags"
|
||||||
value: ${{ steps.ev.outputs.imageTags }}
|
value: ${{ steps.ev.outputs.imageTags }}
|
||||||
attestImageNames:
|
|
||||||
description: "Docker image names used for attestation"
|
|
||||||
value: ${{ steps.ev.outputs.attestImageNames }}
|
|
||||||
imageMainTag:
|
imageMainTag:
|
||||||
description: "Docker image main tag"
|
description: "Docker image main tag"
|
||||||
value: ${{ steps.ev.outputs.imageMainTag }}
|
value: ${{ steps.ev.outputs.imageMainTag }}
|
||||||
imageMainName:
|
|
||||||
description: "Docker image main name"
|
|
||||||
value: ${{ steps.ev.outputs.imageMainName }}
|
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: "composite"
|
using: "composite"
|
||||||
|
@ -7,12 +7,12 @@ from time import time
|
|||||||
parser = configparser.ConfigParser()
|
parser = configparser.ConfigParser()
|
||||||
parser.read(".bumpversion.cfg")
|
parser.read(".bumpversion.cfg")
|
||||||
|
|
||||||
should_build = str(len(os.environ.get("DOCKER_USERNAME", "")) > 0).lower()
|
should_build = str(os.environ.get("DOCKER_USERNAME", None) is not None).lower()
|
||||||
|
|
||||||
branch_name = os.environ["GITHUB_REF"]
|
branch_name = os.environ["GITHUB_REF"]
|
||||||
if os.environ.get("GITHUB_HEAD_REF", "") != "":
|
if os.environ.get("GITHUB_HEAD_REF", "") != "":
|
||||||
branch_name = os.environ["GITHUB_HEAD_REF"]
|
branch_name = os.environ["GITHUB_HEAD_REF"]
|
||||||
safe_branch_name = branch_name.replace("refs/heads/", "").replace("/", "-").replace("'", "-")
|
safe_branch_name = branch_name.replace("refs/heads/", "").replace("/", "-")
|
||||||
|
|
||||||
image_names = os.getenv("IMAGE_NAME").split(",")
|
image_names = os.getenv("IMAGE_NAME").split(",")
|
||||||
image_arch = os.getenv("IMAGE_ARCH") or None
|
image_arch = os.getenv("IMAGE_ARCH") or None
|
||||||
@ -50,25 +50,13 @@ else:
|
|||||||
f"{name}:gh-{safe_branch_name}-{int(time())}-{sha[:7]}{suffix}", # Use by FluxCD
|
f"{name}:gh-{safe_branch_name}-{int(time())}-{sha[:7]}{suffix}", # Use by FluxCD
|
||||||
]
|
]
|
||||||
|
|
||||||
image_main_tag = image_tags[0].split(":")[-1]
|
image_main_tag = image_tags[0]
|
||||||
|
image_tags_rendered = ",".join(image_tags)
|
||||||
|
|
||||||
def get_attest_image_names(image_with_tags: list[str]):
|
|
||||||
"""Attestation only for GHCR"""
|
|
||||||
image_tags = []
|
|
||||||
for image_name in set(name.split(":")[0] for name in image_with_tags):
|
|
||||||
if not image_name.startswith("ghcr.io"):
|
|
||||||
continue
|
|
||||||
image_tags.append(image_name)
|
|
||||||
return ",".join(set(image_tags))
|
|
||||||
|
|
||||||
|
|
||||||
with open(os.environ["GITHUB_OUTPUT"], "a+", encoding="utf-8") as _output:
|
with open(os.environ["GITHUB_OUTPUT"], "a+", encoding="utf-8") as _output:
|
||||||
print(f"shouldBuild={should_build}", file=_output)
|
print("shouldBuild=%s" % should_build, file=_output)
|
||||||
print(f"sha={sha}", file=_output)
|
print("sha=%s" % sha, file=_output)
|
||||||
print(f"version={version}", file=_output)
|
print("version=%s" % version, file=_output)
|
||||||
print(f"prerelease={prerelease}", file=_output)
|
print("prerelease=%s" % prerelease, file=_output)
|
||||||
print(f"imageTags={','.join(image_tags)}", file=_output)
|
print("imageTags=%s" % image_tags_rendered, file=_output)
|
||||||
print(f"attestImageNames={get_attest_image_names(image_tags)}", file=_output)
|
print("imageMainTag=%s" % image_main_tag, file=_output)
|
||||||
print(f"imageMainTag={image_main_tag}", file=_output)
|
|
||||||
print(f"imageMainName={image_tags[0]}", file=_output)
|
|
||||||
|
10
.github/actions/setup/action.yml
vendored
10
.github/actions/setup/action.yml
vendored
@ -14,27 +14,27 @@ runs:
|
|||||||
run: |
|
run: |
|
||||||
pipx install poetry || true
|
pipx install poetry || true
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get install --no-install-recommends -y libpq-dev openssl libxmlsec1-dev pkg-config gettext libkrb5-dev krb5-kdc krb5-user krb5-admin-server
|
sudo apt-get install --no-install-recommends -y libpq-dev openssl libxmlsec1-dev pkg-config gettext
|
||||||
- name: Setup python and restore poetry
|
- name: Setup python and restore poetry
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v4
|
||||||
with:
|
with:
|
||||||
python-version-file: "pyproject.toml"
|
python-version-file: "pyproject.toml"
|
||||||
cache: "poetry"
|
cache: "poetry"
|
||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v4
|
uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version-file: web/package.json
|
node-version-file: web/package.json
|
||||||
cache: "npm"
|
cache: "npm"
|
||||||
cache-dependency-path: web/package-lock.json
|
cache-dependency-path: web/package-lock.json
|
||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@v5
|
uses: actions/setup-go@v4
|
||||||
with:
|
with:
|
||||||
go-version-file: "go.mod"
|
go-version-file: "go.mod"
|
||||||
- name: Setup dependencies
|
- name: Setup dependencies
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
export PSQL_TAG=${{ inputs.postgresql_version }}
|
export PSQL_TAG=${{ inputs.postgresql_version }}
|
||||||
docker compose -f .github/actions/setup/docker-compose.yml up -d
|
docker-compose -f .github/actions/setup/docker-compose.yml up -d
|
||||||
poetry install
|
poetry install
|
||||||
cd web && npm ci
|
cd web && npm ci
|
||||||
- name: Generate config
|
- name: Generate config
|
||||||
|
2
.github/actions/setup/docker-compose.yml
vendored
2
.github/actions/setup/docker-compose.yml
vendored
@ -1,3 +1,5 @@
|
|||||||
|
version: "3.7"
|
||||||
|
|
||||||
services:
|
services:
|
||||||
postgresql:
|
postgresql:
|
||||||
image: docker.io/library/postgres:${PSQL_TAG:-16}
|
image: docker.io/library/postgres:${PSQL_TAG:-16}
|
||||||
|
1
.github/codespell-words.txt
vendored
1
.github/codespell-words.txt
vendored
@ -4,4 +4,3 @@ hass
|
|||||||
warmup
|
warmup
|
||||||
ontext
|
ontext
|
||||||
singed
|
singed
|
||||||
assertIn
|
|
||||||
|
47
.github/dependabot.yml
vendored
47
.github/dependabot.yml
vendored
@ -21,9 +21,7 @@ updates:
|
|||||||
labels:
|
labels:
|
||||||
- dependencies
|
- dependencies
|
||||||
- package-ecosystem: npm
|
- package-ecosystem: npm
|
||||||
directories:
|
directory: "/web"
|
||||||
- "/web"
|
|
||||||
- "/web/sfe"
|
|
||||||
schedule:
|
schedule:
|
||||||
interval: daily
|
interval: daily
|
||||||
time: "04:00"
|
time: "04:00"
|
||||||
@ -32,6 +30,7 @@ updates:
|
|||||||
open-pull-requests-limit: 10
|
open-pull-requests-limit: 10
|
||||||
commit-message:
|
commit-message:
|
||||||
prefix: "web:"
|
prefix: "web:"
|
||||||
|
# TODO: deduplicate these groups
|
||||||
groups:
|
groups:
|
||||||
sentry:
|
sentry:
|
||||||
patterns:
|
patterns:
|
||||||
@ -43,11 +42,9 @@ updates:
|
|||||||
- "babel-*"
|
- "babel-*"
|
||||||
eslint:
|
eslint:
|
||||||
patterns:
|
patterns:
|
||||||
- "@eslint/*"
|
|
||||||
- "@typescript-eslint/*"
|
- "@typescript-eslint/*"
|
||||||
- "eslint-*"
|
|
||||||
- "eslint"
|
- "eslint"
|
||||||
- "typescript-eslint"
|
- "eslint-*"
|
||||||
storybook:
|
storybook:
|
||||||
patterns:
|
patterns:
|
||||||
- "@storybook/*"
|
- "@storybook/*"
|
||||||
@ -55,16 +52,38 @@ updates:
|
|||||||
esbuild:
|
esbuild:
|
||||||
patterns:
|
patterns:
|
||||||
- "@esbuild/*"
|
- "@esbuild/*"
|
||||||
- "esbuild*"
|
- package-ecosystem: npm
|
||||||
rollup:
|
directory: "/tests/wdio"
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
|
time: "04:00"
|
||||||
|
labels:
|
||||||
|
- dependencies
|
||||||
|
open-pull-requests-limit: 10
|
||||||
|
commit-message:
|
||||||
|
prefix: "web:"
|
||||||
|
# TODO: deduplicate these groups
|
||||||
|
groups:
|
||||||
|
sentry:
|
||||||
patterns:
|
patterns:
|
||||||
- "@rollup/*"
|
- "@sentry/*"
|
||||||
- "rollup-*"
|
- "@spotlightjs/*"
|
||||||
- "rollup*"
|
babel:
|
||||||
swc:
|
|
||||||
patterns:
|
patterns:
|
||||||
- "@swc/*"
|
- "@babel/*"
|
||||||
- "swc-*"
|
- "babel-*"
|
||||||
|
eslint:
|
||||||
|
patterns:
|
||||||
|
- "@typescript-eslint/*"
|
||||||
|
- "eslint"
|
||||||
|
- "eslint-*"
|
||||||
|
storybook:
|
||||||
|
patterns:
|
||||||
|
- "@storybook/*"
|
||||||
|
- "*storybook*"
|
||||||
|
esbuild:
|
||||||
|
patterns:
|
||||||
|
- "@esbuild/*"
|
||||||
wdio:
|
wdio:
|
||||||
patterns:
|
patterns:
|
||||||
- "@wdio/*"
|
- "@wdio/*"
|
||||||
|
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
@ -1,7 +1,7 @@
|
|||||||
<!--
|
<!--
|
||||||
👋 Hi there! Welcome.
|
👋 Hi there! Welcome.
|
||||||
|
|
||||||
Please check the Contributing guidelines: https://docs.goauthentik.io/docs/developer-docs/#how-can-i-contribute
|
Please check the Contributing guidelines: https://goauthentik.io/developer-docs/#how-can-i-contribute
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
65
.github/workflows/api-py-publish.yml
vendored
65
.github/workflows/api-py-publish.yml
vendored
@ -1,65 +0,0 @@
|
|||||||
name: authentik-api-py-publish
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
paths:
|
|
||||||
- "schema.yml"
|
|
||||||
workflow_dispatch:
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
id-token: write
|
|
||||||
steps:
|
|
||||||
- id: generate_token
|
|
||||||
uses: tibdex/github-app-token@v2
|
|
||||||
with:
|
|
||||||
app_id: ${{ secrets.GH_APP_ID }}
|
|
||||||
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
- name: Install poetry & deps
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
pipx install poetry || true
|
|
||||||
sudo apt-get update
|
|
||||||
sudo apt-get install --no-install-recommends -y libpq-dev openssl libxmlsec1-dev pkg-config gettext
|
|
||||||
- name: Setup python and restore poetry
|
|
||||||
uses: actions/setup-python@v5
|
|
||||||
with:
|
|
||||||
python-version-file: "pyproject.toml"
|
|
||||||
cache: "poetry"
|
|
||||||
- name: Generate API Client
|
|
||||||
run: make gen-client-py
|
|
||||||
- name: Publish package
|
|
||||||
working-directory: gen-py-api/
|
|
||||||
run: |
|
|
||||||
poetry build
|
|
||||||
- name: Publish package to PyPI
|
|
||||||
uses: pypa/gh-action-pypi-publish@release/v1
|
|
||||||
with:
|
|
||||||
packages-dir: gen-py-api/dist/
|
|
||||||
# We can't easily upgrade the API client being used due to poetry being poetry
|
|
||||||
# so we'll have to rely on dependabot
|
|
||||||
# - name: Upgrade /
|
|
||||||
# run: |
|
|
||||||
# export VERSION=$(cd gen-py-api && poetry version -s)
|
|
||||||
# poetry add "authentik_client=$VERSION" --allow-prereleases --lock
|
|
||||||
# - uses: peter-evans/create-pull-request@v6
|
|
||||||
# id: cpr
|
|
||||||
# with:
|
|
||||||
# token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
# branch: update-root-api-client
|
|
||||||
# commit-message: "root: bump API Client version"
|
|
||||||
# title: "root: bump API Client version"
|
|
||||||
# body: "root: bump API Client version"
|
|
||||||
# delete-branch: true
|
|
||||||
# signoff: true
|
|
||||||
# # ID from https://api.github.com/users/authentik-automation[bot]
|
|
||||||
# author: authentik-automation[bot] <135050075+authentik-automation[bot]@users.noreply.github.com>
|
|
||||||
# - uses: peter-evans/enable-pull-request-automerge@v3
|
|
||||||
# with:
|
|
||||||
# token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
# pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
|
|
||||||
# merge-method: squash
|
|
53
.github/workflows/ci-main.yml
vendored
53
.github/workflows/ci-main.yml
vendored
@ -7,6 +7,8 @@ on:
|
|||||||
- main
|
- main
|
||||||
- next
|
- next
|
||||||
- version-*
|
- version-*
|
||||||
|
paths-ignore:
|
||||||
|
- website/**
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
@ -26,7 +28,10 @@ jobs:
|
|||||||
- bandit
|
- bandit
|
||||||
- black
|
- black
|
||||||
- codespell
|
- codespell
|
||||||
|
- isort
|
||||||
- pending-migrations
|
- pending-migrations
|
||||||
|
# - pylint
|
||||||
|
- pyright
|
||||||
- ruff
|
- ruff
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
@ -50,6 +55,7 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
psql:
|
psql:
|
||||||
|
- 12-alpine
|
||||||
- 15-alpine
|
- 15-alpine
|
||||||
- 16-alpine
|
- 16-alpine
|
||||||
steps:
|
steps:
|
||||||
@ -103,6 +109,7 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
psql:
|
psql:
|
||||||
|
- 12-alpine
|
||||||
- 15-alpine
|
- 15-alpine
|
||||||
- 16-alpine
|
- 16-alpine
|
||||||
steps:
|
steps:
|
||||||
@ -120,12 +127,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
flags: unit
|
flags: unit
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
token: ${{ secrets.CODECOV_TOKEN }}
|
||||||
- if: ${{ !cancelled() }}
|
|
||||||
uses: codecov/test-results-action@v1
|
|
||||||
with:
|
|
||||||
flags: unit
|
|
||||||
file: unittest.xml
|
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
|
||||||
test-integration:
|
test-integration:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
timeout-minutes: 30
|
timeout-minutes: 30
|
||||||
@ -134,7 +135,7 @@ jobs:
|
|||||||
- name: Setup authentik env
|
- name: Setup authentik env
|
||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
- name: Create k8s Kind Cluster
|
- name: Create k8s Kind Cluster
|
||||||
uses: helm/kind-action@v1.10.0
|
uses: helm/kind-action@v1.9.0
|
||||||
- name: run integration
|
- name: run integration
|
||||||
run: |
|
run: |
|
||||||
poetry run coverage run manage.py test tests/integration
|
poetry run coverage run manage.py test tests/integration
|
||||||
@ -144,12 +145,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
flags: integration
|
flags: integration
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
token: ${{ secrets.CODECOV_TOKEN }}
|
||||||
- if: ${{ !cancelled() }}
|
|
||||||
uses: codecov/test-results-action@v1
|
|
||||||
with:
|
|
||||||
flags: integration
|
|
||||||
file: unittest.xml
|
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
|
||||||
test-e2e:
|
test-e2e:
|
||||||
name: test-e2e (${{ matrix.job.name }})
|
name: test-e2e (${{ matrix.job.name }})
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@ -170,8 +165,6 @@ jobs:
|
|||||||
glob: tests/e2e/test_provider_ldap* tests/e2e/test_source_ldap*
|
glob: tests/e2e/test_provider_ldap* tests/e2e/test_source_ldap*
|
||||||
- name: radius
|
- name: radius
|
||||||
glob: tests/e2e/test_provider_radius*
|
glob: tests/e2e/test_provider_radius*
|
||||||
- name: scim
|
|
||||||
glob: tests/e2e/test_source_scim*
|
|
||||||
- name: flows
|
- name: flows
|
||||||
glob: tests/e2e/test_flows*
|
glob: tests/e2e/test_flows*
|
||||||
steps:
|
steps:
|
||||||
@ -180,7 +173,7 @@ jobs:
|
|||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
- name: Setup e2e env (chrome, etc)
|
- name: Setup e2e env (chrome, etc)
|
||||||
run: |
|
run: |
|
||||||
docker compose -f tests/e2e/docker-compose.yml up -d --quiet-pull
|
docker-compose -f tests/e2e/docker-compose.yml up -d
|
||||||
- id: cache-web
|
- id: cache-web
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v4
|
||||||
with:
|
with:
|
||||||
@ -202,12 +195,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
flags: e2e
|
flags: e2e
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
token: ${{ secrets.CODECOV_TOKEN }}
|
||||||
- if: ${{ !cancelled() }}
|
|
||||||
uses: codecov/test-results-action@v1
|
|
||||||
with:
|
|
||||||
flags: e2e
|
|
||||||
file: unittest.xml
|
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
|
||||||
ci-core-mark:
|
ci-core-mark:
|
||||||
needs:
|
needs:
|
||||||
- lint
|
- lint
|
||||||
@ -231,16 +218,13 @@ jobs:
|
|||||||
permissions:
|
permissions:
|
||||||
# Needed to upload contianer images to ghcr.io
|
# Needed to upload contianer images to ghcr.io
|
||||||
packages: write
|
packages: write
|
||||||
# Needed for attestation
|
|
||||||
id-token: write
|
|
||||||
attestations: write
|
|
||||||
timeout-minutes: 120
|
timeout-minutes: 120
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v3.2.0
|
uses: docker/setup-qemu-action@v3.0.0
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@v3
|
||||||
- name: prepare variables
|
- name: prepare variables
|
||||||
@ -261,8 +245,7 @@ jobs:
|
|||||||
- name: generate ts client
|
- name: generate ts client
|
||||||
run: make gen-client-ts
|
run: make gen-client-ts
|
||||||
- name: Build Docker Image
|
- name: Build Docker Image
|
||||||
uses: docker/build-push-action@v6
|
uses: docker/build-push-action@v5
|
||||||
id: push
|
|
||||||
with:
|
with:
|
||||||
context: .
|
context: .
|
||||||
secrets: |
|
secrets: |
|
||||||
@ -272,16 +255,9 @@ jobs:
|
|||||||
push: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
push: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
||||||
build-args: |
|
build-args: |
|
||||||
GIT_BUILD_HASH=${{ steps.ev.outputs.sha }}
|
GIT_BUILD_HASH=${{ steps.ev.outputs.sha }}
|
||||||
cache-from: type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache
|
cache-from: type=gha
|
||||||
cache-to: ${{ steps.ev.outputs.shouldBuild == 'true' && 'type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache,mode=max' || '' }}
|
cache-to: type=gha,mode=max
|
||||||
platforms: linux/${{ matrix.arch }}
|
platforms: linux/${{ matrix.arch }}
|
||||||
- uses: actions/attest-build-provenance@v1
|
|
||||||
id: attest
|
|
||||||
if: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
|
||||||
with:
|
|
||||||
subject-name: ${{ steps.ev.outputs.attestImageNames }}
|
|
||||||
subject-digest: ${{ steps.push.outputs.digest }}
|
|
||||||
push-to-registry: true
|
|
||||||
pr-comment:
|
pr-comment:
|
||||||
needs:
|
needs:
|
||||||
- build
|
- build
|
||||||
@ -303,7 +279,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
image-name: ghcr.io/goauthentik/dev-server
|
image-name: ghcr.io/goauthentik/dev-server
|
||||||
- name: Comment on PR
|
- name: Comment on PR
|
||||||
if: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
|
||||||
uses: ./.github/actions/comment-pr-instructions
|
uses: ./.github/actions/comment-pr-instructions
|
||||||
with:
|
with:
|
||||||
tag: ${{ steps.ev.outputs.imageMainTag }}
|
tag: gh-${{ steps.ev.outputs.imageMainTag }}
|
||||||
|
23
.github/workflows/ci-outpost.yml
vendored
23
.github/workflows/ci-outpost.yml
vendored
@ -29,9 +29,9 @@ jobs:
|
|||||||
- name: Generate API
|
- name: Generate API
|
||||||
run: make gen-client-go
|
run: make gen-client-go
|
||||||
- name: golangci-lint
|
- name: golangci-lint
|
||||||
uses: golangci/golangci-lint-action@v6
|
uses: golangci/golangci-lint-action@v4
|
||||||
with:
|
with:
|
||||||
version: latest
|
version: v1.54.2
|
||||||
args: --timeout 5000s --verbose
|
args: --timeout 5000s --verbose
|
||||||
skip-cache: true
|
skip-cache: true
|
||||||
test-unittest:
|
test-unittest:
|
||||||
@ -71,15 +71,12 @@ jobs:
|
|||||||
permissions:
|
permissions:
|
||||||
# Needed to upload contianer images to ghcr.io
|
# Needed to upload contianer images to ghcr.io
|
||||||
packages: write
|
packages: write
|
||||||
# Needed for attestation
|
|
||||||
id-token: write
|
|
||||||
attestations: write
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v3.2.0
|
uses: docker/setup-qemu-action@v3.0.0
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@v3
|
||||||
- name: prepare variables
|
- name: prepare variables
|
||||||
@ -99,8 +96,7 @@ jobs:
|
|||||||
- name: Generate API
|
- name: Generate API
|
||||||
run: make gen-client-go
|
run: make gen-client-go
|
||||||
- name: Build Docker Image
|
- name: Build Docker Image
|
||||||
id: push
|
uses: docker/build-push-action@v5
|
||||||
uses: docker/build-push-action@v6
|
|
||||||
with:
|
with:
|
||||||
tags: ${{ steps.ev.outputs.imageTags }}
|
tags: ${{ steps.ev.outputs.imageTags }}
|
||||||
file: ${{ matrix.type }}.Dockerfile
|
file: ${{ matrix.type }}.Dockerfile
|
||||||
@ -109,15 +105,8 @@ jobs:
|
|||||||
GIT_BUILD_HASH=${{ steps.ev.outputs.sha }}
|
GIT_BUILD_HASH=${{ steps.ev.outputs.sha }}
|
||||||
platforms: linux/amd64,linux/arm64
|
platforms: linux/amd64,linux/arm64
|
||||||
context: .
|
context: .
|
||||||
cache-from: type=registry,ref=ghcr.io/goauthentik/dev-${{ matrix.type }}:buildcache
|
cache-from: type=gha
|
||||||
cache-to: ${{ steps.ev.outputs.shouldBuild == 'true' && format('type=registry,ref=ghcr.io/goauthentik/dev-{0}:buildcache,mode=max', matrix.type) || '' }}
|
cache-to: type=gha,mode=max
|
||||||
- uses: actions/attest-build-provenance@v1
|
|
||||||
id: attest
|
|
||||||
if: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
|
||||||
with:
|
|
||||||
subject-name: ${{ steps.ev.outputs.attestImageNames }}
|
|
||||||
subject-digest: ${{ steps.push.outputs.digest }}
|
|
||||||
push-to-registry: true
|
|
||||||
build-binary:
|
build-binary:
|
||||||
timeout-minutes: 120
|
timeout-minutes: 120
|
||||||
needs:
|
needs:
|
||||||
|
115
.github/workflows/ci-web.yml
vendored
115
.github/workflows/ci-web.yml
vendored
@ -12,23 +12,14 @@ on:
|
|||||||
- version-*
|
- version-*
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint:
|
lint-eslint:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
command:
|
|
||||||
- lint
|
|
||||||
- lint:lockfile
|
|
||||||
- tsc
|
|
||||||
- prettier-check
|
|
||||||
project:
|
project:
|
||||||
- web
|
- web
|
||||||
include:
|
- tests/wdio
|
||||||
- command: tsc
|
|
||||||
project: web
|
|
||||||
- command: lit-analyse
|
|
||||||
project: web
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v4
|
||||||
@ -37,14 +28,83 @@ jobs:
|
|||||||
cache: "npm"
|
cache: "npm"
|
||||||
cache-dependency-path: ${{ matrix.project }}/package-lock.json
|
cache-dependency-path: ${{ matrix.project }}/package-lock.json
|
||||||
- working-directory: ${{ matrix.project }}/
|
- working-directory: ${{ matrix.project }}/
|
||||||
run: |
|
run: npm ci
|
||||||
npm ci
|
|
||||||
- name: Generate API
|
- name: Generate API
|
||||||
run: make gen-client-ts
|
run: make gen-client-ts
|
||||||
- name: Lint
|
- name: Eslint
|
||||||
working-directory: ${{ matrix.project }}/
|
working-directory: ${{ matrix.project }}/
|
||||||
run: npm run ${{ matrix.command }}
|
run: npm run lint
|
||||||
|
lint-build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: web/package.json
|
||||||
|
cache: "npm"
|
||||||
|
cache-dependency-path: web/package-lock.json
|
||||||
|
- working-directory: web/
|
||||||
|
run: npm ci
|
||||||
|
- name: Generate API
|
||||||
|
run: make gen-client-ts
|
||||||
|
- name: TSC
|
||||||
|
working-directory: web/
|
||||||
|
run: npm run tsc
|
||||||
|
lint-prettier:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
project:
|
||||||
|
- web
|
||||||
|
- tests/wdio
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: ${{ matrix.project }}/package.json
|
||||||
|
cache: "npm"
|
||||||
|
cache-dependency-path: ${{ matrix.project }}/package-lock.json
|
||||||
|
- working-directory: ${{ matrix.project }}/
|
||||||
|
run: npm ci
|
||||||
|
- name: Generate API
|
||||||
|
run: make gen-client-ts
|
||||||
|
- name: prettier
|
||||||
|
working-directory: ${{ matrix.project }}/
|
||||||
|
run: npm run prettier-check
|
||||||
|
lint-lit-analyse:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: web/package.json
|
||||||
|
cache: "npm"
|
||||||
|
cache-dependency-path: web/package-lock.json
|
||||||
|
- working-directory: web/
|
||||||
|
run: |
|
||||||
|
npm ci
|
||||||
|
# lit-analyse doesn't understand path rewrites, so make it
|
||||||
|
# belive it's an actual module
|
||||||
|
cd node_modules/@goauthentik
|
||||||
|
ln -s ../../src/ web
|
||||||
|
- name: Generate API
|
||||||
|
run: make gen-client-ts
|
||||||
|
- name: lit-analyse
|
||||||
|
working-directory: web/
|
||||||
|
run: npm run lit-analyse
|
||||||
|
ci-web-mark:
|
||||||
|
needs:
|
||||||
|
- lint-eslint
|
||||||
|
- lint-prettier
|
||||||
|
- lint-lit-analyse
|
||||||
|
- lint-build
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- run: echo mark
|
||||||
build:
|
build:
|
||||||
|
needs:
|
||||||
|
- ci-web-mark
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
@ -60,28 +120,3 @@ jobs:
|
|||||||
- name: build
|
- name: build
|
||||||
working-directory: web/
|
working-directory: web/
|
||||||
run: npm run build
|
run: npm run build
|
||||||
ci-web-mark:
|
|
||||||
needs:
|
|
||||||
- build
|
|
||||||
- lint
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- run: echo mark
|
|
||||||
test:
|
|
||||||
needs:
|
|
||||||
- ci-web-mark
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: web/package.json
|
|
||||||
cache: "npm"
|
|
||||||
cache-dependency-path: web/package-lock.json
|
|
||||||
- working-directory: web/
|
|
||||||
run: npm ci
|
|
||||||
- name: Generate API
|
|
||||||
run: make gen-client-ts
|
|
||||||
- name: test
|
|
||||||
working-directory: web/
|
|
||||||
run: npm run test || exit 0
|
|
||||||
|
20
.github/workflows/ci-website.yml
vendored
20
.github/workflows/ci-website.yml
vendored
@ -12,21 +12,20 @@ on:
|
|||||||
- version-*
|
- version-*
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint:
|
lint-prettier:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
command:
|
|
||||||
- lint:lockfile
|
|
||||||
- prettier-check
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- 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/
|
- working-directory: website/
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- name: Lint
|
- name: prettier
|
||||||
working-directory: website/
|
working-directory: website/
|
||||||
run: npm run ${{ matrix.command }}
|
run: npm run prettier-check
|
||||||
test:
|
test:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
@ -49,6 +48,7 @@ jobs:
|
|||||||
matrix:
|
matrix:
|
||||||
job:
|
job:
|
||||||
- build
|
- build
|
||||||
|
- build-docs-only
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v4
|
||||||
@ -63,7 +63,7 @@ jobs:
|
|||||||
run: npm run ${{ matrix.job }}
|
run: npm run ${{ matrix.job }}
|
||||||
ci-website-mark:
|
ci-website-mark:
|
||||||
needs:
|
needs:
|
||||||
- lint
|
- lint-prettier
|
||||||
- test
|
- test
|
||||||
- build
|
- build
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
43
.github/workflows/gen-update-webauthn-mds.yml
vendored
43
.github/workflows/gen-update-webauthn-mds.yml
vendored
@ -1,43 +0,0 @@
|
|||||||
name: authentik-gen-update-webauthn-mds
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
schedule:
|
|
||||||
- cron: '30 1 1,15 * *'
|
|
||||||
|
|
||||||
env:
|
|
||||||
POSTGRES_DB: authentik
|
|
||||||
POSTGRES_USER: authentik
|
|
||||||
POSTGRES_PASSWORD: "EK-5jnKfjrGRm<77"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- id: generate_token
|
|
||||||
uses: tibdex/github-app-token@v2
|
|
||||||
with:
|
|
||||||
app_id: ${{ secrets.GH_APP_ID }}
|
|
||||||
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
- name: Setup authentik env
|
|
||||||
uses: ./.github/actions/setup
|
|
||||||
- run: poetry run ak update_webauthn_mds
|
|
||||||
- uses: peter-evans/create-pull-request@v7
|
|
||||||
id: cpr
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
branch: update-fido-mds-client
|
|
||||||
commit-message: "stages/authenticator_webauthn: Update FIDO MDS3 & Passkey aaguid blobs"
|
|
||||||
title: "stages/authenticator_webauthn: Update FIDO MDS3 & Passkey aaguid blobs"
|
|
||||||
body: "stages/authenticator_webauthn: Update FIDO MDS3 & Passkey aaguid blobs"
|
|
||||||
delete-branch: true
|
|
||||||
signoff: true
|
|
||||||
# ID from https://api.github.com/users/authentik-automation[bot]
|
|
||||||
author: authentik-automation[bot] <135050075+authentik-automation[bot]@users.noreply.github.com>
|
|
||||||
- uses: peter-evans/enable-pull-request-automerge@v3
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
|
|
||||||
merge-method: squash
|
|
2
.github/workflows/image-compress.yml
vendored
2
.github/workflows/image-compress.yml
vendored
@ -42,7 +42,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
githubToken: ${{ steps.generate_token.outputs.token }}
|
githubToken: ${{ steps.generate_token.outputs.token }}
|
||||||
compressOnly: ${{ github.event_name != 'pull_request' }}
|
compressOnly: ${{ github.event_name != 'pull_request' }}
|
||||||
- uses: peter-evans/create-pull-request@v7
|
- uses: peter-evans/create-pull-request@v6
|
||||||
if: "${{ github.event_name != 'pull_request' && steps.compress.outputs.markdown != '' }}"
|
if: "${{ github.event_name != 'pull_request' && steps.compress.outputs.markdown != '' }}"
|
||||||
id: cpr
|
id: cpr
|
||||||
with:
|
with:
|
||||||
|
48
.github/workflows/release-publish.yml
vendored
48
.github/workflows/release-publish.yml
vendored
@ -11,13 +11,10 @@ jobs:
|
|||||||
permissions:
|
permissions:
|
||||||
# Needed to upload contianer images to ghcr.io
|
# Needed to upload contianer images to ghcr.io
|
||||||
packages: write
|
packages: write
|
||||||
# Needed for attestation
|
|
||||||
id-token: write
|
|
||||||
attestations: write
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v3.2.0
|
uses: docker/setup-qemu-action@v3.0.0
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@v3
|
||||||
- name: prepare variables
|
- name: prepare variables
|
||||||
@ -43,32 +40,20 @@ jobs:
|
|||||||
mkdir -p ./gen-ts-api
|
mkdir -p ./gen-ts-api
|
||||||
mkdir -p ./gen-go-api
|
mkdir -p ./gen-go-api
|
||||||
- name: Build Docker Image
|
- name: Build Docker Image
|
||||||
uses: docker/build-push-action@v6
|
uses: docker/build-push-action@v5
|
||||||
id: push
|
|
||||||
with:
|
with:
|
||||||
context: .
|
context: .
|
||||||
push: true
|
push: true
|
||||||
secrets: |
|
secrets: |
|
||||||
GEOIPUPDATE_ACCOUNT_ID=${{ secrets.GEOIPUPDATE_ACCOUNT_ID }}
|
GEOIPUPDATE_ACCOUNT_ID=${{ secrets.GEOIPUPDATE_ACCOUNT_ID }}
|
||||||
GEOIPUPDATE_LICENSE_KEY=${{ secrets.GEOIPUPDATE_LICENSE_KEY }}
|
GEOIPUPDATE_LICENSE_KEY=${{ secrets.GEOIPUPDATE_LICENSE_KEY }}
|
||||||
build-args: |
|
|
||||||
VERSION=${{ github.ref }}
|
|
||||||
tags: ${{ steps.ev.outputs.imageTags }}
|
tags: ${{ steps.ev.outputs.imageTags }}
|
||||||
platforms: linux/amd64,linux/arm64
|
platforms: linux/amd64,linux/arm64
|
||||||
- uses: actions/attest-build-provenance@v1
|
|
||||||
id: attest
|
|
||||||
with:
|
|
||||||
subject-name: ${{ steps.ev.outputs.attestImageNames }}
|
|
||||||
subject-digest: ${{ steps.push.outputs.digest }}
|
|
||||||
push-to-registry: true
|
|
||||||
build-outpost:
|
build-outpost:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
# Needed to upload contianer images to ghcr.io
|
# Needed to upload contianer images to ghcr.io
|
||||||
packages: write
|
packages: write
|
||||||
# Needed for attestation
|
|
||||||
id-token: write
|
|
||||||
attestations: write
|
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
@ -83,7 +68,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
go-version-file: "go.mod"
|
go-version-file: "go.mod"
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v3.2.0
|
uses: docker/setup-qemu-action@v3.0.0
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@v3
|
||||||
- name: prepare variables
|
- name: prepare variables
|
||||||
@ -109,22 +94,13 @@ jobs:
|
|||||||
username: ${{ github.repository_owner }}
|
username: ${{ github.repository_owner }}
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
- name: Build Docker Image
|
- name: Build Docker Image
|
||||||
uses: docker/build-push-action@v6
|
uses: docker/build-push-action@v5
|
||||||
id: push
|
|
||||||
with:
|
with:
|
||||||
push: true
|
push: true
|
||||||
build-args: |
|
|
||||||
VERSION=${{ github.ref }}
|
|
||||||
tags: ${{ steps.ev.outputs.imageTags }}
|
tags: ${{ steps.ev.outputs.imageTags }}
|
||||||
file: ${{ matrix.type }}.Dockerfile
|
file: ${{ matrix.type }}.Dockerfile
|
||||||
platforms: linux/amd64,linux/arm64
|
platforms: linux/amd64,linux/arm64
|
||||||
context: .
|
context: .
|
||||||
- uses: actions/attest-build-provenance@v1
|
|
||||||
id: attest
|
|
||||||
with:
|
|
||||||
subject-name: ${{ steps.ev.outputs.attestImageNames }}
|
|
||||||
subject-digest: ${{ steps.push.outputs.digest }}
|
|
||||||
push-to-registry: true
|
|
||||||
build-outpost-binary:
|
build-outpost-binary:
|
||||||
timeout-minutes: 120
|
timeout-minutes: 120
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@ -179,12 +155,12 @@ jobs:
|
|||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Run test suite in final docker images
|
- name: Run test suite in final docker images
|
||||||
run: |
|
run: |
|
||||||
echo "PG_PASS=$(openssl rand 32 | base64 -w 0)" >> .env
|
echo "PG_PASS=$(openssl rand -base64 32)" >> .env
|
||||||
echo "AUTHENTIK_SECRET_KEY=$(openssl rand 32 | base64 -w 0)" >> .env
|
echo "AUTHENTIK_SECRET_KEY=$(openssl rand -base64 32)" >> .env
|
||||||
docker compose pull -q
|
docker-compose pull -q
|
||||||
docker compose up --no-start
|
docker-compose up --no-start
|
||||||
docker compose start postgresql redis
|
docker-compose start postgresql redis
|
||||||
docker compose run -u root server test-all
|
docker-compose run -u root server test-all
|
||||||
sentry-release:
|
sentry-release:
|
||||||
needs:
|
needs:
|
||||||
- build-server
|
- build-server
|
||||||
@ -202,8 +178,8 @@ jobs:
|
|||||||
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
|
||||||
run: |
|
run: |
|
||||||
docker pull ${{ steps.ev.outputs.imageMainName }}
|
docker pull ${{ steps.ev.outputs.imageMainTag }}
|
||||||
container=$(docker container create ${{ steps.ev.outputs.imageMainName }})
|
container=$(docker container create ${{ steps.ev.outputs.imageMainTag }})
|
||||||
docker cp ${container}:web/ .
|
docker cp ${container}:web/ .
|
||||||
- name: Create a Sentry.io release
|
- name: Create a Sentry.io release
|
||||||
uses: getsentry/action-release@v1
|
uses: getsentry/action-release@v1
|
||||||
|
10
.github/workflows/release-tag.yml
vendored
10
.github/workflows/release-tag.yml
vendored
@ -14,16 +14,16 @@ jobs:
|
|||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Pre-release test
|
- name: Pre-release test
|
||||||
run: |
|
run: |
|
||||||
echo "PG_PASS=$(openssl rand 32 | base64 -w 0)" >> .env
|
echo "PG_PASS=$(openssl rand -base64 32)" >> .env
|
||||||
echo "AUTHENTIK_SECRET_KEY=$(openssl rand 32 | base64 -w 0)" >> .env
|
echo "AUTHENTIK_SECRET_KEY=$(openssl rand -base64 32)" >> .env
|
||||||
docker buildx install
|
docker buildx install
|
||||||
mkdir -p ./gen-ts-api
|
mkdir -p ./gen-ts-api
|
||||||
docker build -t testing:latest .
|
docker build -t testing:latest .
|
||||||
echo "AUTHENTIK_IMAGE=testing" >> .env
|
echo "AUTHENTIK_IMAGE=testing" >> .env
|
||||||
echo "AUTHENTIK_TAG=latest" >> .env
|
echo "AUTHENTIK_TAG=latest" >> .env
|
||||||
docker compose up --no-start
|
docker-compose up --no-start
|
||||||
docker compose start postgresql redis
|
docker-compose start postgresql redis
|
||||||
docker compose run -u root server test-all
|
docker-compose run -u root server test-all
|
||||||
- id: generate_token
|
- id: generate_token
|
||||||
uses: tibdex/github-app-token@v2
|
uses: tibdex/github-app-token@v2
|
||||||
with:
|
with:
|
||||||
|
2
.github/workflows/repo-stale.yml
vendored
2
.github/workflows/repo-stale.yml
vendored
@ -23,7 +23,7 @@ jobs:
|
|||||||
repo-token: ${{ steps.generate_token.outputs.token }}
|
repo-token: ${{ steps.generate_token.outputs.token }}
|
||||||
days-before-stale: 60
|
days-before-stale: 60
|
||||||
days-before-close: 7
|
days-before-close: 7
|
||||||
exempt-issue-labels: pinned,security,pr_wanted,enhancement,bug/confirmed,enhancement/confirmed,question,status/reviewing
|
exempt-issue-labels: pinned,security,pr_wanted,enhancement,bug/confirmed,enhancement/confirmed,question
|
||||||
stale-issue-label: wontfix
|
stale-issue-label: wontfix
|
||||||
stale-issue-message: >
|
stale-issue-message: >
|
||||||
This issue has been automatically marked as stale because it has not had
|
This issue has been automatically marked as stale because it has not had
|
||||||
|
@ -32,7 +32,7 @@ jobs:
|
|||||||
poetry run ak compilemessages
|
poetry run ak compilemessages
|
||||||
make web-check-compile
|
make web-check-compile
|
||||||
- name: Create Pull Request
|
- name: Create Pull Request
|
||||||
uses: peter-evans/create-pull-request@v7
|
uses: peter-evans/create-pull-request@v6
|
||||||
with:
|
with:
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
token: ${{ steps.generate_token.outputs.token }}
|
||||||
branch: extract-compile-backend-translation
|
branch: extract-compile-backend-translation
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
name: authentik-api-ts-publish
|
name: authentik-web-api-publish
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [main]
|
branches: [main]
|
||||||
@ -31,16 +31,11 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
|
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
|
||||||
- name: Upgrade /web
|
- name: Upgrade /web
|
||||||
working-directory: web
|
working-directory: web/
|
||||||
run: |
|
run: |
|
||||||
export VERSION=`node -e 'console.log(require("../gen-ts-api/package.json").version)'`
|
export VERSION=`node -e 'console.log(require("../gen-ts-api/package.json").version)'`
|
||||||
npm i @goauthentik/api@$VERSION
|
npm i @goauthentik/api@$VERSION
|
||||||
- name: Upgrade /web/packages/sfe
|
- uses: peter-evans/create-pull-request@v6
|
||||||
working-directory: web/packages/sfe
|
|
||||||
run: |
|
|
||||||
export VERSION=`node -e 'console.log(require("../gen-ts-api/package.json").version)'`
|
|
||||||
npm i @goauthentik/api@$VERSION
|
|
||||||
- uses: peter-evans/create-pull-request@v7
|
|
||||||
id: cpr
|
id: cpr
|
||||||
with:
|
with:
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
token: ${{ steps.generate_token.outputs.token }}
|
5
.vscode/extensions.json
vendored
5
.vscode/extensions.json
vendored
@ -10,12 +10,13 @@
|
|||||||
"Gruntfuggly.todo-tree",
|
"Gruntfuggly.todo-tree",
|
||||||
"mechatroner.rainbow-csv",
|
"mechatroner.rainbow-csv",
|
||||||
"ms-python.black-formatter",
|
"ms-python.black-formatter",
|
||||||
"charliermarsh.ruff",
|
"ms-python.isort",
|
||||||
|
"ms-python.pylint",
|
||||||
"ms-python.python",
|
"ms-python.python",
|
||||||
"ms-python.vscode-pylance",
|
"ms-python.vscode-pylance",
|
||||||
"ms-python.black-formatter",
|
"ms-python.black-formatter",
|
||||||
"redhat.vscode-yaml",
|
"redhat.vscode-yaml",
|
||||||
"Tobermory.es6-string-html",
|
"Tobermory.es6-string-html",
|
||||||
"unifiedjs.vscode-mdx"
|
"unifiedjs.vscode-mdx",
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
2
.vscode/launch.json
vendored
2
.vscode/launch.json
vendored
@ -22,6 +22,6 @@
|
|||||||
},
|
},
|
||||||
"justMyCode": true,
|
"justMyCode": true,
|
||||||
"django": true
|
"django": true
|
||||||
}
|
},
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
33
.vscode/settings.json
vendored
33
.vscode/settings.json
vendored
@ -4,36 +4,33 @@
|
|||||||
"asgi",
|
"asgi",
|
||||||
"authentik",
|
"authentik",
|
||||||
"authn",
|
"authn",
|
||||||
"entra",
|
|
||||||
"goauthentik",
|
"goauthentik",
|
||||||
"jwe",
|
|
||||||
"jwks",
|
"jwks",
|
||||||
"kubernetes",
|
|
||||||
"oidc",
|
"oidc",
|
||||||
"openid",
|
"openid",
|
||||||
"passwordless",
|
|
||||||
"plex",
|
"plex",
|
||||||
"saml",
|
"saml",
|
||||||
"scim",
|
|
||||||
"slo",
|
|
||||||
"sso",
|
|
||||||
"totp",
|
"totp",
|
||||||
|
"webauthn",
|
||||||
"traefik",
|
"traefik",
|
||||||
"webauthn"
|
"passwordless",
|
||||||
|
"kubernetes",
|
||||||
|
"sso",
|
||||||
|
"slo",
|
||||||
|
"scim",
|
||||||
],
|
],
|
||||||
"todo-tree.tree.showCountsInTree": true,
|
"todo-tree.tree.showCountsInTree": true,
|
||||||
"todo-tree.tree.showBadges": true,
|
"todo-tree.tree.showBadges": true,
|
||||||
"yaml.customTags": [
|
"yaml.customTags": [
|
||||||
"!Condition sequence",
|
|
||||||
"!Context scalar",
|
|
||||||
"!Enumerate sequence",
|
|
||||||
"!Env scalar",
|
|
||||||
"!Find sequence",
|
"!Find sequence",
|
||||||
"!Format sequence",
|
|
||||||
"!If sequence",
|
|
||||||
"!Index scalar",
|
|
||||||
"!KeyOf scalar",
|
"!KeyOf scalar",
|
||||||
"!Value scalar"
|
"!Context scalar",
|
||||||
|
"!Context sequence",
|
||||||
|
"!Format sequence",
|
||||||
|
"!Condition sequence",
|
||||||
|
"!Env sequence",
|
||||||
|
"!Env scalar",
|
||||||
|
"!If sequence"
|
||||||
],
|
],
|
||||||
"typescript.preferences.importModuleSpecifier": "non-relative",
|
"typescript.preferences.importModuleSpecifier": "non-relative",
|
||||||
"typescript.preferences.importModuleSpecifierEnding": "index",
|
"typescript.preferences.importModuleSpecifierEnding": "index",
|
||||||
@ -50,7 +47,9 @@
|
|||||||
"ignoreCase": false
|
"ignoreCase": false
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"go.testFlags": ["-count=1"],
|
"go.testFlags": [
|
||||||
|
"-count=1"
|
||||||
|
],
|
||||||
"github-actions.workflows.pinned.workflows": [
|
"github-actions.workflows.pinned.workflows": [
|
||||||
".github/workflows/ci-main.yml"
|
".github/workflows/ci-main.yml"
|
||||||
]
|
]
|
||||||
|
62
.vscode/tasks.json
vendored
62
.vscode/tasks.json
vendored
@ -2,67 +2,85 @@
|
|||||||
"version": "2.0.0",
|
"version": "2.0.0",
|
||||||
"tasks": [
|
"tasks": [
|
||||||
{
|
{
|
||||||
"label": "authentik/core: make",
|
"label": "authentik[core]: format & test",
|
||||||
"command": "poetry",
|
"command": "poetry",
|
||||||
"args": ["run", "make", "lint-fix", "lint"],
|
"args": [
|
||||||
"presentation": {
|
"run",
|
||||||
"panel": "new"
|
"make"
|
||||||
},
|
],
|
||||||
"group": "test"
|
"group": "build",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "authentik/core: run",
|
"label": "authentik[core]: run",
|
||||||
"command": "poetry",
|
"command": "poetry",
|
||||||
"args": ["run", "ak", "server"],
|
"args": [
|
||||||
|
"run",
|
||||||
|
"make",
|
||||||
|
"run",
|
||||||
|
],
|
||||||
"group": "build",
|
"group": "build",
|
||||||
"presentation": {
|
"presentation": {
|
||||||
"panel": "dedicated",
|
"panel": "dedicated",
|
||||||
"group": "running"
|
"group": "running"
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "authentik/web: make",
|
"label": "authentik[web]: format",
|
||||||
"command": "make",
|
"command": "make",
|
||||||
"args": ["web"],
|
"args": ["web"],
|
||||||
"group": "build"
|
"group": "build",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "authentik/web: watch",
|
"label": "authentik[web]: watch",
|
||||||
"command": "make",
|
"command": "make",
|
||||||
"args": ["web-watch"],
|
"args": ["web-watch"],
|
||||||
"group": "build",
|
"group": "build",
|
||||||
"presentation": {
|
"presentation": {
|
||||||
"panel": "dedicated",
|
"panel": "dedicated",
|
||||||
"group": "running"
|
"group": "running"
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "authentik: install",
|
"label": "authentik: install",
|
||||||
"command": "make",
|
"command": "make",
|
||||||
"args": ["install", "-j4"],
|
"args": ["install"],
|
||||||
"group": "build"
|
"group": "build",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "authentik/website: make",
|
"label": "authentik: i18n-extract",
|
||||||
|
"command": "poetry",
|
||||||
|
"args": [
|
||||||
|
"run",
|
||||||
|
"make",
|
||||||
|
"i18n-extract"
|
||||||
|
],
|
||||||
|
"group": "build",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "authentik[website]: format",
|
||||||
"command": "make",
|
"command": "make",
|
||||||
"args": ["website"],
|
"args": ["website"],
|
||||||
"group": "build"
|
"group": "build",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "authentik/website: watch",
|
"label": "authentik[website]: watch",
|
||||||
"command": "make",
|
"command": "make",
|
||||||
"args": ["website-watch"],
|
"args": ["website-watch"],
|
||||||
"group": "build",
|
"group": "build",
|
||||||
"presentation": {
|
"presentation": {
|
||||||
"panel": "dedicated",
|
"panel": "dedicated",
|
||||||
"group": "running"
|
"group": "running"
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "authentik/api: generate",
|
"label": "authentik[api]: generate",
|
||||||
"command": "poetry",
|
"command": "poetry",
|
||||||
"args": ["run", "make", "gen"],
|
"args": [
|
||||||
|
"run",
|
||||||
|
"make",
|
||||||
|
"gen"
|
||||||
|
],
|
||||||
"group": "build"
|
"group": "build"
|
||||||
}
|
},
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
60
Dockerfile
60
Dockerfile
@ -1,7 +1,7 @@
|
|||||||
# syntax=docker/dockerfile:1
|
# syntax=docker/dockerfile:1
|
||||||
|
|
||||||
# Stage 1: Build website
|
# Stage 1: Build website
|
||||||
FROM --platform=${BUILDPLATFORM} docker.io/library/node:22 AS website-builder
|
FROM --platform=${BUILDPLATFORM} docker.io/node:21 as website-builder
|
||||||
|
|
||||||
ENV NODE_ENV=production
|
ENV NODE_ENV=production
|
||||||
|
|
||||||
@ -14,28 +14,22 @@ RUN --mount=type=bind,target=/work/website/package.json,src=./website/package.js
|
|||||||
|
|
||||||
COPY ./website /work/website/
|
COPY ./website /work/website/
|
||||||
COPY ./blueprints /work/blueprints/
|
COPY ./blueprints /work/blueprints/
|
||||||
COPY ./schema.yml /work/
|
|
||||||
COPY ./SECURITY.md /work/
|
COPY ./SECURITY.md /work/
|
||||||
|
|
||||||
RUN npm run build-bundled
|
RUN npm run build-docs-only
|
||||||
|
|
||||||
# Stage 2: Build webui
|
# Stage 2: Build webui
|
||||||
FROM --platform=${BUILDPLATFORM} docker.io/library/node:22 AS web-builder
|
FROM --platform=${BUILDPLATFORM} docker.io/node:21 as web-builder
|
||||||
|
|
||||||
ARG GIT_BUILD_HASH
|
|
||||||
ENV GIT_BUILD_HASH=$GIT_BUILD_HASH
|
|
||||||
ENV NODE_ENV=production
|
ENV NODE_ENV=production
|
||||||
|
|
||||||
WORKDIR /work/web
|
WORKDIR /work/web
|
||||||
|
|
||||||
RUN --mount=type=bind,target=/work/web/package.json,src=./web/package.json \
|
RUN --mount=type=bind,target=/work/web/package.json,src=./web/package.json \
|
||||||
--mount=type=bind,target=/work/web/package-lock.json,src=./web/package-lock.json \
|
--mount=type=bind,target=/work/web/package-lock.json,src=./web/package-lock.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=cache,id=npm-web,sharing=shared,target=/root/.npm \
|
--mount=type=cache,id=npm-web,sharing=shared,target=/root/.npm \
|
||||||
npm ci --include=dev
|
npm ci --include=dev
|
||||||
|
|
||||||
COPY ./package.json /work
|
|
||||||
COPY ./web /work/web/
|
COPY ./web /work/web/
|
||||||
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
|
||||||
@ -43,7 +37,7 @@ COPY ./gen-ts-api /work/web/node_modules/@goauthentik/api
|
|||||||
RUN npm run build
|
RUN npm run build
|
||||||
|
|
||||||
# Stage 3: Build go proxy
|
# Stage 3: Build go proxy
|
||||||
FROM --platform=${BUILDPLATFORM} mcr.microsoft.com/oss/go/microsoft/golang:1.23-fips-bookworm AS go-builder
|
FROM --platform=${BUILDPLATFORM} docker.io/golang:1.22.0-bookworm AS go-builder
|
||||||
|
|
||||||
ARG TARGETOS
|
ARG TARGETOS
|
||||||
ARG TARGETARCH
|
ARG TARGETARCH
|
||||||
@ -54,11 +48,6 @@ ARG GOARCH=$TARGETARCH
|
|||||||
|
|
||||||
WORKDIR /go/src/goauthentik.io
|
WORKDIR /go/src/goauthentik.io
|
||||||
|
|
||||||
RUN --mount=type=cache,id=apt-$TARGETARCH$TARGETVARIANT,sharing=locked,target=/var/cache/apt \
|
|
||||||
dpkg --add-architecture arm64 && \
|
|
||||||
apt-get update && \
|
|
||||||
apt-get install -y --no-install-recommends crossbuild-essential-arm64 gcc-aarch64-linux-gnu
|
|
||||||
|
|
||||||
RUN --mount=type=bind,target=/go/src/goauthentik.io/go.mod,src=./go.mod \
|
RUN --mount=type=bind,target=/go/src/goauthentik.io/go.mod,src=./go.mod \
|
||||||
--mount=type=bind,target=/go/src/goauthentik.io/go.sum,src=./go.sum \
|
--mount=type=bind,target=/go/src/goauthentik.io/go.sum,src=./go.sum \
|
||||||
--mount=type=cache,target=/go/pkg/mod \
|
--mount=type=cache,target=/go/pkg/mod \
|
||||||
@ -73,17 +62,17 @@ COPY ./internal /go/src/goauthentik.io/internal
|
|||||||
COPY ./go.mod /go/src/goauthentik.io/go.mod
|
COPY ./go.mod /go/src/goauthentik.io/go.mod
|
||||||
COPY ./go.sum /go/src/goauthentik.io/go.sum
|
COPY ./go.sum /go/src/goauthentik.io/go.sum
|
||||||
|
|
||||||
|
ENV CGO_ENABLED=0
|
||||||
|
|
||||||
RUN --mount=type=cache,sharing=locked,target=/go/pkg/mod \
|
RUN --mount=type=cache,sharing=locked,target=/go/pkg/mod \
|
||||||
--mount=type=cache,id=go-build-$TARGETARCH$TARGETVARIANT,sharing=locked,target=/root/.cache/go-build \
|
--mount=type=cache,id=go-build-$TARGETARCH$TARGETVARIANT,sharing=locked,target=/root/.cache/go-build \
|
||||||
if [ "$TARGETARCH" = "arm64" ]; then export CC=aarch64-linux-gnu-gcc && export CC_FOR_TARGET=gcc-aarch64-linux-gnu; fi && \
|
GOARM="${TARGETVARIANT#v}" go build -o /go/authentik ./cmd/server
|
||||||
CGO_ENABLED=1 GOEXPERIMENT="systemcrypto" GOFLAGS="-tags=requirefips" GOARM="${TARGETVARIANT#v}" \
|
|
||||||
go build -o /go/authentik ./cmd/server
|
|
||||||
|
|
||||||
# Stage 4: MaxMind GeoIP
|
# Stage 4: MaxMind GeoIP
|
||||||
FROM --platform=${BUILDPLATFORM} ghcr.io/maxmind/geoipupdate:v7.0.1 AS geoip
|
FROM --platform=${BUILDPLATFORM} ghcr.io/maxmind/geoipupdate:v6.1 as geoip
|
||||||
|
|
||||||
ENV GEOIPUPDATE_EDITION_IDS="GeoLite2-City GeoLite2-ASN"
|
ENV GEOIPUPDATE_EDITION_IDS="GeoLite2-City GeoLite2-ASN"
|
||||||
ENV GEOIPUPDATE_VERBOSE="1"
|
ENV GEOIPUPDATE_VERBOSE="true"
|
||||||
ENV GEOIPUPDATE_ACCOUNT_ID_FILE="/run/secrets/GEOIPUPDATE_ACCOUNT_ID"
|
ENV GEOIPUPDATE_ACCOUNT_ID_FILE="/run/secrets/GEOIPUPDATE_ACCOUNT_ID"
|
||||||
ENV GEOIPUPDATE_LICENSE_KEY_FILE="/run/secrets/GEOIPUPDATE_LICENSE_KEY"
|
ENV GEOIPUPDATE_LICENSE_KEY_FILE="/run/secrets/GEOIPUPDATE_LICENSE_KEY"
|
||||||
|
|
||||||
@ -94,10 +83,7 @@ RUN --mount=type=secret,id=GEOIPUPDATE_ACCOUNT_ID \
|
|||||||
/bin/sh -c "/usr/bin/entry.sh || echo 'Failed to get GeoIP database, disabling'; exit 0"
|
/bin/sh -c "/usr/bin/entry.sh || echo 'Failed to get GeoIP database, disabling'; exit 0"
|
||||||
|
|
||||||
# Stage 5: Python dependencies
|
# Stage 5: Python dependencies
|
||||||
FROM ghcr.io/goauthentik/fips-python:3.12.7-slim-bookworm-fips-full AS python-deps
|
FROM docker.io/python:3.12.2-slim-bookworm AS python-deps
|
||||||
|
|
||||||
ARG TARGETARCH
|
|
||||||
ARG TARGETVARIANT
|
|
||||||
|
|
||||||
WORKDIR /ak-root/poetry
|
WORKDIR /ak-root/poetry
|
||||||
|
|
||||||
@ -110,7 +96,7 @@ RUN rm -f /etc/apt/apt.conf.d/docker-clean; echo 'Binary::apt::APT::Keep-Downloa
|
|||||||
RUN --mount=type=cache,id=apt-$TARGETARCH$TARGETVARIANT,sharing=locked,target=/var/cache/apt \
|
RUN --mount=type=cache,id=apt-$TARGETARCH$TARGETVARIANT,sharing=locked,target=/var/cache/apt \
|
||||||
apt-get update && \
|
apt-get update && \
|
||||||
# Required for installing pip packages
|
# Required for installing pip packages
|
||||||
apt-get install -y --no-install-recommends build-essential pkg-config libpq-dev libkrb5-dev
|
apt-get install -y --no-install-recommends build-essential pkg-config libxmlsec1-dev zlib1g-dev libpq-dev
|
||||||
|
|
||||||
RUN --mount=type=bind,target=./pyproject.toml,src=./pyproject.toml \
|
RUN --mount=type=bind,target=./pyproject.toml,src=./pyproject.toml \
|
||||||
--mount=type=bind,target=./poetry.lock,src=./poetry.lock \
|
--mount=type=bind,target=./poetry.lock,src=./poetry.lock \
|
||||||
@ -120,28 +106,27 @@ RUN --mount=type=bind,target=./pyproject.toml,src=./pyproject.toml \
|
|||||||
bash -c "source ${VENV_PATH}/bin/activate && \
|
bash -c "source ${VENV_PATH}/bin/activate && \
|
||||||
pip3 install --upgrade pip && \
|
pip3 install --upgrade pip && \
|
||||||
pip3 install poetry && \
|
pip3 install poetry && \
|
||||||
poetry install --only=main --no-ansi --no-interaction --no-root && \
|
poetry install --only=main --no-ansi --no-interaction --no-root"
|
||||||
pip install --force-reinstall /wheels/*"
|
|
||||||
|
|
||||||
# Stage 6: Run
|
# Stage 6: Run
|
||||||
FROM ghcr.io/goauthentik/fips-python:3.12.7-slim-bookworm-fips-full AS final-image
|
FROM docker.io/python:3.12.2-slim-bookworm AS final-image
|
||||||
|
|
||||||
ARG VERSION
|
|
||||||
ARG GIT_BUILD_HASH
|
ARG GIT_BUILD_HASH
|
||||||
|
ARG VERSION
|
||||||
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.url https://goauthentik.io
|
||||||
LABEL org.opencontainers.image.description="goauthentik.io Main server image, see https://goauthentik.io for more info."
|
LABEL 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
|
LABEL org.opencontainers.image.source https://github.com/goauthentik/authentik
|
||||||
LABEL org.opencontainers.image.version=${VERSION}
|
LABEL org.opencontainers.image.version ${VERSION}
|
||||||
LABEL org.opencontainers.image.revision=${GIT_BUILD_HASH}
|
LABEL org.opencontainers.image.revision ${GIT_BUILD_HASH}
|
||||||
|
|
||||||
WORKDIR /
|
WORKDIR /
|
||||||
|
|
||||||
# We cannot cache this layer otherwise we'll end up with a bigger image
|
# We cannot cache this layer otherwise we'll end up with a bigger image
|
||||||
RUN apt-get update && \
|
RUN apt-get update && \
|
||||||
# Required for runtime
|
# Required for runtime
|
||||||
apt-get install -y --no-install-recommends libpq5 libmaxminddb0 ca-certificates libkrb5-3 libkadm5clnt-mit12 libkdb5-10 && \
|
apt-get install -y --no-install-recommends libpq5 openssl libxmlsec1-openssl libmaxminddb0 ca-certificates && \
|
||||||
# Required for bootstrap & healtcheck
|
# Required for bootstrap & healtcheck
|
||||||
apt-get install -y --no-install-recommends runit && \
|
apt-get install -y --no-install-recommends runit && \
|
||||||
apt-get clean && \
|
apt-get clean && \
|
||||||
@ -161,12 +146,11 @@ COPY ./tests /tests
|
|||||||
COPY ./manage.py /
|
COPY ./manage.py /
|
||||||
COPY ./blueprints /blueprints
|
COPY ./blueprints /blueprints
|
||||||
COPY ./lifecycle/ /lifecycle
|
COPY ./lifecycle/ /lifecycle
|
||||||
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 --from=python-deps /ak-root/venv /ak-root/venv
|
COPY --from=python-deps /ak-root/venv /ak-root/venv
|
||||||
COPY --from=web-builder /work/web/dist/ /web/dist/
|
COPY --from=web-builder /work/web/dist/ /web/dist/
|
||||||
COPY --from=web-builder /work/web/authentik/ /web/authentik/
|
COPY --from=web-builder /work/web/authentik/ /web/authentik/
|
||||||
COPY --from=website-builder /work/website/build/ /website/help/
|
COPY --from=website-builder /work/website/help/ /website/help/
|
||||||
COPY --from=geoip /usr/share/GeoIP /geoip
|
COPY --from=geoip /usr/share/GeoIP /geoip
|
||||||
|
|
||||||
USER 1000
|
USER 1000
|
||||||
@ -178,8 +162,6 @@ ENV TMPDIR=/dev/shm/ \
|
|||||||
VENV_PATH="/ak-root/venv" \
|
VENV_PATH="/ak-root/venv" \
|
||||||
POETRY_VIRTUALENVS_CREATE=false
|
POETRY_VIRTUALENVS_CREATE=false
|
||||||
|
|
||||||
ENV GOFIPS=1
|
|
||||||
|
|
||||||
HEALTHCHECK --interval=30s --timeout=30s --start-period=60s --retries=3 CMD [ "ak", "healthcheck" ]
|
HEALTHCHECK --interval=30s --timeout=30s --start-period=60s --retries=3 CMD [ "ak", "healthcheck" ]
|
||||||
|
|
||||||
ENTRYPOINT [ "dumb-init", "--", "ak" ]
|
ENTRYPOINT [ "dumb-init", "--", "ak" ]
|
||||||
|
62
Makefile
62
Makefile
@ -9,7 +9,6 @@ PY_SOURCES = authentik tests scripts lifecycle .github
|
|||||||
DOCKER_IMAGE ?= "authentik:test"
|
DOCKER_IMAGE ?= "authentik:test"
|
||||||
|
|
||||||
GEN_API_TS = "gen-ts-api"
|
GEN_API_TS = "gen-ts-api"
|
||||||
GEN_API_PY = "gen-py-api"
|
|
||||||
GEN_API_GO = "gen-go-api"
|
GEN_API_GO = "gen-go-api"
|
||||||
|
|
||||||
pg_user := $(shell python -m authentik.lib.config postgresql.user 2>/dev/null)
|
pg_user := $(shell python -m authentik.lib.config postgresql.user 2>/dev/null)
|
||||||
@ -19,13 +18,13 @@ pg_name := $(shell python -m authentik.lib.config postgresql.name 2>/dev/null)
|
|||||||
CODESPELL_ARGS = -D - -D .github/codespell-dictionary.txt \
|
CODESPELL_ARGS = -D - -D .github/codespell-dictionary.txt \
|
||||||
-I .github/codespell-words.txt \
|
-I .github/codespell-words.txt \
|
||||||
-S 'web/src/locales/**' \
|
-S 'web/src/locales/**' \
|
||||||
-S 'website/docs/developer-docs/api/reference/**' \
|
|
||||||
authentik \
|
authentik \
|
||||||
internal \
|
internal \
|
||||||
cmd \
|
cmd \
|
||||||
web/src \
|
web/src \
|
||||||
website/src \
|
website/src \
|
||||||
website/blog \
|
website/blog \
|
||||||
|
website/developer-docs \
|
||||||
website/docs \
|
website/docs \
|
||||||
website/integrations \
|
website/integrations \
|
||||||
website/src
|
website/src
|
||||||
@ -42,16 +41,16 @@ help: ## Show this help
|
|||||||
sort
|
sort
|
||||||
@echo ""
|
@echo ""
|
||||||
|
|
||||||
go-test:
|
test-go:
|
||||||
go test -timeout 0 -v -race -cover ./...
|
go test -timeout 0 -v -race -cover ./...
|
||||||
|
|
||||||
test-docker: ## Run all tests in a docker-compose
|
test-docker: ## Run all tests in a docker-compose
|
||||||
echo "PG_PASS=$(shell openssl rand 32 | base64 -w 0)" >> .env
|
echo "PG_PASS=$(openssl rand -base64 32)" >> .env
|
||||||
echo "AUTHENTIK_SECRET_KEY=$(shell openssl rand 32 | base64 -w 0)" >> .env
|
echo "AUTHENTIK_SECRET_KEY=$(openssl rand -base64 32)" >> .env
|
||||||
docker compose pull -q
|
docker-compose pull -q
|
||||||
docker compose up --no-start
|
docker-compose up --no-start
|
||||||
docker compose start postgresql redis
|
docker-compose start postgresql redis
|
||||||
docker compose run -u root server test-all
|
docker-compose run -u root server test-all
|
||||||
rm -f .env
|
rm -f .env
|
||||||
|
|
||||||
test: ## Run the server tests and produce a coverage report (locally)
|
test: ## Run the server tests and produce a coverage report (locally)
|
||||||
@ -59,15 +58,16 @@ test: ## Run the server tests and produce a coverage report (locally)
|
|||||||
coverage html
|
coverage html
|
||||||
coverage report
|
coverage report
|
||||||
|
|
||||||
lint-fix: lint-codespell ## Lint and automatically fix errors in the python source code. Reports spelling errors.
|
lint-fix: ## Lint and automatically fix errors in the python source code. Reports spelling errors.
|
||||||
|
isort $(PY_SOURCES)
|
||||||
black $(PY_SOURCES)
|
black $(PY_SOURCES)
|
||||||
ruff check --fix $(PY_SOURCES)
|
ruff --fix $(PY_SOURCES)
|
||||||
|
|
||||||
lint-codespell: ## Reports spelling errors.
|
|
||||||
codespell -w $(CODESPELL_ARGS)
|
codespell -w $(CODESPELL_ARGS)
|
||||||
|
|
||||||
lint: ## Lint the python and golang sources
|
lint: ## Lint the python and golang sources
|
||||||
bandit -r $(PY_SOURCES) -x web/node_modules -x tests/wdio/node_modules -x website/node_modules
|
bandit -r $(PY_SOURCES) -x node_modules
|
||||||
|
./web/node_modules/.bin/pyright $(PY_SOURCES)
|
||||||
|
pylint $(PY_SOURCES)
|
||||||
golangci-lint run -v
|
golangci-lint run -v
|
||||||
|
|
||||||
core-install:
|
core-install:
|
||||||
@ -140,10 +140,7 @@ gen-clean-ts: ## Remove generated API client for Typescript
|
|||||||
gen-clean-go: ## Remove generated API client for Go
|
gen-clean-go: ## Remove generated API client for Go
|
||||||
rm -rf ./${GEN_API_GO}/
|
rm -rf ./${GEN_API_GO}/
|
||||||
|
|
||||||
gen-clean-py: ## Remove generated API client for Python
|
gen-clean: gen-clean-ts gen-clean-go ## Remove generated API clients
|
||||||
rm -rf ./${GEN_API_PY}/
|
|
||||||
|
|
||||||
gen-clean: gen-clean-ts gen-clean-go gen-clean-py ## Remove generated API clients
|
|
||||||
|
|
||||||
gen-client-ts: gen-clean-ts ## Build and install the authentik API for Typescript into the authentik UI Application
|
gen-client-ts: gen-clean-ts ## Build and install the authentik API for Typescript into the authentik UI Application
|
||||||
docker run \
|
docker run \
|
||||||
@ -161,20 +158,6 @@ gen-client-ts: gen-clean-ts ## Build and install the authentik API for Typescri
|
|||||||
cd ./${GEN_API_TS} && npm i
|
cd ./${GEN_API_TS} && npm i
|
||||||
\cp -rf ./${GEN_API_TS}/* web/node_modules/@goauthentik/api
|
\cp -rf ./${GEN_API_TS}/* web/node_modules/@goauthentik/api
|
||||||
|
|
||||||
gen-client-py: gen-clean-py ## Build and install the authentik API for Python
|
|
||||||
docker run \
|
|
||||||
--rm -v ${PWD}:/local \
|
|
||||||
--user ${UID}:${GID} \
|
|
||||||
docker.io/openapitools/openapi-generator-cli:v7.4.0 generate \
|
|
||||||
-i /local/schema.yml \
|
|
||||||
-g python \
|
|
||||||
-o /local/${GEN_API_PY} \
|
|
||||||
-c /local/scripts/api-py-config.yaml \
|
|
||||||
--additional-properties=packageVersion=${NPM_VERSION} \
|
|
||||||
--git-repo-id authentik \
|
|
||||||
--git-user-id goauthentik
|
|
||||||
pip install ./${GEN_API_PY}
|
|
||||||
|
|
||||||
gen-client-go: gen-clean-go ## Build and install the authentik API for Golang
|
gen-client-go: gen-clean-go ## Build and install the authentik API for Golang
|
||||||
mkdir -p ./${GEN_API_GO} ./${GEN_API_GO}/templates
|
mkdir -p ./${GEN_API_GO} ./${GEN_API_GO}/templates
|
||||||
wget https://raw.githubusercontent.com/goauthentik/client-go/main/config.yaml -O ./${GEN_API_GO}/config.yaml
|
wget https://raw.githubusercontent.com/goauthentik/client-go/main/config.yaml -O ./${GEN_API_GO}/config.yaml
|
||||||
@ -209,9 +192,6 @@ web: web-lint-fix web-lint web-check-compile ## Automatically fix formatting is
|
|||||||
web-install: ## Install the necessary libraries to build the Authentik UI
|
web-install: ## Install the necessary libraries to build the Authentik UI
|
||||||
cd web && npm ci
|
cd web && npm ci
|
||||||
|
|
||||||
web-test: ## Run tests for the Authentik UI
|
|
||||||
cd web && npm run test
|
|
||||||
|
|
||||||
web-watch: ## Build and watch the Authentik UI for changes, updating automatically
|
web-watch: ## Build and watch the Authentik UI for changes, updating automatically
|
||||||
rm -rf web/dist/
|
rm -rf web/dist/
|
||||||
mkdir web/dist/
|
mkdir web/dist/
|
||||||
@ -243,7 +223,7 @@ website: website-lint-fix website-build ## Automatically fix formatting issues
|
|||||||
website-install:
|
website-install:
|
||||||
cd website && npm ci
|
cd website && npm ci
|
||||||
|
|
||||||
website-lint-fix: lint-codespell
|
website-lint-fix:
|
||||||
cd website && npm run prettier
|
cd website && npm run prettier
|
||||||
|
|
||||||
website-build:
|
website-build:
|
||||||
@ -257,7 +237,6 @@ website-watch: ## Build and watch the documentation website, updating automatic
|
|||||||
#########################
|
#########################
|
||||||
|
|
||||||
docker: ## Build a docker image of the current source tree
|
docker: ## Build a docker image of the current source tree
|
||||||
mkdir -p ${GEN_API_TS}
|
|
||||||
DOCKER_BUILDKIT=1 docker build . --progress plain --tag ${DOCKER_IMAGE}
|
DOCKER_BUILDKIT=1 docker build . --progress plain --tag ${DOCKER_IMAGE}
|
||||||
|
|
||||||
#########################
|
#########################
|
||||||
@ -270,6 +249,9 @@ ci--meta-debug:
|
|||||||
python -V
|
python -V
|
||||||
node --version
|
node --version
|
||||||
|
|
||||||
|
ci-pylint: ci--meta-debug
|
||||||
|
pylint $(PY_SOURCES)
|
||||||
|
|
||||||
ci-black: ci--meta-debug
|
ci-black: ci--meta-debug
|
||||||
black --check $(PY_SOURCES)
|
black --check $(PY_SOURCES)
|
||||||
|
|
||||||
@ -279,8 +261,14 @@ ci-ruff: ci--meta-debug
|
|||||||
ci-codespell: ci--meta-debug
|
ci-codespell: ci--meta-debug
|
||||||
codespell $(CODESPELL_ARGS) -s
|
codespell $(CODESPELL_ARGS) -s
|
||||||
|
|
||||||
|
ci-isort: ci--meta-debug
|
||||||
|
isort --check $(PY_SOURCES)
|
||||||
|
|
||||||
ci-bandit: ci--meta-debug
|
ci-bandit: ci--meta-debug
|
||||||
bandit -r $(PY_SOURCES)
|
bandit -r $(PY_SOURCES)
|
||||||
|
|
||||||
|
ci-pyright: ci--meta-debug
|
||||||
|
./web/node_modules/.bin/pyright $(PY_SOURCES)
|
||||||
|
|
||||||
ci-pending-migrations: ci--meta-debug
|
ci-pending-migrations: ci--meta-debug
|
||||||
ak makemigrations --check
|
ak makemigrations --check
|
||||||
|
12
README.md
12
README.md
@ -15,9 +15,7 @@
|
|||||||
|
|
||||||
## What is authentik?
|
## What is authentik?
|
||||||
|
|
||||||
authentik is an open-source Identity Provider that emphasizes flexibility and versatility, with support for a wide set of protocols.
|
authentik is an open-source Identity Provider that emphasizes flexibility and versatility. It can be seamlessly integrated into existing environments to support new protocols. authentik is also a great solution for implementing sign-up, recovery, and other similar features in your application, saving you the hassle of dealing with them.
|
||||||
|
|
||||||
Our [enterprise offer](https://goauthentik.io/pricing) can also be used as a self-hosted replacement for large-scale deployments of Okta/Auth0, Entra ID, Ping Identity, or other legacy IdPs for employees and B2B2C use.
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@ -28,13 +26,13 @@ For bigger setups, there is a Helm Chart [here](https://github.com/goauthentik/h
|
|||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
| Light | Dark |
|
| Light | Dark |
|
||||||
| ----------------------------------------------------------- | ---------------------------------------------------------- |
|
| ------------------------------------------------------ | ----------------------------------------------------- |
|
||||||
|  |  |
|
|  |  |
|
||||||
|  |  |
|
|  |  |
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
See [Developer Documentation](https://docs.goauthentik.io/docs/developer-docs/?utm_source=github)
|
See [Developer Documentation](https://goauthentik.io/developer-docs/?utm_source=github)
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
||||||
|
@ -19,9 +19,9 @@ Even if the issue is not a CVE, we still greatly appreciate your help in hardeni
|
|||||||
(.x being the latest patch release for each version)
|
(.x being the latest patch release for each version)
|
||||||
|
|
||||||
| Version | Supported |
|
| Version | Supported |
|
||||||
| --------- | --------- |
|
| --- | --- |
|
||||||
| 2024.8.x | ✅ |
|
| 2023.6.x | ✅ |
|
||||||
| 2024.10.x | ✅ |
|
| 2023.8.x | ✅ |
|
||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
@ -32,7 +32,7 @@ To report a vulnerability, send an email to [security@goauthentik.io](mailto:se
|
|||||||
authentik reserves the right to reclassify CVSS as necessary. To determine severity, we will use the CVSS calculator from NVD (https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator). The calculated CVSS score will then be translated into one of the following categories:
|
authentik reserves the right to reclassify CVSS as necessary. To determine severity, we will use the CVSS calculator from NVD (https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator). The calculated CVSS score will then be translated into one of the following categories:
|
||||||
|
|
||||||
| Score | Severity |
|
| Score | Severity |
|
||||||
| ---------- | -------- |
|
| --- | --- |
|
||||||
| 0.0 | None |
|
| 0.0 | None |
|
||||||
| 0.1 – 3.9 | Low |
|
| 0.1 – 3.9 | Low |
|
||||||
| 4.0 – 6.9 | Medium |
|
| 4.0 – 6.9 | Medium |
|
||||||
|
@ -1,12 +1,13 @@
|
|||||||
"""authentik root module"""
|
"""authentik root module"""
|
||||||
|
|
||||||
from os import environ
|
from os import environ
|
||||||
|
from typing import Optional
|
||||||
|
|
||||||
__version__ = "2024.10.0"
|
__version__ = "2024.2.4"
|
||||||
ENV_GIT_HASH_KEY = "GIT_BUILD_HASH"
|
ENV_GIT_HASH_KEY = "GIT_BUILD_HASH"
|
||||||
|
|
||||||
|
|
||||||
def get_build_hash(fallback: str | None = None) -> str:
|
def get_build_hash(fallback: Optional[str] = None) -> str:
|
||||||
"""Get build hash"""
|
"""Get build hash"""
|
||||||
build_hash = environ.get(ENV_GIT_HASH_KEY, fallback if fallback else "")
|
build_hash = environ.get(ENV_GIT_HASH_KEY, fallback if fallback else "")
|
||||||
return fallback if build_hash == "" and fallback else build_hash
|
return fallback if build_hash == "" and fallback else build_hash
|
||||||
|
@ -2,21 +2,18 @@
|
|||||||
|
|
||||||
import platform
|
import platform
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from ssl import OPENSSL_VERSION
|
|
||||||
from sys import version as python_version
|
from sys import version as python_version
|
||||||
from typing import TypedDict
|
from typing import TypedDict
|
||||||
|
|
||||||
from cryptography.hazmat.backends.openssl.backend import backend
|
|
||||||
from django.utils.timezone import now
|
from django.utils.timezone import now
|
||||||
from drf_spectacular.utils import extend_schema
|
from drf_spectacular.utils import extend_schema
|
||||||
|
from gunicorn import version_info as gunicorn_version
|
||||||
from rest_framework.fields import SerializerMethodField
|
from rest_framework.fields import SerializerMethodField
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
from rest_framework.views import APIView
|
from rest_framework.views import APIView
|
||||||
|
|
||||||
from authentik import get_full_version
|
|
||||||
from authentik.core.api.utils import PassiveSerializer
|
from authentik.core.api.utils import PassiveSerializer
|
||||||
from authentik.enterprise.license import LicenseKey
|
|
||||||
from authentik.lib.config import CONFIG
|
from authentik.lib.config import CONFIG
|
||||||
from authentik.lib.utils.reflection import get_env
|
from authentik.lib.utils.reflection import get_env
|
||||||
from authentik.outposts.apps import MANAGED_OUTPOST
|
from authentik.outposts.apps import MANAGED_OUTPOST
|
||||||
@ -28,13 +25,11 @@ class RuntimeDict(TypedDict):
|
|||||||
"""Runtime information"""
|
"""Runtime information"""
|
||||||
|
|
||||||
python_version: str
|
python_version: str
|
||||||
|
gunicorn_version: str
|
||||||
environment: str
|
environment: str
|
||||||
architecture: str
|
architecture: str
|
||||||
platform: str
|
platform: str
|
||||||
uname: str
|
uname: str
|
||||||
openssl_version: str
|
|
||||||
openssl_fips_enabled: bool | None
|
|
||||||
authentik_version: str
|
|
||||||
|
|
||||||
|
|
||||||
class SystemInfoSerializer(PassiveSerializer):
|
class SystemInfoSerializer(PassiveSerializer):
|
||||||
@ -69,15 +64,11 @@ class SystemInfoSerializer(PassiveSerializer):
|
|||||||
def get_runtime(self, request: Request) -> RuntimeDict:
|
def get_runtime(self, request: Request) -> RuntimeDict:
|
||||||
"""Get versions"""
|
"""Get versions"""
|
||||||
return {
|
return {
|
||||||
"architecture": platform.machine(),
|
|
||||||
"authentik_version": get_full_version(),
|
|
||||||
"environment": get_env(),
|
|
||||||
"openssl_fips_enabled": (
|
|
||||||
backend._fips_enabled if LicenseKey.get_total().status().is_valid else None
|
|
||||||
),
|
|
||||||
"openssl_version": OPENSSL_VERSION,
|
|
||||||
"platform": platform.platform(),
|
|
||||||
"python_version": python_version,
|
"python_version": python_version,
|
||||||
|
"gunicorn_version": ".".join(str(x) for x in gunicorn_version),
|
||||||
|
"environment": get_env(),
|
||||||
|
"architecture": platform.machine(),
|
||||||
|
"platform": platform.platform(),
|
||||||
"uname": " ".join(platform.uname()),
|
"uname": " ".join(platform.uname()),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -10,9 +10,8 @@ from rest_framework.response import Response
|
|||||||
from rest_framework.views import APIView
|
from rest_framework.views import APIView
|
||||||
|
|
||||||
from authentik import __version__, get_build_hash
|
from authentik import __version__, get_build_hash
|
||||||
from authentik.admin.tasks import VERSION_CACHE_KEY, VERSION_NULL, update_latest_version
|
from authentik.admin.tasks import VERSION_CACHE_KEY, update_latest_version
|
||||||
from authentik.core.api.utils import PassiveSerializer
|
from authentik.core.api.utils import PassiveSerializer
|
||||||
from authentik.outposts.models import Outpost
|
|
||||||
|
|
||||||
|
|
||||||
class VersionSerializer(PassiveSerializer):
|
class VersionSerializer(PassiveSerializer):
|
||||||
@ -20,10 +19,8 @@ class VersionSerializer(PassiveSerializer):
|
|||||||
|
|
||||||
version_current = SerializerMethodField()
|
version_current = SerializerMethodField()
|
||||||
version_latest = SerializerMethodField()
|
version_latest = SerializerMethodField()
|
||||||
version_latest_valid = SerializerMethodField()
|
|
||||||
build_hash = SerializerMethodField()
|
build_hash = SerializerMethodField()
|
||||||
outdated = SerializerMethodField()
|
outdated = SerializerMethodField()
|
||||||
outpost_outdated = SerializerMethodField()
|
|
||||||
|
|
||||||
def get_build_hash(self, _) -> str:
|
def get_build_hash(self, _) -> str:
|
||||||
"""Get build hash, if version is not latest or released"""
|
"""Get build hash, if version is not latest or released"""
|
||||||
@ -41,23 +38,10 @@ class VersionSerializer(PassiveSerializer):
|
|||||||
return __version__
|
return __version__
|
||||||
return version_in_cache
|
return version_in_cache
|
||||||
|
|
||||||
def get_version_latest_valid(self, _) -> bool:
|
|
||||||
"""Check if latest version is valid"""
|
|
||||||
return cache.get(VERSION_CACHE_KEY) != VERSION_NULL
|
|
||||||
|
|
||||||
def get_outdated(self, instance) -> bool:
|
def get_outdated(self, instance) -> bool:
|
||||||
"""Check if we're running the latest version"""
|
"""Check if we're running the latest version"""
|
||||||
return parse(self.get_version_current(instance)) < parse(self.get_version_latest(instance))
|
return parse(self.get_version_current(instance)) < parse(self.get_version_latest(instance))
|
||||||
|
|
||||||
def get_outpost_outdated(self, _) -> bool:
|
|
||||||
"""Check if any outpost is outdated/has a version mismatch"""
|
|
||||||
any_outdated = False
|
|
||||||
for outpost in Outpost.objects.all():
|
|
||||||
for state in outpost.state:
|
|
||||||
if state.version_outdated:
|
|
||||||
any_outdated = True
|
|
||||||
return any_outdated
|
|
||||||
|
|
||||||
|
|
||||||
class VersionView(APIView):
|
class VersionView(APIView):
|
||||||
"""Get running and latest version."""
|
"""Get running and latest version."""
|
||||||
|
@ -1,33 +0,0 @@
|
|||||||
from rest_framework.permissions import IsAdminUser
|
|
||||||
from rest_framework.viewsets import ReadOnlyModelViewSet
|
|
||||||
|
|
||||||
from authentik.admin.models import VersionHistory
|
|
||||||
from authentik.core.api.utils import ModelSerializer
|
|
||||||
|
|
||||||
|
|
||||||
class VersionHistorySerializer(ModelSerializer):
|
|
||||||
"""VersionHistory Serializer"""
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
model = VersionHistory
|
|
||||||
fields = [
|
|
||||||
"id",
|
|
||||||
"timestamp",
|
|
||||||
"version",
|
|
||||||
"build",
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
class VersionHistoryViewSet(ReadOnlyModelViewSet):
|
|
||||||
"""VersionHistory Viewset"""
|
|
||||||
|
|
||||||
queryset = VersionHistory.objects.all()
|
|
||||||
serializer_class = VersionHistorySerializer
|
|
||||||
permission_classes = [IsAdminUser]
|
|
||||||
filterset_fields = [
|
|
||||||
"version",
|
|
||||||
"build",
|
|
||||||
]
|
|
||||||
search_fields = ["version", "build"]
|
|
||||||
ordering = ["-timestamp"]
|
|
||||||
pagination_class = None
|
|
@ -1,22 +0,0 @@
|
|||||||
"""authentik admin models"""
|
|
||||||
|
|
||||||
from django.db import models
|
|
||||||
from django.utils.translation import gettext_lazy as _
|
|
||||||
|
|
||||||
|
|
||||||
class VersionHistory(models.Model):
|
|
||||||
id = models.BigAutoField(primary_key=True)
|
|
||||||
timestamp = models.DateTimeField()
|
|
||||||
version = models.TextField()
|
|
||||||
build = models.TextField()
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
managed = False
|
|
||||||
db_table = "authentik_version_history"
|
|
||||||
ordering = ("-timestamp",)
|
|
||||||
verbose_name = _("Version history")
|
|
||||||
verbose_name_plural = _("Version history")
|
|
||||||
default_permissions = []
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return f"{self.version}.{self.build} ({self.timestamp})"
|
|
@ -1,8 +1,10 @@
|
|||||||
"""authentik admin tasks"""
|
"""authentik admin tasks"""
|
||||||
|
|
||||||
|
import re
|
||||||
|
|
||||||
from django.core.cache import cache
|
from django.core.cache import cache
|
||||||
|
from django.core.validators import URLValidator
|
||||||
from django.db import DatabaseError, InternalError, ProgrammingError
|
from django.db import DatabaseError, InternalError, ProgrammingError
|
||||||
from django.utils.translation import gettext_lazy as _
|
|
||||||
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
|
||||||
@ -16,9 +18,10 @@ from authentik.lib.utils.http import get_http_session
|
|||||||
from authentik.root.celery import CELERY_APP
|
from authentik.root.celery import CELERY_APP
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
VERSION_NULL = "0.0.0"
|
|
||||||
VERSION_CACHE_KEY = "authentik_latest_version"
|
VERSION_CACHE_KEY = "authentik_latest_version"
|
||||||
VERSION_CACHE_TIMEOUT = 8 * 60 * 60 # 8 hours
|
VERSION_CACHE_TIMEOUT = 8 * 60 * 60 # 8 hours
|
||||||
|
# Chop of the first ^ because we want to search the entire string
|
||||||
|
URL_FINDER = URLValidator.regex.pattern[1:]
|
||||||
LOCAL_VERSION = parse(__version__)
|
LOCAL_VERSION = parse(__version__)
|
||||||
|
|
||||||
|
|
||||||
@ -52,7 +55,7 @@ def clear_update_notifications():
|
|||||||
def update_latest_version(self: SystemTask):
|
def update_latest_version(self: SystemTask):
|
||||||
"""Update latest version info"""
|
"""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, "0.0.0", VERSION_CACHE_TIMEOUT)
|
||||||
self.set_status(TaskStatus.WARNING, "Version check disabled.")
|
self.set_status(TaskStatus.WARNING, "Version check disabled.")
|
||||||
return
|
return
|
||||||
try:
|
try:
|
||||||
@ -74,18 +77,12 @@ def update_latest_version(self: SystemTask):
|
|||||||
context__new_version=upstream_version,
|
context__new_version=upstream_version,
|
||||||
).exists():
|
).exists():
|
||||||
return
|
return
|
||||||
Event.new(
|
event_dict = {"new_version": upstream_version}
|
||||||
EventAction.UPDATE_AVAILABLE,
|
if match := re.search(URL_FINDER, data.get("stable", {}).get("changelog", "")):
|
||||||
message=_(
|
event_dict["message"] = f"Changelog: {match.group()}"
|
||||||
"New version {version} available!".format(
|
Event.new(EventAction.UPDATE_AVAILABLE, **event_dict).save()
|
||||||
version=upstream_version,
|
|
||||||
)
|
|
||||||
),
|
|
||||||
new_version=upstream_version,
|
|
||||||
changelog=data.get("stable", {}).get("changelog_url"),
|
|
||||||
).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, "0.0.0", VERSION_CACHE_TIMEOUT)
|
||||||
self.set_error(exc)
|
self.set_error(exc)
|
||||||
|
|
||||||
|
|
||||||
|
@ -17,7 +17,6 @@ RESPONSE_VALID = {
|
|||||||
"stable": {
|
"stable": {
|
||||||
"version": "99999999.9999999",
|
"version": "99999999.9999999",
|
||||||
"changelog": "See https://goauthentik.io/test",
|
"changelog": "See https://goauthentik.io/test",
|
||||||
"changelog_url": "https://goauthentik.io/test",
|
|
||||||
"reason": "bugfix",
|
"reason": "bugfix",
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
@ -36,7 +35,7 @@ class TestAdminTasks(TestCase):
|
|||||||
Event.objects.filter(
|
Event.objects.filter(
|
||||||
action=EventAction.UPDATE_AVAILABLE,
|
action=EventAction.UPDATE_AVAILABLE,
|
||||||
context__new_version="99999999.9999999",
|
context__new_version="99999999.9999999",
|
||||||
context__message="New version 99999999.9999999 available!",
|
context__message="Changelog: https://goauthentik.io/test",
|
||||||
).exists()
|
).exists()
|
||||||
)
|
)
|
||||||
# test that a consecutive check doesn't create a duplicate event
|
# test that a consecutive check doesn't create a duplicate event
|
||||||
@ -46,7 +45,7 @@ class TestAdminTasks(TestCase):
|
|||||||
Event.objects.filter(
|
Event.objects.filter(
|
||||||
action=EventAction.UPDATE_AVAILABLE,
|
action=EventAction.UPDATE_AVAILABLE,
|
||||||
context__new_version="99999999.9999999",
|
context__new_version="99999999.9999999",
|
||||||
context__message="New version 99999999.9999999 available!",
|
context__message="Changelog: https://goauthentik.io/test",
|
||||||
)
|
)
|
||||||
),
|
),
|
||||||
1,
|
1,
|
||||||
|
@ -6,7 +6,6 @@ from authentik.admin.api.meta import AppsViewSet, ModelViewSet
|
|||||||
from authentik.admin.api.metrics import AdministrationMetricsViewSet
|
from authentik.admin.api.metrics import AdministrationMetricsViewSet
|
||||||
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.workers import WorkerView
|
from authentik.admin.api.workers import WorkerView
|
||||||
|
|
||||||
api_urlpatterns = [
|
api_urlpatterns = [
|
||||||
@ -18,7 +17,6 @@ api_urlpatterns = [
|
|||||||
name="admin_metrics",
|
name="admin_metrics",
|
||||||
),
|
),
|
||||||
path("admin/version/", VersionView.as_view(), name="admin_version"),
|
path("admin/version/", VersionView.as_view(), name="admin_version"),
|
||||||
("admin/version/history", VersionHistoryViewSet, "version_history"),
|
|
||||||
path("admin/workers/", WorkerView.as_view(), name="admin_workers"),
|
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"),
|
||||||
]
|
]
|
||||||
|
@ -10,3 +10,26 @@ class AuthentikAPIConfig(AppConfig):
|
|||||||
label = "authentik_api"
|
label = "authentik_api"
|
||||||
mountpoint = "api/"
|
mountpoint = "api/"
|
||||||
verbose_name = "authentik API"
|
verbose_name = "authentik API"
|
||||||
|
|
||||||
|
def ready(self) -> None:
|
||||||
|
from drf_spectacular.extensions import OpenApiAuthenticationExtension
|
||||||
|
|
||||||
|
from authentik.api.authentication import TokenAuthentication
|
||||||
|
|
||||||
|
# Class is defined here as it needs to be created early enough that drf-spectacular will
|
||||||
|
# find it, but also won't cause any import issues
|
||||||
|
# pylint: disable=unused-variable
|
||||||
|
class TokenSchema(OpenApiAuthenticationExtension):
|
||||||
|
"""Auth schema"""
|
||||||
|
|
||||||
|
target_class = TokenAuthentication
|
||||||
|
name = "authentik"
|
||||||
|
|
||||||
|
def get_security_definition(self, auto_schema):
|
||||||
|
"""Auth schema"""
|
||||||
|
return {
|
||||||
|
"type": "apiKey",
|
||||||
|
"in": "header",
|
||||||
|
"name": "Authorization",
|
||||||
|
"scheme": "bearer",
|
||||||
|
}
|
||||||
|
@ -1,10 +1,9 @@
|
|||||||
"""API Authentication"""
|
"""API Authentication"""
|
||||||
|
|
||||||
from hmac import compare_digest
|
from hmac import compare_digest
|
||||||
from typing import Any
|
from typing import Any, Optional
|
||||||
|
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from drf_spectacular.extensions import OpenApiAuthenticationExtension
|
|
||||||
from rest_framework.authentication import BaseAuthentication, get_authorization_header
|
from rest_framework.authentication import BaseAuthentication, get_authorization_header
|
||||||
from rest_framework.exceptions import AuthenticationFailed
|
from rest_framework.exceptions import AuthenticationFailed
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
@ -18,7 +17,7 @@ from authentik.providers.oauth2.constants import SCOPE_AUTHENTIK_API
|
|||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
def validate_auth(header: bytes) -> str | None:
|
def validate_auth(header: bytes) -> Optional[str]:
|
||||||
"""Validate that the header is in a correct format,
|
"""Validate that the header is in a correct format,
|
||||||
returns type and credentials"""
|
returns type and credentials"""
|
||||||
auth_credentials = header.decode().strip()
|
auth_credentials = header.decode().strip()
|
||||||
@ -33,7 +32,7 @@ def validate_auth(header: bytes) -> str | None:
|
|||||||
return auth_credentials
|
return auth_credentials
|
||||||
|
|
||||||
|
|
||||||
def bearer_auth(raw_header: bytes) -> User | None:
|
def bearer_auth(raw_header: bytes) -> Optional[User]:
|
||||||
"""raw_header in the Format of `Bearer ....`"""
|
"""raw_header in the Format of `Bearer ....`"""
|
||||||
user = auth_user_lookup(raw_header)
|
user = auth_user_lookup(raw_header)
|
||||||
if not user:
|
if not user:
|
||||||
@ -43,7 +42,7 @@ def bearer_auth(raw_header: bytes) -> User | None:
|
|||||||
return user
|
return user
|
||||||
|
|
||||||
|
|
||||||
def auth_user_lookup(raw_header: bytes) -> User | None:
|
def auth_user_lookup(raw_header: bytes) -> Optional[User]:
|
||||||
"""raw_header in the Format of `Bearer ....`"""
|
"""raw_header in the Format of `Bearer ....`"""
|
||||||
from authentik.providers.oauth2.models import AccessToken
|
from authentik.providers.oauth2.models import AccessToken
|
||||||
|
|
||||||
@ -76,7 +75,7 @@ def auth_user_lookup(raw_header: bytes) -> User | None:
|
|||||||
raise AuthenticationFailed("Token invalid/expired")
|
raise AuthenticationFailed("Token invalid/expired")
|
||||||
|
|
||||||
|
|
||||||
def token_secret_key(value: str) -> User | None:
|
def token_secret_key(value: str) -> Optional[User]:
|
||||||
"""Check if the token is the secret key
|
"""Check if the token is the secret key
|
||||||
and return the service account for the managed outpost"""
|
and return the service account for the managed outpost"""
|
||||||
from authentik.outposts.apps import MANAGED_OUTPOST
|
from authentik.outposts.apps import MANAGED_OUTPOST
|
||||||
@ -103,14 +102,3 @@ class TokenAuthentication(BaseAuthentication):
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
return (user, None) # pragma: no cover
|
return (user, None) # pragma: no cover
|
||||||
|
|
||||||
|
|
||||||
class TokenSchema(OpenApiAuthenticationExtension):
|
|
||||||
"""Auth schema"""
|
|
||||||
|
|
||||||
target_class = TokenAuthentication
|
|
||||||
name = "authentik"
|
|
||||||
|
|
||||||
def get_security_definition(self, auto_schema):
|
|
||||||
"""Auth schema"""
|
|
||||||
return {"type": "http", "scheme": "bearer"}
|
|
||||||
|
@ -12,7 +12,6 @@ from drf_spectacular.settings import spectacular_settings
|
|||||||
from drf_spectacular.types import OpenApiTypes
|
from drf_spectacular.types import OpenApiTypes
|
||||||
from rest_framework.settings import api_settings
|
from rest_framework.settings import api_settings
|
||||||
|
|
||||||
from authentik.api.apps import AuthentikAPIConfig
|
|
||||||
from authentik.api.pagination import PAGINATION_COMPONENT_NAME, PAGINATION_SCHEMA
|
from authentik.api.pagination import PAGINATION_COMPONENT_NAME, PAGINATION_SCHEMA
|
||||||
|
|
||||||
|
|
||||||
@ -102,12 +101,3 @@ def postprocess_schema_responses(result, generator: SchemaGenerator, **kwargs):
|
|||||||
comp = result["components"]["schemas"][component]
|
comp = result["components"]["schemas"][component]
|
||||||
comp["additionalProperties"] = {}
|
comp["additionalProperties"] = {}
|
||||||
return result
|
return result
|
||||||
|
|
||||||
|
|
||||||
def preprocess_schema_exclude_non_api(endpoints, **kwargs):
|
|
||||||
"""Filter out all API Views which are not mounted under /api"""
|
|
||||||
return [
|
|
||||||
(path, path_regex, method, callback)
|
|
||||||
for path, path_regex, method, callback in endpoints
|
|
||||||
if path.startswith("/" + AuthentikAPIConfig.mountpoint)
|
|
||||||
]
|
|
||||||
|
@ -1,13 +1,13 @@
|
|||||||
{% extends "base/skeleton.html" %}
|
{% extends "base/skeleton.html" %}
|
||||||
|
|
||||||
{% load authentik_core %}
|
{% load static %}
|
||||||
|
|
||||||
{% block title %}
|
{% block title %}
|
||||||
API Browser - {{ brand.branding_title }}
|
API Browser - {{ brand.branding_title }}
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
|
||||||
{% block head %}
|
{% block head %}
|
||||||
{% versioned_script "dist/standalone/api-browser/index-%v.js" %}
|
<script src="{% static 'dist/standalone/api-browser/index.js' %}?version={{ version }}" type="module"></script>
|
||||||
<meta name="theme-color" content="#151515" media="(prefers-color-scheme: light)">
|
<meta name="theme-color" content="#151515" media="(prefers-color-scheme: light)">
|
||||||
<meta name="theme-color" content="#151515" media="(prefers-color-scheme: dark)">
|
<meta name="theme-color" content="#151515" media="(prefers-color-scheme: dark)">
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
@ -25,17 +25,17 @@ class TestAPIAuth(TestCase):
|
|||||||
def test_invalid_type(self):
|
def test_invalid_type(self):
|
||||||
"""Test invalid type"""
|
"""Test invalid type"""
|
||||||
with self.assertRaises(AuthenticationFailed):
|
with self.assertRaises(AuthenticationFailed):
|
||||||
bearer_auth(b"foo bar")
|
bearer_auth("foo bar".encode())
|
||||||
|
|
||||||
def test_invalid_empty(self):
|
def test_invalid_empty(self):
|
||||||
"""Test invalid type"""
|
"""Test invalid type"""
|
||||||
self.assertIsNone(bearer_auth(b"Bearer "))
|
self.assertIsNone(bearer_auth("Bearer ".encode()))
|
||||||
self.assertIsNone(bearer_auth(b""))
|
self.assertIsNone(bearer_auth("".encode()))
|
||||||
|
|
||||||
def test_invalid_no_token(self):
|
def test_invalid_no_token(self):
|
||||||
"""Test invalid with no token"""
|
"""Test invalid with no token"""
|
||||||
with self.assertRaises(AuthenticationFailed):
|
with self.assertRaises(AuthenticationFailed):
|
||||||
auth = b64encode(b":abc").decode()
|
auth = b64encode(":abc".encode()).decode()
|
||||||
self.assertIsNone(bearer_auth(f"Basic :{auth}".encode()))
|
self.assertIsNone(bearer_auth(f"Basic :{auth}".encode()))
|
||||||
|
|
||||||
def test_bearer_valid(self):
|
def test_bearer_valid(self):
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
"""authentik API Modelviewset tests"""
|
"""authentik API Modelviewset tests"""
|
||||||
|
|
||||||
from collections.abc import Callable
|
from typing import Callable
|
||||||
|
|
||||||
from django.test import TestCase
|
from django.test import TestCase
|
||||||
from rest_framework.viewsets import ModelViewSet, ReadOnlyModelViewSet
|
from rest_framework.viewsets import ModelViewSet, ReadOnlyModelViewSet
|
||||||
@ -26,6 +26,6 @@ def viewset_tester_factory(test_viewset: type[ModelViewSet]) -> Callable:
|
|||||||
|
|
||||||
|
|
||||||
for _, viewset, _ in router.registry:
|
for _, viewset, _ in router.registry:
|
||||||
if not issubclass(viewset, ModelViewSet | ReadOnlyModelViewSet):
|
if not issubclass(viewset, (ModelViewSet, ReadOnlyModelViewSet)):
|
||||||
continue
|
continue
|
||||||
setattr(TestModelViewSets, f"test_viewset_{viewset.__name__}", viewset_tester_factory(viewset))
|
setattr(TestModelViewSets, f"test_viewset_{viewset.__name__}", viewset_tester_factory(viewset))
|
||||||
|
@ -33,7 +33,7 @@ for _authentik_app in get_apps():
|
|||||||
app_name=_authentik_app.name,
|
app_name=_authentik_app.name,
|
||||||
)
|
)
|
||||||
continue
|
continue
|
||||||
urls: list = api_urls.api_urlpatterns
|
urls: list = getattr(api_urls, "api_urlpatterns")
|
||||||
for url in urls:
|
for url in urls:
|
||||||
if isinstance(url, URLPattern):
|
if isinstance(url, URLPattern):
|
||||||
_other_urls.append(url)
|
_other_urls.append(url)
|
||||||
|
@ -51,12 +51,8 @@ class BlueprintInstanceSerializer(ModelSerializer):
|
|||||||
context = self.instance.context if self.instance else {}
|
context = self.instance.context if self.instance else {}
|
||||||
valid, logs = Importer.from_string(content, context).validate()
|
valid, logs = Importer.from_string(content, context).validate()
|
||||||
if not valid:
|
if not valid:
|
||||||
raise ValidationError(
|
text_logs = "\n".join([x["event"] for x in logs])
|
||||||
[
|
raise ValidationError(_("Failed to validate blueprint: %(logs)s" % {"logs": text_logs}))
|
||||||
_("Failed to validate blueprint"),
|
|
||||||
*[f"- {x.event}" for x in logs],
|
|
||||||
]
|
|
||||||
)
|
|
||||||
return content
|
return content
|
||||||
|
|
||||||
def validate(self, attrs: dict) -> dict:
|
def validate(self, attrs: dict) -> dict:
|
||||||
|
@ -1,6 +1,5 @@
|
|||||||
"""authentik Blueprints app"""
|
"""authentik Blueprints app"""
|
||||||
|
|
||||||
from collections.abc import Callable
|
|
||||||
from importlib import import_module
|
from importlib import import_module
|
||||||
from inspect import ismethod
|
from inspect import ismethod
|
||||||
|
|
||||||
@ -8,16 +7,14 @@ from django.apps import AppConfig
|
|||||||
from django.db import DatabaseError, InternalError, ProgrammingError
|
from django.db import DatabaseError, InternalError, ProgrammingError
|
||||||
from structlog.stdlib import BoundLogger, get_logger
|
from structlog.stdlib import BoundLogger, get_logger
|
||||||
|
|
||||||
from authentik.root.signals import startup
|
|
||||||
|
|
||||||
|
|
||||||
class ManagedAppConfig(AppConfig):
|
class ManagedAppConfig(AppConfig):
|
||||||
"""Basic reconciliation logic for apps"""
|
"""Basic reconciliation logic for apps"""
|
||||||
|
|
||||||
logger: BoundLogger
|
logger: BoundLogger
|
||||||
|
|
||||||
RECONCILE_GLOBAL_CATEGORY: str = "global"
|
RECONCILE_GLOBAL_PREFIX: str = "reconcile_global_"
|
||||||
RECONCILE_TENANT_CATEGORY: str = "tenant"
|
RECONCILE_TENANT_PREFIX: str = "reconcile_tenant_"
|
||||||
|
|
||||||
def __init__(self, app_name: str, *args, **kwargs) -> None:
|
def __init__(self, app_name: str, *args, **kwargs) -> None:
|
||||||
super().__init__(app_name, *args, **kwargs)
|
super().__init__(app_name, *args, **kwargs)
|
||||||
@ -25,13 +22,10 @@ class ManagedAppConfig(AppConfig):
|
|||||||
|
|
||||||
def ready(self) -> None:
|
def ready(self) -> None:
|
||||||
self.import_related()
|
self.import_related()
|
||||||
startup.connect(self._on_startup_callback, dispatch_uid=self.label)
|
self.reconcile_global()
|
||||||
|
self.reconcile_tenant()
|
||||||
return super().ready()
|
return super().ready()
|
||||||
|
|
||||||
def _on_startup_callback(self, sender, **_):
|
|
||||||
self._reconcile_global()
|
|
||||||
self._reconcile_tenant()
|
|
||||||
|
|
||||||
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 celery tasks)"""
|
||||||
@ -57,8 +51,7 @@ class ManagedAppConfig(AppConfig):
|
|||||||
meth = getattr(self, meth_name)
|
meth = getattr(self, meth_name)
|
||||||
if not ismethod(meth):
|
if not ismethod(meth):
|
||||||
continue
|
continue
|
||||||
category = getattr(meth, "_authentik_managed_reconcile", None)
|
if not meth_name.startswith(prefix):
|
||||||
if category != prefix:
|
|
||||||
continue
|
continue
|
||||||
name = meth_name.replace(prefix, "")
|
name = meth_name.replace(prefix, "")
|
||||||
try:
|
try:
|
||||||
@ -68,19 +61,7 @@ class ManagedAppConfig(AppConfig):
|
|||||||
except (DatabaseError, ProgrammingError, InternalError) as exc:
|
except (DatabaseError, ProgrammingError, InternalError) as exc:
|
||||||
self.logger.warning("Failed to run reconcile", name=name, exc=exc)
|
self.logger.warning("Failed to run reconcile", name=name, exc=exc)
|
||||||
|
|
||||||
@staticmethod
|
def reconcile_tenant(self) -> None:
|
||||||
def reconcile_tenant(func: Callable):
|
|
||||||
"""Mark a function to be called on startup (for each tenant)"""
|
|
||||||
func._authentik_managed_reconcile = ManagedAppConfig.RECONCILE_TENANT_CATEGORY
|
|
||||||
return func
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def reconcile_global(func: Callable):
|
|
||||||
"""Mark a function to be called on startup (globally)"""
|
|
||||||
func._authentik_managed_reconcile = ManagedAppConfig.RECONCILE_GLOBAL_CATEGORY
|
|
||||||
return func
|
|
||||||
|
|
||||||
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
|
||||||
|
|
||||||
@ -91,9 +72,9 @@ class ManagedAppConfig(AppConfig):
|
|||||||
return
|
return
|
||||||
for tenant in tenants:
|
for tenant in tenants:
|
||||||
with tenant:
|
with tenant:
|
||||||
self._reconcile(self.RECONCILE_TENANT_CATEGORY)
|
self._reconcile(self.RECONCILE_TENANT_PREFIX)
|
||||||
|
|
||||||
def _reconcile_global(self) -> None:
|
def reconcile_global(self) -> None:
|
||||||
"""
|
"""
|
||||||
reconcile ourselves for global methods.
|
reconcile ourselves for global methods.
|
||||||
Used for signals, tasks, etc. Database queries should not be made in here.
|
Used for signals, tasks, etc. Database queries should not be made in here.
|
||||||
@ -101,7 +82,7 @@ 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()):
|
with schema_context(get_public_schema_name()):
|
||||||
self._reconcile(self.RECONCILE_GLOBAL_CATEGORY)
|
self._reconcile(self.RECONCILE_GLOBAL_PREFIX)
|
||||||
|
|
||||||
|
|
||||||
class AuthentikBlueprintsConfig(ManagedAppConfig):
|
class AuthentikBlueprintsConfig(ManagedAppConfig):
|
||||||
@ -112,13 +93,11 @@ class AuthentikBlueprintsConfig(ManagedAppConfig):
|
|||||||
verbose_name = "authentik Blueprints"
|
verbose_name = "authentik Blueprints"
|
||||||
default = True
|
default = True
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_global
|
def reconcile_global_load_blueprints_v1_tasks(self):
|
||||||
def load_blueprints_v1_tasks(self):
|
|
||||||
"""Load v1 tasks"""
|
"""Load v1 tasks"""
|
||||||
self.import_module("authentik.blueprints.v1.tasks")
|
self.import_module("authentik.blueprints.v1.tasks")
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_tenant
|
def reconcile_tenant_blueprints_discovery(self):
|
||||||
def blueprints_discovery(self):
|
|
||||||
"""Run blueprint discovery"""
|
"""Run blueprint discovery"""
|
||||||
from authentik.blueprints.v1.tasks import blueprints_discovery, clear_failed_blueprints
|
from authentik.blueprints.v1.tasks import blueprints_discovery, clear_failed_blueprints
|
||||||
|
|
||||||
|
@ -23,11 +23,9 @@ class Command(BaseCommand):
|
|||||||
for blueprint_path in options.get("blueprints", []):
|
for blueprint_path in options.get("blueprints", []):
|
||||||
content = BlueprintInstance(path=blueprint_path).retrieve()
|
content = BlueprintInstance(path=blueprint_path).retrieve()
|
||||||
importer = Importer.from_string(content)
|
importer = Importer.from_string(content)
|
||||||
valid, logs = importer.validate()
|
valid, _ = importer.validate()
|
||||||
if not valid:
|
if not valid:
|
||||||
self.stderr.write("Blueprint invalid")
|
self.stderr.write("blueprint invalid")
|
||||||
for log in logs:
|
|
||||||
self.stderr.write(f"\t{log.logger}: {log.event}: {log.attributes}")
|
|
||||||
sys_exit(1)
|
sys_exit(1)
|
||||||
importer.apply()
|
importer.apply()
|
||||||
|
|
||||||
|
@ -4,14 +4,12 @@ from json import dumps
|
|||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from django.core.management.base import BaseCommand, no_translations
|
from django.core.management.base import BaseCommand, no_translations
|
||||||
from django.db.models import Model, fields
|
from django.db.models import Model
|
||||||
from drf_jsonschema_serializer.convert import converter, field_to_converter
|
from drf_jsonschema_serializer.convert import field_to_converter
|
||||||
from rest_framework.fields import Field, JSONField, UUIDField
|
from rest_framework.fields import Field, JSONField, UUIDField
|
||||||
from rest_framework.relations import PrimaryKeyRelatedField
|
|
||||||
from rest_framework.serializers import Serializer
|
from rest_framework.serializers import Serializer
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
|
|
||||||
from authentik import __version__
|
|
||||||
from authentik.blueprints.v1.common import BlueprintEntryDesiredState
|
from authentik.blueprints.v1.common import BlueprintEntryDesiredState
|
||||||
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT, is_model_allowed
|
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT, is_model_allowed
|
||||||
from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry
|
from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry
|
||||||
@ -20,23 +18,6 @@ from authentik.lib.models import SerializerModel
|
|||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
@converter
|
|
||||||
class PrimaryKeyRelatedFieldConverter:
|
|
||||||
"""Custom primary key field converter which is aware of non-integer based PKs
|
|
||||||
|
|
||||||
This is not an exhaustive fix for other non-int PKs, however in authentik we either
|
|
||||||
use UUIDs or ints"""
|
|
||||||
|
|
||||||
field_class = PrimaryKeyRelatedField
|
|
||||||
|
|
||||||
def convert(self, field: PrimaryKeyRelatedField):
|
|
||||||
model: Model = field.queryset.model
|
|
||||||
pk_field = model._meta.pk
|
|
||||||
if isinstance(pk_field, fields.UUIDField):
|
|
||||||
return {"type": "string", "format": "uuid"}
|
|
||||||
return {"type": "integer"}
|
|
||||||
|
|
||||||
|
|
||||||
class Command(BaseCommand):
|
class Command(BaseCommand):
|
||||||
"""Generate JSON Schema for blueprints"""
|
"""Generate JSON Schema for blueprints"""
|
||||||
|
|
||||||
@ -48,7 +29,7 @@ class Command(BaseCommand):
|
|||||||
"$schema": "http://json-schema.org/draft-07/schema",
|
"$schema": "http://json-schema.org/draft-07/schema",
|
||||||
"$id": "https://goauthentik.io/blueprints/schema.json",
|
"$id": "https://goauthentik.io/blueprints/schema.json",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"title": f"authentik {__version__} Blueprint schema",
|
"title": "authentik Blueprint schema",
|
||||||
"required": ["version", "entries"],
|
"required": ["version", "entries"],
|
||||||
"properties": {
|
"properties": {
|
||||||
"version": {
|
"version": {
|
||||||
@ -113,19 +94,16 @@ class Command(BaseCommand):
|
|||||||
)
|
)
|
||||||
model_path = f"{model._meta.app_label}.{model._meta.model_name}"
|
model_path = f"{model._meta.app_label}.{model._meta.model_name}"
|
||||||
self.schema["properties"]["entries"]["items"]["oneOf"].append(
|
self.schema["properties"]["entries"]["items"]["oneOf"].append(
|
||||||
self.template_entry(model_path, model, serializer)
|
self.template_entry(model_path, serializer)
|
||||||
)
|
)
|
||||||
|
|
||||||
def template_entry(self, model_path: str, model: type[Model], serializer: Serializer) -> dict:
|
def template_entry(self, model_path: str, serializer: Serializer) -> dict:
|
||||||
"""Template entry for a single model"""
|
"""Template entry for a single model"""
|
||||||
model_schema = self.to_jsonschema(serializer)
|
model_schema = self.to_jsonschema(serializer)
|
||||||
model_schema["required"] = []
|
model_schema["required"] = []
|
||||||
def_name = f"model_{model_path}"
|
def_name = f"model_{model_path}"
|
||||||
def_path = f"#/$defs/{def_name}"
|
def_path = f"#/$defs/{def_name}"
|
||||||
self.schema["$defs"][def_name] = model_schema
|
self.schema["$defs"][def_name] = model_schema
|
||||||
def_name_perm = f"model_{model_path}_permissions"
|
|
||||||
def_path_perm = f"#/$defs/{def_name_perm}"
|
|
||||||
self.schema["$defs"][def_name_perm] = self.model_permissions(model)
|
|
||||||
return {
|
return {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": ["model", "identifiers"],
|
"required": ["model", "identifiers"],
|
||||||
@ -138,7 +116,6 @@ class Command(BaseCommand):
|
|||||||
"default": "present",
|
"default": "present",
|
||||||
},
|
},
|
||||||
"conditions": {"type": "array", "items": {"type": "boolean"}},
|
"conditions": {"type": "array", "items": {"type": "boolean"}},
|
||||||
"permissions": {"$ref": def_path_perm},
|
|
||||||
"attrs": {"$ref": def_path},
|
"attrs": {"$ref": def_path},
|
||||||
"identifiers": {"$ref": def_path},
|
"identifiers": {"$ref": def_path},
|
||||||
},
|
},
|
||||||
@ -189,20 +166,3 @@ class Command(BaseCommand):
|
|||||||
if required:
|
if required:
|
||||||
result["required"] = required
|
result["required"] = required
|
||||||
return result
|
return result
|
||||||
|
|
||||||
def model_permissions(self, model: type[Model]) -> dict:
|
|
||||||
perms = [x[0] for x in model._meta.permissions]
|
|
||||||
for action in model._meta.default_permissions:
|
|
||||||
perms.append(f"{action}_{model._meta.model_name}")
|
|
||||||
return {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "object",
|
|
||||||
"required": ["permission"],
|
|
||||||
"properties": {
|
|
||||||
"permission": {"type": "string", "enum": perms},
|
|
||||||
"user": {"type": "integer"},
|
|
||||||
"role": {"type": "string"},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
@ -29,7 +29,9 @@ def check_blueprint_v1_file(BlueprintInstance: type, db_alias, path: Path):
|
|||||||
if version != 1:
|
if version != 1:
|
||||||
return
|
return
|
||||||
blueprint_file.seek(0)
|
blueprint_file.seek(0)
|
||||||
instance = BlueprintInstance.objects.using(db_alias).filter(path=path).first()
|
instance: BlueprintInstance = (
|
||||||
|
BlueprintInstance.objects.using(db_alias).filter(path=path).first()
|
||||||
|
)
|
||||||
rel_path = path.relative_to(Path(CONFIG.get("blueprints_dir")))
|
rel_path = path.relative_to(Path(CONFIG.get("blueprints_dir")))
|
||||||
meta = None
|
meta = None
|
||||||
if metadata:
|
if metadata:
|
||||||
|
@ -71,19 +71,6 @@ 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)
|
||||||
|
|
||||||
class Meta:
|
|
||||||
verbose_name = _("Blueprint Instance")
|
|
||||||
verbose_name_plural = _("Blueprint Instances")
|
|
||||||
unique_together = (
|
|
||||||
(
|
|
||||||
"name",
|
|
||||||
"path",
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
return f"Blueprint Instance {self.name}"
|
|
||||||
|
|
||||||
def retrieve_oci(self) -> str:
|
def retrieve_oci(self) -> str:
|
||||||
"""Get blueprint from an OCI registry"""
|
"""Get blueprint from an OCI registry"""
|
||||||
client = BlueprintOCIClient(self.path.replace(OCI_PREFIX, "https://"))
|
client = BlueprintOCIClient(self.path.replace(OCI_PREFIX, "https://"))
|
||||||
@ -102,7 +89,7 @@ class BlueprintInstance(SerializerModel, ManagedModel, CreatedUpdatedModel):
|
|||||||
raise BlueprintRetrievalFailed("Invalid blueprint path")
|
raise BlueprintRetrievalFailed("Invalid blueprint path")
|
||||||
with full_path.open("r", encoding="utf-8") as _file:
|
with full_path.open("r", encoding="utf-8") as _file:
|
||||||
return _file.read()
|
return _file.read()
|
||||||
except OSError as exc:
|
except (IOError, OSError) as exc:
|
||||||
raise BlueprintRetrievalFailed(exc) from exc
|
raise BlueprintRetrievalFailed(exc) from exc
|
||||||
|
|
||||||
def retrieve(self) -> str:
|
def retrieve(self) -> str:
|
||||||
@ -118,3 +105,16 @@ class BlueprintInstance(SerializerModel, ManagedModel, CreatedUpdatedModel):
|
|||||||
from authentik.blueprints.api import BlueprintInstanceSerializer
|
from authentik.blueprints.api import BlueprintInstanceSerializer
|
||||||
|
|
||||||
return BlueprintInstanceSerializer
|
return BlueprintInstanceSerializer
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
return f"Blueprint Instance {self.name}"
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
verbose_name = _("Blueprint Instance")
|
||||||
|
verbose_name_plural = _("Blueprint Instances")
|
||||||
|
unique_together = (
|
||||||
|
(
|
||||||
|
"name",
|
||||||
|
"path",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
"""Blueprint helpers"""
|
"""Blueprint helpers"""
|
||||||
|
|
||||||
from collections.abc import Callable
|
|
||||||
from functools import wraps
|
from functools import wraps
|
||||||
|
from typing import Callable
|
||||||
|
|
||||||
from django.apps import apps
|
from django.apps import apps
|
||||||
|
|
||||||
@ -39,7 +39,7 @@ def reconcile_app(app_name: str):
|
|||||||
def wrapper(*args, **kwargs):
|
def wrapper(*args, **kwargs):
|
||||||
config = apps.get_app_config(app_name)
|
config = apps.get_app_config(app_name)
|
||||||
if isinstance(config, ManagedAppConfig):
|
if isinstance(config, ManagedAppConfig):
|
||||||
config._on_startup_callback(None)
|
config.ready()
|
||||||
return func(*args, **kwargs)
|
return func(*args, **kwargs)
|
||||||
|
|
||||||
return wrapper
|
return wrapper
|
||||||
|
@ -1,24 +0,0 @@
|
|||||||
version: 1
|
|
||||||
entries:
|
|
||||||
- model: authentik_core.user
|
|
||||||
id: user
|
|
||||||
identifiers:
|
|
||||||
username: "%(id)s"
|
|
||||||
attrs:
|
|
||||||
name: "%(id)s"
|
|
||||||
- model: authentik_rbac.role
|
|
||||||
id: role
|
|
||||||
identifiers:
|
|
||||||
name: "%(id)s"
|
|
||||||
- model: authentik_flows.flow
|
|
||||||
identifiers:
|
|
||||||
slug: "%(id)s"
|
|
||||||
attrs:
|
|
||||||
designation: authentication
|
|
||||||
name: foo
|
|
||||||
title: foo
|
|
||||||
permissions:
|
|
||||||
- permission: view_flow
|
|
||||||
user: !KeyOf user
|
|
||||||
- permission: view_flow
|
|
||||||
role: !KeyOf role
|
|
@ -1,8 +0,0 @@
|
|||||||
version: 1
|
|
||||||
entries:
|
|
||||||
- model: authentik_rbac.role
|
|
||||||
identifiers:
|
|
||||||
name: "%(id)s"
|
|
||||||
attrs:
|
|
||||||
permissions:
|
|
||||||
- authentik_blueprints.view_blueprintinstance
|
|
@ -1,9 +0,0 @@
|
|||||||
version: 1
|
|
||||||
entries:
|
|
||||||
- model: authentik_core.user
|
|
||||||
identifiers:
|
|
||||||
username: "%(id)s"
|
|
||||||
attrs:
|
|
||||||
name: "%(id)s"
|
|
||||||
permissions:
|
|
||||||
- authentik_blueprints.view_blueprintinstance
|
|
@ -1,7 +1,7 @@
|
|||||||
"""test packaged blueprints"""
|
"""test packaged blueprints"""
|
||||||
|
|
||||||
from collections.abc import Callable
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from typing import Callable
|
||||||
|
|
||||||
from django.test import TransactionTestCase
|
from django.test import TransactionTestCase
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
"""authentik managed models tests"""
|
"""authentik managed models tests"""
|
||||||
|
|
||||||
from collections.abc import Callable
|
from typing import Callable, Type
|
||||||
|
|
||||||
from django.apps import apps
|
from django.apps import apps
|
||||||
from django.test import TestCase
|
from django.test import TestCase
|
||||||
@ -14,7 +14,7 @@ class TestModels(TestCase):
|
|||||||
"""Test Models"""
|
"""Test Models"""
|
||||||
|
|
||||||
|
|
||||||
def serializer_tester_factory(test_model: type[SerializerModel]) -> Callable:
|
def serializer_tester_factory(test_model: Type[SerializerModel]) -> Callable:
|
||||||
"""Test serializer"""
|
"""Test serializer"""
|
||||||
|
|
||||||
def tester(self: TestModels):
|
def tester(self: TestModels):
|
||||||
|
@ -78,5 +78,5 @@ class TestBlueprintsV1API(APITestCase):
|
|||||||
self.assertEqual(res.status_code, 400)
|
self.assertEqual(res.status_code, 400)
|
||||||
self.assertJSONEqual(
|
self.assertJSONEqual(
|
||||||
res.content.decode(),
|
res.content.decode(),
|
||||||
{"content": ["Failed to validate blueprint", "- Invalid blueprint version"]},
|
{"content": ["Failed to validate blueprint: Invalid blueprint version"]},
|
||||||
)
|
)
|
||||||
|
@ -1,57 +0,0 @@
|
|||||||
"""Test blueprints v1"""
|
|
||||||
|
|
||||||
from django.test import TransactionTestCase
|
|
||||||
from guardian.shortcuts import get_perms
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.importer import Importer
|
|
||||||
from authentik.core.models import User
|
|
||||||
from authentik.flows.models import Flow
|
|
||||||
from authentik.lib.generators import generate_id
|
|
||||||
from authentik.lib.tests.utils import load_fixture
|
|
||||||
from authentik.rbac.models import Role
|
|
||||||
|
|
||||||
|
|
||||||
class TestBlueprintsV1RBAC(TransactionTestCase):
|
|
||||||
"""Test Blueprints rbac attribute"""
|
|
||||||
|
|
||||||
def test_user_permission(self):
|
|
||||||
"""Test permissions"""
|
|
||||||
uid = generate_id()
|
|
||||||
import_yaml = load_fixture("fixtures/rbac_user.yaml", id=uid)
|
|
||||||
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
user = User.objects.filter(username=uid).first()
|
|
||||||
self.assertIsNotNone(user)
|
|
||||||
self.assertTrue(user.has_perms(["authentik_blueprints.view_blueprintinstance"]))
|
|
||||||
|
|
||||||
def test_role_permission(self):
|
|
||||||
"""Test permissions"""
|
|
||||||
uid = generate_id()
|
|
||||||
import_yaml = load_fixture("fixtures/rbac_role.yaml", id=uid)
|
|
||||||
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
role = Role.objects.filter(name=uid).first()
|
|
||||||
self.assertIsNotNone(role)
|
|
||||||
self.assertEqual(
|
|
||||||
list(role.group.permissions.all().values_list("codename", flat=True)),
|
|
||||||
["view_blueprintinstance"],
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_object_permission(self):
|
|
||||||
"""Test permissions"""
|
|
||||||
uid = generate_id()
|
|
||||||
import_yaml = load_fixture("fixtures/rbac_object.yaml", id=uid)
|
|
||||||
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
flow = Flow.objects.filter(slug=uid).first()
|
|
||||||
user = User.objects.filter(username=uid).first()
|
|
||||||
role = Role.objects.filter(name=uid).first()
|
|
||||||
self.assertIsNotNone(flow)
|
|
||||||
self.assertEqual(get_perms(user, flow), ["view_flow"])
|
|
||||||
self.assertEqual(get_perms(role.group, flow), ["view_flow"])
|
|
@ -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() # pylint: disable=no-value-for-parameter
|
||||||
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() # pylint: disable=no-value-for-parameter
|
||||||
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() # pylint: disable=no-value-for-parameter
|
||||||
blueprint.refresh_from_db()
|
blueprint.refresh_from_db()
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
blueprint.last_applied_hash,
|
blueprint.last_applied_hash,
|
||||||
@ -149,7 +149,7 @@ class TestBlueprintsV1Tasks(TransactionTestCase):
|
|||||||
instance.status,
|
instance.status,
|
||||||
BlueprintInstanceStatus.UNKNOWN,
|
BlueprintInstanceStatus.UNKNOWN,
|
||||||
)
|
)
|
||||||
apply_blueprint(instance.pk)
|
apply_blueprint(instance.pk) # pylint: disable=no-value-for-parameter
|
||||||
instance.refresh_from_db()
|
instance.refresh_from_db()
|
||||||
self.assertEqual(instance.last_applied_hash, "")
|
self.assertEqual(instance.last_applied_hash, "")
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
|
@ -1,14 +1,13 @@
|
|||||||
"""transfer common classes"""
|
"""transfer common classes"""
|
||||||
|
|
||||||
from collections import OrderedDict
|
from collections import OrderedDict
|
||||||
from collections.abc import Generator, Iterable, Mapping
|
|
||||||
from copy import copy
|
from copy import copy
|
||||||
from dataclasses import asdict, dataclass, field, is_dataclass
|
from dataclasses import asdict, dataclass, field, is_dataclass
|
||||||
from enum import Enum
|
from enum import Enum
|
||||||
from functools import reduce
|
from functools import reduce
|
||||||
from operator import ixor
|
from operator import ixor
|
||||||
from os import getenv
|
from os import getenv
|
||||||
from typing import Any, Literal, Union
|
from typing import Any, Iterable, Literal, Mapping, Optional, Union
|
||||||
from uuid import UUID
|
from uuid import UUID
|
||||||
|
|
||||||
from deepmerge import always_merger
|
from deepmerge import always_merger
|
||||||
@ -46,7 +45,7 @@ def get_attrs(obj: SerializerModel) -> dict[str, Any]:
|
|||||||
class BlueprintEntryState:
|
class BlueprintEntryState:
|
||||||
"""State of a single instance"""
|
"""State of a single instance"""
|
||||||
|
|
||||||
instance: Model | None = None
|
instance: Optional[Model] = None
|
||||||
|
|
||||||
|
|
||||||
class BlueprintEntryDesiredState(Enum):
|
class BlueprintEntryDesiredState(Enum):
|
||||||
@ -58,15 +57,6 @@ class BlueprintEntryDesiredState(Enum):
|
|||||||
MUST_CREATED = "must_created"
|
MUST_CREATED = "must_created"
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class BlueprintEntryPermission:
|
|
||||||
"""Describe object-level permissions"""
|
|
||||||
|
|
||||||
permission: Union[str, "YAMLTag"]
|
|
||||||
user: Union[int, "YAMLTag", None] = field(default=None)
|
|
||||||
role: Union[str, "YAMLTag", None] = field(default=None)
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
class BlueprintEntry:
|
class BlueprintEntry:
|
||||||
"""Single entry of a blueprint"""
|
"""Single entry of a blueprint"""
|
||||||
@ -77,15 +67,14 @@ class BlueprintEntry:
|
|||||||
)
|
)
|
||||||
conditions: list[Any] = field(default_factory=list)
|
conditions: list[Any] = field(default_factory=list)
|
||||||
identifiers: dict[str, Any] = field(default_factory=dict)
|
identifiers: dict[str, Any] = field(default_factory=dict)
|
||||||
attrs: dict[str, Any] | None = field(default_factory=dict)
|
attrs: Optional[dict[str, Any]] = field(default_factory=dict)
|
||||||
permissions: list[BlueprintEntryPermission] = field(default_factory=list)
|
|
||||||
|
|
||||||
id: str | None = None
|
id: Optional[str] = None
|
||||||
|
|
||||||
_state: BlueprintEntryState = field(default_factory=BlueprintEntryState)
|
_state: BlueprintEntryState = field(default_factory=BlueprintEntryState)
|
||||||
|
|
||||||
def __post_init__(self, *args, **kwargs) -> None:
|
def __post_init__(self, *args, **kwargs) -> None:
|
||||||
self.__tag_contexts: list[YAMLTagContext] = []
|
self.__tag_contexts: list["YAMLTagContext"] = []
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def from_model(model: SerializerModel, *extra_identifier_names: str) -> "BlueprintEntry":
|
def from_model(model: SerializerModel, *extra_identifier_names: str) -> "BlueprintEntry":
|
||||||
@ -103,10 +92,10 @@ class BlueprintEntry:
|
|||||||
attrs=all_attrs,
|
attrs=all_attrs,
|
||||||
)
|
)
|
||||||
|
|
||||||
def get_tag_context(
|
def _get_tag_context(
|
||||||
self,
|
self,
|
||||||
depth: int = 0,
|
depth: int = 0,
|
||||||
context_tag_type: type["YAMLTagContext"] | tuple["YAMLTagContext", ...] | None = None,
|
context_tag_type: Optional[type["YAMLTagContext"] | tuple["YAMLTagContext", ...]] = None,
|
||||||
) -> "YAMLTagContext":
|
) -> "YAMLTagContext":
|
||||||
"""Get a YAMLTagContext object located at a certain depth in the tag tree"""
|
"""Get a YAMLTagContext object located at a certain depth in the tag tree"""
|
||||||
if depth < 0:
|
if depth < 0:
|
||||||
@ -119,8 +108,8 @@ class BlueprintEntry:
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
return contexts[-(depth + 1)]
|
return contexts[-(depth + 1)]
|
||||||
except IndexError as exc:
|
except IndexError:
|
||||||
raise ValueError(f"invalid depth: {depth}. Max depth: {len(contexts) - 1}") from exc
|
raise ValueError(f"invalid depth: {depth}. Max depth: {len(contexts) - 1}")
|
||||||
|
|
||||||
def tag_resolver(self, value: Any, blueprint: "Blueprint") -> Any:
|
def tag_resolver(self, value: Any, blueprint: "Blueprint") -> Any:
|
||||||
"""Check if we have any special tags that need handling"""
|
"""Check if we have any special tags that need handling"""
|
||||||
@ -160,17 +149,6 @@ class BlueprintEntry:
|
|||||||
"""Get the blueprint model, with yaml tags resolved if present"""
|
"""Get the blueprint model, with yaml tags resolved if present"""
|
||||||
return str(self.tag_resolver(self.model, blueprint))
|
return str(self.tag_resolver(self.model, blueprint))
|
||||||
|
|
||||||
def get_permissions(
|
|
||||||
self, blueprint: "Blueprint"
|
|
||||||
) -> Generator[BlueprintEntryPermission, None, None]:
|
|
||||||
"""Get permissions of this entry, with all yaml tags resolved"""
|
|
||||||
for perm in self.permissions:
|
|
||||||
yield BlueprintEntryPermission(
|
|
||||||
permission=self.tag_resolver(perm.permission, blueprint),
|
|
||||||
user=self.tag_resolver(perm.user, blueprint),
|
|
||||||
role=self.tag_resolver(perm.role, blueprint),
|
|
||||||
)
|
|
||||||
|
|
||||||
def check_all_conditions_match(self, blueprint: "Blueprint") -> bool:
|
def check_all_conditions_match(self, blueprint: "Blueprint") -> bool:
|
||||||
"""Check all conditions of this entry match (evaluate to True)"""
|
"""Check all conditions of this entry match (evaluate to True)"""
|
||||||
return all(self.tag_resolver(self.conditions, blueprint))
|
return all(self.tag_resolver(self.conditions, blueprint))
|
||||||
@ -192,7 +170,7 @@ class Blueprint:
|
|||||||
entries: list[BlueprintEntry] = field(default_factory=list)
|
entries: list[BlueprintEntry] = field(default_factory=list)
|
||||||
context: dict = field(default_factory=dict)
|
context: dict = field(default_factory=dict)
|
||||||
|
|
||||||
metadata: BlueprintMetadata | None = field(default=None)
|
metadata: Optional[BlueprintMetadata] = field(default=None)
|
||||||
|
|
||||||
|
|
||||||
class YAMLTag:
|
class YAMLTag:
|
||||||
@ -240,7 +218,7 @@ class Env(YAMLTag):
|
|||||||
"""Lookup environment variable with optional default"""
|
"""Lookup environment variable with optional default"""
|
||||||
|
|
||||||
key: str
|
key: str
|
||||||
default: Any | None
|
default: Optional[Any]
|
||||||
|
|
||||||
def __init__(self, loader: "BlueprintLoader", node: ScalarNode | SequenceNode) -> None:
|
def __init__(self, loader: "BlueprintLoader", node: ScalarNode | SequenceNode) -> None:
|
||||||
super().__init__()
|
super().__init__()
|
||||||
@ -259,7 +237,7 @@ class Context(YAMLTag):
|
|||||||
"""Lookup key from instance context"""
|
"""Lookup key from instance context"""
|
||||||
|
|
||||||
key: str
|
key: str
|
||||||
default: Any | None
|
default: Optional[Any]
|
||||||
|
|
||||||
def __init__(self, loader: "BlueprintLoader", node: ScalarNode | SequenceNode) -> None:
|
def __init__(self, loader: "BlueprintLoader", node: ScalarNode | SequenceNode) -> None:
|
||||||
super().__init__()
|
super().__init__()
|
||||||
@ -303,7 +281,7 @@ class Format(YAMLTag):
|
|||||||
try:
|
try:
|
||||||
return self.format_string % tuple(args)
|
return self.format_string % tuple(args)
|
||||||
except TypeError as exc:
|
except TypeError as exc:
|
||||||
raise EntryInvalidError.from_entry(exc, entry) from exc
|
raise EntryInvalidError.from_entry(exc, entry)
|
||||||
|
|
||||||
|
|
||||||
class Find(YAMLTag):
|
class Find(YAMLTag):
|
||||||
@ -328,10 +306,7 @@ class Find(YAMLTag):
|
|||||||
else:
|
else:
|
||||||
model_name = self.model_name
|
model_name = self.model_name
|
||||||
|
|
||||||
try:
|
|
||||||
model_class = apps.get_model(*model_name.split("."))
|
model_class = apps.get_model(*model_name.split("."))
|
||||||
except LookupError as exc:
|
|
||||||
raise EntryInvalidError.from_entry(exc, entry) from exc
|
|
||||||
|
|
||||||
query = Q()
|
query = Q()
|
||||||
for cond in self.conditions:
|
for cond in self.conditions:
|
||||||
@ -391,7 +366,7 @@ class Condition(YAMLTag):
|
|||||||
comparator = self._COMPARATORS[self.mode.upper()]
|
comparator = self._COMPARATORS[self.mode.upper()]
|
||||||
return comparator(tuple(bool(x) for x in args))
|
return comparator(tuple(bool(x) for x in args))
|
||||||
except (TypeError, KeyError) as exc:
|
except (TypeError, KeyError) as exc:
|
||||||
raise EntryInvalidError.from_entry(exc, entry) from exc
|
raise EntryInvalidError.from_entry(exc, entry)
|
||||||
|
|
||||||
|
|
||||||
class If(YAMLTag):
|
class If(YAMLTag):
|
||||||
@ -423,7 +398,7 @@ class If(YAMLTag):
|
|||||||
blueprint,
|
blueprint,
|
||||||
)
|
)
|
||||||
except TypeError as exc:
|
except TypeError as exc:
|
||||||
raise EntryInvalidError.from_entry(exc, entry) from exc
|
raise EntryInvalidError.from_entry(exc, entry)
|
||||||
|
|
||||||
|
|
||||||
class Enumerate(YAMLTag, YAMLTagContext):
|
class Enumerate(YAMLTag, YAMLTagContext):
|
||||||
@ -437,7 +412,9 @@ class Enumerate(YAMLTag, YAMLTagContext):
|
|||||||
"SEQ": (list, lambda a, b: [*a, b]),
|
"SEQ": (list, lambda a, b: [*a, b]),
|
||||||
"MAP": (
|
"MAP": (
|
||||||
dict,
|
dict,
|
||||||
lambda a, b: always_merger.merge(a, {b[0]: b[1]} if isinstance(b, tuple | list) else b),
|
lambda a, b: always_merger.merge(
|
||||||
|
a, {b[0]: b[1]} if isinstance(b, (tuple, list)) else b
|
||||||
|
),
|
||||||
),
|
),
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -479,7 +456,7 @@ class Enumerate(YAMLTag, YAMLTagContext):
|
|||||||
try:
|
try:
|
||||||
output_class, add_fn = self._OUTPUT_BODIES[self.output_body.upper()]
|
output_class, add_fn = self._OUTPUT_BODIES[self.output_body.upper()]
|
||||||
except KeyError as exc:
|
except KeyError as exc:
|
||||||
raise EntryInvalidError.from_entry(exc, entry) from exc
|
raise EntryInvalidError.from_entry(exc, entry)
|
||||||
|
|
||||||
result = output_class()
|
result = output_class()
|
||||||
|
|
||||||
@ -507,13 +484,13 @@ class EnumeratedItem(YAMLTag):
|
|||||||
|
|
||||||
_SUPPORTED_CONTEXT_TAGS = (Enumerate,)
|
_SUPPORTED_CONTEXT_TAGS = (Enumerate,)
|
||||||
|
|
||||||
def __init__(self, _loader: "BlueprintLoader", node: ScalarNode) -> None:
|
def __init__(self, loader: "BlueprintLoader", node: ScalarNode) -> None:
|
||||||
super().__init__()
|
super().__init__()
|
||||||
self.depth = int(node.value)
|
self.depth = int(node.value)
|
||||||
|
|
||||||
def resolve(self, entry: BlueprintEntry, blueprint: Blueprint) -> Any:
|
def resolve(self, entry: BlueprintEntry, blueprint: Blueprint) -> Any:
|
||||||
try:
|
try:
|
||||||
context_tag: Enumerate = entry.get_tag_context(
|
context_tag: Enumerate = entry._get_tag_context(
|
||||||
depth=self.depth,
|
depth=self.depth,
|
||||||
context_tag_type=EnumeratedItem._SUPPORTED_CONTEXT_TAGS,
|
context_tag_type=EnumeratedItem._SUPPORTED_CONTEXT_TAGS,
|
||||||
)
|
)
|
||||||
@ -523,11 +500,9 @@ class EnumeratedItem(YAMLTag):
|
|||||||
f"{self.__class__.__name__} tags are only usable "
|
f"{self.__class__.__name__} tags are only usable "
|
||||||
f"inside an {Enumerate.__name__} tag",
|
f"inside an {Enumerate.__name__} tag",
|
||||||
entry,
|
entry,
|
||||||
) from exc
|
)
|
||||||
|
|
||||||
raise EntryInvalidError.from_entry(
|
raise EntryInvalidError.from_entry(f"{self.__class__.__name__} tag: {exc}", entry)
|
||||||
f"{self.__class__.__name__} tag: {exc}", entry
|
|
||||||
) from exc
|
|
||||||
|
|
||||||
return context_tag.get_context(entry, blueprint)
|
return context_tag.get_context(entry, blueprint)
|
||||||
|
|
||||||
@ -540,8 +515,8 @@ class Index(EnumeratedItem):
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
return context[0]
|
return context[0]
|
||||||
except IndexError as exc: # pragma: no cover
|
except IndexError: # pragma: no cover
|
||||||
raise EntryInvalidError.from_entry(f"Empty/invalid context: {context}", entry) from exc
|
raise EntryInvalidError.from_entry(f"Empty/invalid context: {context}", entry)
|
||||||
|
|
||||||
|
|
||||||
class Value(EnumeratedItem):
|
class Value(EnumeratedItem):
|
||||||
@ -552,8 +527,8 @@ class Value(EnumeratedItem):
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
return context[1]
|
return context[1]
|
||||||
except IndexError as exc: # pragma: no cover
|
except IndexError: # pragma: no cover
|
||||||
raise EntryInvalidError.from_entry(f"Empty/invalid context: {context}", entry) from exc
|
raise EntryInvalidError.from_entry(f"Empty/invalid context: {context}", entry)
|
||||||
|
|
||||||
|
|
||||||
class BlueprintDumper(SafeDumper):
|
class BlueprintDumper(SafeDumper):
|
||||||
@ -580,11 +555,7 @@ class BlueprintDumper(SafeDumper):
|
|||||||
|
|
||||||
def factory(items):
|
def factory(items):
|
||||||
final_dict = dict(items)
|
final_dict = dict(items)
|
||||||
# Remove internal state variables
|
|
||||||
final_dict.pop("_state", None)
|
final_dict.pop("_state", None)
|
||||||
# Future-proof to only remove the ID if we don't set a value
|
|
||||||
if "id" in final_dict and final_dict.get("id") is None:
|
|
||||||
final_dict.pop("id")
|
|
||||||
return final_dict
|
return final_dict
|
||||||
|
|
||||||
data = asdict(data, dict_factory=factory)
|
data = asdict(data, dict_factory=factory)
|
||||||
@ -611,13 +582,13 @@ class BlueprintLoader(SafeLoader):
|
|||||||
class EntryInvalidError(SentryIgnoredException):
|
class EntryInvalidError(SentryIgnoredException):
|
||||||
"""Error raised when an entry is invalid"""
|
"""Error raised when an entry is invalid"""
|
||||||
|
|
||||||
entry_model: str | None
|
entry_model: Optional[str]
|
||||||
entry_id: str | None
|
entry_id: Optional[str]
|
||||||
validation_error: ValidationError | None
|
validation_error: Optional[ValidationError]
|
||||||
serializer: Serializer | None = None
|
serializer: Optional[Serializer] = None
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self, *args: object, validation_error: ValidationError | None = None, **kwargs
|
self, *args: object, validation_error: Optional[ValidationError] = None, **kwargs
|
||||||
) -> None:
|
) -> None:
|
||||||
super().__init__(*args)
|
super().__init__(*args)
|
||||||
self.entry_model = None
|
self.entry_model = None
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
"""Blueprint exporter"""
|
"""Blueprint exporter"""
|
||||||
|
|
||||||
from collections.abc import Iterable
|
from typing import Iterable
|
||||||
from uuid import UUID
|
from uuid import UUID
|
||||||
|
|
||||||
from django.apps import apps
|
from django.apps import apps
|
||||||
@ -59,7 +59,7 @@ class Exporter:
|
|||||||
blueprint = Blueprint()
|
blueprint = Blueprint()
|
||||||
self._pre_export(blueprint)
|
self._pre_export(blueprint)
|
||||||
blueprint.metadata = BlueprintMetadata(
|
blueprint.metadata = BlueprintMetadata(
|
||||||
name=_("authentik Export - {date}".format_map({"date": str(now())})),
|
name=_("authentik Export - %(date)s" % {"date": str(now())}),
|
||||||
labels={
|
labels={
|
||||||
LABEL_AUTHENTIK_GENERATED: "true",
|
LABEL_AUTHENTIK_GENERATED: "true",
|
||||||
},
|
},
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
from contextlib import contextmanager
|
from contextlib import contextmanager
|
||||||
from copy import deepcopy
|
from copy import deepcopy
|
||||||
from typing import Any
|
from typing import Any, Optional
|
||||||
|
|
||||||
from dacite.config import Config
|
from dacite.config import Config
|
||||||
from dacite.core import from_dict
|
from dacite.core import from_dict
|
||||||
@ -16,10 +16,11 @@ from django.db.models.query_utils import Q
|
|||||||
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 guardian.models import UserObjectPermission
|
from guardian.models import UserObjectPermission
|
||||||
from guardian.shortcuts import assign_perm
|
|
||||||
from rest_framework.exceptions import ValidationError
|
from rest_framework.exceptions import ValidationError
|
||||||
from rest_framework.serializers import BaseSerializer, Serializer
|
from rest_framework.serializers import BaseSerializer, Serializer
|
||||||
from structlog.stdlib import BoundLogger, get_logger
|
from structlog.stdlib import BoundLogger, get_logger
|
||||||
|
from structlog.testing import capture_logs
|
||||||
|
from structlog.types import EventDict
|
||||||
from yaml import load
|
from yaml import load
|
||||||
|
|
||||||
from authentik.blueprints.v1.common import (
|
from authentik.blueprints.v1.common import (
|
||||||
@ -33,54 +34,35 @@ from authentik.blueprints.v1.common import (
|
|||||||
from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry
|
from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry
|
||||||
from authentik.core.models import (
|
from authentik.core.models import (
|
||||||
AuthenticatedSession,
|
AuthenticatedSession,
|
||||||
GroupSourceConnection,
|
|
||||||
PropertyMapping,
|
PropertyMapping,
|
||||||
Provider,
|
Provider,
|
||||||
Source,
|
Source,
|
||||||
User,
|
|
||||||
UserSourceConnection,
|
UserSourceConnection,
|
||||||
)
|
)
|
||||||
from authentik.enterprise.license import LicenseKey
|
from authentik.enterprise.license import LicenseKey
|
||||||
from authentik.enterprise.models import LicenseUsage
|
from authentik.enterprise.models import LicenseUsage
|
||||||
from authentik.enterprise.providers.google_workspace.models import (
|
|
||||||
GoogleWorkspaceProviderGroup,
|
|
||||||
GoogleWorkspaceProviderUser,
|
|
||||||
)
|
|
||||||
from authentik.enterprise.providers.microsoft_entra.models import (
|
|
||||||
MicrosoftEntraProviderGroup,
|
|
||||||
MicrosoftEntraProviderUser,
|
|
||||||
)
|
|
||||||
from authentik.enterprise.providers.rac.models import ConnectionToken
|
from authentik.enterprise.providers.rac.models import ConnectionToken
|
||||||
from authentik.enterprise.stages.authenticator_endpoint_gdtc.models import (
|
|
||||||
EndpointDevice,
|
|
||||||
EndpointDeviceConnection,
|
|
||||||
)
|
|
||||||
from authentik.events.logs import LogEvent, capture_logs
|
|
||||||
from authentik.events.models import SystemTask
|
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
|
||||||
from authentik.lib.sentry import SentryIgnoredException
|
from authentik.lib.sentry import SentryIgnoredException
|
||||||
from authentik.lib.utils.reflection import get_apps
|
|
||||||
from authentik.outposts.models import OutpostServiceConnection
|
from authentik.outposts.models import OutpostServiceConnection
|
||||||
from authentik.policies.models import Policy, PolicyBindingModel
|
from authentik.policies.models import Policy, PolicyBindingModel
|
||||||
from authentik.policies.reputation.models import Reputation
|
from authentik.policies.reputation.models import Reputation
|
||||||
from authentik.providers.oauth2.models import AccessToken, AuthorizationCode, RefreshToken
|
from authentik.providers.oauth2.models import AccessToken, AuthorizationCode, RefreshToken
|
||||||
from authentik.providers.scim.models import SCIMProviderGroup, SCIMProviderUser
|
from authentik.providers.scim.models import SCIMGroup, SCIMUser
|
||||||
from authentik.rbac.models import Role
|
|
||||||
from authentik.sources.scim.models import SCIMSourceGroup, SCIMSourceUser
|
|
||||||
from authentik.stages.authenticator_webauthn.models import WebAuthnDeviceType
|
|
||||||
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
|
||||||
# Update website/docs/customize/blueprints/v1/models.md when used
|
# Update website/developer-docs/blueprints/v1/models.md when used
|
||||||
SERIALIZER_CONTEXT_BLUEPRINT = "blueprint_entry"
|
SERIALIZER_CONTEXT_BLUEPRINT = "blueprint_entry"
|
||||||
|
|
||||||
|
|
||||||
def excluded_models() -> list[type[Model]]:
|
def excluded_models() -> list[type[Model]]:
|
||||||
"""Return a list of all excluded models that shouldn't be exposed via API
|
"""Return a list of all excluded models that shouldn't be exposed via API
|
||||||
or other means (internal only, base classes, non-used objects, etc)"""
|
or other means (internal only, base classes, non-used objects, etc)"""
|
||||||
|
# pylint: disable=imported-auth-user
|
||||||
from django.contrib.auth.models import Group as DjangoGroup
|
from django.contrib.auth.models import Group as DjangoGroup
|
||||||
from django.contrib.auth.models import User as DjangoUser
|
from django.contrib.auth.models import User as DjangoUser
|
||||||
|
|
||||||
@ -96,7 +78,6 @@ def excluded_models() -> list[type[Model]]:
|
|||||||
Source,
|
Source,
|
||||||
PropertyMapping,
|
PropertyMapping,
|
||||||
UserSourceConnection,
|
UserSourceConnection,
|
||||||
GroupSourceConnection,
|
|
||||||
Stage,
|
Stage,
|
||||||
OutpostServiceConnection,
|
OutpostServiceConnection,
|
||||||
Policy,
|
Policy,
|
||||||
@ -104,11 +85,10 @@ def excluded_models() -> list[type[Model]]:
|
|||||||
# Classes that have other dependencies
|
# Classes that have other dependencies
|
||||||
AuthenticatedSession,
|
AuthenticatedSession,
|
||||||
# Classes which are only internally managed
|
# Classes which are only internally managed
|
||||||
# FIXME: these shouldn't need to be explicitly listed, but rather based off of a mixin
|
|
||||||
FlowToken,
|
FlowToken,
|
||||||
LicenseUsage,
|
LicenseUsage,
|
||||||
SCIMProviderGroup,
|
SCIMGroup,
|
||||||
SCIMProviderUser,
|
SCIMUser,
|
||||||
Tenant,
|
Tenant,
|
||||||
SystemTask,
|
SystemTask,
|
||||||
ConnectionToken,
|
ConnectionToken,
|
||||||
@ -116,21 +96,12 @@ def excluded_models() -> list[type[Model]]:
|
|||||||
AccessToken,
|
AccessToken,
|
||||||
RefreshToken,
|
RefreshToken,
|
||||||
Reputation,
|
Reputation,
|
||||||
WebAuthnDeviceType,
|
|
||||||
SCIMSourceUser,
|
|
||||||
SCIMSourceGroup,
|
|
||||||
GoogleWorkspaceProviderUser,
|
|
||||||
GoogleWorkspaceProviderGroup,
|
|
||||||
MicrosoftEntraProviderUser,
|
|
||||||
MicrosoftEntraProviderGroup,
|
|
||||||
EndpointDevice,
|
|
||||||
EndpointDeviceConnection,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def is_model_allowed(model: type[Model]) -> bool:
|
def is_model_allowed(model: type[Model]) -> bool:
|
||||||
"""Check if model is allowed"""
|
"""Check if model is allowed"""
|
||||||
return model not in excluded_models() and issubclass(model, SerializerModel | BaseMetaModel)
|
return model not in excluded_models() and issubclass(model, (SerializerModel, BaseMetaModel))
|
||||||
|
|
||||||
|
|
||||||
class DoRollback(SentryIgnoredException):
|
class DoRollback(SentryIgnoredException):
|
||||||
@ -148,23 +119,13 @@ def transaction_rollback():
|
|||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
def rbac_models() -> dict:
|
|
||||||
models = {}
|
|
||||||
for app in get_apps():
|
|
||||||
for model in app.get_models():
|
|
||||||
if not is_model_allowed(model):
|
|
||||||
continue
|
|
||||||
models[model._meta.model_name] = app.label
|
|
||||||
return models
|
|
||||||
|
|
||||||
|
|
||||||
class Importer:
|
class Importer:
|
||||||
"""Import Blueprint from raw dict or YAML/JSON"""
|
"""Import Blueprint from raw dict or YAML/JSON"""
|
||||||
|
|
||||||
logger: BoundLogger
|
logger: BoundLogger
|
||||||
_import: Blueprint
|
_import: Blueprint
|
||||||
|
|
||||||
def __init__(self, blueprint: Blueprint, context: dict | None = None):
|
def __init__(self, blueprint: Blueprint, context: Optional[dict] = None):
|
||||||
self.__pk_map: dict[Any, Model] = {}
|
self.__pk_map: dict[Any, Model] = {}
|
||||||
self._import = blueprint
|
self._import = blueprint
|
||||||
self.logger = get_logger()
|
self.logger = get_logger()
|
||||||
@ -176,10 +137,7 @@ class Importer:
|
|||||||
|
|
||||||
def default_context(self):
|
def default_context(self):
|
||||||
"""Default context"""
|
"""Default context"""
|
||||||
return {
|
return {"goauthentik.io/enterprise/licensed": LicenseKey.get_total().is_valid()}
|
||||||
"goauthentik.io/enterprise/licensed": LicenseKey.get_total().status().is_valid,
|
|
||||||
"goauthentik.io/rbac/models": rbac_models(),
|
|
||||||
}
|
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def from_string(yaml_input: str, context: dict | None = None) -> "Importer":
|
def from_string(yaml_input: str, context: dict | None = None) -> "Importer":
|
||||||
@ -203,14 +161,14 @@ class Importer:
|
|||||||
|
|
||||||
def updater(value) -> Any:
|
def updater(value) -> Any:
|
||||||
if value in self.__pk_map:
|
if value in self.__pk_map:
|
||||||
self.logger.debug("Updating reference in entry", value=value)
|
self.logger.debug("updating reference in entry", value=value)
|
||||||
return self.__pk_map[value]
|
return self.__pk_map[value]
|
||||||
return value
|
return value
|
||||||
|
|
||||||
for key, value in attrs.items():
|
for key, value in attrs.items():
|
||||||
try:
|
try:
|
||||||
if isinstance(value, dict):
|
if isinstance(value, dict):
|
||||||
for _, _inner_key in enumerate(value):
|
for idx, _inner_key in enumerate(value):
|
||||||
value[_inner_key] = updater(value[_inner_key])
|
value[_inner_key] = updater(value[_inner_key])
|
||||||
elif isinstance(value, list):
|
elif isinstance(value, list):
|
||||||
for idx, _inner_value in enumerate(value):
|
for idx, _inner_value in enumerate(value):
|
||||||
@ -239,17 +197,15 @@ class Importer:
|
|||||||
|
|
||||||
return main_query | sub_query
|
return main_query | sub_query
|
||||||
|
|
||||||
def _validate_single(self, entry: BlueprintEntry) -> BaseSerializer | None: # noqa: PLR0915
|
# pylint: disable-msg=too-many-locals
|
||||||
|
def _validate_single(self, entry: BlueprintEntry) -> Optional[BaseSerializer]:
|
||||||
"""Validate a single entry"""
|
"""Validate a single entry"""
|
||||||
if not entry.check_all_conditions_match(self._import):
|
if not entry.check_all_conditions_match(self._import):
|
||||||
self.logger.debug("One or more conditions of this entry are not fulfilled, skipping")
|
self.logger.debug("One or more conditions of this entry are not fulfilled, skipping")
|
||||||
return None
|
return None
|
||||||
|
|
||||||
model_app_label, model_name = entry.get_model(self._import).split(".")
|
model_app_label, model_name = entry.get_model(self._import).split(".")
|
||||||
try:
|
|
||||||
model: type[SerializerModel] = registry.get_model(model_app_label, model_name)
|
model: type[SerializerModel] = registry.get_model(model_app_label, model_name)
|
||||||
except LookupError as exc:
|
|
||||||
raise EntryInvalidError.from_entry(exc, entry) from exc
|
|
||||||
# Don't use isinstance since we don't want to check for inheritance
|
# Don't use isinstance since we don't want to check for inheritance
|
||||||
if not is_model_allowed(model):
|
if not is_model_allowed(model):
|
||||||
raise EntryInvalidError.from_entry(f"Model {model} not allowed", entry)
|
raise EntryInvalidError.from_entry(f"Model {model} not allowed", entry)
|
||||||
@ -295,7 +251,7 @@ class Importer:
|
|||||||
model_instance = existing_models.first()
|
model_instance = existing_models.first()
|
||||||
if not isinstance(model(), BaseMetaModel) and model_instance:
|
if not isinstance(model(), BaseMetaModel) and model_instance:
|
||||||
self.logger.debug(
|
self.logger.debug(
|
||||||
"Initialise serializer with instance",
|
"initialise serializer with instance",
|
||||||
model=model,
|
model=model,
|
||||||
instance=model_instance,
|
instance=model_instance,
|
||||||
pk=model_instance.pk,
|
pk=model_instance.pk,
|
||||||
@ -305,14 +261,14 @@ class Importer:
|
|||||||
elif model_instance and entry.state == BlueprintEntryDesiredState.MUST_CREATED:
|
elif model_instance and entry.state == BlueprintEntryDesiredState.MUST_CREATED:
|
||||||
raise EntryInvalidError.from_entry(
|
raise EntryInvalidError.from_entry(
|
||||||
(
|
(
|
||||||
f"State is set to {BlueprintEntryDesiredState.MUST_CREATED} "
|
f"state is set to {BlueprintEntryDesiredState.MUST_CREATED} "
|
||||||
"and object exists already",
|
"and object exists already",
|
||||||
),
|
),
|
||||||
entry,
|
entry,
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
self.logger.debug(
|
self.logger.debug(
|
||||||
"Initialised new serializer instance",
|
"initialised new serializer instance",
|
||||||
model=model,
|
model=model,
|
||||||
**cleanse_dict(updated_identifiers),
|
**cleanse_dict(updated_identifiers),
|
||||||
)
|
)
|
||||||
@ -324,7 +280,10 @@ class Importer:
|
|||||||
try:
|
try:
|
||||||
full_data = self.__update_pks_for_attrs(entry.get_attrs(self._import))
|
full_data = self.__update_pks_for_attrs(entry.get_attrs(self._import))
|
||||||
except ValueError as exc:
|
except ValueError as exc:
|
||||||
raise EntryInvalidError.from_entry(exc, entry) from exc
|
raise EntryInvalidError.from_entry(
|
||||||
|
exc,
|
||||||
|
entry,
|
||||||
|
) from exc
|
||||||
always_merger.merge(full_data, updated_identifiers)
|
always_merger.merge(full_data, updated_identifiers)
|
||||||
serializer_kwargs["data"] = full_data
|
serializer_kwargs["data"] = full_data
|
||||||
|
|
||||||
@ -345,15 +304,6 @@ class Importer:
|
|||||||
) from exc
|
) from exc
|
||||||
return serializer
|
return serializer
|
||||||
|
|
||||||
def _apply_permissions(self, instance: Model, entry: BlueprintEntry):
|
|
||||||
"""Apply object-level permissions for an entry"""
|
|
||||||
for perm in entry.get_permissions(self._import):
|
|
||||||
if perm.user is not None:
|
|
||||||
assign_perm(perm.permission, User.objects.get(pk=perm.user), instance)
|
|
||||||
if perm.role is not None:
|
|
||||||
role = Role.objects.get(pk=perm.role)
|
|
||||||
role.assign_permission(perm.permission, obj=instance)
|
|
||||||
|
|
||||||
def apply(self) -> bool:
|
def apply(self) -> bool:
|
||||||
"""Apply (create/update) models yaml, in database transaction"""
|
"""Apply (create/update) models yaml, in database transaction"""
|
||||||
try:
|
try:
|
||||||
@ -375,7 +325,7 @@ class Importer:
|
|||||||
model: type[SerializerModel] = registry.get_model(model_app_label, model_name)
|
model: type[SerializerModel] = registry.get_model(model_app_label, model_name)
|
||||||
except LookupError:
|
except LookupError:
|
||||||
self.logger.warning(
|
self.logger.warning(
|
||||||
"App or Model does not exist", app=model_app_label, model=model_name
|
"app or model does not exist", app=model_app_label, model=model_name
|
||||||
)
|
)
|
||||||
return False
|
return False
|
||||||
# Validate each single entry
|
# Validate each single entry
|
||||||
@ -387,7 +337,7 @@ class Importer:
|
|||||||
if entry.get_state(self._import) == BlueprintEntryDesiredState.ABSENT:
|
if entry.get_state(self._import) == BlueprintEntryDesiredState.ABSENT:
|
||||||
serializer = exc.serializer
|
serializer = exc.serializer
|
||||||
else:
|
else:
|
||||||
self.logger.warning(f"Entry invalid: {exc}", entry=entry, error=exc)
|
self.logger.warning(f"entry invalid: {exc}", entry=entry, error=exc)
|
||||||
if raise_errors:
|
if raise_errors:
|
||||||
raise exc
|
raise exc
|
||||||
return False
|
return False
|
||||||
@ -407,42 +357,43 @@ class Importer:
|
|||||||
and state == BlueprintEntryDesiredState.CREATED
|
and state == BlueprintEntryDesiredState.CREATED
|
||||||
):
|
):
|
||||||
self.logger.debug(
|
self.logger.debug(
|
||||||
"Instance exists, skipping",
|
"instance exists, skipping",
|
||||||
model=model,
|
model=model,
|
||||||
instance=instance,
|
instance=instance,
|
||||||
pk=instance.pk,
|
pk=instance.pk,
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
instance = serializer.save()
|
instance = serializer.save()
|
||||||
self.logger.debug("Updated model", model=instance)
|
self.logger.debug("updated model", model=instance)
|
||||||
if "pk" in entry.identifiers:
|
if "pk" in entry.identifiers:
|
||||||
self.__pk_map[entry.identifiers["pk"]] = instance.pk
|
self.__pk_map[entry.identifiers["pk"]] = instance.pk
|
||||||
entry._state = BlueprintEntryState(instance)
|
entry._state = BlueprintEntryState(instance)
|
||||||
self._apply_permissions(instance, entry)
|
|
||||||
elif state == BlueprintEntryDesiredState.ABSENT:
|
elif state == BlueprintEntryDesiredState.ABSENT:
|
||||||
instance: Model | None = serializer.instance
|
instance: Optional[Model] = serializer.instance
|
||||||
if instance.pk:
|
if instance.pk:
|
||||||
instance.delete()
|
instance.delete()
|
||||||
self.logger.debug("Deleted model", mode=instance)
|
self.logger.debug("deleted model", mode=instance)
|
||||||
continue
|
continue
|
||||||
self.logger.debug("Entry to delete with no instance, skipping")
|
self.logger.debug("entry to delete with no instance, skipping")
|
||||||
return True
|
return True
|
||||||
|
|
||||||
def validate(self, raise_validation_errors=False) -> tuple[bool, list[LogEvent]]:
|
def validate(self, raise_validation_errors=False) -> tuple[bool, list[EventDict]]:
|
||||||
"""Validate loaded blueprint export, ensure all models are allowed
|
"""Validate loaded blueprint export, ensure all models are allowed
|
||||||
and serializers have no errors"""
|
and serializers have no errors"""
|
||||||
self.logger.debug("Starting blueprint import validation")
|
self.logger.debug("Starting blueprint import validation")
|
||||||
orig_import = deepcopy(self._import)
|
orig_import = deepcopy(self._import)
|
||||||
if self._import.version != 1:
|
if self._import.version != 1:
|
||||||
self.logger.warning("Invalid blueprint version")
|
self.logger.warning("Invalid blueprint version")
|
||||||
return False, [LogEvent("Invalid blueprint version", log_level="warning", logger=None)]
|
return False, [{"event": "Invalid blueprint version"}]
|
||||||
with (
|
with (
|
||||||
transaction_rollback(),
|
transaction_rollback(),
|
||||||
capture_logs() as logs,
|
capture_logs() as logs,
|
||||||
):
|
):
|
||||||
successful = self._apply_models(raise_errors=raise_validation_errors)
|
successful = self._apply_models(raise_errors=raise_validation_errors)
|
||||||
if not successful:
|
if not successful:
|
||||||
self.logger.warning("Blueprint validation failed")
|
self.logger.debug("Blueprint validation failed")
|
||||||
|
for log in logs:
|
||||||
|
getattr(self.logger, log.get("log_level"))(**log)
|
||||||
self.logger.debug("Finished blueprint import validation")
|
self.logger.debug("Finished blueprint import validation")
|
||||||
self._import = orig_import
|
self._import = orig_import
|
||||||
return successful, logs
|
return successful, logs
|
||||||
|
@ -43,7 +43,7 @@ class ApplyBlueprintMetaSerializer(PassiveSerializer):
|
|||||||
LOGGER.info("Blueprint does not exist, but not required")
|
LOGGER.info("Blueprint does not exist, but not required")
|
||||||
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)
|
||||||
|
# pylint: disable=no-value-for-parameter
|
||||||
apply_blueprint(str(self.blueprint_instance.pk))
|
apply_blueprint(str(self.blueprint_instance.pk))
|
||||||
return MetaResult()
|
return MetaResult()
|
||||||
|
|
||||||
|
@ -8,15 +8,15 @@ from rest_framework.serializers import Serializer
|
|||||||
class BaseMetaModel(Model):
|
class BaseMetaModel(Model):
|
||||||
"""Base models"""
|
"""Base models"""
|
||||||
|
|
||||||
class Meta:
|
|
||||||
abstract = True
|
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def serializer() -> Serializer:
|
def serializer() -> Serializer:
|
||||||
"""Serializer similar to SerializerModel, but as a static method since
|
"""Serializer similar to SerializerModel, but as a static method since
|
||||||
this is an abstract model"""
|
this is an abstract model"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
|
class Meta:
|
||||||
|
abstract = True
|
||||||
|
|
||||||
|
|
||||||
class MetaResult:
|
class MetaResult:
|
||||||
"""Result returned by Meta Models' serializers. Empty class but we can't return none as
|
"""Result returned by Meta Models' serializers. Empty class but we can't return none as
|
||||||
|
@ -4,6 +4,7 @@ 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 typing import Optional
|
||||||
|
|
||||||
from dacite.core import from_dict
|
from dacite.core import from_dict
|
||||||
from django.db import DatabaseError, InternalError, ProgrammingError
|
from django.db import DatabaseError, InternalError, ProgrammingError
|
||||||
@ -30,7 +31,6 @@ from authentik.blueprints.v1.common import BlueprintLoader, BlueprintMetadata, E
|
|||||||
from authentik.blueprints.v1.importer import Importer
|
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.models import TaskStatus
|
from authentik.events.models import TaskStatus
|
||||||
from authentik.events.system_tasks import SystemTask, prefill_task
|
from authentik.events.system_tasks import SystemTask, prefill_task
|
||||||
from authentik.events.utils import sanitize_dict
|
from authentik.events.utils import sanitize_dict
|
||||||
@ -50,14 +50,14 @@ class BlueprintFile:
|
|||||||
version: int
|
version: int
|
||||||
hash: str
|
hash: str
|
||||||
last_m: int
|
last_m: int
|
||||||
meta: BlueprintMetadata | None = field(default=None)
|
meta: Optional[BlueprintMetadata] = field(default=None)
|
||||||
|
|
||||||
|
|
||||||
def start_blueprint_watcher():
|
def start_blueprint_watcher():
|
||||||
"""Start blueprint watcher, if it's not running already."""
|
"""Start blueprint watcher, if it's not running already."""
|
||||||
# This function might be called twice since it's called on celery startup
|
# This function might be called twice since it's called on celery startup
|
||||||
|
# pylint: disable=global-statement
|
||||||
global _file_watcher_started # noqa: PLW0603
|
global _file_watcher_started
|
||||||
if _file_watcher_started:
|
if _file_watcher_started:
|
||||||
return
|
return
|
||||||
observer = Observer()
|
observer = Observer()
|
||||||
@ -126,7 +126,7 @@ def blueprints_find() -> list[BlueprintFile]:
|
|||||||
# Check if any part in the path starts with a dot and assume a hidden file
|
# Check if any part in the path starts with a dot and assume a hidden file
|
||||||
if any(part for part in path.parts if part.startswith(".")):
|
if any(part for part in path.parts if part.startswith(".")):
|
||||||
continue
|
continue
|
||||||
with open(path, encoding="utf-8") as blueprint_file:
|
with open(path, "r", encoding="utf-8") as blueprint_file:
|
||||||
try:
|
try:
|
||||||
raw_blueprint = load(blueprint_file.read(), BlueprintLoader)
|
raw_blueprint = load(blueprint_file.read(), BlueprintLoader)
|
||||||
except YAMLError as exc:
|
except YAMLError as exc:
|
||||||
@ -150,7 +150,7 @@ def blueprints_find() -> list[BlueprintFile]:
|
|||||||
throws=(DatabaseError, ProgrammingError, InternalError), base=SystemTask, bind=True
|
throws=(DatabaseError, ProgrammingError, InternalError), base=SystemTask, bind=True
|
||||||
)
|
)
|
||||||
@prefill_task
|
@prefill_task
|
||||||
def blueprints_discovery(self: SystemTask, path: str | None = None):
|
def blueprints_discovery(self: SystemTask, path: Optional[str] = None):
|
||||||
"""Find blueprints and check if they need to be created in the database"""
|
"""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():
|
||||||
@ -197,7 +197,7 @@ def check_blueprint_v1_file(blueprint: BlueprintFile):
|
|||||||
def apply_blueprint(self: SystemTask, instance_pk: str):
|
def apply_blueprint(self: SystemTask, instance_pk: str):
|
||||||
"""Apply single blueprint"""
|
"""Apply single blueprint"""
|
||||||
self.save_on_success = False
|
self.save_on_success = False
|
||||||
instance: BlueprintInstance | None = None
|
instance: Optional[BlueprintInstance] = 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 or not instance.enabled:
|
||||||
@ -212,24 +212,23 @@ 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.set_status(TaskStatus.ERROR, *[x["event"] for x in logs])
|
||||||
return
|
return
|
||||||
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.set_status(TaskStatus.ERROR, "Failed to apply")
|
||||||
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)
|
self.set_status(TaskStatus.SUCCESSFUL)
|
||||||
except (
|
except (
|
||||||
OSError,
|
|
||||||
DatabaseError,
|
DatabaseError,
|
||||||
ProgrammingError,
|
ProgrammingError,
|
||||||
InternalError,
|
InternalError,
|
||||||
|
IOError,
|
||||||
BlueprintRetrievalFailed,
|
BlueprintRetrievalFailed,
|
||||||
EntryInvalidError,
|
EntryInvalidError,
|
||||||
) as exc:
|
) as exc:
|
||||||
|
@ -11,20 +11,21 @@ from rest_framework.filters import OrderingFilter, SearchFilter
|
|||||||
from rest_framework.permissions import AllowAny
|
from rest_framework.permissions import AllowAny
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
|
from rest_framework.serializers import ModelSerializer
|
||||||
from rest_framework.validators import UniqueValidator
|
from rest_framework.validators import UniqueValidator
|
||||||
from rest_framework.viewsets import ModelViewSet
|
from rest_framework.viewsets import ModelViewSet
|
||||||
|
|
||||||
from authentik.api.authorization import SecretKeyFilter
|
from authentik.api.authorization import SecretKeyFilter
|
||||||
from authentik.brands.models import Brand
|
from authentik.brands.models import Brand
|
||||||
from authentik.core.api.used_by import UsedByMixin
|
from authentik.core.api.used_by import UsedByMixin
|
||||||
from authentik.core.api.utils import ModelSerializer, PassiveSerializer
|
from authentik.core.api.utils import PassiveSerializer
|
||||||
from authentik.tenants.utils import get_current_tenant
|
from authentik.tenants.utils import get_current_tenant
|
||||||
|
|
||||||
|
|
||||||
class FooterLinkSerializer(PassiveSerializer):
|
class FooterLinkSerializer(PassiveSerializer):
|
||||||
"""Links returned in Config API"""
|
"""Links returned in Config API"""
|
||||||
|
|
||||||
href = CharField(read_only=True, allow_null=True)
|
href = CharField(read_only=True)
|
||||||
name = CharField(read_only=True)
|
name = CharField(read_only=True)
|
||||||
|
|
||||||
|
|
||||||
@ -55,7 +56,6 @@ class BrandSerializer(ModelSerializer):
|
|||||||
"flow_unenrollment",
|
"flow_unenrollment",
|
||||||
"flow_user_settings",
|
"flow_user_settings",
|
||||||
"flow_device_code",
|
"flow_device_code",
|
||||||
"default_application",
|
|
||||||
"web_certificate",
|
"web_certificate",
|
||||||
"attributes",
|
"attributes",
|
||||||
]
|
]
|
||||||
|
@ -9,6 +9,3 @@ class AuthentikBrandsConfig(AppConfig):
|
|||||||
name = "authentik.brands"
|
name = "authentik.brands"
|
||||||
label = "authentik_brands"
|
label = "authentik_brands"
|
||||||
verbose_name = "authentik Brands"
|
verbose_name = "authentik Brands"
|
||||||
mountpoints = {
|
|
||||||
"authentik.brands.urls_root": "",
|
|
||||||
}
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
"""Inject brand into current request"""
|
"""Inject brand into current request"""
|
||||||
|
|
||||||
from collections.abc import Callable
|
from typing import Callable
|
||||||
|
|
||||||
from django.http.request import HttpRequest
|
from django.http.request import HttpRequest
|
||||||
from django.http.response import HttpResponse
|
from django.http.response import HttpResponse
|
||||||
@ -20,7 +20,7 @@ class BrandMiddleware:
|
|||||||
def __call__(self, request: HttpRequest) -> HttpResponse:
|
def __call__(self, request: HttpRequest) -> HttpResponse:
|
||||||
if not hasattr(request, "brand"):
|
if not hasattr(request, "brand"):
|
||||||
brand = get_brand_for_request(request)
|
brand = get_brand_for_request(request)
|
||||||
request.brand = brand
|
setattr(request, "brand", brand)
|
||||||
locale = brand.default_locale
|
locale = brand.default_locale
|
||||||
if locale != "":
|
if locale != "":
|
||||||
activate(locale)
|
activate(locale)
|
||||||
|
@ -1,21 +0,0 @@
|
|||||||
# Generated by Django 5.0.4 on 2024-04-18 18:56
|
|
||||||
|
|
||||||
from django.db import migrations, models
|
|
||||||
|
|
||||||
|
|
||||||
class Migration(migrations.Migration):
|
|
||||||
|
|
||||||
dependencies = [
|
|
||||||
("authentik_brands", "0005_tenantuuid_to_branduuid"),
|
|
||||||
]
|
|
||||||
|
|
||||||
operations = [
|
|
||||||
migrations.AddIndex(
|
|
||||||
model_name="brand",
|
|
||||||
index=models.Index(fields=["domain"], name="authentik_b_domain_b9b24a_idx"),
|
|
||||||
),
|
|
||||||
migrations.AddIndex(
|
|
||||||
model_name="brand",
|
|
||||||
index=models.Index(fields=["default"], name="authentik_b_default_3ccf12_idx"),
|
|
||||||
),
|
|
||||||
]
|
|
@ -1,26 +0,0 @@
|
|||||||
# Generated by Django 5.0.6 on 2024-07-04 20:32
|
|
||||||
|
|
||||||
import django.db.models.deletion
|
|
||||||
from django.db import migrations, models
|
|
||||||
|
|
||||||
|
|
||||||
class Migration(migrations.Migration):
|
|
||||||
|
|
||||||
dependencies = [
|
|
||||||
("authentik_brands", "0006_brand_authentik_b_domain_b9b24a_idx_and_more"),
|
|
||||||
("authentik_core", "0035_alter_group_options_and_more"),
|
|
||||||
]
|
|
||||||
|
|
||||||
operations = [
|
|
||||||
migrations.AddField(
|
|
||||||
model_name="brand",
|
|
||||||
name="default_application",
|
|
||||||
field=models.ForeignKey(
|
|
||||||
default=None,
|
|
||||||
help_text="When set, external users will be redirected to this application after authenticating.",
|
|
||||||
null=True,
|
|
||||||
on_delete=django.db.models.deletion.SET_DEFAULT,
|
|
||||||
to="authentik_core.application",
|
|
||||||
),
|
|
||||||
),
|
|
||||||
]
|
|
@ -3,7 +3,6 @@
|
|||||||
from uuid import uuid4
|
from uuid import uuid4
|
||||||
|
|
||||||
from django.db import models
|
from django.db import models
|
||||||
from django.http import HttpRequest
|
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
from rest_framework.serializers import Serializer
|
from rest_framework.serializers import Serializer
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
@ -52,16 +51,6 @@ class Brand(SerializerModel):
|
|||||||
Flow, null=True, on_delete=models.SET_NULL, related_name="brand_device_code"
|
Flow, null=True, on_delete=models.SET_NULL, related_name="brand_device_code"
|
||||||
)
|
)
|
||||||
|
|
||||||
default_application = models.ForeignKey(
|
|
||||||
"authentik_core.Application",
|
|
||||||
null=True,
|
|
||||||
default=None,
|
|
||||||
on_delete=models.SET_DEFAULT,
|
|
||||||
help_text=_(
|
|
||||||
"When set, external users will be redirected to this application after authenticating."
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
web_certificate = models.ForeignKey(
|
web_certificate = models.ForeignKey(
|
||||||
CertificateKeyPair,
|
CertificateKeyPair,
|
||||||
null=True,
|
null=True,
|
||||||
@ -82,7 +71,7 @@ class Brand(SerializerModel):
|
|||||||
"""Get default locale"""
|
"""Get default locale"""
|
||||||
try:
|
try:
|
||||||
return self.attributes.get("settings", {}).get("locale", "")
|
return self.attributes.get("settings", {}).get("locale", "")
|
||||||
|
# pylint: disable=broad-except
|
||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
LOGGER.warning("Failed to get default locale", exc=exc)
|
LOGGER.warning("Failed to get default locale", exc=exc)
|
||||||
return ""
|
return ""
|
||||||
@ -95,17 +84,3 @@ class Brand(SerializerModel):
|
|||||||
class Meta:
|
class Meta:
|
||||||
verbose_name = _("Brand")
|
verbose_name = _("Brand")
|
||||||
verbose_name_plural = _("Brands")
|
verbose_name_plural = _("Brands")
|
||||||
indexes = [
|
|
||||||
models.Index(fields=["domain"]),
|
|
||||||
models.Index(fields=["default"]),
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
class WebfingerProvider(models.Model):
|
|
||||||
"""Provider which supports webfinger discovery"""
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
abstract = True
|
|
||||||
|
|
||||||
def webfinger(self, resource: str, request: HttpRequest) -> dict:
|
|
||||||
raise NotImplementedError()
|
|
||||||
|
@ -5,11 +5,7 @@ from rest_framework.test import APITestCase
|
|||||||
|
|
||||||
from authentik.brands.api import Themes
|
from authentik.brands.api import Themes
|
||||||
from authentik.brands.models import Brand
|
from authentik.brands.models import Brand
|
||||||
from authentik.core.models import Application
|
|
||||||
from authentik.core.tests.utils import create_test_admin_user, create_test_brand
|
from authentik.core.tests.utils import create_test_admin_user, create_test_brand
|
||||||
from authentik.lib.generators import generate_id
|
|
||||||
from authentik.providers.oauth2.models import OAuth2Provider
|
|
||||||
from authentik.providers.saml.models import SAMLProvider
|
|
||||||
|
|
||||||
|
|
||||||
class TestBrands(APITestCase):
|
class TestBrands(APITestCase):
|
||||||
@ -79,45 +75,3 @@ class TestBrands(APITestCase):
|
|||||||
reverse("authentik_api:brand-list"), data={"domain": "bar", "default": True}
|
reverse("authentik_api:brand-list"), data={"domain": "bar", "default": True}
|
||||||
)
|
)
|
||||||
self.assertEqual(response.status_code, 400)
|
self.assertEqual(response.status_code, 400)
|
||||||
|
|
||||||
def test_webfinger_no_app(self):
|
|
||||||
"""Test Webfinger"""
|
|
||||||
create_test_brand()
|
|
||||||
self.assertJSONEqual(
|
|
||||||
self.client.get(reverse("authentik_brands:webfinger")).content.decode(), {}
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_webfinger_not_supported(self):
|
|
||||||
"""Test Webfinger"""
|
|
||||||
brand = create_test_brand()
|
|
||||||
provider = SAMLProvider.objects.create(
|
|
||||||
name=generate_id(),
|
|
||||||
)
|
|
||||||
app = Application.objects.create(name=generate_id(), slug=generate_id(), provider=provider)
|
|
||||||
brand.default_application = app
|
|
||||||
brand.save()
|
|
||||||
self.assertJSONEqual(
|
|
||||||
self.client.get(reverse("authentik_brands:webfinger")).content.decode(), {}
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_webfinger_oidc(self):
|
|
||||||
"""Test Webfinger"""
|
|
||||||
brand = create_test_brand()
|
|
||||||
provider = OAuth2Provider.objects.create(
|
|
||||||
name=generate_id(),
|
|
||||||
)
|
|
||||||
app = Application.objects.create(name=generate_id(), slug=generate_id(), provider=provider)
|
|
||||||
brand.default_application = app
|
|
||||||
brand.save()
|
|
||||||
self.assertJSONEqual(
|
|
||||||
self.client.get(reverse("authentik_brands:webfinger")).content.decode(),
|
|
||||||
{
|
|
||||||
"links": [
|
|
||||||
{
|
|
||||||
"href": f"http://testserver/application/o/{app.slug}/",
|
|
||||||
"rel": "http://openid.net/specs/connect/1.0/issuer",
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"subject": None,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
@ -1,9 +0,0 @@
|
|||||||
"""authentik brand root URLs"""
|
|
||||||
|
|
||||||
from django.urls import path
|
|
||||||
|
|
||||||
from authentik.brands.views.webfinger import WebFingerView
|
|
||||||
|
|
||||||
urlpatterns = [
|
|
||||||
path(".well-known/webfinger", WebFingerView.as_view(), name="webfinger"),
|
|
||||||
]
|
|
@ -5,7 +5,7 @@ from typing import Any
|
|||||||
from django.db.models import F, Q
|
from django.db.models import F, Q
|
||||||
from django.db.models import Value as V
|
from django.db.models import Value as V
|
||||||
from django.http.request import HttpRequest
|
from django.http.request import HttpRequest
|
||||||
from sentry_sdk import get_current_span
|
from sentry_sdk.hub import Hub
|
||||||
|
|
||||||
from authentik import get_full_version
|
from authentik import get_full_version
|
||||||
from authentik.brands.models import Brand
|
from authentik.brands.models import Brand
|
||||||
@ -33,7 +33,7 @@ def context_processor(request: HttpRequest) -> dict[str, Any]:
|
|||||||
brand = getattr(request, "brand", DEFAULT_BRAND)
|
brand = getattr(request, "brand", DEFAULT_BRAND)
|
||||||
tenant = getattr(request, "tenant", Tenant())
|
tenant = getattr(request, "tenant", Tenant())
|
||||||
trace = ""
|
trace = ""
|
||||||
span = get_current_span()
|
span = Hub.current.scope.span
|
||||||
if span:
|
if span:
|
||||||
trace = span.to_traceparent()
|
trace = span.to_traceparent()
|
||||||
return {
|
return {
|
||||||
|
@ -1,29 +0,0 @@
|
|||||||
from typing import Any
|
|
||||||
|
|
||||||
from django.http import HttpRequest, HttpResponse, JsonResponse
|
|
||||||
from django.views import View
|
|
||||||
|
|
||||||
from authentik.brands.models import Brand, WebfingerProvider
|
|
||||||
from authentik.core.models import Application
|
|
||||||
|
|
||||||
|
|
||||||
class WebFingerView(View):
|
|
||||||
"""Webfinger endpoint"""
|
|
||||||
|
|
||||||
def get(self, request: HttpRequest) -> HttpResponse:
|
|
||||||
brand: Brand = request.brand
|
|
||||||
if not brand.default_application:
|
|
||||||
return JsonResponse({})
|
|
||||||
application: Application = brand.default_application
|
|
||||||
provider = application.get_provider()
|
|
||||||
if not provider or not isinstance(provider, WebfingerProvider):
|
|
||||||
return JsonResponse({})
|
|
||||||
webfinger_data = provider.webfinger(request.GET.get("resource"), request)
|
|
||||||
return JsonResponse(webfinger_data)
|
|
||||||
|
|
||||||
def dispatch(self, request: HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse:
|
|
||||||
response = super().dispatch(request, *args, **kwargs)
|
|
||||||
# RFC7033 spec
|
|
||||||
response["Access-Control-Allow-Origin"] = "*"
|
|
||||||
response["Content-Type"] = "application/jrd+json"
|
|
||||||
return response
|
|
@ -1,8 +1,8 @@
|
|||||||
"""Application API Views"""
|
"""Application API Views"""
|
||||||
|
|
||||||
from collections.abc import Iterator
|
|
||||||
from copy import copy
|
from copy import copy
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
|
from typing import Iterator, Optional
|
||||||
|
|
||||||
from django.core.cache import cache
|
from django.core.cache import cache
|
||||||
from django.db.models import QuerySet
|
from django.db.models import QuerySet
|
||||||
@ -17,18 +17,18 @@ from rest_framework.fields import CharField, ReadOnlyField, SerializerMethodFiel
|
|||||||
from rest_framework.parsers import MultiPartParser
|
from rest_framework.parsers import MultiPartParser
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
|
from rest_framework.serializers import ModelSerializer
|
||||||
from rest_framework.viewsets import ModelViewSet
|
from rest_framework.viewsets import ModelViewSet
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
|
from structlog.testing import capture_logs
|
||||||
|
|
||||||
from authentik.admin.api.metrics import CoordinateSerializer
|
from authentik.admin.api.metrics import CoordinateSerializer
|
||||||
from authentik.api.pagination import Pagination
|
|
||||||
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT
|
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT
|
||||||
from authentik.core.api.providers import ProviderSerializer
|
from authentik.core.api.providers import ProviderSerializer
|
||||||
from authentik.core.api.used_by import UsedByMixin
|
from authentik.core.api.used_by import UsedByMixin
|
||||||
from authentik.core.api.utils import ModelSerializer
|
|
||||||
from authentik.core.models import Application, User
|
from authentik.core.models import Application, User
|
||||||
from authentik.events.logs import LogEventSerializer, capture_logs
|
|
||||||
from authentik.events.models import EventAction
|
from authentik.events.models import EventAction
|
||||||
|
from authentik.events.utils import sanitize_dict
|
||||||
from authentik.lib.utils.file import (
|
from authentik.lib.utils.file import (
|
||||||
FilePathSerializer,
|
FilePathSerializer,
|
||||||
FileUploadSerializer,
|
FileUploadSerializer,
|
||||||
@ -37,19 +37,16 @@ from authentik.lib.utils.file import (
|
|||||||
)
|
)
|
||||||
from authentik.policies.api.exec import PolicyTestResultSerializer
|
from authentik.policies.api.exec import PolicyTestResultSerializer
|
||||||
from authentik.policies.engine import PolicyEngine
|
from authentik.policies.engine import PolicyEngine
|
||||||
from authentik.policies.types import CACHE_PREFIX, PolicyResult
|
from authentik.policies.types import PolicyResult
|
||||||
from authentik.rbac.decorators import permission_required
|
from authentik.rbac.decorators import permission_required
|
||||||
from authentik.rbac.filters import ObjectFilter
|
from authentik.rbac.filters import ObjectFilter
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
def user_app_cache_key(user_pk: str, page_number: int | None = None) -> str:
|
def user_app_cache_key(user_pk: str) -> str:
|
||||||
"""Cache key where application list for user is saved"""
|
"""Cache key where application list for user is saved"""
|
||||||
key = f"{CACHE_PREFIX}/app_access/{user_pk}"
|
return f"goauthentik.io/core/app_access/{user_pk}"
|
||||||
if page_number:
|
|
||||||
key += f"/{page_number}"
|
|
||||||
return key
|
|
||||||
|
|
||||||
|
|
||||||
class ApplicationSerializer(ModelSerializer):
|
class ApplicationSerializer(ModelSerializer):
|
||||||
@ -63,7 +60,7 @@ class ApplicationSerializer(ModelSerializer):
|
|||||||
|
|
||||||
meta_icon = ReadOnlyField(source="get_meta_icon")
|
meta_icon = ReadOnlyField(source="get_meta_icon")
|
||||||
|
|
||||||
def get_launch_url(self, app: Application) -> str | None:
|
def get_launch_url(self, app: Application) -> Optional[str]:
|
||||||
"""Allow formatting of launch URL"""
|
"""Allow formatting of launch URL"""
|
||||||
user = None
|
user = None
|
||||||
if "request" in self.context:
|
if "request" in self.context:
|
||||||
@ -103,12 +100,8 @@ class ApplicationSerializer(ModelSerializer):
|
|||||||
class ApplicationViewSet(UsedByMixin, ModelViewSet):
|
class ApplicationViewSet(UsedByMixin, ModelViewSet):
|
||||||
"""Application Viewset"""
|
"""Application Viewset"""
|
||||||
|
|
||||||
queryset = (
|
# pylint: disable=no-member
|
||||||
Application.objects.all()
|
queryset = Application.objects.all().prefetch_related("provider")
|
||||||
.with_provider()
|
|
||||||
.prefetch_related("policies")
|
|
||||||
.prefetch_related("backchannel_providers")
|
|
||||||
)
|
|
||||||
serializer_class = ApplicationSerializer
|
serializer_class = ApplicationSerializer
|
||||||
search_fields = [
|
search_fields = [
|
||||||
"name",
|
"name",
|
||||||
@ -138,7 +131,7 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet):
|
|||||||
return queryset
|
return queryset
|
||||||
|
|
||||||
def _get_allowed_applications(
|
def _get_allowed_applications(
|
||||||
self, pagined_apps: Iterator[Application], user: User | None = None
|
self, pagined_apps: Iterator[Application], user: Optional[User] = None
|
||||||
) -> list[Application]:
|
) -> list[Application]:
|
||||||
applications = []
|
applications = []
|
||||||
request = self.request._request
|
request = self.request._request
|
||||||
@ -152,15 +145,6 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet):
|
|||||||
applications.append(application)
|
applications.append(application)
|
||||||
return applications
|
return applications
|
||||||
|
|
||||||
def _filter_applications_with_launch_url(
|
|
||||||
self, pagined_apps: Iterator[Application]
|
|
||||||
) -> list[Application]:
|
|
||||||
applications = []
|
|
||||||
for app in pagined_apps:
|
|
||||||
if app.get_launch_url():
|
|
||||||
applications.append(app)
|
|
||||||
return applications
|
|
||||||
|
|
||||||
@extend_schema(
|
@extend_schema(
|
||||||
parameters=[
|
parameters=[
|
||||||
OpenApiParameter(
|
OpenApiParameter(
|
||||||
@ -185,7 +169,7 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet):
|
|||||||
try:
|
try:
|
||||||
for_user = User.objects.filter(pk=request.query_params.get("for_user")).first()
|
for_user = User.objects.filter(pk=request.query_params.get("for_user")).first()
|
||||||
except ValueError:
|
except ValueError:
|
||||||
raise ValidationError({"for_user": "for_user must be numerical"}) from None
|
raise ValidationError({"for_user": "for_user must be numerical"})
|
||||||
if not for_user:
|
if not for_user:
|
||||||
raise ValidationError({"for_user": "User not found"})
|
raise ValidationError({"for_user": "User not found"})
|
||||||
engine = PolicyEngine(application, for_user, request)
|
engine = PolicyEngine(application, for_user, request)
|
||||||
@ -199,9 +183,9 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet):
|
|||||||
if request.user.is_superuser:
|
if request.user.is_superuser:
|
||||||
log_messages = []
|
log_messages = []
|
||||||
for log in logs:
|
for log in logs:
|
||||||
if log.attributes.get("process", "") == "PolicyProcess":
|
if log.get("process", "") == "PolicyProcess":
|
||||||
continue
|
continue
|
||||||
log_messages.append(LogEventSerializer(log).data)
|
log_messages.append(sanitize_dict(log))
|
||||||
result.log_messages = log_messages
|
result.log_messages = log_messages
|
||||||
response = PolicyTestResultSerializer(result)
|
response = PolicyTestResultSerializer(result)
|
||||||
return Response(response.data)
|
return Response(response.data)
|
||||||
@ -218,11 +202,6 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet):
|
|||||||
location=OpenApiParameter.QUERY,
|
location=OpenApiParameter.QUERY,
|
||||||
type=OpenApiTypes.INT,
|
type=OpenApiTypes.INT,
|
||||||
),
|
),
|
||||||
OpenApiParameter(
|
|
||||||
name="only_with_launch_url",
|
|
||||||
location=OpenApiParameter.QUERY,
|
|
||||||
type=OpenApiTypes.BOOL,
|
|
||||||
),
|
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
def list(self, request: Request) -> Response:
|
def list(self, request: Request) -> Response:
|
||||||
@ -235,13 +214,8 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet):
|
|||||||
if superuser_full_list and request.user.is_superuser:
|
if superuser_full_list and request.user.is_superuser:
|
||||||
return super().list(request)
|
return super().list(request)
|
||||||
|
|
||||||
only_with_launch_url = str(
|
|
||||||
request.query_params.get("only_with_launch_url", "false")
|
|
||||||
).lower()
|
|
||||||
|
|
||||||
queryset = self._filter_queryset_for_list(self.get_queryset())
|
queryset = self._filter_queryset_for_list(self.get_queryset())
|
||||||
paginator: Pagination = self.paginator
|
pagined_apps = self.paginate_queryset(queryset)
|
||||||
paginated_apps = paginator.paginate_queryset(queryset, request)
|
|
||||||
|
|
||||||
if "for_user" in request.query_params:
|
if "for_user" in request.query_params:
|
||||||
try:
|
try:
|
||||||
@ -255,29 +229,23 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet):
|
|||||||
raise ValidationError({"for_user": "User not found"})
|
raise ValidationError({"for_user": "User not found"})
|
||||||
except ValueError as exc:
|
except ValueError as exc:
|
||||||
raise ValidationError from exc
|
raise ValidationError from exc
|
||||||
allowed_applications = self._get_allowed_applications(paginated_apps, user=for_user)
|
allowed_applications = self._get_allowed_applications(pagined_apps, user=for_user)
|
||||||
serializer = self.get_serializer(allowed_applications, many=True)
|
serializer = self.get_serializer(allowed_applications, many=True)
|
||||||
return self.get_paginated_response(serializer.data)
|
return self.get_paginated_response(serializer.data)
|
||||||
|
|
||||||
allowed_applications = []
|
allowed_applications = []
|
||||||
if not should_cache:
|
if not should_cache:
|
||||||
allowed_applications = self._get_allowed_applications(paginated_apps)
|
allowed_applications = self._get_allowed_applications(pagined_apps)
|
||||||
if should_cache:
|
if should_cache:
|
||||||
allowed_applications = cache.get(
|
allowed_applications = cache.get(user_app_cache_key(self.request.user.pk))
|
||||||
user_app_cache_key(self.request.user.pk, paginator.page.number)
|
|
||||||
)
|
|
||||||
if not allowed_applications:
|
if not allowed_applications:
|
||||||
LOGGER.debug("Caching allowed application list", page=paginator.page.number)
|
LOGGER.debug("Caching allowed application list")
|
||||||
allowed_applications = self._get_allowed_applications(paginated_apps)
|
allowed_applications = self._get_allowed_applications(pagined_apps)
|
||||||
cache.set(
|
cache.set(
|
||||||
user_app_cache_key(self.request.user.pk, paginator.page.number),
|
user_app_cache_key(self.request.user.pk),
|
||||||
allowed_applications,
|
allowed_applications,
|
||||||
timeout=86400,
|
timeout=86400,
|
||||||
)
|
)
|
||||||
|
|
||||||
if only_with_launch_url == "true":
|
|
||||||
allowed_applications = self._filter_applications_with_launch_url(allowed_applications)
|
|
||||||
|
|
||||||
serializer = self.get_serializer(allowed_applications, many=True)
|
serializer = self.get_serializer(allowed_applications, many=True)
|
||||||
return self.get_paginated_response(serializer.data)
|
return self.get_paginated_response(serializer.data)
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
"""AuthenticatedSessions API Viewset"""
|
"""AuthenticatedSessions API Viewset"""
|
||||||
|
|
||||||
from typing import TypedDict
|
from typing import Optional, TypedDict
|
||||||
|
|
||||||
from django_filters.rest_framework import DjangoFilterBackend
|
from django_filters.rest_framework import DjangoFilterBackend
|
||||||
from guardian.utils import get_anonymous_user
|
from guardian.utils import get_anonymous_user
|
||||||
@ -8,12 +8,12 @@ from rest_framework import mixins
|
|||||||
from rest_framework.fields import SerializerMethodField
|
from rest_framework.fields import SerializerMethodField
|
||||||
from rest_framework.filters import OrderingFilter, SearchFilter
|
from rest_framework.filters import OrderingFilter, SearchFilter
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
|
from rest_framework.serializers import ModelSerializer
|
||||||
from rest_framework.viewsets import GenericViewSet
|
from rest_framework.viewsets import GenericViewSet
|
||||||
from ua_parser import user_agent_parser
|
from ua_parser import user_agent_parser
|
||||||
|
|
||||||
from authentik.api.authorization import OwnerSuperuserPermissions
|
from authentik.api.authorization import OwnerSuperuserPermissions
|
||||||
from authentik.core.api.used_by import UsedByMixin
|
from authentik.core.api.used_by import UsedByMixin
|
||||||
from authentik.core.api.utils import ModelSerializer
|
|
||||||
from authentik.core.models import AuthenticatedSession
|
from authentik.core.models import AuthenticatedSession
|
||||||
from authentik.events.context_processors.asn import ASN_CONTEXT_PROCESSOR, ASNDict
|
from authentik.events.context_processors.asn import ASN_CONTEXT_PROCESSOR, ASNDict
|
||||||
from authentik.events.context_processors.geoip import GEOIP_CONTEXT_PROCESSOR, GeoIPDict
|
from authentik.events.context_processors.geoip import GEOIP_CONTEXT_PROCESSOR, GeoIPDict
|
||||||
@ -72,11 +72,11 @@ class AuthenticatedSessionSerializer(ModelSerializer):
|
|||||||
"""Get parsed user agent"""
|
"""Get parsed user agent"""
|
||||||
return user_agent_parser.Parse(instance.last_user_agent)
|
return user_agent_parser.Parse(instance.last_user_agent)
|
||||||
|
|
||||||
def get_geo_ip(self, instance: AuthenticatedSession) -> GeoIPDict | None: # pragma: no cover
|
def get_geo_ip(self, instance: AuthenticatedSession) -> Optional[GeoIPDict]: # pragma: no cover
|
||||||
"""Get GeoIP Data"""
|
"""Get GeoIP Data"""
|
||||||
return GEOIP_CONTEXT_PROCESSOR.city_dict(instance.last_ip)
|
return GEOIP_CONTEXT_PROCESSOR.city_dict(instance.last_ip)
|
||||||
|
|
||||||
def get_asn(self, instance: AuthenticatedSession) -> ASNDict | None: # pragma: no cover
|
def get_asn(self, instance: AuthenticatedSession) -> Optional[ASNDict]: # pragma: no cover
|
||||||
"""Get ASN Data"""
|
"""Get ASN Data"""
|
||||||
return ASN_CONTEXT_PROCESSOR.asn_dict(instance.last_ip)
|
return ASN_CONTEXT_PROCESSOR.asn_dict(instance.last_ip)
|
||||||
|
|
||||||
|
@ -2,49 +2,29 @@
|
|||||||
|
|
||||||
from drf_spectacular.types import OpenApiTypes
|
from drf_spectacular.types import OpenApiTypes
|
||||||
from drf_spectacular.utils import OpenApiParameter, extend_schema
|
from drf_spectacular.utils import OpenApiParameter, extend_schema
|
||||||
from rest_framework.fields import (
|
from rest_framework.fields import BooleanField, CharField, IntegerField, SerializerMethodField
|
||||||
BooleanField,
|
from rest_framework.permissions import IsAdminUser, IsAuthenticated
|
||||||
CharField,
|
|
||||||
DateTimeField,
|
|
||||||
SerializerMethodField,
|
|
||||||
)
|
|
||||||
from rest_framework.permissions import IsAuthenticated
|
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
from rest_framework.viewsets import ViewSet
|
from rest_framework.viewsets import ViewSet
|
||||||
|
|
||||||
from authentik.core.api.utils import MetaNameSerializer
|
from authentik.core.api.utils import MetaNameSerializer
|
||||||
from authentik.enterprise.stages.authenticator_endpoint_gdtc.models import EndpointDevice
|
|
||||||
from authentik.rbac.decorators import permission_required
|
|
||||||
from authentik.stages.authenticator import device_classes, devices_for_user
|
from authentik.stages.authenticator import device_classes, devices_for_user
|
||||||
from authentik.stages.authenticator.models import Device
|
from authentik.stages.authenticator.models import Device
|
||||||
from authentik.stages.authenticator_webauthn.models import WebAuthnDevice
|
|
||||||
|
|
||||||
|
|
||||||
class DeviceSerializer(MetaNameSerializer):
|
class DeviceSerializer(MetaNameSerializer):
|
||||||
"""Serializer for Duo authenticator devices"""
|
"""Serializer for Duo authenticator devices"""
|
||||||
|
|
||||||
pk = CharField()
|
pk = IntegerField()
|
||||||
name = CharField()
|
name = CharField()
|
||||||
type = SerializerMethodField()
|
type = SerializerMethodField()
|
||||||
confirmed = BooleanField()
|
confirmed = BooleanField()
|
||||||
created = DateTimeField(read_only=True)
|
|
||||||
last_updated = DateTimeField(read_only=True)
|
|
||||||
last_used = DateTimeField(read_only=True, allow_null=True)
|
|
||||||
extra_description = SerializerMethodField()
|
|
||||||
|
|
||||||
def get_type(self, instance: Device) -> str:
|
def get_type(self, instance: Device) -> str:
|
||||||
"""Get type of device"""
|
"""Get type of device"""
|
||||||
return instance._meta.label
|
return instance._meta.label
|
||||||
|
|
||||||
def get_extra_description(self, instance: Device) -> str:
|
|
||||||
"""Get extra description"""
|
|
||||||
if isinstance(instance, WebAuthnDevice):
|
|
||||||
return instance.device_type.description
|
|
||||||
if isinstance(instance, EndpointDevice):
|
|
||||||
return instance.data.get("deviceSignals", {}).get("deviceModel")
|
|
||||||
return ""
|
|
||||||
|
|
||||||
|
|
||||||
class DeviceViewSet(ViewSet):
|
class DeviceViewSet(ViewSet):
|
||||||
"""Viewset for authenticator devices"""
|
"""Viewset for authenticator devices"""
|
||||||
@ -63,7 +43,7 @@ class AdminDeviceViewSet(ViewSet):
|
|||||||
"""Viewset for authenticator devices"""
|
"""Viewset for authenticator devices"""
|
||||||
|
|
||||||
serializer_class = DeviceSerializer
|
serializer_class = DeviceSerializer
|
||||||
permission_classes = []
|
permission_classes = [IsAdminUser]
|
||||||
|
|
||||||
def get_devices(self, **kwargs):
|
def get_devices(self, **kwargs):
|
||||||
"""Get all devices in all child classes"""
|
"""Get all devices in all child classes"""
|
||||||
@ -81,10 +61,6 @@ class AdminDeviceViewSet(ViewSet):
|
|||||||
],
|
],
|
||||||
responses={200: DeviceSerializer(many=True)},
|
responses={200: DeviceSerializer(many=True)},
|
||||||
)
|
)
|
||||||
@permission_required(
|
|
||||||
None,
|
|
||||||
[f"{model._meta.app_label}.view_{model._meta.model_name}" for model in device_classes()],
|
|
||||||
)
|
|
||||||
def list(self, request: Request) -> Response:
|
def list(self, request: Request) -> Response:
|
||||||
"""Get all devices for current user"""
|
"""Get all devices for current user"""
|
||||||
kwargs = {}
|
kwargs = {}
|
||||||
|
@ -1,28 +1,22 @@
|
|||||||
"""Groups API Viewset"""
|
"""Groups API Viewset"""
|
||||||
|
|
||||||
from json import loads
|
from json import loads
|
||||||
|
from typing import Optional
|
||||||
|
|
||||||
from django.db.models import Prefetch
|
|
||||||
from django.http import Http404
|
from django.http import Http404
|
||||||
from django_filters.filters import CharFilter, ModelMultipleChoiceFilter
|
from django_filters.filters import CharFilter, ModelMultipleChoiceFilter
|
||||||
from django_filters.filterset import FilterSet
|
from django_filters.filterset import FilterSet
|
||||||
from drf_spectacular.utils import (
|
from drf_spectacular.utils import OpenApiResponse, extend_schema
|
||||||
OpenApiParameter,
|
|
||||||
OpenApiResponse,
|
|
||||||
extend_schema,
|
|
||||||
extend_schema_field,
|
|
||||||
)
|
|
||||||
from guardian.shortcuts import get_objects_for_user
|
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 CharField, IntegerField, SerializerMethodField
|
from rest_framework.fields import CharField, IntegerField
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
from rest_framework.serializers import ListSerializer, ValidationError
|
from rest_framework.serializers import ListSerializer, ModelSerializer, ValidationError
|
||||||
from rest_framework.validators import UniqueValidator
|
|
||||||
from rest_framework.viewsets import ModelViewSet
|
from rest_framework.viewsets import ModelViewSet
|
||||||
|
|
||||||
from authentik.core.api.used_by import UsedByMixin
|
from authentik.core.api.used_by import UsedByMixin
|
||||||
from authentik.core.api.utils import JSONDictField, ModelSerializer, PassiveSerializer
|
from authentik.core.api.utils import JSONDictField, PassiveSerializer
|
||||||
from authentik.core.models import Group, User
|
from authentik.core.models import Group, User
|
||||||
from authentik.rbac.api.roles import RoleSerializer
|
from authentik.rbac.api.roles import RoleSerializer
|
||||||
from authentik.rbac.decorators import permission_required
|
from authentik.rbac.decorators import permission_required
|
||||||
@ -52,7 +46,9 @@ class GroupSerializer(ModelSerializer):
|
|||||||
"""Group Serializer"""
|
"""Group Serializer"""
|
||||||
|
|
||||||
attributes = JSONDictField(required=False)
|
attributes = JSONDictField(required=False)
|
||||||
users_obj = SerializerMethodField(allow_null=True)
|
users_obj = ListSerializer(
|
||||||
|
child=GroupMemberSerializer(), read_only=True, source="users", required=False
|
||||||
|
)
|
||||||
roles_obj = ListSerializer(
|
roles_obj = ListSerializer(
|
||||||
child=RoleSerializer(),
|
child=RoleSerializer(),
|
||||||
read_only=True,
|
read_only=True,
|
||||||
@ -63,20 +59,7 @@ class GroupSerializer(ModelSerializer):
|
|||||||
|
|
||||||
num_pk = IntegerField(read_only=True)
|
num_pk = IntegerField(read_only=True)
|
||||||
|
|
||||||
@property
|
def validate_parent(self, parent: Optional[Group]):
|
||||||
def _should_include_users(self) -> bool:
|
|
||||||
request: Request = self.context.get("request", None)
|
|
||||||
if not request:
|
|
||||||
return True
|
|
||||||
return str(request.query_params.get("include_users", "true")).lower() == "true"
|
|
||||||
|
|
||||||
@extend_schema_field(GroupMemberSerializer(many=True))
|
|
||||||
def get_users_obj(self, instance: Group) -> list[GroupMemberSerializer] | None:
|
|
||||||
if not self._should_include_users:
|
|
||||||
return None
|
|
||||||
return GroupMemberSerializer(instance.users, many=True).data
|
|
||||||
|
|
||||||
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:
|
||||||
return parent
|
return parent
|
||||||
@ -102,10 +85,7 @@ class GroupSerializer(ModelSerializer):
|
|||||||
extra_kwargs = {
|
extra_kwargs = {
|
||||||
"users": {
|
"users": {
|
||||||
"default": list,
|
"default": list,
|
||||||
},
|
}
|
||||||
# TODO: This field isn't unique on the database which is hard to backport
|
|
||||||
# hence we just validate the uniqueness here
|
|
||||||
"name": {"validators": [UniqueValidator(Group.objects.all())]},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@ -134,7 +114,7 @@ class GroupFilter(FilterSet):
|
|||||||
try:
|
try:
|
||||||
value = loads(value)
|
value = loads(value)
|
||||||
except ValueError:
|
except ValueError:
|
||||||
raise ValidationError(detail="filter: failed to parse JSON") from None
|
raise ValidationError(detail="filter: failed to parse JSON")
|
||||||
if not isinstance(value, dict):
|
if not isinstance(value, dict):
|
||||||
raise ValidationError(detail="filter: value must be key:value mapping")
|
raise ValidationError(detail="filter: value must be key:value mapping")
|
||||||
qs = {}
|
qs = {}
|
||||||
@ -151,49 +131,23 @@ class GroupFilter(FilterSet):
|
|||||||
fields = ["name", "is_superuser", "members_by_pk", "attributes", "members_by_username"]
|
fields = ["name", "is_superuser", "members_by_pk", "attributes", "members_by_username"]
|
||||||
|
|
||||||
|
|
||||||
class GroupViewSet(UsedByMixin, ModelViewSet):
|
class UserAccountSerializer(PassiveSerializer):
|
||||||
"""Group Viewset"""
|
|
||||||
|
|
||||||
class UserAccountSerializer(PassiveSerializer):
|
|
||||||
"""Account adding/removing operations"""
|
"""Account adding/removing operations"""
|
||||||
|
|
||||||
pk = IntegerField(required=True)
|
pk = IntegerField(required=True)
|
||||||
|
|
||||||
queryset = Group.objects.none()
|
|
||||||
|
class GroupViewSet(UsedByMixin, ModelViewSet):
|
||||||
|
"""Group Viewset"""
|
||||||
|
|
||||||
|
# pylint: disable=no-member
|
||||||
|
queryset = Group.objects.all().select_related("parent").prefetch_related("users")
|
||||||
serializer_class = GroupSerializer
|
serializer_class = GroupSerializer
|
||||||
search_fields = ["name", "is_superuser"]
|
search_fields = ["name", "is_superuser"]
|
||||||
filterset_class = GroupFilter
|
filterset_class = GroupFilter
|
||||||
ordering = ["name"]
|
ordering = ["name"]
|
||||||
|
|
||||||
def get_queryset(self):
|
@permission_required(None, ["authentik_core.add_user"])
|
||||||
base_qs = Group.objects.all().select_related("parent").prefetch_related("roles")
|
|
||||||
|
|
||||||
if self.serializer_class(context={"request": self.request})._should_include_users:
|
|
||||||
base_qs = base_qs.prefetch_related("users")
|
|
||||||
else:
|
|
||||||
base_qs = base_qs.prefetch_related(
|
|
||||||
Prefetch("users", queryset=User.objects.all().only("id"))
|
|
||||||
)
|
|
||||||
|
|
||||||
return base_qs
|
|
||||||
|
|
||||||
@extend_schema(
|
|
||||||
parameters=[
|
|
||||||
OpenApiParameter("include_users", bool, default=True),
|
|
||||||
]
|
|
||||||
)
|
|
||||||
def list(self, request, *args, **kwargs):
|
|
||||||
return super().list(request, *args, **kwargs)
|
|
||||||
|
|
||||||
@extend_schema(
|
|
||||||
parameters=[
|
|
||||||
OpenApiParameter("include_users", bool, default=True),
|
|
||||||
]
|
|
||||||
)
|
|
||||||
def retrieve(self, request, *args, **kwargs):
|
|
||||||
return super().retrieve(request, *args, **kwargs)
|
|
||||||
|
|
||||||
@permission_required("authentik_core.add_user_to_group")
|
|
||||||
@extend_schema(
|
@extend_schema(
|
||||||
request=UserAccountSerializer,
|
request=UserAccountSerializer,
|
||||||
responses={
|
responses={
|
||||||
@ -201,13 +155,7 @@ class GroupViewSet(UsedByMixin, ModelViewSet):
|
|||||||
404: OpenApiResponse(description="User not found"),
|
404: OpenApiResponse(description="User not found"),
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
@action(
|
@action(detail=True, methods=["POST"], pagination_class=None, filter_backends=[])
|
||||||
detail=True,
|
|
||||||
methods=["POST"],
|
|
||||||
pagination_class=None,
|
|
||||||
filter_backends=[],
|
|
||||||
permission_classes=[],
|
|
||||||
)
|
|
||||||
def add_user(self, request: Request, pk: str) -> Response:
|
def add_user(self, request: Request, pk: str) -> Response:
|
||||||
"""Add user to group"""
|
"""Add user to group"""
|
||||||
group: Group = self.get_object()
|
group: Group = self.get_object()
|
||||||
@ -223,7 +171,7 @@ class GroupViewSet(UsedByMixin, ModelViewSet):
|
|||||||
group.users.add(user)
|
group.users.add(user)
|
||||||
return Response(status=204)
|
return Response(status=204)
|
||||||
|
|
||||||
@permission_required("authentik_core.remove_user_from_group")
|
@permission_required(None, ["authentik_core.add_user"])
|
||||||
@extend_schema(
|
@extend_schema(
|
||||||
request=UserAccountSerializer,
|
request=UserAccountSerializer,
|
||||||
responses={
|
responses={
|
||||||
@ -231,13 +179,7 @@ class GroupViewSet(UsedByMixin, ModelViewSet):
|
|||||||
404: OpenApiResponse(description="User not found"),
|
404: OpenApiResponse(description="User not found"),
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
@action(
|
@action(detail=True, methods=["POST"], pagination_class=None, filter_backends=[])
|
||||||
detail=True,
|
|
||||||
methods=["POST"],
|
|
||||||
pagination_class=None,
|
|
||||||
filter_backends=[],
|
|
||||||
permission_classes=[],
|
|
||||||
)
|
|
||||||
def remove_user(self, request: Request, pk: str) -> Response:
|
def remove_user(self, request: Request, pk: str) -> Response:
|
||||||
"""Add user to group"""
|
"""Add user to group"""
|
||||||
group: Group = self.get_object()
|
group: Group = self.get_object()
|
||||||
|
@ -1,79 +0,0 @@
|
|||||||
"""API Utilities"""
|
|
||||||
|
|
||||||
from drf_spectacular.utils import extend_schema
|
|
||||||
from rest_framework.decorators import action
|
|
||||||
from rest_framework.fields import (
|
|
||||||
BooleanField,
|
|
||||||
CharField,
|
|
||||||
)
|
|
||||||
from rest_framework.request import Request
|
|
||||||
from rest_framework.response import Response
|
|
||||||
|
|
||||||
from authentik.core.api.utils import PassiveSerializer
|
|
||||||
from authentik.enterprise.apps import EnterpriseConfig
|
|
||||||
from authentik.lib.utils.reflection import all_subclasses
|
|
||||||
|
|
||||||
|
|
||||||
class TypeCreateSerializer(PassiveSerializer):
|
|
||||||
"""Types of an object that can be created"""
|
|
||||||
|
|
||||||
name = CharField(required=True)
|
|
||||||
description = CharField(required=True)
|
|
||||||
component = CharField(required=True)
|
|
||||||
model_name = CharField(required=True)
|
|
||||||
|
|
||||||
icon_url = CharField(required=False)
|
|
||||||
requires_enterprise = BooleanField(default=False)
|
|
||||||
|
|
||||||
|
|
||||||
class CreatableType:
|
|
||||||
"""Class to inherit from to mark a model as creatable, even if the model itself is marked
|
|
||||||
as abstract"""
|
|
||||||
|
|
||||||
|
|
||||||
class NonCreatableType:
|
|
||||||
"""Class to inherit from to mark a model as non-creatable even if it is not abstract"""
|
|
||||||
|
|
||||||
|
|
||||||
class TypesMixin:
|
|
||||||
"""Mixin which adds an API endpoint to list all possible types that can be created"""
|
|
||||||
|
|
||||||
@extend_schema(responses={200: TypeCreateSerializer(many=True)})
|
|
||||||
@action(detail=False, pagination_class=None, filter_backends=[])
|
|
||||||
def types(self, request: Request, additional: list[dict] | None = None) -> Response:
|
|
||||||
"""Get all creatable types"""
|
|
||||||
data = []
|
|
||||||
for subclass in all_subclasses(self.queryset.model):
|
|
||||||
instance = None
|
|
||||||
if subclass._meta.abstract:
|
|
||||||
if not issubclass(subclass, CreatableType):
|
|
||||||
continue
|
|
||||||
# Circumvent the django protection for not being able to instantiate
|
|
||||||
# abstract models. We need a model instance to access .component
|
|
||||||
# and further down .icon_url
|
|
||||||
instance = subclass.__new__(subclass)
|
|
||||||
# Django re-sets abstract = False so we need to override that
|
|
||||||
instance.Meta.abstract = True
|
|
||||||
else:
|
|
||||||
if issubclass(subclass, NonCreatableType):
|
|
||||||
continue
|
|
||||||
instance = subclass()
|
|
||||||
try:
|
|
||||||
data.append(
|
|
||||||
{
|
|
||||||
"name": subclass._meta.verbose_name,
|
|
||||||
"description": subclass.__doc__,
|
|
||||||
"component": instance.component,
|
|
||||||
"model_name": subclass._meta.model_name,
|
|
||||||
"icon_url": getattr(instance, "icon_url", None),
|
|
||||||
"requires_enterprise": isinstance(
|
|
||||||
subclass._meta.app_config, EnterpriseConfig
|
|
||||||
),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
except NotImplementedError:
|
|
||||||
continue
|
|
||||||
if additional:
|
|
||||||
data.extend(additional)
|
|
||||||
data = sorted(data, key=lambda x: x["name"])
|
|
||||||
return Response(TypeCreateSerializer(data, many=True).data)
|
|
@ -2,38 +2,25 @@
|
|||||||
|
|
||||||
from json import dumps
|
from json import dumps
|
||||||
|
|
||||||
from django_filters.filters import AllValuesMultipleFilter, BooleanFilter
|
|
||||||
from django_filters.filterset import FilterSet
|
|
||||||
from drf_spectacular.types import OpenApiTypes
|
from drf_spectacular.types import OpenApiTypes
|
||||||
from drf_spectacular.utils import (
|
from drf_spectacular.utils import OpenApiParameter, OpenApiResponse, extend_schema
|
||||||
OpenApiParameter,
|
|
||||||
OpenApiResponse,
|
|
||||||
extend_schema,
|
|
||||||
extend_schema_field,
|
|
||||||
)
|
|
||||||
from guardian.shortcuts import get_objects_for_user
|
from guardian.shortcuts import get_objects_for_user
|
||||||
from rest_framework import mixins
|
from rest_framework import mixins
|
||||||
from rest_framework.decorators import action
|
from rest_framework.decorators import action
|
||||||
from rest_framework.exceptions import PermissionDenied
|
from rest_framework.exceptions import PermissionDenied
|
||||||
from rest_framework.fields import BooleanField, CharField, SerializerMethodField
|
from rest_framework.fields import BooleanField, CharField
|
||||||
from rest_framework.relations import PrimaryKeyRelatedField
|
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
|
from rest_framework.serializers import ModelSerializer, SerializerMethodField
|
||||||
from rest_framework.viewsets import GenericViewSet
|
from rest_framework.viewsets import GenericViewSet
|
||||||
|
|
||||||
from authentik.blueprints.api import ManagedSerializer
|
from authentik.blueprints.api import ManagedSerializer
|
||||||
from authentik.core.api.object_types import TypesMixin
|
|
||||||
from authentik.core.api.used_by import UsedByMixin
|
from authentik.core.api.used_by import UsedByMixin
|
||||||
from authentik.core.api.utils import (
|
from authentik.core.api.utils import MetaNameSerializer, PassiveSerializer, TypeCreateSerializer
|
||||||
MetaNameSerializer,
|
|
||||||
ModelSerializer,
|
|
||||||
PassiveSerializer,
|
|
||||||
)
|
|
||||||
from authentik.core.expression.evaluator import PropertyMappingEvaluator
|
from authentik.core.expression.evaluator import PropertyMappingEvaluator
|
||||||
from authentik.core.expression.exceptions import PropertyMappingExpressionException
|
from authentik.core.models import PropertyMapping
|
||||||
from authentik.core.models import Group, PropertyMapping, User
|
|
||||||
from authentik.events.utils import sanitize_item
|
from authentik.events.utils import sanitize_item
|
||||||
from authentik.lib.utils.errors import exception_to_string
|
from authentik.lib.utils.reflection import all_subclasses
|
||||||
from authentik.policies.api.exec import PolicyTestSerializer
|
from authentik.policies.api.exec import PolicyTestSerializer
|
||||||
from authentik.rbac.decorators import permission_required
|
from authentik.rbac.decorators import permission_required
|
||||||
|
|
||||||
@ -76,20 +63,7 @@ class PropertyMappingSerializer(ManagedSerializer, ModelSerializer, MetaNameSeri
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
class PropertyMappingFilterSet(FilterSet):
|
|
||||||
"""Filter for PropertyMapping"""
|
|
||||||
|
|
||||||
managed = extend_schema_field(OpenApiTypes.STR)(AllValuesMultipleFilter(field_name="managed"))
|
|
||||||
|
|
||||||
managed__isnull = BooleanFilter(field_name="managed", lookup_expr="isnull")
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
model = PropertyMapping
|
|
||||||
fields = ["name", "managed"]
|
|
||||||
|
|
||||||
|
|
||||||
class PropertyMappingViewSet(
|
class PropertyMappingViewSet(
|
||||||
TypesMixin,
|
|
||||||
mixins.RetrieveModelMixin,
|
mixins.RetrieveModelMixin,
|
||||||
mixins.DestroyModelMixin,
|
mixins.DestroyModelMixin,
|
||||||
UsedByMixin,
|
UsedByMixin,
|
||||||
@ -98,23 +72,37 @@ class PropertyMappingViewSet(
|
|||||||
):
|
):
|
||||||
"""PropertyMapping Viewset"""
|
"""PropertyMapping Viewset"""
|
||||||
|
|
||||||
class PropertyMappingTestSerializer(PolicyTestSerializer):
|
queryset = PropertyMapping.objects.none()
|
||||||
"""Test property mapping execution for a user/group with context"""
|
|
||||||
|
|
||||||
user = PrimaryKeyRelatedField(queryset=User.objects.all(), required=False, allow_null=True)
|
|
||||||
group = PrimaryKeyRelatedField(
|
|
||||||
queryset=Group.objects.all(), required=False, allow_null=True
|
|
||||||
)
|
|
||||||
|
|
||||||
queryset = PropertyMapping.objects.select_subclasses()
|
|
||||||
serializer_class = PropertyMappingSerializer
|
serializer_class = PropertyMappingSerializer
|
||||||
filterset_class = PropertyMappingFilterSet
|
search_fields = [
|
||||||
|
"name",
|
||||||
|
]
|
||||||
|
filterset_fields = {"managed": ["isnull"]}
|
||||||
ordering = ["name"]
|
ordering = ["name"]
|
||||||
search_fields = ["name"]
|
|
||||||
|
def get_queryset(self): # pragma: no cover
|
||||||
|
return PropertyMapping.objects.select_subclasses()
|
||||||
|
|
||||||
|
@extend_schema(responses={200: TypeCreateSerializer(many=True)})
|
||||||
|
@action(detail=False, pagination_class=None, filter_backends=[])
|
||||||
|
def types(self, request: Request) -> Response:
|
||||||
|
"""Get all creatable property-mapping types"""
|
||||||
|
data = []
|
||||||
|
for subclass in all_subclasses(self.queryset.model):
|
||||||
|
subclass: PropertyMapping
|
||||||
|
data.append(
|
||||||
|
{
|
||||||
|
"name": subclass._meta.verbose_name,
|
||||||
|
"description": subclass.__doc__,
|
||||||
|
"component": subclass().component,
|
||||||
|
"model_name": subclass._meta.model_name,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return Response(TypeCreateSerializer(data, many=True).data)
|
||||||
|
|
||||||
@permission_required("authentik_core.view_propertymapping")
|
@permission_required("authentik_core.view_propertymapping")
|
||||||
@extend_schema(
|
@extend_schema(
|
||||||
request=PropertyMappingTestSerializer(),
|
request=PolicyTestSerializer(),
|
||||||
responses={
|
responses={
|
||||||
200: PropertyMappingTestResultSerializer,
|
200: PropertyMappingTestResultSerializer,
|
||||||
400: OpenApiResponse(description="Invalid parameters"),
|
400: OpenApiResponse(description="Invalid parameters"),
|
||||||
@ -132,47 +120,34 @@ class PropertyMappingViewSet(
|
|||||||
"""Test Property Mapping"""
|
"""Test Property Mapping"""
|
||||||
_mapping: PropertyMapping = self.get_object()
|
_mapping: PropertyMapping = self.get_object()
|
||||||
# Use `get_subclass` to get correct class and correct `.evaluate` implementation
|
# Use `get_subclass` to get correct class and correct `.evaluate` implementation
|
||||||
mapping: PropertyMapping = PropertyMapping.objects.get_subclass(pk=_mapping.pk)
|
mapping = PropertyMapping.objects.get_subclass(pk=_mapping.pk)
|
||||||
# FIXME: when we separate policy mappings between ones for sources
|
# FIXME: when we separate policy mappings between ones for sources
|
||||||
# and ones for providers, we need to make the user field optional for the source mapping
|
# and ones for providers, we need to make the user field optional for the source mapping
|
||||||
test_params = self.PropertyMappingTestSerializer(data=request.data)
|
test_params = PolicyTestSerializer(data=request.data)
|
||||||
if not test_params.is_valid():
|
if not test_params.is_valid():
|
||||||
return Response(test_params.errors, status=400)
|
return Response(test_params.errors, status=400)
|
||||||
|
|
||||||
format_result = str(request.GET.get("format_result", "false")).lower() == "true"
|
format_result = str(request.GET.get("format_result", "false")).lower() == "true"
|
||||||
|
|
||||||
context: dict = test_params.validated_data.get("context", {})
|
|
||||||
context.setdefault("user", None)
|
|
||||||
|
|
||||||
if user := test_params.validated_data.get("user"):
|
|
||||||
# User permission check, only allow mapping testing for users that are readable
|
# User permission check, only allow mapping testing for users that are readable
|
||||||
users = get_objects_for_user(request.user, "authentik_core.view_user").filter(
|
users = get_objects_for_user(request.user, "authentik_core.view_user").filter(
|
||||||
pk=user.pk
|
pk=test_params.validated_data["user"].pk
|
||||||
)
|
)
|
||||||
if not users.exists():
|
if not users.exists():
|
||||||
raise PermissionDenied()
|
raise PermissionDenied()
|
||||||
context["user"] = user
|
|
||||||
if group := test_params.validated_data.get("group"):
|
|
||||||
# Group permission check, only allow mapping testing for groups that are readable
|
|
||||||
groups = get_objects_for_user(request.user, "authentik_core.view_group").filter(
|
|
||||||
pk=group.pk
|
|
||||||
)
|
|
||||||
if not groups.exists():
|
|
||||||
raise PermissionDenied()
|
|
||||||
context["group"] = group
|
|
||||||
context["request"] = self.request
|
|
||||||
|
|
||||||
response_data = {"successful": True, "result": ""}
|
response_data = {"successful": True, "result": ""}
|
||||||
try:
|
try:
|
||||||
result = mapping.evaluate(dry_run=True, **context)
|
result = mapping.evaluate(
|
||||||
|
users.first(),
|
||||||
|
self.request,
|
||||||
|
**test_params.validated_data.get("context", {}),
|
||||||
|
)
|
||||||
response_data["result"] = dumps(
|
response_data["result"] = dumps(
|
||||||
sanitize_item(result), indent=(4 if format_result else None)
|
sanitize_item(result), indent=(4 if format_result else None)
|
||||||
)
|
)
|
||||||
except PropertyMappingExpressionException as exc:
|
except Exception as exc: # pylint: disable=broad-except
|
||||||
response_data["result"] = exception_to_string(exc.exc)
|
response_data["result"] = str(exc)
|
||||||
response_data["successful"] = False
|
|
||||||
except Exception as exc:
|
|
||||||
response_data["result"] = exception_to_string(exc)
|
|
||||||
response_data["successful"] = False
|
response_data["successful"] = False
|
||||||
response = PropertyMappingTestResultSerializer(response_data)
|
response = PropertyMappingTestResultSerializer(response_data)
|
||||||
return Response(response.data)
|
return Response(response.data)
|
@ -5,14 +5,20 @@ from django.db.models.query import Q
|
|||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
from django_filters.filters import BooleanFilter
|
from django_filters.filters import BooleanFilter
|
||||||
from django_filters.filterset import FilterSet
|
from django_filters.filterset import FilterSet
|
||||||
|
from drf_spectacular.utils import extend_schema
|
||||||
from rest_framework import mixins
|
from rest_framework import mixins
|
||||||
from rest_framework.fields import ReadOnlyField, SerializerMethodField
|
from rest_framework.decorators import action
|
||||||
|
from rest_framework.fields import ReadOnlyField
|
||||||
|
from rest_framework.request import Request
|
||||||
|
from rest_framework.response import Response
|
||||||
|
from rest_framework.serializers import ModelSerializer, SerializerMethodField
|
||||||
from rest_framework.viewsets import GenericViewSet
|
from rest_framework.viewsets import GenericViewSet
|
||||||
|
|
||||||
from authentik.core.api.object_types import TypesMixin
|
|
||||||
from authentik.core.api.used_by import UsedByMixin
|
from authentik.core.api.used_by import UsedByMixin
|
||||||
from authentik.core.api.utils import MetaNameSerializer, ModelSerializer
|
from authentik.core.api.utils import MetaNameSerializer, TypeCreateSerializer
|
||||||
from authentik.core.models import Provider
|
from authentik.core.models import Provider
|
||||||
|
from authentik.enterprise.apps import EnterpriseConfig
|
||||||
|
from authentik.lib.utils.reflection import all_subclasses
|
||||||
|
|
||||||
|
|
||||||
class ProviderSerializer(ModelSerializer, MetaNameSerializer):
|
class ProviderSerializer(ModelSerializer, MetaNameSerializer):
|
||||||
@ -38,7 +44,6 @@ class ProviderSerializer(ModelSerializer, MetaNameSerializer):
|
|||||||
"name",
|
"name",
|
||||||
"authentication_flow",
|
"authentication_flow",
|
||||||
"authorization_flow",
|
"authorization_flow",
|
||||||
"invalidation_flow",
|
|
||||||
"property_mappings",
|
"property_mappings",
|
||||||
"component",
|
"component",
|
||||||
"assigned_application_slug",
|
"assigned_application_slug",
|
||||||
@ -51,7 +56,6 @@ class ProviderSerializer(ModelSerializer, MetaNameSerializer):
|
|||||||
]
|
]
|
||||||
extra_kwargs = {
|
extra_kwargs = {
|
||||||
"authorization_flow": {"required": True, "allow_null": False},
|
"authorization_flow": {"required": True, "allow_null": False},
|
||||||
"invalidation_flow": {"required": True, "allow_null": False},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@ -59,12 +63,8 @@ class ProviderFilter(FilterSet):
|
|||||||
"""Filter for providers"""
|
"""Filter for providers"""
|
||||||
|
|
||||||
application__isnull = BooleanFilter(method="filter_application__isnull")
|
application__isnull = BooleanFilter(method="filter_application__isnull")
|
||||||
backchannel = BooleanFilter(
|
backchannel_only = BooleanFilter(
|
||||||
method="filter_backchannel",
|
method="filter_backchannel_only",
|
||||||
label=_(
|
|
||||||
"When not set all providers are returned. When set to true, only backchannel "
|
|
||||||
"providers are returned. When set to false, backchannel providers are excluded"
|
|
||||||
),
|
|
||||||
)
|
)
|
||||||
|
|
||||||
def filter_application__isnull(self, queryset: QuerySet, name, value):
|
def filter_application__isnull(self, queryset: QuerySet, name, value):
|
||||||
@ -75,14 +75,12 @@ class ProviderFilter(FilterSet):
|
|||||||
| Q(application__isnull=value)
|
| Q(application__isnull=value)
|
||||||
)
|
)
|
||||||
|
|
||||||
def filter_backchannel(self, queryset: QuerySet, name, value):
|
def filter_backchannel_only(self, queryset: QuerySet, name, value):
|
||||||
"""By default all providers are returned. When set to true, only backchannel providers are
|
"""Only return backchannel providers"""
|
||||||
returned. When set to false, backchannel providers are excluded"""
|
|
||||||
return queryset.filter(is_backchannel=value)
|
return queryset.filter(is_backchannel=value)
|
||||||
|
|
||||||
|
|
||||||
class ProviderViewSet(
|
class ProviderViewSet(
|
||||||
TypesMixin,
|
|
||||||
mixins.RetrieveModelMixin,
|
mixins.RetrieveModelMixin,
|
||||||
mixins.DestroyModelMixin,
|
mixins.DestroyModelMixin,
|
||||||
UsedByMixin,
|
UsedByMixin,
|
||||||
@ -101,3 +99,31 @@ class ProviderViewSet(
|
|||||||
|
|
||||||
def get_queryset(self): # pragma: no cover
|
def get_queryset(self): # pragma: no cover
|
||||||
return Provider.objects.select_subclasses()
|
return Provider.objects.select_subclasses()
|
||||||
|
|
||||||
|
@extend_schema(responses={200: TypeCreateSerializer(many=True)})
|
||||||
|
@action(detail=False, pagination_class=None, filter_backends=[])
|
||||||
|
def types(self, request: Request) -> Response:
|
||||||
|
"""Get all creatable provider types"""
|
||||||
|
data = []
|
||||||
|
for subclass in all_subclasses(self.queryset.model):
|
||||||
|
subclass: Provider
|
||||||
|
if subclass._meta.abstract:
|
||||||
|
continue
|
||||||
|
data.append(
|
||||||
|
{
|
||||||
|
"name": subclass._meta.verbose_name,
|
||||||
|
"description": subclass.__doc__,
|
||||||
|
"component": subclass().component,
|
||||||
|
"model_name": subclass._meta.model_name,
|
||||||
|
"requires_enterprise": isinstance(subclass._meta.app_config, EnterpriseConfig),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
data.append(
|
||||||
|
{
|
||||||
|
"name": _("SAML Provider from Metadata"),
|
||||||
|
"description": _("Create a SAML Provider by importing its Metadata."),
|
||||||
|
"component": "ak-provider-saml-import-form",
|
||||||
|
"model_name": "",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return Response(TypeCreateSerializer(data, many=True).data)
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
"""Source API Views"""
|
"""Source API Views"""
|
||||||
|
|
||||||
from collections.abc import Iterable
|
from typing import Iterable
|
||||||
|
|
||||||
from django_filters.rest_framework import DjangoFilterBackend
|
from django_filters.rest_framework import DjangoFilterBackend
|
||||||
from drf_spectacular.utils import OpenApiResponse, extend_schema
|
from drf_spectacular.utils import OpenApiResponse, extend_schema
|
||||||
@ -11,15 +11,15 @@ from rest_framework.filters import OrderingFilter, SearchFilter
|
|||||||
from rest_framework.parsers import MultiPartParser
|
from rest_framework.parsers import MultiPartParser
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
|
from rest_framework.serializers import ModelSerializer
|
||||||
from rest_framework.viewsets import GenericViewSet
|
from rest_framework.viewsets import GenericViewSet
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
|
|
||||||
from authentik.api.authorization import OwnerFilter, OwnerSuperuserPermissions
|
from authentik.api.authorization import OwnerFilter, OwnerSuperuserPermissions
|
||||||
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT
|
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT
|
||||||
from authentik.core.api.object_types import TypesMixin
|
|
||||||
from authentik.core.api.used_by import UsedByMixin
|
from authentik.core.api.used_by import UsedByMixin
|
||||||
from authentik.core.api.utils import MetaNameSerializer, ModelSerializer
|
from authentik.core.api.utils import MetaNameSerializer, TypeCreateSerializer
|
||||||
from authentik.core.models import GroupSourceConnection, Source, UserSourceConnection
|
from authentik.core.models import Source, UserSourceConnection
|
||||||
from authentik.core.types import UserSettingSerializer
|
from authentik.core.types import UserSettingSerializer
|
||||||
from authentik.lib.utils.file import (
|
from authentik.lib.utils.file import (
|
||||||
FilePathSerializer,
|
FilePathSerializer,
|
||||||
@ -27,6 +27,7 @@ from authentik.lib.utils.file import (
|
|||||||
set_file,
|
set_file,
|
||||||
set_file_url,
|
set_file_url,
|
||||||
)
|
)
|
||||||
|
from authentik.lib.utils.reflection import all_subclasses
|
||||||
from authentik.policies.engine import PolicyEngine
|
from authentik.policies.engine import PolicyEngine
|
||||||
from authentik.rbac.decorators import permission_required
|
from authentik.rbac.decorators import permission_required
|
||||||
|
|
||||||
@ -60,8 +61,6 @@ class SourceSerializer(ModelSerializer, MetaNameSerializer):
|
|||||||
"enabled",
|
"enabled",
|
||||||
"authentication_flow",
|
"authentication_flow",
|
||||||
"enrollment_flow",
|
"enrollment_flow",
|
||||||
"user_property_mappings",
|
|
||||||
"group_property_mappings",
|
|
||||||
"component",
|
"component",
|
||||||
"verbose_name",
|
"verbose_name",
|
||||||
"verbose_name_plural",
|
"verbose_name_plural",
|
||||||
@ -75,7 +74,6 @@ class SourceSerializer(ModelSerializer, MetaNameSerializer):
|
|||||||
|
|
||||||
|
|
||||||
class SourceViewSet(
|
class SourceViewSet(
|
||||||
TypesMixin,
|
|
||||||
mixins.RetrieveModelMixin,
|
mixins.RetrieveModelMixin,
|
||||||
mixins.DestroyModelMixin,
|
mixins.DestroyModelMixin,
|
||||||
UsedByMixin,
|
UsedByMixin,
|
||||||
@ -134,6 +132,30 @@ class SourceViewSet(
|
|||||||
source: Source = self.get_object()
|
source: Source = self.get_object()
|
||||||
return set_file_url(request, source, "icon")
|
return set_file_url(request, source, "icon")
|
||||||
|
|
||||||
|
@extend_schema(responses={200: TypeCreateSerializer(many=True)})
|
||||||
|
@action(detail=False, pagination_class=None, filter_backends=[])
|
||||||
|
def types(self, request: Request) -> Response:
|
||||||
|
"""Get all creatable source types"""
|
||||||
|
data = []
|
||||||
|
for subclass in all_subclasses(self.queryset.model):
|
||||||
|
subclass: Source
|
||||||
|
component = ""
|
||||||
|
if len(subclass.__subclasses__()) > 0:
|
||||||
|
continue
|
||||||
|
if subclass._meta.abstract:
|
||||||
|
component = subclass.__bases__[0]().component
|
||||||
|
else:
|
||||||
|
component = subclass().component
|
||||||
|
data.append(
|
||||||
|
{
|
||||||
|
"name": subclass._meta.verbose_name,
|
||||||
|
"description": subclass.__doc__,
|
||||||
|
"component": component,
|
||||||
|
"model_name": subclass._meta.model_name,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return Response(TypeCreateSerializer(data, many=True).data)
|
||||||
|
|
||||||
@extend_schema(responses={200: UserSettingSerializer(many=True)})
|
@extend_schema(responses={200: UserSettingSerializer(many=True)})
|
||||||
@action(detail=False, pagination_class=None, filter_backends=[])
|
@action(detail=False, pagination_class=None, filter_backends=[])
|
||||||
def user_settings(self, request: Request) -> Response:
|
def user_settings(self, request: Request) -> Response:
|
||||||
@ -190,47 +212,6 @@ class UserSourceConnectionViewSet(
|
|||||||
queryset = UserSourceConnection.objects.all()
|
queryset = UserSourceConnection.objects.all()
|
||||||
serializer_class = UserSourceConnectionSerializer
|
serializer_class = UserSourceConnectionSerializer
|
||||||
permission_classes = [OwnerSuperuserPermissions]
|
permission_classes = [OwnerSuperuserPermissions]
|
||||||
filterset_fields = ["user", "source__slug"]
|
filterset_fields = ["user"]
|
||||||
search_fields = ["source__slug"]
|
|
||||||
filter_backends = [OwnerFilter, DjangoFilterBackend, OrderingFilter, SearchFilter]
|
filter_backends = [OwnerFilter, DjangoFilterBackend, OrderingFilter, SearchFilter]
|
||||||
ordering = ["source__slug", "pk"]
|
ordering = ["pk"]
|
||||||
|
|
||||||
|
|
||||||
class GroupSourceConnectionSerializer(SourceSerializer):
|
|
||||||
"""Group Source Connection Serializer"""
|
|
||||||
|
|
||||||
source = SourceSerializer(read_only=True)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
model = GroupSourceConnection
|
|
||||||
fields = [
|
|
||||||
"pk",
|
|
||||||
"group",
|
|
||||||
"source",
|
|
||||||
"identifier",
|
|
||||||
"created",
|
|
||||||
]
|
|
||||||
extra_kwargs = {
|
|
||||||
"group": {"read_only": True},
|
|
||||||
"identifier": {"read_only": True},
|
|
||||||
"created": {"read_only": True},
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
class GroupSourceConnectionViewSet(
|
|
||||||
mixins.RetrieveModelMixin,
|
|
||||||
mixins.UpdateModelMixin,
|
|
||||||
mixins.DestroyModelMixin,
|
|
||||||
UsedByMixin,
|
|
||||||
mixins.ListModelMixin,
|
|
||||||
GenericViewSet,
|
|
||||||
):
|
|
||||||
"""Group-source connection Viewset"""
|
|
||||||
|
|
||||||
queryset = GroupSourceConnection.objects.all()
|
|
||||||
serializer_class = GroupSourceConnectionSerializer
|
|
||||||
permission_classes = [OwnerSuperuserPermissions]
|
|
||||||
filterset_fields = ["group", "source__slug"]
|
|
||||||
search_fields = ["source__slug"]
|
|
||||||
filter_backends = [OwnerFilter, DjangoFilterBackend, OrderingFilter, SearchFilter]
|
|
||||||
ordering = ["source__slug", "pk"]
|
|
||||||
|
@ -2,7 +2,6 @@
|
|||||||
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from django.utils.timezone import now
|
|
||||||
from django_filters.rest_framework import DjangoFilterBackend
|
from django_filters.rest_framework import DjangoFilterBackend
|
||||||
from drf_spectacular.utils import OpenApiResponse, extend_schema, inline_serializer
|
from drf_spectacular.utils import OpenApiResponse, extend_schema, inline_serializer
|
||||||
from guardian.shortcuts import assign_perm, get_anonymous_user
|
from guardian.shortcuts import assign_perm, get_anonymous_user
|
||||||
@ -12,6 +11,7 @@ from rest_framework.fields import CharField
|
|||||||
from rest_framework.filters import OrderingFilter, SearchFilter
|
from rest_framework.filters import OrderingFilter, SearchFilter
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
|
from rest_framework.serializers import ModelSerializer
|
||||||
from rest_framework.viewsets import ModelViewSet
|
from rest_framework.viewsets import ModelViewSet
|
||||||
|
|
||||||
from authentik.api.authorization import OwnerSuperuserPermissions
|
from authentik.api.authorization import OwnerSuperuserPermissions
|
||||||
@ -19,18 +19,10 @@ from authentik.blueprints.api import ManagedSerializer
|
|||||||
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT
|
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT
|
||||||
from authentik.core.api.used_by import UsedByMixin
|
from authentik.core.api.used_by import UsedByMixin
|
||||||
from authentik.core.api.users import UserSerializer
|
from authentik.core.api.users import UserSerializer
|
||||||
from authentik.core.api.utils import ModelSerializer, PassiveSerializer
|
from authentik.core.api.utils import PassiveSerializer
|
||||||
from authentik.core.models import (
|
from authentik.core.models import USER_ATTRIBUTE_TOKEN_EXPIRING, Token, TokenIntents, User
|
||||||
USER_ATTRIBUTE_TOKEN_EXPIRING,
|
|
||||||
USER_ATTRIBUTE_TOKEN_MAXIMUM_LIFETIME,
|
|
||||||
Token,
|
|
||||||
TokenIntents,
|
|
||||||
User,
|
|
||||||
default_token_duration,
|
|
||||||
)
|
|
||||||
from authentik.events.models import Event, EventAction
|
from authentik.events.models import Event, EventAction
|
||||||
from authentik.events.utils import model_to_dict
|
from authentik.events.utils import model_to_dict
|
||||||
from authentik.lib.utils.time import timedelta_from_string
|
|
||||||
from authentik.rbac.decorators import permission_required
|
from authentik.rbac.decorators import permission_required
|
||||||
|
|
||||||
|
|
||||||
@ -64,32 +56,6 @@ class TokenSerializer(ManagedSerializer, ModelSerializer):
|
|||||||
attrs.setdefault("intent", TokenIntents.INTENT_API)
|
attrs.setdefault("intent", TokenIntents.INTENT_API)
|
||||||
if attrs.get("intent") not in [TokenIntents.INTENT_API, TokenIntents.INTENT_APP_PASSWORD]:
|
if attrs.get("intent") not in [TokenIntents.INTENT_API, TokenIntents.INTENT_APP_PASSWORD]:
|
||||||
raise ValidationError({"intent": f"Invalid intent {attrs.get('intent')}"})
|
raise ValidationError({"intent": f"Invalid intent {attrs.get('intent')}"})
|
||||||
|
|
||||||
if attrs.get("intent") == TokenIntents.INTENT_APP_PASSWORD:
|
|
||||||
# user IS in attrs
|
|
||||||
user: User = attrs.get("user")
|
|
||||||
max_token_lifetime = user.group_attributes(request).get(
|
|
||||||
USER_ATTRIBUTE_TOKEN_MAXIMUM_LIFETIME,
|
|
||||||
)
|
|
||||||
max_token_lifetime_dt = default_token_duration()
|
|
||||||
if max_token_lifetime is not None:
|
|
||||||
try:
|
|
||||||
max_token_lifetime_dt = now() + timedelta_from_string(max_token_lifetime)
|
|
||||||
except ValueError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
if "expires" in attrs and attrs.get("expires") > max_token_lifetime_dt:
|
|
||||||
raise ValidationError(
|
|
||||||
{
|
|
||||||
"expires": (
|
|
||||||
f"Token expires exceeds maximum lifetime ({max_token_lifetime_dt} UTC)."
|
|
||||||
)
|
|
||||||
}
|
|
||||||
)
|
|
||||||
elif attrs.get("intent") == TokenIntents.INTENT_API:
|
|
||||||
# For API tokens, expires cannot be overridden
|
|
||||||
attrs["expires"] = default_token_duration()
|
|
||||||
|
|
||||||
return attrs
|
return attrs
|
||||||
|
|
||||||
class Meta:
|
class Meta:
|
||||||
|
@ -65,7 +65,7 @@ class TransactionApplicationSerializer(PassiveSerializer):
|
|||||||
raise ValidationError("Invalid provider model")
|
raise ValidationError("Invalid provider model")
|
||||||
self._provider_model = model
|
self._provider_model = model
|
||||||
except LookupError:
|
except LookupError:
|
||||||
raise ValidationError("Invalid provider model") from None
|
raise ValidationError("Invalid provider model")
|
||||||
return fq_model_name
|
return fq_model_name
|
||||||
|
|
||||||
def validate(self, attrs: dict) -> dict:
|
def validate(self, attrs: dict) -> dict:
|
||||||
@ -106,7 +106,7 @@ class TransactionApplicationSerializer(PassiveSerializer):
|
|||||||
{
|
{
|
||||||
exc.entry_id: exc.validation_error.detail,
|
exc.entry_id: exc.validation_error.detail,
|
||||||
}
|
}
|
||||||
) from None
|
)
|
||||||
return blueprint
|
return blueprint
|
||||||
|
|
||||||
|
|
||||||
|
@ -14,7 +14,6 @@ from rest_framework.request import Request
|
|||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
|
|
||||||
from authentik.core.api.utils import PassiveSerializer
|
from authentik.core.api.utils import PassiveSerializer
|
||||||
from authentik.rbac.filters import ObjectFilter
|
|
||||||
|
|
||||||
|
|
||||||
class DeleteAction(Enum):
|
class DeleteAction(Enum):
|
||||||
@ -40,12 +39,12 @@ def get_delete_action(manager: Manager) -> str:
|
|||||||
"""Get the delete action from the Foreign key, falls back to cascade"""
|
"""Get the delete action from the Foreign key, falls back to cascade"""
|
||||||
if hasattr(manager, "field"):
|
if hasattr(manager, "field"):
|
||||||
if manager.field.remote_field.on_delete.__name__ == SET_NULL.__name__:
|
if manager.field.remote_field.on_delete.__name__ == SET_NULL.__name__:
|
||||||
return DeleteAction.SET_NULL.value
|
return DeleteAction.SET_NULL.name
|
||||||
if manager.field.remote_field.on_delete.__name__ == SET_DEFAULT.__name__:
|
if manager.field.remote_field.on_delete.__name__ == SET_DEFAULT.__name__:
|
||||||
return DeleteAction.SET_DEFAULT.value
|
return DeleteAction.SET_DEFAULT.name
|
||||||
if hasattr(manager, "source_field"):
|
if hasattr(manager, "source_field"):
|
||||||
return DeleteAction.CASCADE_MANY.value
|
return DeleteAction.CASCADE_MANY.name
|
||||||
return DeleteAction.CASCADE.value
|
return DeleteAction.CASCADE.name
|
||||||
|
|
||||||
|
|
||||||
class UsedByMixin:
|
class UsedByMixin:
|
||||||
@ -54,7 +53,8 @@ class UsedByMixin:
|
|||||||
@extend_schema(
|
@extend_schema(
|
||||||
responses={200: UsedBySerializer(many=True)},
|
responses={200: UsedBySerializer(many=True)},
|
||||||
)
|
)
|
||||||
@action(detail=True, pagination_class=None, filter_backends=[ObjectFilter])
|
@action(detail=True, pagination_class=None, filter_backends=[])
|
||||||
|
# pylint: disable=too-many-locals
|
||||||
def used_by(self, request: Request, *args, **kwargs) -> Response:
|
def used_by(self, request: Request, *args, **kwargs) -> Response:
|
||||||
"""Get a list of all objects that use this object"""
|
"""Get a list of all objects that use this object"""
|
||||||
model: Model = self.get_object()
|
model: Model = self.get_object()
|
||||||
|
@ -2,10 +2,9 @@
|
|||||||
|
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
from json import loads
|
from json import loads
|
||||||
from typing import Any
|
from typing import Any, Optional
|
||||||
|
|
||||||
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.sessions.backends.cache import KEY_PREFIX
|
from django.contrib.sessions.backends.cache import KEY_PREFIX
|
||||||
from django.core.cache import cache
|
from django.core.cache import cache
|
||||||
from django.db.models.functions import ExtractHour
|
from django.db.models.functions import ExtractHour
|
||||||
@ -34,21 +33,16 @@ from drf_spectacular.utils import (
|
|||||||
)
|
)
|
||||||
from guardian.shortcuts import get_objects_for_user
|
from guardian.shortcuts import get_objects_for_user
|
||||||
from rest_framework.decorators import action
|
from rest_framework.decorators import action
|
||||||
from rest_framework.exceptions import ValidationError
|
from rest_framework.fields import CharField, IntegerField, ListField, SerializerMethodField
|
||||||
from rest_framework.fields import (
|
|
||||||
BooleanField,
|
|
||||||
CharField,
|
|
||||||
ChoiceField,
|
|
||||||
DateTimeField,
|
|
||||||
IntegerField,
|
|
||||||
ListField,
|
|
||||||
SerializerMethodField,
|
|
||||||
)
|
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
from rest_framework.serializers import (
|
from rest_framework.serializers import (
|
||||||
|
BooleanField,
|
||||||
|
DateTimeField,
|
||||||
ListSerializer,
|
ListSerializer,
|
||||||
|
ModelSerializer,
|
||||||
PrimaryKeyRelatedField,
|
PrimaryKeyRelatedField,
|
||||||
|
ValidationError,
|
||||||
)
|
)
|
||||||
from rest_framework.validators import UniqueValidator
|
from rest_framework.validators import UniqueValidator
|
||||||
from rest_framework.viewsets import ModelViewSet
|
from rest_framework.viewsets import ModelViewSet
|
||||||
@ -58,12 +52,7 @@ from authentik.admin.api.metrics import CoordinateSerializer
|
|||||||
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT
|
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT
|
||||||
from authentik.brands.models import Brand
|
from authentik.brands.models import Brand
|
||||||
from authentik.core.api.used_by import UsedByMixin
|
from authentik.core.api.used_by import UsedByMixin
|
||||||
from authentik.core.api.utils import (
|
from authentik.core.api.utils import JSONDictField, LinkSerializer, PassiveSerializer
|
||||||
JSONDictField,
|
|
||||||
LinkSerializer,
|
|
||||||
ModelSerializer,
|
|
||||||
PassiveSerializer,
|
|
||||||
)
|
|
||||||
from authentik.core.middleware import (
|
from authentik.core.middleware import (
|
||||||
SESSION_KEY_IMPERSONATE_ORIGINAL_USER,
|
SESSION_KEY_IMPERSONATE_ORIGINAL_USER,
|
||||||
SESSION_KEY_IMPERSONATE_USER,
|
SESSION_KEY_IMPERSONATE_USER,
|
||||||
@ -85,7 +74,6 @@ from authentik.flows.planner import PLAN_CONTEXT_PENDING_USER, FlowPlanner
|
|||||||
from authentik.flows.views.executor import QS_KEY_TOKEN
|
from authentik.flows.views.executor import QS_KEY_TOKEN
|
||||||
from authentik.lib.avatars import get_avatar
|
from authentik.lib.avatars import get_avatar
|
||||||
from authentik.rbac.decorators import permission_required
|
from authentik.rbac.decorators import permission_required
|
||||||
from authentik.rbac.models import get_permission_choices
|
|
||||||
from authentik.stages.email.models import EmailStage
|
from authentik.stages.email.models import EmailStage
|
||||||
from authentik.stages.email.tasks import send_mails
|
from authentik.stages.email.tasks import send_mails
|
||||||
from authentik.stages.email.utils import TemplateEmailMessage
|
from authentik.stages.email.utils import TemplateEmailMessage
|
||||||
@ -97,7 +85,7 @@ class UserGroupSerializer(ModelSerializer):
|
|||||||
"""Simplified Group Serializer for user's groups"""
|
"""Simplified Group Serializer for user's groups"""
|
||||||
|
|
||||||
attributes = JSONDictField(required=False)
|
attributes = JSONDictField(required=False)
|
||||||
parent_name = CharField(source="parent.name", read_only=True, allow_null=True)
|
parent_name = CharField(source="parent.name", read_only=True)
|
||||||
|
|
||||||
class Meta:
|
class Meta:
|
||||||
model = Group
|
model = Group
|
||||||
@ -125,43 +113,23 @@ class UserSerializer(ModelSerializer):
|
|||||||
queryset=Group.objects.all().order_by("name"),
|
queryset=Group.objects.all().order_by("name"),
|
||||||
default=list,
|
default=list,
|
||||||
)
|
)
|
||||||
groups_obj = SerializerMethodField(allow_null=True)
|
groups_obj = ListSerializer(child=UserGroupSerializer(), read_only=True, source="ak_groups")
|
||||||
uid = CharField(read_only=True)
|
uid = CharField(read_only=True)
|
||||||
username = CharField(
|
username = CharField(
|
||||||
max_length=150,
|
max_length=150,
|
||||||
validators=[UniqueValidator(queryset=User.objects.all().order_by("username"))],
|
validators=[UniqueValidator(queryset=User.objects.all().order_by("username"))],
|
||||||
)
|
)
|
||||||
|
|
||||||
@property
|
|
||||||
def _should_include_groups(self) -> bool:
|
|
||||||
request: Request = self.context.get("request", None)
|
|
||||||
if not request:
|
|
||||||
return True
|
|
||||||
return str(request.query_params.get("include_groups", "true")).lower() == "true"
|
|
||||||
|
|
||||||
@extend_schema_field(UserGroupSerializer(many=True))
|
|
||||||
def get_groups_obj(self, instance: User) -> list[UserGroupSerializer] | None:
|
|
||||||
if not self._should_include_groups:
|
|
||||||
return None
|
|
||||||
return UserGroupSerializer(instance.ak_groups, many=True).data
|
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
def __init__(self, *args, **kwargs):
|
||||||
super().__init__(*args, **kwargs)
|
super().__init__(*args, **kwargs)
|
||||||
if SERIALIZER_CONTEXT_BLUEPRINT in self.context:
|
if SERIALIZER_CONTEXT_BLUEPRINT in self.context:
|
||||||
self.fields["password"] = CharField(required=False, allow_null=True)
|
self.fields["password"] = CharField(required=False, allow_null=True)
|
||||||
self.fields["permissions"] = ListField(
|
|
||||||
required=False, child=ChoiceField(choices=get_permission_choices())
|
|
||||||
)
|
|
||||||
|
|
||||||
def create(self, validated_data: dict) -> User:
|
def create(self, validated_data: dict) -> User:
|
||||||
"""If this serializer is used in the blueprint context, we allow for
|
"""If this serializer is used in the blueprint context, we allow for
|
||||||
directly setting a password. However should be done via the `set_password`
|
directly setting a password. However should be done via the `set_password`
|
||||||
method instead of directly setting it like rest_framework."""
|
method instead of directly setting it like rest_framework."""
|
||||||
password = validated_data.pop("password", None)
|
password = validated_data.pop("password", None)
|
||||||
permissions = Permission.objects.filter(
|
|
||||||
codename__in=[x.split(".")[1] for x in validated_data.pop("permissions", [])]
|
|
||||||
)
|
|
||||||
validated_data["user_permissions"] = permissions
|
|
||||||
instance: User = super().create(validated_data)
|
instance: User = super().create(validated_data)
|
||||||
self._set_password(instance, password)
|
self._set_password(instance, password)
|
||||||
return instance
|
return instance
|
||||||
@ -170,15 +138,11 @@ class UserSerializer(ModelSerializer):
|
|||||||
"""Same as `create` above, set the password directly if we're in a blueprint
|
"""Same as `create` above, set the password directly if we're in a blueprint
|
||||||
context"""
|
context"""
|
||||||
password = validated_data.pop("password", None)
|
password = validated_data.pop("password", None)
|
||||||
permissions = Permission.objects.filter(
|
|
||||||
codename__in=[x.split(".")[1] for x in validated_data.pop("permissions", [])]
|
|
||||||
)
|
|
||||||
validated_data["user_permissions"] = permissions
|
|
||||||
instance = super().update(instance, validated_data)
|
instance = super().update(instance, validated_data)
|
||||||
self._set_password(instance, password)
|
self._set_password(instance, password)
|
||||||
return instance
|
return instance
|
||||||
|
|
||||||
def _set_password(self, instance: User, password: str | None):
|
def _set_password(self, instance: User, password: Optional[str]):
|
||||||
"""Set password of user if we're in a blueprint context, and if it's an empty
|
"""Set password of user if we're in a blueprint context, and if it's an empty
|
||||||
string then use an unusable password"""
|
string then use an unusable password"""
|
||||||
if SERIALIZER_CONTEXT_BLUEPRINT in self.context and password:
|
if SERIALIZER_CONTEXT_BLUEPRINT in self.context and password:
|
||||||
@ -394,7 +358,7 @@ class UsersFilter(FilterSet):
|
|||||||
try:
|
try:
|
||||||
value = loads(value)
|
value = loads(value)
|
||||||
except ValueError:
|
except ValueError:
|
||||||
raise ValidationError(detail="filter: failed to parse JSON") from None
|
raise ValidationError(detail="filter: failed to parse JSON")
|
||||||
if not isinstance(value, dict):
|
if not isinstance(value, dict):
|
||||||
raise ValidationError(detail="filter: value must be key:value mapping")
|
raise ValidationError(detail="filter: value must be key:value mapping")
|
||||||
qs = {}
|
qs = {}
|
||||||
@ -430,28 +394,18 @@ class UserViewSet(UsedByMixin, ModelViewSet):
|
|||||||
search_fields = ["username", "name", "is_active", "email", "uuid"]
|
search_fields = ["username", "name", "is_active", "email", "uuid"]
|
||||||
filterset_class = UsersFilter
|
filterset_class = UsersFilter
|
||||||
|
|
||||||
def get_queryset(self):
|
def get_queryset(self): # pragma: no cover
|
||||||
base_qs = User.objects.all().exclude_anonymous()
|
return User.objects.all().exclude_anonymous().prefetch_related("ak_groups")
|
||||||
if self.serializer_class(context={"request": self.request})._should_include_groups:
|
|
||||||
base_qs = base_qs.prefetch_related("ak_groups")
|
|
||||||
return base_qs
|
|
||||||
|
|
||||||
@extend_schema(
|
def _create_recovery_link(self) -> tuple[Optional[str], Optional[Token]]:
|
||||||
parameters=[
|
|
||||||
OpenApiParameter("include_groups", bool, default=True),
|
|
||||||
]
|
|
||||||
)
|
|
||||||
def list(self, request, *args, **kwargs):
|
|
||||||
return super().list(request, *args, **kwargs)
|
|
||||||
|
|
||||||
def _create_recovery_link(self) -> tuple[str, Token]:
|
|
||||||
"""Create a recovery link (when the current brand has a recovery flow set),
|
"""Create a recovery link (when the current brand has a recovery flow set),
|
||||||
that can either be shown to an admin or sent to the user directly"""
|
that can either be shown to an admin or sent to the user directly"""
|
||||||
brand: Brand = self.request._request.brand
|
brand: Brand = self.request._request.brand
|
||||||
# Check that there is a recovery flow, if not return an error
|
# Check that there is a recovery flow, if not return an error
|
||||||
flow = brand.flow_recovery
|
flow = brand.flow_recovery
|
||||||
if not flow:
|
if not flow:
|
||||||
raise ValidationError({"non_field_errors": "No recovery flow set."})
|
LOGGER.debug("No recovery flow set")
|
||||||
|
return None, None
|
||||||
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
|
||||||
@ -463,9 +417,8 @@ class UserViewSet(UsedByMixin, ModelViewSet):
|
|||||||
},
|
},
|
||||||
)
|
)
|
||||||
except FlowNonApplicableException:
|
except FlowNonApplicableException:
|
||||||
raise ValidationError(
|
LOGGER.warning("Recovery flow not applicable to user")
|
||||||
{"non_field_errors": "Recovery flow not applicable to user"}
|
return None, None
|
||||||
) from None
|
|
||||||
token, __ = FlowToken.objects.update_or_create(
|
token, __ = FlowToken.objects.update_or_create(
|
||||||
identifier=f"{user.uid}-password-reset",
|
identifier=f"{user.uid}-password-reset",
|
||||||
defaults={
|
defaults={
|
||||||
@ -610,13 +563,16 @@ class UserViewSet(UsedByMixin, ModelViewSet):
|
|||||||
@extend_schema(
|
@extend_schema(
|
||||||
responses={
|
responses={
|
||||||
"200": LinkSerializer(many=False),
|
"200": LinkSerializer(many=False),
|
||||||
|
"404": LinkSerializer(many=False),
|
||||||
},
|
},
|
||||||
request=None,
|
|
||||||
)
|
)
|
||||||
@action(detail=True, pagination_class=None, filter_backends=[], methods=["POST"])
|
@action(detail=True, pagination_class=None, filter_backends=[])
|
||||||
def recovery(self, request: Request, pk: int) -> Response:
|
def recovery(self, request: Request, pk: int) -> Response:
|
||||||
"""Create a temporary link that a user can use to recover their accounts"""
|
"""Create a temporary link that a user can use to recover their accounts"""
|
||||||
link, _ = self._create_recovery_link()
|
link, _ = self._create_recovery_link()
|
||||||
|
if not link:
|
||||||
|
LOGGER.debug("Couldn't create token")
|
||||||
|
return Response({"link": ""}, status=404)
|
||||||
return Response({"link": link})
|
return Response({"link": link})
|
||||||
|
|
||||||
@permission_required("authentik_core.reset_user_password")
|
@permission_required("authentik_core.reset_user_password")
|
||||||
@ -631,24 +587,27 @@ class UserViewSet(UsedByMixin, ModelViewSet):
|
|||||||
],
|
],
|
||||||
responses={
|
responses={
|
||||||
"204": OpenApiResponse(description="Successfully sent recover email"),
|
"204": OpenApiResponse(description="Successfully sent recover email"),
|
||||||
|
"404": OpenApiResponse(description="Bad request"),
|
||||||
},
|
},
|
||||||
request=None,
|
|
||||||
)
|
)
|
||||||
@action(detail=True, pagination_class=None, filter_backends=[], methods=["POST"])
|
@action(detail=True, pagination_class=None, filter_backends=[])
|
||||||
def recovery_email(self, request: Request, pk: int) -> Response:
|
def recovery_email(self, request: Request, pk: int) -> Response:
|
||||||
"""Create a temporary link that a user can use to recover their accounts"""
|
"""Create a temporary link that a user can use to recover their accounts"""
|
||||||
for_user: User = self.get_object()
|
for_user: User = self.get_object()
|
||||||
if for_user.email == "":
|
if for_user.email == "":
|
||||||
LOGGER.debug("User doesn't have an email address")
|
LOGGER.debug("User doesn't have an email address")
|
||||||
raise ValidationError({"non_field_errors": "User does not have an email address set."})
|
return Response(status=404)
|
||||||
link, token = self._create_recovery_link()
|
link, token = self._create_recovery_link()
|
||||||
|
if not link:
|
||||||
|
LOGGER.debug("Couldn't create token")
|
||||||
|
return Response(status=404)
|
||||||
# Lookup the email stage to assure the current user can access it
|
# Lookup the email stage to assure the current user can access it
|
||||||
stages = get_objects_for_user(
|
stages = get_objects_for_user(
|
||||||
request.user, "authentik_stages_email.view_emailstage"
|
request.user, "authentik_stages_email.view_emailstage"
|
||||||
).filter(pk=request.query_params.get("email_stage"))
|
).filter(pk=request.query_params.get("email_stage"))
|
||||||
if not stages.exists():
|
if not stages.exists():
|
||||||
LOGGER.debug("Email stage does not exist/user has no permissions")
|
LOGGER.debug("Email stage does not exist/user has no permissions")
|
||||||
raise ValidationError({"non_field_errors": "Email stage does not exist."})
|
return Response(status=404)
|
||||||
email_stage: EmailStage = stages.first()
|
email_stage: EmailStage = stages.first()
|
||||||
message = TemplateEmailMessage(
|
message = TemplateEmailMessage(
|
||||||
subject=_(email_stage.subject),
|
subject=_(email_stage.subject),
|
||||||
@ -678,13 +637,10 @@ class UserViewSet(UsedByMixin, ModelViewSet):
|
|||||||
if not request.tenant.impersonation:
|
if not request.tenant.impersonation:
|
||||||
LOGGER.debug("User attempted to impersonate", user=request.user)
|
LOGGER.debug("User attempted to impersonate", user=request.user)
|
||||||
return Response(status=401)
|
return Response(status=401)
|
||||||
user_to_be = self.get_object()
|
if not request.user.has_perm("impersonate"):
|
||||||
# Check both object-level perms and global perms
|
|
||||||
if not request.user.has_perm(
|
|
||||||
"authentik_core.impersonate", user_to_be
|
|
||||||
) and not request.user.has_perm("authentik_core.impersonate"):
|
|
||||||
LOGGER.debug("User attempted to impersonate without permissions", user=request.user)
|
LOGGER.debug("User attempted to impersonate without permissions", user=request.user)
|
||||||
return Response(status=401)
|
return Response(status=401)
|
||||||
|
user_to_be = self.get_object()
|
||||||
if user_to_be.pk == self.request.user.pk:
|
if user_to_be.pk == self.request.user.pk:
|
||||||
LOGGER.debug("User attempted to impersonate themselves", user=request.user)
|
LOGGER.debug("User attempted to impersonate themselves", user=request.user)
|
||||||
return Response(status=401)
|
return Response(status=401)
|
||||||
|
@ -6,19 +6,8 @@ from django.db.models import Model
|
|||||||
from drf_spectacular.extensions import OpenApiSerializerFieldExtension
|
from drf_spectacular.extensions import OpenApiSerializerFieldExtension
|
||||||
from drf_spectacular.plumbing import build_basic_type
|
from drf_spectacular.plumbing import build_basic_type
|
||||||
from drf_spectacular.types import OpenApiTypes
|
from drf_spectacular.types import OpenApiTypes
|
||||||
from rest_framework.fields import (
|
from rest_framework.fields import BooleanField, CharField, IntegerField, JSONField
|
||||||
CharField,
|
from rest_framework.serializers import Serializer, SerializerMethodField, ValidationError
|
||||||
IntegerField,
|
|
||||||
JSONField,
|
|
||||||
SerializerMethodField,
|
|
||||||
)
|
|
||||||
from rest_framework.serializers import ModelSerializer as BaseModelSerializer
|
|
||||||
from rest_framework.serializers import (
|
|
||||||
Serializer,
|
|
||||||
ValidationError,
|
|
||||||
model_meta,
|
|
||||||
raise_errors_on_nested_writes,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def is_dict(value: Any):
|
def is_dict(value: Any):
|
||||||
@ -28,39 +17,6 @@ def is_dict(value: Any):
|
|||||||
raise ValidationError("Value must be a dictionary, and not have any duplicate keys.")
|
raise ValidationError("Value must be a dictionary, and not have any duplicate keys.")
|
||||||
|
|
||||||
|
|
||||||
class ModelSerializer(BaseModelSerializer):
|
|
||||||
|
|
||||||
def update(self, instance: Model, validated_data):
|
|
||||||
raise_errors_on_nested_writes("update", self, validated_data)
|
|
||||||
info = model_meta.get_field_info(instance)
|
|
||||||
|
|
||||||
# Simply set each attribute on the instance, and then save it.
|
|
||||||
# Note that unlike `.create()` we don't need to treat many-to-many
|
|
||||||
# relationships as being a special case. During updates we already
|
|
||||||
# have an instance pk for the relationships to be associated with.
|
|
||||||
m2m_fields = []
|
|
||||||
for attr, value in validated_data.items():
|
|
||||||
if attr in info.relations and info.relations[attr].to_many:
|
|
||||||
m2m_fields.append((attr, value))
|
|
||||||
else:
|
|
||||||
setattr(instance, attr, value)
|
|
||||||
|
|
||||||
instance.save()
|
|
||||||
|
|
||||||
# Note that many-to-many fields are set after updating instance.
|
|
||||||
# Setting m2m fields triggers signals which could potentially change
|
|
||||||
# updated instance and we do not want it to collide with .update()
|
|
||||||
for attr, value in m2m_fields:
|
|
||||||
field = getattr(instance, attr)
|
|
||||||
# We can't check for inheritance here as m2m managers are generated dynamically
|
|
||||||
if field.__class__.__name__ == "RelatedManager":
|
|
||||||
field.set(value, bulk=False)
|
|
||||||
else:
|
|
||||||
field.set(value)
|
|
||||||
|
|
||||||
return instance
|
|
||||||
|
|
||||||
|
|
||||||
class JSONDictField(JSONField):
|
class JSONDictField(JSONField):
|
||||||
"""JSON Field which only allows dictionaries"""
|
"""JSON Field which only allows dictionaries"""
|
||||||
|
|
||||||
@ -112,6 +68,16 @@ class MetaNameSerializer(PassiveSerializer):
|
|||||||
return f"{obj._meta.app_label}.{obj._meta.model_name}"
|
return f"{obj._meta.app_label}.{obj._meta.model_name}"
|
||||||
|
|
||||||
|
|
||||||
|
class TypeCreateSerializer(PassiveSerializer):
|
||||||
|
"""Types of an object that can be created"""
|
||||||
|
|
||||||
|
name = CharField(required=True)
|
||||||
|
description = CharField(required=True)
|
||||||
|
component = CharField(required=True)
|
||||||
|
model_name = CharField(required=True)
|
||||||
|
requires_enterprise = BooleanField(default=False)
|
||||||
|
|
||||||
|
|
||||||
class CacheSerializer(PassiveSerializer):
|
class CacheSerializer(PassiveSerializer):
|
||||||
"""Generic cache stats for an object"""
|
"""Generic cache stats for an object"""
|
||||||
|
|
||||||
|
@ -14,16 +14,14 @@ class AuthentikCoreConfig(ManagedAppConfig):
|
|||||||
mountpoint = ""
|
mountpoint = ""
|
||||||
default = True
|
default = True
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_global
|
def reconcile_global_debug_worker_hook(self):
|
||||||
def debug_worker_hook(self):
|
|
||||||
"""Dispatch startup tasks inline when debugging"""
|
"""Dispatch startup tasks inline when debugging"""
|
||||||
if settings.DEBUG:
|
if settings.DEBUG:
|
||||||
from authentik.root.celery import worker_ready_hook
|
from authentik.root.celery import worker_ready_hook
|
||||||
|
|
||||||
worker_ready_hook()
|
worker_ready_hook()
|
||||||
|
|
||||||
@ManagedAppConfig.reconcile_tenant
|
def reconcile_tenant_source_inbuilt(self):
|
||||||
def source_inbuilt(self):
|
|
||||||
"""Reconcile inbuilt source"""
|
"""Reconcile inbuilt source"""
|
||||||
from authentik.core.models import Source
|
from authentik.core.models import Source
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
"""Authenticate with tokens"""
|
"""Authenticate with tokens"""
|
||||||
|
|
||||||
from typing import Any
|
from typing import Any, Optional
|
||||||
|
|
||||||
from django.contrib.auth.backends import ModelBackend
|
from django.contrib.auth.backends import ModelBackend
|
||||||
from django.http.request import HttpRequest
|
from django.http.request import HttpRequest
|
||||||
@ -16,24 +16,23 @@ class InbuiltBackend(ModelBackend):
|
|||||||
"""Inbuilt backend"""
|
"""Inbuilt backend"""
|
||||||
|
|
||||||
def authenticate(
|
def authenticate(
|
||||||
self, request: HttpRequest, username: str | None, password: str | None, **kwargs: Any
|
self, request: HttpRequest, username: Optional[str], password: Optional[str], **kwargs: Any
|
||||||
) -> User | None:
|
) -> Optional[User]:
|
||||||
user = super().authenticate(request, username=username, password=password, **kwargs)
|
user = super().authenticate(request, username=username, password=password, **kwargs)
|
||||||
if not user:
|
if not user:
|
||||||
return None
|
return None
|
||||||
self.set_method("password", request)
|
self.set_method("password", request)
|
||||||
return user
|
return user
|
||||||
|
|
||||||
def set_method(self, method: str, request: HttpRequest | None, **kwargs):
|
def set_method(self, method: str, request: Optional[HttpRequest], **kwargs):
|
||||||
"""Set method data on current flow, if possbiel"""
|
"""Set method data on current flow, if possbiel"""
|
||||||
if not request:
|
if not request:
|
||||||
return
|
return
|
||||||
# Since we can't directly pass other variables to signals, and we want to log the method
|
# Since we can't directly pass other variables to signals, and we want to log the method
|
||||||
# and the token used, we assume we're running in a flow and set a variable in the context
|
# and the token used, we assume we're running in a flow and set a variable in the context
|
||||||
flow_plan: FlowPlan = request.session.get(SESSION_KEY_PLAN, FlowPlan(""))
|
flow_plan: FlowPlan = request.session.get(SESSION_KEY_PLAN, FlowPlan(""))
|
||||||
flow_plan.context.setdefault(PLAN_CONTEXT_METHOD, method)
|
flow_plan.context[PLAN_CONTEXT_METHOD] = method
|
||||||
flow_plan.context.setdefault(PLAN_CONTEXT_METHOD_ARGS, {})
|
flow_plan.context[PLAN_CONTEXT_METHOD_ARGS] = cleanse_dict(sanitize_dict(kwargs))
|
||||||
flow_plan.context[PLAN_CONTEXT_METHOD_ARGS].update(cleanse_dict(sanitize_dict(kwargs)))
|
|
||||||
request.session[SESSION_KEY_PLAN] = flow_plan
|
request.session[SESSION_KEY_PLAN] = flow_plan
|
||||||
|
|
||||||
|
|
||||||
@ -41,18 +40,18 @@ class TokenBackend(InbuiltBackend):
|
|||||||
"""Authenticate with token"""
|
"""Authenticate with token"""
|
||||||
|
|
||||||
def authenticate(
|
def authenticate(
|
||||||
self, request: HttpRequest, username: str | None, password: str | None, **kwargs: Any
|
self, request: HttpRequest, username: Optional[str], password: Optional[str], **kwargs: Any
|
||||||
) -> User | None:
|
) -> Optional[User]:
|
||||||
try:
|
try:
|
||||||
|
# pylint: disable=no-member
|
||||||
user = User._default_manager.get_by_natural_key(username)
|
user = User._default_manager.get_by_natural_key(username)
|
||||||
|
# pylint: disable=no-member
|
||||||
except User.DoesNotExist:
|
except User.DoesNotExist:
|
||||||
# Run the default password hasher once to reduce the timing
|
# Run the default password hasher once to reduce the timing
|
||||||
# difference between an existing and a nonexistent user (#20760).
|
# difference between an existing and a nonexistent user (#20760).
|
||||||
User().set_password(password)
|
User().set_password(password)
|
||||||
return None
|
return None
|
||||||
|
# pylint: disable=no-member
|
||||||
tokens = Token.filter_not_expired(
|
tokens = Token.filter_not_expired(
|
||||||
user=user, key=password, intent=TokenIntents.INTENT_APP_PASSWORD
|
user=user, key=password, intent=TokenIntents.INTENT_APP_PASSWORD
|
||||||
)
|
)
|
||||||
|
@ -38,6 +38,6 @@ class TokenOutpostMiddleware:
|
|||||||
raise DenyConnection()
|
raise DenyConnection()
|
||||||
except AuthenticationFailed as exc:
|
except AuthenticationFailed as exc:
|
||||||
LOGGER.warning("Failed to authenticate", exc=exc)
|
LOGGER.warning("Failed to authenticate", exc=exc)
|
||||||
raise DenyConnection() from None
|
raise DenyConnection()
|
||||||
|
|
||||||
scope["user"] = user
|
scope["user"] = user
|
7
authentik/core/exceptions.py
Normal file
7
authentik/core/exceptions.py
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
"""authentik core exceptions"""
|
||||||
|
|
||||||
|
from authentik.lib.sentry import SentryIgnoredException
|
||||||
|
|
||||||
|
|
||||||
|
class PropertyMappingExpressionException(SentryIgnoredException):
|
||||||
|
"""Error when a PropertyMapping Exception expression could not be parsed or evaluated."""
|
@ -1,13 +1,11 @@
|
|||||||
"""Property Mapping Evaluator"""
|
"""Property Mapping Evaluator"""
|
||||||
|
|
||||||
from types import CodeType
|
from typing import Any, Optional
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
from django.db.models import Model
|
from django.db.models import Model
|
||||||
from django.http import HttpRequest
|
from django.http import HttpRequest
|
||||||
from prometheus_client import Histogram
|
from prometheus_client import Histogram
|
||||||
|
|
||||||
from authentik.core.expression.exceptions import SkipObjectException
|
|
||||||
from authentik.core.models import User
|
from authentik.core.models import User
|
||||||
from authentik.events.models import Event, EventAction
|
from authentik.events.models import Event, EventAction
|
||||||
from authentik.lib.expression.evaluator import BaseEvaluator
|
from authentik.lib.expression.evaluator import BaseEvaluator
|
||||||
@ -25,43 +23,31 @@ class PropertyMappingEvaluator(BaseEvaluator):
|
|||||||
"""Custom Evaluator that adds some different context variables."""
|
"""Custom Evaluator that adds some different context variables."""
|
||||||
|
|
||||||
dry_run: bool
|
dry_run: bool
|
||||||
model: Model
|
|
||||||
_compiled: CodeType | None = None
|
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
model: Model,
|
model: Model,
|
||||||
user: User | None = None,
|
user: Optional[User] = None,
|
||||||
request: HttpRequest | None = None,
|
request: Optional[HttpRequest] = None,
|
||||||
dry_run: bool | None = False,
|
dry_run: Optional[bool] = False,
|
||||||
**kwargs,
|
**kwargs,
|
||||||
):
|
):
|
||||||
self.model = model
|
|
||||||
if hasattr(model, "name"):
|
if hasattr(model, "name"):
|
||||||
_filename = model.name
|
_filename = model.name
|
||||||
else:
|
else:
|
||||||
_filename = str(model)
|
_filename = str(model)
|
||||||
super().__init__(filename=_filename)
|
super().__init__(filename=_filename)
|
||||||
self.dry_run = dry_run
|
|
||||||
self.set_context(user, request, **kwargs)
|
|
||||||
|
|
||||||
def set_context(
|
|
||||||
self,
|
|
||||||
user: User | None = None,
|
|
||||||
request: HttpRequest | None = None,
|
|
||||||
**kwargs,
|
|
||||||
):
|
|
||||||
req = PolicyRequest(user=User())
|
req = PolicyRequest(user=User())
|
||||||
req.obj = self.model
|
req.obj = model
|
||||||
if user:
|
if user:
|
||||||
req.user = user
|
req.user = user
|
||||||
self._context["user"] = user
|
self._context["user"] = user
|
||||||
if request:
|
if request:
|
||||||
req.http_request = request
|
req.http_request = request
|
||||||
req.context.update(**kwargs)
|
|
||||||
self._context["request"] = req
|
self._context["request"] = req
|
||||||
|
req.context.update(**kwargs)
|
||||||
self._context.update(**kwargs)
|
self._context.update(**kwargs)
|
||||||
self._globals["SkipObject"] = SkipObjectException
|
self.dry_run = dry_run
|
||||||
|
|
||||||
def handle_error(self, exc: Exception, expression_source: str):
|
def handle_error(self, exc: Exception, expression_source: str):
|
||||||
"""Exception Handler"""
|
"""Exception Handler"""
|
||||||
@ -76,19 +62,10 @@ class PropertyMappingEvaluator(BaseEvaluator):
|
|||||||
)
|
)
|
||||||
if "request" in self._context:
|
if "request" in self._context:
|
||||||
req: PolicyRequest = self._context["request"]
|
req: PolicyRequest = self._context["request"]
|
||||||
if req.http_request:
|
|
||||||
event.from_http(req.http_request, req.user)
|
event.from_http(req.http_request, req.user)
|
||||||
return
|
return
|
||||||
elif req.user:
|
|
||||||
event.set_user(req.user)
|
|
||||||
event.save()
|
event.save()
|
||||||
|
|
||||||
def evaluate(self, *args, **kwargs) -> Any:
|
def evaluate(self, *args, **kwargs) -> Any:
|
||||||
with PROPERTY_MAPPING_TIME.labels(mapping_name=self._filename).time():
|
with PROPERTY_MAPPING_TIME.labels(mapping_name=self._filename).time():
|
||||||
return super().evaluate(*args, **kwargs)
|
return super().evaluate(*args, **kwargs)
|
||||||
|
|
||||||
def compile(self, expression: str | None = None) -> Any:
|
|
||||||
if not self._compiled:
|
|
||||||
compiled = super().compile(expression or self.model.expression)
|
|
||||||
self._compiled = compiled
|
|
||||||
return self._compiled
|
|
||||||
|
@ -1,19 +0,0 @@
|
|||||||
"""authentik core exceptions"""
|
|
||||||
|
|
||||||
from authentik.lib.expression.exceptions import ControlFlowException
|
|
||||||
from authentik.lib.sentry import SentryIgnoredException
|
|
||||||
|
|
||||||
|
|
||||||
class PropertyMappingExpressionException(SentryIgnoredException):
|
|
||||||
"""Error when a PropertyMapping Exception expression could not be parsed or evaluated."""
|
|
||||||
|
|
||||||
def __init__(self, exc: Exception, mapping) -> None:
|
|
||||||
super().__init__()
|
|
||||||
self.exc = exc
|
|
||||||
self.mapping = mapping
|
|
||||||
|
|
||||||
|
|
||||||
class SkipObjectException(ControlFlowException):
|
|
||||||
"""Exception which can be raised in a property mapping to skip syncing an object.
|
|
||||||
Only applies to Property mappings which sync objects, and not on mappings which transitively
|
|
||||||
apply to a single user"""
|
|
@ -1,32 +0,0 @@
|
|||||||
"""Change user type"""
|
|
||||||
|
|
||||||
from authentik.core.models import User, UserTypes
|
|
||||||
from authentik.tenants.management import TenantCommand
|
|
||||||
|
|
||||||
|
|
||||||
class Command(TenantCommand):
|
|
||||||
"""Change user type"""
|
|
||||||
|
|
||||||
def add_arguments(self, parser):
|
|
||||||
parser.add_argument("--type", type=str, required=True)
|
|
||||||
parser.add_argument("--all", action="store_true", default=False)
|
|
||||||
parser.add_argument("usernames", nargs="*", type=str)
|
|
||||||
|
|
||||||
def handle_per_tenant(self, **options):
|
|
||||||
print(options)
|
|
||||||
new_type = UserTypes(options["type"])
|
|
||||||
qs = (
|
|
||||||
User.objects.exclude_anonymous()
|
|
||||||
.exclude(type=UserTypes.SERVICE_ACCOUNT)
|
|
||||||
.exclude(type=UserTypes.INTERNAL_SERVICE_ACCOUNT)
|
|
||||||
)
|
|
||||||
if options["usernames"] and options["all"]:
|
|
||||||
self.stderr.write("--all and usernames specified, only one can be specified")
|
|
||||||
return
|
|
||||||
if not options["usernames"] and not options["all"]:
|
|
||||||
self.stderr.write("--all or usernames must be specified")
|
|
||||||
return
|
|
||||||
if options["usernames"] and not options["all"]:
|
|
||||||
qs = qs.filter(username__in=options["usernames"])
|
|
||||||
updated = qs.update(type=new_type)
|
|
||||||
self.stdout.write(f"Updated {updated} users.")
|
|
@ -1,34 +1,10 @@
|
|||||||
"""custom runserver command"""
|
"""custom runserver command"""
|
||||||
|
|
||||||
from typing import TextIO
|
|
||||||
|
|
||||||
from daphne.management.commands.runserver import Command as RunServer
|
from daphne.management.commands.runserver import Command as RunServer
|
||||||
from daphne.server import Server
|
|
||||||
|
|
||||||
from authentik.root.signals import post_startup, pre_startup, startup
|
|
||||||
|
|
||||||
|
|
||||||
class SignalServer(Server):
|
|
||||||
"""Server which signals back to authentik when it finished starting up"""
|
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
|
|
||||||
def ready_callable():
|
|
||||||
pre_startup.send(sender=self)
|
|
||||||
startup.send(sender=self)
|
|
||||||
post_startup.send(sender=self)
|
|
||||||
|
|
||||||
self.ready_callable = ready_callable
|
|
||||||
|
|
||||||
|
|
||||||
class Command(RunServer):
|
class Command(RunServer):
|
||||||
"""custom runserver command, which doesn't show the misleading django startup message"""
|
"""custom runserver command, which doesn't show the misleading django startup message"""
|
||||||
|
|
||||||
server_cls = SignalServer
|
def on_bind(self, server_port):
|
||||||
|
pass
|
||||||
def __init__(self, *args, **kwargs):
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
# Redirect standard stdout banner from Daphne into the void
|
|
||||||
# as there are a couple more steps that happen before startup is fully done
|
|
||||||
self.stdout = TextIO()
|
|
||||||
|
@ -4,7 +4,6 @@ import code
|
|||||||
import platform
|
import platform
|
||||||
import sys
|
import sys
|
||||||
import traceback
|
import traceback
|
||||||
from pprint import pprint
|
|
||||||
|
|
||||||
from django.apps import apps
|
from django.apps import apps
|
||||||
from django.core.management.base import BaseCommand
|
from django.core.management.base import BaseCommand
|
||||||
@ -17,8 +16,13 @@ from authentik.events.middleware import should_log_model
|
|||||||
from authentik.events.models import Event, EventAction
|
from authentik.events.models import Event, EventAction
|
||||||
from authentik.events.utils import model_to_dict
|
from authentik.events.utils import model_to_dict
|
||||||
|
|
||||||
BANNER_TEXT = f"""### authentik shell ({get_full_version()})
|
BANNER_TEXT = """### authentik shell ({authentik})
|
||||||
### Node {platform.node()} | Arch {platform.machine()} | Python {platform.python_version()} """
|
### Node {node} | Arch {arch} | Python {python} """.format(
|
||||||
|
node=platform.node(),
|
||||||
|
python=platform.python_version(),
|
||||||
|
arch=platform.machine(),
|
||||||
|
authentik=get_full_version(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class Command(BaseCommand):
|
class Command(BaseCommand):
|
||||||
@ -35,9 +39,7 @@ class Command(BaseCommand):
|
|||||||
|
|
||||||
def get_namespace(self):
|
def get_namespace(self):
|
||||||
"""Prepare namespace with all models"""
|
"""Prepare namespace with all models"""
|
||||||
namespace = {
|
namespace = {}
|
||||||
"pprint": pprint,
|
|
||||||
}
|
|
||||||
|
|
||||||
# Gather Django models and constants from each app
|
# Gather Django models and constants from each app
|
||||||
for app in apps.get_app_configs():
|
for app in apps.get_app_configs():
|
||||||
@ -84,7 +86,7 @@ class Command(BaseCommand):
|
|||||||
|
|
||||||
# If Python code has been passed, execute it and exit.
|
# If Python code has been passed, execute it and exit.
|
||||||
if options["command"]:
|
if options["command"]:
|
||||||
|
# pylint: disable=exec-used
|
||||||
exec(options["command"], namespace) # nosec # noqa
|
exec(options["command"], namespace) # nosec # noqa
|
||||||
return
|
return
|
||||||
|
|
||||||
@ -97,7 +99,7 @@ class Command(BaseCommand):
|
|||||||
else:
|
else:
|
||||||
try:
|
try:
|
||||||
hook()
|
hook()
|
||||||
except Exception:
|
except Exception: # pylint: disable=broad-except
|
||||||
# Match the behavior of the cpython shell where an error in
|
# Match the behavior of the cpython shell where an error in
|
||||||
# sys.__interactivehook__ prints a warning and the exception
|
# sys.__interactivehook__ prints a warning and the exception
|
||||||
# and continues.
|
# and continues.
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
"""authentik admin Middleware to impersonate users"""
|
"""authentik admin Middleware to impersonate users"""
|
||||||
|
|
||||||
from collections.abc import Callable
|
|
||||||
from contextvars import ContextVar
|
from contextvars import ContextVar
|
||||||
|
from typing import Callable, Optional
|
||||||
from uuid import uuid4
|
from uuid import uuid4
|
||||||
|
|
||||||
from django.http import HttpRequest, HttpResponse
|
from django.http import HttpRequest, HttpResponse
|
||||||
@ -15,9 +15,9 @@ RESPONSE_HEADER_ID = "X-authentik-id"
|
|||||||
KEY_AUTH_VIA = "auth_via"
|
KEY_AUTH_VIA = "auth_via"
|
||||||
KEY_USER = "user"
|
KEY_USER = "user"
|
||||||
|
|
||||||
CTX_REQUEST_ID = ContextVar[str | None](STRUCTLOG_KEY_PREFIX + "request_id", default=None)
|
CTX_REQUEST_ID = ContextVar[Optional[str]](STRUCTLOG_KEY_PREFIX + "request_id", default=None)
|
||||||
CTX_HOST = ContextVar[str | None](STRUCTLOG_KEY_PREFIX + "host", default=None)
|
CTX_HOST = ContextVar[Optional[str]](STRUCTLOG_KEY_PREFIX + "host", default=None)
|
||||||
CTX_AUTH_VIA = ContextVar[str | None](STRUCTLOG_KEY_PREFIX + KEY_AUTH_VIA, default=None)
|
CTX_AUTH_VIA = ContextVar[Optional[str]](STRUCTLOG_KEY_PREFIX + KEY_AUTH_VIA, default=None)
|
||||||
|
|
||||||
|
|
||||||
class ImpersonateMiddleware:
|
class ImpersonateMiddleware:
|
||||||
@ -55,7 +55,7 @@ class RequestIDMiddleware:
|
|||||||
def __call__(self, request: HttpRequest) -> HttpResponse:
|
def __call__(self, request: HttpRequest) -> HttpResponse:
|
||||||
if not hasattr(request, "request_id"):
|
if not hasattr(request, "request_id"):
|
||||||
request_id = uuid4().hex
|
request_id = uuid4().hex
|
||||||
request.request_id = request_id
|
setattr(request, "request_id", request_id)
|
||||||
CTX_REQUEST_ID.set(request_id)
|
CTX_REQUEST_ID.set(request_id)
|
||||||
CTX_HOST.set(request.get_host())
|
CTX_HOST.set(request.get_host())
|
||||||
set_tag("authentik.request_id", request_id)
|
set_tag("authentik.request_id", request_id)
|
||||||
@ -67,7 +67,7 @@ class RequestIDMiddleware:
|
|||||||
response = self.get_response(request)
|
response = self.get_response(request)
|
||||||
|
|
||||||
response[RESPONSE_HEADER_ID] = request.request_id
|
response[RESPONSE_HEADER_ID] = request.request_id
|
||||||
response.ak_context = {}
|
setattr(response, "ak_context", {})
|
||||||
response.ak_context["request_id"] = CTX_REQUEST_ID.get()
|
response.ak_context["request_id"] = CTX_REQUEST_ID.get()
|
||||||
response.ak_context["host"] = CTX_HOST.get()
|
response.ak_context["host"] = CTX_HOST.get()
|
||||||
response.ak_context[KEY_AUTH_VIA] = CTX_AUTH_VIA.get()
|
response.ak_context[KEY_AUTH_VIA] = CTX_AUTH_VIA.get()
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user