mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -07:00
Initial commit
This commit is contained in:
Ansible Core Team
commit
aebc1b03fd
4861 changed files with 812621 additions and 0 deletions
405
plugins/modules/identity/ipa/ipa_sudorule.py
Normal file
405
plugins/modules/identity/ipa/ipa_sudorule.py
Normal file
|
|
@ -0,0 +1,405 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright: (c) 2017, Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: ipa_sudorule
|
||||
author: Thomas Krahn (@Nosmoht)
|
||||
short_description: Manage FreeIPA sudo rule
|
||||
description:
|
||||
- Add, modify or delete sudo rule within IPA server using IPA API.
|
||||
options:
|
||||
cn:
|
||||
description:
|
||||
- Canonical name.
|
||||
- Can not be changed as it is the unique identifier.
|
||||
required: true
|
||||
aliases: ['name']
|
||||
type: str
|
||||
cmdcategory:
|
||||
description:
|
||||
- Command category the rule applies to.
|
||||
choices: ['all']
|
||||
type: str
|
||||
cmd:
|
||||
description:
|
||||
- List of commands assigned to the rule.
|
||||
- If an empty list is passed all commands will be removed from the rule.
|
||||
- If option is omitted commands will not be checked or changed.
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
description:
|
||||
- Description of the sudo rule.
|
||||
type: str
|
||||
host:
|
||||
description:
|
||||
- List of hosts assigned to the rule.
|
||||
- If an empty list is passed all hosts will be removed from the rule.
|
||||
- If option is omitted hosts will not be checked or changed.
|
||||
- Option C(hostcategory) must be omitted to assign hosts.
|
||||
type: list
|
||||
elements: str
|
||||
hostcategory:
|
||||
description:
|
||||
- Host category the rule applies to.
|
||||
- If 'all' is passed one must omit C(host) and C(hostgroup).
|
||||
- Option C(host) and C(hostgroup) must be omitted to assign 'all'.
|
||||
choices: ['all']
|
||||
type: str
|
||||
hostgroup:
|
||||
description:
|
||||
- List of host groups assigned to the rule.
|
||||
- If an empty list is passed all host groups will be removed from the rule.
|
||||
- If option is omitted host groups will not be checked or changed.
|
||||
- Option C(hostcategory) must be omitted to assign host groups.
|
||||
type: list
|
||||
elements: str
|
||||
runasusercategory:
|
||||
description:
|
||||
- RunAs User category the rule applies to.
|
||||
choices: ['all']
|
||||
type: str
|
||||
runasgroupcategory:
|
||||
description:
|
||||
- RunAs Group category the rule applies to.
|
||||
choices: ['all']
|
||||
type: str
|
||||
sudoopt:
|
||||
description:
|
||||
- List of options to add to the sudo rule.
|
||||
type: list
|
||||
elements: str
|
||||
user:
|
||||
description:
|
||||
- List of users assigned to the rule.
|
||||
- If an empty list is passed all users will be removed from the rule.
|
||||
- If option is omitted users will not be checked or changed.
|
||||
type: list
|
||||
elements: str
|
||||
usercategory:
|
||||
description:
|
||||
- User category the rule applies to.
|
||||
choices: ['all']
|
||||
type: str
|
||||
usergroup:
|
||||
description:
|
||||
- List of user groups assigned to the rule.
|
||||
- If an empty list is passed all user groups will be removed from the rule.
|
||||
- If option is omitted user groups will not be checked or changed.
|
||||
type: list
|
||||
elements: str
|
||||
state:
|
||||
description: State to ensure.
|
||||
default: present
|
||||
choices: ['absent', 'disabled', 'enabled', 'present']
|
||||
type: str
|
||||
extends_documentation_fragment:
|
||||
- community.general.ipa.documentation
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Ensure sudo rule is present that's allows all every body to execute any command on any host without being asked for a password.
|
||||
ipa_sudorule:
|
||||
name: sudo_all_nopasswd
|
||||
cmdcategory: all
|
||||
description: Allow to run every command with sudo without password
|
||||
hostcategory: all
|
||||
sudoopt:
|
||||
- '!authenticate'
|
||||
usercategory: all
|
||||
ipa_host: ipa.example.com
|
||||
ipa_user: admin
|
||||
ipa_pass: topsecret
|
||||
|
||||
- name: Ensure user group developers can run every command on host group db-server as well as on host db01.example.com.
|
||||
ipa_sudorule:
|
||||
name: sudo_dev_dbserver
|
||||
description: Allow developers to run every command with sudo on all database server
|
||||
cmdcategory: all
|
||||
host:
|
||||
- db01.example.com
|
||||
hostgroup:
|
||||
- db-server
|
||||
sudoopt:
|
||||
- '!authenticate'
|
||||
usergroup:
|
||||
- developers
|
||||
ipa_host: ipa.example.com
|
||||
ipa_user: admin
|
||||
ipa_pass: topsecret
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
sudorule:
|
||||
description: Sudorule as returned by IPA
|
||||
returned: always
|
||||
type: dict
|
||||
'''
|
||||
|
||||
import traceback
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec
|
||||
from ansible.module_utils._text import to_native
|
||||
|
||||
|
||||
class SudoRuleIPAClient(IPAClient):
|
||||
def __init__(self, module, host, port, protocol):
|
||||
super(SudoRuleIPAClient, self).__init__(module, host, port, protocol)
|
||||
|
||||
def sudorule_find(self, name):
|
||||
return self._post_json(method='sudorule_find', name=None, item={'all': True, 'cn': name})
|
||||
|
||||
def sudorule_add(self, name, item):
|
||||
return self._post_json(method='sudorule_add', name=name, item=item)
|
||||
|
||||
def sudorule_mod(self, name, item):
|
||||
return self._post_json(method='sudorule_mod', name=name, item=item)
|
||||
|
||||
def sudorule_del(self, name):
|
||||
return self._post_json(method='sudorule_del', name=name)
|
||||
|
||||
def sudorule_add_option(self, name, item):
|
||||
return self._post_json(method='sudorule_add_option', name=name, item=item)
|
||||
|
||||
def sudorule_add_option_ipasudoopt(self, name, item):
|
||||
return self.sudorule_add_option(name=name, item={'ipasudoopt': item})
|
||||
|
||||
def sudorule_remove_option(self, name, item):
|
||||
return self._post_json(method='sudorule_remove_option', name=name, item=item)
|
||||
|
||||
def sudorule_remove_option_ipasudoopt(self, name, item):
|
||||
return self.sudorule_remove_option(name=name, item={'ipasudoopt': item})
|
||||
|
||||
def sudorule_add_host(self, name, item):
|
||||
return self._post_json(method='sudorule_add_host', name=name, item=item)
|
||||
|
||||
def sudorule_add_host_host(self, name, item):
|
||||
return self.sudorule_add_host(name=name, item={'host': item})
|
||||
|
||||
def sudorule_add_host_hostgroup(self, name, item):
|
||||
return self.sudorule_add_host(name=name, item={'hostgroup': item})
|
||||
|
||||
def sudorule_remove_host(self, name, item):
|
||||
return self._post_json(method='sudorule_remove_host', name=name, item=item)
|
||||
|
||||
def sudorule_remove_host_host(self, name, item):
|
||||
return self.sudorule_remove_host(name=name, item={'host': item})
|
||||
|
||||
def sudorule_remove_host_hostgroup(self, name, item):
|
||||
return self.sudorule_remove_host(name=name, item={'hostgroup': item})
|
||||
|
||||
def sudorule_add_allow_command(self, name, item):
|
||||
return self._post_json(method='sudorule_add_allow_command', name=name, item={'sudocmd': item})
|
||||
|
||||
def sudorule_remove_allow_command(self, name, item):
|
||||
return self._post_json(method='sudorule_remove_allow_command', name=name, item=item)
|
||||
|
||||
def sudorule_add_user(self, name, item):
|
||||
return self._post_json(method='sudorule_add_user', name=name, item=item)
|
||||
|
||||
def sudorule_add_user_user(self, name, item):
|
||||
return self.sudorule_add_user(name=name, item={'user': item})
|
||||
|
||||
def sudorule_add_user_group(self, name, item):
|
||||
return self.sudorule_add_user(name=name, item={'group': item})
|
||||
|
||||
def sudorule_remove_user(self, name, item):
|
||||
return self._post_json(method='sudorule_remove_user', name=name, item=item)
|
||||
|
||||
def sudorule_remove_user_user(self, name, item):
|
||||
return self.sudorule_remove_user(name=name, item={'user': item})
|
||||
|
||||
def sudorule_remove_user_group(self, name, item):
|
||||
return self.sudorule_remove_user(name=name, item={'group': item})
|
||||
|
||||
|
||||
def get_sudorule_dict(cmdcategory=None, description=None, hostcategory=None, ipaenabledflag=None, usercategory=None,
|
||||
runasgroupcategory=None, runasusercategory=None):
|
||||
data = {}
|
||||
if cmdcategory is not None:
|
||||
data['cmdcategory'] = cmdcategory
|
||||
if description is not None:
|
||||
data['description'] = description
|
||||
if hostcategory is not None:
|
||||
data['hostcategory'] = hostcategory
|
||||
if ipaenabledflag is not None:
|
||||
data['ipaenabledflag'] = ipaenabledflag
|
||||
if usercategory is not None:
|
||||
data['usercategory'] = usercategory
|
||||
if runasusercategory is not None:
|
||||
data['ipasudorunasusercategory'] = runasusercategory
|
||||
if runasgroupcategory is not None:
|
||||
data['ipasudorunasgroupcategory'] = runasgroupcategory
|
||||
return data
|
||||
|
||||
|
||||
def category_changed(module, client, category_name, ipa_sudorule):
|
||||
if ipa_sudorule.get(category_name, None) == ['all']:
|
||||
if not module.check_mode:
|
||||
# cn is returned as list even with only a single value.
|
||||
client.sudorule_mod(name=ipa_sudorule.get('cn')[0], item={category_name: None})
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
def ensure(module, client):
|
||||
state = module.params['state']
|
||||
name = module.params['cn']
|
||||
cmd = module.params['cmd']
|
||||
cmdcategory = module.params['cmdcategory']
|
||||
host = module.params['host']
|
||||
hostcategory = module.params['hostcategory']
|
||||
hostgroup = module.params['hostgroup']
|
||||
runasusercategory = module.params['runasusercategory']
|
||||
runasgroupcategory = module.params['runasgroupcategory']
|
||||
|
||||
if state in ['present', 'enabled']:
|
||||
ipaenabledflag = 'TRUE'
|
||||
else:
|
||||
ipaenabledflag = 'FALSE'
|
||||
|
||||
sudoopt = module.params['sudoopt']
|
||||
user = module.params['user']
|
||||
usercategory = module.params['usercategory']
|
||||
usergroup = module.params['usergroup']
|
||||
|
||||
module_sudorule = get_sudorule_dict(cmdcategory=cmdcategory,
|
||||
description=module.params['description'],
|
||||
hostcategory=hostcategory,
|
||||
ipaenabledflag=ipaenabledflag,
|
||||
usercategory=usercategory,
|
||||
runasusercategory=runasusercategory,
|
||||
runasgroupcategory=runasgroupcategory)
|
||||
ipa_sudorule = client.sudorule_find(name=name)
|
||||
|
||||
changed = False
|
||||
if state in ['present', 'disabled', 'enabled']:
|
||||
if not ipa_sudorule:
|
||||
changed = True
|
||||
if not module.check_mode:
|
||||
ipa_sudorule = client.sudorule_add(name=name, item=module_sudorule)
|
||||
else:
|
||||
diff = client.get_diff(ipa_sudorule, module_sudorule)
|
||||
if len(diff) > 0:
|
||||
changed = True
|
||||
if not module.check_mode:
|
||||
if 'hostcategory' in diff:
|
||||
if ipa_sudorule.get('memberhost_host', None) is not None:
|
||||
client.sudorule_remove_host_host(name=name, item=ipa_sudorule.get('memberhost_host'))
|
||||
if ipa_sudorule.get('memberhost_hostgroup', None) is not None:
|
||||
client.sudorule_remove_host_hostgroup(name=name,
|
||||
item=ipa_sudorule.get('memberhost_hostgroup'))
|
||||
|
||||
client.sudorule_mod(name=name, item=module_sudorule)
|
||||
|
||||
if cmd is not None:
|
||||
changed = category_changed(module, client, 'cmdcategory', ipa_sudorule) or changed
|
||||
if not module.check_mode:
|
||||
client.sudorule_add_allow_command(name=name, item=cmd)
|
||||
|
||||
if runasusercategory is not None:
|
||||
changed = category_changed(module, client, 'iparunasusercategory', ipa_sudorule) or changed
|
||||
|
||||
if runasgroupcategory is not None:
|
||||
changed = category_changed(module, client, 'iparunasgroupcategory', ipa_sudorule) or changed
|
||||
|
||||
if host is not None:
|
||||
changed = category_changed(module, client, 'hostcategory', ipa_sudorule) or changed
|
||||
changed = client.modify_if_diff(name, ipa_sudorule.get('memberhost_host', []), host,
|
||||
client.sudorule_add_host_host,
|
||||
client.sudorule_remove_host_host) or changed
|
||||
|
||||
if hostgroup is not None:
|
||||
changed = category_changed(module, client, 'hostcategory', ipa_sudorule) or changed
|
||||
changed = client.modify_if_diff(name, ipa_sudorule.get('memberhost_hostgroup', []), hostgroup,
|
||||
client.sudorule_add_host_hostgroup,
|
||||
client.sudorule_remove_host_hostgroup) or changed
|
||||
if sudoopt is not None:
|
||||
# client.modify_if_diff does not work as each option must be removed/added by its own
|
||||
ipa_list = ipa_sudorule.get('ipasudoopt', [])
|
||||
module_list = sudoopt
|
||||
diff = list(set(ipa_list) - set(module_list))
|
||||
if len(diff) > 0:
|
||||
changed = True
|
||||
if not module.check_mode:
|
||||
for item in diff:
|
||||
client.sudorule_remove_option_ipasudoopt(name, item)
|
||||
diff = list(set(module_list) - set(ipa_list))
|
||||
if len(diff) > 0:
|
||||
changed = True
|
||||
if not module.check_mode:
|
||||
for item in diff:
|
||||
client.sudorule_add_option_ipasudoopt(name, item)
|
||||
|
||||
if user is not None:
|
||||
changed = category_changed(module, client, 'usercategory', ipa_sudorule) or changed
|
||||
changed = client.modify_if_diff(name, ipa_sudorule.get('memberuser_user', []), user,
|
||||
client.sudorule_add_user_user,
|
||||
client.sudorule_remove_user_user) or changed
|
||||
if usergroup is not None:
|
||||
changed = category_changed(module, client, 'usercategory', ipa_sudorule) or changed
|
||||
changed = client.modify_if_diff(name, ipa_sudorule.get('memberuser_group', []), usergroup,
|
||||
client.sudorule_add_user_group,
|
||||
client.sudorule_remove_user_group) or changed
|
||||
else:
|
||||
if ipa_sudorule:
|
||||
changed = True
|
||||
if not module.check_mode:
|
||||
client.sudorule_del(name)
|
||||
|
||||
return changed, client.sudorule_find(name)
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = ipa_argument_spec()
|
||||
argument_spec.update(cmd=dict(type='list', elements='str'),
|
||||
cmdcategory=dict(type='str', choices=['all']),
|
||||
cn=dict(type='str', required=True, aliases=['name']),
|
||||
description=dict(type='str'),
|
||||
host=dict(type='list', elements='str'),
|
||||
hostcategory=dict(type='str', choices=['all']),
|
||||
hostgroup=dict(type='list', elements='str'),
|
||||
runasusercategory=dict(type='str', choices=['all']),
|
||||
runasgroupcategory=dict(type='str', choices=['all']),
|
||||
sudoopt=dict(type='list', elements='str'),
|
||||
state=dict(type='str', default='present', choices=['present', 'absent', 'enabled', 'disabled']),
|
||||
user=dict(type='list', elements='str'),
|
||||
usercategory=dict(type='str', choices=['all']),
|
||||
usergroup=dict(type='list', elements='str'))
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec,
|
||||
mutually_exclusive=[['cmdcategory', 'cmd'],
|
||||
['hostcategory', 'host'],
|
||||
['hostcategory', 'hostgroup'],
|
||||
['usercategory', 'user'],
|
||||
['usercategory', 'usergroup']],
|
||||
supports_check_mode=True)
|
||||
|
||||
client = SudoRuleIPAClient(module=module,
|
||||
host=module.params['ipa_host'],
|
||||
port=module.params['ipa_port'],
|
||||
protocol=module.params['ipa_prot'])
|
||||
try:
|
||||
client.login(username=module.params['ipa_user'],
|
||||
password=module.params['ipa_pass'])
|
||||
changed, sudorule = ensure(module, client)
|
||||
module.exit_json(changed=changed, sudorule=sudorule)
|
||||
except Exception as e:
|
||||
module.fail_json(msg=to_native(e), exception=traceback.format_exc())
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue