mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
123c7efe5e
* Move licenses to LICENSES/, run add-license.py, add LICENSES/MIT.txt. * Replace 'Copyright:' with 'Copyright' sed -i 's|Copyright:\(.*\)|Copyright\1|' $(rg -l 'Copyright:') Co-authored-by: Maxwell G <gotmax@e.email>
152 lines
4 KiB
Python
152 lines
4 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (c) 2022, Alexander Hussey <ahussey@redhat.com>
|
|
# 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
|
|
"""
|
|
Ansible Module - community.general.keyring_info
|
|
"""
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = r"""
|
|
---
|
|
module: keyring_info
|
|
version_added: 5.2.0
|
|
author:
|
|
- Alexander Hussey (@ahussey-redhat)
|
|
short_description: Get a passphrase using the Operating System's native keyring
|
|
description: >-
|
|
This module uses the L(keyring Python library, https://pypi.org/project/keyring/)
|
|
to retrieve passphrases for a given service and username from the OS' native keyring.
|
|
requirements:
|
|
- keyring (Python library)
|
|
- gnome-keyring (application - required for headless Linux keyring access)
|
|
- dbus-run-session (application - required for headless Linux keyring access)
|
|
options:
|
|
service:
|
|
description: The name of the service.
|
|
required: true
|
|
type: str
|
|
username:
|
|
description: The user belonging to the service.
|
|
required: true
|
|
type: str
|
|
keyring_password:
|
|
description: Password to unlock keyring.
|
|
required: true
|
|
type: str
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- name: Retrieve password for service_name/user_name
|
|
community.general.keyring_info:
|
|
service: test
|
|
username: test1
|
|
keyring_password: "{{ keyring_password }}"
|
|
register: test_password
|
|
|
|
- name: Display password
|
|
ansible.builtin.debug:
|
|
msg: "{{ test_password.passphrase }}"
|
|
"""
|
|
|
|
RETURN = r"""
|
|
passphrase:
|
|
description: A string containing the password.
|
|
returned: success and the password exists
|
|
type: str
|
|
sample: Password123
|
|
"""
|
|
|
|
try:
|
|
from shlex import quote
|
|
except ImportError:
|
|
from pipes import quote
|
|
import traceback
|
|
|
|
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
|
|
|
try:
|
|
import keyring
|
|
|
|
HAS_KEYRING = True
|
|
except ImportError:
|
|
HAS_KEYRING = False
|
|
KEYRING_IMP_ERR = traceback.format_exc()
|
|
|
|
|
|
def _alternate_retrieval_method(module):
|
|
get_argument = 'echo "%s" | gnome-keyring-daemon --unlock\nkeyring get %s %s\n' % (
|
|
quote(module.params["keyring_password"]),
|
|
quote(module.params["service"]),
|
|
quote(module.params["username"]),
|
|
)
|
|
dummy, stdout, dummy = module.run_command(
|
|
"dbus-run-session -- /bin/bash",
|
|
use_unsafe_shell=True,
|
|
data=get_argument,
|
|
encoding=None,
|
|
)
|
|
try:
|
|
return stdout.decode("UTF-8").splitlines()[1]
|
|
except IndexError:
|
|
return None
|
|
|
|
|
|
def run_module():
|
|
"""
|
|
Attempts to retrieve a passphrase from a keyring.
|
|
"""
|
|
result = dict(changed=False, msg="")
|
|
|
|
module_args = dict(
|
|
service=dict(type="str", required=True),
|
|
username=dict(type="str", required=True),
|
|
keyring_password=dict(type="str", required=True, no_log=True),
|
|
)
|
|
|
|
module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
|
|
|
|
if not HAS_KEYRING:
|
|
module.fail_json(msg=missing_required_lib("keyring"), exception=KEYRING_IMP_ERR)
|
|
try:
|
|
passphrase = keyring.get_password(
|
|
module.params["service"], module.params["username"]
|
|
)
|
|
except keyring.errors.KeyringLocked:
|
|
pass
|
|
except keyring.errors.InitError:
|
|
pass
|
|
except AttributeError:
|
|
pass
|
|
|
|
if passphrase is None:
|
|
passphrase = _alternate_retrieval_method(module)
|
|
|
|
if passphrase is not None:
|
|
result["msg"] = "Successfully retrieved password for %s@%s" % (
|
|
module.params["service"],
|
|
module.params["username"],
|
|
)
|
|
result["passphrase"] = passphrase
|
|
if passphrase is None:
|
|
result["msg"] = "Password for %s@%s does not exist." % (
|
|
module.params["service"],
|
|
module.params["username"],
|
|
)
|
|
module.exit_json(**result)
|
|
|
|
|
|
def main():
|
|
"""
|
|
main module loop
|
|
"""
|
|
run_module()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|