Compare commits
5 Commits
trustchain
...
version-20
Author | SHA1 | Date |
---|---|---|
Jens Langhammer | 8543e140ef | |
Jens Langhammer | e2cf578afd | |
Jens Langhammer | 0ce9fd9b2e | |
Jens Langhammer | d17ad65435 | |
Jens L | 01529d3894 |
|
@ -1,5 +1,5 @@
|
||||||
[bumpversion]
|
[bumpversion]
|
||||||
current_version = 2023.10.6
|
current_version = 2022.7.3
|
||||||
tag = True
|
tag = True
|
||||||
commit = True
|
commit = True
|
||||||
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)
|
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)
|
||||||
|
@ -17,4 +17,4 @@ tag_name = version/{new_version}
|
||||||
|
|
||||||
[bumpversion:file:internal/constants/constants.go]
|
[bumpversion:file:internal/constants/constants.go]
|
||||||
|
|
||||||
[bumpversion:file:web/src/common/constants.ts]
|
[bumpversion:file:web/src/constants.ts]
|
||||||
|
|
|
@ -1,11 +1,8 @@
|
||||||
|
env
|
||||||
|
static
|
||||||
htmlcov
|
htmlcov
|
||||||
*.env.yml
|
*.env.yml
|
||||||
**/node_modules
|
**/node_modules
|
||||||
dist/**
|
dist/**
|
||||||
build/**
|
build/**
|
||||||
build_docs/**
|
build_docs/**
|
||||||
*Dockerfile
|
|
||||||
blueprints/local
|
|
||||||
.git
|
|
||||||
!gen-ts-api/node_modules
|
|
||||||
!gen-ts-api/dist/**
|
|
||||||
|
|
|
@ -7,14 +7,8 @@ charset = utf-8
|
||||||
trim_trailing_whitespace = true
|
trim_trailing_whitespace = true
|
||||||
insert_final_newline = true
|
insert_final_newline = true
|
||||||
|
|
||||||
[*.html]
|
[html]
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
|
|
||||||
[*.{yaml,yml}]
|
[yaml]
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
|
|
||||||
[*.go]
|
|
||||||
indent_style = tab
|
|
||||||
|
|
||||||
[Makefile]
|
|
||||||
indent_style = tab
|
|
||||||
|
|
|
@ -1,9 +1,10 @@
|
||||||
---
|
---
|
||||||
name: Bug report
|
name: Bug report
|
||||||
about: Create a report to help us improve
|
about: Create a report to help us improve
|
||||||
title: ""
|
title: ''
|
||||||
labels: bug
|
labels: bug
|
||||||
assignees: ""
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
**Describe the bug**
|
||||||
|
@ -11,7 +12,6 @@ A clear and concise description of what the bug is.
|
||||||
|
|
||||||
**To Reproduce**
|
**To Reproduce**
|
||||||
Steps to reproduce the behavior:
|
Steps to reproduce the behavior:
|
||||||
|
|
||||||
1. Go to '...'
|
1. Go to '...'
|
||||||
2. Click on '....'
|
2. Click on '....'
|
||||||
3. Scroll down to '....'
|
3. Scroll down to '....'
|
||||||
|
@ -27,9 +27,8 @@ If applicable, add screenshots to help explain your problem.
|
||||||
Output of docker-compose logs or kubectl logs respectively
|
Output of docker-compose logs or kubectl logs respectively
|
||||||
|
|
||||||
**Version and Deployment (please complete the following information):**
|
**Version and Deployment (please complete the following information):**
|
||||||
|
- authentik version: [e.g. 2021.8.5]
|
||||||
- authentik version: [e.g. 2021.8.5]
|
- Deployment: [e.g. docker-compose, helm]
|
||||||
- Deployment: [e.g. docker-compose, helm]
|
|
||||||
|
|
||||||
**Additional context**
|
**Additional context**
|
||||||
Add any other context about the problem here.
|
Add any other context about the problem here.
|
||||||
|
|
|
@ -1,9 +1,10 @@
|
||||||
---
|
---
|
||||||
name: Feature request
|
name: Feature request
|
||||||
about: Suggest an idea for this project
|
about: Suggest an idea for this project
|
||||||
title: ""
|
title: ''
|
||||||
labels: enhancement
|
labels: enhancement
|
||||||
assignees: ""
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
|
|
@ -1,17 +0,0 @@
|
||||||
---
|
|
||||||
name: Hackathon Idea
|
|
||||||
about: Propose an idea for the hackathon
|
|
||||||
title: ""
|
|
||||||
labels: hackathon
|
|
||||||
assignees: ""
|
|
||||||
---
|
|
||||||
|
|
||||||
**Describe the idea**
|
|
||||||
|
|
||||||
A clear concise description of the idea you want to implement
|
|
||||||
|
|
||||||
You're also free to work on existing GitHub issues, whether they be feature requests or bugs, just link the existing GitHub issue here.
|
|
||||||
|
|
||||||
<!-- Don't modify below here -->
|
|
||||||
|
|
||||||
If you want to help working on this idea or want to contribute in any other way, react to this issue with a :rocket:
|
|
|
@ -1,9 +1,10 @@
|
||||||
---
|
---
|
||||||
name: Question
|
name: Question
|
||||||
about: Ask a question about a feature or specific configuration
|
about: Ask a question about a feature or specific configuration
|
||||||
title: ""
|
title: ''
|
||||||
labels: question
|
labels: question
|
||||||
assignees: ""
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe your question/**
|
**Describe your question/**
|
||||||
|
@ -19,9 +20,8 @@ If applicable, add screenshots to help explain your problem.
|
||||||
Output of docker-compose logs or kubectl logs respectively
|
Output of docker-compose logs or kubectl logs respectively
|
||||||
|
|
||||||
**Version and Deployment (please complete the following information):**
|
**Version and Deployment (please complete the following information):**
|
||||||
|
- authentik version: [e.g. 2021.8.5]
|
||||||
- authentik version: [e.g. 2021.8.5]
|
- Deployment: [e.g. docker-compose, helm]
|
||||||
- Deployment: [e.g. docker-compose, helm]
|
|
||||||
|
|
||||||
**Additional context**
|
**Additional context**
|
||||||
Add any other context about the problem here.
|
Add any other context about the problem here.
|
||||||
|
|
|
@ -1,78 +0,0 @@
|
||||||
name: "Comment usage instructions on PRs"
|
|
||||||
description: "Comment usage instructions on PRs"
|
|
||||||
|
|
||||||
inputs:
|
|
||||||
tag:
|
|
||||||
description: "Image tag to pull"
|
|
||||||
required: true
|
|
||||||
|
|
||||||
runs:
|
|
||||||
using: "composite"
|
|
||||||
steps:
|
|
||||||
- name: Generate config
|
|
||||||
id: ev
|
|
||||||
uses: ./.github/actions/docker-push-variables
|
|
||||||
- name: Find Comment
|
|
||||||
uses: peter-evans/find-comment@v2
|
|
||||||
id: fc
|
|
||||||
with:
|
|
||||||
issue-number: ${{ github.event.pull_request.number }}
|
|
||||||
comment-author: "github-actions[bot]"
|
|
||||||
body-includes: authentik PR Installation instructions
|
|
||||||
- name: Create or update comment
|
|
||||||
uses: peter-evans/create-or-update-comment@v2
|
|
||||||
with:
|
|
||||||
comment-id: ${{ steps.fc.outputs.comment-id }}
|
|
||||||
issue-number: ${{ github.event.pull_request.number }}
|
|
||||||
body: |
|
|
||||||
authentik PR Installation instructions
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Instructions for docker-compose</summary>
|
|
||||||
|
|
||||||
Add the following block to your `.env` file:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
|
|
||||||
AUTHENTIK_TAG=${{ inputs.tag }}
|
|
||||||
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
|
|
||||||
```
|
|
||||||
|
|
||||||
For arm64, use these values:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
|
|
||||||
AUTHENTIK_TAG=${{ inputs.tag }}-arm64
|
|
||||||
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
|
|
||||||
```
|
|
||||||
|
|
||||||
Afterwards, run the upgrade commands from the latest release notes.
|
|
||||||
</details>
|
|
||||||
<details>
|
|
||||||
<summary>Instructions for Kubernetes</summary>
|
|
||||||
|
|
||||||
Add the following block to your `values.yml` file:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
authentik:
|
|
||||||
outposts:
|
|
||||||
container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
|
|
||||||
image:
|
|
||||||
repository: ghcr.io/goauthentik/dev-server
|
|
||||||
tag: ${{ inputs.tag }}
|
|
||||||
```
|
|
||||||
|
|
||||||
For arm64, use these values:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
authentik:
|
|
||||||
outposts:
|
|
||||||
container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
|
|
||||||
image:
|
|
||||||
repository: ghcr.io/goauthentik/dev-server
|
|
||||||
tag: ${{ inputs.tag }}-arm64
|
|
||||||
```
|
|
||||||
|
|
||||||
Afterwards, run the upgrade commands from the latest release notes.
|
|
||||||
</details>
|
|
||||||
edit-mode: replace
|
|
|
@ -1,5 +1,5 @@
|
||||||
name: "Prepare docker environment variables"
|
name: 'Prepare docker environment variables'
|
||||||
description: "Prepare docker environment variables"
|
description: 'Prepare docker environment variables'
|
||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
shouldBuild:
|
shouldBuild:
|
||||||
|
@ -17,9 +17,6 @@ outputs:
|
||||||
sha:
|
sha:
|
||||||
description: "sha"
|
description: "sha"
|
||||||
value: ${{ steps.ev.outputs.sha }}
|
value: ${{ steps.ev.outputs.sha }}
|
||||||
shortHash:
|
|
||||||
description: "shortHash"
|
|
||||||
value: ${{ steps.ev.outputs.shortHash }}
|
|
||||||
version:
|
version:
|
||||||
description: "version"
|
description: "version"
|
||||||
value: ${{ steps.ev.outputs.version }}
|
value: ${{ steps.ev.outputs.version }}
|
||||||
|
@ -35,30 +32,32 @@ runs:
|
||||||
shell: python
|
shell: python
|
||||||
run: |
|
run: |
|
||||||
"""Helper script to get the actual branch name, docker safe"""
|
"""Helper script to get the actual branch name, docker safe"""
|
||||||
import configparser
|
|
||||||
import os
|
import os
|
||||||
from time import time
|
from time import time
|
||||||
|
|
||||||
parser = configparser.ConfigParser()
|
env_pr_branch = "GITHUB_HEAD_REF"
|
||||||
parser.read(".bumpversion.cfg")
|
default_branch = "GITHUB_REF"
|
||||||
|
sha = "GITHUB_SHA"
|
||||||
|
|
||||||
branch_name = os.environ["GITHUB_REF"]
|
branch_name = os.environ[default_branch]
|
||||||
if os.environ.get("GITHUB_HEAD_REF", "") != "":
|
if os.environ.get(env_pr_branch, "") != "":
|
||||||
branch_name = os.environ["GITHUB_HEAD_REF"]
|
branch_name = os.environ[env_pr_branch]
|
||||||
|
|
||||||
should_build = str(os.environ.get("DOCKER_USERNAME", "") != "").lower()
|
should_build = str(os.environ.get("DOCKER_USERNAME", "") != "").lower()
|
||||||
|
|
||||||
|
print("##[set-output name=branchName]%s" % branch_name)
|
||||||
|
print(
|
||||||
|
"##[set-output name=branchNameContainer]%s"
|
||||||
|
% branch_name.replace("refs/heads/", "").replace("/", "-")
|
||||||
|
)
|
||||||
|
print("##[set-output name=timestamp]%s" % int(time()))
|
||||||
|
print("##[set-output name=sha]%s" % os.environ[sha])
|
||||||
|
print("##[set-output name=shouldBuild]%s" % should_build)
|
||||||
|
|
||||||
|
import configparser
|
||||||
|
parser = configparser.ConfigParser()
|
||||||
|
parser.read(".bumpversion.cfg")
|
||||||
version = parser.get("bumpversion", "current_version")
|
version = parser.get("bumpversion", "current_version")
|
||||||
version_family = ".".join(version.split(".")[:-1])
|
version_family = ".".join(version.split(".")[:-1])
|
||||||
safe_branch_name = branch_name.replace("refs/heads/", "").replace("/", "-")
|
print("##[set-output name=version]%s" % version)
|
||||||
|
print("##[set-output name=versionFamily]%s" % version_family)
|
||||||
sha = os.environ["GITHUB_SHA"] if not "${{ github.event.pull_request.head.sha }}" else "${{ github.event.pull_request.head.sha }}"
|
|
||||||
|
|
||||||
with open(os.environ["GITHUB_OUTPUT"], "a+", encoding="utf-8") as _output:
|
|
||||||
print("branchName=%s" % branch_name, file=_output)
|
|
||||||
print("branchNameContainer=%s" % safe_branch_name, file=_output)
|
|
||||||
print("timestamp=%s" % int(time()), file=_output)
|
|
||||||
print("sha=%s" % sha, file=_output)
|
|
||||||
print("shortHash=%s" % sha[:7], file=_output)
|
|
||||||
print("shouldBuild=%s" % should_build, file=_output)
|
|
||||||
print("version=%s" % version, file=_output)
|
|
||||||
print("versionFamily=%s" % version_family, file=_output)
|
|
||||||
|
|
|
@ -1,42 +1,33 @@
|
||||||
name: "Setup authentik testing environment"
|
name: 'Setup authentik testing environemnt'
|
||||||
description: "Setup authentik testing environment"
|
description: 'Setup authentik testing environemnt'
|
||||||
|
|
||||||
inputs:
|
|
||||||
postgresql_version:
|
|
||||||
description: "Optional postgresql image tag"
|
|
||||||
default: "12"
|
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: "composite"
|
using: "composite"
|
||||||
steps:
|
steps:
|
||||||
- name: Install poetry & deps
|
- name: Install poetry
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
pipx install poetry || true
|
pipx install poetry || true
|
||||||
sudo apt-get update
|
sudo apt update
|
||||||
sudo apt-get install --no-install-recommends -y libpq-dev openssl libxmlsec1-dev pkg-config gettext
|
sudo apt install -y libxmlsec1-dev pkg-config gettext
|
||||||
- name: Setup python and restore poetry
|
- name: Setup python and restore poetry
|
||||||
uses: actions/setup-python@v4
|
uses: actions/setup-python@v3
|
||||||
with:
|
with:
|
||||||
python-version-file: 'pyproject.toml'
|
python-version: '3.10'
|
||||||
cache: "poetry"
|
cache: 'poetry'
|
||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v3.1.0
|
||||||
with:
|
with:
|
||||||
node-version-file: web/package.json
|
node-version: '16'
|
||||||
cache: "npm"
|
cache: 'npm'
|
||||||
cache-dependency-path: web/package-lock.json
|
cache-dependency-path: web/package-lock.json
|
||||||
- name: Setup go
|
|
||||||
uses: actions/setup-go@v4
|
|
||||||
with:
|
|
||||||
go-version-file: "go.mod"
|
|
||||||
- name: Setup dependencies
|
- name: Setup dependencies
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
export PSQL_TAG=${{ inputs.postgresql_version }}
|
|
||||||
docker-compose -f .github/actions/setup/docker-compose.yml up -d
|
docker-compose -f .github/actions/setup/docker-compose.yml up -d
|
||||||
|
poetry env use python3.10
|
||||||
poetry install
|
poetry install
|
||||||
cd web && npm ci
|
npm install -g pyright@1.1.136
|
||||||
- name: Generate config
|
- name: Generate config
|
||||||
shell: poetry run python {0}
|
shell: poetry run python {0}
|
||||||
run: |
|
run: |
|
||||||
|
|
|
@ -1,21 +1,23 @@
|
||||||
version: "3.7"
|
version: '3.7'
|
||||||
|
|
||||||
services:
|
services:
|
||||||
postgresql:
|
postgresql:
|
||||||
image: docker.io/library/postgres:${PSQL_TAG:-12}
|
container_name: postgres
|
||||||
|
image: library/postgres:12
|
||||||
volumes:
|
volumes:
|
||||||
- db-data:/var/lib/postgresql/data
|
- db-data:/var/lib/postgresql/data
|
||||||
environment:
|
environment:
|
||||||
POSTGRES_USER: authentik
|
POSTGRES_USER: authentik
|
||||||
POSTGRES_PASSWORD: "EK-5jnKfjrGRm<77"
|
POSTGRES_PASSWORD: "EK-5jnKfjrGRm<77"
|
||||||
POSTGRES_DB: authentik
|
POSTGRES_DB: authentik
|
||||||
ports:
|
ports:
|
||||||
- 5432:5432
|
- 5432:5432
|
||||||
restart: always
|
restart: always
|
||||||
redis:
|
redis:
|
||||||
image: docker.io/library/redis
|
container_name: redis
|
||||||
|
image: library/redis
|
||||||
ports:
|
ports:
|
||||||
- 6379:6379
|
- 6379:6379
|
||||||
restart: always
|
restart: always
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
|
|
|
@ -1,2 +0,0 @@
|
||||||
enabled: true
|
|
||||||
preservePullRequestTitle: true
|
|
|
@ -1,10 +1,3 @@
|
||||||
coverage:
|
coverage:
|
||||||
status:
|
precision: 2
|
||||||
project:
|
round: up
|
||||||
default:
|
|
||||||
target: auto
|
|
||||||
# adjust accordingly based on how flaky your tests are
|
|
||||||
# this allows a 1% drop from the previous base commit coverage
|
|
||||||
threshold: 1%
|
|
||||||
comment:
|
|
||||||
after_n_builds: 3
|
|
||||||
|
|
|
@ -1 +0,0 @@
|
||||||
authentic->authentik
|
|
|
@ -1,4 +1,3 @@
|
||||||
keypair
|
keypair
|
||||||
keypairs
|
keypairs
|
||||||
hass
|
hass
|
||||||
warmup
|
|
||||||
|
|
|
@ -1,121 +1,62 @@
|
||||||
version: 2
|
version: 2
|
||||||
updates:
|
updates:
|
||||||
- package-ecosystem: "github-actions"
|
- package-ecosystem: "github-actions"
|
||||||
directory: "/"
|
directory: "/"
|
||||||
schedule:
|
schedule:
|
||||||
interval: daily
|
interval: daily
|
||||||
time: "04:00"
|
time: "04:00"
|
||||||
open-pull-requests-limit: 10
|
open-pull-requests-limit: 10
|
||||||
commit-message:
|
reviewers:
|
||||||
prefix: "ci:"
|
- "@goauthentik/core"
|
||||||
labels:
|
commit-message:
|
||||||
- dependencies
|
prefix: "ci:"
|
||||||
- package-ecosystem: gomod
|
- package-ecosystem: gomod
|
||||||
directory: "/"
|
directory: "/"
|
||||||
schedule:
|
schedule:
|
||||||
interval: daily
|
interval: daily
|
||||||
time: "04:00"
|
time: "04:00"
|
||||||
open-pull-requests-limit: 10
|
open-pull-requests-limit: 10
|
||||||
commit-message:
|
reviewers:
|
||||||
prefix: "core:"
|
- "@goauthentik/core"
|
||||||
labels:
|
commit-message:
|
||||||
- dependencies
|
prefix: "core:"
|
||||||
- package-ecosystem: npm
|
- package-ecosystem: npm
|
||||||
directory: "/web"
|
directory: "/web"
|
||||||
schedule:
|
schedule:
|
||||||
interval: daily
|
interval: daily
|
||||||
time: "04:00"
|
time: "04:00"
|
||||||
labels:
|
open-pull-requests-limit: 10
|
||||||
- dependencies
|
reviewers:
|
||||||
open-pull-requests-limit: 10
|
- "@goauthentik/core"
|
||||||
commit-message:
|
commit-message:
|
||||||
prefix: "web:"
|
prefix: "web:"
|
||||||
# TODO: deduplicate these groups
|
- package-ecosystem: npm
|
||||||
groups:
|
directory: "/website"
|
||||||
sentry:
|
schedule:
|
||||||
patterns:
|
interval: daily
|
||||||
- "@sentry/*"
|
time: "04:00"
|
||||||
babel:
|
open-pull-requests-limit: 10
|
||||||
patterns:
|
reviewers:
|
||||||
- "@babel/*"
|
- "@goauthentik/core"
|
||||||
- "babel-*"
|
commit-message:
|
||||||
eslint:
|
prefix: "website:"
|
||||||
patterns:
|
- package-ecosystem: pip
|
||||||
- "@typescript-eslint/*"
|
directory: "/"
|
||||||
- "eslint"
|
schedule:
|
||||||
- "eslint-*"
|
interval: daily
|
||||||
storybook:
|
time: "04:00"
|
||||||
patterns:
|
open-pull-requests-limit: 10
|
||||||
- "@storybook/*"
|
reviewers:
|
||||||
- "*storybook*"
|
- "@goauthentik/core"
|
||||||
esbuild:
|
commit-message:
|
||||||
patterns:
|
prefix: "core:"
|
||||||
- "@esbuild/*"
|
- package-ecosystem: docker
|
||||||
- package-ecosystem: npm
|
directory: "/"
|
||||||
directory: "/tests/wdio"
|
schedule:
|
||||||
schedule:
|
interval: daily
|
||||||
interval: daily
|
time: "04:00"
|
||||||
time: "04:00"
|
open-pull-requests-limit: 10
|
||||||
labels:
|
reviewers:
|
||||||
- dependencies
|
- "@goauthentik/core"
|
||||||
open-pull-requests-limit: 10
|
commit-message:
|
||||||
commit-message:
|
prefix: "core:"
|
||||||
prefix: "web:"
|
|
||||||
# TODO: deduplicate these groups
|
|
||||||
groups:
|
|
||||||
sentry:
|
|
||||||
patterns:
|
|
||||||
- "@sentry/*"
|
|
||||||
babel:
|
|
||||||
patterns:
|
|
||||||
- "@babel/*"
|
|
||||||
- "babel-*"
|
|
||||||
eslint:
|
|
||||||
patterns:
|
|
||||||
- "@typescript-eslint/*"
|
|
||||||
- "eslint"
|
|
||||||
- "eslint-*"
|
|
||||||
storybook:
|
|
||||||
patterns:
|
|
||||||
- "@storybook/*"
|
|
||||||
- "*storybook*"
|
|
||||||
esbuild:
|
|
||||||
patterns:
|
|
||||||
- "@esbuild/*"
|
|
||||||
wdio:
|
|
||||||
patterns:
|
|
||||||
- "@wdio/*"
|
|
||||||
- package-ecosystem: npm
|
|
||||||
directory: "/website"
|
|
||||||
schedule:
|
|
||||||
interval: daily
|
|
||||||
time: "04:00"
|
|
||||||
open-pull-requests-limit: 10
|
|
||||||
commit-message:
|
|
||||||
prefix: "website:"
|
|
||||||
labels:
|
|
||||||
- dependencies
|
|
||||||
groups:
|
|
||||||
docusaurus:
|
|
||||||
patterns:
|
|
||||||
- "@docusaurus/*"
|
|
||||||
- package-ecosystem: pip
|
|
||||||
directory: "/"
|
|
||||||
schedule:
|
|
||||||
interval: daily
|
|
||||||
time: "04:00"
|
|
||||||
open-pull-requests-limit: 10
|
|
||||||
commit-message:
|
|
||||||
prefix: "core:"
|
|
||||||
labels:
|
|
||||||
- dependencies
|
|
||||||
- package-ecosystem: docker
|
|
||||||
directory: "/"
|
|
||||||
schedule:
|
|
||||||
interval: daily
|
|
||||||
time: "04:00"
|
|
||||||
open-pull-requests-limit: 10
|
|
||||||
commit-message:
|
|
||||||
prefix: "core:"
|
|
||||||
labels:
|
|
||||||
- dependencies
|
|
||||||
|
|
|
@ -1,35 +1,19 @@
|
||||||
<!--
|
<!--
|
||||||
👋 Hi there! Welcome.
|
👋 Hello there! Welcome.
|
||||||
|
|
||||||
Please check the Contributing guidelines: https://goauthentik.io/developer-docs/#how-can-i-contribute
|
Please check the [Contributing guidelines](https://github.com/goauthentik/authentik/blob/main/CONTRIBUTING.md#how-can-i-contribute).
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Details
|
# Details
|
||||||
|
* **Does this resolve an issue?**
|
||||||
|
Resolves #
|
||||||
|
|
||||||
<!--
|
## Changes
|
||||||
Explain what this PR changes, what the rationale behind the change is, if any new requirements are introduced or any breaking changes caused by this PR.
|
### New Features
|
||||||
|
* Adds feature which does x, y, and z.
|
||||||
|
|
||||||
Ideally also link an Issue for context that this PR will close using `closes #`
|
### Breaking Changes
|
||||||
-->
|
* Adds breaking change which causes \<issue\>.
|
||||||
REPLACE ME
|
|
||||||
|
|
||||||
---
|
## Additional
|
||||||
|
Any further notes or comments you want to make.
|
||||||
## Checklist
|
|
||||||
|
|
||||||
- [ ] Local tests pass (`ak test authentik/`)
|
|
||||||
- [ ] The code has been formatted (`make lint-fix`)
|
|
||||||
|
|
||||||
If an API change has been made
|
|
||||||
|
|
||||||
- [ ] The API schema has been updated (`make gen-build`)
|
|
||||||
|
|
||||||
If changes to the frontend have been made
|
|
||||||
|
|
||||||
- [ ] The code has been formatted (`make web`)
|
|
||||||
- [ ] The translation files have been updated (`make i18n-extract`)
|
|
||||||
|
|
||||||
If applicable
|
|
||||||
|
|
||||||
- [ ] The documentation has been updated
|
|
||||||
- [ ] The documentation has been formatted (`make website`)
|
|
||||||
|
|
|
@ -0,0 +1,18 @@
|
||||||
|
# Number of days of inactivity before an issue becomes stale
|
||||||
|
daysUntilStale: 60
|
||||||
|
# Number of days of inactivity before a stale issue is closed
|
||||||
|
daysUntilClose: 7
|
||||||
|
# Issues with these labels will never be considered stale
|
||||||
|
exemptLabels:
|
||||||
|
- pinned
|
||||||
|
- security
|
||||||
|
- pr_wanted
|
||||||
|
- enhancement
|
||||||
|
- bug/confirmed
|
||||||
|
- enhancement/confirmed
|
||||||
|
- question
|
||||||
|
# Comment to post when marking an issue as stale. Set to `false` to disable
|
||||||
|
markComment: >
|
||||||
|
This issue has been automatically marked as stale because it has not had
|
||||||
|
recent activity. It will be closed if no further activity occurs. Thank you
|
||||||
|
for your contributions.
|
|
@ -1,16 +0,0 @@
|
||||||
git:
|
|
||||||
filters:
|
|
||||||
- filter_type: file
|
|
||||||
# all supported i18n types: https://docs.transifex.com/formats
|
|
||||||
file_format: XLIFF
|
|
||||||
source_language: en
|
|
||||||
source_file: web/xliff/en.xlf
|
|
||||||
# path expression to translation files, must contain <lang> placeholder
|
|
||||||
translation_files_expression: "web/xliff/<lang>.xlf"
|
|
||||||
- filter_type: file
|
|
||||||
# all supported i18n types: https://docs.transifex.com/formats
|
|
||||||
file_format: PO
|
|
||||||
source_language: en
|
|
||||||
source_file: locale/en/LC_MESSAGES/django.po
|
|
||||||
# path expression to translation files, must contain <lang> placeholder
|
|
||||||
translation_files_expression: "locale/<lang>/LC_MESSAGES/django.po"
|
|
|
@ -11,7 +11,6 @@ on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- version-*
|
|
||||||
|
|
||||||
env:
|
env:
|
||||||
POSTGRES_DB: authentik
|
POSTGRES_DB: authentik
|
||||||
|
@ -24,17 +23,15 @@ jobs:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
job:
|
job:
|
||||||
- bandit
|
|
||||||
- black
|
|
||||||
- codespell
|
|
||||||
- isort
|
|
||||||
- pending-migrations
|
|
||||||
- pylint
|
- pylint
|
||||||
|
- black
|
||||||
|
- isort
|
||||||
|
- bandit
|
||||||
- pyright
|
- pyright
|
||||||
- ruff
|
- pending-migrations
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- name: Setup authentik env
|
- name: Setup authentik env
|
||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
- name: run job
|
- name: run job
|
||||||
|
@ -42,44 +39,30 @@ jobs:
|
||||||
test-migrations:
|
test-migrations:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- name: Setup authentik env
|
- name: Setup authentik env
|
||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
- name: run migrations
|
- name: run migrations
|
||||||
run: poetry run python -m lifecycle.migrate
|
run: poetry run python -m lifecycle.migrate
|
||||||
test-migrations-from-stable:
|
test-migrations-from-stable:
|
||||||
name: test-migrations-from-stable - PostgreSQL ${{ matrix.psql }}
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
psql:
|
|
||||||
- 12-alpine
|
|
||||||
- 15-alpine
|
|
||||||
- 16-alpine
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- name: Setup authentik env
|
- name: Setup authentik env
|
||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
with:
|
|
||||||
postgresql_version: ${{ matrix.psql }}
|
|
||||||
- name: checkout stable
|
- name: checkout stable
|
||||||
run: |
|
run: |
|
||||||
# Delete all poetry envs
|
|
||||||
rm -rf /home/runner/.cache/pypoetry
|
|
||||||
# Copy current, latest config to local
|
# Copy current, latest config to local
|
||||||
cp authentik/lib/default.yml local.env.yml
|
cp authentik/lib/default.yml local.env.yml
|
||||||
cp -R .github ..
|
cp -R .github ..
|
||||||
cp -R scripts ..
|
cp -R scripts ..
|
||||||
git checkout version/$(python -c "from authentik import __version__; print(__version__)")
|
git checkout $(git describe --abbrev=0 --match 'version/*')
|
||||||
rm -rf .github/ scripts/
|
rm -rf .github/ scripts/
|
||||||
mv ../.github ../scripts .
|
mv ../.github ../scripts .
|
||||||
- name: Setup authentik env (ensure stable deps are installed)
|
- name: Setup authentik env (ensure stable deps are installed)
|
||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
with:
|
|
||||||
postgresql_version: ${{ matrix.psql }}
|
|
||||||
- name: run migrations to stable
|
- name: run migrations to stable
|
||||||
run: poetry run python -m lifecycle.migrate
|
run: poetry run python -m lifecycle.migrate
|
||||||
- name: checkout current code
|
- name: checkout current code
|
||||||
|
@ -89,84 +72,61 @@ jobs:
|
||||||
git reset --hard HEAD
|
git reset --hard HEAD
|
||||||
git clean -d -fx .
|
git clean -d -fx .
|
||||||
git checkout $GITHUB_SHA
|
git checkout $GITHUB_SHA
|
||||||
# Delete previous poetry env
|
|
||||||
rm -rf $(poetry env info --path)
|
|
||||||
poetry install
|
poetry install
|
||||||
- name: Setup authentik env (ensure latest deps are installed)
|
- name: Setup authentik env (ensure latest deps are installed)
|
||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
with:
|
|
||||||
postgresql_version: ${{ matrix.psql }}
|
|
||||||
- name: migrate to latest
|
- name: migrate to latest
|
||||||
run: poetry run python -m lifecycle.migrate
|
run: poetry run python -m lifecycle.migrate
|
||||||
test-unittest:
|
test-unittest:
|
||||||
name: test-unittest - PostgreSQL ${{ matrix.psql }}
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
timeout-minutes: 30
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
psql:
|
|
||||||
- 12-alpine
|
|
||||||
- 15-alpine
|
|
||||||
- 16-alpine
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- name: Setup authentik env
|
- name: Setup authentik env
|
||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
|
- uses: testspace-com/setup-testspace@v1
|
||||||
with:
|
with:
|
||||||
postgresql_version: ${{ matrix.psql }}
|
domain: ${{github.repository_owner}}
|
||||||
- name: run unittest
|
- name: run unittest
|
||||||
run: |
|
run: |
|
||||||
poetry run make test
|
poetry run make test
|
||||||
poetry run coverage xml
|
poetry run coverage xml
|
||||||
|
- name: run testspace
|
||||||
|
if: ${{ always() }}
|
||||||
|
run: |
|
||||||
|
testspace [unittest]unittest.xml --link=codecov
|
||||||
- if: ${{ always() }}
|
- if: ${{ always() }}
|
||||||
uses: codecov/codecov-action@v3
|
uses: codecov/codecov-action@v3
|
||||||
with:
|
|
||||||
flags: unit
|
|
||||||
test-integration:
|
test-integration:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
timeout-minutes: 30
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- name: Setup authentik env
|
- name: Setup authentik env
|
||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
|
- uses: testspace-com/setup-testspace@v1
|
||||||
|
with:
|
||||||
|
domain: ${{github.repository_owner}}
|
||||||
- name: Create k8s Kind Cluster
|
- name: Create k8s Kind Cluster
|
||||||
uses: helm/kind-action@v1.8.0
|
uses: helm/kind-action@v1.3.0
|
||||||
- name: run integration
|
- name: run integration
|
||||||
run: |
|
run: |
|
||||||
poetry run coverage run manage.py test tests/integration
|
poetry run make test-integration
|
||||||
poetry run coverage xml
|
poetry run coverage xml
|
||||||
|
- name: run testspace
|
||||||
|
if: ${{ always() }}
|
||||||
|
run: |
|
||||||
|
testspace [integration]unittest.xml --link=codecov
|
||||||
- if: ${{ always() }}
|
- if: ${{ always() }}
|
||||||
uses: codecov/codecov-action@v3
|
uses: codecov/codecov-action@v3
|
||||||
with:
|
test-e2e-provider:
|
||||||
flags: integration
|
|
||||||
test-e2e:
|
|
||||||
name: test-e2e (${{ matrix.job.name }})
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
timeout-minutes: 30
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
job:
|
|
||||||
- name: proxy
|
|
||||||
glob: tests/e2e/test_provider_proxy*
|
|
||||||
- name: oauth
|
|
||||||
glob: tests/e2e/test_provider_oauth2* tests/e2e/test_source_oauth*
|
|
||||||
- name: oauth-oidc
|
|
||||||
glob: tests/e2e/test_provider_oidc*
|
|
||||||
- name: saml
|
|
||||||
glob: tests/e2e/test_provider_saml* tests/e2e/test_source_saml*
|
|
||||||
- name: ldap
|
|
||||||
glob: tests/e2e/test_provider_ldap* tests/e2e/test_source_ldap*
|
|
||||||
- name: radius
|
|
||||||
glob: tests/e2e/test_provider_radius*
|
|
||||||
- name: flows
|
|
||||||
glob: tests/e2e/test_flows*
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- name: Setup authentik env
|
- name: Setup authentik env
|
||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
- name: Setup e2e env (chrome, etc)
|
- uses: testspace-com/setup-testspace@v1
|
||||||
|
with:
|
||||||
|
domain: ${{github.repository_owner}}
|
||||||
|
- name: Setup authentik env
|
||||||
run: |
|
run: |
|
||||||
docker-compose -f tests/e2e/docker-compose.yml up -d
|
docker-compose -f tests/e2e/docker-compose.yml up -d
|
||||||
- id: cache-web
|
- id: cache-web
|
||||||
|
@ -179,16 +139,52 @@ jobs:
|
||||||
working-directory: web
|
working-directory: web
|
||||||
run: |
|
run: |
|
||||||
npm ci
|
npm ci
|
||||||
make -C .. gen-client-ts
|
make -C .. gen-client-web
|
||||||
npm run build
|
npm run build
|
||||||
- name: run e2e
|
- name: run e2e
|
||||||
run: |
|
run: |
|
||||||
poetry run coverage run manage.py test ${{ matrix.job.glob }}
|
poetry run make test-e2e-provider
|
||||||
poetry run coverage xml
|
poetry run coverage xml
|
||||||
|
- name: run testspace
|
||||||
|
if: ${{ always() }}
|
||||||
|
run: |
|
||||||
|
testspace [e2e-provider]unittest.xml --link=codecov
|
||||||
- if: ${{ always() }}
|
- if: ${{ always() }}
|
||||||
uses: codecov/codecov-action@v3
|
uses: codecov/codecov-action@v3
|
||||||
|
test-e2e-rest:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- name: Setup authentik env
|
||||||
|
uses: ./.github/actions/setup
|
||||||
|
- uses: testspace-com/setup-testspace@v1
|
||||||
with:
|
with:
|
||||||
flags: e2e
|
domain: ${{github.repository_owner}}
|
||||||
|
- name: Setup authentik env
|
||||||
|
run: |
|
||||||
|
docker-compose -f tests/e2e/docker-compose.yml up -d
|
||||||
|
- id: cache-web
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: web/dist
|
||||||
|
key: ${{ runner.os }}-web-${{ hashFiles('web/package-lock.json', 'web/src/**') }}
|
||||||
|
- name: prepare web ui
|
||||||
|
if: steps.cache-web.outputs.cache-hit != 'true'
|
||||||
|
working-directory: web/
|
||||||
|
run: |
|
||||||
|
npm ci
|
||||||
|
make -C .. gen-client-web
|
||||||
|
npm run build
|
||||||
|
- name: run e2e
|
||||||
|
run: |
|
||||||
|
poetry run make test-e2e-rest
|
||||||
|
poetry run coverage xml
|
||||||
|
- name: run testspace
|
||||||
|
if: ${{ always() }}
|
||||||
|
run: |
|
||||||
|
testspace [e2e-rest]unittest.xml --link=codecov
|
||||||
|
- if: ${{ always() }}
|
||||||
|
uses: codecov/codecov-action@v3
|
||||||
ci-core-mark:
|
ci-core-mark:
|
||||||
needs:
|
needs:
|
||||||
- lint
|
- lint
|
||||||
|
@ -196,108 +192,46 @@ jobs:
|
||||||
- test-migrations-from-stable
|
- test-migrations-from-stable
|
||||||
- test-unittest
|
- test-unittest
|
||||||
- test-integration
|
- test-integration
|
||||||
- test-e2e
|
- test-e2e-rest
|
||||||
|
- test-e2e-provider
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- run: echo mark
|
- run: echo mark
|
||||||
build:
|
build:
|
||||||
needs: ci-core-mark
|
needs: ci-core-mark
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
|
||||||
# Needed to upload contianer images to ghcr.io
|
|
||||||
packages: write
|
|
||||||
timeout-minutes: 120
|
timeout-minutes: 120
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
arch:
|
||||||
|
- 'linux/amd64'
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
with:
|
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v3.0.0
|
uses: docker/setup-qemu-action@v2.0.0
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@v2
|
||||||
- name: prepare variables
|
- name: prepare variables
|
||||||
uses: ./.github/actions/docker-push-variables
|
uses: ./.github/actions/docker-push-variables
|
||||||
id: ev
|
id: ev
|
||||||
env:
|
env:
|
||||||
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
||||||
- name: Login to Container Registry
|
- name: Login to Container Registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@v2
|
||||||
if: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
if: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
||||||
with:
|
with:
|
||||||
registry: ghcr.io
|
registry: ghcr.io
|
||||||
username: ${{ github.repository_owner }}
|
username: ${{ github.repository_owner }}
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
- name: generate ts client
|
- name: Building Docker Image
|
||||||
run: make gen-client-ts
|
uses: docker/build-push-action@v3
|
||||||
- name: Build Docker Image
|
|
||||||
uses: docker/build-push-action@v5
|
|
||||||
with:
|
with:
|
||||||
context: .
|
|
||||||
secrets: |
|
|
||||||
GEOIPUPDATE_ACCOUNT_ID=${{ secrets.GEOIPUPDATE_ACCOUNT_ID }}
|
|
||||||
GEOIPUPDATE_LICENSE_KEY=${{ secrets.GEOIPUPDATE_LICENSE_KEY }}
|
|
||||||
push: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
push: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
||||||
tags: |
|
tags: |
|
||||||
ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.branchNameContainer }}
|
ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.branchNameContainer }}
|
||||||
ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.sha }}
|
ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.branchNameContainer }}-${{ steps.ev.outputs.timestamp }}-${{ steps.ev.outputs.sha }}
|
||||||
ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.branchNameContainer }}-${{ steps.ev.outputs.timestamp }}-${{ steps.ev.outputs.shortHash }}
|
|
||||||
build-args: |
|
build-args: |
|
||||||
GIT_BUILD_HASH=${{ steps.ev.outputs.sha }}
|
GIT_BUILD_HASH=${{ steps.ev.outputs.sha }}
|
||||||
VERSION=${{ steps.ev.outputs.version }}
|
|
||||||
VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }}
|
VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }}
|
||||||
cache-from: type=gha
|
platforms: ${{ matrix.arch }}
|
||||||
cache-to: type=gha,mode=max
|
|
||||||
- name: Comment on PR
|
|
||||||
if: github.event_name == 'pull_request'
|
|
||||||
continue-on-error: true
|
|
||||||
uses: ./.github/actions/comment-pr-instructions
|
|
||||||
with:
|
|
||||||
tag: gh-${{ steps.ev.outputs.branchNameContainer }}-${{ steps.ev.outputs.timestamp }}-${{ steps.ev.outputs.shortHash }}
|
|
||||||
build-arm64:
|
|
||||||
needs: ci-core-mark
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
# Needed to upload contianer images to ghcr.io
|
|
||||||
packages: write
|
|
||||||
timeout-minutes: 120
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
|
||||||
- name: Set up QEMU
|
|
||||||
uses: docker/setup-qemu-action@v3.0.0
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
uses: docker/setup-buildx-action@v3
|
|
||||||
- name: prepare variables
|
|
||||||
uses: ./.github/actions/docker-push-variables
|
|
||||||
id: ev
|
|
||||||
env:
|
|
||||||
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
|
||||||
- name: Login to Container Registry
|
|
||||||
uses: docker/login-action@v3
|
|
||||||
if: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
|
||||||
with:
|
|
||||||
registry: ghcr.io
|
|
||||||
username: ${{ github.repository_owner }}
|
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
- name: generate ts client
|
|
||||||
run: make gen-client-ts
|
|
||||||
- name: Build Docker Image
|
|
||||||
uses: docker/build-push-action@v5
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
secrets: |
|
|
||||||
GEOIPUPDATE_ACCOUNT_ID=${{ secrets.GEOIPUPDATE_ACCOUNT_ID }}
|
|
||||||
GEOIPUPDATE_LICENSE_KEY=${{ secrets.GEOIPUPDATE_LICENSE_KEY }}
|
|
||||||
push: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
|
||||||
tags: |
|
|
||||||
ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.branchNameContainer }}-arm64
|
|
||||||
ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.sha }}-arm64
|
|
||||||
ghcr.io/goauthentik/dev-server:gh-${{ steps.ev.outputs.branchNameContainer }}-${{ steps.ev.outputs.timestamp }}-${{ steps.ev.outputs.shortHash }}-arm64
|
|
||||||
build-args: |
|
|
||||||
GIT_BUILD_HASH=${{ steps.ev.outputs.sha }}
|
|
||||||
VERSION=${{ steps.ev.outputs.version }}
|
|
||||||
VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }}
|
|
||||||
platforms: linux/arm64
|
|
||||||
cache-from: type=gha
|
|
||||||
cache-to: type=gha,mode=max
|
|
||||||
|
|
|
@ -9,16 +9,15 @@ on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- version-*
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint-golint:
|
lint-golint:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-go@v4
|
- uses: actions/setup-go@v3
|
||||||
with:
|
with:
|
||||||
go-version-file: "go.mod"
|
go-version: "^1.17"
|
||||||
- name: Prepare and generate API
|
- name: Prepare and generate API
|
||||||
run: |
|
run: |
|
||||||
# Create folder structure for go embeds
|
# Create folder structure for go embeds
|
||||||
|
@ -29,19 +28,13 @@ jobs:
|
||||||
run: make gen-client-go
|
run: make gen-client-go
|
||||||
- name: golangci-lint
|
- name: golangci-lint
|
||||||
uses: golangci/golangci-lint-action@v3
|
uses: golangci/golangci-lint-action@v3
|
||||||
with:
|
|
||||||
version: v1.54.2
|
|
||||||
args: --timeout 5000s --verbose
|
|
||||||
skip-cache: true
|
|
||||||
test-unittest:
|
test-unittest:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-go@v4
|
- uses: actions/setup-go@v3
|
||||||
with:
|
with:
|
||||||
go-version-file: "go.mod"
|
go-version: "^1.17"
|
||||||
- name: Setup authentik env
|
|
||||||
uses: ./.github/actions/setup
|
|
||||||
- name: Generate API
|
- name: Generate API
|
||||||
run: make gen-client-go
|
run: make gen-client-go
|
||||||
- name: Go unittests
|
- name: Go unittests
|
||||||
|
@ -54,7 +47,7 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- run: echo mark
|
- run: echo mark
|
||||||
build-container:
|
build:
|
||||||
timeout-minutes: 120
|
timeout-minutes: 120
|
||||||
needs:
|
needs:
|
||||||
- ci-outpost-mark
|
- ci-outpost-mark
|
||||||
|
@ -64,26 +57,22 @@ jobs:
|
||||||
type:
|
type:
|
||||||
- proxy
|
- proxy
|
||||||
- ldap
|
- ldap
|
||||||
- radius
|
arch:
|
||||||
|
- 'linux/amd64'
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
|
||||||
# Needed to upload contianer images to ghcr.io
|
|
||||||
packages: write
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
with:
|
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v3.0.0
|
uses: docker/setup-qemu-action@v2.0.0
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@v2
|
||||||
- name: prepare variables
|
- name: prepare variables
|
||||||
uses: ./.github/actions/docker-push-variables
|
uses: ./.github/actions/docker-push-variables
|
||||||
id: ev
|
id: ev
|
||||||
env:
|
env:
|
||||||
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
||||||
- name: Login to Container Registry
|
- name: Login to Container Registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@v2
|
||||||
if: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
if: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
||||||
with:
|
with:
|
||||||
registry: ghcr.io
|
registry: ghcr.io
|
||||||
|
@ -91,23 +80,20 @@ jobs:
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
- name: Generate API
|
- name: Generate API
|
||||||
run: make gen-client-go
|
run: make gen-client-go
|
||||||
- name: Build Docker Image
|
- name: Building Docker Image
|
||||||
uses: docker/build-push-action@v5
|
uses: docker/build-push-action@v3
|
||||||
with:
|
with:
|
||||||
push: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
push: ${{ steps.ev.outputs.shouldBuild == 'true' }}
|
||||||
tags: |
|
tags: |
|
||||||
ghcr.io/goauthentik/dev-${{ matrix.type }}:gh-${{ steps.ev.outputs.branchNameContainer }}
|
ghcr.io/goauthentik/dev-${{ matrix.type }}:gh-${{ steps.ev.outputs.branchNameContainer }}
|
||||||
|
ghcr.io/goauthentik/dev-${{ matrix.type }}:gh-${{ steps.ev.outputs.branchNameContainer }}-${{ steps.ev.outputs.timestamp }}
|
||||||
ghcr.io/goauthentik/dev-${{ matrix.type }}:gh-${{ steps.ev.outputs.sha }}
|
ghcr.io/goauthentik/dev-${{ matrix.type }}:gh-${{ steps.ev.outputs.sha }}
|
||||||
file: ${{ matrix.type }}.Dockerfile
|
file: ${{ matrix.type }}.Dockerfile
|
||||||
build-args: |
|
build-args: |
|
||||||
GIT_BUILD_HASH=${{ steps.ev.outputs.sha }}
|
GIT_BUILD_HASH=${{ steps.ev.outputs.sha }}
|
||||||
VERSION=${{ steps.ev.outputs.version }}
|
|
||||||
VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }}
|
VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }}
|
||||||
platforms: linux/amd64,linux/arm64
|
platforms: ${{ matrix.arch }}
|
||||||
context: .
|
build-outpost-binary:
|
||||||
cache-from: type=gha
|
|
||||||
cache-to: type=gha,mode=max
|
|
||||||
build-binary:
|
|
||||||
timeout-minutes: 120
|
timeout-minutes: 120
|
||||||
needs:
|
needs:
|
||||||
- ci-outpost-mark
|
- ci-outpost-mark
|
||||||
|
@ -118,20 +104,17 @@ jobs:
|
||||||
type:
|
type:
|
||||||
- proxy
|
- proxy
|
||||||
- ldap
|
- ldap
|
||||||
- radius
|
|
||||||
goos: [linux]
|
goos: [linux]
|
||||||
goarch: [amd64, arm64]
|
goarch: [amd64, arm64]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
|
- uses: actions/setup-go@v3
|
||||||
with:
|
with:
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
go-version: "^1.17"
|
||||||
- uses: actions/setup-go@v4
|
- uses: actions/setup-node@v3.4.1
|
||||||
with:
|
with:
|
||||||
go-version-file: "go.mod"
|
node-version: '16'
|
||||||
- uses: actions/setup-node@v4
|
cache: 'npm'
|
||||||
with:
|
|
||||||
node-version-file: web/package.json
|
|
||||||
cache: "npm"
|
|
||||||
cache-dependency-path: web/package-lock.json
|
cache-dependency-path: web/package-lock.json
|
||||||
- name: Generate API
|
- name: Generate API
|
||||||
run: make gen-client-go
|
run: make gen-client-go
|
||||||
|
@ -145,5 +128,8 @@ jobs:
|
||||||
set -x
|
set -x
|
||||||
export GOOS=${{ matrix.goos }}
|
export GOOS=${{ matrix.goos }}
|
||||||
export GOARCH=${{ matrix.goarch }}
|
export GOARCH=${{ matrix.goarch }}
|
||||||
export CGO_ENABLED=0
|
|
||||||
go build -tags=outpost_static_embed -v -o ./authentik-outpost-${{ matrix.type }}_${{ matrix.goos }}_${{ matrix.goarch }} ./cmd/${{ matrix.type }}
|
go build -tags=outpost_static_embed -v -o ./authentik-outpost-${{ matrix.type }}_${{ matrix.goos }}_${{ matrix.goarch }} ./cmd/${{ matrix.type }}
|
||||||
|
- uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: authentik-outpost-${{ matrix.type }}_${{ matrix.goos }}_${{ matrix.goarch }}
|
||||||
|
path: ./authentik-outpost-${{ matrix.type }}_${{ matrix.goos }}_${{ matrix.goarch }}
|
||||||
|
|
|
@ -9,77 +9,48 @@ on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- version-*
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint-eslint:
|
lint-eslint:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
project:
|
|
||||||
- web
|
|
||||||
- tests/wdio
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v3.4.1
|
||||||
with:
|
with:
|
||||||
node-version-file: ${{ matrix.project }}/package.json
|
node-version: '16'
|
||||||
cache: "npm"
|
cache: 'npm'
|
||||||
cache-dependency-path: ${{ matrix.project }}/package-lock.json
|
|
||||||
- working-directory: ${{ matrix.project }}/
|
|
||||||
run: npm ci
|
|
||||||
- name: Generate API
|
|
||||||
run: make gen-client-ts
|
|
||||||
- name: Eslint
|
|
||||||
working-directory: ${{ matrix.project }}/
|
|
||||||
run: npm run lint
|
|
||||||
lint-build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: web/package.json
|
|
||||||
cache: "npm"
|
|
||||||
cache-dependency-path: web/package-lock.json
|
cache-dependency-path: web/package-lock.json
|
||||||
- working-directory: web/
|
- working-directory: web/
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- name: Generate API
|
- name: Generate API
|
||||||
run: make gen-client-ts
|
run: make gen-client-web
|
||||||
- name: TSC
|
- name: Eslint
|
||||||
working-directory: web/
|
working-directory: web/
|
||||||
run: npm run tsc
|
run: npm run lint
|
||||||
lint-prettier:
|
lint-prettier:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
project:
|
|
||||||
- web
|
|
||||||
- tests/wdio
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v3.4.1
|
||||||
with:
|
with:
|
||||||
node-version-file: ${{ matrix.project }}/package.json
|
node-version: '16'
|
||||||
cache: "npm"
|
cache: 'npm'
|
||||||
cache-dependency-path: ${{ matrix.project }}/package-lock.json
|
cache-dependency-path: web/package-lock.json
|
||||||
- working-directory: ${{ matrix.project }}/
|
- working-directory: web/
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- name: Generate API
|
- name: Generate API
|
||||||
run: make gen-client-ts
|
run: make gen-client-web
|
||||||
- name: prettier
|
- name: prettier
|
||||||
working-directory: ${{ matrix.project }}/
|
working-directory: web/
|
||||||
run: npm run prettier-check
|
run: npm run prettier-check
|
||||||
lint-lit-analyse:
|
lint-lit-analyse:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v3.4.1
|
||||||
with:
|
with:
|
||||||
node-version-file: web/package.json
|
node-version: '16'
|
||||||
cache: "npm"
|
cache: 'npm'
|
||||||
cache-dependency-path: web/package-lock.json
|
cache-dependency-path: web/package-lock.json
|
||||||
- working-directory: web/
|
- working-directory: web/
|
||||||
run: |
|
run: |
|
||||||
|
@ -89,7 +60,7 @@ jobs:
|
||||||
cd node_modules/@goauthentik
|
cd node_modules/@goauthentik
|
||||||
ln -s ../../src/ web
|
ln -s ../../src/ web
|
||||||
- name: Generate API
|
- name: Generate API
|
||||||
run: make gen-client-ts
|
run: make gen-client-web
|
||||||
- name: lit-analyse
|
- name: lit-analyse
|
||||||
working-directory: web/
|
working-directory: web/
|
||||||
run: npm run lit-analyse
|
run: npm run lit-analyse
|
||||||
|
@ -98,7 +69,6 @@ jobs:
|
||||||
- lint-eslint
|
- lint-eslint
|
||||||
- lint-prettier
|
- lint-prettier
|
||||||
- lint-lit-analyse
|
- lint-lit-analyse
|
||||||
- lint-build
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- run: echo mark
|
- run: echo mark
|
||||||
|
@ -107,16 +77,16 @@ jobs:
|
||||||
- ci-web-mark
|
- ci-web-mark
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v3.4.1
|
||||||
with:
|
with:
|
||||||
node-version-file: web/package.json
|
node-version: '16'
|
||||||
cache: "npm"
|
cache: 'npm'
|
||||||
cache-dependency-path: web/package-lock.json
|
cache-dependency-path: web/package-lock.json
|
||||||
- working-directory: web/
|
- working-directory: web/
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- name: Generate API
|
- name: Generate API
|
||||||
run: make gen-client-ts
|
run: make gen-client-web
|
||||||
- name: build
|
- name: build
|
||||||
working-directory: web/
|
working-directory: web/
|
||||||
run: npm run build
|
run: npm run build
|
||||||
|
|
|
@ -9,63 +9,25 @@ on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- version-*
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint-prettier:
|
lint-prettier:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v3.4.1
|
||||||
with:
|
with:
|
||||||
node-version-file: website/package.json
|
node-version: '16'
|
||||||
cache: "npm"
|
cache: 'npm'
|
||||||
cache-dependency-path: website/package-lock.json
|
cache-dependency-path: website/package-lock.json
|
||||||
- working-directory: website/
|
- working-directory: website/
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- name: prettier
|
- name: prettier
|
||||||
working-directory: website/
|
working-directory: website/
|
||||||
run: npm run prettier-check
|
run: npm run prettier-check
|
||||||
test:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: website/package.json
|
|
||||||
cache: "npm"
|
|
||||||
cache-dependency-path: website/package-lock.json
|
|
||||||
- working-directory: website/
|
|
||||||
run: npm ci
|
|
||||||
- name: test
|
|
||||||
working-directory: website/
|
|
||||||
run: npm test
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
name: ${{ matrix.job }}
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
job:
|
|
||||||
- build
|
|
||||||
- build-docs-only
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: website/package.json
|
|
||||||
cache: "npm"
|
|
||||||
cache-dependency-path: website/package-lock.json
|
|
||||||
- working-directory: website/
|
|
||||||
run: npm ci
|
|
||||||
- name: build
|
|
||||||
working-directory: website/
|
|
||||||
run: npm run ${{ matrix.job }}
|
|
||||||
ci-website-mark:
|
ci-website-mark:
|
||||||
needs:
|
needs:
|
||||||
- lint-prettier
|
- lint-prettier
|
||||||
- test
|
|
||||||
- build
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- run: echo mark
|
- run: echo mark
|
||||||
|
|
|
@ -2,11 +2,12 @@ name: "CodeQL"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [main, "*", next, version*]
|
branches: [ main, '*', next, version* ]
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [main]
|
# The branches below must be a subset of the branches above
|
||||||
|
branches: [ main ]
|
||||||
schedule:
|
schedule:
|
||||||
- cron: "30 6 * * 5"
|
- cron: '30 6 * * 5'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
analyze:
|
analyze:
|
||||||
|
@ -20,17 +21,40 @@ jobs:
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
language: ["go", "javascript", "python"]
|
language: [ 'go', 'javascript', 'python' ]
|
||||||
|
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
|
||||||
|
# Learn more:
|
||||||
|
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v3
|
||||||
- name: Setup authentik env
|
|
||||||
uses: ./.github/actions/setup
|
# Initializes the CodeQL tools for scanning.
|
||||||
- name: Initialize CodeQL
|
- name: Initialize CodeQL
|
||||||
uses: github/codeql-action/init@v2
|
uses: github/codeql-action/init@v2
|
||||||
with:
|
with:
|
||||||
languages: ${{ matrix.language }}
|
languages: ${{ matrix.language }}
|
||||||
- name: Autobuild
|
# If you wish to specify custom queries, you can do so here or in a config file.
|
||||||
uses: github/codeql-action/autobuild@v2
|
# By default, queries listed here will override any specified in a config file.
|
||||||
- name: Perform CodeQL Analysis
|
# Prefix the list here with "+" to use these queries and those in the config file.
|
||||||
uses: github/codeql-action/analyze@v2
|
# queries: ./path/to/local/query, your-org/your-repo/queries@main
|
||||||
|
|
||||||
|
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
||||||
|
# If this step fails, then you should remove it and run the build manually (see below)
|
||||||
|
- name: Autobuild
|
||||||
|
uses: github/codeql-action/autobuild@v2
|
||||||
|
|
||||||
|
# ℹ️ Command-line programs to run using the OS shell.
|
||||||
|
# 📚 https://git.io/JvXDl
|
||||||
|
|
||||||
|
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
|
||||||
|
# and modify them (or add more) to build your code if your project
|
||||||
|
# uses a compiled language
|
||||||
|
|
||||||
|
#- run: |
|
||||||
|
# make bootstrap
|
||||||
|
# make release
|
||||||
|
|
||||||
|
- name: Perform CodeQL Analysis
|
||||||
|
uses: github/codeql-action/analyze@v2
|
||||||
|
|
|
@ -1,34 +0,0 @@
|
||||||
---
|
|
||||||
# See https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#force-deleting-cache-entries
|
|
||||||
name: Cleanup cache after PR is closed
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
types:
|
|
||||||
- closed
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
cleanup:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Check out code
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Cleanup
|
|
||||||
run: |
|
|
||||||
gh extension install actions/gh-actions-cache
|
|
||||||
|
|
||||||
REPO=${{ github.repository }}
|
|
||||||
BRANCH="refs/pull/${{ github.event.pull_request.number }}/merge"
|
|
||||||
|
|
||||||
echo "Fetching list of cache key"
|
|
||||||
cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH -L 100 | cut -f 1 )
|
|
||||||
|
|
||||||
# Setting this to not fail the workflow while deleting cache keys.
|
|
||||||
set +e
|
|
||||||
echo "Deleting caches..."
|
|
||||||
for cacheKey in $cacheKeysForPR; do
|
|
||||||
gh actions-cache delete $cacheKey -R $REPO -B $BRANCH --confirm
|
|
||||||
done
|
|
||||||
echo "Done"
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
|
@ -1,8 +1,8 @@
|
||||||
name: ghcr-retention
|
name: ghcr-retention
|
||||||
|
|
||||||
on:
|
on:
|
||||||
# schedule:
|
schedule:
|
||||||
# - cron: "0 0 * * *" # every day at midnight
|
- cron: '0 0 * * *' # every day at midnight
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
@ -10,18 +10,13 @@ jobs:
|
||||||
name: Delete old unused container images
|
name: Delete old unused container images
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- id: generate_token
|
|
||||||
uses: tibdex/github-app-token@v2
|
|
||||||
with:
|
|
||||||
app_id: ${{ secrets.GH_APP_ID }}
|
|
||||||
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
||||||
- name: Delete 'dev' containers older than a week
|
- name: Delete 'dev' containers older than a week
|
||||||
uses: snok/container-retention-policy@v2
|
uses: sondrelg/container-retention-policy@v1
|
||||||
with:
|
with:
|
||||||
image-names: dev-server,dev-ldap,dev-proxy
|
image-names: dev-server,dev-ldap,dev-proxy
|
||||||
cut-off: One week ago UTC
|
cut-off: One week ago UTC
|
||||||
account-type: org
|
account-type: org
|
||||||
org-name: goauthentik
|
org-name: goauthentik
|
||||||
untagged-only: false
|
untagged-only: false
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
token: ${{ secrets.GHCR_CLEANUP_TOKEN }}
|
||||||
skip-tags: gh-next,gh-main
|
skip-tags: gh-next,gh-main
|
||||||
|
|
|
@ -1,61 +0,0 @@
|
||||||
---
|
|
||||||
name: authentik-compress-images
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths:
|
|
||||||
- "**.jpg"
|
|
||||||
- "**.jpeg"
|
|
||||||
- "**.png"
|
|
||||||
- "**.webp"
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- "**.jpg"
|
|
||||||
- "**.jpeg"
|
|
||||||
- "**.png"
|
|
||||||
- "**.webp"
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
compress:
|
|
||||||
name: compress
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
# Don't run on forks. Token will not be available. Will run on main and open a PR anyway
|
|
||||||
if: |
|
|
||||||
github.repository == 'goauthentik/authentik' &&
|
|
||||||
(github.event_name != 'pull_request' ||
|
|
||||||
github.event.pull_request.head.repo.full_name == github.repository)
|
|
||||||
steps:
|
|
||||||
- id: generate_token
|
|
||||||
uses: tibdex/github-app-token@v2
|
|
||||||
with:
|
|
||||||
app_id: ${{ secrets.GH_APP_ID }}
|
|
||||||
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
- name: Compress images
|
|
||||||
id: compress
|
|
||||||
uses: calibreapp/image-actions@main
|
|
||||||
with:
|
|
||||||
githubToken: ${{ steps.generate_token.outputs.token }}
|
|
||||||
compressOnly: ${{ github.event_name != 'pull_request' }}
|
|
||||||
- uses: peter-evans/create-pull-request@v5
|
|
||||||
if: "${{ github.event_name != 'pull_request' && steps.compress.outputs.markdown != '' }}"
|
|
||||||
id: cpr
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
title: "*: Auto compress images"
|
|
||||||
branch-suffix: timestamp
|
|
||||||
commit-messsage: "*: compress images"
|
|
||||||
body: ${{ steps.compress.outputs.markdown }}
|
|
||||||
delete-branch: true
|
|
||||||
signoff: true
|
|
||||||
- uses: peter-evans/enable-pull-request-automerge@v3
|
|
||||||
if: "${{ github.event_name != 'pull_request' && steps.compress.outputs.markdown != '' }}"
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
|
|
||||||
merge-method: squash
|
|
|
@ -1,31 +0,0 @@
|
||||||
name: authentik-publish-source-docs
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
|
|
||||||
env:
|
|
||||||
POSTGRES_DB: authentik
|
|
||||||
POSTGRES_USER: authentik
|
|
||||||
POSTGRES_PASSWORD: "EK-5jnKfjrGRm<77"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
publish-source-docs:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 120
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- name: Setup authentik env
|
|
||||||
uses: ./.github/actions/setup
|
|
||||||
- name: generate docs
|
|
||||||
run: |
|
|
||||||
poetry run make migrate
|
|
||||||
poetry run ak build_source_docs
|
|
||||||
- name: Publish
|
|
||||||
uses: netlify/actions/cli@master
|
|
||||||
with:
|
|
||||||
args: deploy --dir=source_docs --prod
|
|
||||||
env:
|
|
||||||
NETLIFY_SITE_ID: eb246b7b-1d83-4f69-89f7-01a936b4ca59
|
|
||||||
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
|
|
@ -1,21 +0,0 @@
|
||||||
name: authentik-on-release-next-branch
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: "0 12 * * *" # every day at noon
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
# Needed to be able to push to the next branch
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
update-next:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment: internal-production
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
ref: main
|
|
||||||
- run: |
|
|
||||||
git push origin --force main:next
|
|
|
@ -7,41 +7,30 @@ on:
|
||||||
jobs:
|
jobs:
|
||||||
build-server:
|
build-server:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
|
||||||
# Needed to upload contianer images to ghcr.io
|
|
||||||
packages: write
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v3.0.0
|
uses: docker/setup-qemu-action@v2.0.0
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@v2
|
||||||
- name: prepare variables
|
- name: prepare variables
|
||||||
uses: ./.github/actions/docker-push-variables
|
uses: ./.github/actions/docker-push-variables
|
||||||
id: ev
|
id: ev
|
||||||
- name: Docker Login Registry
|
- name: Docker Login Registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@v2
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.DOCKER_USERNAME }}
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||||
- name: Login to GitHub Container Registry
|
- name: Login to GitHub Container Registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@v2
|
||||||
with:
|
with:
|
||||||
registry: ghcr.io
|
registry: ghcr.io
|
||||||
username: ${{ github.repository_owner }}
|
username: ${{ github.repository_owner }}
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
- name: make empty clients
|
- name: Building Docker Image
|
||||||
run: |
|
uses: docker/build-push-action@v3
|
||||||
mkdir -p ./gen-ts-api
|
|
||||||
mkdir -p ./gen-go-api
|
|
||||||
- name: Build Docker Image
|
|
||||||
uses: docker/build-push-action@v5
|
|
||||||
with:
|
with:
|
||||||
context: .
|
|
||||||
push: ${{ github.event_name == 'release' }}
|
push: ${{ github.event_name == 'release' }}
|
||||||
secrets: |
|
|
||||||
GEOIPUPDATE_ACCOUNT_ID=${{ secrets.GEOIPUPDATE_ACCOUNT_ID }}
|
|
||||||
GEOIPUPDATE_LICENSE_KEY=${{ secrets.GEOIPUPDATE_LICENSE_KEY }}
|
|
||||||
tags: |
|
tags: |
|
||||||
beryju/authentik:${{ steps.ev.outputs.version }},
|
beryju/authentik:${{ steps.ev.outputs.version }},
|
||||||
beryju/authentik:${{ steps.ev.outputs.versionFamily }},
|
beryju/authentik:${{ steps.ev.outputs.versionFamily }},
|
||||||
|
@ -50,50 +39,40 @@ jobs:
|
||||||
ghcr.io/goauthentik/server:${{ steps.ev.outputs.versionFamily }},
|
ghcr.io/goauthentik/server:${{ steps.ev.outputs.versionFamily }},
|
||||||
ghcr.io/goauthentik/server:latest
|
ghcr.io/goauthentik/server:latest
|
||||||
platforms: linux/amd64,linux/arm64
|
platforms: linux/amd64,linux/arm64
|
||||||
build-args: |
|
context: .
|
||||||
VERSION=${{ steps.ev.outputs.version }}
|
|
||||||
VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }}
|
|
||||||
build-outpost:
|
build-outpost:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
|
||||||
# Needed to upload contianer images to ghcr.io
|
|
||||||
packages: write
|
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
type:
|
type:
|
||||||
- proxy
|
- proxy
|
||||||
- ldap
|
- ldap
|
||||||
- radius
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-go@v4
|
- uses: actions/setup-go@v3
|
||||||
with:
|
with:
|
||||||
go-version-file: "go.mod"
|
go-version: "^1.17"
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v3.0.0
|
uses: docker/setup-qemu-action@v2.0.0
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@v2
|
||||||
- name: prepare variables
|
- name: prepare variables
|
||||||
uses: ./.github/actions/docker-push-variables
|
uses: ./.github/actions/docker-push-variables
|
||||||
id: ev
|
id: ev
|
||||||
- name: make empty clients
|
|
||||||
run: |
|
|
||||||
mkdir -p ./gen-ts-api
|
|
||||||
mkdir -p ./gen-go-api
|
|
||||||
- name: Docker Login Registry
|
- name: Docker Login Registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@v2
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.DOCKER_USERNAME }}
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||||
- name: Login to GitHub Container Registry
|
- name: Login to GitHub Container Registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@v2
|
||||||
with:
|
with:
|
||||||
registry: ghcr.io
|
registry: ghcr.io
|
||||||
username: ${{ github.repository_owner }}
|
username: ${{ github.repository_owner }}
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
- name: Build Docker Image
|
- name: Building Docker Image
|
||||||
uses: docker/build-push-action@v5
|
uses: docker/build-push-action@v3
|
||||||
with:
|
with:
|
||||||
push: ${{ github.event_name == 'release' }}
|
push: ${{ github.event_name == 'release' }}
|
||||||
tags: |
|
tags: |
|
||||||
|
@ -105,34 +84,26 @@ jobs:
|
||||||
ghcr.io/goauthentik/${{ matrix.type }}:latest
|
ghcr.io/goauthentik/${{ matrix.type }}:latest
|
||||||
file: ${{ matrix.type }}.Dockerfile
|
file: ${{ matrix.type }}.Dockerfile
|
||||||
platforms: linux/amd64,linux/arm64
|
platforms: linux/amd64,linux/arm64
|
||||||
context: .
|
|
||||||
build-args: |
|
|
||||||
VERSION=${{ steps.ev.outputs.version }}
|
|
||||||
VERSION_FAMILY=${{ steps.ev.outputs.versionFamily }}
|
|
||||||
build-outpost-binary:
|
build-outpost-binary:
|
||||||
timeout-minutes: 120
|
timeout-minutes: 120
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
|
||||||
# Needed to upload binaries to the release
|
|
||||||
contents: write
|
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
type:
|
type:
|
||||||
- proxy
|
- proxy
|
||||||
- ldap
|
- ldap
|
||||||
- radius
|
|
||||||
goos: [linux, darwin]
|
goos: [linux, darwin]
|
||||||
goarch: [amd64, arm64]
|
goarch: [amd64, arm64]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- uses: actions/setup-go@v4
|
- uses: actions/setup-go@v3
|
||||||
with:
|
with:
|
||||||
go-version-file: "go.mod"
|
go-version: "^1.17"
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v3.4.1
|
||||||
with:
|
with:
|
||||||
node-version-file: web/package.json
|
node-version: '16'
|
||||||
cache: "npm"
|
cache: 'npm'
|
||||||
cache-dependency-path: web/package-lock.json
|
cache-dependency-path: web/package-lock.json
|
||||||
- name: Build web
|
- name: Build web
|
||||||
working-directory: web/
|
working-directory: web/
|
||||||
|
@ -144,7 +115,6 @@ jobs:
|
||||||
set -x
|
set -x
|
||||||
export GOOS=${{ matrix.goos }}
|
export GOOS=${{ matrix.goos }}
|
||||||
export GOARCH=${{ matrix.goarch }}
|
export GOARCH=${{ matrix.goarch }}
|
||||||
export CGO_ENABLED=0
|
|
||||||
go build -tags=outpost_static_embed -v -o ./authentik-outpost-${{ matrix.type }}_${{ matrix.goos }}_${{ matrix.goarch }} ./cmd/${{ matrix.type }}
|
go build -tags=outpost_static_embed -v -o ./authentik-outpost-${{ matrix.type }}_${{ matrix.goos }}_${{ matrix.goarch }} ./cmd/${{ matrix.type }}
|
||||||
- name: Upload binaries to release
|
- name: Upload binaries to release
|
||||||
uses: svenstaro/upload-release-action@v2
|
uses: svenstaro/upload-release-action@v2
|
||||||
|
@ -160,7 +130,7 @@ jobs:
|
||||||
- build-outpost-binary
|
- build-outpost-binary
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- name: Run test suite in final docker images
|
- name: Run test suite in final docker images
|
||||||
run: |
|
run: |
|
||||||
echo "PG_PASS=$(openssl rand -base64 32)" >> .env
|
echo "PG_PASS=$(openssl rand -base64 32)" >> .env
|
||||||
|
@ -168,7 +138,7 @@ jobs:
|
||||||
docker-compose pull -q
|
docker-compose pull -q
|
||||||
docker-compose up --no-start
|
docker-compose up --no-start
|
||||||
docker-compose start postgresql redis
|
docker-compose start postgresql redis
|
||||||
docker-compose run -u root server test-all
|
docker-compose run -u root server test
|
||||||
sentry-release:
|
sentry-release:
|
||||||
needs:
|
needs:
|
||||||
- build-server
|
- build-server
|
||||||
|
@ -176,7 +146,7 @@ jobs:
|
||||||
- build-outpost-binary
|
- build-outpost-binary
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- name: prepare variables
|
- name: prepare variables
|
||||||
uses: ./.github/actions/docker-push-variables
|
uses: ./.github/actions/docker-push-variables
|
||||||
id: ev
|
id: ev
|
||||||
|
@ -187,13 +157,14 @@ jobs:
|
||||||
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
|
||||||
continue-on-error: true
|
|
||||||
if: ${{ github.event_name == 'release' }}
|
if: ${{ github.event_name == 'release' }}
|
||||||
env:
|
env:
|
||||||
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||||
SENTRY_ORG: authentik-security-inc
|
SENTRY_ORG: beryjuorg
|
||||||
SENTRY_PROJECT: authentik
|
SENTRY_PROJECT: authentik
|
||||||
|
SENTRY_URL: https://sentry.beryju.org
|
||||||
with:
|
with:
|
||||||
version: authentik@${{ steps.ev.outputs.version }}
|
version: authentik@${{ steps.ev.outputs.version }}
|
||||||
sourcemaps: "./web/dist"
|
environment: beryjuorg-prod
|
||||||
url_prefix: "~/static/dist"
|
sourcemaps: './web/dist'
|
||||||
|
url_prefix: '~/static/dist'
|
||||||
|
|
|
@ -3,43 +3,40 @@ name: authentik-on-tag
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
tags:
|
tags:
|
||||||
- "version/*"
|
- 'version/*'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
name: Create Release from Tag
|
name: Create Release from Tag
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v3
|
||||||
- name: Pre-release test
|
- name: Pre-release test
|
||||||
run: |
|
run: |
|
||||||
echo "PG_PASS=$(openssl rand -base64 32)" >> .env
|
echo "PG_PASS=$(openssl rand -base64 32)" >> .env
|
||||||
echo "AUTHENTIK_SECRET_KEY=$(openssl rand -base64 32)" >> .env
|
echo "AUTHENTIK_SECRET_KEY=$(openssl rand -base64 32)" >> .env
|
||||||
docker buildx install
|
docker buildx install
|
||||||
mkdir -p ./gen-ts-api
|
docker build \
|
||||||
docker build -t testing:latest .
|
--no-cache \
|
||||||
|
-t testing:latest \
|
||||||
|
-f Dockerfile .
|
||||||
echo "AUTHENTIK_IMAGE=testing" >> .env
|
echo "AUTHENTIK_IMAGE=testing" >> .env
|
||||||
echo "AUTHENTIK_TAG=latest" >> .env
|
echo "AUTHENTIK_TAG=latest" >> .env
|
||||||
docker-compose up --no-start
|
docker-compose up --no-start
|
||||||
docker-compose start postgresql redis
|
docker-compose start postgresql redis
|
||||||
docker-compose run -u root server test-all
|
docker-compose run -u root server test
|
||||||
- id: generate_token
|
|
||||||
uses: tibdex/github-app-token@v2
|
|
||||||
with:
|
|
||||||
app_id: ${{ secrets.GH_APP_ID }}
|
|
||||||
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
||||||
- name: Extract version number
|
- name: Extract version number
|
||||||
id: get_version
|
id: get_version
|
||||||
uses: actions/github-script@v6
|
uses: actions/github-script@v6
|
||||||
with:
|
with:
|
||||||
github-token: ${{ steps.generate_token.outputs.token }}
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
script: |
|
script: |
|
||||||
return context.payload.ref.replace(/\/refs\/tags\/version\//, '');
|
return context.payload.ref.replace(/\/refs\/tags\/version\//, '');
|
||||||
- name: Create Release
|
- name: Create Release
|
||||||
id: create_release
|
id: create_release
|
||||||
uses: actions/create-release@v1.1.4
|
uses: actions/create-release@v1.1.4
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
with:
|
with:
|
||||||
tag_name: ${{ github.ref }}
|
tag_name: ${{ github.ref }}
|
||||||
release_name: Release ${{ steps.get_version.outputs.result }}
|
release_name: Release ${{ steps.get_version.outputs.result }}
|
||||||
|
|
|
@ -1,33 +0,0 @@
|
||||||
name: 'authentik-repo-stale'
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: '30 1 * * *'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
# Needed to update issues and PRs
|
|
||||||
issues: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
stale:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- id: generate_token
|
|
||||||
uses: tibdex/github-app-token@v2
|
|
||||||
with:
|
|
||||||
app_id: ${{ secrets.GH_APP_ID }}
|
|
||||||
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
||||||
- uses: actions/stale@v8
|
|
||||||
with:
|
|
||||||
repo-token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
days-before-stale: 60
|
|
||||||
days-before-close: 7
|
|
||||||
exempt-issue-labels: pinned,security,pr_wanted,enhancement,bug/confirmed,enhancement/confirmed,question
|
|
||||||
stale-issue-label: wontfix
|
|
||||||
stale-issue-message: >
|
|
||||||
This issue has been automatically marked as stale because it has not had
|
|
||||||
recent activity. It will be closed if no further activity occurs. Thank you
|
|
||||||
for your contributions.
|
|
||||||
# Don't stale PRs, so only apply to PRs with a non-existent label
|
|
||||||
only-pr-labels: foo
|
|
|
@ -1,34 +0,0 @@
|
||||||
name: authentik-translation-advice
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths:
|
|
||||||
- "!**"
|
|
||||||
- "locale/**"
|
|
||||||
- "web/src/locales/**"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
post-comment:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Find Comment
|
|
||||||
uses: peter-evans/find-comment@v2
|
|
||||||
id: fc
|
|
||||||
with:
|
|
||||||
issue-number: ${{ github.event.pull_request.number }}
|
|
||||||
comment-author: "github-actions[bot]"
|
|
||||||
body-includes: authentik translations instructions
|
|
||||||
- name: Create or update comment
|
|
||||||
uses: peter-evans/create-or-update-comment@v3
|
|
||||||
with:
|
|
||||||
comment-id: ${{ steps.fc.outputs.comment-id }}
|
|
||||||
issue-number: ${{ github.event.pull_request.number }}
|
|
||||||
edit-mode: replace
|
|
||||||
body: |
|
|
||||||
### authentik translations instructions
|
|
||||||
|
|
||||||
Thanks for your pull request!
|
|
||||||
|
|
||||||
authentik translations are handled using [Transifex](https://explore.transifex.com/authentik/authentik/). Please edit translations over there and they'll be included automatically.
|
|
|
@ -1,9 +1,12 @@
|
||||||
name: authentik-backend-translate-compile
|
name: authentik-backend-translate-compile
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [main]
|
branches: [ main ]
|
||||||
paths:
|
paths:
|
||||||
- "locale/**"
|
- '/locale/'
|
||||||
|
pull_request:
|
||||||
|
paths:
|
||||||
|
- '/locale/'
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
env:
|
env:
|
||||||
|
@ -15,23 +18,16 @@ jobs:
|
||||||
compile:
|
compile:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- id: generate_token
|
- uses: actions/checkout@v3
|
||||||
uses: tibdex/github-app-token@v2
|
|
||||||
with:
|
|
||||||
app_id: ${{ secrets.GH_APP_ID }}
|
|
||||||
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
- name: Setup authentik env
|
- name: Setup authentik env
|
||||||
uses: ./.github/actions/setup
|
uses: ./.github/actions/setup
|
||||||
- name: run compile
|
- name: run compile
|
||||||
run: poetry run ak compilemessages
|
run: poetry run ./manage.py compilemessages
|
||||||
- name: Create Pull Request
|
- name: Create Pull Request
|
||||||
uses: peter-evans/create-pull-request@v5
|
uses: peter-evans/create-pull-request@v4
|
||||||
id: cpr
|
id: cpr
|
||||||
with:
|
with:
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
branch: compile-backend-translation
|
branch: compile-backend-translation
|
||||||
commit-message: "core: compile backend translations"
|
commit-message: "core: compile backend translations"
|
||||||
title: "core: compile backend translations"
|
title: "core: compile backend translations"
|
||||||
|
|
|
@ -1,45 +0,0 @@
|
||||||
# Rename transifex pull requests to have a correct naming
|
|
||||||
# Also enables auto squash-merge
|
|
||||||
name: authentik-translation-transifex-rename
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
types: [opened, reopened]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
rename_pr:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
if: ${{ github.event.pull_request.user.login == 'transifex-integration[bot]'}}
|
|
||||||
steps:
|
|
||||||
- id: generate_token
|
|
||||||
uses: tibdex/github-app-token@v2
|
|
||||||
with:
|
|
||||||
app_id: ${{ secrets.GH_APP_ID }}
|
|
||||||
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
||||||
- name: Get current title
|
|
||||||
id: title
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ steps.generate_token.outputs.token }}
|
|
||||||
run: |
|
|
||||||
title=$(curl -q -L \
|
|
||||||
-H "Accept: application/vnd.github+json" \
|
|
||||||
-H "Authorization: Bearer ${GH_TOKEN}" \
|
|
||||||
-H "X-GitHub-Api-Version: 2022-11-28" \
|
|
||||||
https://api.github.com/repos/${GITHUB_REPOSITORY}/pulls/${{ github.event.pull_request.number }} | jq -r .title)
|
|
||||||
echo "title=${title}" >> "$GITHUB_OUTPUT"
|
|
||||||
- name: Rename
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ steps.generate_token.outputs.token }}
|
|
||||||
run: |
|
|
||||||
curl -L \
|
|
||||||
-X PATCH \
|
|
||||||
-H "Accept: application/vnd.github+json" \
|
|
||||||
-H "Authorization: Bearer ${GH_TOKEN}" \
|
|
||||||
-H "X-GitHub-Api-Version: 2022-11-28" \
|
|
||||||
https://api.github.com/repos/${GITHUB_REPOSITORY}/pulls/${{ github.event.pull_request.number }} \
|
|
||||||
-d "{\"title\":\"translate: ${{ steps.title.outputs.title }}\"}"
|
|
||||||
- uses: peter-evans/enable-pull-request-automerge@v3
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
pull-request-number: ${{ github.event.pull_request.number }}
|
|
||||||
merge-method: squash
|
|
|
@ -1,28 +1,22 @@
|
||||||
name: authentik-web-api-publish
|
name: authentik-web-api-publish
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [main]
|
branches: [ main ]
|
||||||
paths:
|
paths:
|
||||||
- "schema.yml"
|
- 'schema.yml'
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- id: generate_token
|
- uses: actions/checkout@v3
|
||||||
uses: tibdex/github-app-token@v2
|
# Setup .npmrc file to publish to npm
|
||||||
|
- uses: actions/setup-node@v3.4.1
|
||||||
with:
|
with:
|
||||||
app_id: ${{ secrets.GH_APP_ID }}
|
node-version: '16'
|
||||||
private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
registry-url: 'https://registry.npmjs.org'
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: web/package.json
|
|
||||||
registry-url: "https://registry.npmjs.org"
|
|
||||||
- name: Generate API Client
|
- name: Generate API Client
|
||||||
run: make gen-client-ts
|
run: make gen-client-web
|
||||||
- name: Publish package
|
- name: Publish package
|
||||||
working-directory: gen-ts-api/
|
working-directory: gen-ts-api/
|
||||||
run: |
|
run: |
|
||||||
|
@ -35,20 +29,14 @@ 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
|
||||||
- uses: peter-evans/create-pull-request@v5
|
- name: Create Pull Request
|
||||||
|
uses: peter-evans/create-pull-request@v4
|
||||||
id: cpr
|
id: cpr
|
||||||
with:
|
with:
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
branch: update-web-api-client
|
branch: update-web-api-client
|
||||||
commit-message: "web: bump API Client version"
|
commit-message: "web: Update Web API Client version"
|
||||||
title: "web: bump API Client version"
|
title: "web: Update Web API Client version"
|
||||||
body: "web: bump API Client version"
|
body: "web: Update Web API Client version"
|
||||||
delete-branch: true
|
delete-branch: true
|
||||||
signoff: true
|
signoff: true
|
||||||
# ID from https://api.github.com/users/authentik-automation[bot]
|
|
||||||
author: authentik-automation[bot] <135050075+authentik-automation[bot]@users.noreply.github.com>
|
|
||||||
- uses: peter-evans/enable-pull-request-automerge@v3
|
|
||||||
with:
|
|
||||||
token: ${{ steps.generate_token.outputs.token }}
|
|
||||||
pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
|
|
||||||
merge-method: squash
|
|
||||||
|
|
|
@ -166,7 +166,6 @@ dmypy.json
|
||||||
# SageMath parsed files
|
# SageMath parsed files
|
||||||
|
|
||||||
# Environments
|
# Environments
|
||||||
**/.DS_Store
|
|
||||||
|
|
||||||
# Spyder project settings
|
# Spyder project settings
|
||||||
|
|
||||||
|
@ -195,17 +194,11 @@ pip-selfcheck.json
|
||||||
/static/
|
/static/
|
||||||
local.env.yml
|
local.env.yml
|
||||||
|
|
||||||
|
# Selenium Screenshots
|
||||||
|
selenium_screenshots/
|
||||||
|
backups/
|
||||||
media/
|
media/
|
||||||
*mmdb
|
*mmdb
|
||||||
|
|
||||||
.idea/
|
.idea/
|
||||||
/gen-*/
|
/gen-*/
|
||||||
data/
|
|
||||||
|
|
||||||
# Local Netlify folder
|
|
||||||
.netlify
|
|
||||||
.ruff_cache
|
|
||||||
source_docs/
|
|
||||||
|
|
||||||
### Golang ###
|
|
||||||
/vendor/
|
|
||||||
|
|
|
@ -1,21 +0,0 @@
|
||||||
{
|
|
||||||
"recommendations": [
|
|
||||||
"bashmish.es6-string-css",
|
|
||||||
"bpruitt-goddard.mermaid-markdown-syntax-highlighting",
|
|
||||||
"dbaeumer.vscode-eslint",
|
|
||||||
"EditorConfig.EditorConfig",
|
|
||||||
"esbenp.prettier-vscode",
|
|
||||||
"github.vscode-github-actions",
|
|
||||||
"golang.go",
|
|
||||||
"Gruntfuggly.todo-tree",
|
|
||||||
"mechatroner.rainbow-csv",
|
|
||||||
"ms-python.black-formatter",
|
|
||||||
"ms-python.isort",
|
|
||||||
"ms-python.pylint",
|
|
||||||
"ms-python.python",
|
|
||||||
"ms-python.vscode-pylance",
|
|
||||||
"redhat.vscode-yaml",
|
|
||||||
"Tobermory.es6-string-html",
|
|
||||||
"unifiedjs.vscode-mdx",
|
|
||||||
]
|
|
||||||
}
|
|
|
@ -1,27 +0,0 @@
|
||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"name": "Python: PDB attach Server",
|
|
||||||
"type": "python",
|
|
||||||
"request": "attach",
|
|
||||||
"connect": {
|
|
||||||
"host": "localhost",
|
|
||||||
"port": 6800
|
|
||||||
},
|
|
||||||
"justMyCode": true,
|
|
||||||
"django": true
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Python: PDB attach Worker",
|
|
||||||
"type": "python",
|
|
||||||
"request": "attach",
|
|
||||||
"connect": {
|
|
||||||
"host": "localhost",
|
|
||||||
"port": 6900
|
|
||||||
},
|
|
||||||
"justMyCode": true,
|
|
||||||
"django": true
|
|
||||||
},
|
|
||||||
]
|
|
||||||
}
|
|
|
@ -14,45 +14,17 @@
|
||||||
"webauthn",
|
"webauthn",
|
||||||
"traefik",
|
"traefik",
|
||||||
"passwordless",
|
"passwordless",
|
||||||
"kubernetes",
|
"kubernetes"
|
||||||
"sso",
|
|
||||||
"slo",
|
|
||||||
"scim",
|
|
||||||
],
|
],
|
||||||
"python.linting.pylintEnabled": true,
|
"python.linting.pylintEnabled": true,
|
||||||
"todo-tree.tree.showCountsInTree": true,
|
"todo-tree.tree.showCountsInTree": true,
|
||||||
"todo-tree.tree.showBadges": true,
|
"todo-tree.tree.showBadges": true,
|
||||||
"python.formatting.provider": "black",
|
"python.formatting.provider": "black",
|
||||||
"yaml.customTags": [
|
"files.associations": {
|
||||||
"!Find sequence",
|
"*.akflow": "json"
|
||||||
"!KeyOf scalar",
|
},
|
||||||
"!Context scalar",
|
|
||||||
"!Context sequence",
|
|
||||||
"!Format sequence",
|
|
||||||
"!Condition sequence",
|
|
||||||
"!Env sequence",
|
|
||||||
"!Env scalar",
|
|
||||||
"!If sequence"
|
|
||||||
],
|
|
||||||
"typescript.preferences.importModuleSpecifier": "non-relative",
|
"typescript.preferences.importModuleSpecifier": "non-relative",
|
||||||
"typescript.preferences.importModuleSpecifierEnding": "index",
|
"typescript.preferences.importModuleSpecifierEnding": "index",
|
||||||
"typescript.tsdk": "./web/node_modules/typescript/lib",
|
"typescript.tsdk": "./web/node_modules/typescript/lib",
|
||||||
"typescript.enablePromptUseWorkspaceTsdk": true,
|
"typescript.enablePromptUseWorkspaceTsdk": true
|
||||||
"yaml.schemas": {
|
|
||||||
"./blueprints/schema.json": "blueprints/**/*.yaml"
|
|
||||||
},
|
|
||||||
"gitlens.autolinks": [
|
|
||||||
{
|
|
||||||
"alphanumeric": true,
|
|
||||||
"prefix": "#<num>",
|
|
||||||
"url": "https://github.com/goauthentik/authentik/issues/<num>",
|
|
||||||
"ignoreCase": false
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"go.testFlags": [
|
|
||||||
"-count=1"
|
|
||||||
],
|
|
||||||
"github-actions.workflows.pinned.workflows": [
|
|
||||||
".github/workflows/ci-main.yml"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|
26
CODEOWNERS
26
CODEOWNERS
|
@ -1,26 +0,0 @@
|
||||||
# Fallback
|
|
||||||
* @goauthentik/backend @goauthentik/frontend
|
|
||||||
# Backend
|
|
||||||
authentik/ @goauthentik/backend
|
|
||||||
blueprints/ @goauthentik/backend
|
|
||||||
cmd/ @goauthentik/backend
|
|
||||||
internal/ @goauthentik/backend
|
|
||||||
lifecycle/ @goauthentik/backend
|
|
||||||
schemas/ @goauthentik/backend
|
|
||||||
scripts/ @goauthentik/backend
|
|
||||||
tests/ @goauthentik/backend
|
|
||||||
pyproject.toml @goauthentik/backend
|
|
||||||
poetry.lock @goauthentik/backend
|
|
||||||
# Infrastructure
|
|
||||||
.github/ @goauthentik/infrastructure
|
|
||||||
Dockerfile @goauthentik/infrastructure
|
|
||||||
*Dockerfile @goauthentik/infrastructure
|
|
||||||
.dockerignore @goauthentik/infrastructure
|
|
||||||
docker-compose.yml @goauthentik/infrastructure
|
|
||||||
# Web
|
|
||||||
web/ @goauthentik/frontend
|
|
||||||
tests/wdio/ @goauthentik/frontend
|
|
||||||
# Docs & Website
|
|
||||||
website/ @goauthentik/docs
|
|
||||||
# Security
|
|
||||||
website/docs/security/ @goauthentik/security
|
|
|
@ -17,24 +17,24 @@ diverse, inclusive, and healthy community.
|
||||||
Examples of behavior that contributes to a positive environment for our
|
Examples of behavior that contributes to a positive environment for our
|
||||||
community include:
|
community include:
|
||||||
|
|
||||||
- Demonstrating empathy and kindness toward other people
|
* Demonstrating empathy and kindness toward other people
|
||||||
- Being respectful of differing opinions, viewpoints, and experiences
|
* Being respectful of differing opinions, viewpoints, and experiences
|
||||||
- Giving and gracefully accepting constructive feedback
|
* Giving and gracefully accepting constructive feedback
|
||||||
- Accepting responsibility and apologizing to those affected by our mistakes,
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
and learning from the experience
|
and learning from the experience
|
||||||
- Focusing on what is best not just for us as individuals, but for the
|
* Focusing on what is best not just for us as individuals, but for the
|
||||||
overall community
|
overall community
|
||||||
|
|
||||||
Examples of unacceptable behavior include:
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
- The use of sexualized language or imagery, and sexual attention or
|
* The use of sexualized language or imagery, and sexual attention or
|
||||||
advances of any kind
|
advances of any kind
|
||||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
- Public or private harassment
|
* Public or private harassment
|
||||||
- Publishing others' private information, such as a physical or email
|
* Publishing others' private information, such as a physical or email
|
||||||
address, without their explicit permission
|
address, without their explicit permission
|
||||||
- Other conduct which could reasonably be considered inappropriate in a
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
professional setting
|
professional setting
|
||||||
|
|
||||||
## Enforcement Responsibilities
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
|
@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
|
||||||
### 4. Permanent Ban
|
### 4. Permanent Ban
|
||||||
|
|
||||||
**Community Impact**: Demonstrating a pattern of violation of community
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
standards, including sustained inappropriate behavior, harassment of an
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
individual, or aggression toward or disparagement of classes of individuals.
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
**Consequence**: A permanent ban from any sort of public interaction within
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||||||
|
|
|
@ -1 +0,0 @@
|
||||||
website/developer-docs/index.md
|
|
|
@ -0,0 +1,175 @@
|
||||||
|
# Contributing to authentik
|
||||||
|
|
||||||
|
:+1::tada: Thanks for taking the time to contribute! :tada::+1:
|
||||||
|
|
||||||
|
The following is a set of guidelines for contributing to authentik and its components, which are hosted in the [goauthentik Organization](https://github.com/goauthentik) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
||||||
|
|
||||||
|
#### Table Of Contents
|
||||||
|
|
||||||
|
[Code of Conduct](#code-of-conduct)
|
||||||
|
|
||||||
|
[I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
|
||||||
|
|
||||||
|
[What should I know before I get started?](#what-should-i-know-before-i-get-started)
|
||||||
|
* [The components](#the-components)
|
||||||
|
* [authentik's structure](#authentiks-structure)
|
||||||
|
|
||||||
|
[How Can I Contribute?](#how-can-i-contribute)
|
||||||
|
* [Reporting Bugs](#reporting-bugs)
|
||||||
|
* [Suggesting Enhancements](#suggesting-enhancements)
|
||||||
|
* [Your First Code Contribution](#your-first-code-contribution)
|
||||||
|
* [Pull Requests](#pull-requests)
|
||||||
|
|
||||||
|
[Styleguides](#styleguides)
|
||||||
|
* [Git Commit Messages](#git-commit-messages)
|
||||||
|
* [Python Styleguide](#python-styleguide)
|
||||||
|
* [Documentation Styleguide](#documentation-styleguide)
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
Basically, don't be a dickhead. This is an open-source non-profit project, that is made in the free time of Volunteers. If there's something you dislike or think can be done better, tell us! We'd love to hear any suggestions for improvement.
|
||||||
|
|
||||||
|
## I don't want to read this whole thing I just have a question!!!
|
||||||
|
|
||||||
|
Either [create a question on GitHub](https://github.com/goauthentik/authentik/issues/new?assignees=&labels=question&template=question.md&title=) or join [the Discord server](https://goauthentik.io/discord)
|
||||||
|
|
||||||
|
## What should I know before I get started?
|
||||||
|
|
||||||
|
### The components
|
||||||
|
|
||||||
|
authentik consists of a few larger components:
|
||||||
|
|
||||||
|
- *authentik* the actual application server, is described below.
|
||||||
|
- *outpost-proxy* is a Go application based on a forked version of oauth2_proxy, which does identity-aware reverse proxying.
|
||||||
|
- *outpost-ldap* is a Go LDAP server that uses the *authentik* application server as its backend
|
||||||
|
- *web* is the web frontend, both for administrating and using authentik. It is written in TypeScript using lit-html and the PatternFly CSS Library.
|
||||||
|
- *website* is the Website/documentation, which uses docusaurus.
|
||||||
|
|
||||||
|
### authentik's structure
|
||||||
|
|
||||||
|
authentik is at it's very core a Django project. It consists of many individual django applications. These applications are intended to separate concerns, and they may share code between each other.
|
||||||
|
|
||||||
|
These are the current packages:
|
||||||
|
<a id="authentik-packages"/>
|
||||||
|
|
||||||
|
```
|
||||||
|
authentik
|
||||||
|
├── admin - Administrative tasks and APIs, no models (Version updates, Metrics, system tasks)
|
||||||
|
├── api - General API Configuration (Routes, Schema and general API utilities)
|
||||||
|
├── core - Core authentik functionality, central routes, core Models
|
||||||
|
├── crypto - Cryptography, currently used to generate and hold Certificates and Private Keys
|
||||||
|
├── events - Event Log, middleware and signals to generate signals
|
||||||
|
├── flows - Flows, the FlowPlanner and the FlowExecutor, used for all flows for authentication, authorization, etc
|
||||||
|
├── lib - Generic library of functions, few dependencies on other packages.
|
||||||
|
├── managed - Handle managed models and their state.
|
||||||
|
├── outposts - Configure and deploy outposts on kubernetes and docker.
|
||||||
|
├── policies - General PolicyEngine
|
||||||
|
│ ├── dummy - A Dummy policy used for testing
|
||||||
|
│ ├── event_matcher - Match events based on different criteria
|
||||||
|
│ ├── expiry - Check when a user's password was last set
|
||||||
|
│ ├── expression - Execute any arbitrary python code
|
||||||
|
│ ├── hibp - Check a password against HaveIBeenPwned
|
||||||
|
│ ├── password - Check a password against several rules
|
||||||
|
│ └── reputation - Check the user's/client's reputation
|
||||||
|
├── providers
|
||||||
|
│ ├── ldap - Provide LDAP access to authentik users/groups using an outpost
|
||||||
|
│ ├── oauth2 - OIDC-compliant OAuth2 provider
|
||||||
|
│ ├── proxy - Provides an identity-aware proxy using an outpost
|
||||||
|
│ └── saml - SAML2 Provider
|
||||||
|
├── recovery - Generate keys to use in case you lock yourself out
|
||||||
|
├── root - Root django application, contains global settings and routes
|
||||||
|
├── sources
|
||||||
|
│ ├── ldap - Sync LDAP users from OpenLDAP or Active Directory into authentik
|
||||||
|
│ ├── oauth - OAuth1 and OAuth2 Source
|
||||||
|
│ ├── plex - Plex source
|
||||||
|
│ └── saml - SAML2 Source
|
||||||
|
├── stages
|
||||||
|
│ ├── authenticator_duo - Configure a DUO authenticator
|
||||||
|
│ ├── authenticator_static - Configure TOTP backup keys
|
||||||
|
│ ├── authenticator_totp - Configure a TOTP authenticator
|
||||||
|
│ ├── authenticator_validate - Validate any authenticator
|
||||||
|
│ ├── authenticator_webauthn - Configure a WebAuthn authenticator
|
||||||
|
│ ├── captcha - Make the user pass a captcha
|
||||||
|
│ ├── consent - Let the user decide if they want to consent to an action
|
||||||
|
│ ├── deny - Static deny, can be used with policies
|
||||||
|
│ ├── dummy - Dummy stage to test
|
||||||
|
│ ├── email - Send the user an email and block execution until they click the link
|
||||||
|
│ ├── identification - Identify a user with any combination of fields
|
||||||
|
│ ├── invitation - Invitation system to limit flows to certain users
|
||||||
|
│ ├── password - Password authentication
|
||||||
|
│ ├── prompt - Arbitrary prompts
|
||||||
|
│ ├── user_delete - Delete the currently pending user
|
||||||
|
│ ├── user_login - Login the currently pending user
|
||||||
|
│ ├── user_logout - Logout the currently pending user
|
||||||
|
│ └── user_write - Write any currenetly pending data to the user.
|
||||||
|
└── tenants - Soft tennancy, configure defaults and branding per domain
|
||||||
|
```
|
||||||
|
|
||||||
|
This django project is running in gunicorn, which spawns multiple workers and threads. Gunicorn is run from a lightweight Go application which reverse-proxies it, handles static files and will eventually gain more functionality as more code is migrated to go.
|
||||||
|
|
||||||
|
There are also several background tasks which run in Celery, the root celery application is defined in `authentik.root.celery`.
|
||||||
|
|
||||||
|
## How Can I Contribute?
|
||||||
|
|
||||||
|
### Reporting Bugs
|
||||||
|
|
||||||
|
This section guides you through submitting a bug report for authentik. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
|
||||||
|
|
||||||
|
Whenever authentik encounters an error, it will be logged as an Event with the type `system_exception`. This event type has a button to directly open a pre-filled GitHub issue form.
|
||||||
|
|
||||||
|
This form will have the full stack trace of the error that occurred and shouldn't contain any sensitive data.
|
||||||
|
|
||||||
|
### Suggesting Enhancements
|
||||||
|
|
||||||
|
This section guides you through submitting an enhancement suggestion for authentik, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
|
||||||
|
|
||||||
|
When you are creating an enhancement suggestion, please fill in [the template](https://github.com/goauthentik/authentik/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=), including the steps that you imagine you would take if the feature you're requesting existed.
|
||||||
|
|
||||||
|
### Your First Code Contribution
|
||||||
|
|
||||||
|
#### Local development
|
||||||
|
|
||||||
|
authentik can be run locally, all though depending on which part you want to work on, different pre-requisites are required.
|
||||||
|
|
||||||
|
This is documented in the [developer docs](https://goauthentik.io/developer-docs/?utm_source=github)
|
||||||
|
|
||||||
|
### Pull Requests
|
||||||
|
|
||||||
|
The process described here has several goals:
|
||||||
|
|
||||||
|
- Maintain authentik's quality
|
||||||
|
- Fix problems that are important to users
|
||||||
|
- Engage the community in working toward the best possible authentik
|
||||||
|
- Enable a sustainable system for authentik's maintainers to review contributions
|
||||||
|
|
||||||
|
Please follow these steps to have your contribution considered by the maintainers:
|
||||||
|
|
||||||
|
1. Follow the [styleguides](#styleguides)
|
||||||
|
2. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>
|
||||||
|
3. Ensure your Code has tests. While it is not always possible to test every single case, the majority of the code should be tested.
|
||||||
|
|
||||||
|
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
|
||||||
|
|
||||||
|
## Styleguides
|
||||||
|
|
||||||
|
### Git Commit Messages
|
||||||
|
|
||||||
|
* Use the format of `<package>: <verb> <description>`
|
||||||
|
- See [here](#authentik-packages) for `package`
|
||||||
|
- Example: `providers/saml2: fix parsing of requests`
|
||||||
|
* Reference issues and pull requests liberally after the first line
|
||||||
|
|
||||||
|
### Python Styleguide
|
||||||
|
|
||||||
|
All Python code is linted with [black](https://black.readthedocs.io/en/stable/), [PyLint](https://www.pylint.org/) and [isort](https://pycqa.github.io/isort/).
|
||||||
|
|
||||||
|
authentik runs on Python 3.9 at the time of writing this.
|
||||||
|
|
||||||
|
* Use native type-annotations wherever possible.
|
||||||
|
* Add meaningful docstrings when possible.
|
||||||
|
* Ensure any database migrations work properly from the last stable version (this is checked via CI)
|
||||||
|
* If your code changes central functions, make sure nothing else is broken.
|
||||||
|
|
||||||
|
### Documentation Styleguide
|
||||||
|
|
||||||
|
* Use [MDX](https://mdxjs.com/) whenever appropriate.
|
172
Dockerfile
172
Dockerfile
|
@ -1,166 +1,98 @@
|
||||||
# syntax=docker/dockerfile:1
|
|
||||||
|
|
||||||
# Stage 1: Build website
|
# Stage 1: Build website
|
||||||
FROM --platform=${BUILDPLATFORM} docker.io/node:21 as website-builder
|
FROM --platform=${BUILDPLATFORM} docker.io/node:18 as website-builder
|
||||||
|
|
||||||
ENV NODE_ENV=production
|
|
||||||
|
|
||||||
WORKDIR /work/website
|
|
||||||
|
|
||||||
RUN --mount=type=bind,target=/work/website/package.json,src=./website/package.json \
|
|
||||||
--mount=type=bind,target=/work/website/package-lock.json,src=./website/package-lock.json \
|
|
||||||
--mount=type=cache,id=npm-website,sharing=shared,target=/root/.npm \
|
|
||||||
npm ci --include=dev
|
|
||||||
|
|
||||||
COPY ./website /work/website/
|
COPY ./website /work/website/
|
||||||
COPY ./blueprints /work/blueprints/
|
|
||||||
COPY ./SECURITY.md /work/
|
|
||||||
|
|
||||||
RUN npm run build-docs-only
|
|
||||||
|
|
||||||
# Stage 2: Build webui
|
|
||||||
FROM --platform=${BUILDPLATFORM} docker.io/node:21 as web-builder
|
|
||||||
|
|
||||||
ENV NODE_ENV=production
|
ENV NODE_ENV=production
|
||||||
|
WORKDIR /work/website
|
||||||
|
RUN npm ci && npm run build-docs-only
|
||||||
|
|
||||||
WORKDIR /work/web
|
# Stage 2: Build webui
|
||||||
|
FROM --platform=${BUILDPLATFORM} docker.io/node:18 as web-builder
|
||||||
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=cache,id=npm-web,sharing=shared,target=/root/.npm \
|
|
||||||
npm ci --include=dev
|
|
||||||
|
|
||||||
COPY ./web /work/web/
|
COPY ./web /work/web/
|
||||||
COPY ./website /work/website/
|
COPY ./website /work/website/
|
||||||
COPY ./gen-ts-api /work/web/node_modules/@goauthentik/api
|
|
||||||
|
|
||||||
RUN npm run build
|
ENV NODE_ENV=production
|
||||||
|
WORKDIR /work/web
|
||||||
|
RUN npm ci && npm run build
|
||||||
|
|
||||||
# Stage 3: Build go proxy
|
# Stage 3: Poetry to requirements.txt export
|
||||||
FROM --platform=${BUILDPLATFORM} docker.io/golang:1.21.4-bookworm AS go-builder
|
FROM docker.io/python:3.10.5-slim-bullseye AS poetry-locker
|
||||||
|
|
||||||
ARG TARGETOS
|
WORKDIR /work
|
||||||
ARG TARGETARCH
|
COPY ./pyproject.toml /work
|
||||||
ARG TARGETVARIANT
|
COPY ./poetry.lock /work
|
||||||
|
|
||||||
ARG GOOS=$TARGETOS
|
RUN pip install --no-cache-dir poetry && \
|
||||||
ARG GOARCH=$TARGETARCH
|
poetry export -f requirements.txt --output requirements.txt && \
|
||||||
|
poetry export -f requirements.txt --dev --output requirements-dev.txt
|
||||||
|
|
||||||
WORKDIR /go/src/goauthentik.io
|
# Stage 4: Build go proxy
|
||||||
|
FROM docker.io/golang:1.18.4-bullseye AS builder
|
||||||
|
|
||||||
RUN --mount=type=bind,target=/go/src/goauthentik.io/go.mod,src=./go.mod \
|
WORKDIR /work
|
||||||
--mount=type=bind,target=/go/src/goauthentik.io/go.sum,src=./go.sum \
|
|
||||||
--mount=type=cache,target=/go/pkg/mod \
|
|
||||||
go mod download
|
|
||||||
|
|
||||||
COPY ./cmd /go/src/goauthentik.io/cmd
|
COPY --from=web-builder /work/web/robots.txt /work/web/robots.txt
|
||||||
COPY ./authentik/lib /go/src/goauthentik.io/authentik/lib
|
COPY --from=web-builder /work/web/security.txt /work/web/security.txt
|
||||||
COPY ./web/static.go /go/src/goauthentik.io/web/static.go
|
|
||||||
COPY --from=web-builder /work/web/robots.txt /go/src/goauthentik.io/web/robots.txt
|
|
||||||
COPY --from=web-builder /work/web/security.txt /go/src/goauthentik.io/web/security.txt
|
|
||||||
COPY ./internal /go/src/goauthentik.io/internal
|
|
||||||
COPY ./go.mod /go/src/goauthentik.io/go.mod
|
|
||||||
COPY ./go.sum /go/src/goauthentik.io/go.sum
|
|
||||||
|
|
||||||
ENV CGO_ENABLED=0
|
COPY ./cmd /work/cmd
|
||||||
|
COPY ./web/static.go /work/web/static.go
|
||||||
|
COPY ./internal /work/internal
|
||||||
|
COPY ./go.mod /work/go.mod
|
||||||
|
COPY ./go.sum /work/go.sum
|
||||||
|
|
||||||
RUN --mount=type=cache,sharing=locked,target=/go/pkg/mod \
|
RUN go build -o /work/authentik ./cmd/server/main.go
|
||||||
--mount=type=cache,id=go-build-$TARGETARCH$TARGETVARIANT,sharing=locked,target=/root/.cache/go-build \
|
|
||||||
GOARM="${TARGETVARIANT#v}" go build -o /go/authentik ./cmd/server
|
|
||||||
|
|
||||||
# Stage 4: MaxMind GeoIP
|
# Stage 5: Run
|
||||||
FROM --platform=${BUILDPLATFORM} ghcr.io/maxmind/geoipupdate:v6.0 as geoip
|
FROM docker.io/python:3.10.5-slim-bullseye
|
||||||
|
|
||||||
ENV GEOIPUPDATE_EDITION_IDS="GeoLite2-City"
|
|
||||||
ENV GEOIPUPDATE_VERBOSE="true"
|
|
||||||
ENV GEOIPUPDATE_ACCOUNT_ID_FILE="/run/secrets/GEOIPUPDATE_ACCOUNT_ID"
|
|
||||||
ENV GEOIPUPDATE_LICENSE_KEY_FILE="/run/secrets/GEOIPUPDATE_LICENSE_KEY"
|
|
||||||
|
|
||||||
USER root
|
|
||||||
RUN --mount=type=secret,id=GEOIPUPDATE_ACCOUNT_ID \
|
|
||||||
--mount=type=secret,id=GEOIPUPDATE_LICENSE_KEY \
|
|
||||||
mkdir -p /usr/share/GeoIP && \
|
|
||||||
/bin/sh -c "/usr/bin/entry.sh || echo 'Failed to get GeoIP database, disabling'; exit 0"
|
|
||||||
|
|
||||||
# Stage 5: Python dependencies
|
|
||||||
FROM docker.io/python:3.11.5-bookworm AS python-deps
|
|
||||||
|
|
||||||
WORKDIR /ak-root/poetry
|
|
||||||
|
|
||||||
ENV VENV_PATH="/ak-root/venv" \
|
|
||||||
POETRY_VIRTUALENVS_CREATE=false \
|
|
||||||
PATH="/ak-root/venv/bin:$PATH"
|
|
||||||
|
|
||||||
RUN rm -f /etc/apt/apt.conf.d/docker-clean; echo 'Binary::apt::APT::Keep-Downloaded-Packages "true";' > /etc/apt/apt.conf.d/keep-cache
|
|
||||||
|
|
||||||
RUN --mount=type=cache,id=apt-$TARGETARCH$TARGETVARIANT,sharing=locked,target=/var/cache/apt \
|
|
||||||
apt-get update && \
|
|
||||||
# Required for installing pip packages
|
|
||||||
apt-get install -y --no-install-recommends build-essential pkg-config libxmlsec1-dev zlib1g-dev libpq-dev
|
|
||||||
|
|
||||||
RUN --mount=type=bind,target=./pyproject.toml,src=./pyproject.toml \
|
|
||||||
--mount=type=bind,target=./poetry.lock,src=./poetry.lock \
|
|
||||||
--mount=type=cache,target=/root/.cache/pip \
|
|
||||||
--mount=type=cache,target=/root/.cache/pypoetry \
|
|
||||||
python -m venv /ak-root/venv/ && \
|
|
||||||
pip3 install --upgrade pip && \
|
|
||||||
pip3 install poetry && \
|
|
||||||
poetry install --only=main --no-ansi --no-interaction
|
|
||||||
|
|
||||||
# Stage 6: Run
|
|
||||||
FROM docker.io/python:3.11.5-slim-bookworm AS final-image
|
|
||||||
|
|
||||||
ARG GIT_BUILD_HASH
|
|
||||||
ARG VERSION
|
|
||||||
ENV GIT_BUILD_HASH=$GIT_BUILD_HASH
|
|
||||||
|
|
||||||
LABEL org.opencontainers.image.url https://goauthentik.io
|
LABEL org.opencontainers.image.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.revision ${GIT_BUILD_HASH}
|
|
||||||
|
|
||||||
WORKDIR /
|
WORKDIR /
|
||||||
|
|
||||||
# We cannot cache this layer otherwise we'll end up with a bigger image
|
ARG GIT_BUILD_HASH
|
||||||
|
ENV GIT_BUILD_HASH=$GIT_BUILD_HASH
|
||||||
|
|
||||||
|
COPY --from=poetry-locker /work/requirements.txt /
|
||||||
|
COPY --from=poetry-locker /work/requirements-dev.txt /
|
||||||
|
|
||||||
RUN apt-get update && \
|
RUN apt-get update && \
|
||||||
|
# Required for installing pip packages
|
||||||
|
apt-get install -y --no-install-recommends build-essential pkg-config libxmlsec1-dev && \
|
||||||
# Required for runtime
|
# Required for runtime
|
||||||
apt-get install -y --no-install-recommends libpq5 openssl libxmlsec1-openssl libmaxminddb0 && \
|
apt-get install -y --no-install-recommends libxmlsec1-openssl libmaxminddb0 && \
|
||||||
# Required for bootstrap & healtcheck
|
# Required for bootstrap & healtcheck
|
||||||
apt-get install -y --no-install-recommends runit && \
|
apt-get install -y --no-install-recommends curl runit && \
|
||||||
|
pip install --no-cache-dir -r /requirements.txt && \
|
||||||
|
apt-get remove --purge -y build-essential pkg-config libxmlsec1-dev && \
|
||||||
|
apt-get autoremove --purge -y && \
|
||||||
apt-get clean && \
|
apt-get clean && \
|
||||||
rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/ && \
|
rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/ && \
|
||||||
adduser --system --no-create-home --uid 1000 --group --home /authentik authentik && \
|
adduser --system --no-create-home --uid 1000 --group --home /authentik authentik && \
|
||||||
mkdir -p /certs /media /blueprints && \
|
mkdir -p /certs /media && \
|
||||||
mkdir -p /authentik/.ssh && \
|
mkdir -p /authentik/.ssh && \
|
||||||
mkdir -p /ak-root && \
|
chown authentik:authentik /certs /media /authentik/.ssh
|
||||||
chown authentik:authentik /certs /media /authentik/.ssh /ak-root
|
|
||||||
|
|
||||||
COPY ./authentik/ /authentik
|
COPY ./authentik/ /authentik
|
||||||
COPY ./pyproject.toml /
|
COPY ./pyproject.toml /
|
||||||
COPY ./poetry.lock /
|
COPY ./xml /xml
|
||||||
COPY ./schemas /schemas
|
|
||||||
COPY ./locale /locale
|
|
||||||
COPY ./tests /tests
|
COPY ./tests /tests
|
||||||
COPY ./manage.py /
|
COPY ./manage.py /
|
||||||
COPY ./blueprints /blueprints
|
|
||||||
COPY ./lifecycle/ /lifecycle
|
COPY ./lifecycle/ /lifecycle
|
||||||
COPY --from=go-builder /go/authentik /bin/authentik
|
COPY --from=builder /work/authentik /authentik-proxy
|
||||||
COPY --from=python-deps /ak-root/venv /ak-root/venv
|
|
||||||
COPY --from=web-builder /work/web/dist/ /web/dist/
|
COPY --from=web-builder /work/web/dist/ /web/dist/
|
||||||
COPY --from=web-builder /work/web/authentik/ /web/authentik/
|
COPY --from=web-builder /work/web/authentik/ /web/authentik/
|
||||||
COPY --from=website-builder /work/website/help/ /website/help/
|
COPY --from=website-builder /work/website/help/ /website/help/
|
||||||
COPY --from=geoip /usr/share/GeoIP /geoip
|
|
||||||
|
|
||||||
USER 1000
|
USER authentik
|
||||||
|
|
||||||
ENV TMPDIR=/dev/shm/ \
|
ENV TMPDIR /dev/shm/
|
||||||
PYTHONDONTWRITEBYTECODE=1 \
|
ENV PYTHONUNBUFFERED 1
|
||||||
PYTHONUNBUFFERED=1 \
|
ENV PATH "/usr/local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/lifecycle"
|
||||||
PATH="/ak-root/venv/bin:/lifecycle:$PATH" \
|
|
||||||
VENV_PATH="/ak-root/venv" \
|
|
||||||
POETRY_VIRTUALENVS_CREATE=false
|
|
||||||
|
|
||||||
HEALTHCHECK --interval=30s --timeout=30s --start-period=60s --retries=3 CMD [ "ak", "healthcheck" ]
|
HEALTHCHECK --interval=30s --timeout=30s --start-period=60s --retries=3 CMD [ "/lifecycle/ak", "healthcheck" ]
|
||||||
|
|
||||||
ENTRYPOINT [ "dumb-init", "--", "ak" ]
|
ENTRYPOINT [ "/lifecycle/ak" ]
|
||||||
|
|
692
LICENSE
692
LICENSE
|
@ -1,26 +1,674 @@
|
||||||
Copyright (c) 2023 Jens Langhammer
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
Portions of this software are licensed as follows:
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
* All content residing under the "website/" directory of this repository is licensed under "Creative Commons: CC BY-SA 4.0 license".
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
* All content that resides under the "authentik/enterprise/" directory of this repository, if that directory exists, is licensed under the license defined in "authentik/enterprise/LICENSE".
|
of this license document, but changing it is not allowed.
|
||||||
* All client-side JavaScript (when served directly or after being compiled, arranged, augmented, or combined), is licensed under the "MIT Expat" license.
|
|
||||||
* All third party components incorporated into the authentik are licensed under the original license provided by the owner of the applicable component.
|
|
||||||
* Content outside of the above mentioned directories or restrictions above is available under the "MIT" license as defined below.
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Preamble
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
The GNU General Public License is a free, copyleft license for
|
||||||
copies or substantial portions of the Software.
|
software and other kinds of works.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
The licenses for most software and other practical works are designed
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
to take away your freedom to share and change the works. By contrast,
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
share and change all versions of a program--to make sure it remains free
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
GNU General Public License for most of our software; it applies also to
|
||||||
SOFTWARE.
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
|
|
209
Makefile
209
Makefile
|
@ -1,180 +1,122 @@
|
||||||
.PHONY: gen dev-reset all clean test web website
|
.SHELLFLAGS += -x -e
|
||||||
|
|
||||||
.SHELLFLAGS += ${SHELLFLAGS} -e
|
|
||||||
PWD = $(shell pwd)
|
PWD = $(shell pwd)
|
||||||
UID = $(shell id -u)
|
UID = $(shell id -u)
|
||||||
GID = $(shell id -g)
|
GID = $(shell id -g)
|
||||||
NPM_VERSION = $(shell python -m scripts.npm_version)
|
NPM_VERSION = $(shell python -m scripts.npm_version)
|
||||||
PY_SOURCES = authentik tests scripts lifecycle
|
|
||||||
DOCKER_IMAGE ?= "authentik:test"
|
|
||||||
|
|
||||||
pg_user := $(shell python -m authentik.lib.config postgresql.user 2>/dev/null)
|
all: lint-fix lint test gen web
|
||||||
pg_host := $(shell python -m authentik.lib.config postgresql.host 2>/dev/null)
|
|
||||||
pg_name := $(shell python -m authentik.lib.config postgresql.name 2>/dev/null)
|
|
||||||
|
|
||||||
CODESPELL_ARGS = -D - -D .github/codespell-dictionary.txt \
|
test-integration:
|
||||||
-I .github/codespell-words.txt \
|
coverage run manage.py test tests/integration
|
||||||
-S 'web/src/locales/**' \
|
|
||||||
authentik \
|
|
||||||
internal \
|
|
||||||
cmd \
|
|
||||||
web/src \
|
|
||||||
website/src \
|
|
||||||
website/blog \
|
|
||||||
website/developer-docs \
|
|
||||||
website/docs \
|
|
||||||
website/integrations \
|
|
||||||
website/src
|
|
||||||
|
|
||||||
all: lint-fix lint test gen web ## Lint, build, and test everything
|
test-e2e-provider:
|
||||||
|
coverage run manage.py test tests/e2e/test_provider*
|
||||||
|
|
||||||
HELP_WIDTH := $(shell grep -h '^[a-z][^ ]*:.*\#\#' $(MAKEFILE_LIST) 2>/dev/null | \
|
test-e2e-rest:
|
||||||
cut -d':' -f1 | awk '{printf "%d\n", length}' | sort -rn | head -1)
|
coverage run manage.py test tests/e2e/test_flows* tests/e2e/test_source*
|
||||||
|
|
||||||
help: ## Show this help
|
|
||||||
@echo "\nSpecify a command. The choices are:\n"
|
|
||||||
@grep -Eh '^[0-9a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
|
|
||||||
awk 'BEGIN {FS = ":.*?## "}; {printf " \033[0;36m%-$(HELP_WIDTH)s \033[m %s\n", $$1, $$2}' | \
|
|
||||||
sort
|
|
||||||
@echo ""
|
|
||||||
|
|
||||||
test-go:
|
test-go:
|
||||||
go test -timeout 0 -v -race -cover ./...
|
go test -timeout 0 -v -race -cover ./...
|
||||||
|
|
||||||
test-docker: ## Run all tests in a docker-compose
|
test-docker:
|
||||||
echo "PG_PASS=$(openssl rand -base64 32)" >> .env
|
echo "PG_PASS=$(openssl rand -base64 32)" >> .env
|
||||||
echo "AUTHENTIK_SECRET_KEY=$(openssl rand -base64 32)" >> .env
|
echo "AUTHENTIK_SECRET_KEY=$(openssl rand -base64 32)" >> .env
|
||||||
docker-compose pull -q
|
docker-compose pull -q
|
||||||
docker-compose up --no-start
|
docker-compose up --no-start
|
||||||
docker-compose start postgresql redis
|
docker-compose start postgresql redis
|
||||||
docker-compose run -u root server test-all
|
docker-compose run -u root server test
|
||||||
rm -f .env
|
rm -f .env
|
||||||
|
|
||||||
test: ## Run the server tests and produce a coverage report (locally)
|
test:
|
||||||
coverage run manage.py test --keepdb authentik
|
coverage run manage.py test authentik
|
||||||
coverage html
|
coverage html
|
||||||
coverage report
|
coverage report
|
||||||
|
|
||||||
lint-fix: ## Lint and automatically fix errors in the python source code. Reports spelling errors.
|
lint-fix:
|
||||||
isort $(PY_SOURCES)
|
isort authentik tests lifecycle
|
||||||
black $(PY_SOURCES)
|
black authentik tests lifecycle
|
||||||
ruff $(PY_SOURCES)
|
codespell -I .github/codespell-words.txt -S 'web/src/locales/**' -w \
|
||||||
codespell -w $(CODESPELL_ARGS)
|
authentik \
|
||||||
|
internal \
|
||||||
|
cmd \
|
||||||
|
web/src \
|
||||||
|
website/src \
|
||||||
|
website/docs \
|
||||||
|
website/developer-docs
|
||||||
|
|
||||||
lint: ## Lint the python and golang sources
|
lint:
|
||||||
bandit -r $(PY_SOURCES) -x node_modules
|
pylint authentik tests lifecycle
|
||||||
./web/node_modules/.bin/pyright $(PY_SOURCES)
|
bandit -r authentik tests lifecycle -x node_modules
|
||||||
pylint $(PY_SOURCES)
|
|
||||||
golangci-lint run -v
|
golangci-lint run -v
|
||||||
|
|
||||||
migrate: ## Run the Authentik Django server's migrations
|
i18n-extract: i18n-extract-core web-extract
|
||||||
python -m lifecycle.migrate
|
|
||||||
|
|
||||||
i18n-extract: i18n-extract-core web-i18n-extract ## Extract strings that require translation into files to send to a translation service
|
|
||||||
|
|
||||||
i18n-extract-core:
|
i18n-extract-core:
|
||||||
ak makemessages --ignore web --ignore internal --ignore web --ignore web-api --ignore website -l en
|
./manage.py makemessages --ignore web --ignore internal --ignore web --ignore web-api --ignore website -l en
|
||||||
|
|
||||||
install: web-install website-install ## Install all requires dependencies for `web`, `website` and `core`
|
gen-build:
|
||||||
poetry install
|
AUTHENTIK_DEBUG=true ./manage.py spectacular --file schema.yml
|
||||||
|
|
||||||
dev-drop-db:
|
|
||||||
dropdb -U ${pg_user} -h ${pg_host} ${pg_name}
|
|
||||||
# Also remove the test-db if it exists
|
|
||||||
dropdb -U ${pg_user} -h ${pg_host} test_${pg_name} || true
|
|
||||||
redis-cli -n 0 flushall
|
|
||||||
|
|
||||||
dev-create-db:
|
|
||||||
createdb -U ${pg_user} -h ${pg_host} ${pg_name}
|
|
||||||
|
|
||||||
dev-reset: dev-drop-db dev-create-db migrate ## Drop and restore the Authentik PostgreSQL instance to a "fresh install" state.
|
|
||||||
|
|
||||||
#########################
|
|
||||||
## API Schema
|
|
||||||
#########################
|
|
||||||
|
|
||||||
gen-build: ## Extract the schema from the database
|
|
||||||
AUTHENTIK_DEBUG=true ak make_blueprint_schema > blueprints/schema.json
|
|
||||||
AUTHENTIK_DEBUG=true ak spectacular --file schema.yml
|
|
||||||
|
|
||||||
gen-changelog: ## (Release) generate the changelog based from the commits since the last tag
|
|
||||||
git log --pretty=format:" - %s" $(shell git describe --tags $(shell git rev-list --tags --max-count=1))...$(shell git branch --show-current) | sort > changelog.md
|
|
||||||
npx prettier --write changelog.md
|
|
||||||
|
|
||||||
gen-diff: ## (Release) generate the changelog diff between the current schema and the last tag
|
|
||||||
git show $(shell git describe --tags $(shell git rev-list --tags --max-count=1)):schema.yml > old_schema.yml
|
|
||||||
docker run \
|
|
||||||
--rm -v ${PWD}:/local \
|
|
||||||
--user ${UID}:${GID} \
|
|
||||||
docker.io/openapitools/openapi-diff:2.1.0-beta.6 \
|
|
||||||
--markdown /local/diff.md \
|
|
||||||
/local/old_schema.yml /local/schema.yml
|
|
||||||
rm old_schema.yml
|
|
||||||
npx prettier --write diff.md
|
|
||||||
|
|
||||||
gen-clean:
|
gen-clean:
|
||||||
rm -rf web/api/src/
|
rm -rf web/api/src/
|
||||||
rm -rf api/
|
rm -rf api/
|
||||||
|
|
||||||
gen-client-ts: ## Build and install the authentik API for Typescript into the authentik UI Application
|
gen-client-web:
|
||||||
docker run \
|
docker run \
|
||||||
--rm -v ${PWD}:/local \
|
--rm -v ${PWD}:/local \
|
||||||
--user ${UID}:${GID} \
|
--user ${UID}:${GID} \
|
||||||
docker.io/openapitools/openapi-generator-cli:v6.5.0 generate \
|
openapitools/openapi-generator-cli:v6.0.0 generate \
|
||||||
-i /local/schema.yml \
|
-i /local/schema.yml \
|
||||||
-g typescript-fetch \
|
-g typescript-fetch \
|
||||||
-o /local/gen-ts-api \
|
-o /local/gen-ts-api \
|
||||||
-c /local/scripts/api-ts-config.yaml \
|
--additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=@goauthentik/api,npmVersion=${NPM_VERSION}
|
||||||
--additional-properties=npmVersion=${NPM_VERSION} \
|
|
||||||
--git-repo-id authentik \
|
|
||||||
--git-user-id goauthentik
|
|
||||||
mkdir -p web/node_modules/@goauthentik/api
|
mkdir -p web/node_modules/@goauthentik/api
|
||||||
|
\cp -fv scripts/web_api_readme.md gen-ts-api/README.md
|
||||||
cd gen-ts-api && npm i
|
cd gen-ts-api && npm i
|
||||||
\cp -rfv gen-ts-api/* web/node_modules/@goauthentik/api
|
\cp -rfv gen-ts-api/* web/node_modules/@goauthentik/api
|
||||||
|
|
||||||
gen-client-go: ## Build and install the authentik API for Golang
|
gen-client-go:
|
||||||
mkdir -p ./gen-go-api ./gen-go-api/templates
|
wget https://raw.githubusercontent.com/goauthentik/client-go/main/config.yaml -O config.yaml
|
||||||
wget https://raw.githubusercontent.com/goauthentik/client-go/main/config.yaml -O ./gen-go-api/config.yaml
|
mkdir -p templates
|
||||||
wget https://raw.githubusercontent.com/goauthentik/client-go/main/templates/README.mustache -O ./gen-go-api/templates/README.mustache
|
wget https://raw.githubusercontent.com/goauthentik/client-go/main/templates/README.mustache -O templates/README.mustache
|
||||||
wget https://raw.githubusercontent.com/goauthentik/client-go/main/templates/go.mod.mustache -O ./gen-go-api/templates/go.mod.mustache
|
wget https://raw.githubusercontent.com/goauthentik/client-go/main/templates/go.mod.mustache -O templates/go.mod.mustache
|
||||||
cp schema.yml ./gen-go-api/
|
|
||||||
docker run \
|
docker run \
|
||||||
--rm -v ${PWD}/gen-go-api:/local \
|
--rm -v ${PWD}:/local \
|
||||||
--user ${UID}:${GID} \
|
--user ${UID}:${GID} \
|
||||||
docker.io/openapitools/openapi-generator-cli:v6.5.0 generate \
|
openapitools/openapi-generator-cli:v6.0.0 generate \
|
||||||
-i /local/schema.yml \
|
-i /local/schema.yml \
|
||||||
-g go \
|
-g go \
|
||||||
-o /local/ \
|
-o /local/gen-go-api \
|
||||||
-c /local/config.yaml
|
-c /local/config.yaml
|
||||||
go mod edit -replace goauthentik.io/api/v3=./gen-go-api
|
go mod edit -replace goauthentik.io/api/v3=./gen-go-api
|
||||||
rm -rf ./gen-go-api/config.yaml ./gen-go-api/templates/
|
rm -rf config.yaml ./templates/
|
||||||
|
|
||||||
gen-dev-config: ## Generate a local development config file
|
gen: gen-build gen-clean gen-client-web
|
||||||
python -m scripts.generate_config
|
|
||||||
|
|
||||||
gen: gen-build gen-clean gen-client-ts
|
migrate:
|
||||||
|
python -m lifecycle.migrate
|
||||||
|
|
||||||
|
run:
|
||||||
|
go run -v cmd/server/main.go
|
||||||
|
|
||||||
#########################
|
#########################
|
||||||
## Web
|
## Web
|
||||||
#########################
|
#########################
|
||||||
|
|
||||||
web-build: web-install ## Build the Authentik UI
|
web-build: web-install
|
||||||
cd web && npm run build
|
cd web && npm run build
|
||||||
|
|
||||||
web: web-lint-fix web-lint web-check-compile web-i18n-extract ## Automatically fix formatting issues in the Authentik UI source code, lint the code, and compile it
|
web: web-lint-fix web-lint
|
||||||
|
|
||||||
web-install: ## Install the necessary libraries to build the Authentik UI
|
web-install:
|
||||||
cd web && npm ci
|
cd web && npm ci
|
||||||
|
|
||||||
web-watch: ## Build and watch the Authentik UI for changes, updating automatically
|
web-watch:
|
||||||
rm -rf web/dist/
|
rm -rf web/dist/
|
||||||
mkdir web/dist/
|
mkdir web/dist/
|
||||||
touch web/dist/.gitkeep
|
touch web/dist/.gitkeep
|
||||||
cd web && npm run watch
|
cd web && npm run watch
|
||||||
|
|
||||||
web-storybook-watch: ## Build and run the storybook documentation server
|
|
||||||
cd web && npm run storybook
|
|
||||||
|
|
||||||
web-lint-fix:
|
web-lint-fix:
|
||||||
cd web && npm run prettier
|
cd web && npm run prettier
|
||||||
|
|
||||||
|
@ -182,17 +124,14 @@ web-lint:
|
||||||
cd web && npm run lint
|
cd web && npm run lint
|
||||||
cd web && npm run lit-analyse
|
cd web && npm run lit-analyse
|
||||||
|
|
||||||
web-check-compile:
|
web-extract:
|
||||||
cd web && npm run tsc
|
cd web && npm run extract
|
||||||
|
|
||||||
web-i18n-extract:
|
|
||||||
cd web && npm run extract-locales
|
|
||||||
|
|
||||||
#########################
|
#########################
|
||||||
## Website
|
## Website
|
||||||
#########################
|
#########################
|
||||||
|
|
||||||
website: website-lint-fix website-build ## Automatically fix formatting issues in the Authentik website/docs source code, lint the code, and compile it
|
website: website-lint-fix
|
||||||
|
|
||||||
website-install:
|
website-install:
|
||||||
cd website && npm ci
|
cd website && npm ci
|
||||||
|
@ -200,22 +139,9 @@ website-install:
|
||||||
website-lint-fix:
|
website-lint-fix:
|
||||||
cd website && npm run prettier
|
cd website && npm run prettier
|
||||||
|
|
||||||
website-build:
|
website-watch:
|
||||||
cd website && npm run build
|
|
||||||
|
|
||||||
website-watch: ## Build and watch the documentation website, updating automatically
|
|
||||||
cd website && npm run watch
|
cd website && npm run watch
|
||||||
|
|
||||||
#########################
|
|
||||||
## Docker
|
|
||||||
#########################
|
|
||||||
|
|
||||||
docker: ## Build a docker image of the current source tree
|
|
||||||
DOCKER_BUILDKIT=1 docker build . --progress plain --tag ${DOCKER_IMAGE}
|
|
||||||
|
|
||||||
#########################
|
|
||||||
## CI
|
|
||||||
#########################
|
|
||||||
# These targets are use by GitHub actions to allow usage of matrix
|
# These targets are use by GitHub actions to allow usage of matrix
|
||||||
# which makes the YAML File a lot smaller
|
# which makes the YAML File a lot smaller
|
||||||
|
|
||||||
|
@ -224,25 +150,22 @@ ci--meta-debug:
|
||||||
node --version
|
node --version
|
||||||
|
|
||||||
ci-pylint: ci--meta-debug
|
ci-pylint: ci--meta-debug
|
||||||
pylint $(PY_SOURCES)
|
pylint authentik tests lifecycle
|
||||||
|
|
||||||
ci-black: ci--meta-debug
|
ci-black: ci--meta-debug
|
||||||
black --check $(PY_SOURCES)
|
black --check authentik tests lifecycle
|
||||||
|
|
||||||
ci-ruff: ci--meta-debug
|
|
||||||
ruff check $(PY_SOURCES)
|
|
||||||
|
|
||||||
ci-codespell: ci--meta-debug
|
|
||||||
codespell $(CODESPELL_ARGS) -s
|
|
||||||
|
|
||||||
ci-isort: ci--meta-debug
|
ci-isort: ci--meta-debug
|
||||||
isort --check $(PY_SOURCES)
|
isort --check authentik tests lifecycle
|
||||||
|
|
||||||
ci-bandit: ci--meta-debug
|
ci-bandit: ci--meta-debug
|
||||||
bandit -r $(PY_SOURCES)
|
bandit -r authentik tests lifecycle
|
||||||
|
|
||||||
ci-pyright: ci--meta-debug
|
ci-pyright: ci--meta-debug
|
||||||
./web/node_modules/.bin/pyright $(PY_SOURCES)
|
pyright e2e lifecycle
|
||||||
|
|
||||||
ci-pending-migrations: ci--meta-debug
|
ci-pending-migrations: ci--meta-debug
|
||||||
ak makemigrations --check
|
./manage.py makemigrations --check
|
||||||
|
|
||||||
|
install: web-install website-install
|
||||||
|
poetry install
|
||||||
|
|
45
README.md
45
README.md
|
@ -5,39 +5,56 @@
|
||||||
---
|
---
|
||||||
|
|
||||||
[![Join Discord](https://img.shields.io/discord/809154715984199690?label=Discord&style=for-the-badge)](https://goauthentik.io/discord)
|
[![Join Discord](https://img.shields.io/discord/809154715984199690?label=Discord&style=for-the-badge)](https://goauthentik.io/discord)
|
||||||
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/goauthentik/authentik/ci-main.yml?branch=main&label=core%20build&style=for-the-badge)](https://github.com/goauthentik/authentik/actions/workflows/ci-main.yml)
|
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/goauthentik/authentik/authentik-ci-main?label=core%20build&style=for-the-badge)](https://github.com/goauthentik/authentik/actions/workflows/ci-main.yml)
|
||||||
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/goauthentik/authentik/ci-outpost.yml?branch=main&label=outpost%20build&style=for-the-badge)](https://github.com/goauthentik/authentik/actions/workflows/ci-outpost.yml)
|
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/goauthentik/authentik/authentik-ci-outpost?label=outpost%20build&style=for-the-badge)](https://github.com/goauthentik/authentik/actions/workflows/ci-outpost.yml)
|
||||||
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/goauthentik/authentik/ci-web.yml?branch=main&label=web%20build&style=for-the-badge)](https://github.com/goauthentik/authentik/actions/workflows/ci-web.yml)
|
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/goauthentik/authentik/authentik-ci-web?label=web%20build&style=for-the-badge)](https://github.com/goauthentik/authentik/actions/workflows/ci-web.yml)
|
||||||
[![Code Coverage](https://img.shields.io/codecov/c/gh/goauthentik/authentik?style=for-the-badge)](https://codecov.io/gh/goauthentik/authentik)
|
[![Code Coverage](https://img.shields.io/codecov/c/gh/goauthentik/authentik?style=for-the-badge)](https://codecov.io/gh/goauthentik/authentik)
|
||||||
|
[![Testspace tests](https://img.shields.io/testspace/total/goauthentik/goauthentik:authentik/main?style=for-the-badge)](https://goauthentik.testspace.com/)
|
||||||
![Docker pulls](https://img.shields.io/docker/pulls/beryju/authentik.svg?style=for-the-badge)
|
![Docker pulls](https://img.shields.io/docker/pulls/beryju/authentik.svg?style=for-the-badge)
|
||||||
![Latest version](https://img.shields.io/docker/v/beryju/authentik?sort=semver&style=for-the-badge)
|
![Latest version](https://img.shields.io/docker/v/beryju/authentik?sort=semver&style=for-the-badge)
|
||||||
[![](https://img.shields.io/badge/Help%20translate-transifex-blue?style=for-the-badge)](https://www.transifex.com/authentik/authentik/)
|
[![](https://img.shields.io/badge/Help%20translate-transifex-blue?style=for-the-badge)](https://www.transifex.com/beryjuorg/authentik/)
|
||||||
|
|
||||||
## 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 focused on flexibility and versatility. You can use authentik in an existing environment to add support for new protocols. authentik is also a great solution for implementing signup/recovery/etc in your application, so you don't have to deal with it.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
For small/test setups it is recommended to use Docker Compose; refer to the [documentation](https://goauthentik.io/docs/installation/docker-compose/?utm_source=github).
|
For small/test setups it is recommended to use docker-compose, see the [documentation](https://goauthentik.io/docs/installation/docker-compose/?utm_source=github)
|
||||||
|
|
||||||
For bigger setups, there is a Helm Chart [here](https://github.com/goauthentik/helm). This is documented [here](https://goauthentik.io/docs/installation/kubernetes/?utm_source=github).
|
For bigger setups, there is a Helm Chart [here](https://github.com/goauthentik/helm). This is documented [here](https://goauthentik.io/docs/installation/kubernetes/?utm_source=github)
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
| Light | Dark |
|
Light | Dark
|
||||||
| ------------------------------------------------------ | ----------------------------------------------------- |
|
--- | ---
|
||||||
| ![](https://goauthentik.io/img/screen_apps_light.jpg) | ![](https://goauthentik.io/img/screen_apps_dark.jpg) |
|
![](https://goauthentik.io/img/screen_apps_light.jpg) | ![](https://goauthentik.io/img/screen_apps_dark.jpg)
|
||||||
| ![](https://goauthentik.io/img/screen_admin_light.jpg) | ![](https://goauthentik.io/img/screen_admin_dark.jpg) |
|
![](https://goauthentik.io/img/screen_admin_light.jpg) | ![](https://goauthentik.io/img/screen_admin_dark.jpg)
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
See [Developer Documentation](https://goauthentik.io/developer-docs/?utm_source=github)
|
See [Development Documentation](https://goauthentik.io/developer-docs/?utm_source=github)
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
||||||
See [SECURITY.md](SECURITY.md)
|
See [SECURITY.md](SECURITY.md)
|
||||||
|
|
||||||
## Adoption and Contributions
|
## Sponsors
|
||||||
|
|
||||||
Your organization uses authentik? We'd love to add your logo to the readme and our website! Email us @ hello@goauthentik.io or open a GitHub Issue/PR! For more information on how to contribute to authentik, please refer to our [CONTRIBUTING.md file](./CONTRIBUTING.md).
|
This project is proudly sponsored by:
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<a href="https://www.digitalocean.com/?utm_medium=opensource&utm_source=goauthentik.io">
|
||||||
|
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
DigitalOcean provides development and testing resources for authentik.
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<a href="https://www.netlify.com">
|
||||||
|
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" />
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
Netlify hosts the [goauthentik.io](https://goauthentik.io) site.
|
||||||
|
|
49
SECURITY.md
49
SECURITY.md
|
@ -1,50 +1,15 @@
|
||||||
authentik takes security very seriously. We follow the rules of [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure), and we urge our community to do so as well, instead of reporting vulnerabilities publicly. This allows us to patch the issue quickly, announce it's existence and release the fixed version.
|
# Security Policy
|
||||||
|
|
||||||
## What authentik classifies as a CVE
|
|
||||||
|
|
||||||
CVE (Common Vulnerability and Exposure) is a system designed to aggregate all vulnerabilities. As such, a CVE will be issued when there is a either vulnerability or exposure. Per NIST, A vulnerability is:
|
|
||||||
|
|
||||||
“Weakness in an information system, system security procedures, internal controls, or implementation that could be exploited or triggered by a threat source.”
|
|
||||||
|
|
||||||
If it is determined that the issue does qualify as a CVE, a CVE number will be issued to the reporter from GitHub.
|
|
||||||
|
|
||||||
Even if the issue is not a CVE, we still greatly appreciate your help in hardening authentik.
|
|
||||||
|
|
||||||
## Supported Versions
|
## Supported Versions
|
||||||
|
|
||||||
(.x being the latest patch release for each version)
|
(.x being the latest patch release for each version)
|
||||||
|
|
||||||
| Version | Supported |
|
| Version | Supported |
|
||||||
| --- | --- |
|
| ---------- | ------------------ |
|
||||||
| 2023.6.x | ✅ |
|
| 2022.5.x | :white_check_mark: |
|
||||||
| 2023.8.x | ✅ |
|
| 2022.6.x | :white_check_mark: |
|
||||||
|
| 2022.7.x | :white_check_mark: |
|
||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
To report a vulnerability, send an email to [security@goauthentik.io](mailto:security@goauthentik.io). Be sure to include relevant information like which version you've found the issue in, instructions on how to reproduce the issue, and anything else that might make it easier for us to find the issue.
|
To report a vulnerability, send an email to [security@goauthentik.io](mailto:security@goauthentik.io)
|
||||||
|
|
||||||
## Severity levels
|
|
||||||
|
|
||||||
authentik reserves the right to reclassify CVSS as necessary. To determine severity, we will use the CVSS calculator from NVD (https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator). The calculated CVSS score will then be translated into one of the following categories:
|
|
||||||
|
|
||||||
| Score | Severity |
|
|
||||||
| --- | --- |
|
|
||||||
| 0.0 | None |
|
|
||||||
| 0.1 – 3.9 | Low |
|
|
||||||
| 4.0 – 6.9 | Medium |
|
|
||||||
| 7.0 – 8.9 | High |
|
|
||||||
| 9.0 – 10.0 | Critical |
|
|
||||||
|
|
||||||
## Disclosure process
|
|
||||||
|
|
||||||
1. Report from Github or Issue is reported via Email as listed above.
|
|
||||||
2. The authentik Security team will try to reproduce the issue and ask for more information if required.
|
|
||||||
3. A severity level is assigned.
|
|
||||||
4. A fix is created, and if possible tested by the issue reporter.
|
|
||||||
5. The fix is backported to other supported versions, and if possible a workaround for other versions is created.
|
|
||||||
6. An announcement is sent out with a fixed release date and severity level of the issue. The announcement will be sent at least 24 hours before the release of the security fix.
|
|
||||||
7. The fixed version is released for the supported versions.
|
|
||||||
|
|
||||||
## Getting security notifications
|
|
||||||
|
|
||||||
To get security notifications, subscribe to the mailing list [here](https://groups.google.com/g/authentik-security-announcements) or join the [discord](https://goauthentik.io/discord) server.
|
|
||||||
|
|
|
@ -1,15 +1,17 @@
|
||||||
"""authentik root module"""
|
"""authentik"""
|
||||||
from os import environ
|
from os import environ
|
||||||
from typing import Optional
|
from typing import Optional
|
||||||
|
|
||||||
__version__ = "2023.10.6"
|
__version__ = "2022.7.3"
|
||||||
ENV_GIT_HASH_KEY = "GIT_BUILD_HASH"
|
ENV_GIT_HASH_KEY = "GIT_BUILD_HASH"
|
||||||
|
|
||||||
|
|
||||||
def get_build_hash(fallback: Optional[str] = None) -> str:
|
def get_build_hash(fallback: Optional[str] = None) -> str:
|
||||||
"""Get build hash"""
|
"""Get build hash"""
|
||||||
build_hash = environ.get(ENV_GIT_HASH_KEY, fallback if fallback else "")
|
build_hash = environ.get(ENV_GIT_HASH_KEY, fallback if fallback else "")
|
||||||
return fallback if build_hash == "" and fallback else build_hash
|
if build_hash == "" and fallback:
|
||||||
|
return fallback
|
||||||
|
return build_hash
|
||||||
|
|
||||||
|
|
||||||
def get_full_version() -> str:
|
def get_full_version() -> str:
|
||||||
|
|
|
@ -1,14 +1,13 @@
|
||||||
"""Meta API"""
|
"""Meta API"""
|
||||||
from drf_spectacular.utils import extend_schema
|
from drf_spectacular.utils import extend_schema
|
||||||
from rest_framework.fields import CharField
|
from rest_framework.fields import CharField
|
||||||
from rest_framework.permissions import IsAuthenticated
|
from rest_framework.permissions import IsAdminUser
|
||||||
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 PassiveSerializer
|
from authentik.core.api.utils import PassiveSerializer
|
||||||
from authentik.lib.utils.reflection import get_apps
|
from authentik.lib.utils.reflection import get_apps
|
||||||
from authentik.policies.event_matcher.models import model_choices
|
|
||||||
|
|
||||||
|
|
||||||
class AppSerializer(PassiveSerializer):
|
class AppSerializer(PassiveSerializer):
|
||||||
|
@ -19,28 +18,14 @@ class AppSerializer(PassiveSerializer):
|
||||||
|
|
||||||
|
|
||||||
class AppsViewSet(ViewSet):
|
class AppsViewSet(ViewSet):
|
||||||
"""Read-only view list all installed apps"""
|
"""Read-only view set list all installed apps"""
|
||||||
|
|
||||||
permission_classes = [IsAuthenticated]
|
permission_classes = [IsAdminUser]
|
||||||
|
|
||||||
@extend_schema(responses={200: AppSerializer(many=True)})
|
@extend_schema(responses={200: AppSerializer(many=True)})
|
||||||
def list(self, request: Request) -> Response:
|
def list(self, request: Request) -> Response:
|
||||||
"""Read-only view list all installed apps"""
|
"""List current messages and pass into Serializer"""
|
||||||
data = []
|
data = []
|
||||||
for app in sorted(get_apps(), key=lambda app: app.name):
|
for app in sorted(get_apps(), key=lambda app: app.name):
|
||||||
data.append({"name": app.name, "label": app.verbose_name})
|
data.append({"name": app.name, "label": app.verbose_name})
|
||||||
return Response(AppSerializer(data, many=True).data)
|
return Response(AppSerializer(data, many=True).data)
|
||||||
|
|
||||||
|
|
||||||
class ModelViewSet(ViewSet):
|
|
||||||
"""Read-only view list all installed models"""
|
|
||||||
|
|
||||||
permission_classes = [IsAuthenticated]
|
|
||||||
|
|
||||||
@extend_schema(responses={200: AppSerializer(many=True)})
|
|
||||||
def list(self, request: Request) -> Response:
|
|
||||||
"""Read-only view list all installed models"""
|
|
||||||
data = []
|
|
||||||
for name, label in model_choices():
|
|
||||||
data.append({"name": name, "label": label})
|
|
||||||
return Response(AppSerializer(data, many=True).data)
|
|
||||||
|
|
|
@ -1,11 +1,8 @@
|
||||||
"""authentik administration metrics"""
|
"""authentik administration metrics"""
|
||||||
from datetime import timedelta
|
|
||||||
|
|
||||||
from django.db.models.functions import ExtractHour
|
|
||||||
from drf_spectacular.utils import extend_schema, extend_schema_field
|
from drf_spectacular.utils import extend_schema, extend_schema_field
|
||||||
from guardian.shortcuts import get_objects_for_user
|
from guardian.shortcuts import get_objects_for_user
|
||||||
from rest_framework.fields import IntegerField, SerializerMethodField
|
from rest_framework.fields import IntegerField, SerializerMethodField
|
||||||
from rest_framework.permissions import IsAuthenticated
|
from rest_framework.permissions import IsAdminUser
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
from rest_framework.views import APIView
|
from rest_framework.views import APIView
|
||||||
|
@ -24,51 +21,34 @@ class CoordinateSerializer(PassiveSerializer):
|
||||||
class LoginMetricsSerializer(PassiveSerializer):
|
class LoginMetricsSerializer(PassiveSerializer):
|
||||||
"""Login Metrics per 1h"""
|
"""Login Metrics per 1h"""
|
||||||
|
|
||||||
logins = SerializerMethodField()
|
logins_per_1h = SerializerMethodField()
|
||||||
logins_failed = SerializerMethodField()
|
logins_failed_per_1h = SerializerMethodField()
|
||||||
authorizations = SerializerMethodField()
|
|
||||||
|
|
||||||
@extend_schema_field(CoordinateSerializer(many=True))
|
@extend_schema_field(CoordinateSerializer(many=True))
|
||||||
def get_logins(self, _):
|
def get_logins_per_1h(self, _):
|
||||||
"""Get successful logins per 8 hours for the last 7 days"""
|
"""Get successful logins per hour for the last 24 hours"""
|
||||||
user = self.context["user"]
|
user = self.context["user"]
|
||||||
return (
|
return (
|
||||||
get_objects_for_user(user, "authentik_events.view_event").filter(
|
get_objects_for_user(user, "authentik_events.view_event")
|
||||||
action=EventAction.LOGIN
|
.filter(action=EventAction.LOGIN)
|
||||||
)
|
.get_events_per_hour()
|
||||||
# 3 data points per day, so 8 hour spans
|
|
||||||
.get_events_per(timedelta(days=7), ExtractHour, 7 * 3)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
@extend_schema_field(CoordinateSerializer(many=True))
|
@extend_schema_field(CoordinateSerializer(many=True))
|
||||||
def get_logins_failed(self, _):
|
def get_logins_failed_per_1h(self, _):
|
||||||
"""Get failed logins per 8 hours for the last 7 days"""
|
"""Get failed logins per hour for the last 24 hours"""
|
||||||
user = self.context["user"]
|
user = self.context["user"]
|
||||||
return (
|
return (
|
||||||
get_objects_for_user(user, "authentik_events.view_event").filter(
|
get_objects_for_user(user, "authentik_events.view_event")
|
||||||
action=EventAction.LOGIN_FAILED
|
.filter(action=EventAction.LOGIN_FAILED)
|
||||||
)
|
.get_events_per_hour()
|
||||||
# 3 data points per day, so 8 hour spans
|
|
||||||
.get_events_per(timedelta(days=7), ExtractHour, 7 * 3)
|
|
||||||
)
|
|
||||||
|
|
||||||
@extend_schema_field(CoordinateSerializer(many=True))
|
|
||||||
def get_authorizations(self, _):
|
|
||||||
"""Get successful authorizations per 8 hours for the last 7 days"""
|
|
||||||
user = self.context["user"]
|
|
||||||
return (
|
|
||||||
get_objects_for_user(user, "authentik_events.view_event").filter(
|
|
||||||
action=EventAction.AUTHORIZE_APPLICATION
|
|
||||||
)
|
|
||||||
# 3 data points per day, so 8 hour spans
|
|
||||||
.get_events_per(timedelta(days=7), ExtractHour, 7 * 3)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
class AdministrationMetricsViewSet(APIView):
|
class AdministrationMetricsViewSet(APIView):
|
||||||
"""Login Metrics per 1h"""
|
"""Login Metrics per 1h"""
|
||||||
|
|
||||||
permission_classes = [IsAuthenticated]
|
permission_classes = [IsAdminUser]
|
||||||
|
|
||||||
@extend_schema(responses={200: LoginMetricsSerializer(many=False)})
|
@extend_schema(responses={200: LoginMetricsSerializer(many=False)})
|
||||||
def get(self, request: Request) -> Response:
|
def get(self, request: Request) -> Response:
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
"""authentik administration overview"""
|
"""authentik administration overview"""
|
||||||
|
import os
|
||||||
import platform
|
import platform
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from sys import version as python_version
|
from sys import version as python_version
|
||||||
|
@ -7,16 +8,16 @@ from typing import TypedDict
|
||||||
from django.utils.timezone import now
|
from django.utils.timezone import now
|
||||||
from drf_spectacular.utils import extend_schema
|
from drf_spectacular.utils import extend_schema
|
||||||
from gunicorn import version_info as gunicorn_version
|
from gunicorn import version_info as gunicorn_version
|
||||||
|
from kubernetes.config.incluster_config import SERVICE_HOST_ENV_NAME
|
||||||
from rest_framework.fields import SerializerMethodField
|
from rest_framework.fields import SerializerMethodField
|
||||||
|
from rest_framework.permissions import IsAdminUser
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
from rest_framework.views import APIView
|
from rest_framework.views import APIView
|
||||||
|
|
||||||
from authentik.core.api.utils import PassiveSerializer
|
from authentik.core.api.utils import PassiveSerializer
|
||||||
from authentik.lib.utils.reflection import get_env
|
from authentik.outposts.managed import MANAGED_OUTPOST
|
||||||
from authentik.outposts.apps import MANAGED_OUTPOST
|
|
||||||
from authentik.outposts.models import Outpost
|
from authentik.outposts.models import Outpost
|
||||||
from authentik.rbac.permissions import HasPermission
|
|
||||||
|
|
||||||
|
|
||||||
class RuntimeDict(TypedDict):
|
class RuntimeDict(TypedDict):
|
||||||
|
@ -33,6 +34,7 @@ class RuntimeDict(TypedDict):
|
||||||
class SystemSerializer(PassiveSerializer):
|
class SystemSerializer(PassiveSerializer):
|
||||||
"""Get system information."""
|
"""Get system information."""
|
||||||
|
|
||||||
|
env = SerializerMethodField()
|
||||||
http_headers = SerializerMethodField()
|
http_headers = SerializerMethodField()
|
||||||
http_host = SerializerMethodField()
|
http_host = SerializerMethodField()
|
||||||
http_is_secure = SerializerMethodField()
|
http_is_secure = SerializerMethodField()
|
||||||
|
@ -41,6 +43,10 @@ class SystemSerializer(PassiveSerializer):
|
||||||
server_time = SerializerMethodField()
|
server_time = SerializerMethodField()
|
||||||
embedded_outpost_host = SerializerMethodField()
|
embedded_outpost_host = SerializerMethodField()
|
||||||
|
|
||||||
|
def get_env(self, request: Request) -> dict[str, str]:
|
||||||
|
"""Get Environment"""
|
||||||
|
return os.environ.copy()
|
||||||
|
|
||||||
def get_http_headers(self, request: Request) -> dict[str, str]:
|
def get_http_headers(self, request: Request) -> dict[str, str]:
|
||||||
"""Get HTTP Request headers"""
|
"""Get HTTP Request headers"""
|
||||||
headers = {}
|
headers = {}
|
||||||
|
@ -63,7 +69,7 @@ class SystemSerializer(PassiveSerializer):
|
||||||
return {
|
return {
|
||||||
"python_version": python_version,
|
"python_version": python_version,
|
||||||
"gunicorn_version": ".".join(str(x) for x in gunicorn_version),
|
"gunicorn_version": ".".join(str(x) for x in gunicorn_version),
|
||||||
"environment": get_env(),
|
"environment": "kubernetes" if SERVICE_HOST_ENV_NAME in os.environ else "compose",
|
||||||
"architecture": platform.machine(),
|
"architecture": platform.machine(),
|
||||||
"platform": platform.platform(),
|
"platform": platform.platform(),
|
||||||
"uname": " ".join(platform.uname()),
|
"uname": " ".join(platform.uname()),
|
||||||
|
@ -88,17 +94,11 @@ class SystemSerializer(PassiveSerializer):
|
||||||
class SystemView(APIView):
|
class SystemView(APIView):
|
||||||
"""Get system information."""
|
"""Get system information."""
|
||||||
|
|
||||||
permission_classes = [HasPermission("authentik_rbac.view_system_info")]
|
permission_classes = [IsAdminUser]
|
||||||
pagination_class = None
|
pagination_class = None
|
||||||
filter_backends = []
|
filter_backends = []
|
||||||
serializer_class = SystemSerializer
|
|
||||||
|
|
||||||
@extend_schema(responses={200: SystemSerializer(many=False)})
|
@extend_schema(responses={200: SystemSerializer(many=False)})
|
||||||
def get(self, request: Request) -> Response:
|
def get(self, request: Request) -> Response:
|
||||||
"""Get system information."""
|
"""Get system information."""
|
||||||
return Response(SystemSerializer(request).data)
|
return Response(SystemSerializer(request).data)
|
||||||
|
|
||||||
@extend_schema(responses={200: SystemSerializer(many=False)})
|
|
||||||
def post(self, request: Request) -> Response:
|
|
||||||
"""Get system information."""
|
|
||||||
return Response(SystemSerializer(request).data)
|
|
||||||
|
|
|
@ -5,24 +5,17 @@ from django.contrib import messages
|
||||||
from django.http.response import Http404
|
from django.http.response import Http404
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
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 OpenApiResponse, extend_schema
|
||||||
from rest_framework.decorators import action
|
from rest_framework.decorators import action
|
||||||
from rest_framework.fields import (
|
from rest_framework.fields import CharField, ChoiceField, DateTimeField, ListField
|
||||||
CharField,
|
from rest_framework.permissions import IsAdminUser
|
||||||
ChoiceField,
|
|
||||||
DateTimeField,
|
|
||||||
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.viewsets import ViewSet
|
from rest_framework.viewsets import ViewSet
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
|
|
||||||
from authentik.api.decorators import permission_required
|
|
||||||
from authentik.core.api.utils import PassiveSerializer
|
from authentik.core.api.utils import PassiveSerializer
|
||||||
from authentik.events.monitored_tasks import TaskInfo, TaskResultStatus
|
from authentik.events.monitored_tasks import TaskInfo, TaskResultStatus
|
||||||
from authentik.rbac.permissions import HasPermission
|
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
@ -33,7 +26,6 @@ class TaskSerializer(PassiveSerializer):
|
||||||
task_name = CharField()
|
task_name = CharField()
|
||||||
task_description = CharField()
|
task_description = CharField()
|
||||||
task_finish_timestamp = DateTimeField(source="finish_time")
|
task_finish_timestamp = DateTimeField(source="finish_time")
|
||||||
task_duration = SerializerMethodField()
|
|
||||||
|
|
||||||
status = ChoiceField(
|
status = ChoiceField(
|
||||||
source="result.status.name",
|
source="result.status.name",
|
||||||
|
@ -41,18 +33,13 @@ class TaskSerializer(PassiveSerializer):
|
||||||
)
|
)
|
||||||
messages = ListField(source="result.messages")
|
messages = ListField(source="result.messages")
|
||||||
|
|
||||||
def get_task_duration(self, instance: TaskInfo) -> int:
|
def to_representation(self, instance):
|
||||||
"""Get the duration a task took to run"""
|
|
||||||
return max(instance.finish_timestamp - instance.start_timestamp, 0)
|
|
||||||
|
|
||||||
def to_representation(self, instance: TaskInfo):
|
|
||||||
"""When a new version of authentik adds fields to TaskInfo,
|
"""When a new version of authentik adds fields to TaskInfo,
|
||||||
the API will fail with an AttributeError, as the classes
|
the API will fail with an AttributeError, as the classes
|
||||||
are pickled in cache. In that case, just delete the info"""
|
are pickled in cache. In that case, just delete the info"""
|
||||||
try:
|
try:
|
||||||
return super().to_representation(instance)
|
return super().to_representation(instance)
|
||||||
# pylint: disable=broad-except
|
except AttributeError: # pragma: no cover
|
||||||
except Exception: # pragma: no cover
|
|
||||||
if isinstance(self.instance, list):
|
if isinstance(self.instance, list):
|
||||||
for inst in self.instance:
|
for inst in self.instance:
|
||||||
inst.delete()
|
inst.delete()
|
||||||
|
@ -64,23 +51,16 @@ class TaskSerializer(PassiveSerializer):
|
||||||
class TaskViewSet(ViewSet):
|
class TaskViewSet(ViewSet):
|
||||||
"""Read-only view set that returns all background tasks"""
|
"""Read-only view set that returns all background tasks"""
|
||||||
|
|
||||||
permission_classes = [HasPermission("authentik_rbac.view_system_tasks")]
|
permission_classes = [IsAdminUser]
|
||||||
serializer_class = TaskSerializer
|
serializer_class = TaskSerializer
|
||||||
|
|
||||||
@extend_schema(
|
@extend_schema(
|
||||||
responses={
|
responses={
|
||||||
200: TaskSerializer(many=False),
|
200: TaskSerializer(many=False),
|
||||||
404: OpenApiResponse(description="Task not found"),
|
404: OpenApiResponse(description="Task not found"),
|
||||||
},
|
}
|
||||||
parameters=[
|
|
||||||
OpenApiParameter(
|
|
||||||
"id",
|
|
||||||
type=OpenApiTypes.STR,
|
|
||||||
location=OpenApiParameter.PATH,
|
|
||||||
required=True,
|
|
||||||
),
|
|
||||||
],
|
|
||||||
)
|
)
|
||||||
|
# pylint: disable=invalid-name
|
||||||
def retrieve(self, request: Request, pk=None) -> Response:
|
def retrieve(self, request: Request, pk=None) -> Response:
|
||||||
"""Get a single system task"""
|
"""Get a single system task"""
|
||||||
task = TaskInfo.by_name(pk)
|
task = TaskInfo.by_name(pk)
|
||||||
|
@ -94,7 +74,6 @@ class TaskViewSet(ViewSet):
|
||||||
tasks = sorted(TaskInfo.all().values(), key=lambda task: task.task_name)
|
tasks = sorted(TaskInfo.all().values(), key=lambda task: task.task_name)
|
||||||
return Response(TaskSerializer(tasks, many=True).data)
|
return Response(TaskSerializer(tasks, many=True).data)
|
||||||
|
|
||||||
@permission_required(None, ["authentik_rbac.run_system_tasks"])
|
|
||||||
@extend_schema(
|
@extend_schema(
|
||||||
request=OpenApiTypes.NONE,
|
request=OpenApiTypes.NONE,
|
||||||
responses={
|
responses={
|
||||||
|
@ -102,16 +81,9 @@ class TaskViewSet(ViewSet):
|
||||||
404: OpenApiResponse(description="Task not found"),
|
404: OpenApiResponse(description="Task not found"),
|
||||||
500: OpenApiResponse(description="Failed to retry task"),
|
500: OpenApiResponse(description="Failed to retry task"),
|
||||||
},
|
},
|
||||||
parameters=[
|
|
||||||
OpenApiParameter(
|
|
||||||
"id",
|
|
||||||
type=OpenApiTypes.STR,
|
|
||||||
location=OpenApiParameter.PATH,
|
|
||||||
required=True,
|
|
||||||
),
|
|
||||||
],
|
|
||||||
)
|
)
|
||||||
@action(detail=True, methods=["post"])
|
@action(detail=True, methods=["post"])
|
||||||
|
# pylint: disable=invalid-name
|
||||||
def retry(self, request: Request, pk=None) -> Response:
|
def retry(self, request: Request, pk=None) -> Response:
|
||||||
"""Retry task"""
|
"""Retry task"""
|
||||||
task = TaskInfo.by_name(pk)
|
task = TaskInfo.by_name(pk)
|
||||||
|
|
|
@ -2,24 +2,24 @@
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from drf_spectacular.utils import extend_schema, inline_serializer
|
from drf_spectacular.utils import extend_schema, inline_serializer
|
||||||
from rest_framework.fields import IntegerField
|
from rest_framework.fields import IntegerField
|
||||||
|
from rest_framework.permissions import IsAdminUser
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
from rest_framework.views import APIView
|
from rest_framework.views import APIView
|
||||||
|
|
||||||
from authentik.rbac.permissions import HasPermission
|
|
||||||
from authentik.root.celery import CELERY_APP
|
from authentik.root.celery import CELERY_APP
|
||||||
|
|
||||||
|
|
||||||
class WorkerView(APIView):
|
class WorkerView(APIView):
|
||||||
"""Get currently connected worker count."""
|
"""Get currently connected worker count."""
|
||||||
|
|
||||||
permission_classes = [HasPermission("authentik_rbac.view_system_info")]
|
permission_classes = [IsAdminUser]
|
||||||
|
|
||||||
@extend_schema(responses=inline_serializer("Workers", fields={"count": IntegerField()}))
|
@extend_schema(responses=inline_serializer("Workers", fields={"count": IntegerField()}))
|
||||||
def get(self, request: Request) -> Response:
|
def get(self, request: Request) -> Response:
|
||||||
"""Get currently connected worker count."""
|
"""Get currently connected worker count."""
|
||||||
count = len(CELERY_APP.control.ping(timeout=0.5))
|
count = len(CELERY_APP.control.ping(timeout=0.5))
|
||||||
# In debug we run with `task_always_eager`, so tasks are ran on the main process
|
# In debug we run with `CELERY_TASK_ALWAYS_EAGER`, so tasks are ran on the main process
|
||||||
if settings.DEBUG: # pragma: no cover
|
if settings.DEBUG: # pragma: no cover
|
||||||
count += 1
|
count += 1
|
||||||
return Response({"count": count})
|
return Response({"count": count})
|
||||||
|
|
|
@ -1,20 +1,19 @@
|
||||||
"""authentik admin app config"""
|
"""authentik admin app config"""
|
||||||
from prometheus_client import Gauge, Info
|
from importlib import import_module
|
||||||
|
|
||||||
from authentik.blueprints.apps import ManagedAppConfig
|
from django.apps import AppConfig
|
||||||
|
from prometheus_client import Gauge, Info
|
||||||
|
|
||||||
PROM_INFO = Info("authentik_version", "Currently running authentik version")
|
PROM_INFO = Info("authentik_version", "Currently running authentik version")
|
||||||
GAUGE_WORKERS = Gauge("authentik_admin_workers", "Currently connected workers")
|
GAUGE_WORKERS = Gauge("authentik_admin_workers", "Currently connected workers")
|
||||||
|
|
||||||
|
|
||||||
class AuthentikAdminConfig(ManagedAppConfig):
|
class AuthentikAdminConfig(AppConfig):
|
||||||
"""authentik admin app config"""
|
"""authentik admin app config"""
|
||||||
|
|
||||||
name = "authentik.admin"
|
name = "authentik.admin"
|
||||||
label = "authentik_admin"
|
label = "authentik_admin"
|
||||||
verbose_name = "authentik Admin"
|
verbose_name = "authentik Admin"
|
||||||
default = True
|
|
||||||
|
|
||||||
def reconcile_load_admin_signals(self):
|
def ready(self):
|
||||||
"""Load admin signals"""
|
import_module("authentik.admin.signals")
|
||||||
self.import_module("authentik.admin.signals")
|
|
||||||
|
|
|
@ -8,6 +8,7 @@ from authentik.root.monitoring import monitoring_set
|
||||||
|
|
||||||
|
|
||||||
@receiver(monitoring_set)
|
@receiver(monitoring_set)
|
||||||
|
# pylint: disable=unused-argument
|
||||||
def monitoring_set_workers(sender, **kwargs):
|
def monitoring_set_workers(sender, **kwargs):
|
||||||
"""Set worker gauge"""
|
"""Set worker gauge"""
|
||||||
count = len(CELERY_APP.control.ping(timeout=0.5))
|
count = len(CELERY_APP.control.ping(timeout=0.5))
|
||||||
|
@ -15,7 +16,8 @@ def monitoring_set_workers(sender, **kwargs):
|
||||||
|
|
||||||
|
|
||||||
@receiver(monitoring_set)
|
@receiver(monitoring_set)
|
||||||
|
# pylint: disable=unused-argument
|
||||||
def monitoring_set_tasks(sender, **kwargs):
|
def monitoring_set_tasks(sender, **kwargs):
|
||||||
"""Set task gauges"""
|
"""Set task gauges"""
|
||||||
for task in TaskInfo.all().values():
|
for task in TaskInfo.all().values():
|
||||||
task.update_metrics()
|
task.set_prom_metrics()
|
||||||
|
|
|
@ -3,7 +3,6 @@ import re
|
||||||
|
|
||||||
from django.core.cache import cache
|
from django.core.cache import cache
|
||||||
from django.core.validators import URLValidator
|
from django.core.validators import URLValidator
|
||||||
from django.db import DatabaseError, InternalError, ProgrammingError
|
|
||||||
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
|
||||||
|
@ -40,9 +39,7 @@ def _set_prom_info():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@CELERY_APP.task(
|
@CELERY_APP.task()
|
||||||
throws=(DatabaseError, ProgrammingError, InternalError),
|
|
||||||
)
|
|
||||||
def clear_update_notifications():
|
def clear_update_notifications():
|
||||||
"""Clear update notifications on startup if the notification was for the version
|
"""Clear update notifications on startup if the notification was for the version
|
||||||
we're running now."""
|
we're running now."""
|
||||||
|
@ -58,7 +55,7 @@ def clear_update_notifications():
|
||||||
@prefill_task
|
@prefill_task
|
||||||
def update_latest_version(self: MonitoredTask):
|
def update_latest_version(self: MonitoredTask):
|
||||||
"""Update latest version info"""
|
"""Update latest version info"""
|
||||||
if CONFIG.get_bool("disable_update_check"):
|
if CONFIG.y_bool("disable_update_check"):
|
||||||
cache.set(VERSION_CACHE_KEY, "0.0.0", VERSION_CACHE_TIMEOUT)
|
cache.set(VERSION_CACHE_KEY, "0.0.0", VERSION_CACHE_TIMEOUT)
|
||||||
self.set_status(TaskResult(TaskResultStatus.WARNING, messages=["Version check disabled."]))
|
self.set_status(TaskResult(TaskResultStatus.WARNING, messages=["Version check disabled."]))
|
||||||
return
|
return
|
||||||
|
|
|
@ -5,11 +5,10 @@ from django.test import TestCase
|
||||||
from django.urls import reverse
|
from django.urls import reverse
|
||||||
|
|
||||||
from authentik import __version__
|
from authentik import __version__
|
||||||
from authentik.blueprints.tests import reconcile_app
|
|
||||||
from authentik.core.models import Group, User
|
from authentik.core.models import Group, User
|
||||||
from authentik.core.tasks import clean_expired_models
|
from authentik.core.tasks import clean_expired_models
|
||||||
from authentik.events.monitored_tasks import TaskResultStatus
|
from authentik.events.monitored_tasks import TaskResultStatus
|
||||||
from authentik.lib.generators import generate_id
|
from authentik.managed.tasks import managed_reconcile
|
||||||
|
|
||||||
|
|
||||||
class TestAdminAPI(TestCase):
|
class TestAdminAPI(TestCase):
|
||||||
|
@ -17,8 +16,8 @@ class TestAdminAPI(TestCase):
|
||||||
|
|
||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
self.user = User.objects.create(username=generate_id())
|
self.user = User.objects.create(username="test-user")
|
||||||
self.group = Group.objects.create(name=generate_id(), is_superuser=True)
|
self.group = Group.objects.create(name="superusers", is_superuser=True)
|
||||||
self.group.users.add(self.user)
|
self.group.users.add(self.user)
|
||||||
self.group.save()
|
self.group.save()
|
||||||
self.client.force_login(self.user)
|
self.client.force_login(self.user)
|
||||||
|
@ -94,13 +93,9 @@ class TestAdminAPI(TestCase):
|
||||||
response = self.client.get(reverse("authentik_api:apps-list"))
|
response = self.client.get(reverse("authentik_api:apps-list"))
|
||||||
self.assertEqual(response.status_code, 200)
|
self.assertEqual(response.status_code, 200)
|
||||||
|
|
||||||
def test_models(self):
|
|
||||||
"""Test models API"""
|
|
||||||
response = self.client.get(reverse("authentik_api:models-list"))
|
|
||||||
self.assertEqual(response.status_code, 200)
|
|
||||||
|
|
||||||
@reconcile_app("authentik_outposts")
|
|
||||||
def test_system(self):
|
def test_system(self):
|
||||||
"""Test system API"""
|
"""Test system API"""
|
||||||
|
# pyright: reportGeneralTypeIssues=false
|
||||||
|
managed_reconcile() # pylint: disable=no-value-for-parameter
|
||||||
response = self.client.get(reverse("authentik_api:admin_system"))
|
response = self.client.get(reverse("authentik_api:admin_system"))
|
||||||
self.assertEqual(response.status_code, 200)
|
self.assertEqual(response.status_code, 200)
|
||||||
|
|
|
@ -1,23 +0,0 @@
|
||||||
"""API URLs"""
|
|
||||||
from django.urls import path
|
|
||||||
|
|
||||||
from authentik.admin.api.meta import AppsViewSet, ModelViewSet
|
|
||||||
from authentik.admin.api.metrics import AdministrationMetricsViewSet
|
|
||||||
from authentik.admin.api.system import SystemView
|
|
||||||
from authentik.admin.api.tasks import TaskViewSet
|
|
||||||
from authentik.admin.api.version import VersionView
|
|
||||||
from authentik.admin.api.workers import WorkerView
|
|
||||||
|
|
||||||
api_urlpatterns = [
|
|
||||||
("admin/system_tasks", TaskViewSet, "admin_system_tasks"),
|
|
||||||
("admin/apps", AppsViewSet, "apps"),
|
|
||||||
("admin/models", ModelViewSet, "models"),
|
|
||||||
path(
|
|
||||||
"admin/metrics/",
|
|
||||||
AdministrationMetricsViewSet.as_view(),
|
|
||||||
name="admin_metrics",
|
|
||||||
),
|
|
||||||
path("admin/version/", VersionView.as_view(), name="admin_version"),
|
|
||||||
path("admin/workers/", WorkerView.as_view(), name="admin_workers"),
|
|
||||||
path("admin/system/", SystemView.as_view(), name="admin_system"),
|
|
||||||
]
|
|
|
@ -31,5 +31,4 @@ class AuthentikAPIConfig(AppConfig):
|
||||||
"type": "apiKey",
|
"type": "apiKey",
|
||||||
"in": "header",
|
"in": "header",
|
||||||
"name": "Authorization",
|
"name": "Authorization",
|
||||||
"scheme": "bearer",
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,5 +1,4 @@
|
||||||
"""API Authentication"""
|
"""API Authentication"""
|
||||||
from hmac import compare_digest
|
|
||||||
from typing import Any, Optional
|
from typing import Any, Optional
|
||||||
|
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
|
@ -8,15 +7,16 @@ from rest_framework.exceptions import AuthenticationFailed
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
from structlog.stdlib import get_logger
|
from structlog.stdlib import get_logger
|
||||||
|
|
||||||
from authentik.core.middleware import CTX_AUTH_VIA
|
from authentik.core.middleware import KEY_AUTH_VIA, LOCAL
|
||||||
from authentik.core.models import Token, TokenIntents, User
|
from authentik.core.models import Token, TokenIntents, User
|
||||||
from authentik.outposts.models import Outpost
|
from authentik.outposts.models import Outpost
|
||||||
from authentik.providers.oauth2.constants import SCOPE_AUTHENTIK_API
|
from authentik.providers.oauth2.constants import SCOPE_AUTHENTIK_API
|
||||||
|
from authentik.providers.oauth2.models import RefreshToken
|
||||||
|
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
def validate_auth(header: bytes) -> Optional[str]:
|
def validate_auth(header: bytes) -> str:
|
||||||
"""Validate that the header is in a correct format,
|
"""Validate that the header is in a correct format,
|
||||||
returns type and credentials"""
|
returns type and credentials"""
|
||||||
auth_credentials = header.decode().strip()
|
auth_credentials = header.decode().strip()
|
||||||
|
@ -33,43 +33,33 @@ def validate_auth(header: bytes) -> Optional[str]:
|
||||||
|
|
||||||
def bearer_auth(raw_header: bytes) -> Optional[User]:
|
def bearer_auth(raw_header: bytes) -> Optional[User]:
|
||||||
"""raw_header in the Format of `Bearer ....`"""
|
"""raw_header in the Format of `Bearer ....`"""
|
||||||
user = auth_user_lookup(raw_header)
|
|
||||||
if not user:
|
|
||||||
return None
|
|
||||||
if not user.is_active:
|
|
||||||
raise AuthenticationFailed("Token invalid/expired")
|
|
||||||
return user
|
|
||||||
|
|
||||||
|
|
||||||
def auth_user_lookup(raw_header: bytes) -> Optional[User]:
|
|
||||||
"""raw_header in the Format of `Bearer ....`"""
|
|
||||||
from authentik.providers.oauth2.models import AccessToken
|
|
||||||
|
|
||||||
auth_credentials = validate_auth(raw_header)
|
auth_credentials = validate_auth(raw_header)
|
||||||
if not auth_credentials:
|
if not auth_credentials:
|
||||||
return None
|
return None
|
||||||
|
if not hasattr(LOCAL, "authentik"):
|
||||||
|
LOCAL.authentik = {}
|
||||||
# first, check traditional tokens
|
# first, check traditional tokens
|
||||||
key_token = Token.filter_not_expired(
|
key_token = Token.filter_not_expired(
|
||||||
key=auth_credentials, intent=TokenIntents.INTENT_API
|
key=auth_credentials, intent=TokenIntents.INTENT_API
|
||||||
).first()
|
).first()
|
||||||
if key_token:
|
if key_token:
|
||||||
CTX_AUTH_VIA.set("api_token")
|
LOCAL.authentik[KEY_AUTH_VIA] = "api_token"
|
||||||
return key_token.user
|
return key_token.user
|
||||||
# then try to auth via JWT
|
# then try to auth via JWT
|
||||||
jwt_token = AccessToken.filter_not_expired(
|
jwt_token = RefreshToken.filter_not_expired(
|
||||||
token=auth_credentials, _scope__icontains=SCOPE_AUTHENTIK_API
|
refresh_token=auth_credentials, _scope__icontains=SCOPE_AUTHENTIK_API
|
||||||
).first()
|
).first()
|
||||||
if jwt_token:
|
if jwt_token:
|
||||||
# Double-check scopes, since they are saved in a single string
|
# Double-check scopes, since they are saved in a single string
|
||||||
# we want to check the parsed version too
|
# we want to check the parsed version too
|
||||||
if SCOPE_AUTHENTIK_API not in jwt_token.scope:
|
if SCOPE_AUTHENTIK_API not in jwt_token.scope:
|
||||||
raise AuthenticationFailed("Token invalid/expired")
|
raise AuthenticationFailed("Token invalid/expired")
|
||||||
CTX_AUTH_VIA.set("jwt")
|
LOCAL.authentik[KEY_AUTH_VIA] = "jwt"
|
||||||
return jwt_token.user
|
return jwt_token.user
|
||||||
# then try to auth via secret key (for embedded outpost/etc)
|
# then try to auth via secret key (for embedded outpost/etc)
|
||||||
user = token_secret_key(auth_credentials)
|
user = token_secret_key(auth_credentials)
|
||||||
if user:
|
if user:
|
||||||
CTX_AUTH_VIA.set("secret_key")
|
LOCAL.authentik[KEY_AUTH_VIA] = "secret_key"
|
||||||
return user
|
return user
|
||||||
raise AuthenticationFailed("Token invalid/expired")
|
raise AuthenticationFailed("Token invalid/expired")
|
||||||
|
|
||||||
|
@ -77,9 +67,9 @@ def auth_user_lookup(raw_header: bytes) -> Optional[User]:
|
||||||
def token_secret_key(value: str) -> Optional[User]:
|
def token_secret_key(value: str) -> Optional[User]:
|
||||||
"""Check if the token is the secret key
|
"""Check if the token is the secret key
|
||||||
and return the service account for the managed outpost"""
|
and return the service account for the managed outpost"""
|
||||||
from authentik.outposts.apps import MANAGED_OUTPOST
|
from authentik.outposts.managed import MANAGED_OUTPOST
|
||||||
|
|
||||||
if not compare_digest(value, settings.SECRET_KEY):
|
if value != settings.SECRET_KEY:
|
||||||
return None
|
return None
|
||||||
outposts = Outpost.objects.filter(managed=MANAGED_OUTPOST)
|
outposts = Outpost.objects.filter(managed=MANAGED_OUTPOST)
|
||||||
if not outposts:
|
if not outposts:
|
||||||
|
|
|
@ -1,16 +1,10 @@
|
||||||
"""API Authorization"""
|
"""API Authorization"""
|
||||||
from django.conf import settings
|
|
||||||
from django.db.models import Model
|
from django.db.models import Model
|
||||||
from django.db.models.query import QuerySet
|
from django.db.models.query import QuerySet
|
||||||
from django_filters.rest_framework import DjangoFilterBackend
|
|
||||||
from rest_framework.authentication import get_authorization_header
|
|
||||||
from rest_framework.filters import BaseFilterBackend
|
from rest_framework.filters import BaseFilterBackend
|
||||||
from rest_framework.permissions import BasePermission
|
from rest_framework.permissions import BasePermission
|
||||||
from rest_framework.request import Request
|
from rest_framework.request import Request
|
||||||
|
|
||||||
from authentik.api.authentication import validate_auth
|
|
||||||
from authentik.rbac.filters import ObjectFilter
|
|
||||||
|
|
||||||
|
|
||||||
class OwnerFilter(BaseFilterBackend):
|
class OwnerFilter(BaseFilterBackend):
|
||||||
"""Filter objects by their owner"""
|
"""Filter objects by their owner"""
|
||||||
|
@ -23,20 +17,6 @@ class OwnerFilter(BaseFilterBackend):
|
||||||
return queryset.filter(**{self.owner_key: request.user})
|
return queryset.filter(**{self.owner_key: request.user})
|
||||||
|
|
||||||
|
|
||||||
class SecretKeyFilter(DjangoFilterBackend):
|
|
||||||
"""Allow access to all objects when authenticated with secret key as token.
|
|
||||||
|
|
||||||
Replaces both DjangoFilterBackend and ObjectFilter"""
|
|
||||||
|
|
||||||
def filter_queryset(self, request: Request, queryset: QuerySet, view) -> QuerySet:
|
|
||||||
auth_header = get_authorization_header(request)
|
|
||||||
token = validate_auth(auth_header)
|
|
||||||
if token and token == settings.SECRET_KEY:
|
|
||||||
return queryset
|
|
||||||
queryset = ObjectFilter().filter_queryset(request, queryset, view)
|
|
||||||
return super().filter_queryset(request, queryset, view)
|
|
||||||
|
|
||||||
|
|
||||||
class OwnerPermissions(BasePermission):
|
class OwnerPermissions(BasePermission):
|
||||||
"""Authorize requests by an object's owner matching the requesting user"""
|
"""Authorize requests by an object's owner matching the requesting user"""
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ from structlog.stdlib import get_logger
|
||||||
LOGGER = get_logger()
|
LOGGER = get_logger()
|
||||||
|
|
||||||
|
|
||||||
def permission_required(obj_perm: Optional[str] = None, global_perms: Optional[list[str]] = None):
|
def permission_required(perm: Optional[str] = None, other_perms: Optional[list[str]] = None):
|
||||||
"""Check permissions for a single custom action"""
|
"""Check permissions for a single custom action"""
|
||||||
|
|
||||||
def wrapper_outter(func: Callable):
|
def wrapper_outter(func: Callable):
|
||||||
|
@ -18,17 +18,15 @@ def permission_required(obj_perm: Optional[str] = None, global_perms: Optional[l
|
||||||
|
|
||||||
@wraps(func)
|
@wraps(func)
|
||||||
def wrapper(self: ModelViewSet, request: Request, *args, **kwargs) -> Response:
|
def wrapper(self: ModelViewSet, request: Request, *args, **kwargs) -> Response:
|
||||||
if obj_perm:
|
if perm:
|
||||||
obj = self.get_object()
|
obj = self.get_object()
|
||||||
if not request.user.has_perm(obj_perm, obj):
|
if not request.user.has_perm(perm, obj):
|
||||||
LOGGER.debug(
|
LOGGER.debug("denying access for object", user=request.user, perm=perm, obj=obj)
|
||||||
"denying access for object", user=request.user, perm=obj_perm, obj=obj
|
|
||||||
)
|
|
||||||
return self.permission_denied(request)
|
return self.permission_denied(request)
|
||||||
if global_perms:
|
if other_perms:
|
||||||
for other_perm in global_perms:
|
for other_perm in other_perms:
|
||||||
if not request.user.has_perm(other_perm):
|
if not request.user.has_perm(other_perm):
|
||||||
LOGGER.debug("denying access for other", user=request.user, perm=other_perm)
|
LOGGER.debug("denying access for other", user=request.user, perm=perm)
|
||||||
return self.permission_denied(request)
|
return self.permission_denied(request)
|
||||||
return func(self, request, *args, **kwargs)
|
return func(self, request, *args, **kwargs)
|
||||||
|
|
||||||
|
|
|
@ -2,43 +2,6 @@
|
||||||
from rest_framework import pagination
|
from rest_framework import pagination
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
|
|
||||||
PAGINATION_COMPONENT_NAME = "Pagination"
|
|
||||||
PAGINATION_SCHEMA = {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"next": {
|
|
||||||
"type": "number",
|
|
||||||
},
|
|
||||||
"previous": {
|
|
||||||
"type": "number",
|
|
||||||
},
|
|
||||||
"count": {
|
|
||||||
"type": "number",
|
|
||||||
},
|
|
||||||
"current": {
|
|
||||||
"type": "number",
|
|
||||||
},
|
|
||||||
"total_pages": {
|
|
||||||
"type": "number",
|
|
||||||
},
|
|
||||||
"start_index": {
|
|
||||||
"type": "number",
|
|
||||||
},
|
|
||||||
"end_index": {
|
|
||||||
"type": "number",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"next",
|
|
||||||
"previous",
|
|
||||||
"count",
|
|
||||||
"current",
|
|
||||||
"total_pages",
|
|
||||||
"start_index",
|
|
||||||
"end_index",
|
|
||||||
],
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
class Pagination(pagination.PageNumberPagination):
|
class Pagination(pagination.PageNumberPagination):
|
||||||
"""Pagination which includes total pages and current page"""
|
"""Pagination which includes total pages and current page"""
|
||||||
|
@ -72,15 +35,42 @@ class Pagination(pagination.PageNumberPagination):
|
||||||
return {
|
return {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"pagination": {"$ref": f"#/components/schemas/{PAGINATION_COMPONENT_NAME}"},
|
"pagination": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"next": {
|
||||||
|
"type": "number",
|
||||||
|
},
|
||||||
|
"previous": {
|
||||||
|
"type": "number",
|
||||||
|
},
|
||||||
|
"count": {
|
||||||
|
"type": "number",
|
||||||
|
},
|
||||||
|
"current": {
|
||||||
|
"type": "number",
|
||||||
|
},
|
||||||
|
"total_pages": {
|
||||||
|
"type": "number",
|
||||||
|
},
|
||||||
|
"start_index": {
|
||||||
|
"type": "number",
|
||||||
|
},
|
||||||
|
"end_index": {
|
||||||
|
"type": "number",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"next",
|
||||||
|
"previous",
|
||||||
|
"count",
|
||||||
|
"current",
|
||||||
|
"total_pages",
|
||||||
|
"start_index",
|
||||||
|
"end_index",
|
||||||
|
],
|
||||||
|
},
|
||||||
"results": schema,
|
"results": schema,
|
||||||
},
|
},
|
||||||
"required": ["pagination", "results"],
|
"required": ["pagination", "results"],
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
class SmallerPagination(Pagination):
|
|
||||||
"""Smaller pagination for objects which might require a lot of queries
|
|
||||||
to retrieve all data for."""
|
|
||||||
|
|
||||||
max_page_size = 10
|
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
"""Error Response schema, from https://github.com/axnsan12/drf-yasg/issues/224"""
|
"""Error Response schema, from https://github.com/axnsan12/drf-yasg/issues/224"""
|
||||||
from django.utils.translation import gettext_lazy as _
|
from django.utils.translation import gettext_lazy as _
|
||||||
from drf_spectacular.generators import SchemaGenerator
|
|
||||||
from drf_spectacular.plumbing import (
|
from drf_spectacular.plumbing import (
|
||||||
ResolvedComponent,
|
ResolvedComponent,
|
||||||
build_array_type,
|
build_array_type,
|
||||||
|
@ -9,9 +8,6 @@ from drf_spectacular.plumbing import (
|
||||||
)
|
)
|
||||||
from drf_spectacular.settings import spectacular_settings
|
from drf_spectacular.settings import spectacular_settings
|
||||||
from drf_spectacular.types import OpenApiTypes
|
from drf_spectacular.types import OpenApiTypes
|
||||||
from rest_framework.settings import api_settings
|
|
||||||
|
|
||||||
from authentik.api.pagination import PAGINATION_COMPONENT_NAME, PAGINATION_SCHEMA
|
|
||||||
|
|
||||||
|
|
||||||
def build_standard_type(obj, **kwargs):
|
def build_standard_type(obj, **kwargs):
|
||||||
|
@ -32,7 +28,7 @@ GENERIC_ERROR = build_object_type(
|
||||||
VALIDATION_ERROR = build_object_type(
|
VALIDATION_ERROR = build_object_type(
|
||||||
description=_("Validation Error"),
|
description=_("Validation Error"),
|
||||||
properties={
|
properties={
|
||||||
api_settings.NON_FIELD_ERRORS_KEY: build_array_type(build_standard_type(OpenApiTypes.STR)),
|
"non_field_errors": build_array_type(build_standard_type(OpenApiTypes.STR)),
|
||||||
"code": build_standard_type(OpenApiTypes.STR),
|
"code": build_standard_type(OpenApiTypes.STR),
|
||||||
},
|
},
|
||||||
required=[],
|
required=[],
|
||||||
|
@ -40,19 +36,7 @@ VALIDATION_ERROR = build_object_type(
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def create_component(generator: SchemaGenerator, name, schema, type_=ResolvedComponent.SCHEMA):
|
def postprocess_schema_responses(result, generator, **kwargs): # noqa: W0613
|
||||||
"""Register a component and return a reference to it."""
|
|
||||||
component = ResolvedComponent(
|
|
||||||
name=name,
|
|
||||||
type=type_,
|
|
||||||
schema=schema,
|
|
||||||
object=name,
|
|
||||||
)
|
|
||||||
generator.registry.register_on_missing(component)
|
|
||||||
return component
|
|
||||||
|
|
||||||
|
|
||||||
def postprocess_schema_responses(result, generator: SchemaGenerator, **kwargs): # noqa: W0613
|
|
||||||
"""Workaround to set a default response for endpoints.
|
"""Workaround to set a default response for endpoints.
|
||||||
Workaround suggested at
|
Workaround suggested at
|
||||||
<https://github.com/tfranzel/drf-spectacular/issues/119#issuecomment-656970357>
|
<https://github.com/tfranzel/drf-spectacular/issues/119#issuecomment-656970357>
|
||||||
|
@ -60,35 +44,24 @@ def postprocess_schema_responses(result, generator: SchemaGenerator, **kwargs):
|
||||||
<https://github.com/tfranzel/drf-spectacular/issues/101>.
|
<https://github.com/tfranzel/drf-spectacular/issues/101>.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
create_component(generator, PAGINATION_COMPONENT_NAME, PAGINATION_SCHEMA)
|
def create_component(name, schema, type_=ResolvedComponent.SCHEMA):
|
||||||
|
"""Register a component and return a reference to it."""
|
||||||
|
component = ResolvedComponent(
|
||||||
|
name=name,
|
||||||
|
type=type_,
|
||||||
|
schema=schema,
|
||||||
|
object=name,
|
||||||
|
)
|
||||||
|
generator.registry.register_on_missing(component)
|
||||||
|
return component
|
||||||
|
|
||||||
generic_error = create_component(generator, "GenericError", GENERIC_ERROR)
|
generic_error = create_component("GenericError", GENERIC_ERROR)
|
||||||
validation_error = create_component(generator, "ValidationError", VALIDATION_ERROR)
|
validation_error = create_component("ValidationError", VALIDATION_ERROR)
|
||||||
|
|
||||||
for path in result["paths"].values():
|
for path in result["paths"].values():
|
||||||
for method in path.values():
|
for method in path.values():
|
||||||
method["responses"].setdefault(
|
method["responses"].setdefault("400", validation_error.ref)
|
||||||
"400",
|
method["responses"].setdefault("403", generic_error.ref)
|
||||||
{
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": validation_error.ref,
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"description": "",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
method["responses"].setdefault(
|
|
||||||
"403",
|
|
||||||
{
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": generic_error.ref,
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"description": "",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
result["components"] = generator.registry.build(spectacular_settings.APPEND_COMPONENTS)
|
result["components"] = generator.registry.build(spectacular_settings.APPEND_COMPONENTS)
|
||||||
|
|
||||||
|
|
|
@ -7,11 +7,82 @@ API Browser - {{ tenant.branding_title }}
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
|
||||||
{% block head %}
|
{% block head %}
|
||||||
<script src="{% static 'dist/standalone/api-browser/index.js' %}?version={{ version }}" type="module"></script>
|
<script type="module" src="{% static 'dist/rapidoc-min.js' %}"></script>
|
||||||
<meta name="theme-color" content="#151515" media="(prefers-color-scheme: light)">
|
<script>
|
||||||
<meta name="theme-color" content="#151515" media="(prefers-color-scheme: dark)">
|
function getCookie(name) {
|
||||||
|
let cookieValue = "";
|
||||||
|
if (document.cookie && document.cookie !== "") {
|
||||||
|
const cookies = document.cookie.split(";");
|
||||||
|
for (let i = 0; i < cookies.length; i++) {
|
||||||
|
const cookie = cookies[i].trim();
|
||||||
|
// Does this cookie string begin with the name we want?
|
||||||
|
if (cookie.substring(0, name.length + 1) === name + "=") {
|
||||||
|
cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return cookieValue;
|
||||||
|
}
|
||||||
|
window.addEventListener('DOMContentLoaded', (event) => {
|
||||||
|
const rapidocEl = document.querySelector('rapi-doc');
|
||||||
|
rapidocEl.addEventListener('before-try', (e) => {
|
||||||
|
e.detail.request.headers.append('X-authentik-CSRF', getCookie("authentik_csrf"));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
<style>
|
||||||
|
img.logo {
|
||||||
|
width: 100%;
|
||||||
|
padding: 1rem 0.5rem 1.5rem 0.5rem;
|
||||||
|
min-height: 48px;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
|
||||||
{% block body %}
|
{% block body %}
|
||||||
<ak-api-browser schemaPath="{{ path }}"></ak-api-browser>
|
<rapi-doc
|
||||||
|
spec-url="{{ path }}"
|
||||||
|
heading-text=""
|
||||||
|
theme="light"
|
||||||
|
render-style="read"
|
||||||
|
default-schema-tab="schema"
|
||||||
|
primary-color="#fd4b2d"
|
||||||
|
nav-bg-color="#212427"
|
||||||
|
bg-color="#000000"
|
||||||
|
text-color="#000000"
|
||||||
|
nav-text-color="#ffffff"
|
||||||
|
nav-hover-bg-color="#3c3f42"
|
||||||
|
nav-accent-color="#4f5255"
|
||||||
|
nav-hover-text-color="#ffffff"
|
||||||
|
use-path-in-nav-bar="true"
|
||||||
|
nav-item-spacing="relaxed"
|
||||||
|
allow-server-selection="false"
|
||||||
|
show-header="false"
|
||||||
|
allow-spec-url-load="false"
|
||||||
|
allow-spec-file-load="false">
|
||||||
|
<div slot="nav-logo">
|
||||||
|
<img class="logo" src="{% static 'dist/assets/icons/icon_left_brand.png' %}" />
|
||||||
|
</div>
|
||||||
|
</rapi-doc>
|
||||||
|
<script>
|
||||||
|
const rapidoc = document.querySelector("rapi-doc");
|
||||||
|
const matcher = window.matchMedia("(prefers-color-scheme: light)");
|
||||||
|
const changer = (ev) => {
|
||||||
|
const style = getComputedStyle(document.documentElement);
|
||||||
|
let bg, text = "";
|
||||||
|
if (matcher.matches) {
|
||||||
|
bg = style.getPropertyValue('--pf-global--BackgroundColor--light-300');
|
||||||
|
text = style.getPropertyValue('--pf-global--Color--300');
|
||||||
|
} else {
|
||||||
|
bg = style.getPropertyValue('--ak-dark-background');
|
||||||
|
text = style.getPropertyValue('--ak-dark-foreground');
|
||||||
|
}
|
||||||
|
rapidoc.attributes.getNamedItem("bg-color").value = bg.trim();
|
||||||
|
rapidoc.attributes.getNamedItem("text-color").value = text.trim();
|
||||||
|
rapidoc.requestUpdate();
|
||||||
|
};
|
||||||
|
matcher.addEventListener("change", changer);
|
||||||
|
window.addEventListener("load", changer);
|
||||||
|
</script>
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
|
|
@ -1,19 +1,18 @@
|
||||||
"""Test API Authentication"""
|
"""Test API Authentication"""
|
||||||
import json
|
|
||||||
from base64 import b64encode
|
from base64 import b64encode
|
||||||
|
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from django.test import TestCase
|
from django.test import TestCase
|
||||||
from django.utils import timezone
|
from guardian.shortcuts import get_anonymous_user
|
||||||
from rest_framework.exceptions import AuthenticationFailed
|
from rest_framework.exceptions import AuthenticationFailed
|
||||||
|
|
||||||
from authentik.api.authentication import bearer_auth
|
from authentik.api.authentication import bearer_auth
|
||||||
from authentik.blueprints.tests import reconcile_app
|
from authentik.core.models import USER_ATTRIBUTE_SA, Token, TokenIntents
|
||||||
from authentik.core.models import Token, TokenIntents, User, UserTypes
|
from authentik.core.tests.utils import 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.lib.generators import generate_id
|
||||||
|
from authentik.outposts.managed import OutpostManager
|
||||||
from authentik.providers.oauth2.constants import SCOPE_AUTHENTIK_API
|
from authentik.providers.oauth2.constants import SCOPE_AUTHENTIK_API
|
||||||
from authentik.providers.oauth2.models import AccessToken, OAuth2Provider
|
from authentik.providers.oauth2.models import OAuth2Provider, RefreshToken
|
||||||
|
|
||||||
|
|
||||||
class TestAPIAuth(TestCase):
|
class TestAPIAuth(TestCase):
|
||||||
|
@ -37,56 +36,41 @@ class TestAPIAuth(TestCase):
|
||||||
|
|
||||||
def test_bearer_valid(self):
|
def test_bearer_valid(self):
|
||||||
"""Test valid token"""
|
"""Test valid token"""
|
||||||
token = Token.objects.create(intent=TokenIntents.INTENT_API, user=create_test_admin_user())
|
token = Token.objects.create(intent=TokenIntents.INTENT_API, user=get_anonymous_user())
|
||||||
self.assertEqual(bearer_auth(f"Bearer {token.key}".encode()), token.user)
|
self.assertEqual(bearer_auth(f"Bearer {token.key}".encode()), token.user)
|
||||||
|
|
||||||
def test_bearer_valid_deactivated(self):
|
|
||||||
"""Test valid token"""
|
|
||||||
user = create_test_admin_user()
|
|
||||||
user.is_active = False
|
|
||||||
user.save()
|
|
||||||
token = Token.objects.create(intent=TokenIntents.INTENT_API, user=user)
|
|
||||||
with self.assertRaises(AuthenticationFailed):
|
|
||||||
bearer_auth(f"Bearer {token.key}".encode())
|
|
||||||
|
|
||||||
def test_managed_outpost(self):
|
def test_managed_outpost(self):
|
||||||
"""Test managed outpost"""
|
"""Test managed outpost"""
|
||||||
with self.assertRaises(AuthenticationFailed):
|
with self.assertRaises(AuthenticationFailed):
|
||||||
bearer_auth(f"Bearer {settings.SECRET_KEY}".encode())
|
user = bearer_auth(f"Bearer {settings.SECRET_KEY}".encode())
|
||||||
|
|
||||||
@reconcile_app("authentik_outposts")
|
OutpostManager().run()
|
||||||
def test_managed_outpost_success(self):
|
user = bearer_auth(f"Bearer {settings.SECRET_KEY}".encode())
|
||||||
"""Test managed outpost"""
|
self.assertEqual(user.attributes[USER_ATTRIBUTE_SA], True)
|
||||||
user: User = bearer_auth(f"Bearer {settings.SECRET_KEY}".encode())
|
|
||||||
self.assertEqual(user.type, UserTypes.INTERNAL_SERVICE_ACCOUNT)
|
|
||||||
|
|
||||||
def test_jwt_valid(self):
|
def test_jwt_valid(self):
|
||||||
"""Test valid JWT"""
|
"""Test valid JWT"""
|
||||||
provider = OAuth2Provider.objects.create(
|
provider = OAuth2Provider.objects.create(
|
||||||
name=generate_id(), client_id=generate_id(), authorization_flow=create_test_flow()
|
name=generate_id(), client_id=generate_id(), authorization_flow=create_test_flow()
|
||||||
)
|
)
|
||||||
refresh = AccessToken.objects.create(
|
refresh = RefreshToken.objects.create(
|
||||||
user=create_test_admin_user(),
|
user=get_anonymous_user(),
|
||||||
provider=provider,
|
provider=provider,
|
||||||
token=generate_id(),
|
refresh_token=generate_id(),
|
||||||
auth_time=timezone.now(),
|
|
||||||
_scope=SCOPE_AUTHENTIK_API,
|
_scope=SCOPE_AUTHENTIK_API,
|
||||||
_id_token=json.dumps({}),
|
|
||||||
)
|
)
|
||||||
self.assertEqual(bearer_auth(f"Bearer {refresh.token}".encode()), refresh.user)
|
self.assertEqual(bearer_auth(f"Bearer {refresh.refresh_token}".encode()), refresh.user)
|
||||||
|
|
||||||
def test_jwt_missing_scope(self):
|
def test_jwt_missing_scope(self):
|
||||||
"""Test valid JWT"""
|
"""Test valid JWT"""
|
||||||
provider = OAuth2Provider.objects.create(
|
provider = OAuth2Provider.objects.create(
|
||||||
name=generate_id(), client_id=generate_id(), authorization_flow=create_test_flow()
|
name=generate_id(), client_id=generate_id(), authorization_flow=create_test_flow()
|
||||||
)
|
)
|
||||||
refresh = AccessToken.objects.create(
|
refresh = RefreshToken.objects.create(
|
||||||
user=create_test_admin_user(),
|
user=get_anonymous_user(),
|
||||||
provider=provider,
|
provider=provider,
|
||||||
token=generate_id(),
|
refresh_token=generate_id(),
|
||||||
auth_time=timezone.now(),
|
|
||||||
_scope="",
|
_scope="",
|
||||||
_id_token=json.dumps({}),
|
|
||||||
)
|
)
|
||||||
with self.assertRaises(AuthenticationFailed):
|
with self.assertRaises(AuthenticationFailed):
|
||||||
self.assertEqual(bearer_auth(f"Bearer {refresh.token}".encode()), refresh.user)
|
self.assertEqual(bearer_auth(f"Bearer {refresh.refresh_token}".encode()), refresh.user)
|
||||||
|
|
|
@ -4,7 +4,6 @@ from guardian.shortcuts import assign_perm
|
||||||
from rest_framework.test import APITestCase
|
from rest_framework.test import APITestCase
|
||||||
|
|
||||||
from authentik.core.models import Application, User
|
from authentik.core.models import Application, User
|
||||||
from authentik.lib.generators import generate_id
|
|
||||||
|
|
||||||
|
|
||||||
class TestAPIDecorators(APITestCase):
|
class TestAPIDecorators(APITestCase):
|
||||||
|
@ -17,7 +16,7 @@ class TestAPIDecorators(APITestCase):
|
||||||
def test_obj_perm_denied(self):
|
def test_obj_perm_denied(self):
|
||||||
"""Test object perm denied"""
|
"""Test object perm denied"""
|
||||||
self.client.force_login(self.user)
|
self.client.force_login(self.user)
|
||||||
app = Application.objects.create(name=generate_id(), slug=generate_id())
|
app = Application.objects.create(name="denied", slug="denied")
|
||||||
response = self.client.get(
|
response = self.client.get(
|
||||||
reverse("authentik_api:application-metrics", kwargs={"slug": app.slug})
|
reverse("authentik_api:application-metrics", kwargs={"slug": app.slug})
|
||||||
)
|
)
|
||||||
|
@ -26,7 +25,7 @@ class TestAPIDecorators(APITestCase):
|
||||||
def test_other_perm_denied(self):
|
def test_other_perm_denied(self):
|
||||||
"""Test other perm denied"""
|
"""Test other perm denied"""
|
||||||
self.client.force_login(self.user)
|
self.client.force_login(self.user)
|
||||||
app = Application.objects.create(name=generate_id(), slug=generate_id())
|
app = Application.objects.create(name="denied", slug="denied")
|
||||||
assign_perm("authentik_core.view_application", self.user, app)
|
assign_perm("authentik_core.view_application", self.user, app)
|
||||||
response = self.client.get(
|
response = self.client.get(
|
||||||
reverse("authentik_api:application-metrics", kwargs={"slug": app.slug})
|
reverse("authentik_api:application-metrics", kwargs={"slug": app.slug})
|
||||||
|
|
|
@ -16,7 +16,6 @@ def viewset_tester_factory(test_viewset: type[ModelViewSet]) -> Callable:
|
||||||
|
|
||||||
def tester(self: TestModelViewSets):
|
def tester(self: TestModelViewSets):
|
||||||
self.assertIsNotNone(getattr(test_viewset, "search_fields", None))
|
self.assertIsNotNone(getattr(test_viewset, "search_fields", None))
|
||||||
self.assertIsNotNone(getattr(test_viewset, "ordering", None))
|
|
||||||
filterset_class = getattr(test_viewset, "filterset_class", None)
|
filterset_class = getattr(test_viewset, "filterset_class", None)
|
||||||
if not filterset_class:
|
if not filterset_class:
|
||||||
self.assertIsNotNone(getattr(test_viewset, "filterset_fields", None))
|
self.assertIsNotNone(getattr(test_viewset, "filterset_fields", None))
|
||||||
|
|
|
@ -1,9 +1,8 @@
|
||||||
"""core Configs API"""
|
"""core Configs API"""
|
||||||
from pathlib import Path
|
from os import path
|
||||||
|
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from django.db import models
|
from django.db import models
|
||||||
from django.dispatch import Signal
|
|
||||||
from drf_spectacular.utils import extend_schema
|
from drf_spectacular.utils import extend_schema
|
||||||
from rest_framework.fields import (
|
from rest_framework.fields import (
|
||||||
BooleanField,
|
BooleanField,
|
||||||
|
@ -22,8 +21,6 @@ from authentik.core.api.utils import PassiveSerializer
|
||||||
from authentik.events.geo import GEOIP_READER
|
from authentik.events.geo import GEOIP_READER
|
||||||
from authentik.lib.config import CONFIG
|
from authentik.lib.config import CONFIG
|
||||||
|
|
||||||
capabilities = Signal()
|
|
||||||
|
|
||||||
|
|
||||||
class Capabilities(models.TextChoices):
|
class Capabilities(models.TextChoices):
|
||||||
"""Define capabilities which influence which APIs can/should be used"""
|
"""Define capabilities which influence which APIs can/should be used"""
|
||||||
|
@ -31,15 +28,12 @@ class Capabilities(models.TextChoices):
|
||||||
CAN_SAVE_MEDIA = "can_save_media"
|
CAN_SAVE_MEDIA = "can_save_media"
|
||||||
CAN_GEO_IP = "can_geo_ip"
|
CAN_GEO_IP = "can_geo_ip"
|
||||||
CAN_IMPERSONATE = "can_impersonate"
|
CAN_IMPERSONATE = "can_impersonate"
|
||||||
CAN_DEBUG = "can_debug"
|
|
||||||
IS_ENTERPRISE = "is_enterprise"
|
|
||||||
|
|
||||||
|
|
||||||
class ErrorReportingConfigSerializer(PassiveSerializer):
|
class ErrorReportingConfigSerializer(PassiveSerializer):
|
||||||
"""Config for error reporting"""
|
"""Config for error reporting"""
|
||||||
|
|
||||||
enabled = BooleanField(read_only=True)
|
enabled = BooleanField(read_only=True)
|
||||||
sentry_dsn = CharField(read_only=True)
|
|
||||||
environment = CharField(read_only=True)
|
environment = CharField(read_only=True)
|
||||||
send_pii = BooleanField(read_only=True)
|
send_pii = BooleanField(read_only=True)
|
||||||
traces_sample_rate = FloatField(read_only=True)
|
traces_sample_rate = FloatField(read_only=True)
|
||||||
|
@ -66,41 +60,30 @@ class ConfigView(APIView):
|
||||||
"""Get all capabilities this server instance supports"""
|
"""Get all capabilities this server instance supports"""
|
||||||
caps = []
|
caps = []
|
||||||
deb_test = settings.DEBUG or settings.TEST
|
deb_test = settings.DEBUG or settings.TEST
|
||||||
if Path(settings.MEDIA_ROOT).is_mount() or deb_test:
|
if path.ismount(settings.MEDIA_ROOT) or deb_test:
|
||||||
caps.append(Capabilities.CAN_SAVE_MEDIA)
|
caps.append(Capabilities.CAN_SAVE_MEDIA)
|
||||||
if GEOIP_READER.enabled:
|
if GEOIP_READER.enabled:
|
||||||
caps.append(Capabilities.CAN_GEO_IP)
|
caps.append(Capabilities.CAN_GEO_IP)
|
||||||
if CONFIG.get_bool("impersonation"):
|
if CONFIG.y_bool("impersonation"):
|
||||||
caps.append(Capabilities.CAN_IMPERSONATE)
|
caps.append(Capabilities.CAN_IMPERSONATE)
|
||||||
if settings.DEBUG: # pragma: no cover
|
|
||||||
caps.append(Capabilities.CAN_DEBUG)
|
|
||||||
if "authentik.enterprise" in settings.INSTALLED_APPS:
|
|
||||||
caps.append(Capabilities.IS_ENTERPRISE)
|
|
||||||
for _, result in capabilities.send(sender=self):
|
|
||||||
if result:
|
|
||||||
caps.append(result)
|
|
||||||
return caps
|
return caps
|
||||||
|
|
||||||
def get_config(self) -> ConfigSerializer:
|
|
||||||
"""Get Config"""
|
|
||||||
return ConfigSerializer(
|
|
||||||
{
|
|
||||||
"error_reporting": {
|
|
||||||
"enabled": CONFIG.get("error_reporting.enabled"),
|
|
||||||
"sentry_dsn": CONFIG.get("error_reporting.sentry_dsn"),
|
|
||||||
"environment": CONFIG.get("error_reporting.environment"),
|
|
||||||
"send_pii": CONFIG.get("error_reporting.send_pii"),
|
|
||||||
"traces_sample_rate": float(CONFIG.get("error_reporting.sample_rate", 0.4)),
|
|
||||||
},
|
|
||||||
"capabilities": self.get_capabilities(),
|
|
||||||
"cache_timeout": CONFIG.get_int("redis.cache_timeout"),
|
|
||||||
"cache_timeout_flows": CONFIG.get_int("redis.cache_timeout_flows"),
|
|
||||||
"cache_timeout_policies": CONFIG.get_int("redis.cache_timeout_policies"),
|
|
||||||
"cache_timeout_reputation": CONFIG.get_int("redis.cache_timeout_reputation"),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
@extend_schema(responses={200: ConfigSerializer(many=False)})
|
@extend_schema(responses={200: ConfigSerializer(many=False)})
|
||||||
def get(self, request: Request) -> Response:
|
def get(self, request: Request) -> Response:
|
||||||
"""Retrieve public configuration options"""
|
"""Retrieve public configuration options"""
|
||||||
return Response(self.get_config().data)
|
config = ConfigSerializer(
|
||||||
|
{
|
||||||
|
"error_reporting": {
|
||||||
|
"enabled": CONFIG.y("error_reporting.enabled"),
|
||||||
|
"environment": CONFIG.y("error_reporting.environment"),
|
||||||
|
"send_pii": CONFIG.y("error_reporting.send_pii"),
|
||||||
|
"traces_sample_rate": float(CONFIG.y("error_reporting.sample_rate", 0.4)),
|
||||||
|
},
|
||||||
|
"capabilities": self.get_capabilities(),
|
||||||
|
"cache_timeout": int(CONFIG.y("redis.cache_timeout")),
|
||||||
|
"cache_timeout_flows": int(CONFIG.y("redis.cache_timeout_flows")),
|
||||||
|
"cache_timeout_policies": int(CONFIG.y("redis.cache_timeout_policies")),
|
||||||
|
"cache_timeout_reputation": int(CONFIG.y("redis.cache_timeout_reputation")),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return Response(config.data)
|
||||||
|
|
|
@ -1,57 +1,248 @@
|
||||||
"""api v3 urls"""
|
"""api v3 urls"""
|
||||||
from importlib import import_module
|
|
||||||
|
|
||||||
from django.urls import path
|
from django.urls import path
|
||||||
from django.urls.resolvers import URLPattern
|
|
||||||
from django.views.decorators.cache import cache_page
|
from django.views.decorators.cache import cache_page
|
||||||
from drf_spectacular.views import SpectacularAPIView
|
from drf_spectacular.views import SpectacularAPIView
|
||||||
from rest_framework import routers
|
from rest_framework import routers
|
||||||
from structlog.stdlib import get_logger
|
|
||||||
|
|
||||||
|
from authentik.admin.api.meta import AppsViewSet
|
||||||
|
from authentik.admin.api.metrics import AdministrationMetricsViewSet
|
||||||
|
from authentik.admin.api.system import SystemView
|
||||||
|
from authentik.admin.api.tasks import TaskViewSet
|
||||||
|
from authentik.admin.api.version import VersionView
|
||||||
|
from authentik.admin.api.workers import WorkerView
|
||||||
from authentik.api.v3.config import ConfigView
|
from authentik.api.v3.config import ConfigView
|
||||||
from authentik.api.views import APIBrowserView
|
from authentik.api.views import APIBrowserView
|
||||||
from authentik.lib.utils.reflection import get_apps
|
from authentik.core.api.applications import ApplicationViewSet
|
||||||
|
from authentik.core.api.authenticated_sessions import AuthenticatedSessionViewSet
|
||||||
LOGGER = get_logger()
|
from authentik.core.api.devices import DeviceViewSet
|
||||||
|
from authentik.core.api.groups import GroupViewSet
|
||||||
|
from authentik.core.api.propertymappings import PropertyMappingViewSet
|
||||||
|
from authentik.core.api.providers import ProviderViewSet
|
||||||
|
from authentik.core.api.sources import SourceViewSet, UserSourceConnectionViewSet
|
||||||
|
from authentik.core.api.tokens import TokenViewSet
|
||||||
|
from authentik.core.api.users import UserViewSet
|
||||||
|
from authentik.crypto.api import CertificateKeyPairViewSet
|
||||||
|
from authentik.events.api.events import EventViewSet
|
||||||
|
from authentik.events.api.notification_mappings import NotificationWebhookMappingViewSet
|
||||||
|
from authentik.events.api.notification_rules import NotificationRuleViewSet
|
||||||
|
from authentik.events.api.notification_transports import NotificationTransportViewSet
|
||||||
|
from authentik.events.api.notifications import NotificationViewSet
|
||||||
|
from authentik.flows.api.bindings import FlowStageBindingViewSet
|
||||||
|
from authentik.flows.api.flows import FlowViewSet
|
||||||
|
from authentik.flows.api.stages import StageViewSet
|
||||||
|
from authentik.flows.views.executor import FlowExecutorView
|
||||||
|
from authentik.flows.views.inspector import FlowInspectorView
|
||||||
|
from authentik.outposts.api.outposts import OutpostViewSet
|
||||||
|
from authentik.outposts.api.service_connections import (
|
||||||
|
DockerServiceConnectionViewSet,
|
||||||
|
KubernetesServiceConnectionViewSet,
|
||||||
|
ServiceConnectionViewSet,
|
||||||
|
)
|
||||||
|
from authentik.policies.api.bindings import PolicyBindingViewSet
|
||||||
|
from authentik.policies.api.policies import PolicyViewSet
|
||||||
|
from authentik.policies.dummy.api import DummyPolicyViewSet
|
||||||
|
from authentik.policies.event_matcher.api import EventMatcherPolicyViewSet
|
||||||
|
from authentik.policies.expiry.api import PasswordExpiryPolicyViewSet
|
||||||
|
from authentik.policies.expression.api import ExpressionPolicyViewSet
|
||||||
|
from authentik.policies.hibp.api import HaveIBeenPwendPolicyViewSet
|
||||||
|
from authentik.policies.password.api import PasswordPolicyViewSet
|
||||||
|
from authentik.policies.reputation.api import ReputationPolicyViewSet, ReputationViewSet
|
||||||
|
from authentik.providers.ldap.api import LDAPOutpostConfigViewSet, LDAPProviderViewSet
|
||||||
|
from authentik.providers.oauth2.api.provider import OAuth2ProviderViewSet
|
||||||
|
from authentik.providers.oauth2.api.scope import ScopeMappingViewSet
|
||||||
|
from authentik.providers.oauth2.api.tokens import AuthorizationCodeViewSet, RefreshTokenViewSet
|
||||||
|
from authentik.providers.proxy.api import ProxyOutpostConfigViewSet, ProxyProviderViewSet
|
||||||
|
from authentik.providers.saml.api import SAMLPropertyMappingViewSet, SAMLProviderViewSet
|
||||||
|
from authentik.sources.ldap.api import LDAPPropertyMappingViewSet, LDAPSourceViewSet
|
||||||
|
from authentik.sources.oauth.api.source import OAuthSourceViewSet
|
||||||
|
from authentik.sources.oauth.api.source_connection import UserOAuthSourceConnectionViewSet
|
||||||
|
from authentik.sources.plex.api.source import PlexSourceViewSet
|
||||||
|
from authentik.sources.plex.api.source_connection import PlexSourceConnectionViewSet
|
||||||
|
from authentik.sources.saml.api import SAMLSourceViewSet
|
||||||
|
from authentik.stages.authenticator_duo.api import (
|
||||||
|
AuthenticatorDuoStageViewSet,
|
||||||
|
DuoAdminDeviceViewSet,
|
||||||
|
DuoDeviceViewSet,
|
||||||
|
)
|
||||||
|
from authentik.stages.authenticator_sms.api import (
|
||||||
|
AuthenticatorSMSStageViewSet,
|
||||||
|
SMSAdminDeviceViewSet,
|
||||||
|
SMSDeviceViewSet,
|
||||||
|
)
|
||||||
|
from authentik.stages.authenticator_static.api import (
|
||||||
|
AuthenticatorStaticStageViewSet,
|
||||||
|
StaticAdminDeviceViewSet,
|
||||||
|
StaticDeviceViewSet,
|
||||||
|
)
|
||||||
|
from authentik.stages.authenticator_totp.api import (
|
||||||
|
AuthenticatorTOTPStageViewSet,
|
||||||
|
TOTPAdminDeviceViewSet,
|
||||||
|
TOTPDeviceViewSet,
|
||||||
|
)
|
||||||
|
from authentik.stages.authenticator_validate.api import AuthenticatorValidateStageViewSet
|
||||||
|
from authentik.stages.authenticator_webauthn.api import (
|
||||||
|
AuthenticateWebAuthnStageViewSet,
|
||||||
|
WebAuthnAdminDeviceViewSet,
|
||||||
|
WebAuthnDeviceViewSet,
|
||||||
|
)
|
||||||
|
from authentik.stages.captcha.api import CaptchaStageViewSet
|
||||||
|
from authentik.stages.consent.api import ConsentStageViewSet, UserConsentViewSet
|
||||||
|
from authentik.stages.deny.api import DenyStageViewSet
|
||||||
|
from authentik.stages.dummy.api import DummyStageViewSet
|
||||||
|
from authentik.stages.email.api import EmailStageViewSet
|
||||||
|
from authentik.stages.identification.api import IdentificationStageViewSet
|
||||||
|
from authentik.stages.invitation.api import InvitationStageViewSet, InvitationViewSet
|
||||||
|
from authentik.stages.password.api import PasswordStageViewSet
|
||||||
|
from authentik.stages.prompt.api import PromptStageViewSet, PromptViewSet
|
||||||
|
from authentik.stages.user_delete.api import UserDeleteStageViewSet
|
||||||
|
from authentik.stages.user_login.api import UserLoginStageViewSet
|
||||||
|
from authentik.stages.user_logout.api import UserLogoutStageViewSet
|
||||||
|
from authentik.stages.user_write.api import UserWriteStageViewSet
|
||||||
|
from authentik.tenants.api import TenantViewSet
|
||||||
|
|
||||||
router = routers.DefaultRouter()
|
router = routers.DefaultRouter()
|
||||||
router.include_format_suffixes = False
|
router.include_format_suffixes = False
|
||||||
|
|
||||||
_other_urls = []
|
router.register("admin/system_tasks", TaskViewSet, basename="admin_system_tasks")
|
||||||
for _authentik_app in get_apps():
|
router.register("admin/apps", AppsViewSet, basename="apps")
|
||||||
try:
|
|
||||||
api_urls = import_module(f"{_authentik_app.name}.urls")
|
|
||||||
except ModuleNotFoundError:
|
|
||||||
continue
|
|
||||||
except ImportError as exc:
|
|
||||||
LOGGER.warning("Could not import app's URLs", app_name=_authentik_app.name, exc=exc)
|
|
||||||
continue
|
|
||||||
if not hasattr(api_urls, "api_urlpatterns"):
|
|
||||||
LOGGER.debug(
|
|
||||||
"App does not define API URLs",
|
|
||||||
app_name=_authentik_app.name,
|
|
||||||
)
|
|
||||||
continue
|
|
||||||
urls: list = getattr(api_urls, "api_urlpatterns")
|
|
||||||
for url in urls:
|
|
||||||
if isinstance(url, URLPattern):
|
|
||||||
_other_urls.append(url)
|
|
||||||
else:
|
|
||||||
router.register(*url)
|
|
||||||
LOGGER.debug(
|
|
||||||
"Mounted API URLs",
|
|
||||||
app_name=_authentik_app.name,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
router.register("core/authenticated_sessions", AuthenticatedSessionViewSet)
|
||||||
|
router.register("core/applications", ApplicationViewSet)
|
||||||
|
router.register("core/groups", GroupViewSet)
|
||||||
|
router.register("core/users", UserViewSet)
|
||||||
|
router.register("core/user_consent", UserConsentViewSet)
|
||||||
|
router.register("core/tokens", TokenViewSet)
|
||||||
|
router.register("core/tenants", TenantViewSet)
|
||||||
|
|
||||||
|
router.register("outposts/instances", OutpostViewSet)
|
||||||
|
router.register("outposts/service_connections/all", ServiceConnectionViewSet)
|
||||||
|
router.register("outposts/service_connections/docker", DockerServiceConnectionViewSet)
|
||||||
|
router.register("outposts/service_connections/kubernetes", KubernetesServiceConnectionViewSet)
|
||||||
|
router.register("outposts/proxy", ProxyOutpostConfigViewSet)
|
||||||
|
router.register("outposts/ldap", LDAPOutpostConfigViewSet)
|
||||||
|
|
||||||
|
router.register("flows/instances", FlowViewSet)
|
||||||
|
router.register("flows/bindings", FlowStageBindingViewSet)
|
||||||
|
|
||||||
|
router.register("crypto/certificatekeypairs", CertificateKeyPairViewSet)
|
||||||
|
|
||||||
|
router.register("events/events", EventViewSet)
|
||||||
|
router.register("events/notifications", NotificationViewSet)
|
||||||
|
router.register("events/transports", NotificationTransportViewSet)
|
||||||
|
router.register("events/rules", NotificationRuleViewSet)
|
||||||
|
|
||||||
|
router.register("sources/all", SourceViewSet)
|
||||||
|
router.register("sources/user_connections/all", UserSourceConnectionViewSet)
|
||||||
|
router.register("sources/user_connections/oauth", UserOAuthSourceConnectionViewSet)
|
||||||
|
router.register("sources/user_connections/plex", PlexSourceConnectionViewSet)
|
||||||
|
router.register("sources/ldap", LDAPSourceViewSet)
|
||||||
|
router.register("sources/saml", SAMLSourceViewSet)
|
||||||
|
router.register("sources/oauth", OAuthSourceViewSet)
|
||||||
|
router.register("sources/plex", PlexSourceViewSet)
|
||||||
|
|
||||||
|
router.register("policies/all", PolicyViewSet)
|
||||||
|
router.register("policies/bindings", PolicyBindingViewSet)
|
||||||
|
router.register("policies/expression", ExpressionPolicyViewSet)
|
||||||
|
router.register("policies/event_matcher", EventMatcherPolicyViewSet)
|
||||||
|
router.register("policies/haveibeenpwned", HaveIBeenPwendPolicyViewSet)
|
||||||
|
router.register("policies/password_expiry", PasswordExpiryPolicyViewSet)
|
||||||
|
router.register("policies/password", PasswordPolicyViewSet)
|
||||||
|
router.register("policies/reputation/scores", ReputationViewSet)
|
||||||
|
router.register("policies/reputation", ReputationPolicyViewSet)
|
||||||
|
|
||||||
|
router.register("providers/all", ProviderViewSet)
|
||||||
|
router.register("providers/ldap", LDAPProviderViewSet)
|
||||||
|
router.register("providers/proxy", ProxyProviderViewSet)
|
||||||
|
router.register("providers/oauth2", OAuth2ProviderViewSet)
|
||||||
|
router.register("providers/saml", SAMLProviderViewSet)
|
||||||
|
|
||||||
|
router.register("oauth2/authorization_codes", AuthorizationCodeViewSet)
|
||||||
|
router.register("oauth2/refresh_tokens", RefreshTokenViewSet)
|
||||||
|
|
||||||
|
router.register("propertymappings/all", PropertyMappingViewSet)
|
||||||
|
router.register("propertymappings/ldap", LDAPPropertyMappingViewSet)
|
||||||
|
router.register("propertymappings/saml", SAMLPropertyMappingViewSet)
|
||||||
|
router.register("propertymappings/scope", ScopeMappingViewSet)
|
||||||
|
router.register("propertymappings/notification", NotificationWebhookMappingViewSet)
|
||||||
|
|
||||||
|
router.register("authenticators/all", DeviceViewSet, basename="device")
|
||||||
|
router.register("authenticators/duo", DuoDeviceViewSet)
|
||||||
|
router.register("authenticators/sms", SMSDeviceViewSet)
|
||||||
|
router.register("authenticators/static", StaticDeviceViewSet)
|
||||||
|
router.register("authenticators/totp", TOTPDeviceViewSet)
|
||||||
|
router.register("authenticators/webauthn", WebAuthnDeviceViewSet)
|
||||||
|
router.register(
|
||||||
|
"authenticators/admin/duo",
|
||||||
|
DuoAdminDeviceViewSet,
|
||||||
|
basename="admin-duodevice",
|
||||||
|
)
|
||||||
|
router.register(
|
||||||
|
"authenticators/admin/sms",
|
||||||
|
SMSAdminDeviceViewSet,
|
||||||
|
basename="admin-smsdevice",
|
||||||
|
)
|
||||||
|
router.register(
|
||||||
|
"authenticators/admin/static",
|
||||||
|
StaticAdminDeviceViewSet,
|
||||||
|
basename="admin-staticdevice",
|
||||||
|
)
|
||||||
|
router.register("authenticators/admin/totp", TOTPAdminDeviceViewSet, basename="admin-totpdevice")
|
||||||
|
router.register(
|
||||||
|
"authenticators/admin/webauthn",
|
||||||
|
WebAuthnAdminDeviceViewSet,
|
||||||
|
basename="admin-webauthndevice",
|
||||||
|
)
|
||||||
|
|
||||||
|
router.register("stages/all", StageViewSet)
|
||||||
|
router.register("stages/authenticator/duo", AuthenticatorDuoStageViewSet)
|
||||||
|
router.register("stages/authenticator/sms", AuthenticatorSMSStageViewSet)
|
||||||
|
router.register("stages/authenticator/static", AuthenticatorStaticStageViewSet)
|
||||||
|
router.register("stages/authenticator/totp", AuthenticatorTOTPStageViewSet)
|
||||||
|
router.register("stages/authenticator/validate", AuthenticatorValidateStageViewSet)
|
||||||
|
router.register("stages/authenticator/webauthn", AuthenticateWebAuthnStageViewSet)
|
||||||
|
router.register("stages/captcha", CaptchaStageViewSet)
|
||||||
|
router.register("stages/consent", ConsentStageViewSet)
|
||||||
|
router.register("stages/deny", DenyStageViewSet)
|
||||||
|
router.register("stages/email", EmailStageViewSet)
|
||||||
|
router.register("stages/identification", IdentificationStageViewSet)
|
||||||
|
router.register("stages/invitation/invitations", InvitationViewSet)
|
||||||
|
router.register("stages/invitation/stages", InvitationStageViewSet)
|
||||||
|
router.register("stages/password", PasswordStageViewSet)
|
||||||
|
router.register("stages/prompt/prompts", PromptViewSet)
|
||||||
|
router.register("stages/prompt/stages", PromptStageViewSet)
|
||||||
|
router.register("stages/user_delete", UserDeleteStageViewSet)
|
||||||
|
router.register("stages/user_login", UserLoginStageViewSet)
|
||||||
|
router.register("stages/user_logout", UserLogoutStageViewSet)
|
||||||
|
router.register("stages/user_write", UserWriteStageViewSet)
|
||||||
|
|
||||||
|
router.register("stages/dummy", DummyStageViewSet)
|
||||||
|
router.register("policies/dummy", DummyPolicyViewSet)
|
||||||
|
|
||||||
urlpatterns = (
|
urlpatterns = (
|
||||||
[
|
[
|
||||||
path("", APIBrowserView.as_view(), name="schema-browser"),
|
path("", APIBrowserView.as_view(), name="schema-browser"),
|
||||||
]
|
]
|
||||||
+ router.urls
|
+ router.urls
|
||||||
+ _other_urls
|
|
||||||
+ [
|
+ [
|
||||||
|
path(
|
||||||
|
"admin/metrics/",
|
||||||
|
AdministrationMetricsViewSet.as_view(),
|
||||||
|
name="admin_metrics",
|
||||||
|
),
|
||||||
|
path("admin/version/", VersionView.as_view(), name="admin_version"),
|
||||||
|
path("admin/workers/", WorkerView.as_view(), name="admin_workers"),
|
||||||
|
path("admin/system/", SystemView.as_view(), name="admin_system"),
|
||||||
path("root/config/", ConfigView.as_view(), name="config"),
|
path("root/config/", ConfigView.as_view(), name="config"),
|
||||||
|
path(
|
||||||
|
"flows/executor/<slug:flow_slug>/",
|
||||||
|
FlowExecutorView.as_view(),
|
||||||
|
name="flow-executor",
|
||||||
|
),
|
||||||
|
path(
|
||||||
|
"flows/inspector/<slug:flow_slug>/",
|
||||||
|
FlowInspectorView.as_view(),
|
||||||
|
name="flow-inspector",
|
||||||
|
),
|
||||||
path("schema/", cache_page(86400)(SpectacularAPIView.as_view()), name="schema"),
|
path("schema/", cache_page(86400)(SpectacularAPIView.as_view()), name="schema"),
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
|
@ -1,128 +0,0 @@
|
||||||
"""Serializer mixin for managed models"""
|
|
||||||
from django.utils.translation import gettext_lazy as _
|
|
||||||
from drf_spectacular.utils import extend_schema, inline_serializer
|
|
||||||
from rest_framework.decorators import action
|
|
||||||
from rest_framework.exceptions import ValidationError
|
|
||||||
from rest_framework.fields import CharField, DateTimeField, JSONField
|
|
||||||
from rest_framework.request import Request
|
|
||||||
from rest_framework.response import Response
|
|
||||||
from rest_framework.serializers import ListSerializer, ModelSerializer
|
|
||||||
from rest_framework.viewsets import ModelViewSet
|
|
||||||
|
|
||||||
from authentik.api.decorators import permission_required
|
|
||||||
from authentik.blueprints.models import BlueprintInstance
|
|
||||||
from authentik.blueprints.v1.importer import Importer
|
|
||||||
from authentik.blueprints.v1.oci import OCI_PREFIX
|
|
||||||
from authentik.blueprints.v1.tasks import apply_blueprint, blueprints_find_dict
|
|
||||||
from authentik.core.api.used_by import UsedByMixin
|
|
||||||
from authentik.core.api.utils import PassiveSerializer
|
|
||||||
|
|
||||||
|
|
||||||
class ManagedSerializer:
|
|
||||||
"""Managed Serializer"""
|
|
||||||
|
|
||||||
managed = CharField(read_only=True, allow_null=True)
|
|
||||||
|
|
||||||
|
|
||||||
class MetadataSerializer(PassiveSerializer):
|
|
||||||
"""Serializer for blueprint metadata"""
|
|
||||||
|
|
||||||
name = CharField()
|
|
||||||
labels = JSONField()
|
|
||||||
|
|
||||||
|
|
||||||
class BlueprintInstanceSerializer(ModelSerializer):
|
|
||||||
"""Info about a single blueprint instance file"""
|
|
||||||
|
|
||||||
def validate_path(self, path: str) -> str:
|
|
||||||
"""Ensure the path (if set) specified is retrievable"""
|
|
||||||
if path == "" or path.startswith(OCI_PREFIX):
|
|
||||||
return path
|
|
||||||
files: list[dict] = blueprints_find_dict.delay().get()
|
|
||||||
if path not in [file["path"] for file in files]:
|
|
||||||
raise ValidationError(_("Blueprint file does not exist"))
|
|
||||||
return path
|
|
||||||
|
|
||||||
def validate_content(self, content: str) -> str:
|
|
||||||
"""Ensure content (if set) is a valid blueprint"""
|
|
||||||
if content == "":
|
|
||||||
return content
|
|
||||||
context = self.instance.context if self.instance else {}
|
|
||||||
valid, logs = Importer.from_string(content, context).validate()
|
|
||||||
if not valid:
|
|
||||||
text_logs = "\n".join([x["event"] for x in logs])
|
|
||||||
raise ValidationError(_("Failed to validate blueprint: %(logs)s" % {"logs": text_logs}))
|
|
||||||
return content
|
|
||||||
|
|
||||||
def validate(self, attrs: dict) -> dict:
|
|
||||||
if attrs.get("path", "") == "" and attrs.get("content", "") == "":
|
|
||||||
raise ValidationError(_("Either path or content must be set."))
|
|
||||||
return super().validate(attrs)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
model = BlueprintInstance
|
|
||||||
fields = [
|
|
||||||
"pk",
|
|
||||||
"name",
|
|
||||||
"path",
|
|
||||||
"context",
|
|
||||||
"last_applied",
|
|
||||||
"last_applied_hash",
|
|
||||||
"status",
|
|
||||||
"enabled",
|
|
||||||
"managed_models",
|
|
||||||
"metadata",
|
|
||||||
"content",
|
|
||||||
]
|
|
||||||
extra_kwargs = {
|
|
||||||
"status": {"read_only": True},
|
|
||||||
"last_applied": {"read_only": True},
|
|
||||||
"last_applied_hash": {"read_only": True},
|
|
||||||
"managed_models": {"read_only": True},
|
|
||||||
"metadata": {"read_only": True},
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
class BlueprintInstanceViewSet(UsedByMixin, ModelViewSet):
|
|
||||||
"""Blueprint instances"""
|
|
||||||
|
|
||||||
serializer_class = BlueprintInstanceSerializer
|
|
||||||
queryset = BlueprintInstance.objects.all()
|
|
||||||
search_fields = ["name", "path"]
|
|
||||||
filterset_fields = ["name", "path"]
|
|
||||||
ordering = ["name"]
|
|
||||||
|
|
||||||
@extend_schema(
|
|
||||||
responses={
|
|
||||||
200: ListSerializer(
|
|
||||||
child=inline_serializer(
|
|
||||||
"BlueprintFile",
|
|
||||||
fields={
|
|
||||||
"path": CharField(),
|
|
||||||
"last_m": DateTimeField(),
|
|
||||||
"hash": CharField(),
|
|
||||||
"meta": MetadataSerializer(required=False, read_only=True),
|
|
||||||
},
|
|
||||||
)
|
|
||||||
)
|
|
||||||
}
|
|
||||||
)
|
|
||||||
@action(detail=False, pagination_class=None, filter_backends=[])
|
|
||||||
def available(self, request: Request) -> Response:
|
|
||||||
"""Get blueprints"""
|
|
||||||
files: list[dict] = blueprints_find_dict.delay().get()
|
|
||||||
return Response(files)
|
|
||||||
|
|
||||||
@permission_required("authentik_blueprints.view_blueprintinstance")
|
|
||||||
@extend_schema(
|
|
||||||
request=None,
|
|
||||||
responses={
|
|
||||||
200: BlueprintInstanceSerializer(),
|
|
||||||
},
|
|
||||||
)
|
|
||||||
@action(detail=True, pagination_class=None, filter_backends=[], methods=["POST"])
|
|
||||||
def apply(self, request: Request, *args, **kwargs) -> Response:
|
|
||||||
"""Apply a blueprint"""
|
|
||||||
blueprint = self.get_object()
|
|
||||||
apply_blueprint.delay(str(blueprint.pk)).get()
|
|
||||||
return self.retrieve(request, *args, **kwargs)
|
|
|
@ -1,67 +0,0 @@
|
||||||
"""authentik Blueprints app"""
|
|
||||||
|
|
||||||
from importlib import import_module
|
|
||||||
from inspect import ismethod
|
|
||||||
|
|
||||||
from django.apps import AppConfig
|
|
||||||
from django.db import DatabaseError, InternalError, ProgrammingError
|
|
||||||
from structlog.stdlib import BoundLogger, get_logger
|
|
||||||
|
|
||||||
|
|
||||||
class ManagedAppConfig(AppConfig):
|
|
||||||
"""Basic reconciliation logic for apps"""
|
|
||||||
|
|
||||||
_logger: BoundLogger
|
|
||||||
|
|
||||||
def __init__(self, app_name: str, *args, **kwargs) -> None:
|
|
||||||
super().__init__(app_name, *args, **kwargs)
|
|
||||||
self._logger = get_logger().bind(app_name=app_name)
|
|
||||||
|
|
||||||
def ready(self) -> None:
|
|
||||||
self.reconcile()
|
|
||||||
return super().ready()
|
|
||||||
|
|
||||||
def import_module(self, path: str):
|
|
||||||
"""Load module"""
|
|
||||||
import_module(path)
|
|
||||||
|
|
||||||
def reconcile(self) -> None:
|
|
||||||
"""reconcile ourselves"""
|
|
||||||
prefix = "reconcile_"
|
|
||||||
for meth_name in dir(self):
|
|
||||||
meth = getattr(self, meth_name)
|
|
||||||
if not ismethod(meth):
|
|
||||||
continue
|
|
||||||
if not meth_name.startswith(prefix):
|
|
||||||
continue
|
|
||||||
name = meth_name.replace(prefix, "")
|
|
||||||
try:
|
|
||||||
self._logger.debug("Starting reconciler", name=name)
|
|
||||||
meth()
|
|
||||||
self._logger.debug("Successfully reconciled", name=name)
|
|
||||||
except (DatabaseError, ProgrammingError, InternalError) as exc:
|
|
||||||
self._logger.warning("Failed to run reconcile", name=name, exc=exc)
|
|
||||||
|
|
||||||
|
|
||||||
class AuthentikBlueprintsConfig(ManagedAppConfig):
|
|
||||||
"""authentik Blueprints app"""
|
|
||||||
|
|
||||||
name = "authentik.blueprints"
|
|
||||||
label = "authentik_blueprints"
|
|
||||||
verbose_name = "authentik Blueprints"
|
|
||||||
default = True
|
|
||||||
|
|
||||||
def reconcile_load_blueprints_v1_tasks(self):
|
|
||||||
"""Load v1 tasks"""
|
|
||||||
self.import_module("authentik.blueprints.v1.tasks")
|
|
||||||
|
|
||||||
def reconcile_blueprints_discovery(self):
|
|
||||||
"""Run blueprint discovery"""
|
|
||||||
from authentik.blueprints.v1.tasks import blueprints_discovery, clear_failed_blueprints
|
|
||||||
|
|
||||||
blueprints_discovery.delay()
|
|
||||||
clear_failed_blueprints.delay()
|
|
||||||
|
|
||||||
def import_models(self):
|
|
||||||
super().import_models()
|
|
||||||
self.import_module("authentik.blueprints.v1.meta.apply_blueprint")
|
|
|
@ -1,29 +0,0 @@
|
||||||
"""Apply blueprint from commandline"""
|
|
||||||
from sys import exit as sys_exit
|
|
||||||
|
|
||||||
from django.core.management.base import BaseCommand, no_translations
|
|
||||||
from structlog.stdlib import get_logger
|
|
||||||
|
|
||||||
from authentik.blueprints.models import BlueprintInstance
|
|
||||||
from authentik.blueprints.v1.importer import Importer
|
|
||||||
|
|
||||||
LOGGER = get_logger()
|
|
||||||
|
|
||||||
|
|
||||||
class Command(BaseCommand):
|
|
||||||
"""Apply blueprint from commandline"""
|
|
||||||
|
|
||||||
@no_translations
|
|
||||||
def handle(self, *args, **options):
|
|
||||||
"""Apply all blueprints in order, abort when one fails to import"""
|
|
||||||
for blueprint_path in options.get("blueprints", []):
|
|
||||||
content = BlueprintInstance(path=blueprint_path).retrieve()
|
|
||||||
importer = Importer.from_string(content)
|
|
||||||
valid, _ = importer.validate()
|
|
||||||
if not valid:
|
|
||||||
self.stderr.write("blueprint invalid")
|
|
||||||
sys_exit(1)
|
|
||||||
importer.apply()
|
|
||||||
|
|
||||||
def add_arguments(self, parser):
|
|
||||||
parser.add_argument("blueprints", nargs="+", type=str)
|
|
|
@ -1,17 +0,0 @@
|
||||||
"""Export blueprint of current authentik install"""
|
|
||||||
from django.core.management.base import BaseCommand, no_translations
|
|
||||||
from structlog.stdlib import get_logger
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.exporter import Exporter
|
|
||||||
|
|
||||||
LOGGER = get_logger()
|
|
||||||
|
|
||||||
|
|
||||||
class Command(BaseCommand):
|
|
||||||
"""Export blueprint of current authentik install"""
|
|
||||||
|
|
||||||
@no_translations
|
|
||||||
def handle(self, *args, **options):
|
|
||||||
"""Export blueprint of current authentik install"""
|
|
||||||
exporter = Exporter()
|
|
||||||
self.stdout.write(exporter.export_to_string())
|
|
|
@ -1,167 +0,0 @@
|
||||||
"""Generate JSON Schema for blueprints"""
|
|
||||||
from json import dumps
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
from django.core.management.base import BaseCommand, no_translations
|
|
||||||
from django.db.models import Model
|
|
||||||
from drf_jsonschema_serializer.convert import field_to_converter
|
|
||||||
from rest_framework.fields import Field, JSONField, UUIDField
|
|
||||||
from rest_framework.serializers import Serializer
|
|
||||||
from structlog.stdlib import get_logger
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.common import BlueprintEntryDesiredState
|
|
||||||
from authentik.blueprints.v1.importer import SERIALIZER_CONTEXT_BLUEPRINT, is_model_allowed
|
|
||||||
from authentik.blueprints.v1.meta.registry import BaseMetaModel, registry
|
|
||||||
from authentik.lib.models import SerializerModel
|
|
||||||
|
|
||||||
LOGGER = get_logger()
|
|
||||||
|
|
||||||
|
|
||||||
class Command(BaseCommand):
|
|
||||||
"""Generate JSON Schema for blueprints"""
|
|
||||||
|
|
||||||
schema: dict
|
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
self.schema = {
|
|
||||||
"$schema": "http://json-schema.org/draft-07/schema",
|
|
||||||
"$id": "https://goauthentik.io/blueprints/schema.json",
|
|
||||||
"type": "object",
|
|
||||||
"title": "authentik Blueprint schema",
|
|
||||||
"required": ["version", "entries"],
|
|
||||||
"properties": {
|
|
||||||
"version": {
|
|
||||||
"$id": "#/properties/version",
|
|
||||||
"type": "integer",
|
|
||||||
"title": "Blueprint version",
|
|
||||||
"default": 1,
|
|
||||||
},
|
|
||||||
"metadata": {
|
|
||||||
"$id": "#/properties/metadata",
|
|
||||||
"type": "object",
|
|
||||||
"required": ["name"],
|
|
||||||
"properties": {
|
|
||||||
"name": {"type": "string"},
|
|
||||||
"labels": {"type": "object", "additionalProperties": {"type": "string"}},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
"context": {
|
|
||||||
"$id": "#/properties/context",
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": True,
|
|
||||||
},
|
|
||||||
"entries": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"oneOf": [],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
"$defs": {},
|
|
||||||
}
|
|
||||||
|
|
||||||
@no_translations
|
|
||||||
def handle(self, *args, **options):
|
|
||||||
"""Generate JSON Schema for blueprints"""
|
|
||||||
self.build()
|
|
||||||
self.stdout.write(dumps(self.schema, indent=4, default=Command.json_default))
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def json_default(value: Any) -> Any:
|
|
||||||
"""Helper that handles gettext_lazy strings that JSON doesn't handle"""
|
|
||||||
return str(value)
|
|
||||||
|
|
||||||
def build(self):
|
|
||||||
"""Build all models into the schema"""
|
|
||||||
for model in registry.get_models():
|
|
||||||
if issubclass(model, BaseMetaModel):
|
|
||||||
serializer_class = model.serializer()
|
|
||||||
else:
|
|
||||||
if model._meta.abstract:
|
|
||||||
continue
|
|
||||||
if not is_model_allowed(model):
|
|
||||||
continue
|
|
||||||
model_instance: Model = model()
|
|
||||||
if not isinstance(model_instance, SerializerModel):
|
|
||||||
continue
|
|
||||||
serializer_class = model_instance.serializer
|
|
||||||
serializer = serializer_class(
|
|
||||||
context={
|
|
||||||
SERIALIZER_CONTEXT_BLUEPRINT: False,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
model_path = f"{model._meta.app_label}.{model._meta.model_name}"
|
|
||||||
self.schema["properties"]["entries"]["items"]["oneOf"].append(
|
|
||||||
self.template_entry(model_path, serializer)
|
|
||||||
)
|
|
||||||
|
|
||||||
def template_entry(self, model_path: str, serializer: Serializer) -> dict:
|
|
||||||
"""Template entry for a single model"""
|
|
||||||
model_schema = self.to_jsonschema(serializer)
|
|
||||||
model_schema["required"] = []
|
|
||||||
def_name = f"model_{model_path}"
|
|
||||||
def_path = f"#/$defs/{def_name}"
|
|
||||||
self.schema["$defs"][def_name] = model_schema
|
|
||||||
return {
|
|
||||||
"type": "object",
|
|
||||||
"required": ["model", "identifiers"],
|
|
||||||
"properties": {
|
|
||||||
"model": {"const": model_path},
|
|
||||||
"id": {"type": "string"},
|
|
||||||
"state": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [s.value for s in BlueprintEntryDesiredState],
|
|
||||||
"default": "present",
|
|
||||||
},
|
|
||||||
"conditions": {"type": "array", "items": {"type": "boolean"}},
|
|
||||||
"attrs": {"$ref": def_path},
|
|
||||||
"identifiers": {"$ref": def_path},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
def field_to_jsonschema(self, field: Field) -> dict:
|
|
||||||
"""Convert a single field to json schema"""
|
|
||||||
if isinstance(field, Serializer):
|
|
||||||
result = self.to_jsonschema(field)
|
|
||||||
else:
|
|
||||||
try:
|
|
||||||
converter = field_to_converter[field]
|
|
||||||
result = converter.convert(field)
|
|
||||||
except KeyError:
|
|
||||||
if isinstance(field, JSONField):
|
|
||||||
result = {"type": "object", "additionalProperties": True}
|
|
||||||
elif isinstance(field, UUIDField):
|
|
||||||
result = {"type": "string", "format": "uuid"}
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
if field.label:
|
|
||||||
result["title"] = field.label
|
|
||||||
if field.help_text:
|
|
||||||
result["description"] = field.help_text
|
|
||||||
return self.clean_result(result)
|
|
||||||
|
|
||||||
def clean_result(self, result: dict) -> dict:
|
|
||||||
"""Remove enumNames from result, recursively"""
|
|
||||||
result.pop("enumNames", None)
|
|
||||||
for key, value in result.items():
|
|
||||||
if isinstance(value, dict):
|
|
||||||
result[key] = self.clean_result(value)
|
|
||||||
return result
|
|
||||||
|
|
||||||
def to_jsonschema(self, serializer: Serializer) -> dict:
|
|
||||||
"""Convert serializer to json schema"""
|
|
||||||
properties = {}
|
|
||||||
required = []
|
|
||||||
for name, field in serializer.fields.items():
|
|
||||||
if field.read_only:
|
|
||||||
continue
|
|
||||||
sub_schema = self.field_to_jsonschema(field)
|
|
||||||
if field.required:
|
|
||||||
required.append(name)
|
|
||||||
properties[name] = sub_schema
|
|
||||||
|
|
||||||
result = {"type": "object", "properties": properties}
|
|
||||||
if required:
|
|
||||||
result["required"] = required
|
|
||||||
return result
|
|
|
@ -1,138 +0,0 @@
|
||||||
# Generated by Django 4.0.6 on 2022-07-31 17:35
|
|
||||||
import uuid
|
|
||||||
from glob import glob
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import django.contrib.postgres.fields
|
|
||||||
from dacite.core import from_dict
|
|
||||||
from django.apps.registry import Apps
|
|
||||||
from django.db import migrations, models
|
|
||||||
from django.db.backends.base.schema import BaseDatabaseSchemaEditor
|
|
||||||
from yaml import load
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.labels import LABEL_AUTHENTIK_SYSTEM
|
|
||||||
from authentik.lib.config import CONFIG
|
|
||||||
|
|
||||||
|
|
||||||
def check_blueprint_v1_file(BlueprintInstance: type, path: Path):
|
|
||||||
"""Check if blueprint should be imported"""
|
|
||||||
from authentik.blueprints.models import BlueprintInstanceStatus
|
|
||||||
from authentik.blueprints.v1.common import BlueprintLoader, BlueprintMetadata
|
|
||||||
from authentik.blueprints.v1.labels import LABEL_AUTHENTIK_INSTANTIATE
|
|
||||||
|
|
||||||
with open(path, "r", encoding="utf-8") as blueprint_file:
|
|
||||||
raw_blueprint = load(blueprint_file.read(), BlueprintLoader)
|
|
||||||
if not raw_blueprint:
|
|
||||||
return
|
|
||||||
metadata = raw_blueprint.get("metadata", None)
|
|
||||||
version = raw_blueprint.get("version", 1)
|
|
||||||
if version != 1:
|
|
||||||
return
|
|
||||||
blueprint_file.seek(0)
|
|
||||||
instance: BlueprintInstance = BlueprintInstance.objects.filter(path=path).first()
|
|
||||||
rel_path = path.relative_to(Path(CONFIG.get("blueprints_dir")))
|
|
||||||
meta = None
|
|
||||||
if metadata:
|
|
||||||
meta = from_dict(BlueprintMetadata, metadata)
|
|
||||||
if meta.labels.get(LABEL_AUTHENTIK_INSTANTIATE, "").lower() == "false":
|
|
||||||
return
|
|
||||||
if not instance:
|
|
||||||
instance = BlueprintInstance(
|
|
||||||
name=meta.name if meta else str(rel_path),
|
|
||||||
path=str(rel_path),
|
|
||||||
context={},
|
|
||||||
status=BlueprintInstanceStatus.UNKNOWN,
|
|
||||||
enabled=True,
|
|
||||||
managed_models=[],
|
|
||||||
last_applied_hash="",
|
|
||||||
metadata=metadata or {},
|
|
||||||
)
|
|
||||||
instance.save()
|
|
||||||
|
|
||||||
|
|
||||||
def migration_blueprint_import(apps: Apps, schema_editor: BaseDatabaseSchemaEditor):
|
|
||||||
BlueprintInstance = apps.get_model("authentik_blueprints", "BlueprintInstance")
|
|
||||||
Flow = apps.get_model("authentik_flows", "Flow")
|
|
||||||
|
|
||||||
db_alias = schema_editor.connection.alias
|
|
||||||
for file in glob(f"{CONFIG.get('blueprints_dir')}/**/*.yaml", recursive=True):
|
|
||||||
check_blueprint_v1_file(BlueprintInstance, Path(file))
|
|
||||||
|
|
||||||
for blueprint in BlueprintInstance.objects.using(db_alias).all():
|
|
||||||
# If we already have flows (and we should always run before flow migrations)
|
|
||||||
# then this is an existing install and we want to disable all blueprints
|
|
||||||
if Flow.objects.using(db_alias).all().exists():
|
|
||||||
blueprint.enabled = False
|
|
||||||
# System blueprints are always enabled
|
|
||||||
if blueprint.metadata.get("labels", {}).get(LABEL_AUTHENTIK_SYSTEM, "").lower() == "true":
|
|
||||||
blueprint.enabled = True
|
|
||||||
blueprint.save()
|
|
||||||
|
|
||||||
|
|
||||||
class Migration(migrations.Migration):
|
|
||||||
initial = True
|
|
||||||
|
|
||||||
dependencies = [("authentik_flows", "0001_initial")]
|
|
||||||
|
|
||||||
operations = [
|
|
||||||
migrations.CreateModel(
|
|
||||||
name="BlueprintInstance",
|
|
||||||
fields=[
|
|
||||||
("created", models.DateTimeField(auto_now_add=True)),
|
|
||||||
("last_updated", models.DateTimeField(auto_now=True)),
|
|
||||||
(
|
|
||||||
"managed",
|
|
||||||
models.TextField(
|
|
||||||
default=None,
|
|
||||||
help_text=(
|
|
||||||
"Objects which are managed by authentik. These objects are created and"
|
|
||||||
" updated automatically. This is flag only indicates that an object can"
|
|
||||||
" be overwritten by migrations. You can still modify the objects via"
|
|
||||||
" the API, but expect changes to be overwritten in a later update."
|
|
||||||
),
|
|
||||||
null=True,
|
|
||||||
unique=True,
|
|
||||||
verbose_name="Managed by authentik",
|
|
||||||
),
|
|
||||||
),
|
|
||||||
(
|
|
||||||
"instance_uuid",
|
|
||||||
models.UUIDField(
|
|
||||||
default=uuid.uuid4, editable=False, primary_key=True, serialize=False
|
|
||||||
),
|
|
||||||
),
|
|
||||||
("name", models.TextField()),
|
|
||||||
("metadata", models.JSONField(default=dict)),
|
|
||||||
("path", models.TextField()),
|
|
||||||
("context", models.JSONField(default=dict)),
|
|
||||||
("last_applied", models.DateTimeField(auto_now=True)),
|
|
||||||
("last_applied_hash", models.TextField()),
|
|
||||||
(
|
|
||||||
"status",
|
|
||||||
models.TextField(
|
|
||||||
choices=[
|
|
||||||
("successful", "Successful"),
|
|
||||||
("warning", "Warning"),
|
|
||||||
("error", "Error"),
|
|
||||||
("orphaned", "Orphaned"),
|
|
||||||
("unknown", "Unknown"),
|
|
||||||
],
|
|
||||||
default="unknown",
|
|
||||||
),
|
|
||||||
),
|
|
||||||
("enabled", models.BooleanField(default=True)),
|
|
||||||
(
|
|
||||||
"managed_models",
|
|
||||||
django.contrib.postgres.fields.ArrayField(
|
|
||||||
base_field=models.TextField(), default=list, size=None
|
|
||||||
),
|
|
||||||
),
|
|
||||||
],
|
|
||||||
options={
|
|
||||||
"verbose_name": "Blueprint Instance",
|
|
||||||
"verbose_name_plural": "Blueprint Instances",
|
|
||||||
"unique_together": {("name", "path")},
|
|
||||||
},
|
|
||||||
),
|
|
||||||
migrations.RunPython(migration_blueprint_import),
|
|
||||||
]
|
|
|
@ -1,22 +0,0 @@
|
||||||
# Generated by Django 4.1.5 on 2023-01-10 19:48
|
|
||||||
|
|
||||||
from django.db import migrations, models
|
|
||||||
|
|
||||||
|
|
||||||
class Migration(migrations.Migration):
|
|
||||||
dependencies = [
|
|
||||||
("authentik_blueprints", "0001_initial"),
|
|
||||||
]
|
|
||||||
|
|
||||||
operations = [
|
|
||||||
migrations.AddField(
|
|
||||||
model_name="blueprintinstance",
|
|
||||||
name="content",
|
|
||||||
field=models.TextField(blank=True, default=""),
|
|
||||||
),
|
|
||||||
migrations.AlterField(
|
|
||||||
model_name="blueprintinstance",
|
|
||||||
name="path",
|
|
||||||
field=models.TextField(blank=True, default=""),
|
|
||||||
),
|
|
||||||
]
|
|
|
@ -1,31 +0,0 @@
|
||||||
# Generated by Django 4.1.7 on 2023-04-28 10:49
|
|
||||||
|
|
||||||
from django.db import migrations, models
|
|
||||||
|
|
||||||
from authentik.lib.migrations import fallback_names
|
|
||||||
|
|
||||||
|
|
||||||
class Migration(migrations.Migration):
|
|
||||||
dependencies = [
|
|
||||||
("authentik_blueprints", "0002_blueprintinstance_content"),
|
|
||||||
]
|
|
||||||
|
|
||||||
operations = [
|
|
||||||
migrations.RunPython(fallback_names("authentik_blueprints", "blueprintinstance", "name")),
|
|
||||||
migrations.AlterField(
|
|
||||||
model_name="blueprintinstance",
|
|
||||||
name="name",
|
|
||||||
field=models.TextField(unique=True),
|
|
||||||
),
|
|
||||||
migrations.AlterField(
|
|
||||||
model_name="blueprintinstance",
|
|
||||||
name="managed",
|
|
||||||
field=models.TextField(
|
|
||||||
default=None,
|
|
||||||
help_text="Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.",
|
|
||||||
null=True,
|
|
||||||
unique=True,
|
|
||||||
verbose_name="Managed by authentik",
|
|
||||||
),
|
|
||||||
),
|
|
||||||
]
|
|
|
@ -1,119 +0,0 @@
|
||||||
"""blueprint models"""
|
|
||||||
from pathlib import Path
|
|
||||||
from uuid import uuid4
|
|
||||||
|
|
||||||
from django.contrib.postgres.fields import ArrayField
|
|
||||||
from django.db import models
|
|
||||||
from django.utils.translation import gettext_lazy as _
|
|
||||||
from rest_framework.serializers import Serializer
|
|
||||||
from structlog import get_logger
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.oci import OCI_PREFIX, BlueprintOCIClient, OCIException
|
|
||||||
from authentik.lib.config import CONFIG
|
|
||||||
from authentik.lib.models import CreatedUpdatedModel, SerializerModel
|
|
||||||
from authentik.lib.sentry import SentryIgnoredException
|
|
||||||
|
|
||||||
LOGGER = get_logger()
|
|
||||||
|
|
||||||
|
|
||||||
class BlueprintRetrievalFailed(SentryIgnoredException):
|
|
||||||
"""Error raised when we are unable to fetch the blueprint contents, whether it be HTTP files
|
|
||||||
not being accessible or local files not being readable"""
|
|
||||||
|
|
||||||
|
|
||||||
class ManagedModel(models.Model):
|
|
||||||
"""Model that can be managed by authentik exclusively"""
|
|
||||||
|
|
||||||
managed = models.TextField(
|
|
||||||
default=None,
|
|
||||||
null=True,
|
|
||||||
verbose_name=_("Managed by authentik"),
|
|
||||||
help_text=_(
|
|
||||||
"Objects that are managed by authentik. These objects are created and updated "
|
|
||||||
"automatically. This flag only indicates that an object can be overwritten by "
|
|
||||||
"migrations. You can still modify the objects via the API, but expect changes "
|
|
||||||
"to be overwritten in a later update."
|
|
||||||
),
|
|
||||||
unique=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
abstract = True
|
|
||||||
|
|
||||||
|
|
||||||
class BlueprintInstanceStatus(models.TextChoices):
|
|
||||||
"""Instance status"""
|
|
||||||
|
|
||||||
SUCCESSFUL = "successful"
|
|
||||||
WARNING = "warning"
|
|
||||||
ERROR = "error"
|
|
||||||
ORPHANED = "orphaned"
|
|
||||||
UNKNOWN = "unknown"
|
|
||||||
|
|
||||||
|
|
||||||
class BlueprintInstance(SerializerModel, ManagedModel, CreatedUpdatedModel):
|
|
||||||
"""Instance of a single blueprint. Can be parameterized via context attribute when
|
|
||||||
blueprint in `path` has inputs."""
|
|
||||||
|
|
||||||
instance_uuid = models.UUIDField(primary_key=True, editable=False, default=uuid4)
|
|
||||||
|
|
||||||
name = models.TextField(unique=True)
|
|
||||||
metadata = models.JSONField(default=dict)
|
|
||||||
path = models.TextField(default="", blank=True)
|
|
||||||
content = models.TextField(default="", blank=True)
|
|
||||||
context = models.JSONField(default=dict)
|
|
||||||
last_applied = models.DateTimeField(auto_now=True)
|
|
||||||
last_applied_hash = models.TextField()
|
|
||||||
status = models.TextField(
|
|
||||||
choices=BlueprintInstanceStatus.choices, default=BlueprintInstanceStatus.UNKNOWN
|
|
||||||
)
|
|
||||||
enabled = models.BooleanField(default=True)
|
|
||||||
managed_models = ArrayField(models.TextField(), default=list)
|
|
||||||
|
|
||||||
def retrieve_oci(self) -> str:
|
|
||||||
"""Get blueprint from an OCI registry"""
|
|
||||||
client = BlueprintOCIClient(self.path.replace(OCI_PREFIX, "https://"))
|
|
||||||
try:
|
|
||||||
manifests = client.fetch_manifests()
|
|
||||||
return client.fetch_blobs(manifests)
|
|
||||||
except OCIException as exc:
|
|
||||||
raise BlueprintRetrievalFailed(exc) from exc
|
|
||||||
|
|
||||||
def retrieve_file(self) -> str:
|
|
||||||
"""Get blueprint from path"""
|
|
||||||
try:
|
|
||||||
base = Path(CONFIG.get("blueprints_dir"))
|
|
||||||
full_path = base.joinpath(Path(self.path)).resolve()
|
|
||||||
if not str(full_path).startswith(str(base.resolve())):
|
|
||||||
raise BlueprintRetrievalFailed("Invalid blueprint path")
|
|
||||||
with full_path.open("r", encoding="utf-8") as _file:
|
|
||||||
return _file.read()
|
|
||||||
except (IOError, OSError) as exc:
|
|
||||||
raise BlueprintRetrievalFailed(exc) from exc
|
|
||||||
|
|
||||||
def retrieve(self) -> str:
|
|
||||||
"""Retrieve blueprint contents"""
|
|
||||||
if self.path.startswith(OCI_PREFIX):
|
|
||||||
return self.retrieve_oci()
|
|
||||||
if self.path != "":
|
|
||||||
return self.retrieve_file()
|
|
||||||
return self.content
|
|
||||||
|
|
||||||
@property
|
|
||||||
def serializer(self) -> Serializer:
|
|
||||||
from authentik.blueprints.api import BlueprintInstanceSerializer
|
|
||||||
|
|
||||||
return BlueprintInstanceSerializer
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
return f"Blueprint Instance {self.name}"
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
verbose_name = _("Blueprint Instance")
|
|
||||||
verbose_name_plural = _("Blueprint Instances")
|
|
||||||
unique_together = (
|
|
||||||
(
|
|
||||||
"name",
|
|
||||||
"path",
|
|
||||||
),
|
|
||||||
)
|
|
|
@ -1,17 +0,0 @@
|
||||||
"""blueprint Settings"""
|
|
||||||
from celery.schedules import crontab
|
|
||||||
|
|
||||||
from authentik.lib.utils.time import fqdn_rand
|
|
||||||
|
|
||||||
CELERY_BEAT_SCHEDULE = {
|
|
||||||
"blueprints_v1_discover": {
|
|
||||||
"task": "authentik.blueprints.v1.tasks.blueprints_discovery",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("blueprints_v1_discover"), hour="*"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
},
|
|
||||||
"blueprints_v1_cleanup": {
|
|
||||||
"task": "authentik.blueprints.v1.tasks.clear_failed_blueprints",
|
|
||||||
"schedule": crontab(minute=fqdn_rand("blueprints_v1_cleanup"), hour="*"),
|
|
||||||
"options": {"queue": "authentik_scheduled"},
|
|
||||||
},
|
|
||||||
}
|
|
|
@ -1,46 +0,0 @@
|
||||||
"""Blueprint helpers"""
|
|
||||||
from functools import wraps
|
|
||||||
from typing import Callable
|
|
||||||
|
|
||||||
from django.apps import apps
|
|
||||||
|
|
||||||
from authentik.blueprints.apps import ManagedAppConfig
|
|
||||||
from authentik.blueprints.models import BlueprintInstance
|
|
||||||
|
|
||||||
|
|
||||||
def apply_blueprint(*files: str):
|
|
||||||
"""Apply blueprint before test"""
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.importer import Importer
|
|
||||||
|
|
||||||
def wrapper_outer(func: Callable):
|
|
||||||
"""Apply blueprint before test"""
|
|
||||||
|
|
||||||
@wraps(func)
|
|
||||||
def wrapper(*args, **kwargs):
|
|
||||||
for file in files:
|
|
||||||
content = BlueprintInstance(path=file).retrieve()
|
|
||||||
Importer.from_string(content).apply()
|
|
||||||
return func(*args, **kwargs)
|
|
||||||
|
|
||||||
return wrapper
|
|
||||||
|
|
||||||
return wrapper_outer
|
|
||||||
|
|
||||||
|
|
||||||
def reconcile_app(app_name: str):
|
|
||||||
"""Re-reconcile AppConfig methods"""
|
|
||||||
|
|
||||||
def wrapper_outer(func: Callable):
|
|
||||||
"""Re-reconcile AppConfig methods"""
|
|
||||||
|
|
||||||
@wraps(func)
|
|
||||||
def wrapper(*args, **kwargs):
|
|
||||||
config = apps.get_app_config(app_name)
|
|
||||||
if isinstance(config, ManagedAppConfig):
|
|
||||||
config.reconcile()
|
|
||||||
return func(*args, **kwargs)
|
|
||||||
|
|
||||||
return wrapper
|
|
||||||
|
|
||||||
return wrapper_outer
|
|
|
@ -1,52 +0,0 @@
|
||||||
version: 1
|
|
||||||
metadata:
|
|
||||||
name: test conditional fields
|
|
||||||
labels:
|
|
||||||
blueprints.goauthentik.io/description: |
|
|
||||||
Some models have conditional fields that are only allowed in blueprint contexts
|
|
||||||
- Token (key)
|
|
||||||
- Application (icon)
|
|
||||||
- Source (icon)
|
|
||||||
- Flow (background)
|
|
||||||
entries:
|
|
||||||
- model: authentik_core.token
|
|
||||||
identifiers:
|
|
||||||
identifier: "%(uid)s-token"
|
|
||||||
attrs:
|
|
||||||
key: "%(uid)s"
|
|
||||||
user: "%(user)s"
|
|
||||||
intent: api
|
|
||||||
- model: authentik_core.application
|
|
||||||
identifiers:
|
|
||||||
slug: "%(uid)s-app"
|
|
||||||
attrs:
|
|
||||||
name: "%(uid)s-app"
|
|
||||||
icon: https://goauthentik.io/img/icon.png
|
|
||||||
- model: authentik_sources_oauth.oauthsource
|
|
||||||
identifiers:
|
|
||||||
slug: "%(uid)s-source"
|
|
||||||
attrs:
|
|
||||||
name: "%(uid)s-source"
|
|
||||||
provider_type: azuread
|
|
||||||
consumer_key: "%(uid)s"
|
|
||||||
consumer_secret: "%(uid)s"
|
|
||||||
icon: https://goauthentik.io/img/icon.png
|
|
||||||
- model: authentik_flows.flow
|
|
||||||
identifiers:
|
|
||||||
slug: "%(uid)s-flow"
|
|
||||||
attrs:
|
|
||||||
name: "%(uid)s-flow"
|
|
||||||
title: "%(uid)s-flow"
|
|
||||||
designation: authentication
|
|
||||||
background: https://goauthentik.io/img/icon.png
|
|
||||||
- model: authentik_core.user
|
|
||||||
identifiers:
|
|
||||||
username: "%(uid)s"
|
|
||||||
attrs:
|
|
||||||
name: "%(uid)s"
|
|
||||||
password: "%(uid)s"
|
|
||||||
- model: authentik_core.user
|
|
||||||
identifiers:
|
|
||||||
username: "%(uid)s-no-password"
|
|
||||||
attrs:
|
|
||||||
name: "%(uid)s"
|
|
|
@ -1,21 +0,0 @@
|
||||||
version: 1
|
|
||||||
entries:
|
|
||||||
- identifiers:
|
|
||||||
name: "%(id1)s"
|
|
||||||
slug: "%(id1)s"
|
|
||||||
model: authentik_flows.flow
|
|
||||||
conditions:
|
|
||||||
- true
|
|
||||||
attrs:
|
|
||||||
designation: stage_configuration
|
|
||||||
title: foo
|
|
||||||
- identifiers:
|
|
||||||
name: "%(id2)s"
|
|
||||||
slug: "%(id2)s"
|
|
||||||
model: authentik_flows.flow
|
|
||||||
conditions:
|
|
||||||
- true
|
|
||||||
- true
|
|
||||||
attrs:
|
|
||||||
designation: stage_configuration
|
|
||||||
title: foo
|
|
|
@ -1,21 +0,0 @@
|
||||||
version: 1
|
|
||||||
entries:
|
|
||||||
- identifiers:
|
|
||||||
name: "%(id1)s"
|
|
||||||
slug: "%(id1)s"
|
|
||||||
model: authentik_flows.flow
|
|
||||||
conditions:
|
|
||||||
- false
|
|
||||||
attrs:
|
|
||||||
designation: stage_configuration
|
|
||||||
title: foo
|
|
||||||
- identifiers:
|
|
||||||
name: "%(id2)s"
|
|
||||||
slug: "%(id2)s"
|
|
||||||
model: authentik_flows.flow
|
|
||||||
conditions:
|
|
||||||
- true
|
|
||||||
- false
|
|
||||||
attrs:
|
|
||||||
designation: stage_configuration
|
|
||||||
title: foo
|
|
|
@ -1,11 +0,0 @@
|
||||||
version: 1
|
|
||||||
entries:
|
|
||||||
- identifiers:
|
|
||||||
name: "%(id)s"
|
|
||||||
slug: "%(id)s"
|
|
||||||
model: authentik_flows.flow
|
|
||||||
state: absent
|
|
||||||
- identifiers:
|
|
||||||
name: "%(id)s"
|
|
||||||
model: authentik_policies_expression.expressionpolicy
|
|
||||||
state: absent
|
|
|
@ -1,10 +0,0 @@
|
||||||
version: 1
|
|
||||||
entries:
|
|
||||||
- identifiers:
|
|
||||||
name: "%(id)s"
|
|
||||||
slug: "%(id)s"
|
|
||||||
model: authentik_flows.flow
|
|
||||||
state: created
|
|
||||||
attrs:
|
|
||||||
designation: stage_configuration
|
|
||||||
title: foo
|
|
|
@ -1,10 +0,0 @@
|
||||||
version: 1
|
|
||||||
entries:
|
|
||||||
- identifiers:
|
|
||||||
name: "%(id)s"
|
|
||||||
slug: "%(id)s"
|
|
||||||
model: authentik_flows.flow
|
|
||||||
state: present
|
|
||||||
attrs:
|
|
||||||
designation: stage_configuration
|
|
||||||
title: foo
|
|
|
@ -1,13 +0,0 @@
|
||||||
version: 1
|
|
||||||
entries:
|
|
||||||
- identifiers:
|
|
||||||
pk: cb954fd4-65a5-4ad9-b1ee-180ee9559cf4
|
|
||||||
model: authentik_stages_prompt.prompt
|
|
||||||
attrs:
|
|
||||||
name: qwerweqrq
|
|
||||||
field_key: username
|
|
||||||
label: Username
|
|
||||||
type: username
|
|
||||||
required: true
|
|
||||||
placeholder: Username
|
|
||||||
order: 0
|
|
|
@ -1,155 +0,0 @@
|
||||||
version: 1
|
|
||||||
context:
|
|
||||||
foo: bar
|
|
||||||
policy_property: name
|
|
||||||
policy_property_value: foo-bar-baz-qux
|
|
||||||
sequence:
|
|
||||||
- foo
|
|
||||||
- bar
|
|
||||||
mapping:
|
|
||||||
key1: value
|
|
||||||
key2: 2
|
|
||||||
context1: context-nested-value
|
|
||||||
context2: !Context context1
|
|
||||||
entries:
|
|
||||||
- model: !Format ["%s", authentik_sources_oauth.oauthsource]
|
|
||||||
state: !Format ["%s", present]
|
|
||||||
identifiers:
|
|
||||||
slug: test
|
|
||||||
attrs:
|
|
||||||
name: test
|
|
||||||
provider_type: github
|
|
||||||
consumer_key: !Env foo
|
|
||||||
consumer_secret: !Env [bar, baz]
|
|
||||||
authentication_flow:
|
|
||||||
!Find [
|
|
||||||
authentik_flows.Flow,
|
|
||||||
[slug, default-source-authentication],
|
|
||||||
]
|
|
||||||
enrollment_flow:
|
|
||||||
!Find [!Format ["%s", authentik_flows.Flow], [slug, default-source-enrollment]]
|
|
||||||
- attrs:
|
|
||||||
expression: return True
|
|
||||||
identifiers:
|
|
||||||
name: !Format [foo-%s-%s-%s, !Context foo, !Context bar, qux]
|
|
||||||
id: policy
|
|
||||||
model: authentik_policies_expression.expressionpolicy
|
|
||||||
- attrs:
|
|
||||||
attributes:
|
|
||||||
env_null: !Env [bar-baz, null]
|
|
||||||
policy_pk1:
|
|
||||||
!Format [
|
|
||||||
"%s-%s",
|
|
||||||
!Find [
|
|
||||||
authentik_policies_expression.expressionpolicy,
|
|
||||||
[
|
|
||||||
!Context policy_property,
|
|
||||||
!Context policy_property_value,
|
|
||||||
],
|
|
||||||
[expression, return True],
|
|
||||||
],
|
|
||||||
suffix,
|
|
||||||
]
|
|
||||||
policy_pk2: !Format ["%s-%s", !KeyOf policy, suffix]
|
|
||||||
boolAnd:
|
|
||||||
!Condition [AND, !Context foo, !Format ["%s", "a_string"], 1]
|
|
||||||
boolNand:
|
|
||||||
!Condition [NAND, !Context foo, !Format ["%s", "a_string"], 1]
|
|
||||||
boolOr:
|
|
||||||
!Condition [
|
|
||||||
OR,
|
|
||||||
!Context foo,
|
|
||||||
!Format ["%s", "a_string"],
|
|
||||||
null,
|
|
||||||
]
|
|
||||||
boolNor:
|
|
||||||
!Condition [
|
|
||||||
NOR,
|
|
||||||
!Context foo,
|
|
||||||
!Format ["%s", "a_string"],
|
|
||||||
null,
|
|
||||||
]
|
|
||||||
boolXor:
|
|
||||||
!Condition [XOR, !Context foo, !Format ["%s", "a_string"], 1]
|
|
||||||
boolXnor:
|
|
||||||
!Condition [XNOR, !Context foo, !Format ["%s", "a_string"], 1]
|
|
||||||
boolComplex:
|
|
||||||
!Condition [
|
|
||||||
XNOR,
|
|
||||||
!Condition [AND, !Context non_existing],
|
|
||||||
!Condition [NOR, a string],
|
|
||||||
!Condition [XOR, null],
|
|
||||||
]
|
|
||||||
if_true_complex:
|
|
||||||
!If [
|
|
||||||
true,
|
|
||||||
{
|
|
||||||
dictionary:
|
|
||||||
{
|
|
||||||
with: { keys: "and_values" },
|
|
||||||
and_nested_custom_tags:
|
|
||||||
!Format ["foo-%s", !Context foo],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
null,
|
|
||||||
]
|
|
||||||
if_false_complex:
|
|
||||||
!If [
|
|
||||||
!Condition [AND, false],
|
|
||||||
null,
|
|
||||||
[list, with, items, !Format ["foo-%s", !Context foo]],
|
|
||||||
]
|
|
||||||
if_true_simple: !If [!Context foo, true, text]
|
|
||||||
if_short: !If [!Context foo]
|
|
||||||
if_false_simple: !If [null, false, 2]
|
|
||||||
enumerate_mapping_to_mapping: !Enumerate [
|
|
||||||
!Context mapping,
|
|
||||||
MAP,
|
|
||||||
[!Format ["prefix-%s", !Index 0], !Format ["other-prefix-%s", !Value 0]]
|
|
||||||
]
|
|
||||||
enumerate_mapping_to_sequence: !Enumerate [
|
|
||||||
!Context mapping,
|
|
||||||
SEQ,
|
|
||||||
!Format ["prefixed-pair-%s-%s", !Index 0, !Value 0]
|
|
||||||
]
|
|
||||||
enumerate_sequence_to_sequence: !Enumerate [
|
|
||||||
!Context sequence,
|
|
||||||
SEQ,
|
|
||||||
!Format ["prefixed-items-%s-%s", !Index 0, !Value 0]
|
|
||||||
]
|
|
||||||
enumerate_sequence_to_mapping: !Enumerate [
|
|
||||||
!Context sequence,
|
|
||||||
MAP,
|
|
||||||
[!Format ["index: %d", !Index 0], !Value 0]
|
|
||||||
]
|
|
||||||
nested_complex_enumeration: !Enumerate [
|
|
||||||
!Context sequence,
|
|
||||||
MAP,
|
|
||||||
[
|
|
||||||
!Index 0,
|
|
||||||
!Enumerate [
|
|
||||||
!Context mapping,
|
|
||||||
MAP,
|
|
||||||
[
|
|
||||||
!Format ["%s", !Index 0],
|
|
||||||
[
|
|
||||||
!Enumerate [!Value 2, SEQ, !Format ["prefixed-%s", !Value 0]],
|
|
||||||
{
|
|
||||||
outer_value: !Value 1,
|
|
||||||
outer_index: !Index 1,
|
|
||||||
middle_value: !Value 0,
|
|
||||||
middle_index: !Index 0
|
|
||||||
}
|
|
||||||
]
|
|
||||||
]
|
|
||||||
]
|
|
||||||
]
|
|
||||||
]
|
|
||||||
nested_context: !Context context2
|
|
||||||
identifiers:
|
|
||||||
name: test
|
|
||||||
conditions:
|
|
||||||
- !Condition [AND, true, true, text]
|
|
||||||
- true
|
|
||||||
- text
|
|
||||||
model: authentik_core.group
|
|
|
@ -1,15 +0,0 @@
|
||||||
"""authentik managed models tests"""
|
|
||||||
from django.test import TestCase
|
|
||||||
|
|
||||||
from authentik.blueprints.models import BlueprintInstance, BlueprintRetrievalFailed
|
|
||||||
from authentik.lib.generators import generate_id
|
|
||||||
|
|
||||||
|
|
||||||
class TestModels(TestCase):
|
|
||||||
"""Test Models"""
|
|
||||||
|
|
||||||
def test_retrieve_file(self):
|
|
||||||
"""Test retrieve_file"""
|
|
||||||
instance = BlueprintInstance.objects.create(name=generate_id(), path="../etc/hosts")
|
|
||||||
with self.assertRaises(BlueprintRetrievalFailed):
|
|
||||||
instance.retrieve()
|
|
|
@ -1,121 +0,0 @@
|
||||||
"""Test blueprints OCI"""
|
|
||||||
from django.test import TransactionTestCase
|
|
||||||
from requests_mock import Mocker
|
|
||||||
|
|
||||||
from authentik.blueprints.models import BlueprintInstance, BlueprintRetrievalFailed
|
|
||||||
from authentik.blueprints.v1.oci import OCI_MEDIA_TYPE
|
|
||||||
|
|
||||||
|
|
||||||
class TestBlueprintOCI(TransactionTestCase):
|
|
||||||
"""Test Blueprints OCI Tasks"""
|
|
||||||
|
|
||||||
def test_successful(self):
|
|
||||||
"""Successful retrieval"""
|
|
||||||
with Mocker() as mocker:
|
|
||||||
mocker.get(
|
|
||||||
"https://ghcr.io/v2/goauthentik/blueprints/test/manifests/latest",
|
|
||||||
json={
|
|
||||||
"layers": [
|
|
||||||
{
|
|
||||||
"mediaType": OCI_MEDIA_TYPE,
|
|
||||||
"digest": "foo",
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
)
|
|
||||||
mocker.get("https://ghcr.io/v2/goauthentik/blueprints/test/blobs/foo", text="foo")
|
|
||||||
|
|
||||||
self.assertEqual(
|
|
||||||
BlueprintInstance(
|
|
||||||
path="oci://ghcr.io/goauthentik/blueprints/test:latest"
|
|
||||||
).retrieve(),
|
|
||||||
"foo",
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_successful_port(self):
|
|
||||||
"""Successful retrieval with custom port"""
|
|
||||||
with Mocker() as mocker:
|
|
||||||
mocker.get(
|
|
||||||
"https://ghcr.io:1234/v2/goauthentik/blueprints/test/manifests/latest",
|
|
||||||
json={
|
|
||||||
"layers": [
|
|
||||||
{
|
|
||||||
"mediaType": OCI_MEDIA_TYPE,
|
|
||||||
"digest": "foo",
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
)
|
|
||||||
mocker.get("https://ghcr.io:1234/v2/goauthentik/blueprints/test/blobs/foo", text="foo")
|
|
||||||
|
|
||||||
self.assertEqual(
|
|
||||||
BlueprintInstance(
|
|
||||||
path="oci://ghcr.io:1234/goauthentik/blueprints/test:latest"
|
|
||||||
).retrieve(),
|
|
||||||
"foo",
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_manifests_error(self):
|
|
||||||
"""Test manifests request erroring"""
|
|
||||||
with Mocker() as mocker:
|
|
||||||
mocker.get(
|
|
||||||
"https://ghcr.io/v2/goauthentik/blueprints/test/manifests/latest", status_code=401
|
|
||||||
)
|
|
||||||
|
|
||||||
with self.assertRaises(BlueprintRetrievalFailed):
|
|
||||||
BlueprintInstance(
|
|
||||||
path="oci://ghcr.io/goauthentik/blueprints/test:latest"
|
|
||||||
).retrieve_oci()
|
|
||||||
|
|
||||||
def test_manifests_error_response(self):
|
|
||||||
"""Test manifests request erroring"""
|
|
||||||
with Mocker() as mocker:
|
|
||||||
mocker.get(
|
|
||||||
"https://ghcr.io/v2/goauthentik/blueprints/test/manifests/latest",
|
|
||||||
json={"errors": ["foo"]},
|
|
||||||
)
|
|
||||||
|
|
||||||
with self.assertRaises(BlueprintRetrievalFailed):
|
|
||||||
BlueprintInstance(
|
|
||||||
path="oci://ghcr.io/goauthentik/blueprints/test:latest"
|
|
||||||
).retrieve_oci()
|
|
||||||
|
|
||||||
def test_no_matching_blob(self):
|
|
||||||
"""Successful retrieval"""
|
|
||||||
with Mocker() as mocker:
|
|
||||||
mocker.get(
|
|
||||||
"https://ghcr.io/v2/goauthentik/blueprints/test/manifests/latest",
|
|
||||||
json={
|
|
||||||
"layers": [
|
|
||||||
{
|
|
||||||
"mediaType": OCI_MEDIA_TYPE + "foo",
|
|
||||||
"digest": "foo",
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
)
|
|
||||||
with self.assertRaises(BlueprintRetrievalFailed):
|
|
||||||
BlueprintInstance(
|
|
||||||
path="oci://ghcr.io/goauthentik/blueprints/test:latest"
|
|
||||||
).retrieve_oci()
|
|
||||||
|
|
||||||
def test_blob_error(self):
|
|
||||||
"""Successful retrieval"""
|
|
||||||
with Mocker() as mocker:
|
|
||||||
mocker.get(
|
|
||||||
"https://ghcr.io/v2/goauthentik/blueprints/test/manifests/latest",
|
|
||||||
json={
|
|
||||||
"layers": [
|
|
||||||
{
|
|
||||||
"mediaType": OCI_MEDIA_TYPE,
|
|
||||||
"digest": "foo",
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
)
|
|
||||||
mocker.get("https://ghcr.io/v2/goauthentik/blueprints/test/blobs/foo", status_code=401)
|
|
||||||
|
|
||||||
with self.assertRaises(BlueprintRetrievalFailed):
|
|
||||||
BlueprintInstance(
|
|
||||||
path="oci://ghcr.io/goauthentik/blueprints/test:latest"
|
|
||||||
).retrieve_oci()
|
|
|
@ -1,38 +0,0 @@
|
||||||
"""test packaged blueprints"""
|
|
||||||
from pathlib import Path
|
|
||||||
from typing import Callable
|
|
||||||
|
|
||||||
from django.test import TransactionTestCase
|
|
||||||
|
|
||||||
from authentik.blueprints.models import BlueprintInstance
|
|
||||||
from authentik.blueprints.tests import apply_blueprint
|
|
||||||
from authentik.blueprints.v1.importer import Importer
|
|
||||||
from authentik.tenants.models import Tenant
|
|
||||||
|
|
||||||
|
|
||||||
class TestPackaged(TransactionTestCase):
|
|
||||||
"""Empty class, test methods are added dynamically"""
|
|
||||||
|
|
||||||
@apply_blueprint("default/default-tenant.yaml")
|
|
||||||
def test_decorator_static(self):
|
|
||||||
"""Test @apply_blueprint decorator"""
|
|
||||||
self.assertTrue(Tenant.objects.filter(domain="authentik-default").exists())
|
|
||||||
|
|
||||||
|
|
||||||
def blueprint_tester(file_name: Path) -> Callable:
|
|
||||||
"""This is used instead of subTest for better visibility"""
|
|
||||||
|
|
||||||
def tester(self: TestPackaged):
|
|
||||||
base = Path("blueprints/")
|
|
||||||
rel_path = Path(file_name).relative_to(base)
|
|
||||||
importer = Importer.from_string(BlueprintInstance(path=str(rel_path)).retrieve())
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
|
|
||||||
return tester
|
|
||||||
|
|
||||||
|
|
||||||
for blueprint_file in Path("blueprints/").glob("**/*.yaml"):
|
|
||||||
if "local" in str(blueprint_file):
|
|
||||||
continue
|
|
||||||
setattr(TestPackaged, f"test_blueprint_{blueprint_file}", blueprint_tester(blueprint_file))
|
|
|
@ -1,38 +0,0 @@
|
||||||
"""authentik managed models tests"""
|
|
||||||
from typing import Callable, Type
|
|
||||||
|
|
||||||
from django.apps import apps
|
|
||||||
from django.test import TestCase
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.importer import is_model_allowed
|
|
||||||
from authentik.lib.models import SerializerModel
|
|
||||||
from authentik.providers.oauth2.models import RefreshToken
|
|
||||||
|
|
||||||
|
|
||||||
class TestModels(TestCase):
|
|
||||||
"""Test Models"""
|
|
||||||
|
|
||||||
|
|
||||||
def serializer_tester_factory(test_model: Type[SerializerModel]) -> Callable:
|
|
||||||
"""Test serializer"""
|
|
||||||
|
|
||||||
def tester(self: TestModels):
|
|
||||||
if test_model._meta.abstract: # pragma: no cover
|
|
||||||
return
|
|
||||||
model_class = test_model()
|
|
||||||
self.assertTrue(isinstance(model_class, SerializerModel))
|
|
||||||
self.assertIsNotNone(model_class.serializer)
|
|
||||||
if model_class.serializer.Meta().model == RefreshToken:
|
|
||||||
return
|
|
||||||
self.assertEqual(model_class.serializer.Meta().model, test_model)
|
|
||||||
|
|
||||||
return tester
|
|
||||||
|
|
||||||
|
|
||||||
for app in apps.get_app_configs():
|
|
||||||
if not app.label.startswith("authentik"):
|
|
||||||
continue
|
|
||||||
for model in app.get_models():
|
|
||||||
if not is_model_allowed(model):
|
|
||||||
continue
|
|
||||||
setattr(TestModels, f"test_{app.label}_{model.__name__}", serializer_tester_factory(model))
|
|
|
@ -1,303 +0,0 @@
|
||||||
"""Test blueprints v1"""
|
|
||||||
from os import environ
|
|
||||||
|
|
||||||
from django.test import TransactionTestCase
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.exporter import FlowExporter
|
|
||||||
from authentik.blueprints.v1.importer import Importer, transaction_rollback
|
|
||||||
from authentik.core.models import Group
|
|
||||||
from authentik.flows.models import Flow, FlowDesignation, FlowStageBinding
|
|
||||||
from authentik.lib.generators import generate_id
|
|
||||||
from authentik.lib.tests.utils import load_fixture
|
|
||||||
from authentik.policies.expression.models import ExpressionPolicy
|
|
||||||
from authentik.policies.models import PolicyBinding
|
|
||||||
from authentik.sources.oauth.models import OAuthSource
|
|
||||||
from authentik.stages.prompt.models import FieldTypes, Prompt, PromptStage
|
|
||||||
from authentik.stages.user_login.models import UserLoginStage
|
|
||||||
|
|
||||||
|
|
||||||
class TestBlueprintsV1(TransactionTestCase):
|
|
||||||
"""Test Blueprints"""
|
|
||||||
|
|
||||||
def test_blueprint_invalid_format(self):
|
|
||||||
"""Test blueprint with invalid format"""
|
|
||||||
importer = Importer.from_string('{"version": 3}')
|
|
||||||
self.assertFalse(importer.validate()[0])
|
|
||||||
importer = Importer.from_string(
|
|
||||||
'{"version": 1,"entries":[{"identifiers":{},"attrs":{},'
|
|
||||||
'"model": "authentik_core.User"}]}'
|
|
||||||
)
|
|
||||||
self.assertFalse(importer.validate()[0])
|
|
||||||
importer = Importer.from_string(
|
|
||||||
'{"version": 1, "entries": [{"attrs": {"name": "test"}, '
|
|
||||||
'"identifiers": {}, '
|
|
||||||
'"model": "authentik_core.Group"}]}'
|
|
||||||
)
|
|
||||||
self.assertFalse(importer.validate()[0])
|
|
||||||
|
|
||||||
def test_validated_import_dict_identifiers(self):
|
|
||||||
"""Test importing blueprints with dict identifiers."""
|
|
||||||
Group.objects.filter(name__istartswith="test").delete()
|
|
||||||
|
|
||||||
Group.objects.create(
|
|
||||||
name="test1",
|
|
||||||
attributes={
|
|
||||||
"key": ["value"],
|
|
||||||
"other_key": ["a_value", "other_value"],
|
|
||||||
},
|
|
||||||
)
|
|
||||||
Group.objects.create(
|
|
||||||
name="test2",
|
|
||||||
attributes={
|
|
||||||
"key": ["value"],
|
|
||||||
"other_key": ["diff_value", "other_diff_value"],
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
importer = Importer.from_string(
|
|
||||||
'{"version": 1, "entries": [{"attrs": {"name": "test999", "attributes": '
|
|
||||||
'{"key": ["updated_value"]}}, "identifiers": {"attributes": {"other_key": '
|
|
||||||
'["other_value"]}}, "model": "authentik_core.Group"}]}'
|
|
||||||
)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
self.assertTrue(
|
|
||||||
Group.objects.filter(
|
|
||||||
name="test2",
|
|
||||||
attributes={
|
|
||||||
"key": ["value"],
|
|
||||||
"other_key": ["diff_value", "other_diff_value"],
|
|
||||||
},
|
|
||||||
)
|
|
||||||
)
|
|
||||||
self.assertTrue(
|
|
||||||
Group.objects.filter(
|
|
||||||
name="test999",
|
|
||||||
# All attributes used as identifiers are kept and merged with the
|
|
||||||
# new attributes declared in the blueprint
|
|
||||||
attributes={"key": ["updated_value"], "other_key": ["other_value"]},
|
|
||||||
)
|
|
||||||
)
|
|
||||||
self.assertFalse(Group.objects.filter(name="test1"))
|
|
||||||
|
|
||||||
def test_export_validate_import(self):
|
|
||||||
"""Test export and validate it"""
|
|
||||||
flow_slug = generate_id()
|
|
||||||
with transaction_rollback():
|
|
||||||
login_stage = UserLoginStage.objects.create(name=generate_id())
|
|
||||||
|
|
||||||
flow = Flow.objects.create(
|
|
||||||
slug=flow_slug,
|
|
||||||
designation=FlowDesignation.AUTHENTICATION,
|
|
||||||
name=generate_id(),
|
|
||||||
title=generate_id(),
|
|
||||||
)
|
|
||||||
FlowStageBinding.objects.update_or_create(
|
|
||||||
target=flow,
|
|
||||||
stage=login_stage,
|
|
||||||
order=0,
|
|
||||||
)
|
|
||||||
|
|
||||||
exporter = FlowExporter(flow)
|
|
||||||
export = exporter.export()
|
|
||||||
self.assertEqual(len(export.entries), 3)
|
|
||||||
export_yaml = exporter.export_to_string()
|
|
||||||
|
|
||||||
importer = Importer.from_string(export_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
|
|
||||||
self.assertTrue(Flow.objects.filter(slug=flow_slug).exists())
|
|
||||||
|
|
||||||
def test_export_validate_import_re_import(self):
|
|
||||||
"""Test export and import it twice"""
|
|
||||||
count_initial = Prompt.objects.filter(field_key="username").count()
|
|
||||||
|
|
||||||
importer = Importer.from_string(load_fixture("fixtures/static_prompt_export.yaml"))
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
|
|
||||||
count_before = Prompt.objects.filter(field_key="username").count()
|
|
||||||
self.assertEqual(count_initial + 1, count_before)
|
|
||||||
|
|
||||||
importer = Importer.from_string(load_fixture("fixtures/static_prompt_export.yaml"))
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
|
|
||||||
self.assertEqual(Prompt.objects.filter(field_key="username").count(), count_before)
|
|
||||||
|
|
||||||
def test_import_yaml_tags(self):
|
|
||||||
"""Test some yaml tags"""
|
|
||||||
ExpressionPolicy.objects.filter(name="foo-bar-baz-qux").delete()
|
|
||||||
Group.objects.filter(name="test").delete()
|
|
||||||
environ["foo"] = generate_id()
|
|
||||||
importer = Importer.from_string(load_fixture("fixtures/tags.yaml"), {"bar": "baz"})
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
policy = ExpressionPolicy.objects.filter(name="foo-bar-baz-qux").first()
|
|
||||||
self.assertTrue(policy)
|
|
||||||
self.assertTrue(
|
|
||||||
Group.objects.filter(
|
|
||||||
attributes={
|
|
||||||
"policy_pk1": str(policy.pk) + "-suffix",
|
|
||||||
"policy_pk2": str(policy.pk) + "-suffix",
|
|
||||||
"boolAnd": True,
|
|
||||||
"boolNand": False,
|
|
||||||
"boolOr": True,
|
|
||||||
"boolNor": False,
|
|
||||||
"boolXor": True,
|
|
||||||
"boolXnor": False,
|
|
||||||
"boolComplex": True,
|
|
||||||
"if_true_complex": {
|
|
||||||
"dictionary": {
|
|
||||||
"with": {"keys": "and_values"},
|
|
||||||
"and_nested_custom_tags": "foo-bar",
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"if_false_complex": ["list", "with", "items", "foo-bar"],
|
|
||||||
"if_true_simple": True,
|
|
||||||
"if_short": True,
|
|
||||||
"if_false_simple": 2,
|
|
||||||
"enumerate_mapping_to_mapping": {
|
|
||||||
"prefix-key1": "other-prefix-value",
|
|
||||||
"prefix-key2": "other-prefix-2",
|
|
||||||
},
|
|
||||||
"enumerate_mapping_to_sequence": [
|
|
||||||
"prefixed-pair-key1-value",
|
|
||||||
"prefixed-pair-key2-2",
|
|
||||||
],
|
|
||||||
"enumerate_sequence_to_sequence": [
|
|
||||||
"prefixed-items-0-foo",
|
|
||||||
"prefixed-items-1-bar",
|
|
||||||
],
|
|
||||||
"enumerate_sequence_to_mapping": {"index: 0": "foo", "index: 1": "bar"},
|
|
||||||
"nested_complex_enumeration": {
|
|
||||||
"0": {
|
|
||||||
"key1": [
|
|
||||||
["prefixed-f", "prefixed-o", "prefixed-o"],
|
|
||||||
{
|
|
||||||
"outer_value": "foo",
|
|
||||||
"outer_index": 0,
|
|
||||||
"middle_value": "value",
|
|
||||||
"middle_index": "key1",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
"key2": [
|
|
||||||
["prefixed-f", "prefixed-o", "prefixed-o"],
|
|
||||||
{
|
|
||||||
"outer_value": "foo",
|
|
||||||
"outer_index": 0,
|
|
||||||
"middle_value": 2,
|
|
||||||
"middle_index": "key2",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
"1": {
|
|
||||||
"key1": [
|
|
||||||
["prefixed-b", "prefixed-a", "prefixed-r"],
|
|
||||||
{
|
|
||||||
"outer_value": "bar",
|
|
||||||
"outer_index": 1,
|
|
||||||
"middle_value": "value",
|
|
||||||
"middle_index": "key1",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
"key2": [
|
|
||||||
["prefixed-b", "prefixed-a", "prefixed-r"],
|
|
||||||
{
|
|
||||||
"outer_value": "bar",
|
|
||||||
"outer_index": 1,
|
|
||||||
"middle_value": 2,
|
|
||||||
"middle_index": "key2",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
"nested_context": "context-nested-value",
|
|
||||||
"env_null": None,
|
|
||||||
}
|
|
||||||
).exists()
|
|
||||||
)
|
|
||||||
self.assertTrue(
|
|
||||||
OAuthSource.objects.filter(
|
|
||||||
slug="test",
|
|
||||||
consumer_key=environ["foo"],
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_export_validate_import_policies(self):
|
|
||||||
"""Test export and validate it"""
|
|
||||||
flow_slug = generate_id()
|
|
||||||
stage_name = generate_id()
|
|
||||||
with transaction_rollback():
|
|
||||||
flow_policy = ExpressionPolicy.objects.create(
|
|
||||||
name=generate_id(),
|
|
||||||
expression="return True",
|
|
||||||
)
|
|
||||||
flow = Flow.objects.create(
|
|
||||||
slug=flow_slug,
|
|
||||||
designation=FlowDesignation.AUTHENTICATION,
|
|
||||||
name=generate_id(),
|
|
||||||
title=generate_id(),
|
|
||||||
)
|
|
||||||
PolicyBinding.objects.create(policy=flow_policy, target=flow, order=0)
|
|
||||||
|
|
||||||
user_login = UserLoginStage.objects.create(name=stage_name)
|
|
||||||
fsb = FlowStageBinding.objects.create(target=flow, stage=user_login, order=0)
|
|
||||||
PolicyBinding.objects.create(policy=flow_policy, target=fsb, order=0)
|
|
||||||
|
|
||||||
exporter = FlowExporter(flow)
|
|
||||||
export_yaml = exporter.export_to_string()
|
|
||||||
|
|
||||||
importer = Importer.from_string(export_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
self.assertTrue(UserLoginStage.objects.filter(name=stage_name).exists())
|
|
||||||
self.assertTrue(Flow.objects.filter(slug=flow_slug).exists())
|
|
||||||
|
|
||||||
def test_export_validate_import_prompt(self):
|
|
||||||
"""Test export and validate it"""
|
|
||||||
with transaction_rollback():
|
|
||||||
# First stage fields
|
|
||||||
username_prompt = Prompt.objects.create(
|
|
||||||
name=generate_id(),
|
|
||||||
field_key="username",
|
|
||||||
label="Username",
|
|
||||||
order=0,
|
|
||||||
type=FieldTypes.TEXT,
|
|
||||||
)
|
|
||||||
password = Prompt.objects.create(
|
|
||||||
name=generate_id(),
|
|
||||||
field_key="password",
|
|
||||||
label="Password",
|
|
||||||
order=1,
|
|
||||||
type=FieldTypes.PASSWORD,
|
|
||||||
)
|
|
||||||
password_repeat = Prompt.objects.create(
|
|
||||||
name=generate_id(),
|
|
||||||
field_key="password_repeat",
|
|
||||||
label="Password (repeat)",
|
|
||||||
order=2,
|
|
||||||
type=FieldTypes.PASSWORD,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Stages
|
|
||||||
first_stage = PromptStage.objects.create(name=generate_id())
|
|
||||||
first_stage.fields.set([username_prompt, password, password_repeat])
|
|
||||||
first_stage.save()
|
|
||||||
|
|
||||||
flow = Flow.objects.create(
|
|
||||||
name=generate_id(),
|
|
||||||
slug=generate_id(),
|
|
||||||
designation=FlowDesignation.ENROLLMENT,
|
|
||||||
title=generate_id(),
|
|
||||||
)
|
|
||||||
|
|
||||||
FlowStageBinding.objects.create(target=flow, stage=first_stage, order=0)
|
|
||||||
|
|
||||||
exporter = FlowExporter(flow)
|
|
||||||
export_yaml = exporter.export_to_string()
|
|
||||||
|
|
||||||
importer = Importer.from_string(export_yaml)
|
|
||||||
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
|
@ -1,81 +0,0 @@
|
||||||
"""Test blueprints v1 api"""
|
|
||||||
from json import loads
|
|
||||||
from tempfile import NamedTemporaryFile, mkdtemp
|
|
||||||
|
|
||||||
from django.urls import reverse
|
|
||||||
from rest_framework.test import APITestCase
|
|
||||||
from yaml import dump
|
|
||||||
|
|
||||||
from authentik.core.tests.utils import create_test_admin_user
|
|
||||||
from authentik.lib.config import CONFIG
|
|
||||||
|
|
||||||
TMP = mkdtemp("authentik-blueprints")
|
|
||||||
|
|
||||||
|
|
||||||
class TestBlueprintsV1API(APITestCase):
|
|
||||||
"""Test Blueprints API"""
|
|
||||||
|
|
||||||
def setUp(self) -> None:
|
|
||||||
self.user = create_test_admin_user()
|
|
||||||
self.client.force_login(self.user)
|
|
||||||
|
|
||||||
@CONFIG.patch("blueprints_dir", TMP)
|
|
||||||
def test_api_available(self):
|
|
||||||
"""Test valid file"""
|
|
||||||
with NamedTemporaryFile(mode="w+", suffix=".yaml", dir=TMP) as file:
|
|
||||||
file.write(
|
|
||||||
dump(
|
|
||||||
{
|
|
||||||
"version": 1,
|
|
||||||
"entries": [],
|
|
||||||
}
|
|
||||||
)
|
|
||||||
)
|
|
||||||
file.flush()
|
|
||||||
res = self.client.get(reverse("authentik_api:blueprintinstance-available"))
|
|
||||||
self.assertEqual(res.status_code, 200)
|
|
||||||
response = loads(res.content.decode())
|
|
||||||
self.assertEqual(len(response), 1)
|
|
||||||
self.assertEqual(
|
|
||||||
response[0]["hash"],
|
|
||||||
(
|
|
||||||
"e52bb445b03cd36057258dc9f0ce0fbed8278498ee1470e45315293e5f026d1bd1f9b352"
|
|
||||||
"6871c0003f5c07be5c3316d9d4a08444bd8fed1b3f03294e51e44522"
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_api_oci(self):
|
|
||||||
"""Test validation with OCI path"""
|
|
||||||
res = self.client.post(
|
|
||||||
reverse("authentik_api:blueprintinstance-list"),
|
|
||||||
data={"name": "foo", "path": "oci://foo/bar"},
|
|
||||||
)
|
|
||||||
self.assertEqual(res.status_code, 201)
|
|
||||||
|
|
||||||
def test_api_blank(self):
|
|
||||||
"""Test blank"""
|
|
||||||
res = self.client.post(
|
|
||||||
reverse("authentik_api:blueprintinstance-list"),
|
|
||||||
data={
|
|
||||||
"name": "foo",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
self.assertEqual(res.status_code, 400)
|
|
||||||
self.assertJSONEqual(
|
|
||||||
res.content.decode(), {"non_field_errors": ["Either path or content must be set."]}
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_api_content(self):
|
|
||||||
"""Test blank"""
|
|
||||||
res = self.client.post(
|
|
||||||
reverse("authentik_api:blueprintinstance-list"),
|
|
||||||
data={
|
|
||||||
"name": "foo",
|
|
||||||
"content": '{"version": 3}',
|
|
||||||
},
|
|
||||||
)
|
|
||||||
self.assertEqual(res.status_code, 400)
|
|
||||||
self.assertJSONEqual(
|
|
||||||
res.content.decode(),
|
|
||||||
{"content": ["Failed to validate blueprint: Invalid blueprint version"]},
|
|
||||||
)
|
|
|
@ -1,59 +0,0 @@
|
||||||
"""Test blueprints v1"""
|
|
||||||
from django.test import TransactionTestCase
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.importer import Importer
|
|
||||||
from authentik.core.models import Application, Token, User
|
|
||||||
from authentik.core.tests.utils import create_test_admin_user
|
|
||||||
from authentik.flows.models import Flow
|
|
||||||
from authentik.lib.generators import generate_id
|
|
||||||
from authentik.lib.tests.utils import load_fixture
|
|
||||||
from authentik.sources.oauth.models import OAuthSource
|
|
||||||
|
|
||||||
|
|
||||||
class TestBlueprintsV1ConditionalFields(TransactionTestCase):
|
|
||||||
"""Test Blueprints conditional fields"""
|
|
||||||
|
|
||||||
def setUp(self) -> None:
|
|
||||||
user = create_test_admin_user()
|
|
||||||
self.uid = generate_id()
|
|
||||||
import_yaml = load_fixture("fixtures/conditional_fields.yaml", uid=self.uid, user=user.pk)
|
|
||||||
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
|
|
||||||
def test_token(self):
|
|
||||||
"""Test token"""
|
|
||||||
token = Token.objects.filter(identifier=f"{self.uid}-token").first()
|
|
||||||
self.assertIsNotNone(token)
|
|
||||||
self.assertEqual(token.key, self.uid)
|
|
||||||
|
|
||||||
def test_application(self):
|
|
||||||
"""Test application"""
|
|
||||||
app = Application.objects.filter(slug=f"{self.uid}-app").first()
|
|
||||||
self.assertIsNotNone(app)
|
|
||||||
self.assertEqual(app.meta_icon, "https://goauthentik.io/img/icon.png")
|
|
||||||
|
|
||||||
def test_source(self):
|
|
||||||
"""Test source"""
|
|
||||||
source = OAuthSource.objects.filter(slug=f"{self.uid}-source").first()
|
|
||||||
self.assertIsNotNone(source)
|
|
||||||
self.assertEqual(source.icon, "https://goauthentik.io/img/icon.png")
|
|
||||||
|
|
||||||
def test_flow(self):
|
|
||||||
"""Test flow"""
|
|
||||||
flow = Flow.objects.filter(slug=f"{self.uid}-flow").first()
|
|
||||||
self.assertIsNotNone(flow)
|
|
||||||
self.assertEqual(flow.background, "https://goauthentik.io/img/icon.png")
|
|
||||||
|
|
||||||
def test_user(self):
|
|
||||||
"""Test user"""
|
|
||||||
user: User = User.objects.filter(username=self.uid).first()
|
|
||||||
self.assertIsNotNone(user)
|
|
||||||
self.assertTrue(user.check_password(self.uid))
|
|
||||||
|
|
||||||
def test_user_null(self):
|
|
||||||
"""Test user"""
|
|
||||||
user: User = User.objects.filter(username=f"{self.uid}-no-password").first()
|
|
||||||
self.assertIsNotNone(user)
|
|
||||||
self.assertFalse(user.has_usable_password())
|
|
|
@ -1,43 +0,0 @@
|
||||||
"""Test blueprints v1"""
|
|
||||||
from django.test import TransactionTestCase
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.importer import Importer
|
|
||||||
from authentik.flows.models import Flow
|
|
||||||
from authentik.lib.generators import generate_id
|
|
||||||
from authentik.lib.tests.utils import load_fixture
|
|
||||||
|
|
||||||
|
|
||||||
class TestBlueprintsV1Conditions(TransactionTestCase):
|
|
||||||
"""Test Blueprints conditions attribute"""
|
|
||||||
|
|
||||||
def test_conditions_fulfilled(self):
|
|
||||||
"""Test conditions fulfilled"""
|
|
||||||
flow_slug1 = generate_id()
|
|
||||||
flow_slug2 = generate_id()
|
|
||||||
import_yaml = load_fixture(
|
|
||||||
"fixtures/conditions_fulfilled.yaml", id1=flow_slug1, id2=flow_slug2
|
|
||||||
)
|
|
||||||
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
# Ensure objects exist
|
|
||||||
flow: Flow = Flow.objects.filter(slug=flow_slug1).first()
|
|
||||||
self.assertEqual(flow.slug, flow_slug1)
|
|
||||||
flow: Flow = Flow.objects.filter(slug=flow_slug2).first()
|
|
||||||
self.assertEqual(flow.slug, flow_slug2)
|
|
||||||
|
|
||||||
def test_conditions_not_fulfilled(self):
|
|
||||||
"""Test conditions not fulfilled"""
|
|
||||||
flow_slug1 = generate_id()
|
|
||||||
flow_slug2 = generate_id()
|
|
||||||
import_yaml = load_fixture(
|
|
||||||
"fixtures/conditions_not_fulfilled.yaml", id1=flow_slug1, id2=flow_slug2
|
|
||||||
)
|
|
||||||
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
# Ensure objects do not exist
|
|
||||||
self.assertFalse(Flow.objects.filter(slug=flow_slug1))
|
|
||||||
self.assertFalse(Flow.objects.filter(slug=flow_slug2))
|
|
|
@ -1,82 +0,0 @@
|
||||||
"""Test blueprints v1"""
|
|
||||||
from django.test import TransactionTestCase
|
|
||||||
|
|
||||||
from authentik.blueprints.v1.importer import Importer
|
|
||||||
from authentik.flows.models import Flow
|
|
||||||
from authentik.lib.generators import generate_id
|
|
||||||
from authentik.lib.tests.utils import load_fixture
|
|
||||||
|
|
||||||
|
|
||||||
class TestBlueprintsV1State(TransactionTestCase):
|
|
||||||
"""Test Blueprints state attribute"""
|
|
||||||
|
|
||||||
def test_state_present(self):
|
|
||||||
"""Test state present"""
|
|
||||||
flow_slug = generate_id()
|
|
||||||
import_yaml = load_fixture("fixtures/state_present.yaml", id=flow_slug)
|
|
||||||
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
# Ensure object exists
|
|
||||||
flow: Flow = Flow.objects.filter(slug=flow_slug).first()
|
|
||||||
self.assertEqual(flow.slug, flow_slug)
|
|
||||||
|
|
||||||
# Update object
|
|
||||||
flow.title = "bar"
|
|
||||||
flow.save()
|
|
||||||
|
|
||||||
flow.refresh_from_db()
|
|
||||||
self.assertEqual(flow.title, "bar")
|
|
||||||
|
|
||||||
# Ensure importer updates it
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
flow: Flow = Flow.objects.filter(slug=flow_slug).first()
|
|
||||||
self.assertEqual(flow.title, "foo")
|
|
||||||
|
|
||||||
def test_state_created(self):
|
|
||||||
"""Test state created"""
|
|
||||||
flow_slug = generate_id()
|
|
||||||
import_yaml = load_fixture("fixtures/state_created.yaml", id=flow_slug)
|
|
||||||
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
# Ensure object exists
|
|
||||||
flow: Flow = Flow.objects.filter(slug=flow_slug).first()
|
|
||||||
self.assertEqual(flow.slug, flow_slug)
|
|
||||||
|
|
||||||
# Update object
|
|
||||||
flow.title = "bar"
|
|
||||||
flow.save()
|
|
||||||
|
|
||||||
flow.refresh_from_db()
|
|
||||||
self.assertEqual(flow.title, "bar")
|
|
||||||
|
|
||||||
# Ensure importer doesn't update it
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
flow: Flow = Flow.objects.filter(slug=flow_slug).first()
|
|
||||||
self.assertEqual(flow.title, "bar")
|
|
||||||
|
|
||||||
def test_state_absent(self):
|
|
||||||
"""Test state absent"""
|
|
||||||
flow_slug = generate_id()
|
|
||||||
import_yaml = load_fixture("fixtures/state_created.yaml", id=flow_slug)
|
|
||||||
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
# Ensure object exists
|
|
||||||
flow: Flow = Flow.objects.filter(slug=flow_slug).first()
|
|
||||||
self.assertEqual(flow.slug, flow_slug)
|
|
||||||
|
|
||||||
import_yaml = load_fixture("fixtures/state_absent.yaml", id=flow_slug)
|
|
||||||
importer = Importer.from_string(import_yaml)
|
|
||||||
self.assertTrue(importer.validate()[0])
|
|
||||||
self.assertTrue(importer.apply())
|
|
||||||
flow: Flow = Flow.objects.filter(slug=flow_slug).first()
|
|
||||||
self.assertIsNone(flow)
|
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue