diff --git a/README-selfservice.md b/README-selfservice.md
new file mode 100644
index 0000000000000000000000000000000000000000..ae6a8a3e4313e3f301460466c06e39d0d8969628
--- /dev/null
+++ b/README-selfservice.md
@@ -0,0 +1,151 @@
+Selfservice module
+=================
+
+Description
+-----------
+
+The selfservice module allows to ensure presence, absence of selfservices and selfservice attributes.
+
+
+Features
+--------
+
+* Selfservice management
+
+
+Supported FreeIPA Versions
+--------------------------
+
+FreeIPA versions 4.4.0 and up are supported by the ipaselfservice module.
+
+
+Requirements
+------------
+
+**Controller**
+* Ansible version: 2.8+
+
+**Node**
+* Supported FreeIPA version (see above)
+
+
+Usage
+=====
+
+Example inventory file
+
+```ini
+[ipaserver]
+ipaserver.test.local
+```
+
+
+Example playbook to make sure selfservice "Users can manage their own name details" is present:
+
+```yaml
+---
+- name: Playbook to manage IPA selfservice.
+ hosts: ipaserver
+ become: yes
+
+ tasks:
+ - ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ permission: read
+ attribute:
+ - title
+ - initials
+```
+
+
+Example playbook to make sure selfservice "Users can manage their own name details" is absent:
+
+```yaml
+---
+- name: Playbook to manage IPA selfservice.
+ hosts: ipaserver
+ become: yes
+
+ tasks:
+ - ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ state: absent
+```
+
+
+Example playbook to make sure "Users can manage their own name details" member attribute initials is present:
+
+```yaml
+---
+- name: Playbook to manage IPA selfservice.
+ hosts: ipaserver
+ become: yes
+
+ tasks:
+ - ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ attribute:
+ - initials
+ action: member
+```
+
+
+Example playbook to make sure "Users can manage their own name details" member attribute initials is absent:
+
+```yaml
+---
+- name: Playbook to manage IPA selfservice.
+ hosts: ipaserver
+ become: yes
+
+ tasks:
+ - ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ attribute:
+ - initials
+ action: member
+ state: absent
+```
+
+
+Example playbook to make sure selfservice "Users can manage their own name details" is absent:
+
+```yaml
+---
+- name: Playbook to manage IPA selfservice.
+ hosts: ipaserver
+ become: yes
+
+ tasks:
+ - ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ state: absent
+```
+
+
+Variables
+---------
+
+ipaselfservice
+-------
+
+Variable | Description | Required
+-------- | ----------- | --------
+`ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no
+`ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no
+`name` \| `aciname` | The list of selfservice name strings. | yes
+`permission` \| `permissions` | The permission to grant `read`, `read,write`, `write`]. Default is `write`. | no
+`attribute` \| `attrs` | The attribute list to which the selfservice applies. | no
+`action` | Work on selfservice or member level. It can be on of `member` or `selfservice` and defaults to `selfservice`. | no
+`state` | The state to ensure. It can be one of `present`, `absent`, default: `present`. | no
+
+
+Authors
+=======
+
+Thomas Woerner
diff --git a/playbooks/selfservice/selfservice-absent.yml b/playbooks/selfservice/selfservice-absent.yml
new file mode 100644
index 0000000000000000000000000000000000000000..7a1b02b5a17f28df8d7a855f3949c8318cf255ff
--- /dev/null
+++ b/playbooks/selfservice/selfservice-absent.yml
@@ -0,0 +1,11 @@
+---
+- name: Delegation absent
+ hosts: ipaserver
+ become: true
+
+ tasks:
+ - name: Ensure delegation "basic manager attributes" is absent
+ ipadelegation:
+ ipaadmin_password: SomeADMINpassword
+ name: "basic manager attributes"
+ state: absent
diff --git a/playbooks/selfservice/selfservice-member-absent.yml b/playbooks/selfservice/selfservice-member-absent.yml
new file mode 100644
index 0000000000000000000000000000000000000000..61d0d34a9992dcb8819988b75e2a1b4ac4f254cb
--- /dev/null
+++ b/playbooks/selfservice/selfservice-member-absent.yml
@@ -0,0 +1,15 @@
+---
+- name: Delegation member absent
+ hosts: ipaserver
+ become: true
+
+ tasks:
+ - name: Ensure delegation "basic manager attributes" member attributes employeenumber and employeetype are absent
+ ipadelegation:
+ ipaadmin_password: SomeADMINpassword
+ name: "basic manager attributes"
+ attribute:
+ - employeenumber
+ - employeetype
+ action: member
+ state: absent
diff --git a/playbooks/selfservice/selfservice-member-present.yml b/playbooks/selfservice/selfservice-member-present.yml
new file mode 100644
index 0000000000000000000000000000000000000000..1d5c1180cbe921f80dd4ff9befc218d8114f19f8
--- /dev/null
+++ b/playbooks/selfservice/selfservice-member-present.yml
@@ -0,0 +1,13 @@
+---
+- name: Delegation member present
+ hosts: ipaserver
+ become: true
+
+ tasks:
+ - name: Ensure delegation "basic manager attributes" member attribute departmentnumber is present
+ ipadelegation:
+ ipaadmin_password: SomeADMINpassword
+ name: "basic manager attributes"
+ attribute:
+ - departmentnumber
+ action: member
diff --git a/playbooks/selfservice/selfservice-present.yml b/playbooks/selfservice/selfservice-present.yml
new file mode 100644
index 0000000000000000000000000000000000000000..755a5a90e4a37fa319d39c1647ddd1d2bbab4854
--- /dev/null
+++ b/playbooks/selfservice/selfservice-present.yml
@@ -0,0 +1,13 @@
+---
+- name: Delegation present
+ hosts: ipaserver
+ become: true
+
+ tasks:
+ - name: Ensure delegation "basic manager attributes" is present
+ ipadelegation:
+ ipaadmin_password: SomeADMINpassword
+ name: "basic manager attributes"
+ permission: read
+ attribute:
+ - businesscategory
diff --git a/plugins/modules/ipaselfservice.py b/plugins/modules/ipaselfservice.py
new file mode 100644
index 0000000000000000000000000000000000000000..9a900bd39fe619d728051efd095e4561b6ddff9b
--- /dev/null
+++ b/plugins/modules/ipaselfservice.py
@@ -0,0 +1,323 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Authors:
+# Thomas Woerner <twoerner@redhat.com>
+#
+# Copyright (C) 2020 Red Hat
+# see file 'COPYING' for use and warranty information
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ANSIBLE_METADATA = {
+ "metadata_version": "1.0",
+ "supported_by": "community",
+ "status": ["preview"],
+}
+
+DOCUMENTATION = """
+---
+module: ipaselfservice
+short description: Manage FreeIPA selfservices
+description: Manage FreeIPA selfservices and selfservice attributes
+options:
+ ipaadmin_principal:
+ description: The admin principal.
+ default: admin
+ ipaadmin_password:
+ description: The admin password.
+ required: false
+ name:
+ description: The list of selfservice name strings.
+ required: true
+ aliases: ["aciname"]
+ permission:
+ description: Permissions to grant (read, write). Default is write.
+ required: false
+ aliases: ["permissions"]
+ attribute:
+ description: Attribute list to which the selfservice applies
+ required: false
+ aliases: ["attrs"]
+ action:
+ description: Work on selfservice or member level.
+ choices: ["selfservice", "member"]
+ default: selfservice
+ required: false
+ state:
+ description: The state to ensure.
+ choices: ["present", "absent"]
+ default: present
+ required: true
+"""
+
+EXAMPLES = """
+# Ensure selfservice "Users can manage their own name details" is present
+- ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ permission: read
+ attribute:
+ - title
+ - initials
+
+# Ensure selfservice "Users can manage their own name details" member
+# attribute departmentnumber is present
+- ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ attribute:
+ - initials
+ action: member
+
+# Ensure selfservice "Users can manage their own name details" member
+# attributes employeetype and employeenumber are present
+- ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ attribute:
+ - title
+ - initials
+ action: member
+ state: absent
+
+# Ensure selfservice "Users can manage their own name details" is absent
+- ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ state: absent
+"""
+
+RETURN = """
+"""
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.ansible_freeipa_module import \
+ temp_kinit, temp_kdestroy, valid_creds, api_connect, api_command, \
+ compare_args_ipa, module_params_get
+import six
+
+
+if six.PY3:
+ unicode = str
+
+
+def find_selfservice(module, name):
+ """Find if a selfservice with the given name already exist."""
+ try:
+ _result = api_command(module, "selfservice_show", name, {"all": True})
+ except Exception: # pylint: disable=broad-except
+ # An exception is raised if selfservice name is not found.
+ return None
+ else:
+ return _result["result"]
+
+
+def gen_args(permission, attribute):
+ _args = {}
+ if permission is not None:
+ _args["permissions"] = permission
+ if attribute is not None:
+ _args["attrs"] = attribute
+ return _args
+
+
+def main():
+ ansible_module = AnsibleModule(
+ argument_spec=dict(
+ # general
+ ipaadmin_principal=dict(type="str", default="admin"),
+ ipaadmin_password=dict(type="str", required=False, no_log=True),
+
+ name=dict(type="list", aliases=["aciname"], default=None,
+ required=True),
+ # present
+ permission=dict(required=False, type='list',
+ aliases=["permissions"], default=None),
+ attribute=dict(required=False, type='list', aliases=["attrs"],
+ default=None),
+ action=dict(type="str", default="selfservice",
+ choices=["member", "selfservice"]),
+ # state
+ state=dict(type="str", default="present",
+ choices=["present", "absent"]),
+ ),
+ supports_check_mode=True,
+ )
+
+ ansible_module._ansible_debug = True
+
+ # Get parameters
+
+ # general
+ ipaadmin_principal = module_params_get(ansible_module,
+ "ipaadmin_principal")
+ ipaadmin_password = module_params_get(ansible_module, "ipaadmin_password")
+ names = module_params_get(ansible_module, "name")
+
+ # present
+ permission = module_params_get(ansible_module, "permission")
+ attribute = module_params_get(ansible_module, "attribute")
+ action = module_params_get(ansible_module, "action")
+ # state
+ state = module_params_get(ansible_module, "state")
+
+ # Check parameters
+
+ if state == "present":
+ if len(names) != 1:
+ ansible_module.fail_json(
+ msg="Only one selfservice be added at a time.")
+ if action == "member":
+ invalid = ["permission"]
+ for x in invalid:
+ if vars()[x] is not None:
+ ansible_module.fail_json(
+ msg="Argument '%s' can not be used with action "
+ "'%s' and state '%s'" % (x, action, state))
+
+ if state == "absent":
+ if len(names) < 1:
+ ansible_module.fail_json(msg="No name given.")
+ invalid = ["permission"]
+ if action == "selfservice":
+ invalid.append("attribute")
+ for x in invalid:
+ if vars()[x] is not None:
+ ansible_module.fail_json(
+ msg="Argument '%s' can not be used with action "
+ "'%s' and state '%s'" % (x, action, state))
+
+ if permission is not None:
+ perm = [p for p in permission if p not in ("read", "write")]
+ if perm:
+ ansible_module.fail_json(msg="Invalid permission '%s'" % perm)
+ if len(set(permission)) != len(permission):
+ ansible_module.fail_json(
+ msg="Invalid permission '%s', items are not unique" %
+ repr(permission))
+
+ if attribute is not None:
+ if len(set(attribute)) != len(attribute):
+ ansible_module.fail_json(
+ msg="Invalid attribute '%s', items are not unique" %
+ repr(attribute))
+
+ # Init
+
+ changed = False
+ exit_args = {}
+ ccache_dir = None
+ ccache_name = None
+ try:
+ if not valid_creds(ansible_module, ipaadmin_principal):
+ ccache_dir, ccache_name = temp_kinit(ipaadmin_principal,
+ ipaadmin_password)
+ api_connect()
+
+ commands = []
+ for name in names:
+ # Make sure selfservice exists
+ res_find = find_selfservice(ansible_module, name)
+
+ # Create command
+ if state == "present":
+
+ # Generate args
+ args = gen_args(permission, attribute)
+
+ if action == "selfservice":
+ # Found the selfservice
+ if res_find is not None:
+ # For all settings is args, check if there are
+ # different settings in the find result.
+ # If yes: modify
+ if not compare_args_ipa(ansible_module, args,
+ res_find):
+ commands.append([name, "selfservice_mod", args])
+ else:
+ commands.append([name, "selfservice_add", args])
+
+ elif action == "member":
+ if res_find is None:
+ ansible_module.fail_json(
+ msg="No selfservice '%s'" % name)
+
+ if attribute is None:
+ ansible_module.fail_json(msg="No attributes given")
+
+ # New attribute list (add given ones to find result)
+ # Make list with unique entries
+ attrs = list(set(list(res_find["attrs"]) + attribute))
+ if len(attrs) > len(res_find["attrs"]):
+ commands.append([name, "selfservice_mod",
+ {"attrs": attrs}])
+
+ elif state == "absent":
+ if action == "selfservice":
+ if res_find is not None:
+ commands.append([name, "selfservice_del", {}])
+
+ elif action == "member":
+ if res_find is None:
+ ansible_module.fail_json(
+ msg="No selfservice '%s'" % name)
+
+ if attribute is None:
+ ansible_module.fail_json(msg="No attributes given")
+
+ # New attribute list (remove given ones from find result)
+ # Make list with unique entries
+ attrs = list(set(res_find["attrs"]) - set(attribute))
+ if len(attrs) < 1:
+ ansible_module.fail_json(
+ msg="At minimum one attribute is needed.")
+
+ # Entries New number of attributes is smaller
+ if len(attrs) < len(res_find["attrs"]):
+ commands.append([name, "selfservice_mod",
+ {"attrs": attrs}])
+
+ else:
+ ansible_module.fail_json(msg="Unkown state '%s'" % state)
+
+ # Execute commands
+
+ for name, command, args in commands:
+ try:
+ result = api_command(ansible_module, command, name,
+ args)
+ if "completed" in result:
+ if result["completed"] > 0:
+ changed = True
+ else:
+ changed = True
+ except Exception as e:
+ ansible_module.fail_json(msg="%s: %s: %s" % (command, name,
+ str(e)))
+
+ except Exception as e:
+ ansible_module.fail_json(msg=str(e))
+
+ finally:
+ temp_kdestroy(ccache_dir, ccache_name)
+
+ # Done
+
+ ansible_module.exit_json(changed=changed, **exit_args)
+
+
+if __name__ == "__main__":
+ main()
diff --git a/tests/selfservice/test_selfservice.yml b/tests/selfservice/test_selfservice.yml
new file mode 100644
index 0000000000000000000000000000000000000000..3f036acb6427710ce45f721ec1a95869a003537d
--- /dev/null
+++ b/tests/selfservice/test_selfservice.yml
@@ -0,0 +1,160 @@
+---
+- name: Test selfservice
+ hosts: ipaserver
+ become: true
+
+ tasks:
+
+ # CLEANUP TEST ITEMS
+
+ - name: Ensure selfservice "Users can manage their own name details" is absent
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ state: absent
+
+ # CREATE TEST ITEMS
+
+ # TESTS
+
+ - name: Ensure selfservice "Users can manage their own name details" is present
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ permission: write
+ attribute:
+ - givenname
+ - displayname
+ - title
+ register: result
+ failed_when: not result.changed or result.failed
+
+ - name: Ensure selfservice "Users can manage their own name details" is present again
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ permission: write
+ attribute:
+ - givenname
+ - displayname
+ - title
+ register: result
+ failed_when: result.changed or result.failed
+
+ - name: Ensure selfservice "Users can manage their own name details" is present with different attribute initials
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ permission: write
+ attribute:
+ - initials
+ register: result
+ failed_when: not result.changed or result.failed
+
+ - name: Ensure selfservice "Users can manage their own name details" is present with different attribute initials again
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ permission: write
+ attribute:
+ - initials
+ register: result
+ failed_when: result.changed or result.failed
+
+ - name: Ensure selfservice "Users can manage their own name details" member attributes givenname, displayname and title are present
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ attribute:
+ - givenname
+ - displayname
+ - title
+ action: member
+ register: result
+ failed_when: not result.changed or result.failed
+
+ - name: Ensure selfservice "Users can manage their own name details" member attributes givenname, displayname and title are present again
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ attribute:
+ - givenname
+ - displayname
+ - title
+ action: member
+ register: result
+ failed_when: result.changed or result.failed
+
+ - name: Ensure selfservice "Users can manage their own name details" member attribute title is absent
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ attribute:
+ - title
+ action: member
+ state: absent
+ register: result
+ failed_when: not result.changed or result.failed
+
+ - name: Ensure selfservice "Users can manage their own name details" member attribute title is absent again
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ attribute:
+ - title
+ action: member
+ state: absent
+ register: result
+ failed_when: result.changed or result.failed
+
+ # TEST permission change
+
+ - name: Ensure selfservice "Users can manage their own name details" is present with different read,write permission
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ permission: read,write
+ register: result
+ failed_when: not result.changed or result.failed
+
+ - name: Ensure selfservice "Users can manage their own name details" is present with different read,write permission again
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ permission: read,write
+ register: result
+ failed_when: result.changed or result.failed
+
+ - name: Ensure selfservice "Users can manage their own name details" fails with bad permission read,read
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ permission: read,read
+ register: result
+ failed_when: not result.failed or "Invalid permission" not in result.msg
+
+ - name: Ensure selfservice "Users can manage their own name details" fails with bad permission read,write,write
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ permission: read,write,write
+ register: result
+ failed_when: not result.failed or "Invalid permission" not in result.msg
+
+ - name: Ensure selfservice "Users can manage their own name details" fails with bad attribute title,title
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ attribute:
+ - title
+ - title
+ register: result
+ failed_when: not result.failed or "Invalid attribute" not in result.msg
+
+ # CLEANUP TEST ITEMS
+
+ - name: Ensure selfservice "Users can manage their own name details" is absent
+ ipaselfservice:
+ ipaadmin_password: SomeADMINpassword
+ name: "Users can manage their own name details"
+ state: absent