From 114eb67f58826e38b9be5ea2a36590a14369e4b7 Mon Sep 17 00:00:00 2001 From: fachleitner Date: Sat, 22 Apr 2023 22:55:56 +0200 Subject: [PATCH] keycloak: Add option to create authentication sub-flow of type 'form flow' (#6318) * keycloak: Improve API error message * keycloak: Fix API error message They key 'provider' is undefined. * keycloak: Allow the creation of 'form-flow' authentication sub flows To create something like keycloak's built-in registration flow, we need to create a subflow with the type 'form-flow'. * Add changelog fragment 6318 * Update changelogs/fragments/6318-add-form-flow.yml Co-authored-by: Felix Fontein * Update plugins/modules/keycloak_authentication.py Co-authored-by: Felix Fontein * Update plugins/modules/keycloak_authentication.py Co-authored-by: Felix Fontein * keycloak_authentication: Don't compare subFlowType It is only useful for creation. * Update changelogs/fragments/6318-add-form-flow.yml Co-authored-by: Felix Fontein --------- Co-authored-by: Felix Fontein --- changelogs/fragments/6318-add-form-flow.yml | 5 +++++ .../module_utils/identity/keycloak/keycloak.py | 12 +++++++++--- plugins/modules/keycloak_authentication.py | 15 ++++++++++++--- 3 files changed, 26 insertions(+), 6 deletions(-) create mode 100644 changelogs/fragments/6318-add-form-flow.yml diff --git a/changelogs/fragments/6318-add-form-flow.yml b/changelogs/fragments/6318-add-form-flow.yml new file mode 100644 index 0000000000..db567f4faf --- /dev/null +++ b/changelogs/fragments/6318-add-form-flow.yml @@ -0,0 +1,5 @@ +bugfixes: + - "keycloak - improve error messages (https://github.com/ansible-collections/community.general/pull/6318)." + +minor_changes: + - "keycloak_authentication - add flow type option to sub flows to allow the creation of 'form-flow' sub flows like in Keycloak's built-in registration flow (https://github.com/ansible-collections/community.general/pull/6318)." diff --git a/plugins/module_utils/identity/keycloak/keycloak.py b/plugins/module_utils/identity/keycloak/keycloak.py index c22ed21cd5..8be36333e6 100644 --- a/plugins/module_utils/identity/keycloak/keycloak.py +++ b/plugins/module_utils/identity/keycloak/keycloak.py @@ -1930,6 +1930,9 @@ class KeycloakAPI(object): data=json.dumps(updatedExec), timeout=self.connection_timeout, validate_certs=self.validate_certs) + except HTTPError as e: + self.module.fail_json(msg="Unable to update execution '%s': %s: %s %s" % + (flowAlias, repr(e), ";".join([e.url, e.msg, str(e.code), str(e.hdrs)]), str(updatedExec))) except Exception as e: self.module.fail_json(msg="Unable to update executions %s: %s" % (updatedExec, str(e))) @@ -1954,7 +1957,7 @@ class KeycloakAPI(object): except Exception as e: self.module.fail_json(msg="Unable to add authenticationConfig %s: %s" % (executionId, str(e))) - def create_subflow(self, subflowName, flowAlias, realm='master'): + def create_subflow(self, subflowName, flowAlias, realm='master', flowType='basic-flow'): """ Create new sublow on the flow :param subflowName: name of the subflow to create @@ -1965,7 +1968,7 @@ class KeycloakAPI(object): newSubFlow = {} newSubFlow["alias"] = subflowName newSubFlow["provider"] = "registration-page-form" - newSubFlow["type"] = "basic-flow" + newSubFlow["type"] = flowType open_url( URL_AUTHENTICATION_FLOW_EXECUTIONS_FLOW.format( url=self.baseurl, @@ -2000,8 +2003,11 @@ class KeycloakAPI(object): data=json.dumps(newExec), timeout=self.connection_timeout, validate_certs=self.validate_certs) + except HTTPError as e: + self.module.fail_json(msg="Unable to create new execution '%s' %s: %s: %s %s" % + (flowAlias, execution["providerId"], repr(e), ";".join([e.url, e.msg, str(e.code), str(e.hdrs)]), str(newExec))) except Exception as e: - self.module.fail_json(msg="Unable to create new execution %s: %s" % (execution["provider"], str(e))) + self.module.fail_json(msg="Unable to create new execution '%s' %s: %s" % (flowAlias, execution["providerId"], repr(e))) def change_execution_priority(self, executionId, diff, realm='master'): """ Raise or lower execution priority of diff time diff --git a/plugins/modules/keycloak_authentication.py b/plugins/modules/keycloak_authentication.py index 5db9bc9318..6143d9d5cd 100644 --- a/plugins/modules/keycloak_authentication.py +++ b/plugins/modules/keycloak_authentication.py @@ -79,6 +79,14 @@ options: description: - Priority order of the execution. type: int + subFlowType: + description: + - For new subflows, optionally specify the type. + - Is only used at creation. + choices: ["basic-flow", "form-flow"] + default: "basic-flow" + type: str + version_added: 6.6.0 state: description: - Control if the authentication flow must exists or not. @@ -264,7 +272,7 @@ def create_or_update_executions(kc, config, realm='master'): exec_index = find_exec_in_executions(new_exec, existing_executions) if exec_index != -1: # Remove key that doesn't need to be compared with existing_exec - exclude_key = ["flowAlias"] + exclude_key = ["flowAlias", "subFlowType"] for index_key, key in enumerate(new_exec, start=0): if new_exec[key] is None: exclude_key.append(key) @@ -282,7 +290,7 @@ def create_or_update_executions(kc, config, realm='master'): id_to_update = kc.get_executions_representation(config, realm=realm)[exec_index]["id"] after += str(new_exec) + '\n' elif new_exec["displayName"] is not None: - kc.create_subflow(new_exec["displayName"], flow_alias_parent, realm=realm) + kc.create_subflow(new_exec["displayName"], flow_alias_parent, realm=realm, flowType=new_exec["subFlowType"]) exec_found = True exec_index = new_exec_index id_to_update = kc.get_executions_representation(config, realm=realm)[exec_index]["id"] @@ -299,7 +307,7 @@ def create_or_update_executions(kc, config, realm='master'): kc.add_authenticationConfig_to_execution(updated_exec["id"], new_exec["authenticationConfig"], realm=realm) for key in new_exec: # remove unwanted key for the next API call - if key != "flowAlias" and key != "authenticationConfig": + if key not in ("flowAlias", "authenticationConfig", "subFlowType"): updated_exec[key] = new_exec[key] if new_exec["requirement"] is not None: kc.update_authentication_executions(flow_alias_parent, updated_exec, realm=realm) @@ -334,6 +342,7 @@ def main(): flowAlias=dict(type='str'), authenticationConfig=dict(type='dict'), index=dict(type='int'), + subFlowType=dict(choices=["basic-flow", "form-flow"], default='basic-flow', type='str'), )), state=dict(choices=["absent", "present"], default='present'), force=dict(type='bool', default=False),