› ›

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/7.17/saml-metadata.html