community.general.passwordstore lookup – 使用 passwordstore.org 的 pass 工具管理密码
注意
此查找插件是 community.general 集合（版本 10.1.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install community.general。
要在 playbook 中使用它，请指定：community.general.passwordstore。
概要
使 Ansible 能够从 passwordstore.org pass 工具检索、创建或更新密码。它还可以检索、创建或更新以 YAML 样式键存储在密码文件中的多行数据。
为避免一次访问多个密钥时出现问题，请将
auto-expand-secmem添加到~/.gnupg/gpg-agent.conf。如果无法做到这一点，请考虑改用lock=readwrite。
术语
参数 |
注释 |
|---|---|
查询键。 |
关键字参数
这描述了查找的关键字参数。这些是在以下示例中 key1=value1、key2=value2 等值：lookup('community.general.passwordstore', key1=value1, key2=value2, ...) 和 query('community.general.passwordstore', key1=value1, key2=value2, ...)
参数 |
注释 |
|---|---|
指定要使用的后端。 默认为
选择
配置
|
|
密码存储的目录。 如果 如果 配置
|
|
生成的密码的长度。 默认值： |
|
如何同步操作。
选择
配置
|
|
当 带有单位后缀的时间， 与 默认值： 配置
|
|
关于密码文件丢失时要执行的操作的偏好列表。 如果 如果设置为 如果设置为 如果设置为 选择
|
|
关于密码子键丢失时要执行的操作的偏好。 如果设置为 如果设置为 选择
配置
|
|
使用字母数字字符。 选择
|
|
如果密码或子键已存在，则覆盖它。 选择
|
|
将旧的（编辑过的）密码包含在 pass 文件中。 选择
|
|
返回密码的所有内容，而不仅仅是第一行。 选择
|
|
将密码生成信息添加到文件末尾。 选择
|
|
指定要保存的密码，而不是生成的密码。 |
注释
注意
当关键字和位置参数一起使用时，位置参数必须列在关键字参数之前：
lookup('community.general.passwordstore', term1, term2, key1=value1, key2=value2)和query('community.general.passwordstore', term1, term2, key1=value1, key2=value2)自 community.general 6.0.0 起，查找支持将所有选项作为查找参数传递。
示例
ansible.cfg: |
[passwordstore_lookup]
lock=readwrite
locktimeout=45s
missing_subkey=warn
tasks.yml: |
---
# Debug is used for examples, BAD IDEA to show passwords on screen
- name: Basic lookup. Fails if example/test does not exist
ansible.builtin.debug:
msg: "{{ lookup('community.general.passwordstore', 'example/test')}}"
- name: Basic lookup. Warns if example/test does not exist and returns empty string
ansible.builtin.debug:
msg: "{{ lookup('community.general.passwordstore', 'example/test', missing='warn')}}"
- name: Create pass with random 16 character password. If password exists just give the password
ansible.builtin.debug:
var: mypassword
vars:
mypassword: "{{ lookup('community.general.passwordstore', 'example/test', create=true)}}"
- name: Create pass with random 16 character password. If password exists just give the password
ansible.builtin.debug:
var: mypassword
vars:
mypassword: "{{ lookup('community.general.passwordstore', 'example/test', missing='create')}}"
- name: >-
Create a random 16 character password in a subkey. If the password file already exists, just add the subkey in it.
If the subkey exists, returns it
ansible.builtin.debug:
msg: "{{ lookup('community.general.passwordstore', 'example/test', create=true, subkey='foo') }}"
- name: >-
Create a random 16 character password in a subkey. Overwrite if it already exists and backup the old one.
ansible.builtin.debug:
msg: "{{ lookup('community.general.passwordstore', 'example/test', create=true, subkey='user', overwrite=true, backup=true) }}"
- name: Prints 'abc' if example/test does not exist, just give the password otherwise
ansible.builtin.debug:
var: mypassword
vars:
mypassword: >-
{{ lookup('community.general.passwordstore', 'example/test', missing='empty')
| default('abc', true) }}
- name: Different size password
ansible.builtin.debug:
msg: "{{ lookup('community.general.passwordstore', 'example/test', create=true, length=42)}}"
- name: >-
Create password and overwrite the password if it exists.
As a bonus, this module includes the old password inside the pass file
ansible.builtin.debug:
msg: "{{ lookup('community.general.passwordstore', 'example/test', create=true, overwrite=true)}}"
- name: Create an alphanumeric password
ansible.builtin.debug:
msg: "{{ lookup('community.general.passwordstore', 'example/test', create=true, nosymbols=true) }}"
- name: Return the value for user in the KV pair user, username
ansible.builtin.debug:
msg: "{{ lookup('community.general.passwordstore', 'example/test', subkey='user')}}"
- name: Return the entire password file content
ansible.builtin.set_fact:
passfilecontent: "{{ lookup('community.general.passwordstore', 'example/test', returnall=true)}}"
返回值
键 |
描述 |
|---|---|
一个密码 返回： 成功 |