mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-03-26 21:33:05 +00:00
57bedd84a3
ansible-test with ansible-2.14 is adding a lot of new tests to ensure that the documentation section and the agument spec is complete. Needed changes: DOCUMENTATION section - `type: str` needs to be set for string parameters - `type: list` needs to be set for list parameters - `elements: str` needs to be given for list of string parameters - `required` tags need to be fixed according to the `argument_spec` - `author` needs to be given with the github user also: `Name (@user)` argument_spec - `elements="str"` needs to be added to all list of string parameters The `copyright` date is extended with `-2022`.
320 lines
9.8 KiB
Python
320 lines
9.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Authors:
|
|
# Rafael Guterres Jeffman <rjeffman@redhat.com>
|
|
# Thomas Woerner <twoerner@redhat.com>
|
|
#
|
|
# Copyright (C) 2020-2022 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/>.
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
|
|
__metaclass__ = type
|
|
|
|
"""ansible-freeipa module to manage FreeIPA privileges."""
|
|
|
|
|
|
ANSIBLE_METADATA = {
|
|
"metadata_version": "1.0",
|
|
"supported_by": "community",
|
|
"status": ["preview"],
|
|
}
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: ipaprivilege
|
|
short_description: Manage FreeIPA privilege
|
|
description: Manage FreeIPA privilege and privilege members
|
|
extends_documentation_fragment:
|
|
- ipamodule_base_docs
|
|
options:
|
|
name:
|
|
description: The list of privilege name strings.
|
|
type: list
|
|
elements: str
|
|
required: true
|
|
aliases: ["cn"]
|
|
description:
|
|
description: Privilege description
|
|
type: str
|
|
required: false
|
|
rename:
|
|
description: Rename the privilege object.
|
|
type: str
|
|
required: false
|
|
aliases: ["new_name"]
|
|
permission:
|
|
description: Permissions to be added to the privilege.
|
|
type: list
|
|
elements: str
|
|
required: false
|
|
action:
|
|
description: Work on privilege or member level.
|
|
type: str
|
|
choices: ["privilege", "member"]
|
|
default: privilege
|
|
required: false
|
|
state:
|
|
description: The state to ensure.
|
|
type: str
|
|
choices: ["present", "absent", "renamed"]
|
|
default: present
|
|
required: false
|
|
author:
|
|
- Rafael Guterres Jeffman (@rjeffman)
|
|
- Thomas Woerner (@t-woerner)
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
# Ensure privilege "Broad Privilege" is present
|
|
- ipaprivilege:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: Broad Privilege
|
|
description: Broad Privilege
|
|
|
|
# Ensure privilege "Broad Privilege" has permissions set
|
|
- ipaprivilege:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: Broad Privilege
|
|
permission:
|
|
- "Write IPA Configuration"
|
|
- "System: Write DNS Configuration"
|
|
- "System: Update DNS Entries"
|
|
action: member
|
|
|
|
# Ensure privilege member permission 'Write IPA Configuration' is absent
|
|
- ipaprivilege:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: Broad Privilege
|
|
permission:
|
|
- "Write IPA Configuration"
|
|
action: member
|
|
state: absent
|
|
|
|
# Rename privilege "Broad Privilege" to "DNS Special Privilege"
|
|
- ipaprivilege:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: Broad Privilege
|
|
rename: DNS Special Privilege
|
|
state: renamed
|
|
|
|
# Ensure privilege "DNS Special Privilege" is absent
|
|
- ipaprivilege:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: DNS Special Privilege
|
|
state: absent
|
|
"""
|
|
|
|
RETURN = """
|
|
"""
|
|
|
|
|
|
from ansible.module_utils.ansible_freeipa_module import \
|
|
IPAAnsibleModule, compare_args_ipa, gen_add_del_lists, gen_add_list, \
|
|
gen_intersection_list
|
|
from ansible.module_utils import six
|
|
|
|
if six.PY3:
|
|
unicode = str
|
|
|
|
|
|
def find_privilege(module, name):
|
|
"""Find if a privilege with the given name already exist."""
|
|
try:
|
|
_result = module.ipa_command("privilege_show", name, {"all": True})
|
|
except Exception: # pylint: disable=broad-except
|
|
# An exception is raised if privilege name is not found.
|
|
return None
|
|
else:
|
|
return _result["result"]
|
|
|
|
|
|
def main():
|
|
ansible_module = IPAAnsibleModule(
|
|
argument_spec=dict(
|
|
# general
|
|
name=dict(type="list", elements="str", aliases=["cn"],
|
|
required=True),
|
|
# present
|
|
description=dict(required=False, type='str', default=None),
|
|
rename=dict(required=False, type='str', default=None,
|
|
aliases=["new_name"], ),
|
|
permission=dict(required=False, type='list', elements="str",
|
|
default=None),
|
|
action=dict(type="str", default="privilege",
|
|
choices=["member", "privilege"]),
|
|
# state
|
|
state=dict(type="str", default="present",
|
|
choices=["present", "absent", "renamed"]),
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
ansible_module._ansible_debug = True
|
|
|
|
# Get parameters
|
|
|
|
# general
|
|
names = ansible_module.params_get("name")
|
|
|
|
# present
|
|
description = ansible_module.params_get("description")
|
|
permission = ansible_module.params_get("permission")
|
|
rename = ansible_module.params_get("rename")
|
|
action = ansible_module.params_get("action")
|
|
|
|
# state
|
|
state = ansible_module.params_get("state")
|
|
|
|
# Check parameters
|
|
invalid = []
|
|
|
|
if state == "present":
|
|
if len(names) != 1:
|
|
ansible_module.fail_json(
|
|
msg="Only one privilege be added at a time.")
|
|
if action == "member":
|
|
invalid = ["description"]
|
|
|
|
if state == "absent":
|
|
if len(names) < 1:
|
|
ansible_module.fail_json(msg="No name given.")
|
|
invalid = ["description", "rename"]
|
|
if action == "privilege":
|
|
invalid.append("permission")
|
|
|
|
if state == "renamed":
|
|
if len(names) != 1:
|
|
ansible_module.fail_json(
|
|
msg="Only one privilege be added at a time.")
|
|
invalid = ["description", "permission"]
|
|
if action != "privilege":
|
|
ansible_module.fail_json(
|
|
msg="Action '%s' can not be used with state '%s'"
|
|
% (action, state))
|
|
|
|
ansible_module.params_fail_used_invalid(invalid, state, action)
|
|
|
|
# Init
|
|
|
|
changed = False
|
|
exit_args = {}
|
|
|
|
# Connect to IPA API
|
|
with ansible_module.ipa_connect():
|
|
|
|
commands = []
|
|
for name in names:
|
|
# Make sure privilege exists
|
|
res_find = find_privilege(ansible_module, name)
|
|
|
|
# Create command
|
|
if state == "present":
|
|
|
|
args = {}
|
|
if description:
|
|
args['description'] = description
|
|
|
|
if action == "privilege":
|
|
# Found the privilege
|
|
if res_find is not None:
|
|
cmp = {"description": res_find.get("description")}
|
|
if not compare_args_ipa(ansible_module, args, cmp):
|
|
commands.append([name, "privilege_mod", args])
|
|
else:
|
|
commands.append([name, "privilege_add", args])
|
|
res_find = {}
|
|
|
|
# Generate addition and removal lists
|
|
permission_add, permission_del = gen_add_del_lists(
|
|
permission, res_find.get("memberof_permission")
|
|
)
|
|
|
|
# Add members
|
|
if len(permission_add) > 0:
|
|
commands.append([name, "privilege_add_permission",
|
|
{
|
|
"permission": permission_add,
|
|
}])
|
|
# Remove members
|
|
if len(permission_del) > 0:
|
|
commands.append([
|
|
name,
|
|
"privilege_remove_permission",
|
|
{"permission": permission_del}
|
|
])
|
|
|
|
elif action == "member":
|
|
if res_find is None:
|
|
ansible_module.fail_json(
|
|
msg="No privilege '%s'" % name)
|
|
|
|
if permission is None:
|
|
ansible_module.fail_json(msg="No permission given")
|
|
|
|
permission = gen_add_list(
|
|
permission, res_find.get("memberof_permission"))
|
|
if permission:
|
|
commands.append([name, "privilege_add_permission",
|
|
{"permission": permission}])
|
|
|
|
elif state == "absent":
|
|
if action == "privilege":
|
|
if res_find is not None:
|
|
commands.append([name, "privilege_del", {}])
|
|
|
|
elif action == "member":
|
|
if res_find is None:
|
|
ansible_module.fail_json(
|
|
msg="No privilege '%s'" % name)
|
|
|
|
if permission is None:
|
|
ansible_module.fail_json(msg="No permission given")
|
|
|
|
permission = gen_intersection_list(
|
|
permission, res_find.get("memberof_permission"))
|
|
if permission:
|
|
commands.append([name, "privilege_remove_permission",
|
|
{"permission": permission}])
|
|
|
|
elif state == "renamed":
|
|
if not rename:
|
|
ansible_module.fail_json(msg="No rename value given.")
|
|
|
|
if res_find is None:
|
|
ansible_module.fail_json(
|
|
msg="No privilege found to be renamed: '%s'" % (name))
|
|
|
|
if name != rename:
|
|
commands.append(
|
|
[name, "privilege_mod", {"rename": rename}])
|
|
|
|
else:
|
|
ansible_module.fail_json(msg="Unkown state '%s'" % state)
|
|
|
|
# Execute commands
|
|
|
|
changed = ansible_module.execute_ipa_commands(
|
|
commands, fail_on_member_errors=True)
|
|
|
|
# Done
|
|
|
|
ansible_module.exit_json(changed=changed, **exit_args)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|