mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-02-04 07:51:50 +00:00
102 lines
3.1 KiB
Python
102 lines
3.1 KiB
Python
# Copyright (c) 2021, RevBits <info@revbits.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
|
|
from __future__ import annotations
|
|
|
|
|
|
DOCUMENTATION = r"""
|
|
name: revbitspss
|
|
author: RevBits (@RevBits) <info@revbits.com>
|
|
short_description: Get secrets from RevBits PAM server
|
|
version_added: 4.1.0
|
|
description:
|
|
- Uses the revbits_ansible Python SDK to get Secrets from RevBits PAM Server using API key authentication with the REST
|
|
API.
|
|
requirements:
|
|
- revbits_ansible - U(https://pypi.org/project/revbits_ansible/)
|
|
options:
|
|
_terms:
|
|
description:
|
|
- This is an array of keys for secrets which you want to fetch from RevBits PAM.
|
|
required: true
|
|
type: list
|
|
elements: string
|
|
base_url:
|
|
description:
|
|
- This is the base URL of the server, for example V(https://server-url-here).
|
|
required: true
|
|
type: string
|
|
api_key:
|
|
description:
|
|
- This is the API key for authentication. You can get it from the RevBits PAM secret manager module.
|
|
required: true
|
|
type: string
|
|
"""
|
|
|
|
RETURN = r"""
|
|
_list:
|
|
description:
|
|
- The JSON responses which you can access with defined keys.
|
|
- If you are fetching secrets named as UUID, PASSWORD it returns the dict of all secrets.
|
|
type: list
|
|
elements: dict
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
---
|
|
- hosts: localhost
|
|
vars:
|
|
secret: >-
|
|
{{
|
|
lookup(
|
|
'community.general.revbitspss',
|
|
'UUIDPAM', 'DB_PASS',
|
|
base_url='https://server-url-here',
|
|
api_key='API_KEY_GOES_HERE'
|
|
)
|
|
}}
|
|
tasks:
|
|
- ansible.builtin.debug:
|
|
msg: >-
|
|
UUIDPAM is {{ (secret['UUIDPAM']) }} and DB_PASS is {{ (secret['DB_PASS']) }}
|
|
"""
|
|
|
|
from ansible.plugins.lookup import LookupBase
|
|
from ansible.utils.display import Display
|
|
from ansible.errors import AnsibleError
|
|
|
|
ANOTHER_LIBRARY_IMPORT_ERROR: ImportError | None
|
|
try:
|
|
from pam.revbits_ansible.server import SecretServer
|
|
except ImportError as imp_exc:
|
|
ANOTHER_LIBRARY_IMPORT_ERROR = imp_exc
|
|
else:
|
|
ANOTHER_LIBRARY_IMPORT_ERROR = None
|
|
|
|
|
|
display = Display()
|
|
|
|
|
|
class LookupModule(LookupBase):
|
|
@staticmethod
|
|
def Client(server_parameters):
|
|
return SecretServer(**server_parameters)
|
|
|
|
def run(self, terms, variables, **kwargs):
|
|
if ANOTHER_LIBRARY_IMPORT_ERROR:
|
|
raise AnsibleError("revbits_ansible must be installed to use this plugin") from ANOTHER_LIBRARY_IMPORT_ERROR
|
|
self.set_options(var_options=variables, direct=kwargs)
|
|
secret_server = LookupModule.Client(
|
|
{
|
|
"base_url": self.get_option("base_url"),
|
|
"api_key": self.get_option("api_key"),
|
|
}
|
|
)
|
|
result = []
|
|
for term in terms:
|
|
try:
|
|
display.vvv(f"Secret Server lookup of Secret with ID {term}")
|
|
result.append({term: secret_server.get_pam_secret(term)})
|
|
except Exception as error:
|
|
raise AnsibleError(f"Secret Server lookup failure: {error.message}") from error
|
|
return result
|