community.general.onepassword_info – Сбор элементов из 1Password

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.onepassword_info.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

community.general.onepassword_info оборачивает утилиту командной строки op для получения данных об одном или нескольких элементах 1Password.
Возникает ошибка fatal, если какой-либо из искомых элементов не найден.
Рекомендуется использовать опцию no_log для предотвращения записи значений секретов, которые извлекаются.
Этот модуль назывался onepassword_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль community.general.onepassword_info больше не возвращает ansible_facts! Теперь необходимо использовать опцию register для использования фактов в других задачах.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

Утилита командной строки 1Password. См. https://support.1password.com/command-line/

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auto_login словарь		Значение по умолчанию: {}	Словарь, содержащий данные для аутентификации. Если это установлено, community.general.onepassword_info попытается автоматически войти в 1Password. Без этой опции необходимо предварительно войти в систему через CLI 1Password перед запуском Ansible. Настоятельно рекомендуется хранить учетные данные 1Password в Ansible Vault. Убедитесь, что ключ шифрования Ansible Vault не слабее, чем мастер-пароль 1Password.
	master_password строка / обязательно		Мастер-пароль для вашего поддомена. Это всегда требуется при указании `auto_login`.
	secret_key строка		Секретный ключ для вашего поддомена. Требуется только для первоначального входа в систему.
	subdomain строка		Имя поддомена 1Password (<subdomain>.1password.com). Если это не указано, будет использоваться последний поддомен.
	username строка		Имя пользователя 1Password. Требуется только для первоначального входа в систему.
cli_path путь		Значение по умолчанию: "op"	Используется для указания точного пути к интерфейсу командной строки `op`
search_terms список / элементы=строка / обязательно			Список из одного или нескольких поисковых запросов. Каждый поисковой запрос может быть простой строкой или словарем для большего контроля. При передаче простой строки предполагается, что field равен `password`. При передаче словаря доступны следующие поля.
	field строка		Имя поля для поиска в этом элементе (необязательно, по умолчанию "password" (или "document", если у элемента есть вложение).
	name строка		Имя элемента 1Password для поиска (обязательно).
	section строка		Имя раздела в этом элементе, содержащем указанное поле (необязательно, будет искать во всех разделах, если не указано).
	vault строка		Название конкретного хранилища 1Password для поиска, полезно, если ваш пользователь 1Password имеет доступ к нескольким хранилищам (необязательно).

Примечания

Примечание

Проверено с op версией 0.5.5
Основано на плагине поиска onepassword от Скотта Буканена <sbuchanan@ri.pn>.
При вызове этого модуля с устаревшим именем onepassword_facts потенциально конфиденциальные данные из 1Password возвращаются как факты Ansible. Факты могут кешироваться, если это включено, что означает, что эти данные могут храниться в открытом виде на диске или в базе данных.

Примеры

# Gather secrets from 1Password, assuming there is a 'password' field:
- name: Get a password
  community.general.onepassword_info:
    search_terms: My 1Password item
  delegate_to: localhost
  register: my_1password_item
  no_log: true         # Don't want to log the secrets to the console!

# Gather secrets from 1Password, with more advanced search terms:
- name: Get a password
  community.general.onepassword_info:
    search_terms:
      - name:    My 1Password item
        field:   Custom field name       # optional, defaults to 'password'
        section: Custom section name     # optional, defaults to 'None'
        vault:   Name of the vault       # optional, only necessary if there is more than 1 Vault available
  delegate_to: localhost
  register: my_1password_item
  no_log: True                           # Don't want to log the secrets to the console!

# Gather secrets combining simple and advanced search terms to retrieve two items, one of which we fetch two
# fields. In the first 'password' is fetched, as a field name is not specified (default behaviour) and in the
# second, 'Custom field name' is fetched, as that is specified explicitly.
- name: Get a password
  community.general.onepassword_info:
    search_terms:
      - My 1Password item                # 'name' is optional when passing a simple string...
      - name: My Other 1Password item    # ...but it can also be set for consistency
      - name:    My 1Password item
        field:   Custom field name       # optional, defaults to 'password'
        section: Custom section name     # optional, defaults to 'None'
        vault:   Name of the vault       # optional, only necessary if there is more than 1 Vault available
      - name: A 1Password item with document attachment
  delegate_to: localhost
  register: my_1password_item
  no_log: true                           # Don't want to log the secrets to the console!

- name: Debug a password (for example)
  ansible.builtin.debug:
    msg: "{{ my_1password_item['onepassword']['My 1Password item'] }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
onepassword словарь	успех	Словарь каждого элемента 1Password, соответствующего заданным поисковым запросам, показывает, что будет возвращено в третьем примере выше. Пример: {'A 1Password item with document attachment': {'document': 'содержимое документа, прикрепленного к этому элементу'}, 'My 1Password item': {'Имя пользовательского поля': 'значение этого поля', 'password': 'значение этого поля'}, 'My Other 1Password item': {'password': 'значение этого поля'}}

Авторы

Ryan Conway (@Rylon)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/onepassword_info_module.html