mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-24 04:39:15 +00:00
Make all doc fragments, module utils, and plugin utils private (#11896)
* Make all doc fragments private. * Make all plugin utils private. * Make all module utils private. * Reformat. * Changelog fragment. * Update configs and ignores. * Adjust unit test names.
This commit is contained in:
Felix Fontein
GitHub
parent
9ef1dbb6d5
commit
4fa82b9617
807 changed files with 2041 additions and 1702 deletions
|
|
@ -1,225 +0,0 @@
|
|||
# This code is part of Ansible, but is an independent component.
|
||||
# This particular file snippet, and this file snippet only, is BSD licensed.
|
||||
# Modules you write using this snippet, which is embedded dynamically by Ansible
|
||||
# still belong to the author of the module, and may assign their own license
|
||||
# to the complete work.
|
||||
#
|
||||
# Copyright (c) 2016 Thomas Krahn (@Nosmoht)
|
||||
#
|
||||
# Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
|
||||
# SPDX-License-Identifier: BSD-2-Clause
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import socket
|
||||
import typing as t
|
||||
import uuid
|
||||
from http import HTTPStatus
|
||||
from urllib.parse import quote
|
||||
|
||||
from ansible.module_utils.basic import AnsibleFallbackNotFound, env_fallback
|
||||
from ansible.module_utils.common.text.converters import to_bytes, to_text
|
||||
from ansible.module_utils.urls import HAS_GSSAPI, fetch_url
|
||||
|
||||
if t.TYPE_CHECKING:
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
|
||||
def _env_then_dns_fallback(*args, **kwargs) -> str:
|
||||
"""Load value from environment or DNS in that order"""
|
||||
try:
|
||||
result = env_fallback(*args, **kwargs)
|
||||
if result == "":
|
||||
raise AnsibleFallbackNotFound
|
||||
return result
|
||||
except AnsibleFallbackNotFound:
|
||||
# If no host was given, we try to guess it from IPA.
|
||||
# The ipa-ca entry is a standard entry that IPA will have set for
|
||||
# the CA.
|
||||
try:
|
||||
return socket.gethostbyaddr(socket.gethostbyname("ipa-ca"))[0]
|
||||
except Exception:
|
||||
raise AnsibleFallbackNotFound from None # no need to pass the original exception's context since this is basically a special return value
|
||||
|
||||
|
||||
class IPAClient:
|
||||
def __init__(self, module: AnsibleModule, host, port, protocol):
|
||||
self.host = host
|
||||
self.port = port
|
||||
self.protocol = protocol
|
||||
self.module = module
|
||||
self.headers = None
|
||||
self.timeout = module.params.get("ipa_timeout")
|
||||
self.use_gssapi = False
|
||||
|
||||
def get_base_url(self) -> str:
|
||||
return f"{self.protocol}://{self.host}/ipa"
|
||||
|
||||
def get_json_url(self) -> str:
|
||||
return f"{self.get_base_url()}/session/json"
|
||||
|
||||
def login(self, username, password):
|
||||
if "KRB5CCNAME" in os.environ and HAS_GSSAPI:
|
||||
self.use_gssapi = True
|
||||
elif "KRB5_CLIENT_KTNAME" in os.environ and HAS_GSSAPI:
|
||||
ccache = f"MEMORY:{uuid.uuid4()!s}"
|
||||
os.environ["KRB5CCNAME"] = ccache
|
||||
self.use_gssapi = True
|
||||
else:
|
||||
if not password:
|
||||
if "KRB5CCNAME" in os.environ or "KRB5_CLIENT_KTNAME" in os.environ:
|
||||
self.module.warn("In order to use GSSAPI, you need to install 'urllib_gssapi'")
|
||||
self._fail(
|
||||
"login",
|
||||
"Password is required if not using "
|
||||
"GSSAPI. To use GSSAPI, please set the "
|
||||
"KRB5_CLIENT_KTNAME or KRB5CCNAME (or both) "
|
||||
" environment variables.",
|
||||
)
|
||||
url = f"{self.get_base_url()}/session/login_password"
|
||||
data = f"user={quote(username, safe='')}&password={quote(password, safe='')}"
|
||||
headers = {
|
||||
"referer": self.get_base_url(),
|
||||
"Content-Type": "application/x-www-form-urlencoded",
|
||||
"Accept": "text/plain",
|
||||
}
|
||||
try:
|
||||
resp, info = fetch_url(
|
||||
module=self.module, url=url, data=to_bytes(data), headers=headers, timeout=self.timeout
|
||||
)
|
||||
status_code = info["status"]
|
||||
if status_code not in (HTTPStatus.OK, HTTPStatus.CREATED, HTTPStatus.NO_CONTENT):
|
||||
self._fail("login", info["msg"])
|
||||
|
||||
self.headers = {"Cookie": info.get("set-cookie")}
|
||||
except Exception as e:
|
||||
self._fail("login", f"{e}")
|
||||
if not self.headers:
|
||||
self.headers = dict()
|
||||
self.headers.update(
|
||||
{"referer": self.get_base_url(), "Content-Type": "application/json", "Accept": "application/json"}
|
||||
)
|
||||
|
||||
def _fail(self, msg: str, e) -> t.NoReturn:
|
||||
if "message" in e:
|
||||
err_string = e.get("message")
|
||||
else:
|
||||
err_string = e
|
||||
self.module.fail_json(msg=f"{msg}: {err_string}")
|
||||
|
||||
def get_ipa_version(self):
|
||||
response = self.ping()["summary"]
|
||||
ipa_ver_regex = re.compile(r"IPA server version (\d+\.\d+\.\d+).*")
|
||||
version_match = ipa_ver_regex.match(response)
|
||||
ipa_version = None
|
||||
if version_match:
|
||||
ipa_version = version_match.groups()[0]
|
||||
return ipa_version
|
||||
|
||||
def ping(self):
|
||||
return self._post_json(method="ping", name=None)
|
||||
|
||||
def _post_json(self, method, name, item=None):
|
||||
if item is None:
|
||||
item = {}
|
||||
url = f"{self.get_base_url()}/session/json"
|
||||
data = dict(method=method)
|
||||
|
||||
# TODO: We should probably handle this a little better.
|
||||
if method in ("ping", "config_show", "otpconfig_show"):
|
||||
data["params"] = [[], {}]
|
||||
elif method in ("config_mod", "otpconfig_mod"):
|
||||
data["params"] = [[], item]
|
||||
else:
|
||||
data["params"] = [[name], item]
|
||||
|
||||
try:
|
||||
resp, info = fetch_url(
|
||||
module=self.module,
|
||||
url=url,
|
||||
data=to_bytes(json.dumps(data)),
|
||||
headers=self.headers,
|
||||
timeout=self.timeout,
|
||||
use_gssapi=self.use_gssapi,
|
||||
)
|
||||
status_code = info["status"]
|
||||
if status_code not in (HTTPStatus.OK, HTTPStatus.CREATED, HTTPStatus.NO_CONTENT):
|
||||
self._fail(method, info["msg"])
|
||||
except Exception as e:
|
||||
self._fail(f"post {method}", f"{e}")
|
||||
|
||||
charset = resp.headers.get_content_charset("latin-1")
|
||||
resp = json.loads(to_text(resp.read(), encoding=charset))
|
||||
err = resp.get("error")
|
||||
if err is not None:
|
||||
self._fail(f"response {method}", err)
|
||||
|
||||
if "result" in resp:
|
||||
result = resp.get("result")
|
||||
failed = result.get("failed")
|
||||
if failed:
|
||||
self._fail(f"response {method}", failed)
|
||||
if "result" in result:
|
||||
result = result.get("result")
|
||||
if isinstance(result, list):
|
||||
if len(result) > 0:
|
||||
return result[0]
|
||||
else:
|
||||
return {}
|
||||
return result
|
||||
return None
|
||||
|
||||
def get_diff(self, ipa_data, module_data):
|
||||
result = []
|
||||
for key in module_data.keys():
|
||||
mod_value = module_data.get(key, None)
|
||||
if isinstance(mod_value, list):
|
||||
default = []
|
||||
else:
|
||||
default = None
|
||||
ipa_value = ipa_data.get(key, default)
|
||||
if isinstance(ipa_value, list) and not isinstance(mod_value, list):
|
||||
mod_value = [mod_value]
|
||||
if isinstance(ipa_value, list) and isinstance(mod_value, list):
|
||||
mod_value = sorted(mod_value)
|
||||
ipa_value = sorted(ipa_value)
|
||||
if mod_value != ipa_value:
|
||||
result.append(key)
|
||||
return result
|
||||
|
||||
def modify_if_diff(self, name, ipa_list, module_list, add_method, remove_method, item=None, append=None):
|
||||
changed = False
|
||||
diff = list(set(ipa_list) - set(module_list))
|
||||
if append is not True and len(diff) > 0:
|
||||
changed = True
|
||||
if not self.module.check_mode:
|
||||
if item:
|
||||
remove_method(name=name, item={item: diff})
|
||||
else:
|
||||
remove_method(name=name, item=diff)
|
||||
|
||||
diff = list(set(module_list) - set(ipa_list))
|
||||
if len(diff) > 0:
|
||||
changed = True
|
||||
if not self.module.check_mode:
|
||||
if item:
|
||||
add_method(name=name, item={item: diff})
|
||||
else:
|
||||
add_method(name=name, item=diff)
|
||||
|
||||
return changed
|
||||
|
||||
|
||||
def ipa_argument_spec() -> dict[str, t.Any]:
|
||||
return dict(
|
||||
ipa_prot=dict(type="str", default="https", choices=["http", "https"], fallback=(env_fallback, ["IPA_PROT"])),
|
||||
ipa_host=dict(type="str", default="ipa.example.com", fallback=(_env_then_dns_fallback, ["IPA_HOST"])),
|
||||
ipa_port=dict(type="int", default=443, fallback=(env_fallback, ["IPA_PORT"])),
|
||||
ipa_user=dict(type="str", default="admin", fallback=(env_fallback, ["IPA_USER"])),
|
||||
ipa_pass=dict(type="str", no_log=True, fallback=(env_fallback, ["IPA_PASS"])),
|
||||
ipa_timeout=dict(type="int", default=10, fallback=(env_fallback, ["IPA_TIMEOUT"])),
|
||||
validate_certs=dict(type="bool", default=True),
|
||||
)
|
||||
Loading…
Add table
Add a link
Reference in a new issue