поиск community.general.onepassword_ssh_key — получение ключей SSH, хранящихся в 1Password

Примечание

Этот подключаемый модуль поиска входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для работы с этим подключаемым модулем поиска требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.general.onepassword_ssh_key.

Добавлено в community.general 10.3.0

Краткое описание
Требования
Аргументы
Именованные параметры
Примечания
Примеры
Возвращаемое значение

Краткое описание

community.general.onepassword_ssh_key оборачивает утилиту командной строки op для получения ключей SSH из 1Password.

Требования

Следующие требования должны быть выполнены на локальном управляющем узле, который выполняет этот поиск.

op утилита командной строки 1Password версии 2 или более поздней.
См. https://support.1password.com/command-line/

Аргументы

Параметр	Комментарии
Terms list / elements=string / обязательный	Идентификатор(ы) (UUID без учета регистра или имя) элемента(ов), которые нужно получить.

Именованные параметры

Здесь описаны именованные параметры поиска. Это значения key1=value1, key2=value2 и так далее в следующих примерах: lookup('community.general.onepassword_ssh_key', key1=value1, key2=value2, ...) и query('community.general.onepassword_ssh_key', key1=value1, key2=value2, ...)

Параметр	Комментарии
account_id string	ID целевой учетной записи.
connect_host string добавлено в community.general 8.1.0	Узел 1Password Connect. Должен использоваться вместе с `connect_token`. Конфигурация: Переменная окружения: `OP_CONNECT_HOST`
connect_token string добавлено в community.general 8.1.0	Токен для 1Password Connect. Должен использоваться вместе с `connect_host`. Конфигурация: Переменная окружения: `OP_CONNECT_TOKEN`
domain string	Домен 1Password. По умолчанию: `"1password.com"`
master_password псевдонимы: vault_password string	Пароль для разблокировки указанного хранилища.
secret_key string	Секретный ключ, используемый при первоначальном входе.
section string	Раздел элемента, содержащий поле для получения (без учета регистра). Если не указан, возвращается первое совпадение из любого раздела.
service_account_token string	Ключ доступа сервисной учетной записи. Работает только с CLI 1Password версии 2 или более поздней. Конфигурация: Переменная окружения: `OP_SERVICE_ACCOUNT_TOKEN` добавлено в community.general 8.2.0
ssh_format boolean	Выводить ключ в формате SSH, если `true`. В противном случае выводится ключ в формате по умолчанию (PKCS#8). Варианты: `false` ← (по умолчанию) `true`
subdomain string	Поддомен 1Password для аутентификации.
username string	Имя пользователя для входа.
vault string	Хранилище, содержащее элемент для получения (без учета регистра). Если не указано, поиск выполняется во всех хранилищах.

Примечания

Примечание

При совместном использовании именованных и позиционных параметров позиционные параметры должны указываться перед именованными: lookup('community.general.onepassword_ssh_key', term1, term2, key1=value1, key2=value2) и query('community.general.onepassword_ssh_key', term1, term2, key1=value1, key2=value2)
По умолчанию возвращается значение закрытого ключа в формате PKCS#8, если не передан параметр ssh_format=true.
Подключаемый модуль работает только с элементами типа SSHKEY.
Для этого подключаемого модуля требуется op версии 2 или более поздней.
Этот поиск использует существующий сеанс 1Password, если он есть. Если сеанса нет, но вы уже выполнили первоначальный вход (то есть существует ~/.op/config, ~/.config/op/config или ~/.config/.op/config), требуется только master_password. В этом случае можно дополнительно указать subdomain, иначе op будет использовать последний задействованный поддомен.
Этот поиск может выполнить первоначальный вход, если указать subdomain, username, secret_key и master_password.
Можно указать целевую учетную запись, передав account_id.
Учитывая крайне чувствительный характер этих учетных данных, настоятельно рекомендуется передавать только минимально необходимые в данный момент учетные данные. Кроме того, храните их в Ansible Vault, используя ключ, стойкость которого не ниже стойкости главного пароля 1Password.
Этот поиск сохраняет потенциально чувствительные данные из 1Password в виде фактов Ansible. Если включено кэширование, факты могут кэшироваться, а значит, эти данные могут храниться на диске в открытом виде или в базе данных.
Проверено с версией op 2.7.2.

Примеры

---
- name: Retrieve the private SSH key from 1Password
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.onepassword_ssh_key', 'SSH Key', ssh_format=true) }}"

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

Ключ	Описание
Возвращаемое значение list / elements=string	Закрытый ключ пары ключей SSH. Возвращается: при успехе

Авторы

Mohammed Babelly (@mohammedbabelly20)

Ссылки на коллекцию

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