mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2026-11-22 07:00:33 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a1ed36e919 | ||
|
|
37e96d9bc0 | ||
|
|
d8d36a41a8 | ||
|
|
e8031923af | ||
|
|
eee2472cd6 | ||
|
|
45e91f4e3f | ||
|
|
f3b484acdd | ||
|
|
7d9e99b370 | ||
|
|
2b4ce2694c | ||
|
|
44e3f0078f | ||
|
|
034a3bac52 | ||
|
|
2bb6946fb9 | ||
|
|
48d014cb18 | ||
|
|
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 | ||
|
|
a965f47fb8 | ||
|
|
15356606f3 | ||
|
|
8021fd735d | ||
|
|
412f3f405d | ||
|
|
e5f6f92c5d | ||
|
|
3d9c71a2e6 | ||
|
|
742c44039c | ||
|
|
9c347d1bf0 | ||
|
|
6023cff8ca | ||
|
|
fd13175e45 | ||
|
|
c831534a48 | ||
|
|
192061d1b5 | ||
|
|
bba9d8bb23 | ||
|
|
7a1dbad76f | ||
|
|
50e1d93184 | ||
|
|
786ef844f8 | ||
|
|
8d44d73394 | ||
|
|
c8253fdbf8 | ||
|
|
9abf2e832b | ||
|
|
9e5946a2a4 | ||
|
|
ef2f24e9fc | ||
|
|
866c5e2255 | ||
|
|
a0b924b593 | ||
|
|
95c6fe1b50 | ||
|
|
9bb680b8e6 | ||
|
|
1f0a7c289f | ||
|
|
ff51c4098a | ||
|
|
f2792e32ba | ||
|
|
4f62617f2c | ||
|
|
edb38ebb3d | ||
|
|
d25bf46a6a | ||
|
|
74ca1e05ef | ||
|
|
b9181abb24 | ||
|
|
d4eafe1b30 | ||
|
|
19bd41a86a | ||
|
|
b44d754b8c |
@@ -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
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: github-actions
|
||||||
|
directory: /
|
||||||
|
schedule:
|
||||||
|
# Weekly keeps Actions dependency PRs current without daily CI load.
|
||||||
|
interval: weekly
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
---
|
||||||
|
# Partner Certification Checker workflow for Automation Hub requirements.
|
||||||
|
# See: https://github.com/ansible-collections/partner-certification-checker
|
||||||
|
name: Run collection certification checks
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: cert-ver-${{ github.head_ref || github.run_id }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
# Files that are not related to the core functionality of your collection can
|
||||||
|
# cause Ansible Lint to fail. If this happens, add an .ansible-lint file that
|
||||||
|
# excludes those paths. See .ansible-lint in this repository.
|
||||||
|
#
|
||||||
|
# If there are sanity test failures that cannot be fixed, create a sanity ignore
|
||||||
|
# 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@fefb6b967e99964b55665b66ef0d8e4148d84aca # v5.0.0
|
||||||
@@ -14,6 +14,18 @@ on:
|
|||||||
- cron: '15 6 * * *'
|
- cron: '15 6 * * *'
|
||||||
|
|
||||||
jobs:
|
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:
|
ci:
|
||||||
uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm
|
uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm
|
||||||
secrets: inherit
|
secrets: inherit
|
||||||
@@ -22,4 +34,4 @@ jobs:
|
|||||||
root_permission_varname: 'keycloak_install_requires_become'
|
root_permission_varname: 'keycloak_install_requires_become'
|
||||||
debug_verbosity: "${{ github.event.inputs.debug_verbosity }}"
|
debug_verbosity: "${{ github.event.inputs.debug_verbosity }}"
|
||||||
molecule_tests: >-
|
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" ]
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
name: Publish collection
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish:
|
||||||
|
uses: ansible-middleware/github-actions/.github/workflows/publish.yml@main
|
||||||
|
with:
|
||||||
|
collection_fqcn: 'middleware_automation.keycloak'
|
||||||
|
downstream_name: 'rhbk'
|
||||||
|
secrets:
|
||||||
|
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
|
||||||
|
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
|
||||||
|
push_token: ${{ secrets.TRIGGERING_PAT }}
|
||||||
|
|
||||||
|
dispatch:
|
||||||
|
needs: publish
|
||||||
|
if: needs.publish.result == 'success'
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
repo: ['ansible-middleware/ansible-middleware-ee']
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Repository Dispatch
|
||||||
|
uses: peter-evans/repository-dispatch@v4
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.TRIGGERING_PAT }}
|
||||||
|
repository: ${{ matrix.repo }}
|
||||||
|
event-type: "Dependency released - Keycloak v${{ needs.publish.outputs.tag_version }}"
|
||||||
|
client-payload: '{ "github": ${{toJson(github)}} }'
|
||||||
@@ -17,18 +17,4 @@ jobs:
|
|||||||
secrets:
|
secrets:
|
||||||
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
|
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
|
||||||
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
|
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
|
||||||
|
push_token: ${{ secrets.TRIGGERING_PAT }}
|
||||||
dispatch:
|
|
||||||
needs: release
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
repo: ['ansible-middleware/ansible-middleware-ee']
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Repository Dispatch
|
|
||||||
uses: peter-evans/repository-dispatch@v1
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.TRIGGERING_PAT }}
|
|
||||||
repository: ${{ matrix.repo }}
|
|
||||||
event-type: "Dependency released - Keycloak v${{ needs.release.outputs.tag_version }}"
|
|
||||||
client-payload: '{ "github": ${{toJson(github)}} }'
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ jobs:
|
|||||||
traffic:
|
traffic:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v7
|
||||||
with:
|
with:
|
||||||
ref: "gh-pages"
|
ref: "gh-pages"
|
||||||
|
|
||||||
@@ -18,7 +18,7 @@ jobs:
|
|||||||
TRAFFIC_ACTION_TOKEN: ${{ secrets.TRIGGERING_PAT }}
|
TRAFFIC_ACTION_TOKEN: ${{ secrets.TRIGGERING_PAT }}
|
||||||
|
|
||||||
- name: Commit changes
|
- name: Commit changes
|
||||||
uses: EndBug/add-and-commit@v4
|
uses: EndBug/add-and-commit@v11
|
||||||
with:
|
with:
|
||||||
author_name: Ansible Middleware
|
author_name: Ansible Middleware
|
||||||
message: "GitHub traffic"
|
message: "GitHub traffic"
|
||||||
|
|||||||
@@ -11,6 +11,9 @@ docs/_build/
|
|||||||
.mypy_cache/
|
.mypy_cache/
|
||||||
*.retry
|
*.retry
|
||||||
changelogs/.plugin-cache.yaml
|
changelogs/.plugin-cache.yaml
|
||||||
|
changelogs/fragments/*.yaml
|
||||||
|
changelogs/fragments/*.yml
|
||||||
|
|
||||||
*.pem
|
*.pem
|
||||||
*.key
|
*.key
|
||||||
*.p12
|
*.p12
|
||||||
|
|||||||
@@ -6,6 +6,59 @@ middleware\_automation.keycloak Release Notes
|
|||||||
|
|
||||||
This changelog describes changes after version 0.2.6.
|
This changelog describes changes after version 0.2.6.
|
||||||
|
|
||||||
|
v3.1.1
|
||||||
|
======
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Add support for the ``description`` attribute of keycloak groups `#419 <https://github.com/ansible-middleware/keycloak/pull/419>`_
|
||||||
|
- Bump Keycloak to 26.7.3 and RHBK to 26.4.15 `#422 <https://github.com/ansible-middleware/keycloak/pull/422>`_
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Fix keycloak_quarkus_health_check_url crash when hostname is unset `#424 <https://github.com/ansible-middleware/keycloak/pull/424>`_
|
||||||
|
|
||||||
|
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
|
||||||
|
=======
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Add certification checks to the upstream repo `#378 <https://github.com/ansible-middleware/keycloak/pull/378>`_
|
||||||
|
- Fix cert workflow `#389 <https://github.com/ansible-middleware/keycloak/pull/389>`_
|
||||||
|
- Fix health check URL to include HTTP relative path `#364 <https://github.com/ansible-middleware/keycloak/pull/364>`_
|
||||||
|
- fix(keycloak_quarkus): avoid leaking maven provider password in logs `#363 <https://github.com/ansible-middleware/keycloak/pull/363>`_
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- AMW-592 AMW Github Actions are failing because of latest molecule `#366 <https://github.com/ansible-middleware/keycloak/pull/366>`_
|
||||||
|
- AMW-594 Upstream release is failing due to recent rules change `#373 <https://github.com/ansible-middleware/keycloak/pull/373>`_
|
||||||
|
|
||||||
v3.0.10
|
v3.0.10
|
||||||
=======
|
=======
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -10,7 +10,7 @@ Clone the repository, checkout the tag you want to build, or pick the main branc
|
|||||||
|
|
||||||
### Development environment
|
### Development environment
|
||||||
|
|
||||||
Make sure your development machine has avilable:
|
Make sure your development machine has available:
|
||||||
|
|
||||||
* python 3.11+
|
* python 3.11+
|
||||||
* virtualenv
|
* virtualenv
|
||||||
|
|||||||
@@ -85,6 +85,7 @@ All Keycloak administration modules from `community.general` are provided in thi
|
|||||||
* `keycloak_realm_keys_metadata_info`: retrieve realm keys metadata.
|
* `keycloak_realm_keys_metadata_info`: retrieve realm keys metadata.
|
||||||
* `keycloak_realm_localization`: manage realm localization texts.
|
* `keycloak_realm_localization`: manage realm localization texts.
|
||||||
* `keycloak_realm_rolemapping`: manage realm role mappings for users and groups.
|
* `keycloak_realm_rolemapping`: manage realm role mappings for users and groups.
|
||||||
|
* `keycloak_realm_users_info`: retrieve users from a realm.
|
||||||
* `keycloak_role`: manage realm and client roles.
|
* `keycloak_role`: manage realm and client roles.
|
||||||
* `keycloak_user`: manage users (create/update/delete).
|
* `keycloak_user`: manage users (create/update/delete).
|
||||||
* `keycloak_user_execute_actions_email`: trigger execute-actions emails for users.
|
* `keycloak_user_execute_actions_email`: trigger execute-actions emails for users.
|
||||||
|
|||||||
@@ -698,6 +698,37 @@ releases:
|
|||||||
- 358.yaml
|
- 358.yaml
|
||||||
- 359.yaml
|
- 359.yaml
|
||||||
release_date: '2026-06-25'
|
release_date: '2026-06-25'
|
||||||
|
3.0.11:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- 'AMW-592 AMW Github Actions are failing because of latest molecule `#366 <https://github.com/ansible-middleware/keycloak/pull/366>`_
|
||||||
|
|
||||||
|
'
|
||||||
|
- 'AMW-594 Upstream release is failing due to recent rules change `#373 <https://github.com/ansible-middleware/keycloak/pull/373>`_
|
||||||
|
|
||||||
|
'
|
||||||
|
minor_changes:
|
||||||
|
- 'Add certification checks to the upstream repo `#378 <https://github.com/ansible-middleware/keycloak/pull/378>`_
|
||||||
|
|
||||||
|
'
|
||||||
|
- 'Fix cert workflow `#389 <https://github.com/ansible-middleware/keycloak/pull/389>`_
|
||||||
|
|
||||||
|
'
|
||||||
|
- 'Fix health check URL to include HTTP relative path `#364 <https://github.com/ansible-middleware/keycloak/pull/364>`_
|
||||||
|
|
||||||
|
'
|
||||||
|
- 'fix(keycloak_quarkus): avoid leaking maven provider password in logs `#363
|
||||||
|
<https://github.com/ansible-middleware/keycloak/pull/363>`_
|
||||||
|
|
||||||
|
'
|
||||||
|
fragments:
|
||||||
|
- 363.yaml
|
||||||
|
- 364.yaml
|
||||||
|
- 366.yaml
|
||||||
|
- 373.yaml
|
||||||
|
- 378.yaml
|
||||||
|
- 389.yaml
|
||||||
|
release_date: '2026-08-24'
|
||||||
3.0.2:
|
3.0.2:
|
||||||
changes:
|
changes:
|
||||||
bugfixes:
|
bugfixes:
|
||||||
@@ -860,3 +891,92 @@ releases:
|
|||||||
fragments:
|
fragments:
|
||||||
- 344.yaml
|
- 344.yaml
|
||||||
release_date: '2026-06-11'
|
release_date: '2026-06-11'
|
||||||
|
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.1.1:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- 'Fix keycloak_quarkus_health_check_url crash when hostname is unset `#424
|
||||||
|
<https://github.com/ansible-middleware/keycloak/pull/424>`_
|
||||||
|
|
||||||
|
'
|
||||||
|
minor_changes:
|
||||||
|
- 'Add support for the ``description`` attribute of keycloak groups `#419 <https://github.com/ansible-middleware/keycloak/pull/419>`_
|
||||||
|
|
||||||
|
'
|
||||||
|
- 'Bump Keycloak to 26.7.3 and RHBK to 26.4.15 `#422 <https://github.com/ansible-middleware/keycloak/pull/422>`_
|
||||||
|
|
||||||
|
'
|
||||||
|
fragments:
|
||||||
|
- 419.yaml
|
||||||
|
- 422.yaml
|
||||||
|
- 424.yaml
|
||||||
|
release_date: '2026-09-18'
|
||||||
|
|||||||
@@ -1,2 +0,0 @@
|
|||||||
*
|
|
||||||
!.gitignore
|
|
||||||
+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
|
namespace: middleware_automation
|
||||||
name: keycloak
|
name: keycloak
|
||||||
version: "3.0.10"
|
version: "3.1.1"
|
||||||
readme: README.md
|
readme: README.md
|
||||||
authors:
|
authors:
|
||||||
- Romain Pelisse <rpelisse@redhat.com>
|
- Romain Pelisse <rpelisse@redhat.com>
|
||||||
- Guido Grazioli <ggraziol@redhat.com>
|
- Guido Grazioli <ggraziol@redhat.com>
|
||||||
|
- Ranabir Chakraborty <ranabir@ibm.com>
|
||||||
- Pavan Kumar Motaparthi <pmotapar@redhat.com>
|
- Pavan Kumar Motaparthi <pmotapar@redhat.com>
|
||||||
- Helmut Wolf <hwo@world-direct.at>
|
- Helmut Wolf <hwo@world-direct.at>
|
||||||
- Harsha Cherukuri <hcheruku@redhat.com>
|
- Harsha Cherukuri <hcheruku@redhat.com>
|
||||||
|
|||||||
@@ -0,0 +1,14 @@
|
|||||||
|
v3.1.1
|
||||||
|
======
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Add support for the ``description`` attribute of keycloak groups #419
|
||||||
|
- Bump Keycloak to 26.7.3 and RHBK to 26.4.15 #422
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Fix keycloak_quarkus_health_check_url crash when hostname is unset #424
|
||||||
|
|
||||||
@@ -23,12 +23,15 @@ action_groups:
|
|||||||
- keycloak_component_info
|
- keycloak_component_info
|
||||||
- keycloak_group
|
- keycloak_group
|
||||||
- keycloak_identity_provider
|
- keycloak_identity_provider
|
||||||
|
- keycloak_organization
|
||||||
|
- keycloak_organization_info
|
||||||
- keycloak_realm
|
- keycloak_realm
|
||||||
- keycloak_realm_info
|
- keycloak_realm_info
|
||||||
- keycloak_realm_key
|
- keycloak_realm_key
|
||||||
- keycloak_realm_keys_metadata_info
|
- keycloak_realm_keys_metadata_info
|
||||||
- keycloak_realm_localization
|
- keycloak_realm_localization
|
||||||
- keycloak_realm_rolemapping
|
- keycloak_realm_rolemapping
|
||||||
|
- keycloak_realm_users_info
|
||||||
- keycloak_role
|
- keycloak_role
|
||||||
- keycloak_user
|
- keycloak_user
|
||||||
- keycloak_user_federation
|
- keycloak_user_federation
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ platforms:
|
|||||||
image: ghcr.io/hspaans/molecule-containers:debian-13
|
image: ghcr.io/hspaans/molecule-containers:debian-13
|
||||||
pre_build_image: true
|
pre_build_image: true
|
||||||
privileged: true
|
privileged: true
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8443/tcp"
|
- "8443/tcp"
|
||||||
- "8009/tcp"
|
- "8009/tcp"
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ platforms:
|
|||||||
pre_build_image: true
|
pre_build_image: true
|
||||||
privileged: true
|
privileged: true
|
||||||
command: "/usr/sbin/init"
|
command: "/usr/sbin/init"
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8443/tcp"
|
- "8443/tcp"
|
||||||
- "8009/tcp"
|
- "8009/tcp"
|
||||||
|
|||||||
@@ -20,7 +20,7 @@
|
|||||||
|
|
||||||
- name: Download keycloak archive to controller directory
|
- name: Download keycloak archive to controller directory
|
||||||
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
|
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
|
url: https://github.com/keycloak/keycloak/releases/download/26.7.3/keycloak-26.7.3.zip
|
||||||
dest: /tmp/keycloak
|
dest: /tmp/keycloak
|
||||||
mode: '0640'
|
mode: '0640'
|
||||||
validate_certs: false
|
validate_certs: false
|
||||||
@@ -38,7 +38,7 @@
|
|||||||
client_id: "{{ rhn_username }}"
|
client_id: "{{ rhn_username }}"
|
||||||
client_secret: "{{ rhn_password }}"
|
client_secret: "{{ rhn_password }}"
|
||||||
product_type: DISTRIBUTION
|
product_type: DISTRIBUTION
|
||||||
product_version: "{{ keycloak_quarkus_version | default('26.6.2') }}"
|
product_version: "{{ keycloak_quarkus_version | default('26.7.3') }}"
|
||||||
product_category: "RHBK"
|
product_category: "RHBK"
|
||||||
register: rhn_products
|
register: rhn_products
|
||||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||||
@@ -48,7 +48,7 @@
|
|||||||
|
|
||||||
- name: Determine install zipfile from search results
|
- name: Determine install zipfile from search results
|
||||||
ansible.builtin.set_fact:
|
ansible.builtin.set_fact:
|
||||||
rhn_matched_products: "{{ rhn_products.results | selectattr('file_name', 'match', '.*keycloak-' + (keycloak_quarkus_version | default('26.6.2')) + '.zip$') }}"
|
rhn_matched_products: "{{ rhn_products.results | selectattr('file_name', 'match', '.*keycloak-' + (keycloak_quarkus_version | default('26.7.3')) + '.zip$') }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
run_once: true
|
run_once: true
|
||||||
when:
|
when:
|
||||||
@@ -60,7 +60,7 @@
|
|||||||
client_id: "{{ rhn_username }}"
|
client_id: "{{ rhn_username }}"
|
||||||
client_secret: "{{ rhn_password }}"
|
client_secret: "{{ rhn_password }}"
|
||||||
product_id: "{{ (rhn_matched_products | first).id }}"
|
product_id: "{{ (rhn_matched_products | first).id }}"
|
||||||
dest: "/tmp/keycloak/keycloak-{{ keycloak_quarkus_version | default('26.6.2') }}.zip"
|
dest: "/tmp/keycloak/keycloak-{{ keycloak_quarkus_version | default('26.7.3') }}.zip"
|
||||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
run_once: true
|
run_once: true
|
||||||
|
|||||||
@@ -1,4 +1,9 @@
|
|||||||
---
|
---
|
||||||
|
keycloak_download_validate_certs: false
|
||||||
|
keycloak_validate_certs: false
|
||||||
|
keycloak_quarkus_download_validate_certs: false
|
||||||
|
keycloak_quarkus_validate_certs: false
|
||||||
|
keycloak_realm_validate_certs: false
|
||||||
keycloak_quarkus_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
|
keycloak_quarkus_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
|
||||||
keycloak_quarkus_systemd_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
|
keycloak_quarkus_systemd_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
|
||||||
keycloak_quarkus_install_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
|
keycloak_quarkus_install_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
|
||||||
|
|||||||
@@ -7,12 +7,11 @@
|
|||||||
keycloak_quarkus_show_deprecation_warnings: false
|
keycloak_quarkus_show_deprecation_warnings: false
|
||||||
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
||||||
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
|
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
|
||||||
keycloak_quarkus_hostname: https://proxy
|
keycloak_quarkus_hostname: "http://proxy:{{ keycloak_quarkus_http_port }}"
|
||||||
keycloak_quarkus_log: file
|
keycloak_quarkus_log: file
|
||||||
keycloak_quarkus_http_enabled: True
|
keycloak_quarkus_http_enabled: True
|
||||||
keycloak_quarkus_http_port: 8080
|
keycloak_quarkus_http_port: 8080
|
||||||
keycloak_quarkus_proxy_mode: edge
|
keycloak_quarkus_proxy_mode: edge
|
||||||
keycloak_quarkus_http_relative_path: /
|
keycloak_quarkus_http_relative_path: /
|
||||||
keycloak_quarkus_health_check_url: http://proxy:8080/realms/master/.well-known/openid-configuration
|
|
||||||
roles:
|
roles:
|
||||||
- role: keycloak_quarkus
|
- role: keycloak_quarkus
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ platforms:
|
|||||||
command: "/usr/sbin/init"
|
command: "/usr/sbin/init"
|
||||||
networks:
|
networks:
|
||||||
- name: keycloak
|
- name: keycloak
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
published_ports:
|
published_ports:
|
||||||
- 0.0.0.0:8080:8080/tcp
|
- 0.0.0.0:8080:8080/tcp
|
||||||
@@ -20,7 +20,7 @@ platforms:
|
|||||||
command: "/usr/sbin/init"
|
command: "/usr/sbin/init"
|
||||||
networks:
|
networks:
|
||||||
- name: keycloak
|
- name: keycloak
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "443/tcp"
|
- "443/tcp"
|
||||||
published_ports:
|
published_ports:
|
||||||
- 0.0.0.0:443:443/tcp
|
- 0.0.0.0:443:443/tcp
|
||||||
|
|||||||
@@ -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
|
||||||
@@ -7,7 +7,7 @@ platforms:
|
|||||||
pre_build_image: true
|
pre_build_image: true
|
||||||
privileged: true
|
privileged: true
|
||||||
command: "/usr/sbin/init"
|
command: "/usr/sbin/init"
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8443/tcp"
|
- "8443/tcp"
|
||||||
- "8009/tcp"
|
- "8009/tcp"
|
||||||
|
|||||||
@@ -12,6 +12,7 @@
|
|||||||
client: molecule-client
|
client: molecule-client
|
||||||
scope: molecule-scope
|
scope: molecule-scope
|
||||||
group: molecule-group
|
group: molecule-group
|
||||||
|
subgroup: molecule-subgroup
|
||||||
user: molecule-user
|
user: molecule-user
|
||||||
flow: molecule-flow
|
flow: molecule-flow
|
||||||
flow_v2: molecule-flow-v2
|
flow_v2: molecule-flow-v2
|
||||||
@@ -46,12 +47,15 @@
|
|||||||
- keycloak_component_info
|
- keycloak_component_info
|
||||||
- keycloak_group
|
- keycloak_group
|
||||||
- keycloak_identity_provider
|
- keycloak_identity_provider
|
||||||
|
- keycloak_organization
|
||||||
|
- keycloak_organization_info
|
||||||
- keycloak_realm
|
- keycloak_realm
|
||||||
- keycloak_realm_info
|
- keycloak_realm_info
|
||||||
- keycloak_realm_key
|
- keycloak_realm_key
|
||||||
- keycloak_realm_keys_metadata_info
|
- keycloak_realm_keys_metadata_info
|
||||||
- keycloak_realm_localization
|
- keycloak_realm_localization
|
||||||
- keycloak_realm_rolemapping
|
- keycloak_realm_rolemapping
|
||||||
|
- keycloak_realm_users_info
|
||||||
- keycloak_role
|
- keycloak_role
|
||||||
- keycloak_user
|
- keycloak_user
|
||||||
- keycloak_user_execute_actions_email
|
- keycloak_user_execute_actions_email
|
||||||
@@ -90,6 +94,7 @@
|
|||||||
auth_realm: "{{ auth_realm }}"
|
auth_realm: "{{ auth_realm }}"
|
||||||
auth_username: "{{ auth_username }}"
|
auth_username: "{{ auth_username }}"
|
||||||
auth_password: "{{ auth_password }}"
|
auth_password: "{{ auth_password }}"
|
||||||
|
validate_certs: false
|
||||||
block:
|
block:
|
||||||
- name: Reset fixtures from a previous verify run
|
- name: Reset fixtures from a previous verify run
|
||||||
middleware_automation.keycloak.keycloak_user:
|
middleware_automation.keycloak.keycloak_user:
|
||||||
@@ -154,6 +159,35 @@
|
|||||||
enabled: true
|
enabled: true
|
||||||
state: present
|
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
|
- name: keycloak_authentication_flow — create browser-style flow
|
||||||
middleware_automation.keycloak.keycloak_authentication_flow:
|
middleware_automation.keycloak.keycloak_authentication_flow:
|
||||||
realm: "{{ target_realm }}"
|
realm: "{{ target_realm }}"
|
||||||
@@ -168,6 +202,7 @@
|
|||||||
middleware_automation.keycloak.keycloak_realm_info:
|
middleware_automation.keycloak.keycloak_realm_info:
|
||||||
auth_keycloak_url: "{{ auth_keycloak_url }}"
|
auth_keycloak_url: "{{ auth_keycloak_url }}"
|
||||||
realm: "{{ target_realm }}"
|
realm: "{{ target_realm }}"
|
||||||
|
validate_certs: false
|
||||||
|
|
||||||
- name: Exercise migrated modules against running Keycloak
|
- name: Exercise migrated modules against running Keycloak
|
||||||
module_defaults:
|
module_defaults:
|
||||||
@@ -176,6 +211,7 @@
|
|||||||
auth_realm: "{{ auth_realm }}"
|
auth_realm: "{{ auth_realm }}"
|
||||||
auth_username: "{{ auth_username }}"
|
auth_username: "{{ auth_username }}"
|
||||||
auth_password: "{{ auth_password }}"
|
auth_password: "{{ auth_password }}"
|
||||||
|
validate_certs: false
|
||||||
block:
|
block:
|
||||||
- name: keycloak_realm_keys_metadata_info — query realm keys
|
- name: keycloak_realm_keys_metadata_info — query realm keys
|
||||||
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
|
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
|
||||||
@@ -185,6 +221,18 @@
|
|||||||
middleware_automation.keycloak.keycloak_component_info:
|
middleware_automation.keycloak.keycloak_component_info:
|
||||||
realm: "{{ target_realm }}"
|
realm: "{{ target_realm }}"
|
||||||
|
|
||||||
|
- name: keycloak_realm_users_info — list users in realm
|
||||||
|
middleware_automation.keycloak.keycloak_realm_users_info:
|
||||||
|
realm: "{{ target_realm }}"
|
||||||
|
register: realm_users_info_result
|
||||||
|
|
||||||
|
- name: Assert keycloak_realm_users_info returns the molecule user
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- realm_users_info_result is not changed
|
||||||
|
- realm_users_info_result.users | length > 0
|
||||||
|
- realm_users_info_result.users | selectattr('username', 'equalto', user) | list | length == 1
|
||||||
|
|
||||||
- name: keycloak_realm — create ephemeral realm
|
- name: keycloak_realm — create ephemeral realm
|
||||||
middleware_automation.keycloak.keycloak_realm:
|
middleware_automation.keycloak.keycloak_realm:
|
||||||
id: "{{ ephemeral_realm }}"
|
id: "{{ ephemeral_realm }}"
|
||||||
@@ -192,6 +240,213 @@
|
|||||||
enabled: true
|
enabled: true
|
||||||
state: present
|
state: present
|
||||||
|
|
||||||
|
- name: keycloak_realm — modify realm attributes without pruning undefined attributes. Step 1 - Introduce custom realm attributes
|
||||||
|
middleware_automation.keycloak.keycloak_realm:
|
||||||
|
id: "{{ ephemeral_realm }}"
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
enabled: true
|
||||||
|
state: present
|
||||||
|
prune_undefined_realm_attributes: false
|
||||||
|
attributes:
|
||||||
|
custom-realm-attribute-1: 123
|
||||||
|
custom-realm-attribute-2: true
|
||||||
|
register: custom_realm_attributes_result
|
||||||
|
|
||||||
|
- name: Assert realm attribute without pruning undefined data result (Step 1)
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- custom_realm_attributes_result is changed
|
||||||
|
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] == "123"
|
||||||
|
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] == "true"
|
||||||
|
|
||||||
|
- name: keycloak_realm — modify realm attributes without pruning undefined attributes. Step 2 - Verify unchanged custom realm attributes
|
||||||
|
middleware_automation.keycloak.keycloak_realm:
|
||||||
|
id: "{{ ephemeral_realm }}"
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
enabled: true
|
||||||
|
state: present
|
||||||
|
prune_undefined_realm_attributes: false
|
||||||
|
attributes:
|
||||||
|
custom-realm-attribute-2: false
|
||||||
|
register: custom_realm_attributes_result
|
||||||
|
|
||||||
|
- name: Assert realm attribute without pruning undefined data result (Step 2)
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- custom_realm_attributes_result is changed
|
||||||
|
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] == "123" # should still be 123
|
||||||
|
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] == "false"
|
||||||
|
|
||||||
|
- name: keycloak_realm — modify realm attributes with pruning undefined attributes
|
||||||
|
middleware_automation.keycloak.keycloak_realm:
|
||||||
|
id: "{{ ephemeral_realm }}"
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
enabled: true
|
||||||
|
state: present
|
||||||
|
prune_undefined_realm_attributes: true
|
||||||
|
attributes:
|
||||||
|
custom-realm-attribute-3: custom-attribute-3
|
||||||
|
register: custom_realm_attributes_result
|
||||||
|
|
||||||
|
- name: Assert realm attribute with pruning undefined data result
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- custom_realm_attributes_result is changed
|
||||||
|
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] is not defined
|
||||||
|
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] is not defined
|
||||||
|
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-3"] == "custom-attribute-3"
|
||||||
|
|
||||||
|
# --- Organization module tests ---
|
||||||
|
|
||||||
|
- name: keycloak_realm — enable organizations on ephemeral realm
|
||||||
|
middleware_automation.keycloak.keycloak_realm:
|
||||||
|
id: "{{ ephemeral_realm }}"
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
organizations_enabled: true
|
||||||
|
state: present
|
||||||
|
|
||||||
|
- name: keycloak_organization — create organization
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
name: molecule-org
|
||||||
|
description: Molecule test organization
|
||||||
|
enabled: true
|
||||||
|
domains:
|
||||||
|
- name: molecule.example.com
|
||||||
|
state: present
|
||||||
|
register: org_create_result
|
||||||
|
|
||||||
|
- name: Assert organization was created
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- org_create_result is changed
|
||||||
|
- org_create_result.end_state.name == "molecule-org"
|
||||||
|
- org_create_result.end_state.description == "Molecule test organization"
|
||||||
|
- org_create_result.end_state.enabled == true
|
||||||
|
- org_create_result.end_state.id is defined
|
||||||
|
|
||||||
|
- name: keycloak_organization — create organization (idempotency)
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
name: molecule-org
|
||||||
|
description: Molecule test organization
|
||||||
|
enabled: true
|
||||||
|
domains:
|
||||||
|
- name: molecule.example.com
|
||||||
|
state: present
|
||||||
|
register: org_create_idempotent_result
|
||||||
|
|
||||||
|
- name: Assert organization creation is idempotent
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- org_create_idempotent_result is not changed
|
||||||
|
|
||||||
|
- name: keycloak_organization — update organization description
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
name: molecule-org
|
||||||
|
description: Updated molecule test organization
|
||||||
|
state: present
|
||||||
|
register: org_update_result
|
||||||
|
|
||||||
|
- name: Assert organization was updated
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- org_update_result is changed
|
||||||
|
- org_update_result.end_state.description == "Updated molecule test organization"
|
||||||
|
|
||||||
|
- name: keycloak_organization — update organization (idempotency)
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
name: molecule-org
|
||||||
|
description: Updated molecule test organization
|
||||||
|
state: present
|
||||||
|
register: org_update_idempotent_result
|
||||||
|
|
||||||
|
- name: Assert organization update is idempotent
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- org_update_idempotent_result is not changed
|
||||||
|
|
||||||
|
- name: keycloak_organization_info — query organization by name
|
||||||
|
middleware_automation.keycloak.keycloak_organization_info:
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
name: molecule-org
|
||||||
|
register: org_info_result
|
||||||
|
|
||||||
|
- name: Assert organization info returns the created org
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- org_info_result is not changed
|
||||||
|
- org_info_result.organizations | length == 1
|
||||||
|
- org_info_result.organizations[0].name == "molecule-org"
|
||||||
|
|
||||||
|
- name: keycloak_organization_info — list all organizations
|
||||||
|
middleware_automation.keycloak.keycloak_organization_info:
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
register: org_info_all_result
|
||||||
|
|
||||||
|
- name: Assert organization list is non-empty
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- org_info_all_result.organizations | length >= 1
|
||||||
|
|
||||||
|
- name: keycloak_organization — create organization with attributes
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
name: molecule-org-attrs
|
||||||
|
description: Organization with attributes
|
||||||
|
attributes:
|
||||||
|
department: engineering
|
||||||
|
tags:
|
||||||
|
- test
|
||||||
|
- molecule
|
||||||
|
state: present
|
||||||
|
register: org_attrs_result
|
||||||
|
|
||||||
|
- name: Assert organization with attributes was created
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- org_attrs_result is changed
|
||||||
|
- org_attrs_result.end_state.attributes.department == ["engineering"]
|
||||||
|
- org_attrs_result.end_state.attributes.tags == ["test", "molecule"]
|
||||||
|
|
||||||
|
- name: keycloak_organization — delete organization with attributes
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
name: molecule-org-attrs
|
||||||
|
state: absent
|
||||||
|
register: org_attrs_delete_result
|
||||||
|
|
||||||
|
- name: Assert organization with attributes was deleted
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- org_attrs_delete_result is changed
|
||||||
|
|
||||||
|
- name: keycloak_organization — delete organization
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
name: molecule-org
|
||||||
|
state: absent
|
||||||
|
register: org_delete_result
|
||||||
|
|
||||||
|
- name: Assert organization was deleted
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- org_delete_result is changed
|
||||||
|
|
||||||
|
- name: keycloak_organization — delete organization (idempotency)
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
realm: "{{ ephemeral_realm }}"
|
||||||
|
name: molecule-org
|
||||||
|
state: absent
|
||||||
|
register: org_delete_idempotent_result
|
||||||
|
|
||||||
|
- name: Assert organization deletion is idempotent
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- org_delete_idempotent_result is not changed
|
||||||
|
|
||||||
- name: keycloak_realm_localization — set locale override
|
- name: keycloak_realm_localization — set locale override
|
||||||
middleware_automation.keycloak.keycloak_realm_localization:
|
middleware_automation.keycloak.keycloak_realm_localization:
|
||||||
parent_id: "{{ target_realm }}"
|
parent_id: "{{ target_realm }}"
|
||||||
@@ -216,14 +471,8 @@
|
|||||||
state: present
|
state: present
|
||||||
|
|
||||||
- name: keycloak_authentication_v2 — manage flow with safe-swap semantics
|
- name: keycloak_authentication_v2 — manage flow with safe-swap semantics
|
||||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
ansible.builtin.include_tasks:
|
||||||
realm: "{{ target_realm }}"
|
file: keycloak_authentication_v2/verify.yml
|
||||||
alias: "{{ flow_v2 }}"
|
|
||||||
description: Molecule module test flow v2
|
|
||||||
authenticationExecutions:
|
|
||||||
- requirement: REQUIRED
|
|
||||||
providerId: auth-cookie
|
|
||||||
state: present
|
|
||||||
|
|
||||||
- name: keycloak_authentication_required_actions — ensure VERIFY_EMAIL is enabled
|
- name: keycloak_authentication_required_actions — ensure VERIFY_EMAIL is enabled
|
||||||
middleware_automation.keycloak.keycloak_authentication_required_actions:
|
middleware_automation.keycloak.keycloak_authentication_required_actions:
|
||||||
@@ -323,6 +572,44 @@
|
|||||||
roles:
|
roles:
|
||||||
- name: "{{ role }}"
|
- 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
|
- name: keycloak_realm_rolemapping — assign realm role to group
|
||||||
middleware_automation.keycloak.keycloak_realm_rolemapping:
|
middleware_automation.keycloak.keycloak_realm_rolemapping:
|
||||||
realm: "{{ target_realm }}"
|
realm: "{{ target_realm }}"
|
||||||
@@ -340,6 +627,61 @@
|
|||||||
roles:
|
roles:
|
||||||
- name: "{{ client_role }}"
|
- 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
|
- name: keycloak_client_rolescope — restrict realm role on client
|
||||||
middleware_automation.keycloak.keycloak_client_rolescope:
|
middleware_automation.keycloak.keycloak_client_rolescope:
|
||||||
realm: "{{ target_realm }}"
|
realm: "{{ target_realm }}"
|
||||||
@@ -536,6 +878,7 @@
|
|||||||
auth_realm: "{{ auth_realm }}"
|
auth_realm: "{{ auth_realm }}"
|
||||||
auth_username: "{{ auth_username }}"
|
auth_username: "{{ auth_username }}"
|
||||||
auth_password: "{{ auth_password }}"
|
auth_password: "{{ auth_password }}"
|
||||||
|
validate_certs: false
|
||||||
block:
|
block:
|
||||||
- name: keycloak_authz_custom_policy — remove custom policy if created
|
- name: keycloak_authz_custom_policy — remove custom policy if created
|
||||||
middleware_automation.keycloak.keycloak_authz_custom_policy:
|
middleware_automation.keycloak.keycloak_authz_custom_policy:
|
||||||
@@ -611,18 +954,32 @@
|
|||||||
roles:
|
roles:
|
||||||
- name: "{{ role }}"
|
- 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
|
- name: keycloak_identity_provider — remove OIDC provider
|
||||||
middleware_automation.keycloak.keycloak_identity_provider:
|
middleware_automation.keycloak.keycloak_identity_provider:
|
||||||
realm: "{{ target_realm }}"
|
realm: "{{ target_realm }}"
|
||||||
alias: "{{ idp }}"
|
alias: "{{ idp }}"
|
||||||
state: absent
|
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
|
- name: keycloak_authentication — remove copied flow
|
||||||
middleware_automation.keycloak.keycloak_authentication:
|
middleware_automation.keycloak.keycloak_authentication:
|
||||||
realm: "{{ target_realm }}"
|
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
|
||||||
@@ -7,7 +7,7 @@ platforms:
|
|||||||
pre_build_image: true
|
pre_build_image: true
|
||||||
privileged: true
|
privileged: true
|
||||||
command: "/usr/sbin/init"
|
command: "/usr/sbin/init"
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8443/tcp"
|
- "8443/tcp"
|
||||||
- "8009/tcp"
|
- "8009/tcp"
|
||||||
|
|||||||
@@ -36,7 +36,7 @@
|
|||||||
ansible.builtin.set_fact:
|
ansible.builtin.set_fact:
|
||||||
assets_server: "{{ lookup('env', 'MIDDLEWARE_DOWNLOAD_RELEASE_SERVER_URL') }}"
|
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:
|
when:
|
||||||
- assets_server is defined
|
- assets_server is defined
|
||||||
- assets_server | length > 0
|
- assets_server | length > 0
|
||||||
|
|||||||
@@ -25,7 +25,7 @@
|
|||||||
keycloak_quarkus_systemd_wait_for_delay: 2
|
keycloak_quarkus_systemd_wait_for_delay: 2
|
||||||
keycloak_quarkus_systemd_wait_for_log: true
|
keycloak_quarkus_systemd_wait_for_log: true
|
||||||
keycloak_quarkus_restart_health_check: false # would fail because of self-signed cert
|
keycloak_quarkus_restart_health_check: false # would fail because of self-signed cert
|
||||||
keycloak_quarkus_version: 26.6.2
|
keycloak_quarkus_version: 26.7.3
|
||||||
keycloak_quarkus_java_heap_opts: "-Xms1024m -Xmx1024m"
|
keycloak_quarkus_java_heap_opts: "-Xms1024m -Xmx1024m"
|
||||||
keycloak_quarkus_additional_env_vars:
|
keycloak_quarkus_additional_env_vars:
|
||||||
- key: KC_FEATURES_DISABLED
|
- key: KC_FEATURES_DISABLED
|
||||||
@@ -39,16 +39,16 @@
|
|||||||
- key: default-connection-pool-size
|
- key: default-connection-pool-size
|
||||||
value: 10
|
value: 10
|
||||||
- id: spid-saml
|
- id: spid-saml
|
||||||
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.5.6/spid-provider.jar
|
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.7.1/spid-provider.jar
|
||||||
- id: spid-saml-w-checksum
|
- id: spid-saml-w-checksum
|
||||||
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.5.6/spid-provider.jar
|
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.7.1/spid-provider.jar
|
||||||
checksum: sha256:2ddafc389a5f017d8665bfdfa2f72b3784fc74b9f3a482e796fa89a5ba5cc95b
|
checksum: sha256:65c16bc70f36af26dac5ab1506b45120674fdf89106320ce00ff53bf6bf1243e
|
||||||
- id: keycloak-kerberos-federation
|
- id: keycloak-kerberos-federation
|
||||||
maven:
|
maven:
|
||||||
repository_url: https://repo1.maven.org/maven2/ # https://mvnrepository.com/artifact/org.keycloak/keycloak-kerberos-federation/24.0.4
|
repository_url: https://repo1.maven.org/maven2/ # https://mvnrepository.com/artifact/org.keycloak/keycloak-kerberos-federation/24.0.4
|
||||||
group_id: org.keycloak
|
group_id: org.keycloak
|
||||||
artifact_id: keycloak-kerberos-federation
|
artifact_id: keycloak-kerberos-federation
|
||||||
version: 26.6.3 # optional
|
version: 26.7.3 # optional
|
||||||
# username: myUser # optional
|
# username: myUser # optional
|
||||||
# password: myPAT # optional
|
# password: myPAT # optional
|
||||||
# - id: my-static-theme
|
# - id: my-static-theme
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ platforms:
|
|||||||
pre_build_image: true
|
pre_build_image: true
|
||||||
privileged: true
|
privileged: true
|
||||||
command: "/usr/sbin/init"
|
command: "/usr/sbin/init"
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8443/tcp"
|
- "8443/tcp"
|
||||||
- "8009/tcp"
|
- "8009/tcp"
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ platforms:
|
|||||||
pre_build_image: true
|
pre_build_image: true
|
||||||
privileged: true
|
privileged: true
|
||||||
command: "/usr/sbin/init"
|
command: "/usr/sbin/init"
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8009/tcp"
|
- "8009/tcp"
|
||||||
- "9000/tcp"
|
- "9000/tcp"
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ platforms:
|
|||||||
- keycloak
|
- keycloak
|
||||||
networks:
|
networks:
|
||||||
- name: rhbk
|
- name: rhbk
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8443/tcp"
|
- "8443/tcp"
|
||||||
- "9000/tcp"
|
- "9000/tcp"
|
||||||
@@ -24,7 +24,7 @@ platforms:
|
|||||||
- keycloak
|
- keycloak
|
||||||
networks:
|
networks:
|
||||||
- name: rhbk
|
- name: rhbk
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8443/tcp"
|
- "8443/tcp"
|
||||||
- "9000/tcp"
|
- "9000/tcp"
|
||||||
@@ -37,7 +37,7 @@ platforms:
|
|||||||
- database
|
- database
|
||||||
networks:
|
networks:
|
||||||
- name: rhbk
|
- name: rhbk
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "5432/tcp"
|
- "5432/tcp"
|
||||||
mounts:
|
mounts:
|
||||||
- type: bind
|
- type: bind
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ platforms:
|
|||||||
- keycloak
|
- keycloak
|
||||||
networks:
|
networks:
|
||||||
- name: rhbk
|
- name: rhbk
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8443/tcp"
|
- "8443/tcp"
|
||||||
- "9000/tcp"
|
- "9000/tcp"
|
||||||
@@ -24,7 +24,7 @@ platforms:
|
|||||||
- keycloak
|
- keycloak
|
||||||
networks:
|
networks:
|
||||||
- name: rhbk
|
- name: rhbk
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8443/tcp"
|
- "8443/tcp"
|
||||||
- "9000/tcp"
|
- "9000/tcp"
|
||||||
@@ -37,7 +37,7 @@ platforms:
|
|||||||
- database
|
- database
|
||||||
networks:
|
networks:
|
||||||
- name: rhbk
|
- name: rhbk
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "5432/tcp"
|
- "5432/tcp"
|
||||||
mounts:
|
mounts:
|
||||||
- type: bind
|
- type: bind
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ platforms:
|
|||||||
- keycloak
|
- keycloak
|
||||||
networks:
|
networks:
|
||||||
- name: rhbk
|
- name: rhbk
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "8080/tcp"
|
- "8080/tcp"
|
||||||
- "8443/tcp"
|
- "8443/tcp"
|
||||||
- "9000/tcp"
|
- "9000/tcp"
|
||||||
@@ -24,7 +24,7 @@ platforms:
|
|||||||
- infinispan
|
- infinispan
|
||||||
networks:
|
networks:
|
||||||
- name: rhbk
|
- name: rhbk
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "11222/tcp"
|
- "11222/tcp"
|
||||||
- name: postgres
|
- name: postgres
|
||||||
image: ubuntu/postgres:14-22.04_beta
|
image: ubuntu/postgres:14-22.04_beta
|
||||||
@@ -35,7 +35,7 @@ platforms:
|
|||||||
- database
|
- database
|
||||||
networks:
|
networks:
|
||||||
- name: rhbk
|
- name: rhbk
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- "5432/tcp"
|
- "5432/tcp"
|
||||||
mounts:
|
mounts:
|
||||||
- type: bind
|
- type: bind
|
||||||
|
|||||||
@@ -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.7.3/keycloak-26.7.3.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
|
||||||
@@ -9,6 +9,6 @@
|
|||||||
keycloak_quarkus_additional_env_vars:
|
keycloak_quarkus_additional_env_vars:
|
||||||
- key: KC_FEATURES_DISABLED
|
- key: KC_FEATURES_DISABLED
|
||||||
value: ciba,device-flow,impersonation,kerberos,docker
|
value: ciba,device-flow,impersonation,kerberos,docker
|
||||||
keycloak_quarkus_version: 26.6.2
|
keycloak_quarkus_version: 26.7.3
|
||||||
roles:
|
roles:
|
||||||
- role: keycloak_quarkus
|
- role: keycloak_quarkus
|
||||||
|
|||||||
@@ -11,8 +11,8 @@ platforms:
|
|||||||
command: "/usr/sbin/init"
|
command: "/usr/sbin/init"
|
||||||
pre_build_image: true
|
pre_build_image: true
|
||||||
privileged: true
|
privileged: true
|
||||||
port_bindings:
|
exposed_ports:
|
||||||
- 8080:8080
|
- "8080/tcp"
|
||||||
- "9000/tcp"
|
- "9000/tcp"
|
||||||
published_ports:
|
published_ports:
|
||||||
- 0.0.0.0:8080:8080/TCP
|
- 0.0.0.0:8080:8080/TCP
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
- vars.yml
|
- vars.yml
|
||||||
vars:
|
vars:
|
||||||
sudo_pkg_name: sudo
|
sudo_pkg_name: sudo
|
||||||
keycloak_quarkus_version: 26.6.1
|
keycloak_quarkus_version: 26.6.2
|
||||||
keycloak_quarkus_additional_env_vars:
|
keycloak_quarkus_additional_env_vars:
|
||||||
- key: KC_FEATURES_DISABLED
|
- key: KC_FEATURES_DISABLED
|
||||||
value: impersonation,kerberos
|
value: impersonation,kerberos
|
||||||
|
|||||||
@@ -14,7 +14,8 @@ provisioner:
|
|||||||
config_options:
|
config_options:
|
||||||
defaults:
|
defaults:
|
||||||
interpreter_python: auto_silent
|
interpreter_python: auto_silent
|
||||||
callbacks_enabled: profile_tasks, timer, yaml
|
callbacks_enabled: profile_tasks, timer
|
||||||
|
callback_result_format: yaml
|
||||||
ssh_connection:
|
ssh_connection:
|
||||||
pipelining: false
|
pipelining: false
|
||||||
playbooks:
|
playbooks:
|
||||||
|
|||||||
@@ -6,6 +6,8 @@
|
|||||||
keycloak_admin_user: "admin"
|
keycloak_admin_user: "admin"
|
||||||
keycloak_uri: "http://localhost:8080"
|
keycloak_uri: "http://localhost:8080"
|
||||||
keycloak_context: "/auth"
|
keycloak_context: "/auth"
|
||||||
|
parent_group: molecule-parent-group
|
||||||
|
child_group: molecule-child-group
|
||||||
tasks:
|
tasks:
|
||||||
- name: Populate service facts
|
- name: Populate service facts
|
||||||
ansible.builtin.service_facts:
|
ansible.builtin.service_facts:
|
||||||
@@ -24,3 +26,53 @@
|
|||||||
until: keycloak_auth_response.status == 200
|
until: keycloak_auth_response.status == 200
|
||||||
retries: 2
|
retries: 2
|
||||||
delay: 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.
|
- Configures the HTTP User-Agent header.
|
||||||
type: str
|
type: str
|
||||||
default: Ansible
|
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_CLIENTSECRET = "{url}/admin/realms/{realm}/clients/{id}/client-secret"
|
||||||
|
|
||||||
URL_AUTHENTICATION_AUTHENTICATOR_PROVIDERS = "{url}/admin/realms/{realm}/authentication/authenticator-providers"
|
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_FLOWS = "{url}/admin/realms/{realm}/authentication/flows"
|
||||||
URL_AUTHENTICATION_FLOW = "{url}/admin/realms/{realm}/authentication/flows/{id}"
|
URL_AUTHENTICATION_FLOW = "{url}/admin/realms/{realm}/authentication/flows/{id}"
|
||||||
URL_AUTHENTICATION_FLOW_COPY = "{url}/admin/realms/{realm}/authentication/flows/{copyfrom}/copy"
|
URL_AUTHENTICATION_FLOW_COPY = "{url}/admin/realms/{realm}/authentication/flows/{copyfrom}/copy"
|
||||||
@@ -155,6 +157,9 @@ URL_AUTHZ_RESOURCES = "{url}/admin/realms/{realm}/clients/{client_id}/authz/reso
|
|||||||
URL_AUTHZ_CUSTOM_POLICY = "{url}/admin/realms/{realm}/clients/{client_id}/authz/resource-server/policy/{policy_type}"
|
URL_AUTHZ_CUSTOM_POLICY = "{url}/admin/realms/{realm}/clients/{client_id}/authz/resource-server/policy/{policy_type}"
|
||||||
URL_AUTHZ_CUSTOM_POLICIES = "{url}/admin/realms/{realm}/clients/{client_id}/authz/resource-server/policy"
|
URL_AUTHZ_CUSTOM_POLICIES = "{url}/admin/realms/{realm}/clients/{client_id}/authz/resource-server/policy"
|
||||||
|
|
||||||
|
URL_ORGANIZATIONS = "{url}/admin/realms/{realm}/organizations"
|
||||||
|
URL_ORGANIZATION = "{url}/admin/realms/{realm}/organizations/{id}"
|
||||||
|
|
||||||
|
|
||||||
def keycloak_argument_spec() -> dict[str, t.Any]:
|
def keycloak_argument_spec() -> dict[str, t.Any]:
|
||||||
"""
|
"""
|
||||||
@@ -174,6 +179,7 @@ def keycloak_argument_spec() -> dict[str, t.Any]:
|
|||||||
token=dict(type="str", no_log=True),
|
token=dict(type="str", no_log=True),
|
||||||
refresh_token=dict(type="str", no_log=True),
|
refresh_token=dict(type="str", no_log=True),
|
||||||
http_agent=dict(type="str", default="Ansible"),
|
http_agent=dict(type="str", default="Ansible"),
|
||||||
|
use_netrc=dict(type="bool", default=False),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -213,6 +219,7 @@ def _token_request(module_params: dict[str, t.Any], payload: dict[str, t.Any]) -
|
|||||||
http_agent = module_params.get("http_agent")
|
http_agent = module_params.get("http_agent")
|
||||||
validate_certs = module_params.get("validate_certs")
|
validate_certs = module_params.get("validate_certs")
|
||||||
connection_timeout = module_params.get("connection_timeout")
|
connection_timeout = module_params.get("connection_timeout")
|
||||||
|
use_netrc = module_params.get("use_netrc", False)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
r = json.loads(
|
r = json.loads(
|
||||||
@@ -223,6 +230,7 @@ def _token_request(module_params: dict[str, t.Any], payload: dict[str, t.Any]) -
|
|||||||
http_agent=http_agent,
|
http_agent=http_agent,
|
||||||
timeout=connection_timeout,
|
timeout=connection_timeout,
|
||||||
data=urlencode(payload),
|
data=urlencode(payload),
|
||||||
|
use_netrc=use_netrc,
|
||||||
).read()
|
).read()
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -398,6 +406,7 @@ class KeycloakAPI:
|
|||||||
self.connection_timeout = self.module.params.get("connection_timeout")
|
self.connection_timeout = self.module.params.get("connection_timeout")
|
||||||
self.restheaders = connection_header
|
self.restheaders = connection_header
|
||||||
self.http_agent = self.module.params.get("http_agent")
|
self.http_agent = self.module.params.get("http_agent")
|
||||||
|
self.use_netrc = self.module.params.get("use_netrc", False)
|
||||||
|
|
||||||
def _request(
|
def _request(
|
||||||
self, url: str, method: str, data: str | bytes | None = None, *, extra_headers: dict[str, str] | None = None
|
self, url: str, method: str, data: str | bytes | None = None, *, extra_headers: dict[str, str] | None = None
|
||||||
@@ -426,6 +435,7 @@ class KeycloakAPI:
|
|||||||
headers=headers,
|
headers=headers,
|
||||||
timeout=self.connection_timeout,
|
timeout=self.connection_timeout,
|
||||||
validate_certs=self.validate_certs,
|
validate_certs=self.validate_certs,
|
||||||
|
use_netrc=self.use_netrc,
|
||||||
)
|
)
|
||||||
except HTTPError as e:
|
except HTTPError as e:
|
||||||
if e.code != HTTPStatus.UNAUTHORIZED:
|
if e.code != HTTPStatus.UNAUTHORIZED:
|
||||||
@@ -1108,6 +1118,22 @@ class KeycloakAPI:
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
self.fail_request(e, msg=f"Could not obtain the user for realm {realm} and username {username}: {e}")
|
self.fail_request(e, msg=f"Could not obtain the user for realm {realm} and username {username}: {e}")
|
||||||
|
|
||||||
|
def get_realm_users(self, realm: str = "master") -> list[dict[str, t.Any]]:
|
||||||
|
"""Obtain list of users from the realm
|
||||||
|
|
||||||
|
:param realm: realm id
|
||||||
|
:return: list of user representations
|
||||||
|
"""
|
||||||
|
users_url = URL_USERS.format(url=self.baseurl, realm=realm)
|
||||||
|
try:
|
||||||
|
return self._request_and_deserialize(users_url, method="GET")
|
||||||
|
except ValueError as e:
|
||||||
|
self.module.fail_json(
|
||||||
|
msg=f"API returned incorrect JSON when trying to obtain the users for realm {realm}: {e}"
|
||||||
|
)
|
||||||
|
except Exception as e:
|
||||||
|
self.fail_request(e, msg=f"Could not obtain the users for realm {realm}: {e}")
|
||||||
|
|
||||||
def get_service_account_user_by_client_id(self, client_id, realm: str = "master"):
|
def get_service_account_user_by_client_id(self, client_id, realm: str = "master"):
|
||||||
"""Fetch a keycloak service account user within a realm based on its client_id.
|
"""Fetch a keycloak service account user within a realm based on its client_id.
|
||||||
|
|
||||||
@@ -1712,7 +1738,15 @@ class KeycloakAPI:
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
self.module.fail_json(msg=f"Could not fetch group {gid} in realm {realm}: {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:
|
if "subGroupCount" in parent:
|
||||||
# Since version 23, when GETting a group Keycloak does not
|
# Since version 23, when GETting a group Keycloak does not
|
||||||
# return subGroups but only a subGroupCount.
|
# return subGroups but only a subGroupCount.
|
||||||
@@ -1721,9 +1755,17 @@ class KeycloakAPI:
|
|||||||
group_children = []
|
group_children = []
|
||||||
else:
|
else:
|
||||||
group_children_url = f"{URL_GROUP_CHILDREN.format(url=self.baseurl, realm=realm, groupid=parent['id'])}?max={parent['subGroupCount']}"
|
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")
|
group_children = self._request_and_deserialize(group_children_url, method="GET")
|
||||||
subgroups = group_children
|
subgroups = group_children
|
||||||
else:
|
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"]
|
subgroups = parent["subGroups"]
|
||||||
return subgroups
|
return subgroups
|
||||||
|
|
||||||
@@ -1731,7 +1773,8 @@ class KeycloakAPI:
|
|||||||
"""Fetch a keycloak group within a realm based on its name.
|
"""Fetch a keycloak group within a realm based on its name.
|
||||||
|
|
||||||
Uses the Keycloak search API with exact matching for efficient lookup
|
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.
|
If the group does not exist, None is returned.
|
||||||
:param name: Name of the group to fetch.
|
:param name: Name of the group to fetch.
|
||||||
@@ -1745,18 +1788,18 @@ class KeycloakAPI:
|
|||||||
if not parent:
|
if not parent:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
# For subgroups: use children endpoint with search parameter
|
# For subgroups: search the parent's children where the server
|
||||||
search_url = "{url}?search={name}&exact=true".format(
|
# supports it. get_subgroups knows which servers those are, the
|
||||||
url=URL_GROUP_CHILDREN.format(url=self.baseurl, realm=realm, groupid=parent["id"]),
|
# exact name check below covers the ones which do not.
|
||||||
name=quote(name, safe=""),
|
groups = self.get_subgroups(parent, realm, search=name)
|
||||||
)
|
|
||||||
else:
|
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(
|
search_url = "{url}?search={name}&exact=true".format(
|
||||||
url=URL_GROUPS.format(url=self.baseurl, realm=realm), name=quote(name, safe="")
|
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
|
# exact=true should return only exact matches, but verify the name
|
||||||
for group in groups:
|
for group in groups:
|
||||||
@@ -2275,6 +2318,32 @@ class KeycloakAPI:
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
self.fail_request(e, msg=f"Unable get authenticator providers in realm {realm}: {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"):
|
def get_authentication_flow_by_alias(self, alias, realm: str = "master"):
|
||||||
"""
|
"""
|
||||||
Get an authentication flow by its alias
|
Get an authentication flow by its alias
|
||||||
@@ -3492,6 +3561,92 @@ class KeycloakAPI:
|
|||||||
|
|
||||||
return self.get_client_role_scope_from_realm(clientid, realm)
|
return self.get_client_role_scope_from_realm(clientid, realm)
|
||||||
|
|
||||||
|
def get_organizations(self, search_filter=None, realm: str = "master"):
|
||||||
|
"""Fetch representations for organizations in a realm.
|
||||||
|
:param search_filter: Optional query string to append (e.g. 'search=foo&exact=true').
|
||||||
|
:param realm: Realm to be queried; default 'master'.
|
||||||
|
:return: List of organization representations.
|
||||||
|
"""
|
||||||
|
orgs_url = URL_ORGANIZATIONS.format(url=self.baseurl, realm=realm)
|
||||||
|
if search_filter:
|
||||||
|
orgs_url = f"{orgs_url}?{search_filter}"
|
||||||
|
try:
|
||||||
|
return self._request_and_deserialize(orgs_url, method="GET")
|
||||||
|
except ValueError as e:
|
||||||
|
self.module.fail_json(
|
||||||
|
msg=f"API returned incorrect JSON when trying to obtain list of organizations for realm {realm}: {e}"
|
||||||
|
)
|
||||||
|
except Exception as e:
|
||||||
|
self.fail_request(e, msg=f"Could not obtain list of organizations for realm {realm}: {e}")
|
||||||
|
|
||||||
|
def get_organization_by_id(self, org_id, realm: str = "master"):
|
||||||
|
"""Fetch an organization by its UUID.
|
||||||
|
If the organization does not exist, None is returned.
|
||||||
|
:param org_id: UUID of the organization to fetch.
|
||||||
|
:param realm: Realm in which the organization resides; default 'master'.
|
||||||
|
"""
|
||||||
|
org_url = URL_ORGANIZATION.format(url=self.baseurl, realm=realm, id=org_id)
|
||||||
|
try:
|
||||||
|
return self._request_and_deserialize(org_url, method="GET")
|
||||||
|
except HTTPError as e:
|
||||||
|
if e.code == HTTPStatus.NOT_FOUND:
|
||||||
|
return None
|
||||||
|
else:
|
||||||
|
self.fail_request(e, msg=f"Could not fetch organization {org_id} in realm {realm}: {e}")
|
||||||
|
except Exception as e:
|
||||||
|
self.fail_request(e, msg=f"Could not fetch organization {org_id} in realm {realm}: {e}")
|
||||||
|
|
||||||
|
def get_organization_by_name(self, name, realm: str = "master"):
|
||||||
|
"""Fetch an organization by name using search API with exact matching.
|
||||||
|
Returns the full representation (fetched by ID) or None if not found.
|
||||||
|
:param name: Name of the organization to fetch.
|
||||||
|
:param realm: Realm in which the organization resides; default 'master'.
|
||||||
|
"""
|
||||||
|
search_url = URL_ORGANIZATIONS.format(url=self.baseurl, realm=realm)
|
||||||
|
search_url = f"{search_url}?search={quote(name, safe='')}&exact=true"
|
||||||
|
try:
|
||||||
|
orgs = self._request_and_deserialize(search_url, method="GET")
|
||||||
|
if not orgs:
|
||||||
|
return None
|
||||||
|
return self.get_organization_by_id(orgs[0]["id"], realm=realm)
|
||||||
|
except Exception as e:
|
||||||
|
self.fail_request(e, msg=f"Could not fetch organization {name} in realm {realm}: {e}")
|
||||||
|
|
||||||
|
def create_organization(self, orgrep, realm: str = "master"):
|
||||||
|
"""Create an organization.
|
||||||
|
:param orgrep: Organization representation of the organization to be created.
|
||||||
|
:param realm: Realm in which this organization resides, default "master".
|
||||||
|
:return: HTTPResponse object on success.
|
||||||
|
"""
|
||||||
|
orgs_url = URL_ORGANIZATIONS.format(url=self.baseurl, realm=realm)
|
||||||
|
try:
|
||||||
|
return self._request(orgs_url, method="POST", data=json.dumps(orgrep))
|
||||||
|
except Exception as e:
|
||||||
|
self.fail_request(e, msg=f"Could not create organization {orgrep.get('name')} in realm {realm}: {e}")
|
||||||
|
|
||||||
|
def update_organization(self, orgrep, realm: str = "master"):
|
||||||
|
"""Update an existing organization.
|
||||||
|
:param orgrep: Organization representation of the organization to be updated.
|
||||||
|
:param realm: Realm in which this organization resides, default "master".
|
||||||
|
:return: HTTPResponse object on success.
|
||||||
|
"""
|
||||||
|
org_url = URL_ORGANIZATION.format(url=self.baseurl, realm=realm, id=orgrep["id"])
|
||||||
|
try:
|
||||||
|
return self._request(org_url, method="PUT", data=json.dumps(orgrep))
|
||||||
|
except Exception as e:
|
||||||
|
self.fail_request(e, msg=f"Could not update organization {orgrep.get('name')} in realm {realm}: {e}")
|
||||||
|
|
||||||
|
def delete_organization(self, org_id, realm: str = "master"):
|
||||||
|
"""Delete an organization by UUID.
|
||||||
|
:param org_id: UUID of the organization to delete.
|
||||||
|
:param realm: Realm in which this organization resides, default "master".
|
||||||
|
"""
|
||||||
|
org_url = URL_ORGANIZATION.format(url=self.baseurl, realm=realm, id=org_id)
|
||||||
|
try:
|
||||||
|
return self._request(org_url, method="DELETE")
|
||||||
|
except Exception as e:
|
||||||
|
self.fail_request(e, msg=f"Could not delete organization {org_id} in realm {realm}: {e}")
|
||||||
|
|
||||||
def fail_request(self, e: Exception, msg: str, **kwargs: t.Any) -> t.NoReturn:
|
def fail_request(self, e: Exception, msg: str, **kwargs: t.Any) -> t.NoReturn:
|
||||||
"""Triggers a module failure. This should be called
|
"""Triggers a module failure. This should be called
|
||||||
when an exception occurs during/after a request.
|
when an exception occurs during/after a request.
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ description:
|
|||||||
If the option is V(false) and a temporary flow already exists, the module will fail to prevent accidental data loss.
|
If the option is V(false) and a temporary flow already exists, the module will fail to prevent accidental data loss.
|
||||||
- B(Idempotency) - If the existing flow already matches the desired configuration, no changes are made.
|
- B(Idempotency) - If the existing flow already matches the desired configuration, no changes are made.
|
||||||
The module compares a normalised representation of the existing flow against the desired state before deciding whether to trigger the Safe Swap procedure.
|
The module compares a normalised representation of the existing flow against the desired state before deciding whether to trigger the Safe Swap procedure.
|
||||||
- A depth of 4 sub-flows is supported.
|
- A depth of 10 sub-flows is supported.
|
||||||
|
|
||||||
attributes:
|
attributes:
|
||||||
check_mode:
|
check_mode:
|
||||||
@@ -222,7 +222,7 @@ options:
|
|||||||
authenticationExecutions:
|
authenticationExecutions:
|
||||||
description:
|
description:
|
||||||
- The execution configuration for executions within the sub-flow.
|
- The execution configuration for executions within the sub-flow.
|
||||||
- Executions at sub level 4 (last sub level).
|
- Executions at sub level 4.
|
||||||
type: list
|
type: list
|
||||||
elements: dict
|
elements: dict
|
||||||
suboptions:
|
suboptions:
|
||||||
@@ -236,7 +236,6 @@ options:
|
|||||||
description:
|
description:
|
||||||
- The C(providerId) of the execution.
|
- The C(providerId) of the execution.
|
||||||
type: str
|
type: str
|
||||||
required: true
|
|
||||||
authenticationConfig:
|
authenticationConfig:
|
||||||
description:
|
description:
|
||||||
- The configuration for the execution.
|
- The configuration for the execution.
|
||||||
@@ -250,6 +249,247 @@ options:
|
|||||||
description: Options for the execution config.
|
description: Options for the execution config.
|
||||||
required: true
|
required: true
|
||||||
type: dict
|
type: dict
|
||||||
|
subFlow:
|
||||||
|
description:
|
||||||
|
- The name of the sub-flow.
|
||||||
|
type: str
|
||||||
|
subFlowType:
|
||||||
|
description:
|
||||||
|
- The type of the sub-flow.
|
||||||
|
choices: [basic-flow, form-flow]
|
||||||
|
default: basic-flow
|
||||||
|
type: str
|
||||||
|
authenticationExecutions:
|
||||||
|
description:
|
||||||
|
- The execution configuration for executions within the sub-flow.
|
||||||
|
- Executions at sub level 5.
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
suboptions:
|
||||||
|
requirement:
|
||||||
|
description:
|
||||||
|
- The requirement status of the execution or sub-flow.
|
||||||
|
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
providerId:
|
||||||
|
description:
|
||||||
|
- The C(providerId) of the execution.
|
||||||
|
type: str
|
||||||
|
authenticationConfig:
|
||||||
|
description:
|
||||||
|
- The configuration for the execution.
|
||||||
|
type: dict
|
||||||
|
suboptions:
|
||||||
|
alias:
|
||||||
|
description: Name of the execution config.
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
config:
|
||||||
|
description: Options for the execution config.
|
||||||
|
required: true
|
||||||
|
type: dict
|
||||||
|
subFlow:
|
||||||
|
description:
|
||||||
|
- The name of the sub-flow.
|
||||||
|
type: str
|
||||||
|
subFlowType:
|
||||||
|
description:
|
||||||
|
- The type of the sub-flow.
|
||||||
|
choices: [basic-flow, form-flow]
|
||||||
|
default: basic-flow
|
||||||
|
type: str
|
||||||
|
authenticationExecutions:
|
||||||
|
description:
|
||||||
|
- The execution configuration for executions within the sub-flow.
|
||||||
|
- Executions at sub level 6.
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
suboptions:
|
||||||
|
requirement:
|
||||||
|
description:
|
||||||
|
- The requirement status of the execution or sub-flow.
|
||||||
|
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
providerId:
|
||||||
|
description:
|
||||||
|
- The C(providerId) of the execution.
|
||||||
|
type: str
|
||||||
|
authenticationConfig:
|
||||||
|
description:
|
||||||
|
- The configuration for the execution.
|
||||||
|
type: dict
|
||||||
|
suboptions:
|
||||||
|
alias:
|
||||||
|
description: Name of the execution config.
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
config:
|
||||||
|
description: Options for the execution config.
|
||||||
|
required: true
|
||||||
|
type: dict
|
||||||
|
subFlow:
|
||||||
|
description:
|
||||||
|
- The name of the sub-flow.
|
||||||
|
type: str
|
||||||
|
subFlowType:
|
||||||
|
description:
|
||||||
|
- The type of the sub-flow.
|
||||||
|
choices: [basic-flow, form-flow]
|
||||||
|
default: basic-flow
|
||||||
|
type: str
|
||||||
|
authenticationExecutions:
|
||||||
|
description:
|
||||||
|
- The execution configuration for executions within the sub-flow.
|
||||||
|
- Executions at sub level 7.
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
suboptions:
|
||||||
|
requirement:
|
||||||
|
description:
|
||||||
|
- The requirement status of the execution or sub-flow.
|
||||||
|
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
providerId:
|
||||||
|
description:
|
||||||
|
- The C(providerId) of the execution.
|
||||||
|
type: str
|
||||||
|
authenticationConfig:
|
||||||
|
description:
|
||||||
|
- The configuration for the execution.
|
||||||
|
type: dict
|
||||||
|
suboptions:
|
||||||
|
alias:
|
||||||
|
description: Name of the execution config.
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
config:
|
||||||
|
description: Options for the execution config.
|
||||||
|
required: true
|
||||||
|
type: dict
|
||||||
|
subFlow:
|
||||||
|
description:
|
||||||
|
- The name of the sub-flow.
|
||||||
|
type: str
|
||||||
|
subFlowType:
|
||||||
|
description:
|
||||||
|
- The type of the sub-flow.
|
||||||
|
choices: [basic-flow, form-flow]
|
||||||
|
default: basic-flow
|
||||||
|
type: str
|
||||||
|
authenticationExecutions:
|
||||||
|
description:
|
||||||
|
- The execution configuration for executions within the sub-flow.
|
||||||
|
- Executions at sub level 8.
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
suboptions:
|
||||||
|
requirement:
|
||||||
|
description:
|
||||||
|
- The requirement status of the execution or sub-flow.
|
||||||
|
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
providerId:
|
||||||
|
description:
|
||||||
|
- The C(providerId) of the execution.
|
||||||
|
type: str
|
||||||
|
authenticationConfig:
|
||||||
|
description:
|
||||||
|
- The configuration for the execution.
|
||||||
|
type: dict
|
||||||
|
suboptions:
|
||||||
|
alias:
|
||||||
|
description: Name of the execution config.
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
config:
|
||||||
|
description: Options for the execution config.
|
||||||
|
required: true
|
||||||
|
type: dict
|
||||||
|
subFlow:
|
||||||
|
description:
|
||||||
|
- The name of the sub-flow.
|
||||||
|
type: str
|
||||||
|
subFlowType:
|
||||||
|
description:
|
||||||
|
- The type of the sub-flow.
|
||||||
|
choices: [basic-flow, form-flow]
|
||||||
|
default: basic-flow
|
||||||
|
type: str
|
||||||
|
authenticationExecutions:
|
||||||
|
description:
|
||||||
|
- The execution configuration for executions within the sub-flow.
|
||||||
|
- Executions at sub level 9.
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
suboptions:
|
||||||
|
requirement:
|
||||||
|
description:
|
||||||
|
- The requirement status of the execution or sub-flow.
|
||||||
|
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
providerId:
|
||||||
|
description:
|
||||||
|
- The C(providerId) of the execution.
|
||||||
|
type: str
|
||||||
|
authenticationConfig:
|
||||||
|
description:
|
||||||
|
- The configuration for the execution.
|
||||||
|
type: dict
|
||||||
|
suboptions:
|
||||||
|
alias:
|
||||||
|
description: Name of the execution config.
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
config:
|
||||||
|
description: Options for the execution config.
|
||||||
|
required: true
|
||||||
|
type: dict
|
||||||
|
subFlow:
|
||||||
|
description:
|
||||||
|
- The name of the sub-flow.
|
||||||
|
type: str
|
||||||
|
subFlowType:
|
||||||
|
description:
|
||||||
|
- The type of the sub-flow.
|
||||||
|
choices: [basic-flow, form-flow]
|
||||||
|
default: basic-flow
|
||||||
|
type: str
|
||||||
|
authenticationExecutions:
|
||||||
|
description:
|
||||||
|
- The execution configuration for executions within the sub-flow.
|
||||||
|
- Executions at sub level 10 (last sub level).
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
suboptions:
|
||||||
|
requirement:
|
||||||
|
description:
|
||||||
|
- The requirement status of the execution or sub-flow.
|
||||||
|
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
providerId:
|
||||||
|
description:
|
||||||
|
- The C(providerId) of the execution.
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
authenticationConfig:
|
||||||
|
description:
|
||||||
|
- The configuration for the execution.
|
||||||
|
type: dict
|
||||||
|
suboptions:
|
||||||
|
alias:
|
||||||
|
description: Name of the execution config.
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
config:
|
||||||
|
description: Options for the execution config.
|
||||||
|
required: true
|
||||||
|
type: dict
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Whether the authentication flow should exist or not.
|
- Whether the authentication flow should exist or not.
|
||||||
@@ -279,6 +519,7 @@ extends_documentation_fragment:
|
|||||||
|
|
||||||
author:
|
author:
|
||||||
- Thomas Bargetz (@thomasbargetz)
|
- Thomas Bargetz (@thomasbargetz)
|
||||||
|
- Nils Bergmann (@NilsBergmann)
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = r"""
|
EXAMPLES = r"""
|
||||||
@@ -516,8 +757,8 @@ def create_executions(
|
|||||||
:param parent_flow_alias: the alias of the flow or sub-flow that will own the executions.
|
:param parent_flow_alias: the alias of the flow or sub-flow that will own the executions.
|
||||||
"""
|
"""
|
||||||
for desired_exec in executions:
|
for desired_exec in executions:
|
||||||
sub_flow = desired_exec["subFlow"]
|
sub_flow = desired_exec.get("subFlow")
|
||||||
sub_flow_type = desired_exec["subFlowType"]
|
sub_flow_type = desired_exec.get("subFlowType", "basic-flow")
|
||||||
sub_flow_execs = desired_exec.get("authenticationExecutions")
|
sub_flow_execs = desired_exec.get("authenticationExecutions")
|
||||||
|
|
||||||
# Build the minimal payload accepted by the execution creation endpoint.
|
# Build the minimal payload accepted by the execution creation endpoint.
|
||||||
@@ -628,6 +869,12 @@ def existing_auth_to_diff_repr(kc: KeycloakAPI, realm: str, existing_auth: dict)
|
|||||||
execution.pop("description", None)
|
execution.pop("description", None)
|
||||||
execution.pop("flowId", 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:
|
if execution.get("authenticationConfig") is not None:
|
||||||
execution["authenticationConfig"].pop("id", None)
|
execution["authenticationConfig"].pop("id", None)
|
||||||
# The alias is already stored inside the authenticationConfig object; the
|
# The alias is already stored inside the authenticationConfig object; the
|
||||||
@@ -812,33 +1059,46 @@ def create_authentication_execution_spec_options(depth: int) -> dict[str, t.Any]
|
|||||||
return options
|
return options
|
||||||
|
|
||||||
|
|
||||||
def validate_executions(kc: KeycloakAPI, realm: str, executions: dict) -> None:
|
def validate_executions(kc: KeycloakAPI, realm: str, executions: dict, flow_type: str) -> None:
|
||||||
valid_providers = kc.get_authenticator_providers(realm)
|
valid_provider_ids_by_flow_type = {
|
||||||
valid_provider_ids = {provider["id"] for provider in valid_providers}
|
"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)
|
messages = []
|
||||||
if len(invalid_provider_ids) > 0:
|
has_issues = validate_executions_rec(valid_provider_ids_by_flow_type, all_known_provider_ids, executions, flow_type, messages)
|
||||||
invalid_provider_ids_str = ", ".join(f"'{item}'" for item in invalid_provider_ids)
|
if has_issues:
|
||||||
raise ValueError(
|
raise ValueError("Error(s) while validating flow: " + ", ".join(messages))
|
||||||
f"The following execution providerIds are unknown and therefore invalid: {invalid_provider_ids_str}"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def validate_executions_rec(valid_provider_ids: set, executions: dict) -> list:
|
def validate_executions_rec(
|
||||||
invalid_provider_ids = []
|
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:
|
for execution in executions:
|
||||||
provider_id = execution["providerId"]
|
provider_id = execution["providerId"]
|
||||||
sub_flow = execution["subFlow"]
|
sub_flow = execution.get("subFlow")
|
||||||
if provider_id is not None:
|
if provider_id is not None and provider_id not in valid_provider_ids:
|
||||||
if provider_id not in valid_provider_ids:
|
has_issues = True
|
||||||
invalid_provider_ids.append(provider_id)
|
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:
|
if sub_flow is not None:
|
||||||
invalid_provider_ids.extend(
|
if validate_executions_rec(
|
||||||
validate_executions_rec(valid_provider_ids, execution["authenticationExecutions"])
|
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:
|
def main() -> None:
|
||||||
@@ -853,7 +1113,7 @@ def main() -> None:
|
|||||||
authenticationExecutions=dict(
|
authenticationExecutions=dict(
|
||||||
type="list",
|
type="list",
|
||||||
elements="dict",
|
elements="dict",
|
||||||
options=create_authentication_execution_spec_options(4),
|
options=create_authentication_execution_spec_options(10),
|
||||||
),
|
),
|
||||||
state=dict(choices=["absent", "present"], default="present"),
|
state=dict(choices=["absent", "present"], default="present"),
|
||||||
force_temporary_swap_flow_deletion=dict(type="bool", default=True),
|
force_temporary_swap_flow_deletion=dict(type="bool", default=True),
|
||||||
@@ -901,7 +1161,7 @@ def main() -> None:
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
try:
|
try:
|
||||||
validate_executions(kc, realm, desired_auth["authenticationExecutions"])
|
validate_executions(kc, realm, desired_auth["authenticationExecutions"], desired_auth["providerId"])
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
module.fail_json(
|
module.fail_json(
|
||||||
msg=f"Validation of executions failed: {e}",
|
msg=f"Validation of executions failed: {e}",
|
||||||
|
|||||||
@@ -339,11 +339,10 @@ def main():
|
|||||||
role["id"] = role_id
|
role["id"] = role_id
|
||||||
else:
|
else:
|
||||||
module.fail_json(msg=f"Could not fetch role {role['name']}:")
|
module.fail_json(msg=f"Could not fetch role {role['name']}:")
|
||||||
# Fetch missing role_name
|
# Fetch missing role_name from the client's roles, not from existing group mappings
|
||||||
else:
|
elif role["name"] is None:
|
||||||
role["name"] = kc.get_client_group_rolemapping_by_id(gid, cid, role["id"], realm=realm)["name"]
|
role_rep = kc.get_role_by_id(role["id"], realm=realm)
|
||||||
if role["name"] is None:
|
role["name"] = role_rep["name"]
|
||||||
module.fail_json(msg=f"Could not fetch role {role['id']}")
|
|
||||||
|
|
||||||
# Get effective client-level role mappings
|
# Get effective client-level role mappings
|
||||||
available_roles_before = kc.get_client_group_available_rolemappings(gid, cid, realm=realm)
|
available_roles_before = kc.get_client_group_available_rolemappings(gid, cid, realm=realm)
|
||||||
@@ -383,7 +382,10 @@ def main():
|
|||||||
# Assign roles
|
# Assign roles
|
||||||
result["changed"] = True
|
result["changed"] = True
|
||||||
if module._diff:
|
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:
|
if module.check_mode:
|
||||||
module.exit_json(**result)
|
module.exit_json(**result)
|
||||||
kc.add_group_rolemapping(gid, cid, update_roles, realm=realm)
|
kc.add_group_rolemapping(gid, cid, update_roles, realm=realm)
|
||||||
@@ -395,7 +397,10 @@ def main():
|
|||||||
# Remove mapping of role
|
# Remove mapping of role
|
||||||
result["changed"] = True
|
result["changed"] = True
|
||||||
if module._diff:
|
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:
|
if module.check_mode:
|
||||||
module.exit_json(**result)
|
module.exit_json(**result)
|
||||||
kc.delete_group_rolemapping(gid, cid, update_roles, realm=realm)
|
kc.delete_group_rolemapping(gid, cid, update_roles, realm=realm)
|
||||||
|
|||||||
@@ -211,8 +211,14 @@ def main():
|
|||||||
|
|
||||||
module = AnsibleModule(argument_spec=argument_spec,
|
module = AnsibleModule(argument_spec=argument_spec,
|
||||||
supports_check_mode=True,
|
supports_check_mode=True,
|
||||||
required_one_of=([['token', 'auth_realm', 'auth_username', 'auth_password']]),
|
required_one_of=(
|
||||||
required_together=([['auth_realm', 'auth_username', 'auth_password']]))
|
[
|
||||||
|
["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={})
|
result = dict(changed=False, msg='', diff={}, end_state={})
|
||||||
|
|
||||||
|
|||||||
@@ -53,6 +53,10 @@ options:
|
|||||||
description:
|
description:
|
||||||
- Name of the group.
|
- Name of the group.
|
||||||
- This parameter is required only when creating or updating the group.
|
- This parameter is required only when creating or updating the group.
|
||||||
|
description:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Description of the group.
|
||||||
realm:
|
realm:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
@@ -298,6 +302,11 @@ end_state:
|
|||||||
manage: true
|
manage: true
|
||||||
manageMembership: true
|
manageMembership: true
|
||||||
view: true
|
view: true
|
||||||
|
description:
|
||||||
|
description: A description of the group as string.
|
||||||
|
type: str
|
||||||
|
returned: when present
|
||||||
|
sample: An example group description
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
@@ -324,6 +333,7 @@ def main():
|
|||||||
realm=dict(default="master"),
|
realm=dict(default="master"),
|
||||||
id=dict(type="str"),
|
id=dict(type="str"),
|
||||||
name=dict(type="str"),
|
name=dict(type="str"),
|
||||||
|
description=dict(type="str"),
|
||||||
attributes=dict(type="dict"),
|
attributes=dict(type="dict"),
|
||||||
parents=dict(
|
parents=dict(
|
||||||
type="list",
|
type="list",
|
||||||
@@ -361,6 +371,7 @@ def main():
|
|||||||
state = module.params.get("state")
|
state = module.params.get("state")
|
||||||
gid = module.params.get("id")
|
gid = module.params.get("id")
|
||||||
name = module.params.get("name")
|
name = module.params.get("name")
|
||||||
|
description = module.params.get("description")
|
||||||
attributes = module.params.get("attributes")
|
attributes = module.params.get("attributes")
|
||||||
|
|
||||||
parents = module.params.get("parents")
|
parents = module.params.get("parents")
|
||||||
|
|||||||
@@ -0,0 +1,416 @@
|
|||||||
|
|
||||||
|
# Copyright (c) 2025, Chris Brown
|
||||||
|
# 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
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
from __future__ import annotations
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
DOCUMENTATION = r"""
|
||||||
|
module: keycloak_organization
|
||||||
|
|
||||||
|
short_description: Allows administration of Keycloak organizations using Keycloak API
|
||||||
|
|
||||||
|
version_added: "3.1.0"
|
||||||
|
|
||||||
|
description:
|
||||||
|
- This module allows you to add, remove or modify Keycloak organizations using the Keycloak REST API.
|
||||||
|
It requires access to the REST API using OpenID Connect; the user connecting and the client being
|
||||||
|
used must have the requisite access rights. In a default Keycloak installation, admin-cli and an
|
||||||
|
admin user would work, as would a separate client definition with the scope tailored to your needs
|
||||||
|
and a user having the expected roles.
|
||||||
|
- The names of module options are snake_cased versions of the camelCase ones found in the Keycloak
|
||||||
|
API and its documentation at U(https://www.keycloak.org/docs-api/latest/rest-api/index.html).
|
||||||
|
- Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and
|
||||||
|
are returned that way by this module. You may pass single values for attributes when calling the
|
||||||
|
module, and this is translated into a list suitable for the API.
|
||||||
|
- Organizations are available in Keycloak 26 and later. The realm must have organizations enabled
|
||||||
|
(C(organizations_enabled=true) in the M(middleware_automation.keycloak.keycloak_realm) module)
|
||||||
|
before this module can be used.
|
||||||
|
- When updating an organization, where possible provide the organization ID to the module. This
|
||||||
|
removes a lookup to the API to translate the name into the organization ID.
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: full
|
||||||
|
action_group:
|
||||||
|
version_added: "3.1.0"
|
||||||
|
|
||||||
|
options:
|
||||||
|
state:
|
||||||
|
description:
|
||||||
|
- State of the organization.
|
||||||
|
- On V(present), the organization is created if it does not yet exist, or updated with the
|
||||||
|
parameters you provide.
|
||||||
|
- On V(absent), the organization is removed if it exists.
|
||||||
|
default: 'present'
|
||||||
|
type: str
|
||||||
|
choices:
|
||||||
|
- present
|
||||||
|
- absent
|
||||||
|
|
||||||
|
realm:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- The Keycloak realm under which this organization resides.
|
||||||
|
default: 'master'
|
||||||
|
|
||||||
|
id:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- The unique identifier for this organization.
|
||||||
|
- This parameter is not required for updating or deleting an organization but providing it
|
||||||
|
reduces the number of API calls required.
|
||||||
|
|
||||||
|
name:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of the organization.
|
||||||
|
- This parameter is required when creating a new organization.
|
||||||
|
|
||||||
|
alias:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- URL-friendly alias for the organization.
|
||||||
|
- If not provided during creation, defaults to the organization name if URL-safe.
|
||||||
|
- The alias is immutable once set and cannot be changed on update.
|
||||||
|
|
||||||
|
enabled:
|
||||||
|
type: bool
|
||||||
|
description:
|
||||||
|
- Whether the organization is enabled.
|
||||||
|
- Disabled organizations block member authentication.
|
||||||
|
|
||||||
|
description:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Description of the organization.
|
||||||
|
|
||||||
|
domains:
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
description:
|
||||||
|
- List of internet domains associated with the organization.
|
||||||
|
- A domain name can only belong to one organization within a realm.
|
||||||
|
suboptions:
|
||||||
|
name:
|
||||||
|
type: str
|
||||||
|
required: true
|
||||||
|
description:
|
||||||
|
- The domain name (e.g. V(example.com)).
|
||||||
|
verified:
|
||||||
|
type: bool
|
||||||
|
default: false
|
||||||
|
description:
|
||||||
|
- Whether the domain has been verified.
|
||||||
|
|
||||||
|
attributes:
|
||||||
|
type: dict
|
||||||
|
description:
|
||||||
|
- A dict of key/value pairs to set as custom attributes for the organization.
|
||||||
|
- Values may be single values (for example a string) or a list of strings.
|
||||||
|
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- middleware_automation.keycloak.keycloak
|
||||||
|
- middleware_automation.keycloak.actiongroup_keycloak
|
||||||
|
- middleware_automation.keycloak.attributes
|
||||||
|
|
||||||
|
author:
|
||||||
|
- Chris Brown (@chribro)
|
||||||
|
"""
|
||||||
|
|
||||||
|
EXAMPLES = r"""
|
||||||
|
- name: Create a Keycloak organization
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
name: my-org
|
||||||
|
description: My Organization
|
||||||
|
enabled: true
|
||||||
|
realm: MyRealm
|
||||||
|
state: present
|
||||||
|
auth_client_id: admin-cli
|
||||||
|
auth_keycloak_url: https://auth.example.com
|
||||||
|
auth_realm: master
|
||||||
|
auth_username: USERNAME
|
||||||
|
auth_password: PASSWORD
|
||||||
|
delegate_to: localhost
|
||||||
|
|
||||||
|
- name: Create a Keycloak organization with domains
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
name: acme-corp
|
||||||
|
description: Acme Corporation
|
||||||
|
enabled: true
|
||||||
|
domains:
|
||||||
|
- name: acme.com
|
||||||
|
- name: acme.org
|
||||||
|
verified: true
|
||||||
|
realm: MyRealm
|
||||||
|
state: present
|
||||||
|
auth_client_id: admin-cli
|
||||||
|
auth_keycloak_url: https://auth.example.com
|
||||||
|
auth_realm: master
|
||||||
|
auth_username: USERNAME
|
||||||
|
auth_password: PASSWORD
|
||||||
|
delegate_to: localhost
|
||||||
|
|
||||||
|
- name: Update a Keycloak organization
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
name: my-org
|
||||||
|
description: Updated description
|
||||||
|
realm: MyRealm
|
||||||
|
state: present
|
||||||
|
auth_client_id: admin-cli
|
||||||
|
auth_keycloak_url: https://auth.example.com
|
||||||
|
auth_realm: master
|
||||||
|
auth_username: USERNAME
|
||||||
|
auth_password: PASSWORD
|
||||||
|
delegate_to: localhost
|
||||||
|
|
||||||
|
- name: Delete a Keycloak organization
|
||||||
|
middleware_automation.keycloak.keycloak_organization:
|
||||||
|
name: my-org
|
||||||
|
state: absent
|
||||||
|
realm: MyRealm
|
||||||
|
auth_client_id: admin-cli
|
||||||
|
auth_keycloak_url: https://auth.example.com
|
||||||
|
auth_realm: master
|
||||||
|
auth_username: USERNAME
|
||||||
|
auth_password: PASSWORD
|
||||||
|
delegate_to: localhost
|
||||||
|
"""
|
||||||
|
|
||||||
|
RETURN = r"""
|
||||||
|
msg:
|
||||||
|
description: Message as to what action was taken.
|
||||||
|
returned: always
|
||||||
|
type: str
|
||||||
|
|
||||||
|
end_state:
|
||||||
|
description: Representation of the organization after module execution.
|
||||||
|
returned: on success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
id:
|
||||||
|
description: GUID that identifies the organization.
|
||||||
|
type: str
|
||||||
|
returned: always
|
||||||
|
sample: 23f38145-3195-462c-97e7-97041ccea73e
|
||||||
|
name:
|
||||||
|
description: Name of the organization.
|
||||||
|
type: str
|
||||||
|
returned: always
|
||||||
|
sample: my-org
|
||||||
|
alias:
|
||||||
|
description: URL-friendly alias of the organization.
|
||||||
|
type: str
|
||||||
|
returned: always
|
||||||
|
sample: my-org
|
||||||
|
enabled:
|
||||||
|
description: Whether the organization is enabled.
|
||||||
|
type: bool
|
||||||
|
returned: always
|
||||||
|
sample: true
|
||||||
|
description:
|
||||||
|
description: Description of the organization.
|
||||||
|
type: str
|
||||||
|
returned: always
|
||||||
|
sample: My Organization
|
||||||
|
domains:
|
||||||
|
description: Domains associated with the organization.
|
||||||
|
type: list
|
||||||
|
returned: always
|
||||||
|
sample: [{"name": "example.com", "verified": false}]
|
||||||
|
attributes:
|
||||||
|
description: Attributes applied to this organization.
|
||||||
|
type: dict
|
||||||
|
returned: always
|
||||||
|
sample:
|
||||||
|
attr1: ["val1", "val2"]
|
||||||
|
"""
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
||||||
|
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak.keycloak import (
|
||||||
|
KeycloakAPI,
|
||||||
|
KeycloakError,
|
||||||
|
camel,
|
||||||
|
get_token,
|
||||||
|
keycloak_argument_spec,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def normalise_org(org):
|
||||||
|
"""Normalise an organization representation for comparison.
|
||||||
|
Sorts domains by name to ensure order-independent comparison.
|
||||||
|
"""
|
||||||
|
if org and "domains" in org and org["domains"]:
|
||||||
|
org["domains"] = sorted(org["domains"], key=lambda d: d.get("name", ""))
|
||||||
|
return org
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
argument_spec = keycloak_argument_spec()
|
||||||
|
|
||||||
|
meta_args = dict(
|
||||||
|
state=dict(default="present", choices=["present", "absent"]),
|
||||||
|
realm=dict(default="master"),
|
||||||
|
id=dict(type="str"),
|
||||||
|
name=dict(type="str"),
|
||||||
|
alias=dict(type="str"),
|
||||||
|
enabled=dict(type="bool"),
|
||||||
|
description=dict(type="str"),
|
||||||
|
domains=dict(
|
||||||
|
type="list",
|
||||||
|
elements="dict",
|
||||||
|
options=dict(
|
||||||
|
name=dict(type="str", required=True),
|
||||||
|
verified=dict(type="bool", default=False),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
attributes=dict(type="dict"),
|
||||||
|
)
|
||||||
|
|
||||||
|
argument_spec.update(meta_args)
|
||||||
|
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=argument_spec,
|
||||||
|
supports_check_mode=True,
|
||||||
|
required_one_of=(
|
||||||
|
[
|
||||||
|
["id", "name"],
|
||||||
|
["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"},
|
||||||
|
)
|
||||||
|
|
||||||
|
result = dict(changed=False, msg="", diff={}, end_state={})
|
||||||
|
|
||||||
|
try:
|
||||||
|
connection_header = get_token(module.params)
|
||||||
|
except KeycloakError as e:
|
||||||
|
module.fail_json(msg=str(e))
|
||||||
|
|
||||||
|
kc = KeycloakAPI(module, connection_header)
|
||||||
|
|
||||||
|
realm = module.params.get("realm")
|
||||||
|
state = module.params.get("state")
|
||||||
|
oid = module.params.get("id")
|
||||||
|
name = module.params.get("name")
|
||||||
|
attributes = module.params.get("attributes")
|
||||||
|
|
||||||
|
if attributes is not None:
|
||||||
|
for key, val in module.params["attributes"].items():
|
||||||
|
module.params["attributes"][key] = [val] if not isinstance(val, list) else val
|
||||||
|
|
||||||
|
# Parameters that map to the organization representation (excluding module-level params)
|
||||||
|
org_params = [
|
||||||
|
x
|
||||||
|
for x in module.params
|
||||||
|
if x not in list(keycloak_argument_spec().keys()) + ["state", "realm"]
|
||||||
|
and module.params.get(x) is not None
|
||||||
|
]
|
||||||
|
|
||||||
|
if oid is None:
|
||||||
|
before_org = kc.get_organization_by_name(name, realm=realm)
|
||||||
|
else:
|
||||||
|
before_org = kc.get_organization_by_id(oid, realm=realm)
|
||||||
|
|
||||||
|
if before_org is None:
|
||||||
|
before_org = {}
|
||||||
|
|
||||||
|
normalise_org(before_org)
|
||||||
|
|
||||||
|
changeset = {}
|
||||||
|
for param in org_params:
|
||||||
|
new_param_value = module.params.get(param)
|
||||||
|
if param == "alias" and before_org:
|
||||||
|
if new_param_value != before_org.get("alias"):
|
||||||
|
module.warn(
|
||||||
|
f"Organization alias is immutable and cannot be changed from '{before_org.get('alias')}' "
|
||||||
|
f"to '{new_param_value}'. The alias parameter will be ignored for this update."
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
old_value = before_org.get(camel(param))
|
||||||
|
if new_param_value != old_value:
|
||||||
|
changeset[camel(param)] = new_param_value
|
||||||
|
|
||||||
|
desired_org = before_org.copy()
|
||||||
|
desired_org.update(changeset)
|
||||||
|
|
||||||
|
normalise_org(desired_org)
|
||||||
|
|
||||||
|
if not before_org:
|
||||||
|
if state == "absent":
|
||||||
|
if module._diff:
|
||||||
|
result["diff"] = dict(before="", after="")
|
||||||
|
result["changed"] = False
|
||||||
|
result["end_state"] = {}
|
||||||
|
result["msg"] = "Organization does not exist; doing nothing."
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
result["changed"] = True
|
||||||
|
|
||||||
|
if name is None:
|
||||||
|
module.fail_json(msg="name must be specified when creating a new organization")
|
||||||
|
|
||||||
|
if module._diff:
|
||||||
|
result["diff"] = dict(before="", after=desired_org)
|
||||||
|
|
||||||
|
if module.check_mode:
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
kc.create_organization(desired_org, realm=realm)
|
||||||
|
|
||||||
|
after_org = kc.get_organization_by_name(name, realm=realm)
|
||||||
|
|
||||||
|
result["end_state"] = normalise_org(after_org) if after_org else {}
|
||||||
|
result["msg"] = f"Organization {name} has been created with ID {after_org['id']}"
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
else:
|
||||||
|
if state == "present":
|
||||||
|
if desired_org == before_org:
|
||||||
|
result["changed"] = False
|
||||||
|
result["end_state"] = desired_org
|
||||||
|
result["msg"] = f"No changes required to organization {before_org['name']}."
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
result["changed"] = True
|
||||||
|
|
||||||
|
if module._diff:
|
||||||
|
result["diff"] = dict(before=before_org, after=desired_org)
|
||||||
|
|
||||||
|
if module.check_mode:
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
kc.update_organization(desired_org, realm=realm)
|
||||||
|
|
||||||
|
after_org = kc.get_organization_by_id(desired_org["id"], realm=realm)
|
||||||
|
|
||||||
|
result["end_state"] = normalise_org(after_org) if after_org else {}
|
||||||
|
result["msg"] = f"Organization {desired_org['id']} has been updated"
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
else:
|
||||||
|
result["changed"] = True
|
||||||
|
|
||||||
|
if module._diff:
|
||||||
|
result["diff"] = dict(before=before_org, after="")
|
||||||
|
|
||||||
|
if module.check_mode:
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
oid = before_org["id"]
|
||||||
|
kc.delete_organization(org_id=oid, realm=realm)
|
||||||
|
|
||||||
|
result["end_state"] = {}
|
||||||
|
result["msg"] = f"Organization {before_org['name']} has been deleted"
|
||||||
|
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -0,0 +1,142 @@
|
|||||||
|
|
||||||
|
# Copyright (c) 2025, Chris Brown
|
||||||
|
# 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
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
from __future__ import annotations
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
DOCUMENTATION = r"""
|
||||||
|
module: keycloak_organization_info
|
||||||
|
|
||||||
|
short_description: Retrieve organization info in Keycloak
|
||||||
|
|
||||||
|
version_added: "3.1.0"
|
||||||
|
|
||||||
|
description:
|
||||||
|
- This module retrieves information on organizations from Keycloak.
|
||||||
|
- Organizations are available in Keycloak 26 and later. The realm must have organizations enabled
|
||||||
|
before this module can be used.
|
||||||
|
attributes:
|
||||||
|
action_group:
|
||||||
|
version_added: "3.1.0"
|
||||||
|
|
||||||
|
options:
|
||||||
|
realm:
|
||||||
|
description:
|
||||||
|
- The name of the realm.
|
||||||
|
required: true
|
||||||
|
type: str
|
||||||
|
name:
|
||||||
|
description:
|
||||||
|
- Name of the organization to search for.
|
||||||
|
- If not provided, all organizations in the realm are returned.
|
||||||
|
type: str
|
||||||
|
exact:
|
||||||
|
description:
|
||||||
|
- Whether the search should be an exact match.
|
||||||
|
- Only relevant when O(name) is provided.
|
||||||
|
type: bool
|
||||||
|
default: true
|
||||||
|
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- middleware_automation.keycloak.keycloak
|
||||||
|
- middleware_automation.keycloak.actiongroup_keycloak
|
||||||
|
- middleware_automation.keycloak.attributes
|
||||||
|
- middleware_automation.keycloak.attributes.info_module
|
||||||
|
|
||||||
|
author:
|
||||||
|
- Chris Brown (@chribro)
|
||||||
|
"""
|
||||||
|
|
||||||
|
EXAMPLES = r"""
|
||||||
|
- name: Retrieve a specific organization by name
|
||||||
|
middleware_automation.keycloak.keycloak_organization_info:
|
||||||
|
auth_keycloak_url: https://auth.example.com
|
||||||
|
auth_username: admin
|
||||||
|
auth_password: password
|
||||||
|
auth_realm: master
|
||||||
|
realm: MyRealm
|
||||||
|
name: my-org
|
||||||
|
|
||||||
|
- name: List all organizations in a realm
|
||||||
|
middleware_automation.keycloak.keycloak_organization_info:
|
||||||
|
auth_keycloak_url: https://auth.example.com
|
||||||
|
auth_username: admin
|
||||||
|
auth_password: password
|
||||||
|
auth_realm: master
|
||||||
|
realm: MyRealm
|
||||||
|
|
||||||
|
- name: Search organizations by partial name
|
||||||
|
middleware_automation.keycloak.keycloak_organization_info:
|
||||||
|
auth_keycloak_url: https://auth.example.com
|
||||||
|
auth_username: admin
|
||||||
|
auth_password: password
|
||||||
|
auth_realm: master
|
||||||
|
realm: MyRealm
|
||||||
|
name: acme
|
||||||
|
exact: false
|
||||||
|
"""
|
||||||
|
|
||||||
|
RETURN = r"""
|
||||||
|
organizations:
|
||||||
|
description: JSON representation of organizations.
|
||||||
|
returned: always
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
"""
|
||||||
|
|
||||||
|
from urllib.parse import quote
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
||||||
|
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak.keycloak import (
|
||||||
|
KeycloakAPI,
|
||||||
|
KeycloakError,
|
||||||
|
get_token,
|
||||||
|
keycloak_argument_spec,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
argument_spec = keycloak_argument_spec()
|
||||||
|
|
||||||
|
meta_args = dict(
|
||||||
|
name=dict(type="str"),
|
||||||
|
realm=dict(type="str", required=True),
|
||||||
|
exact=dict(type="bool", default=True),
|
||||||
|
)
|
||||||
|
|
||||||
|
argument_spec.update(meta_args)
|
||||||
|
|
||||||
|
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
|
||||||
|
|
||||||
|
result = dict(changed=False, organizations=[])
|
||||||
|
|
||||||
|
try:
|
||||||
|
connection_header = get_token(module.params)
|
||||||
|
except KeycloakError as e:
|
||||||
|
module.fail_json(msg=str(e))
|
||||||
|
|
||||||
|
kc = KeycloakAPI(module, connection_header)
|
||||||
|
|
||||||
|
realm = module.params.get("realm")
|
||||||
|
name = module.params.get("name")
|
||||||
|
exact = module.params.get("exact")
|
||||||
|
|
||||||
|
filters = []
|
||||||
|
if name:
|
||||||
|
filters.append(f"search={quote(name, safe='')}")
|
||||||
|
if exact:
|
||||||
|
filters.append("exact=true")
|
||||||
|
|
||||||
|
filter_str = "&".join(filters) if filters else None
|
||||||
|
|
||||||
|
result["organizations"] = kc.get_organizations(search_filter=filter_str, realm=realm)
|
||||||
|
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -327,6 +327,12 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- maxFailureWaitSeconds
|
- maxFailureWaitSeconds
|
||||||
type: int
|
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:
|
max_temporary_lockouts:
|
||||||
description:
|
description:
|
||||||
- The realm max temporary lockouts.
|
- The realm max temporary lockouts.
|
||||||
@@ -424,6 +430,13 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- permanentLockout
|
- permanentLockout
|
||||||
type: bool
|
type: bool
|
||||||
|
prune_undefined_realm_attributes:
|
||||||
|
description:
|
||||||
|
- If True all realm attributes which are not defined in the attributes dict will be deleted
|
||||||
|
aliases:
|
||||||
|
- pruneUndefinedRealmAttributes
|
||||||
|
type: bool
|
||||||
|
default: true
|
||||||
quick_login_check_milli_seconds:
|
quick_login_check_milli_seconds:
|
||||||
description:
|
description:
|
||||||
- The realm quick login check in milliseconds.
|
- The realm quick login check in milliseconds.
|
||||||
@@ -799,6 +812,9 @@ from ansible_collections.middleware_automation.keycloak.plugins.module_utils.ide
|
|||||||
get_token,
|
get_token,
|
||||||
keycloak_argument_spec,
|
keycloak_argument_spec,
|
||||||
)
|
)
|
||||||
|
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak._keycloak_utils import (
|
||||||
|
merge_settings_without_absent_nulls,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def normalise_cr(realmrep):
|
def normalise_cr(realmrep):
|
||||||
@@ -904,6 +920,7 @@ def main():
|
|||||||
login_with_email_allowed=dict(type="bool", aliases=["loginWithEmailAllowed"]),
|
login_with_email_allowed=dict(type="bool", aliases=["loginWithEmailAllowed"]),
|
||||||
max_delta_time_seconds=dict(type="int", aliases=["maxDeltaTimeSeconds"]),
|
max_delta_time_seconds=dict(type="int", aliases=["maxDeltaTimeSeconds"]),
|
||||||
max_failure_wait_seconds=dict(type="int", aliases=["maxFailureWaitSeconds"]),
|
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"]),
|
max_temporary_lockouts=dict(type="int", aliases=["maxTemporaryLockouts"]),
|
||||||
minimum_quick_login_wait_seconds=dict(type="int", aliases=["minimumQuickLoginWaitSeconds"]),
|
minimum_quick_login_wait_seconds=dict(type="int", aliases=["minimumQuickLoginWaitSeconds"]),
|
||||||
not_before=dict(type="int", aliases=["notBefore"]),
|
not_before=dict(type="int", aliases=["notBefore"]),
|
||||||
@@ -920,6 +937,7 @@ def main():
|
|||||||
password_policy=dict(type="str", aliases=["passwordPolicy"], no_log=False),
|
password_policy=dict(type="str", aliases=["passwordPolicy"], no_log=False),
|
||||||
organizations_enabled=dict(type="bool", aliases=["organizationsEnabled"]),
|
organizations_enabled=dict(type="bool", aliases=["organizationsEnabled"]),
|
||||||
permanent_lockout=dict(type="bool", aliases=["permanentLockout"]),
|
permanent_lockout=dict(type="bool", aliases=["permanentLockout"]),
|
||||||
|
prune_undefined_realm_attributes=dict(type="bool", aliases=["pruneUndefinedRealmAttributes"], default=True),
|
||||||
quick_login_check_milli_seconds=dict(type="int", aliases=["quickLoginCheckMilliSeconds"]),
|
quick_login_check_milli_seconds=dict(type="int", aliases=["quickLoginCheckMilliSeconds"]),
|
||||||
refresh_token_max_reuse=dict(type="int", aliases=["refreshTokenMaxReuse"], no_log=False),
|
refresh_token_max_reuse=dict(type="int", aliases=["refreshTokenMaxReuse"], no_log=False),
|
||||||
registration_allowed=dict(type="bool", aliases=["registrationAllowed"]),
|
registration_allowed=dict(type="bool", aliases=["registrationAllowed"]),
|
||||||
@@ -1031,9 +1049,10 @@ def main():
|
|||||||
|
|
||||||
realm = module.params.get("realm")
|
realm = module.params.get("realm")
|
||||||
state = module.params.get("state")
|
state = module.params.get("state")
|
||||||
|
prune_undefined_realm_attributes = module.params.get("prune_undefined_realm_attributes")
|
||||||
|
|
||||||
# convert module parameters to realm representation parameters (if they belong in there)
|
# convert module parameters to realm representation parameters (if they belong in there)
|
||||||
params_to_ignore = list(keycloak_argument_spec().keys()) + ["state"]
|
params_to_ignore = list(keycloak_argument_spec().keys()) + ["state", "prune_undefined_realm_attributes"]
|
||||||
|
|
||||||
# Filter and map the parameters names that apply to the role
|
# Filter and map the parameters names that apply to the role
|
||||||
realm_params = [x for x in module.params if x not in params_to_ignore and module.params.get(x) is not None]
|
realm_params = [x for x in module.params if x not in params_to_ignore and module.params.get(x) is not None]
|
||||||
@@ -1049,6 +1068,9 @@ def main():
|
|||||||
|
|
||||||
for realm_param in realm_params:
|
for realm_param in realm_params:
|
||||||
new_param_value = module.params.get(realm_param)
|
new_param_value = module.params.get(realm_param)
|
||||||
|
if camel(realm_param) == "attributes" and not prune_undefined_realm_attributes:
|
||||||
|
new_param_value = merge_settings_without_absent_nulls(before_realm.get("attributes"), new_param_value)
|
||||||
|
|
||||||
changeset[camel(realm_param)] = new_param_value
|
changeset[camel(realm_param)] = new_param_value
|
||||||
|
|
||||||
# Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
|
# Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
|
||||||
|
|||||||
@@ -0,0 +1,123 @@
|
|||||||
|
#!/usr/bin/python
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
from __future__ import annotations
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
DOCUMENTATION = r"""
|
||||||
|
module: keycloak_realm_users_info
|
||||||
|
|
||||||
|
short_description: Retrieve users from a Keycloak realm using the Keycloak API
|
||||||
|
|
||||||
|
# Originally added in community.general 13.1.0
|
||||||
|
version_added: "3.1.0"
|
||||||
|
|
||||||
|
description:
|
||||||
|
- This module retrieves all users from a specified Keycloak realm using the Keycloak REST API.
|
||||||
|
- Access to the REST API is performed via OpenID Connect. The user and client used must have the necessary permissions.
|
||||||
|
- Authentication can be performed either with username/password or with a token.
|
||||||
|
- The names of module options are snake_case versions of the camelCase ones found in the Keycloak API and its documentation
|
||||||
|
at U(https://www.keycloak.org/docs-api/latest/rest-api/index.html).
|
||||||
|
|
||||||
|
options:
|
||||||
|
realm:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- The Keycloak realm from which users should be retrieved.
|
||||||
|
default: 'master'
|
||||||
|
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- middleware_automation.keycloak.keycloak
|
||||||
|
- middleware_automation.keycloak.actiongroup_keycloak
|
||||||
|
- middleware_automation.keycloak.attributes
|
||||||
|
- middleware_automation.keycloak.attributes.info_module
|
||||||
|
|
||||||
|
author:
|
||||||
|
- Felix Grzelka (@felix-grzelka)
|
||||||
|
"""
|
||||||
|
|
||||||
|
EXAMPLES = r"""
|
||||||
|
- name: List all users in the "MyCustomRealm" realm using username/password authentication
|
||||||
|
middleware_automation.keycloak.keycloak_realm_users_info:
|
||||||
|
realm: MyCustomRealm
|
||||||
|
auth_client_id: admin-cli
|
||||||
|
auth_keycloak_url: https://auth.example.com
|
||||||
|
auth_realm: master
|
||||||
|
auth_username: USERNAME
|
||||||
|
auth_password: PASSWORD
|
||||||
|
delegate_to: localhost
|
||||||
|
|
||||||
|
- name: List all users in the "MyCustomRealm" realm using a token
|
||||||
|
middleware_automation.keycloak.keycloak_realm_users_info:
|
||||||
|
realm: MyCustomRealm
|
||||||
|
auth_client_id: admin-cli
|
||||||
|
auth_keycloak_url: https://auth.example.com
|
||||||
|
token: TOKEN
|
||||||
|
delegate_to: localhost
|
||||||
|
"""
|
||||||
|
|
||||||
|
RETURN = r"""
|
||||||
|
users:
|
||||||
|
description: List of users in the specified realm.
|
||||||
|
returned: always
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
sample:
|
||||||
|
- id: "1234-5678-90"
|
||||||
|
username: "user1"
|
||||||
|
email: "user1@example.com"
|
||||||
|
- id: "2345-6789-01"
|
||||||
|
username: "user2"
|
||||||
|
email: "user2@example.com"
|
||||||
|
"""
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
||||||
|
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak.keycloak import (
|
||||||
|
KeycloakAPI,
|
||||||
|
KeycloakError,
|
||||||
|
get_token,
|
||||||
|
keycloak_argument_spec,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
argument_spec = keycloak_argument_spec()
|
||||||
|
|
||||||
|
meta_args = dict(
|
||||||
|
realm=dict(default="master"),
|
||||||
|
)
|
||||||
|
argument_spec.update(meta_args)
|
||||||
|
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=argument_spec,
|
||||||
|
supports_check_mode=True,
|
||||||
|
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"},
|
||||||
|
)
|
||||||
|
|
||||||
|
result = dict(changed=False, msg="", users="")
|
||||||
|
|
||||||
|
# Obtain access token, initialize API
|
||||||
|
try:
|
||||||
|
connection_header = get_token(module.params)
|
||||||
|
except KeycloakError as e:
|
||||||
|
module.fail_json(msg=str(e))
|
||||||
|
|
||||||
|
kc = KeycloakAPI(module, connection_header)
|
||||||
|
|
||||||
|
realm = module.params.get("realm")
|
||||||
|
|
||||||
|
result["users"] = kc.get_realm_users(realm=realm)
|
||||||
|
module.exit_json(**result)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -512,6 +512,7 @@ def main():
|
|||||||
"groups",
|
"groups",
|
||||||
"clientConsents",
|
"clientConsents",
|
||||||
"federatedIdentities",
|
"federatedIdentities",
|
||||||
|
"state",
|
||||||
]
|
]
|
||||||
|
|
||||||
if state == "absent":
|
if state == "absent":
|
||||||
@@ -554,9 +555,16 @@ def main():
|
|||||||
# Add user ID to new representation
|
# Add user ID to new representation
|
||||||
desired_user["id"] = before_user["id"]
|
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
|
# Compare users
|
||||||
if not (
|
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
|
): # If the new user introduces a change to the existing user
|
||||||
# Update the user
|
# Update the user
|
||||||
if not module.check_mode:
|
if not module.check_mode:
|
||||||
|
|||||||
@@ -994,7 +994,6 @@ def main():
|
|||||||
if changeset.get("mappers") is None:
|
if changeset.get("mappers") is None:
|
||||||
changeset["mappers"] = list()
|
changeset["mappers"] = list()
|
||||||
changeset["mappers"].append(new_mapper)
|
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
|
# 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:
|
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]
|
[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)
|
# 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 = before_comp.copy()
|
||||||
desired_comp.update(changeset)
|
desired_comp.update(changeset)
|
||||||
|
|||||||
@@ -337,38 +337,9 @@ def main():
|
|||||||
module.fail_json(msg=f"Could not fetch client {client_id}:")
|
module.fail_json(msg=f"Could not fetch client {client_id}:")
|
||||||
if roles is None:
|
if roles is None:
|
||||||
module.exit_json(msg="Nothing to do (no roles specified).")
|
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:
|
if cid is None:
|
||||||
available_roles_before = kc.get_realm_user_available_rolemappings(uid=uid, realm=realm)
|
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)
|
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)
|
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)
|
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["existing"] = assigned_roles_before
|
||||||
result["proposed"] = roles
|
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_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_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` | 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_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_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` |
|
|`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
|
Author Information
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
|
* [Ranabir Chakraborty](https://github.com/RanabirChakraborty)
|
||||||
* [Guido Grazioli](https://github.com/guidograzioli)
|
* [Guido Grazioli](https://github.com/guidograzioli)
|
||||||
* [Romain Pelisse](https://github.com/rpelisse)
|
* [Romain Pelisse](https://github.com/rpelisse)
|
||||||
* [Pavan Kumar Motaparthi](https://github.com/motaparthipavankumar)
|
* [Pavan Kumar Motaparthi](https://github.com/motaparthipavankumar)
|
||||||
|
|||||||
@@ -60,7 +60,7 @@ keycloak_features: []
|
|||||||
keycloak_ha_enabled: false
|
keycloak_ha_enabled: false
|
||||||
### Enable database configuration, must be enabled when HA is configured
|
### Enable database configuration, must be enabled when HA is configured
|
||||||
keycloak_db_enabled: "{{ True if keycloak_ha_enabled else False }}"
|
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' }}"
|
keycloak_ha_discovery: "{{ 'JDBC_PING' if keycloak_db_enabled else 'TCPPING' }}"
|
||||||
### Remote cache store on infinispan cluster
|
### Remote cache store on infinispan cluster
|
||||||
keycloak_remote_cache_enabled: "{{ True if keycloak_ha_enabled else False }}"
|
keycloak_remote_cache_enabled: "{{ True if keycloak_ha_enabled else False }}"
|
||||||
|
|||||||
@@ -296,7 +296,7 @@ argument_specs:
|
|||||||
type: "bool"
|
type: "bool"
|
||||||
keycloak_db_background_validation_millis:
|
keycloak_db_background_validation_millis:
|
||||||
default: "{{ 10000 if keycloak_db_background_validation else 0 }}"
|
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'
|
type: 'int'
|
||||||
keycloak_db_background_validate_on_match:
|
keycloak_db_background_validate_on_match:
|
||||||
default: false
|
default: false
|
||||||
|
|||||||
@@ -87,7 +87,7 @@
|
|||||||
mode: '0644'
|
mode: '0644'
|
||||||
url_username: "{{ keycloak_binary_download_user | default(omit) }}"
|
url_username: "{{ keycloak_binary_download_user | default(omit) }}"
|
||||||
url_password: "{{ keycloak_binary_download_pass | default(omit) }}"
|
url_password: "{{ keycloak_binary_download_pass | default(omit) }}"
|
||||||
validate_certs: false
|
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
run_once: true
|
run_once: true
|
||||||
when:
|
when:
|
||||||
@@ -114,7 +114,7 @@
|
|||||||
product_type: DISTRIBUTION
|
product_type: DISTRIBUTION
|
||||||
product_version: "{{ sso_version.split('.')[:2] | join('.') }}"
|
product_version: "{{ sso_version.split('.')[:2] | join('.') }}"
|
||||||
product_category: "{{ sso_product_category }}"
|
product_category: "{{ sso_product_category }}"
|
||||||
validate_certs: false
|
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
|
||||||
register: keycloak_rhn_products
|
register: keycloak_rhn_products
|
||||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
@@ -135,7 +135,7 @@
|
|||||||
client_secret: "{{ rhn_password }}"
|
client_secret: "{{ rhn_password }}"
|
||||||
product_id: "{{ (keycloak_rhn_filtered_products | first).id }}"
|
product_id: "{{ (keycloak_rhn_filtered_products | first).id }}"
|
||||||
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
|
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
|
||||||
validate_certs: false
|
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
|
||||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
run_once: true
|
run_once: true
|
||||||
@@ -145,7 +145,7 @@
|
|||||||
url: "{{ keycloak_rhsso_download_url }}"
|
url: "{{ keycloak_rhsso_download_url }}"
|
||||||
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
|
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
|
||||||
mode: '0644'
|
mode: '0644'
|
||||||
validate_certs: false
|
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
run_once: true
|
run_once: true
|
||||||
when:
|
when:
|
||||||
@@ -256,8 +256,8 @@
|
|||||||
{
|
{
|
||||||
"name": item,
|
"name": item,
|
||||||
"address": 'jgroups-' + item,
|
"address": 'jgroups-' + item,
|
||||||
"inventory_host": hostvars[item].ansible_default_ipv4.address | default(item) + '[' + (keycloak_jgroups_port | string) + ']',
|
"inventory_host": hostvars[item].ansible_facts['default_ipv4']['address'] | default(item) + '[' + (keycloak_jgroups_port | string) + ']',
|
||||||
"value": hostvars[item].ansible_default_ipv4.address | default(item)
|
"value": hostvars[item].ansible_facts['default_ipv4']['address'] | default(item)
|
||||||
}
|
}
|
||||||
] }}
|
] }}
|
||||||
loop: "{{ ansible_play_batch }}"
|
loop: "{{ ansible_play_batch }}"
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
|
|
||||||
- name: Distro specific tasks
|
- name: Distro specific tasks
|
||||||
ansible.builtin.include_tasks:
|
ansible.builtin.include_tasks:
|
||||||
file: "{{ ansible_os_family | lower }}.yml"
|
file: "{{ ansible_facts['os_family'] | lower }}.yml"
|
||||||
apply:
|
apply:
|
||||||
tags:
|
tags:
|
||||||
- unbound
|
- unbound
|
||||||
@@ -60,7 +60,7 @@
|
|||||||
url: "{{ keycloak_url }}/auth/realms/master/protocol/openid-connect/token"
|
url: "{{ keycloak_url }}/auth/realms/master/protocol/openid-connect/token"
|
||||||
method: POST
|
method: POST
|
||||||
body: "client_id={{ keycloak_auth_client }}&username={{ keycloak_admin_user }}&password={{ keycloak_admin_password }}&grant_type=password"
|
body: "client_id={{ keycloak_auth_client }}&username={{ keycloak_admin_user }}&password={{ keycloak_admin_password }}&grant_type=password"
|
||||||
validate_certs: false
|
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
|
||||||
register: keycloak_auth_response
|
register: keycloak_auth_response
|
||||||
until: keycloak_auth_response.status == 200
|
until: keycloak_auth_response.status == 200
|
||||||
retries: 2
|
retries: 2
|
||||||
@@ -81,6 +81,7 @@
|
|||||||
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
|
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
|
||||||
ansible.builtin.uri:
|
ansible.builtin.uri:
|
||||||
url: "{{ keycloak_config.health_url }}"
|
url: "{{ keycloak_config.health_url }}"
|
||||||
|
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
|
||||||
register: keycloak_status
|
register: keycloak_status
|
||||||
until: keycloak_status.status == 200
|
until: keycloak_status.status == 200
|
||||||
retries: 25
|
retries: 25
|
||||||
|
|||||||
@@ -42,13 +42,13 @@
|
|||||||
- name: Validate OS family
|
- name: Validate OS family
|
||||||
ansible.builtin.assert:
|
ansible.builtin.assert:
|
||||||
that:
|
that:
|
||||||
- ansible_os_family in ["RedHat", "Debian"]
|
- ansible_facts['os_family'] in ["RedHat", "Debian"]
|
||||||
quiet: true
|
quiet: true
|
||||||
fail_msg: "Can only install on RedHat or Debian OS families; found {{ ansible_os_family }}"
|
fail_msg: "Can only install on RedHat or Debian OS families; found {{ ansible_facts['os_family'] }}"
|
||||||
success_msg: "Installing on {{ ansible_os_family }}"
|
success_msg: "Installing on {{ ansible_facts['os_family'] }}"
|
||||||
|
|
||||||
- name: Load OS specific variables
|
- 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:
|
tags:
|
||||||
- always
|
- always
|
||||||
|
|
||||||
|
|||||||
@@ -12,6 +12,7 @@
|
|||||||
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
|
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
|
||||||
ansible.builtin.uri:
|
ansible.builtin.uri:
|
||||||
url: "{{ keycloak_config.health_url }}"
|
url: "{{ keycloak_config.health_url }}"
|
||||||
|
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
|
||||||
register: keycloak_status
|
register: keycloak_status
|
||||||
until: keycloak_status.status == 200
|
until: keycloak_status.status == 200
|
||||||
delegate_to: "{{ ansible_play_hosts | first }}"
|
delegate_to: "{{ ansible_play_hosts | first }}"
|
||||||
|
|||||||
@@ -29,7 +29,7 @@
|
|||||||
product_type: BUGFIX
|
product_type: BUGFIX
|
||||||
product_version: "{{ sso_version.split('.')[:2] | join('.') }}"
|
product_version: "{{ sso_version.split('.')[:2] | join('.') }}"
|
||||||
product_category: "{{ sso_product_category }}"
|
product_category: "{{ sso_product_category }}"
|
||||||
validate_certs: false
|
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
|
||||||
register: keycloak_rhn_products
|
register: keycloak_rhn_products
|
||||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
@@ -75,7 +75,7 @@
|
|||||||
client_secret: "{{ rhn_password }}"
|
client_secret: "{{ rhn_password }}"
|
||||||
product_id: "{{ (keycloak_rhn_filtered_products | sort | last).id }}"
|
product_id: "{{ (keycloak_rhn_filtered_products | sort | last).id }}"
|
||||||
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_patch_bundle }}"
|
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_patch_bundle }}"
|
||||||
validate_certs: false
|
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
|
||||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
run_once: true
|
run_once: true
|
||||||
@@ -143,6 +143,7 @@
|
|||||||
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
|
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
|
||||||
ansible.builtin.uri:
|
ansible.builtin.uri:
|
||||||
url: "{{ keycloak_config.health_url }}"
|
url: "{{ keycloak_config.health_url }}"
|
||||||
|
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
|
||||||
register: keycloak_status
|
register: keycloak_status
|
||||||
until: keycloak_status.status == 200
|
until: keycloak_status.status == 200
|
||||||
retries: 25
|
retries: 25
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
|
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
|
||||||
ansible.builtin.uri:
|
ansible.builtin.uri:
|
||||||
url: "{{ keycloak_config.health_url }}"
|
url: "{{ keycloak_config.health_url }}"
|
||||||
|
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
|
||||||
register: keycloak_status
|
register: keycloak_status
|
||||||
until: keycloak_status.status == 200
|
until: keycloak_status.status == 200
|
||||||
retries: "{{ keycloak_service_start_retries }}"
|
retries: "{{ keycloak_service_start_retries }}"
|
||||||
|
|||||||
@@ -727,8 +727,8 @@
|
|||||||
<inet-address value="{{ keycloak_management_port_bind_address }}"/>
|
<inet-address value="{{ keycloak_management_port_bind_address }}"/>
|
||||||
</interface>
|
</interface>
|
||||||
<interface name="jgroups">
|
<interface name="jgroups">
|
||||||
{% if ansible_default_ipv4 is defined %}
|
{% if ansible_facts['default_ipv4'] is defined %}
|
||||||
<subnet-match value="{{ (ansible_default_ipv4.network + '/' + ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') }}"/>
|
<subnet-match value="{{ (ansible_facts['default_ipv4']['network'] + '/' + ansible_facts['default_ipv4']['netmask']) | ansible.utils.ipaddr('net') }}"/>
|
||||||
{% else %}
|
{% else %}
|
||||||
<any-address />
|
<any-address />
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -724,8 +724,8 @@
|
|||||||
<inet-address value="${jboss.bind.address.management:127.0.0.1}"/>
|
<inet-address value="${jboss.bind.address.management:127.0.0.1}"/>
|
||||||
</interface>
|
</interface>
|
||||||
<interface name="jgroups">
|
<interface name="jgroups">
|
||||||
{% if ansible_default_ipv4 is defined %}
|
{% if ansible_facts['default_ipv4'] is defined %}
|
||||||
<subnet-match value="{{ (ansible_default_ipv4.network + '/' + ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') }}"/>
|
<subnet-match value="{{ (ansible_facts['default_ipv4']['network'] + '/' + ansible_facts['default_ipv4']['netmask']) | ansible.utils.ipaddr('net') }}"/>
|
||||||
{% else %}
|
{% else %}
|
||||||
<any-address />
|
<any-address />
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -664,8 +664,8 @@
|
|||||||
<interface name="jgroups">
|
<interface name="jgroups">
|
||||||
{% if keycloak_jgroups_subnet is defined and keycloak_jgroups_subnet is not none and keycloak_jgroups_subnet | string | length > 0 %}
|
{% 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 }}"/>
|
<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 %}
|
{% 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_default_ipv4.network + '/' + ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') }}"/>
|
<subnet-match value="{{ (ansible_facts['default_ipv4']['network'] + '/' + ansible_facts['default_ipv4']['netmask']) | ansible.utils.ipaddr('net') }}"/>
|
||||||
{% else %}
|
{% else %}
|
||||||
<any-address />
|
<any-address />
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -702,8 +702,8 @@
|
|||||||
<interface name="jgroups">
|
<interface name="jgroups">
|
||||||
{% if keycloak_jgroups_subnet is defined and keycloak_jgroups_subnet is not none and keycloak_jgroups_subnet | string | length > 0 %}
|
{% 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 }}"/>
|
<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 %}
|
{% 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_default_ipv4.network + '/' + ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') }}"/>
|
<subnet-match value="{{ (ansible_facts['default_ipv4']['network'] + '/' + ansible_facts['default_ipv4']['netmask']) | ansible.utils.ipaddr('net') }}"/>
|
||||||
{% else %}
|
{% else %}
|
||||||
<any-address />
|
<any-address />
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ Role Defaults
|
|||||||
|
|
||||||
| Variable | Description | Default |
|
| Variable | Description | Default |
|
||||||
|:---------|:------------|:--------|
|
|:---------|:------------|:--------|
|
||||||
|`keycloak_quarkus_version`| keycloak.org package version | `26.6.2` |
|
|`keycloak_quarkus_version`| keycloak.org package version | `26.7.3` |
|
||||||
|`keycloak_quarkus_offline_install` | Perform an offline install | `False`|
|
|`keycloak_quarkus_offline_install` | Perform an offline install | `False`|
|
||||||
|`keycloak_quarkus_dest`| Installation root path | `/opt/keycloak` |
|
|`keycloak_quarkus_dest`| Installation root path | `/opt/keycloak` |
|
||||||
|`keycloak_quarkus_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}` |
|
|`keycloak_quarkus_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}` |
|
||||||
@@ -63,8 +63,8 @@ Role Defaults
|
|||||||
|`keycloak_quarkus_additional_env_vars` | List of additional env variables of { key: str, value: str} to be put in sysconfig file, see https://www.keycloak.org/server/all-config | `[]` |
|
|`keycloak_quarkus_additional_env_vars` | List of additional env variables of { key: str, value: str} to be put in sysconfig file, see https://www.keycloak.org/server/all-config | `[]` |
|
||||||
|`keycloak_quarkus_frontend_url`| Deprecated, use `keycloak_quarkus_hostname` instead. | |
|
|`keycloak_quarkus_frontend_url`| Deprecated, use `keycloak_quarkus_hostname` instead. | |
|
||||||
|`keycloak_quarkus_admin_url`| Deprecated, use `keycloak_quarkus_hostname_admin` instead. | |
|
|`keycloak_quarkus_admin_url`| Deprecated, use `keycloak_quarkus_hostname_admin` instead. | |
|
||||||
|`keycloak_quarkus_health_check_url`| 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 | `` |
|
|`keycloak_quarkus_health_check_url`| 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 | `{{ keycloak_quarkus_hostname ~ keycloak_quarkus_http_relative_path.rstrip('/') ~ '/' ~ keycloak_quarkus_health_check_url_path }}` |
|
||||||
|`keycloak_quarkus_health_check_url_path`| Path to the health check endpoint; keycloak_quarkus_hostname will be prepended automatically; Note that keycloak_quarkus_health_check_url takes precedence over this property | `realms/master/.well-known/openid-configuration` |
|
|`keycloak_quarkus_health_check_url_path`| Path to the health check endpoint; keycloak_quarkus_hostname will be prepended automatically; Note that keycloak_quarkus_health_check_url takes precedence over this property | `realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration` |
|
||||||
|`keycloak_quarkus_proxy_headers`| Parse reverse proxy headers (`forwarded` or `xforwarded`) | `""` |
|
|`keycloak_quarkus_proxy_headers`| Parse reverse proxy headers (`forwarded` or `xforwarded`) | `""` |
|
||||||
|`keycloak_quarkus_config_key_store_file`| Path to the configuration key store; only used if `keycloak_quarkus_config_key_store_password` is not empty | `{{ keycloak.home }}/conf/conf_store.p12` if `keycloak_quarkus_config_key_store_password != ''`, else `''` |
|
|`keycloak_quarkus_config_key_store_file`| Path to the configuration key store; only used if `keycloak_quarkus_config_key_store_password` is not empty | `{{ keycloak.home }}/conf/conf_store.p12` if `keycloak_quarkus_config_key_store_password != ''`, else `''` |
|
||||||
|`keycloak_quarkus_config_key_store_password`| Password of the configuration keystore; if non-empty, `keycloak_quarkus_db_pass` will be saved to the keystore at `keycloak_quarkus_config_key_store_file` instead of being written to the configuration file in clear text | `""` |
|
|`keycloak_quarkus_config_key_store_password`| Password of the configuration keystore; if non-empty, `keycloak_quarkus_db_pass` will be saved to the keystore at `keycloak_quarkus_config_key_store_file` instead of being written to the configuration file in clear text | `""` |
|
||||||
@@ -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_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_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_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_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` | 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 }}` |
|
|`keycloak_quarkus_systemd_wait_for_port_number`| Which port the systemd unit should wait for | `{{ keycloak_quarkus_https_port }}` |
|
||||||
@@ -88,8 +88,9 @@ Role Defaults
|
|||||||
|`keycloak_quarkus_systemd_wait_for_delay`| Activation delay for service systemd unit (seconds) | `10` |
|
|`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_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`| 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_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` |
|
|`keycloak_quarkus_restart_pause`| Seconds to wait between restarts in HA strategy | `15` |
|
||||||
|
|
||||||
|
|
||||||
@@ -310,4 +311,5 @@ Apache License 2.0
|
|||||||
Author Information
|
Author Information
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
|
* [Ranabir Chakraborty](https://github.com/RanabirChakraborty)
|
||||||
* [Guido Grazioli](https://github.com/guidograzioli)
|
* [Guido Grazioli](https://github.com/guidograzioli)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
### Configuration specific to keycloak
|
### Configuration specific to keycloak
|
||||||
keycloak_quarkus_version: 26.6.2
|
keycloak_quarkus_version: 26.7.3
|
||||||
keycloak_quarkus_archive: "keycloak-{{ keycloak_quarkus_version }}.zip"
|
keycloak_quarkus_archive: "keycloak-{{ keycloak_quarkus_version }}.zip"
|
||||||
keycloak_quarkus_download_url: "https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}"
|
keycloak_quarkus_download_url: "https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}"
|
||||||
keycloak_quarkus_installdir: "{{ keycloak_quarkus_dest }}/keycloak-{{ keycloak_quarkus_version }}"
|
keycloak_quarkus_installdir: "{{ keycloak_quarkus_dest }}/keycloak-{{ keycloak_quarkus_version }}"
|
||||||
@@ -43,7 +43,7 @@ keycloak_quarkus_http_port: 8080
|
|||||||
keycloak_quarkus_https_port: 8443
|
keycloak_quarkus_https_port: 8443
|
||||||
keycloak_quarkus_http_management_port: 9000
|
keycloak_quarkus_http_management_port: 9000
|
||||||
keycloak_quarkus_jgroups_port: 7800
|
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_addr: "{{ keycloak_quarkus_jgroups_bind_address }}"
|
||||||
keycloak_quarkus_jgroups_external_port: "{{ keycloak_quarkus_jgroups_port }}"
|
keycloak_quarkus_jgroups_external_port: "{{ keycloak_quarkus_jgroups_port }}"
|
||||||
keycloak_quarkus_java_heap_opts: "-Xms1024m -Xmx2048m"
|
keycloak_quarkus_java_heap_opts: "-Xms1024m -Xmx2048m"
|
||||||
@@ -91,11 +91,11 @@ keycloak_quarkus_systemd_wait_for_timeout: 60
|
|||||||
keycloak_quarkus_systemd_wait_for_delay: 10
|
keycloak_quarkus_systemd_wait_for_delay: 10
|
||||||
|
|
||||||
### keycloak frontend url
|
### keycloak frontend url
|
||||||
keycloak_quarkus_hostname:
|
keycloak_quarkus_hostname: ""
|
||||||
keycloak_quarkus_hostname_admin: ""
|
keycloak_quarkus_hostname_admin: ""
|
||||||
|
|
||||||
### Set the path relative to / for serving resources. The path must start with a /
|
### 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: /
|
keycloak_quarkus_http_relative_path: /
|
||||||
|
|
||||||
# Disables dynamically resolving the hostname from request headers.
|
# Disables dynamically resolving the hostname from request headers.
|
||||||
@@ -186,6 +186,9 @@ keycloak_quarkus_restart_strategy: restart/serial.yml
|
|||||||
keycloak_quarkus_restart_health_check: true
|
keycloak_quarkus_restart_health_check: true
|
||||||
keycloak_quarkus_restart_health_check_delay: 10
|
keycloak_quarkus_restart_health_check_delay: 10
|
||||||
keycloak_quarkus_restart_health_check_retries: 25
|
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.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_restart_pause: 15
|
||||||
|
|
||||||
keycloak_quarkus_force_install: false
|
keycloak_quarkus_force_install: false
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ argument_specs:
|
|||||||
main:
|
main:
|
||||||
options:
|
options:
|
||||||
keycloak_quarkus_version:
|
keycloak_quarkus_version:
|
||||||
default: "26.6.2"
|
default: "26.7.3"
|
||||||
description: "keycloak.org package version"
|
description: "keycloak.org package version"
|
||||||
type: "str"
|
type: "str"
|
||||||
keycloak_quarkus_archive:
|
keycloak_quarkus_archive:
|
||||||
@@ -89,6 +89,7 @@ argument_specs:
|
|||||||
description: "Deprecated, use `keycloak_quarkus_http_host`"
|
description: "Deprecated, use `keycloak_quarkus_http_host`"
|
||||||
type: "str"
|
type: "str"
|
||||||
keycloak_quarkus_hostname:
|
keycloak_quarkus_hostname:
|
||||||
|
default: ""
|
||||||
description: >-
|
description: >-
|
||||||
Address at which is the server exposed.
|
Address at which is the server exposed.
|
||||||
Can be a full URL, or just a hostname. When only hostname is provided, scheme, port and context path are resolved from the request.
|
Can be a full URL, or just a hostname. When only hostname is provided, scheme, port and context path are resolved from the request.
|
||||||
@@ -115,10 +116,11 @@ argument_specs:
|
|||||||
description: "HTTP port"
|
description: "HTTP port"
|
||||||
type: "int"
|
type: "int"
|
||||||
keycloak_quarkus_health_check_url:
|
keycloak_quarkus_health_check_url:
|
||||||
|
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"
|
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"
|
type: "str"
|
||||||
keycloak_quarkus_health_check_url_path:
|
keycloak_quarkus_health_check_url_path:
|
||||||
default: "realms/master/.well-known/openid-configuration"
|
default: "realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration"
|
||||||
description: "Path to the health check endpoint; keycloak_quarkus_hostname will be prepended automatically; Note that keycloak_quarkus_health_check_url takes precedence over this property"
|
description: "Path to the health check endpoint; keycloak_quarkus_hostname will be prepended automatically; Note that keycloak_quarkus_health_check_url takes precedence over this property"
|
||||||
type: "str"
|
type: "str"
|
||||||
keycloak_quarkus_https_key_file_enabled:
|
keycloak_quarkus_https_key_file_enabled:
|
||||||
@@ -205,7 +207,7 @@ argument_specs:
|
|||||||
type: "int"
|
type: "int"
|
||||||
keycloak_quarkus_jgroups_bind_address:
|
keycloak_quarkus_jgroups_bind_address:
|
||||||
description: 'jgroups bind address'
|
description: 'jgroups bind address'
|
||||||
default: "{{ ansible_default_ipv4.address }}"
|
default: "{{ ansible_facts['default_ipv4']['address'] }}"
|
||||||
type: "str"
|
type: "str"
|
||||||
keycloak_quarkus_jgroups_external_addr:
|
keycloak_quarkus_jgroups_external_addr:
|
||||||
description: 'IP address that other instances in the Keycloak should use to contact this node'
|
description: 'IP address that other instances in the Keycloak should use to contact this node'
|
||||||
@@ -481,13 +483,17 @@ argument_specs:
|
|||||||
default: 15
|
default: 15
|
||||||
type: int
|
type: int
|
||||||
keycloak_quarkus_restart_health_check_delay:
|
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
|
default: 10
|
||||||
type: 'int'
|
type: 'int'
|
||||||
keycloak_quarkus_restart_health_check_retries:
|
keycloak_quarkus_restart_health_check_retries:
|
||||||
description: "Number of attempts for successful health check before failing"
|
description: "Number of attempts for successful health check before failing"
|
||||||
default: 25
|
default: 25
|
||||||
type: 'int'
|
type: 'int'
|
||||||
|
keycloak_quarkus_validate_certs:
|
||||||
|
description: "Whether to validate SSL certificates when performing health checks"
|
||||||
|
default: true
|
||||||
|
type: "bool"
|
||||||
keycloak_quarkus_show_deprecation_warnings:
|
keycloak_quarkus_show_deprecation_warnings:
|
||||||
default: true
|
default: true
|
||||||
description: "Whether or not deprecation warnings should be shown"
|
description: "Whether or not deprecation warnings should be shown"
|
||||||
@@ -519,7 +525,7 @@ argument_specs:
|
|||||||
downstream:
|
downstream:
|
||||||
options:
|
options:
|
||||||
rhbk_version:
|
rhbk_version:
|
||||||
default: "26.4.11"
|
default: "26.4.15"
|
||||||
description: "Red Hat Build of Keycloak version"
|
description: "Red Hat Build of Keycloak version"
|
||||||
type: "str"
|
type: "str"
|
||||||
rhbk_archive:
|
rhbk_archive:
|
||||||
|
|||||||
@@ -36,7 +36,7 @@
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
echo {{ item.value | quote }} | keytool -noprompt -importpass -alias {{ item.key | quote }} -keystore {{ keycloak_quarkus_config_key_store_file | quote }} -storepass {{ keycloak_quarkus_config_key_store_password | quote }} -storetype PKCS12
|
echo {{ item.value | quote }} | keytool -noprompt -importpass -alias {{ item.key | quote }} -keystore {{ keycloak_quarkus_config_key_store_file | quote }} -storepass {{ keycloak_quarkus_config_key_store_password | quote }} -storetype PKCS12
|
||||||
loop: "{{ store_items }}"
|
loop: "{{ keycloak_quarkus_store_items }}"
|
||||||
no_log: true
|
no_log: true
|
||||||
become: "{{ keycloak_quarkus_config_store_require_privilege_escalation | default(true) }}"
|
become: "{{ keycloak_quarkus_config_store_require_privilege_escalation | default(true) }}"
|
||||||
changed_when: true
|
changed_when: true
|
||||||
|
|||||||
@@ -81,7 +81,7 @@
|
|||||||
mode: '0640'
|
mode: '0640'
|
||||||
url_username: "{{ keycloak_quarkus_binary_download_user | default(omit) }}"
|
url_username: "{{ keycloak_quarkus_binary_download_user | default(omit) }}"
|
||||||
url_password: "{{ keycloak_quarkus_binary_download_pass | default(omit) }}"
|
url_password: "{{ keycloak_quarkus_binary_download_pass | default(omit) }}"
|
||||||
validate_certs: false
|
validate_certs: "{{ keycloak_quarkus_download_validate_certs | default(omit) }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
become: false
|
become: false
|
||||||
run_once: true
|
run_once: true
|
||||||
@@ -110,7 +110,7 @@
|
|||||||
product_type: DISTRIBUTION
|
product_type: DISTRIBUTION
|
||||||
product_version: "{{ rhbk_version }}"
|
product_version: "{{ rhbk_version }}"
|
||||||
product_category: "{{ rhbk_product_category }}"
|
product_category: "{{ rhbk_product_category }}"
|
||||||
validate_certs: false
|
validate_certs: "{{ keycloak_quarkus_download_validate_certs | default(omit) }}"
|
||||||
register: keycloak_quarkus_rhn_products
|
register: keycloak_quarkus_rhn_products
|
||||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
@@ -129,7 +129,7 @@
|
|||||||
product_id: "{{ (keycloak_quarkus_rhn_filtered_products | first).id }}"
|
product_id: "{{ (keycloak_quarkus_rhn_filtered_products | first).id }}"
|
||||||
dest: "{{ keycloak_quarkus_local_path.stat.path }}/{{ keycloak.bundle }}"
|
dest: "{{ keycloak_quarkus_local_path.stat.path }}/{{ keycloak.bundle }}"
|
||||||
mode: '0640'
|
mode: '0640'
|
||||||
validate_certs: false
|
validate_certs: "{{ keycloak_quarkus_download_validate_certs | default(omit) }}"
|
||||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
run_once: true
|
run_once: true
|
||||||
@@ -243,9 +243,11 @@
|
|||||||
group: "{{ keycloak.service_group }}"
|
group: "{{ keycloak.service_group }}"
|
||||||
mode: '0640'
|
mode: '0640'
|
||||||
checksum: "{{ item.checksum | default(omit) }}"
|
checksum: "{{ item.checksum | default(omit) }}"
|
||||||
|
validate_certs: "{{ keycloak_quarkus_download_validate_certs | default(omit) }}"
|
||||||
become: "{{ keycloak_quarkus_install_require_privilege_escalation | default(true) }}"
|
become: "{{ keycloak_quarkus_install_require_privilege_escalation | default(true) }}"
|
||||||
loop: "{{ keycloak_quarkus_providers }}"
|
loop: "{{ keycloak_quarkus_providers }}"
|
||||||
when: item.url is defined and item.url | length > 0
|
when: item.url is defined and item.url | length > 0
|
||||||
|
no_log: "{{ item.maven.password is defined and item.maven.password | length > 0 | default(false) }}"
|
||||||
notify: "{{ ['invalidate keycloak theme cache', 'rebuild keycloak config', 'restart keycloak'] if not item.restart is defined or item.restart else [] }}"
|
notify: "{{ ['invalidate keycloak theme cache', 'rebuild keycloak config', 'restart keycloak'] if not item.restart is defined or item.restart else [] }}"
|
||||||
|
|
||||||
# this requires the `lxml` package to be installed; we redirect this step to localhost such that we do need to install it on the remote hosts
|
# this requires the `lxml` package to be installed; we redirect this step to localhost such that we do need to install it on the remote hosts
|
||||||
@@ -258,6 +260,7 @@
|
|||||||
username: "{{ item.maven.username | default(omit) }}"
|
username: "{{ item.maven.username | default(omit) }}"
|
||||||
password: "{{ item.maven.password | default(omit) }}"
|
password: "{{ item.maven.password | default(omit) }}"
|
||||||
dest: "{{ keycloak_quarkus_local_path.stat.path }}/{{ item.id }}.jar"
|
dest: "{{ keycloak_quarkus_local_path.stat.path }}/{{ item.id }}.jar"
|
||||||
|
validate_certs: "{{ keycloak_quarkus_download_validate_certs | default(omit) }}"
|
||||||
delegate_to: "localhost"
|
delegate_to: "localhost"
|
||||||
run_once: true
|
run_once: true
|
||||||
loop: "{{ keycloak_quarkus_providers }}"
|
loop: "{{ keycloak_quarkus_providers }}"
|
||||||
@@ -289,6 +292,7 @@
|
|||||||
become: "{{ keycloak_quarkus_install_require_privilege_escalation | default(true) }}"
|
become: "{{ keycloak_quarkus_install_require_privilege_escalation | default(true) }}"
|
||||||
loop: "{{ keycloak_quarkus_providers }}"
|
loop: "{{ keycloak_quarkus_providers }}"
|
||||||
when: item.local_path is defined
|
when: item.local_path is defined
|
||||||
|
no_log: "{{ item.maven.password is defined and item.maven.password | length > 0 | default(false) }}"
|
||||||
notify: "{{ ['invalidate keycloak theme cache', 'rebuild keycloak config', 'restart keycloak'] if not item.restart is defined or item.restart else [] }}"
|
notify: "{{ ['invalidate keycloak theme cache', 'rebuild keycloak config', 'restart keycloak'] if not item.restart is defined or item.restart else [] }}"
|
||||||
|
|
||||||
- name: Ensure required folder structure for policies exists
|
- name: Ensure required folder structure for policies exists
|
||||||
@@ -308,6 +312,7 @@
|
|||||||
owner: "{{ keycloak.service_user }}"
|
owner: "{{ keycloak.service_user }}"
|
||||||
group: "{{ keycloak.service_group }}"
|
group: "{{ keycloak.service_group }}"
|
||||||
mode: '0640'
|
mode: '0640'
|
||||||
|
validate_certs: "{{ keycloak_quarkus_download_validate_certs | default(omit) }}"
|
||||||
become: "{{ keycloak_quarkus_install_require_privilege_escalation | default(true) }}"
|
become: "{{ keycloak_quarkus_install_require_privilege_escalation | default(true) }}"
|
||||||
loop: "{{ keycloak_quarkus_policies }}"
|
loop: "{{ keycloak_quarkus_policies }}"
|
||||||
when: item.url is defined and item.url | length > 0
|
when: item.url is defined and item.url | length > 0
|
||||||
|
|||||||
@@ -21,7 +21,7 @@
|
|||||||
|
|
||||||
- name: Distro specific tasks
|
- name: Distro specific tasks
|
||||||
ansible.builtin.include_tasks:
|
ansible.builtin.include_tasks:
|
||||||
file: "{{ ansible_os_family | lower }}.yml"
|
file: "{{ ansible_facts['os_family'] | lower }}.yml"
|
||||||
apply:
|
apply:
|
||||||
tags:
|
tags:
|
||||||
- unbound
|
- unbound
|
||||||
|
|||||||
@@ -39,13 +39,13 @@
|
|||||||
- name: Validate OS family
|
- name: Validate OS family
|
||||||
ansible.builtin.assert:
|
ansible.builtin.assert:
|
||||||
that:
|
that:
|
||||||
- ansible_os_family in ["RedHat", "Debian"]
|
- ansible_facts['os_family'] in ["RedHat", "Debian"]
|
||||||
quiet: true
|
quiet: true
|
||||||
fail_msg: "Can only install on RedHat or Debian OS families; found {{ ansible_os_family }}"
|
fail_msg: "Can only install on RedHat or Debian OS families; found {{ ansible_facts['os_family'] }}"
|
||||||
success_msg: "Installing on {{ ansible_os_family }}"
|
success_msg: "Installing on {{ ansible_facts['os_family'] }}"
|
||||||
|
|
||||||
- name: Load OS specific variables
|
- 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:
|
tags:
|
||||||
- always
|
- always
|
||||||
|
|
||||||
@@ -123,6 +123,7 @@
|
|||||||
fail_msg: >
|
fail_msg: >
|
||||||
Providers definition incorrect; `id` and one of `spi`, `url`, `local_path`, or `maven` are mandatory. `key` and `value` are mandatory for each property
|
Providers definition incorrect; `id` and one of `spi`, `url`, `local_path`, or `maven` are mandatory. `key` and `value` are mandatory for each property
|
||||||
loop: "{{ keycloak_quarkus_providers }}"
|
loop: "{{ keycloak_quarkus_providers }}"
|
||||||
|
no_log: "{{ item.maven.password is defined and item.maven.password | length > 0 | default(false) }}"
|
||||||
|
|
||||||
- name: "Validate policies"
|
- name: "Validate policies"
|
||||||
ansible.builtin.assert:
|
ansible.builtin.assert:
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user