👩 This project is part of the passbolt "lab"!
⚗️ It is used to illustrate an article or as a conversation starter.
🧪 Use at your own risks!
(c) 2021 Passbolt SA
Passbolt is registered trademark of Passbolt S.A.
MIT No Attribution - https://opensource.org/licenses/MIT-0
This is the source repository for https://galaxy.ansible.com/anatomicjc/passbolt
This lookup plugin allows you to retrieve ansible secrets from passbolt
It is based on py-passbolt library.
environment variable name | Description | Comments |
---|---|---|
PASSBOLT_BASE_URL | Your passbolt instance url: https://passbolt.domain.tld | Mandatory |
PASSBOLT_PRIVATE_KEY | Your passbolt private key in one-line format (see the below note) | PGPy backend |
PASSBOLT_PASSPHRASE | Your passbolt private key passphrase | PGPy backend |
PASSBOLT_GPG_BINARY | Path to gpg binary | gnupg backend |
PASSBOLT_GPG_LIBRARY | The python library to use | Allowed values: PGPy (default) or gnupg |
PASSBOLT_FINGERPRINT | The key fingerprint to use for gnupg backend | gnupg backend |
PASSBOLT_CREATE_NEW_RESOURCE | Create a new passbolt resource if no resource found (disabled by default) | true / false (default) |
PASSBOLT_NEW_RESOURCE_PASSWORD_LENGTH | Password length when creating a new resource | Default value: 20 |
PASSBOLT_NEW_RESOURCE_PASSWORD_SPECIAL_CHARS | The plugin creates only alphanumerics characters by default. Set this variable to true to include special characters | true / false (default) |
Note: How to set OpenPGP key in one-line format:
Linux:
sed -z 's/\n/\\n/g' private.asc
MacOS:
Install gnu-sed
with brew:
$ brew install gnu-sed
Use gsed instead of sed:
gsed -z 's/\n/\\n/g' private.asc
- Blog post about passbolt ansible lookup plugin: https://blog.passbolt.com/managing-secrets-in-ansible-using-passbolt-87af031ceab6
- Gitlab repository with examples: https://github.com/passbolt/lab-passbolt-ansible-poc