mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
e718bd8445
* Start using Ansible's config manager to handle options. * Docs improvements. * Fix documentation, make options actual lookup options. * The cyberarkpassword lookup does too strange things. * The onepassword lookups are converted in #4728, let's not interfere. * Improve docs. * Skip shelvefile as well. * Convert lmdb_kv. * Convert and fix credstash. * Convert manifold. * Drop chef_databag. * Convert dig. * Update examples. * Forgot the most important part. * Fix lmdb_kv docs. * Python 2.6 compatibility. * Convert AnsibleUnicode to str. * Load lookup with lookup loader. * Fix environment handling and error message checking. * Improve docs formatting.
73 lines
2.1 KiB
Python
73 lines
2.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
# 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 (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
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.
|
|
'''
|
|
|
|
EXAMPLES = """
|
|
- 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 = """
|
|
_raw:
|
|
description: Secrets stored.
|
|
type: list
|
|
elements: str
|
|
"""
|
|
|
|
HAS_KEYRING = True
|
|
|
|
from ansible.errors import AnsibleError
|
|
from ansible.utils.display import Display
|
|
|
|
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(u"Can't LOOKUP(keyring): missing required python library 'keyring'")
|
|
|
|
self.set_options(var_options=variables, direct=kwargs)
|
|
|
|
display.vvvv(u"keyring: %s" % keyring.get_keyring())
|
|
ret = []
|
|
for term in terms:
|
|
(servicename, username) = (term.split()[0], term.split()[1])
|
|
display.vvvv(u"username: %s, servicename: %s " % (username, servicename))
|
|
password = keyring.get_password(servicename, username)
|
|
if password is None:
|
|
raise AnsibleError(u"servicename: %s for user %s not found" % (servicename, username))
|
|
ret.append(password.rstrip())
|
|
return ret
|