Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update and enhance oidc documentation #2142

Merged
merged 31 commits into from
Jul 14, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
a5b5339
update and enhance OIDC documentation
georglauterbach Jul 2, 2021
d19d70b
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 2, 2021
a97d065
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 2, 2021
9c71384
Merge remote-tracking branch 'origin/update-oidc-docs' into update-oi…
georglauterbach Jul 2, 2021
23580da
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 3, 2021
1694d8b
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 5, 2021
4a70cde
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 5, 2021
fffca37
updateddocs according to @clems4ever's suggestions
georglauterbach Jul 5, 2021
109dcfe
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 5, 2021
4b27c4b
add `tr` command in pipe to remove newline which could cause confusion
georglauterbach Jul 5, 2021
7380e74
a bit of Bash fetishism
georglauterbach Jul 6, 2021
2a0909b
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 6, 2021
365216c
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 8, 2021
4c33b6a
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 11, 2021
862ba89
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 12, 2021
6063ba6
Update docs/configuration/secrets.md
georglauterbach Jul 12, 2021
0711d2d
Update docs/community/oidc-integrations.md
georglauterbach Jul 12, 2021
226e7c7
Update docs/community/oidc-integrations.md
georglauterbach Jul 12, 2021
f4009f9
incorporated suggestions
georglauterbach Jul 12, 2021
5b18300
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
041810c
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
0e28050
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
5f3c274
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
6745134
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
bc26b21
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
744cd45
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
bd81219
Update docs/configuration/secrets.md
georglauterbach Jul 13, 2021
5113aa8
Update docs/faq.md
georglauterbach Jul 13, 2021
1fb000c
replace all old links
georglauterbach Jul 13, 2021
3c8e993
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 13, 2021
bf0af03
Merge branch 'master' into update-oidc-docs
clems4ever Jul 13, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
a bit of Bash fetishism
  • Loading branch information
georglauterbach committed Jul 6, 2021
commit 7380e74258ef6f4703efdefa9900dc5b4cc225b1
10 changes: 8 additions & 2 deletions docs/configuration/identity-providers/oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,8 +383,14 @@ know what you're doing. Potential values are `form_post`, `query`, and `fragment
## Generating Options Yourself
georglauterbach marked this conversation as resolved.
Show resolved Hide resolved

If you must generate an option yourself, you can use a random string of sufficient length. The command
georglauterbach marked this conversation as resolved.
Show resolved Hide resolved
`openssl rand -base64 32` provides such a random string with base64-conform characters. For Kubernetes,
see [this section too](../secrets.md#Kubernetes).

```sh
LENGHT=64
georglauterbach marked this conversation as resolved.
Show resolved Hide resolved
tr -cd '[:alnum:]' < /dev/urandom | fold -w "${LENGTH}" | head -n 1 | tr -d '\n' ; echo
```

prints such a string with a length in characters of `${LENGTH}` on `stdout`. The string will only contain alphanumeric
characters. For Kubernetes, see [this section too](../secrets.md#Kubernetes).

## Scope Definitions

Expand Down
18 changes: 13 additions & 5 deletions docs/configuration/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,22 +178,30 @@ metadata:
namespace: your-authelia-namespace

data:
keys.duo: >-
duo_key: >-
UXE1WmM4S0pldnl6eHRwQ3psTGpDbFplOXFueUVyWEZhYjE0Z01IRHN0RT0K

keys.jwt: >-
jwt_secret: >-
anotherBase64EncodedSecret

...
```

where `UXE1WmM4S0pldnl6eHRwQ3psTGpDbFplOXFueUVyWEZhYjE0Z01IRHN0RT0K` is base64 encoded for `Qq5Zc8KJevyzxtpCzlLjClZe9qnyErXFab14gMHDstE`, the actual content of the secret. You can generate these contents with
where `UXE1WmM4S0pldnl6eHRwQ3psTGpDbFplOXFueUVyWEZhYjE0Z01IRHN0RT0K` is Base64 encoded for
`Qq5Zc8KJevyzxtpCzlLjClZe9qnyErXFab14gMHDstE`, the actual content of the secret. You can generate these contents with

```sh
openssl rand -base64 32 | tr -d '\n' | tee actualSecretContent.txt | base64
LENGHT=64
georglauterbach marked this conversation as resolved.
Show resolved Hide resolved
tr -cd '[:alnum:]' < /dev/urandom \
| fold -w "${LENGTH}" \
| head -n 1 \
| tr -d '\n' \
| tee actualSecretContent.txt \
| base64 --wrap 0 \
; echo
```

which writes the secret's content to the `actualSecretContent.txt` file and print the base64 encoded version on the screen (`stdout`). `32` is the length in characters of the secret content generated by `openssl`.
which writes the secret's content to the `actualSecretContent.txt` file and print the Base64 encoded version on `stdout`. `${LENGTH}` is the length in characters of the secret content generated by this pipe. IF you don't want the contents to be written to `actualSecretContent.txt`, just delete the line with the `tee` command.
georglauterbach marked this conversation as resolved.
Show resolved Hide resolved

### Kustomization

Expand Down