win_certificate_store - Управляет хранилищем сертификатов

Новая версия 2.5.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Описание

Используется для импорта/экспорта и удаления сертификатов и ключей из локального хранилища сертификатов.
Этот модуль не используется для создания сертификатов и будет только управлять существующими сертификатами как файлом или в хранилище.
Он может использоваться для импорта сертификатов PEM, DER, P7B, PKCS12 (PFX) и экспорта сертификатов PEM, DER и PKCS12.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
file_type	Варианты: der ← pem pkcs12	Тип файла для экспорта сертификата, когда `state=exported`. `der` — это бинарный файл, закодированный в ASN.1. `pem` — это файл, закодированный в base64, представляющий файл der в формате OpenSSL. `pkcs12` (также известный как pfx) — это бинарный контейнер, содержащий как сам сертификат, так и закрытый ключ, в отличие от других вариантов. Когда `pkcs12` установлен, а закрытый ключ не экспортируем или недоступен текущему пользователю, будет выброшено исключение.
key_exportable	Варианты: нет да ←	Разрешить экспорт закрытого ключа. Если `no`, то этот модуль и другие процессы смогут экспортировать только сертификат, а закрытый ключ экспортировать нельзя. Используется, когда `state=present` только.
key_storage	Варианты: по умолчанию ← машина пользователь	Указывает, где Windows будет хранить закрытый ключ при импорте. При установке в `default`, используется значение по умолчанию, заданное Windows. При установке в `machine`, ключ хранится в пути, доступном для различных пользователей. При установке в `user`, ключ хранится в пути, доступном только текущему пользователю. Используется только при `state=present` и не может быть изменен после импорта. См. https://msdn.microsoft.com/en-us/library/system.security.cryptography.x509certificates.x509keystorageflags.aspx для получения более подробной информации.
password		Пароль ключа сертификата pkcs12. Используется при чтении файла сертификата pkcs12 или для задания пароля при `state=exported` и `file_type=pkcs12`. Если файл pkcs12 не имеет пароля или пароль не должен быть установлен в экспортированном файле, не устанавливайте этот параметр.
path		Путь к файлу сертификата. Требуется, когда состояние равно `present` или `exported`. Когда состояние равно `absent`, а отпечаток не указан, отпечаток выводится из сертификата по этому пути.
state	Варианты: present ← absent exported	Если `present`, убеждается, что сертификат по пути path импортируется в хранилище сертификатов, указанное. Если `absent`, убеждается, что сертификат, указанный отпечатком или отпечатком сертификата по path, удаляется из указанного хранилища. Если `exported`, убеждается, что файл по path является сертификатом, указанным отпечатком. При экспорте сертификата, если path — это каталог, модуль завершится ошибкой, в противном случае файл будет заменён при необходимости.
store_location	Варианты: CurrentUser LocalMachine ←	Местоположение хранилища для использования при импорте сертификата или поиске сертификата.
store_name	Варианты: AddressBook AuthRoot CertificateAuthority Disallowed My ← Root TrustedPeople TrustedPublisher	Имя хранилища для использования при импорте сертификата или поиске сертификата. `AddressBook`: Хранилище сертификатов X.509 для других пользователей `AuthRoot`: Хранилище сертификатов X.509 для сертификационных центров (CAs) третьих сторон `CertificateAuthority`: Хранилище сертификатов X.509 для промежуточных сертификационных центров (CAs) `Disallowed`: Хранилище сертификатов X.509 для отозванных сертификатов `My`: Хранилище сертификатов X.509 для личных сертификатов `Root`: Хранилище сертификатов X.509 для надёжных корневых сертификационных центров (CAs) `TrustedPeople`: Хранилище сертификатов X.509 для непосредственно доверенных людей и ресурсов `TrustedPublisher`: Хранилище сертификатов X.509 для непосредственно доверенных издателей
thumbprint		Отпечаток в формате шестнадцатеричной строки для экспорта или удаления. См. примеры для указания отпечатка.

Примечания

Примечание

Некоторые действия с сертификатами и ключами PKCS12 могут завершиться ошибкой the specified network password is not correct, используйте CredSSP или Kerberos с делегированием учетных данных или become, чтобы обойти эти ограничения.
Сертификаты должны быть расположены на хосте Windows, чтобы быть заданными с помощью path.

Примеры

- name: import a certificate
  win_certificate_store:
    path: C:\temp\cert.pem
    state: present

- name: import pfx certificate that is password protected
  win_certificate_store:
    path: C:\temp\cert.pfx
    state: present
    password: VeryStrongPasswordHere!
  become: yes
  become_method: runas

- name: import pfx certificate without password and set private key as un-exportable
  win_certificate_store:
    path: C:\temp\cert.pfx
    state: present
    key_exportable: no
  # usually you don't set this here but it is for illustrative purposes
  vars:
    ansible_winrm_transport: credssp

- name: remove a certificate based on file thumbprint
  win_certificate_store:
    path: C:\temp\cert.pem
    state: absent

- name: remove a certificate based on thumbprint
  win_certificate_store:
    thumbprint: BD7AF104CF1872BDB518D95C9534EA941665FD27
    state: absent

- name: remove certificate based on thumbprint is CurrentUser/TrustedPublishers store
  win_certificate_store:
    thumbprint: BD7AF104CF1872BDB518D95C9534EA941665FD27
    state: absent
    store_location: CurrentUser
    store_name: TrustedPublisher

- name: export certificate as der encoded file
  win_certificate_store:
    path: C:\temp\cert.cer
    state: exported
    file_type: der

- name: export certificate and key as pfx encoded file
  win_certificate_store:
    path: C:\temp\cert.pfx
    state: exported
    file_type: pkcs12
    password: AnotherStrongPass!
  become: yes
  become_method: runas
  become_user: SYSTEM

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

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

Ключ	Возвращаемое значение	Описание
thumbprints список	успех	Список отпечатков сертификатов, которые были затронуты модулем. Пример: ['BC05633694E675449136679A658281F17A191087']

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.

Автор

Jordan Borean (@jborean93)

Подсказка

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

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