Merge branch 'main' into website/edit/links-to-schemas
* main: (867 commits) website: bump elliptic from 6.5.7 to 6.6.0 in /website (#11869) core: bump selenium from 4.25.0 to 4.26.0 (#11875) core: bump goauthentik.io/api/v3 from 3.2024083.14 to 3.2024100.1 (#11876) website/docs: add info about invalidation flow, default flows in general (#11800) website: fix docs redirect (#11873) website: remove RC disclaimer for version 2024.10 (#11871) website: update supported versions (#11841) web: bump API Client version (#11870) root: backport version bump 2024.10.0 (#11868) website/docs: 2024.8.4 release notes (#11862) web/admin: provide default invalidation flows for LDAP and Radius (#11861) core, web: update translations (#11858) web/admin: fix code-based MFA toggle not working in wizard (#11854) sources/kerberos: add kiprop to ignored system principals (#11852) translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#11846) translate: Updates for file locale/en/LC_MESSAGES/django.po in it (#11845) translate: Updates for file web/xliff/en.xlf in zh_CN (#11847) translate: Updates for file web/xliff/en.xlf in zh-Hans (#11848) translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#11849) translate: Updates for file web/xliff/en.xlf in it (#11850) ...
This commit is contained in:
		| @ -1,5 +1,5 @@ | |||||||
| [bumpversion] | [bumpversion] | ||||||
| current_version = 2024.6.1 | current_version = 2024.10.0 | ||||||
| tag = True | tag = True | ||||||
| commit = True | commit = True | ||||||
| parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<rc_t>[a-zA-Z-]+)(?P<rc_n>[1-9]\\d*))? | parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<rc_t>[a-zA-Z-]+)(?P<rc_n>[1-9]\\d*))? | ||||||
|  | |||||||
| @ -29,9 +29,15 @@ outputs: | |||||||
|   imageTags: |   imageTags: | ||||||
|     description: "Docker image tags" |     description: "Docker image tags" | ||||||
|     value: ${{ steps.ev.outputs.imageTags }} |     value: ${{ steps.ev.outputs.imageTags }} | ||||||
|  |   attestImageNames: | ||||||
|  |     description: "Docker image names used for attestation" | ||||||
|  |     value: ${{ steps.ev.outputs.attestImageNames }} | ||||||
|   imageMainTag: |   imageMainTag: | ||||||
|     description: "Docker image main tag" |     description: "Docker image main tag" | ||||||
|     value: ${{ steps.ev.outputs.imageMainTag }} |     value: ${{ steps.ev.outputs.imageMainTag }} | ||||||
|  |   imageMainName: | ||||||
|  |     description: "Docker image main name" | ||||||
|  |     value: ${{ steps.ev.outputs.imageMainName }} | ||||||
|  |  | ||||||
| runs: | runs: | ||||||
|   using: "composite" |   using: "composite" | ||||||
|  | |||||||
| @ -7,7 +7,7 @@ from time import time | |||||||
| parser = configparser.ConfigParser() | parser = configparser.ConfigParser() | ||||||
| parser.read(".bumpversion.cfg") | parser.read(".bumpversion.cfg") | ||||||
|  |  | ||||||
| should_build = str(os.environ.get("DOCKER_USERNAME", None) is not None).lower() | should_build = str(len(os.environ.get("DOCKER_USERNAME", "")) > 0).lower() | ||||||
|  |  | ||||||
| branch_name = os.environ["GITHUB_REF"] | branch_name = os.environ["GITHUB_REF"] | ||||||
| if os.environ.get("GITHUB_HEAD_REF", "") != "": | if os.environ.get("GITHUB_HEAD_REF", "") != "": | ||||||
| @ -50,13 +50,25 @@ else: | |||||||
|             f"{name}:gh-{safe_branch_name}-{int(time())}-{sha[:7]}{suffix}",  # Use by FluxCD |             f"{name}:gh-{safe_branch_name}-{int(time())}-{sha[:7]}{suffix}",  # Use by FluxCD | ||||||
|         ] |         ] | ||||||
|  |  | ||||||
| image_main_tag = image_tags[0] | image_main_tag = image_tags[0].split(":")[-1] | ||||||
| image_tags_rendered = ",".join(image_tags) |  | ||||||
|  |  | ||||||
|  | def get_attest_image_names(image_with_tags: list[str]): | ||||||
|  |     """Attestation only for GHCR""" | ||||||
|  |     image_tags = [] | ||||||
|  |     for image_name in set(name.split(":")[0] for name in image_with_tags): | ||||||
|  |         if not image_name.startswith("ghcr.io"): | ||||||
|  |             continue | ||||||
|  |         image_tags.append(image_name) | ||||||
|  |     return ",".join(set(image_tags)) | ||||||
|  |  | ||||||
|  |  | ||||||
| with open(os.environ["GITHUB_OUTPUT"], "a+", encoding="utf-8") as _output: | with open(os.environ["GITHUB_OUTPUT"], "a+", encoding="utf-8") as _output: | ||||||
|     print(f"shouldBuild={should_build}", file=_output) |     print(f"shouldBuild={should_build}", file=_output) | ||||||
|     print(f"sha={sha}", file=_output) |     print(f"sha={sha}", file=_output) | ||||||
|     print(f"version={version}", file=_output) |     print(f"version={version}", file=_output) | ||||||
|     print(f"prerelease={prerelease}", file=_output) |     print(f"prerelease={prerelease}", file=_output) | ||||||
|     print(f"imageTags={image_tags_rendered}", 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"imageMainTag={image_main_tag}", file=_output) | ||||||
|  |     print(f"imageMainName={image_tags[0]}", file=_output) | ||||||
|  | |||||||
							
								
								
									
										2
									
								
								.github/actions/setup/action.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/actions/setup/action.yml
									
									
									
									
										vendored
									
									
								
							| @ -14,7 +14,7 @@ runs: | |||||||
|       run: | |       run: | | ||||||
|         pipx install poetry || true |         pipx install poetry || true | ||||||
|         sudo apt-get update |         sudo apt-get update | ||||||
|         sudo apt-get install --no-install-recommends -y libpq-dev openssl libxmlsec1-dev pkg-config gettext |         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 | ||||||
|     - name: Setup python and restore poetry |     - name: Setup python and restore poetry | ||||||
|       uses: actions/setup-python@v5 |       uses: actions/setup-python@v5 | ||||||
|       with: |       with: | ||||||
|  | |||||||
							
								
								
									
										11
									
								
								.github/dependabot.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										11
									
								
								.github/dependabot.yml
									
									
									
									
										vendored
									
									
								
							| @ -23,7 +23,6 @@ updates: | |||||||
|   - package-ecosystem: npm |   - package-ecosystem: npm | ||||||
|     directories: |     directories: | ||||||
|       - "/web" |       - "/web" | ||||||
|       - "/tests/wdio" |  | ||||||
|       - "/web/sfe" |       - "/web/sfe" | ||||||
|     schedule: |     schedule: | ||||||
|       interval: daily |       interval: daily | ||||||
| @ -44,9 +43,11 @@ updates: | |||||||
|           - "babel-*" |           - "babel-*" | ||||||
|       eslint: |       eslint: | ||||||
|         patterns: |         patterns: | ||||||
|  |           - "@eslint/*" | ||||||
|           - "@typescript-eslint/*" |           - "@typescript-eslint/*" | ||||||
|           - "eslint" |  | ||||||
|           - "eslint-*" |           - "eslint-*" | ||||||
|  |           - "eslint" | ||||||
|  |           - "typescript-eslint" | ||||||
|       storybook: |       storybook: | ||||||
|         patterns: |         patterns: | ||||||
|           - "@storybook/*" |           - "@storybook/*" | ||||||
| @ -54,10 +55,16 @@ updates: | |||||||
|       esbuild: |       esbuild: | ||||||
|         patterns: |         patterns: | ||||||
|           - "@esbuild/*" |           - "@esbuild/*" | ||||||
|  |           - "esbuild*" | ||||||
|       rollup: |       rollup: | ||||||
|         patterns: |         patterns: | ||||||
|           - "@rollup/*" |           - "@rollup/*" | ||||||
|           - "rollup-*" |           - "rollup-*" | ||||||
|  |           - "rollup*" | ||||||
|  |       swc: | ||||||
|  |         patterns: | ||||||
|  |           - "@swc/*" | ||||||
|  |           - "swc-*" | ||||||
|       wdio: |       wdio: | ||||||
|         patterns: |         patterns: | ||||||
|           - "@wdio/*" |           - "@wdio/*" | ||||||
|  | |||||||
							
								
								
									
										2
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							| @ -1,7 +1,7 @@ | |||||||
| <!-- | <!-- | ||||||
| 👋 Hi there! Welcome. | 👋 Hi there! Welcome. | ||||||
|  |  | ||||||
| Please check the Contributing guidelines: https://goauthentik.io/developer-docs/#how-can-i-contribute | Please check the Contributing guidelines: https://docs.goauthentik.io/docs/developer-docs/#how-can-i-contribute | ||||||
| --> | --> | ||||||
|  |  | ||||||
| ## Details | ## Details | ||||||
|  | |||||||
							
								
								
									
										6
									
								
								.github/workflows/api-ts-publish.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										6
									
								
								.github/workflows/api-ts-publish.yml
									
									
									
									
										vendored
									
									
								
							| @ -35,12 +35,12 @@ jobs: | |||||||
|         run: | |         run: | | ||||||
|           export VERSION=`node -e 'console.log(require("../gen-ts-api/package.json").version)'` |           export VERSION=`node -e 'console.log(require("../gen-ts-api/package.json").version)'` | ||||||
|           npm i @goauthentik/api@$VERSION |           npm i @goauthentik/api@$VERSION | ||||||
|       - name: Upgrade /web/sfe |       - name: Upgrade /web/packages/sfe | ||||||
|         working-directory: web/sfe |         working-directory: web/packages/sfe | ||||||
|         run: | |         run: | | ||||||
|           export VERSION=`node -e 'console.log(require("../gen-ts-api/package.json").version)'` |           export VERSION=`node -e 'console.log(require("../gen-ts-api/package.json").version)'` | ||||||
|           npm i @goauthentik/api@$VERSION |           npm i @goauthentik/api@$VERSION | ||||||
|       - uses: peter-evans/create-pull-request@v6 |       - uses: peter-evans/create-pull-request@v7 | ||||||
|         id: cpr |         id: cpr | ||||||
|         with: |         with: | ||||||
|           token: ${{ steps.generate_token.outputs.token }} |           token: ${{ steps.generate_token.outputs.token }} | ||||||
|  | |||||||
							
								
								
									
										38
									
								
								.github/workflows/ci-main.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										38
									
								
								.github/workflows/ci-main.yml
									
									
									
									
										vendored
									
									
								
							| @ -120,6 +120,12 @@ jobs: | |||||||
|         with: |         with: | ||||||
|           flags: unit |           flags: unit | ||||||
|           token: ${{ secrets.CODECOV_TOKEN }} |           token: ${{ secrets.CODECOV_TOKEN }} | ||||||
|  |       - if: ${{ !cancelled() }} | ||||||
|  |         uses: codecov/test-results-action@v1 | ||||||
|  |         with: | ||||||
|  |           flags: unit | ||||||
|  |           file: unittest.xml | ||||||
|  |           token: ${{ secrets.CODECOV_TOKEN }} | ||||||
|   test-integration: |   test-integration: | ||||||
|     runs-on: ubuntu-latest |     runs-on: ubuntu-latest | ||||||
|     timeout-minutes: 30 |     timeout-minutes: 30 | ||||||
| @ -138,6 +144,12 @@ jobs: | |||||||
|         with: |         with: | ||||||
|           flags: integration |           flags: integration | ||||||
|           token: ${{ secrets.CODECOV_TOKEN }} |           token: ${{ secrets.CODECOV_TOKEN }} | ||||||
|  |       - if: ${{ !cancelled() }} | ||||||
|  |         uses: codecov/test-results-action@v1 | ||||||
|  |         with: | ||||||
|  |           flags: integration | ||||||
|  |           file: unittest.xml | ||||||
|  |           token: ${{ secrets.CODECOV_TOKEN }} | ||||||
|   test-e2e: |   test-e2e: | ||||||
|     name: test-e2e (${{ matrix.job.name }}) |     name: test-e2e (${{ matrix.job.name }}) | ||||||
|     runs-on: ubuntu-latest |     runs-on: ubuntu-latest | ||||||
| @ -168,7 +180,7 @@ jobs: | |||||||
|         uses: ./.github/actions/setup |         uses: ./.github/actions/setup | ||||||
|       - name: Setup e2e env (chrome, etc) |       - name: Setup e2e env (chrome, etc) | ||||||
|         run: | |         run: | | ||||||
|           docker compose -f tests/e2e/docker-compose.yml up -d |           docker compose -f tests/e2e/docker-compose.yml up -d --quiet-pull | ||||||
|       - id: cache-web |       - id: cache-web | ||||||
|         uses: actions/cache@v4 |         uses: actions/cache@v4 | ||||||
|         with: |         with: | ||||||
| @ -190,6 +202,12 @@ jobs: | |||||||
|         with: |         with: | ||||||
|           flags: e2e |           flags: e2e | ||||||
|           token: ${{ secrets.CODECOV_TOKEN }} |           token: ${{ secrets.CODECOV_TOKEN }} | ||||||
|  |       - if: ${{ !cancelled() }} | ||||||
|  |         uses: codecov/test-results-action@v1 | ||||||
|  |         with: | ||||||
|  |           flags: e2e | ||||||
|  |           file: unittest.xml | ||||||
|  |           token: ${{ secrets.CODECOV_TOKEN }} | ||||||
|   ci-core-mark: |   ci-core-mark: | ||||||
|     needs: |     needs: | ||||||
|       - lint |       - lint | ||||||
| @ -213,13 +231,16 @@ jobs: | |||||||
|     permissions: |     permissions: | ||||||
|       # Needed to upload contianer images to ghcr.io |       # Needed to upload contianer images to ghcr.io | ||||||
|       packages: write |       packages: write | ||||||
|  |       # Needed for attestation | ||||||
|  |       id-token: write | ||||||
|  |       attestations: write | ||||||
|     timeout-minutes: 120 |     timeout-minutes: 120 | ||||||
|     steps: |     steps: | ||||||
|       - uses: actions/checkout@v4 |       - uses: actions/checkout@v4 | ||||||
|         with: |         with: | ||||||
|           ref: ${{ github.event.pull_request.head.sha }} |           ref: ${{ github.event.pull_request.head.sha }} | ||||||
|       - name: Set up QEMU |       - name: Set up QEMU | ||||||
|         uses: docker/setup-qemu-action@v3.1.0 |         uses: docker/setup-qemu-action@v3.2.0 | ||||||
|       - name: Set up Docker Buildx |       - name: Set up Docker Buildx | ||||||
|         uses: docker/setup-buildx-action@v3 |         uses: docker/setup-buildx-action@v3 | ||||||
|       - name: prepare variables |       - name: prepare variables | ||||||
| @ -241,6 +262,7 @@ jobs: | |||||||
|         run: make gen-client-ts |         run: make gen-client-ts | ||||||
|       - name: Build Docker Image |       - name: Build Docker Image | ||||||
|         uses: docker/build-push-action@v6 |         uses: docker/build-push-action@v6 | ||||||
|  |         id: push | ||||||
|         with: |         with: | ||||||
|           context: . |           context: . | ||||||
|           secrets: | |           secrets: | | ||||||
| @ -251,8 +273,15 @@ jobs: | |||||||
|           build-args: | |           build-args: | | ||||||
|             GIT_BUILD_HASH=${{ steps.ev.outputs.sha }} |             GIT_BUILD_HASH=${{ steps.ev.outputs.sha }} | ||||||
|           cache-from: type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache |           cache-from: type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache | ||||||
|           cache-to: type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache,mode=max |           cache-to: ${{ steps.ev.outputs.shouldBuild == 'true' && 'type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache,mode=max' || '' }} | ||||||
|           platforms: linux/${{ matrix.arch }} |           platforms: linux/${{ matrix.arch }} | ||||||
|  |       - uses: actions/attest-build-provenance@v1 | ||||||
|  |         id: attest | ||||||
|  |         if: ${{ steps.ev.outputs.shouldBuild == 'true' }} | ||||||
|  |         with: | ||||||
|  |           subject-name: ${{ steps.ev.outputs.attestImageNames }} | ||||||
|  |           subject-digest: ${{ steps.push.outputs.digest }} | ||||||
|  |           push-to-registry: true | ||||||
|   pr-comment: |   pr-comment: | ||||||
|     needs: |     needs: | ||||||
|       - build |       - build | ||||||
| @ -274,6 +303,7 @@ jobs: | |||||||
|         with: |         with: | ||||||
|           image-name: ghcr.io/goauthentik/dev-server |           image-name: ghcr.io/goauthentik/dev-server | ||||||
|       - name: Comment on PR |       - name: Comment on PR | ||||||
|  |         if: ${{ steps.ev.outputs.shouldBuild == 'true' }} | ||||||
|         uses: ./.github/actions/comment-pr-instructions |         uses: ./.github/actions/comment-pr-instructions | ||||||
|         with: |         with: | ||||||
|           tag: gh-${{ steps.ev.outputs.imageMainTag }} |           tag: ${{ steps.ev.outputs.imageMainTag }} | ||||||
|  | |||||||
							
								
								
									
										17
									
								
								.github/workflows/ci-outpost.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										17
									
								
								.github/workflows/ci-outpost.yml
									
									
									
									
										vendored
									
									
								
							| @ -31,7 +31,7 @@ jobs: | |||||||
|       - name: golangci-lint |       - name: golangci-lint | ||||||
|         uses: golangci/golangci-lint-action@v6 |         uses: golangci/golangci-lint-action@v6 | ||||||
|         with: |         with: | ||||||
|           version: v1.54.2 |           version: latest | ||||||
|           args: --timeout 5000s --verbose |           args: --timeout 5000s --verbose | ||||||
|           skip-cache: true |           skip-cache: true | ||||||
|   test-unittest: |   test-unittest: | ||||||
| @ -71,12 +71,15 @@ jobs: | |||||||
|     permissions: |     permissions: | ||||||
|       # Needed to upload contianer images to ghcr.io |       # Needed to upload contianer images to ghcr.io | ||||||
|       packages: write |       packages: write | ||||||
|  |       # Needed for attestation | ||||||
|  |       id-token: write | ||||||
|  |       attestations: write | ||||||
|     steps: |     steps: | ||||||
|       - uses: actions/checkout@v4 |       - uses: actions/checkout@v4 | ||||||
|         with: |         with: | ||||||
|           ref: ${{ github.event.pull_request.head.sha }} |           ref: ${{ github.event.pull_request.head.sha }} | ||||||
|       - name: Set up QEMU |       - name: Set up QEMU | ||||||
|         uses: docker/setup-qemu-action@v3.1.0 |         uses: docker/setup-qemu-action@v3.2.0 | ||||||
|       - name: Set up Docker Buildx |       - name: Set up Docker Buildx | ||||||
|         uses: docker/setup-buildx-action@v3 |         uses: docker/setup-buildx-action@v3 | ||||||
|       - name: prepare variables |       - name: prepare variables | ||||||
| @ -96,6 +99,7 @@ jobs: | |||||||
|       - name: Generate API |       - name: Generate API | ||||||
|         run: make gen-client-go |         run: make gen-client-go | ||||||
|       - name: Build Docker Image |       - name: Build Docker Image | ||||||
|  |         id: push | ||||||
|         uses: docker/build-push-action@v6 |         uses: docker/build-push-action@v6 | ||||||
|         with: |         with: | ||||||
|           tags: ${{ steps.ev.outputs.imageTags }} |           tags: ${{ steps.ev.outputs.imageTags }} | ||||||
| @ -106,7 +110,14 @@ jobs: | |||||||
|           platforms: linux/amd64,linux/arm64 |           platforms: linux/amd64,linux/arm64 | ||||||
|           context: . |           context: . | ||||||
|           cache-from: type=registry,ref=ghcr.io/goauthentik/dev-${{ matrix.type }}:buildcache |           cache-from: type=registry,ref=ghcr.io/goauthentik/dev-${{ matrix.type }}:buildcache | ||||||
|           cache-to: type=registry,ref=ghcr.io/goauthentik/dev-${{ matrix.type }}:buildcache,mode=max |           cache-to: ${{ steps.ev.outputs.shouldBuild == 'true' && format('type=registry,ref=ghcr.io/goauthentik/dev-{0}:buildcache,mode=max', matrix.type) || '' }} | ||||||
|  |       - uses: actions/attest-build-provenance@v1 | ||||||
|  |         id: attest | ||||||
|  |         if: ${{ steps.ev.outputs.shouldBuild == 'true' }} | ||||||
|  |         with: | ||||||
|  |           subject-name: ${{ steps.ev.outputs.attestImageNames }} | ||||||
|  |           subject-digest: ${{ steps.push.outputs.digest }} | ||||||
|  |           push-to-registry: true | ||||||
|   build-binary: |   build-binary: | ||||||
|     timeout-minutes: 120 |     timeout-minutes: 120 | ||||||
|     needs: |     needs: | ||||||
|  | |||||||
							
								
								
									
										31
									
								
								.github/workflows/ci-web.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										31
									
								
								.github/workflows/ci-web.yml
									
									
									
									
										vendored
									
									
								
							| @ -24,24 +24,11 @@ jobs: | |||||||
|           - prettier-check |           - prettier-check | ||||||
|         project: |         project: | ||||||
|           - web |           - web | ||||||
|           - tests/wdio |  | ||||||
|         include: |         include: | ||||||
|           - command: tsc |           - command: tsc | ||||||
|             project: web |             project: web | ||||||
|             extra_setup: | |  | ||||||
|               cd sfe/ && npm ci |  | ||||||
|           - command: lit-analyse |           - command: lit-analyse | ||||||
|             project: web |             project: web | ||||||
|             extra_setup: | |  | ||||||
|               # lit-analyse doesn't understand path rewrites, so make it |  | ||||||
|               # belive it's an actual module |  | ||||||
|               cd node_modules/@goauthentik |  | ||||||
|               ln -s ../../src/ web |  | ||||||
|         exclude: |  | ||||||
|           - command: lint:lockfile |  | ||||||
|             project: tests/wdio |  | ||||||
|           - command: tsc |  | ||||||
|             project: tests/wdio |  | ||||||
|     steps: |     steps: | ||||||
|       - uses: actions/checkout@v4 |       - uses: actions/checkout@v4 | ||||||
|       - uses: actions/setup-node@v4 |       - uses: actions/setup-node@v4 | ||||||
| @ -52,21 +39,12 @@ jobs: | |||||||
|       - working-directory: ${{ matrix.project }}/ |       - working-directory: ${{ matrix.project }}/ | ||||||
|         run: | |         run: | | ||||||
|           npm ci |           npm ci | ||||||
|           ${{ matrix.extra_setup }} |  | ||||||
|       - name: Generate API |       - name: Generate API | ||||||
|         run: make gen-client-ts |         run: make gen-client-ts | ||||||
|       - name: Lint |       - name: Lint | ||||||
|         working-directory: ${{ matrix.project }}/ |         working-directory: ${{ matrix.project }}/ | ||||||
|         run: npm run ${{ matrix.command }} |         run: npm run ${{ matrix.command }} | ||||||
|   ci-web-mark: |  | ||||||
|     needs: |  | ||||||
|       - lint |  | ||||||
|     runs-on: ubuntu-latest |  | ||||||
|     steps: |  | ||||||
|       - run: echo mark |  | ||||||
|   build: |   build: | ||||||
|     needs: |  | ||||||
|       - ci-web-mark |  | ||||||
|     runs-on: ubuntu-latest |     runs-on: ubuntu-latest | ||||||
|     steps: |     steps: | ||||||
|       - uses: actions/checkout@v4 |       - uses: actions/checkout@v4 | ||||||
| @ -82,6 +60,13 @@ jobs: | |||||||
|       - name: build |       - name: build | ||||||
|         working-directory: web/ |         working-directory: web/ | ||||||
|         run: npm run build |         run: npm run build | ||||||
|  |   ci-web-mark: | ||||||
|  |     needs: | ||||||
|  |       - build | ||||||
|  |       - lint | ||||||
|  |     runs-on: ubuntu-latest | ||||||
|  |     steps: | ||||||
|  |       - run: echo mark | ||||||
|   test: |   test: | ||||||
|     needs: |     needs: | ||||||
|       - ci-web-mark |       - ci-web-mark | ||||||
| @ -99,4 +84,4 @@ jobs: | |||||||
|         run: make gen-client-ts |         run: make gen-client-ts | ||||||
|       - name: test |       - name: test | ||||||
|         working-directory: web/ |         working-directory: web/ | ||||||
|         run: npm run test |         run: npm run test || exit 0 | ||||||
|  | |||||||
| @ -24,7 +24,7 @@ jobs: | |||||||
|       - name: Setup authentik env |       - name: Setup authentik env | ||||||
|         uses: ./.github/actions/setup |         uses: ./.github/actions/setup | ||||||
|       - run: poetry run ak update_webauthn_mds |       - run: poetry run ak update_webauthn_mds | ||||||
|       - uses: peter-evans/create-pull-request@v6 |       - uses: peter-evans/create-pull-request@v7 | ||||||
|         id: cpr |         id: cpr | ||||||
|         with: |         with: | ||||||
|           token: ${{ steps.generate_token.outputs.token }} |           token: ${{ steps.generate_token.outputs.token }} | ||||||
|  | |||||||
							
								
								
									
										2
									
								
								.github/workflows/image-compress.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/workflows/image-compress.yml
									
									
									
									
										vendored
									
									
								
							| @ -42,7 +42,7 @@ jobs: | |||||||
|         with: |         with: | ||||||
|           githubToken: ${{ steps.generate_token.outputs.token }} |           githubToken: ${{ steps.generate_token.outputs.token }} | ||||||
|           compressOnly: ${{ github.event_name != 'pull_request' }} |           compressOnly: ${{ github.event_name != 'pull_request' }} | ||||||
|       - uses: peter-evans/create-pull-request@v6 |       - uses: peter-evans/create-pull-request@v7 | ||||||
|         if: "${{ github.event_name != 'pull_request' && steps.compress.outputs.markdown != '' }}" |         if: "${{ github.event_name != 'pull_request' && steps.compress.outputs.markdown != '' }}" | ||||||
|         id: cpr |         id: cpr | ||||||
|         with: |         with: | ||||||
|  | |||||||
							
								
								
									
										32
									
								
								.github/workflows/release-publish.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										32
									
								
								.github/workflows/release-publish.yml
									
									
									
									
										vendored
									
									
								
							| @ -11,10 +11,13 @@ jobs: | |||||||
|     permissions: |     permissions: | ||||||
|       # Needed to upload contianer images to ghcr.io |       # Needed to upload contianer images to ghcr.io | ||||||
|       packages: write |       packages: write | ||||||
|  |       # Needed for attestation | ||||||
|  |       id-token: write | ||||||
|  |       attestations: write | ||||||
|     steps: |     steps: | ||||||
|       - uses: actions/checkout@v4 |       - uses: actions/checkout@v4 | ||||||
|       - name: Set up QEMU |       - name: Set up QEMU | ||||||
|         uses: docker/setup-qemu-action@v3.1.0 |         uses: docker/setup-qemu-action@v3.2.0 | ||||||
|       - name: Set up Docker Buildx |       - name: Set up Docker Buildx | ||||||
|         uses: docker/setup-buildx-action@v3 |         uses: docker/setup-buildx-action@v3 | ||||||
|       - name: prepare variables |       - name: prepare variables | ||||||
| @ -41,19 +44,31 @@ jobs: | |||||||
|           mkdir -p ./gen-go-api |           mkdir -p ./gen-go-api | ||||||
|       - name: Build Docker Image |       - name: Build Docker Image | ||||||
|         uses: docker/build-push-action@v6 |         uses: docker/build-push-action@v6 | ||||||
|  |         id: push | ||||||
|         with: |         with: | ||||||
|           context: . |           context: . | ||||||
|           push: true |           push: true | ||||||
|           secrets: | |           secrets: | | ||||||
|             GEOIPUPDATE_ACCOUNT_ID=${{ secrets.GEOIPUPDATE_ACCOUNT_ID }} |             GEOIPUPDATE_ACCOUNT_ID=${{ secrets.GEOIPUPDATE_ACCOUNT_ID }} | ||||||
|             GEOIPUPDATE_LICENSE_KEY=${{ secrets.GEOIPUPDATE_LICENSE_KEY }} |             GEOIPUPDATE_LICENSE_KEY=${{ secrets.GEOIPUPDATE_LICENSE_KEY }} | ||||||
|  |           build-args: | | ||||||
|  |             VERSION=${{ github.ref }} | ||||||
|           tags: ${{ steps.ev.outputs.imageTags }} |           tags: ${{ steps.ev.outputs.imageTags }} | ||||||
|           platforms: linux/amd64,linux/arm64 |           platforms: linux/amd64,linux/arm64 | ||||||
|  |       - uses: actions/attest-build-provenance@v1 | ||||||
|  |         id: attest | ||||||
|  |         with: | ||||||
|  |           subject-name: ${{ steps.ev.outputs.attestImageNames }} | ||||||
|  |           subject-digest: ${{ steps.push.outputs.digest }} | ||||||
|  |           push-to-registry: true | ||||||
|   build-outpost: |   build-outpost: | ||||||
|     runs-on: ubuntu-latest |     runs-on: ubuntu-latest | ||||||
|     permissions: |     permissions: | ||||||
|       # Needed to upload contianer images to ghcr.io |       # Needed to upload contianer images to ghcr.io | ||||||
|       packages: write |       packages: write | ||||||
|  |       # Needed for attestation | ||||||
|  |       id-token: write | ||||||
|  |       attestations: write | ||||||
|     strategy: |     strategy: | ||||||
|       fail-fast: false |       fail-fast: false | ||||||
|       matrix: |       matrix: | ||||||
| @ -68,7 +83,7 @@ jobs: | |||||||
|         with: |         with: | ||||||
|           go-version-file: "go.mod" |           go-version-file: "go.mod" | ||||||
|       - name: Set up QEMU |       - name: Set up QEMU | ||||||
|         uses: docker/setup-qemu-action@v3.1.0 |         uses: docker/setup-qemu-action@v3.2.0 | ||||||
|       - name: Set up Docker Buildx |       - name: Set up Docker Buildx | ||||||
|         uses: docker/setup-buildx-action@v3 |         uses: docker/setup-buildx-action@v3 | ||||||
|       - name: prepare variables |       - name: prepare variables | ||||||
| @ -95,12 +110,21 @@ jobs: | |||||||
|           password: ${{ secrets.GITHUB_TOKEN }} |           password: ${{ secrets.GITHUB_TOKEN }} | ||||||
|       - name: Build Docker Image |       - name: Build Docker Image | ||||||
|         uses: docker/build-push-action@v6 |         uses: docker/build-push-action@v6 | ||||||
|  |         id: push | ||||||
|         with: |         with: | ||||||
|           push: true |           push: true | ||||||
|  |           build-args: | | ||||||
|  |             VERSION=${{ github.ref }} | ||||||
|           tags: ${{ steps.ev.outputs.imageTags }} |           tags: ${{ steps.ev.outputs.imageTags }} | ||||||
|           file: ${{ matrix.type }}.Dockerfile |           file: ${{ matrix.type }}.Dockerfile | ||||||
|           platforms: linux/amd64,linux/arm64 |           platforms: linux/amd64,linux/arm64 | ||||||
|           context: . |           context: . | ||||||
|  |       - uses: actions/attest-build-provenance@v1 | ||||||
|  |         id: attest | ||||||
|  |         with: | ||||||
|  |           subject-name: ${{ steps.ev.outputs.attestImageNames }} | ||||||
|  |           subject-digest: ${{ steps.push.outputs.digest }} | ||||||
|  |           push-to-registry: true | ||||||
|   build-outpost-binary: |   build-outpost-binary: | ||||||
|     timeout-minutes: 120 |     timeout-minutes: 120 | ||||||
|     runs-on: ubuntu-latest |     runs-on: ubuntu-latest | ||||||
| @ -178,8 +202,8 @@ jobs: | |||||||
|           image-name: ghcr.io/goauthentik/server |           image-name: ghcr.io/goauthentik/server | ||||||
|       - name: Get static files from docker image |       - name: Get static files from docker image | ||||||
|         run: | |         run: | | ||||||
|           docker pull ${{ steps.ev.outputs.imageMainTag }} |           docker pull ${{ steps.ev.outputs.imageMainName }} | ||||||
|           container=$(docker container create ${{ steps.ev.outputs.imageMainTag }}) |           container=$(docker container create ${{ steps.ev.outputs.imageMainName }}) | ||||||
|           docker cp ${container}:web/ . |           docker cp ${container}:web/ . | ||||||
|       - name: Create a Sentry.io release |       - name: Create a Sentry.io release | ||||||
|         uses: getsentry/action-release@v1 |         uses: getsentry/action-release@v1 | ||||||
|  | |||||||
| @ -32,7 +32,7 @@ jobs: | |||||||
|           poetry run ak compilemessages |           poetry run ak compilemessages | ||||||
|           make web-check-compile |           make web-check-compile | ||||||
|       - name: Create Pull Request |       - name: Create Pull Request | ||||||
|         uses: peter-evans/create-pull-request@v6 |         uses: peter-evans/create-pull-request@v7 | ||||||
|         with: |         with: | ||||||
|           token: ${{ steps.generate_token.outputs.token }} |           token: ${{ steps.generate_token.outputs.token }} | ||||||
|           branch: extract-compile-backend-translation |           branch: extract-compile-backend-translation | ||||||
|  | |||||||
							
								
								
									
										2
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							| @ -16,6 +16,6 @@ | |||||||
|         "ms-python.black-formatter", |         "ms-python.black-formatter", | ||||||
|         "redhat.vscode-yaml", |         "redhat.vscode-yaml", | ||||||
|         "Tobermory.es6-string-html", |         "Tobermory.es6-string-html", | ||||||
|         "unifiedjs.vscode-mdx", |         "unifiedjs.vscode-mdx" | ||||||
|     ] |     ] | ||||||
| } | } | ||||||
|  | |||||||
							
								
								
									
										2
									
								
								.vscode/launch.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.vscode/launch.json
									
									
									
									
										vendored
									
									
								
							| @ -22,6 +22,6 @@ | |||||||
|             }, |             }, | ||||||
|             "justMyCode": true, |             "justMyCode": true, | ||||||
|             "django": true |             "django": true | ||||||
|         }, |         } | ||||||
|     ] |     ] | ||||||
| } | } | ||||||
|  | |||||||
							
								
								
									
										22
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										22
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							| @ -6,6 +6,7 @@ | |||||||
|         "authn", |         "authn", | ||||||
|         "entra", |         "entra", | ||||||
|         "goauthentik", |         "goauthentik", | ||||||
|  |         "jwe", | ||||||
|         "jwks", |         "jwks", | ||||||
|         "kubernetes", |         "kubernetes", | ||||||
|         "oidc", |         "oidc", | ||||||
| @ -18,20 +19,21 @@ | |||||||
|         "sso", |         "sso", | ||||||
|         "totp", |         "totp", | ||||||
|         "traefik", |         "traefik", | ||||||
|         "webauthn", |         "webauthn" | ||||||
|     ], |     ], | ||||||
|     "todo-tree.tree.showCountsInTree": true, |     "todo-tree.tree.showCountsInTree": true, | ||||||
|     "todo-tree.tree.showBadges": true, |     "todo-tree.tree.showBadges": true, | ||||||
|     "yaml.customTags": [ |     "yaml.customTags": [ | ||||||
|         "!Find sequence", |  | ||||||
|         "!KeyOf scalar", |  | ||||||
|         "!Context scalar", |  | ||||||
|         "!Context sequence", |  | ||||||
|         "!Format sequence", |  | ||||||
|         "!Condition sequence", |         "!Condition sequence", | ||||||
|         "!Env sequence", |         "!Context scalar", | ||||||
|  |         "!Enumerate sequence", | ||||||
|         "!Env scalar", |         "!Env scalar", | ||||||
|         "!If sequence" |         "!Find sequence", | ||||||
|  |         "!Format sequence", | ||||||
|  |         "!If sequence", | ||||||
|  |         "!Index scalar", | ||||||
|  |         "!KeyOf scalar", | ||||||
|  |         "!Value scalar" | ||||||
|     ], |     ], | ||||||
|     "typescript.preferences.importModuleSpecifier": "non-relative", |     "typescript.preferences.importModuleSpecifier": "non-relative", | ||||||
|     "typescript.preferences.importModuleSpecifierEnding": "index", |     "typescript.preferences.importModuleSpecifierEnding": "index", | ||||||
| @ -48,9 +50,7 @@ | |||||||
|             "ignoreCase": false |             "ignoreCase": false | ||||||
|         } |         } | ||||||
|     ], |     ], | ||||||
|     "go.testFlags": [ |     "go.testFlags": ["-count=1"], | ||||||
|         "-count=1" |  | ||||||
|     ], |  | ||||||
|     "github-actions.workflows.pinned.workflows": [ |     "github-actions.workflows.pinned.workflows": [ | ||||||
|         ".github/workflows/ci-main.yml" |         ".github/workflows/ci-main.yml" | ||||||
|     ] |     ] | ||||||
|  | |||||||
							
								
								
									
										62
									
								
								.vscode/tasks.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										62
									
								
								.vscode/tasks.json
									
									
									
									
										vendored
									
									
								
							| @ -2,85 +2,67 @@ | |||||||
|     "version": "2.0.0", |     "version": "2.0.0", | ||||||
|     "tasks": [ |     "tasks": [ | ||||||
|         { |         { | ||||||
|             "label": "authentik[core]: format & test", |             "label": "authentik/core: make", | ||||||
|             "command": "poetry", |             "command": "poetry", | ||||||
|             "args": [ |             "args": ["run", "make", "lint-fix", "lint"], | ||||||
|                 "run", |             "presentation": { | ||||||
|                 "make" |                 "panel": "new" | ||||||
|             ], |             }, | ||||||
|             "group": "build", |             "group": "test" | ||||||
|         }, |         }, | ||||||
|         { |         { | ||||||
|             "label": "authentik[core]: run", |             "label": "authentik/core: run", | ||||||
|             "command": "poetry", |             "command": "poetry", | ||||||
|             "args": [ |             "args": ["run", "ak", "server"], | ||||||
|                 "run", |  | ||||||
|                 "make", |  | ||||||
|                 "run", |  | ||||||
|             ], |  | ||||||
|             "group": "build", |             "group": "build", | ||||||
|             "presentation": { |             "presentation": { | ||||||
|                 "panel": "dedicated", |                 "panel": "dedicated", | ||||||
|                 "group": "running" |                 "group": "running" | ||||||
|             }, |             } | ||||||
|         }, |         }, | ||||||
|         { |         { | ||||||
|             "label": "authentik[web]: format", |             "label": "authentik/web: make", | ||||||
|             "command": "make", |             "command": "make", | ||||||
|             "args": ["web"], |             "args": ["web"], | ||||||
|             "group": "build", |             "group": "build" | ||||||
|         }, |         }, | ||||||
|         { |         { | ||||||
|             "label": "authentik[web]: watch", |             "label": "authentik/web: watch", | ||||||
|             "command": "make", |             "command": "make", | ||||||
|             "args": ["web-watch"], |             "args": ["web-watch"], | ||||||
|             "group": "build", |             "group": "build", | ||||||
|             "presentation": { |             "presentation": { | ||||||
|                 "panel": "dedicated", |                 "panel": "dedicated", | ||||||
|                 "group": "running" |                 "group": "running" | ||||||
|             }, |             } | ||||||
|         }, |         }, | ||||||
|         { |         { | ||||||
|             "label": "authentik: install", |             "label": "authentik: install", | ||||||
|             "command": "make", |             "command": "make", | ||||||
|             "args": ["install"], |             "args": ["install", "-j4"], | ||||||
|             "group": "build", |             "group": "build" | ||||||
|         }, |         }, | ||||||
|         { |         { | ||||||
|             "label": "authentik: i18n-extract", |             "label": "authentik/website: make", | ||||||
|             "command": "poetry", |  | ||||||
|             "args": [ |  | ||||||
|                 "run", |  | ||||||
|                 "make", |  | ||||||
|                 "i18n-extract" |  | ||||||
|             ], |  | ||||||
|             "group": "build", |  | ||||||
|         }, |  | ||||||
|         { |  | ||||||
|             "label": "authentik[website]: format", |  | ||||||
|             "command": "make", |             "command": "make", | ||||||
|             "args": ["website"], |             "args": ["website"], | ||||||
|             "group": "build", |             "group": "build" | ||||||
|         }, |         }, | ||||||
|         { |         { | ||||||
|             "label": "authentik[website]: watch", |             "label": "authentik/website: watch", | ||||||
|             "command": "make", |             "command": "make", | ||||||
|             "args": ["website-watch"], |             "args": ["website-watch"], | ||||||
|             "group": "build", |             "group": "build", | ||||||
|             "presentation": { |             "presentation": { | ||||||
|                 "panel": "dedicated", |                 "panel": "dedicated", | ||||||
|                 "group": "running" |                 "group": "running" | ||||||
|             }, |             } | ||||||
|         }, |         }, | ||||||
|         { |         { | ||||||
|             "label": "authentik[api]: generate", |             "label": "authentik/api: generate", | ||||||
|             "command": "poetry", |             "command": "poetry", | ||||||
|             "args": [ |             "args": ["run", "make", "gen"], | ||||||
|                 "run", |  | ||||||
|                 "make", |  | ||||||
|                 "gen" |  | ||||||
|             ], |  | ||||||
|             "group": "build" |             "group": "build" | ||||||
|         }, |         } | ||||||
|     ] |     ] | ||||||
| } | } | ||||||
|  | |||||||
							
								
								
									
										41
									
								
								Dockerfile
									
									
									
									
									
								
							
							
						
						
									
										41
									
								
								Dockerfile
									
									
									
									
									
								
							| @ -1,7 +1,7 @@ | |||||||
| # syntax=docker/dockerfile:1 | # syntax=docker/dockerfile:1 | ||||||
|  |  | ||||||
| # Stage 1: Build website | # Stage 1: Build website | ||||||
| FROM --platform=${BUILDPLATFORM} docker.io/node:22 as website-builder | FROM --platform=${BUILDPLATFORM} docker.io/library/node:22 AS website-builder | ||||||
|  |  | ||||||
| ENV NODE_ENV=production | ENV NODE_ENV=production | ||||||
|  |  | ||||||
| @ -20,7 +20,7 @@ COPY ./SECURITY.md /work/ | |||||||
| RUN npm run build-bundled | RUN npm run build-bundled | ||||||
|  |  | ||||||
| # Stage 2: Build webui | # Stage 2: Build webui | ||||||
| FROM --platform=${BUILDPLATFORM} docker.io/node:22 as web-builder | FROM --platform=${BUILDPLATFORM} docker.io/library/node:22 AS web-builder | ||||||
|  |  | ||||||
| ARG GIT_BUILD_HASH | ARG GIT_BUILD_HASH | ||||||
| ENV GIT_BUILD_HASH=$GIT_BUILD_HASH | ENV GIT_BUILD_HASH=$GIT_BUILD_HASH | ||||||
| @ -30,12 +30,9 @@ WORKDIR /work/web | |||||||
|  |  | ||||||
| RUN --mount=type=bind,target=/work/web/package.json,src=./web/package.json \ | RUN --mount=type=bind,target=/work/web/package.json,src=./web/package.json \ | ||||||
|     --mount=type=bind,target=/work/web/package-lock.json,src=./web/package-lock.json \ |     --mount=type=bind,target=/work/web/package-lock.json,src=./web/package-lock.json \ | ||||||
|     --mount=type=bind,target=/work/web/sfe/package.json,src=./web/sfe/package.json \ |     --mount=type=bind,target=/work/web/packages/sfe/package.json,src=./web/packages/sfe/package.json \ | ||||||
|     --mount=type=bind,target=/work/web/sfe/package-lock.json,src=./web/sfe/package-lock.json \ |  | ||||||
|     --mount=type=bind,target=/work/web/scripts,src=./web/scripts \ |     --mount=type=bind,target=/work/web/scripts,src=./web/scripts \ | ||||||
|     --mount=type=cache,id=npm-web,sharing=shared,target=/root/.npm \ |     --mount=type=cache,id=npm-web,sharing=shared,target=/root/.npm \ | ||||||
|     npm ci --include=dev && \ |  | ||||||
|     cd sfe && \ |  | ||||||
|     npm ci --include=dev |     npm ci --include=dev | ||||||
|  |  | ||||||
| COPY ./package.json /work | COPY ./package.json /work | ||||||
| @ -43,12 +40,10 @@ COPY ./web /work/web/ | |||||||
| COPY ./website /work/website/ | COPY ./website /work/website/ | ||||||
| COPY ./gen-ts-api /work/web/node_modules/@goauthentik/api | COPY ./gen-ts-api /work/web/node_modules/@goauthentik/api | ||||||
|  |  | ||||||
| RUN npm run build && \ | RUN npm run build | ||||||
|     cd sfe && \ |  | ||||||
|     npm run build |  | ||||||
|  |  | ||||||
| # Stage 3: Build go proxy | # Stage 3: Build go proxy | ||||||
| FROM --platform=${BUILDPLATFORM} mcr.microsoft.com/oss/go/microsoft/golang:1.22-fips-bookworm AS go-builder | FROM --platform=${BUILDPLATFORM} mcr.microsoft.com/oss/go/microsoft/golang:1.23-fips-bookworm AS go-builder | ||||||
|  |  | ||||||
| ARG TARGETOS | ARG TARGETOS | ||||||
| ARG TARGETARCH | ARG TARGETARCH | ||||||
| @ -85,7 +80,7 @@ RUN --mount=type=cache,sharing=locked,target=/go/pkg/mod \ | |||||||
|     go build -o /go/authentik ./cmd/server |     go build -o /go/authentik ./cmd/server | ||||||
|  |  | ||||||
| # Stage 4: MaxMind GeoIP | # Stage 4: MaxMind GeoIP | ||||||
| FROM --platform=${BUILDPLATFORM} ghcr.io/maxmind/geoipupdate:v7.0.1 as geoip | FROM --platform=${BUILDPLATFORM} ghcr.io/maxmind/geoipupdate:v7.0.1 AS geoip | ||||||
|  |  | ||||||
| ENV GEOIPUPDATE_EDITION_IDS="GeoLite2-City GeoLite2-ASN" | ENV GEOIPUPDATE_EDITION_IDS="GeoLite2-City GeoLite2-ASN" | ||||||
| ENV GEOIPUPDATE_VERBOSE="1" | ENV GEOIPUPDATE_VERBOSE="1" | ||||||
| @ -99,7 +94,10 @@ RUN --mount=type=secret,id=GEOIPUPDATE_ACCOUNT_ID \ | |||||||
|     /bin/sh -c "/usr/bin/entry.sh || echo 'Failed to get GeoIP database, disabling'; exit 0" |     /bin/sh -c "/usr/bin/entry.sh || echo 'Failed to get GeoIP database, disabling'; exit 0" | ||||||
|  |  | ||||||
| # Stage 5: Python dependencies | # Stage 5: Python dependencies | ||||||
| FROM ghcr.io/goauthentik/fips-python:3.12.3-slim-bookworm-fips-full AS python-deps | FROM ghcr.io/goauthentik/fips-python:3.12.7-slim-bookworm-fips-full AS python-deps | ||||||
|  |  | ||||||
|  | ARG TARGETARCH | ||||||
|  | ARG TARGETVARIANT | ||||||
|  |  | ||||||
| WORKDIR /ak-root/poetry | WORKDIR /ak-root/poetry | ||||||
|  |  | ||||||
| @ -112,7 +110,7 @@ RUN rm -f /etc/apt/apt.conf.d/docker-clean; echo 'Binary::apt::APT::Keep-Downloa | |||||||
| RUN --mount=type=cache,id=apt-$TARGETARCH$TARGETVARIANT,sharing=locked,target=/var/cache/apt \ | RUN --mount=type=cache,id=apt-$TARGETARCH$TARGETVARIANT,sharing=locked,target=/var/cache/apt \ | ||||||
|     apt-get update && \ |     apt-get update && \ | ||||||
|     # Required for installing pip packages |     # Required for installing pip packages | ||||||
|     apt-get install -y --no-install-recommends build-essential pkg-config libpq-dev |     apt-get install -y --no-install-recommends build-essential pkg-config libpq-dev libkrb5-dev | ||||||
|  |  | ||||||
| RUN --mount=type=bind,target=./pyproject.toml,src=./pyproject.toml \ | RUN --mount=type=bind,target=./pyproject.toml,src=./pyproject.toml \ | ||||||
|     --mount=type=bind,target=./poetry.lock,src=./poetry.lock \ |     --mount=type=bind,target=./poetry.lock,src=./poetry.lock \ | ||||||
| @ -126,24 +124,24 @@ RUN --mount=type=bind,target=./pyproject.toml,src=./pyproject.toml \ | |||||||
|     pip install --force-reinstall /wheels/*" |     pip install --force-reinstall /wheels/*" | ||||||
|  |  | ||||||
| # Stage 6: Run | # Stage 6: Run | ||||||
| FROM ghcr.io/goauthentik/fips-python:3.12.3-slim-bookworm-fips-full AS final-image | FROM ghcr.io/goauthentik/fips-python:3.12.7-slim-bookworm-fips-full AS final-image | ||||||
|  |  | ||||||
| ARG GIT_BUILD_HASH |  | ||||||
| ARG VERSION | ARG VERSION | ||||||
|  | ARG GIT_BUILD_HASH | ||||||
| ENV GIT_BUILD_HASH=$GIT_BUILD_HASH | ENV GIT_BUILD_HASH=$GIT_BUILD_HASH | ||||||
|  |  | ||||||
| LABEL org.opencontainers.image.url https://goauthentik.io | LABEL org.opencontainers.image.url=https://goauthentik.io | ||||||
| LABEL org.opencontainers.image.description goauthentik.io Main server image, see https://goauthentik.io for more info. | LABEL org.opencontainers.image.description="goauthentik.io Main server image, see https://goauthentik.io for more info." | ||||||
| LABEL org.opencontainers.image.source https://github.com/goauthentik/authentik | LABEL org.opencontainers.image.source=https://github.com/goauthentik/authentik | ||||||
| LABEL org.opencontainers.image.version ${VERSION} | LABEL org.opencontainers.image.version=${VERSION} | ||||||
| LABEL org.opencontainers.image.revision ${GIT_BUILD_HASH} | LABEL org.opencontainers.image.revision=${GIT_BUILD_HASH} | ||||||
|  |  | ||||||
| WORKDIR / | WORKDIR / | ||||||
|  |  | ||||||
| # We cannot cache this layer otherwise we'll end up with a bigger image | # We cannot cache this layer otherwise we'll end up with a bigger image | ||||||
| RUN apt-get update && \ | RUN apt-get update && \ | ||||||
|     # Required for runtime |     # Required for runtime | ||||||
|     apt-get install -y --no-install-recommends libpq5 libmaxminddb0 ca-certificates && \ |     apt-get install -y --no-install-recommends libpq5 libmaxminddb0 ca-certificates libkrb5-3 libkadm5clnt-mit12 libkdb5-10 && \ | ||||||
|     # Required for bootstrap & healtcheck |     # Required for bootstrap & healtcheck | ||||||
|     apt-get install -y --no-install-recommends runit && \ |     apt-get install -y --no-install-recommends runit && \ | ||||||
|     apt-get clean && \ |     apt-get clean && \ | ||||||
| @ -163,6 +161,7 @@ COPY ./tests /tests | |||||||
| COPY ./manage.py / | COPY ./manage.py / | ||||||
| COPY ./blueprints /blueprints | COPY ./blueprints /blueprints | ||||||
| COPY ./lifecycle/ /lifecycle | COPY ./lifecycle/ /lifecycle | ||||||
|  | COPY ./authentik/sources/kerberos/krb5.conf /etc/krb5.conf | ||||||
| COPY --from=go-builder /go/authentik /bin/authentik | COPY --from=go-builder /go/authentik /bin/authentik | ||||||
| COPY --from=python-deps /ak-root/venv /ak-root/venv | COPY --from=python-deps /ak-root/venv /ak-root/venv | ||||||
| COPY --from=web-builder /work/web/dist/ /web/dist/ | COPY --from=web-builder /work/web/dist/ /web/dist/ | ||||||
|  | |||||||
							
								
								
									
										8
									
								
								Makefile
									
									
									
									
									
								
							
							
						
						
									
										8
									
								
								Makefile
									
									
									
									
									
								
							| @ -19,14 +19,13 @@ pg_name := $(shell python -m authentik.lib.config postgresql.name 2>/dev/null) | |||||||
| CODESPELL_ARGS = -D - -D .github/codespell-dictionary.txt \ | CODESPELL_ARGS = -D - -D .github/codespell-dictionary.txt \ | ||||||
| 		-I .github/codespell-words.txt \ | 		-I .github/codespell-words.txt \ | ||||||
| 		-S 'web/src/locales/**' \ | 		-S 'web/src/locales/**' \ | ||||||
| 		-S 'website/developer-docs/api/reference/**' \ | 		-S 'website/docs/developer-docs/api/reference/**' \ | ||||||
| 		authentik \ | 		authentik \ | ||||||
| 		internal \ | 		internal \ | ||||||
| 		cmd \ | 		cmd \ | ||||||
| 		web/src \ | 		web/src \ | ||||||
| 		website/src \ | 		website/src \ | ||||||
| 		website/blog \ | 		website/blog \ | ||||||
| 		website/developer-docs \ |  | ||||||
| 		website/docs \ | 		website/docs \ | ||||||
| 		website/integrations \ | 		website/integrations \ | ||||||
| 		website/src | 		website/src | ||||||
| @ -43,7 +42,7 @@ help:  ## Show this help | |||||||
| 		sort | 		sort | ||||||
| 	@echo "" | 	@echo "" | ||||||
|  |  | ||||||
| test-go: | go-test: | ||||||
| 	go test -timeout 0 -v -race -cover ./... | 	go test -timeout 0 -v -race -cover ./... | ||||||
|  |  | ||||||
| test-docker:  ## Run all tests in a docker-compose | test-docker:  ## Run all tests in a docker-compose | ||||||
| @ -210,6 +209,9 @@ web: web-lint-fix web-lint web-check-compile  ## Automatically fix formatting is | |||||||
| web-install:  ## Install the necessary libraries to build the Authentik UI | web-install:  ## Install the necessary libraries to build the Authentik UI | ||||||
| 	cd web && npm ci | 	cd web && npm ci | ||||||
|  |  | ||||||
|  | web-test: ## Run tests for the Authentik UI | ||||||
|  | 	cd web && npm run test | ||||||
|  |  | ||||||
| web-watch:  ## Build and watch the Authentik UI for changes, updating automatically | web-watch:  ## Build and watch the Authentik UI for changes, updating automatically | ||||||
| 	rm -rf web/dist/ | 	rm -rf web/dist/ | ||||||
| 	mkdir web/dist/ | 	mkdir web/dist/ | ||||||
|  | |||||||
| @ -15,7 +15,9 @@ | |||||||
|  |  | ||||||
| ## What is authentik? | ## What is authentik? | ||||||
|  |  | ||||||
| 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. | 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. | ||||||
|  |  | ||||||
| ## Installation | ## Installation | ||||||
|  |  | ||||||
| @ -32,7 +34,7 @@ For bigger setups, there is a Helm Chart [here](https://github.com/goauthentik/h | |||||||
|  |  | ||||||
| ## Development | ## Development | ||||||
|  |  | ||||||
| See [Developer Documentation](https://goauthentik.io/developer-docs/?utm_source=github) | See [Developer Documentation](https://docs.goauthentik.io/docs/developer-docs/?utm_source=github) | ||||||
|  |  | ||||||
| ## Security | ## Security | ||||||
|  |  | ||||||
|  | |||||||
| @ -18,10 +18,10 @@ Even if the issue is not a CVE, we still greatly appreciate your help in hardeni | |||||||
|  |  | ||||||
| (.x being the latest patch release for each version) | (.x being the latest patch release for each version) | ||||||
|  |  | ||||||
| | Version  | Supported | | | Version   | Supported | | ||||||
| | -------- | --------- | | | --------- | --------- | | ||||||
| | 2024.4.x | ✅        | | | 2024.8.x  | ✅        | | ||||||
| | 2024.6.x | ✅        | | | 2024.10.x | ✅        | | ||||||
|  |  | ||||||
| ## Reporting a Vulnerability | ## Reporting a Vulnerability | ||||||
|  |  | ||||||
|  | |||||||
| @ -2,7 +2,7 @@ | |||||||
|  |  | ||||||
| from os import environ | from os import environ | ||||||
|  |  | ||||||
| __version__ = "2024.6.1" | __version__ = "2024.10.0" | ||||||
| ENV_GIT_HASH_KEY = "GIT_BUILD_HASH" | ENV_GIT_HASH_KEY = "GIT_BUILD_HASH" | ||||||
|  |  | ||||||
|  |  | ||||||
|  | |||||||
| @ -73,7 +73,7 @@ class SystemInfoSerializer(PassiveSerializer): | |||||||
|             "authentik_version": get_full_version(), |             "authentik_version": get_full_version(), | ||||||
|             "environment": get_env(), |             "environment": get_env(), | ||||||
|             "openssl_fips_enabled": ( |             "openssl_fips_enabled": ( | ||||||
|                 backend._fips_enabled if LicenseKey.get_total().is_valid() else None |                 backend._fips_enabled if LicenseKey.get_total().status().is_valid else None | ||||||
|             ), |             ), | ||||||
|             "openssl_version": OPENSSL_VERSION, |             "openssl_version": OPENSSL_VERSION, | ||||||
|             "platform": platform.platform(), |             "platform": platform.platform(), | ||||||
|  | |||||||
| @ -12,6 +12,7 @@ from rest_framework.views import APIView | |||||||
| from authentik import __version__, get_build_hash | from authentik import __version__, get_build_hash | ||||||
| from authentik.admin.tasks import VERSION_CACHE_KEY, VERSION_NULL, update_latest_version | from authentik.admin.tasks import VERSION_CACHE_KEY, VERSION_NULL, update_latest_version | ||||||
| from authentik.core.api.utils import PassiveSerializer | from authentik.core.api.utils import PassiveSerializer | ||||||
|  | from authentik.outposts.models import Outpost | ||||||
|  |  | ||||||
|  |  | ||||||
| class VersionSerializer(PassiveSerializer): | class VersionSerializer(PassiveSerializer): | ||||||
| @ -22,6 +23,7 @@ class VersionSerializer(PassiveSerializer): | |||||||
|     version_latest_valid = SerializerMethodField() |     version_latest_valid = SerializerMethodField() | ||||||
|     build_hash = SerializerMethodField() |     build_hash = SerializerMethodField() | ||||||
|     outdated = SerializerMethodField() |     outdated = SerializerMethodField() | ||||||
|  |     outpost_outdated = SerializerMethodField() | ||||||
|  |  | ||||||
|     def get_build_hash(self, _) -> str: |     def get_build_hash(self, _) -> str: | ||||||
|         """Get build hash, if version is not latest or released""" |         """Get build hash, if version is not latest or released""" | ||||||
| @ -47,6 +49,15 @@ class VersionSerializer(PassiveSerializer): | |||||||
|         """Check if we're running the latest version""" |         """Check if we're running the latest version""" | ||||||
|         return parse(self.get_version_current(instance)) < parse(self.get_version_latest(instance)) |         return parse(self.get_version_current(instance)) < parse(self.get_version_latest(instance)) | ||||||
|  |  | ||||||
|  |     def get_outpost_outdated(self, _) -> bool: | ||||||
|  |         """Check if any outpost is outdated/has a version mismatch""" | ||||||
|  |         any_outdated = False | ||||||
|  |         for outpost in Outpost.objects.all(): | ||||||
|  |             for state in outpost.state: | ||||||
|  |                 if state.version_outdated: | ||||||
|  |                     any_outdated = True | ||||||
|  |         return any_outdated | ||||||
|  |  | ||||||
|  |  | ||||||
| class VersionView(APIView): | class VersionView(APIView): | ||||||
|     """Get running and latest version.""" |     """Get running and latest version.""" | ||||||
|  | |||||||
							
								
								
									
										33
									
								
								authentik/admin/api/version_history.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										33
									
								
								authentik/admin/api/version_history.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,33 @@ | |||||||
|  | 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 | ||||||
							
								
								
									
										22
									
								
								authentik/admin/models.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								authentik/admin/models.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,22 @@ | |||||||
|  | """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,10 +1,8 @@ | |||||||
| """authentik admin tasks""" | """authentik admin tasks""" | ||||||
|  |  | ||||||
| import re |  | ||||||
|  |  | ||||||
| from django.core.cache import cache | from django.core.cache import cache | ||||||
| from django.core.validators import URLValidator |  | ||||||
| from django.db import DatabaseError, InternalError, ProgrammingError | from django.db import DatabaseError, InternalError, ProgrammingError | ||||||
|  | from django.utils.translation import gettext_lazy as _ | ||||||
| from packaging.version import parse | from packaging.version import parse | ||||||
| from requests import RequestException | from requests import RequestException | ||||||
| from structlog.stdlib import get_logger | from structlog.stdlib import get_logger | ||||||
| @ -21,8 +19,6 @@ LOGGER = get_logger() | |||||||
| VERSION_NULL = "0.0.0" | VERSION_NULL = "0.0.0" | ||||||
| VERSION_CACHE_KEY = "authentik_latest_version" | VERSION_CACHE_KEY = "authentik_latest_version" | ||||||
| VERSION_CACHE_TIMEOUT = 8 * 60 * 60  # 8 hours | VERSION_CACHE_TIMEOUT = 8 * 60 * 60  # 8 hours | ||||||
| # Chop of the first ^ because we want to search the entire string |  | ||||||
| URL_FINDER = URLValidator.regex.pattern[1:] |  | ||||||
| LOCAL_VERSION = parse(__version__) | LOCAL_VERSION = parse(__version__) | ||||||
|  |  | ||||||
|  |  | ||||||
| @ -78,10 +74,16 @@ def update_latest_version(self: SystemTask): | |||||||
|                 context__new_version=upstream_version, |                 context__new_version=upstream_version, | ||||||
|             ).exists(): |             ).exists(): | ||||||
|                 return |                 return | ||||||
|             event_dict = {"new_version": upstream_version} |             Event.new( | ||||||
|             if match := re.search(URL_FINDER, data.get("stable", {}).get("changelog", "")): |                 EventAction.UPDATE_AVAILABLE, | ||||||
|                 event_dict["message"] = f"Changelog: {match.group()}" |                 message=_( | ||||||
|             Event.new(EventAction.UPDATE_AVAILABLE, **event_dict).save() |                     "New version {version} available!".format( | ||||||
|  |                         version=upstream_version, | ||||||
|  |                     ) | ||||||
|  |                 ), | ||||||
|  |                 new_version=upstream_version, | ||||||
|  |                 changelog=data.get("stable", {}).get("changelog_url"), | ||||||
|  |             ).save() | ||||||
|     except (RequestException, IndexError) as exc: |     except (RequestException, IndexError) as exc: | ||||||
|         cache.set(VERSION_CACHE_KEY, VERSION_NULL, VERSION_CACHE_TIMEOUT) |         cache.set(VERSION_CACHE_KEY, VERSION_NULL, VERSION_CACHE_TIMEOUT) | ||||||
|         self.set_error(exc) |         self.set_error(exc) | ||||||
|  | |||||||
| @ -17,6 +17,7 @@ RESPONSE_VALID = { | |||||||
|     "stable": { |     "stable": { | ||||||
|         "version": "99999999.9999999", |         "version": "99999999.9999999", | ||||||
|         "changelog": "See https://goauthentik.io/test", |         "changelog": "See https://goauthentik.io/test", | ||||||
|  |         "changelog_url": "https://goauthentik.io/test", | ||||||
|         "reason": "bugfix", |         "reason": "bugfix", | ||||||
|     }, |     }, | ||||||
| } | } | ||||||
| @ -35,7 +36,7 @@ class TestAdminTasks(TestCase): | |||||||
|                 Event.objects.filter( |                 Event.objects.filter( | ||||||
|                     action=EventAction.UPDATE_AVAILABLE, |                     action=EventAction.UPDATE_AVAILABLE, | ||||||
|                     context__new_version="99999999.9999999", |                     context__new_version="99999999.9999999", | ||||||
|                     context__message="Changelog: https://goauthentik.io/test", |                     context__message="New version 99999999.9999999 available!", | ||||||
|                 ).exists() |                 ).exists() | ||||||
|             ) |             ) | ||||||
|             # test that a consecutive check doesn't create a duplicate event |             # test that a consecutive check doesn't create a duplicate event | ||||||
| @ -45,7 +46,7 @@ class TestAdminTasks(TestCase): | |||||||
|                     Event.objects.filter( |                     Event.objects.filter( | ||||||
|                         action=EventAction.UPDATE_AVAILABLE, |                         action=EventAction.UPDATE_AVAILABLE, | ||||||
|                         context__new_version="99999999.9999999", |                         context__new_version="99999999.9999999", | ||||||
|                         context__message="Changelog: https://goauthentik.io/test", |                         context__message="New version 99999999.9999999 available!", | ||||||
|                     ) |                     ) | ||||||
|                 ), |                 ), | ||||||
|                 1, |                 1, | ||||||
|  | |||||||
| @ -6,6 +6,7 @@ from authentik.admin.api.meta import AppsViewSet, ModelViewSet | |||||||
| from authentik.admin.api.metrics import AdministrationMetricsViewSet | from authentik.admin.api.metrics import AdministrationMetricsViewSet | ||||||
| from authentik.admin.api.system import SystemView | from authentik.admin.api.system import SystemView | ||||||
| from authentik.admin.api.version import VersionView | from authentik.admin.api.version import VersionView | ||||||
|  | from authentik.admin.api.version_history import VersionHistoryViewSet | ||||||
| from authentik.admin.api.workers import WorkerView | from authentik.admin.api.workers import WorkerView | ||||||
|  |  | ||||||
| api_urlpatterns = [ | api_urlpatterns = [ | ||||||
| @ -17,6 +18,7 @@ api_urlpatterns = [ | |||||||
|         name="admin_metrics", |         name="admin_metrics", | ||||||
|     ), |     ), | ||||||
|     path("admin/version/", VersionView.as_view(), name="admin_version"), |     path("admin/version/", VersionView.as_view(), name="admin_version"), | ||||||
|  |     ("admin/version/history", VersionHistoryViewSet, "version_history"), | ||||||
|     path("admin/workers/", WorkerView.as_view(), name="admin_workers"), |     path("admin/workers/", WorkerView.as_view(), name="admin_workers"), | ||||||
|     path("admin/system/", SystemView.as_view(), name="admin_system"), |     path("admin/system/", SystemView.as_view(), name="admin_system"), | ||||||
| ] | ] | ||||||
|  | |||||||
| @ -51,9 +51,11 @@ class BlueprintInstanceSerializer(ModelSerializer): | |||||||
|         context = self.instance.context if self.instance else {} |         context = self.instance.context if self.instance else {} | ||||||
|         valid, logs = Importer.from_string(content, context).validate() |         valid, logs = Importer.from_string(content, context).validate() | ||||||
|         if not valid: |         if not valid: | ||||||
|             text_logs = "\n".join([x["event"] for x in logs]) |  | ||||||
|             raise ValidationError( |             raise ValidationError( | ||||||
|                 _("Failed to validate blueprint: {logs}".format_map({"logs": text_logs})) |                 [ | ||||||
|  |                     _("Failed to validate blueprint"), | ||||||
|  |                     *[f"- {x.event}" for x in logs], | ||||||
|  |                 ] | ||||||
|             ) |             ) | ||||||
|         return content |         return content | ||||||
|  |  | ||||||
|  | |||||||
| @ -23,9 +23,11 @@ class Command(BaseCommand): | |||||||
|                 for blueprint_path in options.get("blueprints", []): |                 for blueprint_path in options.get("blueprints", []): | ||||||
|                     content = BlueprintInstance(path=blueprint_path).retrieve() |                     content = BlueprintInstance(path=blueprint_path).retrieve() | ||||||
|                     importer = Importer.from_string(content) |                     importer = Importer.from_string(content) | ||||||
|                     valid, _ = importer.validate() |                     valid, logs = importer.validate() | ||||||
|                     if not valid: |                     if not valid: | ||||||
|                         self.stderr.write("blueprint invalid") |                         self.stderr.write("Blueprint invalid") | ||||||
|  |                         for log in logs: | ||||||
|  |                             self.stderr.write(f"\t{log.logger}: {log.event}: {log.attributes}") | ||||||
|                         sys_exit(1) |                         sys_exit(1) | ||||||
|                     importer.apply() |                     importer.apply() | ||||||
|  |  | ||||||
|  | |||||||
| @ -113,16 +113,19 @@ class Command(BaseCommand): | |||||||
|             ) |             ) | ||||||
|             model_path = f"{model._meta.app_label}.{model._meta.model_name}" |             model_path = f"{model._meta.app_label}.{model._meta.model_name}" | ||||||
|             self.schema["properties"]["entries"]["items"]["oneOf"].append( |             self.schema["properties"]["entries"]["items"]["oneOf"].append( | ||||||
|                 self.template_entry(model_path, serializer) |                 self.template_entry(model_path, model, serializer) | ||||||
|             ) |             ) | ||||||
|  |  | ||||||
|     def template_entry(self, model_path: str, serializer: Serializer) -> dict: |     def template_entry(self, model_path: str, model: type[Model], serializer: Serializer) -> dict: | ||||||
|         """Template entry for a single model""" |         """Template entry for a single model""" | ||||||
|         model_schema = self.to_jsonschema(serializer) |         model_schema = self.to_jsonschema(serializer) | ||||||
|         model_schema["required"] = [] |         model_schema["required"] = [] | ||||||
|         def_name = f"model_{model_path}" |         def_name = f"model_{model_path}" | ||||||
|         def_path = f"#/$defs/{def_name}" |         def_path = f"#/$defs/{def_name}" | ||||||
|         self.schema["$defs"][def_name] = model_schema |         self.schema["$defs"][def_name] = model_schema | ||||||
|  |         def_name_perm = f"model_{model_path}_permissions" | ||||||
|  |         def_path_perm = f"#/$defs/{def_name_perm}" | ||||||
|  |         self.schema["$defs"][def_name_perm] = self.model_permissions(model) | ||||||
|         return { |         return { | ||||||
|             "type": "object", |             "type": "object", | ||||||
|             "required": ["model", "identifiers"], |             "required": ["model", "identifiers"], | ||||||
| @ -135,6 +138,7 @@ class Command(BaseCommand): | |||||||
|                     "default": "present", |                     "default": "present", | ||||||
|                 }, |                 }, | ||||||
|                 "conditions": {"type": "array", "items": {"type": "boolean"}}, |                 "conditions": {"type": "array", "items": {"type": "boolean"}}, | ||||||
|  |                 "permissions": {"$ref": def_path_perm}, | ||||||
|                 "attrs": {"$ref": def_path}, |                 "attrs": {"$ref": def_path}, | ||||||
|                 "identifiers": {"$ref": def_path}, |                 "identifiers": {"$ref": def_path}, | ||||||
|             }, |             }, | ||||||
| @ -185,3 +189,20 @@ class Command(BaseCommand): | |||||||
|         if required: |         if required: | ||||||
|             result["required"] = required |             result["required"] = required | ||||||
|         return result |         return result | ||||||
|  |  | ||||||
|  |     def model_permissions(self, model: type[Model]) -> dict: | ||||||
|  |         perms = [x[0] for x in model._meta.permissions] | ||||||
|  |         for action in model._meta.default_permissions: | ||||||
|  |             perms.append(f"{action}_{model._meta.model_name}") | ||||||
|  |         return { | ||||||
|  |             "type": "array", | ||||||
|  |             "items": { | ||||||
|  |                 "type": "object", | ||||||
|  |                 "required": ["permission"], | ||||||
|  |                 "properties": { | ||||||
|  |                     "permission": {"type": "string", "enum": perms}, | ||||||
|  |                     "user": {"type": "integer"}, | ||||||
|  |                     "role": {"type": "string"}, | ||||||
|  |                 }, | ||||||
|  |             }, | ||||||
|  |         } | ||||||
|  | |||||||
| @ -29,9 +29,7 @@ def check_blueprint_v1_file(BlueprintInstance: type, db_alias, path: Path): | |||||||
|         if version != 1: |         if version != 1: | ||||||
|             return |             return | ||||||
|         blueprint_file.seek(0) |         blueprint_file.seek(0) | ||||||
|     instance: BlueprintInstance = ( |     instance = BlueprintInstance.objects.using(db_alias).filter(path=path).first() | ||||||
|         BlueprintInstance.objects.using(db_alias).filter(path=path).first() |  | ||||||
|     ) |  | ||||||
|     rel_path = path.relative_to(Path(CONFIG.get("blueprints_dir"))) |     rel_path = path.relative_to(Path(CONFIG.get("blueprints_dir"))) | ||||||
|     meta = None |     meta = None | ||||||
|     if metadata: |     if metadata: | ||||||
|  | |||||||
							
								
								
									
										24
									
								
								authentik/blueprints/tests/fixtures/rbac_object.yaml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								authentik/blueprints/tests/fixtures/rbac_object.yaml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,24 @@ | |||||||
|  | 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 | ||||||
							
								
								
									
										8
									
								
								authentik/blueprints/tests/fixtures/rbac_role.yaml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								authentik/blueprints/tests/fixtures/rbac_role.yaml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,8 @@ | |||||||
|  | version: 1 | ||||||
|  | entries: | ||||||
|  |   - model: authentik_rbac.role | ||||||
|  |     identifiers: | ||||||
|  |       name: "%(id)s" | ||||||
|  |     attrs: | ||||||
|  |       permissions: | ||||||
|  |         - authentik_blueprints.view_blueprintinstance | ||||||
							
								
								
									
										9
									
								
								authentik/blueprints/tests/fixtures/rbac_user.yaml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								authentik/blueprints/tests/fixtures/rbac_user.yaml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,9 @@ | |||||||
|  | version: 1 | ||||||
|  | entries: | ||||||
|  |   - model: authentik_core.user | ||||||
|  |     identifiers: | ||||||
|  |       username: "%(id)s" | ||||||
|  |     attrs: | ||||||
|  |       name: "%(id)s" | ||||||
|  |       permissions: | ||||||
|  |         - authentik_blueprints.view_blueprintinstance | ||||||
| @ -78,5 +78,5 @@ class TestBlueprintsV1API(APITestCase): | |||||||
|         self.assertEqual(res.status_code, 400) |         self.assertEqual(res.status_code, 400) | ||||||
|         self.assertJSONEqual( |         self.assertJSONEqual( | ||||||
|             res.content.decode(), |             res.content.decode(), | ||||||
|             {"content": ["Failed to validate blueprint: Invalid blueprint version"]}, |             {"content": ["Failed to validate blueprint", "- Invalid blueprint version"]}, | ||||||
|         ) |         ) | ||||||
|  | |||||||
							
								
								
									
										57
									
								
								authentik/blueprints/tests/test_v1_rbac.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										57
									
								
								authentik/blueprints/tests/test_v1_rbac.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,57 @@ | |||||||
|  | """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"]) | ||||||
| @ -1,7 +1,7 @@ | |||||||
| """transfer common classes""" | """transfer common classes""" | ||||||
|  |  | ||||||
| from collections import OrderedDict | from collections import OrderedDict | ||||||
| from collections.abc import Iterable, Mapping | from collections.abc import Generator, Iterable, Mapping | ||||||
| from copy import copy | from copy import copy | ||||||
| from dataclasses import asdict, dataclass, field, is_dataclass | from dataclasses import asdict, dataclass, field, is_dataclass | ||||||
| from enum import Enum | from enum import Enum | ||||||
| @ -58,6 +58,15 @@ class BlueprintEntryDesiredState(Enum): | |||||||
|     MUST_CREATED = "must_created" |     MUST_CREATED = "must_created" | ||||||
|  |  | ||||||
|  |  | ||||||
|  | @dataclass | ||||||
|  | class BlueprintEntryPermission: | ||||||
|  |     """Describe object-level permissions""" | ||||||
|  |  | ||||||
|  |     permission: Union[str, "YAMLTag"] | ||||||
|  |     user: Union[int, "YAMLTag", None] = field(default=None) | ||||||
|  |     role: Union[str, "YAMLTag", None] = field(default=None) | ||||||
|  |  | ||||||
|  |  | ||||||
| @dataclass | @dataclass | ||||||
| class BlueprintEntry: | class BlueprintEntry: | ||||||
|     """Single entry of a blueprint""" |     """Single entry of a blueprint""" | ||||||
| @ -69,6 +78,7 @@ class BlueprintEntry: | |||||||
|     conditions: list[Any] = field(default_factory=list) |     conditions: list[Any] = field(default_factory=list) | ||||||
|     identifiers: dict[str, Any] = field(default_factory=dict) |     identifiers: dict[str, Any] = field(default_factory=dict) | ||||||
|     attrs: dict[str, Any] | None = field(default_factory=dict) |     attrs: dict[str, Any] | None = field(default_factory=dict) | ||||||
|  |     permissions: list[BlueprintEntryPermission] = field(default_factory=list) | ||||||
|  |  | ||||||
|     id: str | None = None |     id: str | None = None | ||||||
|  |  | ||||||
| @ -150,6 +160,17 @@ class BlueprintEntry: | |||||||
|         """Get the blueprint model, with yaml tags resolved if present""" |         """Get the blueprint model, with yaml tags resolved if present""" | ||||||
|         return str(self.tag_resolver(self.model, blueprint)) |         return str(self.tag_resolver(self.model, blueprint)) | ||||||
|  |  | ||||||
|  |     def get_permissions( | ||||||
|  |         self, blueprint: "Blueprint" | ||||||
|  |     ) -> Generator[BlueprintEntryPermission, None, None]: | ||||||
|  |         """Get permissions of this entry, with all yaml tags resolved""" | ||||||
|  |         for perm in self.permissions: | ||||||
|  |             yield BlueprintEntryPermission( | ||||||
|  |                 permission=self.tag_resolver(perm.permission, blueprint), | ||||||
|  |                 user=self.tag_resolver(perm.user, blueprint), | ||||||
|  |                 role=self.tag_resolver(perm.role, blueprint), | ||||||
|  |             ) | ||||||
|  |  | ||||||
|     def check_all_conditions_match(self, blueprint: "Blueprint") -> bool: |     def check_all_conditions_match(self, blueprint: "Blueprint") -> bool: | ||||||
|         """Check all conditions of this entry match (evaluate to True)""" |         """Check all conditions of this entry match (evaluate to True)""" | ||||||
|         return all(self.tag_resolver(self.conditions, blueprint)) |         return all(self.tag_resolver(self.conditions, blueprint)) | ||||||
| @ -307,7 +328,10 @@ class Find(YAMLTag): | |||||||
|         else: |         else: | ||||||
|             model_name = self.model_name |             model_name = self.model_name | ||||||
|  |  | ||||||
|         model_class = apps.get_model(*model_name.split(".")) |         try: | ||||||
|  |             model_class = apps.get_model(*model_name.split(".")) | ||||||
|  |         except LookupError as exc: | ||||||
|  |             raise EntryInvalidError.from_entry(exc, entry) from exc | ||||||
|  |  | ||||||
|         query = Q() |         query = Q() | ||||||
|         for cond in self.conditions: |         for cond in self.conditions: | ||||||
|  | |||||||
| @ -16,6 +16,7 @@ from django.db.models.query_utils import Q | |||||||
| from django.db.transaction import atomic | from django.db.transaction import atomic | ||||||
| from django.db.utils import IntegrityError | from django.db.utils import IntegrityError | ||||||
| from guardian.models import UserObjectPermission | from guardian.models import UserObjectPermission | ||||||
|  | from guardian.shortcuts import assign_perm | ||||||
| from rest_framework.exceptions import ValidationError | from rest_framework.exceptions import ValidationError | ||||||
| from rest_framework.serializers import BaseSerializer, Serializer | from rest_framework.serializers import BaseSerializer, Serializer | ||||||
| from structlog.stdlib import BoundLogger, get_logger | from structlog.stdlib import BoundLogger, get_logger | ||||||
| @ -32,9 +33,11 @@ from authentik.blueprints.v1.common import ( | |||||||
| from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry | from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry | ||||||
| from authentik.core.models import ( | from authentik.core.models import ( | ||||||
|     AuthenticatedSession, |     AuthenticatedSession, | ||||||
|  |     GroupSourceConnection, | ||||||
|     PropertyMapping, |     PropertyMapping, | ||||||
|     Provider, |     Provider, | ||||||
|     Source, |     Source, | ||||||
|  |     User, | ||||||
|     UserSourceConnection, |     UserSourceConnection, | ||||||
| ) | ) | ||||||
| from authentik.enterprise.license import LicenseKey | from authentik.enterprise.license import LicenseKey | ||||||
| @ -48,23 +51,29 @@ from authentik.enterprise.providers.microsoft_entra.models import ( | |||||||
|     MicrosoftEntraProviderUser, |     MicrosoftEntraProviderUser, | ||||||
| ) | ) | ||||||
| from authentik.enterprise.providers.rac.models import ConnectionToken | from authentik.enterprise.providers.rac.models import ConnectionToken | ||||||
|  | from authentik.enterprise.stages.authenticator_endpoint_gdtc.models import ( | ||||||
|  |     EndpointDevice, | ||||||
|  |     EndpointDeviceConnection, | ||||||
|  | ) | ||||||
| from authentik.events.logs import LogEvent, capture_logs | from authentik.events.logs import LogEvent, capture_logs | ||||||
| from authentik.events.models import SystemTask | from authentik.events.models import SystemTask | ||||||
| from authentik.events.utils import cleanse_dict | from authentik.events.utils import cleanse_dict | ||||||
| from authentik.flows.models import FlowToken, Stage | from authentik.flows.models import FlowToken, Stage | ||||||
| from authentik.lib.models import SerializerModel | from authentik.lib.models import SerializerModel | ||||||
| from authentik.lib.sentry import SentryIgnoredException | from authentik.lib.sentry import SentryIgnoredException | ||||||
|  | from authentik.lib.utils.reflection import get_apps | ||||||
| from authentik.outposts.models import OutpostServiceConnection | from authentik.outposts.models import OutpostServiceConnection | ||||||
| from authentik.policies.models import Policy, PolicyBindingModel | from authentik.policies.models import Policy, PolicyBindingModel | ||||||
| from authentik.policies.reputation.models import Reputation | from authentik.policies.reputation.models import Reputation | ||||||
| from authentik.providers.oauth2.models import AccessToken, AuthorizationCode, RefreshToken | from authentik.providers.oauth2.models import AccessToken, AuthorizationCode, RefreshToken | ||||||
| from authentik.providers.scim.models import SCIMProviderGroup, SCIMProviderUser | from authentik.providers.scim.models import SCIMProviderGroup, SCIMProviderUser | ||||||
|  | from authentik.rbac.models import Role | ||||||
| from authentik.sources.scim.models import SCIMSourceGroup, SCIMSourceUser | from authentik.sources.scim.models import SCIMSourceGroup, SCIMSourceUser | ||||||
| from authentik.stages.authenticator_webauthn.models import WebAuthnDeviceType | from authentik.stages.authenticator_webauthn.models import WebAuthnDeviceType | ||||||
| from authentik.tenants.models import Tenant | from authentik.tenants.models import Tenant | ||||||
|  |  | ||||||
| # Context set when the serializer is created in a blueprint context | # Context set when the serializer is created in a blueprint context | ||||||
| # Update website/developer-docs/blueprints/v1/models.md when used | # Update website/docs/customize/blueprints/v1/models.md when used | ||||||
| SERIALIZER_CONTEXT_BLUEPRINT = "blueprint_entry" | SERIALIZER_CONTEXT_BLUEPRINT = "blueprint_entry" | ||||||
|  |  | ||||||
|  |  | ||||||
| @ -87,6 +96,7 @@ def excluded_models() -> list[type[Model]]: | |||||||
|         Source, |         Source, | ||||||
|         PropertyMapping, |         PropertyMapping, | ||||||
|         UserSourceConnection, |         UserSourceConnection, | ||||||
|  |         GroupSourceConnection, | ||||||
|         Stage, |         Stage, | ||||||
|         OutpostServiceConnection, |         OutpostServiceConnection, | ||||||
|         Policy, |         Policy, | ||||||
| @ -113,6 +123,8 @@ def excluded_models() -> list[type[Model]]: | |||||||
|         GoogleWorkspaceProviderGroup, |         GoogleWorkspaceProviderGroup, | ||||||
|         MicrosoftEntraProviderUser, |         MicrosoftEntraProviderUser, | ||||||
|         MicrosoftEntraProviderGroup, |         MicrosoftEntraProviderGroup, | ||||||
|  |         EndpointDevice, | ||||||
|  |         EndpointDeviceConnection, | ||||||
|     ) |     ) | ||||||
|  |  | ||||||
|  |  | ||||||
| @ -136,6 +148,16 @@ def transaction_rollback(): | |||||||
|         pass |         pass | ||||||
|  |  | ||||||
|  |  | ||||||
|  | def rbac_models() -> dict: | ||||||
|  |     models = {} | ||||||
|  |     for app in get_apps(): | ||||||
|  |         for model in app.get_models(): | ||||||
|  |             if not is_model_allowed(model): | ||||||
|  |                 continue | ||||||
|  |             models[model._meta.model_name] = app.label | ||||||
|  |     return models | ||||||
|  |  | ||||||
|  |  | ||||||
| class Importer: | class Importer: | ||||||
|     """Import Blueprint from raw dict or YAML/JSON""" |     """Import Blueprint from raw dict or YAML/JSON""" | ||||||
|  |  | ||||||
| @ -154,7 +176,10 @@ class Importer: | |||||||
|  |  | ||||||
|     def default_context(self): |     def default_context(self): | ||||||
|         """Default context""" |         """Default context""" | ||||||
|         return {"goauthentik.io/enterprise/licensed": LicenseKey.get_total().is_valid()} |         return { | ||||||
|  |             "goauthentik.io/enterprise/licensed": LicenseKey.get_total().status().is_valid, | ||||||
|  |             "goauthentik.io/rbac/models": rbac_models(), | ||||||
|  |         } | ||||||
|  |  | ||||||
|     @staticmethod |     @staticmethod | ||||||
|     def from_string(yaml_input: str, context: dict | None = None) -> "Importer": |     def from_string(yaml_input: str, context: dict | None = None) -> "Importer": | ||||||
| @ -214,14 +239,17 @@ class Importer: | |||||||
|  |  | ||||||
|         return main_query | sub_query |         return main_query | sub_query | ||||||
|  |  | ||||||
|     def _validate_single(self, entry: BlueprintEntry) -> BaseSerializer | None: |     def _validate_single(self, entry: BlueprintEntry) -> BaseSerializer | None:  # noqa: PLR0915 | ||||||
|         """Validate a single entry""" |         """Validate a single entry""" | ||||||
|         if not entry.check_all_conditions_match(self._import): |         if not entry.check_all_conditions_match(self._import): | ||||||
|             self.logger.debug("One or more conditions of this entry are not fulfilled, skipping") |             self.logger.debug("One or more conditions of this entry are not fulfilled, skipping") | ||||||
|             return None |             return None | ||||||
|  |  | ||||||
|         model_app_label, model_name = entry.get_model(self._import).split(".") |         model_app_label, model_name = entry.get_model(self._import).split(".") | ||||||
|         model: type[SerializerModel] = registry.get_model(model_app_label, model_name) |         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 |         # Don't use isinstance since we don't want to check for inheritance | ||||||
|         if not is_model_allowed(model): |         if not is_model_allowed(model): | ||||||
|             raise EntryInvalidError.from_entry(f"Model {model} not allowed", entry) |             raise EntryInvalidError.from_entry(f"Model {model} not allowed", entry) | ||||||
| @ -296,10 +324,7 @@ class Importer: | |||||||
|         try: |         try: | ||||||
|             full_data = self.__update_pks_for_attrs(entry.get_attrs(self._import)) |             full_data = self.__update_pks_for_attrs(entry.get_attrs(self._import)) | ||||||
|         except ValueError as exc: |         except ValueError as exc: | ||||||
|             raise EntryInvalidError.from_entry( |             raise EntryInvalidError.from_entry(exc, entry) from exc | ||||||
|                 exc, |  | ||||||
|                 entry, |  | ||||||
|             ) from exc |  | ||||||
|         always_merger.merge(full_data, updated_identifiers) |         always_merger.merge(full_data, updated_identifiers) | ||||||
|         serializer_kwargs["data"] = full_data |         serializer_kwargs["data"] = full_data | ||||||
|  |  | ||||||
| @ -320,6 +345,15 @@ class Importer: | |||||||
|             ) from exc |             ) from exc | ||||||
|         return serializer |         return serializer | ||||||
|  |  | ||||||
|  |     def _apply_permissions(self, instance: Model, entry: BlueprintEntry): | ||||||
|  |         """Apply object-level permissions for an entry""" | ||||||
|  |         for perm in entry.get_permissions(self._import): | ||||||
|  |             if perm.user is not None: | ||||||
|  |                 assign_perm(perm.permission, User.objects.get(pk=perm.user), instance) | ||||||
|  |             if perm.role is not None: | ||||||
|  |                 role = Role.objects.get(pk=perm.role) | ||||||
|  |                 role.assign_permission(perm.permission, obj=instance) | ||||||
|  |  | ||||||
|     def apply(self) -> bool: |     def apply(self) -> bool: | ||||||
|         """Apply (create/update) models yaml, in database transaction""" |         """Apply (create/update) models yaml, in database transaction""" | ||||||
|         try: |         try: | ||||||
| @ -384,6 +418,7 @@ class Importer: | |||||||
|                 if "pk" in entry.identifiers: |                 if "pk" in entry.identifiers: | ||||||
|                     self.__pk_map[entry.identifiers["pk"]] = instance.pk |                     self.__pk_map[entry.identifiers["pk"]] = instance.pk | ||||||
|                 entry._state = BlueprintEntryState(instance) |                 entry._state = BlueprintEntryState(instance) | ||||||
|  |                 self._apply_permissions(instance, entry) | ||||||
|             elif state == BlueprintEntryDesiredState.ABSENT: |             elif state == BlueprintEntryDesiredState.ABSENT: | ||||||
|                 instance: Model | None = serializer.instance |                 instance: Model | None = serializer.instance | ||||||
|                 if instance.pk: |                 if instance.pk: | ||||||
| @ -400,7 +435,7 @@ class Importer: | |||||||
|         orig_import = deepcopy(self._import) |         orig_import = deepcopy(self._import) | ||||||
|         if self._import.version != 1: |         if self._import.version != 1: | ||||||
|             self.logger.warning("Invalid blueprint version") |             self.logger.warning("Invalid blueprint version") | ||||||
|             return False, [{"event": "Invalid blueprint version"}] |             return False, [LogEvent("Invalid blueprint version", log_level="warning", logger=None)] | ||||||
|         with ( |         with ( | ||||||
|             transaction_rollback(), |             transaction_rollback(), | ||||||
|             capture_logs() as logs, |             capture_logs() as logs, | ||||||
|  | |||||||
| @ -55,6 +55,7 @@ class BrandSerializer(ModelSerializer): | |||||||
|             "flow_unenrollment", |             "flow_unenrollment", | ||||||
|             "flow_user_settings", |             "flow_user_settings", | ||||||
|             "flow_device_code", |             "flow_device_code", | ||||||
|  |             "default_application", | ||||||
|             "web_certificate", |             "web_certificate", | ||||||
|             "attributes", |             "attributes", | ||||||
|         ] |         ] | ||||||
|  | |||||||
| @ -9,3 +9,6 @@ class AuthentikBrandsConfig(AppConfig): | |||||||
|     name = "authentik.brands" |     name = "authentik.brands" | ||||||
|     label = "authentik_brands" |     label = "authentik_brands" | ||||||
|     verbose_name = "authentik Brands" |     verbose_name = "authentik Brands" | ||||||
|  |     mountpoints = { | ||||||
|  |         "authentik.brands.urls_root": "", | ||||||
|  |     } | ||||||
|  | |||||||
| @ -0,0 +1,26 @@ | |||||||
|  | # 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,6 +3,7 @@ | |||||||
| from uuid import uuid4 | from uuid import uuid4 | ||||||
|  |  | ||||||
| from django.db import models | from django.db import models | ||||||
|  | from django.http import HttpRequest | ||||||
| from django.utils.translation import gettext_lazy as _ | from django.utils.translation import gettext_lazy as _ | ||||||
| from rest_framework.serializers import Serializer | from rest_framework.serializers import Serializer | ||||||
| from structlog.stdlib import get_logger | from structlog.stdlib import get_logger | ||||||
| @ -51,6 +52,16 @@ class Brand(SerializerModel): | |||||||
|         Flow, null=True, on_delete=models.SET_NULL, related_name="brand_device_code" |         Flow, null=True, on_delete=models.SET_NULL, related_name="brand_device_code" | ||||||
|     ) |     ) | ||||||
|  |  | ||||||
|  |     default_application = models.ForeignKey( | ||||||
|  |         "authentik_core.Application", | ||||||
|  |         null=True, | ||||||
|  |         default=None, | ||||||
|  |         on_delete=models.SET_DEFAULT, | ||||||
|  |         help_text=_( | ||||||
|  |             "When set, external users will be redirected to this application after authenticating." | ||||||
|  |         ), | ||||||
|  |     ) | ||||||
|  |  | ||||||
|     web_certificate = models.ForeignKey( |     web_certificate = models.ForeignKey( | ||||||
|         CertificateKeyPair, |         CertificateKeyPair, | ||||||
|         null=True, |         null=True, | ||||||
| @ -88,3 +99,13 @@ class Brand(SerializerModel): | |||||||
|             models.Index(fields=["domain"]), |             models.Index(fields=["domain"]), | ||||||
|             models.Index(fields=["default"]), |             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,7 +5,11 @@ from rest_framework.test import APITestCase | |||||||
|  |  | ||||||
| from authentik.brands.api import Themes | from authentik.brands.api import Themes | ||||||
| from authentik.brands.models import Brand | from authentik.brands.models import Brand | ||||||
|  | from authentik.core.models import Application | ||||||
| from authentik.core.tests.utils import create_test_admin_user, create_test_brand | from authentik.core.tests.utils import create_test_admin_user, create_test_brand | ||||||
|  | from authentik.lib.generators import generate_id | ||||||
|  | from authentik.providers.oauth2.models import OAuth2Provider | ||||||
|  | from authentik.providers.saml.models import SAMLProvider | ||||||
|  |  | ||||||
|  |  | ||||||
| class TestBrands(APITestCase): | class TestBrands(APITestCase): | ||||||
| @ -75,3 +79,45 @@ class TestBrands(APITestCase): | |||||||
|             reverse("authentik_api:brand-list"), data={"domain": "bar", "default": True} |             reverse("authentik_api:brand-list"), data={"domain": "bar", "default": True} | ||||||
|         ) |         ) | ||||||
|         self.assertEqual(response.status_code, 400) |         self.assertEqual(response.status_code, 400) | ||||||
|  |  | ||||||
|  |     def test_webfinger_no_app(self): | ||||||
|  |         """Test Webfinger""" | ||||||
|  |         create_test_brand() | ||||||
|  |         self.assertJSONEqual( | ||||||
|  |             self.client.get(reverse("authentik_brands:webfinger")).content.decode(), {} | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |     def test_webfinger_not_supported(self): | ||||||
|  |         """Test Webfinger""" | ||||||
|  |         brand = create_test_brand() | ||||||
|  |         provider = SAMLProvider.objects.create( | ||||||
|  |             name=generate_id(), | ||||||
|  |         ) | ||||||
|  |         app = Application.objects.create(name=generate_id(), slug=generate_id(), provider=provider) | ||||||
|  |         brand.default_application = app | ||||||
|  |         brand.save() | ||||||
|  |         self.assertJSONEqual( | ||||||
|  |             self.client.get(reverse("authentik_brands:webfinger")).content.decode(), {} | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |     def test_webfinger_oidc(self): | ||||||
|  |         """Test Webfinger""" | ||||||
|  |         brand = create_test_brand() | ||||||
|  |         provider = OAuth2Provider.objects.create( | ||||||
|  |             name=generate_id(), | ||||||
|  |         ) | ||||||
|  |         app = Application.objects.create(name=generate_id(), slug=generate_id(), provider=provider) | ||||||
|  |         brand.default_application = app | ||||||
|  |         brand.save() | ||||||
|  |         self.assertJSONEqual( | ||||||
|  |             self.client.get(reverse("authentik_brands:webfinger")).content.decode(), | ||||||
|  |             { | ||||||
|  |                 "links": [ | ||||||
|  |                     { | ||||||
|  |                         "href": f"http://testserver/application/o/{app.slug}/", | ||||||
|  |                         "rel": "http://openid.net/specs/connect/1.0/issuer", | ||||||
|  |                     } | ||||||
|  |                 ], | ||||||
|  |                 "subject": None, | ||||||
|  |             }, | ||||||
|  |         ) | ||||||
|  | |||||||
							
								
								
									
										9
									
								
								authentik/brands/urls_root.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								authentik/brands/urls_root.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,9 @@ | |||||||
|  | """authentik brand root URLs""" | ||||||
|  |  | ||||||
|  | from django.urls import path | ||||||
|  |  | ||||||
|  | from authentik.brands.views.webfinger import WebFingerView | ||||||
|  |  | ||||||
|  | urlpatterns = [ | ||||||
|  |     path(".well-known/webfinger", WebFingerView.as_view(), name="webfinger"), | ||||||
|  | ] | ||||||
| @ -5,7 +5,7 @@ from typing import Any | |||||||
| from django.db.models import F, Q | from django.db.models import F, Q | ||||||
| from django.db.models import Value as V | from django.db.models import Value as V | ||||||
| from django.http.request import HttpRequest | from django.http.request import HttpRequest | ||||||
| from sentry_sdk.hub import Hub | from sentry_sdk import get_current_span | ||||||
|  |  | ||||||
| from authentik import get_full_version | from authentik import get_full_version | ||||||
| from authentik.brands.models import Brand | from authentik.brands.models import Brand | ||||||
| @ -33,7 +33,7 @@ def context_processor(request: HttpRequest) -> dict[str, Any]: | |||||||
|     brand = getattr(request, "brand", DEFAULT_BRAND) |     brand = getattr(request, "brand", DEFAULT_BRAND) | ||||||
|     tenant = getattr(request, "tenant", Tenant()) |     tenant = getattr(request, "tenant", Tenant()) | ||||||
|     trace = "" |     trace = "" | ||||||
|     span = Hub.current.scope.span |     span = get_current_span() | ||||||
|     if span: |     if span: | ||||||
|         trace = span.to_traceparent() |         trace = span.to_traceparent() | ||||||
|     return { |     return { | ||||||
|  | |||||||
							
								
								
									
										0
									
								
								authentik/brands/views/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								authentik/brands/views/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
								
								
									
										29
									
								
								authentik/brands/views/webfinger.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								authentik/brands/views/webfinger.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,29 @@ | |||||||
|  | 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 | ||||||
| @ -103,7 +103,12 @@ class ApplicationSerializer(ModelSerializer): | |||||||
| class ApplicationViewSet(UsedByMixin, ModelViewSet): | class ApplicationViewSet(UsedByMixin, ModelViewSet): | ||||||
|     """Application Viewset""" |     """Application Viewset""" | ||||||
|  |  | ||||||
|     queryset = Application.objects.all().prefetch_related("provider").prefetch_related("policies") |     queryset = ( | ||||||
|  |         Application.objects.all() | ||||||
|  |         .with_provider() | ||||||
|  |         .prefetch_related("policies") | ||||||
|  |         .prefetch_related("backchannel_providers") | ||||||
|  |     ) | ||||||
|     serializer_class = ApplicationSerializer |     serializer_class = ApplicationSerializer | ||||||
|     search_fields = [ |     search_fields = [ | ||||||
|         "name", |         "name", | ||||||
| @ -147,6 +152,15 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet): | |||||||
|                 applications.append(application) |                 applications.append(application) | ||||||
|         return applications |         return applications | ||||||
|  |  | ||||||
|  |     def _filter_applications_with_launch_url( | ||||||
|  |         self, pagined_apps: Iterator[Application] | ||||||
|  |     ) -> list[Application]: | ||||||
|  |         applications = [] | ||||||
|  |         for app in pagined_apps: | ||||||
|  |             if app.get_launch_url(): | ||||||
|  |                 applications.append(app) | ||||||
|  |         return applications | ||||||
|  |  | ||||||
|     @extend_schema( |     @extend_schema( | ||||||
|         parameters=[ |         parameters=[ | ||||||
|             OpenApiParameter( |             OpenApiParameter( | ||||||
| @ -204,6 +218,11 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet): | |||||||
|                 location=OpenApiParameter.QUERY, |                 location=OpenApiParameter.QUERY, | ||||||
|                 type=OpenApiTypes.INT, |                 type=OpenApiTypes.INT, | ||||||
|             ), |             ), | ||||||
|  |             OpenApiParameter( | ||||||
|  |                 name="only_with_launch_url", | ||||||
|  |                 location=OpenApiParameter.QUERY, | ||||||
|  |                 type=OpenApiTypes.BOOL, | ||||||
|  |             ), | ||||||
|         ] |         ] | ||||||
|     ) |     ) | ||||||
|     def list(self, request: Request) -> Response: |     def list(self, request: Request) -> Response: | ||||||
| @ -216,6 +235,10 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet): | |||||||
|         if superuser_full_list and request.user.is_superuser: |         if superuser_full_list and request.user.is_superuser: | ||||||
|             return super().list(request) |             return super().list(request) | ||||||
|  |  | ||||||
|  |         only_with_launch_url = str( | ||||||
|  |             request.query_params.get("only_with_launch_url", "false") | ||||||
|  |         ).lower() | ||||||
|  |  | ||||||
|         queryset = self._filter_queryset_for_list(self.get_queryset()) |         queryset = self._filter_queryset_for_list(self.get_queryset()) | ||||||
|         paginator: Pagination = self.paginator |         paginator: Pagination = self.paginator | ||||||
|         paginated_apps = paginator.paginate_queryset(queryset, request) |         paginated_apps = paginator.paginate_queryset(queryset, request) | ||||||
| @ -251,6 +274,10 @@ class ApplicationViewSet(UsedByMixin, ModelViewSet): | |||||||
|                     allowed_applications, |                     allowed_applications, | ||||||
|                     timeout=86400, |                     timeout=86400, | ||||||
|                 ) |                 ) | ||||||
|  |  | ||||||
|  |         if only_with_launch_url == "true": | ||||||
|  |             allowed_applications = self._filter_applications_with_launch_url(allowed_applications) | ||||||
|  |  | ||||||
|         serializer = self.get_serializer(allowed_applications, many=True) |         serializer = self.get_serializer(allowed_applications, many=True) | ||||||
|         return self.get_paginated_response(serializer.data) |         return self.get_paginated_response(serializer.data) | ||||||
|  |  | ||||||
|  | |||||||
| @ -2,29 +2,49 @@ | |||||||
|  |  | ||||||
| from drf_spectacular.types import OpenApiTypes | from drf_spectacular.types import OpenApiTypes | ||||||
| from drf_spectacular.utils import OpenApiParameter, extend_schema | from drf_spectacular.utils import OpenApiParameter, extend_schema | ||||||
| from rest_framework.fields import BooleanField, CharField, IntegerField, SerializerMethodField | from rest_framework.fields import ( | ||||||
| from rest_framework.permissions import IsAdminUser, IsAuthenticated |     BooleanField, | ||||||
|  |     CharField, | ||||||
|  |     DateTimeField, | ||||||
|  |     SerializerMethodField, | ||||||
|  | ) | ||||||
|  | from rest_framework.permissions import IsAuthenticated | ||||||
| from rest_framework.request import Request | from rest_framework.request import Request | ||||||
| from rest_framework.response import Response | from rest_framework.response import Response | ||||||
| from rest_framework.viewsets import ViewSet | from rest_framework.viewsets import ViewSet | ||||||
|  |  | ||||||
| from authentik.core.api.utils import MetaNameSerializer | from authentik.core.api.utils import MetaNameSerializer | ||||||
|  | from authentik.enterprise.stages.authenticator_endpoint_gdtc.models import EndpointDevice | ||||||
|  | from authentik.rbac.decorators import permission_required | ||||||
| from authentik.stages.authenticator import device_classes, devices_for_user | from authentik.stages.authenticator import device_classes, devices_for_user | ||||||
| from authentik.stages.authenticator.models import Device | from authentik.stages.authenticator.models import Device | ||||||
|  | from authentik.stages.authenticator_webauthn.models import WebAuthnDevice | ||||||
|  |  | ||||||
|  |  | ||||||
| class DeviceSerializer(MetaNameSerializer): | class DeviceSerializer(MetaNameSerializer): | ||||||
|     """Serializer for Duo authenticator devices""" |     """Serializer for Duo authenticator devices""" | ||||||
|  |  | ||||||
|     pk = IntegerField() |     pk = CharField() | ||||||
|     name = CharField() |     name = CharField() | ||||||
|     type = SerializerMethodField() |     type = SerializerMethodField() | ||||||
|     confirmed = BooleanField() |     confirmed = BooleanField() | ||||||
|  |     created = DateTimeField(read_only=True) | ||||||
|  |     last_updated = DateTimeField(read_only=True) | ||||||
|  |     last_used = DateTimeField(read_only=True, allow_null=True) | ||||||
|  |     extra_description = SerializerMethodField() | ||||||
|  |  | ||||||
|     def get_type(self, instance: Device) -> str: |     def get_type(self, instance: Device) -> str: | ||||||
|         """Get type of device""" |         """Get type of device""" | ||||||
|         return instance._meta.label |         return instance._meta.label | ||||||
|  |  | ||||||
|  |     def get_extra_description(self, instance: Device) -> str: | ||||||
|  |         """Get extra description""" | ||||||
|  |         if isinstance(instance, WebAuthnDevice): | ||||||
|  |             return instance.device_type.description | ||||||
|  |         if isinstance(instance, EndpointDevice): | ||||||
|  |             return instance.data.get("deviceSignals", {}).get("deviceModel") | ||||||
|  |         return "" | ||||||
|  |  | ||||||
|  |  | ||||||
| class DeviceViewSet(ViewSet): | class DeviceViewSet(ViewSet): | ||||||
|     """Viewset for authenticator devices""" |     """Viewset for authenticator devices""" | ||||||
| @ -43,7 +63,7 @@ class AdminDeviceViewSet(ViewSet): | |||||||
|     """Viewset for authenticator devices""" |     """Viewset for authenticator devices""" | ||||||
|  |  | ||||||
|     serializer_class = DeviceSerializer |     serializer_class = DeviceSerializer | ||||||
|     permission_classes = [IsAdminUser] |     permission_classes = [] | ||||||
|  |  | ||||||
|     def get_devices(self, **kwargs): |     def get_devices(self, **kwargs): | ||||||
|         """Get all devices in all child classes""" |         """Get all devices in all child classes""" | ||||||
| @ -61,6 +81,10 @@ class AdminDeviceViewSet(ViewSet): | |||||||
|         ], |         ], | ||||||
|         responses={200: DeviceSerializer(many=True)}, |         responses={200: DeviceSerializer(many=True)}, | ||||||
|     ) |     ) | ||||||
|  |     @permission_required( | ||||||
|  |         None, | ||||||
|  |         [f"{model._meta.app_label}.view_{model._meta.model_name}" for model in device_classes()], | ||||||
|  |     ) | ||||||
|     def list(self, request: Request) -> Response: |     def list(self, request: Request) -> Response: | ||||||
|         """Get all devices for current user""" |         """Get all devices for current user""" | ||||||
|         kwargs = {} |         kwargs = {} | ||||||
|  | |||||||
| @ -2,8 +2,15 @@ | |||||||
|  |  | ||||||
| from json import dumps | from json import dumps | ||||||
|  |  | ||||||
|  | from django_filters.filters import AllValuesMultipleFilter, BooleanFilter | ||||||
|  | from django_filters.filterset import FilterSet | ||||||
| from drf_spectacular.types import OpenApiTypes | from drf_spectacular.types import OpenApiTypes | ||||||
| from drf_spectacular.utils import OpenApiParameter, OpenApiResponse, extend_schema | from drf_spectacular.utils import ( | ||||||
|  |     OpenApiParameter, | ||||||
|  |     OpenApiResponse, | ||||||
|  |     extend_schema, | ||||||
|  |     extend_schema_field, | ||||||
|  | ) | ||||||
| from guardian.shortcuts import get_objects_for_user | from guardian.shortcuts import get_objects_for_user | ||||||
| from rest_framework import mixins | from rest_framework import mixins | ||||||
| from rest_framework.decorators import action | from rest_framework.decorators import action | ||||||
| @ -23,8 +30,10 @@ from authentik.core.api.utils import ( | |||||||
|     PassiveSerializer, |     PassiveSerializer, | ||||||
| ) | ) | ||||||
| from authentik.core.expression.evaluator import PropertyMappingEvaluator | from authentik.core.expression.evaluator import PropertyMappingEvaluator | ||||||
|  | from authentik.core.expression.exceptions import PropertyMappingExpressionException | ||||||
| from authentik.core.models import Group, PropertyMapping, User | from authentik.core.models import Group, PropertyMapping, User | ||||||
| from authentik.events.utils import sanitize_item | from authentik.events.utils import sanitize_item | ||||||
|  | from authentik.lib.utils.errors import exception_to_string | ||||||
| from authentik.policies.api.exec import PolicyTestSerializer | from authentik.policies.api.exec import PolicyTestSerializer | ||||||
| from authentik.rbac.decorators import permission_required | from authentik.rbac.decorators import permission_required | ||||||
|  |  | ||||||
| @ -67,6 +76,18 @@ class PropertyMappingSerializer(ManagedSerializer, ModelSerializer, MetaNameSeri | |||||||
|         ] |         ] | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class PropertyMappingFilterSet(FilterSet): | ||||||
|  |     """Filter for PropertyMapping""" | ||||||
|  |  | ||||||
|  |     managed = extend_schema_field(OpenApiTypes.STR)(AllValuesMultipleFilter(field_name="managed")) | ||||||
|  |  | ||||||
|  |     managed__isnull = BooleanFilter(field_name="managed", lookup_expr="isnull") | ||||||
|  |  | ||||||
|  |     class Meta: | ||||||
|  |         model = PropertyMapping | ||||||
|  |         fields = ["name", "managed"] | ||||||
|  |  | ||||||
|  |  | ||||||
| class PropertyMappingViewSet( | class PropertyMappingViewSet( | ||||||
|     TypesMixin, |     TypesMixin, | ||||||
|     mixins.RetrieveModelMixin, |     mixins.RetrieveModelMixin, | ||||||
| @ -87,11 +108,9 @@ class PropertyMappingViewSet( | |||||||
|  |  | ||||||
|     queryset = PropertyMapping.objects.select_subclasses() |     queryset = PropertyMapping.objects.select_subclasses() | ||||||
|     serializer_class = PropertyMappingSerializer |     serializer_class = PropertyMappingSerializer | ||||||
|     search_fields = [ |     filterset_class = PropertyMappingFilterSet | ||||||
|         "name", |  | ||||||
|     ] |  | ||||||
|     filterset_fields = {"managed": ["isnull"]} |  | ||||||
|     ordering = ["name"] |     ordering = ["name"] | ||||||
|  |     search_fields = ["name"] | ||||||
|  |  | ||||||
|     @permission_required("authentik_core.view_propertymapping") |     @permission_required("authentik_core.view_propertymapping") | ||||||
|     @extend_schema( |     @extend_schema( | ||||||
| @ -145,12 +164,15 @@ class PropertyMappingViewSet( | |||||||
|  |  | ||||||
|         response_data = {"successful": True, "result": ""} |         response_data = {"successful": True, "result": ""} | ||||||
|         try: |         try: | ||||||
|             result = mapping.evaluate(**context) |             result = mapping.evaluate(dry_run=True, **context) | ||||||
|             response_data["result"] = dumps( |             response_data["result"] = dumps( | ||||||
|                 sanitize_item(result), indent=(4 if format_result else None) |                 sanitize_item(result), indent=(4 if format_result else None) | ||||||
|             ) |             ) | ||||||
|  |         except PropertyMappingExpressionException as exc: | ||||||
|  |             response_data["result"] = exception_to_string(exc.exc) | ||||||
|  |             response_data["successful"] = False | ||||||
|         except Exception as exc: |         except Exception as exc: | ||||||
|             response_data["result"] = str(exc) |             response_data["result"] = exception_to_string(exc) | ||||||
|             response_data["successful"] = False |             response_data["successful"] = False | ||||||
|         response = PropertyMappingTestResultSerializer(response_data) |         response = PropertyMappingTestResultSerializer(response_data) | ||||||
|         return Response(response.data) |         return Response(response.data) | ||||||
|  | |||||||
| @ -38,6 +38,7 @@ class ProviderSerializer(ModelSerializer, MetaNameSerializer): | |||||||
|             "name", |             "name", | ||||||
|             "authentication_flow", |             "authentication_flow", | ||||||
|             "authorization_flow", |             "authorization_flow", | ||||||
|  |             "invalidation_flow", | ||||||
|             "property_mappings", |             "property_mappings", | ||||||
|             "component", |             "component", | ||||||
|             "assigned_application_slug", |             "assigned_application_slug", | ||||||
| @ -50,6 +51,7 @@ class ProviderSerializer(ModelSerializer, MetaNameSerializer): | |||||||
|         ] |         ] | ||||||
|         extra_kwargs = { |         extra_kwargs = { | ||||||
|             "authorization_flow": {"required": True, "allow_null": False}, |             "authorization_flow": {"required": True, "allow_null": False}, | ||||||
|  |             "invalidation_flow": {"required": True, "allow_null": False}, | ||||||
|         } |         } | ||||||
|  |  | ||||||
|  |  | ||||||
|  | |||||||
| @ -19,7 +19,7 @@ from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT | |||||||
| from authentik.core.api.object_types import TypesMixin | from authentik.core.api.object_types import TypesMixin | ||||||
| from authentik.core.api.used_by import UsedByMixin | from authentik.core.api.used_by import UsedByMixin | ||||||
| from authentik.core.api.utils import MetaNameSerializer, ModelSerializer | from authentik.core.api.utils import MetaNameSerializer, ModelSerializer | ||||||
| from authentik.core.models import Source, UserSourceConnection | from authentik.core.models import GroupSourceConnection, Source, UserSourceConnection | ||||||
| from authentik.core.types import UserSettingSerializer | from authentik.core.types import UserSettingSerializer | ||||||
| from authentik.lib.utils.file import ( | from authentik.lib.utils.file import ( | ||||||
|     FilePathSerializer, |     FilePathSerializer, | ||||||
| @ -60,6 +60,8 @@ class SourceSerializer(ModelSerializer, MetaNameSerializer): | |||||||
|             "enabled", |             "enabled", | ||||||
|             "authentication_flow", |             "authentication_flow", | ||||||
|             "enrollment_flow", |             "enrollment_flow", | ||||||
|  |             "user_property_mappings", | ||||||
|  |             "group_property_mappings", | ||||||
|             "component", |             "component", | ||||||
|             "verbose_name", |             "verbose_name", | ||||||
|             "verbose_name_plural", |             "verbose_name_plural", | ||||||
| @ -188,6 +190,47 @@ class UserSourceConnectionViewSet( | |||||||
|     queryset = UserSourceConnection.objects.all() |     queryset = UserSourceConnection.objects.all() | ||||||
|     serializer_class = UserSourceConnectionSerializer |     serializer_class = UserSourceConnectionSerializer | ||||||
|     permission_classes = [OwnerSuperuserPermissions] |     permission_classes = [OwnerSuperuserPermissions] | ||||||
|     filterset_fields = ["user"] |     filterset_fields = ["user", "source__slug"] | ||||||
|  |     search_fields = ["source__slug"] | ||||||
|     filter_backends = [OwnerFilter, DjangoFilterBackend, OrderingFilter, SearchFilter] |     filter_backends = [OwnerFilter, DjangoFilterBackend, OrderingFilter, SearchFilter] | ||||||
|     ordering = ["pk"] |     ordering = ["source__slug", "pk"] | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class GroupSourceConnectionSerializer(SourceSerializer): | ||||||
|  |     """Group Source Connection Serializer""" | ||||||
|  |  | ||||||
|  |     source = SourceSerializer(read_only=True) | ||||||
|  |  | ||||||
|  |     class Meta: | ||||||
|  |         model = GroupSourceConnection | ||||||
|  |         fields = [ | ||||||
|  |             "pk", | ||||||
|  |             "group", | ||||||
|  |             "source", | ||||||
|  |             "identifier", | ||||||
|  |             "created", | ||||||
|  |         ] | ||||||
|  |         extra_kwargs = { | ||||||
|  |             "group": {"read_only": True}, | ||||||
|  |             "identifier": {"read_only": True}, | ||||||
|  |             "created": {"read_only": True}, | ||||||
|  |         } | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class GroupSourceConnectionViewSet( | ||||||
|  |     mixins.RetrieveModelMixin, | ||||||
|  |     mixins.UpdateModelMixin, | ||||||
|  |     mixins.DestroyModelMixin, | ||||||
|  |     UsedByMixin, | ||||||
|  |     mixins.ListModelMixin, | ||||||
|  |     GenericViewSet, | ||||||
|  | ): | ||||||
|  |     """Group-source connection Viewset""" | ||||||
|  |  | ||||||
|  |     queryset = GroupSourceConnection.objects.all() | ||||||
|  |     serializer_class = GroupSourceConnectionSerializer | ||||||
|  |     permission_classes = [OwnerSuperuserPermissions] | ||||||
|  |     filterset_fields = ["group", "source__slug"] | ||||||
|  |     search_fields = ["source__slug"] | ||||||
|  |     filter_backends = [OwnerFilter, DjangoFilterBackend, OrderingFilter, SearchFilter] | ||||||
|  |     ordering = ["source__slug", "pk"] | ||||||
|  | |||||||
| @ -14,6 +14,7 @@ from rest_framework.request import Request | |||||||
| from rest_framework.response import Response | from rest_framework.response import Response | ||||||
|  |  | ||||||
| from authentik.core.api.utils import PassiveSerializer | from authentik.core.api.utils import PassiveSerializer | ||||||
|  | from authentik.rbac.filters import ObjectFilter | ||||||
|  |  | ||||||
|  |  | ||||||
| class DeleteAction(Enum): | class DeleteAction(Enum): | ||||||
| @ -53,7 +54,7 @@ class UsedByMixin: | |||||||
|     @extend_schema( |     @extend_schema( | ||||||
|         responses={200: UsedBySerializer(many=True)}, |         responses={200: UsedBySerializer(many=True)}, | ||||||
|     ) |     ) | ||||||
|     @action(detail=True, pagination_class=None, filter_backends=[]) |     @action(detail=True, pagination_class=None, filter_backends=[ObjectFilter]) | ||||||
|     def used_by(self, request: Request, *args, **kwargs) -> Response: |     def used_by(self, request: Request, *args, **kwargs) -> Response: | ||||||
|         """Get a list of all objects that use this object""" |         """Get a list of all objects that use this object""" | ||||||
|         model: Model = self.get_object() |         model: Model = self.get_object() | ||||||
|  | |||||||
| @ -5,6 +5,7 @@ from json import loads | |||||||
| from typing import Any | from typing import Any | ||||||
|  |  | ||||||
| from django.contrib.auth import update_session_auth_hash | from django.contrib.auth import update_session_auth_hash | ||||||
|  | from django.contrib.auth.models import Permission | ||||||
| from django.contrib.sessions.backends.cache import KEY_PREFIX | from django.contrib.sessions.backends.cache import KEY_PREFIX | ||||||
| from django.core.cache import cache | from django.core.cache import cache | ||||||
| from django.db.models.functions import ExtractHour | from django.db.models.functions import ExtractHour | ||||||
| @ -33,15 +34,21 @@ from drf_spectacular.utils import ( | |||||||
| ) | ) | ||||||
| from guardian.shortcuts import get_objects_for_user | from guardian.shortcuts import get_objects_for_user | ||||||
| from rest_framework.decorators import action | from rest_framework.decorators import action | ||||||
| from rest_framework.fields import CharField, IntegerField, ListField, SerializerMethodField | from rest_framework.exceptions import ValidationError | ||||||
|  | from rest_framework.fields import ( | ||||||
|  |     BooleanField, | ||||||
|  |     CharField, | ||||||
|  |     ChoiceField, | ||||||
|  |     DateTimeField, | ||||||
|  |     IntegerField, | ||||||
|  |     ListField, | ||||||
|  |     SerializerMethodField, | ||||||
|  | ) | ||||||
| from rest_framework.request import Request | from rest_framework.request import Request | ||||||
| from rest_framework.response import Response | from rest_framework.response import Response | ||||||
| from rest_framework.serializers import ( | from rest_framework.serializers import ( | ||||||
|     BooleanField, |  | ||||||
|     DateTimeField, |  | ||||||
|     ListSerializer, |     ListSerializer, | ||||||
|     PrimaryKeyRelatedField, |     PrimaryKeyRelatedField, | ||||||
|     ValidationError, |  | ||||||
| ) | ) | ||||||
| from rest_framework.validators import UniqueValidator | from rest_framework.validators import UniqueValidator | ||||||
| from rest_framework.viewsets import ModelViewSet | from rest_framework.viewsets import ModelViewSet | ||||||
| @ -78,6 +85,7 @@ from authentik.flows.planner import PLAN_CONTEXT_PENDING_USER, FlowPlanner | |||||||
| from authentik.flows.views.executor import QS_KEY_TOKEN | from authentik.flows.views.executor import QS_KEY_TOKEN | ||||||
| from authentik.lib.avatars import get_avatar | from authentik.lib.avatars import get_avatar | ||||||
| from authentik.rbac.decorators import permission_required | from authentik.rbac.decorators import permission_required | ||||||
|  | from authentik.rbac.models import get_permission_choices | ||||||
| from authentik.stages.email.models import EmailStage | from authentik.stages.email.models import EmailStage | ||||||
| from authentik.stages.email.tasks import send_mails | from authentik.stages.email.tasks import send_mails | ||||||
| from authentik.stages.email.utils import TemplateEmailMessage | from authentik.stages.email.utils import TemplateEmailMessage | ||||||
| @ -141,12 +149,19 @@ class UserSerializer(ModelSerializer): | |||||||
|         super().__init__(*args, **kwargs) |         super().__init__(*args, **kwargs) | ||||||
|         if SERIALIZER_CONTEXT_BLUEPRINT in self.context: |         if SERIALIZER_CONTEXT_BLUEPRINT in self.context: | ||||||
|             self.fields["password"] = CharField(required=False, allow_null=True) |             self.fields["password"] = CharField(required=False, allow_null=True) | ||||||
|  |             self.fields["permissions"] = ListField( | ||||||
|  |                 required=False, child=ChoiceField(choices=get_permission_choices()) | ||||||
|  |             ) | ||||||
|  |  | ||||||
|     def create(self, validated_data: dict) -> User: |     def create(self, validated_data: dict) -> User: | ||||||
|         """If this serializer is used in the blueprint context, we allow for |         """If this serializer is used in the blueprint context, we allow for | ||||||
|         directly setting a password. However should be done via the `set_password` |         directly setting a password. However should be done via the `set_password` | ||||||
|         method instead of directly setting it like rest_framework.""" |         method instead of directly setting it like rest_framework.""" | ||||||
|         password = validated_data.pop("password", None) |         password = validated_data.pop("password", None) | ||||||
|  |         permissions = Permission.objects.filter( | ||||||
|  |             codename__in=[x.split(".")[1] for x in validated_data.pop("permissions", [])] | ||||||
|  |         ) | ||||||
|  |         validated_data["user_permissions"] = permissions | ||||||
|         instance: User = super().create(validated_data) |         instance: User = super().create(validated_data) | ||||||
|         self._set_password(instance, password) |         self._set_password(instance, password) | ||||||
|         return instance |         return instance | ||||||
| @ -155,6 +170,10 @@ class UserSerializer(ModelSerializer): | |||||||
|         """Same as `create` above, set the password directly if we're in a blueprint |         """Same as `create` above, set the password directly if we're in a blueprint | ||||||
|         context""" |         context""" | ||||||
|         password = validated_data.pop("password", None) |         password = validated_data.pop("password", None) | ||||||
|  |         permissions = Permission.objects.filter( | ||||||
|  |             codename__in=[x.split(".")[1] for x in validated_data.pop("permissions", [])] | ||||||
|  |         ) | ||||||
|  |         validated_data["user_permissions"] = permissions | ||||||
|         instance = super().update(instance, validated_data) |         instance = super().update(instance, validated_data) | ||||||
|         self._set_password(instance, password) |         self._set_password(instance, password) | ||||||
|         return instance |         return instance | ||||||
| @ -659,10 +678,13 @@ class UserViewSet(UsedByMixin, ModelViewSet): | |||||||
|         if not request.tenant.impersonation: |         if not request.tenant.impersonation: | ||||||
|             LOGGER.debug("User attempted to impersonate", user=request.user) |             LOGGER.debug("User attempted to impersonate", user=request.user) | ||||||
|             return Response(status=401) |             return Response(status=401) | ||||||
|         if not request.user.has_perm("impersonate"): |         user_to_be = self.get_object() | ||||||
|  |         # Check both object-level perms and global perms | ||||||
|  |         if not request.user.has_perm( | ||||||
|  |             "authentik_core.impersonate", user_to_be | ||||||
|  |         ) and not request.user.has_perm("authentik_core.impersonate"): | ||||||
|             LOGGER.debug("User attempted to impersonate without permissions", user=request.user) |             LOGGER.debug("User attempted to impersonate without permissions", user=request.user) | ||||||
|             return Response(status=401) |             return Response(status=401) | ||||||
|         user_to_be = self.get_object() |  | ||||||
|         if user_to_be.pk == self.request.user.pk: |         if user_to_be.pk == self.request.user.pk: | ||||||
|             LOGGER.debug("User attempted to impersonate themselves", user=request.user) |             LOGGER.debug("User attempted to impersonate themselves", user=request.user) | ||||||
|             return Response(status=401) |             return Response(status=401) | ||||||
|  | |||||||
							
								
								
									
										32
									
								
								authentik/core/management/commands/change_user_type.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								authentik/core/management/commands/change_user_type.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,32 @@ | |||||||
|  | """Change user type""" | ||||||
|  |  | ||||||
|  | from authentik.core.models import User, UserTypes | ||||||
|  | from authentik.tenants.management import TenantCommand | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Command(TenantCommand): | ||||||
|  |     """Change user type""" | ||||||
|  |  | ||||||
|  |     def add_arguments(self, parser): | ||||||
|  |         parser.add_argument("--type", type=str, required=True) | ||||||
|  |         parser.add_argument("--all", action="store_true", default=False) | ||||||
|  |         parser.add_argument("usernames", nargs="*", type=str) | ||||||
|  |  | ||||||
|  |     def handle_per_tenant(self, **options): | ||||||
|  |         print(options) | ||||||
|  |         new_type = UserTypes(options["type"]) | ||||||
|  |         qs = ( | ||||||
|  |             User.objects.exclude_anonymous() | ||||||
|  |             .exclude(type=UserTypes.SERVICE_ACCOUNT) | ||||||
|  |             .exclude(type=UserTypes.INTERNAL_SERVICE_ACCOUNT) | ||||||
|  |         ) | ||||||
|  |         if options["usernames"] and options["all"]: | ||||||
|  |             self.stderr.write("--all and usernames specified, only one can be specified") | ||||||
|  |             return | ||||||
|  |         if not options["usernames"] and not options["all"]: | ||||||
|  |             self.stderr.write("--all or usernames must be specified") | ||||||
|  |             return | ||||||
|  |         if options["usernames"] and not options["all"]: | ||||||
|  |             qs = qs.filter(username__in=options["usernames"]) | ||||||
|  |         updated = qs.update(type=new_type) | ||||||
|  |         self.stdout.write(f"Updated {updated} users.") | ||||||
| @ -4,6 +4,7 @@ import code | |||||||
| import platform | import platform | ||||||
| import sys | import sys | ||||||
| import traceback | import traceback | ||||||
|  | from pprint import pprint | ||||||
|  |  | ||||||
| from django.apps import apps | from django.apps import apps | ||||||
| from django.core.management.base import BaseCommand | from django.core.management.base import BaseCommand | ||||||
| @ -34,7 +35,9 @@ class Command(BaseCommand): | |||||||
|  |  | ||||||
|     def get_namespace(self): |     def get_namespace(self): | ||||||
|         """Prepare namespace with all models""" |         """Prepare namespace with all models""" | ||||||
|         namespace = {} |         namespace = { | ||||||
|  |             "pprint": pprint, | ||||||
|  |         } | ||||||
|  |  | ||||||
|         # Gather Django models and constants from each app |         # Gather Django models and constants from each app | ||||||
|         for app in apps.get_app_configs(): |         for app in apps.get_app_configs(): | ||||||
|  | |||||||
| @ -0,0 +1,43 @@ | |||||||
|  | # Generated by Django 5.0.2 on 2024-02-29 11:05 | ||||||
|  |  | ||||||
|  | from django.db import migrations, models | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Migration(migrations.Migration): | ||||||
|  |  | ||||||
|  |     dependencies = [ | ||||||
|  |         ("authentik_core", "0035_alter_group_options_and_more"), | ||||||
|  |     ] | ||||||
|  |  | ||||||
|  |     operations = [ | ||||||
|  |         migrations.AddField( | ||||||
|  |             model_name="source", | ||||||
|  |             name="group_property_mappings", | ||||||
|  |             field=models.ManyToManyField( | ||||||
|  |                 blank=True, | ||||||
|  |                 default=None, | ||||||
|  |                 related_name="source_grouppropertymappings_set", | ||||||
|  |                 to="authentik_core.propertymapping", | ||||||
|  |             ), | ||||||
|  |         ), | ||||||
|  |         migrations.AddField( | ||||||
|  |             model_name="source", | ||||||
|  |             name="user_property_mappings", | ||||||
|  |             field=models.ManyToManyField( | ||||||
|  |                 blank=True, | ||||||
|  |                 default=None, | ||||||
|  |                 related_name="source_userpropertymappings_set", | ||||||
|  |                 to="authentik_core.propertymapping", | ||||||
|  |             ), | ||||||
|  |         ), | ||||||
|  |         migrations.AlterField( | ||||||
|  |             model_name="source", | ||||||
|  |             name="property_mappings", | ||||||
|  |             field=models.ManyToManyField( | ||||||
|  |                 blank=True, | ||||||
|  |                 default=None, | ||||||
|  |                 related_name="source_set", | ||||||
|  |                 to="authentik_core.propertymapping", | ||||||
|  |             ), | ||||||
|  |         ), | ||||||
|  |     ] | ||||||
| @ -0,0 +1,18 @@ | |||||||
|  | # Generated by Django 5.0.2 on 2024-02-29 11:21 | ||||||
|  |  | ||||||
|  | from django.db import migrations | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Migration(migrations.Migration): | ||||||
|  |  | ||||||
|  |     dependencies = [ | ||||||
|  |         ("authentik_sources_ldap", "0005_remove_ldappropertymapping_object_field_and_more"), | ||||||
|  |         ("authentik_core", "0036_source_group_property_mappings_and_more"), | ||||||
|  |     ] | ||||||
|  |  | ||||||
|  |     operations = [ | ||||||
|  |         migrations.RemoveField( | ||||||
|  |             model_name="source", | ||||||
|  |             name="property_mappings", | ||||||
|  |         ), | ||||||
|  |     ] | ||||||
| @ -0,0 +1,19 @@ | |||||||
|  | # Generated by Django 5.0.7 on 2024-07-22 13:32 | ||||||
|  |  | ||||||
|  | from django.db import migrations, models | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Migration(migrations.Migration): | ||||||
|  |  | ||||||
|  |     dependencies = [ | ||||||
|  |         ("authentik_core", "0037_remove_source_property_mappings"), | ||||||
|  |         ("authentik_flows", "0027_auto_20231028_1424"), | ||||||
|  |         ("authentik_policies", "0011_policybinding_failure_result_and_more"), | ||||||
|  |     ] | ||||||
|  |  | ||||||
|  |     operations = [ | ||||||
|  |         migrations.AddIndex( | ||||||
|  |             model_name="source", | ||||||
|  |             index=models.Index(fields=["enabled"], name="authentik_c_enabled_d72365_idx"), | ||||||
|  |         ), | ||||||
|  |     ] | ||||||
| @ -0,0 +1,67 @@ | |||||||
|  | # Generated by Django 5.0.7 on 2024-08-01 18:52 | ||||||
|  |  | ||||||
|  | import django.db.models.deletion | ||||||
|  | from django.db import migrations, models | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Migration(migrations.Migration): | ||||||
|  |  | ||||||
|  |     dependencies = [ | ||||||
|  |         ("authentik_core", "0038_source_authentik_c_enabled_d72365_idx"), | ||||||
|  |     ] | ||||||
|  |  | ||||||
|  |     operations = [ | ||||||
|  |         migrations.AddField( | ||||||
|  |             model_name="source", | ||||||
|  |             name="group_matching_mode", | ||||||
|  |             field=models.TextField( | ||||||
|  |                 choices=[ | ||||||
|  |                     ("identifier", "Use the source-specific identifier"), | ||||||
|  |                     ( | ||||||
|  |                         "name_link", | ||||||
|  |                         "Link to a group with identical name. Can have security implications when a group name is used with another source.", | ||||||
|  |                     ), | ||||||
|  |                     ( | ||||||
|  |                         "name_deny", | ||||||
|  |                         "Use the group name, but deny enrollment when the name already exists.", | ||||||
|  |                     ), | ||||||
|  |                 ], | ||||||
|  |                 default="identifier", | ||||||
|  |                 help_text="How the source determines if an existing group should be used or a new group created.", | ||||||
|  |             ), | ||||||
|  |         ), | ||||||
|  |         migrations.AlterField( | ||||||
|  |             model_name="group", | ||||||
|  |             name="name", | ||||||
|  |             field=models.TextField(verbose_name="name"), | ||||||
|  |         ), | ||||||
|  |         migrations.CreateModel( | ||||||
|  |             name="GroupSourceConnection", | ||||||
|  |             fields=[ | ||||||
|  |                 ( | ||||||
|  |                     "id", | ||||||
|  |                     models.AutoField( | ||||||
|  |                         auto_created=True, primary_key=True, serialize=False, verbose_name="ID" | ||||||
|  |                     ), | ||||||
|  |                 ), | ||||||
|  |                 ("created", models.DateTimeField(auto_now_add=True)), | ||||||
|  |                 ("last_updated", models.DateTimeField(auto_now=True)), | ||||||
|  |                 ("identifier", models.TextField()), | ||||||
|  |                 ( | ||||||
|  |                     "group", | ||||||
|  |                     models.ForeignKey( | ||||||
|  |                         on_delete=django.db.models.deletion.CASCADE, to="authentik_core.group" | ||||||
|  |                     ), | ||||||
|  |                 ), | ||||||
|  |                 ( | ||||||
|  |                     "source", | ||||||
|  |                     models.ForeignKey( | ||||||
|  |                         on_delete=django.db.models.deletion.CASCADE, to="authentik_core.source" | ||||||
|  |                     ), | ||||||
|  |                 ), | ||||||
|  |             ], | ||||||
|  |             options={ | ||||||
|  |                 "unique_together": {("group", "source")}, | ||||||
|  |             }, | ||||||
|  |         ), | ||||||
|  |     ] | ||||||
							
								
								
									
										55
									
								
								authentik/core/migrations/0040_provider_invalidation_flow.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										55
									
								
								authentik/core/migrations/0040_provider_invalidation_flow.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,55 @@ | |||||||
|  | # Generated by Django 5.0.9 on 2024-10-02 11:35 | ||||||
|  |  | ||||||
|  | import django.db.models.deletion | ||||||
|  | from django.db import migrations, models | ||||||
|  |  | ||||||
|  | from django.apps.registry import Apps | ||||||
|  | from django.db import migrations, models | ||||||
|  | from django.db.backends.base.schema import BaseDatabaseSchemaEditor | ||||||
|  |  | ||||||
|  |  | ||||||
|  | def migrate_invalidation_flow_default(apps: Apps, schema_editor: BaseDatabaseSchemaEditor): | ||||||
|  |     from authentik.flows.models import FlowDesignation, FlowAuthenticationRequirement | ||||||
|  |  | ||||||
|  |     db_alias = schema_editor.connection.alias | ||||||
|  |  | ||||||
|  |     Flow = apps.get_model("authentik_flows", "Flow") | ||||||
|  |     Provider = apps.get_model("authentik_core", "Provider") | ||||||
|  |  | ||||||
|  |     # So this flow is managed via a blueprint, bue we're in a migration so we don't want to rely on that | ||||||
|  |     # since the blueprint is just an empty flow we can just create it here | ||||||
|  |     # and let it be managed by the blueprint later | ||||||
|  |     flow, _ = Flow.objects.using(db_alias).update_or_create( | ||||||
|  |         slug="default-provider-invalidation-flow", | ||||||
|  |         defaults={ | ||||||
|  |             "name": "Logged out of application", | ||||||
|  |             "title": "You've logged out of %(app)s.", | ||||||
|  |             "authentication": FlowAuthenticationRequirement.NONE, | ||||||
|  |             "designation": FlowDesignation.INVALIDATION, | ||||||
|  |         }, | ||||||
|  |     ) | ||||||
|  |     Provider.objects.using(db_alias).filter(invalidation_flow=None).update(invalidation_flow=flow) | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Migration(migrations.Migration): | ||||||
|  |  | ||||||
|  |     dependencies = [ | ||||||
|  |         ("authentik_core", "0039_source_group_matching_mode_alter_group_name_and_more"), | ||||||
|  |         ("authentik_flows", "0027_auto_20231028_1424"), | ||||||
|  |     ] | ||||||
|  |  | ||||||
|  |     operations = [ | ||||||
|  |         migrations.AddField( | ||||||
|  |             model_name="provider", | ||||||
|  |             name="invalidation_flow", | ||||||
|  |             field=models.ForeignKey( | ||||||
|  |                 default=None, | ||||||
|  |                 help_text="Flow used ending the session from a provider.", | ||||||
|  |                 null=True, | ||||||
|  |                 on_delete=django.db.models.deletion.SET_DEFAULT, | ||||||
|  |                 related_name="provider_invalidation", | ||||||
|  |                 to="authentik_flows.flow", | ||||||
|  |             ), | ||||||
|  |         ), | ||||||
|  |         migrations.RunPython(migrate_invalidation_flow_default), | ||||||
|  |     ] | ||||||
| @ -11,6 +11,7 @@ from django.contrib.auth.models import AbstractUser | |||||||
| from django.contrib.auth.models import UserManager as DjangoUserManager | from django.contrib.auth.models import UserManager as DjangoUserManager | ||||||
| from django.db import models | from django.db import models | ||||||
| from django.db.models import Q, QuerySet, options | from django.db.models import Q, QuerySet, options | ||||||
|  | from django.db.models.constants import LOOKUP_SEP | ||||||
| from django.http import HttpRequest | from django.http import HttpRequest | ||||||
| from django.utils.functional import SimpleLazyObject, cached_property | from django.utils.functional import SimpleLazyObject, cached_property | ||||||
| from django.utils.timezone import now | from django.utils.timezone import now | ||||||
| @ -28,6 +29,7 @@ from authentik.core.types import UILoginButton, UserSettingSerializer | |||||||
| from authentik.lib.avatars import get_avatar | from authentik.lib.avatars import get_avatar | ||||||
| from authentik.lib.expression.exceptions import ControlFlowException | from authentik.lib.expression.exceptions import ControlFlowException | ||||||
| from authentik.lib.generators import generate_id | from authentik.lib.generators import generate_id | ||||||
|  | from authentik.lib.merge import MERGE_LIST_UNIQUE | ||||||
| from authentik.lib.models import ( | from authentik.lib.models import ( | ||||||
|     CreatedUpdatedModel, |     CreatedUpdatedModel, | ||||||
|     DomainlessFormattedURLValidator, |     DomainlessFormattedURLValidator, | ||||||
| @ -100,6 +102,38 @@ class UserTypes(models.TextChoices): | |||||||
|     INTERNAL_SERVICE_ACCOUNT = "internal_service_account" |     INTERNAL_SERVICE_ACCOUNT = "internal_service_account" | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class AttributesMixin(models.Model): | ||||||
|  |     """Adds an attributes property to a model""" | ||||||
|  |  | ||||||
|  |     attributes = models.JSONField(default=dict, blank=True) | ||||||
|  |  | ||||||
|  |     class Meta: | ||||||
|  |         abstract = True | ||||||
|  |  | ||||||
|  |     def update_attributes(self, properties: dict[str, Any]): | ||||||
|  |         """Update fields and attributes, but correctly by merging dicts""" | ||||||
|  |         for key, value in properties.items(): | ||||||
|  |             if key == "attributes": | ||||||
|  |                 continue | ||||||
|  |             setattr(self, key, value) | ||||||
|  |         final_attributes = {} | ||||||
|  |         MERGE_LIST_UNIQUE.merge(final_attributes, self.attributes) | ||||||
|  |         MERGE_LIST_UNIQUE.merge(final_attributes, properties.get("attributes", {})) | ||||||
|  |         self.attributes = final_attributes | ||||||
|  |         self.save() | ||||||
|  |  | ||||||
|  |     @classmethod | ||||||
|  |     def update_or_create_attributes( | ||||||
|  |         cls, query: dict[str, Any], properties: dict[str, Any] | ||||||
|  |     ) -> tuple[models.Model, bool]: | ||||||
|  |         """Same as django's update_or_create but correctly updates attributes by merging dicts""" | ||||||
|  |         instance = cls.objects.filter(**query).first() | ||||||
|  |         if not instance: | ||||||
|  |             return cls.objects.create(**properties), True | ||||||
|  |         instance.update_attributes(properties) | ||||||
|  |         return instance, False | ||||||
|  |  | ||||||
|  |  | ||||||
| class GroupQuerySet(CTEQuerySet): | class GroupQuerySet(CTEQuerySet): | ||||||
|     def with_children_recursive(self): |     def with_children_recursive(self): | ||||||
|         """Recursively get all groups that have the current queryset as parents |         """Recursively get all groups that have the current queryset as parents | ||||||
| @ -134,12 +168,12 @@ class GroupQuerySet(CTEQuerySet): | |||||||
|         return cte.join(Group, group_uuid=cte.col.group_uuid).with_cte(cte) |         return cte.join(Group, group_uuid=cte.col.group_uuid).with_cte(cte) | ||||||
|  |  | ||||||
|  |  | ||||||
| class Group(SerializerModel): | class Group(SerializerModel, AttributesMixin): | ||||||
|     """Group model which supports a basic hierarchy and has attributes""" |     """Group model which supports a basic hierarchy and has attributes""" | ||||||
|  |  | ||||||
|     group_uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4) |     group_uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4) | ||||||
|  |  | ||||||
|     name = models.CharField(_("name"), max_length=80) |     name = models.TextField(_("name")) | ||||||
|     is_superuser = models.BooleanField( |     is_superuser = models.BooleanField( | ||||||
|         default=False, help_text=_("Users added to this group will be superusers.") |         default=False, help_text=_("Users added to this group will be superusers.") | ||||||
|     ) |     ) | ||||||
| @ -154,10 +188,27 @@ class Group(SerializerModel): | |||||||
|         on_delete=models.SET_NULL, |         on_delete=models.SET_NULL, | ||||||
|         related_name="children", |         related_name="children", | ||||||
|     ) |     ) | ||||||
|     attributes = models.JSONField(default=dict, blank=True) |  | ||||||
|  |  | ||||||
|     objects = GroupQuerySet.as_manager() |     objects = GroupQuerySet.as_manager() | ||||||
|  |  | ||||||
|  |     class Meta: | ||||||
|  |         unique_together = ( | ||||||
|  |             ( | ||||||
|  |                 "name", | ||||||
|  |                 "parent", | ||||||
|  |             ), | ||||||
|  |         ) | ||||||
|  |         indexes = [models.Index(fields=["name"])] | ||||||
|  |         verbose_name = _("Group") | ||||||
|  |         verbose_name_plural = _("Groups") | ||||||
|  |         permissions = [ | ||||||
|  |             ("add_user_to_group", _("Add user to group")), | ||||||
|  |             ("remove_user_from_group", _("Remove user from group")), | ||||||
|  |         ] | ||||||
|  |  | ||||||
|  |     def __str__(self): | ||||||
|  |         return f"Group {self.name}" | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def serializer(self) -> Serializer: |     def serializer(self) -> Serializer: | ||||||
|         from authentik.core.api.groups import GroupSerializer |         from authentik.core.api.groups import GroupSerializer | ||||||
| @ -182,24 +233,6 @@ class Group(SerializerModel): | |||||||
|             qs = Group.objects.filter(group_uuid=self.group_uuid) |             qs = Group.objects.filter(group_uuid=self.group_uuid) | ||||||
|         return qs.with_children_recursive() |         return qs.with_children_recursive() | ||||||
|  |  | ||||||
|     def __str__(self): |  | ||||||
|         return f"Group {self.name}" |  | ||||||
|  |  | ||||||
|     class Meta: |  | ||||||
|         unique_together = ( |  | ||||||
|             ( |  | ||||||
|                 "name", |  | ||||||
|                 "parent", |  | ||||||
|             ), |  | ||||||
|         ) |  | ||||||
|         indexes = [models.Index(fields=["name"])] |  | ||||||
|         verbose_name = _("Group") |  | ||||||
|         verbose_name_plural = _("Groups") |  | ||||||
|         permissions = [ |  | ||||||
|             ("add_user_to_group", _("Add user to group")), |  | ||||||
|             ("remove_user_from_group", _("Remove user from group")), |  | ||||||
|         ] |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class UserQuerySet(models.QuerySet): | class UserQuerySet(models.QuerySet): | ||||||
|     """User queryset""" |     """User queryset""" | ||||||
| @ -225,7 +258,7 @@ class UserManager(DjangoUserManager): | |||||||
|         return self.get_queryset().exclude_anonymous() |         return self.get_queryset().exclude_anonymous() | ||||||
|  |  | ||||||
|  |  | ||||||
| class User(SerializerModel, GuardianUserMixin, AbstractUser): | class User(SerializerModel, GuardianUserMixin, AttributesMixin, AbstractUser): | ||||||
|     """authentik User model, based on django's contrib auth user model.""" |     """authentik User model, based on django's contrib auth user model.""" | ||||||
|  |  | ||||||
|     uuid = models.UUIDField(default=uuid4, editable=False, unique=True) |     uuid = models.UUIDField(default=uuid4, editable=False, unique=True) | ||||||
| @ -237,10 +270,30 @@ class User(SerializerModel, GuardianUserMixin, AbstractUser): | |||||||
|     ak_groups = models.ManyToManyField("Group", related_name="users") |     ak_groups = models.ManyToManyField("Group", related_name="users") | ||||||
|     password_change_date = models.DateTimeField(auto_now_add=True) |     password_change_date = models.DateTimeField(auto_now_add=True) | ||||||
|  |  | ||||||
|     attributes = models.JSONField(default=dict, blank=True) |  | ||||||
|  |  | ||||||
|     objects = UserManager() |     objects = UserManager() | ||||||
|  |  | ||||||
|  |     class Meta: | ||||||
|  |         verbose_name = _("User") | ||||||
|  |         verbose_name_plural = _("Users") | ||||||
|  |         permissions = [ | ||||||
|  |             ("reset_user_password", _("Reset Password")), | ||||||
|  |             ("impersonate", _("Can impersonate other users")), | ||||||
|  |             ("assign_user_permissions", _("Can assign permissions to users")), | ||||||
|  |             ("unassign_user_permissions", _("Can unassign permissions from users")), | ||||||
|  |             ("preview_user", _("Can preview user data sent to providers")), | ||||||
|  |             ("view_user_applications", _("View applications the user has access to")), | ||||||
|  |         ] | ||||||
|  |         indexes = [ | ||||||
|  |             models.Index(fields=["last_login"]), | ||||||
|  |             models.Index(fields=["password_change_date"]), | ||||||
|  |             models.Index(fields=["uuid"]), | ||||||
|  |             models.Index(fields=["path"]), | ||||||
|  |             models.Index(fields=["type"]), | ||||||
|  |         ] | ||||||
|  |  | ||||||
|  |     def __str__(self): | ||||||
|  |         return self.username | ||||||
|  |  | ||||||
|     @staticmethod |     @staticmethod | ||||||
|     def default_path() -> str: |     def default_path() -> str: | ||||||
|         """Get the default user path""" |         """Get the default user path""" | ||||||
| @ -277,11 +330,13 @@ class User(SerializerModel, GuardianUserMixin, AbstractUser): | |||||||
|         """superuser == staff user""" |         """superuser == staff user""" | ||||||
|         return self.is_superuser  # type: ignore |         return self.is_superuser  # type: ignore | ||||||
|  |  | ||||||
|     def set_password(self, raw_password, signal=True): |     def set_password(self, raw_password, signal=True, sender=None): | ||||||
|         if self.pk and signal: |         if self.pk and signal: | ||||||
|             from authentik.core.signals import password_changed |             from authentik.core.signals import password_changed | ||||||
|  |  | ||||||
|             password_changed.send(sender=self, user=self, password=raw_password) |             if not sender: | ||||||
|  |                 sender = self | ||||||
|  |             password_changed.send(sender=sender, user=self, password=raw_password) | ||||||
|         self.password_change_date = now() |         self.password_change_date = now() | ||||||
|         return super().set_password(raw_password) |         return super().set_password(raw_password) | ||||||
|  |  | ||||||
| @ -322,25 +377,6 @@ class User(SerializerModel, GuardianUserMixin, AbstractUser): | |||||||
|         """Get avatar, depending on authentik.avatar setting""" |         """Get avatar, depending on authentik.avatar setting""" | ||||||
|         return get_avatar(self) |         return get_avatar(self) | ||||||
|  |  | ||||||
|     class Meta: |  | ||||||
|         verbose_name = _("User") |  | ||||||
|         verbose_name_plural = _("Users") |  | ||||||
|         permissions = [ |  | ||||||
|             ("reset_user_password", _("Reset Password")), |  | ||||||
|             ("impersonate", _("Can impersonate other users")), |  | ||||||
|             ("assign_user_permissions", _("Can assign permissions to users")), |  | ||||||
|             ("unassign_user_permissions", _("Can unassign permissions from users")), |  | ||||||
|             ("preview_user", _("Can preview user data sent to providers")), |  | ||||||
|             ("view_user_applications", _("View applications the user has access to")), |  | ||||||
|         ] |  | ||||||
|         indexes = [ |  | ||||||
|             models.Index(fields=["last_login"]), |  | ||||||
|             models.Index(fields=["password_change_date"]), |  | ||||||
|             models.Index(fields=["uuid"]), |  | ||||||
|             models.Index(fields=["path"]), |  | ||||||
|             models.Index(fields=["type"]), |  | ||||||
|         ] |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class Provider(SerializerModel): | class Provider(SerializerModel): | ||||||
|     """Application-independent Provider instance. For example SAML2 Remote, OAuth2 Application""" |     """Application-independent Provider instance. For example SAML2 Remote, OAuth2 Application""" | ||||||
| @ -357,14 +393,23 @@ class Provider(SerializerModel): | |||||||
|         ), |         ), | ||||||
|         related_name="provider_authentication", |         related_name="provider_authentication", | ||||||
|     ) |     ) | ||||||
|  |  | ||||||
|     authorization_flow = models.ForeignKey( |     authorization_flow = models.ForeignKey( | ||||||
|         "authentik_flows.Flow", |         "authentik_flows.Flow", | ||||||
|  |         # Set to cascade even though null is allowed, since most providers | ||||||
|  |         # still require an authorization flow set | ||||||
|         on_delete=models.CASCADE, |         on_delete=models.CASCADE, | ||||||
|         null=True, |         null=True, | ||||||
|         help_text=_("Flow used when authorizing this provider."), |         help_text=_("Flow used when authorizing this provider."), | ||||||
|         related_name="provider_authorization", |         related_name="provider_authorization", | ||||||
|     ) |     ) | ||||||
|  |     invalidation_flow = models.ForeignKey( | ||||||
|  |         "authentik_flows.Flow", | ||||||
|  |         on_delete=models.SET_DEFAULT, | ||||||
|  |         default=None, | ||||||
|  |         null=True, | ||||||
|  |         help_text=_("Flow used ending the session from a provider."), | ||||||
|  |         related_name="provider_invalidation", | ||||||
|  |     ) | ||||||
|  |  | ||||||
|     property_mappings = models.ManyToManyField("PropertyMapping", default=None, blank=True) |     property_mappings = models.ManyToManyField("PropertyMapping", default=None, blank=True) | ||||||
|  |  | ||||||
| @ -428,6 +473,14 @@ class BackchannelProvider(Provider): | |||||||
|         abstract = True |         abstract = True | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class ApplicationQuerySet(QuerySet): | ||||||
|  |     def with_provider(self) -> "QuerySet[Application]": | ||||||
|  |         qs = self.select_related("provider") | ||||||
|  |         for subclass in Provider.objects.get_queryset()._get_subclasses_recurse(Provider): | ||||||
|  |             qs = qs.select_related(f"provider__{subclass}") | ||||||
|  |         return qs | ||||||
|  |  | ||||||
|  |  | ||||||
| class Application(SerializerModel, PolicyBindingModel): | class Application(SerializerModel, PolicyBindingModel): | ||||||
|     """Every Application which uses authentik for authentication/identification/authorization |     """Every Application which uses authentik for authentication/identification/authorization | ||||||
|     needs an Application record. Other authentication types can subclass this Model to |     needs an Application record. Other authentication types can subclass this Model to | ||||||
| @ -459,6 +512,8 @@ class Application(SerializerModel, PolicyBindingModel): | |||||||
|     meta_description = models.TextField(default="", blank=True) |     meta_description = models.TextField(default="", blank=True) | ||||||
|     meta_publisher = models.TextField(default="", blank=True) |     meta_publisher = models.TextField(default="", blank=True) | ||||||
|  |  | ||||||
|  |     objects = ApplicationQuerySet.as_manager() | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def serializer(self) -> Serializer: |     def serializer(self) -> Serializer: | ||||||
|         from authentik.core.api.applications import ApplicationSerializer |         from authentik.core.api.applications import ApplicationSerializer | ||||||
| @ -495,16 +550,28 @@ class Application(SerializerModel, PolicyBindingModel): | |||||||
|         return url |         return url | ||||||
|  |  | ||||||
|     def get_provider(self) -> Provider | None: |     def get_provider(self) -> Provider | None: | ||||||
|         """Get casted provider instance""" |         """Get casted provider instance. Needs Application queryset with_provider""" | ||||||
|         if not self.provider: |         if not self.provider: | ||||||
|             return None |             return None | ||||||
|         # if the Application class has been cache, self.provider is set |  | ||||||
|         # but doing a direct query lookup will fail. |         candidates = [] | ||||||
|         # In that case, just return None |         base_class = Provider | ||||||
|         try: |         for subclass in base_class.objects.get_queryset()._get_subclasses_recurse(base_class): | ||||||
|             return Provider.objects.get_subclass(pk=self.provider.pk) |             parent = self.provider | ||||||
|         except Provider.DoesNotExist: |             for level in subclass.split(LOOKUP_SEP): | ||||||
|  |                 try: | ||||||
|  |                     parent = getattr(parent, level) | ||||||
|  |                 except AttributeError: | ||||||
|  |                     break | ||||||
|  |             if parent in candidates: | ||||||
|  |                 continue | ||||||
|  |             idx = subclass.count(LOOKUP_SEP) | ||||||
|  |             if type(parent) is not base_class: | ||||||
|  |                 idx += 1 | ||||||
|  |             candidates.insert(idx, parent) | ||||||
|  |         if not candidates: | ||||||
|             return None |             return None | ||||||
|  |         return candidates[-1] | ||||||
|  |  | ||||||
|     def __str__(self): |     def __str__(self): | ||||||
|         return str(self.name) |         return str(self.name) | ||||||
| @ -534,6 +601,19 @@ class SourceUserMatchingModes(models.TextChoices): | |||||||
|     ) |     ) | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class SourceGroupMatchingModes(models.TextChoices): | ||||||
|  |     """Different modes a source can handle new/returning groups""" | ||||||
|  |  | ||||||
|  |     IDENTIFIER = "identifier", _("Use the source-specific identifier") | ||||||
|  |     NAME_LINK = "name_link", _( | ||||||
|  |         "Link to a group with identical name. Can have security implications " | ||||||
|  |         "when a group name is used with another source." | ||||||
|  |     ) | ||||||
|  |     NAME_DENY = "name_deny", _( | ||||||
|  |         "Use the group name, but deny enrollment when the name already exists." | ||||||
|  |     ) | ||||||
|  |  | ||||||
|  |  | ||||||
| class Source(ManagedModel, SerializerModel, PolicyBindingModel): | class Source(ManagedModel, SerializerModel, PolicyBindingModel): | ||||||
|     """Base Authentication source, i.e. an OAuth Provider, SAML Remote or LDAP Server""" |     """Base Authentication source, i.e. an OAuth Provider, SAML Remote or LDAP Server""" | ||||||
|  |  | ||||||
| @ -543,7 +623,12 @@ class Source(ManagedModel, SerializerModel, PolicyBindingModel): | |||||||
|     user_path_template = models.TextField(default="goauthentik.io/sources/%(slug)s") |     user_path_template = models.TextField(default="goauthentik.io/sources/%(slug)s") | ||||||
|  |  | ||||||
|     enabled = models.BooleanField(default=True) |     enabled = models.BooleanField(default=True) | ||||||
|     property_mappings = models.ManyToManyField("PropertyMapping", default=None, blank=True) |     user_property_mappings = models.ManyToManyField( | ||||||
|  |         "PropertyMapping", default=None, blank=True, related_name="source_userpropertymappings_set" | ||||||
|  |     ) | ||||||
|  |     group_property_mappings = models.ManyToManyField( | ||||||
|  |         "PropertyMapping", default=None, blank=True, related_name="source_grouppropertymappings_set" | ||||||
|  |     ) | ||||||
|     icon = models.FileField( |     icon = models.FileField( | ||||||
|         upload_to="source-icons/", |         upload_to="source-icons/", | ||||||
|         default=None, |         default=None, | ||||||
| @ -578,6 +663,14 @@ class Source(ManagedModel, SerializerModel, PolicyBindingModel): | |||||||
|             "a new user enrolled." |             "a new user enrolled." | ||||||
|         ), |         ), | ||||||
|     ) |     ) | ||||||
|  |     group_matching_mode = models.TextField( | ||||||
|  |         choices=SourceGroupMatchingModes.choices, | ||||||
|  |         default=SourceGroupMatchingModes.IDENTIFIER, | ||||||
|  |         help_text=_( | ||||||
|  |             "How the source determines if an existing group should be used or " | ||||||
|  |             "a new group created." | ||||||
|  |         ), | ||||||
|  |     ) | ||||||
|  |  | ||||||
|     objects = InheritanceManager() |     objects = InheritanceManager() | ||||||
|  |  | ||||||
| @ -607,6 +700,11 @@ class Source(ManagedModel, SerializerModel, PolicyBindingModel): | |||||||
|         """Return component used to edit this object""" |         """Return component used to edit this object""" | ||||||
|         raise NotImplementedError |         raise NotImplementedError | ||||||
|  |  | ||||||
|  |     @property | ||||||
|  |     def property_mapping_type(self) -> "type[PropertyMapping]": | ||||||
|  |         """Return property mapping type used by this object""" | ||||||
|  |         raise NotImplementedError | ||||||
|  |  | ||||||
|     def ui_login_button(self, request: HttpRequest) -> UILoginButton | None: |     def ui_login_button(self, request: HttpRequest) -> UILoginButton | None: | ||||||
|         """If source uses a http-based flow, return UI Information about the login |         """If source uses a http-based flow, return UI Information about the login | ||||||
|         button. If source doesn't use http-based flow, return None.""" |         button. If source doesn't use http-based flow, return None.""" | ||||||
| @ -617,6 +715,14 @@ class Source(ManagedModel, SerializerModel, PolicyBindingModel): | |||||||
|         user settings are available, or UserSettingSerializer.""" |         user settings are available, or UserSettingSerializer.""" | ||||||
|         return None |         return None | ||||||
|  |  | ||||||
|  |     def get_base_user_properties(self, **kwargs) -> dict[str, Any | dict[str, Any]]: | ||||||
|  |         """Get base properties for a user to build final properties upon.""" | ||||||
|  |         raise NotImplementedError | ||||||
|  |  | ||||||
|  |     def get_base_group_properties(self, **kwargs) -> dict[str, Any | dict[str, Any]]: | ||||||
|  |         """Get base properties for a group to build final properties upon.""" | ||||||
|  |         raise NotImplementedError | ||||||
|  |  | ||||||
|     def __str__(self): |     def __str__(self): | ||||||
|         return str(self.name) |         return str(self.name) | ||||||
|  |  | ||||||
| @ -632,6 +738,11 @@ class Source(ManagedModel, SerializerModel, PolicyBindingModel): | |||||||
|                     "name", |                     "name", | ||||||
|                 ] |                 ] | ||||||
|             ), |             ), | ||||||
|  |             models.Index( | ||||||
|  |                 fields=[ | ||||||
|  |                     "enabled", | ||||||
|  |                 ] | ||||||
|  |             ), | ||||||
|         ] |         ] | ||||||
|  |  | ||||||
|  |  | ||||||
| @ -655,6 +766,27 @@ class UserSourceConnection(SerializerModel, CreatedUpdatedModel): | |||||||
|         unique_together = (("user", "source"),) |         unique_together = (("user", "source"),) | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class GroupSourceConnection(SerializerModel, CreatedUpdatedModel): | ||||||
|  |     """Connection between Group and Source.""" | ||||||
|  |  | ||||||
|  |     group = models.ForeignKey(Group, on_delete=models.CASCADE) | ||||||
|  |     source = models.ForeignKey(Source, on_delete=models.CASCADE) | ||||||
|  |     identifier = models.TextField() | ||||||
|  |  | ||||||
|  |     objects = InheritanceManager() | ||||||
|  |  | ||||||
|  |     @property | ||||||
|  |     def serializer(self) -> type[Serializer]: | ||||||
|  |         """Get serializer for this model""" | ||||||
|  |         raise NotImplementedError | ||||||
|  |  | ||||||
|  |     def __str__(self) -> str: | ||||||
|  |         return f"Group-source connection (group={self.group_id}, source={self.source_id})" | ||||||
|  |  | ||||||
|  |     class Meta: | ||||||
|  |         unique_together = (("group", "source"),) | ||||||
|  |  | ||||||
|  |  | ||||||
| class ExpiringModel(models.Model): | class ExpiringModel(models.Model): | ||||||
|     """Base Model which can expire, and is automatically cleaned up.""" |     """Base Model which can expire, and is automatically cleaned up.""" | ||||||
|  |  | ||||||
| @ -787,7 +919,7 @@ class PropertyMapping(SerializerModel, ManagedModel): | |||||||
|         except ControlFlowException as exc: |         except ControlFlowException as exc: | ||||||
|             raise exc |             raise exc | ||||||
|         except Exception as exc: |         except Exception as exc: | ||||||
|             raise PropertyMappingExpressionException(self, exc) from exc |             raise PropertyMappingExpressionException(exc, self) from exc | ||||||
|  |  | ||||||
|     def __str__(self): |     def __str__(self): | ||||||
|         return f"Property Mapping {self.name}" |         return f"Property Mapping {self.name}" | ||||||
|  | |||||||
| @ -52,6 +52,8 @@ def user_logged_in_session(sender, request: HttpRequest, user: User, **_): | |||||||
| @receiver(user_logged_out) | @receiver(user_logged_out) | ||||||
| def user_logged_out_session(sender, request: HttpRequest, user: User, **_): | def user_logged_out_session(sender, request: HttpRequest, user: User, **_): | ||||||
|     """Delete AuthenticatedSession if it exists""" |     """Delete AuthenticatedSession if it exists""" | ||||||
|  |     if not request.session or not request.session.session_key: | ||||||
|  |         return | ||||||
|     AuthenticatedSession.objects.filter(session_key=request.session.session_key).delete() |     AuthenticatedSession.objects.filter(session_key=request.session.session_key).delete() | ||||||
|  |  | ||||||
|  |  | ||||||
|  | |||||||
| @ -1,19 +1,28 @@ | |||||||
| """Source decision helper""" | """Source decision helper""" | ||||||
|  |  | ||||||
| from enum import Enum |  | ||||||
| from typing import Any | from typing import Any | ||||||
|  |  | ||||||
| from django.contrib import messages | from django.contrib import messages | ||||||
| from django.db import IntegrityError | from django.db import IntegrityError, transaction | ||||||
| from django.db.models.query_utils import Q |  | ||||||
| from django.http import HttpRequest, HttpResponse | from django.http import HttpRequest, HttpResponse | ||||||
| from django.shortcuts import redirect | from django.shortcuts import redirect | ||||||
| from django.urls import reverse | from django.urls import reverse | ||||||
| from django.utils.translation import gettext as _ | from django.utils.translation import gettext as _ | ||||||
| from structlog.stdlib import get_logger | from structlog.stdlib import get_logger | ||||||
|  |  | ||||||
| from authentik.core.models import Source, SourceUserMatchingModes, User, UserSourceConnection | from authentik.core.models import ( | ||||||
| from authentik.core.sources.stage import PLAN_CONTEXT_SOURCES_CONNECTION, PostSourceStage |     Group, | ||||||
|  |     GroupSourceConnection, | ||||||
|  |     Source, | ||||||
|  |     User, | ||||||
|  |     UserSourceConnection, | ||||||
|  | ) | ||||||
|  | from authentik.core.sources.mapper import SourceMapper | ||||||
|  | from authentik.core.sources.matcher import Action, SourceMatcher | ||||||
|  | from authentik.core.sources.stage import ( | ||||||
|  |     PLAN_CONTEXT_SOURCES_CONNECTION, | ||||||
|  |     PostSourceStage, | ||||||
|  | ) | ||||||
| from authentik.events.models import Event, EventAction | from authentik.events.models import Event, EventAction | ||||||
| from authentik.flows.exceptions import FlowNonApplicableException | from authentik.flows.exceptions import FlowNonApplicableException | ||||||
| from authentik.flows.models import Flow, FlowToken, Stage, in_memory_stage | from authentik.flows.models import Flow, FlowToken, Stage, in_memory_stage | ||||||
| @ -36,17 +45,10 @@ from authentik.stages.password.stage import PLAN_CONTEXT_AUTHENTICATION_BACKEND | |||||||
| from authentik.stages.prompt.stage import PLAN_CONTEXT_PROMPT | from authentik.stages.prompt.stage import PLAN_CONTEXT_PROMPT | ||||||
| from authentik.stages.user_write.stage import PLAN_CONTEXT_USER_PATH | from authentik.stages.user_write.stage import PLAN_CONTEXT_USER_PATH | ||||||
|  |  | ||||||
|  | LOGGER = get_logger() | ||||||
|  |  | ||||||
| SESSION_KEY_OVERRIDE_FLOW_TOKEN = "authentik/flows/source_override_flow_token"  # nosec | SESSION_KEY_OVERRIDE_FLOW_TOKEN = "authentik/flows/source_override_flow_token"  # nosec | ||||||
|  | PLAN_CONTEXT_SOURCE_GROUPS = "source_groups" | ||||||
|  |  | ||||||
| class Action(Enum): |  | ||||||
|     """Actions that can be decided based on the request |  | ||||||
|     and source settings""" |  | ||||||
|  |  | ||||||
|     LINK = "link" |  | ||||||
|     AUTH = "auth" |  | ||||||
|     ENROLL = "enroll" |  | ||||||
|     DENY = "deny" |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class MessageStage(StageView): | class MessageStage(StageView): | ||||||
| @ -70,96 +72,74 @@ class SourceFlowManager: | |||||||
|     or deny the request.""" |     or deny the request.""" | ||||||
|  |  | ||||||
|     source: Source |     source: Source | ||||||
|  |     mapper: SourceMapper | ||||||
|  |     matcher: SourceMatcher | ||||||
|     request: HttpRequest |     request: HttpRequest | ||||||
|  |  | ||||||
|     identifier: str |     identifier: str | ||||||
|  |  | ||||||
|     connection_type: type[UserSourceConnection] = UserSourceConnection |     user_connection_type: type[UserSourceConnection] = UserSourceConnection | ||||||
|  |     group_connection_type: type[GroupSourceConnection] = GroupSourceConnection | ||||||
|  |  | ||||||
|     enroll_info: dict[str, Any] |     user_info: dict[str, Any] | ||||||
|     policy_context: dict[str, Any] |     policy_context: dict[str, Any] | ||||||
|  |     user_properties: dict[str, Any | dict[str, Any]] | ||||||
|  |     groups_properties: dict[str, dict[str, Any | dict[str, Any]]] | ||||||
|  |  | ||||||
|     def __init__( |     def __init__( | ||||||
|         self, |         self, | ||||||
|         source: Source, |         source: Source, | ||||||
|         request: HttpRequest, |         request: HttpRequest, | ||||||
|         identifier: str, |         identifier: str, | ||||||
|         enroll_info: dict[str, Any], |         user_info: dict[str, Any], | ||||||
|  |         policy_context: dict[str, Any], | ||||||
|     ) -> None: |     ) -> None: | ||||||
|         self.source = source |         self.source = source | ||||||
|  |         self.mapper = SourceMapper(self.source) | ||||||
|  |         self.matcher = SourceMatcher( | ||||||
|  |             self.source, self.user_connection_type, self.group_connection_type | ||||||
|  |         ) | ||||||
|         self.request = request |         self.request = request | ||||||
|         self.identifier = identifier |         self.identifier = identifier | ||||||
|         self.enroll_info = enroll_info |         self.user_info = user_info | ||||||
|         self._logger = get_logger().bind(source=source, identifier=identifier) |         self._logger = get_logger().bind(source=source, identifier=identifier) | ||||||
|         self.policy_context = {} |         self.policy_context = policy_context | ||||||
|  |  | ||||||
|  |         self.user_properties = self.mapper.build_object_properties( | ||||||
|  |             object_type=User, request=request, user=None, **self.user_info | ||||||
|  |         ) | ||||||
|  |         self.groups_properties = { | ||||||
|  |             group_id: self.mapper.build_object_properties( | ||||||
|  |                 object_type=Group, | ||||||
|  |                 request=request, | ||||||
|  |                 user=None, | ||||||
|  |                 group_id=group_id, | ||||||
|  |                 **self.user_info, | ||||||
|  |             ) | ||||||
|  |             for group_id in self.user_properties.setdefault("groups", []) | ||||||
|  |         } | ||||||
|  |         del self.user_properties["groups"] | ||||||
|  |  | ||||||
|     def get_action(self, **kwargs) -> tuple[Action, UserSourceConnection | None]:  # noqa: PLR0911 |     def get_action(self, **kwargs) -> tuple[Action, UserSourceConnection | None]:  # noqa: PLR0911 | ||||||
|         """decide which action should be taken""" |         """decide which action should be taken""" | ||||||
|         new_connection = self.connection_type(source=self.source, identifier=self.identifier) |  | ||||||
|         # When request is authenticated, always link |         # When request is authenticated, always link | ||||||
|         if self.request.user.is_authenticated: |         if self.request.user.is_authenticated: | ||||||
|  |             new_connection = self.user_connection_type( | ||||||
|  |                 source=self.source, identifier=self.identifier | ||||||
|  |             ) | ||||||
|             new_connection.user = self.request.user |             new_connection.user = self.request.user | ||||||
|             new_connection = self.update_connection(new_connection, **kwargs) |             new_connection = self.update_user_connection(new_connection, **kwargs) | ||||||
|             return Action.LINK, new_connection |             return Action.LINK, new_connection | ||||||
|  |  | ||||||
|         existing_connections = self.connection_type.objects.filter( |         action, connection = self.matcher.get_user_action(self.identifier, self.user_properties) | ||||||
|             source=self.source, identifier=self.identifier |         if connection: | ||||||
|         ) |             connection = self.update_user_connection(connection, **kwargs) | ||||||
|         if existing_connections.exists(): |         return action, connection | ||||||
|             connection = existing_connections.first() |  | ||||||
|             return Action.AUTH, self.update_connection(connection, **kwargs) |  | ||||||
|         # No connection exists, but we match on identifier, so enroll |  | ||||||
|         if self.source.user_matching_mode == SourceUserMatchingModes.IDENTIFIER: |  | ||||||
|             # We don't save the connection here cause it doesn't have a user assigned yet |  | ||||||
|             return Action.ENROLL, self.update_connection(new_connection, **kwargs) |  | ||||||
|  |  | ||||||
|         # Check for existing users with matching attributes |     def update_user_connection( | ||||||
|         query = Q() |  | ||||||
|         # Either query existing user based on email or username |  | ||||||
|         if self.source.user_matching_mode in [ |  | ||||||
|             SourceUserMatchingModes.EMAIL_LINK, |  | ||||||
|             SourceUserMatchingModes.EMAIL_DENY, |  | ||||||
|         ]: |  | ||||||
|             if not self.enroll_info.get("email", None): |  | ||||||
|                 self._logger.warning("Refusing to use none email", source=self.source) |  | ||||||
|                 return Action.DENY, None |  | ||||||
|             query = Q(email__exact=self.enroll_info.get("email", None)) |  | ||||||
|         if self.source.user_matching_mode in [ |  | ||||||
|             SourceUserMatchingModes.USERNAME_LINK, |  | ||||||
|             SourceUserMatchingModes.USERNAME_DENY, |  | ||||||
|         ]: |  | ||||||
|             if not self.enroll_info.get("username", None): |  | ||||||
|                 self._logger.warning("Refusing to use none username", source=self.source) |  | ||||||
|                 return Action.DENY, None |  | ||||||
|             query = Q(username__exact=self.enroll_info.get("username", None)) |  | ||||||
|         self._logger.debug("trying to link with existing user", query=query) |  | ||||||
|         matching_users = User.objects.filter(query) |  | ||||||
|         # No matching users, always enroll |  | ||||||
|         if not matching_users.exists(): |  | ||||||
|             self._logger.debug("no matching users found, enrolling") |  | ||||||
|             return Action.ENROLL, self.update_connection(new_connection, **kwargs) |  | ||||||
|  |  | ||||||
|         user = matching_users.first() |  | ||||||
|         if self.source.user_matching_mode in [ |  | ||||||
|             SourceUserMatchingModes.EMAIL_LINK, |  | ||||||
|             SourceUserMatchingModes.USERNAME_LINK, |  | ||||||
|         ]: |  | ||||||
|             new_connection.user = user |  | ||||||
|             new_connection = self.update_connection(new_connection, **kwargs) |  | ||||||
|             return Action.LINK, new_connection |  | ||||||
|         if self.source.user_matching_mode in [ |  | ||||||
|             SourceUserMatchingModes.EMAIL_DENY, |  | ||||||
|             SourceUserMatchingModes.USERNAME_DENY, |  | ||||||
|         ]: |  | ||||||
|             self._logger.info("denying source because user exists", user=user) |  | ||||||
|             return Action.DENY, None |  | ||||||
|         # Should never get here as default enroll case is returned above. |  | ||||||
|         return Action.DENY, None  # pragma: no cover |  | ||||||
|  |  | ||||||
|     def update_connection( |  | ||||||
|         self, connection: UserSourceConnection, **kwargs |         self, connection: UserSourceConnection, **kwargs | ||||||
|     ) -> UserSourceConnection:  # pragma: no cover |     ) -> UserSourceConnection:  # pragma: no cover | ||||||
|         """Optionally make changes to the connection after it is looked up/created.""" |         """Optionally make changes to the user connection after it is looked up/created.""" | ||||||
|         return connection |         return connection | ||||||
|  |  | ||||||
|     def get_flow(self, **kwargs) -> HttpResponse: |     def get_flow(self, **kwargs) -> HttpResponse: | ||||||
| @ -215,25 +195,31 @@ class SourceFlowManager: | |||||||
|         flow: Flow | None, |         flow: Flow | None, | ||||||
|         connection: UserSourceConnection, |         connection: UserSourceConnection, | ||||||
|         stages: list[StageView] | None = None, |         stages: list[StageView] | None = None, | ||||||
|         **kwargs, |         **flow_context, | ||||||
|     ) -> HttpResponse: |     ) -> HttpResponse: | ||||||
|         """Prepare Authentication Plan, redirect user FlowExecutor""" |         """Prepare Authentication Plan, redirect user FlowExecutor""" | ||||||
|         kwargs.update( |         # Ensure redirect is carried through when user was trying to | ||||||
|  |         # authorize application | ||||||
|  |         final_redirect = self.request.session.get(SESSION_KEY_GET, {}).get( | ||||||
|  |             NEXT_ARG_NAME, "authentik_core:if-user" | ||||||
|  |         ) | ||||||
|  |         flow_context.update( | ||||||
|             { |             { | ||||||
|                 # Since we authenticate the user by their token, they have no backend set |                 # Since we authenticate the user by their token, they have no backend set | ||||||
|                 PLAN_CONTEXT_AUTHENTICATION_BACKEND: BACKEND_INBUILT, |                 PLAN_CONTEXT_AUTHENTICATION_BACKEND: BACKEND_INBUILT, | ||||||
|                 PLAN_CONTEXT_SSO: True, |                 PLAN_CONTEXT_SSO: True, | ||||||
|                 PLAN_CONTEXT_SOURCE: self.source, |                 PLAN_CONTEXT_SOURCE: self.source, | ||||||
|                 PLAN_CONTEXT_SOURCES_CONNECTION: connection, |                 PLAN_CONTEXT_SOURCES_CONNECTION: connection, | ||||||
|  |                 PLAN_CONTEXT_SOURCE_GROUPS: self.groups_properties, | ||||||
|             } |             } | ||||||
|         ) |         ) | ||||||
|         kwargs.update(self.policy_context) |         flow_context.update(self.policy_context) | ||||||
|         if SESSION_KEY_OVERRIDE_FLOW_TOKEN in self.request.session: |         if SESSION_KEY_OVERRIDE_FLOW_TOKEN in self.request.session: | ||||||
|             token: FlowToken = self.request.session.get(SESSION_KEY_OVERRIDE_FLOW_TOKEN) |             token: FlowToken = self.request.session.get(SESSION_KEY_OVERRIDE_FLOW_TOKEN) | ||||||
|             self._logger.info("Replacing source flow with overridden flow", flow=token.flow.slug) |             self._logger.info("Replacing source flow with overridden flow", flow=token.flow.slug) | ||||||
|             plan = token.plan |             plan = token.plan | ||||||
|             plan.context[PLAN_CONTEXT_IS_RESTORED] = token |             plan.context[PLAN_CONTEXT_IS_RESTORED] = token | ||||||
|             plan.context.update(kwargs) |             plan.context.update(flow_context) | ||||||
|             for stage in self.get_stages_to_append(flow): |             for stage in self.get_stages_to_append(flow): | ||||||
|                 plan.append_stage(stage) |                 plan.append_stage(stage) | ||||||
|             if stages: |             if stages: | ||||||
| @ -252,8 +238,8 @@ class SourceFlowManager: | |||||||
|         final_redirect = self.request.session.get(SESSION_KEY_GET, {}).get( |         final_redirect = self.request.session.get(SESSION_KEY_GET, {}).get( | ||||||
|             NEXT_ARG_NAME, "authentik_core:if-user" |             NEXT_ARG_NAME, "authentik_core:if-user" | ||||||
|         ) |         ) | ||||||
|         if PLAN_CONTEXT_REDIRECT not in kwargs: |         if PLAN_CONTEXT_REDIRECT not in flow_context: | ||||||
|             kwargs[PLAN_CONTEXT_REDIRECT] = final_redirect |             flow_context[PLAN_CONTEXT_REDIRECT] = final_redirect | ||||||
|  |  | ||||||
|         if not flow: |         if not flow: | ||||||
|             return bad_request_message( |             return bad_request_message( | ||||||
| @ -265,9 +251,12 @@ class SourceFlowManager: | |||||||
|         # We append some stages so the initial flow we get might be empty |         # We append some stages so the initial flow we get might be empty | ||||||
|         planner.allow_empty_flows = True |         planner.allow_empty_flows = True | ||||||
|         planner.use_cache = False |         planner.use_cache = False | ||||||
|         plan = planner.plan(self.request, kwargs) |         plan = planner.plan(self.request, flow_context) | ||||||
|         for stage in self.get_stages_to_append(flow): |         for stage in self.get_stages_to_append(flow): | ||||||
|             plan.append_stage(stage) |             plan.append_stage(stage) | ||||||
|  |         plan.append_stage( | ||||||
|  |             in_memory_stage(GroupUpdateStage, group_connection_type=self.group_connection_type) | ||||||
|  |         ) | ||||||
|         if stages: |         if stages: | ||||||
|             for stage in stages: |             for stage in stages: | ||||||
|                 plan.append_stage(stage) |                 plan.append_stage(stage) | ||||||
| @ -283,7 +272,6 @@ class SourceFlowManager: | |||||||
|         connection: UserSourceConnection, |         connection: UserSourceConnection, | ||||||
|     ) -> HttpResponse: |     ) -> HttpResponse: | ||||||
|         """Login user and redirect.""" |         """Login user and redirect.""" | ||||||
|         flow_kwargs = {PLAN_CONTEXT_PENDING_USER: connection.user} |  | ||||||
|         return self._prepare_flow( |         return self._prepare_flow( | ||||||
|             self.source.authentication_flow, |             self.source.authentication_flow, | ||||||
|             connection, |             connection, | ||||||
| @ -297,7 +285,11 @@ class SourceFlowManager: | |||||||
|                     ), |                     ), | ||||||
|                 ) |                 ) | ||||||
|             ], |             ], | ||||||
|             **flow_kwargs, |             **{ | ||||||
|  |                 PLAN_CONTEXT_PENDING_USER: connection.user, | ||||||
|  |                 PLAN_CONTEXT_PROMPT: delete_none_values(self.user_properties), | ||||||
|  |                 PLAN_CONTEXT_USER_PATH: self.source.get_user_path(), | ||||||
|  |             }, | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     def handle_existing_link( |     def handle_existing_link( | ||||||
| @ -354,7 +346,66 @@ class SourceFlowManager: | |||||||
|                 ) |                 ) | ||||||
|             ], |             ], | ||||||
|             **{ |             **{ | ||||||
|                 PLAN_CONTEXT_PROMPT: delete_none_values(self.enroll_info), |                 PLAN_CONTEXT_PROMPT: delete_none_values(self.user_properties), | ||||||
|                 PLAN_CONTEXT_USER_PATH: self.source.get_user_path(), |                 PLAN_CONTEXT_USER_PATH: self.source.get_user_path(), | ||||||
|             }, |             }, | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class GroupUpdateStage(StageView): | ||||||
|  |     """Dynamically injected stage which updates the user after enrollment/authentication.""" | ||||||
|  |  | ||||||
|  |     def handle_group( | ||||||
|  |         self, group_id: str, group_properties: dict[str, Any | dict[str, Any]] | ||||||
|  |     ) -> Group | None: | ||||||
|  |         action, connection = self.matcher.get_group_action(group_id, group_properties) | ||||||
|  |         if action == Action.ENROLL: | ||||||
|  |             group = Group.objects.create(**group_properties) | ||||||
|  |             connection.group = group | ||||||
|  |             connection.save() | ||||||
|  |             return group | ||||||
|  |         elif action in (Action.LINK, Action.AUTH): | ||||||
|  |             group = connection.group | ||||||
|  |             group.update_attributes(group_properties) | ||||||
|  |             connection.save() | ||||||
|  |             return group | ||||||
|  |  | ||||||
|  |         return None | ||||||
|  |  | ||||||
|  |     def handle_groups(self) -> bool: | ||||||
|  |         self.source: Source = self.executor.plan.context[PLAN_CONTEXT_SOURCE] | ||||||
|  |         self.user: User = self.executor.plan.context[PLAN_CONTEXT_PENDING_USER] | ||||||
|  |         self.group_connection_type: GroupSourceConnection = ( | ||||||
|  |             self.executor.current_stage.group_connection_type | ||||||
|  |         ) | ||||||
|  |         self.matcher = SourceMatcher(self.source, None, self.group_connection_type) | ||||||
|  |  | ||||||
|  |         raw_groups: dict[str, dict[str, Any | dict[str, Any]]] = self.executor.plan.context[ | ||||||
|  |             PLAN_CONTEXT_SOURCE_GROUPS | ||||||
|  |         ] | ||||||
|  |         groups: list[Group] = [] | ||||||
|  |  | ||||||
|  |         for group_id, group_properties in raw_groups.items(): | ||||||
|  |             group = self.handle_group(group_id, group_properties) | ||||||
|  |             if not group: | ||||||
|  |                 return False | ||||||
|  |             groups.append(group) | ||||||
|  |  | ||||||
|  |         with transaction.atomic(): | ||||||
|  |             self.user.ak_groups.remove( | ||||||
|  |                 *self.user.ak_groups.filter(groupsourceconnection__source=self.source) | ||||||
|  |             ) | ||||||
|  |             self.user.ak_groups.add(*groups) | ||||||
|  |  | ||||||
|  |         return True | ||||||
|  |  | ||||||
|  |     def get(self, request: HttpRequest, *args, **kwargs) -> HttpResponse: | ||||||
|  |         """Stage used after the user has been enrolled to sync their groups from source data""" | ||||||
|  |         if self.handle_groups(): | ||||||
|  |             return self.executor.stage_ok() | ||||||
|  |         else: | ||||||
|  |             return self.executor.stage_invalid("Failed to update groups. Please try again later.") | ||||||
|  |  | ||||||
|  |     def post(self, request: HttpRequest) -> HttpResponse: | ||||||
|  |         """Wrapper for post requests""" | ||||||
|  |         return self.get(request) | ||||||
|  | |||||||
							
								
								
									
										103
									
								
								authentik/core/sources/mapper.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										103
									
								
								authentik/core/sources/mapper.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,103 @@ | |||||||
|  | from typing import Any | ||||||
|  |  | ||||||
|  | from django.http import HttpRequest | ||||||
|  | from structlog.stdlib import get_logger | ||||||
|  |  | ||||||
|  | from authentik.core.expression.exceptions import PropertyMappingExpressionException | ||||||
|  | from authentik.core.models import Group, PropertyMapping, Source, User | ||||||
|  | from authentik.events.models import Event, EventAction | ||||||
|  | from authentik.lib.merge import MERGE_LIST_UNIQUE | ||||||
|  | from authentik.lib.sync.mapper import PropertyMappingManager | ||||||
|  | from authentik.policies.utils import delete_none_values | ||||||
|  |  | ||||||
|  | LOGGER = get_logger() | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class SourceMapper: | ||||||
|  |     def __init__(self, source: Source): | ||||||
|  |         self.source = source | ||||||
|  |  | ||||||
|  |     def get_manager( | ||||||
|  |         self, object_type: type[User | Group], context_keys: list[str] | ||||||
|  |     ) -> PropertyMappingManager: | ||||||
|  |         """Get property mapping manager for this source.""" | ||||||
|  |  | ||||||
|  |         qs = PropertyMapping.objects.none() | ||||||
|  |         if object_type == User: | ||||||
|  |             qs = self.source.user_property_mappings.all().select_subclasses() | ||||||
|  |         elif object_type == Group: | ||||||
|  |             qs = self.source.group_property_mappings.all().select_subclasses() | ||||||
|  |         qs = qs.order_by("name") | ||||||
|  |         return PropertyMappingManager( | ||||||
|  |             qs, | ||||||
|  |             self.source.property_mapping_type, | ||||||
|  |             ["source", "properties"] + context_keys, | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |     def get_base_properties( | ||||||
|  |         self, object_type: type[User | Group], **kwargs | ||||||
|  |     ) -> dict[str, Any | dict[str, Any]]: | ||||||
|  |         """Get base properties for a user or a group to build final properties upon.""" | ||||||
|  |         if object_type == User: | ||||||
|  |             properties = self.source.get_base_user_properties(**kwargs) | ||||||
|  |             properties.setdefault("path", self.source.get_user_path()) | ||||||
|  |             return properties | ||||||
|  |         if object_type == Group: | ||||||
|  |             return self.source.get_base_group_properties(**kwargs) | ||||||
|  |         return {} | ||||||
|  |  | ||||||
|  |     def build_object_properties( | ||||||
|  |         self, | ||||||
|  |         object_type: type[User | Group], | ||||||
|  |         manager: "PropertyMappingManager | None" = None, | ||||||
|  |         user: User | None = None, | ||||||
|  |         request: HttpRequest | None = None, | ||||||
|  |         **kwargs, | ||||||
|  |     ) -> dict[str, Any | dict[str, Any]]: | ||||||
|  |         """Build a user or group properties from the source configured property mappings.""" | ||||||
|  |  | ||||||
|  |         properties = self.get_base_properties(object_type, **kwargs) | ||||||
|  |         if "attributes" not in properties: | ||||||
|  |             properties["attributes"] = {} | ||||||
|  |  | ||||||
|  |         if not manager: | ||||||
|  |             manager = self.get_manager(object_type, list(kwargs.keys())) | ||||||
|  |         evaluations = manager.iter_eval( | ||||||
|  |             user=user, | ||||||
|  |             request=request, | ||||||
|  |             return_mapping=True, | ||||||
|  |             source=self.source, | ||||||
|  |             properties=properties, | ||||||
|  |             **kwargs, | ||||||
|  |         ) | ||||||
|  |         while True: | ||||||
|  |             try: | ||||||
|  |                 value, mapping = next(evaluations) | ||||||
|  |             except StopIteration: | ||||||
|  |                 break | ||||||
|  |             except PropertyMappingExpressionException as exc: | ||||||
|  |                 Event.new( | ||||||
|  |                     EventAction.CONFIGURATION_ERROR, | ||||||
|  |                     message=f"Failed to evaluate property mapping: '{exc.mapping.name}'", | ||||||
|  |                     source=self, | ||||||
|  |                     mapping=exc.mapping, | ||||||
|  |                 ).save() | ||||||
|  |                 LOGGER.warning( | ||||||
|  |                     "Mapping failed to evaluate", | ||||||
|  |                     exc=exc, | ||||||
|  |                     source=self, | ||||||
|  |                     mapping=exc.mapping, | ||||||
|  |                 ) | ||||||
|  |                 raise exc | ||||||
|  |  | ||||||
|  |             if not value or not isinstance(value, dict): | ||||||
|  |                 LOGGER.debug( | ||||||
|  |                     "Mapping evaluated to None or is not a dict. Skipping", | ||||||
|  |                     source=self, | ||||||
|  |                     mapping=mapping, | ||||||
|  |                 ) | ||||||
|  |                 continue | ||||||
|  |  | ||||||
|  |             MERGE_LIST_UNIQUE.merge(properties, value) | ||||||
|  |  | ||||||
|  |         return delete_none_values(properties) | ||||||
							
								
								
									
										152
									
								
								authentik/core/sources/matcher.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										152
									
								
								authentik/core/sources/matcher.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,152 @@ | |||||||
|  | """Source user and group matching""" | ||||||
|  |  | ||||||
|  | from dataclasses import dataclass | ||||||
|  | from enum import Enum | ||||||
|  | from typing import Any | ||||||
|  |  | ||||||
|  | from django.db.models import Q | ||||||
|  | from structlog import get_logger | ||||||
|  |  | ||||||
|  | from authentik.core.models import ( | ||||||
|  |     Group, | ||||||
|  |     GroupSourceConnection, | ||||||
|  |     Source, | ||||||
|  |     SourceGroupMatchingModes, | ||||||
|  |     SourceUserMatchingModes, | ||||||
|  |     User, | ||||||
|  |     UserSourceConnection, | ||||||
|  | ) | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Action(Enum): | ||||||
|  |     """Actions that can be decided based on the request and source settings""" | ||||||
|  |  | ||||||
|  |     LINK = "link" | ||||||
|  |     AUTH = "auth" | ||||||
|  |     ENROLL = "enroll" | ||||||
|  |     DENY = "deny" | ||||||
|  |  | ||||||
|  |  | ||||||
|  | @dataclass | ||||||
|  | class MatchableProperty: | ||||||
|  |     property: str | ||||||
|  |     link_mode: SourceUserMatchingModes | SourceGroupMatchingModes | ||||||
|  |     deny_mode: SourceUserMatchingModes | SourceGroupMatchingModes | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class SourceMatcher: | ||||||
|  |     def __init__( | ||||||
|  |         self, | ||||||
|  |         source: Source, | ||||||
|  |         user_connection_type: type[UserSourceConnection], | ||||||
|  |         group_connection_type: type[GroupSourceConnection], | ||||||
|  |     ): | ||||||
|  |         self.source = source | ||||||
|  |         self.user_connection_type = user_connection_type | ||||||
|  |         self.group_connection_type = group_connection_type | ||||||
|  |         self._logger = get_logger().bind(source=self.source) | ||||||
|  |  | ||||||
|  |     def get_action( | ||||||
|  |         self, | ||||||
|  |         object_type: type[User | Group], | ||||||
|  |         matchable_properties: list[MatchableProperty], | ||||||
|  |         identifier: str, | ||||||
|  |         properties: dict[str, Any | dict[str, Any]], | ||||||
|  |     ) -> tuple[Action, UserSourceConnection | GroupSourceConnection | None]: | ||||||
|  |         connection_type = None | ||||||
|  |         matching_mode = None | ||||||
|  |         identifier_matching_mode = None | ||||||
|  |         if object_type == User: | ||||||
|  |             connection_type = self.user_connection_type | ||||||
|  |             matching_mode = self.source.user_matching_mode | ||||||
|  |             identifier_matching_mode = SourceUserMatchingModes.IDENTIFIER | ||||||
|  |         if object_type == Group: | ||||||
|  |             connection_type = self.group_connection_type | ||||||
|  |             matching_mode = self.source.group_matching_mode | ||||||
|  |             identifier_matching_mode = SourceGroupMatchingModes.IDENTIFIER | ||||||
|  |         if not connection_type or not matching_mode or not identifier_matching_mode: | ||||||
|  |             return Action.DENY, None | ||||||
|  |  | ||||||
|  |         new_connection = connection_type(source=self.source, identifier=identifier) | ||||||
|  |  | ||||||
|  |         existing_connections = connection_type.objects.filter( | ||||||
|  |             source=self.source, identifier=identifier | ||||||
|  |         ) | ||||||
|  |         if existing_connections.exists(): | ||||||
|  |             return Action.AUTH, existing_connections.first() | ||||||
|  |         # No connection exists, but we match on identifier, so enroll | ||||||
|  |         if matching_mode == identifier_matching_mode: | ||||||
|  |             # We don't save the connection here cause it doesn't have a user/group assigned yet | ||||||
|  |             return Action.ENROLL, new_connection | ||||||
|  |  | ||||||
|  |         # Check for existing users with matching attributes | ||||||
|  |         query = Q() | ||||||
|  |         for matchable_property in matchable_properties: | ||||||
|  |             property = matchable_property.property | ||||||
|  |             if matching_mode in [matchable_property.link_mode, matchable_property.deny_mode]: | ||||||
|  |                 if not properties.get(property, None): | ||||||
|  |                     self._logger.warning( | ||||||
|  |                         "Refusing to use none property", identifier=identifier, property=property | ||||||
|  |                     ) | ||||||
|  |                     return Action.DENY, None | ||||||
|  |                 query_args = { | ||||||
|  |                     f"{property}__exact": properties[property], | ||||||
|  |                 } | ||||||
|  |                 query = Q(**query_args) | ||||||
|  |         self._logger.debug( | ||||||
|  |             "Trying to link with existing object", query=query, identifier=identifier | ||||||
|  |         ) | ||||||
|  |         matching_objects = object_type.objects.filter(query) | ||||||
|  |         # Not matching objects, always enroll | ||||||
|  |         if not matching_objects.exists(): | ||||||
|  |             self._logger.debug("No matching objects found, enrolling") | ||||||
|  |             return Action.ENROLL, new_connection | ||||||
|  |  | ||||||
|  |         obj = matching_objects.first() | ||||||
|  |         if matching_mode in [mp.link_mode for mp in matchable_properties]: | ||||||
|  |             attr = None | ||||||
|  |             if object_type == User: | ||||||
|  |                 attr = "user" | ||||||
|  |             if object_type == Group: | ||||||
|  |                 attr = "group" | ||||||
|  |             setattr(new_connection, attr, obj) | ||||||
|  |             return Action.LINK, new_connection | ||||||
|  |         if matching_mode in [mp.deny_mode for mp in matchable_properties]: | ||||||
|  |             self._logger.info("Denying source because object exists", obj=obj) | ||||||
|  |             return Action.DENY, None | ||||||
|  |  | ||||||
|  |         # Should never get here as default enroll case is returned above. | ||||||
|  |         return Action.DENY, None  # pragma: no cover | ||||||
|  |  | ||||||
|  |     def get_user_action( | ||||||
|  |         self, identifier: str, properties: dict[str, Any | dict[str, Any]] | ||||||
|  |     ) -> tuple[Action, UserSourceConnection | None]: | ||||||
|  |         return self.get_action( | ||||||
|  |             User, | ||||||
|  |             [ | ||||||
|  |                 MatchableProperty( | ||||||
|  |                     "username", | ||||||
|  |                     SourceUserMatchingModes.USERNAME_LINK, | ||||||
|  |                     SourceUserMatchingModes.USERNAME_DENY, | ||||||
|  |                 ), | ||||||
|  |                 MatchableProperty( | ||||||
|  |                     "email", SourceUserMatchingModes.EMAIL_LINK, SourceUserMatchingModes.EMAIL_DENY | ||||||
|  |                 ), | ||||||
|  |             ], | ||||||
|  |             identifier, | ||||||
|  |             properties, | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |     def get_group_action( | ||||||
|  |         self, identifier: str, properties: dict[str, Any | dict[str, Any]] | ||||||
|  |     ) -> tuple[Action, GroupSourceConnection | None]: | ||||||
|  |         return self.get_action( | ||||||
|  |             Group, | ||||||
|  |             [ | ||||||
|  |                 MatchableProperty( | ||||||
|  |                     "name", SourceGroupMatchingModes.NAME_LINK, SourceGroupMatchingModes.NAME_DENY | ||||||
|  |                 ), | ||||||
|  |             ], | ||||||
|  |             identifier, | ||||||
|  |             properties, | ||||||
|  |         ) | ||||||
| @ -4,7 +4,7 @@ | |||||||
|  |  | ||||||
| <!DOCTYPE html> | <!DOCTYPE html> | ||||||
|  |  | ||||||
| <html lang="en"> | <html> | ||||||
|     <head> |     <head> | ||||||
|         <meta charset="UTF-8"> |         <meta charset="UTF-8"> | ||||||
|         <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> |         <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> | ||||||
|  | |||||||
| @ -1,43 +0,0 @@ | |||||||
| {% extends 'login/base_full.html' %} |  | ||||||
|  |  | ||||||
| {% load static %} |  | ||||||
| {% load i18n %} |  | ||||||
|  |  | ||||||
| {% block title %} |  | ||||||
| {% trans 'End session' %} - {{ brand.branding_title }} |  | ||||||
| {% endblock %} |  | ||||||
|  |  | ||||||
| {% block card_title %} |  | ||||||
| {% blocktrans with application=application.name %} |  | ||||||
| You've logged out of {{ application }}. |  | ||||||
| {% endblocktrans %} |  | ||||||
| {% endblock %} |  | ||||||
|  |  | ||||||
| {% block card %} |  | ||||||
| <form method="POST" class="pf-c-form"> |  | ||||||
|     <p> |  | ||||||
|         {% blocktrans with application=application.name branding_title=brand.branding_title %} |  | ||||||
|             You've logged out of {{ application }}. You can go back to the overview to launch another application, or log out of your {{ branding_title }} account. |  | ||||||
|         {% endblocktrans %} |  | ||||||
|     </p> |  | ||||||
|  |  | ||||||
|     <a id="ak-back-home" href="{% url 'authentik_core:root-redirect' %}" class="pf-c-button pf-m-primary"> |  | ||||||
|         {% trans 'Go back to overview' %} |  | ||||||
|     </a> |  | ||||||
|  |  | ||||||
|     <a id="logout" href="{% url 'authentik_flows:default-invalidation' %}" class="pf-c-button pf-m-secondary"> |  | ||||||
|         {% blocktrans with branding_title=brand.branding_title %} |  | ||||||
|             Log out of {{ branding_title }} |  | ||||||
|         {% endblocktrans %} |  | ||||||
|     </a> |  | ||||||
|  |  | ||||||
|     {% if application.get_launch_url %} |  | ||||||
|     <a href="{{ application.get_launch_url }}" class="pf-c-button pf-m-secondary"> |  | ||||||
|         {% blocktrans with application=application.name %} |  | ||||||
|             Log back into {{ application }} |  | ||||||
|         {% endblocktrans %} |  | ||||||
|     </a> |  | ||||||
|     {% endif %} |  | ||||||
|  |  | ||||||
| </form> |  | ||||||
| {% endblock %} |  | ||||||
| @ -9,9 +9,12 @@ from rest_framework.test import APITestCase | |||||||
|  |  | ||||||
| from authentik.core.models import Application | from authentik.core.models import Application | ||||||
| from authentik.core.tests.utils import create_test_admin_user, create_test_flow | from authentik.core.tests.utils import create_test_admin_user, create_test_flow | ||||||
|  | from authentik.lib.generators import generate_id | ||||||
| from authentik.policies.dummy.models import DummyPolicy | from authentik.policies.dummy.models import DummyPolicy | ||||||
| from authentik.policies.models import PolicyBinding | from authentik.policies.models import PolicyBinding | ||||||
| from authentik.providers.oauth2.models import OAuth2Provider | from authentik.providers.oauth2.models import OAuth2Provider | ||||||
|  | from authentik.providers.proxy.models import ProxyProvider | ||||||
|  | from authentik.providers.saml.models import SAMLProvider | ||||||
|  |  | ||||||
|  |  | ||||||
| class TestApplicationsAPI(APITestCase): | class TestApplicationsAPI(APITestCase): | ||||||
| @ -131,6 +134,7 @@ class TestApplicationsAPI(APITestCase): | |||||||
|                             "assigned_application_name": "allowed", |                             "assigned_application_name": "allowed", | ||||||
|                             "assigned_application_slug": "allowed", |                             "assigned_application_slug": "allowed", | ||||||
|                             "authentication_flow": None, |                             "authentication_flow": None, | ||||||
|  |                             "invalidation_flow": None, | ||||||
|                             "authorization_flow": str(self.provider.authorization_flow.pk), |                             "authorization_flow": str(self.provider.authorization_flow.pk), | ||||||
|                             "component": "ak-provider-oauth2-form", |                             "component": "ak-provider-oauth2-form", | ||||||
|                             "meta_model_name": "authentik_providers_oauth2.oauth2provider", |                             "meta_model_name": "authentik_providers_oauth2.oauth2provider", | ||||||
| @ -183,6 +187,7 @@ class TestApplicationsAPI(APITestCase): | |||||||
|                             "assigned_application_name": "allowed", |                             "assigned_application_name": "allowed", | ||||||
|                             "assigned_application_slug": "allowed", |                             "assigned_application_slug": "allowed", | ||||||
|                             "authentication_flow": None, |                             "authentication_flow": None, | ||||||
|  |                             "invalidation_flow": None, | ||||||
|                             "authorization_flow": str(self.provider.authorization_flow.pk), |                             "authorization_flow": str(self.provider.authorization_flow.pk), | ||||||
|                             "component": "ak-provider-oauth2-form", |                             "component": "ak-provider-oauth2-form", | ||||||
|                             "meta_model_name": "authentik_providers_oauth2.oauth2provider", |                             "meta_model_name": "authentik_providers_oauth2.oauth2provider", | ||||||
| @ -222,3 +227,31 @@ class TestApplicationsAPI(APITestCase): | |||||||
|                 ], |                 ], | ||||||
|             }, |             }, | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|  |     def test_get_provider(self): | ||||||
|  |         """Ensure that proxy providers (at the time of writing that is the only provider | ||||||
|  |         that inherits from another proxy type (OAuth) instead of inheriting from the root | ||||||
|  |         provider class) is correctly looked up and selected from the database""" | ||||||
|  |         slug = generate_id() | ||||||
|  |         provider = ProxyProvider.objects.create(name=generate_id()) | ||||||
|  |         Application.objects.create( | ||||||
|  |             name=generate_id(), | ||||||
|  |             slug=slug, | ||||||
|  |             provider=provider, | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(Application.objects.get(slug=slug).get_provider(), provider) | ||||||
|  |         self.assertEqual( | ||||||
|  |             Application.objects.with_provider().get(slug=slug).get_provider(), provider | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |         slug = generate_id() | ||||||
|  |         provider = SAMLProvider.objects.create(name=generate_id()) | ||||||
|  |         Application.objects.create( | ||||||
|  |             name=generate_id(), | ||||||
|  |             slug=slug, | ||||||
|  |             provider=provider, | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(Application.objects.get(slug=slug).get_provider(), provider) | ||||||
|  |         self.assertEqual( | ||||||
|  |             Application.objects.with_provider().get(slug=slug).get_provider(), provider | ||||||
|  |         ) | ||||||
|  | |||||||
							
								
								
									
										59
									
								
								authentik/core/tests/test_devices_api.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										59
									
								
								authentik/core/tests/test_devices_api.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,59 @@ | |||||||
|  | """Test Devices API""" | ||||||
|  |  | ||||||
|  | from json import loads | ||||||
|  |  | ||||||
|  | from django.urls import reverse | ||||||
|  | from rest_framework.test import APITestCase | ||||||
|  |  | ||||||
|  | from authentik.core.tests.utils import create_test_admin_user, create_test_user | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class TestDevicesAPI(APITestCase): | ||||||
|  |     """Test applications API""" | ||||||
|  |  | ||||||
|  |     def setUp(self) -> None: | ||||||
|  |         self.admin = create_test_admin_user() | ||||||
|  |         self.user1 = create_test_user() | ||||||
|  |         self.device1 = self.user1.staticdevice_set.create() | ||||||
|  |         self.user2 = create_test_user() | ||||||
|  |         self.device2 = self.user2.staticdevice_set.create() | ||||||
|  |  | ||||||
|  |     def test_user_api(self): | ||||||
|  |         """Test user API""" | ||||||
|  |         self.client.force_login(self.user1) | ||||||
|  |         response = self.client.get( | ||||||
|  |             reverse( | ||||||
|  |                 "authentik_api:device-list", | ||||||
|  |             ) | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(response.status_code, 200) | ||||||
|  |         body = loads(response.content.decode()) | ||||||
|  |         self.assertEqual(len(body), 1) | ||||||
|  |         self.assertEqual(body[0]["pk"], str(self.device1.pk)) | ||||||
|  |  | ||||||
|  |     def test_user_api_as_admin(self): | ||||||
|  |         """Test user API""" | ||||||
|  |         self.client.force_login(self.admin) | ||||||
|  |         response = self.client.get( | ||||||
|  |             reverse( | ||||||
|  |                 "authentik_api:device-list", | ||||||
|  |             ) | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(response.status_code, 200) | ||||||
|  |         body = loads(response.content.decode()) | ||||||
|  |         self.assertEqual(len(body), 0) | ||||||
|  |  | ||||||
|  |     def test_admin_api(self): | ||||||
|  |         """Test admin API""" | ||||||
|  |         self.client.force_login(self.admin) | ||||||
|  |         response = self.client.get( | ||||||
|  |             reverse( | ||||||
|  |                 "authentik_api:admin-device-list", | ||||||
|  |             ) | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(response.status_code, 200) | ||||||
|  |         body = loads(response.content.decode()) | ||||||
|  |         self.assertEqual(len(body), 2) | ||||||
|  |         self.assertEqual( | ||||||
|  |             {body[0]["pk"], body[1]["pk"]}, {str(self.device1.pk), str(self.device2.pk)} | ||||||
|  |         ) | ||||||
| @ -3,10 +3,10 @@ | |||||||
| from json import loads | from json import loads | ||||||
|  |  | ||||||
| from django.urls import reverse | from django.urls import reverse | ||||||
|  | from guardian.shortcuts import assign_perm | ||||||
| from rest_framework.test import APITestCase | from rest_framework.test import APITestCase | ||||||
|  |  | ||||||
| from authentik.core.models import User | from authentik.core.tests.utils import create_test_admin_user, create_test_user | ||||||
| from authentik.core.tests.utils import create_test_admin_user |  | ||||||
| from authentik.tenants.utils import get_current_tenant | from authentik.tenants.utils import get_current_tenant | ||||||
|  |  | ||||||
|  |  | ||||||
| @ -15,7 +15,7 @@ class TestImpersonation(APITestCase): | |||||||
|  |  | ||||||
|     def setUp(self) -> None: |     def setUp(self) -> None: | ||||||
|         super().setUp() |         super().setUp() | ||||||
|         self.other_user = User.objects.create(username="to-impersonate") |         self.other_user = create_test_user() | ||||||
|         self.user = create_test_admin_user() |         self.user = create_test_admin_user() | ||||||
|  |  | ||||||
|     def test_impersonate_simple(self): |     def test_impersonate_simple(self): | ||||||
| @ -44,6 +44,46 @@ class TestImpersonation(APITestCase): | |||||||
|         self.assertEqual(response_body["user"]["username"], self.user.username) |         self.assertEqual(response_body["user"]["username"], self.user.username) | ||||||
|         self.assertNotIn("original", response_body) |         self.assertNotIn("original", response_body) | ||||||
|  |  | ||||||
|  |     def test_impersonate_global(self): | ||||||
|  |         """Test impersonation with global permissions""" | ||||||
|  |         new_user = create_test_user() | ||||||
|  |         assign_perm("authentik_core.impersonate", new_user) | ||||||
|  |         assign_perm("authentik_core.view_user", new_user) | ||||||
|  |         self.client.force_login(new_user) | ||||||
|  |  | ||||||
|  |         response = self.client.post( | ||||||
|  |             reverse( | ||||||
|  |                 "authentik_api:user-impersonate", | ||||||
|  |                 kwargs={"pk": self.other_user.pk}, | ||||||
|  |             ) | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(response.status_code, 201) | ||||||
|  |  | ||||||
|  |         response = self.client.get(reverse("authentik_api:user-me")) | ||||||
|  |         response_body = loads(response.content.decode()) | ||||||
|  |         self.assertEqual(response_body["user"]["username"], self.other_user.username) | ||||||
|  |         self.assertEqual(response_body["original"]["username"], new_user.username) | ||||||
|  |  | ||||||
|  |     def test_impersonate_scoped(self): | ||||||
|  |         """Test impersonation with scoped permissions""" | ||||||
|  |         new_user = create_test_user() | ||||||
|  |         assign_perm("authentik_core.impersonate", new_user, self.other_user) | ||||||
|  |         assign_perm("authentik_core.view_user", new_user, self.other_user) | ||||||
|  |         self.client.force_login(new_user) | ||||||
|  |  | ||||||
|  |         response = self.client.post( | ||||||
|  |             reverse( | ||||||
|  |                 "authentik_api:user-impersonate", | ||||||
|  |                 kwargs={"pk": self.other_user.pk}, | ||||||
|  |             ) | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(response.status_code, 201) | ||||||
|  |  | ||||||
|  |         response = self.client.get(reverse("authentik_api:user-me")) | ||||||
|  |         response_body = loads(response.content.decode()) | ||||||
|  |         self.assertEqual(response_body["user"]["username"], self.other_user.username) | ||||||
|  |         self.assertEqual(response_body["original"]["username"], new_user.username) | ||||||
|  |  | ||||||
|     def test_impersonate_denied(self): |     def test_impersonate_denied(self): | ||||||
|         """test impersonation without permissions""" |         """test impersonation without permissions""" | ||||||
|         self.client.force_login(self.other_user) |         self.client.force_login(self.other_user) | ||||||
|  | |||||||
| @ -38,7 +38,9 @@ class TestSourceFlowManager(TestCase): | |||||||
|     def test_unauthenticated_enroll(self): |     def test_unauthenticated_enroll(self): | ||||||
|         """Test un-authenticated user enrolling""" |         """Test un-authenticated user enrolling""" | ||||||
|         request = get_request("/", user=AnonymousUser()) |         request = get_request("/", user=AnonymousUser()) | ||||||
|         flow_manager = OAuthSourceFlowManager(self.source, request, self.identifier, {}) |         flow_manager = OAuthSourceFlowManager( | ||||||
|  |             self.source, request, self.identifier, {"info": {}}, {} | ||||||
|  |         ) | ||||||
|         action, _ = flow_manager.get_action() |         action, _ = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.ENROLL) |         self.assertEqual(action, Action.ENROLL) | ||||||
|         response = flow_manager.get_flow() |         response = flow_manager.get_flow() | ||||||
| @ -52,7 +54,9 @@ class TestSourceFlowManager(TestCase): | |||||||
|             user=get_anonymous_user(), source=self.source, identifier=self.identifier |             user=get_anonymous_user(), source=self.source, identifier=self.identifier | ||||||
|         ) |         ) | ||||||
|         request = get_request("/", user=AnonymousUser()) |         request = get_request("/", user=AnonymousUser()) | ||||||
|         flow_manager = OAuthSourceFlowManager(self.source, request, self.identifier, {}) |         flow_manager = OAuthSourceFlowManager( | ||||||
|  |             self.source, request, self.identifier, {"info": {}}, {} | ||||||
|  |         ) | ||||||
|         action, _ = flow_manager.get_action() |         action, _ = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.AUTH) |         self.assertEqual(action, Action.AUTH) | ||||||
|         response = flow_manager.get_flow() |         response = flow_manager.get_flow() | ||||||
| @ -64,7 +68,9 @@ class TestSourceFlowManager(TestCase): | |||||||
|         """Test authenticated user linking""" |         """Test authenticated user linking""" | ||||||
|         user = User.objects.create(username="foo", email="foo@bar.baz") |         user = User.objects.create(username="foo", email="foo@bar.baz") | ||||||
|         request = get_request("/", user=user) |         request = get_request("/", user=user) | ||||||
|         flow_manager = OAuthSourceFlowManager(self.source, request, self.identifier, {}) |         flow_manager = OAuthSourceFlowManager( | ||||||
|  |             self.source, request, self.identifier, {"info": {}}, {} | ||||||
|  |         ) | ||||||
|         action, connection = flow_manager.get_action() |         action, connection = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.LINK) |         self.assertEqual(action, Action.LINK) | ||||||
|         self.assertIsNone(connection.pk) |         self.assertIsNone(connection.pk) | ||||||
| @ -77,7 +83,9 @@ class TestSourceFlowManager(TestCase): | |||||||
|  |  | ||||||
|     def test_unauthenticated_link(self): |     def test_unauthenticated_link(self): | ||||||
|         """Test un-authenticated user linking""" |         """Test un-authenticated user linking""" | ||||||
|         flow_manager = OAuthSourceFlowManager(self.source, get_request("/"), self.identifier, {}) |         flow_manager = OAuthSourceFlowManager( | ||||||
|  |             self.source, get_request("/"), self.identifier, {"info": {}}, {} | ||||||
|  |         ) | ||||||
|         action, connection = flow_manager.get_action() |         action, connection = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.LINK) |         self.assertEqual(action, Action.LINK) | ||||||
|         self.assertIsNone(connection.pk) |         self.assertIsNone(connection.pk) | ||||||
| @ -90,7 +98,7 @@ class TestSourceFlowManager(TestCase): | |||||||
|  |  | ||||||
|         # Without email, deny |         # Without email, deny | ||||||
|         flow_manager = OAuthSourceFlowManager( |         flow_manager = OAuthSourceFlowManager( | ||||||
|             self.source, get_request("/", user=AnonymousUser()), self.identifier, {} |             self.source, get_request("/", user=AnonymousUser()), self.identifier, {"info": {}}, {} | ||||||
|         ) |         ) | ||||||
|         action, _ = flow_manager.get_action() |         action, _ = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.DENY) |         self.assertEqual(action, Action.DENY) | ||||||
| @ -100,7 +108,12 @@ class TestSourceFlowManager(TestCase): | |||||||
|             self.source, |             self.source, | ||||||
|             get_request("/", user=AnonymousUser()), |             get_request("/", user=AnonymousUser()), | ||||||
|             self.identifier, |             self.identifier, | ||||||
|             {"email": "foo@bar.baz"}, |             { | ||||||
|  |                 "info": { | ||||||
|  |                     "email": "foo@bar.baz", | ||||||
|  |                 }, | ||||||
|  |             }, | ||||||
|  |             {}, | ||||||
|         ) |         ) | ||||||
|         action, _ = flow_manager.get_action() |         action, _ = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.LINK) |         self.assertEqual(action, Action.LINK) | ||||||
| @ -113,7 +126,7 @@ class TestSourceFlowManager(TestCase): | |||||||
|  |  | ||||||
|         # Without username, deny |         # Without username, deny | ||||||
|         flow_manager = OAuthSourceFlowManager( |         flow_manager = OAuthSourceFlowManager( | ||||||
|             self.source, get_request("/", user=AnonymousUser()), self.identifier, {} |             self.source, get_request("/", user=AnonymousUser()), self.identifier, {"info": {}}, {} | ||||||
|         ) |         ) | ||||||
|         action, _ = flow_manager.get_action() |         action, _ = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.DENY) |         self.assertEqual(action, Action.DENY) | ||||||
| @ -123,7 +136,10 @@ class TestSourceFlowManager(TestCase): | |||||||
|             self.source, |             self.source, | ||||||
|             get_request("/", user=AnonymousUser()), |             get_request("/", user=AnonymousUser()), | ||||||
|             self.identifier, |             self.identifier, | ||||||
|             {"username": "foo"}, |             { | ||||||
|  |                 "info": {"username": "foo"}, | ||||||
|  |             }, | ||||||
|  |             {}, | ||||||
|         ) |         ) | ||||||
|         action, _ = flow_manager.get_action() |         action, _ = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.LINK) |         self.assertEqual(action, Action.LINK) | ||||||
| @ -140,8 +156,11 @@ class TestSourceFlowManager(TestCase): | |||||||
|             get_request("/", user=AnonymousUser()), |             get_request("/", user=AnonymousUser()), | ||||||
|             self.identifier, |             self.identifier, | ||||||
|             { |             { | ||||||
|                 "username": "bar", |                 "info": { | ||||||
|  |                     "username": "bar", | ||||||
|  |                 }, | ||||||
|             }, |             }, | ||||||
|  |             {}, | ||||||
|         ) |         ) | ||||||
|         action, _ = flow_manager.get_action() |         action, _ = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.ENROLL) |         self.assertEqual(action, Action.ENROLL) | ||||||
| @ -151,7 +170,10 @@ class TestSourceFlowManager(TestCase): | |||||||
|             self.source, |             self.source, | ||||||
|             get_request("/", user=AnonymousUser()), |             get_request("/", user=AnonymousUser()), | ||||||
|             self.identifier, |             self.identifier, | ||||||
|             {"username": "foo"}, |             { | ||||||
|  |                 "info": {"username": "foo"}, | ||||||
|  |             }, | ||||||
|  |             {}, | ||||||
|         ) |         ) | ||||||
|         action, _ = flow_manager.get_action() |         action, _ = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.DENY) |         self.assertEqual(action, Action.DENY) | ||||||
| @ -165,7 +187,10 @@ class TestSourceFlowManager(TestCase): | |||||||
|             self.source, |             self.source, | ||||||
|             get_request("/", user=AnonymousUser()), |             get_request("/", user=AnonymousUser()), | ||||||
|             self.identifier, |             self.identifier, | ||||||
|             {"username": "foo"}, |             { | ||||||
|  |                 "info": {"username": "foo"}, | ||||||
|  |             }, | ||||||
|  |             {}, | ||||||
|         ) |         ) | ||||||
|         action, _ = flow_manager.get_action() |         action, _ = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.ENROLL) |         self.assertEqual(action, Action.ENROLL) | ||||||
| @ -191,7 +216,10 @@ class TestSourceFlowManager(TestCase): | |||||||
|             self.source, |             self.source, | ||||||
|             get_request("/", user=AnonymousUser()), |             get_request("/", user=AnonymousUser()), | ||||||
|             self.identifier, |             self.identifier, | ||||||
|             {"username": "foo"}, |             { | ||||||
|  |                 "info": {"username": "foo"}, | ||||||
|  |             }, | ||||||
|  |             {}, | ||||||
|         ) |         ) | ||||||
|         action, _ = flow_manager.get_action() |         action, _ = flow_manager.get_action() | ||||||
|         self.assertEqual(action, Action.ENROLL) |         self.assertEqual(action, Action.ENROLL) | ||||||
|  | |||||||
| @ -0,0 +1,237 @@ | |||||||
|  | """Test Source flow_manager group update stage""" | ||||||
|  |  | ||||||
|  | from django.test import RequestFactory | ||||||
|  |  | ||||||
|  | from authentik.core.models import Group, SourceGroupMatchingModes | ||||||
|  | from authentik.core.sources.flow_manager import PLAN_CONTEXT_SOURCE_GROUPS, GroupUpdateStage | ||||||
|  | from authentik.core.tests.utils import create_test_admin_user, create_test_flow | ||||||
|  | from authentik.flows.models import in_memory_stage | ||||||
|  | from authentik.flows.planner import PLAN_CONTEXT_PENDING_USER, PLAN_CONTEXT_SOURCE, FlowPlan | ||||||
|  | from authentik.flows.tests import FlowTestCase | ||||||
|  | from authentik.flows.views.executor import FlowExecutorView | ||||||
|  | from authentik.lib.generators import generate_id | ||||||
|  | from authentik.sources.oauth.models import GroupOAuthSourceConnection, OAuthSource | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class TestSourceFlowManager(FlowTestCase): | ||||||
|  |     """Test Source flow_manager group update stage""" | ||||||
|  |  | ||||||
|  |     def setUp(self) -> None: | ||||||
|  |         super().setUp() | ||||||
|  |         self.factory = RequestFactory() | ||||||
|  |         self.authentication_flow = create_test_flow() | ||||||
|  |         self.enrollment_flow = create_test_flow() | ||||||
|  |         self.source: OAuthSource = OAuthSource.objects.create( | ||||||
|  |             name=generate_id(), | ||||||
|  |             slug=generate_id(), | ||||||
|  |             authentication_flow=self.authentication_flow, | ||||||
|  |             enrollment_flow=self.enrollment_flow, | ||||||
|  |         ) | ||||||
|  |         self.identifier = generate_id() | ||||||
|  |         self.user = create_test_admin_user() | ||||||
|  |  | ||||||
|  |     def test_nonexistant_group(self): | ||||||
|  |         request = self.factory.get("/") | ||||||
|  |         stage = GroupUpdateStage( | ||||||
|  |             FlowExecutorView( | ||||||
|  |                 current_stage=in_memory_stage( | ||||||
|  |                     GroupUpdateStage, group_connection_type=GroupOAuthSourceConnection | ||||||
|  |                 ), | ||||||
|  |                 plan=FlowPlan( | ||||||
|  |                     flow_pk=generate_id(), | ||||||
|  |                     context={ | ||||||
|  |                         PLAN_CONTEXT_SOURCE: self.source, | ||||||
|  |                         PLAN_CONTEXT_PENDING_USER: self.user, | ||||||
|  |                         PLAN_CONTEXT_SOURCE_GROUPS: { | ||||||
|  |                             "group 1": { | ||||||
|  |                                 "name": "group 1", | ||||||
|  |                             }, | ||||||
|  |                         }, | ||||||
|  |                     }, | ||||||
|  |                 ), | ||||||
|  |             ), | ||||||
|  |             request=request, | ||||||
|  |         ) | ||||||
|  |         self.assertTrue(stage.handle_groups()) | ||||||
|  |         self.assertTrue(Group.objects.filter(name="group 1").exists()) | ||||||
|  |         self.assertTrue(self.user.ak_groups.filter(name="group 1").exists()) | ||||||
|  |         self.assertTrue( | ||||||
|  |             GroupOAuthSourceConnection.objects.filter( | ||||||
|  |                 group=Group.objects.get(name="group 1"), source=self.source | ||||||
|  |             ).exists() | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |     def test_nonexistant_group_name_link(self): | ||||||
|  |         self.source.group_matching_mode = SourceGroupMatchingModes.NAME_LINK | ||||||
|  |         self.source.save() | ||||||
|  |  | ||||||
|  |         request = self.factory.get("/") | ||||||
|  |         stage = GroupUpdateStage( | ||||||
|  |             FlowExecutorView( | ||||||
|  |                 current_stage=in_memory_stage( | ||||||
|  |                     GroupUpdateStage, group_connection_type=GroupOAuthSourceConnection | ||||||
|  |                 ), | ||||||
|  |                 plan=FlowPlan( | ||||||
|  |                     flow_pk=generate_id(), | ||||||
|  |                     context={ | ||||||
|  |                         PLAN_CONTEXT_SOURCE: self.source, | ||||||
|  |                         PLAN_CONTEXT_PENDING_USER: self.user, | ||||||
|  |                         PLAN_CONTEXT_SOURCE_GROUPS: { | ||||||
|  |                             "group 1": { | ||||||
|  |                                 "name": "group 1", | ||||||
|  |                             }, | ||||||
|  |                         }, | ||||||
|  |                     }, | ||||||
|  |                 ), | ||||||
|  |             ), | ||||||
|  |             request=request, | ||||||
|  |         ) | ||||||
|  |         self.assertTrue(stage.handle_groups()) | ||||||
|  |         self.assertTrue(Group.objects.filter(name="group 1").exists()) | ||||||
|  |         self.assertTrue(self.user.ak_groups.filter(name="group 1").exists()) | ||||||
|  |         self.assertTrue( | ||||||
|  |             GroupOAuthSourceConnection.objects.filter( | ||||||
|  |                 group=Group.objects.get(name="group 1"), source=self.source | ||||||
|  |             ).exists() | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |     def test_existant_group_name_link(self): | ||||||
|  |         self.source.group_matching_mode = SourceGroupMatchingModes.NAME_LINK | ||||||
|  |         self.source.save() | ||||||
|  |         group = Group.objects.create(name="group 1") | ||||||
|  |  | ||||||
|  |         request = self.factory.get("/") | ||||||
|  |         stage = GroupUpdateStage( | ||||||
|  |             FlowExecutorView( | ||||||
|  |                 current_stage=in_memory_stage( | ||||||
|  |                     GroupUpdateStage, group_connection_type=GroupOAuthSourceConnection | ||||||
|  |                 ), | ||||||
|  |                 plan=FlowPlan( | ||||||
|  |                     flow_pk=generate_id(), | ||||||
|  |                     context={ | ||||||
|  |                         PLAN_CONTEXT_SOURCE: self.source, | ||||||
|  |                         PLAN_CONTEXT_PENDING_USER: self.user, | ||||||
|  |                         PLAN_CONTEXT_SOURCE_GROUPS: { | ||||||
|  |                             "group 1": { | ||||||
|  |                                 "name": "group 1", | ||||||
|  |                             }, | ||||||
|  |                         }, | ||||||
|  |                     }, | ||||||
|  |                 ), | ||||||
|  |             ), | ||||||
|  |             request=request, | ||||||
|  |         ) | ||||||
|  |         self.assertTrue(stage.handle_groups()) | ||||||
|  |         self.assertTrue(Group.objects.filter(name="group 1").exists()) | ||||||
|  |         self.assertTrue(self.user.ak_groups.filter(name="group 1").exists()) | ||||||
|  |         self.assertTrue( | ||||||
|  |             GroupOAuthSourceConnection.objects.filter(group=group, source=self.source).exists() | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |     def test_nonexistant_group_name_deny(self): | ||||||
|  |         self.source.group_matching_mode = SourceGroupMatchingModes.NAME_DENY | ||||||
|  |         self.source.save() | ||||||
|  |  | ||||||
|  |         request = self.factory.get("/") | ||||||
|  |         stage = GroupUpdateStage( | ||||||
|  |             FlowExecutorView( | ||||||
|  |                 current_stage=in_memory_stage( | ||||||
|  |                     GroupUpdateStage, group_connection_type=GroupOAuthSourceConnection | ||||||
|  |                 ), | ||||||
|  |                 plan=FlowPlan( | ||||||
|  |                     flow_pk=generate_id(), | ||||||
|  |                     context={ | ||||||
|  |                         PLAN_CONTEXT_SOURCE: self.source, | ||||||
|  |                         PLAN_CONTEXT_PENDING_USER: self.user, | ||||||
|  |                         PLAN_CONTEXT_SOURCE_GROUPS: { | ||||||
|  |                             "group 1": { | ||||||
|  |                                 "name": "group 1", | ||||||
|  |                             }, | ||||||
|  |                         }, | ||||||
|  |                     }, | ||||||
|  |                 ), | ||||||
|  |             ), | ||||||
|  |             request=request, | ||||||
|  |         ) | ||||||
|  |         self.assertTrue(stage.handle_groups()) | ||||||
|  |         self.assertTrue(Group.objects.filter(name="group 1").exists()) | ||||||
|  |         self.assertTrue(self.user.ak_groups.filter(name="group 1").exists()) | ||||||
|  |         self.assertTrue( | ||||||
|  |             GroupOAuthSourceConnection.objects.filter( | ||||||
|  |                 group=Group.objects.get(name="group 1"), source=self.source | ||||||
|  |             ).exists() | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |     def test_existant_group_name_deny(self): | ||||||
|  |         self.source.group_matching_mode = SourceGroupMatchingModes.NAME_DENY | ||||||
|  |         self.source.save() | ||||||
|  |         group = Group.objects.create(name="group 1") | ||||||
|  |  | ||||||
|  |         request = self.factory.get("/") | ||||||
|  |         stage = GroupUpdateStage( | ||||||
|  |             FlowExecutorView( | ||||||
|  |                 current_stage=in_memory_stage( | ||||||
|  |                     GroupUpdateStage, group_connection_type=GroupOAuthSourceConnection | ||||||
|  |                 ), | ||||||
|  |                 plan=FlowPlan( | ||||||
|  |                     flow_pk=generate_id(), | ||||||
|  |                     context={ | ||||||
|  |                         PLAN_CONTEXT_SOURCE: self.source, | ||||||
|  |                         PLAN_CONTEXT_PENDING_USER: self.user, | ||||||
|  |                         PLAN_CONTEXT_SOURCE_GROUPS: { | ||||||
|  |                             "group 1": { | ||||||
|  |                                 "name": "group 1", | ||||||
|  |                             }, | ||||||
|  |                         }, | ||||||
|  |                     }, | ||||||
|  |                 ), | ||||||
|  |             ), | ||||||
|  |             request=request, | ||||||
|  |         ) | ||||||
|  |         self.assertFalse(stage.handle_groups()) | ||||||
|  |         self.assertFalse(self.user.ak_groups.filter(name="group 1").exists()) | ||||||
|  |         self.assertFalse( | ||||||
|  |             GroupOAuthSourceConnection.objects.filter(group=group, source=self.source).exists() | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |     def test_group_updates(self): | ||||||
|  |         self.source.group_matching_mode = SourceGroupMatchingModes.NAME_LINK | ||||||
|  |         self.source.save() | ||||||
|  |  | ||||||
|  |         other_group = Group.objects.create(name="other group") | ||||||
|  |         old_group = Group.objects.create(name="old group") | ||||||
|  |         new_group = Group.objects.create(name="new group") | ||||||
|  |         self.user.ak_groups.set([other_group, old_group]) | ||||||
|  |         GroupOAuthSourceConnection.objects.create( | ||||||
|  |             group=old_group, source=self.source, identifier=old_group.name | ||||||
|  |         ) | ||||||
|  |         GroupOAuthSourceConnection.objects.create( | ||||||
|  |             group=new_group, source=self.source, identifier=new_group.name | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |         request = self.factory.get("/") | ||||||
|  |         stage = GroupUpdateStage( | ||||||
|  |             FlowExecutorView( | ||||||
|  |                 current_stage=in_memory_stage( | ||||||
|  |                     GroupUpdateStage, group_connection_type=GroupOAuthSourceConnection | ||||||
|  |                 ), | ||||||
|  |                 plan=FlowPlan( | ||||||
|  |                     flow_pk=generate_id(), | ||||||
|  |                     context={ | ||||||
|  |                         PLAN_CONTEXT_SOURCE: self.source, | ||||||
|  |                         PLAN_CONTEXT_PENDING_USER: self.user, | ||||||
|  |                         PLAN_CONTEXT_SOURCE_GROUPS: { | ||||||
|  |                             "new group": { | ||||||
|  |                                 "name": "new group", | ||||||
|  |                             }, | ||||||
|  |                         }, | ||||||
|  |                     }, | ||||||
|  |                 ), | ||||||
|  |             ), | ||||||
|  |             request=request, | ||||||
|  |         ) | ||||||
|  |         self.assertTrue(stage.handle_groups()) | ||||||
|  |         self.assertFalse(self.user.ak_groups.filter(name="old group").exists()) | ||||||
|  |         self.assertTrue(self.user.ak_groups.filter(name="other group").exists()) | ||||||
|  |         self.assertTrue(self.user.ak_groups.filter(name="new group").exists()) | ||||||
|  |         self.assertEqual(self.user.ak_groups.count(), 2) | ||||||
							
								
								
									
										72
									
								
								authentik/core/tests/test_source_property_mappings.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										72
									
								
								authentik/core/tests/test_source_property_mappings.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,72 @@ | |||||||
|  | """Test Source Property mappings""" | ||||||
|  |  | ||||||
|  | from django.test import TestCase | ||||||
|  |  | ||||||
|  | from authentik.core.models import Group, PropertyMapping, Source, User | ||||||
|  | from authentik.core.sources.mapper import SourceMapper | ||||||
|  | from authentik.lib.generators import generate_id | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class ProxySource(Source): | ||||||
|  |     @property | ||||||
|  |     def property_mapping_type(self): | ||||||
|  |         return PropertyMapping | ||||||
|  |  | ||||||
|  |     def get_base_user_properties(self, **kwargs): | ||||||
|  |         return { | ||||||
|  |             "username": kwargs.get("username", None), | ||||||
|  |             "email": kwargs.get("email", "default@authentik"), | ||||||
|  |         } | ||||||
|  |  | ||||||
|  |     def get_base_group_properties(self, **kwargs): | ||||||
|  |         return {"name": kwargs.get("name", None)} | ||||||
|  |  | ||||||
|  |     class Meta: | ||||||
|  |         proxy = True | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class TestSourcePropertyMappings(TestCase): | ||||||
|  |     """Test Source PropertyMappings""" | ||||||
|  |  | ||||||
|  |     def test_base_properties(self): | ||||||
|  |         source = ProxySource.objects.create(name=generate_id(), slug=generate_id(), enabled=True) | ||||||
|  |         mapper = SourceMapper(source) | ||||||
|  |  | ||||||
|  |         user_base_properties = mapper.get_base_properties(User, username="test1") | ||||||
|  |         self.assertEqual( | ||||||
|  |             user_base_properties, | ||||||
|  |             { | ||||||
|  |                 "username": "test1", | ||||||
|  |                 "email": "default@authentik", | ||||||
|  |                 "path": f"goauthentik.io/sources/{source.slug}", | ||||||
|  |             }, | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |         group_base_properties = mapper.get_base_properties(Group) | ||||||
|  |         self.assertEqual(group_base_properties, {"name": None}) | ||||||
|  |  | ||||||
|  |     def test_build_properties(self): | ||||||
|  |         source = ProxySource.objects.create(name=generate_id(), slug=generate_id(), enabled=True) | ||||||
|  |         mapper = SourceMapper(source) | ||||||
|  |  | ||||||
|  |         source.user_property_mappings.add( | ||||||
|  |             PropertyMapping.objects.create( | ||||||
|  |                 name=generate_id(), | ||||||
|  |                 expression=""" | ||||||
|  |                     return {"username": data.get("username", None), "email": None} | ||||||
|  |                 """, | ||||||
|  |             ) | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |         properties = mapper.build_object_properties( | ||||||
|  |             object_type=User, user=None, request=None, username="test1", data={"username": "test2"} | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |         self.assertEqual( | ||||||
|  |             properties, | ||||||
|  |             { | ||||||
|  |                 "username": "test2", | ||||||
|  |                 "path": f"goauthentik.io/sources/{source.slug}", | ||||||
|  |                 "attributes": {}, | ||||||
|  |             }, | ||||||
|  |         ) | ||||||
| @ -19,7 +19,6 @@ class TestTransactionalApplicationsAPI(APITestCase): | |||||||
|         """Test transactional Application + provider creation""" |         """Test transactional Application + provider creation""" | ||||||
|         self.client.force_login(self.user) |         self.client.force_login(self.user) | ||||||
|         uid = generate_id() |         uid = generate_id() | ||||||
|         authorization_flow = create_test_flow() |  | ||||||
|         response = self.client.put( |         response = self.client.put( | ||||||
|             reverse("authentik_api:core-transactional-application"), |             reverse("authentik_api:core-transactional-application"), | ||||||
|             data={ |             data={ | ||||||
| @ -30,7 +29,8 @@ class TestTransactionalApplicationsAPI(APITestCase): | |||||||
|                 "provider_model": "authentik_providers_oauth2.oauth2provider", |                 "provider_model": "authentik_providers_oauth2.oauth2provider", | ||||||
|                 "provider": { |                 "provider": { | ||||||
|                     "name": uid, |                     "name": uid, | ||||||
|                     "authorization_flow": str(authorization_flow.pk), |                     "authorization_flow": str(create_test_flow().pk), | ||||||
|  |                     "invalidation_flow": str(create_test_flow().pk), | ||||||
|                 }, |                 }, | ||||||
|             }, |             }, | ||||||
|         ) |         ) | ||||||
| @ -56,10 +56,16 @@ class TestTransactionalApplicationsAPI(APITestCase): | |||||||
|                 "provider": { |                 "provider": { | ||||||
|                     "name": uid, |                     "name": uid, | ||||||
|                     "authorization_flow": "", |                     "authorization_flow": "", | ||||||
|  |                     "invalidation_flow": "", | ||||||
|                 }, |                 }, | ||||||
|             }, |             }, | ||||||
|         ) |         ) | ||||||
|         self.assertJSONEqual( |         self.assertJSONEqual( | ||||||
|             response.content.decode(), |             response.content.decode(), | ||||||
|             {"provider": {"authorization_flow": ["This field may not be null."]}}, |             { | ||||||
|  |                 "provider": { | ||||||
|  |                     "authorization_flow": ["This field may not be null."], | ||||||
|  |                     "invalidation_flow": ["This field may not be null."], | ||||||
|  |                 } | ||||||
|  |             }, | ||||||
|         ) |         ) | ||||||
|  | |||||||
| @ -5,8 +5,6 @@ from channels.sessions import CookieMiddleware | |||||||
| from django.conf import settings | from django.conf import settings | ||||||
| from django.contrib.auth.decorators import login_required | from django.contrib.auth.decorators import login_required | ||||||
| from django.urls import path | from django.urls import path | ||||||
| from django.views.decorators.csrf import ensure_csrf_cookie |  | ||||||
| from django.views.generic import RedirectView |  | ||||||
|  |  | ||||||
| from authentik.core.api.applications import ApplicationViewSet | from authentik.core.api.applications import ApplicationViewSet | ||||||
| from authentik.core.api.authenticated_sessions import AuthenticatedSessionViewSet | from authentik.core.api.authenticated_sessions import AuthenticatedSessionViewSet | ||||||
| @ -18,10 +16,13 @@ from authentik.core.api.sources import SourceViewSet, UserSourceConnectionViewSe | |||||||
| from authentik.core.api.tokens import TokenViewSet | from authentik.core.api.tokens import TokenViewSet | ||||||
| from authentik.core.api.transactional_applications import TransactionalApplicationView | from authentik.core.api.transactional_applications import TransactionalApplicationView | ||||||
| from authentik.core.api.users import UserViewSet | from authentik.core.api.users import UserViewSet | ||||||
| from authentik.core.views import apps | from authentik.core.views.apps import RedirectToAppLaunch | ||||||
| from authentik.core.views.debug import AccessDeniedView | from authentik.core.views.debug import AccessDeniedView | ||||||
| from authentik.core.views.interface import InterfaceView | from authentik.core.views.interface import ( | ||||||
| from authentik.core.views.session import EndSessionView |     BrandDefaultRedirectView, | ||||||
|  |     InterfaceView, | ||||||
|  |     RootRedirectView, | ||||||
|  | ) | ||||||
| from authentik.flows.views.interface import FlowInterfaceView | from authentik.flows.views.interface import FlowInterfaceView | ||||||
| from authentik.root.asgi_middleware import SessionMiddleware | from authentik.root.asgi_middleware import SessionMiddleware | ||||||
| from authentik.root.messages.consumer import MessageConsumer | from authentik.root.messages.consumer import MessageConsumer | ||||||
| @ -30,40 +31,33 @@ from authentik.root.middleware import ChannelsLoggingMiddleware | |||||||
| urlpatterns = [ | urlpatterns = [ | ||||||
|     path( |     path( | ||||||
|         "", |         "", | ||||||
|         login_required( |         login_required(RootRedirectView.as_view()), | ||||||
|             RedirectView.as_view(pattern_name="authentik_core:if-user", query_string=True) |  | ||||||
|         ), |  | ||||||
|         name="root-redirect", |         name="root-redirect", | ||||||
|     ), |     ), | ||||||
|     path( |     path( | ||||||
|         # We have to use this format since everything else uses applications/o or applications/saml |         # We have to use this format since everything else uses application/o or application/saml | ||||||
|         "application/launch/<slug:application_slug>/", |         "application/launch/<slug:application_slug>/", | ||||||
|         apps.RedirectToAppLaunch.as_view(), |         RedirectToAppLaunch.as_view(), | ||||||
|         name="application-launch", |         name="application-launch", | ||||||
|     ), |     ), | ||||||
|     # Interfaces |     # Interfaces | ||||||
|     path( |     path( | ||||||
|         "if/admin/", |         "if/admin/", | ||||||
|         ensure_csrf_cookie(InterfaceView.as_view(template_name="if/admin.html")), |         BrandDefaultRedirectView.as_view(template_name="if/admin.html"), | ||||||
|         name="if-admin", |         name="if-admin", | ||||||
|     ), |     ), | ||||||
|     path( |     path( | ||||||
|         "if/user/", |         "if/user/", | ||||||
|         ensure_csrf_cookie(InterfaceView.as_view(template_name="if/user.html")), |         BrandDefaultRedirectView.as_view(template_name="if/user.html"), | ||||||
|         name="if-user", |         name="if-user", | ||||||
|     ), |     ), | ||||||
|     path( |     path( | ||||||
|         "if/flow/<slug:flow_slug>/", |         "if/flow/<slug:flow_slug>/", | ||||||
|         # FIXME: move this url to the flows app...also will cause all |         # FIXME: move this url to the flows app...also will cause all | ||||||
|         # of the reverse calls to be adjusted |         # of the reverse calls to be adjusted | ||||||
|         ensure_csrf_cookie(FlowInterfaceView.as_view()), |         FlowInterfaceView.as_view(), | ||||||
|         name="if-flow", |         name="if-flow", | ||||||
|     ), |     ), | ||||||
|     path( |  | ||||||
|         "if/session-end/<slug:application_slug>/", |  | ||||||
|         ensure_csrf_cookie(EndSessionView.as_view()), |  | ||||||
|         name="if-session-end", |  | ||||||
|     ), |  | ||||||
|     # Fallback for WS |     # Fallback for WS | ||||||
|     path("ws/outpost/<uuid:pk>/", InterfaceView.as_view(template_name="if/admin.html")), |     path("ws/outpost/<uuid:pk>/", InterfaceView.as_view(template_name="if/admin.html")), | ||||||
|     path( |     path( | ||||||
|  | |||||||
| @ -8,7 +8,6 @@ from django.views import View | |||||||
| from authentik.core.models import Application | from authentik.core.models import Application | ||||||
| from authentik.flows.challenge import ( | from authentik.flows.challenge import ( | ||||||
|     ChallengeResponse, |     ChallengeResponse, | ||||||
|     ChallengeTypes, |  | ||||||
|     HttpChallengeResponse, |     HttpChallengeResponse, | ||||||
|     RedirectChallenge, |     RedirectChallenge, | ||||||
| ) | ) | ||||||
| @ -74,7 +73,6 @@ class RedirectToAppStage(ChallengeStageView): | |||||||
|             raise Http404 |             raise Http404 | ||||||
|         return RedirectChallenge( |         return RedirectChallenge( | ||||||
|             instance={ |             instance={ | ||||||
|                 "type": ChallengeTypes.REDIRECT.value, |  | ||||||
|                 "to": launch, |                 "to": launch, | ||||||
|             } |             } | ||||||
|         ) |         ) | ||||||
|  | |||||||
| @ -3,13 +3,42 @@ | |||||||
| from json import dumps | from json import dumps | ||||||
| from typing import Any | from typing import Any | ||||||
|  |  | ||||||
| from django.views.generic.base import TemplateView | from django.http import HttpRequest | ||||||
|  | from django.http.response import HttpResponse | ||||||
|  | from django.shortcuts import redirect | ||||||
|  | from django.utils.translation import gettext as _ | ||||||
|  | from django.views.generic.base import RedirectView, TemplateView | ||||||
| from rest_framework.request import Request | from rest_framework.request import Request | ||||||
|  |  | ||||||
| from authentik import get_build_hash | from authentik import get_build_hash | ||||||
| from authentik.admin.tasks import LOCAL_VERSION | from authentik.admin.tasks import LOCAL_VERSION | ||||||
| from authentik.api.v3.config import ConfigView | from authentik.api.v3.config import ConfigView | ||||||
| from authentik.brands.api import CurrentBrandSerializer | from authentik.brands.api import CurrentBrandSerializer | ||||||
|  | from authentik.brands.models import Brand | ||||||
|  | from authentik.core.models import UserTypes | ||||||
|  | from authentik.policies.denied import AccessDeniedResponse | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class RootRedirectView(RedirectView): | ||||||
|  |     """Root redirect view, redirect to brand's default application if set""" | ||||||
|  |  | ||||||
|  |     pattern_name = "authentik_core:if-user" | ||||||
|  |     query_string = True | ||||||
|  |  | ||||||
|  |     def redirect_to_app(self, request: HttpRequest): | ||||||
|  |         if request.user.is_authenticated and request.user.type == UserTypes.EXTERNAL: | ||||||
|  |             brand: Brand = request.brand | ||||||
|  |             if brand.default_application: | ||||||
|  |                 return redirect( | ||||||
|  |                     "authentik_core:application-launch", | ||||||
|  |                     application_slug=brand.default_application.slug, | ||||||
|  |                 ) | ||||||
|  |         return None | ||||||
|  |  | ||||||
|  |     def dispatch(self, request: HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse: | ||||||
|  |         if redirect_response := RootRedirectView().redirect_to_app(request): | ||||||
|  |             return redirect_response | ||||||
|  |         return super().dispatch(request, *args, **kwargs) | ||||||
|  |  | ||||||
|  |  | ||||||
| class InterfaceView(TemplateView): | class InterfaceView(TemplateView): | ||||||
| @ -23,3 +52,20 @@ class InterfaceView(TemplateView): | |||||||
|         kwargs["build"] = get_build_hash() |         kwargs["build"] = get_build_hash() | ||||||
|         kwargs["url_kwargs"] = self.kwargs |         kwargs["url_kwargs"] = self.kwargs | ||||||
|         return super().get_context_data(**kwargs) |         return super().get_context_data(**kwargs) | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class BrandDefaultRedirectView(InterfaceView): | ||||||
|  |     """By default redirect to default app""" | ||||||
|  |  | ||||||
|  |     def dispatch(self, request: HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse: | ||||||
|  |         if request.user.is_authenticated and request.user.type == UserTypes.EXTERNAL: | ||||||
|  |             brand: Brand = request.brand | ||||||
|  |             if brand.default_application: | ||||||
|  |                 return redirect( | ||||||
|  |                     "authentik_core:application-launch", | ||||||
|  |                     application_slug=brand.default_application.slug, | ||||||
|  |                 ) | ||||||
|  |             response = AccessDeniedResponse(self.request) | ||||||
|  |             response.error_message = _("Interface can only be accessed by internal users.") | ||||||
|  |             return response | ||||||
|  |         return super().dispatch(request, *args, **kwargs) | ||||||
|  | |||||||
| @ -1,23 +0,0 @@ | |||||||
| """authentik Session Views""" |  | ||||||
|  |  | ||||||
| from typing import Any |  | ||||||
|  |  | ||||||
| from django.shortcuts import get_object_or_404 |  | ||||||
| from django.views.generic.base import TemplateView |  | ||||||
|  |  | ||||||
| from authentik.core.models import Application |  | ||||||
| from authentik.policies.views import PolicyAccessView |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class EndSessionView(TemplateView, PolicyAccessView): |  | ||||||
|     """Allow the client to end the Session""" |  | ||||||
|  |  | ||||||
|     template_name = "if/end_session.html" |  | ||||||
|  |  | ||||||
|     def resolve_provider_application(self): |  | ||||||
|         self.application = get_object_or_404(Application, slug=self.kwargs["application_slug"]) |  | ||||||
|  |  | ||||||
|     def get_context_data(self, **kwargs: Any) -> dict[str, Any]: |  | ||||||
|         context = super().get_context_data(**kwargs) |  | ||||||
|         context["application"] = self.application |  | ||||||
|         return context |  | ||||||
| @ -35,6 +35,7 @@ from authentik.crypto.builder import CertificateBuilder, PrivateKeyAlg | |||||||
| from authentik.crypto.models import CertificateKeyPair | from authentik.crypto.models import CertificateKeyPair | ||||||
| from authentik.events.models import Event, EventAction | from authentik.events.models import Event, EventAction | ||||||
| from authentik.rbac.decorators import permission_required | from authentik.rbac.decorators import permission_required | ||||||
|  | from authentik.rbac.filters import ObjectFilter | ||||||
|  |  | ||||||
| LOGGER = get_logger() | LOGGER = get_logger() | ||||||
|  |  | ||||||
| @ -265,7 +266,7 @@ class CertificateKeyPairViewSet(UsedByMixin, ModelViewSet): | |||||||
|         ], |         ], | ||||||
|         responses={200: CertificateDataSerializer(many=False)}, |         responses={200: CertificateDataSerializer(many=False)}, | ||||||
|     ) |     ) | ||||||
|     @action(detail=True, pagination_class=None, filter_backends=[]) |     @action(detail=True, pagination_class=None, filter_backends=[ObjectFilter]) | ||||||
|     def view_certificate(self, request: Request, pk: str) -> Response: |     def view_certificate(self, request: Request, pk: str) -> Response: | ||||||
|         """Return certificate-key pairs certificate and log access""" |         """Return certificate-key pairs certificate and log access""" | ||||||
|         certificate: CertificateKeyPair = self.get_object() |         certificate: CertificateKeyPair = self.get_object() | ||||||
| @ -295,7 +296,7 @@ class CertificateKeyPairViewSet(UsedByMixin, ModelViewSet): | |||||||
|         ], |         ], | ||||||
|         responses={200: CertificateDataSerializer(many=False)}, |         responses={200: CertificateDataSerializer(many=False)}, | ||||||
|     ) |     ) | ||||||
|     @action(detail=True, pagination_class=None, filter_backends=[]) |     @action(detail=True, pagination_class=None, filter_backends=[ObjectFilter]) | ||||||
|     def view_private_key(self, request: Request, pk: str) -> Response: |     def view_private_key(self, request: Request, pk: str) -> Response: | ||||||
|         """Return certificate-key pairs private key and log access""" |         """Return certificate-key pairs private key and log access""" | ||||||
|         certificate: CertificateKeyPair = self.get_object() |         certificate: CertificateKeyPair = self.get_object() | ||||||
|  | |||||||
| @ -76,7 +76,7 @@ class CertificateBuilder: | |||||||
|             .subject_name( |             .subject_name( | ||||||
|                 x509.Name( |                 x509.Name( | ||||||
|                     [ |                     [ | ||||||
|                         x509.NameAttribute(NameOID.COMMON_NAME, self.common_name), |                         x509.NameAttribute(NameOID.COMMON_NAME, self.common_name[:64]), | ||||||
|                         x509.NameAttribute(NameOID.ORGANIZATION_NAME, "authentik"), |                         x509.NameAttribute(NameOID.ORGANIZATION_NAME, "authentik"), | ||||||
|                         x509.NameAttribute(NameOID.ORGANIZATIONAL_UNIT_NAME, "Self-signed"), |                         x509.NameAttribute(NameOID.ORGANIZATIONAL_UNIT_NAME, "Self-signed"), | ||||||
|                     ] |                     ] | ||||||
|  | |||||||
| @ -214,6 +214,46 @@ class TestCrypto(APITestCase): | |||||||
|         self.assertEqual(200, response.status_code) |         self.assertEqual(200, response.status_code) | ||||||
|         self.assertIn("Content-Disposition", response) |         self.assertIn("Content-Disposition", response) | ||||||
|  |  | ||||||
|  |     def test_certificate_download_denied(self): | ||||||
|  |         """Test certificate export (download)""" | ||||||
|  |         self.client.logout() | ||||||
|  |         keypair = create_test_cert() | ||||||
|  |         response = self.client.get( | ||||||
|  |             reverse( | ||||||
|  |                 "authentik_api:certificatekeypair-view-certificate", | ||||||
|  |                 kwargs={"pk": keypair.pk}, | ||||||
|  |             ) | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(403, response.status_code) | ||||||
|  |         response = self.client.get( | ||||||
|  |             reverse( | ||||||
|  |                 "authentik_api:certificatekeypair-view-certificate", | ||||||
|  |                 kwargs={"pk": keypair.pk}, | ||||||
|  |             ), | ||||||
|  |             data={"download": True}, | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(403, response.status_code) | ||||||
|  |  | ||||||
|  |     def test_private_key_download_denied(self): | ||||||
|  |         """Test private_key export (download)""" | ||||||
|  |         self.client.logout() | ||||||
|  |         keypair = create_test_cert() | ||||||
|  |         response = self.client.get( | ||||||
|  |             reverse( | ||||||
|  |                 "authentik_api:certificatekeypair-view-private-key", | ||||||
|  |                 kwargs={"pk": keypair.pk}, | ||||||
|  |             ) | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(403, response.status_code) | ||||||
|  |         response = self.client.get( | ||||||
|  |             reverse( | ||||||
|  |                 "authentik_api:certificatekeypair-view-private-key", | ||||||
|  |                 kwargs={"pk": keypair.pk}, | ||||||
|  |             ), | ||||||
|  |             data={"download": True}, | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(403, response.status_code) | ||||||
|  |  | ||||||
|     def test_used_by(self): |     def test_used_by(self): | ||||||
|         """Test used_by endpoint""" |         """Test used_by endpoint""" | ||||||
|         self.client.force_login(create_test_admin_user()) |         self.client.force_login(create_test_admin_user()) | ||||||
| @ -246,6 +286,26 @@ class TestCrypto(APITestCase): | |||||||
|             ], |             ], | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|  |     def test_used_by_denied(self): | ||||||
|  |         """Test used_by endpoint""" | ||||||
|  |         self.client.logout() | ||||||
|  |         keypair = create_test_cert() | ||||||
|  |         OAuth2Provider.objects.create( | ||||||
|  |             name=generate_id(), | ||||||
|  |             client_id="test", | ||||||
|  |             client_secret=generate_key(), | ||||||
|  |             authorization_flow=create_test_flow(), | ||||||
|  |             redirect_uris="http://localhost", | ||||||
|  |             signing_key=keypair, | ||||||
|  |         ) | ||||||
|  |         response = self.client.get( | ||||||
|  |             reverse( | ||||||
|  |                 "authentik_api:certificatekeypair-used-by", | ||||||
|  |                 kwargs={"pk": keypair.pk}, | ||||||
|  |             ) | ||||||
|  |         ) | ||||||
|  |         self.assertEqual(403, response.status_code) | ||||||
|  |  | ||||||
|     def test_discovery(self): |     def test_discovery(self): | ||||||
|         """Test certificate discovery""" |         """Test certificate discovery""" | ||||||
|         name = generate_id() |         name = generate_id() | ||||||
|  | |||||||
| @ -1,12 +1,11 @@ | |||||||
| """Enterprise API Views""" | """Enterprise API Views""" | ||||||
|  |  | ||||||
| from dataclasses import asdict |  | ||||||
| from datetime import timedelta | from datetime import timedelta | ||||||
|  |  | ||||||
| from django.utils.timezone import now | from django.utils.timezone import now | ||||||
| from django.utils.translation import gettext as _ | from django.utils.translation import gettext as _ | ||||||
| from drf_spectacular.types import OpenApiTypes | from drf_spectacular.types import OpenApiTypes | ||||||
| from drf_spectacular.utils import extend_schema, inline_serializer | from drf_spectacular.utils import OpenApiParameter, extend_schema, inline_serializer | ||||||
| from rest_framework.decorators import action | from rest_framework.decorators import action | ||||||
| from rest_framework.exceptions import ValidationError | from rest_framework.exceptions import ValidationError | ||||||
| from rest_framework.fields import CharField, IntegerField | from rest_framework.fields import CharField, IntegerField | ||||||
| @ -30,7 +29,7 @@ class EnterpriseRequiredMixin: | |||||||
|  |  | ||||||
|     def validate(self, attrs: dict) -> dict: |     def validate(self, attrs: dict) -> dict: | ||||||
|         """Check that a valid license exists""" |         """Check that a valid license exists""" | ||||||
|         if not LicenseKey.cached_summary().has_license: |         if not LicenseKey.cached_summary().status.is_valid: | ||||||
|             raise ValidationError(_("Enterprise is required to create/update this object.")) |             raise ValidationError(_("Enterprise is required to create/update this object.")) | ||||||
|         return super().validate(attrs) |         return super().validate(attrs) | ||||||
|  |  | ||||||
| @ -87,7 +86,7 @@ class LicenseViewSet(UsedByMixin, ModelViewSet): | |||||||
|         }, |         }, | ||||||
|     ) |     ) | ||||||
|     @action(detail=False, methods=["GET"]) |     @action(detail=False, methods=["GET"]) | ||||||
|     def get_install_id(self, request: Request) -> Response: |     def install_id(self, request: Request) -> Response: | ||||||
|         """Get install_id""" |         """Get install_id""" | ||||||
|         return Response( |         return Response( | ||||||
|             data={ |             data={ | ||||||
| @ -100,12 +99,22 @@ class LicenseViewSet(UsedByMixin, ModelViewSet): | |||||||
|         responses={ |         responses={ | ||||||
|             200: LicenseSummarySerializer(), |             200: LicenseSummarySerializer(), | ||||||
|         }, |         }, | ||||||
|  |         parameters=[ | ||||||
|  |             OpenApiParameter( | ||||||
|  |                 name="cached", | ||||||
|  |                 location=OpenApiParameter.QUERY, | ||||||
|  |                 type=OpenApiTypes.BOOL, | ||||||
|  |                 default=True, | ||||||
|  |             ) | ||||||
|  |         ], | ||||||
|     ) |     ) | ||||||
|     @action(detail=False, methods=["GET"], permission_classes=[IsAuthenticated]) |     @action(detail=False, methods=["GET"], permission_classes=[IsAuthenticated]) | ||||||
|     def summary(self, request: Request) -> Response: |     def summary(self, request: Request) -> Response: | ||||||
|         """Get the total license status""" |         """Get the total license status""" | ||||||
|         response = LicenseSummarySerializer(data=asdict(LicenseKey.cached_summary())) |         summary = LicenseKey.cached_summary() | ||||||
|         response.is_valid(raise_exception=True) |         if request.query_params.get("cached", "true").lower() == "false": | ||||||
|  |             summary = LicenseKey.get_total().summary() | ||||||
|  |         response = LicenseSummarySerializer(instance=summary) | ||||||
|         return Response(response.data) |         return Response(response.data) | ||||||
|  |  | ||||||
|     @permission_required(None, ["authentik_enterprise.view_license"]) |     @permission_required(None, ["authentik_enterprise.view_license"]) | ||||||
| @ -128,7 +137,7 @@ class LicenseViewSet(UsedByMixin, ModelViewSet): | |||||||
|         forecast_for_months = 12 |         forecast_for_months = 12 | ||||||
|         response = LicenseForecastSerializer( |         response = LicenseForecastSerializer( | ||||||
|             data={ |             data={ | ||||||
|                 "internal_users": LicenseKey.get_default_user_count(), |                 "internal_users": LicenseKey.get_internal_user_count(), | ||||||
|                 "external_users": LicenseKey.get_external_user_count(), |                 "external_users": LicenseKey.get_external_user_count(), | ||||||
|                 "forecasted_internal_users": (internal_in_last_month * forecast_for_months), |                 "forecasted_internal_users": (internal_in_last_month * forecast_for_months), | ||||||
|                 "forecasted_external_users": (external_in_last_month * forecast_for_months), |                 "forecasted_external_users": (external_in_last_month * forecast_for_months), | ||||||
|  | |||||||
| @ -25,4 +25,4 @@ class AuthentikEnterpriseConfig(EnterpriseConfig): | |||||||
|         """Actual enterprise check, cached""" |         """Actual enterprise check, cached""" | ||||||
|         from authentik.enterprise.license import LicenseKey |         from authentik.enterprise.license import LicenseKey | ||||||
|  |  | ||||||
|         return LicenseKey.cached_summary().valid |         return LicenseKey.cached_summary().status.is_valid | ||||||
|  | |||||||
| @ -3,24 +3,37 @@ | |||||||
| from base64 import b64decode | from base64 import b64decode | ||||||
| from binascii import Error | from binascii import Error | ||||||
| from dataclasses import asdict, dataclass, field | from dataclasses import asdict, dataclass, field | ||||||
| from datetime import datetime, timedelta | from datetime import UTC, datetime, timedelta | ||||||
| from enum import Enum | from enum import Enum | ||||||
| from functools import lru_cache | from functools import lru_cache | ||||||
| from time import mktime | from time import mktime | ||||||
|  |  | ||||||
| from cryptography.exceptions import InvalidSignature | from cryptography.exceptions import InvalidSignature | ||||||
| from cryptography.x509 import Certificate, load_der_x509_certificate, load_pem_x509_certificate | from cryptography.x509 import Certificate, load_der_x509_certificate, load_pem_x509_certificate | ||||||
| from dacite import from_dict | from dacite import DaciteError, from_dict | ||||||
| from django.core.cache import cache | from django.core.cache import cache | ||||||
| from django.db.models.query import QuerySet | from django.db.models.query import QuerySet | ||||||
| from django.utils.timezone import now | from django.utils.timezone import now | ||||||
| from jwt import PyJWTError, decode, get_unverified_header | from jwt import PyJWTError, decode, get_unverified_header | ||||||
| from rest_framework.exceptions import ValidationError | from rest_framework.exceptions import ValidationError | ||||||
| from rest_framework.fields import BooleanField, DateTimeField, IntegerField | from rest_framework.fields import ( | ||||||
|  |     ChoiceField, | ||||||
|  |     DateTimeField, | ||||||
|  |     IntegerField, | ||||||
|  |     ListField, | ||||||
|  | ) | ||||||
|  |  | ||||||
| from authentik.core.api.utils import PassiveSerializer | from authentik.core.api.utils import PassiveSerializer | ||||||
| from authentik.core.models import User, UserTypes | from authentik.core.models import User, UserTypes | ||||||
| from authentik.enterprise.models import License, LicenseUsage | from authentik.enterprise.models import ( | ||||||
|  |     THRESHOLD_READ_ONLY_WEEKS, | ||||||
|  |     THRESHOLD_WARNING_ADMIN_WEEKS, | ||||||
|  |     THRESHOLD_WARNING_EXPIRY_WEEKS, | ||||||
|  |     THRESHOLD_WARNING_USER_WEEKS, | ||||||
|  |     License, | ||||||
|  |     LicenseUsage, | ||||||
|  |     LicenseUsageStatus, | ||||||
|  | ) | ||||||
| from authentik.tenants.utils import get_unique_identifier | from authentik.tenants.utils import get_unique_identifier | ||||||
|  |  | ||||||
| CACHE_KEY_ENTERPRISE_LICENSE = "goauthentik.io/enterprise/license" | CACHE_KEY_ENTERPRISE_LICENSE = "goauthentik.io/enterprise/license" | ||||||
| @ -42,6 +55,9 @@ def get_license_aud() -> str: | |||||||
| class LicenseFlags(Enum): | class LicenseFlags(Enum): | ||||||
|     """License flags""" |     """License flags""" | ||||||
|  |  | ||||||
|  |     TRIAL = "trial" | ||||||
|  |     NON_PRODUCTION = "non_production" | ||||||
|  |  | ||||||
|  |  | ||||||
| @dataclass | @dataclass | ||||||
| class LicenseSummary: | class LicenseSummary: | ||||||
| @ -49,12 +65,9 @@ class LicenseSummary: | |||||||
|  |  | ||||||
|     internal_users: int |     internal_users: int | ||||||
|     external_users: int |     external_users: int | ||||||
|     valid: bool |     status: LicenseUsageStatus | ||||||
|     show_admin_warning: bool |  | ||||||
|     show_user_warning: bool |  | ||||||
|     read_only: bool |  | ||||||
|     latest_valid: datetime |     latest_valid: datetime | ||||||
|     has_license: bool |     license_flags: list[LicenseFlags] | ||||||
|  |  | ||||||
|  |  | ||||||
| class LicenseSummarySerializer(PassiveSerializer): | class LicenseSummarySerializer(PassiveSerializer): | ||||||
| @ -62,12 +75,9 @@ class LicenseSummarySerializer(PassiveSerializer): | |||||||
|  |  | ||||||
|     internal_users = IntegerField(required=True) |     internal_users = IntegerField(required=True) | ||||||
|     external_users = IntegerField(required=True) |     external_users = IntegerField(required=True) | ||||||
|     valid = BooleanField() |     status = ChoiceField(choices=LicenseUsageStatus.choices) | ||||||
|     show_admin_warning = BooleanField() |  | ||||||
|     show_user_warning = BooleanField() |  | ||||||
|     read_only = BooleanField() |  | ||||||
|     latest_valid = DateTimeField() |     latest_valid = DateTimeField() | ||||||
|     has_license = BooleanField() |     license_flags = ListField(child=ChoiceField(choices=tuple(x.value for x in LicenseFlags))) | ||||||
|  |  | ||||||
|  |  | ||||||
| @dataclass | @dataclass | ||||||
| @ -80,10 +90,10 @@ class LicenseKey: | |||||||
|     name: str |     name: str | ||||||
|     internal_users: int = 0 |     internal_users: int = 0 | ||||||
|     external_users: int = 0 |     external_users: int = 0 | ||||||
|     flags: list[LicenseFlags] = field(default_factory=list) |     license_flags: list[LicenseFlags] = field(default_factory=list) | ||||||
|  |  | ||||||
|     @staticmethod |     @staticmethod | ||||||
|     def validate(jwt: str) -> "LicenseKey": |     def validate(jwt: str, check_expiry=True) -> "LicenseKey": | ||||||
|         """Validate the license from a given JWT""" |         """Validate the license from a given JWT""" | ||||||
|         try: |         try: | ||||||
|             headers = get_unverified_header(jwt) |             headers = get_unverified_header(jwt) | ||||||
| @ -107,26 +117,28 @@ class LicenseKey: | |||||||
|                     our_cert.public_key(), |                     our_cert.public_key(), | ||||||
|                     algorithms=["ES512"], |                     algorithms=["ES512"], | ||||||
|                     audience=get_license_aud(), |                     audience=get_license_aud(), | ||||||
|  |                     options={"verify_exp": check_expiry, "verify_signature": check_expiry}, | ||||||
|                 ), |                 ), | ||||||
|             ) |             ) | ||||||
|         except PyJWTError: |         except PyJWTError: | ||||||
|  |             unverified = decode(jwt, options={"verify_signature": False}) | ||||||
|  |             if unverified["aud"] != get_license_aud(): | ||||||
|  |                 raise ValidationError("Invalid Install ID in license") from None | ||||||
|             raise ValidationError("Unable to verify license") from None |             raise ValidationError("Unable to verify license") from None | ||||||
|         return body |         return body | ||||||
|  |  | ||||||
|     @staticmethod |     @staticmethod | ||||||
|     def get_total() -> "LicenseKey": |     def get_total() -> "LicenseKey": | ||||||
|         """Get a summarized version of all (not expired) licenses""" |         """Get a summarized version of all (not expired) licenses""" | ||||||
|         active_licenses = License.objects.filter(expiry__gte=now()) |  | ||||||
|         total = LicenseKey(get_license_aud(), 0, "Summarized license", 0, 0) |         total = LicenseKey(get_license_aud(), 0, "Summarized license", 0, 0) | ||||||
|         for lic in active_licenses: |         for lic in License.objects.all(): | ||||||
|             total.internal_users += lic.internal_users |             total.internal_users += lic.internal_users | ||||||
|             total.external_users += lic.external_users |             total.external_users += lic.external_users | ||||||
|             exp_ts = int(mktime(lic.expiry.timetuple())) |             exp_ts = int(mktime(lic.expiry.timetuple())) | ||||||
|             if total.exp == 0: |             if total.exp == 0: | ||||||
|                 total.exp = exp_ts |                 total.exp = exp_ts | ||||||
|             if exp_ts <= total.exp: |             total.exp = max(total.exp, exp_ts) | ||||||
|                 total.exp = exp_ts |             total.license_flags.extend(lic.status.license_flags) | ||||||
|             total.flags.extend(lic.status.flags) |  | ||||||
|         return total |         return total | ||||||
|  |  | ||||||
|     @staticmethod |     @staticmethod | ||||||
| @ -135,7 +147,7 @@ class LicenseKey: | |||||||
|         return User.objects.all().exclude_anonymous().exclude(is_active=False) |         return User.objects.all().exclude_anonymous().exclude(is_active=False) | ||||||
|  |  | ||||||
|     @staticmethod |     @staticmethod | ||||||
|     def get_default_user_count(): |     def get_internal_user_count(): | ||||||
|         """Get current default user count""" |         """Get current default user count""" | ||||||
|         return LicenseKey.base_user_qs().filter(type=UserTypes.INTERNAL).count() |         return LicenseKey.base_user_qs().filter(type=UserTypes.INTERNAL).count() | ||||||
|  |  | ||||||
| @ -144,59 +156,73 @@ class LicenseKey: | |||||||
|         """Get current external user count""" |         """Get current external user count""" | ||||||
|         return LicenseKey.base_user_qs().filter(type=UserTypes.EXTERNAL).count() |         return LicenseKey.base_user_qs().filter(type=UserTypes.EXTERNAL).count() | ||||||
|  |  | ||||||
|     def is_valid(self) -> bool: |     def _last_valid_date(self): | ||||||
|         """Check if the given license body covers all users |         last_valid_date = ( | ||||||
|  |             LicenseUsage.objects.order_by("-record_date") | ||||||
|  |             .filter(status=LicenseUsageStatus.VALID) | ||||||
|  |             .first() | ||||||
|  |         ) | ||||||
|  |         if not last_valid_date: | ||||||
|  |             return datetime.fromtimestamp(0, UTC) | ||||||
|  |         return last_valid_date.record_date | ||||||
|  |  | ||||||
|         Only checks the current count, no historical data is checked""" |     def status(self) -> LicenseUsageStatus: | ||||||
|         default_users = self.get_default_user_count() |         """Check if the given license body covers all users, and is valid.""" | ||||||
|         if default_users > self.internal_users: |         last_valid = self._last_valid_date() | ||||||
|             return False |         if self.exp == 0 and not License.objects.exists(): | ||||||
|         active_users = self.get_external_user_count() |             return LicenseUsageStatus.UNLICENSED | ||||||
|         if active_users > self.external_users: |         _now = now() | ||||||
|             return False |         # Check limit-exceeded based status | ||||||
|         return True |         internal_users = self.get_internal_user_count() | ||||||
|  |         external_users = self.get_external_user_count() | ||||||
|  |         if internal_users > self.internal_users or external_users > self.external_users: | ||||||
|  |             if last_valid < _now - timedelta(weeks=THRESHOLD_READ_ONLY_WEEKS): | ||||||
|  |                 return LicenseUsageStatus.READ_ONLY | ||||||
|  |             if last_valid < _now - timedelta(weeks=THRESHOLD_WARNING_USER_WEEKS): | ||||||
|  |                 return LicenseUsageStatus.LIMIT_EXCEEDED_USER | ||||||
|  |             if last_valid < _now - timedelta(weeks=THRESHOLD_WARNING_ADMIN_WEEKS): | ||||||
|  |                 return LicenseUsageStatus.LIMIT_EXCEEDED_ADMIN | ||||||
|  |         # Check expiry based status | ||||||
|  |         if datetime.fromtimestamp(self.exp, UTC) < _now: | ||||||
|  |             if datetime.fromtimestamp(self.exp, UTC) < _now - timedelta( | ||||||
|  |                 weeks=THRESHOLD_READ_ONLY_WEEKS | ||||||
|  |             ): | ||||||
|  |                 return LicenseUsageStatus.READ_ONLY | ||||||
|  |             return LicenseUsageStatus.EXPIRED | ||||||
|  |         # Expiry warning | ||||||
|  |         if datetime.fromtimestamp(self.exp, UTC) <= _now + timedelta( | ||||||
|  |             weeks=THRESHOLD_WARNING_EXPIRY_WEEKS | ||||||
|  |         ): | ||||||
|  |             return LicenseUsageStatus.EXPIRY_SOON | ||||||
|  |         return LicenseUsageStatus.VALID | ||||||
|  |  | ||||||
|     def record_usage(self): |     def record_usage(self): | ||||||
|         """Capture the current validity status and metrics and save them""" |         """Capture the current validity status and metrics and save them""" | ||||||
|         threshold = now() - timedelta(hours=8) |         threshold = now() - timedelta(hours=8) | ||||||
|         if not LicenseUsage.objects.filter(record_date__gte=threshold).exists(): |         usage = ( | ||||||
|             LicenseUsage.objects.create( |             LicenseUsage.objects.order_by("-record_date").filter(record_date__gte=threshold).first() | ||||||
|                 user_count=self.get_default_user_count(), |         ) | ||||||
|  |         if not usage: | ||||||
|  |             usage = LicenseUsage.objects.create( | ||||||
|  |                 internal_user_count=self.get_internal_user_count(), | ||||||
|                 external_user_count=self.get_external_user_count(), |                 external_user_count=self.get_external_user_count(), | ||||||
|                 within_limits=self.is_valid(), |                 status=self.status(), | ||||||
|             ) |             ) | ||||||
|         summary = asdict(self.summary()) |         summary = asdict(self.summary()) | ||||||
|         # Also cache the latest summary for the middleware |         # Also cache the latest summary for the middleware | ||||||
|         cache.set(CACHE_KEY_ENTERPRISE_LICENSE, summary, timeout=CACHE_EXPIRY_ENTERPRISE_LICENSE) |         cache.set(CACHE_KEY_ENTERPRISE_LICENSE, summary, timeout=CACHE_EXPIRY_ENTERPRISE_LICENSE) | ||||||
|         return summary |         return usage | ||||||
|  |  | ||||||
|     @staticmethod |  | ||||||
|     def last_valid_date() -> datetime: |  | ||||||
|         """Get the last date the license was valid""" |  | ||||||
|         usage: LicenseUsage = ( |  | ||||||
|             LicenseUsage.filter_not_expired(within_limits=True).order_by("-record_date").first() |  | ||||||
|         ) |  | ||||||
|         if not usage: |  | ||||||
|             return now() |  | ||||||
|         return usage.record_date |  | ||||||
|  |  | ||||||
|     def summary(self) -> LicenseSummary: |     def summary(self) -> LicenseSummary: | ||||||
|         """Summary of license status""" |         """Summary of license status""" | ||||||
|         has_license = License.objects.all().count() > 0 |         status = self.status() | ||||||
|         last_valid = LicenseKey.last_valid_date() |  | ||||||
|         show_admin_warning = last_valid < now() - timedelta(weeks=2) |  | ||||||
|         show_user_warning = last_valid < now() - timedelta(weeks=4) |  | ||||||
|         read_only = last_valid < now() - timedelta(weeks=6) |  | ||||||
|         latest_valid = datetime.fromtimestamp(self.exp) |         latest_valid = datetime.fromtimestamp(self.exp) | ||||||
|         return LicenseSummary( |         return LicenseSummary( | ||||||
|             show_admin_warning=show_admin_warning and has_license, |  | ||||||
|             show_user_warning=show_user_warning and has_license, |  | ||||||
|             read_only=read_only and has_license, |  | ||||||
|             latest_valid=latest_valid, |             latest_valid=latest_valid, | ||||||
|             internal_users=self.internal_users, |             internal_users=self.internal_users, | ||||||
|             external_users=self.external_users, |             external_users=self.external_users, | ||||||
|             valid=self.is_valid(), |             status=status, | ||||||
|             has_license=has_license, |             license_flags=self.license_flags, | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     @staticmethod |     @staticmethod | ||||||
| @ -205,4 +231,8 @@ class LicenseKey: | |||||||
|         summary = cache.get(CACHE_KEY_ENTERPRISE_LICENSE) |         summary = cache.get(CACHE_KEY_ENTERPRISE_LICENSE) | ||||||
|         if not summary: |         if not summary: | ||||||
|             return LicenseKey.get_total().summary() |             return LicenseKey.get_total().summary() | ||||||
|         return from_dict(LicenseSummary, summary) |         try: | ||||||
|  |             return from_dict(LicenseSummary, summary) | ||||||
|  |         except DaciteError: | ||||||
|  |             cache.delete(CACHE_KEY_ENTERPRISE_LICENSE) | ||||||
|  |             return LicenseKey.get_total().summary() | ||||||
|  | |||||||
| @ -8,6 +8,7 @@ from structlog.stdlib import BoundLogger, get_logger | |||||||
|  |  | ||||||
| from authentik.enterprise.api import LicenseViewSet | from authentik.enterprise.api import LicenseViewSet | ||||||
| from authentik.enterprise.license import LicenseKey | from authentik.enterprise.license import LicenseKey | ||||||
|  | from authentik.enterprise.models import LicenseUsageStatus | ||||||
| from authentik.flows.views.executor import FlowExecutorView | from authentik.flows.views.executor import FlowExecutorView | ||||||
| from authentik.lib.utils.reflection import class_to_path | from authentik.lib.utils.reflection import class_to_path | ||||||
|  |  | ||||||
| @ -43,7 +44,7 @@ class EnterpriseMiddleware: | |||||||
|         cached_status = LicenseKey.cached_summary() |         cached_status = LicenseKey.cached_summary() | ||||||
|         if not cached_status: |         if not cached_status: | ||||||
|             return True |             return True | ||||||
|         if cached_status.read_only: |         if cached_status.status == LicenseUsageStatus.READ_ONLY: | ||||||
|             return False |             return False | ||||||
|         return True |         return True | ||||||
|  |  | ||||||
| @ -53,10 +54,10 @@ class EnterpriseMiddleware: | |||||||
|         if request.method.lower() in ["get", "head", "options", "trace"]: |         if request.method.lower() in ["get", "head", "options", "trace"]: | ||||||
|             return True |             return True | ||||||
|         # Always allow requests to manage licenses |         # Always allow requests to manage licenses | ||||||
|         if class_to_path(request.resolver_match.func) == class_to_path(LicenseViewSet): |         if request.resolver_match._func_path == class_to_path(LicenseViewSet): | ||||||
|             return True |             return True | ||||||
|         # Flow executor is mounted as an API path but explicitly allowed |         # Flow executor is mounted as an API path but explicitly allowed | ||||||
|         if class_to_path(request.resolver_match.func) == class_to_path(FlowExecutorView): |         if request.resolver_match._func_path == class_to_path(FlowExecutorView): | ||||||
|             return True |             return True | ||||||
|         # Only apply these restrictions to the API |         # Only apply these restrictions to the API | ||||||
|         if "authentik_api" not in request.resolver_match.app_names: |         if "authentik_api" not in request.resolver_match.app_names: | ||||||
|  | |||||||
| @ -0,0 +1,68 @@ | |||||||
|  | # Generated by Django 5.0.8 on 2024-08-08 14:15 | ||||||
|  |  | ||||||
|  | from django.db import migrations, models | ||||||
|  | from django.apps.registry import Apps | ||||||
|  | from django.db.backends.base.schema import BaseDatabaseSchemaEditor | ||||||
|  |  | ||||||
|  |  | ||||||
|  | def migrate_license_usage(apps: Apps, schema_editor: BaseDatabaseSchemaEditor): | ||||||
|  |     LicenseUsage = apps.get_model("authentik_enterprise", "licenseusage") | ||||||
|  |     db_alias = schema_editor.connection.alias | ||||||
|  |  | ||||||
|  |     for usage in LicenseUsage.objects.using(db_alias).all(): | ||||||
|  |         usage.status = "valid" if usage.within_limits else "limit_exceeded_admin" | ||||||
|  |         usage.save() | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Migration(migrations.Migration): | ||||||
|  |  | ||||||
|  |     dependencies = [ | ||||||
|  |         ("authentik_enterprise", "0002_rename_users_license_internal_users_and_more"), | ||||||
|  |     ] | ||||||
|  |  | ||||||
|  |     operations = [ | ||||||
|  |         migrations.AddField( | ||||||
|  |             model_name="licenseusage", | ||||||
|  |             name="status", | ||||||
|  |             field=models.TextField( | ||||||
|  |                 choices=[ | ||||||
|  |                     ("unlicensed", "Unlicensed"), | ||||||
|  |                     ("valid", "Valid"), | ||||||
|  |                     ("expired", "Expired"), | ||||||
|  |                     ("expiry_soon", "Expiry Soon"), | ||||||
|  |                     ("limit_exceeded_admin", "Limit Exceeded Admin"), | ||||||
|  |                     ("limit_exceeded_user", "Limit Exceeded User"), | ||||||
|  |                     ("read_only", "Read Only"), | ||||||
|  |                 ], | ||||||
|  |                 default=None, | ||||||
|  |                 null=True, | ||||||
|  |             ), | ||||||
|  |             preserve_default=False, | ||||||
|  |         ), | ||||||
|  |         migrations.RunPython(migrate_license_usage), | ||||||
|  |         migrations.RemoveField( | ||||||
|  |             model_name="licenseusage", | ||||||
|  |             name="within_limits", | ||||||
|  |         ), | ||||||
|  |         migrations.AlterField( | ||||||
|  |             model_name="licenseusage", | ||||||
|  |             name="status", | ||||||
|  |             field=models.TextField( | ||||||
|  |                 choices=[ | ||||||
|  |                     ("unlicensed", "Unlicensed"), | ||||||
|  |                     ("valid", "Valid"), | ||||||
|  |                     ("expired", "Expired"), | ||||||
|  |                     ("expiry_soon", "Expiry Soon"), | ||||||
|  |                     ("limit_exceeded_admin", "Limit Exceeded Admin"), | ||||||
|  |                     ("limit_exceeded_user", "Limit Exceeded User"), | ||||||
|  |                     ("read_only", "Read Only"), | ||||||
|  |                 ], | ||||||
|  |             ), | ||||||
|  |             preserve_default=False, | ||||||
|  |         ), | ||||||
|  |         migrations.RenameField( | ||||||
|  |             model_name="licenseusage", | ||||||
|  |             old_name="user_count", | ||||||
|  |             new_name="internal_user_count", | ||||||
|  |         ), | ||||||
|  |     ] | ||||||
| @ -17,6 +17,17 @@ if TYPE_CHECKING: | |||||||
|     from authentik.enterprise.license import LicenseKey |     from authentik.enterprise.license import LicenseKey | ||||||
|  |  | ||||||
|  |  | ||||||
|  | def usage_expiry(): | ||||||
|  |     """Keep license usage records for 3 months""" | ||||||
|  |     return now() + timedelta(days=30 * 3) | ||||||
|  |  | ||||||
|  |  | ||||||
|  | THRESHOLD_WARNING_ADMIN_WEEKS = 2 | ||||||
|  | THRESHOLD_WARNING_USER_WEEKS = 4 | ||||||
|  | THRESHOLD_WARNING_EXPIRY_WEEKS = 2 | ||||||
|  | THRESHOLD_READ_ONLY_WEEKS = 6 | ||||||
|  |  | ||||||
|  |  | ||||||
| class License(SerializerModel): | class License(SerializerModel): | ||||||
|     """An authentik enterprise license""" |     """An authentik enterprise license""" | ||||||
|  |  | ||||||
| @ -39,7 +50,7 @@ class License(SerializerModel): | |||||||
|         """Get parsed license status""" |         """Get parsed license status""" | ||||||
|         from authentik.enterprise.license import LicenseKey |         from authentik.enterprise.license import LicenseKey | ||||||
|  |  | ||||||
|         return LicenseKey.validate(self.key) |         return LicenseKey.validate(self.key, check_expiry=False) | ||||||
|  |  | ||||||
|     class Meta: |     class Meta: | ||||||
|         indexes = (HashIndex(fields=("key",)),) |         indexes = (HashIndex(fields=("key",)),) | ||||||
| @ -47,9 +58,23 @@ class License(SerializerModel): | |||||||
|         verbose_name_plural = _("Licenses") |         verbose_name_plural = _("Licenses") | ||||||
|  |  | ||||||
|  |  | ||||||
| def usage_expiry(): | class LicenseUsageStatus(models.TextChoices): | ||||||
|     """Keep license usage records for 3 months""" |     """License states an instance/tenant can be in""" | ||||||
|     return now() + timedelta(days=30 * 3) |  | ||||||
|  |     UNLICENSED = "unlicensed" | ||||||
|  |     VALID = "valid" | ||||||
|  |     EXPIRED = "expired" | ||||||
|  |     EXPIRY_SOON = "expiry_soon" | ||||||
|  |     # User limit exceeded, 2 week threshold, show message in admin interface | ||||||
|  |     LIMIT_EXCEEDED_ADMIN = "limit_exceeded_admin" | ||||||
|  |     # User limit exceeded, 4 week threshold, show message in user interface | ||||||
|  |     LIMIT_EXCEEDED_USER = "limit_exceeded_user" | ||||||
|  |     READ_ONLY = "read_only" | ||||||
|  |  | ||||||
|  |     @property | ||||||
|  |     def is_valid(self) -> bool: | ||||||
|  |         """Quickly check if a license is valid""" | ||||||
|  |         return self in [LicenseUsageStatus.VALID, LicenseUsageStatus.EXPIRY_SOON] | ||||||
|  |  | ||||||
|  |  | ||||||
| class LicenseUsage(ExpiringModel): | class LicenseUsage(ExpiringModel): | ||||||
| @ -59,9 +84,9 @@ class LicenseUsage(ExpiringModel): | |||||||
|  |  | ||||||
|     usage_uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4) |     usage_uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4) | ||||||
|  |  | ||||||
|     user_count = models.BigIntegerField() |     internal_user_count = models.BigIntegerField() | ||||||
|     external_user_count = models.BigIntegerField() |     external_user_count = models.BigIntegerField() | ||||||
|     within_limits = models.BooleanField() |     status = models.TextField(choices=LicenseUsageStatus.choices) | ||||||
|  |  | ||||||
|     record_date = models.DateTimeField(auto_now_add=True) |     record_date = models.DateTimeField(auto_now_add=True) | ||||||
|  |  | ||||||
|  | |||||||
| @ -13,7 +13,7 @@ class EnterprisePolicyAccessView(PolicyAccessView): | |||||||
|  |  | ||||||
|     def check_license(self): |     def check_license(self): | ||||||
|         """Check license""" |         """Check license""" | ||||||
|         if not LicenseKey.get_total().is_valid(): |         if not LicenseKey.get_total().status().is_valid: | ||||||
|             return PolicyResult(False, _("Enterprise required to access this feature.")) |             return PolicyResult(False, _("Enterprise required to access this feature.")) | ||||||
|         if self.request.user.type != UserTypes.INTERNAL: |         if self.request.user.type != UserTypes.INTERNAL: | ||||||
|             return PolicyResult(False, _("Feature only accessible for internal users.")) |             return PolicyResult(False, _("Feature only accessible for internal users.")) | ||||||
|  | |||||||
| @ -6,7 +6,10 @@ from authentik.core.api.providers import ProviderSerializer | |||||||
| from authentik.core.api.used_by import UsedByMixin | from authentik.core.api.used_by import UsedByMixin | ||||||
| from authentik.enterprise.api import EnterpriseRequiredMixin | from authentik.enterprise.api import EnterpriseRequiredMixin | ||||||
| from authentik.enterprise.providers.google_workspace.models import GoogleWorkspaceProvider | from authentik.enterprise.providers.google_workspace.models import GoogleWorkspaceProvider | ||||||
| from authentik.enterprise.providers.google_workspace.tasks import google_workspace_sync | from authentik.enterprise.providers.google_workspace.tasks import ( | ||||||
|  |     google_workspace_sync, | ||||||
|  |     google_workspace_sync_objects, | ||||||
|  | ) | ||||||
| from authentik.lib.sync.outgoing.api import OutgoingSyncProviderStatusMixin | from authentik.lib.sync.outgoing.api import OutgoingSyncProviderStatusMixin | ||||||
|  |  | ||||||
|  |  | ||||||
| @ -52,3 +55,4 @@ class GoogleWorkspaceProviderViewSet(OutgoingSyncProviderStatusMixin, UsedByMixi | |||||||
|     search_fields = ["name"] |     search_fields = ["name"] | ||||||
|     ordering = ["name"] |     ordering = ["name"] | ||||||
|     sync_single_task = google_workspace_sync |     sync_single_task = google_workspace_sync | ||||||
|  |     sync_objects_task = google_workspace_sync_objects | ||||||
|  | |||||||
| @ -181,7 +181,7 @@ class GoogleWorkspaceProviderMapping(PropertyMapping): | |||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def component(self) -> str: |     def component(self) -> str: | ||||||
|         return "ak-property-mapping-google-workspace-form" |         return "ak-property-mapping-provider-google-workspace-form" | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def serializer(self) -> type[Serializer]: |     def serializer(self) -> type[Serializer]: | ||||||
|  | |||||||
| @ -6,7 +6,10 @@ from authentik.core.api.providers import ProviderSerializer | |||||||
| from authentik.core.api.used_by import UsedByMixin | from authentik.core.api.used_by import UsedByMixin | ||||||
| from authentik.enterprise.api import EnterpriseRequiredMixin | from authentik.enterprise.api import EnterpriseRequiredMixin | ||||||
| from authentik.enterprise.providers.microsoft_entra.models import MicrosoftEntraProvider | from authentik.enterprise.providers.microsoft_entra.models import MicrosoftEntraProvider | ||||||
| from authentik.enterprise.providers.microsoft_entra.tasks import microsoft_entra_sync | from authentik.enterprise.providers.microsoft_entra.tasks import ( | ||||||
|  |     microsoft_entra_sync, | ||||||
|  |     microsoft_entra_sync_objects, | ||||||
|  | ) | ||||||
| from authentik.lib.sync.outgoing.api import OutgoingSyncProviderStatusMixin | from authentik.lib.sync.outgoing.api import OutgoingSyncProviderStatusMixin | ||||||
|  |  | ||||||
|  |  | ||||||
| @ -50,3 +53,4 @@ class MicrosoftEntraProviderViewSet(OutgoingSyncProviderStatusMixin, UsedByMixin | |||||||
|     search_fields = ["name"] |     search_fields = ["name"] | ||||||
|     ordering = ["name"] |     ordering = ["name"] | ||||||
|     sync_single_task = microsoft_entra_sync |     sync_single_task = microsoft_entra_sync | ||||||
|  |     sync_objects_task = microsoft_entra_sync_objects | ||||||
|  | |||||||
| @ -170,7 +170,7 @@ class MicrosoftEntraProviderMapping(PropertyMapping): | |||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def component(self) -> str: |     def component(self) -> str: | ||||||
|         return "ak-property-mapping-microsoft-entra-form" |         return "ak-property-mapping-provider-microsoft-entra-form" | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def serializer(self) -> type[Serializer]: |     def serializer(self) -> type[Serializer]: | ||||||
|  | |||||||
| @ -34,6 +34,12 @@ class ConnectionTokenSerializer(EnterpriseRequiredMixin, ModelSerializer): | |||||||
|         ] |         ] | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class ConnectionTokenOwnerFilter(OwnerFilter): | ||||||
|  |     """Owner filter for connection tokens (checks session's user)""" | ||||||
|  |  | ||||||
|  |     owner_key = "session__user" | ||||||
|  |  | ||||||
|  |  | ||||||
| class ConnectionTokenViewSet( | class ConnectionTokenViewSet( | ||||||
|     mixins.RetrieveModelMixin, |     mixins.RetrieveModelMixin, | ||||||
|     mixins.UpdateModelMixin, |     mixins.UpdateModelMixin, | ||||||
| @ -50,4 +56,9 @@ class ConnectionTokenViewSet( | |||||||
|     search_fields = ["endpoint__name", "provider__name"] |     search_fields = ["endpoint__name", "provider__name"] | ||||||
|     ordering = ["endpoint__name", "provider__name"] |     ordering = ["endpoint__name", "provider__name"] | ||||||
|     permission_classes = [OwnerSuperuserPermissions] |     permission_classes = [OwnerSuperuserPermissions] | ||||||
|     filter_backends = [OwnerFilter, DjangoFilterBackend, OrderingFilter, SearchFilter] |     filter_backends = [ | ||||||
|  |         ConnectionTokenOwnerFilter, | ||||||
|  |         DjangoFilterBackend, | ||||||
|  |         OrderingFilter, | ||||||
|  |         SearchFilter, | ||||||
|  |     ] | ||||||
|  | |||||||
| @ -0,0 +1,20 @@ | |||||||
|  | # Generated by Django 5.0.8 on 2024-08-12 12:54 | ||||||
|  |  | ||||||
|  | from django.db import migrations | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Migration(migrations.Migration): | ||||||
|  |  | ||||||
|  |     dependencies = [ | ||||||
|  |         ("authentik_providers_rac", "0004_alter_connectiontoken_expires"), | ||||||
|  |     ] | ||||||
|  |  | ||||||
|  |     operations = [ | ||||||
|  |         migrations.AlterModelOptions( | ||||||
|  |             name="racpropertymapping", | ||||||
|  |             options={ | ||||||
|  |                 "verbose_name": "RAC Provider Property Mapping", | ||||||
|  |                 "verbose_name_plural": "RAC Provider Property Mappings", | ||||||
|  |             }, | ||||||
|  |         ), | ||||||
|  |     ] | ||||||
| @ -125,7 +125,7 @@ class RACPropertyMapping(PropertyMapping): | |||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def component(self) -> str: |     def component(self) -> str: | ||||||
|         return "ak-property-mapping-rac-form" |         return "ak-property-mapping-provider-rac-form" | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def serializer(self) -> type[Serializer]: |     def serializer(self) -> type[Serializer]: | ||||||
| @ -136,8 +136,8 @@ class RACPropertyMapping(PropertyMapping): | |||||||
|         return RACPropertyMappingSerializer |         return RACPropertyMappingSerializer | ||||||
|  |  | ||||||
|     class Meta: |     class Meta: | ||||||
|         verbose_name = _("RAC Property Mapping") |         verbose_name = _("RAC Provider Property Mapping") | ||||||
|         verbose_name_plural = _("RAC Property Mappings") |         verbose_name_plural = _("RAC Provider Property Mappings") | ||||||
|  |  | ||||||
|  |  | ||||||
| class ConnectionToken(ExpiringModel): | class ConnectionToken(ExpiringModel): | ||||||
|  | |||||||
| @ -21,6 +21,8 @@ from authentik.enterprise.providers.rac.models import ConnectionToken, Endpoint | |||||||
| @receiver(user_logged_out) | @receiver(user_logged_out) | ||||||
| def user_logged_out_session(sender, request: HttpRequest, user: User, **_): | def user_logged_out_session(sender, request: HttpRequest, user: User, **_): | ||||||
|     """Disconnect any open RAC connections""" |     """Disconnect any open RAC connections""" | ||||||
|  |     if not request.session or not request.session.session_key: | ||||||
|  |         return | ||||||
|     layer = get_channel_layer() |     layer = get_channel_layer() | ||||||
|     async_to_sync(layer.group_send)( |     async_to_sync(layer.group_send)( | ||||||
|         RAC_CLIENT_GROUP_SESSION |         RAC_CLIENT_GROUP_SESSION | ||||||
|  | |||||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user
	 Ken Sternberg
					Ken Sternberg