Skip to content

Clarify tls settings for OIDC providers #659

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

Merged
merged 3 commits into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .yamllint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,8 @@ rules:
check-keys: false
comments:
min-spaces-from-content: 1 # Needed due to https://github.com/adrienverge/yamllint/issues/443
document-start:
ignore:
- modules/**/examples/** # We don't want the `---` in doc includes.
indentation:
indent-sequences: consistent
5 changes: 5 additions & 0 deletions modules/concepts/examples/authenticationclass-keycloak.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,8 @@ spec:
- profile
principalClaim: preferred_username # <5>
providerHint: Keycloak # <6>
tls: # <7>
verification:
server:
caCert:
webPki: {} # <8>
2 changes: 2 additions & 0 deletions modules/concepts/pages/authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ include::example$authenticationclass-keycloak.yaml[]
<4> Scopes to request from your identity provider. It is recommended to request the `openid`, `email`, and `profile` scopes.
<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.
<6> This is a hint about which identity provider is used by the AuthenticationClass.
<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[].
<8> Trust certificates signed by commonly trusted Certificate Authorities.

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].

Expand Down