Merge pull request #374 from resmo/feature/cloudstack_sg_rule
cloudstack: add new module cs_securitygroup_rule
This commit is contained in:
Brian Coca
commit
02242f5fca
1 changed files with 437 additions and 0 deletions
437
cloud/cloudstack/cs_securitygroup_rule.py
Normal file
437
cloud/cloudstack/cs_securitygroup_rule.py
Normal file
|
|
@ -0,0 +1,437 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# (c) 2015, René Moser <mail@renemoser.net>
|
||||
#
|
||||
# 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: cs_securitygroup_rule
|
||||
short_description: Manages security group rules on Apache CloudStack based clouds.
|
||||
description: Add and remove security group rules.
|
||||
version_added: '2.0'
|
||||
author: René Moser
|
||||
options:
|
||||
security_group:
|
||||
description:
|
||||
- Name of the security group the rule is related to. The security group must be existing.
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- State of the security group rule.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
protocol:
|
||||
description:
|
||||
- Protocol of the security group rule.
|
||||
required: false
|
||||
default: 'tcp'
|
||||
choices: [ 'tcp', 'udp', 'icmp', 'ah', 'esp', 'gre' ]
|
||||
type:
|
||||
description:
|
||||
- Ingress or egress security group rule.
|
||||
required: false
|
||||
default: 'ingress'
|
||||
choices: [ 'ingress', 'egress' ]
|
||||
cidr:
|
||||
description:
|
||||
- CIDR (full notation) to be used for security group rule.
|
||||
required: false
|
||||
default: '0.0.0.0/0'
|
||||
user_security_group
|
||||
description:
|
||||
- Security group this rule is based of.
|
||||
required: false
|
||||
default: null
|
||||
start_port
|
||||
description:
|
||||
- Start port for this rule. Required if C(protocol=tcp) or C(protocol=udp).
|
||||
required: false
|
||||
default: null
|
||||
aliases: [ 'port' ]
|
||||
end_port
|
||||
description:
|
||||
- End port for this rule. Required if C(protocol=tcp) or C(protocol=udp), but C(start_port) will be used if not set.
|
||||
required: false
|
||||
default: null
|
||||
icmp_type
|
||||
description:
|
||||
- Type of the icmp message being sent. Required if C(protocol=icmp).
|
||||
required: false
|
||||
default: null
|
||||
icmp_code
|
||||
description:
|
||||
- Error code for this icmp message. Required if C(protocol=icmp).
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the security group to be created in.
|
||||
required: false
|
||||
default: null
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
---
|
||||
# Allow inbound port 80/tcp from 1.2.3.4 added to security group 'default'
|
||||
- local_action:
|
||||
module: cs_securitygroup_rule
|
||||
security_group: default
|
||||
port: 80
|
||||
cidr: 1.2.3.4/32
|
||||
|
||||
|
||||
# Allow tcp/udp outbound added to security group 'default'
|
||||
- local_action:
|
||||
module: cs_securitygroup_rule
|
||||
security_group: default
|
||||
type: egress
|
||||
start_port: 1
|
||||
end_port: 65535
|
||||
protocol: '{{ item }}'
|
||||
with_items:
|
||||
- tcp
|
||||
- udp
|
||||
|
||||
|
||||
# Allow inbound icmp from 0.0.0.0/0 added to security group 'default'
|
||||
- local_action:
|
||||
module: cs_securitygroup_rule
|
||||
security_group: default
|
||||
protocol: icmp
|
||||
icmp_code: -1
|
||||
icmp_type: -1
|
||||
|
||||
|
||||
# Remove rule inbound port 80/tcp from 0.0.0.0/0 from security group 'default'
|
||||
- local_action:
|
||||
module: cs_securitygroup_rule
|
||||
security_group: default
|
||||
port: 80
|
||||
state: absent
|
||||
|
||||
|
||||
# Allow inbound port 80/tcp from security group web added to security group 'default'
|
||||
- local_action:
|
||||
module: cs_securitygroup_rule
|
||||
security_group: default
|
||||
port: 80
|
||||
user_security_group: web
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
---
|
||||
security_group:
|
||||
description: security group of the rule.
|
||||
returned: success
|
||||
type: string
|
||||
sample: default
|
||||
type:
|
||||
description: type of the rule.
|
||||
returned: success
|
||||
type: string
|
||||
sample: ingress
|
||||
cidr:
|
||||
description: CIDR of the rule.
|
||||
returned: success and cidr is defined
|
||||
type: string
|
||||
sample: 0.0.0.0/0
|
||||
user_security_group:
|
||||
description: user security group of the rule.
|
||||
returned: success and user_security_group is defined
|
||||
type: string
|
||||
sample: default
|
||||
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
|
||||
'''
|
||||
|
||||
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 AnsibleCloudStackSecurityGroupRule(AnsibleCloudStack):
|
||||
|
||||
def __init__(self, module):
|
||||
AnsibleCloudStack.__init__(self, module)
|
||||
self.result = {
|
||||
'changed': False,
|
||||
}
|
||||
|
||||
|
||||
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 _icmp_match(self, rule, protocol, icmp_code, icmp_type):
|
||||
return protocol == 'icmp' \
|
||||
and protocol == rule['protocol'] \
|
||||
and icmp_code == int(rule['icmpcode']) \
|
||||
and icmp_type == int(rule['icmptype'])
|
||||
|
||||
|
||||
def _ah_esp_gre_match(self, rule, protocol):
|
||||
return protocol in ['ah', 'esp', 'gre'] \
|
||||
and protocol == rule['protocol']
|
||||
|
||||
|
||||
def _type_security_group_match(self, rule, security_group_name):
|
||||
return security_group_name \
|
||||
and 'securitygroupname' in rule \
|
||||
and security_group_name == rule['securitygroupname']
|
||||
|
||||
|
||||
def _type_cidr_match(self, rule, cidr):
|
||||
return 'cidr' in rule \
|
||||
and cidr == rule['cidr']
|
||||
|
||||
|
||||
def _get_rule(self, rules):
|
||||
user_security_group_name = self.module.params.get('user_security_group')
|
||||
cidr = self.module.params.get('cidr')
|
||||
protocol = self.module.params.get('protocol')
|
||||
start_port = self.module.params.get('start_port')
|
||||
end_port = self.module.params.get('end_port')
|
||||
icmp_code = self.module.params.get('icmp_code')
|
||||
icmp_type = self.module.params.get('icmp_type')
|
||||
|
||||
if not end_port:
|
||||
end_port = start_port
|
||||
|
||||
if protocol in ['tcp', 'udp'] and not (start_port and end_port):
|
||||
self.module.fail_json(msg="no start_port or end_port set for protocol '%s'" % protocol)
|
||||
|
||||
if protocol == 'icmp' and not (icmp_type and icmp_code):
|
||||
self.module.fail_json(msg="no icmp_type or icmp_code set for protocol '%s'" % protocol)
|
||||
|
||||
for rule in rules:
|
||||
if user_security_group_name:
|
||||
type_match = self._type_security_group_match(rule, user_security_group_name)
|
||||
else:
|
||||
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._ah_esp_gre_match(rule, protocol)
|
||||
)
|
||||
|
||||
if type_match and protocol_match:
|
||||
return rule
|
||||
return None
|
||||
|
||||
|
||||
def get_security_group(self, security_group_name=None):
|
||||
if not security_group_name:
|
||||
security_group_name = self.module.params.get('security_group')
|
||||
args = {}
|
||||
args['securitygroupname'] = security_group_name
|
||||
args['projectid'] = self.get_project_id()
|
||||
sgs = self.cs.listSecurityGroups(**args)
|
||||
if not sgs or 'securitygroup' not in sgs:
|
||||
self.module.fail_json(msg="security group '%s' not found" % security_group_name)
|
||||
return sgs['securitygroup'][0]
|
||||
|
||||
|
||||
def add_rule(self):
|
||||
security_group = self.get_security_group()
|
||||
|
||||
args = {}
|
||||
user_security_group_name = self.module.params.get('user_security_group')
|
||||
|
||||
# the user_security_group and cidr are mutually_exclusive, but cidr is defaulted to 0.0.0.0/0.
|
||||
# that is why we ignore if we have a user_security_group.
|
||||
if user_security_group_name:
|
||||
args['usersecuritygrouplist'] = []
|
||||
user_security_group = self.get_security_group(user_security_group_name)
|
||||
args['usersecuritygrouplist'].append({
|
||||
'group': user_security_group['name'],
|
||||
'account': user_security_group['account'],
|
||||
})
|
||||
else:
|
||||
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.module.params.get('end_port')
|
||||
args['icmptype'] = self.module.params.get('icmp_type')
|
||||
args['icmpcode'] = self.module.params.get('icmp_code')
|
||||
args['projectid'] = self.get_project_id()
|
||||
args['securitygroupid'] = security_group['id']
|
||||
|
||||
if not args['endport']:
|
||||
args['endport'] = args['startport']
|
||||
|
||||
rule = None
|
||||
res = None
|
||||
type = self.module.params.get('type')
|
||||
if type == 'ingress':
|
||||
rule = self._get_rule(security_group['ingressrule'])
|
||||
if not rule:
|
||||
self.result['changed'] = True
|
||||
if not self.module.check_mode:
|
||||
res = self.cs.authorizeSecurityGroupIngress(**args)
|
||||
|
||||
elif type == 'egress':
|
||||
rule = self._get_rule(security_group['egressrule'])
|
||||
if not rule:
|
||||
self.result['changed'] = True
|
||||
if not self.module.check_mode:
|
||||
res = self.cs.authorizeSecurityGroupEgress(**args)
|
||||
|
||||
if res and 'errortext' in res:
|
||||
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
|
||||
|
||||
poll_async = self.module.params.get('poll_async')
|
||||
if res and poll_async:
|
||||
security_group = self._poll_job(res, 'securitygroup')
|
||||
return security_group
|
||||
|
||||
|
||||
def remove_rule(self):
|
||||
security_group = self.get_security_group()
|
||||
rule = None
|
||||
res = None
|
||||
type = self.module.params.get('type')
|
||||
if type == 'ingress':
|
||||
rule = self._get_rule(security_group['ingressrule'])
|
||||
if rule:
|
||||
self.result['changed'] = True
|
||||
if not self.module.check_mode:
|
||||
res = self.cs.revokeSecurityGroupIngress(id=rule['ruleid'])
|
||||
|
||||
elif type == 'egress':
|
||||
rule = self._get_rule(security_group['egressrule'])
|
||||
if rule:
|
||||
self.result['changed'] = True
|
||||
if not self.module.check_mode:
|
||||
res = self.cs.revokeSecurityGroupEgress(id=rule['ruleid'])
|
||||
|
||||
if res and 'errortext' in res:
|
||||
self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
|
||||
|
||||
poll_async = self.module.params.get('poll_async')
|
||||
if res and poll_async:
|
||||
res = self._poll_job(res, 'securitygroup')
|
||||
return security_group
|
||||
|
||||
|
||||
def get_result(self, security_group_rule):
|
||||
type = self.module.params.get('type')
|
||||
|
||||
key = 'ingressrule'
|
||||
if type == 'egress':
|
||||
key = 'egressrule'
|
||||
|
||||
self.result['type'] = type
|
||||
self.result['security_group'] = self.module.params.get('security_group')
|
||||
|
||||
if key in security_group_rule and security_group_rule[key]:
|
||||
if 'securitygroupname' in security_group_rule[key][0]:
|
||||
self.result['user_security_group'] = security_group_rule[key][0]['securitygroupname']
|
||||
if 'cidr' in security_group_rule[key][0]:
|
||||
self.result['cidr'] = security_group_rule[key][0]['cidr']
|
||||
if 'protocol' in security_group_rule[key][0]:
|
||||
self.result['protocol'] = security_group_rule[key][0]['protocol']
|
||||
if 'startport' in security_group_rule[key][0]:
|
||||
self.result['start_port'] = security_group_rule[key][0]['startport']
|
||||
if 'endport' in security_group_rule[key][0]:
|
||||
self.result['end_port'] = security_group_rule[key][0]['endport']
|
||||
if 'icmpcode' in security_group_rule[key][0]:
|
||||
self.result['icmp_code'] = security_group_rule[key][0]['icmpcode']
|
||||
if 'icmptype' in security_group_rule[key][0]:
|
||||
self.result['icmp_type'] = security_group_rule[key][0]['icmptype']
|
||||
return self.result
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec = dict(
|
||||
security_group = dict(required=True),
|
||||
type = dict(choices=['ingress', 'egress'], default='ingress'),
|
||||
cidr = dict(default='0.0.0.0/0'),
|
||||
user_security_group = dict(default=None),
|
||||
protocol = dict(choices=['tcp', 'udp', 'icmp', 'ah', 'esp', 'gre'], default='tcp'),
|
||||
icmp_type = dict(type='int', default=None),
|
||||
icmp_code = dict(type='int', default=None),
|
||||
start_port = dict(type='int', default=None, aliases=['port']),
|
||||
end_port = dict(type='int', default=None),
|
||||
state = dict(choices=['present', 'absent'], default='present'),
|
||||
project = dict(default=None),
|
||||
poll_async = dict(choices=BOOLEANS, default=True),
|
||||
api_key = dict(default=None),
|
||||
api_secret = dict(default=None),
|
||||
api_url = dict(default=None),
|
||||
api_http_method = dict(default='get'),
|
||||
),
|
||||
mutually_exclusive = (
|
||||
['icmp_type', 'start_port'],
|
||||
['icmp_type', 'end_port'],
|
||||
['icmp_code', 'start_port'],
|
||||
['icmp_code', 'end_port'],
|
||||
),
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
if not has_lib_cs:
|
||||
module.fail_json(msg="python library cs required: pip install cs")
|
||||
|
||||
try:
|
||||
acs_sg_rule = AnsibleCloudStackSecurityGroupRule(module)
|
||||
|
||||
state = module.params.get('state')
|
||||
if state in ['absent']:
|
||||
sg_rule = acs_sg_rule.remove_rule()
|
||||
else:
|
||||
sg_rule = acs_sg_rule.add_rule()
|
||||
|
||||
result = acs_sg_rule.get_result(sg_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 *
|
||||
main()
|
||||
Loading…
Reference in a new issue