From 4e768e26971710c410ed558a93a9c58797e70ef4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20Angel=20Mu=C3=B1oz=20Gonz=C3=A1lez?= Date: Thu, 22 Aug 2019 15:38:59 +0200 Subject: [PATCH] Fortinet's new module for fortios_user_peer (#61056) * Fortinet's new module for fortios_user_peer * Update fortios_user_peer.py --- .../network/fortios/fortios_user_peer.py | 406 ++++++++++++++++++ .../network/fortios/test_fortios_user_peer.py | 319 ++++++++++++++ 2 files changed, 725 insertions(+) create mode 100644 lib/ansible/modules/network/fortios/fortios_user_peer.py create mode 100644 test/units/modules/network/fortios/test_fortios_user_peer.py diff --git a/lib/ansible/modules/network/fortios/fortios_user_peer.py b/lib/ansible/modules/network/fortios/fortios_user_peer.py new file mode 100644 index 00000000000..840b098bd27 --- /dev/null +++ b/lib/ansible/modules/network/fortios/fortios_user_peer.py @@ -0,0 +1,406 @@ +#!/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 + +__metaclass__ = type + +ANSIBLE_METADATA = {'status': ['preview'], + 'supported_by': 'community', + 'metadata_version': '1.1'} + +DOCUMENTATION = ''' +--- +module: fortios_user_peer +short_description: Configure peer users in Fortinet's FortiOS and FortiGate. +description: + - This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the + user to set and modify user feature and peer category. + Examples include all parameters and values need to be adjusted to datasources before usage. + Tested with FOS v6.0.5 +version_added: "2.9" +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. + type: str + required: false + username: + description: + - FortiOS or FortiGate username. + type: str + required: false + password: + description: + - FortiOS or FortiGate password. + type: str + 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. + type: str + default: root + https: + description: + - Indicates if the requests towards FortiGate must use HTTPS protocol. + type: bool + default: true + ssl_verify: + description: + - Ensures FortiGate certificate must be verified by a proper CA. + type: bool + default: true + state: + description: + - Indicates whether to create or remove the object. + type: str + required: true + choices: + - present + - absent + user_peer: + description: + - Configure peer users. + default: null + type: dict + suboptions: + ca: + description: + - Name of the CA certificate as returned by the execute vpn certificate ca list command. Source vpn.certificate.ca.name. + type: str + cn: + description: + - Peer certificate common name. + type: str + cn_type: + description: + - Peer certificate common name type. + type: str + choices: + - string + - email + - FQDN + - ipv4 + - ipv6 + ldap_mode: + description: + - Mode for LDAP peer authentication. + type: str + choices: + - password + - principal-name + ldap_password: + description: + - Password for LDAP server bind. + type: str + ldap_server: + description: + - Name of an LDAP server defined under the user ldap command. Performs client access rights check. Source user.ldap.name. + type: str + ldap_username: + description: + - Username for LDAP server bind. + type: str + mandatory_ca_verify: + description: + - Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certificate as + valid. + type: str + choices: + - enable + - disable + name: + description: + - Peer name. + required: true + type: str + ocsp_override_server: + description: + - Online Certificate Status Protocol (OCSP) server for certificate retrieval. Source vpn.certificate.ocsp-server.name. + type: str + passwd: + description: + - Peer's password used for two-factor authentication. + type: str + subject: + description: + - Peer certificate name constraints. + type: str + two_factor: + description: + - Enable/disable two-factor authentication, applying certificate and password-based authentication. + type: str + choices: + - enable + - disable +''' + +EXAMPLES = ''' +- hosts: localhost + vars: + host: "192.168.122.40" + username: "admin" + password: "" + vdom: "root" + ssl_verify: "False" + tasks: + - name: Configure peer users. + fortios_user_peer: + host: "{{ host }}" + username: "{{ username }}" + password: "{{ password }}" + vdom: "{{ vdom }}" + https: "False" + state: "present" + user_peer: + ca: " (source vpn.certificate.ca.name)" + cn: "" + cn_type: "string" + ldap_mode: "password" + ldap_password: "" + ldap_server: " (source user.ldap.name)" + ldap_username: "" + mandatory_ca_verify: "enable" + name: "default_name_11" + ocsp_override_server: " (source vpn.certificate.ocsp-server.name)" + passwd: "" + subject: "" + two_factor: "enable" +''' + +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 +from ansible.module_utils.connection import Connection +from ansible.module_utils.network.fortios.fortios import FortiOSHandler +from ansible.module_utils.network.fortimanager.common import FAIL_SOCKET_MSG + + +def login(data, fos): + host = data['host'] + username = data['username'] + password = data['password'] + ssl_verify = data['ssl_verify'] + + fos.debug('on') + if 'https' in data and not data['https']: + fos.https('off') + else: + fos.https('on') + + fos.login(host, username, password, verify=ssl_verify) + + +def filter_user_peer_data(json): + option_list = ['ca', 'cn', 'cn_type', + 'ldap_mode', 'ldap_password', 'ldap_server', + 'ldap_username', 'mandatory_ca_verify', 'name', + 'ocsp_override_server', 'passwd', 'subject', + 'two_factor'] + dictionary = {} + + for attribute in option_list: + if attribute in json and json[attribute] is not None: + dictionary[attribute] = json[attribute] + + return dictionary + + +def underscore_to_hyphen(data): + if isinstance(data, list): + for elem in data: + elem = underscore_to_hyphen(elem) + elif isinstance(data, dict): + new_data = {} + for k, v in data.items(): + new_data[k.replace('_', '-')] = underscore_to_hyphen(v) + data = new_data + + return data + + +def user_peer(data, fos): + vdom = data['vdom'] + state = data['state'] + user_peer_data = data['user_peer'] + filtered_data = underscore_to_hyphen(filter_user_peer_data(user_peer_data)) + + if state == "present": + return fos.set('user', + 'peer', + data=filtered_data, + vdom=vdom) + + elif state == "absent": + return fos.delete('user', + 'peer', + mkey=filtered_data['name'], + vdom=vdom) + + +def is_successful_status(status): + return status['status'] == "success" or \ + status['http_method'] == "DELETE" and status['http_status'] == 404 + + +def fortios_user(data, fos): + + if data['user_peer']: + resp = user_peer(data, fos) + + return not is_successful_status(resp), \ + resp['status'] == "success", \ + resp + + +def main(): + fields = { + "host": {"required": False, "type": "str"}, + "username": {"required": False, "type": "str"}, + "password": {"required": False, "type": "str", "default": "", "no_log": True}, + "vdom": {"required": False, "type": "str", "default": "root"}, + "https": {"required": False, "type": "bool", "default": True}, + "ssl_verify": {"required": False, "type": "bool", "default": True}, + "state": {"required": True, "type": "str", + "choices": ["present", "absent"]}, + "user_peer": { + "required": False, "type": "dict", "default": None, + "options": { + "ca": {"required": False, "type": "str"}, + "cn": {"required": False, "type": "str"}, + "cn_type": {"required": False, "type": "str", + "choices": ["string", "email", "FQDN", + "ipv4", "ipv6"]}, + "ldap_mode": {"required": False, "type": "str", + "choices": ["password", "principal-name"]}, + "ldap_password": {"required": False, "type": "str"}, + "ldap_server": {"required": False, "type": "str"}, + "ldap_username": {"required": False, "type": "str"}, + "mandatory_ca_verify": {"required": False, "type": "str", + "choices": ["enable", "disable"]}, + "name": {"required": True, "type": "str"}, + "ocsp_override_server": {"required": False, "type": "str"}, + "passwd": {"required": False, "type": "str"}, + "subject": {"required": False, "type": "str"}, + "two_factor": {"required": False, "type": "str", + "choices": ["enable", "disable"]} + + } + } + } + + module = AnsibleModule(argument_spec=fields, + supports_check_mode=False) + + # legacy_mode refers to using fortiosapi instead of HTTPAPI + legacy_mode = 'host' in module.params and module.params['host'] is not None and \ + 'username' in module.params and module.params['username'] is not None and \ + 'password' in module.params and module.params['password'] is not None + + if not legacy_mode: + if module._socket_path: + connection = Connection(module._socket_path) + fos = FortiOSHandler(connection) + + is_error, has_changed, result = fortios_user(module.params, fos) + else: + module.fail_json(**FAIL_SOCKET_MSG) + else: + try: + from fortiosapi import FortiOSAPI + except ImportError: + module.fail_json(msg="fortiosapi module is required") + + fos = FortiOSAPI() + + login(module.params, fos) + is_error, has_changed, result = fortios_user(module.params, fos) + fos.logout() + + 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() diff --git a/test/units/modules/network/fortios/test_fortios_user_peer.py b/test/units/modules/network/fortios/test_fortios_user_peer.py new file mode 100644 index 00000000000..044fd40481e --- /dev/null +++ b/test/units/modules/network/fortios/test_fortios_user_peer.py @@ -0,0 +1,319 @@ +# 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 Ansible. If not, see . + +# Make coding more python3-ish +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import os +import json +import pytest +from mock import ANY +from ansible.module_utils.network.fortios.fortios import FortiOSHandler + +try: + from ansible.modules.network.fortios import fortios_user_peer +except ImportError: + pytest.skip("Could not load required modules for testing", allow_module_level=True) + + +@pytest.fixture(autouse=True) +def connection_mock(mocker): + connection_class_mock = mocker.patch('ansible.modules.network.fortios.fortios_user_peer.Connection') + return connection_class_mock + + +fos_instance = FortiOSHandler(connection_mock) + + +def test_user_peer_creation(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + set_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200} + set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result) + + input_data = { + 'username': 'admin', + 'state': 'present', + 'user_peer': { + 'ca': 'test_value_3', + 'cn': 'test_value_4', + 'cn_type': 'string', + 'ldap_mode': 'password', + 'ldap_password': 'test_value_7', + 'ldap_server': 'test_value_8', + 'ldap_username': 'test_value_9', + 'mandatory_ca_verify': 'enable', + 'name': 'default_name_11', + 'ocsp_override_server': 'test_value_12', + 'passwd': 'test_value_13', + 'subject': 'test_value_14', + 'two_factor': 'enable' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_user_peer.fortios_user(input_data, fos_instance) + + expected_data = { + 'ca': 'test_value_3', + 'cn': 'test_value_4', + 'cn-type': 'string', + 'ldap-mode': 'password', + 'ldap-password': 'test_value_7', + 'ldap-server': 'test_value_8', + 'ldap-username': 'test_value_9', + 'mandatory-ca-verify': 'enable', + 'name': 'default_name_11', + 'ocsp-override-server': 'test_value_12', + 'passwd': 'test_value_13', + 'subject': 'test_value_14', + 'two-factor': 'enable' + } + + set_method_mock.assert_called_with('user', 'peer', data=expected_data, vdom='root') + schema_method_mock.assert_not_called() + assert not is_error + assert changed + assert response['status'] == 'success' + assert response['http_status'] == 200 + + +def test_user_peer_creation_fails(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + set_method_result = {'status': 'error', 'http_method': 'POST', 'http_status': 500} + set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result) + + input_data = { + 'username': 'admin', + 'state': 'present', + 'user_peer': { + 'ca': 'test_value_3', + 'cn': 'test_value_4', + 'cn_type': 'string', + 'ldap_mode': 'password', + 'ldap_password': 'test_value_7', + 'ldap_server': 'test_value_8', + 'ldap_username': 'test_value_9', + 'mandatory_ca_verify': 'enable', + 'name': 'default_name_11', + 'ocsp_override_server': 'test_value_12', + 'passwd': 'test_value_13', + 'subject': 'test_value_14', + 'two_factor': 'enable' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_user_peer.fortios_user(input_data, fos_instance) + + expected_data = { + 'ca': 'test_value_3', + 'cn': 'test_value_4', + 'cn-type': 'string', + 'ldap-mode': 'password', + 'ldap-password': 'test_value_7', + 'ldap-server': 'test_value_8', + 'ldap-username': 'test_value_9', + 'mandatory-ca-verify': 'enable', + 'name': 'default_name_11', + 'ocsp-override-server': 'test_value_12', + 'passwd': 'test_value_13', + 'subject': 'test_value_14', + 'two-factor': 'enable' + } + + set_method_mock.assert_called_with('user', 'peer', data=expected_data, vdom='root') + schema_method_mock.assert_not_called() + assert is_error + assert not changed + assert response['status'] == 'error' + assert response['http_status'] == 500 + + +def test_user_peer_removal(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + delete_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200} + delete_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.delete', return_value=delete_method_result) + + input_data = { + 'username': 'admin', + 'state': 'absent', + 'user_peer': { + 'ca': 'test_value_3', + 'cn': 'test_value_4', + 'cn_type': 'string', + 'ldap_mode': 'password', + 'ldap_password': 'test_value_7', + 'ldap_server': 'test_value_8', + 'ldap_username': 'test_value_9', + 'mandatory_ca_verify': 'enable', + 'name': 'default_name_11', + 'ocsp_override_server': 'test_value_12', + 'passwd': 'test_value_13', + 'subject': 'test_value_14', + 'two_factor': 'enable' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_user_peer.fortios_user(input_data, fos_instance) + + delete_method_mock.assert_called_with('user', 'peer', mkey=ANY, vdom='root') + schema_method_mock.assert_not_called() + assert not is_error + assert changed + assert response['status'] == 'success' + assert response['http_status'] == 200 + + +def test_user_peer_deletion_fails(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + delete_method_result = {'status': 'error', 'http_method': 'POST', 'http_status': 500} + delete_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.delete', return_value=delete_method_result) + + input_data = { + 'username': 'admin', + 'state': 'absent', + 'user_peer': { + 'ca': 'test_value_3', + 'cn': 'test_value_4', + 'cn_type': 'string', + 'ldap_mode': 'password', + 'ldap_password': 'test_value_7', + 'ldap_server': 'test_value_8', + 'ldap_username': 'test_value_9', + 'mandatory_ca_verify': 'enable', + 'name': 'default_name_11', + 'ocsp_override_server': 'test_value_12', + 'passwd': 'test_value_13', + 'subject': 'test_value_14', + 'two_factor': 'enable' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_user_peer.fortios_user(input_data, fos_instance) + + delete_method_mock.assert_called_with('user', 'peer', mkey=ANY, vdom='root') + schema_method_mock.assert_not_called() + assert is_error + assert not changed + assert response['status'] == 'error' + assert response['http_status'] == 500 + + +def test_user_peer_idempotent(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + set_method_result = {'status': 'error', 'http_method': 'DELETE', 'http_status': 404} + set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result) + + input_data = { + 'username': 'admin', + 'state': 'present', + 'user_peer': { + 'ca': 'test_value_3', + 'cn': 'test_value_4', + 'cn_type': 'string', + 'ldap_mode': 'password', + 'ldap_password': 'test_value_7', + 'ldap_server': 'test_value_8', + 'ldap_username': 'test_value_9', + 'mandatory_ca_verify': 'enable', + 'name': 'default_name_11', + 'ocsp_override_server': 'test_value_12', + 'passwd': 'test_value_13', + 'subject': 'test_value_14', + 'two_factor': 'enable' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_user_peer.fortios_user(input_data, fos_instance) + + expected_data = { + 'ca': 'test_value_3', + 'cn': 'test_value_4', + 'cn-type': 'string', + 'ldap-mode': 'password', + 'ldap-password': 'test_value_7', + 'ldap-server': 'test_value_8', + 'ldap-username': 'test_value_9', + 'mandatory-ca-verify': 'enable', + 'name': 'default_name_11', + 'ocsp-override-server': 'test_value_12', + 'passwd': 'test_value_13', + 'subject': 'test_value_14', + 'two-factor': 'enable' + } + + set_method_mock.assert_called_with('user', 'peer', data=expected_data, vdom='root') + schema_method_mock.assert_not_called() + assert not is_error + assert not changed + assert response['status'] == 'error' + assert response['http_status'] == 404 + + +def test_user_peer_filter_foreign_attributes(mocker): + schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema') + + set_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200} + set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result) + + input_data = { + 'username': 'admin', + 'state': 'present', + 'user_peer': { + 'random_attribute_not_valid': 'tag', + 'ca': 'test_value_3', + 'cn': 'test_value_4', + 'cn_type': 'string', + 'ldap_mode': 'password', + 'ldap_password': 'test_value_7', + 'ldap_server': 'test_value_8', + 'ldap_username': 'test_value_9', + 'mandatory_ca_verify': 'enable', + 'name': 'default_name_11', + 'ocsp_override_server': 'test_value_12', + 'passwd': 'test_value_13', + 'subject': 'test_value_14', + 'two_factor': 'enable' + }, + 'vdom': 'root'} + + is_error, changed, response = fortios_user_peer.fortios_user(input_data, fos_instance) + + expected_data = { + 'ca': 'test_value_3', + 'cn': 'test_value_4', + 'cn-type': 'string', + 'ldap-mode': 'password', + 'ldap-password': 'test_value_7', + 'ldap-server': 'test_value_8', + 'ldap-username': 'test_value_9', + 'mandatory-ca-verify': 'enable', + 'name': 'default_name_11', + 'ocsp-override-server': 'test_value_12', + 'passwd': 'test_value_13', + 'subject': 'test_value_14', + 'two-factor': 'enable' + } + + set_method_mock.assert_called_with('user', 'peer', data=expected_data, vdom='root') + schema_method_mock.assert_not_called() + assert not is_error + assert changed + assert response['status'] == 'success' + assert response['http_status'] == 200