mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-04-05 10:13:06 +00:00
857fb82eb9
This patch allows the modification of the forward zone policy in an existing DNS Forward Zone, and fixes some issues with `enable` and `disable` state that prevented correct behavior of `forwardpolicy`.
387 lines
13 KiB
Python
387 lines
13 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Authors:
|
|
# Chris Procter <cprocter@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: ipa_dnsforwardzone
|
|
author: chris procter
|
|
short_description: Manage FreeIPA DNS Forwarder Zones
|
|
description:
|
|
- Add and delete an IPA DNS Forwarder Zones using IPA API
|
|
options:
|
|
ipaadmin_principal:
|
|
description: The admin principal
|
|
default: admin
|
|
ipaadmin_password:
|
|
description: The admin password
|
|
required: false
|
|
name:
|
|
description:
|
|
- The DNS zone name which needs to be managed.
|
|
required: true
|
|
aliases: ["cn"]
|
|
state:
|
|
description: State to ensure
|
|
required: false
|
|
default: present
|
|
choices: ["present", "absent", "enabled", "disabled"]
|
|
forwarders:
|
|
description:
|
|
- List of the DNS servers to forward to
|
|
aliases: ["idnsforwarders"]
|
|
options:
|
|
ip_address:
|
|
description: Forwarder IP address (either IPv4 or IPv6).
|
|
required: false
|
|
type: string
|
|
port:
|
|
description: Forwarder port.
|
|
required: false
|
|
type: int
|
|
forwardpolicy:
|
|
description: Per-zone conditional forwarding policy
|
|
required: false
|
|
default: only
|
|
choices: ["only", "first", "none"]
|
|
aliases: ["idnsforwarders"]
|
|
skip_overlap_check:
|
|
description:
|
|
- Force DNS zone creation even if it will overlap with an existing zone.
|
|
required: false
|
|
default: false
|
|
permission:
|
|
description:
|
|
- Allow DNS Forward Zone to be managed.
|
|
required: false
|
|
type: bool
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Ensure dns zone is present
|
|
- ipadnsforwardzone:
|
|
ipaadmin_password: MyPassword123
|
|
state: present
|
|
name: example.com
|
|
forwarders:
|
|
- 8.8.8.8
|
|
- 4.4.4.4
|
|
forwardpolicy: first
|
|
skip_overlap_check: true
|
|
|
|
# Ensure that dns zone is removed
|
|
- ipadnsforwardzone:
|
|
ipaadmin_password: MyPassword123
|
|
name: example.com
|
|
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
|
|
|
|
|
|
def find_dnsforwardzone(module, name):
|
|
_args = {
|
|
"all": True,
|
|
"idnsname": name
|
|
}
|
|
_result = api_command(module, "dnsforwardzone_find", name, _args)
|
|
|
|
if len(_result["result"]) > 1:
|
|
module.fail_json(
|
|
msg="There is more than one dnsforwardzone '%s'" % (name))
|
|
elif len(_result["result"]) == 1:
|
|
return _result["result"][0]
|
|
else:
|
|
return None
|
|
|
|
|
|
def gen_args(forwarders, forwardpolicy, skip_overlap_check):
|
|
_args = {}
|
|
|
|
if forwarders is not None:
|
|
_args["idnsforwarders"] = forwarders
|
|
if forwardpolicy is not None:
|
|
_args["idnsforwardpolicy"] = forwardpolicy
|
|
if skip_overlap_check is not None:
|
|
_args["skip_overlap_check"] = skip_overlap_check
|
|
|
|
return _args
|
|
|
|
|
|
def forwarder_list(forwarders):
|
|
"""Convert the forwarder dict into a list compatible with IPA API."""
|
|
if forwarders is None:
|
|
return None
|
|
fwd_list = []
|
|
for forwarder in forwarders:
|
|
if forwarder.get('port', None) is not None:
|
|
formatter = "{ip_address} port {port}"
|
|
else:
|
|
formatter = "{ip_address}"
|
|
fwd_list.append(formatter.format(**forwarder))
|
|
return fwd_list
|
|
|
|
|
|
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),
|
|
forwarders=dict(type="list", default=None, required=False,
|
|
aliases=["idnsforwarders"], elements='dict',
|
|
options=dict(
|
|
ip_address=dict(type='str', required=True),
|
|
port=dict(type='int', required=False,
|
|
default=None),
|
|
)),
|
|
forwardpolicy=dict(type='str', aliases=["idnsforwardpolicy"],
|
|
required=False,
|
|
choices=['only', 'first', 'none']),
|
|
skip_overlap_check=dict(type='bool', required=False),
|
|
permission=dict(type='bool', required=False,
|
|
aliases=['managedby']),
|
|
action=dict(type="str", default="dnsforwardzone",
|
|
choices=["member", "dnsforwardzone"]),
|
|
# state
|
|
state=dict(type='str', default='present',
|
|
choices=['present', 'absent', 'enabled', 'disabled']),
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
ansible_module._ansible_debug = True
|
|
|
|
# Get parameters
|
|
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")
|
|
action = module_params_get(ansible_module, "action")
|
|
forwarders = forwarder_list(
|
|
module_params_get(ansible_module, "forwarders"))
|
|
forwardpolicy = module_params_get(ansible_module, "forwardpolicy")
|
|
skip_overlap_check = module_params_get(ansible_module,
|
|
"skip_overlap_check")
|
|
permission = module_params_get(ansible_module, "permission")
|
|
state = module_params_get(ansible_module, "state")
|
|
|
|
if state == 'present' and len(names) != 1:
|
|
ansible_module.fail_json(
|
|
msg="Only one dnsforwardzone can be added at a time.")
|
|
if state == 'absent' and len(names) < 1:
|
|
ansible_module.fail_json(msg="No name given.")
|
|
|
|
# absent stae means delete if the action is NOT member but update if it is
|
|
# if action is member then update an exisiting resource
|
|
# and if action is not member then create a resource
|
|
if state == "absent" and action == "dnsforwardzone":
|
|
operation = "del"
|
|
elif action == "member":
|
|
operation = "update"
|
|
else:
|
|
operation = "add"
|
|
|
|
if state in ["enabled", "disabled"]:
|
|
if action == "member":
|
|
ansible_module.fail_json(
|
|
msg="Action `member` cannot be used with state `%s`"
|
|
% (state))
|
|
invalid = [
|
|
"forwarders", "forwardpolicy", "skip_overlap_check", "permission"
|
|
]
|
|
for x in invalid:
|
|
if vars()[x] is not None:
|
|
ansible_module.fail_json(
|
|
msg="Argument '%s' can not be used with action "
|
|
"'%s', state `%s`" % (x, action, state))
|
|
wants_enable = (state == "enabled")
|
|
|
|
if operation == "del":
|
|
invalid = [
|
|
"forwarders", "forwardpolicy", "skip_overlap_check", "permission"
|
|
]
|
|
for x in invalid:
|
|
if vars()[x] is not None:
|
|
ansible_module.fail_json(
|
|
msg="Argument '%s' can not be used with action "
|
|
"'%s', state `%s`" % (x, action, state))
|
|
|
|
changed = False
|
|
exit_args = {}
|
|
args = {}
|
|
ccache_dir = None
|
|
ccache_name = None
|
|
is_enabled = "IGNORE"
|
|
try:
|
|
# we need to determine 3 variables
|
|
# args = the values we want to change/set
|
|
# command = the ipa api command to call del, add, or mod
|
|
# is_enabled = is the current resource enabled (True)
|
|
# disabled (False) and do we care (IGNORE)
|
|
|
|
if not valid_creds(ansible_module, ipaadmin_principal):
|
|
ccache_dir, ccache_name = temp_kinit(ipaadmin_principal,
|
|
ipaadmin_password)
|
|
api_connect()
|
|
|
|
for name in names:
|
|
commands = []
|
|
command = None
|
|
|
|
# Make sure forwardzone exists
|
|
existing_resource = find_dnsforwardzone(ansible_module, name)
|
|
|
|
# validate parameters
|
|
if state == 'present':
|
|
if existing_resource is None and not forwarders:
|
|
ansible_module.fail_json(msg='No forwarders specified.')
|
|
|
|
if existing_resource is None:
|
|
if operation == "add":
|
|
# does not exist but should be present
|
|
# determine args
|
|
args = gen_args(forwarders, forwardpolicy,
|
|
skip_overlap_check)
|
|
# set command
|
|
command = "dnsforwardzone_add"
|
|
# enabled or disabled?
|
|
|
|
elif operation == "update":
|
|
# does not exist and is updating
|
|
# trying to update something that doesn't exist, so error
|
|
ansible_module.fail_json(
|
|
msg="dnsforwardzone '%s' not found." % (name))
|
|
|
|
elif operation == "del":
|
|
# there's nothnig to do.
|
|
continue
|
|
|
|
else: # existing_resource is not None
|
|
if state != "absent":
|
|
if forwarders:
|
|
forwarders = list(
|
|
set(existing_resource["idnsforwarders"]
|
|
+ forwarders))
|
|
else:
|
|
if forwarders:
|
|
forwarders = list(
|
|
set(existing_resource["idnsforwarders"])
|
|
- set(forwarders))
|
|
|
|
if operation == "add":
|
|
# exists and should be present, has it changed?
|
|
# determine args
|
|
args = gen_args(
|
|
forwarders, forwardpolicy, skip_overlap_check)
|
|
if 'skip_overlap_check' in args:
|
|
del args['skip_overlap_check']
|
|
|
|
# set command
|
|
if not compare_args_ipa(
|
|
ansible_module, args, existing_resource):
|
|
command = "dnsforwardzone_mod"
|
|
|
|
elif operation == "del":
|
|
# exists but should be absent
|
|
# set command
|
|
command = "dnsforwardzone_del"
|
|
args = {}
|
|
|
|
elif operation == "update":
|
|
# exists and is updating
|
|
# calculate the new forwarders and mod
|
|
args = gen_args(
|
|
forwarders, forwardpolicy, skip_overlap_check)
|
|
if "skip_overlap_check" in args:
|
|
del args['skip_overlap_check']
|
|
|
|
# command
|
|
if not compare_args_ipa(
|
|
ansible_module, args, existing_resource):
|
|
command = "dnsforwardzone_mod"
|
|
|
|
if state in ['enabled', 'disabled']:
|
|
if existing_resource is not None:
|
|
is_enabled = existing_resource["idnszoneactive"][0]
|
|
else:
|
|
ansible_module.fail_json(
|
|
msg="dnsforwardzone '%s' not found." % (name))
|
|
|
|
# does the enabled state match what we want (if we care)
|
|
if is_enabled != "IGNORE":
|
|
if wants_enable and is_enabled != "TRUE":
|
|
commands.append([name, "dnsforwardzone_enable", {}])
|
|
elif not wants_enable and is_enabled != "FALSE":
|
|
commands.append([name, "dnsforwardzone_disable", {}])
|
|
|
|
# if command is set...
|
|
if command is not None:
|
|
commands.append([name, command, args])
|
|
|
|
if permission is not None:
|
|
if existing_resource is None:
|
|
managedby = None
|
|
else:
|
|
managedby = existing_resource.get('managedby', None)
|
|
if permission and managedby is None:
|
|
commands.append(
|
|
[name, 'dnsforwardzone_add_permission', {}]
|
|
)
|
|
elif not permission and managedby is not None:
|
|
commands.append(
|
|
[name, 'dnsforwardzone_remove_permission', {}]
|
|
)
|
|
|
|
for name, command, args in commands:
|
|
api_command(ansible_module, command, name, args)
|
|
changed = True
|
|
|
|
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, dnsforwardzone=exit_args)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|