From 023ca403928e5926f9436efc9ba42f6c75d0a6b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20Angel=20Mu=C3=B1oz=20Gonz=C3=A1lez?= Date: Tue, 12 Feb 2019 09:58:13 +0100 Subject: [PATCH] Fortinet's FortiOS DLP Filepattern (#51829) --- .../fortios/fortios_dlp_filepattern.py | 382 ++++++++++++++++++ 1 file changed, 382 insertions(+) create mode 100644 lib/ansible/modules/network/fortios/fortios_dlp_filepattern.py diff --git a/lib/ansible/modules/network/fortios/fortios_dlp_filepattern.py b/lib/ansible/modules/network/fortios/fortios_dlp_filepattern.py new file mode 100644 index 0000000000..96893ca5c0 --- /dev/null +++ b/lib/ansible/modules/network/fortios/fortios_dlp_filepattern.py @@ -0,0 +1,382 @@ +#!/usr/bin/python +from __future__ import (absolute_import, division, print_function) +# Copyright 2018 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 . +# +# 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_dlp_filepattern +short_description: Configure file patterns used by DLP blocking in Fortinet's FortiOS and FortiGate. +description: + - This module is able to configure a FortiGate or FortiOS by + allowing the user to configure dlp feature and filepattern category. + Examples includes all options and 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 adress. + 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: false + dlp_filepattern: + description: + - Configure file patterns used by DLP blocking. + default: null + suboptions: + state: + description: + - Indicates whether to create or remove the object + choices: + - present + - absent + comment: + description: + - Optional comments. + entries: + description: + - Configure file patterns used by DLP blocking. + suboptions: + file-type: + description: + - Select a file type. + choices: + - 7z + - arj + - cab + - lzh + - rar + - tar + - zip + - bzip + - gzip + - bzip2 + - xz + - bat + - msc + - uue + - mime + - base64 + - binhex + - elf + - exe + - hta + - html + - jad + - class + - cod + - javascript + - msoffice + - msofficex + - fsg + - upx + - petite + - aspack + - sis + - hlp + - activemime + - jpeg + - gif + - tiff + - png + - bmp + - ignored + - unknown + - mpeg + - mov + - mp3 + - wma + - wav + - pdf + - avi + - rm + - torrent + - hibun + - msi + - mach-o + - dmg + - .net + - xar + - chm + - iso + - crx + filter-type: + description: + - Filter by file name pattern or by file type. + choices: + - pattern + - type + pattern: + description: + - Add a file name pattern. + required: true + id: + description: + - ID. + required: true + name: + description: + - Name of table containing the file pattern list. +''' + +EXAMPLES = ''' +- hosts: localhost + vars: + host: "192.168.122.40" + username: "admin" + password: "" + vdom: "root" + tasks: + - name: Configure file patterns used by DLP blocking. + fortios_dlp_filepattern: + host: "{{ host }}" + username: "{{ username }}" + password: "{{ password }}" + vdom: "{{ vdom }}" + dlp_filepattern: + state: "present" + comment: "Optional comments." + entries: + - + file-type: "7z" + filter-type: "pattern" + pattern: "" + id: "8" + name: "default_name_9" +''' + +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_dlp_filepattern_data(json): + option_list = ['comment', 'entries', 'id', + 'name'] + dictionary = {} + + for attribute in option_list: + if attribute in json and json[attribute] is not None: + dictionary[attribute] = json[attribute] + + return dictionary + + +def dlp_filepattern(data, fos): + vdom = data['vdom'] + dlp_filepattern_data = data['dlp_filepattern'] + filtered_data = filter_dlp_filepattern_data(dlp_filepattern_data) + if dlp_filepattern_data['state'] == "present": + return fos.set('dlp', + 'filepattern', + data=filtered_data, + vdom=vdom) + + elif dlp_filepattern_data['state'] == "absent": + return fos.delete('dlp', + 'filepattern', + mkey=filtered_data['id'], + vdom=vdom) + + +def fortios_dlp(data, fos): + login(data) + + methodlist = ['dlp_filepattern'] + for method in methodlist: + if data[method]: + resp = eval(method)(data, fos) + break + + 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": "False"}, + "dlp_filepattern": { + "required": False, "type": "dict", + "options": { + "state": {"required": True, "type": "str", + "choices": ["present", "absent"]}, + "comment": {"required": False, "type": "str"}, + "entries": {"required": False, "type": "list", + "options": { + "file-type": {"required": False, "type": "str", + "choices": ["7z", "arj", "cab", + "lzh", "rar", "tar", + "zip", "bzip", "gzip", + "bzip2", "xz", "bat", + "msc", "uue", "mime", + "base64", "binhex", "elf", + "exe", "hta", "html", + "jad", "class", "cod", + "javascript", "msoffice", "msofficex", + "fsg", "upx", "petite", + "aspack", "sis", "hlp", + "activemime", "jpeg", "gif", + "tiff", "png", "bmp", + "ignored", "unknown", "mpeg", + "mov", "mp3", "wma", + "wav", "pdf", "avi", + "rm", "torrent", "hibun", + "msi", "mach-o", "dmg", + ".net", "xar", "chm", + "iso", "crx"]}, + "filter-type": {"required": False, "type": "str", + "choices": ["pattern", "type"]}, + "pattern": {"required": True, "type": "str"} + }}, + "id": {"required": True, "type": "int"}, + "name": {"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_dlp(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()