{"id":50852027,"url":"https://github.com/passbolt/passbolt-ansible-lookup-plugin","last_synced_at":"2026-06-14T14:04:43.394Z","repository":{"id":360900334,"uuid":"1151500768","full_name":"passbolt/passbolt-ansible-lookup-plugin","owner":"passbolt","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-28T09:40:41.000Z","size":73,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-14T14:04:42.122Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/passbolt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-06T14:46:53.000Z","updated_at":"2026-05-28T09:40:46.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/passbolt/passbolt-ansible-lookup-plugin","commit_stats":null,"previous_names":["passbolt/passbolt-ansible-lookup-plugin"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/passbolt/passbolt-ansible-lookup-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/passbolt%2Fpassbolt-ansible-lookup-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/passbolt%2Fpassbolt-ansible-lookup-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/passbolt%2Fpassbolt-ansible-lookup-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/passbolt%2Fpassbolt-ansible-lookup-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/passbolt","download_url":"https://codeload.github.com/passbolt/passbolt-ansible-lookup-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/passbolt%2Fpassbolt-ansible-lookup-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34324004,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-14T02:00:07.365Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-14T14:04:42.729Z","updated_at":"2026-06-14T14:04:43.386Z","avatar_url":"https://github.com/passbolt.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Passbolt Ansible Lookup Plugin\n\n## Configuration\n\nThis lookup plugin directly interact with the Passbolt server's API, and thus needs\nto authenticate. In order to do that, it utilizes our **Account Kit**, which can be\ndownloaded in the Passbolt web UI, under `Profile` \u003e `Desktop app setup` \u003e\n`Download your account kit`.\n\n## Usage\n\nOnce installed, the collection can be used in your playbook by adding it to its\n`collections` section and by calling it:\n\n```yaml\nlookup('passbolt.passbolt_lookup.passbolt_lookup', '\u003cresource UUID\u003e')\n```\n\n### Return format\nThe lookup returns a dictionary with two sections:\n- metadata (decrypted public information)\n- secret (decrypted sensitive information)\n\n```json\n  {\n      \"custom_fields\": {\n        \"a key\": \"a value (secret)\",\n        \"another key\": \"another value (secret)\"\n      },\n  \"description\": \"a searchable desc\",\n      \"icon\": {\n        \"background_color\": \"#E88BA8\",\n        \"type\": \"keepass-icon-set\",\n        \"value\": 10\n      },\n      \"name\": \"a random password\",\n      \"note\": \"a secure note\",\n      \"password\": \"darkside\",\n      \"totp\": {\n        \"algorithm\": \"SHA1\",\n        \"digits\": 6,\n        \"period\": 30,\n        \"secret_key\": \"JBSWY3DPEHPK3PXP\"\n      },\n      \"uris\": [\n        \"https://oneurl.com\",\n        \"https://anotherurl.com\"\n      ],\n      \"username\": \"anakin\"\n}\n```\n\n### Options\n\n| Name                    | Mandatory? | Format  | Default | Description                                                           |\n|-------------------------|------------|---------|---------|-----------------------------------------------------------------------|\n| `skip_ssl_verification` | ❌          | Boolean | `false` | Should we ignore SSL validation errors when calling the Passbolt API? |\n| `timeout`               | ❌          | Integer | `30`    | How long to wait for the Passbolt API to reply.                       |\n\n### Variables\n\n| Name                   | Mandatory? | Description                              |\n|------------------------|------------|------------------------------------------|\n| `passbolt.account_kit` | ✅          | The content of the Passbolt account kit. |\n| `passbolt.passphrase`  | ✅          | The passphrase for the Passbolt account. |\n\n\u003e ⚠️ Both of these variables are considered secrets and should be treated as such:\n\u003e please avoid storing them unencrypted, please use [Ansible vault](https://docs.ansible.com/projects/ansible/latest/vault_guide/index.html)\n\u003e or similar for storing those.\n\n### Supported Features\n\n- **API v5 Metadata Encryption**: Supports both shared and personal metadata-encrypted resources\n- **Custom Fields**: Supports custom fields in both metadata and secret sections\n\n## Development\n\nThis project uses Python, and we recommend creating a [virtual environment](https://docs.python.org/3/library/venv.html)\nto handle dependencies:\n\n```bash\npython -m venv .venv\nsource .venv/bin/activate\n```\n\nOnce the virtual environment activated, dependencies can be installed using\nthe following command:\n\n```bash\npip install -r passbolt/passbolt_lookup/requirements.txt\n```\n\nThis project is using an Ansible collection, named `passbolt_lookup` and\nunder the `passbolt` namespace. The [lookup plugin](passbolt/passbolt_lookup/plugins/lookup/passbolt_lookup.py)\nis simple and utilizes a local Passbolt API client, which code is located\nunder the [module_utils](passbolt/passbolt_lookup/plugins/module_utils/passbolt)\ndirectory.\n\nInstalling the collection can be done using the following command:\n\n```bash\n# Add --force to override the local install, useful when developing.\nansible-galaxy collection install ./passbolt\n```\n\nA sample (and simple) [playbook](playbook.yaml) is provided for helping in\ntesting the lookup plugin using a debug call.\n\n### Running Tests\n\nUnit tests can be run from the repository root without installing the collection:\n\n```bash\npython -m pytest tests/unit/ -v\n```\n\nTests use `unittest.mock` to mock HTTP and GnuPG dependencies, so no Passbolt\nserver or GPG keyring is required.\n\n## Copyright \u0026 License\n\n(c) 2025 Passbolt SA\n\nPassbolt is registered trademark of Passbolt S.A.\n\nAGPLv3 - https://www.gnu.org/licenses/agpl-3.0.en.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpassbolt%2Fpassbolt-ansible-lookup-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpassbolt%2Fpassbolt-ansible-lookup-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpassbolt%2Fpassbolt-ansible-lookup-plugin/lists"}