Blame plugins/modules/ipahbacsvcgroup.py

Packit Service 0a38ef
# -*- coding: utf-8 -*-
Packit Service 0a38ef
Packit Service 0a38ef
# Authors:
Packit Service 0a38ef
#   Thomas Woerner <twoerner@redhat.com>
Packit Service 0a38ef
#
Packit Service 0a38ef
# Copyright (C) 2019 Red Hat
Packit Service 0a38ef
# see file 'COPYING' for use and warranty information
Packit Service 0a38ef
#
Packit Service 0a38ef
# This program is free software; you can redistribute it and/or modify
Packit Service 0a38ef
# it under the terms of the GNU General Public License as published by
Packit Service 0a38ef
# the Free Software Foundation, either version 3 of the License, or
Packit Service 0a38ef
# (at your option) any later version.
Packit Service 0a38ef
#
Packit Service 0a38ef
# This program is distributed in the hope that it will be useful,
Packit Service 0a38ef
# but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 0a38ef
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service 0a38ef
# GNU General Public License for more details.
Packit Service 0a38ef
#
Packit Service 0a38ef
# You should have received a copy of the GNU General Public License
Packit Service 0a38ef
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
Packit Service 0a38ef
Packit Service 0a38ef
ANSIBLE_METADATA = {
Packit Service 0a38ef
    "metadata_version": "1.0",
Packit Service 0a38ef
    "supported_by": "community",
Packit Service 0a38ef
    "status": ["preview"],
Packit Service 0a38ef
}
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
DOCUMENTATION = """
Packit Service 0a38ef
---
Packit Service 0a38ef
module: ipahbacsvcgroup
Packit Service 0a38ef
short description: Manage FreeIPA hbacsvcgroups
Packit Service 0a38ef
description: Manage FreeIPA hbacsvcgroups
Packit Service 0a38ef
options:
Packit Service 0a38ef
  ipaadmin_principal:
Packit Service 0a38ef
    description: The admin principal
Packit Service 0a38ef
    default: admin
Packit Service 0a38ef
  ipaadmin_password:
Packit Service 0a38ef
    description: The admin password
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
  name:
Packit Service 0a38ef
    description: The hbacsvcgroup name
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    aliases: ["cn"]
Packit Service 0a38ef
  description:
Packit Service 0a38ef
    description: The hbacsvcgroup description
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
  hbacsvc:
Packit Service 0a38ef
    description: List of hbacsvc names assigned to this hbacsvcgroup.
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    type: list
Packit Service 0a38ef
  nomembers:
Packit Service 0a38ef
    description: Suppress processing of membership attributes
Packit Service 0a38ef
    required: false
Packit Service 0a38ef
    type: bool
Packit Service 0a38ef
  action:
Packit Service 0a38ef
    description: Work on hbacsvcgroup or member level
Packit Service 0a38ef
    default: hbacsvcgroup
Packit Service 0a38ef
    choices: ["member", "hbacsvcgroup"]
Packit Service 0a38ef
  state:
Packit Service 0a38ef
    description: State to ensure
Packit Service 0a38ef
    default: present
Packit Service 0a38ef
    choices: ["present", "absent"]
Packit Service 0a38ef
author:
Packit Service 0a38ef
    - Thomas Woerner
Packit Service 0a38ef
"""
Packit Service 0a38ef
Packit Service 0a38ef
EXAMPLES = """
Packit Service 0a38ef
# Ensure hbacsvcgroup login is present
Packit Service 0a38ef
- ipahbacsvcgroup:
Packit Service 0a38ef
    ipaadmin_password: SomeADMINpassword
Packit Service 0a38ef
    name: login
Packit Service 0a38ef
    hbacsvc:
Packit Service 0a38ef
    - sshd
Packit Service 0a38ef
Packit Service 0a38ef
# Ensure hbacsvc sshd is present in existing login hbacsvcgroup
Packit Service 0a38ef
- ipahbacsvcgroup:
Packit Service 0a38ef
    ipaadmin_password: SomeADMINpassword
Packit Service 0a38ef
    name: databases
Packit Service 0a38ef
    hbacsvc:
Packit Service 0a38ef
    - sshd
Packit Service 0a38ef
    action: member
Packit Service 0a38ef
Packit Service 0a38ef
# Ensure hbacsvc sshd is abdsent in existing login hbacsvcgroup
Packit Service 0a38ef
- ipahbacsvcgroup:
Packit Service 0a38ef
    ipaadmin_password: SomeADMINpassword
Packit Service 0a38ef
    name: databases
Packit Service 0a38ef
    hbacsvc:
Packit Service 0a38ef
    - sshd
Packit Service 0a38ef
    action: member
Packit Service 0a38ef
    state: absent
Packit Service 0a38ef
Packit Service 0a38ef
# Ensure hbacsvcgroup login is absent
Packit Service 0a38ef
- ipahbacsvcgroup:
Packit Service 0a38ef
    ipaadmin_password: SomeADMINpassword
Packit Service 0a38ef
    name: login
Packit Service 0a38ef
    state: absent
Packit Service 0a38ef
"""
Packit Service 0a38ef
Packit Service 0a38ef
RETURN = """
Packit Service 0a38ef
"""
Packit Service 0a38ef
Packit Service 0a38ef
from ansible.module_utils.basic import AnsibleModule
Packit Service 0a38ef
from ansible.module_utils._text import to_text
Packit Service 0a38ef
from ansible.module_utils.ansible_freeipa_module import temp_kinit, \
Packit Service 0a38ef
    temp_kdestroy, valid_creds, api_connect, api_command, compare_args_ipa, \
Packit Service 0a38ef
    gen_add_del_lists
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
def find_hbacsvcgroup(module, name):
Packit Service 0a38ef
    _args = {
Packit Service 0a38ef
        "all": True,
Packit Service 0a38ef
        "cn": to_text(name),
Packit Service 0a38ef
    }
Packit Service 0a38ef
Packit Service 0a38ef
    _result = api_command(module, "hbacsvcgroup_find", to_text(name), _args)
Packit Service 0a38ef
Packit Service 0a38ef
    if len(_result["result"]) > 1:
Packit Service 0a38ef
        module.fail_json(
Packit Service 0a38ef
            msg="There is more than one hbacsvcgroup '%s'" % (name))
Packit Service 0a38ef
    elif len(_result["result"]) == 1:
Packit Service 0a38ef
        return _result["result"][0]
Packit Service 0a38ef
    else:
Packit Service 0a38ef
        return None
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
def gen_args(description, nomembers):
Packit Service 0a38ef
    _args = {}
Packit Service 0a38ef
    if description is not None:
Packit Service 0a38ef
        _args["description"] = to_text(description)
Packit Service 0a38ef
    if nomembers is not None:
Packit Service 0a38ef
        _args["nomembers"] = nomembers
Packit Service 0a38ef
Packit Service 0a38ef
    return _args
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
def gen_member_args(hbacsvc):
Packit Service 0a38ef
    _args = {}
Packit Service 0a38ef
    if hbacsvc is not None:
Packit Service 0a38ef
        _args["member_hbacsvc"] = [to_text(svc) for svc in hbacsvc]
Packit Service 0a38ef
Packit Service 0a38ef
    return _args
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
def main():
Packit Service 0a38ef
    ansible_module = AnsibleModule(
Packit Service 0a38ef
        argument_spec=dict(
Packit Service 0a38ef
            # general
Packit Service 0a38ef
            ipaadmin_principal=dict(type="str", default="admin"),
Packit Service 0a38ef
            ipaadmin_password=dict(type="str", required=False, no_log=True),
Packit Service 0a38ef
Packit Service 0a38ef
            name=dict(type="list", aliases=["cn"], default=None,
Packit Service 0a38ef
                      required=True),
Packit Service 0a38ef
            # present
Packit Service 0a38ef
            description=dict(type="str", default=None),
Packit Service 0a38ef
            nomembers=dict(required=False, type='bool', default=None),
Packit Service 0a38ef
            hbacsvc=dict(required=False, type='list', default=None),
Packit Service 0a38ef
            action=dict(type="str", default="hbacsvcgroup",
Packit Service 0a38ef
                        choices=["member", "hbacsvcgroup"]),
Packit Service 0a38ef
            # state
Packit Service 0a38ef
            state=dict(type="str", default="present",
Packit Service 0a38ef
                       choices=["present", "absent"]),
Packit Service 0a38ef
        ),
Packit Service 0a38ef
        supports_check_mode=True,
Packit Service 0a38ef
    )
Packit Service 0a38ef
Packit Service 0a38ef
    ansible_module._ansible_debug = True
Packit Service 0a38ef
Packit Service 0a38ef
    # Get parameters
Packit Service 0a38ef
Packit Service 0a38ef
    # general
Packit Service 0a38ef
    ipaadmin_principal = ansible_module.params.get("ipaadmin_principal")
Packit Service 0a38ef
    ipaadmin_password = ansible_module.params.get("ipaadmin_password")
Packit Service 0a38ef
    names = ansible_module.params.get("name")
Packit Service 0a38ef
Packit Service 0a38ef
    # present
Packit Service 0a38ef
    description = ansible_module.params.get("description")
Packit Service 0a38ef
    nomembers = ansible_module.params.get("nomembers")
Packit Service 0a38ef
    hbacsvc = ansible_module.params.get("hbacsvc")
Packit Service 0a38ef
    action = ansible_module.params.get("action")
Packit Service 0a38ef
    # state
Packit Service 0a38ef
    state = ansible_module.params.get("state")
Packit Service 0a38ef
Packit Service 0a38ef
    # Check parameters
Packit Service 0a38ef
Packit Service 0a38ef
    if state == "present":
Packit Service 0a38ef
        if len(names) != 1:
Packit Service 0a38ef
            ansible_module.fail_json(
Packit Service 0a38ef
                msg="Only one hbacsvcgroup can be added at a time.")
Packit Service 0a38ef
        if action == "member":
Packit Service 0a38ef
            invalid = ["description", "nomembers"]
Packit Service 0a38ef
            for x in invalid:
Packit Service 0a38ef
                if vars()[x] is not None:
Packit Service 0a38ef
                    ansible_module.fail_json(
Packit Service 0a38ef
                        msg="Argument '%s' can not be used with action "
Packit Service 0a38ef
                        "'%s'" % (x, action))
Packit Service 0a38ef
Packit Service 0a38ef
    if state == "absent":
Packit Service 0a38ef
        if len(names) < 1:
Packit Service 0a38ef
            ansible_module.fail_json(
Packit Service 0a38ef
                msg="No name given.")
Packit Service 0a38ef
        invalid = ["description", "nomembers"]
Packit Service 0a38ef
        if action == "hbacsvcgroup":
Packit Service 0a38ef
            invalid.extend(["hbacsvc"])
Packit Service 0a38ef
        for x in invalid:
Packit Service 0a38ef
            if vars()[x] is not None:
Packit Service 0a38ef
                ansible_module.fail_json(
Packit Service 0a38ef
                    msg="Argument '%s' can not be used with state '%s'" %
Packit Service 0a38ef
                    (x, state))
Packit Service 0a38ef
Packit Service 0a38ef
    # Init
Packit Service 0a38ef
Packit Service 0a38ef
    changed = False
Packit Service 0a38ef
    exit_args = {}
Packit Service 0a38ef
    ccache_dir = None
Packit Service 0a38ef
    ccache_name = None
Packit Service 0a38ef
    try:
Packit Service 0a38ef
        if not valid_creds(ansible_module, ipaadmin_principal):
Packit Service 0a38ef
            ccache_dir, ccache_name = temp_kinit(ipaadmin_principal,
Packit Service 0a38ef
                                                 ipaadmin_password)
Packit Service 0a38ef
        api_connect()
Packit Service 0a38ef
Packit Service 0a38ef
        commands = []
Packit Service 0a38ef
Packit Service 0a38ef
        for name in names:
Packit Service 0a38ef
            # Make sure hbacsvcgroup exists
Packit Service 0a38ef
            res_find = find_hbacsvcgroup(ansible_module, name)
Packit Service 0a38ef
Packit Service 0a38ef
            # Create command
Packit Service 0a38ef
            if state == "present":
Packit Service 0a38ef
                # Generate args
Packit Service 0a38ef
                args = gen_args(description, nomembers)
Packit Service 0a38ef
Packit Service 0a38ef
                if action == "hbacsvcgroup":
Packit Service 0a38ef
                    # Found the hbacsvcgroup
Packit Service 0a38ef
                    if res_find is not None:
Packit Service 0a38ef
                        # For all settings is args, check if there are
Packit Service 0a38ef
                        # different settings in the find result.
Packit Service 0a38ef
                        # If yes: modify
Packit Service 0a38ef
                        if not compare_args_ipa(ansible_module, args,
Packit Service 0a38ef
                                                res_find):
Packit Service 0a38ef
                            commands.append([name, "hbacsvcgroup_mod", args])
Packit Service 0a38ef
                    else:
Packit Service 0a38ef
                        commands.append([name, "hbacsvcgroup_add", args])
Packit Service 0a38ef
                        # Set res_find to empty dict for next step
Packit Service 0a38ef
                        res_find = {}
Packit Service 0a38ef
Packit Service 0a38ef
                    member_args = gen_member_args(hbacsvc)
Packit Service 0a38ef
                    if not compare_args_ipa(ansible_module, member_args,
Packit Service 0a38ef
                                            res_find):
Packit Service 0a38ef
                        # Generate addition and removal lists
Packit Service 0a38ef
                        hbacsvc_add, hbacsvc_del = gen_add_del_lists(
Packit Service 0a38ef
                            hbacsvc, res_find.get("member_hbacsvc"))
Packit Service 0a38ef
Packit Service 0a38ef
                        # Add members
Packit Service 0a38ef
                        if len(hbacsvc_add) > 0:
Packit Service 0a38ef
                            commands.append([name, "hbacsvcgroup_add_member",
Packit Service 0a38ef
                                             {
Packit Service 0a38ef
                                                 "hbacsvc":
Packit Service 0a38ef
                                                 [to_text(svc)
Packit Service 0a38ef
                                                  for svc in hbacsvc_add],
Packit Service 0a38ef
                                             }])
Packit Service 0a38ef
                        # Remove members
Packit Service 0a38ef
                        if len(hbacsvc_del) > 0:
Packit Service 0a38ef
                            commands.append([name,
Packit Service 0a38ef
                                             "hbacsvcgroup_remove_member",
Packit Service 0a38ef
                                             {
Packit Service 0a38ef
                                                 "hbacsvc":
Packit Service 0a38ef
                                                 [to_text(svc)
Packit Service 0a38ef
                                                  for svc in hbacsvc_del],
Packit Service 0a38ef
                                             }])
Packit Service 0a38ef
                elif action == "member":
Packit Service 0a38ef
                    if res_find is None:
Packit Service 0a38ef
                        ansible_module.fail_json(
Packit Service 0a38ef
                            msg="No hbacsvcgroup '%s'" % name)
Packit Service 0a38ef
Packit Service 0a38ef
                    # Ensure members are present
Packit Service 0a38ef
                    commands.append([name, "hbacsvcgroup_add_member",
Packit Service 0a38ef
                                     {
Packit Service 0a38ef
                                         "hbacsvc": [to_text(svc)
Packit Service 0a38ef
                                                     for svc in hbacsvc],
Packit Service 0a38ef
                                     }])
Packit Service 0a38ef
            elif state == "absent":
Packit Service 0a38ef
                if action == "hbacsvcgroup":
Packit Service 0a38ef
                    if res_find is not None:
Packit Service 0a38ef
                        commands.append([name, "hbacsvcgroup_del", {}])
Packit Service 0a38ef
Packit Service 0a38ef
                elif action == "member":
Packit Service 0a38ef
                    if res_find is None:
Packit Service 0a38ef
                        ansible_module.fail_json(
Packit Service 0a38ef
                            msg="No hbacsvcgroup '%s'" % name)
Packit Service 0a38ef
Packit Service 0a38ef
                    # Ensure members are absent
Packit Service 0a38ef
                    commands.append([name, "hbacsvcgroup_remove_member",
Packit Service 0a38ef
                                     {
Packit Service 0a38ef
                                         "hbacsvc": [to_text(svc)
Packit Service 0a38ef
                                                     for svc in hbacsvc],
Packit Service 0a38ef
                                     }])
Packit Service 0a38ef
            else:
Packit Service 0a38ef
                ansible_module.fail_json(msg="Unkown state '%s'" % state)
Packit Service 0a38ef
Packit Service 0a38ef
        # Execute commands
Packit Service 0a38ef
        errors = []
Packit Service 0a38ef
        for name, command, args in commands:
Packit Service 0a38ef
            try:
Packit Service 0a38ef
                result = api_command(ansible_module, command, to_text(name),
Packit Service 0a38ef
                                     args)
Packit Service 0a38ef
                if "completed" in result:
Packit Service 0a38ef
                    if result["completed"] > 0:
Packit Service 0a38ef
                        changed = True
Packit Service 0a38ef
                else:
Packit Service 0a38ef
                    changed = True
Packit Service 0a38ef
            except Exception as e:
Packit Service 0a38ef
                ansible_module.fail_json(msg="%s: %s: %s" % (command, name,
Packit Service 0a38ef
                                                             str(e)))
Packit Service 0a38ef
            # Get all errors
Packit Service 0a38ef
            # All "already a member" and "not a member" failures in the
Packit Service 0a38ef
            # result are ignored. All others are reported.
Packit Service 0a38ef
            if "failed" in result and "member" in result["failed"]:
Packit Service 0a38ef
                failed = result["failed"]["member"]
Packit Service 0a38ef
                for member_type in failed:
Packit Service 0a38ef
                    for member, failure in failed[member_type]:
Packit Service 0a38ef
                        if "already a member" not in failure \
Packit Service 0a38ef
                           and "not a member" not in failure:
Packit Service 0a38ef
                            errors.append("%s: %s %s: %s" % (
Packit Service 0a38ef
                                command, member_type, member, failure))
Packit Service 0a38ef
        if len(errors) > 0:
Packit Service 0a38ef
            ansible_module.fail_json(msg=", ".join(errors))
Packit Service 0a38ef
Packit Service 0a38ef
    except Exception as e:
Packit Service 0a38ef
        ansible_module.fail_json(msg=str(e))
Packit Service 0a38ef
Packit Service 0a38ef
    finally:
Packit Service 0a38ef
        temp_kdestroy(ccache_dir, ccache_name)
Packit Service 0a38ef
Packit Service 0a38ef
    # Done
Packit Service 0a38ef
Packit Service 0a38ef
    ansible_module.exit_json(changed=changed, **exit_args)
Packit Service 0a38ef
Packit Service 0a38ef
Packit Service 0a38ef
if __name__ == "__main__":
Packit Service 0a38ef
    main()