Spec-Zone.ru › Ansible 2.9

openssl_csr_info – Предоставление информации о запросах на подписание сертификатов OpenSSL (CSR)

Новое в версии 2.8.

  • Описание
  • Требования
  • Параметры
  • См. также
  • Примеры
  • Значения возврата
  • Статус

Описание

  • Этот модуль позволяет запросить информацию о запросах на подписание сертификатов OpenSSL (CSR).
  • В случае, если подпись CSR не может быть проверена, модуль завершится ошибкой. При этом все возвращаемые переменные всё равно возвращаются.
  • Он использует библиотеки pyOpenSSL или cryptography для взаимодействия с OpenSSL. Если оба, cryptography и PyOpenSSL, доступны (и соответствуют минимальным требованиям версии), cryptography будет предпочтительным бэкендом перед PyOpenSSL (если бэкенд не принудительно задан с помощью select_crypto_backend). Обратите внимание, что бэкенд PyOpenSSL был устаревшим в Ansible 2.9 и будет удалён в Ansible 2.13.

Требования

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

  • PyOpenSSL >= 0.15 или cryptography >= 1.3

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
path
path / обязательно
Абсолютный путь к удалённому файлу CSR.
select_crypto_backend
строка
    Варианты:
  • auto ←
  • cryptography
  • pyopenssl
Определяет, какой криптографический бэкенд использовать.
По умолчанию выбирается auto, который пытается использовать cryptography если она доступна, и переходит к pyopenssl.
Если установлено значение pyopenssl, будет использоваться библиотека pyOpenSSL.
Если установлено значение cryptography, будет использоваться библиотека cryptography.
Обратите внимание, что бэкенд pyopenssl был устаревшим в Ansible 2.9 и будет удалён в Ansible 2.13. После этого момента будет доступен только бэкенд cryptography.

См. также

См. также

openssl_csr – Генерация запросов на подпись сертификатов OpenSSL (CSR)
Официальная документация модуля openssl_csr.

Примеры

- name: Generate an OpenSSL Certificate Signing Request
  openssl_csr:
    path: /etc/ssl/csr/www.ansible.com.csr
    privatekey_path: /etc/ssl/private/ansible.com.pem
    common_name: www.ansible.com

- name: Get information on the CSR
  openssl_csr_info:
    path: /etc/ssl/csr/www.ansible.com.csr
  register: result

- name: Dump information
  debug:
    var: result

Значения возврата

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

Ключ Возвращённое значение Описание
authority_cert_issuer
список / элементы=строка
добавлен в 2.9
успех и если используется не backend pyOpenSSL
Издатель сертификата авторизации CSR в виде списка общих имён.
Возвращает none, если расширение AuthorityKeyIdentifier отсутствует.

Пример:
[DNS:www.ansible.com, IP:1.2.3.4]
authority_cert_serial_number
целое число
добавлен в 2.9
успех и если используется не backend pyOpenSSL
Серийный номер сертификата авторизации CSR.
Возвращает none, если расширение AuthorityKeyIdentifier отсутствует.

Пример:
12345
authority_key_identifier
строка
добавлен в 2.9
успех и если используется не backend pyOpenSSL
Идентификатор ключа авторизации CSR.
Идентификатор возвращается в шестнадцатеричном формате, с : в качестве разделителя байтов.
Возвращает none, если расширение AuthorityKeyIdentifier отсутствует.

Пример:
00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33
basic_constraints
список / элементы=строка
успех
Элементы расширения basic_constraints, или none, если расширение отсутствует.

Пример:
[CA:TRUE, pathlen:1]
basic_constraints_critical
булево
успех
Является ли расширение basic_constraints критичным.

extended_key_usage
список / элементы=строка
успех
Элементы расширения extended_key_usage, или none, если расширение отсутствует.

Пример:
[Biometric Info, DVCS, Time Stamping]
extended_key_usage_critical
булево
успех
Является ли расширение extended_key_usage критичным.

extensions_by_oid
словарь
успех
Возвращает словарь для каждого расширения OID

Пример:
{"1.3.6.1.5.5.7.1.24": { "critical": false, "value": "MAMCAQU="}}
critical
булево
успех
Является ли расширение критичным.

value
строка
успех
Значение расширения в кодировке Base64 (в формате DER).

Пример:
MAMCAQU=
key_usage
строка
успех
Элементы расширения key_usage, или none, если расширение отсутствует.

Пример:
[Key Agreement, Data Encipherment]
key_usage_critical
булево
успех
Является ли расширение key_usage критичным.

ocsp_must_staple
булево
успех
yes если расширение OCSP Must Staple присутствует, none в противном случае.

ocsp_must_staple_critical
булево
успех
Является ли расширение ocsp_must_staple критичным.

public_key
строка
успех
Открытый ключ CSR в формате PEM.

Пример:
-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8A...
public_key_fingerprints
словарь
успех
Отпечатки пальцев открытого ключа CSR.
Для каждого доступного алгоритма хеширования вычисляется отпечаток пальца.

Пример:
{'sha256': 'd4:b3:aa:6d:c8:04:ce:4e:ba:f6:29:4d:92:a3:94:b0:c2:ff:bd:bf:33:63:11:43:34:0f:51:b0:95:09:2f:63', 'sha512': 'f7:07:4a:f0:b0:f0:e6:8b:95:5f:f9:e6:61:0a:32:68:f1...
signature_valid
булево
успех
Является ли подпись CSR действительной.
В случае, если проверка возвращает no, модуль завершится с ошибкой.

subject
словарь
успех
Предмет CSR в виде словаря.
Обратите внимание, что для повторяющихся значений возвращается только последнее.

Пример:
{"commonName": "www.example.com", "emailAddress": "test@example.com"}
subject_alt_name
список / элементы=строка
успех
Элементы расширения subject_alt_name, или none, если расширение отсутствует.

Пример:
[DNS:www.ansible.com, IP:1.2.3.4]
subject_alt_name_critical
булево
успех
Является ли расширение subject_alt_name критичным.

subject_key_identifier
строка
добавлен в 2.9
успех и если используется не backend pyOpenSSL
Идентификатор ключа предмета CSR.
Идентификатор возвращается в шестнадцатеричном формате, с : в качестве разделителя байтов.
Возвращает none, если расширение SubjectKeyIdentifier отсутствует.

Пример:
00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33
subject_ordered
список / элементы=список
добавлен в 2.9
успех
Предмет CSR в виде упорядоченного списка кортежей.

Пример:
[["commonName", "www.example.com"], ["emailAddress": "test@example.com"]]


Состояние

  • Этот модуль не гарантирует обратную совместимость. [предварительная версия]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Felix Fontein (@felixfontein)
  • Yanis Guenane (@Spredzy)

Подсказка

Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/openssl_csr_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API