Skip to content

Commit 173f247

Browse files
Clarify tls settings for OIDC providers (#659)
* Clarify tls settings for oidc prodivers * Configure yamllint * Update modules/concepts/pages/authentication.adoc Co-authored-by: Sebastian Bernauer <[email protected]> --------- Co-authored-by: Sebastian Bernauer <[email protected]>
1 parent 90db4a7 commit 173f247

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

.yamllint.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,8 @@ rules:
77
check-keys: false
88
comments:
99
min-spaces-from-content: 1 # Needed due to https://github.com/adrienverge/yamllint/issues/443
10+
document-start:
11+
ignore:
12+
- modules/**/examples/** # We don't want the `---` in doc includes.
13+
indentation:
14+
indent-sequences: consistent

modules/concepts/examples/authenticationclass-keycloak.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,8 @@ spec:
1414
- profile
1515
principalClaim: preferred_username # <5>
1616
providerHint: Keycloak # <6>
17+
tls: # <7>
18+
verification:
19+
server:
20+
caCert:
21+
webPki: {} # <8>

modules/concepts/pages/authentication.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ include::example$authenticationclass-keycloak.yaml[]
5454
<4> Scopes to request from your identity provider. It is recommended to request the `openid`, `email`, and `profile` scopes.
5555
<5> If a product extracts some sort of "effective user" that is represented by a string internally, this config determines which claim is used to extract that string.
5656
<6> This is a hint about which identity provider is used by the AuthenticationClass.
57+
<7> Optionally enable TLS and configure verification. When present, connections to the idP will use `https://` instead of `http://`. See xref:tls-server-verification.adoc[].
58+
<8> Trust certificates signed by commonly trusted Certificate Authorities.
5759

5860
NOTE: Get a full overview of all the properties in the {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/#spec-provider-oidc[AuthenticationClass OIDC provider CRD reference].
5961

0 commit comments

Comments
 (0)