Compare commits
	
		
			1 Commits
		
	
	
		
			version/20
			...
			smusali/ev
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 617d913ca2 | 
| @ -1,34 +1,20 @@ | ||||
| [bumpversion] | ||||
| current_version = 2024.12.0-rc1 | ||||
| current_version = 2023.10.7 | ||||
| tag = 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*))? | ||||
| serialize =  | ||||
| 	{major}.{minor}.{patch}-{rc_t}{rc_n} | ||||
| 	{major}.{minor}.{patch} | ||||
| parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+) | ||||
| serialize = {major}.{minor}.{patch} | ||||
| message = release: {new_version} | ||||
| tag_name = version/{new_version} | ||||
|  | ||||
| [bumpversion:part:rc_t] | ||||
| values =  | ||||
| 	rc | ||||
| 	final | ||||
| optional_value = final | ||||
|  | ||||
| [bumpversion:file:pyproject.toml] | ||||
|  | ||||
| [bumpversion:file:package.json] | ||||
|  | ||||
| [bumpversion:file:docker-compose.yml] | ||||
|  | ||||
| [bumpversion:file:schema.yml] | ||||
|  | ||||
| [bumpversion:file:blueprints/schema.json] | ||||
|  | ||||
| [bumpversion:file:authentik/__init__.py] | ||||
|  | ||||
| [bumpversion:file:internal/constants/constants.go] | ||||
|  | ||||
| [bumpversion:file:web/src/common/constants.ts] | ||||
|  | ||||
| [bumpversion:file:website/docs/install-config/install/aws/template.yaml] | ||||
|  | ||||
							
								
								
									
										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/** | ||||
| 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 | ||||
|  | ||||
| **Screenshots** | ||||
|  | ||||
| @ -9,6 +9,9 @@ inputs: | ||||
| runs: | ||||
|   using: "composite" | ||||
|   steps: | ||||
|     - name: Generate config | ||||
|       id: ev | ||||
|       uses: ./.github/actions/docker-push-variables | ||||
|     - name: Find Comment | ||||
|       uses: peter-evans/find-comment@v2 | ||||
|       id: fc | ||||
| @ -54,7 +57,6 @@ runs: | ||||
|             authentik: | ||||
|                 outposts: | ||||
|                     container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s | ||||
|             global: | ||||
|             image: | ||||
|                 repository: ghcr.io/goauthentik/dev-server | ||||
|                 tag: ${{ inputs.tag }} | ||||
| @ -66,7 +68,6 @@ runs: | ||||
|             authentik: | ||||
|                 outposts: | ||||
|                     container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s | ||||
|             global: | ||||
|             image: | ||||
|                 repository: ghcr.io/goauthentik/dev-server | ||||
|                 tag: ${{ inputs.tag }}-arm64 | ||||
|  | ||||
							
								
								
									
										85
									
								
								.github/actions/docker-push-variables/action.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										85
									
								
								.github/actions/docker-push-variables/action.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,53 +1,64 @@ | ||||
| --- | ||||
| name: "Prepare docker environment variables" | ||||
| description: "Prepare docker environment variables" | ||||
|  | ||||
| inputs: | ||||
|   image-name: | ||||
|     required: true | ||||
|     description: "Docker image prefix" | ||||
|   image-arch: | ||||
|     required: false | ||||
|     description: "Docker image arch" | ||||
|  | ||||
| outputs: | ||||
|   shouldPush: | ||||
|     description: "Whether to push the image or not" | ||||
|     value: ${{ steps.ev.outputs.shouldPush }} | ||||
|  | ||||
|   shouldBuild: | ||||
|     description: "Whether to build image or not" | ||||
|     value: ${{ steps.ev.outputs.shouldBuild }} | ||||
|   branchName: | ||||
|     description: "Branch name" | ||||
|     value: ${{ steps.ev.outputs.branchName }} | ||||
|   branchNameContainer: | ||||
|     description: "Branch name (for containers)" | ||||
|     value: ${{ steps.ev.outputs.branchNameContainer }} | ||||
|   timestamp: | ||||
|     description: "Timestamp" | ||||
|     value: ${{ steps.ev.outputs.timestamp }} | ||||
|   sha: | ||||
|     description: "sha" | ||||
|     value: ${{ steps.ev.outputs.sha }} | ||||
|  | ||||
|   shortHash: | ||||
|     description: "shortHash" | ||||
|     value: ${{ steps.ev.outputs.shortHash }} | ||||
|   version: | ||||
|     description: "Version" | ||||
|     description: "version" | ||||
|     value: ${{ steps.ev.outputs.version }} | ||||
|   prerelease: | ||||
|     description: "Prerelease" | ||||
|     value: ${{ steps.ev.outputs.prerelease }} | ||||
|  | ||||
|   imageTags: | ||||
|     description: "Docker image tags" | ||||
|     value: ${{ steps.ev.outputs.imageTags }} | ||||
|   attestImageNames: | ||||
|     description: "Docker image names used for attestation" | ||||
|     value: ${{ steps.ev.outputs.attestImageNames }} | ||||
|   imageMainTag: | ||||
|     description: "Docker image main tag" | ||||
|     value: ${{ steps.ev.outputs.imageMainTag }} | ||||
|   imageMainName: | ||||
|     description: "Docker image main name" | ||||
|     value: ${{ steps.ev.outputs.imageMainName }} | ||||
|   versionFamily: | ||||
|     description: "versionFamily" | ||||
|     value: ${{ steps.ev.outputs.versionFamily }} | ||||
|  | ||||
| runs: | ||||
|   using: "composite" | ||||
|   steps: | ||||
|     - name: Generate config | ||||
|       id: ev | ||||
|       shell: bash | ||||
|       env: | ||||
|         IMAGE_NAME: ${{ inputs.image-name }} | ||||
|         IMAGE_ARCH: ${{ inputs.image-arch }} | ||||
|         PR_HEAD_SHA: ${{ github.event.pull_request.head.sha }} | ||||
|       shell: python | ||||
|       run: | | ||||
|         python3 ${{ github.action_path }}/push_vars.py | ||||
|         """Helper script to get the actual branch name, docker safe""" | ||||
|         import configparser | ||||
|         import os | ||||
|         from time import time | ||||
|  | ||||
|         parser = configparser.ConfigParser() | ||||
|         parser.read(".bumpversion.cfg") | ||||
|  | ||||
|         branch_name = os.environ["GITHUB_REF"] | ||||
|         if os.environ.get("GITHUB_HEAD_REF", "") != "": | ||||
|             branch_name = os.environ["GITHUB_HEAD_REF"] | ||||
|  | ||||
|         should_build = str(os.environ.get("DOCKER_USERNAME", "") != "").lower() | ||||
|         version = parser.get("bumpversion", "current_version") | ||||
|         version_family = ".".join(version.split(".")[:-1]) | ||||
|         safe_branch_name = branch_name.replace("refs/heads/", "").replace("/", "-") | ||||
|  | ||||
|         sha = os.environ["GITHUB_SHA"] if not "${{ github.event.pull_request.head.sha }}" else "${{ github.event.pull_request.head.sha }}" | ||||
|  | ||||
|         with open(os.environ["GITHUB_OUTPUT"], "a+", encoding="utf-8") as _output: | ||||
|             print("branchName=%s" % branch_name, file=_output) | ||||
|             print("branchNameContainer=%s" % safe_branch_name, file=_output) | ||||
|             print("timestamp=%s" % int(time()), file=_output) | ||||
|             print("sha=%s" % sha, file=_output) | ||||
|             print("shortHash=%s" % sha[:7], file=_output) | ||||
|             print("shouldBuild=%s" % should_build, file=_output) | ||||
|             print("version=%s" % version, file=_output) | ||||
|             print("versionFamily=%s" % version_family, file=_output) | ||||
|  | ||||
| @ -1,81 +0,0 @@ | ||||
| """Helper script to get the actual branch name, docker safe""" | ||||
|  | ||||
| import configparser | ||||
| import os | ||||
| from time import time | ||||
|  | ||||
| parser = configparser.ConfigParser() | ||||
| parser.read(".bumpversion.cfg") | ||||
|  | ||||
| # Decide if we should push the image or not | ||||
| should_push = True | ||||
| if len(os.environ.get("DOCKER_USERNAME", "")) < 1: | ||||
|     # Don't push if we don't have DOCKER_USERNAME, i.e. no secrets are available | ||||
|     should_push = False | ||||
| if os.environ.get("GITHUB_REPOSITORY").lower() == "goauthentik/authentik-internal": | ||||
|     # Don't push on the internal repo | ||||
|     should_push = False | ||||
|  | ||||
| branch_name = os.environ["GITHUB_REF"] | ||||
| if os.environ.get("GITHUB_HEAD_REF", "") != "": | ||||
|     branch_name = os.environ["GITHUB_HEAD_REF"] | ||||
| safe_branch_name = branch_name.replace("refs/heads/", "").replace("/", "-").replace("'", "-") | ||||
|  | ||||
| image_names = os.getenv("IMAGE_NAME").split(",") | ||||
| image_arch = os.getenv("IMAGE_ARCH") or None | ||||
|  | ||||
| is_pull_request = bool(os.getenv("PR_HEAD_SHA")) | ||||
| is_release = "dev" not in image_names[0] | ||||
|  | ||||
| sha = os.environ["GITHUB_SHA"] if not is_pull_request else os.getenv("PR_HEAD_SHA") | ||||
|  | ||||
| # 2042.1.0 or 2042.1.0-rc1 | ||||
| version = parser.get("bumpversion", "current_version") | ||||
| # 2042.1 | ||||
| version_family = ".".join(version.split("-", 1)[0].split(".")[:-1]) | ||||
| prerelease = "-" in version | ||||
|  | ||||
| image_tags = [] | ||||
| if is_release: | ||||
|     for name in image_names: | ||||
|         image_tags += [ | ||||
|             f"{name}:{version}", | ||||
|         ] | ||||
|         if not prerelease: | ||||
|             image_tags += [ | ||||
|                 f"{name}:latest", | ||||
|                 f"{name}:{version_family}", | ||||
|             ] | ||||
| else: | ||||
|     suffix = "" | ||||
|     if image_arch and image_arch != "amd64": | ||||
|         suffix = f"-{image_arch}" | ||||
|     for name in image_names: | ||||
|         image_tags += [ | ||||
|             f"{name}:gh-{sha}{suffix}",  # Used for ArgoCD and PR comments | ||||
|             f"{name}:gh-{safe_branch_name}{suffix}",  # For convenience | ||||
|             f"{name}:gh-{safe_branch_name}-{int(time())}-{sha[:7]}{suffix}",  # Use by FluxCD | ||||
|         ] | ||||
|  | ||||
| image_main_tag = image_tags[0].split(":")[-1] | ||||
|  | ||||
|  | ||||
| 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: | ||||
|     print(f"shouldPush={str(should_push).lower()}", file=_output) | ||||
|     print(f"sha={sha}", file=_output) | ||||
|     print(f"version={version}", file=_output) | ||||
|     print(f"prerelease={prerelease}", file=_output) | ||||
|     print(f"imageTags={','.join(image_tags)}", file=_output) | ||||
|     print(f"attestImageNames={get_attest_image_names(image_tags)}", file=_output) | ||||
|     print(f"imageMainTag={image_main_tag}", file=_output) | ||||
|     print(f"imageMainName={image_tags[0]}", file=_output) | ||||
| @ -1,7 +0,0 @@ | ||||
| #!/bin/bash -x | ||||
| SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) | ||||
| GITHUB_OUTPUT=/dev/stdout \ | ||||
|     GITHUB_REF=ref \ | ||||
|     GITHUB_SHA=sha \ | ||||
|     IMAGE_NAME=ghcr.io/goauthentik/server,beryju/authentik \ | ||||
|     python $SCRIPT_DIR/push_vars.py | ||||
							
								
								
									
										12
									
								
								.github/actions/setup/action.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										12
									
								
								.github/actions/setup/action.yml
									
									
									
									
										vendored
									
									
								
							| @ -14,28 +14,28 @@ runs: | ||||
|       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 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 | ||||
|       uses: actions/setup-python@v5 | ||||
|       uses: actions/setup-python@v4 | ||||
|       with: | ||||
|         python-version-file: "pyproject.toml" | ||||
|         cache: "poetry" | ||||
|     - name: Setup node | ||||
|       uses: actions/setup-node@v4 | ||||
|       uses: actions/setup-node@v3 | ||||
|       with: | ||||
|         node-version-file: web/package.json | ||||
|         cache: "npm" | ||||
|         cache-dependency-path: web/package-lock.json | ||||
|     - name: Setup go | ||||
|       uses: actions/setup-go@v5 | ||||
|       uses: actions/setup-go@v4 | ||||
|       with: | ||||
|         go-version-file: "go.mod" | ||||
|     - name: Setup dependencies | ||||
|       shell: bash | ||||
|       run: | | ||||
|         export PSQL_TAG=${{ inputs.postgresql_version }} | ||||
|         docker compose -f .github/actions/setup/docker-compose.yml up -d | ||||
|         poetry install --sync | ||||
|         docker-compose -f .github/actions/setup/docker-compose.yml up -d | ||||
|         poetry install | ||||
|         cd web && npm ci | ||||
|     - name: Generate config | ||||
|       shell: poetry run python {0} | ||||
|  | ||||
							
								
								
									
										2
									
								
								.github/actions/setup/docker-compose.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/actions/setup/docker-compose.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,3 +1,5 @@ | ||||
| version: "3.7" | ||||
|  | ||||
| services: | ||||
|   postgresql: | ||||
|     image: docker.io/library/postgres:${PSQL_TAG:-16} | ||||
|  | ||||
							
								
								
									
										2
									
								
								.github/codespell-words.txt
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/codespell-words.txt
									
									
									
									
										vendored
									
									
								
							| @ -3,5 +3,3 @@ keypairs | ||||
| hass | ||||
| warmup | ||||
| ontext | ||||
| singed | ||||
| assertIn | ||||
|  | ||||
							
								
								
									
										47
									
								
								.github/dependabot.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										47
									
								
								.github/dependabot.yml
									
									
									
									
										vendored
									
									
								
							| @ -21,9 +21,7 @@ updates: | ||||
|     labels: | ||||
|       - dependencies | ||||
|   - package-ecosystem: npm | ||||
|     directories: | ||||
|       - "/web" | ||||
|       - "/web/sfe" | ||||
|     directory: "/web" | ||||
|     schedule: | ||||
|       interval: daily | ||||
|       time: "04:00" | ||||
| @ -32,6 +30,7 @@ updates: | ||||
|     open-pull-requests-limit: 10 | ||||
|     commit-message: | ||||
|       prefix: "web:" | ||||
|     # TODO: deduplicate these groups | ||||
|     groups: | ||||
|       sentry: | ||||
|         patterns: | ||||
| @ -43,11 +42,9 @@ updates: | ||||
|           - "babel-*" | ||||
|       eslint: | ||||
|         patterns: | ||||
|           - "@eslint/*" | ||||
|           - "@typescript-eslint/*" | ||||
|           - "eslint-*" | ||||
|           - "eslint" | ||||
|           - "typescript-eslint" | ||||
|           - "eslint-*" | ||||
|       storybook: | ||||
|         patterns: | ||||
|           - "@storybook/*" | ||||
| @ -55,16 +52,38 @@ updates: | ||||
|       esbuild: | ||||
|         patterns: | ||||
|           - "@esbuild/*" | ||||
|           - "esbuild*" | ||||
|       rollup: | ||||
|   - package-ecosystem: npm | ||||
|     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: | ||||
|           - "@rollup/*" | ||||
|           - "rollup-*" | ||||
|           - "rollup*" | ||||
|       swc: | ||||
|           - "@sentry/*" | ||||
|           - "@spotlightjs/*" | ||||
|       babel: | ||||
|         patterns: | ||||
|           - "@swc/*" | ||||
|           - "swc-*" | ||||
|           - "@babel/*" | ||||
|           - "babel-*" | ||||
|       eslint: | ||||
|         patterns: | ||||
|           - "@typescript-eslint/*" | ||||
|           - "eslint" | ||||
|           - "eslint-*" | ||||
|       storybook: | ||||
|         patterns: | ||||
|           - "@storybook/*" | ||||
|           - "*storybook*" | ||||
|       esbuild: | ||||
|         patterns: | ||||
|           - "@esbuild/*" | ||||
|       wdio: | ||||
|         patterns: | ||||
|           - "@wdio/*" | ||||
|  | ||||
							
								
								
									
										3
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							| @ -1,7 +1,7 @@ | ||||
| <!-- | ||||
| 👋 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 | ||||
| @ -27,6 +27,7 @@ If an API change has been made | ||||
| If changes to the frontend have been made | ||||
|  | ||||
| -   [ ] The code has been formatted (`make web`) | ||||
| -   [ ] The translation files have been updated (`make i18n-extract`) | ||||
|  | ||||
| If applicable | ||||
|  | ||||
|  | ||||
							
								
								
									
										66
									
								
								.github/workflows/api-py-publish.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										66
									
								
								.github/workflows/api-py-publish.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,66 +0,0 @@ | ||||
| name: authentik-api-py-publish | ||||
| on: | ||||
|   push: | ||||
|     branches: [main] | ||||
|     paths: | ||||
|       - "schema.yml" | ||||
|   workflow_dispatch: | ||||
| jobs: | ||||
|   build: | ||||
|     if: ${{ github.repository != 'goauthentik/authentik-internal' }} | ||||
|     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 | ||||
							
								
								
									
										46
									
								
								.github/workflows/ci-aws-cfn.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										46
									
								
								.github/workflows/ci-aws-cfn.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,46 +0,0 @@ | ||||
| name: authentik-ci-aws-cfn | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: | ||||
|       - main | ||||
|       - next | ||||
|       - version-* | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|       - version-* | ||||
|  | ||||
| env: | ||||
|   POSTGRES_DB: authentik | ||||
|   POSTGRES_USER: authentik | ||||
|   POSTGRES_PASSWORD: "EK-5jnKfjrGRm<77" | ||||
|  | ||||
| jobs: | ||||
|   check-changes-applied: | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|       - name: Setup authentik env | ||||
|         uses: ./.github/actions/setup | ||||
|       - uses: actions/setup-node@v4 | ||||
|         with: | ||||
|           node-version-file: website/package.json | ||||
|           cache: "npm" | ||||
|           cache-dependency-path: website/package-lock.json | ||||
|       - working-directory: website/ | ||||
|         run: | | ||||
|           npm ci | ||||
|       - name: Check changes have been applied | ||||
|         run: | | ||||
|           poetry run make aws-cfn | ||||
|           git diff --exit-code | ||||
|   ci-aws-cfn-mark: | ||||
|     if: always() | ||||
|     needs: | ||||
|       - check-changes-applied | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - uses: re-actors/alls-green@release/v1 | ||||
|         with: | ||||
|           jobs: ${{ toJSON(needs) }} | ||||
							
								
								
									
										137
									
								
								.github/workflows/ci-main.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										137
									
								
								.github/workflows/ci-main.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,4 +1,3 @@ | ||||
| --- | ||||
| name: authentik-ci-main | ||||
|  | ||||
| on: | ||||
| @ -7,6 +6,8 @@ on: | ||||
|       - main | ||||
|       - next | ||||
|       - version-* | ||||
|     paths-ignore: | ||||
|       - website | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
| @ -26,7 +27,10 @@ jobs: | ||||
|           - bandit | ||||
|           - black | ||||
|           - codespell | ||||
|           - isort | ||||
|           - pending-migrations | ||||
|           - pylint | ||||
|           - pyright | ||||
|           - ruff | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
| @ -50,6 +54,7 @@ jobs: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         psql: | ||||
|           - 12-alpine | ||||
|           - 15-alpine | ||||
|           - 16-alpine | ||||
|     steps: | ||||
| @ -64,7 +69,7 @@ jobs: | ||||
|           cp authentik/lib/default.yml local.env.yml | ||||
|           cp -R .github .. | ||||
|           cp -R scripts .. | ||||
|           git checkout $(git tag --sort=version:refname | grep '^version/' | grep -vE -- '-rc[0-9]+$' | tail -n1) | ||||
|           git checkout version/$(python -c "from authentik import __version__; print(__version__)") | ||||
|           rm -rf .github/ scripts/ | ||||
|           mv ../.github ../scripts . | ||||
|       - name: Setup authentik env (stable) | ||||
| @ -103,6 +108,7 @@ jobs: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         psql: | ||||
|           - 12-alpine | ||||
|           - 15-alpine | ||||
|           - 16-alpine | ||||
|     steps: | ||||
| @ -116,16 +122,10 @@ jobs: | ||||
|           poetry run make test | ||||
|           poetry run coverage xml | ||||
|       - if: ${{ always() }} | ||||
|         uses: codecov/codecov-action@v5 | ||||
|         uses: codecov/codecov-action@v4 | ||||
|         with: | ||||
|           flags: unit | ||||
|           token: ${{ secrets.CODECOV_TOKEN }} | ||||
|       - if: ${{ !cancelled() }} | ||||
|         uses: codecov/test-results-action@v1 | ||||
|         with: | ||||
|           flags: unit | ||||
|           file: unittest.xml | ||||
|           token: ${{ secrets.CODECOV_TOKEN }} | ||||
|   test-integration: | ||||
|     runs-on: ubuntu-latest | ||||
|     timeout-minutes: 30 | ||||
| @ -134,22 +134,16 @@ jobs: | ||||
|       - name: Setup authentik env | ||||
|         uses: ./.github/actions/setup | ||||
|       - name: Create k8s Kind Cluster | ||||
|         uses: helm/kind-action@v1.11.0 | ||||
|         uses: helm/kind-action@v1.8.0 | ||||
|       - name: run integration | ||||
|         run: | | ||||
|           poetry run coverage run manage.py test tests/integration | ||||
|           poetry run coverage xml | ||||
|       - if: ${{ always() }} | ||||
|         uses: codecov/codecov-action@v5 | ||||
|         uses: codecov/codecov-action@v4 | ||||
|         with: | ||||
|           flags: integration | ||||
|           token: ${{ secrets.CODECOV_TOKEN }} | ||||
|       - if: ${{ !cancelled() }} | ||||
|         uses: codecov/test-results-action@v1 | ||||
|         with: | ||||
|           flags: integration | ||||
|           file: unittest.xml | ||||
|           token: ${{ secrets.CODECOV_TOKEN }} | ||||
|   test-e2e: | ||||
|     name: test-e2e (${{ matrix.job.name }}) | ||||
|     runs-on: ubuntu-latest | ||||
| @ -170,8 +164,6 @@ jobs: | ||||
|             glob: tests/e2e/test_provider_ldap* tests/e2e/test_source_ldap* | ||||
|           - name: radius | ||||
|             glob: tests/e2e/test_provider_radius* | ||||
|           - name: scim | ||||
|             glob: tests/e2e/test_source_scim* | ||||
|           - name: flows | ||||
|             glob: tests/e2e/test_flows* | ||||
|     steps: | ||||
| @ -180,7 +172,7 @@ jobs: | ||||
|         uses: ./.github/actions/setup | ||||
|       - name: Setup e2e env (chrome, etc) | ||||
|         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 | ||||
|         uses: actions/cache@v4 | ||||
|         with: | ||||
| @ -198,18 +190,11 @@ jobs: | ||||
|           poetry run coverage run manage.py test ${{ matrix.job.glob }} | ||||
|           poetry run coverage xml | ||||
|       - if: ${{ always() }} | ||||
|         uses: codecov/codecov-action@v5 | ||||
|         uses: codecov/codecov-action@v4 | ||||
|         with: | ||||
|           flags: e2e | ||||
|           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: | ||||
|     if: always() | ||||
|     needs: | ||||
|       - lint | ||||
|       - test-migrations | ||||
| @ -219,31 +204,20 @@ jobs: | ||||
|       - test-e2e | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - uses: re-actors/alls-green@release/v1 | ||||
|         with: | ||||
|           jobs: ${{ toJSON(needs) }} | ||||
|       - run: echo mark | ||||
|   build: | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         arch: | ||||
|           - amd64 | ||||
|           - arm64 | ||||
|     needs: ci-core-mark | ||||
|     runs-on: ubuntu-latest | ||||
|     permissions: | ||||
|       # Needed to upload contianer images to ghcr.io | ||||
|       packages: write | ||||
|       # Needed for attestation | ||||
|       id-token: write | ||||
|       attestations: write | ||||
|     timeout-minutes: 120 | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|         with: | ||||
|           ref: ${{ github.event.pull_request.head.sha }} | ||||
|       - 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 | ||||
|         uses: docker/setup-buildx-action@v3 | ||||
|       - name: prepare variables | ||||
| @ -251,12 +225,9 @@ jobs: | ||||
|         id: ev | ||||
|         env: | ||||
|           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | ||||
|         with: | ||||
|           image-name: ghcr.io/goauthentik/dev-server | ||||
|           image-arch: ${{ matrix.arch }} | ||||
|       - name: Login to Container Registry | ||||
|         if: ${{ steps.ev.outputs.shouldPush == 'true' }} | ||||
|         uses: docker/login-action@v3 | ||||
|         if: ${{ steps.ev.outputs.shouldBuild == 'true' }} | ||||
|         with: | ||||
|           registry: ghcr.io | ||||
|           username: ${{ github.repository_owner }} | ||||
| @ -264,30 +235,75 @@ jobs: | ||||
|       - name: generate ts client | ||||
|         run: make gen-client-ts | ||||
|       - name: Build Docker Image | ||||
|         uses: docker/build-push-action@v6 | ||||
|         id: push | ||||
|         uses: docker/build-push-action@v5 | ||||
|         with: | ||||
|           context: . | ||||
|           secrets: | | ||||
|             GEOIPUPDATE_ACCOUNT_ID=${{ secrets.GEOIPUPDATE_ACCOUNT_ID }} | ||||
|             GEOIPUPDATE_LICENSE_KEY=${{ secrets.GEOIPUPDATE_LICENSE_KEY }} | ||||
|           tags: ${{ steps.ev.outputs.imageTags }} | ||||
|           push: ${{ steps.ev.outputs.shouldPush == 'true' }} | ||||
|           push: ${{ steps.ev.outputs.shouldBuild == 'true' }} | ||||
|           tags: | | ||||
|             ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.branchNameContainer }} | ||||
|             ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.sha }} | ||||
|             ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.branchNameContainer }}-${{ steps.ev.outputs.timestamp }}-${{ steps.ev.outputs.shortHash }} | ||||
|           build-args: | | ||||
|             GIT_BUILD_HASH=${{ steps.ev.outputs.sha }} | ||||
|           cache-from: type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache | ||||
|           cache-to: ${{ steps.ev.outputs.shouldPush == 'true' && 'type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache,mode=max' || '' }} | ||||
|           platforms: linux/${{ matrix.arch }} | ||||
|       - uses: actions/attest-build-provenance@v2 | ||||
|         id: attest | ||||
|         if: ${{ steps.ev.outputs.shouldPush == 'true' }} | ||||
|             VERSION=${{ steps.ev.outputs.version }} | ||||
|             VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }} | ||||
|           cache-from: type=gha | ||||
|           cache-to: type=gha,mode=max | ||||
|   build-arm64: | ||||
|     needs: ci-core-mark | ||||
|     runs-on: ubuntu-latest | ||||
|     permissions: | ||||
|       # Needed to upload contianer images to ghcr.io | ||||
|       packages: write | ||||
|     timeout-minutes: 120 | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|         with: | ||||
|           subject-name: ${{ steps.ev.outputs.attestImageNames }} | ||||
|           subject-digest: ${{ steps.push.outputs.digest }} | ||||
|           push-to-registry: true | ||||
|           ref: ${{ github.event.pull_request.head.sha }} | ||||
|       - name: Set up QEMU | ||||
|         uses: docker/setup-qemu-action@v3.0.0 | ||||
|       - name: Set up Docker Buildx | ||||
|         uses: docker/setup-buildx-action@v3 | ||||
|       - name: prepare variables | ||||
|         uses: ./.github/actions/docker-push-variables | ||||
|         id: ev | ||||
|         env: | ||||
|           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | ||||
|       - name: Login to Container Registry | ||||
|         uses: docker/login-action@v3 | ||||
|         if: ${{ steps.ev.outputs.shouldBuild == 'true' }} | ||||
|         with: | ||||
|           registry: ghcr.io | ||||
|           username: ${{ github.repository_owner }} | ||||
|           password: ${{ secrets.GITHUB_TOKEN }} | ||||
|       - name: generate ts client | ||||
|         run: make gen-client-ts | ||||
|       - name: Build Docker Image | ||||
|         uses: docker/build-push-action@v5 | ||||
|         with: | ||||
|           context: . | ||||
|           secrets: | | ||||
|             GEOIPUPDATE_ACCOUNT_ID=${{ secrets.GEOIPUPDATE_ACCOUNT_ID }} | ||||
|             GEOIPUPDATE_LICENSE_KEY=${{ secrets.GEOIPUPDATE_LICENSE_KEY }} | ||||
|           push: ${{ steps.ev.outputs.shouldBuild == 'true' }} | ||||
|           tags: | | ||||
|             ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.branchNameContainer }}-arm64 | ||||
|             ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.sha }}-arm64 | ||||
|             ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.branchNameContainer }}-${{ steps.ev.outputs.timestamp }}-${{ steps.ev.outputs.shortHash }}-arm64 | ||||
|           build-args: | | ||||
|             GIT_BUILD_HASH=${{ steps.ev.outputs.sha }} | ||||
|             VERSION=${{ steps.ev.outputs.version }} | ||||
|             VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }} | ||||
|           platforms: linux/arm64 | ||||
|           cache-from: type=gha | ||||
|           cache-to: type=gha,mode=max | ||||
|   pr-comment: | ||||
|     needs: | ||||
|       - build | ||||
|       - build-arm64 | ||||
|     runs-on: ubuntu-latest | ||||
|     if: ${{ github.event_name == 'pull_request' }} | ||||
|     permissions: | ||||
| @ -303,10 +319,7 @@ jobs: | ||||
|         id: ev | ||||
|         env: | ||||
|           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | ||||
|         with: | ||||
|           image-name: ghcr.io/goauthentik/dev-server | ||||
|       - name: Comment on PR | ||||
|         if: ${{ steps.ev.outputs.shouldPush == 'true' }} | ||||
|         uses: ./.github/actions/comment-pr-instructions | ||||
|         with: | ||||
|           tag: ${{ steps.ev.outputs.imageMainTag }} | ||||
|           tag: gh-${{ steps.ev.outputs.branchNameContainer }}-${{ steps.ev.outputs.timestamp }}-${{ steps.ev.outputs.shortHash }} | ||||
|  | ||||
							
								
								
									
										41
									
								
								.github/workflows/ci-outpost.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										41
									
								
								.github/workflows/ci-outpost.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,4 +1,3 @@ | ||||
| --- | ||||
| name: authentik-ci-outpost | ||||
|  | ||||
| on: | ||||
| @ -29,9 +28,9 @@ jobs: | ||||
|       - name: Generate API | ||||
|         run: make gen-client-go | ||||
|       - name: golangci-lint | ||||
|         uses: golangci/golangci-lint-action@v6 | ||||
|         uses: golangci/golangci-lint-action@v3 | ||||
|         with: | ||||
|           version: latest | ||||
|           version: v1.54.2 | ||||
|           args: --timeout 5000s --verbose | ||||
|           skip-cache: true | ||||
|   test-unittest: | ||||
| @ -49,15 +48,12 @@ jobs: | ||||
|         run: | | ||||
|           go test -timeout 0 -v -race -coverprofile=coverage.out -covermode=atomic -cover ./... | ||||
|   ci-outpost-mark: | ||||
|     if: always() | ||||
|     needs: | ||||
|       - lint-golint | ||||
|       - test-unittest | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - uses: re-actors/alls-green@release/v1 | ||||
|         with: | ||||
|           jobs: ${{ toJSON(needs) }} | ||||
|       - run: echo mark | ||||
|   build-container: | ||||
|     timeout-minutes: 120 | ||||
|     needs: | ||||
| @ -74,15 +70,12 @@ jobs: | ||||
|     permissions: | ||||
|       # Needed to upload contianer images to ghcr.io | ||||
|       packages: write | ||||
|       # Needed for attestation | ||||
|       id-token: write | ||||
|       attestations: write | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|         with: | ||||
|           ref: ${{ github.event.pull_request.head.sha }} | ||||
|       - 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 | ||||
|         uses: docker/setup-buildx-action@v3 | ||||
|       - name: prepare variables | ||||
| @ -90,11 +83,9 @@ jobs: | ||||
|         id: ev | ||||
|         env: | ||||
|           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | ||||
|         with: | ||||
|           image-name: ghcr.io/goauthentik/dev-${{ matrix.type }} | ||||
|       - name: Login to Container Registry | ||||
|         if: ${{ steps.ev.outputs.shouldPush == 'true' }} | ||||
|         uses: docker/login-action@v3 | ||||
|         if: ${{ steps.ev.outputs.shouldBuild == 'true' }} | ||||
|         with: | ||||
|           registry: ghcr.io | ||||
|           username: ${{ github.repository_owner }} | ||||
| @ -102,25 +93,21 @@ jobs: | ||||
|       - name: Generate API | ||||
|         run: make gen-client-go | ||||
|       - name: Build Docker Image | ||||
|         id: push | ||||
|         uses: docker/build-push-action@v6 | ||||
|         uses: docker/build-push-action@v5 | ||||
|         with: | ||||
|           tags: ${{ steps.ev.outputs.imageTags }} | ||||
|           push: ${{ steps.ev.outputs.shouldBuild == 'true' }} | ||||
|           tags: | | ||||
|             ghcr.io/goauthentik/dev-${{ matrix.type }}:gh-${{ steps.ev.outputs.branchNameContainer }} | ||||
|             ghcr.io/goauthentik/dev-${{ matrix.type }}:gh-${{ steps.ev.outputs.sha }} | ||||
|           file: ${{ matrix.type }}.Dockerfile | ||||
|           push: ${{ steps.ev.outputs.shouldPush == 'true' }} | ||||
|           build-args: | | ||||
|             GIT_BUILD_HASH=${{ steps.ev.outputs.sha }} | ||||
|             VERSION=${{ steps.ev.outputs.version }} | ||||
|             VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }} | ||||
|           platforms: linux/amd64,linux/arm64 | ||||
|           context: . | ||||
|           cache-from: type=registry,ref=ghcr.io/goauthentik/dev-${{ matrix.type }}:buildcache | ||||
|           cache-to: ${{ steps.ev.outputs.shouldPush == 'true' && format('type=registry,ref=ghcr.io/goauthentik/dev-{0}:buildcache,mode=max', matrix.type) || '' }} | ||||
|       - uses: actions/attest-build-provenance@v2 | ||||
|         id: attest | ||||
|         if: ${{ steps.ev.outputs.shouldPush == 'true' }} | ||||
|         with: | ||||
|           subject-name: ${{ steps.ev.outputs.attestImageNames }} | ||||
|           subject-digest: ${{ steps.push.outputs.digest }} | ||||
|           push-to-registry: true | ||||
|           cache-from: type=gha | ||||
|           cache-to: type=gha,mode=max | ||||
|   build-binary: | ||||
|     timeout-minutes: 120 | ||||
|     needs: | ||||
|  | ||||
							
								
								
									
										118
									
								
								.github/workflows/ci-web.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										118
									
								
								.github/workflows/ci-web.yml
									
									
									
									
										vendored
									
									
								
							| @ -12,23 +12,14 @@ on: | ||||
|       - version-* | ||||
|  | ||||
| jobs: | ||||
|   lint: | ||||
|   lint-eslint: | ||||
|     runs-on: ubuntu-latest | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         command: | ||||
|           - lint | ||||
|           - lint:lockfile | ||||
|           - tsc | ||||
|           - prettier-check | ||||
|         project: | ||||
|           - web | ||||
|         include: | ||||
|           - command: tsc | ||||
|             project: web | ||||
|           - command: lit-analyse | ||||
|             project: web | ||||
|           - tests/wdio | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|       - uses: actions/setup-node@v4 | ||||
| @ -37,14 +28,83 @@ jobs: | ||||
|           cache: "npm" | ||||
|           cache-dependency-path: ${{ matrix.project }}/package-lock.json | ||||
|       - working-directory: ${{ matrix.project }}/ | ||||
|         run: | | ||||
|           npm ci | ||||
|         run: npm ci | ||||
|       - name: Generate API | ||||
|         run: make gen-client-ts | ||||
|       - name: Lint | ||||
|       - name: Eslint | ||||
|         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: | ||||
|     needs: | ||||
|       - ci-web-mark | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
| @ -60,31 +120,3 @@ jobs: | ||||
|       - name: build | ||||
|         working-directory: web/ | ||||
|         run: npm run build | ||||
|   ci-web-mark: | ||||
|     if: always() | ||||
|     needs: | ||||
|       - build | ||||
|       - lint | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - uses: re-actors/alls-green@release/v1 | ||||
|         with: | ||||
|           jobs: ${{ toJSON(needs) }} | ||||
|   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 | ||||
|  | ||||
							
								
								
									
										25
									
								
								.github/workflows/ci-website.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										25
									
								
								.github/workflows/ci-website.yml
									
									
									
									
										vendored
									
									
								
							| @ -12,21 +12,20 @@ on: | ||||
|       - version-* | ||||
|  | ||||
| jobs: | ||||
|   lint: | ||||
|   lint-prettier: | ||||
|     runs-on: ubuntu-latest | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         command: | ||||
|           - lint:lockfile | ||||
|           - prettier-check | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|       - uses: actions/setup-node@v4 | ||||
|         with: | ||||
|           node-version-file: website/package.json | ||||
|           cache: "npm" | ||||
|           cache-dependency-path: website/package-lock.json | ||||
|       - working-directory: website/ | ||||
|         run: npm ci | ||||
|       - name: Lint | ||||
|       - name: prettier | ||||
|         working-directory: website/ | ||||
|         run: npm run ${{ matrix.command }} | ||||
|         run: npm run prettier-check | ||||
|   test: | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
| @ -49,6 +48,7 @@ jobs: | ||||
|       matrix: | ||||
|         job: | ||||
|           - build | ||||
|           - build-docs-only | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|       - uses: actions/setup-node@v4 | ||||
| @ -62,13 +62,10 @@ jobs: | ||||
|         working-directory: website/ | ||||
|         run: npm run ${{ matrix.job }} | ||||
|   ci-website-mark: | ||||
|     if: always() | ||||
|     needs: | ||||
|       - lint | ||||
|       - lint-prettier | ||||
|       - test | ||||
|       - build | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - uses: re-actors/alls-green@release/v1 | ||||
|         with: | ||||
|           jobs: ${{ toJSON(needs) }} | ||||
|       - run: echo mark | ||||
|  | ||||
							
								
								
									
										44
									
								
								.github/workflows/gen-update-webauthn-mds.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										44
									
								
								.github/workflows/gen-update-webauthn-mds.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,44 +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: | ||||
|     if: ${{ github.repository != 'goauthentik/authentik-internal' }} | ||||
|     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 | ||||
							
								
								
									
										1
									
								
								.github/workflows/ghcr-retention.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/ghcr-retention.yml
									
									
									
									
										vendored
									
									
								
							| @ -7,7 +7,6 @@ on: | ||||
|  | ||||
| jobs: | ||||
|   clean-ghcr: | ||||
|     if: ${{ github.repository != 'goauthentik/authentik-internal' }} | ||||
|     name: Delete old unused container images | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|  | ||||
							
								
								
									
										2
									
								
								.github/workflows/image-compress.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/workflows/image-compress.yml
									
									
									
									
										vendored
									
									
								
							| @ -42,7 +42,7 @@ jobs: | ||||
|         with: | ||||
|           githubToken: ${{ steps.generate_token.outputs.token }} | ||||
|           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 != '' }}" | ||||
|         id: cpr | ||||
|         with: | ||||
|  | ||||
							
								
								
									
										1
									
								
								.github/workflows/publish-source-docs.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/publish-source-docs.yml
									
									
									
									
										vendored
									
									
								
							| @ -12,7 +12,6 @@ env: | ||||
|  | ||||
| jobs: | ||||
|   publish-source-docs: | ||||
|     if: ${{ github.repository != 'goauthentik/authentik-internal' }} | ||||
|     runs-on: ubuntu-latest | ||||
|     timeout-minutes: 120 | ||||
|     steps: | ||||
|  | ||||
							
								
								
									
										1
									
								
								.github/workflows/release-next-branch.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/release-next-branch.yml
									
									
									
									
										vendored
									
									
								
							| @ -11,7 +11,6 @@ permissions: | ||||
|  | ||||
| jobs: | ||||
|   update-next: | ||||
|     if: ${{ github.repository != 'goauthentik/authentik-internal' }} | ||||
|     runs-on: ubuntu-latest | ||||
|     environment: internal-production | ||||
|     steps: | ||||
|  | ||||
							
								
								
									
										109
									
								
								.github/workflows/release-publish.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										109
									
								
								.github/workflows/release-publish.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,4 +1,3 @@ | ||||
| --- | ||||
| name: authentik-on-release | ||||
|  | ||||
| on: | ||||
| @ -11,22 +10,15 @@ jobs: | ||||
|     permissions: | ||||
|       # Needed to upload contianer images to ghcr.io | ||||
|       packages: write | ||||
|       # Needed for attestation | ||||
|       id-token: write | ||||
|       attestations: write | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|       - 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 | ||||
|         uses: docker/setup-buildx-action@v3 | ||||
|       - name: prepare variables | ||||
|         uses: ./.github/actions/docker-push-variables | ||||
|         id: ev | ||||
|         env: | ||||
|           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | ||||
|         with: | ||||
|           image-name: ghcr.io/goauthentik/server,beryju/authentik | ||||
|       - name: Docker Login Registry | ||||
|         uses: docker/login-action@v3 | ||||
|         with: | ||||
| @ -43,32 +35,29 @@ jobs: | ||||
|           mkdir -p ./gen-ts-api | ||||
|           mkdir -p ./gen-go-api | ||||
|       - name: Build Docker Image | ||||
|         uses: docker/build-push-action@v6 | ||||
|         id: push | ||||
|         uses: docker/build-push-action@v5 | ||||
|         with: | ||||
|           context: . | ||||
|           push: true | ||||
|           push: ${{ github.event_name == 'release' }} | ||||
|           secrets: | | ||||
|             GEOIPUPDATE_ACCOUNT_ID=${{ secrets.GEOIPUPDATE_ACCOUNT_ID }} | ||||
|             GEOIPUPDATE_LICENSE_KEY=${{ secrets.GEOIPUPDATE_LICENSE_KEY }} | ||||
|           build-args: | | ||||
|             VERSION=${{ github.ref }} | ||||
|           tags: ${{ steps.ev.outputs.imageTags }} | ||||
|           tags: | | ||||
|             beryju/authentik:${{ steps.ev.outputs.version }}, | ||||
|             beryju/authentik:${{ steps.ev.outputs.versionFamily }}, | ||||
|             beryju/authentik:latest, | ||||
|             ghcr.io/goauthentik/server:${{ steps.ev.outputs.version }}, | ||||
|             ghcr.io/goauthentik/server:${{ steps.ev.outputs.versionFamily }}, | ||||
|             ghcr.io/goauthentik/server:latest | ||||
|           platforms: linux/amd64,linux/arm64 | ||||
|       - uses: actions/attest-build-provenance@v2 | ||||
|         id: attest | ||||
|         with: | ||||
|           subject-name: ${{ steps.ev.outputs.attestImageNames }} | ||||
|           subject-digest: ${{ steps.push.outputs.digest }} | ||||
|           push-to-registry: true | ||||
|           build-args: | | ||||
|             VERSION=${{ steps.ev.outputs.version }} | ||||
|             VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }} | ||||
|   build-outpost: | ||||
|     runs-on: ubuntu-latest | ||||
|     permissions: | ||||
|       # Needed to upload contianer images to ghcr.io | ||||
|       packages: write | ||||
|       # Needed for attestation | ||||
|       id-token: write | ||||
|       attestations: write | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
| @ -83,16 +72,12 @@ jobs: | ||||
|         with: | ||||
|           go-version-file: "go.mod" | ||||
|       - 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 | ||||
|         uses: docker/setup-buildx-action@v3 | ||||
|       - name: prepare variables | ||||
|         uses: ./.github/actions/docker-push-variables | ||||
|         id: ev | ||||
|         env: | ||||
|           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | ||||
|         with: | ||||
|           image-name: ghcr.io/goauthentik/${{ matrix.type }},beryju/authentik-${{ matrix.type }} | ||||
|       - name: make empty clients | ||||
|         run: | | ||||
|           mkdir -p ./gen-ts-api | ||||
| @ -109,22 +94,22 @@ jobs: | ||||
|           username: ${{ github.repository_owner }} | ||||
|           password: ${{ secrets.GITHUB_TOKEN }} | ||||
|       - name: Build Docker Image | ||||
|         uses: docker/build-push-action@v6 | ||||
|         id: push | ||||
|         uses: docker/build-push-action@v5 | ||||
|         with: | ||||
|           push: true | ||||
|           build-args: | | ||||
|             VERSION=${{ github.ref }} | ||||
|           tags: ${{ steps.ev.outputs.imageTags }} | ||||
|           push: ${{ github.event_name == 'release' }} | ||||
|           tags: | | ||||
|             beryju/authentik-${{ matrix.type }}:${{ steps.ev.outputs.version }}, | ||||
|             beryju/authentik-${{ matrix.type }}:${{ steps.ev.outputs.versionFamily }}, | ||||
|             beryju/authentik-${{ matrix.type }}:latest, | ||||
|             ghcr.io/goauthentik/${{ matrix.type }}:${{ steps.ev.outputs.version }}, | ||||
|             ghcr.io/goauthentik/${{ matrix.type }}:${{ steps.ev.outputs.versionFamily }}, | ||||
|             ghcr.io/goauthentik/${{ matrix.type }}:latest | ||||
|           file: ${{ matrix.type }}.Dockerfile | ||||
|           platforms: linux/amd64,linux/arm64 | ||||
|           context: . | ||||
|       - uses: actions/attest-build-provenance@v2 | ||||
|         id: attest | ||||
|         with: | ||||
|           subject-name: ${{ steps.ev.outputs.attestImageNames }} | ||||
|           subject-digest: ${{ steps.push.outputs.digest }} | ||||
|           push-to-registry: true | ||||
|           build-args: | | ||||
|             VERSION=${{ steps.ev.outputs.version }} | ||||
|             VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }} | ||||
|   build-outpost-binary: | ||||
|     timeout-minutes: 120 | ||||
|     runs-on: ubuntu-latest | ||||
| @ -169,27 +154,6 @@ jobs: | ||||
|           file: ./authentik-outpost-${{ matrix.type }}_${{ matrix.goos }}_${{ matrix.goarch }} | ||||
|           asset_name: authentik-outpost-${{ matrix.type }}_${{ matrix.goos }}_${{ matrix.goarch }} | ||||
|           tag: ${{ github.ref }} | ||||
|   upload-aws-cfn-template: | ||||
|     permissions: | ||||
|       # Needed for AWS login | ||||
|       id-token: write | ||||
|       contents: read | ||||
|     needs: | ||||
|       - build-server | ||||
|       - build-outpost | ||||
|     env: | ||||
|       AWS_REGION: eu-central-1 | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|       - uses: aws-actions/configure-aws-credentials@v4 | ||||
|         with: | ||||
|           role-to-assume: "arn:aws:iam::016170277896:role/github_goauthentik_authentik" | ||||
|           aws-region: ${{ env.AWS_REGION }} | ||||
|       - name: Upload template | ||||
|         run: | | ||||
|           aws s3 cp website/docs/install-config/install/aws/template.yaml s3://authentik-cloudformation-templates/authentik.ecs.${{ github.ref }}.yaml | ||||
|           aws s3 cp website/docs/install-config/install/aws/template.yaml s3://authentik-cloudformation-templates/authentik.ecs.latest.yaml | ||||
|   test-release: | ||||
|     needs: | ||||
|       - build-server | ||||
| @ -200,12 +164,12 @@ jobs: | ||||
|       - uses: actions/checkout@v4 | ||||
|       - name: Run test suite in final docker images | ||||
|         run: | | ||||
|           echo "PG_PASS=$(openssl rand 32 | base64 -w 0)" >> .env | ||||
|           echo "AUTHENTIK_SECRET_KEY=$(openssl rand 32 | base64 -w 0)" >> .env | ||||
|           docker compose pull -q | ||||
|           docker compose up --no-start | ||||
|           docker compose start postgresql redis | ||||
|           docker compose run -u root server test-all | ||||
|           echo "PG_PASS=$(openssl rand -base64 32)" >> .env | ||||
|           echo "AUTHENTIK_SECRET_KEY=$(openssl rand -base64 32)" >> .env | ||||
|           docker-compose pull -q | ||||
|           docker-compose up --no-start | ||||
|           docker-compose start postgresql redis | ||||
|           docker-compose run -u root server test-all | ||||
|   sentry-release: | ||||
|     needs: | ||||
|       - build-server | ||||
| @ -217,18 +181,15 @@ jobs: | ||||
|       - name: prepare variables | ||||
|         uses: ./.github/actions/docker-push-variables | ||||
|         id: ev | ||||
|         env: | ||||
|           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | ||||
|         with: | ||||
|           image-name: ghcr.io/goauthentik/server | ||||
|       - name: Get static files from docker image | ||||
|         run: | | ||||
|           docker pull ${{ steps.ev.outputs.imageMainName }} | ||||
|           container=$(docker container create ${{ steps.ev.outputs.imageMainName }}) | ||||
|           docker pull ghcr.io/goauthentik/server:latest | ||||
|           container=$(docker container create ghcr.io/goauthentik/server:latest) | ||||
|           docker cp ${container}:web/ . | ||||
|       - name: Create a Sentry.io release | ||||
|         uses: getsentry/action-release@v1 | ||||
|         continue-on-error: true | ||||
|         if: ${{ github.event_name == 'release' }} | ||||
|         env: | ||||
|           SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }} | ||||
|           SENTRY_ORG: authentik-security-inc | ||||
|  | ||||
							
								
								
									
										27
									
								
								.github/workflows/release-tag.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										27
									
								
								.github/workflows/release-tag.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,4 +1,3 @@ | ||||
| --- | ||||
| name: authentik-on-tag | ||||
|  | ||||
| on: | ||||
| @ -14,28 +13,28 @@ jobs: | ||||
|       - uses: actions/checkout@v4 | ||||
|       - name: Pre-release test | ||||
|         run: | | ||||
|           echo "PG_PASS=$(openssl rand 32 | base64 -w 0)" >> .env | ||||
|           echo "AUTHENTIK_SECRET_KEY=$(openssl rand 32 | base64 -w 0)" >> .env | ||||
|           echo "PG_PASS=$(openssl rand -base64 32)" >> .env | ||||
|           echo "AUTHENTIK_SECRET_KEY=$(openssl rand -base64 32)" >> .env | ||||
|           docker buildx install | ||||
|           mkdir -p ./gen-ts-api | ||||
|           docker build -t testing:latest . | ||||
|           echo "AUTHENTIK_IMAGE=testing" >> .env | ||||
|           echo "AUTHENTIK_TAG=latest" >> .env | ||||
|           docker compose up --no-start | ||||
|           docker compose start postgresql redis | ||||
|           docker compose run -u root server test-all | ||||
|           docker-compose up --no-start | ||||
|           docker-compose start postgresql redis | ||||
|           docker-compose run -u root server test-all | ||||
|       - id: generate_token | ||||
|         uses: tibdex/github-app-token@v2 | ||||
|         with: | ||||
|           app_id: ${{ secrets.GH_APP_ID }} | ||||
|           private_key: ${{ secrets.GH_APP_PRIVATE_KEY }} | ||||
|       - name: prepare variables | ||||
|         uses: ./.github/actions/docker-push-variables | ||||
|         id: ev | ||||
|         env: | ||||
|           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} | ||||
|       - name: Extract version number | ||||
|         id: get_version | ||||
|         uses: actions/github-script@v7 | ||||
|         with: | ||||
|           image-name: ghcr.io/goauthentik/server | ||||
|           github-token: ${{ steps.generate_token.outputs.token }} | ||||
|           script: | | ||||
|             return context.payload.ref.replace(/\/refs\/tags\/version\//, ''); | ||||
|       - name: Create Release | ||||
|         id: create_release | ||||
|         uses: actions/create-release@v1.1.4 | ||||
| @ -43,6 +42,6 @@ jobs: | ||||
|           GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }} | ||||
|         with: | ||||
|           tag_name: ${{ github.ref }} | ||||
|           release_name: Release ${{ steps.ev.outputs.version }} | ||||
|           release_name: Release ${{ steps.get_version.outputs.result }} | ||||
|           draft: true | ||||
|           prerelease: ${{ steps.ev.outputs.prerelease == 'true' }} | ||||
|           prerelease: false | ||||
|  | ||||
							
								
								
									
										21
									
								
								.github/workflows/repo-mirror.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										21
									
								
								.github/workflows/repo-mirror.yml
									
									
									
									
										vendored
									
									
								
							| @ -1,21 +0,0 @@ | ||||
| name: "authentik-repo-mirror" | ||||
|  | ||||
| on: [push, delete] | ||||
|  | ||||
| jobs: | ||||
|   to_internal: | ||||
|     if: ${{ github.repository != 'goauthentik/authentik-internal' }} | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - uses: actions/checkout@v4 | ||||
|         with: | ||||
|           fetch-depth: 0 | ||||
|       - if: ${{ env.MIRROR_KEY != '' }} | ||||
|         uses: pixta-dev/repository-mirroring-action@v1 | ||||
|         with: | ||||
|           target_repo_url: | ||||
|             git@github.com:goauthentik/authentik-internal.git | ||||
|           ssh_private_key: | ||||
|             ${{ secrets.GH_MIRROR_KEY }} | ||||
|         env: | ||||
|           MIRROR_KEY: ${{ secrets.GH_MIRROR_KEY }} | ||||
							
								
								
									
										3
									
								
								.github/workflows/repo-stale.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.github/workflows/repo-stale.yml
									
									
									
									
										vendored
									
									
								
							| @ -11,7 +11,6 @@ permissions: | ||||
|  | ||||
| jobs: | ||||
|   stale: | ||||
|     if: ${{ github.repository != 'goauthentik/authentik-internal' }} | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - id: generate_token | ||||
| @ -24,7 +23,7 @@ jobs: | ||||
|           repo-token: ${{ steps.generate_token.outputs.token }} | ||||
|           days-before-stale: 60 | ||||
|           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-message: > | ||||
|             This issue has been automatically marked as stale because it has not had | ||||
|  | ||||
| @ -1,8 +1,9 @@ | ||||
| --- | ||||
| name: authentik-backend-translate-extract-compile | ||||
| name: authentik-backend-translate-compile | ||||
| on: | ||||
|   schedule: | ||||
|     - cron: "0 0 * * *" # every day at midnight | ||||
|   push: | ||||
|     branches: [main] | ||||
|     paths: | ||||
|       - "locale/**" | ||||
|   workflow_dispatch: | ||||
| 
 | ||||
| env: | ||||
| @ -24,20 +25,16 @@ jobs: | ||||
|           token: ${{ steps.generate_token.outputs.token }} | ||||
|       - name: Setup authentik env | ||||
|         uses: ./.github/actions/setup | ||||
|       - name: run extract | ||||
|         run: | | ||||
|           poetry run make i18n-extract | ||||
|       - name: run compile | ||||
|         run: | | ||||
|           poetry run ak compilemessages | ||||
|           make web-check-compile | ||||
|         run: poetry run ak compilemessages | ||||
|       - name: Create Pull Request | ||||
|         uses: peter-evans/create-pull-request@v7 | ||||
|         uses: peter-evans/create-pull-request@v6 | ||||
|         id: cpr | ||||
|         with: | ||||
|           token: ${{ steps.generate_token.outputs.token }} | ||||
|           branch: extract-compile-backend-translation | ||||
|           commit-message: "core, web: update translations" | ||||
|           title: "core, web: update translations" | ||||
|           body: "core, web: update translations" | ||||
|           branch: compile-backend-translation | ||||
|           commit-message: "core: compile backend translations" | ||||
|           title: "core: compile backend translations" | ||||
|           body: "core: compile backend translations" | ||||
|           delete-branch: true | ||||
|           signoff: true | ||||
| @ -1,4 +1,4 @@ | ||||
| name: authentik-api-ts-publish | ||||
| name: authentik-web-api-publish | ||||
| on: | ||||
|   push: | ||||
|     branches: [main] | ||||
| @ -7,7 +7,6 @@ on: | ||||
|   workflow_dispatch: | ||||
| jobs: | ||||
|   build: | ||||
|     if: ${{ github.repository != 'goauthentik/authentik-internal' }} | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - id: generate_token | ||||
| @ -32,16 +31,11 @@ jobs: | ||||
|         env: | ||||
|           NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }} | ||||
|       - name: Upgrade /web | ||||
|         working-directory: web | ||||
|         working-directory: web/ | ||||
|         run: | | ||||
|           export VERSION=`node -e 'console.log(require("../gen-ts-api/package.json").version)'` | ||||
|           npm i @goauthentik/api@$VERSION | ||||
|       - name: Upgrade /web/packages/sfe | ||||
|         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 | ||||
|       - uses: peter-evans/create-pull-request@v6 | ||||
|         id: cpr | ||||
|         with: | ||||
|           token: ${{ steps.generate_token.outputs.token }} | ||||
							
								
								
									
										5
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							| @ -10,12 +10,13 @@ | ||||
|         "Gruntfuggly.todo-tree", | ||||
|         "mechatroner.rainbow-csv", | ||||
|         "ms-python.black-formatter", | ||||
|         "charliermarsh.ruff", | ||||
|         "ms-python.isort", | ||||
|         "ms-python.pylint", | ||||
|         "ms-python.python", | ||||
|         "ms-python.vscode-pylance", | ||||
|         "ms-python.black-formatter", | ||||
|         "redhat.vscode-yaml", | ||||
|         "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, | ||||
|             "django": true | ||||
|         } | ||||
|         }, | ||||
|     ] | ||||
| } | ||||
|  | ||||
							
								
								
									
										34
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										34
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							| @ -4,37 +4,33 @@ | ||||
|         "asgi", | ||||
|         "authentik", | ||||
|         "authn", | ||||
|         "entra", | ||||
|         "goauthentik", | ||||
|         "jwe", | ||||
|         "jwks", | ||||
|         "kubernetes", | ||||
|         "oidc", | ||||
|         "openid", | ||||
|         "passwordless", | ||||
|         "plex", | ||||
|         "saml", | ||||
|         "scim", | ||||
|         "slo", | ||||
|         "sso", | ||||
|         "totp", | ||||
|         "webauthn", | ||||
|         "traefik", | ||||
|         "webauthn" | ||||
|         "passwordless", | ||||
|         "kubernetes", | ||||
|         "sso", | ||||
|         "slo", | ||||
|         "scim", | ||||
|     ], | ||||
|     "todo-tree.tree.showCountsInTree": true, | ||||
|     "todo-tree.tree.showBadges": true, | ||||
|     "yaml.customTags": [ | ||||
|         "!Condition sequence", | ||||
|         "!Context scalar", | ||||
|         "!Enumerate sequence", | ||||
|         "!Env scalar", | ||||
|         "!Find sequence", | ||||
|         "!Format sequence", | ||||
|         "!If sequence", | ||||
|         "!Index scalar", | ||||
|         "!KeyOf scalar", | ||||
|         "!Value scalar", | ||||
|         "!AtIndex scalar" | ||||
|         "!Context scalar", | ||||
|         "!Context sequence", | ||||
|         "!Format sequence", | ||||
|         "!Condition sequence", | ||||
|         "!Env sequence", | ||||
|         "!Env scalar", | ||||
|         "!If sequence" | ||||
|     ], | ||||
|     "typescript.preferences.importModuleSpecifier": "non-relative", | ||||
|     "typescript.preferences.importModuleSpecifierEnding": "index", | ||||
| @ -51,7 +47,9 @@ | ||||
|             "ignoreCase": false | ||||
|         } | ||||
|     ], | ||||
|     "go.testFlags": ["-count=1"], | ||||
|     "go.testFlags": [ | ||||
|         "-count=1" | ||||
|     ], | ||||
|     "github-actions.workflows.pinned.workflows": [ | ||||
|         ".github/workflows/ci-main.yml" | ||||
|     ] | ||||
|  | ||||
							
								
								
									
										62
									
								
								.vscode/tasks.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										62
									
								
								.vscode/tasks.json
									
									
									
									
										vendored
									
									
								
							| @ -2,67 +2,85 @@ | ||||
|     "version": "2.0.0", | ||||
|     "tasks": [ | ||||
|         { | ||||
|             "label": "authentik/core: make", | ||||
|             "label": "authentik[core]: format & test", | ||||
|             "command": "poetry", | ||||
|             "args": ["run", "make", "lint-fix", "lint"], | ||||
|             "presentation": { | ||||
|                 "panel": "new" | ||||
|             }, | ||||
|             "group": "test" | ||||
|             "args": [ | ||||
|                 "run", | ||||
|                 "make" | ||||
|             ], | ||||
|             "group": "build", | ||||
|         }, | ||||
|         { | ||||
|             "label": "authentik/core: run", | ||||
|             "label": "authentik[core]: run", | ||||
|             "command": "poetry", | ||||
|             "args": ["run", "ak", "server"], | ||||
|             "args": [ | ||||
|                 "run", | ||||
|                 "make", | ||||
|                 "run", | ||||
|             ], | ||||
|             "group": "build", | ||||
|             "presentation": { | ||||
|                 "panel": "dedicated", | ||||
|                 "group": "running" | ||||
|             } | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             "label": "authentik/web: make", | ||||
|             "label": "authentik[web]: format", | ||||
|             "command": "make", | ||||
|             "args": ["web"], | ||||
|             "group": "build" | ||||
|             "group": "build", | ||||
|         }, | ||||
|         { | ||||
|             "label": "authentik/web: watch", | ||||
|             "label": "authentik[web]: watch", | ||||
|             "command": "make", | ||||
|             "args": ["web-watch"], | ||||
|             "group": "build", | ||||
|             "presentation": { | ||||
|                 "panel": "dedicated", | ||||
|                 "group": "running" | ||||
|             } | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             "label": "authentik: install", | ||||
|             "command": "make", | ||||
|             "args": ["install", "-j4"], | ||||
|             "group": "build" | ||||
|             "args": ["install"], | ||||
|             "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", | ||||
|             "args": ["website"], | ||||
|             "group": "build" | ||||
|             "group": "build", | ||||
|         }, | ||||
|         { | ||||
|             "label": "authentik/website: watch", | ||||
|             "label": "authentik[website]: watch", | ||||
|             "command": "make", | ||||
|             "args": ["website-watch"], | ||||
|             "group": "build", | ||||
|             "presentation": { | ||||
|                 "panel": "dedicated", | ||||
|                 "group": "running" | ||||
|             } | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             "label": "authentik/api: generate", | ||||
|             "label": "authentik[api]: generate", | ||||
|             "command": "poetry", | ||||
|             "args": ["run", "make", "gen"], | ||||
|             "args": [ | ||||
|                 "run", | ||||
|                 "make", | ||||
|                 "gen" | ||||
|             ], | ||||
|             "group": "build" | ||||
|         } | ||||
|         }, | ||||
|     ] | ||||
| } | ||||
|  | ||||
							
								
								
									
										10
									
								
								CODEOWNERS
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								CODEOWNERS
									
									
									
									
									
								
							| @ -19,18 +19,10 @@ Dockerfile                      @goauthentik/infrastructure | ||||
| *Dockerfile                     @goauthentik/infrastructure | ||||
| .dockerignore                   @goauthentik/infrastructure | ||||
| docker-compose.yml              @goauthentik/infrastructure | ||||
| Makefile                        @goauthentik/infrastructure | ||||
| .editorconfig                   @goauthentik/infrastructure | ||||
| CODEOWNERS                      @goauthentik/infrastructure | ||||
| # Web | ||||
| web/                            @goauthentik/frontend | ||||
| tests/wdio/                     @goauthentik/frontend | ||||
| # Locale | ||||
| locale/                         @goauthentik/backend @goauthentik/frontend | ||||
| web/xliff/                      @goauthentik/backend @goauthentik/frontend | ||||
| # Docs & Website | ||||
| website/                        @goauthentik/docs | ||||
| CODE_OF_CONDUCT.md              @goauthentik/docs | ||||
| # Security | ||||
| SECURITY.md                     @goauthentik/security @goauthentik/docs | ||||
| website/docs/security/          @goauthentik/security @goauthentik/docs | ||||
| website/docs/security/          @goauthentik/security | ||||
|  | ||||
| @ -1 +1 @@ | ||||
| website/docs/developer-docs/index.md | ||||
| website/developer-docs/index.md | ||||
							
								
								
									
										61
									
								
								Dockerfile
									
									
									
									
									
								
							
							
						
						
									
										61
									
								
								Dockerfile
									
									
									
									
									
								
							| @ -1,7 +1,7 @@ | ||||
| # syntax=docker/dockerfile:1 | ||||
|  | ||||
| # 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 | ||||
|  | ||||
| @ -14,28 +14,22 @@ RUN --mount=type=bind,target=/work/website/package.json,src=./website/package.js | ||||
|  | ||||
| COPY ./website /work/website/ | ||||
| COPY ./blueprints /work/blueprints/ | ||||
| COPY ./schema.yml /work/ | ||||
| COPY ./SECURITY.md /work/ | ||||
|  | ||||
| RUN npm run build-bundled | ||||
| RUN npm run build-docs-only | ||||
|  | ||||
| # 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 | ||||
|  | ||||
| WORKDIR /work/web | ||||
|  | ||||
| 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/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 \ | ||||
|     npm ci --include=dev | ||||
|  | ||||
| COPY ./package.json /work | ||||
| COPY ./web /work/web/ | ||||
| COPY ./website /work/website/ | ||||
| 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 | ||||
|  | ||||
| # 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.21.6-bookworm AS go-builder | ||||
|  | ||||
| ARG TARGETOS | ||||
| ARG TARGETARCH | ||||
| @ -54,11 +48,6 @@ ARG GOARCH=$TARGETARCH | ||||
|  | ||||
| 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 \ | ||||
|     --mount=type=bind,target=/go/src/goauthentik.io/go.sum,src=./go.sum \ | ||||
|     --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.sum /go/src/goauthentik.io/go.sum | ||||
|  | ||||
| ENV CGO_ENABLED=0 | ||||
|  | ||||
| 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 \ | ||||
|     if [ "$TARGETARCH" = "arm64" ]; then export CC=aarch64-linux-gnu-gcc && export CC_FOR_TARGET=gcc-aarch64-linux-gnu; fi && \ | ||||
|     CGO_ENABLED=1 GOEXPERIMENT="systemcrypto" GOFLAGS="-tags=requirefips" GOARM="${TARGETVARIANT#v}" \ | ||||
|     go build -o /go/authentik ./cmd/server | ||||
|     GOARM="${TARGETVARIANT#v}" go build -o /go/authentik ./cmd/server | ||||
|  | ||||
| # Stage 4: MaxMind GeoIP | ||||
| FROM --platform=${BUILDPLATFORM} ghcr.io/maxmind/geoipupdate:v7.1.0 AS geoip | ||||
| FROM --platform=${BUILDPLATFORM} ghcr.io/maxmind/geoipupdate:v6.1 as geoip | ||||
|  | ||||
| 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_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" | ||||
|  | ||||
| # Stage 5: Python dependencies | ||||
| FROM ghcr.io/goauthentik/fips-python:3.12.7-slim-bookworm-fips-full AS python-deps | ||||
|  | ||||
| ARG TARGETARCH | ||||
| ARG TARGETVARIANT | ||||
| FROM docker.io/python:3.12.1-slim-bookworm AS python-deps | ||||
|  | ||||
| WORKDIR /ak-root/poetry | ||||
|  | ||||
| @ -110,38 +96,36 @@ 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 \ | ||||
|     apt-get update && \ | ||||
|     # 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 \ | ||||
|     --mount=type=bind,target=./poetry.lock,src=./poetry.lock \ | ||||
|     --mount=type=cache,target=/root/.cache/pip \ | ||||
|     --mount=type=cache,target=/root/.cache/pypoetry \ | ||||
|     python -m venv /ak-root/venv/ && \ | ||||
|     bash -c "source ${VENV_PATH}/bin/activate && \ | ||||
|     pip3 install --upgrade pip && \ | ||||
|     pip3 install poetry && \ | ||||
|     poetry install --only=main --no-ansi --no-interaction --no-root && \ | ||||
|     pip install --force-reinstall /wheels/*" | ||||
|     poetry install --only=main --no-ansi --no-interaction | ||||
|  | ||||
| # 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.1-slim-bookworm AS final-image | ||||
|  | ||||
| ARG VERSION | ||||
| ARG GIT_BUILD_HASH | ||||
| ARG VERSION | ||||
| ENV GIT_BUILD_HASH=$GIT_BUILD_HASH | ||||
|  | ||||
| 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.source=https://github.com/goauthentik/authentik | ||||
| LABEL org.opencontainers.image.version=${VERSION} | ||||
| LABEL org.opencontainers.image.revision=${GIT_BUILD_HASH} | ||||
| 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.source https://github.com/goauthentik/authentik | ||||
| LABEL org.opencontainers.image.version ${VERSION} | ||||
| LABEL org.opencontainers.image.revision ${GIT_BUILD_HASH} | ||||
|  | ||||
| WORKDIR / | ||||
|  | ||||
| # We cannot cache this layer otherwise we'll end up with a bigger image | ||||
| RUN apt-get update && \ | ||||
|     # 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 | ||||
|     apt-get install -y --no-install-recommends runit && \ | ||||
|     apt-get clean && \ | ||||
| @ -161,12 +145,11 @@ COPY ./tests /tests | ||||
| COPY ./manage.py / | ||||
| COPY ./blueprints /blueprints | ||||
| COPY ./lifecycle/ /lifecycle | ||||
| COPY ./authentik/sources/kerberos/krb5.conf /etc/krb5.conf | ||||
| COPY --from=go-builder /go/authentik /bin/authentik | ||||
| 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/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 | ||||
|  | ||||
| USER 1000 | ||||
| @ -178,8 +161,6 @@ ENV TMPDIR=/dev/shm/ \ | ||||
|     VENV_PATH="/ak-root/venv" \ | ||||
|     POETRY_VIRTUALENVS_CREATE=false | ||||
|  | ||||
| ENV GOFIPS=1 | ||||
|  | ||||
| HEALTHCHECK --interval=30s --timeout=30s --start-period=60s --retries=3 CMD [ "ak", "healthcheck" ] | ||||
|  | ||||
| ENTRYPOINT [ "dumb-init", "--", "ak" ] | ||||
|  | ||||
							
								
								
									
										112
									
								
								Makefile
									
									
									
									
									
								
							
							
						
						
									
										112
									
								
								Makefile
									
									
									
									
									
								
							| @ -5,13 +5,9 @@ PWD = $(shell pwd) | ||||
| UID = $(shell id -u) | ||||
| GID = $(shell id -g) | ||||
| NPM_VERSION = $(shell python -m scripts.npm_version) | ||||
| PY_SOURCES = authentik tests scripts lifecycle .github website/docs/install-config/install/aws | ||||
| PY_SOURCES = authentik tests scripts lifecycle | ||||
| DOCKER_IMAGE ?= "authentik:test" | ||||
|  | ||||
| GEN_API_TS = "gen-ts-api" | ||||
| GEN_API_PY = "gen-py-api" | ||||
| GEN_API_GO = "gen-go-api" | ||||
|  | ||||
| pg_user := $(shell python -m authentik.lib.config postgresql.user 2>/dev/null) | ||||
| pg_host := $(shell python -m authentik.lib.config postgresql.host 2>/dev/null) | ||||
| pg_name := $(shell python -m authentik.lib.config postgresql.name 2>/dev/null) | ||||
| @ -19,13 +15,13 @@ pg_name := $(shell python -m authentik.lib.config postgresql.name 2>/dev/null) | ||||
| CODESPELL_ARGS = -D - -D .github/codespell-dictionary.txt \ | ||||
| 		-I .github/codespell-words.txt \ | ||||
| 		-S 'web/src/locales/**' \ | ||||
| 		-S 'website/docs/developer-docs/api/reference/**' \ | ||||
| 		authentik \ | ||||
| 		internal \ | ||||
| 		cmd \ | ||||
| 		web/src \ | ||||
| 		website/src \ | ||||
| 		website/blog \ | ||||
| 		website/developer-docs \ | ||||
| 		website/docs \ | ||||
| 		website/integrations \ | ||||
| 		website/src | ||||
| @ -42,16 +38,16 @@ help:  ## Show this help | ||||
| 		sort | ||||
| 	@echo "" | ||||
|  | ||||
| go-test: | ||||
| test-go: | ||||
| 	go test -timeout 0 -v -race -cover ./... | ||||
|  | ||||
| test-docker:  ## Run all tests in a docker-compose | ||||
| 	echo "PG_PASS=$(shell openssl rand 32 | base64 -w 0)" >> .env | ||||
| 	echo "AUTHENTIK_SECRET_KEY=$(shell openssl rand 32 | base64 -w 0)" >> .env | ||||
| 	docker compose pull -q | ||||
| 	docker compose up --no-start | ||||
| 	docker compose start postgresql redis | ||||
| 	docker compose run -u root server test-all | ||||
| 	echo "PG_PASS=$(openssl rand -base64 32)" >> .env | ||||
| 	echo "AUTHENTIK_SECRET_KEY=$(openssl rand -base64 32)" >> .env | ||||
| 	docker-compose pull -q | ||||
| 	docker-compose up --no-start | ||||
| 	docker-compose start postgresql redis | ||||
| 	docker-compose run -u root server test-all | ||||
| 	rm -f .env | ||||
|  | ||||
| test: ## Run the server tests and produce a coverage report (locally) | ||||
| @ -59,15 +55,16 @@ test: ## Run the server tests and produce a coverage report (locally) | ||||
| 	coverage html | ||||
| 	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) | ||||
| 	ruff check --fix $(PY_SOURCES) | ||||
|  | ||||
| lint-codespell:  ## Reports spelling errors. | ||||
| 	ruff --fix $(PY_SOURCES) | ||||
| 	codespell -w $(CODESPELL_ARGS) | ||||
|  | ||||
| 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 | ||||
|  | ||||
| core-install: | ||||
| @ -79,15 +76,7 @@ migrate: ## Run the Authentik Django server's migrations | ||||
| i18n-extract: core-i18n-extract web-i18n-extract  ## Extract strings that require translation into files to send to a translation service | ||||
|  | ||||
| core-i18n-extract: | ||||
| 	ak makemessages \ | ||||
| 		--add-location file \ | ||||
| 		--no-obsolete \ | ||||
| 		--ignore web \ | ||||
| 		--ignore internal \ | ||||
| 		--ignore ${GEN_API_TS} \ | ||||
| 		--ignore ${GEN_API_GO} \ | ||||
| 		--ignore website \ | ||||
| 		-l en | ||||
| 	ak makemessages --ignore web --ignore internal --ignore web --ignore web-api --ignore website -l en | ||||
|  | ||||
| install: web-install website-install core-install  ## Install all requires dependencies for `web`, `website` and `core` | ||||
|  | ||||
| @ -125,7 +114,7 @@ gen-diff:  ## (Release) generate the changelog diff between the current schema a | ||||
| 	docker run \ | ||||
| 		--rm -v ${PWD}:/local \ | ||||
| 		--user ${UID}:${GID} \ | ||||
| 		docker.io/openapitools/openapi-diff:2.1.0-beta.8 \ | ||||
| 		docker.io/openapitools/openapi-diff:2.1.0-beta.6 \ | ||||
| 		--markdown /local/diff.md \ | ||||
| 		/local/old_schema.yml /local/schema.yml | ||||
| 	rm old_schema.yml | ||||
| @ -134,16 +123,13 @@ gen-diff:  ## (Release) generate the changelog diff between the current schema a | ||||
| 	npx prettier --write diff.md | ||||
|  | ||||
| gen-clean-ts:  ## Remove generated API client for Typescript | ||||
| 	rm -rf ./${GEN_API_TS}/ | ||||
| 	rm -rf ./web/node_modules/@goauthentik/api/ | ||||
| 	rm -rf gen-ts-api/ | ||||
| 	rm -rf web/node_modules/@goauthentik/api/ | ||||
|  | ||||
| gen-clean-go:  ## Remove generated API client for Go | ||||
| 	rm -rf ./${GEN_API_GO}/ | ||||
| 	rm -rf gen-go-api/ | ||||
|  | ||||
| gen-clean-py:  ## Remove generated API client for Python | ||||
| 	rm -rf ./${GEN_API_PY}/ | ||||
|  | ||||
| gen-clean: gen-clean-ts gen-clean-go gen-clean-py  ## Remove generated API clients | ||||
| gen-clean: gen-clean-ts gen-clean-go  ## Remove generated API clients | ||||
|  | ||||
| gen-client-ts: gen-clean-ts  ## Build and install the authentik API for Typescript into the authentik UI Application | ||||
| 	docker run \ | ||||
| @ -152,45 +138,31 @@ gen-client-ts: gen-clean-ts  ## Build and install the authentik API for Typescri | ||||
| 		docker.io/openapitools/openapi-generator-cli:v6.5.0 generate \ | ||||
| 		-i /local/schema.yml \ | ||||
| 		-g typescript-fetch \ | ||||
| 		-o /local/${GEN_API_TS} \ | ||||
| 		-o /local/gen-ts-api \ | ||||
| 		-c /local/scripts/api-ts-config.yaml \ | ||||
| 		--additional-properties=npmVersion=${NPM_VERSION} \ | ||||
| 		--git-repo-id authentik \ | ||||
| 		--git-user-id goauthentik | ||||
| 	mkdir -p web/node_modules/@goauthentik/api | ||||
| 	cd ./${GEN_API_TS} && npm i | ||||
| 	\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} | ||||
| 	cd gen-ts-api && npm i | ||||
| 	\cp -rfv gen-ts-api/* web/node_modules/@goauthentik/api | ||||
|  | ||||
| gen-client-go: gen-clean-go  ## Build and install the authentik API for Golang | ||||
| 	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/templates/README.mustache -O ./${GEN_API_GO}/templates/README.mustache | ||||
| 	wget https://raw.githubusercontent.com/goauthentik/client-go/main/templates/go.mod.mustache -O ./${GEN_API_GO}/templates/go.mod.mustache | ||||
| 	cp schema.yml ./${GEN_API_GO}/ | ||||
| 	mkdir -p ./gen-go-api ./gen-go-api/templates | ||||
| 	wget https://raw.githubusercontent.com/goauthentik/client-go/main/config.yaml -O ./gen-go-api/config.yaml | ||||
| 	wget https://raw.githubusercontent.com/goauthentik/client-go/main/templates/README.mustache -O ./gen-go-api/templates/README.mustache | ||||
| 	wget https://raw.githubusercontent.com/goauthentik/client-go/main/templates/go.mod.mustache -O ./gen-go-api/templates/go.mod.mustache | ||||
| 	cp schema.yml ./gen-go-api/ | ||||
| 	docker run \ | ||||
| 		--rm -v ${PWD}/${GEN_API_GO}:/local \ | ||||
| 		--rm -v ${PWD}/gen-go-api:/local \ | ||||
| 		--user ${UID}:${GID} \ | ||||
| 		docker.io/openapitools/openapi-generator-cli:v6.5.0 generate \ | ||||
| 		-i /local/schema.yml \ | ||||
| 		-g go \ | ||||
| 		-o /local/ \ | ||||
| 		-c /local/config.yaml | ||||
| 	go mod edit -replace goauthentik.io/api/v3=./${GEN_API_GO} | ||||
| 	rm -rf ./${GEN_API_GO}/config.yaml ./${GEN_API_GO}/templates/ | ||||
| 	go mod edit -replace goauthentik.io/api/v3=./gen-go-api | ||||
| 	rm -rf ./gen-go-api/config.yaml ./gen-go-api/templates/ | ||||
|  | ||||
| gen-dev-config:  ## Generate a local development config file | ||||
| 	python -m scripts.generate_config | ||||
| @ -204,14 +176,11 @@ gen: gen-build gen-client-ts | ||||
| web-build: web-install  ## Build the Authentik UI | ||||
| 	cd web && npm run build | ||||
|  | ||||
| web: web-lint-fix web-lint web-check-compile  ## Automatically fix formatting issues in the Authentik UI source code, lint the code, and compile it | ||||
| web: web-lint-fix web-lint web-check-compile web-i18n-extract  ## Automatically fix formatting issues in the Authentik UI source code, lint the code, and compile it | ||||
|  | ||||
| web-install:  ## Install the necessary libraries to build the Authentik UI | ||||
| 	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 | ||||
| 	rm -rf web/dist/ | ||||
| 	mkdir web/dist/ | ||||
| @ -243,7 +212,7 @@ website: website-lint-fix website-build  ## Automatically fix formatting issues | ||||
| website-install: | ||||
| 	cd website && npm ci | ||||
|  | ||||
| website-lint-fix: lint-codespell | ||||
| website-lint-fix: | ||||
| 	cd website && npm run prettier | ||||
|  | ||||
| website-build: | ||||
| @ -252,15 +221,11 @@ website-build: | ||||
| website-watch:  ## Build and watch the documentation website, updating automatically | ||||
| 	cd website && npm run watch | ||||
|  | ||||
| aws-cfn: | ||||
| 	cd website && npm run aws-cfn | ||||
|  | ||||
| ######################### | ||||
| ## Docker | ||||
| ######################### | ||||
|  | ||||
| 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} | ||||
|  | ||||
| ######################### | ||||
| @ -273,6 +238,9 @@ ci--meta-debug: | ||||
| 	python -V | ||||
| 	node --version | ||||
|  | ||||
| ci-pylint: ci--meta-debug | ||||
| 	pylint $(PY_SOURCES) | ||||
|  | ||||
| ci-black: ci--meta-debug | ||||
| 	black --check $(PY_SOURCES) | ||||
|  | ||||
| @ -282,8 +250,14 @@ ci-ruff: ci--meta-debug | ||||
| ci-codespell: ci--meta-debug | ||||
| 	codespell $(CODESPELL_ARGS) -s | ||||
|  | ||||
| ci-isort: ci--meta-debug | ||||
| 	isort --check $(PY_SOURCES) | ||||
|  | ||||
| ci-bandit: ci--meta-debug | ||||
| 	bandit -r $(PY_SOURCES) | ||||
|  | ||||
| ci-pyright: ci--meta-debug | ||||
| 	./web/node_modules/.bin/pyright $(PY_SOURCES) | ||||
|  | ||||
| ci-pending-migrations: ci--meta-debug | ||||
| 	ak makemigrations --check | ||||
|  | ||||
							
								
								
									
										12
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										12
									
								
								README.md
									
									
									
									
									
								
							| @ -15,9 +15,7 @@ | ||||
|  | ||||
| ## What is authentik? | ||||
|  | ||||
| authentik is an open-source Identity Provider that emphasizes flexibility and versatility, with support for a wide set of protocols. | ||||
|  | ||||
| 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. | ||||
| 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. | ||||
|  | ||||
| ## Installation | ||||
|  | ||||
| @ -28,13 +26,13 @@ For bigger setups, there is a Helm Chart [here](https://github.com/goauthentik/h | ||||
| ## Screenshots | ||||
|  | ||||
| | Light                                                  | Dark                                                  | | ||||
| | ----------------------------------------------------------- | ---------------------------------------------------------- | | ||||
| |   |   | | ||||
| |  |  | | ||||
| | ------------------------------------------------------ | ----------------------------------------------------- | | ||||
| |   |   | | ||||
| |  |  | | ||||
|  | ||||
| ## 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 | ||||
|  | ||||
|  | ||||
							
								
								
									
										10
									
								
								SECURITY.md
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								SECURITY.md
									
									
									
									
									
								
							| @ -2,7 +2,7 @@ authentik takes security very seriously. We follow the rules of [responsible di | ||||
|  | ||||
| ## Independent audits and pentests | ||||
|  | ||||
| We are committed to engaging in regular pentesting and security audits of authentik. Defining and adhering to a cadence of external testing ensures a stronger probability that our code base, our features, and our architecture is as secure and non-exploitable as possible. For more details about specfic audits and pentests, refer to "Audits and Certificates" in our [Security documentation](https://docs.goauthentik.io/docs/security). | ||||
| In May/June of 2023 [Cure53](https://cure53.de) conducted an audit and pentest. The [results](https://cure53.de/pentest-report_authentik.pdf) are published on the [Cure53 website](https://cure53.de/#publications-2023). For more details about authentik's response to the findings of the audit refer to [2023-06 Cure53 Code audit](https://goauthentik.io/docs/security/2023-06-cure53). | ||||
|  | ||||
| ## What authentik classifies as a CVE | ||||
|  | ||||
| @ -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) | ||||
|  | ||||
| | Version | Supported | | ||||
| | --------- | --------- | | ||||
| | 2024.8.x  | ✅        | | ||||
| | 2024.10.x | ✅        | | ||||
| | --- | --- | | ||||
| | 2023.6.x | ✅ | | ||||
| | 2023.8.x | ✅ | | ||||
|  | ||||
| ## 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: | ||||
|  | ||||
| | Score | Severity | | ||||
| | ---------- | -------- | | ||||
| | --- | --- | | ||||
| | 0.0 | None | | ||||
| | 0.1 – 3.9 | Low | | ||||
| | 4.0 – 6.9 | Medium | | ||||
|  | ||||
| @ -1,12 +1,13 @@ | ||||
| """authentik root module""" | ||||
|  | ||||
| from os import environ | ||||
| from typing import Optional | ||||
|  | ||||
| __version__ = "2024.12.0" | ||||
| __version__ = "2023.10.7" | ||||
| 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""" | ||||
|     build_hash = environ.get(ENV_GIT_HASH_KEY, fallback if fallback else "") | ||||
|     return fallback if build_hash == "" and fallback else build_hash | ||||
|  | ||||
| @ -2,21 +2,18 @@ | ||||
|  | ||||
| import platform | ||||
| from datetime import datetime | ||||
| from ssl import OPENSSL_VERSION | ||||
| from sys import version as python_version | ||||
| from typing import TypedDict | ||||
|  | ||||
| from cryptography.hazmat.backends.openssl.backend import backend | ||||
| from django.utils.timezone import now | ||||
| from drf_spectacular.utils import extend_schema | ||||
| from gunicorn import version_info as gunicorn_version | ||||
| from rest_framework.fields import SerializerMethodField | ||||
| from rest_framework.request import Request | ||||
| from rest_framework.response import Response | ||||
| from rest_framework.views import APIView | ||||
|  | ||||
| from authentik import get_full_version | ||||
| from authentik.core.api.utils import PassiveSerializer | ||||
| from authentik.enterprise.license import LicenseKey | ||||
| from authentik.lib.config import CONFIG | ||||
| from authentik.lib.utils.reflection import get_env | ||||
| from authentik.outposts.apps import MANAGED_OUTPOST | ||||
| @ -28,13 +25,11 @@ class RuntimeDict(TypedDict): | ||||
|     """Runtime information""" | ||||
|  | ||||
|     python_version: str | ||||
|     gunicorn_version: str | ||||
|     environment: str | ||||
|     architecture: str | ||||
|     platform: str | ||||
|     uname: str | ||||
|     openssl_version: str | ||||
|     openssl_fips_enabled: bool | None | ||||
|     authentik_version: str | ||||
|  | ||||
|  | ||||
| class SystemInfoSerializer(PassiveSerializer): | ||||
| @ -69,15 +64,11 @@ class SystemInfoSerializer(PassiveSerializer): | ||||
|     def get_runtime(self, request: Request) -> RuntimeDict: | ||||
|         """Get versions""" | ||||
|         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, | ||||
|             "gunicorn_version": ".".join(str(x) for x in gunicorn_version), | ||||
|             "environment": get_env(), | ||||
|             "architecture": platform.machine(), | ||||
|             "platform": platform.platform(), | ||||
|             "uname": " ".join(platform.uname()), | ||||
|         } | ||||
|  | ||||
|  | ||||
| @ -10,9 +10,8 @@ from rest_framework.response import Response | ||||
| from rest_framework.views import APIView | ||||
|  | ||||
| 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.outposts.models import Outpost | ||||
|  | ||||
|  | ||||
| class VersionSerializer(PassiveSerializer): | ||||
| @ -20,10 +19,8 @@ class VersionSerializer(PassiveSerializer): | ||||
|  | ||||
|     version_current = SerializerMethodField() | ||||
|     version_latest = SerializerMethodField() | ||||
|     version_latest_valid = SerializerMethodField() | ||||
|     build_hash = SerializerMethodField() | ||||
|     outdated = SerializerMethodField() | ||||
|     outpost_outdated = SerializerMethodField() | ||||
|  | ||||
|     def get_build_hash(self, _) -> str: | ||||
|         """Get build hash, if version is not latest or released""" | ||||
| @ -41,23 +38,10 @@ class VersionSerializer(PassiveSerializer): | ||||
|             return __version__ | ||||
|         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: | ||||
|         """Check if we're running the latest version""" | ||||
|         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): | ||||
|     """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 | ||||
| @ -15,3 +15,7 @@ class AuthentikAdminConfig(ManagedAppConfig): | ||||
|     label = "authentik_admin" | ||||
|     verbose_name = "authentik Admin" | ||||
|     default = True | ||||
|  | ||||
|     def reconcile_global_load_admin_signals(self): | ||||
|         """Load admin signals""" | ||||
|         self.import_module("authentik.admin.signals") | ||||
|  | ||||
| @ -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""" | ||||
|  | ||||
| import re | ||||
|  | ||||
| from django.core.cache import cache | ||||
| from django.core.validators import URLValidator | ||||
| from django.db import DatabaseError, InternalError, ProgrammingError | ||||
| from django.utils.translation import gettext_lazy as _ | ||||
| from packaging.version import parse | ||||
| from requests import RequestException | ||||
| 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 | ||||
|  | ||||
| LOGGER = get_logger() | ||||
| VERSION_NULL = "0.0.0" | ||||
| VERSION_CACHE_KEY = "authentik_latest_version" | ||||
| 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__) | ||||
|  | ||||
|  | ||||
| @ -52,7 +55,7 @@ def clear_update_notifications(): | ||||
| def update_latest_version(self: SystemTask): | ||||
|     """Update latest version info""" | ||||
|     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.") | ||||
|         return | ||||
|     try: | ||||
| @ -74,18 +77,12 @@ def update_latest_version(self: SystemTask): | ||||
|                 context__new_version=upstream_version, | ||||
|             ).exists(): | ||||
|                 return | ||||
|             Event.new( | ||||
|                 EventAction.UPDATE_AVAILABLE, | ||||
|                 message=_( | ||||
|                     "New version {version} available!".format( | ||||
|                         version=upstream_version, | ||||
|                     ) | ||||
|                 ), | ||||
|                 new_version=upstream_version, | ||||
|                 changelog=data.get("stable", {}).get("changelog_url"), | ||||
|             ).save() | ||||
|             event_dict = {"new_version": upstream_version} | ||||
|             if match := re.search(URL_FINDER, data.get("stable", {}).get("changelog", "")): | ||||
|                 event_dict["message"] = f"Changelog: {match.group()}" | ||||
|             Event.new(EventAction.UPDATE_AVAILABLE, **event_dict).save() | ||||
|     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) | ||||
|  | ||||
|  | ||||
|  | ||||
| @ -17,7 +17,6 @@ RESPONSE_VALID = { | ||||
|     "stable": { | ||||
|         "version": "99999999.9999999", | ||||
|         "changelog": "See https://goauthentik.io/test", | ||||
|         "changelog_url": "https://goauthentik.io/test", | ||||
|         "reason": "bugfix", | ||||
|     }, | ||||
| } | ||||
| @ -36,7 +35,7 @@ class TestAdminTasks(TestCase): | ||||
|                 Event.objects.filter( | ||||
|                     action=EventAction.UPDATE_AVAILABLE, | ||||
|                     context__new_version="99999999.9999999", | ||||
|                     context__message="New version 99999999.9999999 available!", | ||||
|                     context__message="Changelog: https://goauthentik.io/test", | ||||
|                 ).exists() | ||||
|             ) | ||||
|             # test that a consecutive check doesn't create a duplicate event | ||||
| @ -46,7 +45,7 @@ class TestAdminTasks(TestCase): | ||||
|                     Event.objects.filter( | ||||
|                         action=EventAction.UPDATE_AVAILABLE, | ||||
|                         context__new_version="99999999.9999999", | ||||
|                         context__message="New version 99999999.9999999 available!", | ||||
|                         context__message="Changelog: https://goauthentik.io/test", | ||||
|                     ) | ||||
|                 ), | ||||
|                 1, | ||||
|  | ||||
| @ -6,7 +6,6 @@ from authentik.admin.api.meta import AppsViewSet, ModelViewSet | ||||
| from authentik.admin.api.metrics import AdministrationMetricsViewSet | ||||
| from authentik.admin.api.system import SystemView | ||||
| from authentik.admin.api.version import VersionView | ||||
| from authentik.admin.api.version_history import VersionHistoryViewSet | ||||
| from authentik.admin.api.workers import WorkerView | ||||
|  | ||||
| api_urlpatterns = [ | ||||
| @ -18,7 +17,6 @@ api_urlpatterns = [ | ||||
|         name="admin_metrics", | ||||
|     ), | ||||
|     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/system/", SystemView.as_view(), name="admin_system"), | ||||
| ] | ||||
|  | ||||
| @ -10,3 +10,26 @@ class AuthentikAPIConfig(AppConfig): | ||||
|     label = "authentik_api" | ||||
|     mountpoint = "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""" | ||||
|  | ||||
| from hmac import compare_digest | ||||
| from typing import Any | ||||
| from typing import Any, Optional | ||||
|  | ||||
| from django.conf import settings | ||||
| from drf_spectacular.extensions import OpenApiAuthenticationExtension | ||||
| from rest_framework.authentication import BaseAuthentication, get_authorization_header | ||||
| from rest_framework.exceptions import AuthenticationFailed | ||||
| from rest_framework.request import Request | ||||
| @ -18,7 +17,7 @@ from authentik.providers.oauth2.constants import SCOPE_AUTHENTIK_API | ||||
| 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, | ||||
|     returns type and credentials""" | ||||
|     auth_credentials = header.decode().strip() | ||||
| @ -33,7 +32,7 @@ def validate_auth(header: bytes) -> str | None: | ||||
|     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 ....`""" | ||||
|     user = auth_user_lookup(raw_header) | ||||
|     if not user: | ||||
| @ -43,7 +42,7 @@ def bearer_auth(raw_header: bytes) -> User | None: | ||||
|     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 ....`""" | ||||
|     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") | ||||
|  | ||||
|  | ||||
| def token_secret_key(value: str) -> User | None: | ||||
| def token_secret_key(value: str) -> Optional[User]: | ||||
|     """Check if the token is the secret key | ||||
|     and return the service account for the managed outpost""" | ||||
|     from authentik.outposts.apps import MANAGED_OUTPOST | ||||
| @ -103,14 +102,3 @@ class TokenAuthentication(BaseAuthentication): | ||||
|             return None | ||||
|  | ||||
|         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"} | ||||
|  | ||||
| @ -1,7 +1,7 @@ | ||||
| """API Decorators""" | ||||
| 
 | ||||
| from collections.abc import Callable | ||||
| from functools import wraps | ||||
| from typing import Callable, Optional | ||||
| 
 | ||||
| from rest_framework.request import Request | ||||
| from rest_framework.response import Response | ||||
| @ -11,26 +11,21 @@ from structlog.stdlib import get_logger | ||||
| LOGGER = get_logger() | ||||
| 
 | ||||
| 
 | ||||
| def permission_required(obj_perm: str | None = None, global_perms: list[str] | None = None): | ||||
| def permission_required(obj_perm: Optional[str] = None, global_perms: Optional[list[str]] = None): | ||||
|     """Check permissions for a single custom action""" | ||||
| 
 | ||||
|     def _check_obj_perm(self: ModelViewSet, request: Request): | ||||
|         # Check obj_perm both globally and on the specific object | ||||
|         # Having the global permission has higher priority | ||||
|         if request.user.has_perm(obj_perm): | ||||
|             return | ||||
|         obj = self.get_object() | ||||
|         if not request.user.has_perm(obj_perm, obj): | ||||
|             LOGGER.debug("denying access for object", user=request.user, perm=obj_perm, obj=obj) | ||||
|             self.permission_denied(request) | ||||
| 
 | ||||
|     def wrapper_outer(func: Callable): | ||||
|     def wrapper_outter(func: Callable): | ||||
|         """Check permissions for a single custom action""" | ||||
| 
 | ||||
|         @wraps(func) | ||||
|         def wrapper(self: ModelViewSet, request: Request, *args, **kwargs) -> Response: | ||||
|             if obj_perm: | ||||
|                 _check_obj_perm(self, request) | ||||
|                 obj = self.get_object() | ||||
|                 if not request.user.has_perm(obj_perm, obj): | ||||
|                     LOGGER.debug( | ||||
|                         "denying access for object", user=request.user, perm=obj_perm, obj=obj | ||||
|                     ) | ||||
|                     return self.permission_denied(request) | ||||
|             if global_perms: | ||||
|                 for other_perm in global_perms: | ||||
|                     if not request.user.has_perm(other_perm): | ||||
| @ -40,4 +35,4 @@ def permission_required(obj_perm: str | None = None, global_perms: list[str] | N | ||||
| 
 | ||||
|         return wrapper | ||||
| 
 | ||||
|     return wrapper_outer | ||||
|     return wrapper_outter | ||||
| @ -12,7 +12,6 @@ from drf_spectacular.settings import spectacular_settings | ||||
| from drf_spectacular.types import OpenApiTypes | ||||
| from rest_framework.settings import api_settings | ||||
|  | ||||
| from authentik.api.apps import AuthentikAPIConfig | ||||
| 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["additionalProperties"] = {} | ||||
|     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" %} | ||||
|  | ||||
| {% load authentik_core %} | ||||
| {% load static %} | ||||
|  | ||||
| {% block title %} | ||||
| API Browser - {{ brand.branding_title }} | ||||
| {% endblock %} | ||||
|  | ||||
| {% block head %} | ||||
| <script src="{% versioned_script 'dist/standalone/api-browser/index-%v.js' %}" type="module"></script> | ||||
| <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: dark)"> | ||||
| {% endblock %} | ||||
|  | ||||
| @ -25,17 +25,17 @@ class TestAPIAuth(TestCase): | ||||
|     def test_invalid_type(self): | ||||
|         """Test invalid type""" | ||||
|         with self.assertRaises(AuthenticationFailed): | ||||
|             bearer_auth(b"foo bar") | ||||
|             bearer_auth("foo bar".encode()) | ||||
|  | ||||
|     def test_invalid_empty(self): | ||||
|         """Test invalid type""" | ||||
|         self.assertIsNone(bearer_auth(b"Bearer ")) | ||||
|         self.assertIsNone(bearer_auth(b"")) | ||||
|         self.assertIsNone(bearer_auth("Bearer ".encode())) | ||||
|         self.assertIsNone(bearer_auth("".encode())) | ||||
|  | ||||
|     def test_invalid_no_token(self): | ||||
|         """Test invalid with no token""" | ||||
|         with self.assertRaises(AuthenticationFailed): | ||||
|             auth = b64encode(b":abc").decode() | ||||
|             auth = b64encode(":abc".encode()).decode() | ||||
|             self.assertIsNone(bearer_auth(f"Basic :{auth}".encode())) | ||||
|  | ||||
|     def test_bearer_valid(self): | ||||
|  | ||||
							
								
								
									
										35
									
								
								authentik/api/tests/test_decorators.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										35
									
								
								authentik/api/tests/test_decorators.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,35 @@ | ||||
| """test decorators api""" | ||||
|  | ||||
| from django.urls import reverse | ||||
| from guardian.shortcuts import assign_perm | ||||
| from rest_framework.test import APITestCase | ||||
|  | ||||
| from authentik.core.models import Application, User | ||||
| from authentik.lib.generators import generate_id | ||||
|  | ||||
|  | ||||
| class TestAPIDecorators(APITestCase): | ||||
|     """test decorators api""" | ||||
|  | ||||
|     def setUp(self) -> None: | ||||
|         super().setUp() | ||||
|         self.user = User.objects.create(username="test-user") | ||||
|  | ||||
|     def test_obj_perm_denied(self): | ||||
|         """Test object perm denied""" | ||||
|         self.client.force_login(self.user) | ||||
|         app = Application.objects.create(name=generate_id(), slug=generate_id()) | ||||
|         response = self.client.get( | ||||
|             reverse("authentik_api:application-metrics", kwargs={"slug": app.slug}) | ||||
|         ) | ||||
|         self.assertEqual(response.status_code, 403) | ||||
|  | ||||
|     def test_other_perm_denied(self): | ||||
|         """Test other perm denied""" | ||||
|         self.client.force_login(self.user) | ||||
|         app = Application.objects.create(name=generate_id(), slug=generate_id()) | ||||
|         assign_perm("authentik_core.view_application", self.user, app) | ||||
|         response = self.client.get( | ||||
|             reverse("authentik_api:application-metrics", kwargs={"slug": app.slug}) | ||||
|         ) | ||||
|         self.assertEqual(response.status_code, 403) | ||||
| @ -1,6 +1,6 @@ | ||||
| """authentik API Modelviewset tests""" | ||||
|  | ||||
| from collections.abc import Callable | ||||
| from typing import Callable | ||||
|  | ||||
| from django.test import TestCase | ||||
| 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: | ||||
|     if not issubclass(viewset, ModelViewSet | ReadOnlyModelViewSet): | ||||
|     if not issubclass(viewset, (ModelViewSet, ReadOnlyModelViewSet)): | ||||
|         continue | ||||
|     setattr(TestModelViewSets, f"test_viewset_{viewset.__name__}", viewset_tester_factory(viewset)) | ||||
|  | ||||
| @ -68,11 +68,7 @@ class ConfigView(APIView): | ||||
|         """Get all capabilities this server instance supports""" | ||||
|         caps = [] | ||||
|         deb_test = settings.DEBUG or settings.TEST | ||||
|         if ( | ||||
|             CONFIG.get("storage.media.backend", "file") == "s3" | ||||
|             or Path(settings.STORAGES["default"]["OPTIONS"]["location"]).is_mount() | ||||
|             or deb_test | ||||
|         ): | ||||
|         if Path(settings.MEDIA_ROOT).is_mount() or deb_test: | ||||
|             caps.append(Capabilities.CAN_SAVE_MEDIA) | ||||
|         for processor in get_context_processors(): | ||||
|             if cap := processor.capability(): | ||||
|  | ||||
| @ -33,7 +33,7 @@ for _authentik_app in get_apps(): | ||||
|             app_name=_authentik_app.name, | ||||
|         ) | ||||
|         continue | ||||
|     urls: list = api_urls.api_urlpatterns | ||||
|     urls: list = getattr(api_urls, "api_urlpatterns") | ||||
|     for url in urls: | ||||
|         if isinstance(url, URLPattern): | ||||
|             _other_urls.append(url) | ||||
|  | ||||
| @ -10,13 +10,13 @@ from rest_framework.response import Response | ||||
| from rest_framework.serializers import ListSerializer, ModelSerializer | ||||
| from rest_framework.viewsets import ModelViewSet | ||||
|  | ||||
| from authentik.api.decorators import permission_required | ||||
| from authentik.blueprints.models import BlueprintInstance | ||||
| from authentik.blueprints.v1.importer import Importer | ||||
| from authentik.blueprints.v1.oci import OCI_PREFIX | ||||
| from authentik.blueprints.v1.tasks import apply_blueprint, blueprints_find_dict | ||||
| from authentik.core.api.used_by import UsedByMixin | ||||
| from authentik.core.api.utils import JSONDictField, PassiveSerializer | ||||
| from authentik.rbac.decorators import permission_required | ||||
|  | ||||
|  | ||||
| class ManagedSerializer: | ||||
| @ -51,12 +51,8 @@ class BlueprintInstanceSerializer(ModelSerializer): | ||||
|         context = self.instance.context if self.instance else {} | ||||
|         valid, logs = Importer.from_string(content, context).validate() | ||||
|         if not valid: | ||||
|             raise ValidationError( | ||||
|                 [ | ||||
|                     _("Failed to validate blueprint"), | ||||
|                     *[f"- {x.event}" for x in logs], | ||||
|                 ] | ||||
|             ) | ||||
|             text_logs = "\n".join([x["event"] for x in logs]) | ||||
|             raise ValidationError(_("Failed to validate blueprint: %(logs)s" % {"logs": text_logs})) | ||||
|         return content | ||||
|  | ||||
|     def validate(self, attrs: dict) -> dict: | ||||
|  | ||||
| @ -1,6 +1,5 @@ | ||||
| """authentik Blueprints app""" | ||||
|  | ||||
| from collections.abc import Callable | ||||
| from importlib import import_module | ||||
| from inspect import ismethod | ||||
|  | ||||
| @ -8,46 +7,24 @@ from django.apps import AppConfig | ||||
| from django.db import DatabaseError, InternalError, ProgrammingError | ||||
| from structlog.stdlib import BoundLogger, get_logger | ||||
|  | ||||
| from authentik.root.signals import startup | ||||
|  | ||||
|  | ||||
| class ManagedAppConfig(AppConfig): | ||||
|     """Basic reconciliation logic for apps""" | ||||
|  | ||||
|     logger: BoundLogger | ||||
|  | ||||
|     RECONCILE_GLOBAL_CATEGORY: str = "global" | ||||
|     RECONCILE_TENANT_CATEGORY: str = "tenant" | ||||
|     RECONCILE_GLOBAL_PREFIX: str = "reconcile_global_" | ||||
|     RECONCILE_TENANT_PREFIX: str = "reconcile_tenant_" | ||||
|  | ||||
|     def __init__(self, app_name: str, *args, **kwargs) -> None: | ||||
|         super().__init__(app_name, *args, **kwargs) | ||||
|         self.logger = get_logger().bind(app_name=app_name) | ||||
|  | ||||
|     def ready(self) -> None: | ||||
|         self.import_related() | ||||
|         startup.connect(self._on_startup_callback, dispatch_uid=self.label) | ||||
|         self.reconcile_global() | ||||
|         self.reconcile_tenant() | ||||
|         return super().ready() | ||||
|  | ||||
|     def _on_startup_callback(self, sender, **_): | ||||
|         self._reconcile_global() | ||||
|         self._reconcile_tenant() | ||||
|  | ||||
|     def import_related(self): | ||||
|         """Automatically import related modules which rely on just being imported | ||||
|         to register themselves (mainly django signals and celery tasks)""" | ||||
|  | ||||
|         def import_relative(rel_module: str): | ||||
|             try: | ||||
|                 module_name = f"{self.name}.{rel_module}" | ||||
|                 import_module(module_name) | ||||
|                 self.logger.info("Imported related module", module=module_name) | ||||
|             except ModuleNotFoundError: | ||||
|                 pass | ||||
|  | ||||
|         import_relative("checks") | ||||
|         import_relative("tasks") | ||||
|         import_relative("signals") | ||||
|  | ||||
|     def import_module(self, path: str): | ||||
|         """Load module""" | ||||
|         import_module(path) | ||||
| @ -57,8 +34,7 @@ class ManagedAppConfig(AppConfig): | ||||
|             meth = getattr(self, meth_name) | ||||
|             if not ismethod(meth): | ||||
|                 continue | ||||
|             category = getattr(meth, "_authentik_managed_reconcile", None) | ||||
|             if category != prefix: | ||||
|             if not meth_name.startswith(prefix): | ||||
|                 continue | ||||
|             name = meth_name.replace(prefix, "") | ||||
|             try: | ||||
| @ -68,19 +44,7 @@ class ManagedAppConfig(AppConfig): | ||||
|             except (DatabaseError, ProgrammingError, InternalError) as exc: | ||||
|                 self.logger.warning("Failed to run reconcile", name=name, exc=exc) | ||||
|  | ||||
|     @staticmethod | ||||
|     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: | ||||
|     def reconcile_tenant(self) -> None: | ||||
|         """reconcile ourselves for tenanted methods""" | ||||
|         from authentik.tenants.models import Tenant | ||||
|  | ||||
| @ -91,9 +55,9 @@ class ManagedAppConfig(AppConfig): | ||||
|             return | ||||
|         for tenant in tenants: | ||||
|             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. | ||||
|         Used for signals, tasks, etc. Database queries should not be made in here. | ||||
| @ -101,7 +65,7 @@ class ManagedAppConfig(AppConfig): | ||||
|         from django_tenants.utils import get_public_schema_name, schema_context | ||||
|  | ||||
|         with schema_context(get_public_schema_name()): | ||||
|             self._reconcile(self.RECONCILE_GLOBAL_CATEGORY) | ||||
|             self._reconcile(self.RECONCILE_GLOBAL_PREFIX) | ||||
|  | ||||
|  | ||||
| class AuthentikBlueprintsConfig(ManagedAppConfig): | ||||
| @ -112,13 +76,11 @@ class AuthentikBlueprintsConfig(ManagedAppConfig): | ||||
|     verbose_name = "authentik Blueprints" | ||||
|     default = True | ||||
|  | ||||
|     @ManagedAppConfig.reconcile_global | ||||
|     def load_blueprints_v1_tasks(self): | ||||
|     def reconcile_global_load_blueprints_v1_tasks(self): | ||||
|         """Load v1 tasks""" | ||||
|         self.import_module("authentik.blueprints.v1.tasks") | ||||
|  | ||||
|     @ManagedAppConfig.reconcile_tenant | ||||
|     def blueprints_discovery(self): | ||||
|     def reconcile_tenant_blueprints_discovery(self): | ||||
|         """Run blueprint discovery""" | ||||
|         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", []): | ||||
|                     content = BlueprintInstance(path=blueprint_path).retrieve() | ||||
|                     importer = Importer.from_string(content) | ||||
|                     valid, logs = importer.validate() | ||||
|                     valid, _ = importer.validate() | ||||
|                     if not valid: | ||||
|                         self.stderr.write("Blueprint invalid") | ||||
|                         for log in logs: | ||||
|                             self.stderr.write(f"\t{log.logger}: {log.event}: {log.attributes}") | ||||
|                         self.stderr.write("blueprint invalid") | ||||
|                         sys_exit(1) | ||||
|                     importer.apply() | ||||
|  | ||||
|  | ||||
| @ -4,14 +4,12 @@ from json import dumps | ||||
| from typing import Any | ||||
|  | ||||
| from django.core.management.base import BaseCommand, no_translations | ||||
| from django.db.models import Model, fields | ||||
| from drf_jsonschema_serializer.convert import converter, field_to_converter | ||||
| from django.db.models import Model | ||||
| from drf_jsonschema_serializer.convert import field_to_converter | ||||
| from rest_framework.fields import Field, JSONField, UUIDField | ||||
| from rest_framework.relations import PrimaryKeyRelatedField | ||||
| from rest_framework.serializers import Serializer | ||||
| from structlog.stdlib import get_logger | ||||
|  | ||||
| from authentik import __version__ | ||||
| from authentik.blueprints.v1.common import BlueprintEntryDesiredState | ||||
| from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT, is_model_allowed | ||||
| from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry | ||||
| @ -20,23 +18,6 @@ from authentik.lib.models import SerializerModel | ||||
| 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): | ||||
|     """Generate JSON Schema for blueprints""" | ||||
|  | ||||
| @ -48,7 +29,7 @@ class Command(BaseCommand): | ||||
|             "$schema": "http://json-schema.org/draft-07/schema", | ||||
|             "$id": "https://goauthentik.io/blueprints/schema.json", | ||||
|             "type": "object", | ||||
|             "title": f"authentik {__version__} Blueprint schema", | ||||
|             "title": "authentik Blueprint schema", | ||||
|             "required": ["version", "entries"], | ||||
|             "properties": { | ||||
|                 "version": { | ||||
| @ -113,19 +94,16 @@ class Command(BaseCommand): | ||||
|             ) | ||||
|             model_path = f"{model._meta.app_label}.{model._meta.model_name}" | ||||
|             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""" | ||||
|         model_schema = self.to_jsonschema(serializer) | ||||
|         model_schema["required"] = [] | ||||
|         def_name = f"model_{model_path}" | ||||
|         def_path = f"#/$defs/{def_name}" | ||||
|         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 { | ||||
|             "type": "object", | ||||
|             "required": ["model", "identifiers"], | ||||
| @ -138,7 +116,6 @@ class Command(BaseCommand): | ||||
|                     "default": "present", | ||||
|                 }, | ||||
|                 "conditions": {"type": "array", "items": {"type": "boolean"}}, | ||||
|                 "permissions": {"$ref": def_path_perm}, | ||||
|                 "attrs": {"$ref": def_path}, | ||||
|                 "identifiers": {"$ref": def_path}, | ||||
|             }, | ||||
| @ -189,20 +166,3 @@ class Command(BaseCommand): | ||||
|         if required: | ||||
|             result["required"] = required | ||||
|         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: | ||||
|             return | ||||
|         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"))) | ||||
|     meta = None | ||||
|     if metadata: | ||||
|  | ||||
| @ -71,19 +71,6 @@ class BlueprintInstance(SerializerModel, ManagedModel, CreatedUpdatedModel): | ||||
|     enabled = models.BooleanField(default=True) | ||||
|     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: | ||||
|         """Get blueprint from an OCI registry""" | ||||
|         client = BlueprintOCIClient(self.path.replace(OCI_PREFIX, "https://")) | ||||
| @ -102,7 +89,7 @@ class BlueprintInstance(SerializerModel, ManagedModel, CreatedUpdatedModel): | ||||
|                 raise BlueprintRetrievalFailed("Invalid blueprint path") | ||||
|             with full_path.open("r", encoding="utf-8") as _file: | ||||
|                 return _file.read() | ||||
|         except OSError as exc: | ||||
|         except (IOError, OSError) as exc: | ||||
|             raise BlueprintRetrievalFailed(exc) from exc | ||||
|  | ||||
|     def retrieve(self) -> str: | ||||
| @ -118,3 +105,16 @@ class BlueprintInstance(SerializerModel, ManagedModel, CreatedUpdatedModel): | ||||
|         from authentik.blueprints.api import 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""" | ||||
|  | ||||
| from collections.abc import Callable | ||||
| from functools import wraps | ||||
| from typing import Callable | ||||
|  | ||||
| from django.apps import apps | ||||
|  | ||||
| @ -39,7 +39,7 @@ def reconcile_app(app_name: str): | ||||
|         def wrapper(*args, **kwargs): | ||||
|             config = apps.get_app_config(app_name) | ||||
|             if isinstance(config, ManagedAppConfig): | ||||
|                 config._on_startup_callback(None) | ||||
|                 config.ready() | ||||
|             return func(*args, **kwargs) | ||||
|  | ||||
|         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 | ||||
| @ -146,10 +146,6 @@ entries: | ||||
|                   ] | ||||
|               ] | ||||
|               nested_context: !Context context2 | ||||
|               at_index_sequence: !AtIndex [!Context sequence, 0] | ||||
|               at_index_sequence_default: !AtIndex [!Context sequence, 100, "non existent"] | ||||
|               at_index_mapping: !AtIndex [!Context mapping, "key2"] | ||||
|               at_index_mapping_default: !AtIndex [!Context mapping, "invalid", "non existent"] | ||||
|       identifiers: | ||||
|           name: test | ||||
|       conditions: | ||||
|  | ||||
| @ -1,7 +1,7 @@ | ||||
| """test packaged blueprints""" | ||||
|  | ||||
| from collections.abc import Callable | ||||
| from pathlib import Path | ||||
| from typing import Callable | ||||
|  | ||||
| from django.test import TransactionTestCase | ||||
|  | ||||
| @ -27,8 +27,7 @@ def blueprint_tester(file_name: Path) -> Callable: | ||||
|         base = Path("blueprints/") | ||||
|         rel_path = Path(file_name).relative_to(base) | ||||
|         importer = Importer.from_string(BlueprintInstance(path=str(rel_path)).retrieve()) | ||||
|         validation, logs = importer.validate() | ||||
|         self.assertTrue(validation, logs) | ||||
|         self.assertTrue(importer.validate()[0]) | ||||
|         self.assertTrue(importer.apply()) | ||||
|  | ||||
|     return tester | ||||
|  | ||||
| @ -1,6 +1,6 @@ | ||||
| """authentik managed models tests""" | ||||
|  | ||||
| from collections.abc import Callable | ||||
| from typing import Callable, Type | ||||
|  | ||||
| from django.apps import apps | ||||
| from django.test import TestCase | ||||
| @ -14,7 +14,7 @@ class TestModels(TestCase): | ||||
|     """Test Models""" | ||||
|  | ||||
|  | ||||
| def serializer_tester_factory(test_model: type[SerializerModel]) -> Callable: | ||||
| def serializer_tester_factory(test_model: Type[SerializerModel]) -> Callable: | ||||
|     """Test serializer""" | ||||
|  | ||||
|     def tester(self: TestModels): | ||||
|  | ||||
| @ -215,10 +215,6 @@ class TestBlueprintsV1(TransactionTestCase): | ||||
|                     }, | ||||
|                     "nested_context": "context-nested-value", | ||||
|                     "env_null": None, | ||||
|                     "at_index_sequence": "foo", | ||||
|                     "at_index_sequence_default": "non existent", | ||||
|                     "at_index_mapping": 2, | ||||
|                     "at_index_mapping_default": "non existent", | ||||
|                 } | ||||
|             ).exists() | ||||
|         ) | ||||
|  | ||||
| @ -78,5 +78,5 @@ class TestBlueprintsV1API(APITestCase): | ||||
|         self.assertEqual(res.status_code, 400) | ||||
|         self.assertJSONEqual( | ||||
|             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_hash = sha512(file.read().encode()).hexdigest() | ||||
|             file.flush() | ||||
|             blueprints_discovery() | ||||
|             blueprints_discovery()  # pylint: disable=no-value-for-parameter | ||||
|             instance = BlueprintInstance.objects.filter(name=blueprint_id).first() | ||||
|             self.assertEqual(instance.last_applied_hash, file_hash) | ||||
|             self.assertEqual( | ||||
| @ -82,7 +82,7 @@ class TestBlueprintsV1Tasks(TransactionTestCase): | ||||
|                 ) | ||||
|             ) | ||||
|             file.flush() | ||||
|             blueprints_discovery() | ||||
|             blueprints_discovery()  # pylint: disable=no-value-for-parameter | ||||
|             blueprint = BlueprintInstance.objects.filter(name="foo").first() | ||||
|             self.assertEqual( | ||||
|                 blueprint.last_applied_hash, | ||||
| @ -107,7 +107,7 @@ class TestBlueprintsV1Tasks(TransactionTestCase): | ||||
|                 ) | ||||
|             ) | ||||
|             file.flush() | ||||
|             blueprints_discovery() | ||||
|             blueprints_discovery()  # pylint: disable=no-value-for-parameter | ||||
|             blueprint.refresh_from_db() | ||||
|             self.assertEqual( | ||||
|                 blueprint.last_applied_hash, | ||||
| @ -149,7 +149,7 @@ class TestBlueprintsV1Tasks(TransactionTestCase): | ||||
|                 instance.status, | ||||
|                 BlueprintInstanceStatus.UNKNOWN, | ||||
|             ) | ||||
|             apply_blueprint(instance.pk) | ||||
|             apply_blueprint(instance.pk)  # pylint: disable=no-value-for-parameter | ||||
|             instance.refresh_from_db() | ||||
|             self.assertEqual(instance.last_applied_hash, "") | ||||
|             self.assertEqual( | ||||
|  | ||||
| @ -1,14 +1,13 @@ | ||||
| """transfer common classes""" | ||||
|  | ||||
| from collections import OrderedDict | ||||
| from collections.abc import Generator, Iterable, Mapping | ||||
| from copy import copy | ||||
| from dataclasses import asdict, dataclass, field, is_dataclass | ||||
| from enum import Enum | ||||
| from functools import reduce | ||||
| from operator import ixor | ||||
| from os import getenv | ||||
| from typing import Any, Literal, Union | ||||
| from typing import Any, Iterable, Literal, Mapping, Optional, Union | ||||
| from uuid import UUID | ||||
|  | ||||
| from deepmerge import always_merger | ||||
| @ -24,10 +23,6 @@ from authentik.lib.sentry import SentryIgnoredException | ||||
| from authentik.policies.models import PolicyBindingModel | ||||
|  | ||||
|  | ||||
| class UNSET: | ||||
|     """Used to test whether a key has not been set.""" | ||||
|  | ||||
|  | ||||
| def get_attrs(obj: SerializerModel) -> dict[str, Any]: | ||||
|     """Get object's attributes via their serializer, and convert it to a normal dict""" | ||||
|     serializer: Serializer = obj.serializer(obj) | ||||
| @ -50,7 +45,7 @@ def get_attrs(obj: SerializerModel) -> dict[str, Any]: | ||||
| class BlueprintEntryState: | ||||
|     """State of a single instance""" | ||||
|  | ||||
|     instance: Model | None = None | ||||
|     instance: Optional[Model] = None | ||||
|  | ||||
|  | ||||
| class BlueprintEntryDesiredState(Enum): | ||||
| @ -62,15 +57,6 @@ class BlueprintEntryDesiredState(Enum): | ||||
|     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 | ||||
| class BlueprintEntry: | ||||
|     """Single entry of a blueprint""" | ||||
| @ -81,15 +67,14 @@ class BlueprintEntry: | ||||
|     ) | ||||
|     conditions: list[Any] = field(default_factory=list) | ||||
|     identifiers: dict[str, Any] = field(default_factory=dict) | ||||
|     attrs: dict[str, Any] | None = field(default_factory=dict) | ||||
|     permissions: list[BlueprintEntryPermission] = field(default_factory=list) | ||||
|     attrs: Optional[dict[str, Any]] = field(default_factory=dict) | ||||
|  | ||||
|     id: str | None = None | ||||
|     id: Optional[str] = None | ||||
|  | ||||
|     _state: BlueprintEntryState = field(default_factory=BlueprintEntryState) | ||||
|  | ||||
|     def __post_init__(self, *args, **kwargs) -> None: | ||||
|         self.__tag_contexts: list[YAMLTagContext] = [] | ||||
|         self.__tag_contexts: list["YAMLTagContext"] = [] | ||||
|  | ||||
|     @staticmethod | ||||
|     def from_model(model: SerializerModel, *extra_identifier_names: str) -> "BlueprintEntry": | ||||
| @ -107,10 +92,10 @@ class BlueprintEntry: | ||||
|             attrs=all_attrs, | ||||
|         ) | ||||
|  | ||||
|     def get_tag_context( | ||||
|     def _get_tag_context( | ||||
|         self, | ||||
|         depth: int = 0, | ||||
|         context_tag_type: type["YAMLTagContext"] | tuple["YAMLTagContext", ...] | None = None, | ||||
|         context_tag_type: Optional[type["YAMLTagContext"] | tuple["YAMLTagContext", ...]] = None, | ||||
|     ) -> "YAMLTagContext": | ||||
|         """Get a YAMLTagContext object located at a certain depth in the tag tree""" | ||||
|         if depth < 0: | ||||
| @ -123,8 +108,8 @@ class BlueprintEntry: | ||||
|  | ||||
|         try: | ||||
|             return contexts[-(depth + 1)] | ||||
|         except IndexError as exc: | ||||
|             raise ValueError(f"invalid depth: {depth}. Max depth: {len(contexts) - 1}") from exc | ||||
|         except IndexError: | ||||
|             raise ValueError(f"invalid depth: {depth}. Max depth: {len(contexts) - 1}") | ||||
|  | ||||
|     def tag_resolver(self, value: Any, blueprint: "Blueprint") -> Any: | ||||
|         """Check if we have any special tags that need handling""" | ||||
| @ -164,17 +149,6 @@ class BlueprintEntry: | ||||
|         """Get the blueprint model, with yaml tags resolved if present""" | ||||
|         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: | ||||
|         """Check all conditions of this entry match (evaluate to True)""" | ||||
|         return all(self.tag_resolver(self.conditions, blueprint)) | ||||
| @ -196,7 +170,7 @@ class Blueprint: | ||||
|     entries: list[BlueprintEntry] = field(default_factory=list) | ||||
|     context: dict = field(default_factory=dict) | ||||
|  | ||||
|     metadata: BlueprintMetadata | None = field(default=None) | ||||
|     metadata: Optional[BlueprintMetadata] = field(default=None) | ||||
|  | ||||
|  | ||||
| class YAMLTag: | ||||
| @ -244,7 +218,7 @@ class Env(YAMLTag): | ||||
|     """Lookup environment variable with optional default""" | ||||
|  | ||||
|     key: str | ||||
|     default: Any | None | ||||
|     default: Optional[Any] | ||||
|  | ||||
|     def __init__(self, loader: "BlueprintLoader", node: ScalarNode | SequenceNode) -> None: | ||||
|         super().__init__() | ||||
| @ -263,7 +237,7 @@ class Context(YAMLTag): | ||||
|     """Lookup key from instance context""" | ||||
|  | ||||
|     key: str | ||||
|     default: Any | None | ||||
|     default: Optional[Any] | ||||
|  | ||||
|     def __init__(self, loader: "BlueprintLoader", node: ScalarNode | SequenceNode) -> None: | ||||
|         super().__init__() | ||||
| @ -307,7 +281,7 @@ class Format(YAMLTag): | ||||
|         try: | ||||
|             return self.format_string % tuple(args) | ||||
|         except TypeError as exc: | ||||
|             raise EntryInvalidError.from_entry(exc, entry) from exc | ||||
|             raise EntryInvalidError.from_entry(exc, entry) | ||||
|  | ||||
|  | ||||
| class Find(YAMLTag): | ||||
| @ -332,10 +306,7 @@ class Find(YAMLTag): | ||||
|         else: | ||||
|             model_name = self.model_name | ||||
|  | ||||
|         try: | ||||
|         model_class = apps.get_model(*model_name.split(".")) | ||||
|         except LookupError as exc: | ||||
|             raise EntryInvalidError.from_entry(exc, entry) from exc | ||||
|  | ||||
|         query = Q() | ||||
|         for cond in self.conditions: | ||||
| @ -395,7 +366,7 @@ class Condition(YAMLTag): | ||||
|             comparator = self._COMPARATORS[self.mode.upper()] | ||||
|             return comparator(tuple(bool(x) for x in args)) | ||||
|         except (TypeError, KeyError) as exc: | ||||
|             raise EntryInvalidError.from_entry(exc, entry) from exc | ||||
|             raise EntryInvalidError.from_entry(exc, entry) | ||||
|  | ||||
|  | ||||
| class If(YAMLTag): | ||||
| @ -427,7 +398,7 @@ class If(YAMLTag): | ||||
|                 blueprint, | ||||
|             ) | ||||
|         except TypeError as exc: | ||||
|             raise EntryInvalidError.from_entry(exc, entry) from exc | ||||
|             raise EntryInvalidError.from_entry(exc, entry) | ||||
|  | ||||
|  | ||||
| class Enumerate(YAMLTag, YAMLTagContext): | ||||
| @ -441,7 +412,9 @@ class Enumerate(YAMLTag, YAMLTagContext): | ||||
|         "SEQ": (list, lambda a, b: [*a, b]), | ||||
|         "MAP": ( | ||||
|             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 | ||||
|             ), | ||||
|         ), | ||||
|     } | ||||
|  | ||||
| @ -483,7 +456,7 @@ class Enumerate(YAMLTag, YAMLTagContext): | ||||
|         try: | ||||
|             output_class, add_fn = self._OUTPUT_BODIES[self.output_body.upper()] | ||||
|         except KeyError as exc: | ||||
|             raise EntryInvalidError.from_entry(exc, entry) from exc | ||||
|             raise EntryInvalidError.from_entry(exc, entry) | ||||
|  | ||||
|         result = output_class() | ||||
|  | ||||
| @ -511,13 +484,13 @@ class EnumeratedItem(YAMLTag): | ||||
|  | ||||
|     _SUPPORTED_CONTEXT_TAGS = (Enumerate,) | ||||
|  | ||||
|     def __init__(self, _loader: "BlueprintLoader", node: ScalarNode) -> None: | ||||
|     def __init__(self, loader: "BlueprintLoader", node: ScalarNode) -> None: | ||||
|         super().__init__() | ||||
|         self.depth = int(node.value) | ||||
|  | ||||
|     def resolve(self, entry: BlueprintEntry, blueprint: Blueprint) -> Any: | ||||
|         try: | ||||
|             context_tag: Enumerate = entry.get_tag_context( | ||||
|             context_tag: Enumerate = entry._get_tag_context( | ||||
|                 depth=self.depth, | ||||
|                 context_tag_type=EnumeratedItem._SUPPORTED_CONTEXT_TAGS, | ||||
|             ) | ||||
| @ -527,11 +500,9 @@ class EnumeratedItem(YAMLTag): | ||||
|                     f"{self.__class__.__name__} tags are only usable " | ||||
|                     f"inside an {Enumerate.__name__} tag", | ||||
|                     entry, | ||||
|                 ) from exc | ||||
|                 ) | ||||
|  | ||||
|             raise EntryInvalidError.from_entry( | ||||
|                 f"{self.__class__.__name__} tag: {exc}", entry | ||||
|             ) from exc | ||||
|             raise EntryInvalidError.from_entry(f"{self.__class__.__name__} tag: {exc}", entry) | ||||
|  | ||||
|         return context_tag.get_context(entry, blueprint) | ||||
|  | ||||
| @ -544,8 +515,8 @@ class Index(EnumeratedItem): | ||||
|  | ||||
|         try: | ||||
|             return context[0] | ||||
|         except IndexError as exc:  # pragma: no cover | ||||
|             raise EntryInvalidError.from_entry(f"Empty/invalid context: {context}", entry) from exc | ||||
|         except IndexError:  # pragma: no cover | ||||
|             raise EntryInvalidError.from_entry(f"Empty/invalid context: {context}", entry) | ||||
|  | ||||
|  | ||||
| class Value(EnumeratedItem): | ||||
| @ -556,55 +527,8 @@ class Value(EnumeratedItem): | ||||
|  | ||||
|         try: | ||||
|             return context[1] | ||||
|         except IndexError as exc:  # pragma: no cover | ||||
|             raise EntryInvalidError.from_entry(f"Empty/invalid context: {context}", entry) from exc | ||||
|  | ||||
|  | ||||
| class AtIndex(YAMLTag): | ||||
|     """Get value at index of a sequence or mapping""" | ||||
|  | ||||
|     obj: YAMLTag | dict | list | tuple | ||||
|     attribute: int | str | YAMLTag | ||||
|     default: Any | UNSET | ||||
|  | ||||
|     def __init__(self, loader: "BlueprintLoader", node: SequenceNode) -> None: | ||||
|         super().__init__() | ||||
|         self.obj = loader.construct_object(node.value[0]) | ||||
|         self.attribute = loader.construct_object(node.value[1]) | ||||
|         if len(node.value) == 2:  # noqa: PLR2004 | ||||
|             self.default = UNSET | ||||
|         else: | ||||
|             self.default = loader.construct_object(node.value[2]) | ||||
|  | ||||
|     def resolve(self, entry: BlueprintEntry, blueprint: Blueprint) -> Any: | ||||
|         if isinstance(self.obj, YAMLTag): | ||||
|             obj = self.obj.resolve(entry, blueprint) | ||||
|         else: | ||||
|             obj = self.obj | ||||
|         if isinstance(self.attribute, YAMLTag): | ||||
|             attribute = self.attribute.resolve(entry, blueprint) | ||||
|         else: | ||||
|             attribute = self.attribute | ||||
|  | ||||
|         if isinstance(obj, list | tuple): | ||||
|             try: | ||||
|                 return obj[attribute] | ||||
|             except TypeError as exc: | ||||
|                 raise EntryInvalidError.from_entry( | ||||
|                     f"Invalid index for list: {attribute}", entry | ||||
|                 ) from exc | ||||
|             except IndexError as exc: | ||||
|                 if self.default is UNSET: | ||||
|                     raise EntryInvalidError.from_entry( | ||||
|                         f"Index out of range: {attribute}", entry | ||||
|                     ) from exc | ||||
|                 return self.default | ||||
|         if attribute in obj: | ||||
|             return obj[attribute] | ||||
|         else: | ||||
|             if self.default is UNSET: | ||||
|                 raise EntryInvalidError.from_entry(f"Key does not exist: {attribute}", entry) | ||||
|             return self.default | ||||
|         except IndexError:  # pragma: no cover | ||||
|             raise EntryInvalidError.from_entry(f"Empty/invalid context: {context}", entry) | ||||
|  | ||||
|  | ||||
| class BlueprintDumper(SafeDumper): | ||||
| @ -631,11 +555,7 @@ class BlueprintDumper(SafeDumper): | ||||
|  | ||||
|             def factory(items): | ||||
|                 final_dict = dict(items) | ||||
|                 # Remove internal state variables | ||||
|                 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 | ||||
|  | ||||
|             data = asdict(data, dict_factory=factory) | ||||
| @ -657,19 +577,18 @@ class BlueprintLoader(SafeLoader): | ||||
|         self.add_constructor("!Enumerate", Enumerate) | ||||
|         self.add_constructor("!Value", Value) | ||||
|         self.add_constructor("!Index", Index) | ||||
|         self.add_constructor("!AtIndex", AtIndex) | ||||
|  | ||||
|  | ||||
| class EntryInvalidError(SentryIgnoredException): | ||||
|     """Error raised when an entry is invalid""" | ||||
|  | ||||
|     entry_model: str | None | ||||
|     entry_id: str | None | ||||
|     validation_error: ValidationError | None | ||||
|     serializer: Serializer | None = None | ||||
|     entry_model: Optional[str] | ||||
|     entry_id: Optional[str] | ||||
|     validation_error: Optional[ValidationError] | ||||
|     serializer: Optional[Serializer] = None | ||||
|  | ||||
|     def __init__( | ||||
|         self, *args: object, validation_error: ValidationError | None = None, **kwargs | ||||
|         self, *args: object, validation_error: Optional[ValidationError] = None, **kwargs | ||||
|     ) -> None: | ||||
|         super().__init__(*args) | ||||
|         self.entry_model = None | ||||
|  | ||||
| @ -1,6 +1,6 @@ | ||||
| """Blueprint exporter""" | ||||
|  | ||||
| from collections.abc import Iterable | ||||
| from typing import Iterable | ||||
| from uuid import UUID | ||||
|  | ||||
| from django.apps import apps | ||||
| @ -59,7 +59,7 @@ class Exporter: | ||||
|         blueprint = Blueprint() | ||||
|         self._pre_export(blueprint) | ||||
|         blueprint.metadata = BlueprintMetadata( | ||||
|             name=_("authentik Export - {date}".format_map({"date": str(now())})), | ||||
|             name=_("authentik Export - %(date)s" % {"date": str(now())}), | ||||
|             labels={ | ||||
|                 LABEL_AUTHENTIK_GENERATED: "true", | ||||
|             }, | ||||
| @ -74,7 +74,7 @@ class Exporter: | ||||
|  | ||||
|  | ||||
| class FlowExporter(Exporter): | ||||
|     """Exporter customized to only return objects related to `flow`""" | ||||
|     """Exporter customised to only return objects related to `flow`""" | ||||
|  | ||||
|     flow: Flow | ||||
|     with_policies: bool | ||||
|  | ||||
| @ -2,7 +2,7 @@ | ||||
|  | ||||
| from contextlib import contextmanager | ||||
| from copy import deepcopy | ||||
| from typing import Any | ||||
| from typing import Any, Optional | ||||
|  | ||||
| from dacite.config import Config | ||||
| 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.utils import IntegrityError | ||||
| from guardian.models import UserObjectPermission | ||||
| from guardian.shortcuts import assign_perm | ||||
| from rest_framework.exceptions import ValidationError | ||||
| from rest_framework.serializers import BaseSerializer, Serializer | ||||
| from structlog.stdlib import BoundLogger, get_logger | ||||
| from structlog.testing import capture_logs | ||||
| from structlog.types import EventDict | ||||
| from yaml import load | ||||
|  | ||||
| from authentik.blueprints.v1.common import ( | ||||
| @ -33,59 +34,34 @@ from authentik.blueprints.v1.common import ( | ||||
| from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry | ||||
| from authentik.core.models import ( | ||||
|     AuthenticatedSession, | ||||
|     GroupSourceConnection, | ||||
|     PropertyMapping, | ||||
|     Provider, | ||||
|     Source, | ||||
|     User, | ||||
|     UserSourceConnection, | ||||
| ) | ||||
| from authentik.enterprise.license import LicenseKey | ||||
| 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.models import LicenseKey, LicenseUsage | ||||
| 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.utils import cleanse_dict | ||||
| from authentik.flows.models import FlowToken, Stage | ||||
| from authentik.lib.models import SerializerModel | ||||
| from authentik.lib.sentry import SentryIgnoredException | ||||
| from authentik.lib.utils.reflection import get_apps | ||||
| from authentik.outposts.models import OutpostServiceConnection | ||||
| from authentik.policies.models import Policy, PolicyBindingModel | ||||
| from authentik.policies.reputation.models import Reputation | ||||
| from authentik.providers.oauth2.models import ( | ||||
|     AccessToken, | ||||
|     AuthorizationCode, | ||||
|     DeviceToken, | ||||
|     RefreshToken, | ||||
| ) | ||||
| from authentik.providers.scim.models import SCIMProviderGroup, SCIMProviderUser | ||||
| from authentik.rbac.models import Role | ||||
| from authentik.sources.scim.models import SCIMSourceGroup, SCIMSourceUser | ||||
| from authentik.stages.authenticator_webauthn.models import WebAuthnDeviceType | ||||
| from authentik.providers.oauth2.models import AccessToken, AuthorizationCode, RefreshToken | ||||
| from authentik.providers.scim.models import SCIMGroup, SCIMUser | ||||
| from authentik.tenants.models import Tenant | ||||
|  | ||||
| # 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" | ||||
|  | ||||
|  | ||||
| def excluded_models() -> list[type[Model]]: | ||||
|     """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)""" | ||||
|  | ||||
|     # pylint: disable=imported-auth-user | ||||
|     from django.contrib.auth.models import Group as DjangoGroup | ||||
|     from django.contrib.auth.models import User as DjangoUser | ||||
|  | ||||
| @ -101,7 +77,6 @@ def excluded_models() -> list[type[Model]]: | ||||
|         Source, | ||||
|         PropertyMapping, | ||||
|         UserSourceConnection, | ||||
|         GroupSourceConnection, | ||||
|         Stage, | ||||
|         OutpostServiceConnection, | ||||
|         Policy, | ||||
| @ -109,11 +84,10 @@ def excluded_models() -> list[type[Model]]: | ||||
|         # Classes that have other dependencies | ||||
|         AuthenticatedSession, | ||||
|         # Classes which are only internally managed | ||||
|         # FIXME: these shouldn't need to be explicitly listed, but rather based off of a mixin | ||||
|         FlowToken, | ||||
|         LicenseUsage, | ||||
|         SCIMProviderGroup, | ||||
|         SCIMProviderUser, | ||||
|         SCIMGroup, | ||||
|         SCIMUser, | ||||
|         Tenant, | ||||
|         SystemTask, | ||||
|         ConnectionToken, | ||||
| @ -121,22 +95,12 @@ def excluded_models() -> list[type[Model]]: | ||||
|         AccessToken, | ||||
|         RefreshToken, | ||||
|         Reputation, | ||||
|         WebAuthnDeviceType, | ||||
|         SCIMSourceUser, | ||||
|         SCIMSourceGroup, | ||||
|         GoogleWorkspaceProviderUser, | ||||
|         GoogleWorkspaceProviderGroup, | ||||
|         MicrosoftEntraProviderUser, | ||||
|         MicrosoftEntraProviderGroup, | ||||
|         EndpointDevice, | ||||
|         EndpointDeviceConnection, | ||||
|         DeviceToken, | ||||
|     ) | ||||
|  | ||||
|  | ||||
| def is_model_allowed(model: type[Model]) -> bool: | ||||
|     """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): | ||||
| @ -154,23 +118,13 @@ def transaction_rollback(): | ||||
|         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: | ||||
|     """Import Blueprint from raw dict or YAML/JSON""" | ||||
|  | ||||
|     logger: BoundLogger | ||||
|     _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._import = blueprint | ||||
|         self.logger = get_logger() | ||||
| @ -182,10 +136,7 @@ class Importer: | ||||
|  | ||||
|     def default_context(self): | ||||
|         """Default context""" | ||||
|         return { | ||||
|             "goauthentik.io/enterprise/licensed": LicenseKey.get_total().status().is_valid, | ||||
|             "goauthentik.io/rbac/models": rbac_models(), | ||||
|         } | ||||
|         return {"goauthentik.io/enterprise/licensed": LicenseKey.get_total().is_valid()} | ||||
|  | ||||
|     @staticmethod | ||||
|     def from_string(yaml_input: str, context: dict | None = None) -> "Importer": | ||||
| @ -209,14 +160,14 @@ class Importer: | ||||
|  | ||||
|         def updater(value) -> Any: | ||||
|             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 value | ||||
|  | ||||
|         for key, value in attrs.items(): | ||||
|             try: | ||||
|                 if isinstance(value, dict): | ||||
|                     for _, _inner_key in enumerate(value): | ||||
|                     for idx, _inner_key in enumerate(value): | ||||
|                         value[_inner_key] = updater(value[_inner_key]) | ||||
|                 elif isinstance(value, list): | ||||
|                     for idx, _inner_value in enumerate(value): | ||||
| @ -245,17 +196,15 @@ class Importer: | ||||
|  | ||||
|         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""" | ||||
|         if not entry.check_all_conditions_match(self._import): | ||||
|             self.logger.debug("One or more conditions of this entry are not fulfilled, skipping") | ||||
|             return None | ||||
|  | ||||
|         model_app_label, model_name = entry.get_model(self._import).split(".") | ||||
|         try: | ||||
|         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 | ||||
|         if not is_model_allowed(model): | ||||
|             raise EntryInvalidError.from_entry(f"Model {model} not allowed", entry) | ||||
| @ -299,13 +248,9 @@ class Importer: | ||||
|  | ||||
|         serializer_kwargs = {} | ||||
|         model_instance = existing_models.first() | ||||
|         if ( | ||||
|             not isinstance(model(), BaseMetaModel) | ||||
|             and model_instance | ||||
|             and entry.state != BlueprintEntryDesiredState.MUST_CREATED | ||||
|         ): | ||||
|         if not isinstance(model(), BaseMetaModel) and model_instance: | ||||
|             self.logger.debug( | ||||
|                 "Initialise serializer with instance", | ||||
|                 "initialise serializer with instance", | ||||
|                 model=model, | ||||
|                 instance=model_instance, | ||||
|                 pk=model_instance.pk, | ||||
| @ -313,17 +258,16 @@ class Importer: | ||||
|             serializer_kwargs["instance"] = model_instance | ||||
|             serializer_kwargs["partial"] = True | ||||
|         elif model_instance and entry.state == BlueprintEntryDesiredState.MUST_CREATED: | ||||
|             msg = ( | ||||
|                 f"State is set to {BlueprintEntryDesiredState.MUST_CREATED.value} " | ||||
|                 "and object exists already", | ||||
|             ) | ||||
|             raise EntryInvalidError.from_entry( | ||||
|                 ValidationError({k: msg for k in entry.identifiers.keys()}, "unique"), | ||||
|                 ( | ||||
|                     f"state is set to {BlueprintEntryDesiredState.MUST_CREATED} " | ||||
|                     "and object exists already", | ||||
|                 ), | ||||
|                 entry, | ||||
|             ) | ||||
|         else: | ||||
|             self.logger.debug( | ||||
|                 "Initialised new serializer instance", | ||||
|                 "initialised new serializer instance", | ||||
|                 model=model, | ||||
|                 **cleanse_dict(updated_identifiers), | ||||
|             ) | ||||
| @ -335,7 +279,10 @@ class Importer: | ||||
|         try: | ||||
|             full_data = self.__update_pks_for_attrs(entry.get_attrs(self._import)) | ||||
|         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) | ||||
|         serializer_kwargs["data"] = full_data | ||||
|  | ||||
| @ -356,15 +303,6 @@ class Importer: | ||||
|             ) from exc | ||||
|         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: | ||||
|         """Apply (create/update) models yaml, in database transaction""" | ||||
|         try: | ||||
| @ -386,7 +324,7 @@ class Importer: | ||||
|                 model: type[SerializerModel] = registry.get_model(model_app_label, model_name) | ||||
|             except LookupError: | ||||
|                 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 | ||||
|             # Validate each single entry | ||||
| @ -398,7 +336,7 @@ class Importer: | ||||
|                 if entry.get_state(self._import) == BlueprintEntryDesiredState.ABSENT: | ||||
|                     serializer = exc.serializer | ||||
|                 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: | ||||
|                         raise exc | ||||
|                     return False | ||||
| @ -418,42 +356,43 @@ class Importer: | ||||
|                     and state == BlueprintEntryDesiredState.CREATED | ||||
|                 ): | ||||
|                     self.logger.debug( | ||||
|                         "Instance exists, skipping", | ||||
|                         "instance exists, skipping", | ||||
|                         model=model, | ||||
|                         instance=instance, | ||||
|                         pk=instance.pk, | ||||
|                     ) | ||||
|                 else: | ||||
|                     instance = serializer.save() | ||||
|                     self.logger.debug("Updated model", model=instance) | ||||
|                     self.logger.debug("updated model", model=instance) | ||||
|                 if "pk" in entry.identifiers: | ||||
|                     self.__pk_map[entry.identifiers["pk"]] = instance.pk | ||||
|                 entry._state = BlueprintEntryState(instance) | ||||
|                 self._apply_permissions(instance, entry) | ||||
|             elif state == BlueprintEntryDesiredState.ABSENT: | ||||
|                 instance: Model | None = serializer.instance | ||||
|                 instance: Optional[Model] = serializer.instance | ||||
|                 if instance.pk: | ||||
|                     instance.delete() | ||||
|                     self.logger.debug("Deleted model", mode=instance) | ||||
|                     self.logger.debug("deleted model", mode=instance) | ||||
|                     continue | ||||
|                 self.logger.debug("Entry to delete with no instance, skipping") | ||||
|                 self.logger.debug("entry to delete with no instance, skipping") | ||||
|         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 | ||||
|         and serializers have no errors""" | ||||
|         self.logger.debug("Starting blueprint import validation") | ||||
|         orig_import = deepcopy(self._import) | ||||
|         if self._import.version != 1: | ||||
|             self.logger.warning("Invalid blueprint version") | ||||
|             return False, [LogEvent("Invalid blueprint version", log_level="warning", logger=None)] | ||||
|             return False, [{"event": "Invalid blueprint version"}] | ||||
|         with ( | ||||
|             transaction_rollback(), | ||||
|             capture_logs() as logs, | ||||
|         ): | ||||
|             successful = self._apply_models(raise_errors=raise_validation_errors) | ||||
|             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._import = orig_import | ||||
|         return successful, logs | ||||
|  | ||||
| @ -43,7 +43,7 @@ class ApplyBlueprintMetaSerializer(PassiveSerializer): | ||||
|             LOGGER.info("Blueprint does not exist, but not required") | ||||
|             return MetaResult() | ||||
|         LOGGER.debug("Applying blueprint from meta model", blueprint=self.blueprint_instance) | ||||
|  | ||||
|         # pylint: disable=no-value-for-parameter | ||||
|         apply_blueprint(str(self.blueprint_instance.pk)) | ||||
|         return MetaResult() | ||||
|  | ||||
|  | ||||
| @ -8,15 +8,15 @@ from rest_framework.serializers import Serializer | ||||
| class BaseMetaModel(Model): | ||||
|     """Base models""" | ||||
|  | ||||
|     class Meta: | ||||
|         abstract = True | ||||
|  | ||||
|     @staticmethod | ||||
|     def serializer() -> Serializer: | ||||
|         """Serializer similar to SerializerModel, but as a static method since | ||||
|         this is an abstract model""" | ||||
|         raise NotImplementedError | ||||
|  | ||||
|     class Meta: | ||||
|         abstract = True | ||||
|  | ||||
|  | ||||
| class MetaResult: | ||||
|     """Result returned by Meta Models' serializers. Empty class but we can't return none as | ||||
|  | ||||
| @ -3,7 +3,7 @@ | ||||
| from dataclasses import asdict, dataclass, field | ||||
| from hashlib import sha512 | ||||
| from pathlib import Path | ||||
| from sys import platform | ||||
| from typing import Optional | ||||
|  | ||||
| from dacite.core import from_dict | ||||
| from django.db import DatabaseError, InternalError, ProgrammingError | ||||
| @ -30,7 +30,6 @@ from authentik.blueprints.v1.common import BlueprintLoader, BlueprintMetadata, E | ||||
| from authentik.blueprints.v1.importer import Importer | ||||
| from authentik.blueprints.v1.labels import LABEL_AUTHENTIK_INSTANTIATE | ||||
| from authentik.blueprints.v1.oci import OCI_PREFIX | ||||
| from authentik.events.logs import capture_logs | ||||
| from authentik.events.models import TaskStatus | ||||
| from authentik.events.system_tasks import SystemTask, prefill_task | ||||
| from authentik.events.utils import sanitize_dict | ||||
| @ -50,23 +49,18 @@ class BlueprintFile: | ||||
|     version: int | ||||
|     hash: str | ||||
|     last_m: int | ||||
|     meta: BlueprintMetadata | None = field(default=None) | ||||
|     meta: Optional[BlueprintMetadata] = field(default=None) | ||||
|  | ||||
|  | ||||
| def start_blueprint_watcher(): | ||||
|     """Start blueprint watcher, if it's not running already.""" | ||||
|     # This function might be called twice since it's called on celery startup | ||||
|  | ||||
|     global _file_watcher_started  # noqa: PLW0603 | ||||
|     # pylint: disable=global-statement | ||||
|     global _file_watcher_started | ||||
|     if _file_watcher_started: | ||||
|         return | ||||
|     observer = Observer() | ||||
|     kwargs = {} | ||||
|     if platform.startswith("linux"): | ||||
|         kwargs["event_filter"] = (FileCreatedEvent, FileModifiedEvent) | ||||
|     observer.schedule( | ||||
|         BlueprintEventHandler(), CONFIG.get("blueprints_dir"), recursive=True, **kwargs | ||||
|     ) | ||||
|     observer.schedule(BlueprintEventHandler(), CONFIG.get("blueprints_dir"), recursive=True) | ||||
|     observer.start() | ||||
|     _file_watcher_started = True | ||||
|  | ||||
| @ -74,33 +68,23 @@ def start_blueprint_watcher(): | ||||
| class BlueprintEventHandler(FileSystemEventHandler): | ||||
|     """Event handler for blueprint events""" | ||||
|  | ||||
|     # We only ever get creation and modification events. | ||||
|     # See the creation of the Observer instance above for the event filtering. | ||||
|  | ||||
|     # Even though we filter to only get file events, we might still get | ||||
|     # directory events as some implementations such as inotify do not support | ||||
|     # filtering on file/directory. | ||||
|  | ||||
|     def dispatch(self, event: FileSystemEvent) -> None: | ||||
|         """Call specific event handler method. Ignores directory changes.""" | ||||
|     def on_any_event(self, event: FileSystemEvent): | ||||
|         if not isinstance(event, (FileCreatedEvent, FileModifiedEvent)): | ||||
|             return | ||||
|         if event.is_directory: | ||||
|             return None | ||||
|         return super().dispatch(event) | ||||
|  | ||||
|     def on_created(self, event: FileSystemEvent): | ||||
|         """Process file creation""" | ||||
|         LOGGER.debug("new blueprint file created, starting discovery") | ||||
|         for tenant in Tenant.objects.filter(ready=True): | ||||
|             with tenant: | ||||
|                 blueprints_discovery.delay() | ||||
|  | ||||
|     def on_modified(self, event: FileSystemEvent): | ||||
|         """Process file modification""" | ||||
|         path = Path(event.src_path) | ||||
|             return | ||||
|         root = Path(CONFIG.get("blueprints_dir")).absolute() | ||||
|         path = Path(event.src_path).absolute() | ||||
|         rel_path = str(path.relative_to(root)) | ||||
|         for tenant in Tenant.objects.filter(ready=True): | ||||
|             with tenant: | ||||
|                 root = Path(CONFIG.get("blueprints_dir")).absolute() | ||||
|                 path = Path(event.src_path).absolute() | ||||
|                 rel_path = str(path.relative_to(root)) | ||||
|                 if isinstance(event, FileCreatedEvent): | ||||
|                     LOGGER.debug("new blueprint file created, starting discovery", path=rel_path) | ||||
|                     blueprints_discovery.delay(rel_path) | ||||
|                 if isinstance(event, FileModifiedEvent): | ||||
|                     for instance in BlueprintInstance.objects.filter(path=rel_path, enabled=True): | ||||
|                         LOGGER.debug("modified blueprint file, starting apply", instance=instance) | ||||
|                         apply_blueprint.delay(instance.pk.hex) | ||||
| @ -126,7 +110,7 @@ def blueprints_find() -> list[BlueprintFile]: | ||||
|         # 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(".")): | ||||
|             continue | ||||
|         with open(path, encoding="utf-8") as blueprint_file: | ||||
|         with open(path, "r", encoding="utf-8") as blueprint_file: | ||||
|             try: | ||||
|                 raw_blueprint = load(blueprint_file.read(), BlueprintLoader) | ||||
|             except YAMLError as exc: | ||||
| @ -150,7 +134,7 @@ def blueprints_find() -> list[BlueprintFile]: | ||||
|     throws=(DatabaseError, ProgrammingError, InternalError), base=SystemTask, bind=True | ||||
| ) | ||||
| @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""" | ||||
|     count = 0 | ||||
|     for blueprint in blueprints_find(): | ||||
| @ -159,7 +143,7 @@ def blueprints_discovery(self: SystemTask, path: str | None = None): | ||||
|         check_blueprint_v1_file(blueprint) | ||||
|         count += 1 | ||||
|     self.set_status( | ||||
|         TaskStatus.SUCCESSFUL, _("Successfully imported {count} files.".format(count=count)) | ||||
|         TaskStatus.SUCCESSFUL, _("Successfully imported %(count)d files." % {"count": count}) | ||||
|     ) | ||||
|  | ||||
|  | ||||
| @ -197,7 +181,7 @@ def check_blueprint_v1_file(blueprint: BlueprintFile): | ||||
| def apply_blueprint(self: SystemTask, instance_pk: str): | ||||
|     """Apply single blueprint""" | ||||
|     self.save_on_success = False | ||||
|     instance: BlueprintInstance | None = None | ||||
|     instance: Optional[BlueprintInstance] = None | ||||
|     try: | ||||
|         instance: BlueprintInstance = BlueprintInstance.objects.filter(pk=instance_pk).first() | ||||
|         if not instance or not instance.enabled: | ||||
| @ -212,24 +196,23 @@ def apply_blueprint(self: SystemTask, instance_pk: str): | ||||
|         if not valid: | ||||
|             instance.status = BlueprintInstanceStatus.ERROR | ||||
|             instance.save() | ||||
|             self.set_status(TaskStatus.ERROR, *logs) | ||||
|             self.set_status(TaskStatus.ERROR, *[x["event"] for x in logs]) | ||||
|             return | ||||
|         with capture_logs() as logs: | ||||
|         applied = importer.apply() | ||||
|         if not applied: | ||||
|             instance.status = BlueprintInstanceStatus.ERROR | ||||
|             instance.save() | ||||
|                 self.set_status(TaskStatus.ERROR, *logs) | ||||
|             self.set_status(TaskStatus.ERROR, "Failed to apply") | ||||
|             return | ||||
|         instance.status = BlueprintInstanceStatus.SUCCESSFUL | ||||
|         instance.last_applied_hash = file_hash | ||||
|         instance.last_applied = now() | ||||
|         self.set_status(TaskStatus.SUCCESSFUL) | ||||
|     except ( | ||||
|         OSError, | ||||
|         DatabaseError, | ||||
|         ProgrammingError, | ||||
|         InternalError, | ||||
|         IOError, | ||||
|         BlueprintRetrievalFailed, | ||||
|         EntryInvalidError, | ||||
|     ) as exc: | ||||
|  | ||||
| @ -11,20 +11,21 @@ from rest_framework.filters import OrderingFilter, SearchFilter | ||||
| from rest_framework.permissions import AllowAny | ||||
| from rest_framework.request import Request | ||||
| from rest_framework.response import Response | ||||
| from rest_framework.serializers import ModelSerializer | ||||
| from rest_framework.validators import UniqueValidator | ||||
| from rest_framework.viewsets import ModelViewSet | ||||
|  | ||||
| from authentik.api.authorization import SecretKeyFilter | ||||
| from authentik.brands.models import Brand | ||||
| 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 | ||||
|  | ||||
|  | ||||
| class FooterLinkSerializer(PassiveSerializer): | ||||
|     """Links returned in Config API""" | ||||
|  | ||||
|     href = CharField(read_only=True, allow_null=True) | ||||
|     href = CharField(read_only=True) | ||||
|     name = CharField(read_only=True) | ||||
|  | ||||
|  | ||||
| @ -55,7 +56,6 @@ class BrandSerializer(ModelSerializer): | ||||
|             "flow_unenrollment", | ||||
|             "flow_user_settings", | ||||
|             "flow_device_code", | ||||
|             "default_application", | ||||
|             "web_certificate", | ||||
|             "attributes", | ||||
|         ] | ||||
| @ -84,8 +84,8 @@ class CurrentBrandSerializer(PassiveSerializer): | ||||
|  | ||||
|     matched_domain = CharField(source="domain") | ||||
|     branding_title = CharField() | ||||
|     branding_logo = CharField(source="branding_logo_url") | ||||
|     branding_favicon = CharField(source="branding_favicon_url") | ||||
|     branding_logo = CharField() | ||||
|     branding_favicon = CharField() | ||||
|     ui_footer_links = ListField( | ||||
|         child=FooterLinkSerializer(), | ||||
|         read_only=True, | ||||
|  | ||||
| @ -9,6 +9,3 @@ class AuthentikBrandsConfig(AppConfig): | ||||
|     name = "authentik.brands" | ||||
|     label = "authentik_brands" | ||||
|     verbose_name = "authentik Brands" | ||||
|     mountpoints = { | ||||
|         "authentik.brands.urls_root": "", | ||||
|     } | ||||
|  | ||||
| @ -1,10 +1,10 @@ | ||||
| """Inject brand into current request""" | ||||
|  | ||||
| from collections.abc import Callable | ||||
| from typing import Callable | ||||
|  | ||||
| from django.http.request import HttpRequest | ||||
| from django.http.response import HttpResponse | ||||
| from django.utils.translation import override | ||||
| from django.utils.translation import activate | ||||
|  | ||||
| from authentik.brands.utils import get_brand_for_request | ||||
|  | ||||
| @ -18,14 +18,10 @@ class BrandMiddleware: | ||||
|         self.get_response = get_response | ||||
|  | ||||
|     def __call__(self, request: HttpRequest) -> HttpResponse: | ||||
|         locale_to_set = None | ||||
|         if not hasattr(request, "brand"): | ||||
|             brand = get_brand_for_request(request) | ||||
|             request.brand = brand | ||||
|             setattr(request, "brand", brand) | ||||
|             locale = brand.default_locale | ||||
|             if locale != "": | ||||
|                 locale_to_set = locale | ||||
|         if locale_to_set: | ||||
|             with override(locale_to_set): | ||||
|                 return self.get_response(request) | ||||
|                 activate(locale) | ||||
|         return self.get_response(request) | ||||
|  | ||||
| @ -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,14 +3,12 @@ | ||||
| from uuid import uuid4 | ||||
|  | ||||
| from django.db import models | ||||
| from django.http import HttpRequest | ||||
| from django.utils.translation import gettext_lazy as _ | ||||
| from rest_framework.serializers import Serializer | ||||
| from structlog.stdlib import get_logger | ||||
|  | ||||
| from authentik.crypto.models import CertificateKeyPair | ||||
| from authentik.flows.models import Flow | ||||
| from authentik.lib.config import CONFIG | ||||
| from authentik.lib.models import SerializerModel | ||||
|  | ||||
| LOGGER = get_logger() | ||||
| @ -53,16 +51,6 @@ class Brand(SerializerModel): | ||||
|         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( | ||||
|         CertificateKeyPair, | ||||
|         null=True, | ||||
| @ -72,18 +60,6 @@ class Brand(SerializerModel): | ||||
|     ) | ||||
|     attributes = models.JSONField(default=dict, blank=True) | ||||
|  | ||||
|     def branding_logo_url(self) -> str: | ||||
|         """Get branding_logo with the correct prefix""" | ||||
|         if self.branding_logo.startswith("/static"): | ||||
|             return CONFIG.get("web.path", "/")[:-1] + self.branding_logo | ||||
|         return self.branding_logo | ||||
|  | ||||
|     def branding_favicon_url(self) -> str: | ||||
|         """Get branding_favicon with the correct prefix""" | ||||
|         if self.branding_favicon.startswith("/static"): | ||||
|             return CONFIG.get("web.path", "/")[:-1] + self.branding_favicon | ||||
|         return self.branding_favicon | ||||
|  | ||||
|     @property | ||||
|     def serializer(self) -> Serializer: | ||||
|         from authentik.brands.api import BrandSerializer | ||||
| @ -95,7 +71,7 @@ class Brand(SerializerModel): | ||||
|         """Get default locale""" | ||||
|         try: | ||||
|             return self.attributes.get("settings", {}).get("locale", "") | ||||
|  | ||||
|         # pylint: disable=broad-except | ||||
|         except Exception as exc: | ||||
|             LOGGER.warning("Failed to get default locale", exc=exc) | ||||
|             return "" | ||||
| @ -108,17 +84,3 @@ class Brand(SerializerModel): | ||||
|     class Meta: | ||||
|         verbose_name = _("Brand") | ||||
|         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.models import Brand | ||||
| from authentik.core.models import Application | ||||
| 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): | ||||
| @ -79,45 +75,3 @@ class TestBrands(APITestCase): | ||||
|             reverse("authentik_api:brand-list"), data={"domain": "bar", "default": True} | ||||
|         ) | ||||
|         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,11 +5,10 @@ from typing import Any | ||||
| from django.db.models import F, Q | ||||
| from django.db.models import Value as V | ||||
| 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.brands.models import Brand | ||||
| from authentik.tenants.models import Tenant | ||||
|  | ||||
| _q_default = Q(default=True) | ||||
| DEFAULT_BRAND = Brand(domain="fallback") | ||||
| @ -31,14 +30,13 @@ def get_brand_for_request(request: HttpRequest) -> Brand: | ||||
| def context_processor(request: HttpRequest) -> dict[str, Any]: | ||||
|     """Context Processor that injects brand object into every template""" | ||||
|     brand = getattr(request, "brand", DEFAULT_BRAND) | ||||
|     tenant = getattr(request, "tenant", Tenant()) | ||||
|     trace = "" | ||||
|     span = get_current_span() | ||||
|     span = Hub.current.scope.span | ||||
|     if span: | ||||
|         trace = span.to_traceparent() | ||||
|     return { | ||||
|         "brand": brand, | ||||
|         "footer_links": tenant.footer_links, | ||||
|         "footer_links": request.tenant.footer_links, | ||||
|         "sentry_trace": trace, | ||||
|         "version": get_full_version(), | ||||
|     } | ||||
|  | ||||
| @ -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,54 +0,0 @@ | ||||
| """Application Roles API Viewset""" | ||||
|  | ||||
| from django.utils.translation import gettext_lazy as _ | ||||
| from rest_framework.exceptions import ValidationError | ||||
| from rest_framework.viewsets import ModelViewSet | ||||
|  | ||||
| from authentik.core.api.used_by import UsedByMixin | ||||
| from authentik.core.api.utils import ModelSerializer | ||||
| from authentik.core.models import ( | ||||
|     Application, | ||||
|     ApplicationEntitlement, | ||||
|     User, | ||||
| ) | ||||
|  | ||||
|  | ||||
| class ApplicationEntitlementSerializer(ModelSerializer): | ||||
|     """ApplicationEntitlement Serializer""" | ||||
|  | ||||
|     def validate_app(self, app: Application) -> Application: | ||||
|         """Ensure user has permission to view""" | ||||
|         user: User = self._context["request"].user | ||||
|         if user.has_perm("view_application", app) or user.has_perm( | ||||
|             "authentik_core.view_application" | ||||
|         ): | ||||
|             return app | ||||
|         raise ValidationError(_("User does not have access to application."), code="invalid") | ||||
|  | ||||
|     class Meta: | ||||
|         model = ApplicationEntitlement | ||||
|         fields = [ | ||||
|             "pbm_uuid", | ||||
|             "name", | ||||
|             "app", | ||||
|             "attributes", | ||||
|         ] | ||||
|  | ||||
|  | ||||
| class ApplicationEntitlementViewSet(UsedByMixin, ModelViewSet): | ||||
|     """ApplicationEntitlement Viewset""" | ||||
|  | ||||
|     queryset = ApplicationEntitlement.objects.all() | ||||
|     serializer_class = ApplicationEntitlementSerializer | ||||
|     search_fields = [ | ||||
|         "pbm_uuid", | ||||
|         "name", | ||||
|         "app", | ||||
|         "attributes", | ||||
|     ] | ||||
|     filterset_fields = [ | ||||
|         "pbm_uuid", | ||||
|         "name", | ||||
|         "app", | ||||
|     ] | ||||
|     ordering = ["name"] | ||||
| @ -1,8 +1,8 @@ | ||||
| """Application API Views""" | ||||
|  | ||||
| from collections.abc import Iterator | ||||
| from copy import copy | ||||
| from datetime import timedelta | ||||
| from typing import Optional | ||||
|  | ||||
| from django.core.cache import cache | ||||
| from django.db.models import QuerySet | ||||
| @ -17,18 +17,19 @@ from rest_framework.fields import CharField, ReadOnlyField, SerializerMethodFiel | ||||
| from rest_framework.parsers import MultiPartParser | ||||
| from rest_framework.request import Request | ||||
| from rest_framework.response import Response | ||||
| from rest_framework.serializers import ModelSerializer | ||||
| from rest_framework.viewsets import ModelViewSet | ||||
| from structlog.stdlib import get_logger | ||||
| from structlog.testing import capture_logs | ||||
|  | ||||
| from authentik.admin.api.metrics import CoordinateSerializer | ||||
| from authentik.api.pagination import Pagination | ||||
| from authentik.api.decorators import permission_required | ||||
| from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT | ||||
| from authentik.core.api.providers import ProviderSerializer | ||||
| from authentik.core.api.used_by import UsedByMixin | ||||
| from authentik.core.api.utils import ModelSerializer | ||||
| from authentik.core.models import Application, User | ||||
| from authentik.events.logs import LogEventSerializer, capture_logs | ||||
| from authentik.events.models import EventAction | ||||
| from authentik.events.utils import sanitize_dict | ||||
| from authentik.lib.utils.file import ( | ||||
|     FilePathSerializer, | ||||
|     FileUploadSerializer, | ||||
| @ -37,19 +38,15 @@ from authentik.lib.utils.file import ( | ||||
| ) | ||||
| from authentik.policies.api.exec import PolicyTestResultSerializer | ||||
| from authentik.policies.engine import PolicyEngine | ||||
| from authentik.policies.types import CACHE_PREFIX, PolicyResult | ||||
| from authentik.rbac.decorators import permission_required | ||||
| from authentik.policies.types import PolicyResult | ||||
| from authentik.rbac.filters import ObjectFilter | ||||
|  | ||||
| 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""" | ||||
|     key = f"{CACHE_PREFIX}/app_access/{user_pk}" | ||||
|     if page_number: | ||||
|         key += f"/{page_number}" | ||||
|     return key | ||||
|     return f"goauthentik.io/core/app_access/{user_pk}" | ||||
|  | ||||
|  | ||||
| class ApplicationSerializer(ModelSerializer): | ||||
| @ -63,7 +60,7 @@ class ApplicationSerializer(ModelSerializer): | ||||
|  | ||||
|     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""" | ||||
|         user = None | ||||
|         if "request" in self.context: | ||||
| @ -103,12 +100,8 @@ class ApplicationSerializer(ModelSerializer): | ||||
| class ApplicationViewSet(UsedByMixin, ModelViewSet): | ||||
|     """Application Viewset""" | ||||
|  | ||||
|     queryset = ( | ||||
|         Application.objects.all() | ||||
|         .with_provider() | ||||
|         .prefetch_related("policies") | ||||
|         .prefetch_related("backchannel_providers") | ||||
|     ) | ||||
|     # pylint: disable=no-member | ||||
|     queryset = Application.objects.all().prefetch_related("provider") | ||||
|     serializer_class = ApplicationSerializer | ||||
|     search_fields = [ | ||||
|         "name", | ||||
| @ -138,29 +131,20 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet): | ||||
|         return queryset | ||||
|  | ||||
|     def _get_allowed_applications( | ||||
|         self, pagined_apps: Iterator[Application], user: User | None = None | ||||
|         self, queryset: QuerySet, user: Optional[User] = None | ||||
|     ) -> list[Application]: | ||||
|         applications = [] | ||||
|         request = self.request._request | ||||
|         if user: | ||||
|             request = copy(request) | ||||
|             request.user = user | ||||
|         for application in pagined_apps: | ||||
|         for application in queryset: | ||||
|             engine = PolicyEngine(application, request.user, request) | ||||
|             engine.build() | ||||
|             if engine.passing: | ||||
|                 applications.append(application) | ||||
|         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( | ||||
|         parameters=[ | ||||
|             OpenApiParameter( | ||||
| @ -185,7 +169,7 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet): | ||||
|             try: | ||||
|                 for_user = User.objects.filter(pk=request.query_params.get("for_user")).first() | ||||
|             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: | ||||
|                 raise ValidationError({"for_user": "User not found"}) | ||||
|         engine = PolicyEngine(application, for_user, request) | ||||
| @ -199,9 +183,9 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet): | ||||
|         if request.user.is_superuser: | ||||
|             log_messages = [] | ||||
|             for log in logs: | ||||
|                 if log.attributes.get("process", "") == "PolicyProcess": | ||||
|                 if log.get("process", "") == "PolicyProcess": | ||||
|                     continue | ||||
|                 log_messages.append(LogEventSerializer(log).data) | ||||
|                 log_messages.append(sanitize_dict(log)) | ||||
|             result.log_messages = log_messages | ||||
|             response = PolicyTestResultSerializer(result) | ||||
|         return Response(response.data) | ||||
| @ -218,11 +202,6 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet): | ||||
|                 location=OpenApiParameter.QUERY, | ||||
|                 type=OpenApiTypes.INT, | ||||
|             ), | ||||
|             OpenApiParameter( | ||||
|                 name="only_with_launch_url", | ||||
|                 location=OpenApiParameter.QUERY, | ||||
|                 type=OpenApiTypes.BOOL, | ||||
|             ), | ||||
|         ] | ||||
|     ) | ||||
|     def list(self, request: Request) -> Response: | ||||
| @ -235,13 +214,8 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet): | ||||
|         if superuser_full_list and request.user.is_superuser: | ||||
|             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()) | ||||
|         paginator: Pagination = self.paginator | ||||
|         paginated_apps = paginator.paginate_queryset(queryset, request) | ||||
|         self.paginate_queryset(queryset) | ||||
|  | ||||
|         if "for_user" in request.query_params: | ||||
|             try: | ||||
| @ -255,29 +229,23 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet): | ||||
|                     raise ValidationError({"for_user": "User not found"}) | ||||
|             except ValueError as exc: | ||||
|                 raise ValidationError from exc | ||||
|             allowed_applications = self._get_allowed_applications(paginated_apps, user=for_user) | ||||
|             allowed_applications = self._get_allowed_applications(queryset, user=for_user) | ||||
|             serializer = self.get_serializer(allowed_applications, many=True) | ||||
|             return self.get_paginated_response(serializer.data) | ||||
|  | ||||
|         allowed_applications = [] | ||||
|         if not should_cache: | ||||
|             allowed_applications = self._get_allowed_applications(paginated_apps) | ||||
|             allowed_applications = self._get_allowed_applications(queryset) | ||||
|         if should_cache: | ||||
|             allowed_applications = cache.get( | ||||
|                 user_app_cache_key(self.request.user.pk, paginator.page.number) | ||||
|             ) | ||||
|             allowed_applications = cache.get(user_app_cache_key(self.request.user.pk)) | ||||
|             if not allowed_applications: | ||||
|                 LOGGER.debug("Caching allowed application list", page=paginator.page.number) | ||||
|                 allowed_applications = self._get_allowed_applications(paginated_apps) | ||||
|                 LOGGER.debug("Caching allowed application list") | ||||
|                 allowed_applications = self._get_allowed_applications(queryset) | ||||
|                 cache.set( | ||||
|                     user_app_cache_key(self.request.user.pk, paginator.page.number), | ||||
|                     user_app_cache_key(self.request.user.pk), | ||||
|                     allowed_applications, | ||||
|                     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) | ||||
|         return self.get_paginated_response(serializer.data) | ||||
|  | ||||
|  | ||||
| @ -1,6 +1,6 @@ | ||||
| """AuthenticatedSessions API Viewset""" | ||||
|  | ||||
| from typing import TypedDict | ||||
| from typing import Optional, TypedDict | ||||
|  | ||||
| from django_filters.rest_framework import DjangoFilterBackend | ||||
| 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.filters import OrderingFilter, SearchFilter | ||||
| from rest_framework.request import Request | ||||
| from rest_framework.serializers import ModelSerializer | ||||
| from rest_framework.viewsets import GenericViewSet | ||||
| from ua_parser import user_agent_parser | ||||
|  | ||||
| from authentik.api.authorization import OwnerSuperuserPermissions | ||||
| from authentik.core.api.used_by import UsedByMixin | ||||
| from authentik.core.api.utils import ModelSerializer | ||||
| from authentik.core.models import AuthenticatedSession | ||||
| from authentik.events.context_processors.asn import ASN_CONTEXT_PROCESSOR, ASNDict | ||||
| from authentik.events.context_processors.geoip import GEOIP_CONTEXT_PROCESSOR, GeoIPDict | ||||
| @ -72,11 +72,11 @@ class AuthenticatedSessionSerializer(ModelSerializer): | ||||
|         """Get parsed 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""" | ||||
|         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""" | ||||
|         return ASN_CONTEXT_PROCESSOR.asn_dict(instance.last_ip) | ||||
|  | ||||
|  | ||||
| @ -1,55 +1,30 @@ | ||||
| """Authenticator Devices API Views""" | ||||
|  | ||||
| from django.utils.translation import gettext_lazy as _ | ||||
| from drf_spectacular.types import OpenApiTypes | ||||
| from drf_spectacular.utils import OpenApiParameter, extend_schema | ||||
| from rest_framework.fields import ( | ||||
|     BooleanField, | ||||
|     CharField, | ||||
|     DateTimeField, | ||||
|     SerializerMethodField, | ||||
| ) | ||||
| from rest_framework.permissions import IsAuthenticated | ||||
| from rest_framework.fields import BooleanField, CharField, IntegerField, SerializerMethodField | ||||
| from rest_framework.permissions import IsAdminUser, IsAuthenticated | ||||
| from rest_framework.request import Request | ||||
| from rest_framework.response import Response | ||||
| from rest_framework.viewsets import ViewSet | ||||
|  | ||||
| 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.models import Device | ||||
| from authentik.stages.authenticator_webauthn.models import WebAuthnDevice | ||||
|  | ||||
|  | ||||
| class DeviceSerializer(MetaNameSerializer): | ||||
|     """Serializer for Duo authenticator devices""" | ||||
|  | ||||
|     pk = CharField() | ||||
|     pk = IntegerField() | ||||
|     name = CharField() | ||||
|     type = SerializerMethodField() | ||||
|     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: | ||||
|         """Get type of device""" | ||||
|         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 instance.device_type | ||||
|                 else _("Extra description not available") | ||||
|             ) | ||||
|         if isinstance(instance, EndpointDevice): | ||||
|             return instance.data.get("deviceSignals", {}).get("deviceModel") | ||||
|         return "" | ||||
|  | ||||
|  | ||||
| class DeviceViewSet(ViewSet): | ||||
|     """Viewset for authenticator devices""" | ||||
| @ -68,7 +43,7 @@ class AdminDeviceViewSet(ViewSet): | ||||
|     """Viewset for authenticator devices""" | ||||
|  | ||||
|     serializer_class = DeviceSerializer | ||||
|     permission_classes = [] | ||||
|     permission_classes = [IsAdminUser] | ||||
|  | ||||
|     def get_devices(self, **kwargs): | ||||
|         """Get all devices in all child classes""" | ||||
| @ -86,10 +61,6 @@ class AdminDeviceViewSet(ViewSet): | ||||
|         ], | ||||
|         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: | ||||
|         """Get all devices for current user""" | ||||
|         kwargs = {} | ||||
|  | ||||
| @ -1,31 +1,25 @@ | ||||
| """Groups API Viewset""" | ||||
|  | ||||
| from json import loads | ||||
| from typing import Optional | ||||
|  | ||||
| from django.db.models import Prefetch | ||||
| from django.http import Http404 | ||||
| from django_filters.filters import CharFilter, ModelMultipleChoiceFilter | ||||
| from django_filters.filterset import FilterSet | ||||
| from drf_spectacular.utils import ( | ||||
|     OpenApiParameter, | ||||
|     OpenApiResponse, | ||||
|     extend_schema, | ||||
|     extend_schema_field, | ||||
| ) | ||||
| from drf_spectacular.utils import OpenApiResponse, extend_schema | ||||
| from guardian.shortcuts import get_objects_for_user | ||||
| from rest_framework.decorators import action | ||||
| from rest_framework.fields import CharField, IntegerField, SerializerMethodField | ||||
| from rest_framework.fields import CharField, IntegerField | ||||
| from rest_framework.request import Request | ||||
| from rest_framework.response import Response | ||||
| from rest_framework.serializers import ListSerializer, ValidationError | ||||
| from rest_framework.validators import UniqueValidator | ||||
| from rest_framework.serializers import ListSerializer, ModelSerializer, ValidationError | ||||
| from rest_framework.viewsets import ModelViewSet | ||||
|  | ||||
| from authentik.api.decorators import permission_required | ||||
| 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.rbac.api.roles import RoleSerializer | ||||
| from authentik.rbac.decorators import permission_required | ||||
|  | ||||
|  | ||||
| class GroupMemberSerializer(ModelSerializer): | ||||
| @ -52,7 +46,9 @@ class GroupSerializer(ModelSerializer): | ||||
|     """Group Serializer""" | ||||
|  | ||||
|     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( | ||||
|         child=RoleSerializer(), | ||||
|         read_only=True, | ||||
| @ -63,20 +59,7 @@ class GroupSerializer(ModelSerializer): | ||||
|  | ||||
|     num_pk = IntegerField(read_only=True) | ||||
|  | ||||
|     @property | ||||
|     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): | ||||
|     def validate_parent(self, parent: Optional[Group]): | ||||
|         """Validate group parent (if set), ensuring the parent isn't itself""" | ||||
|         if not self.instance or not parent: | ||||
|             return parent | ||||
| @ -102,10 +85,7 @@ class GroupSerializer(ModelSerializer): | ||||
|         extra_kwargs = { | ||||
|             "users": { | ||||
|                 "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: | ||||
|             value = loads(value) | ||||
|         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): | ||||
|             raise ValidationError(detail="filter: value must be key:value mapping") | ||||
|         qs = {} | ||||
| @ -151,49 +131,23 @@ class GroupFilter(FilterSet): | ||||
|         fields = ["name", "is_superuser", "members_by_pk", "attributes", "members_by_username"] | ||||
|  | ||||
|  | ||||
| class GroupViewSet(UsedByMixin, ModelViewSet): | ||||
|     """Group Viewset""" | ||||
|  | ||||
|     class UserAccountSerializer(PassiveSerializer): | ||||
| class UserAccountSerializer(PassiveSerializer): | ||||
|     """Account adding/removing operations""" | ||||
|  | ||||
|     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 | ||||
|     search_fields = ["name", "is_superuser"] | ||||
|     filterset_class = GroupFilter | ||||
|     ordering = ["name"] | ||||
|  | ||||
|     def get_queryset(self): | ||||
|         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") | ||||
|     @permission_required(None, ["authentik_core.add_user"]) | ||||
|     @extend_schema( | ||||
|         request=UserAccountSerializer, | ||||
|         responses={ | ||||
| @ -201,13 +155,7 @@ class GroupViewSet(UsedByMixin, ModelViewSet): | ||||
|             404: OpenApiResponse(description="User not found"), | ||||
|         }, | ||||
|     ) | ||||
|     @action( | ||||
|         detail=True, | ||||
|         methods=["POST"], | ||||
|         pagination_class=None, | ||||
|         filter_backends=[], | ||||
|         permission_classes=[], | ||||
|     ) | ||||
|     @action(detail=True, methods=["POST"], pagination_class=None, filter_backends=[]) | ||||
|     def add_user(self, request: Request, pk: str) -> Response: | ||||
|         """Add user to group""" | ||||
|         group: Group = self.get_object() | ||||
| @ -223,7 +171,7 @@ class GroupViewSet(UsedByMixin, ModelViewSet): | ||||
|         group.users.add(user) | ||||
|         return Response(status=204) | ||||
|  | ||||
|     @permission_required("authentik_core.remove_user_from_group") | ||||
|     @permission_required(None, ["authentik_core.add_user"]) | ||||
|     @extend_schema( | ||||
|         request=UserAccountSerializer, | ||||
|         responses={ | ||||
| @ -231,13 +179,7 @@ class GroupViewSet(UsedByMixin, ModelViewSet): | ||||
|             404: OpenApiResponse(description="User not found"), | ||||
|         }, | ||||
|     ) | ||||
|     @action( | ||||
|         detail=True, | ||||
|         methods=["POST"], | ||||
|         pagination_class=None, | ||||
|         filter_backends=[], | ||||
|         permission_classes=[], | ||||
|     ) | ||||
|     @action(detail=True, methods=["POST"], pagination_class=None, filter_backends=[]) | ||||
|     def remove_user(self, request: Request, pk: str) -> Response: | ||||
|         """Add user to group""" | ||||
|         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) | ||||
| @ -1,178 +0,0 @@ | ||||
| """PropertyMapping API Views""" | ||||
|  | ||||
| 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.utils import ( | ||||
|     OpenApiParameter, | ||||
|     OpenApiResponse, | ||||
|     extend_schema, | ||||
|     extend_schema_field, | ||||
| ) | ||||
| from guardian.shortcuts import get_objects_for_user | ||||
| from rest_framework import mixins | ||||
| from rest_framework.decorators import action | ||||
| from rest_framework.exceptions import PermissionDenied | ||||
| from rest_framework.fields import BooleanField, CharField, SerializerMethodField | ||||
| from rest_framework.relations import PrimaryKeyRelatedField | ||||
| from rest_framework.request import Request | ||||
| from rest_framework.response import Response | ||||
| from rest_framework.viewsets import GenericViewSet | ||||
|  | ||||
| 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.utils import ( | ||||
|     MetaNameSerializer, | ||||
|     ModelSerializer, | ||||
|     PassiveSerializer, | ||||
| ) | ||||
| from authentik.core.expression.evaluator import PropertyMappingEvaluator | ||||
| from authentik.core.expression.exceptions import PropertyMappingExpressionException | ||||
| from authentik.core.models import Group, PropertyMapping, User | ||||
| from authentik.events.utils import sanitize_item | ||||
| from authentik.lib.utils.errors import exception_to_string | ||||
| from authentik.policies.api.exec import PolicyTestSerializer | ||||
| from authentik.rbac.decorators import permission_required | ||||
|  | ||||
|  | ||||
| class PropertyMappingTestResultSerializer(PassiveSerializer): | ||||
|     """Result of a Property-mapping test""" | ||||
|  | ||||
|     result = CharField(read_only=True) | ||||
|     successful = BooleanField(read_only=True) | ||||
|  | ||||
|  | ||||
| class PropertyMappingSerializer(ManagedSerializer, ModelSerializer, MetaNameSerializer): | ||||
|     """PropertyMapping Serializer""" | ||||
|  | ||||
|     component = SerializerMethodField() | ||||
|  | ||||
|     def get_component(self, obj: PropertyMapping) -> str: | ||||
|         """Get object's component so that we know how to edit the object""" | ||||
|         return obj.component | ||||
|  | ||||
|     def validate_expression(self, expression: str) -> str: | ||||
|         """Test Syntax""" | ||||
|         evaluator = PropertyMappingEvaluator( | ||||
|             self.instance, | ||||
|         ) | ||||
|         evaluator.validate(expression) | ||||
|         return expression | ||||
|  | ||||
|     class Meta: | ||||
|         model = PropertyMapping | ||||
|         fields = [ | ||||
|             "pk", | ||||
|             "managed", | ||||
|             "name", | ||||
|             "expression", | ||||
|             "component", | ||||
|             "verbose_name", | ||||
|             "verbose_name_plural", | ||||
|             "meta_model_name", | ||||
|         ] | ||||
|  | ||||
|  | ||||
| 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( | ||||
|     TypesMixin, | ||||
|     mixins.RetrieveModelMixin, | ||||
|     mixins.DestroyModelMixin, | ||||
|     UsedByMixin, | ||||
|     mixins.ListModelMixin, | ||||
|     GenericViewSet, | ||||
| ): | ||||
|     """PropertyMapping Viewset""" | ||||
|  | ||||
|     class PropertyMappingTestSerializer(PolicyTestSerializer): | ||||
|         """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 | ||||
|     filterset_class = PropertyMappingFilterSet | ||||
|     ordering = ["name"] | ||||
|     search_fields = ["name"] | ||||
|  | ||||
|     @permission_required("authentik_core.view_propertymapping") | ||||
|     @extend_schema( | ||||
|         request=PropertyMappingTestSerializer(), | ||||
|         responses={ | ||||
|             200: PropertyMappingTestResultSerializer, | ||||
|             400: OpenApiResponse(description="Invalid parameters"), | ||||
|         }, | ||||
|         parameters=[ | ||||
|             OpenApiParameter( | ||||
|                 name="format_result", | ||||
|                 location=OpenApiParameter.QUERY, | ||||
|                 type=OpenApiTypes.BOOL, | ||||
|             ) | ||||
|         ], | ||||
|     ) | ||||
|     @action(detail=True, pagination_class=None, filter_backends=[], methods=["POST"]) | ||||
|     def test(self, request: Request, pk: str) -> Response: | ||||
|         """Test Property Mapping""" | ||||
|         _mapping: PropertyMapping = self.get_object() | ||||
|         # Use `get_subclass` to get correct class and correct `.evaluate` implementation | ||||
|         mapping: PropertyMapping = PropertyMapping.objects.get_subclass(pk=_mapping.pk) | ||||
|         # 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 | ||||
|         test_params = self.PropertyMappingTestSerializer(data=request.data) | ||||
|         if not test_params.is_valid(): | ||||
|             return Response(test_params.errors, status=400) | ||||
|  | ||||
|         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 | ||||
|             users = get_objects_for_user(request.user, "authentik_core.view_user").filter( | ||||
|                 pk=user.pk | ||||
|             ) | ||||
|             if not users.exists(): | ||||
|                 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": ""} | ||||
|         try: | ||||
|             result = mapping.evaluate(dry_run=True, **context) | ||||
|             response_data["result"] = dumps( | ||||
|                 sanitize_item(result), indent=(4 if format_result else None) | ||||
|             ) | ||||
|         except PropertyMappingExpressionException as exc: | ||||
|             response_data["result"] = exception_to_string(exc.exc) | ||||
|             response_data["successful"] = False | ||||
|         except Exception as exc: | ||||
|             response_data["result"] = exception_to_string(exc) | ||||
|             response_data["successful"] = False | ||||
|         response = PropertyMappingTestResultSerializer(response_data) | ||||
|         return Response(response.data) | ||||
							
								
								
									
										149
									
								
								authentik/core/api/propertymappings.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										149
									
								
								authentik/core/api/propertymappings.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,149 @@ | ||||
| """PropertyMapping API Views""" | ||||
|  | ||||
| from json import dumps | ||||
|  | ||||
| from drf_spectacular.types import OpenApiTypes | ||||
| from drf_spectacular.utils import OpenApiParameter, OpenApiResponse, extend_schema | ||||
| from guardian.shortcuts import get_objects_for_user | ||||
| from rest_framework import mixins | ||||
| from rest_framework.decorators import action | ||||
| from rest_framework.exceptions import PermissionDenied | ||||
| from rest_framework.fields import BooleanField, CharField | ||||
| 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 authentik.api.decorators import permission_required | ||||
| from authentik.blueprints.api import ManagedSerializer | ||||
| from authentik.core.api.used_by import UsedByMixin | ||||
| from authentik.core.api.utils import MetaNameSerializer, PassiveSerializer, TypeCreateSerializer | ||||
| from authentik.core.expression.evaluator import PropertyMappingEvaluator | ||||
| from authentik.core.models import PropertyMapping | ||||
| from authentik.events.utils import sanitize_item | ||||
| from authentik.lib.utils.reflection import all_subclasses | ||||
| from authentik.policies.api.exec import PolicyTestSerializer | ||||
|  | ||||
|  | ||||
| class PropertyMappingTestResultSerializer(PassiveSerializer): | ||||
|     """Result of a Property-mapping test""" | ||||
|  | ||||
|     result = CharField(read_only=True) | ||||
|     successful = BooleanField(read_only=True) | ||||
|  | ||||
|  | ||||
| class PropertyMappingSerializer(ManagedSerializer, ModelSerializer, MetaNameSerializer): | ||||
|     """PropertyMapping Serializer""" | ||||
|  | ||||
|     component = SerializerMethodField() | ||||
|  | ||||
|     def get_component(self, obj: PropertyMapping) -> str: | ||||
|         """Get object's component so that we know how to edit the object""" | ||||
|         return obj.component | ||||
|  | ||||
|     def validate_expression(self, expression: str) -> str: | ||||
|         """Test Syntax""" | ||||
|         evaluator = PropertyMappingEvaluator( | ||||
|             self.instance, | ||||
|         ) | ||||
|         evaluator.validate(expression) | ||||
|         return expression | ||||
|  | ||||
|     class Meta: | ||||
|         model = PropertyMapping | ||||
|         fields = [ | ||||
|             "pk", | ||||
|             "managed", | ||||
|             "name", | ||||
|             "expression", | ||||
|             "component", | ||||
|             "verbose_name", | ||||
|             "verbose_name_plural", | ||||
|             "meta_model_name", | ||||
|         ] | ||||
|  | ||||
|  | ||||
| class PropertyMappingViewSet( | ||||
|     mixins.RetrieveModelMixin, | ||||
|     mixins.DestroyModelMixin, | ||||
|     UsedByMixin, | ||||
|     mixins.ListModelMixin, | ||||
|     GenericViewSet, | ||||
| ): | ||||
|     """PropertyMapping Viewset""" | ||||
|  | ||||
|     queryset = PropertyMapping.objects.none() | ||||
|     serializer_class = PropertyMappingSerializer | ||||
|     search_fields = [ | ||||
|         "name", | ||||
|     ] | ||||
|     filterset_fields = {"managed": ["isnull"]} | ||||
|     ordering = ["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") | ||||
|     @extend_schema( | ||||
|         request=PolicyTestSerializer(), | ||||
|         responses={ | ||||
|             200: PropertyMappingTestResultSerializer, | ||||
|             400: OpenApiResponse(description="Invalid parameters"), | ||||
|         }, | ||||
|         parameters=[ | ||||
|             OpenApiParameter( | ||||
|                 name="format_result", | ||||
|                 location=OpenApiParameter.QUERY, | ||||
|                 type=OpenApiTypes.BOOL, | ||||
|             ) | ||||
|         ], | ||||
|     ) | ||||
|     @action(detail=True, pagination_class=None, filter_backends=[], methods=["POST"]) | ||||
|     def test(self, request: Request, pk: str) -> Response: | ||||
|         """Test Property Mapping""" | ||||
|         mapping: PropertyMapping = self.get_object() | ||||
|         test_params = PolicyTestSerializer(data=request.data) | ||||
|         if not test_params.is_valid(): | ||||
|             return Response(test_params.errors, status=400) | ||||
|  | ||||
|         format_result = str(request.GET.get("format_result", "false")).lower() == "true" | ||||
|  | ||||
|         # User permission check, only allow mapping testing for users that are readable | ||||
|         users = get_objects_for_user(request.user, "authentik_core.view_user").filter( | ||||
|             pk=test_params.validated_data["user"].pk | ||||
|         ) | ||||
|         if not users.exists(): | ||||
|             raise PermissionDenied() | ||||
|  | ||||
|         response_data = {"successful": True, "result": ""} | ||||
|         try: | ||||
|             result = mapping.evaluate( | ||||
|                 users.first(), | ||||
|                 self.request, | ||||
|                 **test_params.validated_data.get("context", {}), | ||||
|             ) | ||||
|             response_data["result"] = dumps( | ||||
|                 sanitize_item(result), indent=(4 if format_result else None) | ||||
|             ) | ||||
|         except Exception as exc:  # pylint: disable=broad-except | ||||
|             response_data["result"] = str(exc) | ||||
|             response_data["successful"] = False | ||||
|         response = PropertyMappingTestResultSerializer(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_filters.filters import BooleanFilter | ||||
| from django_filters.filterset import FilterSet | ||||
| from drf_spectacular.utils import extend_schema | ||||
| 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 authentik.core.api.object_types import TypesMixin | ||||
| 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.enterprise.apps import EnterpriseConfig | ||||
| from authentik.lib.utils.reflection import all_subclasses | ||||
|  | ||||
|  | ||||
| class ProviderSerializer(ModelSerializer, MetaNameSerializer): | ||||
| @ -38,7 +44,6 @@ class ProviderSerializer(ModelSerializer, MetaNameSerializer): | ||||
|             "name", | ||||
|             "authentication_flow", | ||||
|             "authorization_flow", | ||||
|             "invalidation_flow", | ||||
|             "property_mappings", | ||||
|             "component", | ||||
|             "assigned_application_slug", | ||||
| @ -51,7 +56,6 @@ class ProviderSerializer(ModelSerializer, MetaNameSerializer): | ||||
|         ] | ||||
|         extra_kwargs = { | ||||
|             "authorization_flow": {"required": True, "allow_null": False}, | ||||
|             "invalidation_flow": {"required": True, "allow_null": False}, | ||||
|         } | ||||
|  | ||||
|  | ||||
| @ -59,12 +63,8 @@ class ProviderFilter(FilterSet): | ||||
|     """Filter for providers""" | ||||
|  | ||||
|     application__isnull = BooleanFilter(method="filter_application__isnull") | ||||
|     backchannel = BooleanFilter( | ||||
|         method="filter_backchannel", | ||||
|         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" | ||||
|         ), | ||||
|     backchannel_only = BooleanFilter( | ||||
|         method="filter_backchannel_only", | ||||
|     ) | ||||
|  | ||||
|     def filter_application__isnull(self, queryset: QuerySet, name, value): | ||||
| @ -75,14 +75,12 @@ class ProviderFilter(FilterSet): | ||||
|             | Q(application__isnull=value) | ||||
|         ) | ||||
|  | ||||
|     def filter_backchannel(self, queryset: QuerySet, name, value): | ||||
|         """By default all providers are returned. When set to true, only backchannel providers are | ||||
|         returned. When set to false, backchannel providers are excluded""" | ||||
|     def filter_backchannel_only(self, queryset: QuerySet, name, value): | ||||
|         """Only return backchannel providers""" | ||||
|         return queryset.filter(is_backchannel=value) | ||||
|  | ||||
|  | ||||
| class ProviderViewSet( | ||||
|     TypesMixin, | ||||
|     mixins.RetrieveModelMixin, | ||||
|     mixins.DestroyModelMixin, | ||||
|     UsedByMixin, | ||||
| @ -101,3 +99,31 @@ class ProviderViewSet( | ||||
|  | ||||
|     def get_queryset(self):  # pragma: no cover | ||||
|         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) | ||||
|  | ||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user
	