openssl_publickey - Генерация открытого ключа OpenSSL из его закрытого ключа.
Новое в версии 2.3.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
Описание
- Этот модуль позволяет (пере)генерировать открытые ключи OpenSSL из их закрытых ключей. Он использует библиотеку pyOpenSSL для взаимодействия с openssl. Ключи генерируются в формате PEM. Этот модуль работает только если версия PyOpenSSL достаточно новая (> 16.0.0). Этот модуль использует общие параметры файлов для указания разрешений сгенерированного файла.
Требования (к хосту, на котором выполняется модуль)
- python-pyOpenSSL
Параметры
| параметр | обязательно | значение по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| force | нет |
| Необходимо ли перегенерировать ключ, даже если он уже существует | |
| format (добавлен в 2.4)
| нет | PEM |
| Формат открытого ключа. |
| path | да | Имя файла, в котором будет записан сгенерированный открытый ключ TLS/SSL. | ||
| privatekey_passphrase (добавлен в 2.4)
| нет | Пароль к закрытому ключу. | ||
| privatekey_path | да | Путь к закрытому ключу TLS/SSL, из которого будет сгенерирован открытый ключ. | ||
| state | нет | present |
| Нужно ли, чтобы открытый ключ существовал или нет, выполнив действие, если состояние отличается от указанного. |
Примеры
# Generate an OpenSSL public key in PEM format.
- openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
# Generate an OpenSSL public key in OpenSSH v2 format.
- openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
format: OpenSSH
# Generate an OpenSSL public key with a passphrase protected
# private key
- openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
privatekey_passphrase: ansible
# Force regenerate an OpenSSL public key if it already exists
- openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
force: True
# Remove an OpenSSL public key
- openssl_publickey:
path: /etc/ssl/public/ansible.com.pem
privatekey_path: /etc/ssl/private/ansible.com.pem
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращаемое | тип | пример |
|---|---|---|---|---|
| filename | Путь к сгенерированному файлу открытого ключа TLS/SSL | изменено или успех | строка | /etc/ssl/public/ansible.com.pem |
| fingerprint | Отпечаток открытого ключа. Отпечаток будет сгенерирован для каждого доступного алгоритма hashlib. Требуется PyOpenSSL >= 16.0 для осмысленного вывода. | изменено или успех | словарь | {'sha1': '51:cc:7c:68:5d:eb:41:43:88:7e:1a:ae:c7:f8:24:72:ee:71:f6:10', 'sha384': '85:39:50:4e:de:d9:19:33:40:70:ae:10:ab:59:24:19:51:c3:a2:e4:0b:1c:b1:6e:dd:b3:0c:d9:9e:6a:46:af:da:18:f8:ef:ae:2e:c0:9a:75:2c:9b:b3:0f:3a:5f:3d', 'sha224': 'b1:19:a6:6c:14:ac:33:1d:ed:18:50:d3:06:5c:b2:32:91:f1:f1:52:8c:cb:d5:75:e9:f5:9b:46', 'sha256': '41:ab:c7:cb:d5:5f:30:60:46:99:ac:d4:00:70:cf:a1:76:4f:24:5d:10:24:57:5d:51:6e:09:97:df:2f:de:c7', 'sha512': 'fd:ed:5e:39:48:5f:9f:fe:7f:25:06:3f:79:08:cd:ee:a5:e7:b3:3d:13:82:87:1f:84:e1:f5:c7:28:77:53:94:86:56:38:69:f0:d9:35:22:01:1e:a6:60:...:0f:9b', 'md5': '84:75:71:72:8d:04:b5:6c:4d:37:6d:66:83:f5:4c:29'} |
| format | Формат открытого ключа (PEM, OpenSSH, ...) | изменено или успех | строка | PEM |
| privatekey | Путь к закрытому ключу TLS/SSL, из которого был сгенерирован открытый ключ | изменено или успех | строка | /etc/ssl/private/ansible.com.pem |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Справочной информацией и участием в разработке сообщества, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/openssl_publickey_module.html