Adds ipsec policy module for BIG-IP (#47785)

Allows users to manage IPSec policies on a BIG-IP

lib/ansible/modules/network/f5/bigip_ipsec_policy.py

@@ -0,0 +1,701 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright: (c) 2018, F5 Networks Inc.
+# 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': 'certified'}
+
+DOCUMENTATION = r'''
+---
+module: bigip_ipsec_policy
+short_description: Manage IPSec policies on a BIG-IP
+description:
+  - Manage IPSec policies on a BIG-IP.
+version_added: 2.8
+options:
+  name:
+    description:
+      - Specifies the name of the IPSec policy.
+    required: True
+  description:
+    description:
+      - Description of the policy
+  protocol:
+    description:
+      - Specifies the IPsec protocol
+      - Options include ESP (Encapsulating Security Protocol) or AH (Authentication Header).
+    choices:
+      - esp
+      - ah
+  mode:
+    description:
+      - Specifies the processing mode.
+      - When C(transport), specifies a mode that encapsulates only the payload (adding
+        an ESP header, trailer, and authentication tag).
+      - When C(tunnel), specifies a mode that includes encapsulation of the header as
+        well as the payload (adding a new IP header, in addition to adding an ESP header,
+        trailer, and authentication tag). If you select this option, you must also
+        provide IP addresses for the local and remote endpoints of the IPsec tunnel.
+      - When C(isession), specifies the use of iSession over an IPsec tunnel. To use
+        this option, you must also configure the iSession endpoints with IPsec in the
+        Acceleration section of the user interface.
+      - When C(interface), specifies that the IPsec policy can be used in the tunnel
+        profile for network interfaces.
+    choices:
+      - transport
+      - interface
+      - isession
+      - tunnel
+  tunnel_local_address:
+    description:
+      - Specifies the local endpoint IP address of the IPsec tunnel.
+      - This parameter is only valid when C(mode) is C(tunnel).
+  tunnel_remote_address:
+    description:
+      - Specifies the remote endpoint IP address of the IPsec tunnel.
+      - This parameter is only valid when C(mode) is C(tunnel).
+  encrypt_algorithm:
+    description:
+      - Specifies the algorithm to use for IKE encryption.
+    choices:
+      - none
+      - 3des
+      - aes128
+      - aes192
+      - aes256
+      - aes-gmac256
+      - aes-gmac192
+      - aes-gmac128
+      - aes-gcm256
+      - aes-gcm192
+      - aes-gcm256
+      - aes-gcm128
+  route_domain:
+    description:
+      - Specifies the route domain, when C(interface) is selected for the C(mode) setting.
+  auth_algorithm:
+    description:
+      - Specifies the algorithm to use for IKE authentication.
+    choices:
+      - sha1
+      - sha256
+      - sha384
+      - sha512
+      - aes-gcm128
+      - aes-gcm192
+      - aes-gcm256
+      - aes-gmac128
+      - aes-gmac192
+      - aes-gmac256
+  ipcomp:
+    description:
+      - Specifies whether to use IPComp encapsulation.
+      - When C(none), specifies that IPComp is disabled.
+      - When C(deflate), specifies that IPComp is enabled and uses the Deflate
+        compression algorithm.
+    choices:
+      - none
+      - "null"
+      - deflate
+  lifetime:
+    description:
+      - Specifies the length of time, in minutes, before the IKE security association
+        expires.
+  kb_lifetime:
+    description:
+      - Specifies the length of time, in kilobytes, before the IKE security association
+        expires.
+  perfect_forward_secrecy:
+    description:
+      - Specifies the Diffie-Hellman group to use for IKE Phase 2 negotiation.
+    choices:
+      - none
+      - modp768
+      - modp1024
+      - modp1536
+      - modp2048
+      - modp3072
+      - modp4096
+      - modp6144
+      - modp8192
+  partition:
+    description:
+      - Device partition to manage resources on.
+    default: Common
+  state:
+    description:
+      - When C(present), ensures that the resource exists.
+      - When C(absent), ensures the resource is removed.
+    default: present
+    choices:
+      - present
+      - absent
+extends_documentation_fragment: f5
+author:
+  - Tim Rupp (@caphrim007)
+'''
+
+EXAMPLES = r'''
+- name: Create a IPSec policy
+  bigip_ipsec_policy:
+    name: policy1
+    mode: tunnel
+    tunnel_local_address: 1.1.1.1
+    tunnel_remote_address: 2.2.2.
+    auth_algorithm: sha1
+    encrypt_algorithm: 3des
+    protocol: esp
+    perfect_forward_secrecy: modp1024
+    provider:
+      password: secret
+      server: lb.mydomain.com
+      user: admin
+  delegate_to: localhost
+'''
+
+RETURN = r'''
+auth_algorithm:
+  description: The new IKE Phase 2 Authentication Algorithm value.
+  returned: changed
+  type: string
+  sample: sha512
+encrypt_algorithm:
+  description: The new IKE Phase 2 Encryption Algorithm value.
+  returned: changed
+  type: string
+  sample: aes256
+lifetime:
+  description: The new IKE Phase 2 Lifetime value.
+  returned: changed
+  type: int
+  sample: 1440
+kb_lifetime:
+  description: The new IKE Phase 2 KB Lifetime value.
+  returned: changed
+  type: int
+  sample: 0
+perfect_forward_secrecy:
+  description: The new IKE Phase 2 Perfect Forward Secrecy value.
+  returned: changed
+  type: string
+  sample: modp2048
+tunnel_local_address:
+  description: The new Tunnel Local Address value.
+  returned: changed
+  type: string
+  sample: 1.2.2.1
+tunnel_remote_address:
+  description: The new Tunnel Remote Address value.
+  returned: changed
+  type: string
+  sample: 2.1.1.2
+mode:
+  description: The new Mode value.
+  returned: changed
+  type: string
+  sample: tunnel
+protocol:
+  description: The new IPsec Protocol value.
+  returned: changed
+  type: string
+  sample: ah
+ipcomp:
+  description: The new IKE Phase 2 IPComp value.
+  returned: changed
+  type: string
+  sample: deflate
+description:
+  description: The new description value.
+  returned: changed
+  type: string
+  sample: My policy
+route_domain:
+  description: The new Route Domain value when in Tunnel mode.
+  returned: changed
+  type: int
+  sample: 2
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+
+try:
+    from library.module_utils.network.f5.bigip import F5RestClient
+    from library.module_utils.network.f5.common import F5ModuleError
+    from library.module_utils.network.f5.common import AnsibleF5Parameters
+    from library.module_utils.network.f5.common import cleanup_tokens
+    from library.module_utils.network.f5.common import fq_name
+    from library.module_utils.network.f5.common import f5_argument_spec
+    from library.module_utils.network.f5.common import exit_json
+    from library.module_utils.network.f5.common import fail_json
+    from library.module_utils.network.f5.common import transform_name
+except ImportError:
+    from ansible.module_utils.network.f5.bigip import F5RestClient
+    from ansible.module_utils.network.f5.common import F5ModuleError
+    from ansible.module_utils.network.f5.common import AnsibleF5Parameters
+    from ansible.module_utils.network.f5.common import cleanup_tokens
+    from ansible.module_utils.network.f5.common import fq_name
+    from ansible.module_utils.network.f5.common import f5_argument_spec
+    from ansible.module_utils.network.f5.common import exit_json
+    from ansible.module_utils.network.f5.common import fail_json
+    from ansible.module_utils.network.f5.common import transform_name
+
+
+class Parameters(AnsibleF5Parameters):
+    api_map = {
+        'ikePhase2AuthAlgorithm': 'auth_algorithm',
+        'ikePhase2EncryptAlgorithm': 'encrypt_algorithm',
+        'ikePhase2Lifetime': 'lifetime',
+        'ikePhase2LifetimeKilobytes': 'kb_lifetime',
+        'ikePhase2PerfectForwardSecrecy': 'perfect_forward_secrecy',
+        'tunnelLocalAddress': 'tunnel_local_address',
+        'tunnelRemoteAddress': 'tunnel_remote_address',
+    }
+
+    api_attributes = [
+        'ikePhase2AuthAlgorithm',
+        'ikePhase2EncryptAlgorithm',
+        'ikePhase2Lifetime',
+        'ikePhase2LifetimeKilobytes',
+        'ikePhase2PerfectForwardSecrecy',
+        'tunnelLocalAddress',
+        'tunnelRemoteAddress',
+        'mode',
+        'protocol',
+        'ipcomp',
+        'description',
+    ]
+
+    returnables = [
+        'auth_algorithm',
+        'encrypt_algorithm',
+        'lifetime',
+        'kb_lifetime',
+        'perfect_forward_secrecy',
+        'tunnel_local_address',
+        'tunnel_remote_address',
+        'mode',
+        'protocol',
+        'ipcomp',
+        'description',
+        'route_domain',
+    ]
+
+    updatables = [
+        'auth_algorithm',
+        'encrypt_algorithm',
+        'lifetime',
+        'kb_lifetime',
+        'perfect_forward_secrecy',
+        'tunnel_local_address',
+        'tunnel_remote_address',
+        'mode',
+        'protocol',
+        'ipcomp',
+        'description',
+        'route_domain',
+    ]
+
+
+class ApiParameters(Parameters):
+    @property
+    def encrypt_algorithm(self):
+        if self._values['encrypt_algorithm'] is None:
+            return None
+        elif self._values['encrypt_algorithm'] == 'null':
+            return 'none'
+        return self._values['encrypt_algorithm']
+
+    @property
+    def description(self):
+        if self._values['description'] in [None, 'none']:
+            return None
+        return self._values['description']
+
+    @property
+    def route_domain(self):
+        if self.tunnel_local_address is None and self.tunnel_remote_address is None:
+            return None
+        elif self.tunnel_local_address is None and self.tunnel_remote_address is not None:
+            if self.tunnel_remote_address == 'any6':
+                result = 'any6'
+            else:
+                result = int(self.tunnel_remote_address.split('%')[1])
+        elif self.tunnel_remote_address is None and self.tunnel_local_address is not None:
+            if self.tunnel_local_address == 'any6':
+                result = 'any6'
+            else:
+                result = int(self.tunnel_local_address.split('%')[1])
+        else:
+            try:
+                result = int(self.tunnel_local_address.split('%')[1])
+            except Exception:
+                if self.tunnel_local_address == 'any6':
+                    return 0
+                return None
+        try:
+            if result == 'any6':
+                return 0
+            return int(self.tunnel_local_address.split('%')[1])
+        except Exception:
+            return None
+
+
+class ModuleParameters(Parameters):
+    @property
+    def description(self):
+        if self._values['description'] is None:
+            return None
+        elif self._values['description'] in ['none', '']:
+            return ''
+        return self._values['description']
+
+
+class Changes(Parameters):
+    def to_return(self):
+        result = {}
+        try:
+            for returnable in self.returnables:
+                result[returnable] = getattr(self, returnable)
+            result = self._filter_params(result)
+        except Exception:
+            pass
+        return result
+
+
+class UsableChanges(Changes):
+    @property
+    def encrypt_algorithm(self):
+        if self._values['encrypt_algorithm'] is None:
+            return None
+        elif self._values['encrypt_algorithm'] == 'none':
+            return 'null'
+        return self._values['encrypt_algorithm']
+
+
+class ReportableChanges(Changes):
+    @property
+    def encrypt_algorithm(self):
+        if self._values['encrypt_algorithm'] is None:
+            return None
+        elif self._values['encrypt_algorithm'] == 'null':
+            return 'none'
+        return self._values['encrypt_algorithm']
+
+
+class Difference(object):
+    def __init__(self, want, have=None):
+        self.want = want
+        self.have = have
+
+    def compare(self, param):
+        try:
+            result = getattr(self, param)
+            return result
+        except AttributeError:
+            return self.__default(param)
+
+    def __default(self, param):
+        attr1 = getattr(self.want, param)
+        try:
+            attr2 = getattr(self.have, param)
+            if attr1 != attr2:
+                return attr1
+        except AttributeError:
+            return attr1
+
+    @property
+    def description(self):
+        if self.want.description is None:
+            return None
+        if self.have.description is None and self.want.description == '':
+            return None
+        if self.want.description != self.have.description:
+            return self.want.description
+
+    @property
+    def route_domain(self):
+        if self.want.route_domain is None:
+            return None
+        if self.have.route_domain != self.want.route_domain:
+            if self.want.route_domain == 0:
+                return dict(
+                    tunnel_local_address='any6',
+                    tunnel_remote_address='any6',
+                    route_domain=self.want.route_domain,
+                )
+            else:
+                return dict(
+                    tunnel_local_address='any%{0}'.format(self.want.route_domain),
+                    tunnel_remote_address='any%{0}'.format(self.want.route_domain),
+                    route_domain=self.want.route_domain,
+                )
+
+
+class ModuleManager(object):
+    def __init__(self, *args, **kwargs):
+        self.module = kwargs.get('module', None)
+        self.client = kwargs.get('client', None)
+        self.want = ModuleParameters(params=self.module.params)
+        self.have = ApiParameters()
+        self.changes = UsableChanges()
+
+    def _set_changed_options(self):
+        changed = {}
+        for key in Parameters.returnables:
+            if getattr(self.want, key) is not None:
+                changed[key] = getattr(self.want, key)
+        if changed:
+            self.changes = UsableChanges(params=changed)
+
+    def _update_changed_options(self):
+        diff = Difference(self.want, self.have)
+        updatables = Parameters.updatables
+        changed = dict()
+        for k in updatables:
+            change = diff.compare(k)
+            if change is None:
+                continue
+            else:
+                if isinstance(change, dict):
+                    changed.update(change)
+                else:
+                    changed[k] = change
+        if changed:
+            self.changes = UsableChanges(params=changed)
+            return True
+        return False
+
+    def should_update(self):
+        result = self._update_changed_options()
+        if result:
+            return True
+        return False
+
+    def exec_module(self):
+        changed = False
+        result = dict()
+        state = self.want.state
+
+        if state == "present":
+            changed = self.present()
+        elif state == "absent":
+            changed = self.absent()
+
+        reportable = ReportableChanges(params=self.changes.to_return())
+        changes = reportable.to_return()
+        result.update(**changes)
+        result.update(dict(changed=changed))
+        self._announce_deprecations(result)
+        return result
+
+    def _announce_deprecations(self, result):
+        warnings = result.pop('__warnings', [])
+        for warning in warnings:
+            self.client.module.deprecate(
+                msg=warning['msg'],
+                version=warning['version']
+            )
+
+    def present(self):
+        if self.exists():
+            return self.update()
+        else:
+            return self.create()
+
+    def exists(self):
+        uri = "https://{0}:{1}/mgmt/tm/net/ipsec/ipsec-policy/{2}".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            transform_name(self.want.partition, self.want.name)
+        )
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError:
+            return False
+        if resp.status == 404 or 'code' in response and response['code'] == 404:
+            return False
+        return True
+
+    def update(self):
+        self.have = self.read_current_from_device()
+        if not self.should_update():
+            return False
+        if self.module.check_mode:
+            return True
+        self.update_on_device()
+        return True
+
+    def remove(self):
+        if self.module.check_mode:
+            return True
+        self.remove_from_device()
+        if self.exists():
+            raise F5ModuleError("Failed to delete the resource.")
+        return True
+
+    def create(self):
+        self._set_changed_options()
+        if self.module.check_mode:
+            return True
+        self.create_on_device()
+        return True
+
+    def create_on_device(self):
+        params = self.changes.api_params()
+        params['name'] = self.want.name
+        params['partition'] = self.want.partition
+        uri = "https://{0}:{1}/mgmt/tm/net/ipsec/ipsec-policy/".format(
+            self.client.provider['server'],
+            self.client.provider['server_port']
+        )
+        resp = self.client.api.post(uri, json=params)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+
+        if 'code' in response and response['code'] in [400, 403]:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp.content)
+
+    def update_on_device(self):
+        params = self.changes.api_params()
+        uri = "https://{0}:{1}/mgmt/tm/net/ipsec/ipsec-policy/{2}".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            transform_name(self.want.partition, self.want.name)
+        )
+        resp = self.client.api.patch(uri, json=params)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+
+        if 'code' in response and response['code'] == 400:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp.content)
+
+    def absent(self):
+        if self.exists():
+            return self.remove()
+        return False
+
+    def remove_from_device(self):
+        uri = "https://{0}:{1}/mgmt/tm/net/ipsec/ipsec-policy/{2}".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            transform_name(self.want.partition, self.want.name)
+        )
+        resp = self.client.api.delete(uri)
+        if resp.status == 200:
+            return True
+
+    def read_current_from_device(self):
+        uri = "https://{0}:{1}/mgmt/tm/net/ipsec/ipsec-policy/{2}".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            transform_name(self.want.partition, self.want.name)
+        )
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+
+        if 'code' in response and response['code'] == 400:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp.content)
+        return ApiParameters(params=response)
+
+
+class ArgumentSpec(object):
+    def __init__(self):
+        self.supports_check_mode = True
+        argument_spec = dict(
+            name=dict(required=True),
+            description=dict(),
+            protocol=dict(
+                choices=['esp', 'ah']
+            ),
+            mode=dict(
+                choices=['transport', 'interface', 'isession', 'tunnel']
+            ),
+            tunnel_local_address=dict(),
+            tunnel_remote_address=dict(),
+            encrypt_algorithm=dict(
+                choices=[
+                    'none', '3des', 'aes128', 'aes192', 'aes256', 'aes-gmac256',
+                    'aes-gmac192', 'aes-gmac128', 'aes-gcm256', 'aes-gcm192',
+                    'aes-gcm256', 'aes-gcm128'
+                ]
+            ),
+            route_domain=dict(type='int'),
+            auth_algorithm=dict(
+                choices=[
+                    'sha1', 'sha256', 'sha384', 'sha512', 'aes-gcm128',
+                    'aes-gcm192', 'aes-gcm256', 'aes-gmac128', 'aes-gmac192',
+                    'aes-gmac256',
+                ]
+            ),
+            ipcomp=dict(
+                choices=['none', 'null', 'deflate']
+            ),
+            lifetime=dict(type='int'),
+            kb_lifetime=dict(type='int'),
+            perfect_forward_secrecy=dict(
+                choices=[
+                    'none', 'modp768', 'modp1024', 'modp1536', 'modp2048', 'modp3072',
+                    'modp4096', 'modp6144', 'modp8192'
+                ]
+            ),
+            state=dict(default='present', choices=['absent', 'present']),
+            partition=dict(
+                default='Common',
+                fallback=(env_fallback, ['F5_PARTITION'])
+            )
+        )
+        self.argument_spec = {}
+        self.argument_spec.update(f5_argument_spec)
+        self.argument_spec.update(argument_spec)
+        self.required_if = [
+            ['mode', 'tunnel', ['tunnel_local_address', 'tunnel_remote_address']],
+            ['mode', 'interface', ['route_domain']]
+        ]
+
+
+def main():
+    spec = ArgumentSpec()
+
+    module = AnsibleModule(
+        argument_spec=spec.argument_spec,
+        supports_check_mode=spec.supports_check_mode,
+    )
+
+    try:
+        client = F5RestClient(**module.params)
+        mm = ModuleManager(module=module, client=client)
+        results = mm.exec_module()
+        cleanup_tokens(client)
+        exit_json(module, results, client)
+    except F5ModuleError as ex:
+        cleanup_tokens(client)
+        fail_json(module, ex, client)
+
+
+if __name__ == '__main__':
+    main()

test/units/modules/network/f5/test_bigip_ipsec_policy.py

@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright: (c) 2018, F5 Networks Inc.
+# 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
+
+import os
+import json
+import sys
+
+from nose.plugins.skip import SkipTest
+if sys.version_info < (2, 7):
+    raise SkipTest("F5 Ansible modules require Python >= 2.7")
+
+from ansible.module_utils.basic import AnsibleModule
+
+try:
+    from library.modules.bigip_ipsec_policy import ApiParameters
+    from library.modules.bigip_ipsec_policy import ModuleParameters
+    from library.modules.bigip_ipsec_policy import ModuleManager
+    from library.modules.bigip_ipsec_policy import ArgumentSpec
+
+    # In Ansible 2.8, Ansible changed import paths.
+    from test.units.compat import unittest
+    from test.units.compat.mock import Mock
+    from test.units.compat.mock import patch
+
+    from test.units.modules.utils import set_module_args
+except ImportError:
+    try:
+        from ansible.modules.network.f5.bigip_ipsec_policy import ApiParameters
+        from ansible.modules.network.f5.bigip_ipsec_policy import ModuleParameters
+        from ansible.modules.network.f5.bigip_ipsec_policy import ModuleManager
+        from ansible.modules.network.f5.bigip_ipsec_policy import ArgumentSpec
+
+        # Ansible 2.8 imports
+        from units.compat import unittest
+        from units.compat.mock import Mock
+        from units.compat.mock import patch
+
+        from units.modules.utils import set_module_args
+    except ImportError:
+        raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
+
+fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
+fixture_data = {}
+
+
+def load_fixture(name):
+    path = os.path.join(fixture_path, name)
+
+    if path in fixture_data:
+        return fixture_data[path]
+
+    with open(path) as f:
+        data = f.read()
+
+    try:
+        data = json.loads(data)
+    except Exception:
+        pass
+
+    fixture_data[path] = data
+    return data
+
+
+class TestParameters(unittest.TestCase):
+    def test_module_parameters(self):
+        args = dict(
+            name='ipsec1',
+        )
+        p = ModuleParameters(params=args)
+        assert p.name == 'ipsec1'
+
+    def test_api_parameters(self):
+        args = dict(
+            name='ipsec1',
+        )
+        p = ApiParameters(params=args)
+        assert p.name == 'ipsec1'
+
+
+class TestUntypedManager(unittest.TestCase):
+
+    def setUp(self):
+        self.spec = ArgumentSpec()
+
+    def test_create(self, *args):
+        set_module_args(dict(
+            name='ipsec1',
+            password='password',
+            server='localhost',
+            user='admin'
+        ))
+
+        module = AnsibleModule(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(module=module)
+        mm.create_on_device = Mock(return_value=True)
+        mm.exists = Mock(return_value=False)
+
+        results = mm.exec_module()
+
+        assert results['changed'] is True