› ›

elasticsearch-saml-metadata

Команда elasticsearch-saml-metadata может использоваться для генерации файла метаданных SAML 2.0 поставщика услуг.

Синтаксис

bin/elasticsearch-saml-metadata
[--realm <name>]
[--out <file_path>] [--batch]
[--attribute <name>] [--service-name <name>]
[--locale <name>] [--contacts]
([--organisation-name <name>] [--organisation-display-name <name>] [--organisation-url <url>])
([--signing-bundle <file_path>] | [--signing-cert <file_path>][--signing-key <file_path>])
[--signing-key-password <password>]
[-E <KeyValuePair>]
[-h, --help] ([-s, --silent] | [-v, --verbose])

Описание

Спецификация SAML 2.0 предоставляет механизм для поставщиков услуг описания их возможностей и конфигурации с помощью файла метаданных.

Команда elasticsearch-saml-metadata генерирует такой файл, основанный на конфигурации SAML-область в Elasticsearch.

Некоторые поставщики идентификации SAML позволят вам автоматически импортировать файл метаданных при настройке Elastic Stack в качестве поставщика услуг.

Вы можете выборочно выбрать цифровую подпись файла метаданных, чтобы обеспечить его целостность и подлинность перед его предоставлением поставщику идентификации. Ключ, используемый для подписи файла метаданных, необязательно должен быть тем же самым, что и ключи, уже используемые в конфигурации saml-область для подписи сообщений SAML.

Если ваш хранилище ключей Elasticsearch защищено паролем, вам будет предложено ввести пароль при выполнении команды elasticsearch-saml-metadata.

Параметры

--attribute <name>: Указывает SAML-атрибут, который должен быть включен как элемент <RequestedAttribute> в метаданных. Любой атрибут, настроенный в области Elasticsearch, автоматически включается и не требует указания в качестве параметра командной строки.
--batch: Не запрашивать ввод данных пользователя.
--contacts: Указывает, что метаданные должны содержать один или несколько элементов <ContactPerson>. Пользователю будет предложено ввести подробности для каждого человека.
-E <KeyValuePair>: Настраивает параметр Elasticsearch.
-h, --help: Возвращает все параметры команд.
--locale <name>: Указывает локаль, которую следует использовать для элементов метаданных, таких как <ServiceName>. По умолчанию используется системная локаль JVM.
--organisation-display-name <name: Указывает значение элемента <OrganizationDisplayName>. Действительно только если также указан --organisation-name.
--organisation-name <name>: Указывает, что элемент <Organization> должен быть включен в метаданные и предоставляет значение для <OrganizationName>. Если это указано, то также должен быть указан --organisation-url.
--organisation-url <url>: Указывает значение элемента <OrganizationURL>. Требуется, если указан --organisation-name.
--out <file_path>: Указывает путь для выходных файлов. По умолчанию saml-elasticsearch-metadata.xml
--service-name <name>: Указывает значение для элемента <ServiceName> в метаданных. По умолчанию elasticsearch.
--signing-bundle <file_path>: Указывает путь к существующей паре ключей (в формате PKCS#12). Закрытый ключ этой пары будет использован для подписи файла метаданных.
--signing-cert <file_path>: Указывает путь к существующему сертификату (в формате PEM), который будет использоваться для подписи файла метаданных. Также необходимо указать параметр --signing-key. Этот параметр нельзя использовать с параметром --signing-bundle.
--signing-key <file_path>: Указывает путь к существующему ключу (в формате PEM), который будет использоваться для подписи файла метаданных. Также необходимо указать параметр --signing-cert. Этот параметр нельзя использовать с параметром --signing-bundle.
--signing-key-password <password>: Указывает пароль для ключа подписи. Может использоваться как с параметрами --signing-key, так и с параметрами --signing-bundle.
--realm <name>: Указывает имя области, для которой должны быть сгенерированы метаданные. Этот параметр необходим, если в вашей конфигурации Elasticsearch есть более 1 saml области.
-s, --silent: Показать минимальный вывод.
-v, --verbose: Показать подробный вывод.

Примеры

Следующая команда генерирует файл метаданных по умолчанию для области saml1:

bin/elasticsearch-saml-metadata --realm saml1

Файл будет записан в saml-elasticsearch-metadata.xml. Вам может быть предложено предоставить значение "friendlyName" для любых атрибутов, используемых областью.

Следующая команда генерирует файл метаданных для области saml2, со значением <ServiceName> как kibana-finance, локалью en-GB и включает элементы <ContactPerson> и элемент <Organization>:

bin/elasticsearch-saml-metadata --realm saml2 \
    --service-name kibana-finance \
    --locale en-GB \
    --contacts \
    --organisation-name "Mega Corp. Finance Team" \
    --organisation-url "http://mega.example.com/finance/"

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/saml-metadata.html