Skip to content
Snippets Groups Projects
Select Git revision
  • 2c056b5c926a54dfb94bc65dd562659a51c73496
  • master default protected
  • v1.15.0
  • v1.14.7
  • v1.14.6
  • v1.14.5
  • v1.14.4
  • v1.14.3
  • v1.14.2
  • v1.14.1
  • v1.14.0
  • v1.13.2
  • v1.13.1
  • v1.13.0
  • v1.12.1
  • v1.12.0
  • v1.11.1
  • v1.11.0
  • v1.10.0
  • v1.9.2
  • v1.9.1
  • v1.9.0
22 results

ipadelegation.py

Blame
  • user avatar
    Eric Nothen authored
    Added code to the ipa* plugins to support Ansible's check_mode, by
    means of a clean exit before the execution of the actual list of
    commands that would otherwise create/update/delete IPA servers
    and/or its resources.
    7bbb401b
    History
    ipadelegation.py 11.37 KiB
    #!/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: ipadelegation
    short description: Manage FreeIPA delegations
    description: Manage FreeIPA delegations and delegation attributes
    options:
      ipaadmin_principal:
        description: The admin principal.
        default: admin
      ipaadmin_password:
        description: The admin password.
        required: false
      name:
        description: The list of delegation 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 delegation applies
        required: false
        aliases: ["attrs"]
      membergroup:
        description: User group to apply delegation to
        required: false
        aliases: ["memberof"]
      group:
        description: User group ACI grants access to
        required: false
      action:
        description: Work on delegation or member level.
        choices: ["delegation", "member"]
        default: delegation
        required: false
      state:
        description: The state to ensure.
        choices: ["present", "absent"]
        default: present
        required: true
    """
    
    EXAMPLES = """
    # Ensure delegation "basic manager attributes" is present
    - ipadelegation:
        ipaadmin_password: SomeADMINpassword
        name: "basic manager attributes"
        permission: read
        attribute:
        - businesscategory
        - employeetype
        group: managers
        membergroup: employees
    
    # Ensure delegation "basic manager attributes" member attribute
    # departmentnumber is present
    - ipadelegation:
        ipaadmin_password: SomeADMINpassword
        name: "basic manager attributes"
        attribute:
        - departmentnumber
        action: member
    
    # Ensure delegation "basic manager attributes" member attributes
    # employeetype and employeenumber are present
    - ipadelegation:
        ipaadmin_password: SomeADMINpassword
        name: "basic manager attributes"
        attribute:
        - employeenumber
        - employeetype
        action: member
        state: absent
    
    # Ensure delegation "basic manager attributes" is absent
    - ipadelegation:
        ipaadmin_password: SomeADMINpassword
        name: "basic manager attributes"
        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_delegation(module, name):
        """Find if a delegation with the given name already exist."""
        try:
            _result = api_command(module, "delegation_show", name, {"all": True})
        except Exception:  # pylint: disable=broad-except
            # An exception is raised if delegation name is not found.
            return None
        else:
            return _result["result"]
    
    
    def gen_args(permission, attribute, membergroup, group):
        _args = {}
        if permission is not None:
            _args["permissions"] = permission
        if attribute is not None:
            _args["attrs"] = attribute
        if membergroup is not None:
            _args["memberof"] = membergroup
        if group is not None:
            _args["group"] = group
        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),
                membergroup=dict(type="str", aliases=["memberof"], default=None),
                group=dict(type="str", default=None),
                action=dict(type="str", default="delegation",
                            choices=["member", "delegation"]),
                # 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")
        membergroup = module_params_get(ansible_module, "membergroup")
        group = module_params_get(ansible_module, "group")
        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 delegation be added at a time.")
            if action == "member":
                invalid = ["permission", "membergroup", "group"]
                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", "membergroup", "group"]
            if action == "delegation":
                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 delegation exists
                res_find = find_delegation(ansible_module, name)
    
                # Create command
                if state == "present":
    
                    # Generate args
                    args = gen_args(permission, attribute, membergroup, group)
    
                    if action == "delegation":
                        # Found the delegation
                        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, "delegation_mod", args])
                        else:
                            commands.append([name, "delegation_add", args])
    
                    elif action == "member":
                        if res_find is None:
                            ansible_module.fail_json(
                                msg="No delegation '%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, "delegation_mod",
                                             {"attrs": attrs}])
    
                elif state == "absent":
                    if action == "delegation":
                        if res_find is not None:
                            commands.append([name, "delegation_del", {}])
    
                    elif action == "member":
                        if res_find is None:
                            ansible_module.fail_json(
                                msg="No delegation '%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, "delegation_mod",
                                             {"attrs": attrs}])
    
                else:
                    ansible_module.fail_json(msg="Unkown state '%s'" % state)
    
            # Check mode exit
            if ansible_module.check_mode:
                ansible_module.exit_json(changed=len(commands) > 0, **exit_args)
    
            # 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()