Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию community.crypto (версия 2.22.1).

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

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

Чтобы использовать его в книге задач, укажите: community.crypto.openssl_csr_info.

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

Обзор

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

Требования

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

  • Если name_encoding установлено не в значение ignore, требуется установка библиотеки idna Python.
  • cryptography >= 1.3

Параметры

Параметр

Комментарии

content

строка

Добавлен в community.crypto 1.0.0

Содержание файла CSR.

Должен быть указан либо path, либо content, но не оба.

name_encoding

строка

Способ кодирования имён (имена DNS, URI, адреса электронной почты) в значениях возврата.

ignore будет использовать кодировку, возвращаемую бэкендом.

idna преобразует все метки доменных имён в кодировку IDNA. Будет предпочтительна кодировка IDNA2008, а IDNA2003 будет использована, если кодировка IDNA2008 не удаётся.

unicode преобразует все метки доменных имён в Unicode. Будет предпочтительна кодировка IDNA2008, а IDNA2003 будет использована, если кодировка IDNA2008 не удаётся.

Примечание, что idna и unicode требуют установленной библиотеки idna Python.

Варианты:

  • "ignore" ← (по умолчанию)
  • "idna"
  • "unicode"

path

путь

Полный путь к файлу CSR на удалённом сервере.

Должен быть указан либо path, либо content, но не оба.

select_crypto_backend

строка

Определяет, какой криптографический бэкенд использовать.

По умолчанию используется auto, который пытается использовать cryptography при его наличии.

Если установлено cryptography, будет использоваться библиотека cryptography.

Варианты:

  • "auto" ← (по умолчанию)
  • "cryptography"

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Это действие не изменяет состояние.

Может выполняться в check_mode и возвращать прогноз изменения состояния без модификации целевого объекта.

diff_mode

Поддержка: Нет

Это действие не изменяет состояние.

Вернёт подробности о том, что изменилось (или, возможно, нужно изменить в check_mode), при использовании режима сравнения.

См. также

См. также

community.crypto.openssl_csr

Генерация запроса на подписание сертификата OpenSSL (CSR).

community.crypto.openssl_csr_pipe

Генерация запроса на подписание сертификата OpenSSL (CSR).

community.crypto.openssl_csr_info плагин фильтра

Вариант фильтра этого модуля.

community.crypto.to_serial плагин фильтра

Преобразовать целое число в список шестнадцатеричных чисел, разделённых двоеточием.

Примеры

- name: Generate an OpenSSL Certificate Signing Request
  community.crypto.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
  community.crypto.openssl_csr_info:
    path: /etc/ssl/csr/www.ansible.com.csr
  register: result

- name: Dump information
  ansible.builtin.debug:
    var: result

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

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

Ключ

Описание

authority_cert_issuer

list / elements=string

Уполномоченный центр сертификации CSR в виде списка общих имен.

Is none if the AuthorityKeyIdentifier extension is not present.

See name_encoding for how IDNs are handled.

Возвращается: success

Пример: ["DNS:www.ansible.com", "IP:1.2.3.4"]

authority_cert_serial_number

integer

Серийный номер сертификата уполномоченного центра CSR.

Is none if the AuthorityKeyIdentifier extension is not present.

Это возвращаемое значение является целым числом. Если вам нужны серийные номера в виде шестнадцатеричной строки, разделенной двоеточиями, например 11:22:33, вам нужно преобразовать его в этот формат с помощью community.crypto.to_serial.

Возвращается: success

Пример: 12345

authority_key_identifier

string

Идентификатор ключа уполномоченного центра CSR.

Идентификатор возвращается в шестнадцатеричном формате, с : используется для разделения байтов.

Is none if the AuthorityKeyIdentifier extension is not present.

Возвращается: success

Пример: "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"

basic_constraints

list / elements=string

Записи в расширении basic_constraints, или none если расширение отсутствует.

Возвращается: success

Пример: ["CA:TRUE", "pathlen:1"]

basic_constraints_critical

boolean

Является ли расширение basic_constraints критическим.

Возвращается: success

extended_key_usage

list / elements=string

Записи в расширении extended_key_usage, или none если расширение отсутствует.

Возвращается: success

Пример: ["Biometric Info", "DVCS", "Time Stamping"]

extended_key_usage_critical

boolean

Является ли расширение extended_key_usage критическим.

Возвращается: success

extensions_by_oid

dictionary

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

Возвращается: success

Пример: {"1.3.6.1.5.5.7.1.24": {"critical": false, "value": "MAMCAQU="}}

critical

boolean

Является ли расширение критическим.

Возвращается: success

value

string

Значение расширения, закодированное в Base64 (в формате DER).

Примечание: в зависимости от используемой версии cryptography, извлечь содержимое ASN.1 расширения невозможно, можно только предоставить перекодированное содержимое расширения, если оно было проанализировано cryptography. Обычно это должно привести к точно такому же значению, за исключением случаев, когда исходное значение расширения было некорректным.

Возвращается: success

Пример: "MAMCAQU="

key_usage

string

Записи в расширении key_usage, или none если расширение отсутствует.

Возвращается: success

Пример: "['Key Agreement', 'Data Encipherment']"

key_usage_critical

boolean

Является ли расширение key_usage критическим.

Возвращается: success

name_constraints_critical

boolean

добавлено в community.crypto 1.1.0

Является ли расширение name_constraints критическим.

Is none if extension is not present.

Возвращается: success

name_constraints_excluded

list / elements=string

добавлено в community.crypto 1.1.0

Список исключенных поддеревьев, для которых ЦС не может подписывать сертификаты.

Is none if extension is not present.

See name_encoding for how IDNs are handled.

Возвращается: success

Пример: ["email:.com"]

name_constraints_permitted

list / elements=string

добавлено в community.crypto 1.1.0

Список разрешенных поддеревьев для подписи сертификатов.

Возвращается: success

Пример: ["email:.somedomain.com"]

ocsp_must_staple

boolean

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

Возвращаемое значение: успех

ocsp_must_staple_critical

boolean

Является ли расширение ocsp_must_staple критическим.

Возвращаемое значение: успех

public_key

string

Открытый ключ CSR в формате PEM

Возвращаемое значение: успех

Пример: "-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8A..."

public_key_data

dictionary

добавлен в community.crypto 1.7.0

Данные открытого ключа. Зависит от типа открытого ключа.

Возвращаемое значение: успех

curve

string

Имя кривой для ECC.

Возвращаемое значение: При public_key_type=ECC

exponent

integer

Общеизвестный показатель степени для RSA ключа.

Возвращаемое значение: При public_key_type=RSA

exponent_size

integer

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

Возвращаемое значение: При public_key_type=ECC

g

integer

Значение g для DSA.

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

Возвращаемое значение: При public_key_type=DSA

modulus

integer

Модуль RSA ключа.

Возвращаемое значение: При public_key_type=RSA

p

integer

Значение p для DSA.

Это простой модуль, на котором выполняются арифметические операции.

Возвращаемое значение: При public_key_type=DSA

q

integer

Значение q для DSA.

Это простое число, которое делит p - 1, и одновременно порядок подгруппы мультипликативной группы используемого простого поля.

Возвращаемое значение: При public_key_type=DSA

size

integer

Размер модуля в битах (RSA) или простое число (DSA).

Возвращаемое значение: При public_key_type=RSA или public_key_type=DSA

x

integer

Координата x для точки открытого ключа на эллиптической кривой.

Возвращаемое значение: При public_key_type=ECC

y

integer

Для public_key_type=ECC, это y координата для точки открытого ключа на эллиптической кривой.

Для public_key_type=DSA, это общеизвестный групповой элемент, дискретный логарифм которого по отношению к g представляет собой закрытый ключ.

Возвращаемое значение: При public_key_type=DSA или public_key_type=ECC

public_key_fingerprints

dictionary

Отпечатки пальцев открытого ключа 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..."

public_key_type

string

добавлен в community.crypto 1.7.0

Тип открытого ключа CSR.

Один из RSA, DSA, ECC, Ed25519, X25519, Ed448, или X448.

Начнётся с unknown если тип ключа определить не удаётся.

Возвращаемое значение: успех

Пример: "RSA"

signature_valid

boolean

Является ли подпись CSR валидной.

В случае, если проверка вернёт false, модуль завершится с ошибкой.

Возвращаемое значение: успех

subject

dictionary

Предмет CSR в виде словаря.

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

Возвращаемое значение: успех

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

subject_alt_name

список / элементы=строка

Элементы расширения subject_alt_name, или none, если расширение отсутствует.

См. name_encoding, чтобы узнать, как обрабатываются IDN.

Возвращается: успех

Пример: ["DNS:www.ansible.com", "IP:1.2.3.4"]

subject_alt_name_critical

логическое

Является ли расширение subject_alt_name критическим.

Возвращается: успех

subject_key_identifier

строка

Идентификатор ключа субъекта 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

список / элементы=список

Субъект CSR в виде упорядоченного списка кортежей.

Возвращается: успех

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

Авторы

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

Ссылки на сборник

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Задайте вопрос (криптография)
  • Задайте вопрос (ACME)
  • Отправить отчет об ошибке
  • Запросить функцию
  • Связь

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

Spec-Zone.ru

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