Fortinet's FortiOS vpn ipsec manualkey interface (#52364)
This commit is contained in:
Miguel Angel Muñoz González
John R Barker
parent
e2c2910f25
commit
7a8529ecbd
1 changed files with 375 additions and 0 deletions
|
|
@ -0,0 +1,375 @@
|
|||
#!/usr/bin/python
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
# Copyright 2019 Fortinet, Inc.
|
||||
#
|
||||
# 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 <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
# the lib use python logging can get it if the following is set in your
|
||||
# Ansible config.
|
||||
|
||||
__metaclass__ = type
|
||||
|
||||
ANSIBLE_METADATA = {'status': ['preview'],
|
||||
'supported_by': 'community',
|
||||
'metadata_version': '1.1'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: fortios_vpn_ipsec_manualkey_interface
|
||||
short_description: Configure IPsec manual keys in Fortinet's FortiOS and FortiGate.
|
||||
description:
|
||||
- This module is able to configure a FortiGate or FortiOS by allowing the
|
||||
user to set and modify vpn_ipsec feature and manualkey_interface category.
|
||||
Examples include all parameters and values need to be adjusted to datasources before usage.
|
||||
Tested with FOS v6.0.2
|
||||
version_added: "2.8"
|
||||
author:
|
||||
- Miguel Angel Munoz (@mamunozgonzalez)
|
||||
- Nicolas Thomas (@thomnico)
|
||||
notes:
|
||||
- Requires fortiosapi library developed by Fortinet
|
||||
- Run as a local_action in your playbook
|
||||
requirements:
|
||||
- fortiosapi>=0.9.8
|
||||
options:
|
||||
host:
|
||||
description:
|
||||
- FortiOS or FortiGate ip address.
|
||||
required: true
|
||||
username:
|
||||
description:
|
||||
- FortiOS or FortiGate username.
|
||||
required: true
|
||||
password:
|
||||
description:
|
||||
- FortiOS or FortiGate password.
|
||||
default: ""
|
||||
vdom:
|
||||
description:
|
||||
- Virtual domain, among those defined previously. A vdom is a
|
||||
virtual instance of the FortiGate that can be configured and
|
||||
used as a different unit.
|
||||
default: root
|
||||
https:
|
||||
description:
|
||||
- Indicates if the requests towards FortiGate must use HTTPS
|
||||
protocol
|
||||
type: bool
|
||||
default: true
|
||||
vpn_ipsec_manualkey_interface:
|
||||
description:
|
||||
- Configure IPsec manual keys.
|
||||
default: null
|
||||
suboptions:
|
||||
state:
|
||||
description:
|
||||
- Indicates whether to create or remove the object
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
addr-type:
|
||||
description:
|
||||
- IP version to use for IP packets.
|
||||
choices:
|
||||
- 4
|
||||
- 6
|
||||
auth-alg:
|
||||
description:
|
||||
- Authentication algorithm. Must be the same for both ends of the tunnel.
|
||||
choices:
|
||||
- null
|
||||
- md5
|
||||
- sha1
|
||||
- sha256
|
||||
- sha384
|
||||
- sha512
|
||||
auth-key:
|
||||
description:
|
||||
- Hexadecimal authentication key in 16-digit (8-byte) segments separated by hyphens.
|
||||
enc-alg:
|
||||
description:
|
||||
- Encryption algorithm. Must be the same for both ends of the tunnel.
|
||||
choices:
|
||||
- null
|
||||
- des
|
||||
enc-key:
|
||||
description:
|
||||
- Hexadecimal encryption key in 16-digit (8-byte) segments separated by hyphens.
|
||||
interface:
|
||||
description:
|
||||
- Name of the physical, aggregate, or VLAN interface. Source system.interface.name.
|
||||
ip-version:
|
||||
description:
|
||||
- IP version to use for VPN interface.
|
||||
choices:
|
||||
- 4
|
||||
- 6
|
||||
local-gw:
|
||||
description:
|
||||
- IPv4 address of the local gateway's external interface.
|
||||
local-gw6:
|
||||
description:
|
||||
- Local IPv6 address of VPN gateway.
|
||||
local-spi:
|
||||
description:
|
||||
- Local SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic streams with different encryption rules.
|
||||
name:
|
||||
description:
|
||||
- IPsec tunnel name.
|
||||
required: true
|
||||
npu-offload:
|
||||
description:
|
||||
- Enable/disable offloading IPsec VPN manual key sessions to NPUs.
|
||||
choices:
|
||||
- enable
|
||||
- disable
|
||||
remote-gw:
|
||||
description:
|
||||
- IPv4 address of the remote gateway's external interface.
|
||||
remote-gw6:
|
||||
description:
|
||||
- Remote IPv6 address of VPN gateway.
|
||||
remote-spi:
|
||||
description:
|
||||
- Remote SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic streams with different encryption rules.
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- hosts: localhost
|
||||
vars:
|
||||
host: "192.168.122.40"
|
||||
username: "admin"
|
||||
password: ""
|
||||
vdom: "root"
|
||||
tasks:
|
||||
- name: Configure IPsec manual keys.
|
||||
fortios_vpn_ipsec_manualkey_interface:
|
||||
host: "{{ host }}"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
vdom: "{{ vdom }}"
|
||||
https: "False"
|
||||
vpn_ipsec_manualkey_interface:
|
||||
state: "present"
|
||||
addr-type: "4"
|
||||
auth-alg: "null"
|
||||
auth-key: "<your_own_value>"
|
||||
enc-alg: "null"
|
||||
enc-key: "<your_own_value>"
|
||||
interface: "<your_own_value> (source system.interface.name)"
|
||||
ip-version: "4"
|
||||
local-gw: "<your_own_value>"
|
||||
local-gw6: "<your_own_value>"
|
||||
local-spi: "<your_own_value>"
|
||||
name: "default_name_13"
|
||||
npu-offload: "enable"
|
||||
remote-gw: "<your_own_value>"
|
||||
remote-gw6: "<your_own_value>"
|
||||
remote-spi: "<your_own_value>"
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
build:
|
||||
description: Build number of the fortigate image
|
||||
returned: always
|
||||
type: str
|
||||
sample: '1547'
|
||||
http_method:
|
||||
description: Last method used to provision the content into FortiGate
|
||||
returned: always
|
||||
type: str
|
||||
sample: 'PUT'
|
||||
http_status:
|
||||
description: Last result given by FortiGate on last operation applied
|
||||
returned: always
|
||||
type: str
|
||||
sample: "200"
|
||||
mkey:
|
||||
description: Master key (id) used in the last call to FortiGate
|
||||
returned: success
|
||||
type: str
|
||||
sample: "id"
|
||||
name:
|
||||
description: Name of the table used to fulfill the request
|
||||
returned: always
|
||||
type: str
|
||||
sample: "urlfilter"
|
||||
path:
|
||||
description: Path of the table used to fulfill the request
|
||||
returned: always
|
||||
type: str
|
||||
sample: "webfilter"
|
||||
revision:
|
||||
description: Internal revision number
|
||||
returned: always
|
||||
type: str
|
||||
sample: "17.0.2.10658"
|
||||
serial:
|
||||
description: Serial number of the unit
|
||||
returned: always
|
||||
type: str
|
||||
sample: "FGVMEVYYQT3AB5352"
|
||||
status:
|
||||
description: Indication of the operation's result
|
||||
returned: always
|
||||
type: str
|
||||
sample: "success"
|
||||
vdom:
|
||||
description: Virtual domain used
|
||||
returned: always
|
||||
type: str
|
||||
sample: "root"
|
||||
version:
|
||||
description: Version of the FortiGate
|
||||
returned: always
|
||||
type: str
|
||||
sample: "v5.6.3"
|
||||
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
fos = None
|
||||
|
||||
|
||||
def login(data):
|
||||
host = data['host']
|
||||
username = data['username']
|
||||
password = data['password']
|
||||
|
||||
fos.debug('on')
|
||||
if 'https' in data and not data['https']:
|
||||
fos.https('off')
|
||||
else:
|
||||
fos.https('on')
|
||||
|
||||
fos.login(host, username, password)
|
||||
|
||||
|
||||
def filter_vpn_ipsec_manualkey_interface_data(json):
|
||||
option_list = ['addr-type', 'auth-alg', 'auth-key',
|
||||
'enc-alg', 'enc-key', 'interface',
|
||||
'ip-version', 'local-gw', 'local-gw6',
|
||||
'local-spi', 'name', 'npu-offload',
|
||||
'remote-gw', 'remote-gw6', 'remote-spi']
|
||||
dictionary = {}
|
||||
|
||||
for attribute in option_list:
|
||||
if attribute in json and json[attribute] is not None:
|
||||
dictionary[attribute] = json[attribute]
|
||||
|
||||
return dictionary
|
||||
|
||||
|
||||
def flatten_multilists_attributes(data):
|
||||
multilist_attrs = []
|
||||
|
||||
for attr in multilist_attrs:
|
||||
try:
|
||||
path = "data['" + "']['".join(elem for elem in attr) + "']"
|
||||
current_val = eval(path)
|
||||
flattened_val = ' '.join(elem for elem in current_val)
|
||||
exec(path + '= flattened_val')
|
||||
except BaseException:
|
||||
pass
|
||||
|
||||
return data
|
||||
|
||||
|
||||
def vpn_ipsec_manualkey_interface(data, fos):
|
||||
vdom = data['vdom']
|
||||
vpn_ipsec_manualkey_interface_data = data['vpn_ipsec_manualkey_interface']
|
||||
flattened_data = flatten_multilists_attributes(vpn_ipsec_manualkey_interface_data)
|
||||
filtered_data = filter_vpn_ipsec_manualkey_interface_data(flattened_data)
|
||||
if vpn_ipsec_manualkey_interface_data['state'] == "present":
|
||||
return fos.set('vpn.ipsec',
|
||||
'manualkey-interface',
|
||||
data=filtered_data,
|
||||
vdom=vdom)
|
||||
|
||||
elif vpn_ipsec_manualkey_interface_data['state'] == "absent":
|
||||
return fos.delete('vpn.ipsec',
|
||||
'manualkey-interface',
|
||||
mkey=filtered_data['name'],
|
||||
vdom=vdom)
|
||||
|
||||
|
||||
def fortios_vpn_ipsec(data, fos):
|
||||
login(data)
|
||||
|
||||
if data['vpn_ipsec_manualkey_interface']:
|
||||
resp = vpn_ipsec_manualkey_interface(data, fos)
|
||||
|
||||
fos.logout()
|
||||
return not resp['status'] == "success", resp['status'] == "success", resp
|
||||
|
||||
|
||||
def main():
|
||||
fields = {
|
||||
"host": {"required": True, "type": "str"},
|
||||
"username": {"required": True, "type": "str"},
|
||||
"password": {"required": False, "type": "str", "no_log": True},
|
||||
"vdom": {"required": False, "type": "str", "default": "root"},
|
||||
"https": {"required": False, "type": "bool", "default": True},
|
||||
"vpn_ipsec_manualkey_interface": {
|
||||
"required": False, "type": "dict",
|
||||
"options": {
|
||||
"state": {"required": True, "type": "str",
|
||||
"choices": ["present", "absent"]},
|
||||
"addr-type": {"required": False, "type": "str",
|
||||
"choices": ["4", "6"]},
|
||||
"auth-alg": {"required": False, "type": "str",
|
||||
"choices": ["null", "md5", "sha1",
|
||||
"sha256", "sha384", "sha512"]},
|
||||
"auth-key": {"required": False, "type": "str"},
|
||||
"enc-alg": {"required": False, "type": "str",
|
||||
"choices": ["null", "des"]},
|
||||
"enc-key": {"required": False, "type": "str"},
|
||||
"interface": {"required": False, "type": "str"},
|
||||
"ip-version": {"required": False, "type": "str",
|
||||
"choices": ["4", "6"]},
|
||||
"local-gw": {"required": False, "type": "str"},
|
||||
"local-gw6": {"required": False, "type": "str"},
|
||||
"local-spi": {"required": False, "type": "str"},
|
||||
"name": {"required": True, "type": "str"},
|
||||
"npu-offload": {"required": False, "type": "str",
|
||||
"choices": ["enable", "disable"]},
|
||||
"remote-gw": {"required": False, "type": "str"},
|
||||
"remote-gw6": {"required": False, "type": "str"},
|
||||
"remote-spi": {"required": False, "type": "str"}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module = AnsibleModule(argument_spec=fields,
|
||||
supports_check_mode=False)
|
||||
try:
|
||||
from fortiosapi import FortiOSAPI
|
||||
except ImportError:
|
||||
module.fail_json(msg="fortiosapi module is required")
|
||||
|
||||
global fos
|
||||
fos = FortiOSAPI()
|
||||
|
||||
is_error, has_changed, result = fortios_vpn_ipsec(module.params, fos)
|
||||
|
||||
if not is_error:
|
||||
module.exit_json(changed=has_changed, meta=result)
|
||||
else:
|
||||
module.fail_json(msg="Error in repo", meta=result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue