mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
FortiManager security profile group module (#46220)
* Initial Commit * Initial Commit * Initial Commit * Fixing syntax errors * After running sanity tests, fixed pylint and pep8 errors * After running sanity tests, fixed pylint and pep8 errors * Fixing more syntax issues * Fixing more syntax issues * Adding username to doc block * PR candidate * PR candidate * fixed pep8 and docs issues * fixed 2.6 function issues * fixed 2.6 function issues part duex * Initial commit for security profile group module * Adding better playbook example to module * Adding another commit to test shippable tests * Fixing shippable errors, pep8 in unit test file and doc block problem in main module * Fixing documentation module error * Fixing pep8 line too long in unit test * Fixing utility function with nested dictionaries * Fixing utility function with pep8 issue * Adding change to allow for multiple list of dictionaries to be submitted via a single playbook * Fixing review changes * Adding @ in author names per @Gundalow's request per Ansible's guidelines
This commit is contained in:
ftntcorecse
Sumit Jaiswal
parent
64c4881d58
commit
4862a4aeb4
4 changed files with 963 additions and 0 deletions
|
|
@ -0,0 +1,430 @@
|
||||||
|
#!/usr/bin/python
|
||||||
|
#
|
||||||
|
# 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/>.
|
||||||
|
#
|
||||||
|
|
||||||
|
from __future__ import absolute_import, division, print_function
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
ANSIBLE_METADATA = {'status': ['preview'],
|
||||||
|
'supported_by': 'community',
|
||||||
|
'metadata_version': '1.1'}
|
||||||
|
|
||||||
|
DOCUMENTATION = '''
|
||||||
|
---
|
||||||
|
module: fmgr_secprof_profile_group
|
||||||
|
version_added: "2.8"
|
||||||
|
author:
|
||||||
|
- Luke Weighall (@lweighall)
|
||||||
|
- Andrew Welsh (@Ghilli3)
|
||||||
|
- Jim Huber (@p4r4n0y1ng)
|
||||||
|
short_description: Manage security profiles within FortiManager
|
||||||
|
description:
|
||||||
|
- Manage security profile group which allows you to create a group of security profiles and apply that to a policy.
|
||||||
|
|
||||||
|
options:
|
||||||
|
adom:
|
||||||
|
description:
|
||||||
|
- The ADOM the configuration should belong to.
|
||||||
|
required: false
|
||||||
|
default: root
|
||||||
|
|
||||||
|
host:
|
||||||
|
description:
|
||||||
|
- The FortiManager's address.
|
||||||
|
required: true
|
||||||
|
|
||||||
|
username:
|
||||||
|
description:
|
||||||
|
- The username associated with the account.
|
||||||
|
required: true
|
||||||
|
|
||||||
|
password:
|
||||||
|
description:
|
||||||
|
- The password associated with the username account.
|
||||||
|
required: true
|
||||||
|
|
||||||
|
mode:
|
||||||
|
description:
|
||||||
|
- Sets one of three modes for managing the object.
|
||||||
|
- Allows use of soft-adds instead of overwriting existing values.
|
||||||
|
choices: ['add', 'set', 'delete', 'update']
|
||||||
|
required: false
|
||||||
|
default: add
|
||||||
|
|
||||||
|
webfilter_profile:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing Web filter profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
waf_profile:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing Web application firewall profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
voip_profile:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing VoIP profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
ssl_ssh_profile:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing SSL SSH profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
ssh_filter_profile:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing SSH filter profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
spamfilter_profile:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing Spam filter profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
profile_protocol_options:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing Protocol options profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
name:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Profile group name.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
mms_profile:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing MMS profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
ips_sensor:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing IPS sensor.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
icap_profile:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing ICAP profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
dnsfilter_profile:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing DNS filter profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
dlp_sensor:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing DLP sensor.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
av_profile:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing Antivirus profile.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
application_list:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Name of an existing Application list.
|
||||||
|
required: false
|
||||||
|
|
||||||
|
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = '''
|
||||||
|
- name: DELETE Profile
|
||||||
|
fmgr_secprof_profile_group:
|
||||||
|
host: "{{inventory_hostname}}"
|
||||||
|
username: "{{ username }}"
|
||||||
|
password: "{{ password }}"
|
||||||
|
name: "Ansible_TEST_Profile_Group"
|
||||||
|
mode: "delete"
|
||||||
|
|
||||||
|
- name: CREATE Profile
|
||||||
|
fmgr_secprof_profile_group:
|
||||||
|
host: "{{inventory_hostname}}"
|
||||||
|
username: "{{ username }}"
|
||||||
|
password: "{{ password }}"
|
||||||
|
name: "Ansible_TEST_Profile_Group"
|
||||||
|
mode: "set"
|
||||||
|
av_profile: "Ansible_AV_Profile"
|
||||||
|
profile_protocol_options: "default"
|
||||||
|
'''
|
||||||
|
|
||||||
|
RETURN = """
|
||||||
|
api_result:
|
||||||
|
description: full API response, includes status code and message
|
||||||
|
returned: always
|
||||||
|
type: string
|
||||||
|
"""
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule, env_fallback
|
||||||
|
from ansible.module_utils.network.fortimanager.fortimanager import AnsibleFortiManager
|
||||||
|
|
||||||
|
# check for pyFMG lib
|
||||||
|
try:
|
||||||
|
from pyFMG.fortimgr import FortiManager
|
||||||
|
HAS_PYFMGR = True
|
||||||
|
except ImportError:
|
||||||
|
HAS_PYFMGR = False
|
||||||
|
|
||||||
|
###############
|
||||||
|
# START METHODS
|
||||||
|
###############
|
||||||
|
|
||||||
|
|
||||||
|
def fmgr_firewall_profile_group_addsetdelete(fmg, paramgram):
|
||||||
|
"""
|
||||||
|
fmgr_firewall_profile_group -- Your Description here, bruh
|
||||||
|
"""
|
||||||
|
|
||||||
|
mode = paramgram["mode"]
|
||||||
|
adom = paramgram["adom"]
|
||||||
|
url = ""
|
||||||
|
datagram = {}
|
||||||
|
|
||||||
|
response = (-100000, {"msg": "Illegal or malformed paramgram discovered. System Exception"})
|
||||||
|
|
||||||
|
# EVAL THE MODE PARAMETER FOR SET OR ADD
|
||||||
|
if mode in ['set', 'add', 'update']:
|
||||||
|
url = '/pm/config/adom/{adom}/obj/firewall/profile-group'.format(adom=adom)
|
||||||
|
datagram = fmgr_del_none(fmgr_prepare_dict(paramgram))
|
||||||
|
|
||||||
|
# EVAL THE MODE PARAMETER FOR DELETE
|
||||||
|
elif mode == "delete":
|
||||||
|
# SET THE CORRECT URL FOR DELETE
|
||||||
|
url = '/pm/config/adom/{adom}/obj/firewall/profile-group/{name}'.format(adom=adom, name=paramgram["name"])
|
||||||
|
datagram = {}
|
||||||
|
|
||||||
|
# IF MODE = SET -- USE THE 'SET' API CALL MODE
|
||||||
|
if mode == "set":
|
||||||
|
response = fmg.set(url, datagram)
|
||||||
|
# IF MODE = UPDATE -- USER THE 'UPDATE' API CALL MODE
|
||||||
|
elif mode == "update":
|
||||||
|
response = fmg.update(url, datagram)
|
||||||
|
# IF MODE = ADD -- USE THE 'ADD' API CALL MODE
|
||||||
|
elif mode == "add":
|
||||||
|
response = fmg.add(url, datagram)
|
||||||
|
# IF MODE = DELETE -- USE THE DELETE URL AND API CALL MODE
|
||||||
|
elif mode == "delete":
|
||||||
|
response = fmg.delete(url, datagram)
|
||||||
|
|
||||||
|
return response
|
||||||
|
|
||||||
|
|
||||||
|
# ADDITIONAL COMMON FUNCTIONS
|
||||||
|
# FUNCTION/METHOD FOR LOGGING OUT AND ANALYZING ERROR CODES
|
||||||
|
def fmgr_logout(fmg, module, msg="NULL", results=(), good_codes=(0,), logout_on_fail=True, logout_on_success=False):
|
||||||
|
"""
|
||||||
|
THIS METHOD CONTROLS THE LOGOUT AND ERROR REPORTING AFTER AN METHOD OR FUNCTION RUNS
|
||||||
|
"""
|
||||||
|
|
||||||
|
# VALIDATION ERROR (NO RESULTS, JUST AN EXIT)
|
||||||
|
if msg != "NULL" and len(results) == 0:
|
||||||
|
try:
|
||||||
|
fmg.logout()
|
||||||
|
except BaseException:
|
||||||
|
pass
|
||||||
|
module.fail_json(msg=msg)
|
||||||
|
|
||||||
|
# SUBMISSION ERROR
|
||||||
|
if len(results) > 0:
|
||||||
|
if msg == "NULL":
|
||||||
|
try:
|
||||||
|
msg = results[1]['status']['message']
|
||||||
|
except BaseException:
|
||||||
|
msg = "No status message returned from pyFMG. Possible that this was a GET with a tuple result."
|
||||||
|
|
||||||
|
if results[0] not in good_codes:
|
||||||
|
if logout_on_fail:
|
||||||
|
fmg.logout()
|
||||||
|
module.fail_json(msg=msg, **results[1])
|
||||||
|
else:
|
||||||
|
return msg
|
||||||
|
else:
|
||||||
|
if logout_on_success:
|
||||||
|
fmg.logout()
|
||||||
|
module.exit_json(msg=msg, **results[1])
|
||||||
|
else:
|
||||||
|
return msg
|
||||||
|
|
||||||
|
|
||||||
|
# FUNCTION/METHOD FOR CONVERTING CIDR TO A NETMASK
|
||||||
|
# DID NOT USE IP ADDRESS MODULE TO KEEP INCLUDES TO A MINIMUM
|
||||||
|
def fmgr_cidr_to_netmask(cidr):
|
||||||
|
cidr = int(cidr)
|
||||||
|
mask = (0xffffffff >> (32 - cidr)) << (32 - cidr)
|
||||||
|
return(str((0xff000000 & mask) >> 24) + '.' +
|
||||||
|
str((0x00ff0000 & mask) >> 16) + '.' +
|
||||||
|
str((0x0000ff00 & mask) >> 8) + '.' +
|
||||||
|
str((0x000000ff & mask)))
|
||||||
|
|
||||||
|
|
||||||
|
# utility function: removing keys wih value of None, nothing in playbook for that key
|
||||||
|
def fmgr_del_none(obj):
|
||||||
|
if isinstance(obj, dict):
|
||||||
|
return type(obj)((fmgr_del_none(k), fmgr_del_none(v))
|
||||||
|
for k, v in obj.items() if k is not None and (v is not None and not fmgr_is_empty_dict(v)))
|
||||||
|
else:
|
||||||
|
return obj
|
||||||
|
|
||||||
|
|
||||||
|
# utility function: remove keys that are need for the logic but the FMG API won't accept them
|
||||||
|
def fmgr_prepare_dict(obj):
|
||||||
|
list_of_elems = ["mode", "adom", "host", "username", "password"]
|
||||||
|
if isinstance(obj, dict):
|
||||||
|
obj = dict((key, fmgr_prepare_dict(value)) for (key, value) in obj.items() if key not in list_of_elems)
|
||||||
|
return obj
|
||||||
|
|
||||||
|
|
||||||
|
def fmgr_is_empty_dict(obj):
|
||||||
|
return_val = False
|
||||||
|
if isinstance(obj, dict):
|
||||||
|
if len(obj) > 0:
|
||||||
|
for k, v in obj.items():
|
||||||
|
if isinstance(v, dict):
|
||||||
|
if len(v) == 0:
|
||||||
|
return_val = True
|
||||||
|
elif len(v) > 0:
|
||||||
|
for k1, v1 in v.items():
|
||||||
|
if v1 is None:
|
||||||
|
return_val = True
|
||||||
|
elif v1 is not None:
|
||||||
|
return_val = False
|
||||||
|
return return_val
|
||||||
|
elif v is None:
|
||||||
|
return_val = True
|
||||||
|
elif v is not None:
|
||||||
|
return_val = False
|
||||||
|
return return_val
|
||||||
|
elif len(obj) == 0:
|
||||||
|
return_val = True
|
||||||
|
|
||||||
|
return return_val
|
||||||
|
|
||||||
|
|
||||||
|
def fmgr_split_comma_strings_into_lists(obj):
|
||||||
|
if isinstance(obj, dict):
|
||||||
|
if len(obj) > 0:
|
||||||
|
for k, v in obj.items():
|
||||||
|
if isinstance(v, str):
|
||||||
|
new_list = list()
|
||||||
|
if "," in v:
|
||||||
|
new_items = v.split(",")
|
||||||
|
for item in new_items:
|
||||||
|
new_list.append(item.strip())
|
||||||
|
obj[k] = new_list
|
||||||
|
|
||||||
|
return obj
|
||||||
|
|
||||||
|
|
||||||
|
#############
|
||||||
|
# END METHODS
|
||||||
|
#############
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
argument_spec = dict(
|
||||||
|
adom=dict(type="str", default="root"),
|
||||||
|
host=dict(required=True, type="str"),
|
||||||
|
password=dict(fallback=(env_fallback, ["ANSIBLE_NET_PASSWORD"]), no_log=True, required=True),
|
||||||
|
username=dict(fallback=(env_fallback, ["ANSIBLE_NET_USERNAME"]), no_log=True, required=True),
|
||||||
|
mode=dict(choices=["add", "set", "delete", "update"], type="str", default="add"),
|
||||||
|
|
||||||
|
webfilter_profile=dict(required=False, type="str"),
|
||||||
|
waf_profile=dict(required=False, type="str"),
|
||||||
|
voip_profile=dict(required=False, type="str"),
|
||||||
|
ssl_ssh_profile=dict(required=False, type="str"),
|
||||||
|
ssh_filter_profile=dict(required=False, type="str"),
|
||||||
|
spamfilter_profile=dict(required=False, type="str"),
|
||||||
|
profile_protocol_options=dict(required=False, type="str"),
|
||||||
|
name=dict(required=False, type="str"),
|
||||||
|
mms_profile=dict(required=False, type="str"),
|
||||||
|
ips_sensor=dict(required=False, type="str"),
|
||||||
|
icap_profile=dict(required=False, type="str"),
|
||||||
|
dnsfilter_profile=dict(required=False, type="str"),
|
||||||
|
dlp_sensor=dict(required=False, type="str"),
|
||||||
|
av_profile=dict(required=False, type="str"),
|
||||||
|
application_list=dict(required=False, type="str"),
|
||||||
|
|
||||||
|
)
|
||||||
|
|
||||||
|
module = AnsibleModule(argument_spec, supports_check_mode=False)
|
||||||
|
|
||||||
|
# MODULE PARAMGRAM
|
||||||
|
paramgram = {
|
||||||
|
"mode": module.params["mode"],
|
||||||
|
"adom": module.params["adom"],
|
||||||
|
"webfilter-profile": module.params["webfilter_profile"],
|
||||||
|
"waf-profile": module.params["waf_profile"],
|
||||||
|
"voip-profile": module.params["voip_profile"],
|
||||||
|
"ssl-ssh-profile": module.params["ssl_ssh_profile"],
|
||||||
|
"ssh-filter-profile": module.params["ssh_filter_profile"],
|
||||||
|
"spamfilter-profile": module.params["spamfilter_profile"],
|
||||||
|
"profile-protocol-options": module.params["profile_protocol_options"],
|
||||||
|
"name": module.params["name"],
|
||||||
|
"mms-profile": module.params["mms_profile"],
|
||||||
|
"ips-sensor": module.params["ips_sensor"],
|
||||||
|
"icap-profile": module.params["icap_profile"],
|
||||||
|
"dnsfilter-profile": module.params["dnsfilter_profile"],
|
||||||
|
"dlp-sensor": module.params["dlp_sensor"],
|
||||||
|
"av-profile": module.params["av_profile"],
|
||||||
|
"application-list": module.params["application_list"],
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# CHECK IF THE HOST/USERNAME/PW EXISTS, AND IF IT DOES, LOGIN.
|
||||||
|
host = module.params["host"]
|
||||||
|
password = module.params["password"]
|
||||||
|
username = module.params["username"]
|
||||||
|
if host is None or username is None or password is None:
|
||||||
|
module.fail_json(msg="Host and username and password are required")
|
||||||
|
|
||||||
|
# CHECK IF LOGIN FAILED
|
||||||
|
fmg = AnsibleFortiManager(module, module.params["host"], module.params["username"], module.params["password"])
|
||||||
|
|
||||||
|
response = fmg.login()
|
||||||
|
if response[1]['status']['code'] != 0:
|
||||||
|
module.fail_json(msg="Connection to FortiManager Failed")
|
||||||
|
|
||||||
|
results = fmgr_firewall_profile_group_addsetdelete(fmg, paramgram)
|
||||||
|
if results[0] != 0:
|
||||||
|
fmgr_logout(fmg, module, results=results, good_codes=[0])
|
||||||
|
|
||||||
|
fmg.logout()
|
||||||
|
|
||||||
|
if results is not None:
|
||||||
|
return module.exit_json(**results[1])
|
||||||
|
else:
|
||||||
|
return module.exit_json(msg="No results were returned from the API call.")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
|
|
@ -0,0 +1,371 @@
|
||||||
|
{
|
||||||
|
"fmgr_antivirus_profile_addSetDelete": [
|
||||||
|
{
|
||||||
|
"raw_response": {
|
||||||
|
"status": {
|
||||||
|
"message": "Object does not exist",
|
||||||
|
"code": -3
|
||||||
|
},
|
||||||
|
"url": "/pm/config/adom/root/obj/antivirus/profile/Ansible_AV_Profile"
|
||||||
|
},
|
||||||
|
"paramgram_used": {
|
||||||
|
"comment": null,
|
||||||
|
"av-block-log": null,
|
||||||
|
"extended-log": null,
|
||||||
|
"analytics-db": null,
|
||||||
|
"analytics-wl-filetype": null,
|
||||||
|
"av-virus-log": null,
|
||||||
|
"content-disarm": {
|
||||||
|
"pdf-act-movie": null,
|
||||||
|
"pdf-act-gotor": null,
|
||||||
|
"pdf-act-java": null,
|
||||||
|
"original-file-destination": null,
|
||||||
|
"office-hylink": null,
|
||||||
|
"pdf-act-sound": null,
|
||||||
|
"detect-only": null,
|
||||||
|
"office-embed": null,
|
||||||
|
"office-linked": null,
|
||||||
|
"pdf-javacode": null,
|
||||||
|
"pdf-hyperlink": null,
|
||||||
|
"pdf-embedfile": null,
|
||||||
|
"office-macro": null,
|
||||||
|
"pdf-act-form": null,
|
||||||
|
"pdf-act-launch": null,
|
||||||
|
"cover-page": null
|
||||||
|
},
|
||||||
|
"ftp": {
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"options": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null
|
||||||
|
},
|
||||||
|
"mapi": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"analytics-max-upload": null,
|
||||||
|
"nntp": {
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"options": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null
|
||||||
|
},
|
||||||
|
"smb": {
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"options": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null
|
||||||
|
},
|
||||||
|
"analytics-bl-filetype": null,
|
||||||
|
"http": {
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"adom": "root",
|
||||||
|
"smtp": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"pop3": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"inspection-mode": null,
|
||||||
|
"ftgd-analytics": null,
|
||||||
|
"imap": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"name": "Ansible_AV_Profile",
|
||||||
|
"replacemsg-group": null,
|
||||||
|
"scan-mode": null,
|
||||||
|
"nac-quar": {
|
||||||
|
"infected": null,
|
||||||
|
"log": null,
|
||||||
|
"expiry": null
|
||||||
|
},
|
||||||
|
"mode": "delete",
|
||||||
|
"mobile-malware-db": null
|
||||||
|
},
|
||||||
|
"post_method": "delete"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"paramgram_used": {
|
||||||
|
"comment": "Created by Ansible Module TEST",
|
||||||
|
"name": "Ansible_AV_Profile",
|
||||||
|
"scan-mode": "full",
|
||||||
|
"av-block-log": "enable",
|
||||||
|
"inspection-mode": "proxy",
|
||||||
|
"av-virus-log": "enable",
|
||||||
|
"ftgd-analytics": "everything",
|
||||||
|
"mobile-malware-db": "enable",
|
||||||
|
"mode": "delete",
|
||||||
|
"adom": "root"
|
||||||
|
},
|
||||||
|
"raw_response": {
|
||||||
|
"status": {
|
||||||
|
"message": "OK",
|
||||||
|
"code": 0
|
||||||
|
},
|
||||||
|
"url": "/pm/config/adom/root/obj/antivirus/profile"
|
||||||
|
},
|
||||||
|
"post_method": "set"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"raw_response": {
|
||||||
|
"status": {
|
||||||
|
"message": "OK",
|
||||||
|
"code": 0
|
||||||
|
},
|
||||||
|
"url": "/pm/config/adom/root/obj/antivirus/profile/Ansible_AV_Profile"
|
||||||
|
},
|
||||||
|
"paramgram_used": {
|
||||||
|
"comment": null,
|
||||||
|
"av-block-log": null,
|
||||||
|
"extended-log": null,
|
||||||
|
"analytics-db": null,
|
||||||
|
"analytics-wl-filetype": null,
|
||||||
|
"av-virus-log": null,
|
||||||
|
"content-disarm": {
|
||||||
|
"pdf-act-movie": null,
|
||||||
|
"pdf-act-gotor": null,
|
||||||
|
"office-macro": null,
|
||||||
|
"pdf-act-java": null,
|
||||||
|
"original-file-destination": null,
|
||||||
|
"office-hylink": null,
|
||||||
|
"pdf-act-sound": null,
|
||||||
|
"detect-only": null,
|
||||||
|
"office-embed": null,
|
||||||
|
"office-linked": null,
|
||||||
|
"pdf-javacode": null,
|
||||||
|
"pdf-hyperlink": null,
|
||||||
|
"cover-page": null,
|
||||||
|
"pdf-embedfile": null,
|
||||||
|
"pdf-act-form": null,
|
||||||
|
"pdf-act-launch": null
|
||||||
|
},
|
||||||
|
"ftp": {
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"options": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null
|
||||||
|
},
|
||||||
|
"mapi": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"analytics-max-upload": null,
|
||||||
|
"nntp": {
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"options": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null
|
||||||
|
},
|
||||||
|
"smb": {
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"options": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null
|
||||||
|
},
|
||||||
|
"analytics-bl-filetype": null,
|
||||||
|
"http": {
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"adom": "root",
|
||||||
|
"smtp": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"pop3": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"inspection-mode": null,
|
||||||
|
"ftgd-analytics": null,
|
||||||
|
"imap": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"name": "Ansible_AV_Profile",
|
||||||
|
"replacemsg-group": null,
|
||||||
|
"scan-mode": null,
|
||||||
|
"nac-quar": {
|
||||||
|
"infected": null,
|
||||||
|
"log": null,
|
||||||
|
"expiry": null
|
||||||
|
},
|
||||||
|
"mode": "delete",
|
||||||
|
"mobile-malware-db": null
|
||||||
|
},
|
||||||
|
"post_method": "delete"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"raw_response": {
|
||||||
|
"status": {
|
||||||
|
"message": "used",
|
||||||
|
"code": -10015
|
||||||
|
},
|
||||||
|
"url": "/pm/config/adom/root/obj/antivirus/profile/Ansible_AV_Profile"
|
||||||
|
},
|
||||||
|
"paramgram_used": {
|
||||||
|
"comment": null,
|
||||||
|
"av-block-log": null,
|
||||||
|
"extended-log": null,
|
||||||
|
"analytics-db": null,
|
||||||
|
"analytics-wl-filetype": null,
|
||||||
|
"av-virus-log": null,
|
||||||
|
"content-disarm": {
|
||||||
|
"pdf-act-movie": null,
|
||||||
|
"pdf-act-gotor": null,
|
||||||
|
"pdf-act-java": null,
|
||||||
|
"original-file-destination": null,
|
||||||
|
"cover-page": null,
|
||||||
|
"pdf-act-sound": null,
|
||||||
|
"detect-only": null,
|
||||||
|
"office-embed": null,
|
||||||
|
"pdf-embedfile": null,
|
||||||
|
"office-linked": null,
|
||||||
|
"pdf-javacode": null,
|
||||||
|
"pdf-hyperlink": null,
|
||||||
|
"office-hylink": null,
|
||||||
|
"office-macro": null,
|
||||||
|
"pdf-act-form": null,
|
||||||
|
"pdf-act-launch": null
|
||||||
|
},
|
||||||
|
"ftp": {
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"options": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null
|
||||||
|
},
|
||||||
|
"smtp": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"mapi": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"analytics-max-upload": null,
|
||||||
|
"nntp": {
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"options": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null
|
||||||
|
},
|
||||||
|
"smb": {
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"options": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null
|
||||||
|
},
|
||||||
|
"analytics-bl-filetype": null,
|
||||||
|
"http": {
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"adom": "root",
|
||||||
|
"scan-mode": null,
|
||||||
|
"pop3": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"inspection-mode": null,
|
||||||
|
"ftgd-analytics": null,
|
||||||
|
"imap": {
|
||||||
|
"executables": null,
|
||||||
|
"archive-log": null,
|
||||||
|
"outbreak-prevention": null,
|
||||||
|
"emulator": null,
|
||||||
|
"archive-block": null,
|
||||||
|
"content-disarm": null,
|
||||||
|
"options": null
|
||||||
|
},
|
||||||
|
"name": "Ansible_AV_Profile",
|
||||||
|
"replacemsg-group": null,
|
||||||
|
"nac-quar": {
|
||||||
|
"infected": null,
|
||||||
|
"log": null,
|
||||||
|
"expiry": null
|
||||||
|
},
|
||||||
|
"mode": "delete",
|
||||||
|
"mobile-malware-db": null
|
||||||
|
},
|
||||||
|
"post_method": "delete"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,62 @@
|
||||||
|
{
|
||||||
|
"fmgr_firewall_profile_group_addsetdelete": [
|
||||||
|
{
|
||||||
|
"paramgram_used": {
|
||||||
|
"ssl-ssh-profile": null,
|
||||||
|
"waf-profile": null,
|
||||||
|
"adom": "root",
|
||||||
|
"webfilter-profile": null,
|
||||||
|
"profile-protocol-options": null,
|
||||||
|
"application-list": null,
|
||||||
|
"icap-profile": null,
|
||||||
|
"voip-profile": null,
|
||||||
|
"ips-sensor": null,
|
||||||
|
"dnsfilter-profile": null,
|
||||||
|
"av-profile": null,
|
||||||
|
"spamfilter-profile": null,
|
||||||
|
"dlp-sensor": null,
|
||||||
|
"mode": "delete",
|
||||||
|
"ssh-filter-profile": null,
|
||||||
|
"mms-profile": null,
|
||||||
|
"name": "Ansible_TEST_Profile_Group"
|
||||||
|
},
|
||||||
|
"raw_response": {
|
||||||
|
"status": {
|
||||||
|
"message": "OK",
|
||||||
|
"code": 0
|
||||||
|
},
|
||||||
|
"url": "/pm/config/adom/root/obj/firewall/profile-group/Ansible_TEST_Profile_Group"
|
||||||
|
},
|
||||||
|
"post_method": "delete"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"raw_response": {
|
||||||
|
"status": {
|
||||||
|
"message": "OK",
|
||||||
|
"code": 0
|
||||||
|
},
|
||||||
|
"url": "/pm/config/adom/root/obj/firewall/profile-group"
|
||||||
|
},
|
||||||
|
"paramgram_used": {
|
||||||
|
"ssl-ssh-profile": null,
|
||||||
|
"application-list": null,
|
||||||
|
"waf-profile": null,
|
||||||
|
"adom": "root",
|
||||||
|
"webfilter-profile": null,
|
||||||
|
"ips-sensor": null,
|
||||||
|
"spamfilter-profile": null,
|
||||||
|
"icap-profile": null,
|
||||||
|
"dnsfilter-profile": null,
|
||||||
|
"name": "Ansible_TEST_Profile_Group",
|
||||||
|
"voip-profile": null,
|
||||||
|
"av-profile": "Ansible_AV_Profile",
|
||||||
|
"mode": "set",
|
||||||
|
"dlp-sensor": null,
|
||||||
|
"mms-profile": null,
|
||||||
|
"ssh-filter-profile": null,
|
||||||
|
"profile-protocol-options": "default"
|
||||||
|
},
|
||||||
|
"post_method": "set"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,100 @@
|
||||||
|
# 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 Ansible. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
# Make coding more python3-ish
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
import os
|
||||||
|
import json
|
||||||
|
from pyFMG.fortimgr import FortiManager
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
try:
|
||||||
|
from ansible.modules.network.fortimanager import fmgr_secprof_profile_group
|
||||||
|
except ImportError:
|
||||||
|
pytest.skip("Could not load required modules for testing", allow_module_level=True)
|
||||||
|
|
||||||
|
fmg_instance = FortiManager("1.1.1.1", "admin", "")
|
||||||
|
|
||||||
|
|
||||||
|
def load_fixtures():
|
||||||
|
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures') + "/{filename}.json".format(
|
||||||
|
filename=os.path.splitext(os.path.basename(__file__))[0])
|
||||||
|
try:
|
||||||
|
with open(fixture_path, "r") as fixture_file:
|
||||||
|
fixture_data = json.load(fixture_file)
|
||||||
|
except IOError:
|
||||||
|
return []
|
||||||
|
return [fixture_data]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="function", params=load_fixtures())
|
||||||
|
def fixture_data(request):
|
||||||
|
func_name = request.function.__name__.replace("test_", "")
|
||||||
|
return request.param.get(func_name, None)
|
||||||
|
|
||||||
|
|
||||||
|
def test_fmgr_firewall_profile_group_addsetdelete(fixture_data, mocker):
|
||||||
|
mocker.patch("pyFMG.fortimgr.FortiManager._post_request", side_effect=fixture_data)
|
||||||
|
# Fixture sets used:###########################
|
||||||
|
|
||||||
|
##################################################
|
||||||
|
# ssl-ssh-profile: None
|
||||||
|
# waf-profile: None
|
||||||
|
# adom: root
|
||||||
|
# webfilter-profile: None
|
||||||
|
# profile-protocol-options: None
|
||||||
|
# application-list: None
|
||||||
|
# icap-profile: None
|
||||||
|
# voip-profile: None
|
||||||
|
# ips-sensor: None
|
||||||
|
# dnsfilter-profile: None
|
||||||
|
# av-profile: None
|
||||||
|
# spamfilter-profile: None
|
||||||
|
# dlp-sensor: None
|
||||||
|
# mode: delete
|
||||||
|
# ssh-filter-profile: None
|
||||||
|
# mms-profile: None
|
||||||
|
# name: Ansible_TEST_Profile_Group
|
||||||
|
##################################################
|
||||||
|
##################################################
|
||||||
|
# ssl-ssh-profile: None
|
||||||
|
# application-list: None
|
||||||
|
# waf-profile: None
|
||||||
|
# adom: root
|
||||||
|
# webfilter-profile: None
|
||||||
|
# ips-sensor: None
|
||||||
|
# spamfilter-profile: None
|
||||||
|
# icap-profile: None
|
||||||
|
# dnsfilter-profile: None
|
||||||
|
# name: Ansible_TEST_Profile_Group
|
||||||
|
# voip-profile: None
|
||||||
|
# av-profile: Ansible_AV_Profile
|
||||||
|
# mode: set
|
||||||
|
# dlp-sensor: None
|
||||||
|
# mms-profile: None
|
||||||
|
# ssh-filter-profile: None
|
||||||
|
# profile-protocol-options: default
|
||||||
|
##################################################
|
||||||
|
|
||||||
|
# Test using fixture 1 #
|
||||||
|
output = fmgr_secprof_profile_group.fmgr_firewall_profile_group_addsetdelete(fmg_instance,
|
||||||
|
fixture_data[0]['paramgram_used'])
|
||||||
|
assert output['raw_response']['status']['code'] == 0
|
||||||
|
# Test using fixture 2 #
|
||||||
|
output = fmgr_secprof_profile_group.fmgr_firewall_profile_group_addsetdelete(fmg_instance,
|
||||||
|
fixture_data[1]['paramgram_used'])
|
||||||
|
assert output['raw_response']['status']['code'] == 0
|
||||||
Loading…
Reference in a new issue