mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2026-11-21 14:48:50 +00:00
Compare commits
123
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3b89e5a154 | ||
|
|
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 | ||
|
|
404d2f6a1b | ||
|
|
bfcb125d87 | ||
|
|
1164bf008d | ||
|
|
f3353d1686 | ||
|
|
e4c3ec8046 | ||
|
|
82022b9031 | ||
|
|
0307985282 | ||
|
|
b0d1114684 | ||
|
|
728d5288ec | ||
|
|
eaeedd8d74 | ||
|
|
86a6bc63bb | ||
|
|
d557665dc9 | ||
|
|
bd82a85dea | ||
|
|
1f82f50127 | ||
|
|
adf0f7fc36 | ||
|
|
0a9e6c66eb | ||
|
|
da3d5e0ed6 | ||
|
|
f172e019b4 | ||
|
|
e764cfd6f1 | ||
|
|
01b00dfb2e | ||
|
|
1908794569 | ||
|
|
c8bcff39ef | ||
|
|
0fad56294b | ||
|
|
b2b52ddfb5 | ||
|
|
7369a5724c | ||
|
|
942f0ae896 | ||
|
|
92d6dddd49 | ||
|
|
a1bb84ea5b | ||
|
|
1ec94b961f | ||
|
|
ba3f716e5c | ||
|
|
808d137e4c | ||
|
|
1794d4ff9b | ||
|
|
e898a2511a | ||
|
|
dd2cfaa87d | ||
|
|
b114c7b252 | ||
|
|
9920dc93c9 |
+2
-2
@@ -1,4 +1,6 @@
|
||||
# .ansible-lint
|
||||
profile: production
|
||||
|
||||
exclude_paths:
|
||||
- .cache/
|
||||
- .github/
|
||||
@@ -36,7 +38,5 @@ skip_list:
|
||||
- vars_should_not_be_used
|
||||
- file_is_small_enough
|
||||
- file_has_valid_name
|
||||
- name[template]
|
||||
- var-naming[no-role-prefix]
|
||||
|
||||
use_default_rules: true
|
||||
|
||||
@@ -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 * * *'
|
||||
|
||||
jobs:
|
||||
spellcheck:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v7
|
||||
|
||||
- name: Run cspell
|
||||
uses: streetsidesoftware/cspell-action@v9
|
||||
with:
|
||||
incremental_files_only: false
|
||||
use_cspell_files: true
|
||||
|
||||
ci:
|
||||
uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm
|
||||
secrets: inherit
|
||||
@@ -22,4 +34,4 @@ jobs:
|
||||
root_permission_varname: 'keycloak_install_requires_become'
|
||||
debug_verbosity: "${{ github.event.inputs.debug_verbosity }}"
|
||||
molecule_tests: >-
|
||||
[ "debian", "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:
|
||||
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
|
||||
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
|
||||
|
||||
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)}} }'
|
||||
push_token: ${{ secrets.TRIGGERING_PAT }}
|
||||
|
||||
@@ -8,7 +8,7 @@ jobs:
|
||||
traffic:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
ref: "gh-pages"
|
||||
|
||||
@@ -18,7 +18,7 @@ jobs:
|
||||
TRAFFIC_ACTION_TOKEN: ${{ secrets.TRIGGERING_PAT }}
|
||||
|
||||
- name: Commit changes
|
||||
uses: EndBug/add-and-commit@v4
|
||||
uses: EndBug/add-and-commit@v11
|
||||
with:
|
||||
author_name: Ansible Middleware
|
||||
message: "GitHub traffic"
|
||||
|
||||
@@ -11,6 +11,9 @@ docs/_build/
|
||||
.mypy_cache/
|
||||
*.retry
|
||||
changelogs/.plugin-cache.yaml
|
||||
changelogs/fragments/*.yaml
|
||||
changelogs/fragments/*.yml
|
||||
|
||||
*.pem
|
||||
*.key
|
||||
*.p12
|
||||
|
||||
@@ -6,6 +6,85 @@ middleware\_automation.keycloak Release Notes
|
||||
|
||||
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
|
||||
=======
|
||||
|
||||
Major Changes
|
||||
-------------
|
||||
|
||||
- Fixing linting issues `#357 <https://github.com/ansible-middleware/keycloak/pull/357>`_
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- AMW-571 keycloak_identity_provider hide_on_login_page not working `#356 <https://github.com/ansible-middleware/keycloak/pull/356>`_
|
||||
- Fixing vars naming issue `#359 <https://github.com/ansible-middleware/keycloak/pull/359>`_
|
||||
- Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors `#358 <https://github.com/ansible-middleware/keycloak/pull/358>`_
|
||||
|
||||
v3.0.9
|
||||
======
|
||||
|
||||
Bugfixes
|
||||
--------
|
||||
|
||||
- AMW-551 Providing correct rhbk version `#344 <https://github.com/ansible-middleware/keycloak/pull/344>`_
|
||||
|
||||
v3.0.8
|
||||
======
|
||||
|
||||
v3.0.7
|
||||
======
|
||||
|
||||
|
||||
+1
-1
@@ -10,7 +10,7 @@ Clone the repository, checkout the tag you want to build, or pick the main branc
|
||||
|
||||
### Development environment
|
||||
|
||||
Make sure your development machine has avilable:
|
||||
Make sure your development machine has available:
|
||||
|
||||
* python 3.11+
|
||||
* virtualenv
|
||||
|
||||
@@ -49,9 +49,9 @@ A requirement file is provided to install:
|
||||
<!--start roles_paths -->
|
||||
### Included roles
|
||||
|
||||
* `keycloak_quarkus`: role for installing keycloak (>= 19.0.0, quarkus based).
|
||||
* `keycloak_realm`: role for configuring a realm, user federation(s), clients and users, in an installed service.
|
||||
* `keycloak`: role for installing legacy keycloak (<= 19.0, wildfly based).
|
||||
* [`keycloak_quarkus`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_quarkus/README.md): role for installing keycloak (>= 19.0.0, quarkus based).
|
||||
* [`keycloak_realm`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_realm/README.md): role for configuring a realm, user federation(s), clients and users, in an installed service.
|
||||
* [`keycloak`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md): role for installing legacy keycloak (<= 19.0, wildfly based).
|
||||
|
||||
<!--end roles_paths -->
|
||||
|
||||
@@ -71,7 +71,7 @@ All Keycloak administration modules from `community.general` are provided in thi
|
||||
* `keycloak_client_rolemapping`: manage client role mappings for users and groups.
|
||||
* `keycloak_client_rolescope`: manage client role scope mappings.
|
||||
* `keycloak_client_scope`: manage client scopes and protocol mappers (replaces `community.general.keycloak_clientscope`).
|
||||
* `keycloak_clientscope_type`: manage default and optional client scope assignments.
|
||||
* `keycloak_client_scope_type`: manage default and optional client scope assignments.
|
||||
* `keycloak_clientsecret_info`: retrieve client secret information.
|
||||
* `keycloak_clientsecret_regenerate`: regenerate a client secret.
|
||||
* `keycloak_clienttemplate`: manage legacy client templates.
|
||||
@@ -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_localization`: manage realm localization texts.
|
||||
* `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_user`: manage users (create/update/delete).
|
||||
* `keycloak_user_execute_actions_email`: trigger execute-actions emails for users.
|
||||
@@ -155,11 +156,11 @@ Note: when deploying clustered configurations, all hosts belonging to the cluste
|
||||
Execute the following command from the source root directory:
|
||||
|
||||
```bash
|
||||
ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_admin_password=<changeme> -e keycloak_realm=test
|
||||
ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_realm_admin_password=<changeme> -e keycloak_realm_realm=test
|
||||
```
|
||||
|
||||
- `keycloak_admin_password` password for the administration console user account.
|
||||
- `keycloak_realm` name of the realm to be created/used.
|
||||
- `keycloak_realm_admin_password` password for the administration console user account.
|
||||
- `keycloak_realm_realm` name of the realm to be created/used.
|
||||
- `ansible_hosts` is the inventory, below is an example inventory for deploying to localhost
|
||||
|
||||
```
|
||||
@@ -220,5 +221,5 @@ For details on changes between versions, please see the [CHANGELOG](https://gith
|
||||
|
||||
Apache License v2.0 or later
|
||||
<!--start license -->
|
||||
See [LICENSE](LICENSE) to view the full text.
|
||||
See [LICENSE](https://github.com/ansible-middleware/keycloak/blob/main/LICENSE) to view the full text.
|
||||
<!--end license -->
|
||||
|
||||
@@ -6,4 +6,5 @@ python3-netaddr [platform:rpm platform:dpkg]
|
||||
python3-lxml [platform:rpm platform:dpkg]
|
||||
python3-jmespath [platform:rpm platform:dpkg]
|
||||
python3-requests [platform:rpm platform:dpkg]
|
||||
podman [platform:rpm platform:dpkg]
|
||||
|
||||
|
||||
@@ -674,6 +674,61 @@ releases:
|
||||
- 276.yaml
|
||||
- 277.yaml
|
||||
release_date: '2025-05-02'
|
||||
3.0.10:
|
||||
changes:
|
||||
major_changes:
|
||||
- 'Fixing linting issues `#357 <https://github.com/ansible-middleware/keycloak/pull/357>`_
|
||||
|
||||
'
|
||||
minor_changes:
|
||||
- 'AMW-571 keycloak_identity_provider hide_on_login_page not working `#356 <https://github.com/ansible-middleware/keycloak/pull/356>`_
|
||||
|
||||
'
|
||||
- 'Fixing vars naming issue `#359 <https://github.com/ansible-middleware/keycloak/pull/359>`_
|
||||
|
||||
'
|
||||
- 'Removing from __future__ import annotations broke runtime type hints using
|
||||
Sequence and union syntax, causing sanity import failures and molecule module
|
||||
errors `#358 <https://github.com/ansible-middleware/keycloak/pull/358>`_
|
||||
|
||||
'
|
||||
fragments:
|
||||
- 356.yaml
|
||||
- 357.yaml
|
||||
- 358.yaml
|
||||
- 359.yaml
|
||||
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:
|
||||
changes:
|
||||
bugfixes:
|
||||
@@ -825,3 +880,103 @@ releases:
|
||||
- 341.yaml
|
||||
- 343.yaml
|
||||
release_date: '2026-06-01'
|
||||
3.0.8:
|
||||
release_date: '2026-06-09'
|
||||
3.0.9:
|
||||
changes:
|
||||
bugfixes:
|
||||
- 'AMW-551 Providing correct rhbk version `#344 <https://github.com/ansible-middleware/keycloak/pull/344>`_
|
||||
|
||||
'
|
||||
fragments:
|
||||
- 344.yaml
|
||||
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"
|
||||
]
|
||||
}
|
||||
@@ -44,7 +44,6 @@ extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx_antsibull_ext',
|
||||
'ansible_basic_sphinx_ext',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
# ansible_basic_sphinx_ext still imports pkg_resources (removed in setuptools 82+).
|
||||
setuptools>=70.0.0,<81.0.0
|
||||
antsibull>=0.17.0
|
||||
antsibull-docs
|
||||
antsibull-changelog
|
||||
ansible-core>=2.16.0
|
||||
ansible-pygments
|
||||
sphinx-rtd-theme
|
||||
git+https://github.com/felixfontein/ansible-basic-sphinx-ext
|
||||
myst-parser
|
||||
|
||||
+2
-1
@@ -1,11 +1,12 @@
|
||||
---
|
||||
namespace: middleware_automation
|
||||
name: keycloak
|
||||
version: "3.0.8"
|
||||
version: "3.1.2"
|
||||
readme: README.md
|
||||
authors:
|
||||
- Romain Pelisse <rpelisse@redhat.com>
|
||||
- Guido Grazioli <ggraziol@redhat.com>
|
||||
- Ranabir Chakraborty <ranabir@ibm.com>
|
||||
- Pavan Kumar Motaparthi <pmotapar@redhat.com>
|
||||
- Helmut Wolf <hwo@world-direct.at>
|
||||
- Harsha Cherukuri <hcheruku@redhat.com>
|
||||
|
||||
@@ -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
|
||||
|
||||
+21
-2
@@ -14,8 +14,8 @@ action_groups:
|
||||
- keycloak_client_rolemapping
|
||||
- keycloak_client_rolescope
|
||||
- keycloak_client_scope
|
||||
- keycloak_clientscope_type
|
||||
- keycloak_clientscope_rolemappings
|
||||
- keycloak_client_scope_type
|
||||
- keycloak_client_scope_rolemappings
|
||||
- keycloak_clientsecret_info
|
||||
- keycloak_clientsecret_regenerate
|
||||
- keycloak_clienttemplate
|
||||
@@ -23,12 +23,15 @@ action_groups:
|
||||
- keycloak_component_info
|
||||
- keycloak_group
|
||||
- keycloak_identity_provider
|
||||
- keycloak_organization
|
||||
- keycloak_organization_info
|
||||
- keycloak_realm
|
||||
- keycloak_realm_info
|
||||
- keycloak_realm_key
|
||||
- keycloak_realm_keys_metadata_info
|
||||
- keycloak_realm_localization
|
||||
- keycloak_realm_rolemapping
|
||||
- keycloak_realm_users_info
|
||||
- keycloak_role
|
||||
- keycloak_user
|
||||
- keycloak_user_federation
|
||||
@@ -44,3 +47,19 @@ plugin_routing:
|
||||
warning_text: >-
|
||||
The module has been renamed to keycloak_client_scope for Keycloak 17+ (Quarkus).
|
||||
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope.
|
||||
|
||||
keycloak_clientscope_type:
|
||||
redirect: middleware_automation.keycloak.keycloak_client_scope_type
|
||||
deprecation:
|
||||
removal_version: 5.0.0
|
||||
warning_text: >-
|
||||
The module has been renamed to keycloak_client_scope_type for Keycloak 17+ (Quarkus).
|
||||
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope_type.
|
||||
|
||||
keycloak_clientscope_rolemappings:
|
||||
redirect: middleware_automation.keycloak.keycloak_client_scope_rolemappings
|
||||
deprecation:
|
||||
removal_version: 5.0.0
|
||||
warning_text: >-
|
||||
The module has been renamed to keycloak_client_scope_rolemappings for Keycloak 17+ (Quarkus).
|
||||
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope_rolemappings.
|
||||
|
||||
@@ -14,32 +14,32 @@
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
- role: keycloak_realm
|
||||
keycloak_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_client_users:
|
||||
keycloak_realm_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_realm_client_users:
|
||||
- username: TestUser
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- username: TestAdmin
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- client: TestClient
|
||||
role: TestRoleAdmin
|
||||
realm: "{{ keycloak_realm }}"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_clients:
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient
|
||||
realm: "{{ keycloak_realm }}"
|
||||
public_client: "{{ keycloak_client_public }}"
|
||||
web_origins: "{{ keycloak_client_web_origins }}"
|
||||
users: "{{ keycloak_client_users }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: "{{ keycloak_realm_client_public }}"
|
||||
web_origins: "{{ keycloak_realm_client_web_origins }}"
|
||||
users: "{{ keycloak_realm_client_users }}"
|
||||
client_id: TestClient
|
||||
attributes:
|
||||
post.logout.redirect.uris: '/public/logout'
|
||||
|
||||
@@ -6,7 +6,7 @@ platforms:
|
||||
image: ghcr.io/hspaans/molecule-containers:debian-13
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
|
||||
@@ -19,30 +19,30 @@
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
- role: keycloak_realm
|
||||
keycloak_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_client_users:
|
||||
keycloak_realm_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_realm_client_users:
|
||||
- username: TestUser
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- username: TestAdmin
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- client: TestClient
|
||||
role: TestRoleAdmin
|
||||
realm: "{{ keycloak_realm }}"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_clients:
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient
|
||||
realm: "{{ keycloak_realm }}"
|
||||
public_client: "{{ keycloak_client_public }}"
|
||||
web_origins: "{{ keycloak_client_web_origins }}"
|
||||
users: "{{ keycloak_client_users }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: "{{ keycloak_realm_client_public }}"
|
||||
web_origins: "{{ keycloak_realm_client_web_origins }}"
|
||||
users: "{{ keycloak_realm_client_users }}"
|
||||
client_id: TestClient
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
driver:
|
||||
name: podman
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
|
||||
@@ -20,8 +20,51 @@
|
||||
|
||||
- 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.4.7/keycloak-26.4.7.zip
|
||||
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
|
||||
|
||||
- name: Attempt RHBK download using redhat.runtimes_common collection
|
||||
when:
|
||||
- rhn_username is defined
|
||||
- rhn_username | length > 0
|
||||
block:
|
||||
- name: Retrieve RHBK product download using Unified Downloads API
|
||||
middleware_automation.common.product_search:
|
||||
client_id: "{{ rhn_username }}"
|
||||
client_secret: "{{ rhn_password }}"
|
||||
product_type: DISTRIBUTION
|
||||
product_version: "{{ keycloak_quarkus_version | default('26.7.3') }}"
|
||||
product_category: "RHBK"
|
||||
register: rhn_products
|
||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
ignore_errors: true
|
||||
|
||||
- name: Determine install zipfile from search results
|
||||
ansible.builtin.set_fact:
|
||||
rhn_matched_products: "{{ rhn_products.results | selectattr('file_name', 'match', '.*keycloak-' + (keycloak_quarkus_version | default('26.7.3')) + '.zip$') }}"
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
when:
|
||||
- rhn_products is defined
|
||||
- rhn_products.results is defined
|
||||
|
||||
- name: Download Red Hat Build of Keycloak
|
||||
middleware_automation.common.product_download:
|
||||
client_id: "{{ rhn_username }}"
|
||||
client_secret: "{{ rhn_password }}"
|
||||
product_id: "{{ (rhn_matched_products | first).id }}"
|
||||
dest: "/tmp/keycloak/keycloak-{{ keycloak_quarkus_version | default('26.7.3') }}.zip"
|
||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
when:
|
||||
- rhn_matched_products is defined
|
||||
- rhn_matched_products | length > 0
|
||||
ignore_errors: 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_systemd_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_bootstrap_admin_password: "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_http_enabled: True
|
||||
keycloak_quarkus_http_port: 8080
|
||||
keycloak_quarkus_proxy_mode: edge
|
||||
keycloak_quarkus_http_relative_path: /
|
||||
keycloak_quarkus_health_check_url: http://proxy:8080/realms/master/.well-known/openid-configuration
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
|
||||
@@ -9,7 +9,7 @@ platforms:
|
||||
command: "/usr/sbin/init"
|
||||
networks:
|
||||
- name: keycloak
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
published_ports:
|
||||
- 0.0.0.0:8080:8080/tcp
|
||||
@@ -20,7 +20,7 @@ platforms:
|
||||
command: "/usr/sbin/init"
|
||||
networks:
|
||||
- name: keycloak
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "443/tcp"
|
||||
published_ports:
|
||||
- 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
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
driver:
|
||||
name: podman
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
|
||||
@@ -12,6 +12,7 @@
|
||||
client: molecule-client
|
||||
scope: molecule-scope
|
||||
group: molecule-group
|
||||
subgroup: molecule-subgroup
|
||||
user: molecule-user
|
||||
flow: molecule-flow
|
||||
flow_v2: molecule-flow-v2
|
||||
@@ -37,8 +38,8 @@
|
||||
- keycloak_client_rolemapping
|
||||
- keycloak_client_rolescope
|
||||
- keycloak_client_scope
|
||||
- keycloak_clientscope_type
|
||||
- keycloak_clientscope_rolemappings
|
||||
- keycloak_client_scope_type
|
||||
- keycloak_client_scope_rolemappings
|
||||
- keycloak_clientsecret_info
|
||||
- keycloak_clientsecret_regenerate
|
||||
- keycloak_clienttemplate
|
||||
@@ -46,12 +47,15 @@
|
||||
- keycloak_component_info
|
||||
- keycloak_group
|
||||
- keycloak_identity_provider
|
||||
- keycloak_organization
|
||||
- keycloak_organization_info
|
||||
- keycloak_realm
|
||||
- keycloak_realm_info
|
||||
- keycloak_realm_key
|
||||
- keycloak_realm_keys_metadata_info
|
||||
- keycloak_realm_localization
|
||||
- keycloak_realm_rolemapping
|
||||
- keycloak_realm_users_info
|
||||
- keycloak_role
|
||||
- keycloak_user
|
||||
- keycloak_user_execute_actions_email
|
||||
@@ -90,6 +94,7 @@
|
||||
auth_realm: "{{ auth_realm }}"
|
||||
auth_username: "{{ auth_username }}"
|
||||
auth_password: "{{ auth_password }}"
|
||||
validate_certs: false
|
||||
block:
|
||||
- name: Reset fixtures from a previous verify run
|
||||
middleware_automation.keycloak.keycloak_user:
|
||||
@@ -154,6 +159,35 @@
|
||||
enabled: true
|
||||
state: present
|
||||
|
||||
- name: keycloak_role — create realm role for restricted admin test
|
||||
middleware_automation.keycloak.keycloak_role:
|
||||
realm: "{{ target_realm }}"
|
||||
name: "{{ role }}-restricted"
|
||||
state: present
|
||||
|
||||
- name: keycloak_user — create restricted admin in master (manage-users only, no view-realm)
|
||||
middleware_automation.keycloak.keycloak_user:
|
||||
realm: master
|
||||
username: molecule-restricted-admin
|
||||
first_name: Restricted
|
||||
last_name: Admin
|
||||
enabled: true
|
||||
credentials:
|
||||
- type: password
|
||||
value: restricted-admin-password
|
||||
temporary: false
|
||||
state: present
|
||||
|
||||
- name: keycloak_user_rolemapping — grant manage-users for TestRealm to restricted admin
|
||||
middleware_automation.keycloak.keycloak_user_rolemapping:
|
||||
realm: master
|
||||
target_username: molecule-restricted-admin
|
||||
client_id: "{{ target_realm }}-realm"
|
||||
state: present
|
||||
roles:
|
||||
- name: manage-users
|
||||
- name: view-users
|
||||
|
||||
- name: keycloak_authentication_flow — create browser-style flow
|
||||
middleware_automation.keycloak.keycloak_authentication_flow:
|
||||
realm: "{{ target_realm }}"
|
||||
@@ -168,6 +202,7 @@
|
||||
middleware_automation.keycloak.keycloak_realm_info:
|
||||
auth_keycloak_url: "{{ auth_keycloak_url }}"
|
||||
realm: "{{ target_realm }}"
|
||||
validate_certs: false
|
||||
|
||||
- name: Exercise migrated modules against running Keycloak
|
||||
module_defaults:
|
||||
@@ -176,6 +211,7 @@
|
||||
auth_realm: "{{ auth_realm }}"
|
||||
auth_username: "{{ auth_username }}"
|
||||
auth_password: "{{ auth_password }}"
|
||||
validate_certs: false
|
||||
block:
|
||||
- name: keycloak_realm_keys_metadata_info — query realm keys
|
||||
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
|
||||
@@ -185,6 +221,18 @@
|
||||
middleware_automation.keycloak.keycloak_component_info:
|
||||
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
|
||||
middleware_automation.keycloak.keycloak_realm:
|
||||
id: "{{ ephemeral_realm }}"
|
||||
@@ -192,6 +240,213 @@
|
||||
enabled: true
|
||||
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
|
||||
middleware_automation.keycloak.keycloak_realm_localization:
|
||||
parent_id: "{{ target_realm }}"
|
||||
@@ -216,14 +471,8 @@
|
||||
state: present
|
||||
|
||||
- name: keycloak_authentication_v2 — manage flow with safe-swap semantics
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ flow_v2 }}"
|
||||
description: Molecule module test flow v2
|
||||
authenticationExecutions:
|
||||
- requirement: REQUIRED
|
||||
providerId: auth-cookie
|
||||
state: present
|
||||
ansible.builtin.include_tasks:
|
||||
file: keycloak_authentication_v2/verify.yml
|
||||
|
||||
- name: keycloak_authentication_required_actions — ensure VERIFY_EMAIL is enabled
|
||||
middleware_automation.keycloak.keycloak_authentication_required_actions:
|
||||
@@ -253,6 +502,50 @@
|
||||
clientId: molecule-idp-client
|
||||
state: present
|
||||
|
||||
- name: keycloak_identity_provider — set hide_on_login via top-level param
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ idp }}"
|
||||
hide_on_login: true
|
||||
state: present
|
||||
register: idp_hide_on_login_result
|
||||
|
||||
- name: Assert hide_on_login is set correctly in end_state
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- idp_hide_on_login_result is changed
|
||||
- idp_hide_on_login_result.end_state.hideOnLogin == true
|
||||
- "'hide_on_login' not in (idp_hide_on_login_result.end_state.config | default({}))"
|
||||
|
||||
- name: keycloak_identity_provider — set hide_on_login idempotency check
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ idp }}"
|
||||
hide_on_login: true
|
||||
state: present
|
||||
register: idp_hide_on_login_idempotent_result
|
||||
|
||||
- name: Assert hide_on_login idempotency (no change)
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- idp_hide_on_login_idempotent_result is not changed
|
||||
- idp_hide_on_login_idempotent_result.end_state.hideOnLogin == true
|
||||
|
||||
- name: keycloak_identity_provider — set hide_on_login via legacy config key (backward compat)
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ idp }}"
|
||||
hide_on_login: false
|
||||
state: present
|
||||
register: idp_hide_on_login_off_result
|
||||
|
||||
- name: Assert hide_on_login can be toggled off via top-level param
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- idp_hide_on_login_off_result is changed
|
||||
- idp_hide_on_login_off_result.end_state.hideOnLogin == false
|
||||
- "'hide_on_login_page' not in (idp_hide_on_login_off_result.end_state.config | default({}))"
|
||||
|
||||
- name: keycloak_clienttemplate — create client template
|
||||
middleware_automation.keycloak.keycloak_clienttemplate:
|
||||
realm: "{{ target_realm }}"
|
||||
@@ -265,10 +558,10 @@
|
||||
- "'404' not in (clienttemplate_result.msg | default(''))"
|
||||
- "'Not Found' not in (clienttemplate_result.msg | default(''))"
|
||||
|
||||
- name: keycloak_clientscope_type — attach scope as optional on realm
|
||||
middleware_automation.keycloak.keycloak_clientscope_type:
|
||||
- name: keycloak_client_scope_type — attach scope as optional on realm
|
||||
middleware_automation.keycloak.keycloak_client_scope_type:
|
||||
realm: "{{ target_realm }}"
|
||||
optional_clientscopes:
|
||||
optional_client_scopes:
|
||||
- "{{ scope }}"
|
||||
|
||||
- name: keycloak_user_rolemapping — assign realm role to user
|
||||
@@ -279,6 +572,44 @@
|
||||
roles:
|
||||
- name: "{{ role }}"
|
||||
|
||||
- name: keycloak_user_rolemapping — assign realm role using restricted admin (no view-realm)
|
||||
middleware_automation.keycloak.keycloak_user_rolemapping:
|
||||
auth_keycloak_url: "{{ auth_keycloak_url }}"
|
||||
auth_realm: master
|
||||
auth_username: molecule-restricted-admin
|
||||
auth_password: restricted-admin-password
|
||||
validate_certs: false
|
||||
realm: "{{ target_realm }}"
|
||||
target_username: "{{ user }}"
|
||||
state: present
|
||||
roles:
|
||||
- name: "{{ role }}-restricted"
|
||||
register: restricted_admin_rolemapping_result
|
||||
|
||||
- name: Assert restricted admin can assign realm role without view-realm
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- restricted_admin_rolemapping_result is changed
|
||||
|
||||
- name: keycloak_user_rolemapping — idempotency check with restricted admin
|
||||
middleware_automation.keycloak.keycloak_user_rolemapping:
|
||||
auth_keycloak_url: "{{ auth_keycloak_url }}"
|
||||
auth_realm: master
|
||||
auth_username: molecule-restricted-admin
|
||||
auth_password: restricted-admin-password
|
||||
validate_certs: false
|
||||
realm: "{{ target_realm }}"
|
||||
target_username: "{{ user }}"
|
||||
state: present
|
||||
roles:
|
||||
- name: "{{ role }}-restricted"
|
||||
register: restricted_admin_rolemapping_idempotent_result
|
||||
|
||||
- name: Assert restricted admin rolemapping is idempotent
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- restricted_admin_rolemapping_idempotent_result is not changed
|
||||
|
||||
- name: keycloak_realm_rolemapping — assign realm role to group
|
||||
middleware_automation.keycloak.keycloak_realm_rolemapping:
|
||||
realm: "{{ target_realm }}"
|
||||
@@ -296,57 +627,112 @@
|
||||
roles:
|
||||
- name: "{{ client_role }}"
|
||||
|
||||
- name: keycloak_group — create subgroup below the parent group
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
realm: "{{ target_realm }}"
|
||||
name: "{{ subgroup }}"
|
||||
parents:
|
||||
- name: "{{ group }}"
|
||||
state: present
|
||||
register: subgroup_result
|
||||
|
||||
- name: Assert subgroup was created below the parent group
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- subgroup_result is changed
|
||||
- subgroup_result.end_state.path == '/' ~ group ~ '/' ~ subgroup
|
||||
|
||||
- name: keycloak_group — create enough siblings to exceed the children page size
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
realm: "{{ target_realm }}"
|
||||
name: "{{ subgroup }}-{{ item }}"
|
||||
parents:
|
||||
- name: "{{ group }}"
|
||||
state: present
|
||||
loop: "{{ range(1, 13) | list }}"
|
||||
|
||||
- name: keycloak_group — look up a subgroup sorting past the children page size
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
realm: "{{ target_realm }}"
|
||||
name: "{{ subgroup }}-9"
|
||||
parents:
|
||||
- name: "{{ group }}"
|
||||
state: present
|
||||
register: subgroup_paging_result
|
||||
|
||||
- name: Assert subgroup lookup is not limited to the first page of children
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- subgroup_paging_result is not changed
|
||||
- subgroup_paging_result.end_state.path == '/' ~ group ~ '/' ~ subgroup ~ '-9'
|
||||
|
||||
- name: keycloak_realm_rolemapping — assign realm role to subgroup via parents
|
||||
middleware_automation.keycloak.keycloak_realm_rolemapping:
|
||||
realm: "{{ target_realm }}"
|
||||
group_name: "{{ subgroup }}"
|
||||
parents:
|
||||
- name: "{{ group }}"
|
||||
state: present
|
||||
roles:
|
||||
- name: "{{ role }}"
|
||||
register: subgroup_rolemapping_result
|
||||
|
||||
- name: Assert realm role was mapped to the subgroup
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- subgroup_rolemapping_result is changed
|
||||
|
||||
- name: keycloak_client_rolescope — restrict realm role on client
|
||||
middleware_automation.keycloak.keycloak_client_rolescope:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "{{ client }}"
|
||||
target_client_id: "{{ client }}"
|
||||
role_names:
|
||||
- "{{ role }}"
|
||||
state: present
|
||||
|
||||
- name: keycloak_clientscope_rolemappings — map client roles to clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: keycloak_client_scope_rolemappings — map client roles to client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "{{ client }}"
|
||||
clientscope_id: "{{ scope }}"
|
||||
client_scope_id: "{{ scope }}"
|
||||
role_names:
|
||||
- "{{ client_role }}"
|
||||
register: clientscope_rolemappings_result
|
||||
register: client_scope_rolemappings_result
|
||||
|
||||
- name: Assert clientscope role mappings were created
|
||||
- name: Assert client scope role mappings were created
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- clientscope_rolemappings_result is changed
|
||||
- clientscope_rolemappings_result.end_state | length == 1
|
||||
- client_scope_rolemappings_result is changed
|
||||
- client_scope_rolemappings_result.end_state | length == 1
|
||||
|
||||
- name: keycloak_clientscope_rolemappings — remap client role (idempotency)
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: keycloak_client_scope_rolemappings — remap client role (idempotency)
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "{{ client }}"
|
||||
clientscope_id: "{{ scope }}"
|
||||
client_scope_id: "{{ scope }}"
|
||||
role_names:
|
||||
- "{{ client_role }}"
|
||||
register: clientscope_rolemappings_idempotent_result
|
||||
register: client_scope_rolemappings_idempotent_result
|
||||
|
||||
- name: Assert clientscope role mappings are idempotent
|
||||
- name: Assert client scope role mappings are idempotent
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- clientscope_rolemappings_idempotent_result is not changed
|
||||
- clientscope_rolemappings_idempotent_result.end_state | length == 1
|
||||
- client_scope_rolemappings_idempotent_result is not changed
|
||||
- client_scope_rolemappings_idempotent_result.end_state | length == 1
|
||||
|
||||
- name: keycloak_clientscope_rolemappings — map realm role to clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: keycloak_client_scope_rolemappings — map realm role to client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
realm: "{{ target_realm }}"
|
||||
clientscope_id: "{{ scope }}"
|
||||
client_scope_id: "{{ scope }}"
|
||||
role_names:
|
||||
- "{{ role }}"
|
||||
register: clientscope_realm_rolemappings_result
|
||||
register: client_scope_realm_rolemappings_result
|
||||
|
||||
- name: Assert realm role was mapped to clientscope
|
||||
- name: Assert realm role was mapped to client_scope
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- clientscope_realm_rolemappings_result is changed
|
||||
- clientscope_realm_rolemappings_result.end_state | length == 1
|
||||
- client_scope_realm_rolemappings_result is changed
|
||||
- client_scope_realm_rolemappings_result.end_state | length == 1
|
||||
|
||||
- name: keycloak_user — set email_verified explicitly
|
||||
middleware_automation.keycloak.keycloak_user:
|
||||
@@ -492,6 +878,7 @@
|
||||
auth_realm: "{{ auth_realm }}"
|
||||
auth_username: "{{ auth_username }}"
|
||||
auth_password: "{{ auth_password }}"
|
||||
validate_certs: false
|
||||
block:
|
||||
- name: keycloak_authz_custom_policy — remove custom policy if created
|
||||
middleware_automation.keycloak.keycloak_authz_custom_policy:
|
||||
@@ -517,19 +904,19 @@
|
||||
name: "{{ authz_scope }}"
|
||||
state: absent
|
||||
|
||||
- name: keycloak_clientscope_rolemappings — remove realm role from clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: keycloak_client_scope_rolemappings — remove realm role from client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
realm: "{{ target_realm }}"
|
||||
clientscope_id: "{{ scope }}"
|
||||
client_scope_id: "{{ scope }}"
|
||||
role_names:
|
||||
- "{{ role }}"
|
||||
state: absent
|
||||
|
||||
- name: keycloak_clientscope_rolemappings — remove client role from clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: keycloak_client_scope_rolemappings — remove client role from client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "{{ client }}"
|
||||
clientscope_id: "{{ scope }}"
|
||||
client_scope_id: "{{ scope }}"
|
||||
role_names:
|
||||
- "{{ client_role }}"
|
||||
state: absent
|
||||
@@ -537,7 +924,7 @@
|
||||
- name: keycloak_client_rolescope — remove role scope mapping
|
||||
middleware_automation.keycloak.keycloak_client_rolescope:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "{{ client }}"
|
||||
target_client_id: "{{ client }}"
|
||||
role_names:
|
||||
- "{{ role }}"
|
||||
state: absent
|
||||
@@ -567,18 +954,32 @@
|
||||
roles:
|
||||
- name: "{{ role }}"
|
||||
|
||||
- name: keycloak_user_rolemapping — remove restricted admin role mapping from user
|
||||
middleware_automation.keycloak.keycloak_user_rolemapping:
|
||||
realm: "{{ target_realm }}"
|
||||
target_username: "{{ user }}"
|
||||
state: absent
|
||||
roles:
|
||||
- name: "{{ role }}-restricted"
|
||||
|
||||
- name: keycloak_user — remove restricted admin user from master
|
||||
middleware_automation.keycloak.keycloak_user:
|
||||
realm: master
|
||||
username: molecule-restricted-admin
|
||||
state: absent
|
||||
|
||||
- name: keycloak_role — remove restricted admin test role
|
||||
middleware_automation.keycloak.keycloak_role:
|
||||
realm: "{{ target_realm }}"
|
||||
name: "{{ role }}-restricted"
|
||||
state: absent
|
||||
|
||||
- name: keycloak_identity_provider — remove OIDC provider
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ idp }}"
|
||||
state: absent
|
||||
|
||||
- name: keycloak_authentication_v2 — remove flow
|
||||
middleware_automation.keycloak.keycloak_authentication_v2:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ flow_v2 }}"
|
||||
state: absent
|
||||
|
||||
- name: keycloak_authentication — remove copied flow
|
||||
middleware_automation.keycloak.keycloak_authentication:
|
||||
realm: "{{ target_realm }}"
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
driver:
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
- "9000/tcp"
|
||||
provisioner:
|
||||
name: ansible
|
||||
config_options:
|
||||
defaults:
|
||||
interpreter_python: auto_silent
|
||||
roles_path: ../../roles
|
||||
ssh_connection:
|
||||
pipelining: false
|
||||
playbooks:
|
||||
prepare: ../default/prepare.yml
|
||||
converge: ../default/converge.yml
|
||||
verify: verify.yml
|
||||
inventory:
|
||||
group_vars:
|
||||
all:
|
||||
keycloak_install_requires_become: true
|
||||
host_vars:
|
||||
localhost:
|
||||
ansible_python_interpreter: "{{ ansible_playbook_python }}"
|
||||
env:
|
||||
ANSIBLE_FORCE_COLOR: "true"
|
||||
PROXY: "${PROXY}"
|
||||
NO_PROXY: "${NO_PROXY}"
|
||||
verifier:
|
||||
name: ansible
|
||||
scenario:
|
||||
test_sequence:
|
||||
- cleanup
|
||||
- destroy
|
||||
- create
|
||||
- prepare
|
||||
- converge
|
||||
- verify
|
||||
- cleanup
|
||||
- destroy
|
||||
Symlink
+1
@@ -0,0 +1 @@
|
||||
../../roles
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
- name: Verify use_netrc option prevents .netrc from overriding bearer token (issue 403)
|
||||
hosts: all
|
||||
vars:
|
||||
auth_keycloak_url: http://instance:8080
|
||||
auth_realm: master
|
||||
auth_username: remembertochangeme
|
||||
auth_password: remembertochangeme
|
||||
target_realm: TestRealm
|
||||
module_defaults:
|
||||
group/middleware_automation.keycloak.keycloak:
|
||||
auth_keycloak_url: "{{ auth_keycloak_url }}"
|
||||
auth_realm: "{{ auth_realm }}"
|
||||
auth_username: "{{ auth_username }}"
|
||||
auth_password: "{{ auth_password }}"
|
||||
validate_certs: false
|
||||
tasks:
|
||||
- name: Populate service facts
|
||||
ansible.builtin.service_facts:
|
||||
|
||||
- name: Check if keycloak service started
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- ansible_facts.services["keycloak.service"]["state"] == "running"
|
||||
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
|
||||
fail_msg: Keycloak service is not running
|
||||
|
||||
- name: Verify netrc handling
|
||||
block:
|
||||
- name: Create .netrc with bogus credentials matching the Keycloak host
|
||||
ansible.builtin.copy:
|
||||
dest: ~/.netrc
|
||||
mode: "0600"
|
||||
content: |
|
||||
machine instance
|
||||
login netrc_user
|
||||
password netrc_password
|
||||
|
||||
- name: API call with default use_netrc (false) ignores .netrc
|
||||
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
|
||||
realm: "{{ target_realm }}"
|
||||
register: netrc_default_result
|
||||
|
||||
- name: Assert API call succeeds with default use_netrc despite .netrc
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- netrc_default_result is not failed
|
||||
|
||||
- name: API call with use_netrc true picks up .netrc credentials
|
||||
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
|
||||
realm: "{{ target_realm }}"
|
||||
use_netrc: true
|
||||
register: netrc_true_result
|
||||
ignore_errors: true
|
||||
|
||||
- name: Assert API call fails when use_netrc is true and .netrc has credentials
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- netrc_true_result is failed
|
||||
always:
|
||||
- name: Remove .netrc test file
|
||||
ansible.builtin.file:
|
||||
path: ~/.netrc
|
||||
state: absent
|
||||
@@ -4,7 +4,9 @@
|
||||
vars_files:
|
||||
- ../group_vars/all/vars.yml
|
||||
vars:
|
||||
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_quarkus_hostname: "http://instance:8080"
|
||||
keycloak_config_override_template: custom.xml.j2
|
||||
keycloak_http_port: 8081
|
||||
keycloak_management_http_port: 19990
|
||||
|
||||
@@ -7,7 +7,7 @@ platforms:
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
|
||||
@@ -36,7 +36,7 @@
|
||||
ansible.builtin.set_fact:
|
||||
assets_server: "{{ lookup('env', 'MIDDLEWARE_DOWNLOAD_RELEASE_SERVER_URL') }}"
|
||||
|
||||
- name: "Download artefacts only if assets_server is set"
|
||||
- name: "Download artifacts only if assets_server is set"
|
||||
when:
|
||||
- assets_server is defined
|
||||
- assets_server | length > 0
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
keycloak_quarkus_show_deprecation_warnings: false
|
||||
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
||||
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_quarkus_hostname: https://instance:8443
|
||||
keycloak_quarkus_log: file
|
||||
keycloak_quarkus_log_level: debug # needed for the verify step
|
||||
@@ -25,7 +25,7 @@
|
||||
keycloak_quarkus_systemd_wait_for_delay: 2
|
||||
keycloak_quarkus_systemd_wait_for_log: true
|
||||
keycloak_quarkus_restart_health_check: false # would fail because of self-signed cert
|
||||
keycloak_quarkus_version: 26.4.7
|
||||
keycloak_quarkus_version: 26.7.3
|
||||
keycloak_quarkus_java_heap_opts: "-Xms1024m -Xmx1024m"
|
||||
keycloak_quarkus_additional_env_vars:
|
||||
- key: KC_FEATURES_DISABLED
|
||||
@@ -39,16 +39,16 @@
|
||||
- key: default-connection-pool-size
|
||||
value: 10
|
||||
- id: spid-saml
|
||||
url: https://github.com/italia/spid-keycloak-provider/releases/download/24.0.2/spid-provider.jar
|
||||
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.7.1/spid-provider.jar
|
||||
- id: spid-saml-w-checksum
|
||||
url: https://github.com/italia/spid-keycloak-provider/releases/download/24.0.2/spid-provider.jar
|
||||
checksum: sha256:fbb50e73739d7a6d35b5bff611b1c01668b29adf6f6259624b95e466a305f377
|
||||
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.7.1/spid-provider.jar
|
||||
checksum: sha256:65c16bc70f36af26dac5ab1506b45120674fdf89106320ce00ff53bf6bf1243e
|
||||
- id: keycloak-kerberos-federation
|
||||
maven:
|
||||
repository_url: https://repo1.maven.org/maven2/ # https://mvnrepository.com/artifact/org.keycloak/keycloak-kerberos-federation/24.0.4
|
||||
group_id: org.keycloak
|
||||
artifact_id: keycloak-kerberos-federation
|
||||
version: 26.4.7 # optional
|
||||
version: 26.7.3 # optional
|
||||
# username: myUser # optional
|
||||
# password: myPAT # optional
|
||||
# - id: my-static-theme
|
||||
@@ -62,34 +62,34 @@
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
- role: keycloak_realm
|
||||
keycloak_url: http://instance:8080
|
||||
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_client_default_roles:
|
||||
keycloak_realm_url: http://instance:8080
|
||||
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_realm_client_default_roles:
|
||||
- TestRoleAdmin
|
||||
- TestRoleUser
|
||||
keycloak_client_users:
|
||||
keycloak_realm_client_users:
|
||||
- username: TestUser
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- username: TestAdmin
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- client: TestClient
|
||||
role: TestRoleAdmin
|
||||
realm: "{{ keycloak_realm }}"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_clients:
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient
|
||||
roles: "{{ keycloak_client_default_roles }}"
|
||||
realm: "{{ keycloak_realm }}"
|
||||
public_client: "{{ keycloak_client_public }}"
|
||||
web_origins: "{{ keycloak_client_web_origins }}"
|
||||
users: "{{ keycloak_client_users }}"
|
||||
roles: "{{ keycloak_realm_client_default_roles }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: "{{ keycloak_realm_client_public }}"
|
||||
web_origins: "{{ keycloak_realm_client_web_origins }}"
|
||||
users: "{{ keycloak_realm_client_users }}"
|
||||
client_id: TestClient
|
||||
|
||||
@@ -7,7 +7,7 @@ platforms:
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
keycloak_quarkus_show_deprecation_warnings: false
|
||||
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
||||
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_quarkus_log: file
|
||||
keycloak_quarkus_hostname: 'http://localhost:8080'
|
||||
keycloak_quarkus_start_dev: True
|
||||
@@ -18,34 +18,34 @@
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
- role: keycloak_realm
|
||||
keycloak_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_client_default_roles:
|
||||
keycloak_realm_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_realm_client_default_roles:
|
||||
- TestRoleAdmin
|
||||
- TestRoleUser
|
||||
keycloak_client_users:
|
||||
keycloak_realm_client_users:
|
||||
- username: TestUser
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- username: TestAdmin
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- client: TestClient
|
||||
role: TestRoleAdmin
|
||||
realm: "{{ keycloak_realm }}"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_clients:
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient
|
||||
roles: "{{ keycloak_client_default_roles }}"
|
||||
realm: "{{ keycloak_realm }}"
|
||||
public_client: "{{ keycloak_client_public }}"
|
||||
web_origins: "{{ keycloak_client_web_origins }}"
|
||||
users: "{{ keycloak_client_users }}"
|
||||
roles: "{{ keycloak_realm_client_default_roles }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: "{{ keycloak_realm_client_public }}"
|
||||
web_origins: "{{ keycloak_realm_client_web_origins }}"
|
||||
users: "{{ keycloak_realm_client_users }}"
|
||||
client_id: TestClient
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
driver:
|
||||
name: podman
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8009/tcp"
|
||||
- "9000/tcp"
|
||||
|
||||
@@ -11,7 +11,7 @@ platforms:
|
||||
- keycloak
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "9000/tcp"
|
||||
@@ -24,7 +24,7 @@ platforms:
|
||||
- keycloak
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "9000/tcp"
|
||||
@@ -37,7 +37,7 @@ platforms:
|
||||
- database
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "5432/tcp"
|
||||
mounts:
|
||||
- type: bind
|
||||
|
||||
@@ -11,7 +11,7 @@ platforms:
|
||||
- keycloak
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "9000/tcp"
|
||||
@@ -24,7 +24,7 @@ platforms:
|
||||
- keycloak
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "9000/tcp"
|
||||
@@ -37,7 +37,7 @@ platforms:
|
||||
- database
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "5432/tcp"
|
||||
mounts:
|
||||
- type: bind
|
||||
|
||||
@@ -11,7 +11,7 @@ platforms:
|
||||
- keycloak
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "9000/tcp"
|
||||
@@ -24,7 +24,7 @@ platforms:
|
||||
- infinispan
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "11222/tcp"
|
||||
- name: postgres
|
||||
image: ubuntu/postgres:14-22.04_beta
|
||||
@@ -35,7 +35,7 @@ platforms:
|
||||
- database
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "5432/tcp"
|
||||
mounts:
|
||||
- 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:
|
||||
- key: KC_FEATURES_DISABLED
|
||||
value: ciba,device-flow,impersonation,kerberos,docker
|
||||
keycloak_quarkus_version: 26.0.7
|
||||
keycloak_quarkus_version: 26.7.3
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
|
||||
@@ -4,15 +4,15 @@ dependency:
|
||||
options:
|
||||
requirements-file: molecule/requirements.yml
|
||||
driver:
|
||||
name: podman
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
command: "/usr/sbin/init"
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
port_bindings:
|
||||
- 8080:8080
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "9000/tcp"
|
||||
published_ports:
|
||||
- 0.0.0.0:8080:8080/TCP
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
- vars.yml
|
||||
vars:
|
||||
sudo_pkg_name: sudo
|
||||
keycloak_quarkus_version: 26.0.4
|
||||
keycloak_quarkus_version: 26.6.2
|
||||
keycloak_quarkus_additional_env_vars:
|
||||
- key: KC_FEATURES_DISABLED
|
||||
value: impersonation,kerberos
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
- name: Converge
|
||||
hosts: all
|
||||
vars_files:
|
||||
- ../group_vars/all/vars.yml
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_enable: true
|
||||
keycloak_offline_install: false
|
||||
roles:
|
||||
- role: keycloak
|
||||
- role: keycloak_realm
|
||||
keycloak_realm_url: "http://instance:8080"
|
||||
keycloak_realm_context: "/auth"
|
||||
keycloak_realm_admin_user: "admin"
|
||||
keycloak_realm_admin_password: "remembertochangeme"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: true
|
||||
client_id: TestClient
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
dependency:
|
||||
name: galaxy
|
||||
driver:
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
command: /usr/sbin/init
|
||||
privileged: true
|
||||
pre_build_image: true
|
||||
provisioner:
|
||||
name: ansible
|
||||
config_options:
|
||||
defaults:
|
||||
interpreter_python: auto_silent
|
||||
callbacks_enabled: profile_tasks, timer
|
||||
callback_result_format: yaml
|
||||
ssh_connection:
|
||||
pipelining: false
|
||||
playbooks:
|
||||
prepare: prepare.yml
|
||||
converge: converge.yml
|
||||
verify: verify.yml
|
||||
env:
|
||||
ANSIBLE_ROLES_PATH: "../../roles"
|
||||
inventory:
|
||||
host_vars:
|
||||
instance:
|
||||
ansible_user: root
|
||||
verifier:
|
||||
name: ansible
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
- 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
|
||||
@@ -0,0 +1,78 @@
|
||||
---
|
||||
- name: Verify
|
||||
hosts: all
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_admin_user: "admin"
|
||||
keycloak_uri: "http://localhost:8080"
|
||||
keycloak_context: "/auth"
|
||||
parent_group: molecule-parent-group
|
||||
child_group: molecule-child-group
|
||||
tasks:
|
||||
- name: Populate service facts
|
||||
ansible.builtin.service_facts:
|
||||
- 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 token api call
|
||||
ansible.builtin.uri:
|
||||
url: "{{ keycloak_uri }}{{ keycloak_context }}/realms/master/protocol/openid-connect/token"
|
||||
method: POST
|
||||
body: "client_id=admin-cli&username={{ keycloak_admin_user }}&password={{ keycloak_admin_password }}&grant_type=password"
|
||||
validate_certs: no
|
||||
register: keycloak_auth_response
|
||||
until: keycloak_auth_response.status == 200
|
||||
retries: 2
|
||||
delay: 2
|
||||
|
||||
# This Keycloak is older than 23, so its group children endpoint accepts no
|
||||
# GET request and the subgroup lookup has to fall back to the subgroups
|
||||
# inlined in the parent group representation.
|
||||
- name: Verify subgroup handling on a pre-23 Keycloak
|
||||
module_defaults:
|
||||
group/middleware_automation.keycloak.keycloak:
|
||||
auth_keycloak_url: "{{ keycloak_uri }}{{ keycloak_context }}"
|
||||
auth_realm: master
|
||||
auth_username: "{{ keycloak_admin_user }}"
|
||||
auth_password: "{{ keycloak_admin_password }}"
|
||||
validate_certs: false
|
||||
realm: master
|
||||
block:
|
||||
- name: keycloak_group — create parent group
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
name: "{{ parent_group }}"
|
||||
state: present
|
||||
|
||||
- name: keycloak_group — create subgroup below the parent group
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
name: "{{ child_group }}"
|
||||
parents:
|
||||
- name: "{{ parent_group }}"
|
||||
state: present
|
||||
register: subgroup_result
|
||||
|
||||
- name: Assert subgroup was created below the parent group
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- subgroup_result is changed
|
||||
- subgroup_result.end_state.path == '/' ~ parent_group ~ '/' ~ child_group
|
||||
|
||||
- name: keycloak_group — look the subgroup up through parents again
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
name: "{{ child_group }}"
|
||||
parents:
|
||||
- name: "{{ parent_group }}"
|
||||
state: present
|
||||
register: subgroup_lookup_result
|
||||
|
||||
- name: Assert the existing subgroup was found instead of re-created
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- subgroup_lookup_result is not changed
|
||||
always:
|
||||
- name: keycloak_group — remove parent group and its subtree
|
||||
middleware_automation.keycloak.keycloak_group:
|
||||
name: "{{ parent_group }}"
|
||||
state: absent
|
||||
@@ -6,9 +6,9 @@
|
||||
ansible.builtin.include_role:
|
||||
name: keycloak_realm
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_user_federation:
|
||||
keycloak_realm_admin_password: "remembertochangeme"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_user_federation:
|
||||
- realm: TestRealm
|
||||
name: my-ldap
|
||||
provider_id: ldap
|
||||
@@ -48,13 +48,13 @@
|
||||
ldap.full.name.attribute: cn
|
||||
read.only: true
|
||||
write.only: false
|
||||
keycloak_clients:
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient1
|
||||
client_id: TestClient1
|
||||
roles:
|
||||
- TestClient1Admin
|
||||
- TestClient1User
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: true
|
||||
web_origins:
|
||||
- http://testclient1origin/application
|
||||
@@ -65,4 +65,4 @@
|
||||
client_roles:
|
||||
- client: TestClient1
|
||||
role: TestClient1User
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
- name: Playbook for Keycloak Hosts
|
||||
hosts: all
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_clients:
|
||||
keycloak_realm_admin_password: "remembertochangeme"
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient1
|
||||
client_id: TestClient1
|
||||
roles:
|
||||
@@ -23,4 +23,4 @@
|
||||
realm: TestRealm
|
||||
roles:
|
||||
- role: middleware_automation.keycloak.keycloak_realm
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_realm_realm: TestRealm
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
ansible.builtin.include_role:
|
||||
name: middleware_automation.keycloak.keycloak_realm
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_client_default_roles:
|
||||
keycloak_realm_admin_password: "remembertochangeme"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_client_default_roles:
|
||||
- TestRoleAdmin
|
||||
- TestRoleUser
|
||||
keycloak_client_users:
|
||||
keycloak_realm_client_users:
|
||||
- username: TestUser
|
||||
password: password
|
||||
client_roles:
|
||||
@@ -27,13 +27,13 @@
|
||||
- client: TestClient1
|
||||
role: TestRoleAdmin
|
||||
realm: TestRealm
|
||||
keycloak_clients:
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient1
|
||||
client_id: TestClient1
|
||||
roles: "{{ keycloak_client_default_roles }}"
|
||||
roles: "{{ keycloak_realm_client_default_roles }}"
|
||||
realm: TestRealm
|
||||
public_client: true
|
||||
web_origins:
|
||||
- http://testclient1origin/application
|
||||
- http://testclient1origin/other
|
||||
users: "{{ keycloak_client_users }}"
|
||||
users: "{{ keycloak_realm_client_users }}"
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
@@ -77,4 +78,12 @@ options:
|
||||
- Configures the HTTP User-Agent header.
|
||||
type: str
|
||||
default: Ansible
|
||||
use_netrc:
|
||||
description:
|
||||
- Whether to use credentials from C(~/.netrc) file.
|
||||
- By default, C(~/.netrc) is not used because these modules authenticate via
|
||||
explicit OIDC credentials/token. A matching C(~/.netrc) entry would silently
|
||||
override the Bearer token with Basic authentication, causing 401 errors.
|
||||
type: bool
|
||||
default: false
|
||||
'''
|
||||
|
||||
@@ -5,7 +5,9 @@
|
||||
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
|
||||
# Do not use this from other collections or standalone plugins/modules!
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
import typing as t
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -2,7 +2,9 @@
|
||||
# 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
|
||||
|
||||
import typing as t
|
||||
|
||||
@@ -66,7 +68,7 @@ def keycloak_clientsecret_module_resolve_params(module: AnsibleModule, kc: Keycl
|
||||
# less lookup.
|
||||
if id is None:
|
||||
# Due to the required_one_of spec, client_id is guaranteed to not be None
|
||||
client = kc.get_client_by_clientid(client_id, realm=realm)
|
||||
client = kc.get_client_by_client_id(client_id, realm=realm)
|
||||
|
||||
if client is None:
|
||||
module.fail_json(msg=f"Client does not exist {client_id}")
|
||||
|
||||
@@ -2,7 +2,9 @@
|
||||
# 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_authentication
|
||||
|
||||
@@ -5,7 +5,8 @@
|
||||
# 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 (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# 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_authentication_required_actions
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# 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_authentication_v2
|
||||
@@ -28,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.
|
||||
- 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.
|
||||
- A depth of 4 sub-flows is supported.
|
||||
- A depth of 10 sub-flows is supported.
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
@@ -220,7 +222,7 @@ options:
|
||||
authenticationExecutions:
|
||||
description:
|
||||
- The execution configuration for executions within the sub-flow.
|
||||
- Executions at sub level 4 (last sub level).
|
||||
- Executions at sub level 4.
|
||||
type: list
|
||||
elements: dict
|
||||
suboptions:
|
||||
@@ -234,7 +236,6 @@ options:
|
||||
description:
|
||||
- The C(providerId) of the execution.
|
||||
type: str
|
||||
required: true
|
||||
authenticationConfig:
|
||||
description:
|
||||
- The configuration for the execution.
|
||||
@@ -248,6 +249,247 @@ options:
|
||||
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 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:
|
||||
description:
|
||||
- Whether the authentication flow should exist or not.
|
||||
@@ -277,6 +519,7 @@ extends_documentation_fragment:
|
||||
|
||||
author:
|
||||
- Thomas Bargetz (@thomasbargetz)
|
||||
- Nils Bergmann (@NilsBergmann)
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
@@ -514,8 +757,8 @@ def create_executions(
|
||||
:param parent_flow_alias: the alias of the flow or sub-flow that will own the executions.
|
||||
"""
|
||||
for desired_exec in executions:
|
||||
sub_flow = desired_exec["subFlow"]
|
||||
sub_flow_type = desired_exec["subFlowType"]
|
||||
sub_flow = desired_exec.get("subFlow")
|
||||
sub_flow_type = desired_exec.get("subFlowType", "basic-flow")
|
||||
sub_flow_execs = desired_exec.get("authenticationExecutions")
|
||||
|
||||
# Build the minimal payload accepted by the execution creation endpoint.
|
||||
@@ -626,6 +869,12 @@ def existing_auth_to_diff_repr(kc: KeycloakAPI, realm: str, existing_auth: dict)
|
||||
execution.pop("description", None)
|
||||
execution.pop("flowId", None)
|
||||
|
||||
if execution.get("authenticationFlow"):
|
||||
# This is always None for non-form-flows and defaults to 'registration-page-form' for form-flows.
|
||||
# Keycloak supports custom form-flow providers via the FormAuthenticatorFactory SPI, but this module has no
|
||||
# option to choose one, so the providerId is stripped from the existing execution before comparison.
|
||||
execution.pop("providerId", None)
|
||||
|
||||
if execution.get("authenticationConfig") is not None:
|
||||
execution["authenticationConfig"].pop("id", None)
|
||||
# The alias is already stored inside the authenticationConfig object; the
|
||||
@@ -810,33 +1059,46 @@ def create_authentication_execution_spec_options(depth: int) -> dict[str, t.Any]
|
||||
return options
|
||||
|
||||
|
||||
def validate_executions(kc: KeycloakAPI, realm: str, executions: dict) -> None:
|
||||
valid_providers = kc.get_authenticator_providers(realm)
|
||||
valid_provider_ids = {provider["id"] for provider in valid_providers}
|
||||
def validate_executions(kc: KeycloakAPI, realm: str, executions: dict, flow_type: str) -> None:
|
||||
valid_provider_ids_by_flow_type = {
|
||||
"basic-flow": {provider["id"] for provider in kc.get_authenticator_providers(realm)},
|
||||
"form-flow": {provider["id"] for provider in kc.get_form_action_providers(realm)},
|
||||
"client-flow": {provider["id"] for provider in kc.get_client_authenticator_providers(realm)},
|
||||
}
|
||||
all_known_provider_ids = set().union(*valid_provider_ids_by_flow_type.values())
|
||||
|
||||
invalid_provider_ids = validate_executions_rec(valid_provider_ids, executions)
|
||||
if len(invalid_provider_ids) > 0:
|
||||
invalid_provider_ids_str = ", ".join(f"'{item}'" for item in invalid_provider_ids)
|
||||
raise ValueError(
|
||||
f"The following execution providerIds are unknown and therefore invalid: {invalid_provider_ids_str}"
|
||||
)
|
||||
messages = []
|
||||
has_issues = validate_executions_rec(valid_provider_ids_by_flow_type, all_known_provider_ids, executions, flow_type, messages)
|
||||
if has_issues:
|
||||
raise ValueError("Error(s) while validating flow: " + ", ".join(messages))
|
||||
|
||||
|
||||
def validate_executions_rec(valid_provider_ids: set, executions: dict) -> list:
|
||||
invalid_provider_ids = []
|
||||
def validate_executions_rec(
|
||||
valid_provider_ids_by_flow_type: dict, all_known_provider_ids: set, executions: dict, flow_type: str, messages: list
|
||||
) -> bool:
|
||||
if flow_type not in valid_provider_ids_by_flow_type:
|
||||
messages.append(f"Unsupported flow type '{flow_type}'")
|
||||
return True
|
||||
|
||||
has_issues = False
|
||||
valid_provider_ids = valid_provider_ids_by_flow_type[flow_type]
|
||||
for execution in executions:
|
||||
provider_id = execution["providerId"]
|
||||
sub_flow = execution["subFlow"]
|
||||
if provider_id is not None:
|
||||
if provider_id not in valid_provider_ids:
|
||||
invalid_provider_ids.append(provider_id)
|
||||
sub_flow = execution.get("subFlow")
|
||||
if provider_id is not None and provider_id not in valid_provider_ids:
|
||||
has_issues = True
|
||||
if provider_id in all_known_provider_ids:
|
||||
messages.append(f"'{provider_id}' is not a valid provider for parent flow '{flow_type}'")
|
||||
else:
|
||||
messages.append(f"Unknown providerId '{provider_id}'")
|
||||
|
||||
if sub_flow is not None:
|
||||
invalid_provider_ids.extend(
|
||||
validate_executions_rec(valid_provider_ids, execution["authenticationExecutions"])
|
||||
)
|
||||
if validate_executions_rec(
|
||||
valid_provider_ids_by_flow_type, all_known_provider_ids, execution["authenticationExecutions"], execution["subFlowType"], messages
|
||||
):
|
||||
has_issues = True
|
||||
|
||||
return invalid_provider_ids
|
||||
return has_issues
|
||||
|
||||
|
||||
def main() -> None:
|
||||
@@ -851,7 +1113,7 @@ def main() -> None:
|
||||
authenticationExecutions=dict(
|
||||
type="list",
|
||||
elements="dict",
|
||||
options=create_authentication_execution_spec_options(4),
|
||||
options=create_authentication_execution_spec_options(10),
|
||||
),
|
||||
state=dict(choices=["absent", "present"], default="present"),
|
||||
force_temporary_swap_flow_deletion=dict(type="bool", default=True),
|
||||
@@ -899,7 +1161,7 @@ def main() -> None:
|
||||
|
||||
try:
|
||||
try:
|
||||
validate_executions(kc, realm, desired_auth["authenticationExecutions"])
|
||||
validate_executions(kc, realm, desired_auth["authenticationExecutions"], desired_auth["providerId"])
|
||||
except ValueError as e:
|
||||
module.fail_json(
|
||||
msg=f"Validation of executions failed: {e}",
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# 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_authz_authorization_scope
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# 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_authz_custom_policy
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# 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_authz_permission
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# 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_authz_permission_info
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# 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_client
|
||||
@@ -1100,11 +1102,11 @@ def add_default_client_scopes(desired_client, before_client, realm, kc):
|
||||
missing_scopes = [item for item in desired_default_scope if item not in before_client["defaultClientScopes"]]
|
||||
if not missing_scopes:
|
||||
return
|
||||
client_scopes = kc.get_clientscopes(realm)
|
||||
client_scopes = kc.get_client_scopes(realm)
|
||||
for name in missing_scopes:
|
||||
scope = find_match(client_scopes, "name", name)
|
||||
if scope:
|
||||
kc.add_default_clientscope(scope["id"], realm, desired_client["clientId"])
|
||||
kc.add_default_client_scope(scope["id"], realm, desired_client["clientId"])
|
||||
|
||||
|
||||
def add_optional_client_scopes(desired_client, before_client, realm, kc):
|
||||
@@ -1139,11 +1141,11 @@ def add_optional_client_scopes(desired_client, before_client, realm, kc):
|
||||
missing_scopes = [item for item in desired_optional_scope if item not in before_client["optionalClientScopes"]]
|
||||
if not missing_scopes:
|
||||
return
|
||||
client_scopes = kc.get_clientscopes(realm)
|
||||
client_scopes = kc.get_client_scopes(realm)
|
||||
for name in missing_scopes:
|
||||
scope = find_match(client_scopes, "name", name)
|
||||
if scope:
|
||||
kc.add_optional_clientscope(scope["id"], realm, desired_client["clientId"])
|
||||
kc.add_optional_client_scope(scope["id"], realm, desired_client["clientId"])
|
||||
|
||||
|
||||
def remove_default_client_scopes(desired_client, before_client, realm, kc):
|
||||
@@ -1178,11 +1180,11 @@ def remove_default_client_scopes(desired_client, before_client, realm, kc):
|
||||
missing_scopes = [item for item in before_default_scope if item not in desired_client["defaultClientScopes"]]
|
||||
if not missing_scopes:
|
||||
return
|
||||
client_scopes = kc.get_default_clientscopes(realm, desired_client["clientId"])
|
||||
client_scopes = kc.get_default_client_scopes(realm, desired_client["clientId"])
|
||||
for name in missing_scopes:
|
||||
scope = find_match(client_scopes, "name", name)
|
||||
if scope:
|
||||
kc.delete_default_clientscope(scope["id"], realm, desired_client["clientId"])
|
||||
kc.delete_default_client_scope(scope["id"], realm, desired_client["clientId"])
|
||||
|
||||
|
||||
def remove_optional_client_scopes(desired_client, before_client, realm, kc):
|
||||
@@ -1217,11 +1219,11 @@ def remove_optional_client_scopes(desired_client, before_client, realm, kc):
|
||||
missing_scopes = [item for item in before_optional_scope if item not in desired_client["optionalClientScopes"]]
|
||||
if not missing_scopes:
|
||||
return
|
||||
client_scopes = kc.get_optional_clientscopes(realm, desired_client["clientId"])
|
||||
client_scopes = kc.get_optional_client_scopes(realm, desired_client["clientId"])
|
||||
for name in missing_scopes:
|
||||
scope = find_match(client_scopes, "name", name)
|
||||
if scope:
|
||||
kc.delete_optional_clientscope(scope["id"], realm, desired_client["clientId"])
|
||||
kc.delete_optional_client_scope(scope["id"], realm, desired_client["clientId"])
|
||||
|
||||
|
||||
def main():
|
||||
@@ -1346,7 +1348,7 @@ def main():
|
||||
|
||||
# See if it already exists in Keycloak
|
||||
if cid is None:
|
||||
before_client = kc.get_client_by_clientid(module.params.get("client_id"), realm=realm)
|
||||
before_client = kc.get_client_by_client_id(module.params.get("client_id"), realm=realm)
|
||||
if before_client is not None:
|
||||
cid = before_client["id"]
|
||||
else:
|
||||
@@ -1440,7 +1442,7 @@ def main():
|
||||
|
||||
# create it
|
||||
kc.create_client(desired_client, realm=realm)
|
||||
after_client = kc.get_client_by_clientid(desired_client["clientId"], realm=realm)
|
||||
after_client = kc.get_client_by_client_id(desired_client["clientId"], realm=realm)
|
||||
|
||||
result["end_state"] = sanitize_cr(after_client)
|
||||
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# 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_client_rolemapping
|
||||
@@ -337,11 +339,10 @@ def main():
|
||||
role["id"] = role_id
|
||||
else:
|
||||
module.fail_json(msg=f"Could not fetch role {role['name']}:")
|
||||
# Fetch missing role_name
|
||||
else:
|
||||
role["name"] = kc.get_client_group_rolemapping_by_id(gid, cid, role["id"], realm=realm)["name"]
|
||||
if role["name"] is None:
|
||||
module.fail_json(msg=f"Could not fetch role {role['id']}")
|
||||
# Fetch missing role_name from the client's roles, not from existing group mappings
|
||||
elif role["name"] is None:
|
||||
role_rep = kc.get_role_by_id(role["id"], realm=realm)
|
||||
role["name"] = role_rep["name"]
|
||||
|
||||
# Get effective client-level role mappings
|
||||
available_roles_before = kc.get_client_group_available_rolemappings(gid, cid, realm=realm)
|
||||
@@ -381,7 +382,10 @@ def main():
|
||||
# Assign roles
|
||||
result["changed"] = True
|
||||
if module._diff:
|
||||
result["diff"] = dict(before=assigned_roles_before, after=result["proposed"])
|
||||
result["diff"] = dict(
|
||||
before={"roles": assigned_roles_before or []},
|
||||
after={"roles": result["proposed"]},
|
||||
)
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
kc.add_group_rolemapping(gid, cid, update_roles, realm=realm)
|
||||
@@ -393,7 +397,10 @@ def main():
|
||||
# Remove mapping of role
|
||||
result["changed"] = True
|
||||
if module._diff:
|
||||
result["diff"] = dict(before=assigned_roles_before, after=result["proposed"])
|
||||
result["diff"] = dict(
|
||||
before={"roles": assigned_roles_before or []},
|
||||
after={"roles": result["proposed"]},
|
||||
)
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
kc.delete_group_rolemapping(gid, cid, update_roles, realm=realm)
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# 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_client_rolescope
|
||||
@@ -19,7 +21,7 @@ description:
|
||||
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.
|
||||
- Client O(client_id) must have O(middleware_automation.keycloak.keycloak_client#module:full_scope_allowed) set to V(false).
|
||||
- Client O(target_client_id) must have O(middleware_automation.keycloak.keycloak_client#module:full_scope_allowed) set to V(false).
|
||||
- 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.
|
||||
@@ -50,12 +52,12 @@ options:
|
||||
- The Keycloak realm under which clients resides.
|
||||
default: 'master'
|
||||
|
||||
client_id:
|
||||
target_client_id:
|
||||
type: str
|
||||
required: true
|
||||
description:
|
||||
- Roles provided in O(role_names) while be added to this client scope.
|
||||
client_scope_id:
|
||||
role_owner_client_id:
|
||||
type: str
|
||||
description:
|
||||
- If the O(role_names) are client role, the client ID under which it resides.
|
||||
@@ -66,8 +68,8 @@ options:
|
||||
elements: str
|
||||
description:
|
||||
- Names of roles to manipulate.
|
||||
- If O(client_scope_id) is present, all roles must be under this client.
|
||||
- If O(client_scope_id) is absent, all roles must be under the realm.
|
||||
- If O(role_owner_client_id) is present, all roles must be under this client.
|
||||
- If O(role_owner_client_id) is absent, all roles must be under the realm.
|
||||
extends_documentation_fragment:
|
||||
- middleware_automation.keycloak.keycloak
|
||||
- middleware_automation.keycloak.actiongroup_keycloak
|
||||
@@ -85,8 +87,8 @@ EXAMPLES = r"""
|
||||
auth_username: USERNAME
|
||||
auth_password: PASSWORD
|
||||
realm: MyCustomRealm
|
||||
client_id: frontend-client-public
|
||||
client_scope_id: backend-client-private
|
||||
target_client_id: frontend-client-public
|
||||
role_owner_client_id: backend-client-private
|
||||
role_names:
|
||||
- backend-role-admin
|
||||
- backend-role-user
|
||||
@@ -98,8 +100,8 @@ EXAMPLES = r"""
|
||||
auth_username: USERNAME
|
||||
auth_password: PASSWORD
|
||||
realm: MyCustomRealm
|
||||
client_id: frontend-client-public
|
||||
client_scope_id: backend-client-private
|
||||
target_client_id: frontend-client-public
|
||||
role_owner_client_id: backend-client-private
|
||||
role_names:
|
||||
- backend-role-admin
|
||||
state: absent
|
||||
@@ -111,7 +113,7 @@ EXAMPLES = r"""
|
||||
auth_username: USERNAME
|
||||
auth_password: PASSWORD
|
||||
realm: MyCustomRealm
|
||||
client_id: frontend-client-public
|
||||
target_client_id: frontend-client-public
|
||||
role_names:
|
||||
- realm-role-admin
|
||||
- realm-role-user
|
||||
@@ -167,8 +169,8 @@ def main():
|
||||
argument_spec = keycloak_argument_spec()
|
||||
|
||||
meta_args = dict(
|
||||
client_id=dict(type="str", required=True),
|
||||
client_scope_id=dict(type="str"),
|
||||
target_client_id=dict(type="str", required=True),
|
||||
role_owner_client_id=dict(type="str"),
|
||||
realm=dict(type="str", default="master"),
|
||||
role_names=dict(type="list", elements="str", required=True),
|
||||
state=dict(type="str", default="present", choices=["present", "absent"]),
|
||||
@@ -189,8 +191,8 @@ def main():
|
||||
kc = KeycloakAPI(module, connection_header)
|
||||
|
||||
realm = module.params.get("realm")
|
||||
clientid = module.params.get("client_id")
|
||||
client_scope_id = module.params.get("client_scope_id")
|
||||
target_client_id = module.params.get("target_client_id")
|
||||
role_owner_client_id = module.params.get("role_owner_client_id")
|
||||
role_names = module.params.get("role_names")
|
||||
state = module.params.get("state")
|
||||
|
||||
@@ -198,23 +200,23 @@ def main():
|
||||
if not objRealm:
|
||||
module.fail_json(msg=f"Failed to retrive realm '{realm}'")
|
||||
|
||||
objClient = kc.get_client_by_clientid(clientid, realm)
|
||||
objClient = kc.get_client_by_client_id(target_client_id, realm)
|
||||
if not objClient:
|
||||
module.fail_json(msg=f"Failed to retrive client '{realm}.{clientid}'")
|
||||
module.fail_json(msg=f"Failed to retrive client '{realm}.{target_client_id}'")
|
||||
if objClient["fullScopeAllowed"] and state == "present":
|
||||
module.fail_json(msg=f"FullScopeAllowed is active for Client '{realm}.{clientid}'")
|
||||
module.fail_json(msg=f"FullScopeAllowed is active for Client '{realm}.{target_client_id}'")
|
||||
|
||||
if client_scope_id:
|
||||
objClientScope = kc.get_client_by_clientid(client_scope_id, realm)
|
||||
if not objClientScope:
|
||||
module.fail_json(msg=f"Failed to retrive client '{realm}.{client_scope_id}'")
|
||||
before_role_mapping = kc.get_client_role_scope_from_client(objClient["id"], objClientScope["id"], realm)
|
||||
if role_owner_client_id:
|
||||
role_owner_client = kc.get_client_by_client_id(role_owner_client_id, realm)
|
||||
if not role_owner_client:
|
||||
module.fail_json(msg=f"Failed to retrive client '{realm}.{role_owner_client_id}'")
|
||||
before_role_mapping = kc.get_client_role_scope_from_client(objClient["id"], role_owner_client["id"], realm)
|
||||
else:
|
||||
before_role_mapping = kc.get_client_role_scope_from_realm(objClient["id"], realm)
|
||||
|
||||
if client_scope_id:
|
||||
if role_owner_client_id:
|
||||
# retrive all role from client_scope
|
||||
client_scope_roles_by_name = kc.get_client_roles_by_id(objClientScope["id"], realm)
|
||||
client_scope_roles_by_name = kc.get_client_roles_by_id(role_owner_client["id"], realm)
|
||||
else:
|
||||
# retrive all role from realm
|
||||
client_scope_roles_by_name = kc.get_realm_roles(realm)
|
||||
@@ -228,8 +230,8 @@ def main():
|
||||
# update desired
|
||||
for role_name in role_names:
|
||||
if role_name not in client_scope_roles_by_name:
|
||||
if client_scope_id:
|
||||
module.fail_json(msg=f"Failed to retrive role '{realm}.{client_scope_id}.{role_name}'")
|
||||
if role_owner_client_id:
|
||||
module.fail_json(msg=f"Failed to retrive role '{realm}.{role_owner_client_id}.{role_name}'")
|
||||
else:
|
||||
module.fail_json(msg=f"Failed to retrive role '{realm}.{role_name}'")
|
||||
if role_name not in role_mapping_by_name:
|
||||
@@ -253,33 +255,33 @@ def main():
|
||||
if not result["changed"]:
|
||||
# no changes
|
||||
result["end_state"] = before_role_mapping
|
||||
result["msg"] = f"No changes required for client role scope {clientid}."
|
||||
result["msg"] = f"No changes required for client role scope {target_client_id}."
|
||||
elif state == "present":
|
||||
# doing update
|
||||
if module.check_mode:
|
||||
result["end_state"] = desired_role_mapping
|
||||
elif client_scope_id:
|
||||
elif role_owner_client_id:
|
||||
result["end_state"] = kc.update_client_role_scope_from_client(
|
||||
role_mapping_to_manipulate, objClient["id"], objClientScope["id"], realm
|
||||
role_mapping_to_manipulate, objClient["id"], role_owner_client["id"], realm
|
||||
)
|
||||
else:
|
||||
result["end_state"] = kc.update_client_role_scope_from_realm(
|
||||
role_mapping_to_manipulate, objClient["id"], realm
|
||||
)
|
||||
result["msg"] = f"Client role scope for {clientid} has been updated"
|
||||
result["msg"] = f"Client role scope for {target_client_id} has been updated"
|
||||
else:
|
||||
# doing delete
|
||||
if module.check_mode:
|
||||
result["end_state"] = desired_role_mapping
|
||||
elif client_scope_id:
|
||||
elif role_owner_client_id:
|
||||
result["end_state"] = kc.delete_client_role_scope_from_client(
|
||||
role_mapping_to_manipulate, objClient["id"], objClientScope["id"], realm
|
||||
role_mapping_to_manipulate, objClient["id"], role_owner_client["id"], realm
|
||||
)
|
||||
else:
|
||||
result["end_state"] = kc.delete_client_role_scope_from_realm(
|
||||
role_mapping_to_manipulate, objClient["id"], realm
|
||||
)
|
||||
result["msg"] = f"Client role scope for {clientid} has been deleted"
|
||||
result["msg"] = f"Client role scope for {target_client_id} has been deleted"
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,8 @@
|
||||
# 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 (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
@@ -210,8 +211,14 @@ def main():
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec,
|
||||
supports_check_mode=True,
|
||||
required_one_of=([['token', 'auth_realm', 'auth_username', 'auth_password']]),
|
||||
required_together=([['auth_realm', 'auth_username', 'auth_password']]))
|
||||
required_one_of=(
|
||||
[
|
||||
["token", "auth_realm", "auth_username", "auth_password", "auth_client_id", "auth_client_secret"],
|
||||
]
|
||||
),
|
||||
required_together=([["auth_username", "auth_password"]]),
|
||||
required_by={"refresh_token": "auth_realm"},
|
||||
mutually_exclusive=[["token", "auth_realm"], ["token", "auth_username"], ["token", "auth_password"]])
|
||||
|
||||
result = dict(changed=False, msg='', diff={}, end_state={})
|
||||
|
||||
@@ -230,7 +237,7 @@ def main():
|
||||
attributes = module.params.get('attributes')
|
||||
protocol_mappers = module.params.get('protocol_mappers')
|
||||
|
||||
before_scope = kc.get_clientscope_by_name(name, realm=realm)
|
||||
before_scope = kc.get_client_scope_by_name(name, realm=realm)
|
||||
|
||||
if state == 'absent':
|
||||
if before_scope:
|
||||
@@ -239,7 +246,7 @@ def main():
|
||||
result['diff'] = dict(before=before_scope, after='')
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
kc.delete_clientscope(cid=before_scope['id'], realm=realm)
|
||||
kc.delete_client_scope(cid=before_scope['id'], realm=realm)
|
||||
result['msg'] = "Client scope {name} has been deleted".format(name=name)
|
||||
else:
|
||||
result['msg'] = "Client scope {name} does not exist, doing nothing".format(name=name)
|
||||
@@ -261,8 +268,8 @@ def main():
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
|
||||
kc.create_clientscope(scope_rep, realm=realm)
|
||||
after_scope = kc.get_clientscope_by_name(name, realm=realm)
|
||||
kc.create_client_scope(scope_rep, realm=realm)
|
||||
after_scope = kc.get_client_scope_by_name(name, realm=realm)
|
||||
|
||||
if protocol_mappers:
|
||||
for mapper in protocol_mappers:
|
||||
@@ -272,8 +279,8 @@ def main():
|
||||
'protocolMapper': mapper['protocolMapper'],
|
||||
'config': mapper['config'],
|
||||
}
|
||||
kc.create_clientscope_protocolmapper(after_scope['id'], mapper_rep, realm=realm)
|
||||
after_scope = kc.get_clientscope_by_name(name, realm=realm)
|
||||
kc.create_client_scope_protocolmapper(after_scope['id'], mapper_rep, realm=realm)
|
||||
after_scope = kc.get_client_scope_by_name(name, realm=realm)
|
||||
|
||||
result['end_state'] = after_scope
|
||||
result['msg'] = "Client scope {name} has been created".format(name=name)
|
||||
@@ -296,10 +303,10 @@ def main():
|
||||
result['diff'] = dict(before=before_scope, after=scope_rep)
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
kc.update_clientscope(scope_rep, realm=realm)
|
||||
kc.update_client_scope(scope_rep, realm=realm)
|
||||
|
||||
if protocol_mappers:
|
||||
existing_mappers = kc.get_clientscope_protocolmappers(before_scope['id'], realm=realm)
|
||||
existing_mappers = kc.get_client_scope_protocolmappers(before_scope['id'], realm=realm)
|
||||
existing_mapper_names = {m['name'] for m in existing_mappers}
|
||||
|
||||
for mapper in protocol_mappers:
|
||||
@@ -312,9 +319,9 @@ def main():
|
||||
'protocolMapper': mapper['protocolMapper'],
|
||||
'config': mapper['config'],
|
||||
}
|
||||
kc.create_clientscope_protocolmapper(before_scope['id'], mapper_rep, realm=realm)
|
||||
kc.create_client_scope_protocolmapper(before_scope['id'], mapper_rep, realm=realm)
|
||||
|
||||
after_scope = kc.get_clientscope_by_name(name, realm=realm)
|
||||
after_scope = kc.get_client_scope_by_name(name, realm=realm)
|
||||
result['end_state'] = after_scope
|
||||
|
||||
if result['changed']:
|
||||
|
||||
+37
-35
@@ -3,19 +3,21 @@
|
||||
# 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_clientscope_rolemappings
|
||||
module: keycloak_client_scope_rolemappings
|
||||
|
||||
short_description: Allows administration of Keycloak clientscope scope mappings to restrict the usage of certain roles to
|
||||
specific clientscopes
|
||||
short_description: Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to
|
||||
specific client scopes
|
||||
|
||||
# Originally added in community.general 13.1.0
|
||||
version_added: "3.0.0"
|
||||
|
||||
description:
|
||||
- This module allows you to add or remove Keycloak roles from clientscopes using the Keycloak REST API. It requires access
|
||||
- This module allows you to add or remove Keycloak roles from client scopes 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, C(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.
|
||||
@@ -49,11 +51,11 @@ options:
|
||||
- The Keycloak realm under which clients resides.
|
||||
default: 'master'
|
||||
|
||||
clientscope_id:
|
||||
client_scope_id:
|
||||
required: true
|
||||
type: str
|
||||
description:
|
||||
- Roles provided in O(role_names) will be added to this clientscope.
|
||||
- Roles provided in O(role_names) will be added to this client scope.
|
||||
|
||||
client_id:
|
||||
type: str
|
||||
@@ -81,40 +83,40 @@ author:
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
- name: Add roles to clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: Add roles to client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
auth_keycloak_url: https://auth.example.com
|
||||
auth_realm: master
|
||||
auth_username: USERNAME
|
||||
auth_password: PASSWORD
|
||||
realm: MyCustomRealm
|
||||
client_id: frontend-client-public
|
||||
clientscope_id: frontend-clientscope
|
||||
client_scope_id: frontend-client-scope
|
||||
role_names:
|
||||
- backend-role-admin
|
||||
- backend-role-user
|
||||
|
||||
- name: Remove roles from clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: Remove roles from client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
auth_keycloak_url: https://auth.example.com
|
||||
auth_realm: master
|
||||
auth_username: USERNAME
|
||||
auth_password: PASSWORD
|
||||
realm: MyCustomRealm
|
||||
client_id: frontend-client-public
|
||||
clientscope_id: frontend-clientscope
|
||||
client_scope_id: frontend-client-scope
|
||||
role_names:
|
||||
- backend-role-admin
|
||||
state: absent
|
||||
|
||||
- name: Add realm roles to clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: Add realm roles to client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
auth_keycloak_url: https://auth.example.com
|
||||
auth_realm: master
|
||||
auth_username: USERNAME
|
||||
auth_password: PASSWORD
|
||||
realm: MyCustomRealm
|
||||
clientscope_id: frontend-clientscope
|
||||
client_scope_id: frontend-client-scope
|
||||
role_names:
|
||||
- realm-role-admin
|
||||
- realm-role-user
|
||||
@@ -122,7 +124,7 @@ EXAMPLES = r"""
|
||||
|
||||
RETURN = r"""
|
||||
end_state:
|
||||
description: Representation of clientscope scope mappings after module execution.
|
||||
description: Representation of client scope scope mappings after module execution.
|
||||
returned: on success
|
||||
type: list
|
||||
elements: dict
|
||||
@@ -164,7 +166,7 @@ def main():
|
||||
|
||||
meta_args = dict(
|
||||
client_id=dict(type="str"),
|
||||
clientscope_id=dict(type="str", required=True),
|
||||
client_scope_id=dict(type="str", required=True),
|
||||
realm=dict(type="str", default="master"),
|
||||
role_names=dict(type="list", elements="str", required=True),
|
||||
state=dict(type="str", default="present", choices=["present", "absent"]),
|
||||
@@ -186,7 +188,7 @@ def main():
|
||||
|
||||
realm = module.params["realm"]
|
||||
client_id = module.params["client_id"]
|
||||
clientscope_id = module.params["clientscope_id"]
|
||||
client_scope_id = module.params["client_scope_id"]
|
||||
role_names = module.params["role_names"]
|
||||
state = module.params["state"]
|
||||
|
||||
@@ -194,23 +196,23 @@ def main():
|
||||
if not realm_object:
|
||||
module.fail_json(msg=f"Failed to retrieve realm '{realm}'")
|
||||
|
||||
clientscope_object = kc.get_clientscope_by_name(clientscope_id, realm)
|
||||
if not clientscope_object:
|
||||
module.fail_json(msg=f"Failed to retrieve client-scope '{clientscope_id}'")
|
||||
client_scope_object = kc.get_client_scope_by_name(client_scope_id, realm)
|
||||
if not client_scope_object:
|
||||
module.fail_json(msg=f"Failed to retrieve client scope '{client_scope_id}'")
|
||||
|
||||
if client_id:
|
||||
# add client role
|
||||
client_object = kc.get_client_by_clientid(client_id, realm)
|
||||
client_object = kc.get_client_by_client_id(client_id, realm)
|
||||
if not client_object:
|
||||
module.fail_json(msg=f"Failed to retrieve client '{realm}.{client_id}'")
|
||||
if client_object["fullScopeAllowed"] and state == "present":
|
||||
module.fail_json(msg=f"FullScopeAllowed is active for Client '{realm}.{client_id}'")
|
||||
|
||||
before_roles = kc.get_clientscope_scope_mappings_client(clientscope_object["id"], client_object["id"], realm)
|
||||
before_roles = kc.get_client_scope_scope_mappings_client(client_scope_object["id"], client_object["id"], realm)
|
||||
available_roles_by_name = kc.get_client_roles_by_id(client_object["id"], realm)
|
||||
else:
|
||||
# add realm role
|
||||
before_roles = kc.get_clientscope_scope_mappings_realm(clientscope_object["id"], realm)
|
||||
before_roles = kc.get_client_scope_scope_mappings_realm(client_scope_object["id"], realm)
|
||||
available_roles_by_name = kc.get_realm_roles(realm)
|
||||
|
||||
# convert to indexed Dict by name
|
||||
@@ -248,33 +250,33 @@ def main():
|
||||
if not result["changed"]:
|
||||
# no changes
|
||||
result["end_state"] = before_roles
|
||||
result["msg"] = f"No changes required for clientscope {clientscope_id}."
|
||||
result["msg"] = f"No changes required for client scope {client_scope_id}."
|
||||
elif state == "present":
|
||||
# doing update
|
||||
if module.check_mode:
|
||||
result["end_state"] = desired_role_mapping
|
||||
elif client_id:
|
||||
result["end_state"] = kc.update_clientscope_scope_mappings_client(
|
||||
changed_roles, clientscope_object["id"], client_object["id"], realm
|
||||
result["end_state"] = kc.update_client_scope_scope_mappings_client(
|
||||
changed_roles, client_scope_object["id"], client_object["id"], realm
|
||||
)
|
||||
else:
|
||||
result["end_state"] = kc.update_clientscope_scope_mappings_realm(
|
||||
changed_roles, clientscope_object["id"], realm
|
||||
result["end_state"] = kc.update_client_scope_scope_mappings_realm(
|
||||
changed_roles, client_scope_object["id"], realm
|
||||
)
|
||||
result["msg"] = f"Clientscope scope mappings for {clientscope_id} have been updated"
|
||||
result["msg"] = f"Clientscope scope mappings for {client_scope_id} have been updated"
|
||||
else:
|
||||
# doing delete
|
||||
if module.check_mode:
|
||||
result["end_state"] = desired_role_mapping
|
||||
elif client_id:
|
||||
result["end_state"] = kc.delete_clientscope_scope_mappings_client(
|
||||
changed_roles, clientscope_object["id"], client_object["id"], realm
|
||||
result["end_state"] = kc.delete_client_scope_scope_mappings_client(
|
||||
changed_roles, client_scope_object["id"], client_object["id"], realm
|
||||
)
|
||||
else:
|
||||
result["end_state"] = kc.delete_clientscope_scope_mappings_realm(
|
||||
changed_roles, clientscope_object["id"], realm
|
||||
result["end_state"] = kc.delete_client_scope_scope_mappings_realm(
|
||||
changed_roles, client_scope_object["id"], realm
|
||||
)
|
||||
result["msg"] = f"Clientscope scope mappings for {clientscope_id} have been deleted"
|
||||
result["msg"] = f"Clientscope scope mappings for {client_scope_id} have been deleted"
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
+79
-77
@@ -3,18 +3,20 @@
|
||||
# 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_clientscope_type
|
||||
module: keycloak_client_scope_type
|
||||
|
||||
short_description: Set the type of aclientscope in realm or client using Keycloak API
|
||||
short_description: Set the type of a client scope in a realm or client using the Keycloak API
|
||||
|
||||
# Originally added in community.general 6.6.0
|
||||
version_added: "3.0.0"
|
||||
|
||||
description:
|
||||
- This module allows you to set the type (optional, default) of clientscopes using the Keycloak REST API. It requires access
|
||||
- This module allows you to set the type (optional, default) of client scopes 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.
|
||||
@@ -36,18 +38,18 @@ options:
|
||||
|
||||
client_id:
|
||||
description:
|
||||
- The O(client_id) of the client. If not set the clientscope types are set as a default for the realm.
|
||||
- The O(client_id) of the client. If not set the client scope types are set as a default for the realm.
|
||||
aliases:
|
||||
- clientId
|
||||
type: str
|
||||
|
||||
default_clientscopes:
|
||||
default_client_scopes:
|
||||
description:
|
||||
- Client scopes that should be of type default.
|
||||
type: list
|
||||
elements: str
|
||||
|
||||
optional_clientscopes:
|
||||
optional_client_scopes:
|
||||
description:
|
||||
- Client scopes that should be of type optional.
|
||||
type: list
|
||||
@@ -64,26 +66,26 @@ author:
|
||||
|
||||
EXAMPLES = r"""
|
||||
- name: Set default client scopes on realm level
|
||||
middleware_automation.keycloak.keycloak_clientscope_type:
|
||||
middleware_automation.keycloak.keycloak_client_scope_type:
|
||||
auth_client_id: admin-cli
|
||||
auth_keycloak_url: https://auth.example.com
|
||||
auth_realm: master
|
||||
auth_username: USERNAME
|
||||
auth_password: PASSWORD
|
||||
realm: "MyCustomRealm"
|
||||
default_clientscopes: ['profile', 'roles']
|
||||
default_client_scopes: ['profile', 'roles']
|
||||
delegate_to: localhost
|
||||
|
||||
|
||||
- name: Set default and optional client scopes on client level with token auth
|
||||
middleware_automation.keycloak.keycloak_clientscope_type:
|
||||
middleware_automation.keycloak.keycloak_client_scope_type:
|
||||
auth_client_id: admin-cli
|
||||
auth_keycloak_url: https://auth.example.com
|
||||
token: TOKEN
|
||||
realm: "MyCustomRealm"
|
||||
client_id: "MyCustomClient"
|
||||
default_clientscopes: ['profile', 'roles']
|
||||
optional_clientscopes: ['phone']
|
||||
default_client_scopes: ['profile', 'roles']
|
||||
optional_client_scopes: ['phone']
|
||||
delegate_to: localhost
|
||||
"""
|
||||
|
||||
@@ -94,16 +96,16 @@ msg:
|
||||
type: str
|
||||
sample: ""
|
||||
proposed:
|
||||
description: Representation of proposed client-scope types mapping.
|
||||
description: Representation of proposed client scope types mapping.
|
||||
returned: always
|
||||
type: dict
|
||||
sample:
|
||||
{
|
||||
"default_clientscopes": [
|
||||
"default_client_scopes": [
|
||||
"profile",
|
||||
"role"
|
||||
],
|
||||
"optional_clientscopes": []
|
||||
"optional_client_scopes": []
|
||||
}
|
||||
existing:
|
||||
description:
|
||||
@@ -112,11 +114,11 @@ existing:
|
||||
type: dict
|
||||
sample:
|
||||
{
|
||||
"default_clientscopes": [
|
||||
"default_client_scopes": [
|
||||
"profile",
|
||||
"role"
|
||||
],
|
||||
"optional_clientscopes": [
|
||||
"optional_client_scopes": [
|
||||
"phone"
|
||||
]
|
||||
}
|
||||
@@ -128,11 +130,11 @@ end_state:
|
||||
type: dict
|
||||
sample:
|
||||
{
|
||||
"default_clientscopes": [
|
||||
"default_client_scopes": [
|
||||
"profile",
|
||||
"role"
|
||||
],
|
||||
"optional_clientscopes": []
|
||||
"optional_client_scopes": []
|
||||
}
|
||||
"""
|
||||
|
||||
@@ -146,7 +148,7 @@ from ansible_collections.middleware_automation.keycloak.plugins.module_utils.ide
|
||||
)
|
||||
|
||||
|
||||
def keycloak_clientscope_type_module():
|
||||
def keycloak_client_scope_type_module():
|
||||
"""
|
||||
Returns an AnsibleModule definition.
|
||||
|
||||
@@ -157,8 +159,8 @@ def keycloak_clientscope_type_module():
|
||||
meta_args = dict(
|
||||
realm=dict(default="master"),
|
||||
client_id=dict(type="str", aliases=["clientId"]),
|
||||
default_clientscopes=dict(type="list", elements="str"),
|
||||
optional_clientscopes=dict(type="list", elements="str"),
|
||||
default_client_scopes=dict(type="list", elements="str"),
|
||||
optional_client_scopes=dict(type="list", elements="str"),
|
||||
)
|
||||
|
||||
argument_spec.update(meta_args)
|
||||
@@ -169,7 +171,7 @@ def keycloak_clientscope_type_module():
|
||||
required_one_of=(
|
||||
[
|
||||
["token", "auth_realm", "auth_username", "auth_password", "auth_client_id", "auth_client_secret"],
|
||||
["default_clientscopes", "optional_clientscopes"],
|
||||
["default_client_scopes", "optional_client_scopes"],
|
||||
]
|
||||
),
|
||||
required_together=([["auth_username", "auth_password"]]),
|
||||
@@ -180,21 +182,21 @@ def keycloak_clientscope_type_module():
|
||||
return module
|
||||
|
||||
|
||||
def clientscopes_to_add(existing, proposed):
|
||||
def client_scopes_to_add(existing, proposed):
|
||||
to_add = []
|
||||
existing_clientscope_ids = extract_field(existing, "id")
|
||||
for clientscope in proposed:
|
||||
if clientscope["id"] not in existing_clientscope_ids:
|
||||
to_add.append(clientscope)
|
||||
existing_client_scope_ids = extract_field(existing, "id")
|
||||
for client_scope in proposed:
|
||||
if client_scope["id"] not in existing_client_scope_ids:
|
||||
to_add.append(client_scope)
|
||||
return to_add
|
||||
|
||||
|
||||
def clientscopes_to_delete(existing, proposed):
|
||||
def client_scopes_to_delete(existing, proposed):
|
||||
to_delete = []
|
||||
proposed_clientscope_ids = extract_field(proposed, "id")
|
||||
for clientscope in existing:
|
||||
if clientscope["id"] not in proposed_clientscope_ids:
|
||||
to_delete.append(clientscope)
|
||||
proposed_client_scope_ids = extract_field(proposed, "id")
|
||||
for client_scope in existing:
|
||||
if client_scope["id"] not in proposed_client_scope_ids:
|
||||
to_delete.append(client_scope)
|
||||
return to_delete
|
||||
|
||||
|
||||
@@ -204,21 +206,21 @@ def extract_field(dictionary, field="name"):
|
||||
|
||||
def normalize_scopes(scopes):
|
||||
scopes_copy = scopes.copy()
|
||||
if isinstance(scopes_copy.get("default_clientscopes"), list):
|
||||
scopes_copy["default_clientscopes"] = sorted(scopes_copy["default_clientscopes"])
|
||||
if isinstance(scopes_copy.get("optional_clientscopes"), list):
|
||||
scopes_copy["optional_clientscopes"] = sorted(scopes_copy["optional_clientscopes"])
|
||||
if isinstance(scopes_copy.get("default_client_scopes"), list):
|
||||
scopes_copy["default_client_scopes"] = sorted(scopes_copy["default_client_scopes"])
|
||||
if isinstance(scopes_copy.get("optional_client_scopes"), list):
|
||||
scopes_copy["optional_client_scopes"] = sorted(scopes_copy["optional_client_scopes"])
|
||||
return scopes_copy
|
||||
|
||||
|
||||
def main():
|
||||
"""
|
||||
Module keycloak_clientscope_type
|
||||
Module keycloak_client_scope_type
|
||||
|
||||
:return:
|
||||
"""
|
||||
|
||||
module = keycloak_clientscope_type_module()
|
||||
module = keycloak_client_scope_type_module()
|
||||
|
||||
# Obtain access token, initialize API
|
||||
try:
|
||||
@@ -230,81 +232,81 @@ def main():
|
||||
|
||||
realm = module.params.get("realm")
|
||||
client_id = module.params.get("client_id")
|
||||
default_clientscopes = module.params.get("default_clientscopes")
|
||||
optional_clientscopes = module.params.get("optional_clientscopes")
|
||||
default_client_scopes = module.params.get("default_client_scopes")
|
||||
optional_client_scopes = module.params.get("optional_client_scopes")
|
||||
|
||||
result = dict(changed=False, msg="", proposed={}, existing={}, end_state={})
|
||||
|
||||
all_clientscopes = kc.get_clientscopes(realm)
|
||||
default_clientscopes_real = []
|
||||
optional_clientscopes_real = []
|
||||
all_client_scopes = kc.get_client_scopes(realm)
|
||||
default_client_scopes_real = []
|
||||
optional_client_scopes_real = []
|
||||
|
||||
for client_scope in all_clientscopes:
|
||||
if default_clientscopes is not None and client_scope["name"] in default_clientscopes:
|
||||
default_clientscopes_real.append(client_scope)
|
||||
if optional_clientscopes is not None and client_scope["name"] in optional_clientscopes:
|
||||
optional_clientscopes_real.append(client_scope)
|
||||
for client_scope in all_client_scopes:
|
||||
if default_client_scopes is not None and client_scope["name"] in default_client_scopes:
|
||||
default_client_scopes_real.append(client_scope)
|
||||
if optional_client_scopes is not None and client_scope["name"] in optional_client_scopes:
|
||||
optional_client_scopes_real.append(client_scope)
|
||||
|
||||
if default_clientscopes is not None and len(default_clientscopes_real) != len(default_clientscopes):
|
||||
module.fail_json(msg="At least one of the default_clientscopes does not exist!")
|
||||
if default_client_scopes is not None and len(default_client_scopes_real) != len(default_client_scopes):
|
||||
module.fail_json(msg="At least one of the default_client_scopes does not exist!")
|
||||
|
||||
if optional_clientscopes is not None and len(optional_clientscopes_real) != len(optional_clientscopes):
|
||||
module.fail_json(msg="At least one of the optional_clientscopes does not exist!")
|
||||
if optional_client_scopes is not None and len(optional_client_scopes_real) != len(optional_client_scopes):
|
||||
module.fail_json(msg="At least one of the optional_client_scopes does not exist!")
|
||||
|
||||
result["proposed"].update(
|
||||
{
|
||||
"default_clientscopes": "no-change" if default_clientscopes is None else default_clientscopes,
|
||||
"optional_clientscopes": "no-change" if optional_clientscopes is None else optional_clientscopes,
|
||||
"default_client_scopes": "no-change" if default_client_scopes is None else default_client_scopes,
|
||||
"optional_client_scopes": "no-change" if optional_client_scopes is None else optional_client_scopes,
|
||||
}
|
||||
)
|
||||
|
||||
default_clientscopes_existing = kc.get_default_clientscopes(realm, client_id)
|
||||
optional_clientscopes_existing = kc.get_optional_clientscopes(realm, client_id)
|
||||
default_client_scopes_existing = kc.get_default_client_scopes(realm, client_id)
|
||||
optional_client_scopes_existing = kc.get_optional_client_scopes(realm, client_id)
|
||||
|
||||
result["existing"].update(
|
||||
{
|
||||
"default_clientscopes": extract_field(default_clientscopes_existing),
|
||||
"optional_clientscopes": extract_field(optional_clientscopes_existing),
|
||||
"default_client_scopes": extract_field(default_client_scopes_existing),
|
||||
"optional_client_scopes": extract_field(optional_client_scopes_existing),
|
||||
}
|
||||
)
|
||||
|
||||
if module._diff:
|
||||
result["diff"] = dict(before=normalize_scopes(result["existing"]), after=normalize_scopes(result["proposed"]))
|
||||
|
||||
default_clientscopes_add = clientscopes_to_add(default_clientscopes_existing, default_clientscopes_real)
|
||||
optional_clientscopes_add = clientscopes_to_add(optional_clientscopes_existing, optional_clientscopes_real)
|
||||
default_client_scopes_add = client_scopes_to_add(default_client_scopes_existing, default_client_scopes_real)
|
||||
optional_client_scopes_add = client_scopes_to_add(optional_client_scopes_existing, optional_client_scopes_real)
|
||||
|
||||
default_clientscopes_delete = clientscopes_to_delete(default_clientscopes_existing, default_clientscopes_real)
|
||||
optional_clientscopes_delete = clientscopes_to_delete(optional_clientscopes_existing, optional_clientscopes_real)
|
||||
default_client_scopes_delete = client_scopes_to_delete(default_client_scopes_existing, default_client_scopes_real)
|
||||
optional_client_scopes_delete = client_scopes_to_delete(optional_client_scopes_existing, optional_client_scopes_real)
|
||||
|
||||
result["changed"] = any(
|
||||
len(x) > 0
|
||||
for x in [
|
||||
default_clientscopes_add,
|
||||
optional_clientscopes_add,
|
||||
default_clientscopes_delete,
|
||||
optional_clientscopes_delete,
|
||||
default_client_scopes_add,
|
||||
optional_client_scopes_add,
|
||||
default_client_scopes_delete,
|
||||
optional_client_scopes_delete,
|
||||
]
|
||||
)
|
||||
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
|
||||
# first delete so clientscopes can change type
|
||||
for clientscope in default_clientscopes_delete:
|
||||
kc.delete_default_clientscope(clientscope["id"], realm, client_id)
|
||||
for clientscope in optional_clientscopes_delete:
|
||||
kc.delete_optional_clientscope(clientscope["id"], realm, client_id)
|
||||
# first delete so client_scopes can change type
|
||||
for client_scope in default_client_scopes_delete:
|
||||
kc.delete_default_client_scope(client_scope["id"], realm, client_id)
|
||||
for client_scope in optional_client_scopes_delete:
|
||||
kc.delete_optional_client_scope(client_scope["id"], realm, client_id)
|
||||
|
||||
for clientscope in default_clientscopes_add:
|
||||
kc.add_default_clientscope(clientscope["id"], realm, client_id)
|
||||
for clientscope in optional_clientscopes_add:
|
||||
kc.add_optional_clientscope(clientscope["id"], realm, client_id)
|
||||
for client_scope in default_client_scopes_add:
|
||||
kc.add_default_client_scope(client_scope["id"], realm, client_id)
|
||||
for client_scope in optional_client_scopes_add:
|
||||
kc.add_optional_client_scope(client_scope["id"], realm, client_id)
|
||||
|
||||
result["end_state"].update(
|
||||
{
|
||||
"default_clientscopes": extract_field(kc.get_default_clientscopes(realm, client_id)),
|
||||
"optional_clientscopes": extract_field(kc.get_optional_clientscopes(realm, client_id)),
|
||||
"default_client_scopes": extract_field(kc.get_default_client_scopes(realm, client_id)),
|
||||
"optional_client_scopes": extract_field(kc.get_optional_client_scopes(realm, client_id)),
|
||||
}
|
||||
)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user