mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-06-05 07:47:12 +00:00
2d8e6cb851
Prevent using _terms for positional arguments. Also rejecting positional arguments completely for lookups that don't use them.
80 lines
2.3 KiB
Python
80 lines
2.3 KiB
Python
# Copyright (c) 2016, Samuel Boucher <boucher.samuel.c@gmail.com>
|
|
# Copyright (c) 2017 Ansible Project
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import annotations
|
|
|
|
DOCUMENTATION = r"""
|
|
name: keyring
|
|
author:
|
|
- Samuel Boucher (!UNKNOWN) <boucher.samuel.c@gmail.com>
|
|
requirements:
|
|
- keyring (python library)
|
|
short_description: Grab secrets from the OS keyring
|
|
description:
|
|
- Allows you to access data stored in the OS provided keyring/keychain.
|
|
options:
|
|
_terms:
|
|
description:
|
|
- List of pairs of service and user name.
|
|
- Every entry must be of the form V(servicename username).
|
|
type: list
|
|
elements: str
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- name: output secrets to screen (BAD IDEA)
|
|
ansible.builtin.debug:
|
|
msg: "Password: {{item}}"
|
|
with_community.general.keyring:
|
|
- 'servicename username'
|
|
|
|
- name: access mysql with password from keyring
|
|
community.mysql.mysql_db:
|
|
login_password: "{{ lookup('community.general.keyring', 'mysql joe') }}"
|
|
login_user: joe
|
|
"""
|
|
|
|
RETURN = r"""
|
|
_raw:
|
|
description: Secrets stored.
|
|
type: list
|
|
elements: str
|
|
"""
|
|
|
|
HAS_KEYRING = True
|
|
|
|
from ansible.errors import AnsibleError
|
|
from ansible.utils.display import Display
|
|
|
|
from ansible_collections.community.general.plugins.plugin_utils._lookup import check_for_wrong_terms
|
|
|
|
try:
|
|
import keyring
|
|
except ImportError:
|
|
HAS_KEYRING = False
|
|
|
|
from ansible.plugins.lookup import LookupBase
|
|
|
|
display = Display()
|
|
|
|
|
|
class LookupModule(LookupBase):
|
|
def run(self, terms, variables=None, **kwargs):
|
|
if not HAS_KEYRING:
|
|
raise AnsibleError("Can't LOOKUP(keyring): missing required python library 'keyring'")
|
|
|
|
self.set_options(var_options=variables, direct=kwargs)
|
|
check_for_wrong_terms(self, direct=kwargs)
|
|
|
|
display.vvvv(f"keyring: {keyring.get_keyring()}")
|
|
ret = []
|
|
for term in terms:
|
|
(servicename, username) = (term.split()[0], term.split()[1])
|
|
display.vvvv(f"username: {username}, servicename: {servicename} ")
|
|
password = keyring.get_password(servicename, username)
|
|
if password is None:
|
|
raise AnsibleError(f"servicename: {servicename} for user {username} not found")
|
|
ret.append(password.rstrip())
|
|
return ret
|