community.crypto.openssl_pkcs12 – Генерация архива OpenSSL PKCS#12
Примечание
Этот плагин является частью коллекции community.crypto (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.crypto.
Для использования в плейбуке укажите: community.crypto.openssl_pkcs12.
Обзор
- Этот модуль позволяет (пере)генерировать PKCS#12.
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- python-pyOpenSSL
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action строка |
| export или parse PKCS#12. |
| attributes строка добавлен в 2.3 ansible.builtin | Атрибуты, которые должен иметь результирующий файл или каталог. Для получения поддерживаемых флагов см. страницу справки для chattr на целевой системе. Эта строка должна содержать атрибуты в том же порядке, что и отображаемый lsattr. Оператор = предполагается по умолчанию, в противном случае операторы + или - необходимо включить в строку.алиасы: attr | |
| backup логическое |
| Создать резервную копию файла, включая отметку времени, чтобы вы могли получить исходный выходной файл обратно, если по ошибке перезаписали его новым. |
| certificate_path путь | Путь для чтения сертификатов и закрытых ключей. Должен быть в формате PEM. | |
| force логическое |
| Следует ли перегенерировать файл, даже если он уже существует. |
| friendly_name строка | Указывает имя для сертификата и закрытого ключа. алиасы: name | |
| group строка | Имя группы, которая должна владеть файлом/каталогом, как будет передано в chown. | |
| iter_size целое число | По умолчанию: 2048 | Количество раз для повторения шага шифрования. |
| maciter_size целое число | По умолчанию: 1 | Количество раз для повторения шага MAC. |
| mode сырой | Разрешения, которые должен иметь результирующий файл или каталог. Для тех, кто привык к /usr/bin/chmod, помните, что режимы фактически являются восьмеричными числами. Вы должны либо добавить ведущую нуль, чтобы парсер YAML Ansible знал, что это восьмеричное число (например, 0644 или 01777), либо заключить в кавычки (например, '644' или '1777'), чтобы Ansible получил строку и смог выполнить собственное преобразование из строки в число.Предоставление Ansible числа без соблюдения одного из этих правил приведет к десятичному числу, что приведет к нежелательным результатам. Начиная с Ansible 1.8, режим может быть указан как символический режим (например, u+rwx или u=rw,g=r,o=r). | |
| other_certificates список / элементы=путь | Список других сертификатов для включения. До версии 2.8 этот параметр назывался ca_certificates
алиасы: ca_certificates | |
| owner строка | Имя пользователя, который должен владеть файлом/каталогом, как будет передано в chown. | |
| passphrase строка | Пароль PKCS#12. | |
| path путь / обязательный | Имя файла для записи файла PKCS#12. | |
| privatekey_passphrase строка | Источник пароля для расшифровки любых входных закрытых ключей. | |
| privatekey_path путь | Файл для чтения закрытого ключа. | |
| return_content логическое добавлен в 1.0.0 community.crypto |
| Если установлено в значение yes, вернет содержимое (текущего или сгенерированного) PKCS#12 как pkcs12. |
| selevel строка | Часть контекста SELinux-файла уровня. Это атрибут MLS/MCS, иногда называемый range.Если установлено в значение _default, будет использоваться часть политики level если доступна. | |
| serole строка | Часть контекста SELinux-файла роли. Если установлено в значение _default, будет использоваться часть политики role если доступна. | |
| setype строка | Часть контекста SELinux-файла типа. Если установлено в значение _default, будет использоваться часть политики type если доступна. | |
| seuser строка | Часть контекста SELinux-файла пользователя. По умолчанию используется политика system, если применимо.Если установлено в значение _default, будет использоваться часть политики user если доступна. | |
| src путь | Путь к файлу PKCS#12 для парсинга. | |
| state строка |
| Существует ли файл или нет. Все параметры, кроме path, игнорируются, когда состояние равно absent. |
| unsafe_writes логическое добавлен в 2.2 ansible.builtin |
| Влияние на то, когда использовать атомную операцию для предотвращения повреждения данных или несогласованного чтения из целевого файла. По умолчанию этот модуль использует атомные операции для предотвращения повреждения данных или несогласованного чтения из целевых файлов, но иногда системы настроены или просто не работают так, чтобы это предотвратить. Одним из примеров являются файлы, смонтированные в Docker, которые не могут обновляться атомарно внутри контейнера и могут быть записаны только небезопасным способом. Этот параметр позволяет Ansible перейти к небезопасным методам обновления файлов, когда атомные операции терпят неудачу (однако, он не заставляет Ansible выполнять небезопасные записи). ВАЖНО! Небезопасные записи подвержены гонкам и могут привести к повреждению данных. |
См. также
См. также
- community.crypto.x509_certificate
-
Официальная документация модуля community.crypto.x509_certificate.
- community.crypto.openssl_csr
-
Официальная документация модуля community.crypto.openssl_csr.
- community.crypto.openssl_dhparam
-
Официальная документация модуля community.crypto.openssl_dhparam.
- community.crypto.openssl_privatekey
-
Официальная документация модуля community.crypto.openssl_privatekey.
- community.crypto.openssl_publickey
-
Официальная документация модуля community.crypto.openssl_publickey.
Примеры
- name: Generate PKCS#12 file
community.crypto.openssl_pkcs12:
action: export
path: /opt/certs/ansible.p12
friendly_name: raclette
privatekey_path: /opt/certs/keys/key.pem
certificate_path: /opt/certs/cert.pem
other_certificates: /opt/certs/ca.pem
state: present
- name: Change PKCS#12 file permission
community.crypto.openssl_pkcs12:
action: export
path: /opt/certs/ansible.p12
friendly_name: raclette
privatekey_path: /opt/certs/keys/key.pem
certificate_path: /opt/certs/cert.pem
other_certificates: /opt/certs/ca.pem
state: present
mode: '0600'
- name: Regen PKCS#12 file
community.crypto.openssl_pkcs12:
action: export
src: /opt/certs/ansible.p12
path: /opt/certs/ansible.p12
friendly_name: raclette
privatekey_path: /opt/certs/keys/key.pem
certificate_path: /opt/certs/cert.pem
other_certificates: /opt/certs/ca.pem
state: present
mode: '0600'
force: yes
- name: Dump/Parse PKCS#12 file
community.crypto.openssl_pkcs12:
action: parse
src: /opt/certs/ansible.p12
path: /opt/certs/ansible.pem
state: present
- name: Remove PKCS#12 file
community.crypto.openssl_pkcs12:
path: /opt/certs/ansible.p12
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| backup_file строка | изменено, если backup yes
| Имя созданного файла резервной копии. Пример: /path/to/ansible.com.pem.2019-03-09@11:22~ |
| filename строка | изменено или успех | Путь к сгенерированному файлу PKCS#12. Пример: /opt/certs/ansible.p12 |
| pkcs12 строка добавлено в 1.0.0 community.crypto | если state present и return_content yes
| Контент PKCS#12 (текущий или сгенерированный), закодированный в Base64. |
| privatekey строка | изменено или успех | Путь к приватному ключу TLS/SSL, из которого был сгенерирован публичный ключ. Пример: /etc/ssl/private/ansible.com.pem |
Авторы
- Guillaume Delpierre (@gdelpierre)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/crypto/openssl_pkcs12_module.html
