mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-03-26 21:33:05 +00:00
a4a15defa9
group_add_member is only supporting services in more recent IPA versions. This is 4.7+. Code has been added to detect if services are supported by the used IPA version and used in the parameters of the module. In this case an error is printed. Additionally all parameters will be get from the module using module_params_get provided by ansible_freeipa_module. Additional to_text conversions have been removed as they are not needed anymore with this.
446 lines
16 KiB
Python
446 lines
16 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Authors:
|
|
# Thomas Woerner <twoerner@redhat.com>
|
|
#
|
|
# Copyright (C) 2019 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: ipagroup
|
|
short description: Manage FreeIPA groups
|
|
description: Manage FreeIPA groups
|
|
options:
|
|
ipaadmin_principal:
|
|
description: The admin principal
|
|
default: admin
|
|
ipaadmin_password:
|
|
description: The admin password
|
|
required: false
|
|
name:
|
|
description: The group name
|
|
required: false
|
|
aliases: ["cn"]
|
|
description:
|
|
description: The group description
|
|
required: false
|
|
gid:
|
|
description: The GID
|
|
required: false
|
|
aliases: ["gidnumber"]
|
|
nonposix:
|
|
description: Create as a non-POSIX group
|
|
required: false
|
|
type: bool
|
|
external:
|
|
description: Allow adding external non-IPA members from trusted domains
|
|
required: false
|
|
type: bool
|
|
nomembers:
|
|
description: Suppress processing of membership attributes
|
|
required: false
|
|
type: bool
|
|
user:
|
|
description: List of user names assigned to this group.
|
|
required: false
|
|
type: list
|
|
group:
|
|
description: List of group names assigned to this group.
|
|
required: false
|
|
type: list
|
|
service:
|
|
description:
|
|
- List of service names assigned to this group.
|
|
- Only usable with IPA versions 4.7 and up.
|
|
required: false
|
|
type: list
|
|
action:
|
|
description: Work on group or member level
|
|
default: group
|
|
choices: ["member", "group"]
|
|
state:
|
|
description: State to ensure
|
|
default: present
|
|
choices: ["present", "absent"]
|
|
author:
|
|
- Thomas Woerner
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
# Create group ops with gid 1234
|
|
- ipagroup:
|
|
ipaadmin_password: MyPassword123
|
|
name: ops
|
|
gidnumber: 1234
|
|
|
|
# Create group sysops
|
|
- ipagroup:
|
|
ipaadmin_password: MyPassword123
|
|
name: sysops
|
|
|
|
# Create group appops
|
|
- ipagroup:
|
|
ipaadmin_password: MyPassword123
|
|
name: appops
|
|
|
|
# Add user member pinky to group sysops
|
|
- ipagroup:
|
|
ipaadmin_password: MyPassword123
|
|
name: sysops
|
|
action: member
|
|
user:
|
|
- pinky
|
|
|
|
# Add user member brain to group sysops
|
|
- ipagroup:
|
|
ipaadmin_password: MyPassword123
|
|
name: sysops
|
|
action: member
|
|
user:
|
|
- brain
|
|
|
|
# Add group members sysops and appops to group sysops
|
|
- ipagroup:
|
|
ipaadmin_password: MyPassword123
|
|
name: ops
|
|
group:
|
|
- sysops
|
|
- appops
|
|
|
|
# Remove goups sysops, appops and ops
|
|
- ipagroup:
|
|
ipaadmin_password: MyPassword123
|
|
name: sysops,appops,ops
|
|
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, \
|
|
api_check_param, module_params_get
|
|
|
|
|
|
def find_group(module, name):
|
|
_args = {
|
|
"all": True,
|
|
"cn": name,
|
|
}
|
|
|
|
_result = api_command(module, "group_find", name, _args)
|
|
|
|
if len(_result["result"]) > 1:
|
|
module.fail_json(
|
|
msg="There is more than one group '%s'" % (name))
|
|
elif len(_result["result"]) == 1:
|
|
return _result["result"][0]
|
|
else:
|
|
return None
|
|
|
|
|
|
def gen_args(description, gid, nonposix, external, nomembers):
|
|
_args = {}
|
|
if description is not None:
|
|
_args["description"] = description
|
|
if gid is not None:
|
|
_args["gidnumber"] = gid
|
|
if nonposix is not None:
|
|
_args["nonposix"] = nonposix
|
|
if external is not None:
|
|
_args["external"] = external
|
|
if nomembers is not None:
|
|
_args["nomembers"] = nomembers
|
|
|
|
return _args
|
|
|
|
|
|
def gen_member_args(user, group, service):
|
|
_args = {}
|
|
if user is not None:
|
|
_args["member_user"] = user
|
|
if group is not None:
|
|
_args["member_group"] = group
|
|
if service is not None:
|
|
_args["member_service"] = service
|
|
|
|
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=["cn"], default=None,
|
|
required=True),
|
|
# present
|
|
description=dict(type="str", default=None),
|
|
gid=dict(type="int", aliases=["gidnumber"], default=None),
|
|
nonposix=dict(required=False, type='bool', default=None),
|
|
external=dict(required=False, type='bool', default=None),
|
|
nomembers=dict(required=False, type='bool', default=None),
|
|
user=dict(required=False, type='list', default=None),
|
|
group=dict(required=False, type='list', default=None),
|
|
service=dict(required=False, type='list', default=None),
|
|
action=dict(type="str", default="group",
|
|
choices=["member", "group"]),
|
|
# 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
|
|
description = module_params_get(ansible_module, "description")
|
|
gid = module_params_get(ansible_module, "gid")
|
|
nonposix = module_params_get(ansible_module, "nonposix")
|
|
external = module_params_get(ansible_module, "external")
|
|
nomembers = module_params_get(ansible_module, "nomembers")
|
|
user = module_params_get(ansible_module, "user")
|
|
group = module_params_get(ansible_module, "group")
|
|
service = module_params_get(ansible_module, "service")
|
|
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 group can be added at a time.")
|
|
if action == "member":
|
|
invalid = ["description", "gid", "nonposix", "external",
|
|
"nomembers"]
|
|
for x in invalid:
|
|
if vars()[x] is not None:
|
|
ansible_module.fail_json(
|
|
msg="Argument '%s' can not be used with action "
|
|
"'%s'" % (x, action))
|
|
|
|
if state == "absent":
|
|
if len(names) < 1:
|
|
ansible_module.fail_json(
|
|
msg="No name given.")
|
|
invalid = ["description", "gid", "nonposix", "external", "nomembers"]
|
|
if action == "group":
|
|
invalid.extend(["user", "group", "service"])
|
|
for x in invalid:
|
|
if vars()[x] is not None:
|
|
ansible_module.fail_json(
|
|
msg="Argument '%s' can not be used with state '%s'" %
|
|
(x, state))
|
|
|
|
# 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()
|
|
|
|
has_add_member_service = api_check_param("group_add_member", "service")
|
|
if service is not None and not has_add_member_service:
|
|
ansible_module.fail_json(
|
|
msg="Managing a service as part of a group is not supported "
|
|
"by your IPA version")
|
|
|
|
commands = []
|
|
|
|
for name in names:
|
|
# Make sure group exists
|
|
res_find = find_group(ansible_module, name)
|
|
|
|
# Create command
|
|
if state == "present":
|
|
# Generate args
|
|
args = gen_args(description, gid, nonposix, external,
|
|
nomembers)
|
|
|
|
if action == "group":
|
|
# Found the group
|
|
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, "group_mod", args])
|
|
else:
|
|
commands.append([name, "group_add", args])
|
|
# Set res_find to empty dict for next step
|
|
res_find = {}
|
|
|
|
member_args = gen_member_args(user, group, service)
|
|
if not compare_args_ipa(ansible_module, member_args,
|
|
res_find):
|
|
# Generate addition and removal lists
|
|
user_add = list(
|
|
set(user or []) -
|
|
set(res_find.get("member_user", [])))
|
|
user_del = list(
|
|
set(res_find.get("member_user", [])) -
|
|
set(user or []))
|
|
group_add = list(
|
|
set(group or []) -
|
|
set(res_find.get("member_group", [])))
|
|
group_del = list(
|
|
set(res_find.get("member_group", [])) -
|
|
set(group or []))
|
|
service_add = list(
|
|
set(service or []) -
|
|
set(res_find.get("member_service", [])))
|
|
service_del = list(
|
|
set(res_find.get("member_service", [])) -
|
|
set(service or []))
|
|
|
|
if has_add_member_service:
|
|
# Add members
|
|
if len(user_add) > 0 or len(group_add) > 0 or \
|
|
len(service_add) > 0:
|
|
commands.append([name, "group_add_member",
|
|
{
|
|
"user": user_add,
|
|
"group": group_add,
|
|
"service": service_add,
|
|
}])
|
|
# Remove members
|
|
if len(user_del) > 0 or len(group_del) > 0 or \
|
|
len(service_del) > 0:
|
|
commands.append([name, "group_remove_member",
|
|
{
|
|
"user": user_del,
|
|
"group": group_del,
|
|
"service": service_del,
|
|
}])
|
|
else:
|
|
# Add members
|
|
if len(user_add) > 0 or len(group_add) > 0:
|
|
commands.append([name, "group_add_member",
|
|
{
|
|
"user": user_add,
|
|
"group": group_add,
|
|
}])
|
|
# Remove members
|
|
if len(user_del) > 0 or len(group_del) > 0:
|
|
commands.append([name, "group_remove_member",
|
|
{
|
|
"user": user_del,
|
|
"group": group_del,
|
|
}])
|
|
elif action == "member":
|
|
if res_find is None:
|
|
ansible_module.fail_json(msg="No group '%s'" % name)
|
|
if has_add_member_service:
|
|
commands.append([name, "group_add_member",
|
|
{
|
|
"user": user,
|
|
"group": group,
|
|
"service": service,
|
|
}])
|
|
else:
|
|
commands.append([name, "group_add_member",
|
|
{
|
|
"user": user,
|
|
"group": group,
|
|
}])
|
|
|
|
elif state == "absent":
|
|
if action == "group":
|
|
if res_find is not None:
|
|
commands.append([name, "group_del", {}])
|
|
|
|
elif action == "member":
|
|
if res_find is None:
|
|
ansible_module.fail_json(msg="No group '%s'" % name)
|
|
|
|
commands.append([name, "group_remove_member",
|
|
{
|
|
"user": user,
|
|
"group": group,
|
|
"service": service,
|
|
}])
|
|
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 and result["completed"] > 0:
|
|
changed = True
|
|
except Exception as e:
|
|
ansible_module.fail_json(msg="%s: %s: %s" % (command, name,
|
|
str(e)))
|
|
# Get all errors
|
|
# All "already a member" and "not a member" failures in the
|
|
# result are ignored. All others are reported.
|
|
errors = []
|
|
if "failed" in result and len(result["failed"]) > 0:
|
|
for item in result["failed"]:
|
|
failed_item = result["failed"][item]
|
|
for member_type in failed_item:
|
|
for member, failure in failed_item[member_type]:
|
|
if "already a member" in failure \
|
|
or "not a member" in failure:
|
|
continue
|
|
errors.append("%s: %s %s: %s" % (
|
|
command, member_type, member, failure))
|
|
if len(errors) > 0:
|
|
ansible_module.fail_json(msg=", ".join(errors))
|
|
|
|
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()
|