mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
3726b50a92
Type options of lookup plugins (#8626)
Type options of lookup plugins.
(cherry picked from commit daed4dcc94)
Co-authored-by: Felix Fontein <felix@fontein.de>
106 lines
3.5 KiB
Python
106 lines
3.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2023, 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: onepassword_doc
|
|
author:
|
|
- Sam Doran (@samdoran)
|
|
requirements:
|
|
- C(op) 1Password command line utility version 2 or later.
|
|
short_description: Fetch documents stored in 1Password
|
|
version_added: "8.1.0"
|
|
description:
|
|
- P(community.general.onepassword_doc#lookup) wraps C(op) command line utility to fetch one or more documents from 1Password.
|
|
notes:
|
|
- The document contents are a string exactly as stored in 1Password.
|
|
- This plugin requires C(op) version 2 or later.
|
|
|
|
options:
|
|
_terms:
|
|
description: Identifier(s) (case-insensitive UUID or name) of item(s) to retrieve.
|
|
required: true
|
|
type: list
|
|
elements: string
|
|
|
|
extends_documentation_fragment:
|
|
- community.general.onepassword
|
|
- community.general.onepassword.lookup
|
|
'''
|
|
|
|
EXAMPLES = """
|
|
- name: Retrieve a private key from 1Password
|
|
ansible.builtin.debug:
|
|
var: lookup('community.general.onepassword_doc', 'Private key')
|
|
"""
|
|
|
|
RETURN = """
|
|
_raw:
|
|
description: Requested document
|
|
type: list
|
|
elements: string
|
|
"""
|
|
|
|
from ansible_collections.community.general.plugins.lookup.onepassword import OnePass, OnePassCLIv2
|
|
from ansible.errors import AnsibleLookupError
|
|
from ansible.module_utils.common.text.converters import to_bytes
|
|
from ansible.plugins.lookup import LookupBase
|
|
|
|
|
|
class OnePassCLIv2Doc(OnePassCLIv2):
|
|
def get_raw(self, item_id, vault=None, token=None):
|
|
args = ["document", "get", item_id]
|
|
if vault is not None:
|
|
args = [*args, "--vault={0}".format(vault)]
|
|
|
|
if self.service_account_token:
|
|
if vault is None:
|
|
raise AnsibleLookupError("'vault' is required with 'service_account_token'")
|
|
|
|
environment_update = {"OP_SERVICE_ACCOUNT_TOKEN": self.service_account_token}
|
|
return self._run(args, environment_update=environment_update)
|
|
|
|
if token is not None:
|
|
args = [*args, to_bytes("--session=") + token]
|
|
|
|
return self._run(args)
|
|
|
|
|
|
class LookupModule(LookupBase):
|
|
def run(self, terms, variables=None, **kwargs):
|
|
self.set_options(var_options=variables, direct=kwargs)
|
|
|
|
vault = self.get_option("vault")
|
|
subdomain = self.get_option("subdomain")
|
|
domain = self.get_option("domain", "1password.com")
|
|
username = self.get_option("username")
|
|
secret_key = self.get_option("secret_key")
|
|
master_password = self.get_option("master_password")
|
|
service_account_token = self.get_option("service_account_token")
|
|
account_id = self.get_option("account_id")
|
|
connect_host = self.get_option("connect_host")
|
|
connect_token = self.get_option("connect_token")
|
|
|
|
op = OnePass(
|
|
subdomain=subdomain,
|
|
domain=domain,
|
|
username=username,
|
|
secret_key=secret_key,
|
|
master_password=master_password,
|
|
service_account_token=service_account_token,
|
|
account_id=account_id,
|
|
connect_host=connect_host,
|
|
connect_token=connect_token,
|
|
cli_class=OnePassCLIv2Doc,
|
|
)
|
|
op.assert_logged_in()
|
|
|
|
values = []
|
|
for term in terms:
|
|
values.append(op.get_raw(term, vault))
|
|
|
|
return values
|