community.general.onepassword – fetch field values from 1Password
Note
This plugin is part of the community.general collection (version 3.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.onepassword
.
Synopsis
onepassword
wraps theop
command line utility to fetch specific field values from 1Password.
Requirements
The below requirements are needed on the local controller node that executes this lookup.
op
1Password command line utility. See https://support.1password.com/command-line/
Parameters
Parameter |
Comments |
---|---|
identifier(s) (UUID, name, or subdomain; case-insensitive) of item(s) to retrieve. |
|
Domain of 1Password. Default is 1password.com. Default: “1password.com” |
|
field to return from each matching item (case-insensitive). Default: “password” |
|
The password used to unlock the specified vault. |
|
The secret key used when performing an initial sign in. |
|
Item section containing the field to retrieve (case-insensitive). If absent will return first match from any section. |
|
The 1Password subdomain to authenticate against. |
|
The username used to sign in. |
|
Vault containing the item to retrieve (case-insensitive). If absent will search all vaults. |
Notes
Note
This lookup will use an existing 1Password session if one exists. If not, and you have already performed an initial sign in (meaning
~/.op/config exists
), then only themaster_password
is required. You may optionally specifysubdomain
in this scenario, otherwise the last used subdomain will be used byop
.This lookup can perform an initial login by providing
subdomain
,username
,secret_key
, andmaster_password
.Due to the very sensitive nature of these credentials, it is highly recommended that you only pass in the minimal credentials needed at any given time. Also, store these credentials in an Ansible Vault using a key that is equal to or greater in strength to the 1Password master password.
This lookup stores potentially sensitive data from 1Password as Ansible facts. Facts are subject to caching if enabled, which means this data could be stored in clear text on disk or in a database.
Tested with
op
version 0.5.3
Examples
# These examples only work when already signed in to 1Password
- name: Retrieve password for KITT when already signed in to 1Password
ansible.builtin.debug:
var: lookup('community.general.onepassword', 'KITT')
- name: Retrieve password for Wintermute when already signed in to 1Password
ansible.builtin.debug:
var: lookup('community.general.onepassword', 'Tessier-Ashpool', section='Wintermute')
- name: Retrieve username for HAL when already signed in to 1Password
ansible.builtin.debug:
var: lookup('community.general.onepassword', 'HAL 9000', field='username', vault='Discovery')
- name: Retrieve password for HAL when not signed in to 1Password
ansible.builtin.debug:
var: lookup('community.general.onepassword'
'HAL 9000'
subdomain='Discovery'
master_password=vault_master_password)
- name: Retrieve password for HAL when never signed in to 1Password
ansible.builtin.debug:
var: lookup('community.general.onepassword'
'HAL 9000'
subdomain='Discovery'
master_password=vault_master_password
username='[email protected]'
secret_key=vault_secret_key)
Return Values
Common return values are documented here, the following are the fields unique to this lookup:
Key |
Description |
---|---|
field data requested Returned: success |
Authors
Scott Buchanan (@scottsb)
Andrew Zenk (@azenk)
Sam Doran (@samdoran)