elasticsearch-saml-元数据

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])

描述

edit

SAML 2.0 规范提供了一种机制，使服务提供商能够使用元数据文件描述其功能和配置。

命令elasticsearch-saml-metadata 根据 Elasticsearch 中 SAML 领域的配置生成这样一个文件。

一些SAML身份提供者将允许您在将Elastic Stack配置为服务提供者时自动导入元数据文件。

您可以选择对元数据文件进行数字签名，以确保其在与身份提供者共享之前的完整性和真实性。用于签名元数据文件的密钥不必与已在SAML领域配置中用于SAML消息签名的密钥相同。

如果您的 Elasticsearch 密钥库受密码保护，当您运行 elasticsearch-saml-metadata 命令时，系统会提示您输入密码。

参数

edit

--attribute <name>: 指定一个SAML属性，该属性应作为元素包含在元数据中。在Elasticsearch领域中配置的任何属性都会自动包含，不需要作为命令行选项指定。
--batch: 不要提示用户输入。
--contacts: 指定元数据应包含一个或多个元素。用户将被提示输入每个人员的详细信息。
-E <KeyValuePair>: 配置一个Elasticsearch设置。
-h, --help: 返回所有命令参数。
--locale <name>: 指定用于元数据元素（如）的区域设置。默认为JVM的默认系统区域设置。
--organisation-display-name <name: 指定了元素的值。仅在指定了 --organisation-name 时有效。
--organisation-name <name>: 指定应在元数据中包含一个元素，并提供的值。如果指定了这个选项，那么还必须指定--organisation-url。
--organisation-url <url>: 指定元素的值。如果指定了--organisation-name，则这是必需的。
--out <file_path>: 指定输出文件的路径。默认为 saml-elasticsearch-metadata.xml
--service-name <name>: 指定元数据中元素的值。默认为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 配置中有多个 saml 领域，则此参数是必需的。
-s, --silent: 显示最小输出。
-v, --verbose: 显示详细输出。

示例

edit

以下命令为 saml1 领域生成默认的元数据文件：

bin/elasticsearch-saml-metadata --realm saml1

文件将被写入 saml-elasticsearch-metadata.xml。系统可能会提示您为领域使用的任何属性提供“friendlyName”值。

以下命令为 saml2 领域生成一个元数据文件，为 kibana-finance，语言环境为 en-GB，并包含元素和元素：

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/"

« elasticsearch-reset-password elasticsearch-service-tokens »