Compare commits

..
89 Commits
Author SHA1 Message Date
Ranabir ChakrabortyandGitHub a071cd1c2d Merge pull request #416 from RanabirChakraborty/changelog/3.1.0
Update changelog for release 3.1.0
2026-09-11 20:34:19 +05:30
ansible-middleware-coreandRanabir Chakraborty 6b2d4a8552 Update changelog for release 3.1.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-09-11 20:29:58 +05:30
Ranabir ChakrabortyandGitHub 08ee1c33bc Merge pull request #412 from cihlamar/AMW-628
Replace deprecated top-level fact variables with ansible_fact
2026-09-11 20:01:40 +05:30
Ranabir ChakrabortyandGitHub e103524781 Merge pull request #384 from NilsBergmann/feature/authv2-formaction
authentication_v2: Fix validation for FormActions
2026-09-11 20:00:09 +05:30
Ranabir ChakrabortyandGitHub 45863b3023 Merge pull request #414 from hcherukuri/main
Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in
2026-09-11 12:44:16 +05:30
Ranabir ChakrabortyandGitHub 9ac8274434 Merge pull request #413 from cihlamar/AMW-578
Replace deprecated community.general.yaml callback with result
2026-09-10 21:07:57 +05:30
Harsha Cherukuri 0716f622ad Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in 2026-09-10 09:03:29 -04:00
Harsha CherukuriandGitHub 14cba062b4 Merge pull request #411 from RanabirChakraborty/AMW-626
AMW-626 keycloak_user_rolemapping raises 403 error code while listing asignable Roles if invoker lacks view-realm Role
2026-09-10 08:57:52 -04:00
Martin Cihlar 9d56a54bd8 AMW-628 Replace deprecated top-level fact variables with ansible_facts syntax 2026-09-10 13:26:02 +02:00
Martin Cihlar 8c3c4d8cbc AMW-578 Replace deprecated community.general.yaml callback with result_format 2026-09-10 10:38:00 +02:00
Nils Bergmann 638f694120 authentication_v2: Fix validation for form-flows and client-flows 2026-09-09 10:36:56 +02:00
Ranabir Chakraborty 86bd6c77d6 AMW-626 keycloak_user_rolemapping raises 403 error code while listing asignable Roles if invoker lacks view-realm Role 2026-09-09 13:24:37 +05:30
Ranabir ChakrabortyandGitHub 6644207e5d Merge pull request #407 from Yabk/bugfix/keycloak_group_parents
keycloak_group: fix subgroup lookup on Keycloak older than 25
2026-09-09 12:40:51 +05:30
Ranabir ChakrabortyandGitHub 5ba8098c15 Merge pull request #408 from cihlamar/AMW-625
Add use_netrc option to prevent .netrc overriding bearer token
2026-09-09 12:33:09 +05:30
Martin Cihlar d6ceb63914 AMW-625 add use_netrc option to prevent .netrc overriding bearer token auth
When ~/.netrc contains an entry matching the Keycloak host, open_url()
silently replaces the OIDC Bearer header with Basic auth, causing 401
errors. Add use_netrc option (default false) to all keycloak modules
and pass it through to both open_url() call sites.

Includes molecule test scenario (netrc) that verifies both behaviors:
- default use_netrc=false ignores .netrc (fix works)
- use_netrc=true picks up .netrc and gets 401 (proves the bug)

Fixes: https://github.com/ansible-middleware/keycloak/issues/403
2026-09-07 09:09:39 +02:00
Yabk 529b667321 keycloak_group: fix subgroup lookup on Keycloak older than 25
The parents branch of get_group_by_name() queried
GET /admin/realms/{realm}/groups/{id}/children?search=&exact=true
unconditionally. That endpoint only accepts GET from Keycloak 23 on, so
older servers (RH-SSO 7.x included) failed with 405 Method Not Allowed,
and 23/24 ignore search/exact and return only the first 10 children, so
subgroups past the tenth were silently reported as absent.

The lookup now goes through get_subgroups(), which already detects the
server generation, and that helper takes an optional search argument so
the search optimization is kept where the server supports it.
2026-09-04 12:56:23 +02:00
Harsha CherukuriandGitHub 8d5526aeb6 Merge pull request #406 from RanabirChakraborty/AMW-622
AMW-622 keycloak collection spelling and grammar checking for PRs
2026-09-03 13:48:04 -04:00
Ranabir ChakrabortyandGitHub afc12b6ae2 Merge pull request #405 from hcherukuri/main
Fix issue #397 #398 crash on first role assignment
2026-09-03 22:34:37 +05:30
Ranabir Chakraborty 0868b58e90 AMW-622 keycloak collection spelling and grammar checking for PRs 2026-09-03 22:18:47 +05:30
Harsha Cherukuri 2ffe3a8f7b Fix keycloak_user_federation for issue #398 2026-09-03 10:02:35 -04:00
Harsha CherukuriandGitHub 6814939116 Merge pull request #402 from stblassitude/fix/keycloak_authentication_v2-subflow-keyerror
In a flow definition, handle non-existing keys correctly
2026-09-03 09:47:01 -04:00
Harsha Cherukuri 24350903ed Fix issue #397 crash on first role assignment 2026-09-03 09:43:17 -04:00
Harsha CherukuriandGitHub 89cb1691ae Merge pull request #404 from hcherukuri/main
Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter
2026-09-03 09:38:14 -04:00
Harsha Cherukuri 79852e61fc Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter 2026-09-03 08:23:38 -04:00
Stefan Bethke 8007d8039a Handle non-existing keys correctly
See issue #401 for details.
2026-09-02 10:35:01 +02:00
Ranabir ChakrabortyandGitHub 85d494731a Merge pull request #399 from santanoce/bugfix/keycloak_user
keycloak_user: fix attributes always reporting changed=True
2026-09-01 18:43:41 +05:30
Ranabir ChakrabortyandGitHub d41fc161be Merge pull request #392 from cihlamar/AMW-612
Normalize hostname that includes http_relative_path suffix
2026-09-01 18:42:10 +05:30
Harsha CherukuriandGitHub 4e1d14c4a1 Merge pull request #400 from RanabirChakraborty/AMW-615
AMW-615 Inconsistent support of authentication via client credentials
2026-08-31 22:34:42 -04:00
Ranabir Chakraborty e9f74fa4a9 AMW-615 Inconsistent support of authentication via client credentials 2026-08-31 23:40:02 +05:30
santanoce 23d96186f5 keycloak_user: fix attributes always reporting changed=True 2026-08-30 12:44:17 +02:00
Martin Cihlar b48b0b7334 AMW-612 Fix health URL duplication when hostname includes http_relative_path
Use removesuffix to strip overlapping path from hostname before
re-appending http_relative_path, preventing /auth/auth/ duplication.
Add molecule test for the relative path scenario.
2026-08-27 13:14:28 +02:00
Martin CihlarandGitHub 9446e53b6e Merge pull request #393 from ansible-middleware/dependabot/github_actions/ansible-collections/partner-certification-checker/dot-github/workflows/certification-reusable.yml-4.1.0
Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml from 4.0.0 to 4.1.0
2026-08-27 11:50:45 +02:00
Ranabir ChakrabortyandGitHub a29e1a0c0e Merge pull request #387 from ansible-middleware/dependabot/github_actions/EndBug/add-and-commit-11
Bump EndBug/add-and-commit from 10 to 11
2026-08-26 22:45:27 +05:30
Ranabir ChakrabortyandGitHub f082e8adb1 Merge pull request #374 from RISE-GmbH/369-add_integration_tests_for_keycloak_authentication_v2
369 add integration tests for keycloak_authentication_v2
2026-08-26 22:45:08 +05:30
Ranabir ChakrabortyandGitHub a4cdf1b154 Merge pull request #395 from ansible-middleware/bump/3.0.12
Bump version to 3.0.12
2026-08-24 22:40:30 +05:30
ansible-middleware-core 4112ac7d71 Bump version to 3.0.12 2026-08-24 17:08:25 +00:00
Ranabir ChakrabortyandGitHub a965f47fb8 Merge pull request #394 from ansible-middleware/changelog/3.0.11
Update changelog for release 3.0.11
2026-08-24 22:37:01 +05:30
ansible-middleware-core 15356606f3 Update changelog for release 3.0.11
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-08-24 17:05:40 +00:00
dependabot[bot]andGitHub 8021fd735d Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
Bumps [ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml](https://github.com/ansible-collections/partner-certification-checker) from 4.0.0 to 4.1.0.
- [Release notes](https://github.com/ansible-collections/partner-certification-checker/releases)
- [Changelog](https://github.com/ansible-collections/partner-certification-checker/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/ansible-collections/partner-certification-checker/compare/f182febf0568baf1151f66549401167fd10b25d2...f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e)

---
updated-dependencies:
- dependency-name: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
  dependency-version: 4.1.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-24 12:45:47 +00:00
Ranabir ChakrabortyandGitHub 412f3f405d Merge pull request #389 from hcherukuri/main
Fix cert workflow
2026-08-18 18:39:45 +05:30
Harsha Cherukuri e5f6f92c5d Fix cert workflow 2026-08-18 08:46:50 -04:00
dependabot[bot]andGitHub 3d9c71a2e6 Bump EndBug/add-and-commit from 10 to 11
Bumps [EndBug/add-and-commit](https://github.com/endbug/add-and-commit) from 10 to 11.
- [Release notes](https://github.com/endbug/add-and-commit/releases)
- [Commits](https://github.com/endbug/add-and-commit/compare/v10...v11)

---
updated-dependencies:
- dependency-name: EndBug/add-and-commit
  dependency-version: '11'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-17 12:46:38 +00:00
Thomas Bargetz 742c44039c 369 add integration tests for keycloak_authentication_v2 2026-08-17 07:40:31 +02:00
Harsha CherukuriandGitHub 9c347d1bf0 Merge pull request #376 from RISE-GmbH/375-increase_number_of_subflow_levels
375 increase maximum of sub levels to 25
2026-08-14 11:28:40 -04:00
Harsha CherukuriandGitHub 6023cff8ca Merge pull request #381 from snecklifter/fix/changelog-sanity-dotfile
Remove changelogs/fragments/.gitignore to fix changelog sanity test
2026-08-13 13:56:27 -04:00
Harsha CherukuriandGitHub fd13175e45 Merge pull request #377 from snecklifter/feat/keycloak-organization-module
Add keycloak_organization and keycloak_organization_info modules
2026-08-13 13:55:33 -04:00
Harsha CherukuriandGitHub c831534a48 Merge pull request #379 from ansible-middleware/dependabot/github_actions/actions/checkout-7
Bump actions/checkout from 2 to 7
2026-08-12 17:53:24 -04:00
Chris BrownandClaude Opus 4.6 192061d1b5 Remove changelogs/fragments/.gitignore to fix changelog sanity test
The changelog sanity test rejects dotfiles in the fragments directory.
The .gitignore was only present to keep the empty directory tracked
by git. The directory is recreated by antsibull-changelog when
fragments are added, so it does not need to exist in the repo.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-08-12 21:43:02 +01:00
Ranabir ChakrabortyandGitHub bba9d8bb23 Merge pull request #380 from ansible-middleware/dependabot/github_actions/EndBug/add-and-commit-10
Bump EndBug/add-and-commit from 4 to 10
2026-08-12 21:01:55 +05:30
dependabot[bot]andGitHub 7a1dbad76f Bump EndBug/add-and-commit from 4 to 10
Bumps [EndBug/add-and-commit](https://github.com/endbug/add-and-commit) from 4 to 10.
- [Release notes](https://github.com/endbug/add-and-commit/releases)
- [Commits](https://github.com/endbug/add-and-commit/compare/v4...v10)

---
updated-dependencies:
- dependency-name: EndBug/add-and-commit
  dependency-version: '10'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-10 17:05:00 +00:00
dependabot[bot]andGitHub 50e1d93184 Bump actions/checkout from 2 to 7
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 7.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v2...v7)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-10 17:04:56 +00:00
Ranabir ChakrabortyandGitHub 786ef844f8 Merge pull request #378 from hcherukuri/main
Add certification checks to the upstream repo
2026-08-10 22:31:41 +05:30
Harsha Cherukuri 8d44d73394 Add certification checks to the upstream repo
Declare module Python requirement for certification sanity
2026-08-10 10:11:24 -04:00
Chris BrownandClaude Opus 4.6 c8253fdbf8 Add keycloak_organization and keycloak_organization_info modules
Keycloak 26 introduced Organizations as a stable feature for B2B
multi-tenancy within a single realm. This adds declarative Ansible
module support so organizations can be managed like other Keycloak
resources instead of requiring direct REST API calls.

New modules:
- keycloak_organization: CRUD for organizations with full check_mode,
  diff_mode, and idempotency support. Manages name, alias, description,
  enabled state, domains, and attributes.
- keycloak_organization_info: read-only module to list/search
  organizations by name with exact or partial matching.

Also adds 6 API methods to the KeycloakAPI class and comprehensive
Molecule integration tests covering create, idempotency, update,
info queries, attributes, and delete flows.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-08-07 07:26:58 +01:00
Thomas Bargetz 9abf2e832b 375 increase maximum of sub levels to 10 2026-07-30 12:56:51 +02:00
Harsha CherukuriandGitHub 9e5946a2a4 Merge pull request #373 from RanabirChakraborty/AMW-594
AMW-594 Upstream release is failing due to recent rules change
2026-07-28 13:21:08 -04:00
Ranabir Chakraborty ef2f24e9fc AMW-594 Upstream release is failing due to recent rules change 2026-07-28 21:28:35 +05:30
Harsha CherukuriandGitHub 866c5e2255 Merge pull request #371 from RISE-GmbH/368-avoid_pruning_of_undefined_realm_attributes
368 keycloak_realm: Control whether undefined realm attributes are pruned
2026-07-28 09:10:49 -04:00
Harsha CherukuriandGitHub a0b924b593 Merge pull request #372 from hcherukuri/main
Add community.general.keycloak_realm_users_info into keycloak collection
2026-07-28 08:46:31 -04:00
Thomas Bargetz 95c6fe1b50 386 add integration tests 2026-07-27 11:01:35 +02:00
9bb680b8e6 Update plugins/modules/keycloak_realm_users_info.py
Co-authored-by: Felix Fontein <felix@fontein.de>
2026-07-26 21:02:08 -04:00
Thomas Bargetz 1f0a7c289f 368 introduce the parameter prune_undefined_realm_attributes to control whether undefined realm attributes are pruned 2026-07-24 10:20:17 +02:00
Harsha Cherukuri ff51c4098a Add community.general.keycloak_realm_users_info into keycloak collection 2026-07-23 22:31:32 -04:00
Ranabir ChakrabortyandGitHub f2792e32ba Merge pull request #364 from cihlamar/AMW-299
Fix health check URL to include HTTP relative path
2026-07-22 19:49:44 +05:30
Martin Cihlar 4f62617f2c Fix health check URL to include HTTP relative path
- Include keycloak_quarkus_http_relative_path in health_url construction
- Use rstrip('/') to handle both default '/' and custom paths like '/auth'
- Replace hardcoded 'master' realm with keycloak_quarkus_master_realm variable
- Add keycloak_quarkus_validate_certs option for SSL certificate validation
- Update documentation in meta and README

Fixes #299
2026-07-22 11:24:57 +02:00
Harsha CherukuriandGitHub edb38ebb3d Merge pull request #366 from RanabirChakraborty/AMW-592
AMW-592 AMW Github Actions are failing because of latest molecule
2026-07-20 15:38:03 -04:00
Ranabir Chakraborty d25bf46a6a AMW-592 AMW Github Actions are failing because of latest molecule 2026-07-21 00:27:35 +05:30
Helmut WolfandGitHub 74ca1e05ef Merge pull request #363 from world-direct/fix/no_log-provider-secrets
fix(keycloak_quarkus): avoid leaking maven provider password in logs
2026-07-01 09:38:16 +02:00
Helmut WolfandClaude Opus 4.8 b9181abb24 fix(keycloak_quarkus): avoid leaking maven provider password in logs
The Validate providers / Download custom providers via http / Copy local
providers tasks loop over all providers and print the item (including
maven.password) in cleartext, even for skipped iterations. Add the same
conditional no_log the maven download/copy tasks already use so entries
carrying a secret are censored while url/local providers stay visible.

Refs ansible-middleware/keycloak#362

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-01 09:23:48 +02:00
Helmut WolfandGitHub d4eafe1b30 Merge pull request #361 from world-direct/fix/360
fix: fact renaming regression (store_items), closes #360
2026-06-30 08:35:09 +02:00
Helmut Wolf 19bd41a86a fix: fact renaming regression (store_items), closes #360 2026-06-30 08:15:48 +02:00
ansible-middleware-core b44d754b8c Bump version to 3.0.11 2026-06-25 12:29:55 +00:00
ansible-middleware-core 404d2f6a1b Update changelog for release 3.0.10
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-06-25 12:29:32 +00:00
Ranabir ChakrabortyandGitHub bfcb125d87 Merge pull request #359 from RanabirChakraborty/vars_fix
Fixing vars naming issue
2026-06-25 13:38:46 +05:30
Ranabir Chakraborty 1164bf008d Fixing vars naming issue 2026-06-25 12:32:49 +05:30
Ranabir ChakrabortyandGitHub f3353d1686 Merge pull request #358 from hcherukuri/main
Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors
2026-06-25 10:38:20 +05:30
Harsha Cherukuri e4c3ec8046 Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors. 2026-06-24 23:19:59 -04:00
Harsha Cherukuri 82022b9031 Replace from __future__ import annotations with the required future-import. 2026-06-24 23:19:59 -04:00
Harsha CherukuriandGitHub 0307985282 Merge pull request #356 from RanabirChakraborty/AMW-571
AMW-571 keycloak_identity_provider hide_on_login_page not working
2026-06-24 23:19:24 -04:00
Harsha CherukuriandGitHub b0d1114684 Merge pull request #357 from RanabirChakraborty/lint_issue_fix
Fixing linting issues
2026-06-24 23:18:59 -04:00
Ranabir Chakraborty 728d5288ec Fixing linting issues 2026-06-25 03:22:25 +05:30
Ranabir Chakraborty eaeedd8d74 AMW-571 keycloak_identity_provider hide_on_login_page not working 2026-06-23 22:43:37 +05:30
Harsha CherukuriandGitHub 86a6bc63bb Merge pull request #354 from RanabirChakraborty/remove_deprecate
Remove deprecated ansible-basic-sphinx-ext
2026-06-23 08:26:40 -04:00
Ranabir Chakraborty d557665dc9 Remove deprecated ansible-basic-sphinx-ext 2026-06-23 14:52:59 +05:30
Harsha CherukuriandGitHub bd82a85dea Merge pull request #353 from RanabirChakraborty/AMW-568
Fix downstream SSO collection errors
2026-06-20 15:43:59 -04:00
Ranabir Chakraborty 1f82f50127 Fix downstream SSO collection errors 2026-06-20 21:14:34 +05:30
Ranabir ChakrabortyandGitHub adf0f7fc36 Merge pull request #352 from RanabirChakraborty/fix_password
Fixing password
2026-06-20 13:02:14 +05:30
Ranabir Chakraborty 0a9e6c66eb Fixing password 2026-06-20 13:01:44 +05:30
ansible-middleware-core da3d5e0ed6 Bump version to 3.0.10 2026-06-11 15:16:22 +00:00
176 changed files with 4295 additions and 658 deletions
-2
View File
@@ -38,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
+88
View File
@@ -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
+8
View File
@@ -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
+25
View File
@@ -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@f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e # v4.1.0
+13 -1
View File
@@ -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" ]
+31
View File
@@ -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)}} }'
+1 -15
View File
@@ -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 }}
+2 -2
View File
@@ -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"
+3
View File
@@ -11,6 +11,9 @@ docs/_build/
.mypy_cache/
*.retry
changelogs/.plugin-cache.yaml
changelogs/fragments/*.yaml
changelogs/fragments/*.yml
*.pem
*.key
*.p12
+54
View File
@@ -6,6 +6,60 @@ middleware\_automation.keycloak Release Notes
This changelog describes changes after version 0.2.6.
v3.1.0
======
Minor Changes
-------------
- 369 add integration tests for keycloak_authentication_v2 `#374 <https://github.com/ansible-middleware/keycloak/pull/374>`_
- AMW-578 Replace deprecated community.general.yaml callback with result `#413 <https://github.com/ansible-middleware/keycloak/pull/413>`_
- AMW-615 Inconsistent support of authentication via client credentials `#400 <https://github.com/ansible-middleware/keycloak/pull/400>`_
- AMW-622 keycloak collection spelling and grammar checking for PRs `#406 <https://github.com/ansible-middleware/keycloak/pull/406>`_
- AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable Roles if invoker lacks view-realm Role `#411 <https://github.com/ansible-middleware/keycloak/pull/411>`_
- Add use_netrc option to prevent .netrc overriding bearer token `#408 <https://github.com/ansible-middleware/keycloak/pull/408>`_
- Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter `#404 <https://github.com/ansible-middleware/keycloak/pull/404>`_
- Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in `#414 <https://github.com/ansible-middleware/keycloak/pull/414>`_
- Fix issue #397 #398 crash on first role assignment `#405 <https://github.com/ansible-middleware/keycloak/pull/405>`_
- In a flow definition, handle non-existing keys correctly `#402 <https://github.com/ansible-middleware/keycloak/pull/402>`_
- Normalize hostname that includes http_relative_path suffix `#392 <https://github.com/ansible-middleware/keycloak/pull/392>`_
- Replace deprecated top-level fact variables with ansible_fact `#412 <https://github.com/ansible-middleware/keycloak/pull/412>`_
- authentication_v2: Fix validation for FormActions `#384 <https://github.com/ansible-middleware/keycloak/pull/384>`_
- keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 <https://github.com/ansible-middleware/keycloak/pull/407>`_
- keycloak_user: fix attributes always reporting changed=True `#399 <https://github.com/ansible-middleware/keycloak/pull/399>`_
v3.0.11
=======
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
======
+1 -1
View File
@@ -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
+4 -3
View File
@@ -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
```
+125
View File
@@ -674,6 +674,131 @@ 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.1.0:
changes:
minor_changes:
- '369 add integration tests for keycloak_authentication_v2 `#374 <https://github.com/ansible-middleware/keycloak/pull/374>`_
'
- 'AMW-578 Replace deprecated community.general.yaml callback with result `#413
<https://github.com/ansible-middleware/keycloak/pull/413>`_
'
- 'AMW-615 Inconsistent support of authentication via client credentials `#400
<https://github.com/ansible-middleware/keycloak/pull/400>`_
'
- 'AMW-622 keycloak collection spelling and grammar checking for PRs `#406 <https://github.com/ansible-middleware/keycloak/pull/406>`_
'
- 'AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable
Roles if invoker lacks view-realm Role `#411 <https://github.com/ansible-middleware/keycloak/pull/411>`_
'
- 'Add use_netrc option to prevent .netrc overriding bearer token `#408 <https://github.com/ansible-middleware/keycloak/pull/408>`_
'
- 'Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter
`#404 <https://github.com/ansible-middleware/keycloak/pull/404>`_
'
- 'Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified
mappers are merged in `#414 <https://github.com/ansible-middleware/keycloak/pull/414>`_
'
- 'Fix issue #397 #398 crash on first role assignment `#405 <https://github.com/ansible-middleware/keycloak/pull/405>`_
'
- 'In a flow definition, handle non-existing keys correctly `#402 <https://github.com/ansible-middleware/keycloak/pull/402>`_
'
- 'Normalize hostname that includes http_relative_path suffix `#392 <https://github.com/ansible-middleware/keycloak/pull/392>`_
'
- 'Replace deprecated top-level fact variables with ansible_fact `#412 <https://github.com/ansible-middleware/keycloak/pull/412>`_
'
- 'authentication_v2: Fix validation for FormActions `#384 <https://github.com/ansible-middleware/keycloak/pull/384>`_
'
- 'keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 <https://github.com/ansible-middleware/keycloak/pull/407>`_
'
- 'keycloak_user: fix attributes always reporting changed=True `#399 <https://github.com/ansible-middleware/keycloak/pull/399>`_
'
fragments:
- 374.yaml
- 384.yaml
- 392.yaml
- 399.yaml
- 400.yaml
- 402.yaml
- 404.yaml
- 405.yaml
- 406.yaml
- 407.yaml
- 408.yaml
- 411.yaml
- 412.yaml
- 413.yaml
- 414.yaml
release_date: '2026-09-11'
3.0.2:
changes:
bugfixes:
-2
View File
@@ -1,2 +0,0 @@
*
!.gitignore
+59
View File
@@ -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"
]
}
-1
View File
@@ -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.
-3
View File
@@ -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
View File
@@ -1,11 +1,12 @@
---
namespace: middleware_automation
name: keycloak
version: "3.0.9"
version: "3.1.0"
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>
+22
View File
@@ -0,0 +1,22 @@
v3.1.0
======
Minor Changes
-------------
- 369 add integration tests for keycloak_authentication_v2 #374
- AMW-578 Replace deprecated community.general.yaml callback with result #413
- AMW-615 Inconsistent support of authentication via client credentials #400
- AMW-622 keycloak collection spelling and grammar checking for PRs #406
- AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable Roles if invoker lacks view-realm Role #411
- Add use_netrc option to prevent .netrc overriding bearer token #408
- Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter #404
- Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in #414
- Fix issue #397 #398 crash on first role assignment #405
- In a flow definition, handle non-existing keys correctly #402
- Normalize hostname that includes http_relative_path suffix #392
- Replace deprecated top-level fact variables with ansible_fact #412
- authentication_v2: Fix validation for FormActions #384
- keycloak_group: fix subgroup lookup on Keycloak older than 25 #407
- keycloak_user: fix attributes always reporting changed=True #399
+3
View File
@@ -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
+13 -13
View File
@@ -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'
+1 -1
View File
@@ -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"
+13 -13
View File
@@ -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 -1
View File
@@ -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"
+1
View File
@@ -23,6 +23,7 @@
url: https://github.com/keycloak/keycloak/releases/download/26.6.2/keycloak-26.6.2.zip
dest: /tmp/keycloak
mode: '0640'
validate_certs: false
delegate_to: localhost
run_once: true
ignore_errors: true
+5
View File
@@ -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) }}"
+1 -2
View File
@@ -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
+2 -2
View File
@@ -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
@@ -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"
@@ -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"
@@ -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
@@ -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
@@ -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') }}"
@@ -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
@@ -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') }}"
@@ -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"
@@ -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
@@ -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
@@ -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
@@ -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 -1
View File
@@ -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"
+415 -14
View File
@@ -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
@@ -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 }}"
@@ -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,6 +627,61 @@
roles:
- name: "{{ client_role }}"
- name: keycloak_group — create subgroup below the parent group
middleware_automation.keycloak.keycloak_group:
realm: "{{ target_realm }}"
name: "{{ subgroup }}"
parents:
- name: "{{ group }}"
state: present
register: subgroup_result
- name: Assert subgroup was created below the parent group
ansible.builtin.assert:
that:
- subgroup_result is changed
- subgroup_result.end_state.path == '/' ~ group ~ '/' ~ subgroup
- name: keycloak_group — create enough siblings to exceed the children page size
middleware_automation.keycloak.keycloak_group:
realm: "{{ target_realm }}"
name: "{{ subgroup }}-{{ item }}"
parents:
- name: "{{ group }}"
state: present
loop: "{{ range(1, 13) | list }}"
- name: keycloak_group — look up a subgroup sorting past the children page size
middleware_automation.keycloak.keycloak_group:
realm: "{{ target_realm }}"
name: "{{ subgroup }}-9"
parents:
- name: "{{ group }}"
state: present
register: subgroup_paging_result
- name: Assert subgroup lookup is not limited to the first page of children
ansible.builtin.assert:
that:
- subgroup_paging_result is not changed
- subgroup_paging_result.end_state.path == '/' ~ group ~ '/' ~ subgroup ~ '-9'
- name: keycloak_realm_rolemapping — assign realm role to subgroup via parents
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ target_realm }}"
group_name: "{{ subgroup }}"
parents:
- name: "{{ group }}"
state: present
roles:
- name: "{{ role }}"
register: subgroup_rolemapping_result
- name: Assert realm role was mapped to the subgroup
ansible.builtin.assert:
that:
- subgroup_rolemapping_result is changed
- name: keycloak_client_rolescope — restrict realm role on client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ target_realm }}"
@@ -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:
@@ -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 }}"
+49
View File
@@ -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
+1
View File
@@ -0,0 +1 @@
../../roles
+64
View File
@@ -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
-2
View File
@@ -4,8 +4,6 @@
vars_files:
- ../group_vars/all/vars.yml
vars:
rhn_username: "{{ lookup('env', 'rhn_username') | default('4278e994-7f90-46eb-b99c-90f2815b845f', true) }}"
rhn_password: "{{ lookup('env', 'rhn_password') | default('AHOLJo08ursGdWVm0F66iDR5Owk0CwpL', true) }}"
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_admin_password: "remembertochangeme"
keycloak_quarkus_hostname: "http://instance:8080"
+1 -1
View File
@@ -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"
+1 -1
View File
@@ -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
+16 -16
View File
@@ -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
@@ -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
+1 -1
View File
@@ -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"
+16 -16
View File
@@ -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 -1
View File
@@ -7,7 +7,7 @@ platforms:
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
port_bindings:
exposed_ports:
- "8080/tcp"
- "8009/tcp"
- "9000/tcp"
+3 -3
View File
@@ -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
+3 -3
View File
@@ -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
+3 -3
View File
@@ -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
+21
View File
@@ -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
+50
View File
@@ -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
+29
View File
@@ -0,0 +1,29 @@
---
- name: Prepare
hosts: all
vars_files:
- ../group_vars/all/vars.yml
gather_facts: yes
vars:
sudo_pkg_name: sudo
tasks:
- name: "Run preparation common to all scenario"
ansible.builtin.include_tasks: ../prepare.yml
- name: Create controller directory for downloads
ansible.builtin.file: # noqa risky-file-permissions delegated, uses controller host user
path: /tmp/keycloak
state: directory
mode: '0750'
delegate_to: localhost
run_once: true
- name: Download keycloak archive to controller directory
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
url: https://github.com/keycloak/keycloak/releases/download/26.6.2/keycloak-26.6.2.zip
dest: /tmp/keycloak
mode: '0640'
validate_certs: false
delegate_to: localhost
run_once: true
ignore_errors: true
+1
View File
@@ -0,0 +1 @@
../../roles
+24
View File
@@ -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
+2 -2
View File
@@ -11,8 +11,8 @@ platforms:
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
+22
View File
@@ -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
+32
View File
@@ -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
+11
View File
@@ -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
+78
View File
@@ -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 -6
View File
@@ -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 }}"
+3 -3
View File
@@ -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
+7 -7
View File
@@ -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
+1
View File
@@ -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
+9
View File
@@ -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
@@ -2,7 +2,9 @@
# BSD 2-Clause license (see LICENSES/BSD-2-Clause.txt)
# SPDX-License-Identifier: BSD-2-Clause
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
import copy
import json
@@ -107,6 +109,8 @@ URL_REALM_GROUP_ROLEMAPPINGS = "{url}/admin/realms/{realm}/groups/{group}/role-m
URL_CLIENTSECRET = "{url}/admin/realms/{realm}/clients/{id}/client-secret"
URL_AUTHENTICATION_AUTHENTICATOR_PROVIDERS = "{url}/admin/realms/{realm}/authentication/authenticator-providers"
URL_AUTHENTICATION_CLIENT_AUTHENTICATOR_PROVIDERS = "{url}/admin/realms/{realm}/authentication/client-authenticator-providers"
URL_AUTHENTICATION_FORM_ACTION_PROVIDERS = "{url}/admin/realms/{realm}/authentication/form-action-providers"
URL_AUTHENTICATION_FLOWS = "{url}/admin/realms/{realm}/authentication/flows"
URL_AUTHENTICATION_FLOW = "{url}/admin/realms/{realm}/authentication/flows/{id}"
URL_AUTHENTICATION_FLOW_COPY = "{url}/admin/realms/{realm}/authentication/flows/{copyfrom}/copy"
@@ -153,6 +157,9 @@ URL_AUTHZ_RESOURCES = "{url}/admin/realms/{realm}/clients/{client_id}/authz/reso
URL_AUTHZ_CUSTOM_POLICY = "{url}/admin/realms/{realm}/clients/{client_id}/authz/resource-server/policy/{policy_type}"
URL_AUTHZ_CUSTOM_POLICIES = "{url}/admin/realms/{realm}/clients/{client_id}/authz/resource-server/policy"
URL_ORGANIZATIONS = "{url}/admin/realms/{realm}/organizations"
URL_ORGANIZATION = "{url}/admin/realms/{realm}/organizations/{id}"
def keycloak_argument_spec() -> dict[str, t.Any]:
"""
@@ -172,6 +179,7 @@ def keycloak_argument_spec() -> dict[str, t.Any]:
token=dict(type="str", no_log=True),
refresh_token=dict(type="str", no_log=True),
http_agent=dict(type="str", default="Ansible"),
use_netrc=dict(type="bool", default=False),
)
@@ -211,6 +219,7 @@ def _token_request(module_params: dict[str, t.Any], payload: dict[str, t.Any]) -
http_agent = module_params.get("http_agent")
validate_certs = module_params.get("validate_certs")
connection_timeout = module_params.get("connection_timeout")
use_netrc = module_params.get("use_netrc", False)
try:
r = json.loads(
@@ -221,6 +230,7 @@ def _token_request(module_params: dict[str, t.Any], payload: dict[str, t.Any]) -
http_agent=http_agent,
timeout=connection_timeout,
data=urlencode(payload),
use_netrc=use_netrc,
).read()
)
@@ -396,6 +406,7 @@ class KeycloakAPI:
self.connection_timeout = self.module.params.get("connection_timeout")
self.restheaders = connection_header
self.http_agent = self.module.params.get("http_agent")
self.use_netrc = self.module.params.get("use_netrc", False)
def _request(
self, url: str, method: str, data: str | bytes | None = None, *, extra_headers: dict[str, str] | None = None
@@ -424,6 +435,7 @@ class KeycloakAPI:
headers=headers,
timeout=self.connection_timeout,
validate_certs=self.validate_certs,
use_netrc=self.use_netrc,
)
except HTTPError as e:
if e.code != HTTPStatus.UNAUTHORIZED:
@@ -1106,6 +1118,22 @@ class KeycloakAPI:
except Exception as e:
self.fail_request(e, msg=f"Could not obtain the user for realm {realm} and username {username}: {e}")
def get_realm_users(self, realm: str = "master") -> list[dict[str, t.Any]]:
"""Obtain list of users from the realm
:param realm: realm id
:return: list of user representations
"""
users_url = URL_USERS.format(url=self.baseurl, realm=realm)
try:
return self._request_and_deserialize(users_url, method="GET")
except ValueError as e:
self.module.fail_json(
msg=f"API returned incorrect JSON when trying to obtain the users for realm {realm}: {e}"
)
except Exception as e:
self.fail_request(e, msg=f"Could not obtain the users for realm {realm}: {e}")
def get_service_account_user_by_client_id(self, client_id, realm: str = "master"):
"""Fetch a keycloak service account user within a realm based on its client_id.
@@ -1710,7 +1738,15 @@ class KeycloakAPI:
except Exception as e:
self.module.fail_json(msg=f"Could not fetch group {gid} in realm {realm}: {e}")
def get_subgroups(self, parent, realm: str = "master"):
def get_subgroups(self, parent, realm: str = "master", search=None):
"""Fetch the direct subgroups of a group.
:param parent: GroupRepresentation of the parent group
:param realm: Realm in which the group resides; default "master"
:param search: Optional group name, letting the server narrow the result
down. This is a hint only: servers which do not support searching
return all subgroups, so callers must still match names themselves.
"""
if "subGroupCount" in parent:
# Since version 23, when GETting a group Keycloak does not
# return subGroups but only a subGroupCount.
@@ -1719,9 +1755,17 @@ class KeycloakAPI:
group_children = []
else:
group_children_url = f"{URL_GROUP_CHILDREN.format(url=self.baseurl, realm=realm, groupid=parent['id'])}?max={parent['subGroupCount']}"
if search is not None:
# search/exact are only honoured from version 25 on, 23 and 24
# silently ignore them, which is why max is always sent as the
# full child count.
group_children_url += f"&search={quote(search, safe='')}&exact=true"
group_children = self._request_and_deserialize(group_children_url, method="GET")
subgroups = group_children
else:
# Before version 23 the children endpoint has no GET method at all
# (it answers 405 Method Not Allowed), the subgroups are inlined in
# the parent representation instead.
subgroups = parent["subGroups"]
return subgroups
@@ -1729,7 +1773,8 @@ class KeycloakAPI:
"""Fetch a keycloak group within a realm based on its name.
Uses the Keycloak search API with exact matching for efficient lookup
instead of fetching all groups.
instead of fetching all groups. Servers which do not support searching
are handled transparently, see the comments below.
If the group does not exist, None is returned.
:param name: Name of the group to fetch.
@@ -1743,18 +1788,18 @@ class KeycloakAPI:
if not parent:
return None
# For subgroups: use children endpoint with search parameter
search_url = "{url}?search={name}&exact=true".format(
url=URL_GROUP_CHILDREN.format(url=self.baseurl, realm=realm, groupid=parent["id"]),
name=quote(name, safe=""),
)
# For subgroups: search the parent's children where the server
# supports it. get_subgroups knows which servers those are, the
# exact name check below covers the ones which do not.
groups = self.get_subgroups(parent, realm, search=name)
else:
# For top-level groups: use groups endpoint with search parameter
# For top-level groups: use groups endpoint with search parameter.
# exact was only added in version 20; older servers ignore it and return
# substring matches, which the exact name check below sorts out.
search_url = "{url}?search={name}&exact=true".format(
url=URL_GROUPS.format(url=self.baseurl, realm=realm), name=quote(name, safe="")
)
groups = self._request_and_deserialize(search_url, method="GET")
groups = self._request_and_deserialize(search_url, method="GET")
# exact=true should return only exact matches, but verify the name
for group in groups:
@@ -2273,6 +2318,32 @@ class KeycloakAPI:
except Exception as e:
self.fail_request(e, msg=f"Unable get authenticator providers in realm {realm}: {e}")
def get_client_authenticator_providers(self, realm: str = "master"):
"""
Get all available client authenticator providers of the realm.
:param realm: Realm.
:return: List of client authenticator provider representations.
"""
try:
return self._request_and_deserialize(
URL_AUTHENTICATION_CLIENT_AUTHENTICATOR_PROVIDERS.format(url=self.baseurl, realm=realm), method="GET"
)
except Exception as e:
self.fail_request(e, msg=f"Unable get client authenticator providers in realm {realm}: {e}")
def get_form_action_providers(self, realm: str = "master"):
"""
Get all available form action providers of the realm.
:param realm: Realm.
:return: List of form action provider representations.
"""
try:
return self._request_and_deserialize(
URL_AUTHENTICATION_FORM_ACTION_PROVIDERS.format(url=self.baseurl, realm=realm), method="GET"
)
except Exception as e:
self.fail_request(e, msg=f"Unable get form action providers in realm {realm}: {e}")
def get_authentication_flow_by_alias(self, alias, realm: str = "master"):
"""
Get an authentication flow by its alias
@@ -3490,6 +3561,92 @@ class KeycloakAPI:
return self.get_client_role_scope_from_realm(clientid, realm)
def get_organizations(self, search_filter=None, realm: str = "master"):
"""Fetch representations for organizations in a realm.
:param search_filter: Optional query string to append (e.g. 'search=foo&exact=true').
:param realm: Realm to be queried; default 'master'.
:return: List of organization representations.
"""
orgs_url = URL_ORGANIZATIONS.format(url=self.baseurl, realm=realm)
if search_filter:
orgs_url = f"{orgs_url}?{search_filter}"
try:
return self._request_and_deserialize(orgs_url, method="GET")
except ValueError as e:
self.module.fail_json(
msg=f"API returned incorrect JSON when trying to obtain list of organizations for realm {realm}: {e}"
)
except Exception as e:
self.fail_request(e, msg=f"Could not obtain list of organizations for realm {realm}: {e}")
def get_organization_by_id(self, org_id, realm: str = "master"):
"""Fetch an organization by its UUID.
If the organization does not exist, None is returned.
:param org_id: UUID of the organization to fetch.
:param realm: Realm in which the organization resides; default 'master'.
"""
org_url = URL_ORGANIZATION.format(url=self.baseurl, realm=realm, id=org_id)
try:
return self._request_and_deserialize(org_url, method="GET")
except HTTPError as e:
if e.code == HTTPStatus.NOT_FOUND:
return None
else:
self.fail_request(e, msg=f"Could not fetch organization {org_id} in realm {realm}: {e}")
except Exception as e:
self.fail_request(e, msg=f"Could not fetch organization {org_id} in realm {realm}: {e}")
def get_organization_by_name(self, name, realm: str = "master"):
"""Fetch an organization by name using search API with exact matching.
Returns the full representation (fetched by ID) or None if not found.
:param name: Name of the organization to fetch.
:param realm: Realm in which the organization resides; default 'master'.
"""
search_url = URL_ORGANIZATIONS.format(url=self.baseurl, realm=realm)
search_url = f"{search_url}?search={quote(name, safe='')}&exact=true"
try:
orgs = self._request_and_deserialize(search_url, method="GET")
if not orgs:
return None
return self.get_organization_by_id(orgs[0]["id"], realm=realm)
except Exception as e:
self.fail_request(e, msg=f"Could not fetch organization {name} in realm {realm}: {e}")
def create_organization(self, orgrep, realm: str = "master"):
"""Create an organization.
:param orgrep: Organization representation of the organization to be created.
:param realm: Realm in which this organization resides, default "master".
:return: HTTPResponse object on success.
"""
orgs_url = URL_ORGANIZATIONS.format(url=self.baseurl, realm=realm)
try:
return self._request(orgs_url, method="POST", data=json.dumps(orgrep))
except Exception as e:
self.fail_request(e, msg=f"Could not create organization {orgrep.get('name')} in realm {realm}: {e}")
def update_organization(self, orgrep, realm: str = "master"):
"""Update an existing organization.
:param orgrep: Organization representation of the organization to be updated.
:param realm: Realm in which this organization resides, default "master".
:return: HTTPResponse object on success.
"""
org_url = URL_ORGANIZATION.format(url=self.baseurl, realm=realm, id=orgrep["id"])
try:
return self._request(org_url, method="PUT", data=json.dumps(orgrep))
except Exception as e:
self.fail_request(e, msg=f"Could not update organization {orgrep.get('name')} in realm {realm}: {e}")
def delete_organization(self, org_id, realm: str = "master"):
"""Delete an organization by UUID.
:param org_id: UUID of the organization to delete.
:param realm: Realm in which this organization resides, default "master".
"""
org_url = URL_ORGANIZATION.format(url=self.baseurl, realm=realm, id=org_id)
try:
return self._request(org_url, method="DELETE")
except Exception as e:
self.fail_request(e, msg=f"Could not delete organization {org_id} in realm {realm}: {e}")
def fail_request(self, e: Exception, msg: str, **kwargs: t.Any) -> t.NoReturn:
"""Triggers a module failure. This should be called
when an exception occurs during/after a request.
@@ -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
@@ -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
+288 -26
View File
@@ -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
+2
View File
@@ -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
+14 -7
View File
@@ -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
+10 -3
View File
@@ -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={})
@@ -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_scope_rolemappings
@@ -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_scope_type
@@ -3,7 +3,9 @@
# GNU General Public License v3.0+ (see COPYING 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_clientsecret_info
@@ -3,7 +3,9 @@
# GNU General Public License v3.0+ (see COPYING 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_clientsecret_regenerate
@@ -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_clienttemplate

Some files were not shown because too many files have changed in this diff Show More