#!/usr/bin/python # -*- coding: utf-8 -*- # # (c) 2015, René Moser # # 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 . DOCUMENTATION = ''' --- module: cs_firewall short_description: Manages firewall rules on Apache CloudStack based clouds. description: - Creates and removes firewall rules. version_added: '2.0' author: "René Moser (@resmo)" options: ip_address: description: - Public IP address the ingress rule is assigned to. - Required if C(type=ingress). required: false default: null network: description: - Network the egress rule is related to. - Required if C(type=egress). required: false default: null state: description: - State of the firewall rule. required: false default: 'present' choices: [ 'present', 'absent' ] type: description: - Type of the firewall rule. required: false default: 'ingress' choices: [ 'ingress', 'egress' ] protocol: description: - Protocol of the firewall rule. - C(all) is only available if C(type=egress) required: false default: 'tcp' choices: [ 'tcp', 'udp', 'icmp', 'all' ] cidr: description: - CIDR (full notation) to be used for firewall rule. required: false default: '0.0.0.0/0' start_port: description: - Start port for this rule. Considered if C(protocol=tcp) or C(protocol=udp). required: false default: null aliases: [ 'port' ] end_port: description: - End port for this rule. Considered if C(protocol=tcp) or C(protocol=udp). If not specified, equal C(start_port). required: false default: null icmp_type: description: - Type of the icmp message being sent. Considered if C(protocol=icmp). required: false default: null icmp_code: description: - Error code for this icmp message. Considered if C(protocol=icmp). required: false default: null domain: description: - Domain the firewall rule is related to. required: false default: null account: description: - Account the firewall rule is related to. required: false default: null project: description: - Name of the project the firewall rule is related to. required: false default: null zone: description: - Name of the zone in which the virtual machine is in. - If not set, default zone is used. required: false default: null poll_async: description: - Poll async jobs until job has finished. required: false default: true extends_documentation_fragment: cloudstack ''' EXAMPLES = ''' # Allow inbound port 80/tcp from 1.2.3.4 to 4.3.2.1 - local_action: module: cs_firewall ip_address: 4.3.2.1 port: 80 cidr: 1.2.3.4/32 # Allow inbound tcp/udp port 53 to 4.3.2.1 - local_action: module: cs_firewall ip_address: 4.3.2.1 port: 53 protocol: '{{ item }}' with_items: - tcp - udp # Ensure firewall rule is removed - local_action: module: cs_firewall ip_address: 4.3.2.1 start_port: 8000 end_port: 8888 cidr: 17.0.0.0/8 state: absent # Allow all outbound traffic - local_action: module: cs_firewall network: my_network type: egress protocol: all # Allow only HTTP outbound traffic for an IP - local_action: module: cs_firewall network: my_network type: egress port: 80 cidr: 10.101.1.20 ''' RETURN = ''' --- id: description: UUID of the rule. returned: success type: string sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 ip_address: description: IP address of the rule if C(type=ingress) returned: success type: string sample: 10.100.212.10 type: description: Type of the rule. returned: success type: string sample: ingress cidr: description: CIDR of the rule. returned: success type: string sample: 0.0.0.0/0 protocol: description: Protocol of the rule. returned: success type: string sample: tcp start_port: description: Start port of the rule. returned: success type: int sample: 80 end_port: description: End port of the rule. returned: success type: int sample: 80 icmp_code: description: ICMP code of the rule. returned: success type: int sample: 1 icmp_type: description: ICMP type of the rule. returned: success type: int sample: 1 network: description: Name of the network if C(type=egress) returned: success type: string sample: my_network ''' try: from cs import CloudStack, CloudStackException, read_config has_lib_cs = True except ImportError: has_lib_cs = False # import cloudstack common from ansible.module_utils.cloudstack import * class AnsibleCloudStackFirewall(AnsibleCloudStack): def __init__(self, module): super(AnsibleCloudStackFirewall, self).__init__(module) self.returns = { 'cidrlist': 'cidr', 'startport': 'start_port', 'endpoint': 'end_port', 'protocol': 'protocol', 'ipaddress': 'ip_address', 'icmpcode': 'icmp_code', 'icmptype': 'icmp_type', } self.firewall_rule = None def get_firewall_rule(self): if not self.firewall_rule: cidr = self.module.params.get('cidr') protocol = self.module.params.get('protocol') start_port = self.module.params.get('start_port') end_port = self.get_or_fallback('end_port', 'start_port') icmp_code = self.module.params.get('icmp_code') icmp_type = self.module.params.get('icmp_type') fw_type = self.module.params.get('type') if protocol in ['tcp', 'udp'] and not (start_port and end_port): self.module.fail_json(msg="missing required argument for protocol '%s': start_port or end_port" % protocol) if protocol == 'icmp' and not icmp_type: self.module.fail_json(msg="missing required argument for protocol 'icmp': icmp_type") if protocol == 'all' and fw_type != 'egress': self.module.fail_json(msg="protocol 'all' could only be used for type 'egress'" ) args = {} args['account'] = self.get_account('name') args['domainid'] = self.get_domain('id') args['projectid'] = self.get_project('id') if fw_type == 'egress': args['networkid'] = self.get_network(key='id') if not args['networkid']: self.module.fail_json(msg="missing required argument for type egress: network") firewall_rules = self.cs.listEgressFirewallRules(**args) else: args['ipaddressid'] = self.get_ip_address('id') if not args['ipaddressid']: self.module.fail_json(msg="missing required argument for type ingress: ip_address") firewall_rules = self.cs.listFirewallRules(**args) if firewall_rules and 'firewallrule' in firewall_rules: for rule in firewall_rules['firewallrule']: type_match = self._type_cidr_match(rule, cidr) protocol_match = self._tcp_udp_match(rule, protocol, start_port, end_port) \ or self._icmp_match(rule, protocol, icmp_code, icmp_type) \ or self._egress_all_match(rule, protocol, fw_type) if type_match and protocol_match: self.firewall_rule = rule break return self.firewall_rule def _tcp_udp_match(self, rule, protocol, start_port, end_port): return protocol in ['tcp', 'udp'] \ and protocol == rule['protocol'] \ and start_port == int(rule['startport']) \ and end_port == int(rule['endport']) def _egress_all_match(self, rule, protocol, fw_type): return protocol in ['all'] \ and protocol == rule['protocol'] \ and fw_type == 'egress' def _icmp_match(self, rule, protocol, icmp_code, icmp_type): return protocol == 'icmp' \ and protocol == rule['protocol'] \ and icmp_code == rule['icmpcode'] \ and icmp_type == rule['icmptype'] def _type_cidr_match(self, rule, cidr): return cidr == rule['cidrlist'] def get_network(self, key=None, network=None): if not network: network = self.module.params.get('network') if not network: return None args = {} args['account'] = self.get_account('name') args['domainid'] = self.get_domain('id') args['projectid'] = self.get_project('id') args['zoneid'] = self.get_zone('id') networks = self.cs.listNetworks(**args) if not networks: self.module.fail_json(msg="No networks available") for n in networks['network']: if network in [ n['displaytext'], n['name'], n['id'] ]: return self._get_by_key(key, n) break self.module.fail_json(msg="Network '%s' not found" % network) def create_firewall_rule(self): firewall_rule = self.get_firewall_rule() if not firewall_rule: self.result['changed'] = True args = {} args['cidrlist'] = self.module.params.get('cidr') args['protocol'] = self.module.params.get('protocol') args['startport'] = self.module.params.get('start_port') args['endport'] = self.get_or_fallback('end_port', 'start_port') args['icmptype'] = self.module.params.get('icmp_type') args['icmpcode'] = self.module.params.get('icmp_code') fw_type = self.module.params.get('type') if not self.module.check_mode: if fw_type == 'egress': args['networkid'] = self.get_network(key='id') res = self.cs.createEgressFirewallRule(**args) else: args['ipaddressid'] = self.get_ip_address('id') res = self.cs.createFirewallRule(**args) if 'errortext' in res: self.module.fail_json(msg="Failed: '%s'" % res['errortext']) poll_async = self.module.params.get('poll_async') if poll_async: firewall_rule = self._poll_job(res, 'firewallrule') return firewall_rule def remove_firewall_rule(self): firewall_rule = self.get_firewall_rule() if firewall_rule: self.result['changed'] = True args = {} args['id'] = firewall_rule['id'] fw_type = self.module.params.get('type') if not self.module.check_mode: if fw_type == 'egress': res = self.cs.deleteEgressFirewallRule(**args) else: res = self.cs.deleteFirewallRule(**args) if 'errortext' in res: self.module.fail_json(msg="Failed: '%s'" % res['errortext']) poll_async = self.module.params.get('poll_async') if poll_async: res = self._poll_job(res, 'firewallrule') return firewall_rule def get_result(self, firewall_rule): super(AnsibleCloudStackFirewall, self).get_result(firewall_rule) if firewall_rule: self.result['type'] = self.module.params.get('type') if 'networkid' in firewall_rule: self.result['network'] = self.get_network(key='displaytext', network=firewall_rule['networkid']) return self.result def main(): argument_spec = cs_argument_spec() argument_spec.update(dict( ip_address = dict(default=None), network = dict(default=None), cidr = dict(default='0.0.0.0/0'), protocol = dict(choices=['tcp', 'udp', 'icmp', 'all'], default='tcp'), type = dict(choices=['ingress', 'egress'], default='ingress'), icmp_type = dict(type='int', default=None), icmp_code = dict(type='int', default=None), start_port = dict(type='int', aliases=['port'], default=None), end_port = dict(type='int', default=None), state = dict(choices=['present', 'absent'], default='present'), zone = dict(default=None), domain = dict(default=None), account = dict(default=None), project = dict(default=None), poll_async = dict(choices=BOOLEANS, default=True), )) required_together = cs_required_together() required_together.extend([ ['icmp_type', 'icmp_code'], ]) module = AnsibleModule( argument_spec=argument_spec, required_together=required_together, required_one_of = ( ['ip_address', 'network'], ), mutually_exclusive = ( ['icmp_type', 'start_port'], ['icmp_type', 'end_port'], ['ip_address', 'network'], ), supports_check_mode=True ) if not has_lib_cs: module.fail_json(msg="python library cs required: pip install cs") try: acs_fw = AnsibleCloudStackFirewall(module) state = module.params.get('state') if state in ['absent']: fw_rule = acs_fw.remove_firewall_rule() else: fw_rule = acs_fw.create_firewall_rule() result = acs_fw.get_result(fw_rule) except CloudStackException, e: module.fail_json(msg='CloudStackException: %s' % str(e)) module.exit_json(**result) # import module snippets from ansible.module_utils.basic import * if __name__ == '__main__': main()