elasticsearch-saml-metadata

elasticsearch-saml-metadata コマンドは、SAML 2.0 サービスプロバイダー メタデータファイルを生成するために使用できます。

概要

シェル

  1. bin/elasticsearch-saml-metadata
  2. [--realm <name>]
  3. [--out <file_path>] [--batch]
  4. [--attribute <name>] [--service-name <name>]
  5. [--locale <name>] [--contacts]
  6. ([--organisation-name <name>] [--organisation-display-name <name>] [--organisation-url <url>])
  7. ([--signing-bundle <file_path>] | [--signing-cert <file_path>][--signing-key <file_path>])
  8. [--signing-key-password <password>]
  9. [-E <KeyValuePair>]
  10. [-h, --help] ([-s, --silent] | [-v, --verbose])

説明

SAML 2.0 仕様は、サービスプロバイダーが メタデータファイル を使用してその機能と構成を説明するためのメカニズムを提供します。

elasticsearch-saml-metadata コマンドは、Elasticsearch の SAML レルムの構成に基づいて、そのようなファイルを生成します。

一部の SAML アイデンティティプロバイダーは、Elastic Stack をサービスプロバイダーとして構成する際に、メタデータファイルを自動的にインポートすることを許可します。

アイデンティティプロバイダーと共有する前に、その整合性と真正性を確保するために、メタデータファイルにデジタル署名を選択することもできます。メタデータファイルに署名するために使用されるキーは、必ずしも SAML メッセージ署名のために SAML レルム構成で既に使用されているキーと同じである必要はありません。

Elasticsearch キーストアがパスワードで保護されている場合、elasticsearch-saml-metadata コマンドを実行するときにパスワードの入力を求められます。

パラメータ

  • --attribute <name>
  • メタデータに <RequestedAttribute> 要素として含めるべき SAML 属性を指定します。Elasticsearch レルムで構成された任意の属性は自動的に含まれ、コマンドラインオプションとして指定する必要はありません。
  • --batch
  • ユーザー入力を求めない。
  • --contacts
  • メタデータに 1 つ以上の <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 レルムのデフォルトメタデータファイルを生成します: 

  1. bin/elasticsearch-saml-metadata --realm saml1

ファイルは saml-elasticsearch-metadata.xml に書き込まれます。レルムで使用される属性の「friendlyName」値を提供するように求められる場合があります。

次のコマンドは、saml2 レルムのメタデータファイルを生成し、<ServiceName> を kibana-finance に設定し、en-GB のロケールを指定し、<ContactPerson> 要素と <Organization> 要素を含めます: 

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