mirror of https://github.com/ansible/ansible.git
Fortinet's new module for fortios_user_ldap (#61053)
* Fortinet's new module for fortios_user_ldap * Update fortios_user_ldap.pypull/61177/head
parent
4130fdbc8a
commit
2684635f7f
@ -0,0 +1,493 @@
|
|||||||
|
#!/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/>
|
||||||
|
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
ANSIBLE_METADATA = {'status': ['preview'],
|
||||||
|
'supported_by': 'community',
|
||||||
|
'metadata_version': '1.1'}
|
||||||
|
|
||||||
|
DOCUMENTATION = '''
|
||||||
|
---
|
||||||
|
module: fortios_user_ldap
|
||||||
|
short_description: Configure LDAP server entries 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 ldap 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_ldap:
|
||||||
|
description:
|
||||||
|
- Configure LDAP server entries.
|
||||||
|
default: null
|
||||||
|
type: dict
|
||||||
|
suboptions:
|
||||||
|
account_key_filter:
|
||||||
|
description:
|
||||||
|
- Account key filter, using the UPN as the search filter.
|
||||||
|
type: str
|
||||||
|
account_key_processing:
|
||||||
|
description:
|
||||||
|
- Account key processing operation, either keep or strip domain string of UPN in the token.
|
||||||
|
type: str
|
||||||
|
choices:
|
||||||
|
- same
|
||||||
|
- strip
|
||||||
|
ca_cert:
|
||||||
|
description:
|
||||||
|
- CA certificate name. Source vpn.certificate.ca.name.
|
||||||
|
type: str
|
||||||
|
cnid:
|
||||||
|
description:
|
||||||
|
- Common name identifier for the LDAP server. The common name identifier for most LDAP servers is "cn".
|
||||||
|
type: str
|
||||||
|
dn:
|
||||||
|
description:
|
||||||
|
- Distinguished name used to look up entries on the LDAP server.
|
||||||
|
type: str
|
||||||
|
group_filter:
|
||||||
|
description:
|
||||||
|
- Filter used for group matching.
|
||||||
|
type: str
|
||||||
|
group_member_check:
|
||||||
|
description:
|
||||||
|
- Group member checking methods.
|
||||||
|
type: str
|
||||||
|
choices:
|
||||||
|
- user-attr
|
||||||
|
- group-object
|
||||||
|
- posix-group-object
|
||||||
|
group_object_filter:
|
||||||
|
description:
|
||||||
|
- Filter used for group searching.
|
||||||
|
type: str
|
||||||
|
group_search_base:
|
||||||
|
description:
|
||||||
|
- Search base used for group searching.
|
||||||
|
type: str
|
||||||
|
member_attr:
|
||||||
|
description:
|
||||||
|
- Name of attribute from which to get group membership.
|
||||||
|
type: str
|
||||||
|
name:
|
||||||
|
description:
|
||||||
|
- LDAP server entry name.
|
||||||
|
required: true
|
||||||
|
type: str
|
||||||
|
password:
|
||||||
|
description:
|
||||||
|
- Password for initial binding.
|
||||||
|
type: str
|
||||||
|
password_expiry_warning:
|
||||||
|
description:
|
||||||
|
- Enable/disable password expiry warnings.
|
||||||
|
type: str
|
||||||
|
choices:
|
||||||
|
- enable
|
||||||
|
- disable
|
||||||
|
password_renewal:
|
||||||
|
description:
|
||||||
|
- Enable/disable online password renewal.
|
||||||
|
type: str
|
||||||
|
choices:
|
||||||
|
- enable
|
||||||
|
- disable
|
||||||
|
port:
|
||||||
|
description:
|
||||||
|
- Port to be used for communication with the LDAP server .
|
||||||
|
type: int
|
||||||
|
secondary_server:
|
||||||
|
description:
|
||||||
|
- Secondary LDAP server CN domain name or IP.
|
||||||
|
type: str
|
||||||
|
secure:
|
||||||
|
description:
|
||||||
|
- Port to be used for authentication.
|
||||||
|
type: str
|
||||||
|
choices:
|
||||||
|
- disable
|
||||||
|
- starttls
|
||||||
|
- ldaps
|
||||||
|
server:
|
||||||
|
description:
|
||||||
|
- LDAP server CN domain name or IP.
|
||||||
|
type: str
|
||||||
|
server_identity_check:
|
||||||
|
description:
|
||||||
|
- Enable/disable LDAP server identity check (verify server domain name/IP address against the server certificate).
|
||||||
|
type: str
|
||||||
|
choices:
|
||||||
|
- enable
|
||||||
|
- disable
|
||||||
|
source_ip:
|
||||||
|
description:
|
||||||
|
- Source IP for communications to LDAP server.
|
||||||
|
type: str
|
||||||
|
ssl_min_proto_version:
|
||||||
|
description:
|
||||||
|
- Minimum supported protocol version for SSL/TLS connections .
|
||||||
|
type: str
|
||||||
|
choices:
|
||||||
|
- default
|
||||||
|
- SSLv3
|
||||||
|
- TLSv1
|
||||||
|
- TLSv1-1
|
||||||
|
- TLSv1-2
|
||||||
|
tertiary_server:
|
||||||
|
description:
|
||||||
|
- Tertiary LDAP server CN domain name or IP.
|
||||||
|
type: str
|
||||||
|
type:
|
||||||
|
description:
|
||||||
|
- Authentication type for LDAP searches.
|
||||||
|
type: str
|
||||||
|
choices:
|
||||||
|
- simple
|
||||||
|
- anonymous
|
||||||
|
- regular
|
||||||
|
username:
|
||||||
|
description:
|
||||||
|
- Username (full DN) for initial binding.
|
||||||
|
type: str
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = '''
|
||||||
|
- hosts: localhost
|
||||||
|
vars:
|
||||||
|
host: "192.168.122.40"
|
||||||
|
username: "admin"
|
||||||
|
password: ""
|
||||||
|
vdom: "root"
|
||||||
|
ssl_verify: "False"
|
||||||
|
tasks:
|
||||||
|
- name: Configure LDAP server entries.
|
||||||
|
fortios_user_ldap:
|
||||||
|
host: "{{ host }}"
|
||||||
|
username: "{{ username }}"
|
||||||
|
password: "{{ password }}"
|
||||||
|
vdom: "{{ vdom }}"
|
||||||
|
https: "False"
|
||||||
|
state: "present"
|
||||||
|
user_ldap:
|
||||||
|
account_key_filter: "<your_own_value>"
|
||||||
|
account_key_processing: "same"
|
||||||
|
ca_cert: "<your_own_value> (source vpn.certificate.ca.name)"
|
||||||
|
cnid: "<your_own_value>"
|
||||||
|
dn: "<your_own_value>"
|
||||||
|
group_filter: "<your_own_value>"
|
||||||
|
group_member_check: "user-attr"
|
||||||
|
group_object_filter: "<your_own_value>"
|
||||||
|
group_search_base: "<your_own_value>"
|
||||||
|
member_attr: "<your_own_value>"
|
||||||
|
name: "default_name_13"
|
||||||
|
password: "<your_own_value>"
|
||||||
|
password_expiry_warning: "enable"
|
||||||
|
password_renewal: "enable"
|
||||||
|
port: "17"
|
||||||
|
secondary_server: "<your_own_value>"
|
||||||
|
secure: "disable"
|
||||||
|
server: "192.168.100.40"
|
||||||
|
server_identity_check: "enable"
|
||||||
|
source_ip: "84.230.14.43"
|
||||||
|
ssl_min_proto_version: "default"
|
||||||
|
tertiary_server: "<your_own_value>"
|
||||||
|
type: "simple"
|
||||||
|
username: "<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
|
||||||
|
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_ldap_data(json):
|
||||||
|
option_list = ['account_key_filter', 'account_key_processing', 'ca_cert',
|
||||||
|
'cnid', 'dn', 'group_filter',
|
||||||
|
'group_member_check', 'group_object_filter', 'group_search_base',
|
||||||
|
'member_attr', 'name', 'password',
|
||||||
|
'password_expiry_warning', 'password_renewal', 'port',
|
||||||
|
'secondary_server', 'secure', 'server',
|
||||||
|
'server_identity_check', 'source_ip', 'ssl_min_proto_version',
|
||||||
|
'tertiary_server', 'type', 'username']
|
||||||
|
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_ldap(data, fos):
|
||||||
|
vdom = data['vdom']
|
||||||
|
state = data['state']
|
||||||
|
user_ldap_data = data['user_ldap']
|
||||||
|
filtered_data = underscore_to_hyphen(filter_user_ldap_data(user_ldap_data))
|
||||||
|
|
||||||
|
if state == "present":
|
||||||
|
return fos.set('user',
|
||||||
|
'ldap',
|
||||||
|
data=filtered_data,
|
||||||
|
vdom=vdom)
|
||||||
|
|
||||||
|
elif state == "absent":
|
||||||
|
return fos.delete('user',
|
||||||
|
'ldap',
|
||||||
|
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_ldap']:
|
||||||
|
resp = user_ldap(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_ldap": {
|
||||||
|
"required": False, "type": "dict", "default": None,
|
||||||
|
"options": {
|
||||||
|
"account_key_filter": {"required": False, "type": "str"},
|
||||||
|
"account_key_processing": {"required": False, "type": "str",
|
||||||
|
"choices": ["same", "strip"]},
|
||||||
|
"ca_cert": {"required": False, "type": "str"},
|
||||||
|
"cnid": {"required": False, "type": "str"},
|
||||||
|
"dn": {"required": False, "type": "str"},
|
||||||
|
"group_filter": {"required": False, "type": "str"},
|
||||||
|
"group_member_check": {"required": False, "type": "str",
|
||||||
|
"choices": ["user-attr", "group-object", "posix-group-object"]},
|
||||||
|
"group_object_filter": {"required": False, "type": "str"},
|
||||||
|
"group_search_base": {"required": False, "type": "str"},
|
||||||
|
"member_attr": {"required": False, "type": "str"},
|
||||||
|
"name": {"required": True, "type": "str"},
|
||||||
|
"password": {"required": False, "type": "str"},
|
||||||
|
"password_expiry_warning": {"required": False, "type": "str",
|
||||||
|
"choices": ["enable", "disable"]},
|
||||||
|
"password_renewal": {"required": False, "type": "str",
|
||||||
|
"choices": ["enable", "disable"]},
|
||||||
|
"port": {"required": False, "type": "int"},
|
||||||
|
"secondary_server": {"required": False, "type": "str"},
|
||||||
|
"secure": {"required": False, "type": "str",
|
||||||
|
"choices": ["disable", "starttls", "ldaps"]},
|
||||||
|
"server": {"required": False, "type": "str"},
|
||||||
|
"server_identity_check": {"required": False, "type": "str",
|
||||||
|
"choices": ["enable", "disable"]},
|
||||||
|
"source_ip": {"required": False, "type": "str"},
|
||||||
|
"ssl_min_proto_version": {"required": False, "type": "str",
|
||||||
|
"choices": ["default", "SSLv3", "TLSv1",
|
||||||
|
"TLSv1-1", "TLSv1-2"]},
|
||||||
|
"tertiary_server": {"required": False, "type": "str"},
|
||||||
|
"type": {"required": False, "type": "str",
|
||||||
|
"choices": ["simple", "anonymous", "regular"]},
|
||||||
|
"username": {"required": False, "type": "str"}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
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()
|
@ -0,0 +1,429 @@
|
|||||||
|
# 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 <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
# 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_ldap
|
||||||
|
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_ldap.Connection')
|
||||||
|
return connection_class_mock
|
||||||
|
|
||||||
|
|
||||||
|
fos_instance = FortiOSHandler(connection_mock)
|
||||||
|
|
||||||
|
|
||||||
|
def test_user_ldap_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_ldap': {
|
||||||
|
'account_key_filter': 'test_value_3',
|
||||||
|
'account_key_processing': 'same',
|
||||||
|
'ca_cert': 'test_value_5',
|
||||||
|
'cnid': 'test_value_6',
|
||||||
|
'dn': 'test_value_7',
|
||||||
|
'group_filter': 'test_value_8',
|
||||||
|
'group_member_check': 'user-attr',
|
||||||
|
'group_object_filter': 'test_value_10',
|
||||||
|
'group_search_base': 'test_value_11',
|
||||||
|
'member_attr': 'test_value_12',
|
||||||
|
'name': 'default_name_13',
|
||||||
|
'password': 'test_value_14',
|
||||||
|
'password_expiry_warning': 'enable',
|
||||||
|
'password_renewal': 'enable',
|
||||||
|
'port': '17',
|
||||||
|
'secondary_server': 'test_value_18',
|
||||||
|
'secure': 'disable',
|
||||||
|
'server': '192.168.100.20',
|
||||||
|
'server_identity_check': 'enable',
|
||||||
|
'source_ip': '84.230.14.22',
|
||||||
|
'ssl_min_proto_version': 'default',
|
||||||
|
'tertiary_server': 'test_value_24',
|
||||||
|
'type': 'simple',
|
||||||
|
'username': 'test_value_26'
|
||||||
|
},
|
||||||
|
'vdom': 'root'}
|
||||||
|
|
||||||
|
is_error, changed, response = fortios_user_ldap.fortios_user(input_data, fos_instance)
|
||||||
|
|
||||||
|
expected_data = {
|
||||||
|
'account-key-filter': 'test_value_3',
|
||||||
|
'account-key-processing': 'same',
|
||||||
|
'ca-cert': 'test_value_5',
|
||||||
|
'cnid': 'test_value_6',
|
||||||
|
'dn': 'test_value_7',
|
||||||
|
'group-filter': 'test_value_8',
|
||||||
|
'group-member-check': 'user-attr',
|
||||||
|
'group-object-filter': 'test_value_10',
|
||||||
|
'group-search-base': 'test_value_11',
|
||||||
|
'member-attr': 'test_value_12',
|
||||||
|
'name': 'default_name_13',
|
||||||
|
'password': 'test_value_14',
|
||||||
|
'password-expiry-warning': 'enable',
|
||||||
|
'password-renewal': 'enable',
|
||||||
|
'port': '17',
|
||||||
|
'secondary-server': 'test_value_18',
|
||||||
|
'secure': 'disable',
|
||||||
|
'server': '192.168.100.20',
|
||||||
|
'server-identity-check': 'enable',
|
||||||
|
'source-ip': '84.230.14.22',
|
||||||
|
'ssl-min-proto-version': 'default',
|
||||||
|
'tertiary-server': 'test_value_24',
|
||||||
|
'type': 'simple',
|
||||||
|
'username': 'test_value_26'
|
||||||
|
}
|
||||||
|
|
||||||
|
set_method_mock.assert_called_with('user', 'ldap', 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_ldap_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_ldap': {
|
||||||
|
'account_key_filter': 'test_value_3',
|
||||||
|
'account_key_processing': 'same',
|
||||||
|
'ca_cert': 'test_value_5',
|
||||||
|
'cnid': 'test_value_6',
|
||||||
|
'dn': 'test_value_7',
|
||||||
|
'group_filter': 'test_value_8',
|
||||||
|
'group_member_check': 'user-attr',
|
||||||
|
'group_object_filter': 'test_value_10',
|
||||||
|
'group_search_base': 'test_value_11',
|
||||||
|
'member_attr': 'test_value_12',
|
||||||
|
'name': 'default_name_13',
|
||||||
|
'password': 'test_value_14',
|
||||||
|
'password_expiry_warning': 'enable',
|
||||||
|
'password_renewal': 'enable',
|
||||||
|
'port': '17',
|
||||||
|
'secondary_server': 'test_value_18',
|
||||||
|
'secure': 'disable',
|
||||||
|
'server': '192.168.100.20',
|
||||||
|
'server_identity_check': 'enable',
|
||||||
|
'source_ip': '84.230.14.22',
|
||||||
|
'ssl_min_proto_version': 'default',
|
||||||
|
'tertiary_server': 'test_value_24',
|
||||||
|
'type': 'simple',
|
||||||
|
'username': 'test_value_26'
|
||||||
|
},
|
||||||
|
'vdom': 'root'}
|
||||||
|
|
||||||
|
is_error, changed, response = fortios_user_ldap.fortios_user(input_data, fos_instance)
|
||||||
|
|
||||||
|
expected_data = {
|
||||||
|
'account-key-filter': 'test_value_3',
|
||||||
|
'account-key-processing': 'same',
|
||||||
|
'ca-cert': 'test_value_5',
|
||||||
|
'cnid': 'test_value_6',
|
||||||
|
'dn': 'test_value_7',
|
||||||
|
'group-filter': 'test_value_8',
|
||||||
|
'group-member-check': 'user-attr',
|
||||||
|
'group-object-filter': 'test_value_10',
|
||||||
|
'group-search-base': 'test_value_11',
|
||||||
|
'member-attr': 'test_value_12',
|
||||||
|
'name': 'default_name_13',
|
||||||
|
'password': 'test_value_14',
|
||||||
|
'password-expiry-warning': 'enable',
|
||||||
|
'password-renewal': 'enable',
|
||||||
|
'port': '17',
|
||||||
|
'secondary-server': 'test_value_18',
|
||||||
|
'secure': 'disable',
|
||||||
|
'server': '192.168.100.20',
|
||||||
|
'server-identity-check': 'enable',
|
||||||
|
'source-ip': '84.230.14.22',
|
||||||
|
'ssl-min-proto-version': 'default',
|
||||||
|
'tertiary-server': 'test_value_24',
|
||||||
|
'type': 'simple',
|
||||||
|
'username': 'test_value_26'
|
||||||
|
}
|
||||||
|
|
||||||
|
set_method_mock.assert_called_with('user', 'ldap', 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_ldap_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_ldap': {
|
||||||
|
'account_key_filter': 'test_value_3',
|
||||||
|
'account_key_processing': 'same',
|
||||||
|
'ca_cert': 'test_value_5',
|
||||||
|
'cnid': 'test_value_6',
|
||||||
|
'dn': 'test_value_7',
|
||||||
|
'group_filter': 'test_value_8',
|
||||||
|
'group_member_check': 'user-attr',
|
||||||
|
'group_object_filter': 'test_value_10',
|
||||||
|
'group_search_base': 'test_value_11',
|
||||||
|
'member_attr': 'test_value_12',
|
||||||
|
'name': 'default_name_13',
|
||||||
|
'password': 'test_value_14',
|
||||||
|
'password_expiry_warning': 'enable',
|
||||||
|
'password_renewal': 'enable',
|
||||||
|
'port': '17',
|
||||||
|
'secondary_server': 'test_value_18',
|
||||||
|
'secure': 'disable',
|
||||||
|
'server': '192.168.100.20',
|
||||||
|
'server_identity_check': 'enable',
|
||||||
|
'source_ip': '84.230.14.22',
|
||||||
|
'ssl_min_proto_version': 'default',
|
||||||
|
'tertiary_server': 'test_value_24',
|
||||||
|
'type': 'simple',
|
||||||
|
'username': 'test_value_26'
|
||||||
|
},
|
||||||
|
'vdom': 'root'}
|
||||||
|
|
||||||
|
is_error, changed, response = fortios_user_ldap.fortios_user(input_data, fos_instance)
|
||||||
|
|
||||||
|
delete_method_mock.assert_called_with('user', 'ldap', 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_ldap_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_ldap': {
|
||||||
|
'account_key_filter': 'test_value_3',
|
||||||
|
'account_key_processing': 'same',
|
||||||
|
'ca_cert': 'test_value_5',
|
||||||
|
'cnid': 'test_value_6',
|
||||||
|
'dn': 'test_value_7',
|
||||||
|
'group_filter': 'test_value_8',
|
||||||
|
'group_member_check': 'user-attr',
|
||||||
|
'group_object_filter': 'test_value_10',
|
||||||
|
'group_search_base': 'test_value_11',
|
||||||
|
'member_attr': 'test_value_12',
|
||||||
|
'name': 'default_name_13',
|
||||||
|
'password': 'test_value_14',
|
||||||
|
'password_expiry_warning': 'enable',
|
||||||
|
'password_renewal': 'enable',
|
||||||
|
'port': '17',
|
||||||
|
'secondary_server': 'test_value_18',
|
||||||
|
'secure': 'disable',
|
||||||
|
'server': '192.168.100.20',
|
||||||
|
'server_identity_check': 'enable',
|
||||||
|
'source_ip': '84.230.14.22',
|
||||||
|
'ssl_min_proto_version': 'default',
|
||||||
|
'tertiary_server': 'test_value_24',
|
||||||
|
'type': 'simple',
|
||||||
|
'username': 'test_value_26'
|
||||||
|
},
|
||||||
|
'vdom': 'root'}
|
||||||
|
|
||||||
|
is_error, changed, response = fortios_user_ldap.fortios_user(input_data, fos_instance)
|
||||||
|
|
||||||
|
delete_method_mock.assert_called_with('user', 'ldap', 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_ldap_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_ldap': {
|
||||||
|
'account_key_filter': 'test_value_3',
|
||||||
|
'account_key_processing': 'same',
|
||||||
|
'ca_cert': 'test_value_5',
|
||||||
|
'cnid': 'test_value_6',
|
||||||
|
'dn': 'test_value_7',
|
||||||
|
'group_filter': 'test_value_8',
|
||||||
|
'group_member_check': 'user-attr',
|
||||||
|
'group_object_filter': 'test_value_10',
|
||||||
|
'group_search_base': 'test_value_11',
|
||||||
|
'member_attr': 'test_value_12',
|
||||||
|
'name': 'default_name_13',
|
||||||
|
'password': 'test_value_14',
|
||||||
|
'password_expiry_warning': 'enable',
|
||||||
|
'password_renewal': 'enable',
|
||||||
|
'port': '17',
|
||||||
|
'secondary_server': 'test_value_18',
|
||||||
|
'secure': 'disable',
|
||||||
|
'server': '192.168.100.20',
|
||||||
|
'server_identity_check': 'enable',
|
||||||
|
'source_ip': '84.230.14.22',
|
||||||
|
'ssl_min_proto_version': 'default',
|
||||||
|
'tertiary_server': 'test_value_24',
|
||||||
|
'type': 'simple',
|
||||||
|
'username': 'test_value_26'
|
||||||
|
},
|
||||||
|
'vdom': 'root'}
|
||||||
|
|
||||||
|
is_error, changed, response = fortios_user_ldap.fortios_user(input_data, fos_instance)
|
||||||
|
|
||||||
|
expected_data = {
|
||||||
|
'account-key-filter': 'test_value_3',
|
||||||
|
'account-key-processing': 'same',
|
||||||
|
'ca-cert': 'test_value_5',
|
||||||
|
'cnid': 'test_value_6',
|
||||||
|
'dn': 'test_value_7',
|
||||||
|
'group-filter': 'test_value_8',
|
||||||
|
'group-member-check': 'user-attr',
|
||||||
|
'group-object-filter': 'test_value_10',
|
||||||
|
'group-search-base': 'test_value_11',
|
||||||
|
'member-attr': 'test_value_12',
|
||||||
|
'name': 'default_name_13',
|
||||||
|
'password': 'test_value_14',
|
||||||
|
'password-expiry-warning': 'enable',
|
||||||
|
'password-renewal': 'enable',
|
||||||
|
'port': '17',
|
||||||
|
'secondary-server': 'test_value_18',
|
||||||
|
'secure': 'disable',
|
||||||
|
'server': '192.168.100.20',
|
||||||
|
'server-identity-check': 'enable',
|
||||||
|
'source-ip': '84.230.14.22',
|
||||||
|
'ssl-min-proto-version': 'default',
|
||||||
|
'tertiary-server': 'test_value_24',
|
||||||
|
'type': 'simple',
|
||||||
|
'username': 'test_value_26'
|
||||||
|
}
|
||||||
|
|
||||||
|
set_method_mock.assert_called_with('user', 'ldap', 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_ldap_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_ldap': {
|
||||||
|
'random_attribute_not_valid': 'tag',
|
||||||
|
'account_key_filter': 'test_value_3',
|
||||||
|
'account_key_processing': 'same',
|
||||||
|
'ca_cert': 'test_value_5',
|
||||||
|
'cnid': 'test_value_6',
|
||||||
|
'dn': 'test_value_7',
|
||||||
|
'group_filter': 'test_value_8',
|
||||||
|
'group_member_check': 'user-attr',
|
||||||
|
'group_object_filter': 'test_value_10',
|
||||||
|
'group_search_base': 'test_value_11',
|
||||||
|
'member_attr': 'test_value_12',
|
||||||
|
'name': 'default_name_13',
|
||||||
|
'password': 'test_value_14',
|
||||||
|
'password_expiry_warning': 'enable',
|
||||||
|
'password_renewal': 'enable',
|
||||||
|
'port': '17',
|
||||||
|
'secondary_server': 'test_value_18',
|
||||||
|
'secure': 'disable',
|
||||||
|
'server': '192.168.100.20',
|
||||||
|
'server_identity_check': 'enable',
|
||||||
|
'source_ip': '84.230.14.22',
|
||||||
|
'ssl_min_proto_version': 'default',
|
||||||
|
'tertiary_server': 'test_value_24',
|
||||||
|
'type': 'simple',
|
||||||
|
'username': 'test_value_26'
|
||||||
|
},
|
||||||
|
'vdom': 'root'}
|
||||||
|
|
||||||
|
is_error, changed, response = fortios_user_ldap.fortios_user(input_data, fos_instance)
|
||||||
|
|
||||||
|
expected_data = {
|
||||||
|
'account-key-filter': 'test_value_3',
|
||||||
|
'account-key-processing': 'same',
|
||||||
|
'ca-cert': 'test_value_5',
|
||||||
|
'cnid': 'test_value_6',
|
||||||
|
'dn': 'test_value_7',
|
||||||
|
'group-filter': 'test_value_8',
|
||||||
|
'group-member-check': 'user-attr',
|
||||||
|
'group-object-filter': 'test_value_10',
|
||||||
|
'group-search-base': 'test_value_11',
|
||||||
|
'member-attr': 'test_value_12',
|
||||||
|
'name': 'default_name_13',
|
||||||
|
'password': 'test_value_14',
|
||||||
|
'password-expiry-warning': 'enable',
|
||||||
|
'password-renewal': 'enable',
|
||||||
|
'port': '17',
|
||||||
|
'secondary-server': 'test_value_18',
|
||||||
|
'secure': 'disable',
|
||||||
|
'server': '192.168.100.20',
|
||||||
|
'server-identity-check': 'enable',
|
||||||
|
'source-ip': '84.230.14.22',
|
||||||
|
'ssl-min-proto-version': 'default',
|
||||||
|
'tertiary-server': 'test_value_24',
|
||||||
|
'type': 'simple',
|
||||||
|
'username': 'test_value_26'
|
||||||
|
}
|
||||||
|
|
||||||
|
set_method_mock.assert_called_with('user', 'ldap', 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
|
Loading…
Reference in New Issue