521 lines
17 KiB
Python
521 lines
17 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2013, Adam Miller (maxamillion@fedoraproject.org)
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible 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.
|
|
#
|
|
# Ansible 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 Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: firewalld
|
|
short_description: Manage arbitrary ports/services with firewalld
|
|
description:
|
|
- This module allows for addition or deletion of services and ports either tcp or udp in either running or permanent firewalld rules.
|
|
version_added: "1.4"
|
|
options:
|
|
service:
|
|
description:
|
|
- "Name of a service to add/remove to/from firewalld - service must be listed in /etc/services."
|
|
required: false
|
|
default: null
|
|
port:
|
|
description:
|
|
- "Name of a port or port range to add/remove to/from firewalld. Must be in the form PORT/PROTOCOL or PORT-PORT/PROTOCOL for port ranges."
|
|
required: false
|
|
default: null
|
|
rich_rule:
|
|
description:
|
|
- "Rich rule to add/remove to/from firewalld."
|
|
required: false
|
|
default: null
|
|
source:
|
|
description:
|
|
- 'The source/network you would like to add/remove to/from firewalld'
|
|
required: false
|
|
default: null
|
|
version_added: "2.0"
|
|
interface:
|
|
description:
|
|
- 'The interface you would like to add/remove to/from a zone in firewalld'
|
|
required: false
|
|
default: null
|
|
version_added: "2.1"
|
|
zone:
|
|
description:
|
|
- 'The firewalld zone to add/remove to/from (NOTE: default zone can be configured per system but "public" is default from upstream. Available choices can be extended based on per-system configs, listed here are "out of the box" defaults).'
|
|
required: false
|
|
default: system-default(public)
|
|
choices: [ "work", "drop", "internal", "external", "trusted", "home", "dmz", "public", "block" ]
|
|
permanent:
|
|
description:
|
|
- "Should this configuration be in the running firewalld configuration or persist across reboots."
|
|
required: false
|
|
default: null
|
|
immediate:
|
|
description:
|
|
- "Should this configuration be applied immediately, if set as permanent"
|
|
required: false
|
|
default: false
|
|
version_added: "1.9"
|
|
state:
|
|
description:
|
|
- "Should this port accept(enabled) or reject(disabled) connections."
|
|
required: true
|
|
choices: [ "enabled", "disabled" ]
|
|
timeout:
|
|
description:
|
|
- "The amount of time the rule should be in effect for when non-permanent."
|
|
required: false
|
|
default: 0
|
|
notes:
|
|
- Not tested on any Debian based system.
|
|
- Requires the python2 bindings of firewalld, who may not be installed by default if the distribution switched to python 3
|
|
requirements: [ 'firewalld >= 0.2.11' ]
|
|
author: "Adam Miller (@maxamillion)"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- firewalld: service=https permanent=true state=enabled
|
|
- firewalld: port=8081/tcp permanent=true state=disabled
|
|
- firewalld: port=161-162/udp permanent=true state=enabled
|
|
- firewalld: zone=dmz service=http permanent=true state=enabled
|
|
- firewalld: rich_rule='rule service name="ftp" audit limit value="1/m" accept' permanent=true state=enabled
|
|
- firewalld: source='192.168.1.0/24' zone=internal state=enabled
|
|
- firewalld: zone=trusted interface=eth2 permanent=true state=enabled
|
|
'''
|
|
|
|
import os
|
|
import re
|
|
|
|
try:
|
|
import firewall.config
|
|
FW_VERSION = firewall.config.VERSION
|
|
|
|
from firewall.client import Rich_Rule
|
|
from firewall.client import FirewallClient
|
|
fw = FirewallClient()
|
|
if not fw.connected:
|
|
HAS_FIREWALLD = False
|
|
else:
|
|
HAS_FIREWALLD = True
|
|
except ImportError:
|
|
HAS_FIREWALLD = False
|
|
|
|
################
|
|
# port handling
|
|
#
|
|
def get_port_enabled(zone, port_proto):
|
|
if port_proto in fw.getPorts(zone):
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def set_port_enabled(zone, port, protocol, timeout):
|
|
fw.addPort(zone, port, protocol, timeout)
|
|
|
|
def set_port_disabled(zone, port, protocol):
|
|
fw.removePort(zone, port, protocol)
|
|
|
|
def get_port_enabled_permanent(zone, port_proto):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
if tuple(port_proto) in fw_settings.getPorts():
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def set_port_enabled_permanent(zone, port, protocol):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
fw_settings.addPort(port, protocol)
|
|
fw_zone.update(fw_settings)
|
|
|
|
def set_port_disabled_permanent(zone, port, protocol):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
fw_settings.removePort(port, protocol)
|
|
fw_zone.update(fw_settings)
|
|
|
|
####################
|
|
# source handling
|
|
#
|
|
def get_source(zone, source):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
if source in fw_settings.getSources():
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def add_source(zone, source):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
fw_settings.addSource(source)
|
|
fw_zone.update(fw_settings)
|
|
|
|
def remove_source(zone, source):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
fw_settings.removeSource(source)
|
|
fw_zone.update(fw_settings)
|
|
|
|
####################
|
|
# interface handling
|
|
#
|
|
def get_interface(zone, interface):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
if interface in fw_settings.getInterfaces():
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def add_interface(zone, interface):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
fw_settings.addInterface(interface)
|
|
fw_zone.update(fw_settings)
|
|
|
|
def remove_interface(zone, interface):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
fw_settings.removeInterface(interface)
|
|
fw_zone.update(fw_settings)
|
|
|
|
####################
|
|
# service handling
|
|
#
|
|
def get_service_enabled(zone, service):
|
|
if service in fw.getServices(zone):
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def set_service_enabled(zone, service, timeout):
|
|
fw.addService(zone, service, timeout)
|
|
|
|
def set_service_disabled(zone, service):
|
|
fw.removeService(zone, service)
|
|
|
|
def get_service_enabled_permanent(zone, service):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
if service in fw_settings.getServices():
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def set_service_enabled_permanent(zone, service):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
fw_settings.addService(service)
|
|
fw_zone.update(fw_settings)
|
|
|
|
def set_service_disabled_permanent(zone, service):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
fw_settings.removeService(service)
|
|
fw_zone.update(fw_settings)
|
|
|
|
|
|
####################
|
|
# rich rule handling
|
|
#
|
|
def get_rich_rule_enabled(zone, rule):
|
|
# Convert the rule string to standard format
|
|
# before checking whether it is present
|
|
rule = str(Rich_Rule(rule_str=rule))
|
|
if rule in fw.getRichRules(zone):
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def set_rich_rule_enabled(zone, rule, timeout):
|
|
fw.addRichRule(zone, rule, timeout)
|
|
|
|
def set_rich_rule_disabled(zone, rule):
|
|
fw.removeRichRule(zone, rule)
|
|
|
|
def get_rich_rule_enabled_permanent(zone, rule):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
# Convert the rule string to standard format
|
|
# before checking whether it is present
|
|
rule = str(Rich_Rule(rule_str=rule))
|
|
if rule in fw_settings.getRichRules():
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def set_rich_rule_enabled_permanent(zone, rule):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
fw_settings.addRichRule(rule)
|
|
fw_zone.update(fw_settings)
|
|
|
|
def set_rich_rule_disabled_permanent(zone, rule):
|
|
fw_zone = fw.config().getZoneByName(zone)
|
|
fw_settings = fw_zone.getSettings()
|
|
fw_settings.removeRichRule(rule)
|
|
fw_zone.update(fw_settings)
|
|
|
|
|
|
def main():
|
|
|
|
module = AnsibleModule(
|
|
argument_spec = dict(
|
|
service=dict(required=False,default=None),
|
|
port=dict(required=False,default=None),
|
|
rich_rule=dict(required=False,default=None),
|
|
zone=dict(required=False,default=None),
|
|
immediate=dict(type='bool',default=False),
|
|
source=dict(required=False,default=None),
|
|
permanent=dict(type='bool',required=False,default=None),
|
|
state=dict(choices=['enabled', 'disabled'], required=True),
|
|
timeout=dict(type='int',required=False,default=0),
|
|
interface=dict(required=False,default=None),
|
|
),
|
|
supports_check_mode=True
|
|
)
|
|
if module.params['source'] == None and module.params['permanent'] == None:
|
|
module.fail_json(msg='permanent is a required parameter')
|
|
|
|
if module.params['interface'] != None and module.params['zone'] == None:
|
|
module.fail(msg='zone is a required parameter')
|
|
|
|
if not HAS_FIREWALLD:
|
|
module.fail_json(msg='firewalld and its python 2 module are required for this module')
|
|
|
|
## Pre-run version checking
|
|
if FW_VERSION < "0.2.11":
|
|
module.fail_json(msg='unsupported version of firewalld, requires >= 2.0.11')
|
|
|
|
## Global Vars
|
|
changed=False
|
|
msgs = []
|
|
service = module.params['service']
|
|
rich_rule = module.params['rich_rule']
|
|
source = module.params['source']
|
|
|
|
if module.params['port'] != None:
|
|
port, protocol = module.params['port'].split('/')
|
|
if protocol == None:
|
|
module.fail_json(msg='improper port format (missing protocol?)')
|
|
else:
|
|
port = None
|
|
|
|
if module.params['zone'] != None:
|
|
zone = module.params['zone']
|
|
else:
|
|
zone = fw.getDefaultZone()
|
|
|
|
permanent = module.params['permanent']
|
|
desired_state = module.params['state']
|
|
immediate = module.params['immediate']
|
|
timeout = module.params['timeout']
|
|
interface = module.params['interface']
|
|
|
|
## Check for firewalld running
|
|
try:
|
|
if fw.connected == False:
|
|
module.fail_json(msg='firewalld service must be running')
|
|
except AttributeError:
|
|
module.fail_json(msg="firewalld connection can't be established,\
|
|
version likely too old. Requires firewalld >= 2.0.11")
|
|
|
|
modification_count = 0
|
|
if service != None:
|
|
modification_count += 1
|
|
if port != None:
|
|
modification_count += 1
|
|
if rich_rule != None:
|
|
modification_count += 1
|
|
if interface != None:
|
|
modification_count += 1
|
|
|
|
if modification_count > 1:
|
|
module.fail_json(msg='can only operate on port, service, rich_rule or interface at once')
|
|
|
|
if service != None:
|
|
if permanent:
|
|
is_enabled = get_service_enabled_permanent(zone, service)
|
|
msgs.append('Permanent operation')
|
|
|
|
if desired_state == "enabled":
|
|
if is_enabled == False:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_service_enabled_permanent(zone, service)
|
|
changed=True
|
|
elif desired_state == "disabled":
|
|
if is_enabled == True:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_service_disabled_permanent(zone, service)
|
|
changed=True
|
|
if immediate or not permanent:
|
|
is_enabled = get_service_enabled(zone, service)
|
|
msgs.append('Non-permanent operation')
|
|
|
|
|
|
if desired_state == "enabled":
|
|
if is_enabled == False:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_service_enabled(zone, service, timeout)
|
|
changed=True
|
|
elif desired_state == "disabled":
|
|
if is_enabled == True:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_service_disabled(zone, service)
|
|
changed=True
|
|
|
|
if changed == True:
|
|
msgs.append("Changed service %s to %s" % (service, desired_state))
|
|
|
|
if source != None:
|
|
is_enabled = get_source(zone, source)
|
|
if desired_state == "enabled":
|
|
if is_enabled == False:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
add_source(zone, source)
|
|
changed=True
|
|
msgs.append("Added %s to zone %s" % (source, zone))
|
|
elif desired_state == "disabled":
|
|
if is_enabled == True:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
remove_source(zone, source)
|
|
changed=True
|
|
msgs.append("Removed %s from zone %s" % (source, zone))
|
|
|
|
if port != None:
|
|
if permanent:
|
|
is_enabled = get_port_enabled_permanent(zone, [port, protocol])
|
|
msgs.append('Permanent operation')
|
|
|
|
if desired_state == "enabled":
|
|
if is_enabled == False:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_port_enabled_permanent(zone, port, protocol)
|
|
changed=True
|
|
elif desired_state == "disabled":
|
|
if is_enabled == True:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_port_disabled_permanent(zone, port, protocol)
|
|
changed=True
|
|
if immediate or not permanent:
|
|
is_enabled = get_port_enabled(zone, [port,protocol])
|
|
msgs.append('Non-permanent operation')
|
|
|
|
if desired_state == "enabled":
|
|
if is_enabled == False:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_port_enabled(zone, port, protocol, timeout)
|
|
changed=True
|
|
elif desired_state == "disabled":
|
|
if is_enabled == True:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_port_disabled(zone, port, protocol)
|
|
changed=True
|
|
|
|
if changed == True:
|
|
msgs.append("Changed port %s to %s" % ("%s/%s" % (port, protocol), \
|
|
desired_state))
|
|
|
|
if rich_rule != None:
|
|
if permanent:
|
|
is_enabled = get_rich_rule_enabled_permanent(zone, rich_rule)
|
|
msgs.append('Permanent operation')
|
|
|
|
if desired_state == "enabled":
|
|
if is_enabled == False:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_rich_rule_enabled_permanent(zone, rich_rule)
|
|
changed=True
|
|
elif desired_state == "disabled":
|
|
if is_enabled == True:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_rich_rule_disabled_permanent(zone, rich_rule)
|
|
changed=True
|
|
if immediate or not permanent:
|
|
is_enabled = get_rich_rule_enabled(zone, rich_rule)
|
|
msgs.append('Non-permanent operation')
|
|
|
|
if desired_state == "enabled":
|
|
if is_enabled == False:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_rich_rule_enabled(zone, rich_rule, timeout)
|
|
changed=True
|
|
elif desired_state == "disabled":
|
|
if is_enabled == True:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
set_rich_rule_disabled(zone, rich_rule)
|
|
changed=True
|
|
|
|
if changed == True:
|
|
msgs.append("Changed rich_rule %s to %s" % (rich_rule, desired_state))
|
|
|
|
if interface != None:
|
|
is_enabled = get_interface(zone, interface)
|
|
if desired_state == "enabled":
|
|
if is_enabled == False:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
add_interface(zone, interface)
|
|
changed=True
|
|
msgs.append("Added %s to zone %s" % (interface, zone))
|
|
elif desired_state == "disabled":
|
|
if is_enabled == True:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True)
|
|
|
|
remove_interface(zone, interface)
|
|
changed=True
|
|
msgs.append("Removed %s from zone %s" % (interface, zone))
|
|
|
|
module.exit_json(changed=changed, msg=', '.join(msgs))
|
|
|
|
|
|
#################################################
|
|
# import module snippets
|
|
from ansible.module_utils.basic import *
|
|
main()
|