mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2026-11-21 14:48:50 +00:00
Compare commits
40
Commits
3.0.11
..
bump/3.1.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0fb476c6a1 | ||
|
|
a071cd1c2d | ||
|
|
6b2d4a8552 | ||
|
|
08ee1c33bc | ||
|
|
e103524781 | ||
|
|
45863b3023 | ||
|
|
9ac8274434 | ||
|
|
0716f622ad | ||
|
|
14cba062b4 | ||
|
|
9d56a54bd8 | ||
|
|
8c3c4d8cbc | ||
|
|
638f694120 | ||
|
|
86bd6c77d6 | ||
|
|
6644207e5d | ||
|
|
5ba8098c15 | ||
|
|
d6ceb63914 | ||
|
|
529b667321 | ||
|
|
8d5526aeb6 | ||
|
|
afc12b6ae2 | ||
|
|
0868b58e90 | ||
|
|
2ffe3a8f7b | ||
|
|
6814939116 | ||
|
|
24350903ed | ||
|
|
89cb1691ae | ||
|
|
79852e61fc | ||
|
|
8007d8039a | ||
|
|
85d494731a | ||
|
|
d41fc161be | ||
|
|
4e1d14c4a1 | ||
|
|
e9f74fa4a9 | ||
|
|
23d96186f5 | ||
|
|
b48b0b7334 | ||
|
|
9446e53b6e | ||
|
|
a29e1a0c0e | ||
|
|
f082e8adb1 | ||
|
|
a4cdf1b154 | ||
|
|
4112ac7d71 | ||
|
|
8021fd735d | ||
|
|
3d9c71a2e6 | ||
|
|
742c44039c |
@@ -0,0 +1,88 @@
|
||||
# Keycloak / Ansible domain-specific words
|
||||
# Only terms NOT covered by built-in dictionaries
|
||||
|
||||
# Product names and projects
|
||||
Infinispan
|
||||
infinispan
|
||||
Wildfly
|
||||
wildfly
|
||||
keycloak
|
||||
|
||||
# Red Hat product names
|
||||
RHBK
|
||||
rhbk
|
||||
rhsso
|
||||
|
||||
# Java / JBoss terms
|
||||
Djboss
|
||||
Djgroups
|
||||
Dsun
|
||||
ispn
|
||||
ISPN
|
||||
jaegertracing
|
||||
jaxrs
|
||||
jberet
|
||||
JDBCPING
|
||||
jgroups
|
||||
JGROUPSPING
|
||||
jndi
|
||||
keytool
|
||||
MPING
|
||||
NAKACK
|
||||
passivation
|
||||
passivating
|
||||
slsb
|
||||
sfsb
|
||||
TCPPING
|
||||
tcpping
|
||||
jdbcx
|
||||
cacerts
|
||||
changeit
|
||||
|
||||
# Systemd directives
|
||||
restartsec
|
||||
runas
|
||||
startlimitburst
|
||||
systemdunit
|
||||
|
||||
# Ansible terms
|
||||
fqcn
|
||||
FQCN
|
||||
|
||||
# WildFly / JBoss terms
|
||||
jbcs
|
||||
modcluster
|
||||
|
||||
# Linux / System terms
|
||||
firewalld
|
||||
cgroupns
|
||||
zgrep
|
||||
|
||||
# Configuration terms
|
||||
xforwarded
|
||||
PYTHONHTTPSVERIFY
|
||||
|
||||
# Keycloak-specific
|
||||
ciba
|
||||
clusterless
|
||||
remembertochangeme
|
||||
|
||||
# Molecule / Testing
|
||||
hspaans
|
||||
|
||||
# CI / DevOps
|
||||
sangonzal
|
||||
rootperm
|
||||
|
||||
# RST / Sphinx directives
|
||||
toctree
|
||||
|
||||
# Task names / verbs
|
||||
Reown
|
||||
decomment
|
||||
|
||||
# British spellings (from upstream Keycloak docs)
|
||||
recognises
|
||||
|
||||
# Other
|
||||
rmaster
|
||||
@@ -22,4 +22,4 @@ concurrency:
|
||||
# file for each affected ansible-core version (for example, tests/sanity/ignore-2.18.txt).
|
||||
jobs:
|
||||
call:
|
||||
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@f182febf0568baf1151f66549401167fd10b25d2 # v4.0.0
|
||||
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e # v4.1.0
|
||||
|
||||
@@ -14,6 +14,18 @@ on:
|
||||
- cron: '15 6 * * *'
|
||||
|
||||
jobs:
|
||||
spellcheck:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v7
|
||||
|
||||
- name: Run cspell
|
||||
uses: streetsidesoftware/cspell-action@v9
|
||||
with:
|
||||
incremental_files_only: false
|
||||
use_cspell_files: true
|
||||
|
||||
ci:
|
||||
uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm
|
||||
secrets: inherit
|
||||
@@ -22,4 +34,4 @@ jobs:
|
||||
root_permission_varname: 'keycloak_install_requires_become'
|
||||
debug_verbosity: "${{ github.event.inputs.debug_verbosity }}"
|
||||
molecule_tests: >-
|
||||
[ "debian", "sso_test", "quarkus", "quarkus_ha", "quarkus_ha_remote", "quarkus_ha_26.4_below", "default", "quarkus_devmode", "quarkus_upgrade", "keycloak_modules" ]
|
||||
[ "debian", "sso_test", "quarkus", "quarkus_ha", "quarkus_ha_remote", "quarkus_ha_26.4_below", "default", "quarkus_devmode", "quarkus_upgrade", "keycloak_modules", "quarkus_relpath" ]
|
||||
|
||||
@@ -18,7 +18,7 @@ jobs:
|
||||
TRAFFIC_ACTION_TOKEN: ${{ secrets.TRIGGERING_PAT }}
|
||||
|
||||
- name: Commit changes
|
||||
uses: EndBug/add-and-commit@v10
|
||||
uses: EndBug/add-and-commit@v11
|
||||
with:
|
||||
author_name: Ansible Middleware
|
||||
message: "GitHub traffic"
|
||||
|
||||
@@ -6,6 +6,28 @@ middleware\_automation.keycloak Release Notes
|
||||
|
||||
This changelog describes changes after version 0.2.6.
|
||||
|
||||
v3.1.0
|
||||
======
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- 369 add integration tests for keycloak_authentication_v2 `#374 <https://github.com/ansible-middleware/keycloak/pull/374>`_
|
||||
- AMW-578 Replace deprecated community.general.yaml callback with result `#413 <https://github.com/ansible-middleware/keycloak/pull/413>`_
|
||||
- AMW-615 Inconsistent support of authentication via client credentials `#400 <https://github.com/ansible-middleware/keycloak/pull/400>`_
|
||||
- AMW-622 keycloak collection spelling and grammar checking for PRs `#406 <https://github.com/ansible-middleware/keycloak/pull/406>`_
|
||||
- AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable Roles if invoker lacks view-realm Role `#411 <https://github.com/ansible-middleware/keycloak/pull/411>`_
|
||||
- Add use_netrc option to prevent .netrc overriding bearer token `#408 <https://github.com/ansible-middleware/keycloak/pull/408>`_
|
||||
- Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter `#404 <https://github.com/ansible-middleware/keycloak/pull/404>`_
|
||||
- Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in `#414 <https://github.com/ansible-middleware/keycloak/pull/414>`_
|
||||
- Fix issue #397 #398 crash on first role assignment `#405 <https://github.com/ansible-middleware/keycloak/pull/405>`_
|
||||
- In a flow definition, handle non-existing keys correctly `#402 <https://github.com/ansible-middleware/keycloak/pull/402>`_
|
||||
- Normalize hostname that includes http_relative_path suffix `#392 <https://github.com/ansible-middleware/keycloak/pull/392>`_
|
||||
- Replace deprecated top-level fact variables with ansible_fact `#412 <https://github.com/ansible-middleware/keycloak/pull/412>`_
|
||||
- authentication_v2: Fix validation for FormActions `#384 <https://github.com/ansible-middleware/keycloak/pull/384>`_
|
||||
- keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 <https://github.com/ansible-middleware/keycloak/pull/407>`_
|
||||
- keycloak_user: fix attributes always reporting changed=True `#399 <https://github.com/ansible-middleware/keycloak/pull/399>`_
|
||||
|
||||
v3.0.11
|
||||
=======
|
||||
|
||||
|
||||
+1
-1
@@ -10,7 +10,7 @@ Clone the repository, checkout the tag you want to build, or pick the main branc
|
||||
|
||||
### Development environment
|
||||
|
||||
Make sure your development machine has avilable:
|
||||
Make sure your development machine has available:
|
||||
|
||||
* python 3.11+
|
||||
* virtualenv
|
||||
|
||||
@@ -729,6 +729,76 @@ releases:
|
||||
- 378.yaml
|
||||
- 389.yaml
|
||||
release_date: '2026-08-24'
|
||||
3.1.0:
|
||||
changes:
|
||||
minor_changes:
|
||||
- '369 add integration tests for keycloak_authentication_v2 `#374 <https://github.com/ansible-middleware/keycloak/pull/374>`_
|
||||
|
||||
'
|
||||
- 'AMW-578 Replace deprecated community.general.yaml callback with result `#413
|
||||
<https://github.com/ansible-middleware/keycloak/pull/413>`_
|
||||
|
||||
'
|
||||
- 'AMW-615 Inconsistent support of authentication via client credentials `#400
|
||||
<https://github.com/ansible-middleware/keycloak/pull/400>`_
|
||||
|
||||
'
|
||||
- 'AMW-622 keycloak collection spelling and grammar checking for PRs `#406 <https://github.com/ansible-middleware/keycloak/pull/406>`_
|
||||
|
||||
'
|
||||
- 'AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable
|
||||
Roles if invoker lacks view-realm Role `#411 <https://github.com/ansible-middleware/keycloak/pull/411>`_
|
||||
|
||||
'
|
||||
- 'Add use_netrc option to prevent .netrc overriding bearer token `#408 <https://github.com/ansible-middleware/keycloak/pull/408>`_
|
||||
|
||||
'
|
||||
- 'Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter
|
||||
`#404 <https://github.com/ansible-middleware/keycloak/pull/404>`_
|
||||
|
||||
'
|
||||
- 'Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified
|
||||
mappers are merged in `#414 <https://github.com/ansible-middleware/keycloak/pull/414>`_
|
||||
|
||||
'
|
||||
- 'Fix issue #397 #398 crash on first role assignment `#405 <https://github.com/ansible-middleware/keycloak/pull/405>`_
|
||||
|
||||
'
|
||||
- 'In a flow definition, handle non-existing keys correctly `#402 <https://github.com/ansible-middleware/keycloak/pull/402>`_
|
||||
|
||||
'
|
||||
- 'Normalize hostname that includes http_relative_path suffix `#392 <https://github.com/ansible-middleware/keycloak/pull/392>`_
|
||||
|
||||
'
|
||||
- 'Replace deprecated top-level fact variables with ansible_fact `#412 <https://github.com/ansible-middleware/keycloak/pull/412>`_
|
||||
|
||||
'
|
||||
- 'authentication_v2: Fix validation for FormActions `#384 <https://github.com/ansible-middleware/keycloak/pull/384>`_
|
||||
|
||||
'
|
||||
- 'keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 <https://github.com/ansible-middleware/keycloak/pull/407>`_
|
||||
|
||||
'
|
||||
- 'keycloak_user: fix attributes always reporting changed=True `#399 <https://github.com/ansible-middleware/keycloak/pull/399>`_
|
||||
|
||||
'
|
||||
fragments:
|
||||
- 374.yaml
|
||||
- 384.yaml
|
||||
- 392.yaml
|
||||
- 399.yaml
|
||||
- 400.yaml
|
||||
- 402.yaml
|
||||
- 404.yaml
|
||||
- 405.yaml
|
||||
- 406.yaml
|
||||
- 407.yaml
|
||||
- 408.yaml
|
||||
- 411.yaml
|
||||
- 412.yaml
|
||||
- 413.yaml
|
||||
- 414.yaml
|
||||
release_date: '2026-09-11'
|
||||
3.0.2:
|
||||
changes:
|
||||
bugfixes:
|
||||
|
||||
+59
@@ -0,0 +1,59 @@
|
||||
{
|
||||
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
|
||||
"version": "0.2",
|
||||
"language": "en",
|
||||
"ignorePaths": ["changelogs/**", "CHANGELOG.rst"],
|
||||
"files": [
|
||||
"**/*.md",
|
||||
"**/*.rst",
|
||||
"roles/*/meta/argument_specs.yml",
|
||||
"roles/*/meta/main.yml",
|
||||
"roles/*/tasks/**/*.yml",
|
||||
"roles/*/defaults/*.yml",
|
||||
"roles/*/handlers/*.yml",
|
||||
"roles/*/templates/*.j2",
|
||||
"molecule/**/*.yml",
|
||||
"molecule/**/*.j2",
|
||||
"playbooks/**/*.yml",
|
||||
"meta/runtime.yml",
|
||||
"meta/execution-environment.yml",
|
||||
".github/workflows/*.yml",
|
||||
".github/ISSUE_TEMPLATE/*.md",
|
||||
"galaxy.yml"
|
||||
],
|
||||
"dictionaries": [
|
||||
"custom-keycloak",
|
||||
"java",
|
||||
"bash",
|
||||
"shellscript",
|
||||
"fullstack",
|
||||
"softwareTerms",
|
||||
"software-tools",
|
||||
"cpp-compound-words",
|
||||
"python",
|
||||
"docker",
|
||||
"k8s",
|
||||
"html",
|
||||
"css",
|
||||
"git",
|
||||
"networking-terms",
|
||||
"node",
|
||||
"npm"
|
||||
],
|
||||
"dictionaryDefinitions": [
|
||||
{
|
||||
"name": "custom-keycloak",
|
||||
"path": ".cspell/custom-dictionary.txt",
|
||||
"addWords": true
|
||||
}
|
||||
],
|
||||
"ignoreRegExpList": [
|
||||
"/\\{\\{.*?\\}\\}/g",
|
||||
"/`[^`]+`/g",
|
||||
"/(https?:\\/\\/[^\\s)]+)/g",
|
||||
"/\\|`?[a-z_]+`?\\|/g",
|
||||
"/\\[.*?\\]\\(.*?\\)/g",
|
||||
"/^\\s*authors?:.*$/gm",
|
||||
"/^\\s*-\\s+.*<[^>]+>.*$/gm"
|
||||
]
|
||||
}
|
||||
+2
-1
@@ -1,11 +1,12 @@
|
||||
---
|
||||
namespace: middleware_automation
|
||||
name: keycloak
|
||||
version: "3.0.11"
|
||||
version: "3.1.1"
|
||||
readme: README.md
|
||||
authors:
|
||||
- Romain Pelisse <rpelisse@redhat.com>
|
||||
- Guido Grazioli <ggraziol@redhat.com>
|
||||
- Ranabir Chakraborty <ranabir@ibm.com>
|
||||
- Pavan Kumar Motaparthi <pmotapar@redhat.com>
|
||||
- Helmut Wolf <hwo@world-direct.at>
|
||||
- Harsha Cherukuri <hcheruku@redhat.com>
|
||||
|
||||
+17
-12
@@ -1,17 +1,22 @@
|
||||
v3.0.11
|
||||
=======
|
||||
v3.1.0
|
||||
======
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- Add certification checks to the upstream repo #378
|
||||
- Fix cert workflow #389
|
||||
- Fix health check URL to include HTTP relative path #364
|
||||
- fix(keycloak_quarkus): avoid leaking maven provider password in logs #363
|
||||
|
||||
Bugfixes
|
||||
--------
|
||||
|
||||
- AMW-592 AMW Github Actions are failing because of latest molecule #366
|
||||
- AMW-594 Upstream release is failing due to recent rules change #373
|
||||
- 369 add integration tests for keycloak_authentication_v2 #374
|
||||
- AMW-578 Replace deprecated community.general.yaml callback with result #413
|
||||
- AMW-615 Inconsistent support of authentication via client credentials #400
|
||||
- AMW-622 keycloak collection spelling and grammar checking for PRs #406
|
||||
- AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable Roles if invoker lacks view-realm Role #411
|
||||
- Add use_netrc option to prevent .netrc overriding bearer token #408
|
||||
- Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter #404
|
||||
- Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in #414
|
||||
- Fix issue #397 #398 crash on first role assignment #405
|
||||
- In a flow definition, handle non-existing keys correctly #402
|
||||
- Normalize hostname that includes http_relative_path suffix #392
|
||||
- Replace deprecated top-level fact variables with ansible_fact #412
|
||||
- authentication_v2: Fix validation for FormActions #384
|
||||
- keycloak_group: fix subgroup lookup on Keycloak older than 25 #407
|
||||
- keycloak_user: fix attributes always reporting changed=True #399
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Get access token
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/realms/{{ auth_realm }}/protocol/openid-connect/token"
|
||||
method: POST
|
||||
status_code: 200
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
body_format: form-urlencoded
|
||||
body:
|
||||
grant_type: "password"
|
||||
client_id: "admin-cli"
|
||||
username: "{{ auth_username }}"
|
||||
password: "{{ auth_password }}"
|
||||
register: token_response
|
||||
no_log: true
|
||||
|
||||
- name: Extract access token
|
||||
ansible.builtin.set_fact:
|
||||
access_token: "{{ token_response.json['access_token'] }}"
|
||||
no_log: true
|
||||
@@ -0,0 +1,37 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Flow Creation/Update <Integration Test Flow> Version 1
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow
|
||||
state: present
|
||||
authenticationExecutions:
|
||||
- providerId: idp-review-profile
|
||||
requirement: REQUIRED
|
||||
authenticationConfig:
|
||||
alias: Integration Test Flow - review profile config
|
||||
config:
|
||||
update.profile.on.first.login: "missing"
|
||||
- subFlow: Integration Test Flow - User creation or linking
|
||||
requirement: REQUIRED
|
||||
authenticationExecutions:
|
||||
- providerId: idp-create-user-if-unique
|
||||
requirement: ALTERNATIVE
|
||||
authenticationConfig:
|
||||
alias: Integration Test Flow - create unique user config
|
||||
config:
|
||||
require.password.update.after.registration: "false"
|
||||
- subFlow: Integration Test Flow - Handle Existing Account
|
||||
requirement: ALTERNATIVE
|
||||
authenticationExecutions:
|
||||
- providerId: idp-confirm-link
|
||||
requirement: REQUIRED
|
||||
- providerId: auth-cookie
|
||||
requirement: REQUIRED
|
||||
register: flow_v1_result
|
||||
|
||||
- name: Expose flow_v1_result to parent scope
|
||||
ansible.builtin.set_fact:
|
||||
flow_v1_result: "{{ flow_v1_result }}"
|
||||
no_log: true
|
||||
@@ -0,0 +1,43 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
# - adding a new execution inside the sub flow 'Integration Test Flow - User creation or linking' after the execution 'idp-create-user-if-unique'
|
||||
# - disable auth-cookie at the end of the flow
|
||||
# - change the config require.password.update.after.registration to "true"
|
||||
- name: Flow Creation/Update <Integration Test Flow> Version 2
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow
|
||||
state: present
|
||||
authenticationExecutions:
|
||||
- providerId: idp-review-profile
|
||||
requirement: REQUIRED
|
||||
authenticationConfig:
|
||||
alias: Integration Test Flow - review profile config
|
||||
config:
|
||||
update.profile.on.first.login: "missing"
|
||||
- subFlow: Integration Test Flow - User creation or linking
|
||||
requirement: REQUIRED
|
||||
authenticationExecutions:
|
||||
- providerId: idp-create-user-if-unique
|
||||
requirement: ALTERNATIVE
|
||||
authenticationConfig:
|
||||
alias: Integration Test Flow - create unique user config
|
||||
config:
|
||||
require.password.update.after.registration: "true"
|
||||
- providerId: auth-cookie
|
||||
requirement: REQUIRED
|
||||
- subFlow: Integration Test Flow - Handle Existing Account
|
||||
requirement: ALTERNATIVE
|
||||
authenticationExecutions:
|
||||
- providerId: idp-confirm-link
|
||||
requirement: REQUIRED
|
||||
- providerId: auth-cookie
|
||||
requirement: DISABLED
|
||||
register: flow_v2_result
|
||||
|
||||
- name: Expose flow_v2_result to parent scope
|
||||
ansible.builtin.set_fact:
|
||||
flow_v2_result: "{{ flow_v2_result }}"
|
||||
no_log: true
|
||||
@@ -0,0 +1,28 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
# Rebuilds Keycloak's own built-in "clients" flow structure as of 26.7.1.
|
||||
# validate_executions() used to raise a KeyError for client-flow parents, since only
|
||||
# basic-flow and form-flow provider sets were known.
|
||||
- name: Flow Creation/Update <Integration Test Flow - Client Flow>
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow - Client Flow
|
||||
providerId: client-flow
|
||||
state: present
|
||||
authenticationExecutions:
|
||||
- providerId: client-secret
|
||||
requirement: ALTERNATIVE
|
||||
- providerId: client-jwt
|
||||
requirement: ALTERNATIVE
|
||||
- providerId: client-secret-jwt
|
||||
requirement: ALTERNATIVE
|
||||
- providerId: client-x509
|
||||
requirement: ALTERNATIVE
|
||||
register: flow_v2_client_flow_result
|
||||
|
||||
- name: Expose flow_v2_client_flow_result to parent scope
|
||||
ansible.builtin.set_fact:
|
||||
flow_v2_client_flow_result: "{{ flow_v2_client_flow_result }}"
|
||||
no_log: true
|
||||
@@ -0,0 +1,31 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
# Rebuilds Keycloak's own built-in "registration" flow structure as of 26.7.1.
|
||||
# validate_executions() used to only check authenticator-providers and falsely flagged form actions as invalid
|
||||
# See https://github.com/ansible-middleware/keycloak/issues/382
|
||||
- name: Flow Creation/Update <Integration Test Flow - Form Actions>
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow - Form Actions
|
||||
state: present
|
||||
authenticationExecutions:
|
||||
- subFlow: Integration Test Flow - Form Actions - registration form
|
||||
subFlowType: form-flow
|
||||
requirement: REQUIRED
|
||||
authenticationExecutions:
|
||||
- providerId: registration-user-creation
|
||||
requirement: REQUIRED
|
||||
- providerId: registration-password-action
|
||||
requirement: REQUIRED
|
||||
- providerId: registration-recaptcha-action
|
||||
requirement: DISABLED
|
||||
- providerId: registration-terms-and-conditions
|
||||
requirement: DISABLED
|
||||
register: flow_v2_form_action_result
|
||||
|
||||
- name: Expose flow_v2_form_action_result to parent scope
|
||||
ansible.builtin.set_fact:
|
||||
flow_v2_form_action_result: "{{ flow_v2_form_action_result }}"
|
||||
no_log: true
|
||||
+144
@@ -0,0 +1,144 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Retrieve access token
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/fetch_access_token.yml
|
||||
|
||||
- name: Fetch all authentication flows
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: keycloak_flows_response
|
||||
no_log: true
|
||||
|
||||
- name: Extract flow id for alias 'Integration Test Flow'
|
||||
ansible.builtin.set_fact:
|
||||
test_flow_id: >-
|
||||
{{ keycloak_flows_response.json
|
||||
| selectattr('alias', 'equalto', 'Integration Test Flow')
|
||||
| map(attribute='id')
|
||||
| first }}
|
||||
no_log: true
|
||||
|
||||
- name: Fetch basic flow data for 'Integration Test Flow'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_top_level_data
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow attributes
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_top_level_data.json.alias == "Integration Test Flow"
|
||||
- test_flow_top_level_data.json.providerId == "basic-flow"
|
||||
- test_flow_top_level_data.json.topLevel == true
|
||||
- test_flow_top_level_data.json.builtIn == false
|
||||
|
||||
- name: Fetch flow executions for 'Integration Test Flow'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_executions
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow executions
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_executions.json | length == 6
|
||||
- test_flow_executions.json[0].providerId == "idp-review-profile"
|
||||
- test_flow_executions.json[0].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[0].index == 0
|
||||
- test_flow_executions.json[0].priority == 0
|
||||
- test_flow_executions.json[0].level == 0
|
||||
- test_flow_executions.json[0].authenticationConfig is not none
|
||||
- test_flow_executions.json[0]['authenticationFlow'] is not defined or test_flow_executions.json[0].authenticationFlow == false
|
||||
- test_flow_executions.json[1].displayName == "Integration Test Flow - User creation or linking"
|
||||
- test_flow_executions.json[1].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[1].index == 1
|
||||
- test_flow_executions.json[1].priority == 1
|
||||
- test_flow_executions.json[1].level == 0
|
||||
- test_flow_executions.json[1]['authenticationConfig'] is not defined
|
||||
- test_flow_executions.json[1].authenticationFlow == true
|
||||
- test_flow_executions.json[2].providerId == "idp-create-user-if-unique"
|
||||
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
|
||||
- test_flow_executions.json[2].index == 0
|
||||
- test_flow_executions.json[2].priority == 0
|
||||
- test_flow_executions.json[2].level == 1
|
||||
- test_flow_executions.json[2].authenticationConfig is not none
|
||||
- test_flow_executions.json[2]['authenticationFlow'] is not defined or test_flow_executions.json[2].authenticationFlow == false
|
||||
- test_flow_executions.json[3].displayName == "Integration Test Flow - Handle Existing Account"
|
||||
- test_flow_executions.json[3].requirement == "ALTERNATIVE"
|
||||
- test_flow_executions.json[3].index == 1
|
||||
- test_flow_executions.json[3].priority == 1
|
||||
- test_flow_executions.json[3].level == 1
|
||||
- test_flow_executions.json[3]['authenticationConfig'] is not defined
|
||||
- test_flow_executions.json[3].authenticationFlow == true
|
||||
- test_flow_executions.json[4].providerId == "idp-confirm-link"
|
||||
- test_flow_executions.json[4].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[4].index == 0
|
||||
- test_flow_executions.json[4].priority == 0
|
||||
- test_flow_executions.json[4].level == 2
|
||||
- test_flow_executions.json[4]['authenticationConfig'] is not defined
|
||||
- test_flow_executions.json[4]['authenticationFlow'] is not defined or test_flow_executions.json[4].authenticationFlow == false
|
||||
- test_flow_executions.json[5].providerId == "auth-cookie"
|
||||
- test_flow_executions.json[5].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[5].index == 2
|
||||
- test_flow_executions.json[5].priority == 2
|
||||
- test_flow_executions.json[5].level == 0
|
||||
- test_flow_executions.json[5]['authenticationConfig'] is not defined
|
||||
- test_flow_executions.json[5]['authenticationFlow'] is not defined or test_flow_executions.json[5].authenticationFlow == false
|
||||
|
||||
- name: Fetch flow execution config for 'idp-review-profile'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[0].authenticationConfig }}"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_execution_idp_review_profile_config
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow execution config for 'idp-review-profile'
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_execution_idp_review_profile_config.json.alias == "Integration Test Flow - review profile config"
|
||||
- test_flow_execution_idp_review_profile_config.json.config is not none
|
||||
- test_flow_execution_idp_review_profile_config.json.config['update.profile.on.first.login'] == "missing"
|
||||
|
||||
- name: Fetch flow execution config for 'idp-create-user-if-unique'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[2].authenticationConfig }}"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_execution_idp_create_user_if_unique
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow execution config for 'idp-create-user-if-unique'
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_execution_idp_create_user_if_unique.json.alias == "Integration Test Flow - create unique user config"
|
||||
- test_flow_execution_idp_create_user_if_unique.json.config is not none
|
||||
- test_flow_execution_idp_create_user_if_unique.json.config['require.password.update.after.registration'] == "false"
|
||||
+151
@@ -0,0 +1,151 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Retrieve access token
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/fetch_access_token.yml
|
||||
|
||||
- name: Fetch all authentication flows
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: keycloak_flows_response
|
||||
no_log: true
|
||||
|
||||
- name: Extract flow id for alias 'Integration Test Flow'
|
||||
ansible.builtin.set_fact:
|
||||
test_flow_id: >-
|
||||
{{ keycloak_flows_response.json
|
||||
| selectattr('alias', 'equalto', 'Integration Test Flow')
|
||||
| map(attribute='id')
|
||||
| first }}
|
||||
no_log: true
|
||||
|
||||
- name: Fetch basic flow data for 'Integration Test Flow'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_top_level_data
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow attributes
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_top_level_data.json.alias == "Integration Test Flow"
|
||||
- test_flow_top_level_data.json.providerId == "basic-flow"
|
||||
- test_flow_top_level_data.json.topLevel == true
|
||||
- test_flow_top_level_data.json.builtIn == false
|
||||
|
||||
- name: Fetch flow executions for 'Integration Test Flow'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_executions
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow executions
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_executions.json | length == 7
|
||||
- test_flow_executions.json[0].providerId == "idp-review-profile"
|
||||
- test_flow_executions.json[0].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[0].index == 0
|
||||
- test_flow_executions.json[0].priority == 0
|
||||
- test_flow_executions.json[0].level == 0
|
||||
- test_flow_executions.json[0].authenticationConfig is not none
|
||||
- test_flow_executions.json[0]['authenticationFlow'] is not defined or test_flow_executions.json[0].authenticationFlow == false
|
||||
- test_flow_executions.json[1].displayName == "Integration Test Flow - User creation or linking"
|
||||
- test_flow_executions.json[1].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[1].index == 1
|
||||
- test_flow_executions.json[1].priority == 1
|
||||
- test_flow_executions.json[1].level == 0
|
||||
- test_flow_executions.json[1]['authenticationConfig'] is not defined
|
||||
- test_flow_executions.json[1].authenticationFlow == true
|
||||
- test_flow_executions.json[2].providerId == "idp-create-user-if-unique"
|
||||
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
|
||||
- test_flow_executions.json[2].index == 0
|
||||
- test_flow_executions.json[2].priority == 0
|
||||
- test_flow_executions.json[2].level == 1
|
||||
- test_flow_executions.json[2].authenticationConfig is not none
|
||||
- test_flow_executions.json[2]['authenticationFlow'] is not defined or test_flow_executions.json[2].authenticationFlow == false
|
||||
- test_flow_executions.json[3].providerId == "auth-cookie"
|
||||
- test_flow_executions.json[3].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[3].index == 1
|
||||
- test_flow_executions.json[3].priority == 1
|
||||
- test_flow_executions.json[3].level == 1
|
||||
- test_flow_executions.json[3]['authenticationConfig'] is not defined
|
||||
- test_flow_executions.json[3]['authenticationFlow'] is not defined or test_flow_executions.json[3].authenticationFlow == false
|
||||
- test_flow_executions.json[4].displayName == "Integration Test Flow - Handle Existing Account"
|
||||
- test_flow_executions.json[4].requirement == "ALTERNATIVE"
|
||||
- test_flow_executions.json[4].index == 2
|
||||
- test_flow_executions.json[4].priority == 2
|
||||
- test_flow_executions.json[4].level == 1
|
||||
- test_flow_executions.json[4]['authenticationConfig'] is not defined
|
||||
- test_flow_executions.json[4].authenticationFlow == true
|
||||
- test_flow_executions.json[5].providerId == "idp-confirm-link"
|
||||
- test_flow_executions.json[5].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[5].index == 0
|
||||
- test_flow_executions.json[5].priority == 0
|
||||
- test_flow_executions.json[5].level == 2
|
||||
- test_flow_executions.json[5]['authenticationConfig'] is not defined
|
||||
- test_flow_executions.json[5]['authenticationFlow'] is not defined or test_flow_executions.json[5].authenticationFlow == false
|
||||
- test_flow_executions.json[6].providerId == "auth-cookie"
|
||||
- test_flow_executions.json[6].requirement == "DISABLED"
|
||||
- test_flow_executions.json[6].index == 2
|
||||
- test_flow_executions.json[6].priority == 2
|
||||
- test_flow_executions.json[6].level == 0
|
||||
- test_flow_executions.json[6]['authenticationConfig'] is not defined
|
||||
- test_flow_executions.json[6]['authenticationFlow'] is not defined or test_flow_executions.json[6].authenticationFlow == false
|
||||
|
||||
- name: Fetch flow execution config for 'idp-review-profile'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[0].authenticationConfig }}"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_execution_idp_review_profile_config
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow execution config for 'idp-review-profile'
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_execution_idp_review_profile_config.json.alias == "Integration Test Flow - review profile config"
|
||||
- test_flow_execution_idp_review_profile_config.json.config is not none
|
||||
- test_flow_execution_idp_review_profile_config.json.config['update.profile.on.first.login'] == "missing"
|
||||
|
||||
- name: Fetch flow execution config for 'idp-create-user-if-unique'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[2].authenticationConfig }}"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_execution_idp_create_user_if_unique
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow execution config for 'idp-create-user-if-unique'
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_execution_idp_create_user_if_unique.json.alias == "Integration Test Flow - create unique user config"
|
||||
- test_flow_execution_idp_create_user_if_unique.json.config is not none
|
||||
- test_flow_execution_idp_create_user_if_unique.json.config['require.password.update.after.registration'] == "true"
|
||||
+80
@@ -0,0 +1,80 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Retrieve access token
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/fetch_access_token.yml
|
||||
|
||||
- name: Fetch all authentication flows
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: keycloak_flows_response
|
||||
no_log: true
|
||||
|
||||
- name: Extract flow id for alias 'Integration Test Flow - Client Flow'
|
||||
ansible.builtin.set_fact:
|
||||
test_flow_id: >-
|
||||
{{ keycloak_flows_response.json
|
||||
| selectattr('alias', 'equalto', 'Integration Test Flow - Client Flow')
|
||||
| map(attribute='id')
|
||||
| first }}
|
||||
no_log: true
|
||||
|
||||
- name: Fetch basic flow data for 'Integration Test Flow - Client Flow'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_top_level_data
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow attributes
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_top_level_data.json.alias == "Integration Test Flow - Client Flow"
|
||||
- test_flow_top_level_data.json.providerId == "client-flow"
|
||||
- test_flow_top_level_data.json.topLevel == true
|
||||
- test_flow_top_level_data.json.builtIn == false
|
||||
|
||||
- name: Fetch flow executions for 'Integration Test Flow - Client Flow'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Client%20Flow/executions"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_executions
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow executions
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_executions.json | length == 4
|
||||
- test_flow_executions.json[0].providerId == "client-secret"
|
||||
- test_flow_executions.json[0].requirement == "ALTERNATIVE"
|
||||
- test_flow_executions.json[0].index == 0
|
||||
- test_flow_executions.json[0].level == 0
|
||||
- test_flow_executions.json[1].providerId == "client-jwt"
|
||||
- test_flow_executions.json[1].requirement == "ALTERNATIVE"
|
||||
- test_flow_executions.json[1].index == 1
|
||||
- test_flow_executions.json[1].level == 0
|
||||
- test_flow_executions.json[2].providerId == "client-secret-jwt"
|
||||
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
|
||||
- test_flow_executions.json[2].index == 2
|
||||
- test_flow_executions.json[2].level == 0
|
||||
- test_flow_executions.json[3].providerId == "client-x509"
|
||||
- test_flow_executions.json[3].requirement == "ALTERNATIVE"
|
||||
- test_flow_executions.json[3].index == 3
|
||||
- test_flow_executions.json[3].level == 0
|
||||
+86
@@ -0,0 +1,86 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Retrieve access token
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/fetch_access_token.yml
|
||||
|
||||
- name: Fetch all authentication flows
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: keycloak_flows_response
|
||||
no_log: true
|
||||
|
||||
- name: Extract flow id for alias 'Integration Test Flow - Form Actions'
|
||||
ansible.builtin.set_fact:
|
||||
test_flow_id: >-
|
||||
{{ keycloak_flows_response.json
|
||||
| selectattr('alias', 'equalto', 'Integration Test Flow - Form Actions')
|
||||
| map(attribute='id')
|
||||
| first }}
|
||||
no_log: true
|
||||
|
||||
- name: Fetch basic flow data for 'Integration Test Flow - Form Actions'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_top_level_data
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow attributes
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_top_level_data.json.alias == "Integration Test Flow - Form Actions"
|
||||
- test_flow_top_level_data.json.providerId == "basic-flow"
|
||||
- test_flow_top_level_data.json.topLevel == true
|
||||
- test_flow_top_level_data.json.builtIn == false
|
||||
|
||||
- name: Fetch flow executions for 'Integration Test Flow - Form Actions'
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Form%20Actions/executions"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: test_flow_executions
|
||||
no_log: true
|
||||
|
||||
- name: Assert flow executions
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- test_flow_executions.json | length == 5
|
||||
- test_flow_executions.json[0].displayName == "Integration Test Flow - Form Actions - registration form"
|
||||
- test_flow_executions.json[0].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[0].index == 0
|
||||
- test_flow_executions.json[0].level == 0
|
||||
- test_flow_executions.json[0].authenticationFlow == true
|
||||
- test_flow_executions.json[1].providerId == "registration-user-creation"
|
||||
- test_flow_executions.json[1].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[1].index == 0
|
||||
- test_flow_executions.json[1].level == 1
|
||||
- test_flow_executions.json[1]['authenticationFlow'] is not defined or test_flow_executions.json[1].authenticationFlow == false
|
||||
- test_flow_executions.json[2].providerId == "registration-password-action"
|
||||
- test_flow_executions.json[2].requirement == "REQUIRED"
|
||||
- test_flow_executions.json[2].index == 1
|
||||
- test_flow_executions.json[2].level == 1
|
||||
- test_flow_executions.json[3].providerId == "registration-recaptcha-action"
|
||||
- test_flow_executions.json[3].requirement == "DISABLED"
|
||||
- test_flow_executions.json[3].index == 2
|
||||
- test_flow_executions.json[3].level == 1
|
||||
- test_flow_executions.json[4].providerId == "registration-terms-and-conditions"
|
||||
- test_flow_executions.json[4].requirement == "DISABLED"
|
||||
- test_flow_executions.json[4].index == 3
|
||||
- test_flow_executions.json[4].level == 1
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Setup Test
|
||||
ansible.builtin.include_tasks:
|
||||
file: test_setup.yml
|
||||
|
||||
- name: Create the new flow <Integration Test Flow - Client Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v2_client_flow.yml
|
||||
|
||||
- name: Assert the flow creation result
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v2_client_flow_result is changed
|
||||
- flow_v2_client_flow_result.diff is defined
|
||||
msg: "Expected changes and a diff but got: changed={{ flow_v2_client_flow_result.changed }}, diff={{ flow_v2_client_flow_result.get('diff') }}"
|
||||
|
||||
- name: Assert the created flow <Integration Test Flow - Client Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../assertions/assertion_flow_v2_client_flow.yml
|
||||
|
||||
# Check idempotency, by trying to create the existing flow again
|
||||
- name: Trying to create the <Integration Test Flow - Client Flow> again, although nothing changed
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v2_client_flow.yml
|
||||
|
||||
- name: Assert that the task didn't re-create the flow, because the flow didn't change
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v2_client_flow_result is not changed
|
||||
- flow_v2_client_flow_result.diff is not defined
|
||||
msg: "Expected no changes and no diff but got: changed={{ flow_v2_client_flow_result.changed }}, diff={{ flow_v2_client_flow_result.get('diff') }}"
|
||||
+61
@@ -0,0 +1,61 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Setup Test
|
||||
ansible.builtin.include_tasks:
|
||||
file: test_setup.yml
|
||||
|
||||
- name: Create the new flow <Integration Test Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v1.yml
|
||||
|
||||
- name: Create a client with browser override <Integration Test Flow>
|
||||
middleware_automation.keycloak.keycloak_client:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "test_client"
|
||||
state: present
|
||||
authentication_flow_binding_overrides:
|
||||
browser_name: "Integration Test Flow"
|
||||
|
||||
- name: Modify the flow <Integration Test Flow> although it is bound as client override flow
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v2.yml
|
||||
|
||||
- name: Assert the flow modification result
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v2_result is changed
|
||||
- flow_v2_result.diff is defined
|
||||
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
|
||||
|
||||
- name: Assert the flow <Integration Test Flow> after the modifications
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../assertions/assertion_flow_v2.yml
|
||||
|
||||
- name: Fetch client data
|
||||
middleware_automation.keycloak.keycloak_client:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "test_client"
|
||||
state: present
|
||||
register: client_result
|
||||
|
||||
- name: Retrieve access token
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/fetch_access_token.yml
|
||||
|
||||
- name: Fetch authentication flow (browser override={{ client_result.end_state.authenticationFlowBindingOverrides.browser }})
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ client_result.end_state.authenticationFlowBindingOverrides.browser }}"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
register: flow_response
|
||||
|
||||
- name: Assert client flow override binding
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_response.json is defined
|
||||
- flow_response.json.alias == "Integration Test Flow"
|
||||
@@ -0,0 +1,33 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Setup Test
|
||||
ansible.builtin.include_tasks:
|
||||
file: test_setup.yml
|
||||
|
||||
- name: Create the new flow <Integration Test Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v1.yml
|
||||
|
||||
- name: Assert the flow creation result
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v1_result is changed
|
||||
- flow_v1_result.diff is defined
|
||||
msg: "Expected changes and a diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
|
||||
|
||||
- name: Assert the created flow <Integration Test Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../assertions/assertion_flow_v1.yml
|
||||
|
||||
# Check idempotency, by trying to create the existing flow again
|
||||
- name: Trying to create the <Integration Test Flow> again, although nothing changed
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v1.yml
|
||||
|
||||
- name: Assert that the task didn't re-create the flow, because the flow didn't change
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v1_result is not changed
|
||||
- flow_v1_result.diff is not defined
|
||||
msg: "Expected no changes and no diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
|
||||
@@ -0,0 +1,40 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Setup Test
|
||||
ansible.builtin.include_tasks:
|
||||
file: test_setup.yml
|
||||
|
||||
- name: Create the new flow <Integration Test Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v1.yml
|
||||
|
||||
- name: Delete the flow <Integration Test Flow>
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow
|
||||
state: absent
|
||||
register: flow_deletion_result
|
||||
|
||||
- name: Assert that the flow deletion result
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_deletion_result is changed
|
||||
- flow_deletion_result.diff is defined
|
||||
msg: "Expected changes and a diff but got: changed={{ flow_deletion_result.changed }}, diff={{ flow_deletion_result.get('diff') }}"
|
||||
|
||||
- name: Retrieve access token
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/fetch_access_token.yml
|
||||
|
||||
- name: Assert that the flow does not exist anymore
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
status_code: 404
|
||||
register: flow_response
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Setup Test
|
||||
ansible.builtin.include_tasks:
|
||||
file: test_setup.yml
|
||||
|
||||
- name: Create the new flow <Integration Test Flow - Form Actions>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v2_form_action.yml
|
||||
|
||||
- name: Assert the flow creation result
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v2_form_action_result is changed
|
||||
- flow_v2_form_action_result.diff is defined
|
||||
msg: "Expected changes and a diff but got: changed={{ flow_v2_form_action_result.changed }}, diff={{ flow_v2_form_action_result.get('diff') }}"
|
||||
|
||||
- name: Assert the created flow <Integration Test Flow - Form Actions>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../assertions/assertion_flow_v2_form_action.yml
|
||||
|
||||
# Check idempotency, by trying to create the existing flow again
|
||||
- name: Trying to create the <Integration Test Flow - Form Actions> again, although nothing changed
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v2_form_action.yml
|
||||
|
||||
- name: Assert that the task didn't re-create the flow, because the flow didn't change
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v2_form_action_result is not changed
|
||||
- flow_v2_form_action_result.diff is not defined
|
||||
msg: "Expected no changes and no diff but got: changed={{ flow_v2_form_action_result.changed }}, diff={{ flow_v2_form_action_result.get('diff') }}"
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Setup Test
|
||||
ansible.builtin.include_tasks:
|
||||
file: test_setup.yml
|
||||
|
||||
- name: Create the new flow <Integration Test Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v1.yml
|
||||
|
||||
- name: Create an identity-provider with first and post login flow override <Integration Test Flow>
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: oidc-idp-integration-test
|
||||
state: present
|
||||
display_name: OpenID Connect IdP - Integration Test
|
||||
enabled: true
|
||||
provider_id: oidc
|
||||
first_broker_login_flow_alias: Integration Test Flow
|
||||
post_broker_login_flow_alias: Integration Test Flow
|
||||
config:
|
||||
issuer: https://idp.example.com
|
||||
authorizationUrl: https://idp.example.com/auth
|
||||
tokenUrl: https://idp.example.com/token
|
||||
userInfoUrl: https://idp.example.com/userinfo
|
||||
clientAuthMethod: client_secret_post
|
||||
clientId: my-client
|
||||
clientSecret: secret
|
||||
syncMode: FORCE
|
||||
|
||||
- name: Modify the flow <Integration Test Flow> although it is bound as identity-provider first and post login flow
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v2.yml
|
||||
|
||||
- name: Assert the flow modification result
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v2_result is changed
|
||||
- flow_v2_result.diff is defined
|
||||
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
|
||||
|
||||
- name: Assert the flow <Integration Test Flow> after the modifications
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../assertions/assertion_flow_v2.yml
|
||||
|
||||
- name: Fetch identity-provider data
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: oidc-idp-integration-test
|
||||
state: present
|
||||
register: identity_provider_result
|
||||
|
||||
- name: Assert identity-provider first and post flow binding
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- identity_provider_result.end_state.firstBrokerLoginFlowAlias == "Integration Test Flow"
|
||||
- identity_provider_result.end_state.postBrokerLoginFlowAlias == "Integration Test Flow"
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
---
|
||||
- name: Setup Test
|
||||
ansible.builtin.include_tasks:
|
||||
file: test_setup.yml
|
||||
|
||||
- name: Flow Creation/Update <Integration Test Flow with invalid providerid in execution>
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow with invalid providerid in execution
|
||||
state: present
|
||||
authenticationExecutions:
|
||||
- providerId: idp-review-profile
|
||||
requirement: REQUIRED
|
||||
authenticationConfig:
|
||||
alias: Integration Test Flow - review profile config
|
||||
config:
|
||||
update.profile.on.first.login: "missing"
|
||||
- subFlow: Integration Test Flow - User creation or linking
|
||||
requirement: REQUIRED
|
||||
authenticationExecutions:
|
||||
- providerId: invalid-providerid
|
||||
requirement: ALTERNATIVE
|
||||
- subFlow: Integration Test Flow - Handle Existing Account
|
||||
requirement: ALTERNATIVE
|
||||
authenticationExecutions:
|
||||
- providerId: another-invalid-providerid
|
||||
requirement: REQUIRED
|
||||
- providerId: auth-cookie
|
||||
requirement: REQUIRED
|
||||
ignore_errors: true
|
||||
register: invalid_providerid_in_flow_result
|
||||
|
||||
- name: Verify that invalid providerId causes failure
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- invalid_providerid_in_flow_result is failed
|
||||
- invalid_providerid_in_flow_result is not changed
|
||||
- >-
|
||||
invalid_providerid_in_flow_result.msg == "Validation of executions failed: Error(s) while validating flow: Unknown providerId 'invalid-providerid', Unknown providerId 'another-invalid-providerid'"
|
||||
|
||||
- name: Retrieve access token
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/fetch_access_token.yml
|
||||
|
||||
- name: Assert that the flow did not get created
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20with%20invalid%20providerid%20in%20execution/executions"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
status_code: 404
|
||||
register: flow_response
|
||||
+50
@@ -0,0 +1,50 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Setup Test
|
||||
ansible.builtin.include_tasks:
|
||||
file: test_setup.yml
|
||||
|
||||
# form-action providers are valid for form-flow, but not for basic-flow.
|
||||
# This test ensures that validate_executions() correctly rejects them when used in a basic-flow context.
|
||||
# Same for authentication providers (e.g auth-cookie) in a form-flow context.
|
||||
- name: Flow Creation/Update <Integration Test Flow - Mismatched Flow Type> with providerIds mismatched to their parent flow type
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow - Mismatched Flow Type
|
||||
state: present
|
||||
authenticationExecutions:
|
||||
- providerId: registration-user-creation
|
||||
requirement: REQUIRED
|
||||
- subFlow: Integration Test Flow - Mismatched Flow Type - form
|
||||
subFlowType: form-flow
|
||||
requirement: REQUIRED
|
||||
authenticationExecutions:
|
||||
- providerId: auth-cookie
|
||||
requirement: REQUIRED
|
||||
ignore_errors: true
|
||||
register: mismatched_flow_type_result
|
||||
|
||||
- name: Assert providerIds mismatched with their parent flow type are rejected
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- mismatched_flow_type_result is failed
|
||||
- mismatched_flow_type_result is not changed
|
||||
- "'registration-user-creation' in mismatched_flow_type_result.msg"
|
||||
- "'auth-cookie' in mismatched_flow_type_result.msg"
|
||||
|
||||
- name: Retrieve access token
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/fetch_access_token.yml
|
||||
|
||||
- name: Assert that the flow did not get created
|
||||
ansible.builtin.uri:
|
||||
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Mismatched%20Flow%20Type/executions"
|
||||
method: GET
|
||||
headers:
|
||||
Accept: application/json
|
||||
User-agent: Ansible
|
||||
Authorization: "Bearer {{ access_token }}"
|
||||
return_content: true
|
||||
status_code: 404
|
||||
register: flow_response
|
||||
@@ -0,0 +1,45 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Delete identity-provider <oidc-idp-integration-test> if it exists
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: oidc-idp-integration-test
|
||||
state: absent
|
||||
|
||||
- name: Delete client <test_client> if it exists
|
||||
middleware_automation.keycloak.keycloak_client:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "test_client"
|
||||
state: absent
|
||||
|
||||
- name: Unassign the flow <Integration Test Flow> as default browser flow
|
||||
middleware_automation.keycloak.keycloak_realm:
|
||||
id: "{{ target_realm }}"
|
||||
realm: "{{ target_realm }}"
|
||||
state: present
|
||||
browser_flow: browser
|
||||
|
||||
- name: Delete <Integration Test Flow> flow if it exists
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow
|
||||
state: absent
|
||||
|
||||
- name: Delete <Integration Test Flow - Form Actions> flow if it exists
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow - Form Actions
|
||||
state: absent
|
||||
|
||||
- name: Delete <Integration Test Flow - Mismatched Flow Type> flow if it exists
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow - Mismatched Flow Type
|
||||
state: absent
|
||||
|
||||
- name: Delete <Integration Test Flow - Client Flow> flow if it exists
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: Integration Test Flow - Client Flow
|
||||
state: absent
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Setup Test
|
||||
ansible.builtin.include_tasks:
|
||||
file: test_setup.yml
|
||||
|
||||
- name: Create the new flow <Integration Test Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v1.yml
|
||||
|
||||
- name: Modify the flow <Integration Test Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v2.yml
|
||||
|
||||
- name: Assert the flow creation modification result
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v2_result is changed
|
||||
- flow_v2_result.diff is defined
|
||||
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
|
||||
|
||||
- name: Assert the modified flow <Integration Test Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../assertions/assertion_flow_v2.yml
|
||||
|
||||
# Revert the modifications from the previous step
|
||||
- name: Revert the modifications the flow <Integration Test Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v1.yml
|
||||
|
||||
- name: Assert the flow modification result
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v1_result is changed
|
||||
- flow_v1_result.diff is defined
|
||||
msg: "Expected changes and a diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
|
||||
|
||||
- name: Assert the flow <Integration Test Flow> after reverting the modifications
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../assertions/assertion_flow_v1.yml
|
||||
+44
@@ -0,0 +1,44 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
- name: Setup Test
|
||||
ansible.builtin.include_tasks:
|
||||
file: test_setup.yml
|
||||
|
||||
- name: Create the new flow <Integration Test Flow>
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v1.yml
|
||||
|
||||
- name: Assign the flow <Integration Test Flow> as default browser flow
|
||||
middleware_automation.keycloak.keycloak_realm:
|
||||
id: "{{ target_realm }}"
|
||||
realm: "{{ target_realm }}"
|
||||
state: present
|
||||
browser_flow: Integration Test Flow
|
||||
|
||||
- name: Modify the flow <Integration Test Flow> although it is bound as realm browser flow
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../actions/flow_v2.yml
|
||||
|
||||
- name: Assert the flow modification result
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- flow_v2_result is changed
|
||||
- flow_v2_result.diff is defined
|
||||
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
|
||||
|
||||
- name: Assert the flow <Integration Test Flow> after the modifications
|
||||
ansible.builtin.include_tasks:
|
||||
file: ../assertions/assertion_flow_v2.yml
|
||||
|
||||
- name: Fetch realm data to validate if the browser flow is still set to <Integration Test Flow>
|
||||
middleware_automation.keycloak.keycloak_realm:
|
||||
id: "{{ target_realm }}"
|
||||
realm: "{{ target_realm }}"
|
||||
state: present
|
||||
register: realm_result
|
||||
|
||||
- name: Assert realm browser flow binding
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- realm_result.end_state.browserFlow == "Integration Test Flow"
|
||||
@@ -0,0 +1,39 @@
|
||||
- name: Executing flow creation tests
|
||||
ansible.builtin.include_tasks:
|
||||
file: tests/test_flow_creation.yml
|
||||
|
||||
- name: Executing unused flow modification tests
|
||||
ansible.builtin.include_tasks:
|
||||
file: tests/test_unused_flow_modification.yml
|
||||
|
||||
- name: Executing used default browser flow modification tests
|
||||
ansible.builtin.include_tasks:
|
||||
file: tests/test_used_default_browser_flow_modification.yml
|
||||
|
||||
- name: Executing client flow override flow modification tests
|
||||
ansible.builtin.include_tasks:
|
||||
file: tests/test_client_flow_override_flow_modification.yml
|
||||
|
||||
- name: Executing identity provider first and post flow override flow modification tests
|
||||
ansible.builtin.include_tasks:
|
||||
file: tests/test_identity_provider_flow_overrides_flow_modification.yml
|
||||
|
||||
- name: Executing flow deletion tests
|
||||
ansible.builtin.include_tasks:
|
||||
file: tests/test_flow_deletion.yml
|
||||
|
||||
- name: Invalid providerIds in execution tests
|
||||
ansible.builtin.include_tasks:
|
||||
file: tests/test_invalid_providerid_flow_creation.yml
|
||||
|
||||
- name: Executing form action flow creation tests
|
||||
ansible.builtin.include_tasks:
|
||||
file: tests/test_form_action_flow_creation.yml
|
||||
|
||||
- name: Mismatched flow type providerIds in execution tests
|
||||
ansible.builtin.include_tasks:
|
||||
file: tests/test_mismatched_flow_type_flow_creation.yml
|
||||
|
||||
- name: Executing client flow creation tests
|
||||
ansible.builtin.include_tasks:
|
||||
file: tests/test_client_flow_creation.yml
|
||||
@@ -12,6 +12,7 @@
|
||||
client: molecule-client
|
||||
scope: molecule-scope
|
||||
group: molecule-group
|
||||
subgroup: molecule-subgroup
|
||||
user: molecule-user
|
||||
flow: molecule-flow
|
||||
flow_v2: molecule-flow-v2
|
||||
@@ -158,6 +159,35 @@
|
||||
enabled: true
|
||||
state: present
|
||||
|
||||
- name: keycloak_role — create realm role for restricted admin test
|
||||
middleware_automation.keycloak.keycloak_role:
|
||||
realm: "{{ target_realm }}"
|
||||
name: "{{ role }}-restricted"
|
||||
state: present
|
||||
|
||||
- name: keycloak_user — create restricted admin in master (manage-users only, no view-realm)
|
||||
middleware_automation.keycloak.keycloak_user:
|
||||
realm: master
|
||||
username: molecule-restricted-admin
|
||||
first_name: Restricted
|
||||
last_name: Admin
|
||||
enabled: true
|
||||
credentials:
|
||||
- type: password
|
||||
value: restricted-admin-password
|
||||
temporary: false
|
||||
state: present
|
||||
|
||||
- name: keycloak_user_rolemapping — grant manage-users for TestRealm to restricted admin
|
||||
middleware_automation.keycloak.keycloak_user_rolemapping:
|
||||
realm: master
|
||||
target_username: molecule-restricted-admin
|
||||
client_id: "{{ target_realm }}-realm"
|
||||
state: present
|
||||
roles:
|
||||
- name: manage-users
|
||||
- name: view-users
|
||||
|
||||
- name: keycloak_authentication_flow — create browser-style flow
|
||||
middleware_automation.keycloak.keycloak_authentication_flow:
|
||||
realm: "{{ target_realm }}"
|
||||
@@ -441,14 +471,8 @@
|
||||
state: present
|
||||
|
||||
- name: keycloak_authentication_v2 — manage flow with safe-swap semantics
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ flow_v2 }}"
|
||||
description: Molecule module test flow v2
|
||||
authenticationExecutions:
|
||||
- requirement: REQUIRED
|
||||
providerId: auth-cookie
|
||||
state: present
|
||||
ansible.builtin.include_tasks:
|
||||
file: keycloak_authentication_v2/verify.yml
|
||||
|
||||
- name: keycloak_authentication_required_actions — ensure VERIFY_EMAIL is enabled
|
||||
middleware_automation.keycloak.keycloak_authentication_required_actions:
|
||||
@@ -548,6 +572,44 @@
|
||||
roles:
|
||||
- name: "{{ role }}"
|
||||
|
||||
- name: keycloak_user_rolemapping — assign realm role using restricted admin (no view-realm)
|
||||
middleware_automation.keycloak.keycloak_user_rolemapping:
|
||||
auth_keycloak_url: "{{ auth_keycloak_url }}"
|
||||
auth_realm: master
|
||||
auth_username: molecule-restricted-admin
|
||||
auth_password: restricted-admin-password
|
||||
validate_certs: false
|
||||
realm: "{{ target_realm }}"
|
||||
target_username: "{{ user }}"
|
||||
state: present
|
||||
roles:
|
||||
- name: "{{ role }}-restricted"
|
||||
register: restricted_admin_rolemapping_result
|
||||
|
||||
- name: Assert restricted admin can assign realm role without view-realm
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- restricted_admin_rolemapping_result is changed
|
||||
|
||||
- name: keycloak_user_rolemapping — idempotency check with restricted admin
|
||||
middleware_automation.keycloak.keycloak_user_rolemapping:
|
||||
auth_keycloak_url: "{{ auth_keycloak_url }}"
|
||||
auth_realm: master
|
||||
auth_username: molecule-restricted-admin
|
||||
auth_password: restricted-admin-password
|
||||
validate_certs: false
|
||||
realm: "{{ target_realm }}"
|
||||
target_username: "{{ user }}"
|
||||
state: present
|
||||
roles:
|
||||
- name: "{{ role }}-restricted"
|
||||
register: restricted_admin_rolemapping_idempotent_result
|
||||
|
||||
- name: Assert restricted admin rolemapping is idempotent
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- restricted_admin_rolemapping_idempotent_result is not changed
|
||||
|
||||
- name: keycloak_realm_rolemapping — assign realm role to group
|
||||
middleware_automation.keycloak.keycloak_realm_rolemapping:
|
||||
realm: "{{ target_realm }}"
|
||||
@@ -565,6 +627,61 @@
|
||||
roles:
|
||||
- name: "{{ client_role }}"
|
||||
|
||||
- name: keycloak_group — create subgroup below the parent group
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
realm: "{{ target_realm }}"
|
||||
name: "{{ subgroup }}"
|
||||
parents:
|
||||
- name: "{{ group }}"
|
||||
state: present
|
||||
register: subgroup_result
|
||||
|
||||
- name: Assert subgroup was created below the parent group
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- subgroup_result is changed
|
||||
- subgroup_result.end_state.path == '/' ~ group ~ '/' ~ subgroup
|
||||
|
||||
- name: keycloak_group — create enough siblings to exceed the children page size
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
realm: "{{ target_realm }}"
|
||||
name: "{{ subgroup }}-{{ item }}"
|
||||
parents:
|
||||
- name: "{{ group }}"
|
||||
state: present
|
||||
loop: "{{ range(1, 13) | list }}"
|
||||
|
||||
- name: keycloak_group — look up a subgroup sorting past the children page size
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
realm: "{{ target_realm }}"
|
||||
name: "{{ subgroup }}-9"
|
||||
parents:
|
||||
- name: "{{ group }}"
|
||||
state: present
|
||||
register: subgroup_paging_result
|
||||
|
||||
- name: Assert subgroup lookup is not limited to the first page of children
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- subgroup_paging_result is not changed
|
||||
- subgroup_paging_result.end_state.path == '/' ~ group ~ '/' ~ subgroup ~ '-9'
|
||||
|
||||
- name: keycloak_realm_rolemapping — assign realm role to subgroup via parents
|
||||
middleware_automation.keycloak.keycloak_realm_rolemapping:
|
||||
realm: "{{ target_realm }}"
|
||||
group_name: "{{ subgroup }}"
|
||||
parents:
|
||||
- name: "{{ group }}"
|
||||
state: present
|
||||
roles:
|
||||
- name: "{{ role }}"
|
||||
register: subgroup_rolemapping_result
|
||||
|
||||
- name: Assert realm role was mapped to the subgroup
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- subgroup_rolemapping_result is changed
|
||||
|
||||
- name: keycloak_client_rolescope — restrict realm role on client
|
||||
middleware_automation.keycloak.keycloak_client_rolescope:
|
||||
realm: "{{ target_realm }}"
|
||||
@@ -837,18 +954,32 @@
|
||||
roles:
|
||||
- name: "{{ role }}"
|
||||
|
||||
- name: keycloak_user_rolemapping — remove restricted admin role mapping from user
|
||||
middleware_automation.keycloak.keycloak_user_rolemapping:
|
||||
realm: "{{ target_realm }}"
|
||||
target_username: "{{ user }}"
|
||||
state: absent
|
||||
roles:
|
||||
- name: "{{ role }}-restricted"
|
||||
|
||||
- name: keycloak_user — remove restricted admin user from master
|
||||
middleware_automation.keycloak.keycloak_user:
|
||||
realm: master
|
||||
username: molecule-restricted-admin
|
||||
state: absent
|
||||
|
||||
- name: keycloak_role — remove restricted admin test role
|
||||
middleware_automation.keycloak.keycloak_role:
|
||||
realm: "{{ target_realm }}"
|
||||
name: "{{ role }}-restricted"
|
||||
state: absent
|
||||
|
||||
- name: keycloak_identity_provider — remove OIDC provider
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ idp }}"
|
||||
state: absent
|
||||
|
||||
- name: keycloak_authentication_v2 — remove flow
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ flow_v2 }}"
|
||||
state: absent
|
||||
|
||||
- name: keycloak_authentication — remove copied flow
|
||||
middleware_automation.keycloak.keycloak_authentication:
|
||||
realm: "{{ target_realm }}"
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
driver:
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
- "9000/tcp"
|
||||
provisioner:
|
||||
name: ansible
|
||||
config_options:
|
||||
defaults:
|
||||
interpreter_python: auto_silent
|
||||
roles_path: ../../roles
|
||||
ssh_connection:
|
||||
pipelining: false
|
||||
playbooks:
|
||||
prepare: ../default/prepare.yml
|
||||
converge: ../default/converge.yml
|
||||
verify: verify.yml
|
||||
inventory:
|
||||
group_vars:
|
||||
all:
|
||||
keycloak_install_requires_become: true
|
||||
host_vars:
|
||||
localhost:
|
||||
ansible_python_interpreter: "{{ ansible_playbook_python }}"
|
||||
env:
|
||||
ANSIBLE_FORCE_COLOR: "true"
|
||||
PROXY: "${PROXY}"
|
||||
NO_PROXY: "${NO_PROXY}"
|
||||
verifier:
|
||||
name: ansible
|
||||
scenario:
|
||||
test_sequence:
|
||||
- cleanup
|
||||
- destroy
|
||||
- create
|
||||
- prepare
|
||||
- converge
|
||||
- verify
|
||||
- cleanup
|
||||
- destroy
|
||||
Symlink
+1
@@ -0,0 +1 @@
|
||||
../../roles
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
- name: Verify use_netrc option prevents .netrc from overriding bearer token (issue 403)
|
||||
hosts: all
|
||||
vars:
|
||||
auth_keycloak_url: http://instance:8080
|
||||
auth_realm: master
|
||||
auth_username: remembertochangeme
|
||||
auth_password: remembertochangeme
|
||||
target_realm: TestRealm
|
||||
module_defaults:
|
||||
group/middleware_automation.keycloak.keycloak:
|
||||
auth_keycloak_url: "{{ auth_keycloak_url }}"
|
||||
auth_realm: "{{ auth_realm }}"
|
||||
auth_username: "{{ auth_username }}"
|
||||
auth_password: "{{ auth_password }}"
|
||||
validate_certs: false
|
||||
tasks:
|
||||
- name: Populate service facts
|
||||
ansible.builtin.service_facts:
|
||||
|
||||
- name: Check if keycloak service started
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- ansible_facts.services["keycloak.service"]["state"] == "running"
|
||||
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
|
||||
fail_msg: Keycloak service is not running
|
||||
|
||||
- name: Verify netrc handling
|
||||
block:
|
||||
- name: Create .netrc with bogus credentials matching the Keycloak host
|
||||
ansible.builtin.copy:
|
||||
dest: ~/.netrc
|
||||
mode: "0600"
|
||||
content: |
|
||||
machine instance
|
||||
login netrc_user
|
||||
password netrc_password
|
||||
|
||||
- name: API call with default use_netrc (false) ignores .netrc
|
||||
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
|
||||
realm: "{{ target_realm }}"
|
||||
register: netrc_default_result
|
||||
|
||||
- name: Assert API call succeeds with default use_netrc despite .netrc
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- netrc_default_result is not failed
|
||||
|
||||
- name: API call with use_netrc true picks up .netrc credentials
|
||||
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
|
||||
realm: "{{ target_realm }}"
|
||||
use_netrc: true
|
||||
register: netrc_true_result
|
||||
ignore_errors: true
|
||||
|
||||
- name: Assert API call fails when use_netrc is true and .netrc has credentials
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- netrc_true_result is failed
|
||||
always:
|
||||
- name: Remove .netrc test file
|
||||
ansible.builtin.file:
|
||||
path: ~/.netrc
|
||||
state: absent
|
||||
@@ -36,7 +36,7 @@
|
||||
ansible.builtin.set_fact:
|
||||
assets_server: "{{ lookup('env', 'MIDDLEWARE_DOWNLOAD_RELEASE_SERVER_URL') }}"
|
||||
|
||||
- name: "Download artefacts only if assets_server is set"
|
||||
- name: "Download artifacts only if assets_server is set"
|
||||
when:
|
||||
- assets_server is defined
|
||||
- assets_server | length > 0
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
- name: Converge
|
||||
hosts: all
|
||||
vars_files:
|
||||
- ../group_vars/all/vars.yml
|
||||
vars:
|
||||
keycloak_quarkus_show_deprecation_warnings: false
|
||||
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
||||
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
|
||||
keycloak_quarkus_hostname: http://instance:8080/auth
|
||||
keycloak_quarkus_http_relative_path: /auth
|
||||
keycloak_quarkus_log: file
|
||||
keycloak_quarkus_log_level: debug
|
||||
keycloak_quarkus_log_target: /tmp/keycloak
|
||||
keycloak_quarkus_start_dev: true
|
||||
keycloak_quarkus_proxy_mode: none
|
||||
keycloak_quarkus_offline_install: true
|
||||
keycloak_quarkus_download_path: /tmp/keycloak/
|
||||
keycloak_quarkus_java_heap_opts: "-Xms640m -Xmx640m "
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
driver:
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
- "9000/tcp"
|
||||
provisioner:
|
||||
name: ansible
|
||||
config_options:
|
||||
defaults:
|
||||
interpreter_python: auto_silent
|
||||
ssh_connection:
|
||||
pipelining: false
|
||||
playbooks:
|
||||
prepare: prepare.yml
|
||||
converge: converge.yml
|
||||
verify: verify.yml
|
||||
inventory:
|
||||
group_vars:
|
||||
all:
|
||||
keycloak_install_requires_become: true
|
||||
host_vars:
|
||||
localhost:
|
||||
ansible_python_interpreter: "{{ ansible_playbook_python }}"
|
||||
env:
|
||||
ANSIBLE_FORCE_COLOR: "true"
|
||||
PROXY: "${PROXY}"
|
||||
NO_PROXY: "${NO_PROXY}"
|
||||
verifier:
|
||||
name: ansible
|
||||
scenario:
|
||||
test_sequence:
|
||||
- cleanup
|
||||
- destroy
|
||||
- create
|
||||
- prepare
|
||||
- converge
|
||||
- idempotence
|
||||
- side_effect
|
||||
- verify
|
||||
- cleanup
|
||||
- destroy
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
- name: Prepare
|
||||
hosts: all
|
||||
vars_files:
|
||||
- ../group_vars/all/vars.yml
|
||||
gather_facts: yes
|
||||
vars:
|
||||
sudo_pkg_name: sudo
|
||||
tasks:
|
||||
- name: "Run preparation common to all scenario"
|
||||
ansible.builtin.include_tasks: ../prepare.yml
|
||||
|
||||
- name: Create controller directory for downloads
|
||||
ansible.builtin.file: # noqa risky-file-permissions delegated, uses controller host user
|
||||
path: /tmp/keycloak
|
||||
state: directory
|
||||
mode: '0750'
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
|
||||
- name: Download keycloak archive to controller directory
|
||||
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
|
||||
url: https://github.com/keycloak/keycloak/releases/download/26.6.2/keycloak-26.6.2.zip
|
||||
dest: /tmp/keycloak
|
||||
mode: '0640'
|
||||
validate_certs: false
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
ignore_errors: true
|
||||
Symlink
+1
@@ -0,0 +1 @@
|
||||
../../roles
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
- name: Verify
|
||||
hosts: all
|
||||
vars:
|
||||
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
||||
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
|
||||
keycloak_uri: "http://localhost:8080/auth"
|
||||
tasks:
|
||||
- name: Populate service facts
|
||||
ansible.builtin.service_facts:
|
||||
- name: Check if keycloak service started
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- ansible_facts.services["keycloak.service"]["state"] == "running"
|
||||
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
|
||||
- name: Verify openid endpoint with relative path
|
||||
ansible.builtin.uri:
|
||||
url: "{{ keycloak_uri }}/realms/master/.well-known/openid-configuration"
|
||||
method: GET
|
||||
validate_certs: no
|
||||
register: keycloak_openid_response
|
||||
until: keycloak_openid_response.status == 200
|
||||
retries: 5
|
||||
delay: 5
|
||||
@@ -14,7 +14,8 @@ provisioner:
|
||||
config_options:
|
||||
defaults:
|
||||
interpreter_python: auto_silent
|
||||
callbacks_enabled: profile_tasks, timer, yaml
|
||||
callbacks_enabled: profile_tasks, timer
|
||||
callback_result_format: yaml
|
||||
ssh_connection:
|
||||
pipelining: false
|
||||
playbooks:
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
keycloak_admin_user: "admin"
|
||||
keycloak_uri: "http://localhost:8080"
|
||||
keycloak_context: "/auth"
|
||||
parent_group: molecule-parent-group
|
||||
child_group: molecule-child-group
|
||||
tasks:
|
||||
- name: Populate service facts
|
||||
ansible.builtin.service_facts:
|
||||
@@ -24,3 +26,53 @@
|
||||
until: keycloak_auth_response.status == 200
|
||||
retries: 2
|
||||
delay: 2
|
||||
|
||||
# This Keycloak is older than 23, so its group children endpoint accepts no
|
||||
# GET request and the subgroup lookup has to fall back to the subgroups
|
||||
# inlined in the parent group representation.
|
||||
- name: Verify subgroup handling on a pre-23 Keycloak
|
||||
module_defaults:
|
||||
group/middleware_automation.keycloak.keycloak:
|
||||
auth_keycloak_url: "{{ keycloak_uri }}{{ keycloak_context }}"
|
||||
auth_realm: master
|
||||
auth_username: "{{ keycloak_admin_user }}"
|
||||
auth_password: "{{ keycloak_admin_password }}"
|
||||
validate_certs: false
|
||||
realm: master
|
||||
block:
|
||||
- name: keycloak_group — create parent group
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
name: "{{ parent_group }}"
|
||||
state: present
|
||||
|
||||
- name: keycloak_group — create subgroup below the parent group
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
name: "{{ child_group }}"
|
||||
parents:
|
||||
- name: "{{ parent_group }}"
|
||||
state: present
|
||||
register: subgroup_result
|
||||
|
||||
- name: Assert subgroup was created below the parent group
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- subgroup_result is changed
|
||||
- subgroup_result.end_state.path == '/' ~ parent_group ~ '/' ~ child_group
|
||||
|
||||
- name: keycloak_group — look the subgroup up through parents again
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
name: "{{ child_group }}"
|
||||
parents:
|
||||
- name: "{{ parent_group }}"
|
||||
state: present
|
||||
register: subgroup_lookup_result
|
||||
|
||||
- name: Assert the existing subgroup was found instead of re-created
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- subgroup_lookup_result is not changed
|
||||
always:
|
||||
- name: keycloak_group — remove parent group and its subtree
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
name: "{{ parent_group }}"
|
||||
state: absent
|
||||
|
||||
@@ -78,4 +78,12 @@ options:
|
||||
- Configures the HTTP User-Agent header.
|
||||
type: str
|
||||
default: Ansible
|
||||
use_netrc:
|
||||
description:
|
||||
- Whether to use credentials from C(~/.netrc) file.
|
||||
- By default, C(~/.netrc) is not used because these modules authenticate via
|
||||
explicit OIDC credentials/token. A matching C(~/.netrc) entry would silently
|
||||
override the Bearer token with Basic authentication, causing 401 errors.
|
||||
type: bool
|
||||
default: false
|
||||
'''
|
||||
|
||||
@@ -109,6 +109,8 @@ URL_REALM_GROUP_ROLEMAPPINGS = "{url}/admin/realms/{realm}/groups/{group}/role-m
|
||||
URL_CLIENTSECRET = "{url}/admin/realms/{realm}/clients/{id}/client-secret"
|
||||
|
||||
URL_AUTHENTICATION_AUTHENTICATOR_PROVIDERS = "{url}/admin/realms/{realm}/authentication/authenticator-providers"
|
||||
URL_AUTHENTICATION_CLIENT_AUTHENTICATOR_PROVIDERS = "{url}/admin/realms/{realm}/authentication/client-authenticator-providers"
|
||||
URL_AUTHENTICATION_FORM_ACTION_PROVIDERS = "{url}/admin/realms/{realm}/authentication/form-action-providers"
|
||||
URL_AUTHENTICATION_FLOWS = "{url}/admin/realms/{realm}/authentication/flows"
|
||||
URL_AUTHENTICATION_FLOW = "{url}/admin/realms/{realm}/authentication/flows/{id}"
|
||||
URL_AUTHENTICATION_FLOW_COPY = "{url}/admin/realms/{realm}/authentication/flows/{copyfrom}/copy"
|
||||
@@ -177,6 +179,7 @@ def keycloak_argument_spec() -> dict[str, t.Any]:
|
||||
token=dict(type="str", no_log=True),
|
||||
refresh_token=dict(type="str", no_log=True),
|
||||
http_agent=dict(type="str", default="Ansible"),
|
||||
use_netrc=dict(type="bool", default=False),
|
||||
)
|
||||
|
||||
|
||||
@@ -216,6 +219,7 @@ def _token_request(module_params: dict[str, t.Any], payload: dict[str, t.Any]) -
|
||||
http_agent = module_params.get("http_agent")
|
||||
validate_certs = module_params.get("validate_certs")
|
||||
connection_timeout = module_params.get("connection_timeout")
|
||||
use_netrc = module_params.get("use_netrc", False)
|
||||
|
||||
try:
|
||||
r = json.loads(
|
||||
@@ -226,6 +230,7 @@ def _token_request(module_params: dict[str, t.Any], payload: dict[str, t.Any]) -
|
||||
http_agent=http_agent,
|
||||
timeout=connection_timeout,
|
||||
data=urlencode(payload),
|
||||
use_netrc=use_netrc,
|
||||
).read()
|
||||
)
|
||||
|
||||
@@ -401,6 +406,7 @@ class KeycloakAPI:
|
||||
self.connection_timeout = self.module.params.get("connection_timeout")
|
||||
self.restheaders = connection_header
|
||||
self.http_agent = self.module.params.get("http_agent")
|
||||
self.use_netrc = self.module.params.get("use_netrc", False)
|
||||
|
||||
def _request(
|
||||
self, url: str, method: str, data: str | bytes | None = None, *, extra_headers: dict[str, str] | None = None
|
||||
@@ -429,6 +435,7 @@ class KeycloakAPI:
|
||||
headers=headers,
|
||||
timeout=self.connection_timeout,
|
||||
validate_certs=self.validate_certs,
|
||||
use_netrc=self.use_netrc,
|
||||
)
|
||||
except HTTPError as e:
|
||||
if e.code != HTTPStatus.UNAUTHORIZED:
|
||||
@@ -1731,7 +1738,15 @@ class KeycloakAPI:
|
||||
except Exception as e:
|
||||
self.module.fail_json(msg=f"Could not fetch group {gid} in realm {realm}: {e}")
|
||||
|
||||
def get_subgroups(self, parent, realm: str = "master"):
|
||||
def get_subgroups(self, parent, realm: str = "master", search=None):
|
||||
"""Fetch the direct subgroups of a group.
|
||||
|
||||
:param parent: GroupRepresentation of the parent group
|
||||
:param realm: Realm in which the group resides; default "master"
|
||||
:param search: Optional group name, letting the server narrow the result
|
||||
down. This is a hint only: servers which do not support searching
|
||||
return all subgroups, so callers must still match names themselves.
|
||||
"""
|
||||
if "subGroupCount" in parent:
|
||||
# Since version 23, when GETting a group Keycloak does not
|
||||
# return subGroups but only a subGroupCount.
|
||||
@@ -1740,9 +1755,17 @@ class KeycloakAPI:
|
||||
group_children = []
|
||||
else:
|
||||
group_children_url = f"{URL_GROUP_CHILDREN.format(url=self.baseurl, realm=realm, groupid=parent['id'])}?max={parent['subGroupCount']}"
|
||||
if search is not None:
|
||||
# search/exact are only honoured from version 25 on, 23 and 24
|
||||
# silently ignore them, which is why max is always sent as the
|
||||
# full child count.
|
||||
group_children_url += f"&search={quote(search, safe='')}&exact=true"
|
||||
group_children = self._request_and_deserialize(group_children_url, method="GET")
|
||||
subgroups = group_children
|
||||
else:
|
||||
# Before version 23 the children endpoint has no GET method at all
|
||||
# (it answers 405 Method Not Allowed), the subgroups are inlined in
|
||||
# the parent representation instead.
|
||||
subgroups = parent["subGroups"]
|
||||
return subgroups
|
||||
|
||||
@@ -1750,7 +1773,8 @@ class KeycloakAPI:
|
||||
"""Fetch a keycloak group within a realm based on its name.
|
||||
|
||||
Uses the Keycloak search API with exact matching for efficient lookup
|
||||
instead of fetching all groups.
|
||||
instead of fetching all groups. Servers which do not support searching
|
||||
are handled transparently, see the comments below.
|
||||
|
||||
If the group does not exist, None is returned.
|
||||
:param name: Name of the group to fetch.
|
||||
@@ -1764,18 +1788,18 @@ class KeycloakAPI:
|
||||
if not parent:
|
||||
return None
|
||||
|
||||
# For subgroups: use children endpoint with search parameter
|
||||
search_url = "{url}?search={name}&exact=true".format(
|
||||
url=URL_GROUP_CHILDREN.format(url=self.baseurl, realm=realm, groupid=parent["id"]),
|
||||
name=quote(name, safe=""),
|
||||
)
|
||||
# For subgroups: search the parent's children where the server
|
||||
# supports it. get_subgroups knows which servers those are, the
|
||||
# exact name check below covers the ones which do not.
|
||||
groups = self.get_subgroups(parent, realm, search=name)
|
||||
else:
|
||||
# For top-level groups: use groups endpoint with search parameter
|
||||
# For top-level groups: use groups endpoint with search parameter.
|
||||
# exact was only added in version 20; older servers ignore it and return
|
||||
# substring matches, which the exact name check below sorts out.
|
||||
search_url = "{url}?search={name}&exact=true".format(
|
||||
url=URL_GROUPS.format(url=self.baseurl, realm=realm), name=quote(name, safe="")
|
||||
)
|
||||
|
||||
groups = self._request_and_deserialize(search_url, method="GET")
|
||||
groups = self._request_and_deserialize(search_url, method="GET")
|
||||
|
||||
# exact=true should return only exact matches, but verify the name
|
||||
for group in groups:
|
||||
@@ -2294,6 +2318,32 @@ class KeycloakAPI:
|
||||
except Exception as e:
|
||||
self.fail_request(e, msg=f"Unable get authenticator providers in realm {realm}: {e}")
|
||||
|
||||
def get_client_authenticator_providers(self, realm: str = "master"):
|
||||
"""
|
||||
Get all available client authenticator providers of the realm.
|
||||
:param realm: Realm.
|
||||
:return: List of client authenticator provider representations.
|
||||
"""
|
||||
try:
|
||||
return self._request_and_deserialize(
|
||||
URL_AUTHENTICATION_CLIENT_AUTHENTICATOR_PROVIDERS.format(url=self.baseurl, realm=realm), method="GET"
|
||||
)
|
||||
except Exception as e:
|
||||
self.fail_request(e, msg=f"Unable get client authenticator providers in realm {realm}: {e}")
|
||||
|
||||
def get_form_action_providers(self, realm: str = "master"):
|
||||
"""
|
||||
Get all available form action providers of the realm.
|
||||
:param realm: Realm.
|
||||
:return: List of form action provider representations.
|
||||
"""
|
||||
try:
|
||||
return self._request_and_deserialize(
|
||||
URL_AUTHENTICATION_FORM_ACTION_PROVIDERS.format(url=self.baseurl, realm=realm), method="GET"
|
||||
)
|
||||
except Exception as e:
|
||||
self.fail_request(e, msg=f"Unable get form action providers in realm {realm}: {e}")
|
||||
|
||||
def get_authentication_flow_by_alias(self, alias, realm: str = "master"):
|
||||
"""
|
||||
Get an authentication flow by its alias
|
||||
|
||||
@@ -519,6 +519,7 @@ extends_documentation_fragment:
|
||||
|
||||
author:
|
||||
- Thomas Bargetz (@thomasbargetz)
|
||||
- Nils Bergmann (@NilsBergmann)
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
@@ -756,8 +757,8 @@ def create_executions(
|
||||
:param parent_flow_alias: the alias of the flow or sub-flow that will own the executions.
|
||||
"""
|
||||
for desired_exec in executions:
|
||||
sub_flow = desired_exec["subFlow"]
|
||||
sub_flow_type = desired_exec["subFlowType"]
|
||||
sub_flow = desired_exec.get("subFlow")
|
||||
sub_flow_type = desired_exec.get("subFlowType", "basic-flow")
|
||||
sub_flow_execs = desired_exec.get("authenticationExecutions")
|
||||
|
||||
# Build the minimal payload accepted by the execution creation endpoint.
|
||||
@@ -868,6 +869,12 @@ def existing_auth_to_diff_repr(kc: KeycloakAPI, realm: str, existing_auth: dict)
|
||||
execution.pop("description", None)
|
||||
execution.pop("flowId", None)
|
||||
|
||||
if execution.get("authenticationFlow"):
|
||||
# This is always None for non-form-flows and defaults to 'registration-page-form' for form-flows.
|
||||
# Keycloak supports custom form-flow providers via the FormAuthenticatorFactory SPI, but this module has no
|
||||
# option to choose one, so the providerId is stripped from the existing execution before comparison.
|
||||
execution.pop("providerId", None)
|
||||
|
||||
if execution.get("authenticationConfig") is not None:
|
||||
execution["authenticationConfig"].pop("id", None)
|
||||
# The alias is already stored inside the authenticationConfig object; the
|
||||
@@ -1052,33 +1059,46 @@ def create_authentication_execution_spec_options(depth: int) -> dict[str, t.Any]
|
||||
return options
|
||||
|
||||
|
||||
def validate_executions(kc: KeycloakAPI, realm: str, executions: dict) -> None:
|
||||
valid_providers = kc.get_authenticator_providers(realm)
|
||||
valid_provider_ids = {provider["id"] for provider in valid_providers}
|
||||
def validate_executions(kc: KeycloakAPI, realm: str, executions: dict, flow_type: str) -> None:
|
||||
valid_provider_ids_by_flow_type = {
|
||||
"basic-flow": {provider["id"] for provider in kc.get_authenticator_providers(realm)},
|
||||
"form-flow": {provider["id"] for provider in kc.get_form_action_providers(realm)},
|
||||
"client-flow": {provider["id"] for provider in kc.get_client_authenticator_providers(realm)},
|
||||
}
|
||||
all_known_provider_ids = set().union(*valid_provider_ids_by_flow_type.values())
|
||||
|
||||
invalid_provider_ids = validate_executions_rec(valid_provider_ids, executions)
|
||||
if len(invalid_provider_ids) > 0:
|
||||
invalid_provider_ids_str = ", ".join(f"'{item}'" for item in invalid_provider_ids)
|
||||
raise ValueError(
|
||||
f"The following execution providerIds are unknown and therefore invalid: {invalid_provider_ids_str}"
|
||||
)
|
||||
messages = []
|
||||
has_issues = validate_executions_rec(valid_provider_ids_by_flow_type, all_known_provider_ids, executions, flow_type, messages)
|
||||
if has_issues:
|
||||
raise ValueError("Error(s) while validating flow: " + ", ".join(messages))
|
||||
|
||||
|
||||
def validate_executions_rec(valid_provider_ids: set, executions: dict) -> list:
|
||||
invalid_provider_ids = []
|
||||
def validate_executions_rec(
|
||||
valid_provider_ids_by_flow_type: dict, all_known_provider_ids: set, executions: dict, flow_type: str, messages: list
|
||||
) -> bool:
|
||||
if flow_type not in valid_provider_ids_by_flow_type:
|
||||
messages.append(f"Unsupported flow type '{flow_type}'")
|
||||
return True
|
||||
|
||||
has_issues = False
|
||||
valid_provider_ids = valid_provider_ids_by_flow_type[flow_type]
|
||||
for execution in executions:
|
||||
provider_id = execution["providerId"]
|
||||
sub_flow = execution["subFlow"]
|
||||
if provider_id is not None:
|
||||
if provider_id not in valid_provider_ids:
|
||||
invalid_provider_ids.append(provider_id)
|
||||
sub_flow = execution.get("subFlow")
|
||||
if provider_id is not None and provider_id not in valid_provider_ids:
|
||||
has_issues = True
|
||||
if provider_id in all_known_provider_ids:
|
||||
messages.append(f"'{provider_id}' is not a valid provider for parent flow '{flow_type}'")
|
||||
else:
|
||||
messages.append(f"Unknown providerId '{provider_id}'")
|
||||
|
||||
if sub_flow is not None:
|
||||
invalid_provider_ids.extend(
|
||||
validate_executions_rec(valid_provider_ids, execution["authenticationExecutions"])
|
||||
)
|
||||
if validate_executions_rec(
|
||||
valid_provider_ids_by_flow_type, all_known_provider_ids, execution["authenticationExecutions"], execution["subFlowType"], messages
|
||||
):
|
||||
has_issues = True
|
||||
|
||||
return invalid_provider_ids
|
||||
return has_issues
|
||||
|
||||
|
||||
def main() -> None:
|
||||
@@ -1141,7 +1161,7 @@ def main() -> None:
|
||||
|
||||
try:
|
||||
try:
|
||||
validate_executions(kc, realm, desired_auth["authenticationExecutions"])
|
||||
validate_executions(kc, realm, desired_auth["authenticationExecutions"], desired_auth["providerId"])
|
||||
except ValueError as e:
|
||||
module.fail_json(
|
||||
msg=f"Validation of executions failed: {e}",
|
||||
|
||||
@@ -339,11 +339,10 @@ def main():
|
||||
role["id"] = role_id
|
||||
else:
|
||||
module.fail_json(msg=f"Could not fetch role {role['name']}:")
|
||||
# Fetch missing role_name
|
||||
else:
|
||||
role["name"] = kc.get_client_group_rolemapping_by_id(gid, cid, role["id"], realm=realm)["name"]
|
||||
if role["name"] is None:
|
||||
module.fail_json(msg=f"Could not fetch role {role['id']}")
|
||||
# Fetch missing role_name from the client's roles, not from existing group mappings
|
||||
elif role["name"] is None:
|
||||
role_rep = kc.get_role_by_id(role["id"], realm=realm)
|
||||
role["name"] = role_rep["name"]
|
||||
|
||||
# Get effective client-level role mappings
|
||||
available_roles_before = kc.get_client_group_available_rolemappings(gid, cid, realm=realm)
|
||||
@@ -383,7 +382,10 @@ def main():
|
||||
# Assign roles
|
||||
result["changed"] = True
|
||||
if module._diff:
|
||||
result["diff"] = dict(before=assigned_roles_before, after=result["proposed"])
|
||||
result["diff"] = dict(
|
||||
before={"roles": assigned_roles_before or []},
|
||||
after={"roles": result["proposed"]},
|
||||
)
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
kc.add_group_rolemapping(gid, cid, update_roles, realm=realm)
|
||||
@@ -395,7 +397,10 @@ def main():
|
||||
# Remove mapping of role
|
||||
result["changed"] = True
|
||||
if module._diff:
|
||||
result["diff"] = dict(before=assigned_roles_before, after=result["proposed"])
|
||||
result["diff"] = dict(
|
||||
before={"roles": assigned_roles_before or []},
|
||||
after={"roles": result["proposed"]},
|
||||
)
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
kc.delete_group_rolemapping(gid, cid, update_roles, realm=realm)
|
||||
|
||||
@@ -211,8 +211,14 @@ def main():
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec,
|
||||
supports_check_mode=True,
|
||||
required_one_of=([['token', 'auth_realm', 'auth_username', 'auth_password']]),
|
||||
required_together=([['auth_realm', 'auth_username', 'auth_password']]))
|
||||
required_one_of=(
|
||||
[
|
||||
["token", "auth_realm", "auth_username", "auth_password", "auth_client_id", "auth_client_secret"],
|
||||
]
|
||||
),
|
||||
required_together=([["auth_username", "auth_password"]]),
|
||||
required_by={"refresh_token": "auth_realm"},
|
||||
mutually_exclusive=[["token", "auth_realm"], ["token", "auth_username"], ["token", "auth_password"]])
|
||||
|
||||
result = dict(changed=False, msg='', diff={}, end_state={})
|
||||
|
||||
|
||||
@@ -327,6 +327,12 @@ options:
|
||||
aliases:
|
||||
- maxFailureWaitSeconds
|
||||
type: int
|
||||
max_secondary_auth_failures:
|
||||
description:
|
||||
- The realm max secondary authentication failures (used with brute force detection for secondary auth mechanisms).
|
||||
aliases:
|
||||
- maxSecondaryAuthFailures
|
||||
type: int
|
||||
max_temporary_lockouts:
|
||||
description:
|
||||
- The realm max temporary lockouts.
|
||||
@@ -914,6 +920,7 @@ def main():
|
||||
login_with_email_allowed=dict(type="bool", aliases=["loginWithEmailAllowed"]),
|
||||
max_delta_time_seconds=dict(type="int", aliases=["maxDeltaTimeSeconds"]),
|
||||
max_failure_wait_seconds=dict(type="int", aliases=["maxFailureWaitSeconds"]),
|
||||
max_secondary_auth_failures=dict(type="int", aliases=["maxSecondaryAuthFailures"]),
|
||||
max_temporary_lockouts=dict(type="int", aliases=["maxTemporaryLockouts"]),
|
||||
minimum_quick_login_wait_seconds=dict(type="int", aliases=["minimumQuickLoginWaitSeconds"]),
|
||||
not_before=dict(type="int", aliases=["notBefore"]),
|
||||
|
||||
@@ -512,6 +512,7 @@ def main():
|
||||
"groups",
|
||||
"clientConsents",
|
||||
"federatedIdentities",
|
||||
"state",
|
||||
]
|
||||
|
||||
if state == "absent":
|
||||
@@ -554,9 +555,16 @@ def main():
|
||||
# Add user ID to new representation
|
||||
desired_user["id"] = before_user["id"]
|
||||
|
||||
before_user_for_compare = before_user
|
||||
if "attributes" in changeset and "attributes" in before_user:
|
||||
before_user_for_compare = before_user.copy()
|
||||
before_user_for_compare["attributes"] = kc.convert_keycloak_user_attributes_dict_to_module_list(
|
||||
attributes=before_user["attributes"]
|
||||
)
|
||||
|
||||
# Compare users
|
||||
if not (
|
||||
is_struct_included(desired_user, before_user, user_compare_excludes, empty_list_result=False)
|
||||
is_struct_included(desired_user, before_user_for_compare, user_compare_excludes, empty_list_result=False)
|
||||
): # If the new user introduces a change to the existing user
|
||||
# Update the user
|
||||
if not module.check_mode:
|
||||
|
||||
@@ -994,7 +994,6 @@ def main():
|
||||
if changeset.get("mappers") is None:
|
||||
changeset["mappers"] = list()
|
||||
changeset["mappers"].append(new_mapper)
|
||||
changeset["mappers"] = sorted(changeset["mappers"], key=lambda x: x.get("name") or "")
|
||||
|
||||
# to keep unspecified existing mappers we add them to the desired mappers list, unless they're already present
|
||||
if not module.params["remove_unspecified_mappers"] and "mappers" in before_comp:
|
||||
@@ -1003,6 +1002,9 @@ def main():
|
||||
[mapper for mapper in before_comp["mappers"] if mapper["id"] not in changeset_mapper_ids]
|
||||
)
|
||||
|
||||
# ensure idempotency in case module.params.mappers is not sorted by name
|
||||
changeset["mappers"] = sorted(changeset["mappers"], key=lambda x: x.get("name") or "")
|
||||
|
||||
# Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
|
||||
desired_comp = before_comp.copy()
|
||||
desired_comp.update(changeset)
|
||||
|
||||
@@ -337,38 +337,9 @@ def main():
|
||||
module.fail_json(msg=f"Could not fetch client {client_id}:")
|
||||
if roles is None:
|
||||
module.exit_json(msg="Nothing to do (no roles specified).")
|
||||
else:
|
||||
for role in roles:
|
||||
if role.get("name") is None and role.get("id") is None:
|
||||
module.fail_json(msg="Either the `name` or `id` has to be specified on each role.")
|
||||
# Fetch missing role_id
|
||||
if role.get("id") is None:
|
||||
if cid is None:
|
||||
role_id = kc.get_realm_role(name=role.get("name"), realm=realm)["id"]
|
||||
else:
|
||||
role_id = kc.get_client_role_id_by_name(cid=cid, name=role.get("name"), realm=realm)
|
||||
if role_id is not None:
|
||||
role["id"] = role_id
|
||||
else:
|
||||
module.fail_json(
|
||||
msg=f"Could not fetch role {role.get('name')} for client_id {client_id} or realm {realm}"
|
||||
)
|
||||
# Fetch missing role_name
|
||||
else:
|
||||
if cid is None:
|
||||
role_rep = kc.get_realm_user_rolemapping_by_id(uid=uid, rid=role.get("id"), realm=realm)
|
||||
if role_rep is not None:
|
||||
role["name"] = role_rep["name"]
|
||||
else:
|
||||
role_rep = kc.get_client_user_rolemapping_by_id(uid=uid, cid=cid, rid=role.get("id"), realm=realm)
|
||||
if role_rep is not None:
|
||||
role["name"] = role_rep["name"]
|
||||
if role.get("name") is None:
|
||||
module.fail_json(
|
||||
msg=f"Could not fetch role {role.get('id')} for client_id {client_id} or realm {realm}"
|
||||
)
|
||||
|
||||
# Get effective role mappings
|
||||
# Get available and assigned role mappings using user-scoped endpoints
|
||||
# (these do not require the view-realm permission)
|
||||
if cid is None:
|
||||
available_roles_before = kc.get_realm_user_available_rolemappings(uid=uid, realm=realm)
|
||||
assigned_roles_before = kc.get_realm_user_composite_rolemappings(uid=uid, realm=realm)
|
||||
@@ -376,6 +347,38 @@ def main():
|
||||
available_roles_before = kc.get_client_user_available_rolemappings(uid=uid, cid=cid, realm=realm)
|
||||
assigned_roles_before = kc.get_client_user_composite_rolemappings(uid=uid, cid=cid, realm=realm)
|
||||
|
||||
all_known_roles = available_roles_before + assigned_roles_before
|
||||
|
||||
for role in roles:
|
||||
if role.get("name") is None and role.get("id") is None:
|
||||
module.fail_json(msg="Either the `name` or `id` has to be specified on each role.")
|
||||
# Fetch missing role_id
|
||||
if role.get("id") is None:
|
||||
role_id = None
|
||||
for r in all_known_roles:
|
||||
if r["name"] == role.get("name"):
|
||||
role_id = r["id"]
|
||||
break
|
||||
if role_id is not None:
|
||||
role["id"] = role_id
|
||||
else:
|
||||
module.fail_json(
|
||||
msg=f"Could not fetch role {role.get('name')} for client_id {client_id} or realm {realm}"
|
||||
)
|
||||
# Fetch missing role_name
|
||||
elif role.get("name") is None:
|
||||
role_name = None
|
||||
for r in all_known_roles:
|
||||
if r["id"] == role.get("id"):
|
||||
role_name = r["name"]
|
||||
break
|
||||
if role_name is not None:
|
||||
role["name"] = role_name
|
||||
else:
|
||||
module.fail_json(
|
||||
msg=f"Could not fetch role {role.get('id')} for client_id {client_id} or realm {realm}"
|
||||
)
|
||||
|
||||
result["existing"] = assigned_roles_before
|
||||
result["proposed"] = roles
|
||||
|
||||
|
||||
@@ -116,7 +116,7 @@ Role Defaults
|
||||
|`keycloak_management_url` | URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port + keycloak_jboss_port_offset }}` |
|
||||
|`keycloak_frontend_url_force` | Force backend requests to use the frontend URL | `false` |
|
||||
|`keycloak_db_background_validation` | Enable background validation of database connection | `false` |
|
||||
|`keycloak_db_background_validation_millis`| How frequenly the connection pool is validated in the background | `10000` if background validation enabled |
|
||||
|`keycloak_db_background_validation_millis`| How frequently the connection pool is validated in the background | `10000` if background validation enabled |
|
||||
|`keycloak_db_background_validate_on_match` | Enable validate on match for database connections | `false` |
|
||||
|`keycloak_frontend_url` | frontend URL for keycloak endpoint | `http://localhost:8080/auth/` |
|
||||
|`keycloak_log_target`| Set the destination of the keycloak log folder link | `/var/log/keycloak` |
|
||||
@@ -210,6 +210,7 @@ Apache License 2.0
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
* [Ranabir Chakraborty](https://github.com/RanabirChakraborty)
|
||||
* [Guido Grazioli](https://github.com/guidograzioli)
|
||||
* [Romain Pelisse](https://github.com/rpelisse)
|
||||
* [Pavan Kumar Motaparthi](https://github.com/motaparthipavankumar)
|
||||
|
||||
@@ -60,7 +60,7 @@ keycloak_features: []
|
||||
keycloak_ha_enabled: false
|
||||
### Enable database configuration, must be enabled when HA is configured
|
||||
keycloak_db_enabled: "{{ True if keycloak_ha_enabled else False }}"
|
||||
### Discovery protocol for ha cluster members, valus [ 'JDBC_PING', 'TCPPING' ]
|
||||
### Discovery protocol for ha cluster members, values [ 'JDBC_PING', 'TCPPING' ]
|
||||
keycloak_ha_discovery: "{{ 'JDBC_PING' if keycloak_db_enabled else 'TCPPING' }}"
|
||||
### Remote cache store on infinispan cluster
|
||||
keycloak_remote_cache_enabled: "{{ True if keycloak_ha_enabled else False }}"
|
||||
|
||||
@@ -296,7 +296,7 @@ argument_specs:
|
||||
type: "bool"
|
||||
keycloak_db_background_validation_millis:
|
||||
default: "{{ 10000 if keycloak_db_background_validation else 0 }}"
|
||||
description: "How frequenly the connection pool is validated in the background"
|
||||
description: "How frequently the connection pool is validated in the background"
|
||||
type: 'int'
|
||||
keycloak_db_background_validate_on_match:
|
||||
default: false
|
||||
|
||||
@@ -256,8 +256,8 @@
|
||||
{
|
||||
"name": item,
|
||||
"address": 'jgroups-' + item,
|
||||
"inventory_host": hostvars[item].ansible_default_ipv4.address | default(item) + '[' + (keycloak_jgroups_port | string) + ']',
|
||||
"value": hostvars[item].ansible_default_ipv4.address | default(item)
|
||||
"inventory_host": hostvars[item].ansible_facts['default_ipv4']['address'] | default(item) + '[' + (keycloak_jgroups_port | string) + ']',
|
||||
"value": hostvars[item].ansible_facts['default_ipv4']['address'] | default(item)
|
||||
}
|
||||
] }}
|
||||
loop: "{{ ansible_play_batch }}"
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
- name: Distro specific tasks
|
||||
ansible.builtin.include_tasks:
|
||||
file: "{{ ansible_os_family | lower }}.yml"
|
||||
file: "{{ ansible_facts['os_family'] | lower }}.yml"
|
||||
apply:
|
||||
tags:
|
||||
- unbound
|
||||
|
||||
@@ -42,13 +42,13 @@
|
||||
- name: Validate OS family
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- ansible_os_family in ["RedHat", "Debian"]
|
||||
- ansible_facts['os_family'] in ["RedHat", "Debian"]
|
||||
quiet: true
|
||||
fail_msg: "Can only install on RedHat or Debian OS families; found {{ ansible_os_family }}"
|
||||
success_msg: "Installing on {{ ansible_os_family }}"
|
||||
fail_msg: "Can only install on RedHat or Debian OS families; found {{ ansible_facts['os_family'] }}"
|
||||
success_msg: "Installing on {{ ansible_facts['os_family'] }}"
|
||||
|
||||
- name: Load OS specific variables
|
||||
ansible.builtin.include_vars: "vars/{{ ansible_os_family | lower }}.yml"
|
||||
ansible.builtin.include_vars: "vars/{{ ansible_facts['os_family'] | lower }}.yml"
|
||||
tags:
|
||||
- always
|
||||
|
||||
|
||||
@@ -727,8 +727,8 @@
|
||||
<inet-address value="{{ keycloak_management_port_bind_address }}"/>
|
||||
</interface>
|
||||
<interface name="jgroups">
|
||||
{% if ansible_default_ipv4 is defined %}
|
||||
<subnet-match value="{{ (ansible_default_ipv4.network + '/' + ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') }}"/>
|
||||
{% if ansible_facts['default_ipv4'] is defined %}
|
||||
<subnet-match value="{{ (ansible_facts['default_ipv4']['network'] + '/' + ansible_facts['default_ipv4']['netmask']) | ansible.utils.ipaddr('net') }}"/>
|
||||
{% else %}
|
||||
<any-address />
|
||||
{% endif %}
|
||||
|
||||
@@ -724,8 +724,8 @@
|
||||
<inet-address value="${jboss.bind.address.management:127.0.0.1}"/>
|
||||
</interface>
|
||||
<interface name="jgroups">
|
||||
{% if ansible_default_ipv4 is defined %}
|
||||
<subnet-match value="{{ (ansible_default_ipv4.network + '/' + ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') }}"/>
|
||||
{% if ansible_facts['default_ipv4'] is defined %}
|
||||
<subnet-match value="{{ (ansible_facts['default_ipv4']['network'] + '/' + ansible_facts['default_ipv4']['netmask']) | ansible.utils.ipaddr('net') }}"/>
|
||||
{% else %}
|
||||
<any-address />
|
||||
{% endif %}
|
||||
|
||||
@@ -664,8 +664,8 @@
|
||||
<interface name="jgroups">
|
||||
{% if keycloak_jgroups_subnet is defined and keycloak_jgroups_subnet is not none and keycloak_jgroups_subnet | string | length > 0 %}
|
||||
<subnet-match value="{{ keycloak_jgroups_subnet | string }}"/>
|
||||
{% elif ansible_default_ipv4 is defined and (ansible_default_ipv4.network + '/' + ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') | length > 0 %}
|
||||
<subnet-match value="{{ (ansible_default_ipv4.network + '/' + ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') }}"/>
|
||||
{% elif ansible_facts['default_ipv4'] is defined and (ansible_facts['default_ipv4']['network'] + '/' + ansible_facts['default_ipv4']['netmask']) | ansible.utils.ipaddr('net') | length > 0 %}
|
||||
<subnet-match value="{{ (ansible_facts['default_ipv4']['network'] + '/' + ansible_facts['default_ipv4']['netmask']) | ansible.utils.ipaddr('net') }}"/>
|
||||
{% else %}
|
||||
<any-address />
|
||||
{% endif %}
|
||||
|
||||
@@ -702,8 +702,8 @@
|
||||
<interface name="jgroups">
|
||||
{% if keycloak_jgroups_subnet is defined and keycloak_jgroups_subnet is not none and keycloak_jgroups_subnet | string | length > 0 %}
|
||||
<subnet-match value="{{ keycloak_jgroups_subnet | string }}"/>
|
||||
{% elif ansible_default_ipv4 is defined and (ansible_default_ipv4.network + '/' + ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') | length > 0 %}
|
||||
<subnet-match value="{{ (ansible_default_ipv4.network + '/' + ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') }}"/>
|
||||
{% elif ansible_facts['default_ipv4'] is defined and (ansible_facts['default_ipv4']['network'] + '/' + ansible_facts['default_ipv4']['netmask']) | ansible.utils.ipaddr('net') | length > 0 %}
|
||||
<subnet-match value="{{ (ansible_facts['default_ipv4']['network'] + '/' + ansible_facts['default_ipv4']['netmask']) | ansible.utils.ipaddr('net') }}"/>
|
||||
{% else %}
|
||||
<any-address />
|
||||
{% endif %}
|
||||
|
||||
@@ -79,7 +79,7 @@ Role Defaults
|
||||
|`keycloak_quarkus_ha_enabled`| Enable auto configuration for database backend, clustering and remote caches on infinispan | `False` |
|
||||
|`keycloak_quarkus_ha_discovery`| Discovery protocol for HA cluster members | `JDBCPING` |
|
||||
|`keycloak_quarkus_db_enabled`| Enable auto configuration for database backend | `True` if `keycloak_quarkus_ha_enabled` is True, else `False` |
|
||||
|`keycloak_quarkus_jgroups_ip`| Host jgroups IP. If changing this variable you must make sure it is always set for all hosts in your cluster. | `{{ ansible_default_ipv4.address }}` |
|
||||
|`keycloak_quarkus_jgroups_ip`| Host jgroups IP. If changing this variable you must make sure it is always set for all hosts in your cluster. | `{{ ansible_facts['default_ipv4']['address'] }}` |
|
||||
|`keycloak_quarkus_jgroups_port`| jgroups cluster tcp port | `7800` |
|
||||
|`keycloak_quarkus_systemd_wait_for_port` | Whether systemd unit should wait for keycloak port before returning | `{{ keycloak_quarkus_ha_enabled }}` |
|
||||
|`keycloak_quarkus_systemd_wait_for_port_number`| Which port the systemd unit should wait for | `{{ keycloak_quarkus_https_port }}` |
|
||||
@@ -88,7 +88,7 @@ Role Defaults
|
||||
|`keycloak_quarkus_systemd_wait_for_delay`| Activation delay for service systemd unit (seconds) | `10` |
|
||||
|`keycloak_quarkus_restart_strategy`| Strategy task file for restarting in HA (one of provided restart/['serial.yml','none.yml','serial_then_parallel.yml']) or path to file when providing custom strategy | `restart/serial.yml` |
|
||||
|`keycloak_quarkus_restart_health_check`| Whether to wait for successful health check after restart | `true` |
|
||||
|`keycloak_quarkus_restart_health_check_delay`| Seconds to let pass before starting healch checks | `10` |
|
||||
|`keycloak_quarkus_restart_health_check_delay`| Seconds to let pass before starting health checks | `10` |
|
||||
|`keycloak_quarkus_restart_health_check_retries`| Number of attempts for successful health check before failing | `25` |
|
||||
|`keycloak_quarkus_validate_certs`| Whether to validate SSL certificates when performing health checks | `true` |
|
||||
|`keycloak_quarkus_restart_pause`| Seconds to wait between restarts in HA strategy | `15` |
|
||||
@@ -311,4 +311,5 @@ Apache License 2.0
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
* [Ranabir Chakraborty](https://github.com/RanabirChakraborty)
|
||||
* [Guido Grazioli](https://github.com/guidograzioli)
|
||||
|
||||
@@ -43,7 +43,7 @@ keycloak_quarkus_http_port: 8080
|
||||
keycloak_quarkus_https_port: 8443
|
||||
keycloak_quarkus_http_management_port: 9000
|
||||
keycloak_quarkus_jgroups_port: 7800
|
||||
keycloak_quarkus_jgroups_bind_address: "{{ ansible_default_ipv4.address }}"
|
||||
keycloak_quarkus_jgroups_bind_address: "{{ ansible_facts['default_ipv4']['address'] }}"
|
||||
keycloak_quarkus_jgroups_external_addr: "{{ keycloak_quarkus_jgroups_bind_address }}"
|
||||
keycloak_quarkus_jgroups_external_port: "{{ keycloak_quarkus_jgroups_port }}"
|
||||
keycloak_quarkus_java_heap_opts: "-Xms1024m -Xmx2048m"
|
||||
@@ -95,7 +95,7 @@ keycloak_quarkus_hostname:
|
||||
keycloak_quarkus_hostname_admin: ""
|
||||
|
||||
### Set the path relative to / for serving resources. The path must start with a /
|
||||
### (set to `/auth` for retrocompatibility with pre-quarkus releases)
|
||||
### (set to `/auth` for backward compatibility with pre-quarkus releases)
|
||||
keycloak_quarkus_http_relative_path: /
|
||||
|
||||
# Disables dynamically resolving the hostname from request headers.
|
||||
@@ -188,7 +188,7 @@ keycloak_quarkus_restart_health_check_delay: 10
|
||||
keycloak_quarkus_restart_health_check_retries: 25
|
||||
keycloak_quarkus_validate_certs: true
|
||||
keycloak_quarkus_health_check_url_path: "realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration"
|
||||
keycloak_quarkus_health_check_url: "{{ keycloak_quarkus_hostname ~ keycloak_quarkus_http_relative_path.rstrip('/') ~ '/' ~ keycloak_quarkus_health_check_url_path }}"
|
||||
keycloak_quarkus_health_check_url: "{{ keycloak_quarkus_hostname.rstrip('/').removesuffix(keycloak_quarkus_http_relative_path.rstrip('/')) ~ keycloak_quarkus_http_relative_path.rstrip('/') ~ '/' ~ keycloak_quarkus_health_check_url_path }}"
|
||||
keycloak_quarkus_restart_pause: 15
|
||||
|
||||
keycloak_quarkus_force_install: false
|
||||
|
||||
@@ -115,7 +115,7 @@ argument_specs:
|
||||
description: "HTTP port"
|
||||
type: "int"
|
||||
keycloak_quarkus_health_check_url:
|
||||
default: "{{ keycloak_quarkus_hostname ~ keycloak_quarkus_http_relative_path.rstrip('/') ~ '/' ~ keycloak_quarkus_health_check_url_path }}"
|
||||
default: "{{ keycloak_quarkus_hostname.rstrip('/').removesuffix(keycloak_quarkus_http_relative_path.rstrip('/')) ~ keycloak_quarkus_http_relative_path.rstrip('/') ~ '/' ~ keycloak_quarkus_health_check_url_path }}"
|
||||
description: "Full URL (including scheme, host, path, fragment etc.) used for health check endpoint; keycloak_quarkus_hostname will NOT be prepended; helpful when health checks should happen against http port, but keycloak_quarkus_hostname uses https scheme per default"
|
||||
type: "str"
|
||||
keycloak_quarkus_health_check_url_path:
|
||||
@@ -206,7 +206,7 @@ argument_specs:
|
||||
type: "int"
|
||||
keycloak_quarkus_jgroups_bind_address:
|
||||
description: 'jgroups bind address'
|
||||
default: "{{ ansible_default_ipv4.address }}"
|
||||
default: "{{ ansible_facts['default_ipv4']['address'] }}"
|
||||
type: "str"
|
||||
keycloak_quarkus_jgroups_external_addr:
|
||||
description: 'IP address that other instances in the Keycloak should use to contact this node'
|
||||
@@ -482,7 +482,7 @@ argument_specs:
|
||||
default: 15
|
||||
type: int
|
||||
keycloak_quarkus_restart_health_check_delay:
|
||||
description: "Seconds to let pass before starting healch checks"
|
||||
description: "Seconds to let pass before starting health checks"
|
||||
default: 10
|
||||
type: 'int'
|
||||
keycloak_quarkus_restart_health_check_retries:
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
- name: Distro specific tasks
|
||||
ansible.builtin.include_tasks:
|
||||
file: "{{ ansible_os_family | lower }}.yml"
|
||||
file: "{{ ansible_facts['os_family'] | lower }}.yml"
|
||||
apply:
|
||||
tags:
|
||||
- unbound
|
||||
|
||||
@@ -39,13 +39,13 @@
|
||||
- name: Validate OS family
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- ansible_os_family in ["RedHat", "Debian"]
|
||||
- ansible_facts['os_family'] in ["RedHat", "Debian"]
|
||||
quiet: true
|
||||
fail_msg: "Can only install on RedHat or Debian OS families; found {{ ansible_os_family }}"
|
||||
success_msg: "Installing on {{ ansible_os_family }}"
|
||||
fail_msg: "Can only install on RedHat or Debian OS families; found {{ ansible_facts['os_family'] }}"
|
||||
success_msg: "Installing on {{ ansible_facts['os_family'] }}"
|
||||
|
||||
- name: Load OS specific variables
|
||||
ansible.builtin.include_vars: "vars/{{ ansible_os_family | lower }}.yml"
|
||||
ansible.builtin.include_vars: "vars/{{ ansible_facts['os_family'] | lower }}.yml"
|
||||
tags:
|
||||
- always
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
- name: "Restart services in serial, with optional healtch check (keycloak_quarkus_restart_health_check)"
|
||||
- name: "Restart services in serial, with optional health check (keycloak_quarkus_restart_health_check)"
|
||||
throttle: 1
|
||||
block:
|
||||
- name: "Restart and enable service: {{ keycloak.service_name }}"
|
||||
|
||||
@@ -192,5 +192,6 @@ Apache License 2.0
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
* [Ranabir Chakraborty](https://github.com/RanabirChakraborty)
|
||||
* [Guido Grazioli](https://github.com/guidograzioli)
|
||||
* [Romain Pelisse](https://github.com/rpelisse)
|
||||
|
||||
@@ -39,7 +39,7 @@ keycloak_realm_clients: []
|
||||
# list of roles to create in the client
|
||||
keycloak_realm_client_default_roles: []
|
||||
|
||||
# if True, create a public client; otherwise, a confidetial client
|
||||
# if True, create a public client; otherwise, a confidential client
|
||||
keycloak_realm_client_public: true
|
||||
|
||||
# allowed web origins for the client
|
||||
|
||||
Reference in New Issue
Block a user