Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/christian-heusel/ansible-lookup-plugin-gopass
Ansible lookup plugin for gopass (https://www.gopass.pw/).
https://github.com/christian-heusel/ansible-lookup-plugin-gopass
ansible ansible-plugin gopass
Last synced: 15 days ago
JSON representation
Ansible lookup plugin for gopass (https://www.gopass.pw/).
- Host: GitHub
- URL: https://github.com/christian-heusel/ansible-lookup-plugin-gopass
- Owner: christian-heusel
- License: gpl-3.0
- Created: 2022-08-11T14:14:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-18T09:15:09.000Z (over 1 year ago)
- Last Synced: 2024-12-12T16:39:55.545Z (22 days ago)
- Topics: ansible, ansible-plugin, gopass
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ansible `gopass` Lookup Plugin
> Ansible lookup plugin for the [gopass][0] password manager.
This lookup plugin allows you to use [gopass][0] to generate passwords. It
mimics the behaviour of the password lookup, but using gopass instead of
plaintext files for storing the passwords.
If the password doesn't exist it will be generated with the parameters.
## Usage
Clone this repository in a directory of your choice and tell ansible to look for
plugins there by setting something like this in `ansible.cfg`:
```
lookup_plugins=/path/to/ansible/plugins
```
Then just use it as you would use the password lookup, but with the path to your
password instead of the path to a file. For example, if you would normally get
your password with
```
$ gopass show path/to/your/password
```
you would use it like this in a playbook to set the password of a user
```yaml
---
- hosts: monitoringserver
tasks:
- set_fact:
password: "{{ lookup('gopass', 'path/to/your/password') }}"
# https://docs.ansible.com/ansible/latest/reference_appendices/logging.html#protecting-sensitive-data-with-no-log
no_log: true
- name: set password for user debian
user:
name: debian
password: "{{ password | password_hash('sha512') }}"
state: present
shell: /bin/bash
```
### Parameters
You can use parameters to control how `gopass generate` will be called.
* **`length`:** length of the generated password (default: `32`).
* **`symbols`:** include symbols in the generated password (default: `False`).
* **`regenerate`:** force the generation of a new password (default: `False`).
* **`list`:** list the passwords under the given path (default: `False`).
## Installation
### Arch Linux
This ansible plugin is availiable via the AUR as
[`ansible-gopass`](https://aur.archlinux.org/packages/ansible-gopass).
## Examples
### Get a single password
```yaml
password: "{{ lookup('gopass', 'path/to/your/password', length=16, symbols=True, regenerate=True) }}"
```
### Get all passwords under a path
```yaml
- debug:
msg: "{{ lookup('gopass', item) }}"
# https://docs.ansible.com/ansible/latest/reference_appendices/logging.html#protecting-sensitive-data-with-no-log
# no_log: true
with_items: "{{ lookup('gopass', 'heuselfamily/mqtt/', list=True) }}"
```
## License & Acknowledgements
The contents of this repository are based on https://github.com/gcoop-libre/ansible-lookup-plugin-pass and share a common history.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
[0]: https://www.gopass.pw/ "gopass"