2018-02-04 20:22:54 -05:00
|
|
|
[role="xpack"]
|
2018-06-06 10:49:15 -04:00
|
|
|
[testenv="gold+"]
|
2018-02-04 20:22:54 -05:00
|
|
|
[[saml-metadata]]
|
2018-08-28 17:34:39 -04:00
|
|
|
== elasticsearch-saml-metadata
|
2018-02-04 20:22:54 -05:00
|
|
|
|
2018-04-11 11:31:53 -04:00
|
|
|
The `elasticsearch-saml-metadata` command can be used to generate a SAML 2.0 Service
|
|
|
|
|
Provider Metadata file.
|
2018-02-04 20:22:54 -05:00
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-02-04 20:22:54 -05:00
|
|
|
=== Synopsis
|
|
|
|
|
|
|
|
|
|
[source,shell]
|
|
|
|
|
--------------------------------------------------
|
2018-04-11 11:31:53 -04:00
|
|
|
bin/elasticsearch-saml-metadata
|
2018-02-04 20:22:54 -05:00
|
|
|
[--realm <name>]
|
|
|
|
|
[--out <file_path>] [--batch]
|
|
|
|
|
[--attribute <name>] [--service-name <name>]
|
|
|
|
|
[--locale <name>] [--contacts]
|
|
|
|
|
([--organisation-name <name>] [--organisation-display-name <name>] [--organisation-url <url>])
|
2018-04-17 07:23:26 -04:00
|
|
|
([--signing-bundle <file_path>] | [--signing-cert <file_path>][--signing-key <file_path>])
|
|
|
|
|
[--signing-key-password <password>]
|
2018-02-04 20:22:54 -05:00
|
|
|
[-E <KeyValuePair>]
|
|
|
|
|
[-h, --help] ([-s, --silent] | [-v, --verbose])
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-02-04 20:22:54 -05:00
|
|
|
=== Description
|
|
|
|
|
|
|
|
|
|
The SAML 2.0 specification provides a mechanism for Service Providers to
|
|
|
|
|
describe their capabilities and configuration using a _metadata file_.
|
|
|
|
|
|
2018-04-11 11:31:53 -04:00
|
|
|
The `elasticsearch-saml-metadata` command generates such a file, based on the
|
|
|
|
|
configuration of a SAML realm in {es}.
|
2018-02-04 20:22:54 -05:00
|
|
|
|
|
|
|
|
Some SAML Identity Providers will allow you to automatically import a metadata
|
|
|
|
|
file when you configure the Elastic Stack as a Service Provider.
|
|
|
|
|
|
2018-04-17 07:23:26 -04:00
|
|
|
You can optionally select to digitally sign the metadata file in order to
|
|
|
|
|
ensure its integrity and authenticity before sharing it with the Identity Provider.
|
|
|
|
|
The key used for signing the metadata file need not necessarily be the same as
|
|
|
|
|
the keys already used in the saml realm configuration for SAML message signing.
|
|
|
|
|
|
Password-protected Keystore Feature Branch PR (#51123) (#51510)
* Reload secure settings with password (#43197)
If a password is not set, we assume an empty string to be
compatible with previous behavior.
Only allow the reload to be broadcast to other nodes if TLS is
enabled for the transport layer.
* Add passphrase support to elasticsearch-keystore (#38498)
This change adds support for keystore passphrases to all subcommands
of the elasticsearch-keystore cli tool and adds a subcommand for
changing the passphrase of an existing keystore.
The work to read the passphrase in Elasticsearch when
loading, which will be addressed in a different PR.
Subcommands of elasticsearch-keystore can handle (open and create)
passphrase protected keystores
When reading a keystore, a user is only prompted for a passphrase
only if the keystore is passphrase protected.
When creating a keystore, a user is allowed (default behavior) to create one with an
empty passphrase
Passphrase can be set to be empty when changing/setting it for an
existing keystore
Relates to: #32691
Supersedes: #37472
* Restore behavior for force parameter (#44847)
Turns out that the behavior of `-f` for the add and add-file sub
commands where it would also forcibly create the keystore if it
didn't exist, was by design - although undocumented.
This change restores that behavior auto-creating a keystore that
is not password protected if the force flag is used. The force
OptionSpec is moved to the BaseKeyStoreCommand as we will presumably
want to maintain the same behavior in any other command that takes
a force option.
* Handle pwd protected keystores in all CLI tools (#45289)
This change ensures that `elasticsearch-setup-passwords` and
`elasticsearch-saml-metadata` can handle a password protected
elasticsearch.keystore.
For setup passwords the user would be prompted to add the
elasticsearch keystore password upon running the tool. There is no
option to pass the password as a parameter as we assume the user is
present in order to enter the desired passwords for the built-in
users.
For saml-metadata, we prompt for the keystore password at all times
even though we'd only need to read something from the keystore when
there is a signing or encryption configuration.
* Modify docs for setup passwords and saml metadata cli (#45797)
Adds a sentence in the documentation of `elasticsearch-setup-passwords`
and `elasticsearch-saml-metadata` to describe that users would be
prompted for the keystore's password when running these CLI tools,
when the keystore is password protected.
Co-Authored-By: Lisa Cawley <lcawley@elastic.co>
* Elasticsearch keystore passphrase for startup scripts (#44775)
This commit allows a user to provide a keystore password on Elasticsearch
startup, but only prompts when the keystore exists and is encrypted.
The entrypoint in Java code is standard input. When the Bootstrap class is
checking for secure keystore settings, it checks whether or not the keystore
is encrypted. If so, we read one line from standard input and use this as the
password. For simplicity's sake, we allow a maximum passphrase length of 128
characters. (This is an arbitrary limit and could be increased or eliminated.
It is also enforced in the keystore tools, so that a user can't create a
password that's too long to enter at startup.)
In order to provide a password on standard input, we have to account for four
different ways of starting Elasticsearch: the bash startup script, the Windows
batch startup script, systemd startup, and docker startup. We use wrapper
scripts to reduce systemd and docker to the bash case: in both cases, a
wrapper script can read a passphrase from the filesystem and pass it to the
bash script.
In order to simplify testing the need for a passphrase, I have added a
has-passwd command to the keystore tool. This command can run silently, and
exit with status 0 when the keystore has a password. It exits with status 1 if
the keystore doesn't exist or exists and is unencrypted.
A good deal of the code-change in this commit has to do with refactoring
packaging tests to cleanly use the same tests for both the "archive" and the
"package" cases. This required not only moving tests around, but also adding
some convenience methods for an abstraction layer over distribution-specific
commands.
* Adjust docs for password protected keystore (#45054)
This commit adds relevant parts in the elasticsearch-keystore
sub-commands reference docs and in the reload secure settings API
doc.
* Fix failing Keystore Passphrase test for feature branch (#50154)
One problem with the passphrase-from-file tests, as written, is that
they would leave a SystemD environment variable set when they failed,
and this setting would cause elasticsearch startup to fail for other
tests as well. By using a try-finally, I hope that these tests will fail
more gracefully.
It appears that our Fedora and Ubuntu environments may be configured to
store journald information under /var rather than under /run, so that it
will persist between boots. Our destructive tests that read from the
journal need to account for this in order to avoid trying to limit the
output we check in tests.
* Run keystore management tests on docker distros (#50610)
* Add Docker handling to PackagingTestCase
Keystore tests need to be able to run in the Docker case. We can do this
by using a DockerShell instead of a plain Shell when Docker is running.
* Improve ES startup check for docker
Previously we were checking truncated output for the packaged JDK as
an indication that Elasticsearch had started. With new preliminary
password checks, we might get a false positive from ES keystore
commands, so we have to check specifically that the Elasticsearch
class from the Bootstrap package is what's running.
* Test password-protected keystore with Docker (#50803)
This commit adds two tests for the case where we mount a
password-protected keystore into a Docker container and provide a
password via a Docker environment variable.
We also fix a logging bug where we were logging the identifier for an
array of strings rather than the contents of that array.
* Add documentation for keystore startup prompting (#50821)
When a keystore is password-protected, Elasticsearch will prompt at
startup. This commit adds documentation for this prompt for the archive,
systemd, and Docker cases.
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
* Warn when unable to upgrade keystore on debian (#51011)
For Red Hat RPM upgrades, we warn if we can't upgrade the keystore. This
commit brings the same logic to the code for Debian packages. See the
posttrans file for gets executed for RPMs.
* Restore handling of string input
Adds tests that were mistakenly removed. One of these tests proved
we were not handling the the stdin (-x) option correctly when no
input was added. This commit restores the original approach of
reading stdin one char at a time until there is no more (-1, \r, \n)
instead of using readline() that might return null
* Apply spotless reformatting
* Use '--since' flag to get recent journal messages
When we get Elasticsearch logs from journald, we want to fetch only log
messages from the last run. There are two reasons for this. First, if
there are many logs, we might get a string that's too large for our
utility methods. Second, when we're looking for a specific message or
error, we almost certainly want to look only at messages from the last
execution.
Previously, we've been trying to do this by clearing out the physical
files under the journald process. But there seems to be some contention
over these directories: if journald writes a log file in between when
our deletion command deletes the file and when it deletes the log
directory, the deletion will fail.
It seems to me that we might be able to use journald's "--since" flag to
retrieve only log messages from the last run, and that this might be
less likely to fail due to race conditions in file deletion.
Unfortunately, it looks as if the "--since" flag has a granularity of
one-second. I've added a two-second sleep to make sure that there's a
sufficient gap between the test that will read from journald and the
test before it.
* Use new journald wrapper pattern
* Update version added in secure settings request
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>
2020-01-28 05:32:32 -05:00
|
|
|
If your {es} keystore is password protected, you
|
|
|
|
|
are prompted to enter the password when you run the
|
|
|
|
|
`elasticsearch-saml-metadata` command.
|
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2020-09-29 10:35:23 -04:00
|
|
|
[[saml-metadata-parameters]]
|
2018-02-04 20:22:54 -05:00
|
|
|
=== Parameters
|
|
|
|
|
|
|
|
|
|
`--attribute <name>`:: Specifies a SAML attribute that should be
|
|
|
|
|
included as a `<RequestedAttribute>` element in the metadata. Any attribute
|
|
|
|
|
configured in the {es} realm is automatically included and does not need to be
|
|
|
|
|
specified as a commandline option.
|
|
|
|
|
|
|
|
|
|
`--batch`:: Do not prompt for user input.
|
|
|
|
|
|
|
|
|
|
`--contacts`:: Specifies that the metadata should include one or more
|
|
|
|
|
`<ContactPerson>` elements. The user will be prompted to enter the details for
|
|
|
|
|
each person.
|
|
|
|
|
|
|
|
|
|
`-E <KeyValuePair>`:: Configures an {es} setting.
|
|
|
|
|
|
|
|
|
|
`-h, --help`:: Returns all of the command parameters.
|
|
|
|
|
|
|
|
|
|
`--locale <name>`:: Specifies the locale to use for metadata elements such as
|
|
|
|
|
`<ServiceName>`. Defaults to the JVM's default system locale.
|
|
|
|
|
|
|
|
|
|
`--organisation-display-name <name`:: Specified the value of the
|
|
|
|
|
`<OrganizationDisplayName>` element.
|
|
|
|
|
Only valid if `--organisation-name` is also specified.
|
|
|
|
|
|
|
|
|
|
`--organisation-name <name>`:: Specifies that an `<Organization>` element should
|
|
|
|
|
be included in the metadata and provides the value for the `<OrganizationName>`.
|
|
|
|
|
If this is specified, then `--organisation-url` must also be specified.
|
|
|
|
|
|
|
|
|
|
`--organisation-url <url>`:: Specifies the value of the `<OrganizationURL>`
|
|
|
|
|
element. This is required if `--organisation-name` is specified.
|
|
|
|
|
|
|
|
|
|
`--out <file_path>`:: Specifies a path for the output files.
|
|
|
|
|
Defaults to `saml-elasticsearch-metadata.xml`
|
|
|
|
|
|
|
|
|
|
`--service-name <name>`:: Specifies the value for the `<ServiceName>` element in
|
|
|
|
|
the metadata. Defaults to `elasticsearch`.
|
|
|
|
|
|
2018-04-17 07:23:26 -04:00
|
|
|
`--signing-bundle <file_path>`:: Specifies the path to an existing key pair
|
|
|
|
|
(in PKCS#12 format). The private key of that key pair will be used to sign
|
|
|
|
|
the metadata file.
|
|
|
|
|
|
|
|
|
|
`--signing-cert <file_path>`:: Specifies the path to an existing certificate (in
|
|
|
|
|
PEM format) to be used for signing of the metadata file. You must also specify
|
|
|
|
|
the `--signing-key` parameter. This parameter cannot be used with the
|
|
|
|
|
`--signing-bundle` parameter.
|
|
|
|
|
|
|
|
|
|
`--signing-key <file_path>`:: Specifies the path to an existing key (in PEM format)
|
|
|
|
|
to be used for signing of the metadata file. You must also specify the
|
|
|
|
|
`--signing-cert` parameter. This parameter cannot be used with the
|
|
|
|
|
`--signing-bundle` parameter.
|
|
|
|
|
|
|
|
|
|
`--signing-key-password <password>`:: Specifies the password for the signing key.
|
|
|
|
|
It can be used with either the `--signing-key` or the `--signing-bundle` parameters.
|
|
|
|
|
|
2018-02-04 20:22:54 -05:00
|
|
|
`--realm <name>`:: Specifies the name of the realm for which the metadata
|
|
|
|
|
should be generated. This parameter is required if there is more than 1 `saml`
|
|
|
|
|
realm in your {es} configuration.
|
|
|
|
|
|
|
|
|
|
`-s, --silent`:: Shows minimal output.
|
|
|
|
|
|
|
|
|
|
`-v, --verbose`:: Shows verbose output.
|
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-02-04 20:22:54 -05:00
|
|
|
=== Examples
|
|
|
|
|
|
|
|
|
|
The following command generates a default metadata file for the `saml1` realm:
|
|
|
|
|
|
|
|
|
|
[source, sh]
|
|
|
|
|
--------------------------------------------------
|
2018-04-11 11:31:53 -04:00
|
|
|
bin/elasticsearch-saml-metadata --realm saml1
|
2018-02-04 20:22:54 -05:00
|
|
|
--------------------------------------------------
|
|
|
|
|
|
|
|
|
|
The file will be written to `saml-elasticsearch-metadata.xml`.
|
|
|
|
|
You may be prompted to provide the "friendlyName" value for any attributes that
|
|
|
|
|
are used by the realm.
|
|
|
|
|
|
|
|
|
|
The following command generates a metadata file for the `saml2` realm, with a
|
|
|
|
|
`<ServiceName>` of `kibana-finance`, a locale of `en-GB` and includes
|
|
|
|
|
`<ContactPerson>` elements and an `<Organization>` element:
|
|
|
|
|
|
|
|
|
|
[source, sh]
|
|
|
|
|
--------------------------------------------------
|
2018-04-11 11:31:53 -04:00
|
|
|
bin/elasticsearch-saml-metadata --realm saml2 \
|
2018-02-04 20:22:54 -05:00
|
|
|
--service-name kibana-finance \
|
|
|
|
|
--locale en-GB \
|
|
|
|
|
--contacts \
|
|
|
|
|
--organisation-name "Mega Corp. Finance Team" \
|
|
|
|
|
--organisation-url "http://mega.example.com/finance/"
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
|
