Adjust docs for password protected keystore #45054
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds relevant parts in the elasticsearch-keystore subcommands reference docs and in the reload secure settings API doc.
jkakavas
added
>docs
|
Pinging @elastic/es-core-infra |
|
Pinging @elastic/es-docs |
|
Pinging @elastic/es-security |
rjernst
approved these changes
Jul 31, 2019
| decryption and reading across the cluster. The keystore's plain content is | ||
| The cluster nodes reload secure settings API is used to re-read the local node's encrypted keystore. | ||
| Specifically, it will prompt the keystore decryption and reading across the cluster. | ||
| The keystore's decrypted content is | ||
| used to reinitialize all compatible plugins. A compatible plugin can be |
There was a problem hiding this comment.
I think this existing wording is deceptive. Plugin's can't be reinitialized. Rather, the consumers of the keystore settings are notified of the updated value.
There was a problem hiding this comment.
I went ahead and removed the existing additional information. It felt more like describing internal implementation than adding something of value for the users/API consumers.
| ==== Reload Password Protected Secure Settings | ||
|
|
||
| When the elasticsearch keystore is password protected and not simply obfuscated, the password for the keystore needs to be provided in the request to reload the secure settings. | ||
| Reloading the settings for the whole cluster assumes that all nodes keystores are protected with the same password and is only allowed when |
There was a problem hiding this comment.
nit: nodes -> nodes' (plural possessive)
| The cluster nodes reload secure settings API is used to re-read the | ||
| local node's encrypted keystore. Specifically, it will prompt the keystore | ||
| decryption and reading across the cluster. The keystore's plain content is | ||
| The cluster nodes reload secure settings API is used to re-read the local node's encrypted keystore. |
There was a problem hiding this comment.
The local node's encrypted keystore implies to me the api must be run on every node, when in fact this is a cluster level API, correct? Maybe reword to ...is used to re-load the keystore on each node? I'm not sure encrypted should be there as a qualifier since in the no-passphrase case it is only obfuscated.
| -------------------------------------------------- | ||
| // NOTCONSOLE | ||
|
|
||
| <1> The password that the elasticsearch keystore is encrypted with. |
There was a problem hiding this comment.
I woudl add a qualfiier that this password must be the same on all nodes.
| -------------------------------------------------- | ||
| // NOTCONSOLE | ||
|
|
||
| <1> The password that the elasticsearch keystore is encrypted with. |
There was a problem hiding this comment.
encrypted with on the local node
|
|
||
| <1> The password that the elasticsearch keystore is encrypted with. | ||
|
|
||
| Note:It is an error if secure settings are inconsistent across the cluster nodes, yet this consistency is not enforced whatsoever.Hence, reloading specific nodes is not standard.It is only justifiable when retrying failed reload operations. |
There was a problem hiding this comment.
Should this be a real asciidoc "Note"? Also, seem to have lost some spacing between sentences in moving down here.
| bin/elasticsearch-keystore create -p | ||
| ---------------------------------------------------------------- | ||
|
|
||
| You will be prompted to enter the keystore password and the file `elasticsearch.keystore` will be created alongside `elasticsearch.yml` ,protected with the password you specified. |
There was a problem hiding this comment.
nit: spacing after comma, remove space before comma
jrodewig
reviewed
Aug 1, 2019
| Note: It is an error if secure settings are inconsistent across the cluster | ||
| nodes, yet this consistency is not enforced whatsoever. Hence, reloading specific | ||
| nodes is not standard. It is only justifiable when retrying failed reload operations. | ||
| NOTE: It is an error if secure settings are inconsistent across the cluster nodes, yet this consistency is not enforced |
There was a problem hiding this comment.
Suggested change
| NOTE: It is an error if secure settings are inconsistent across the cluster nodes, yet this consistency is not enforced | |
| NOTE: {es} returns an error if secure settings are inconsistent across the cluster nodes, but this consistency is not enforced |
There was a problem hiding this comment.
We don't return an error ( this is what the "but this consistency is not enforced" is meant to explain ). I see how this is not very clear, I'm open to suggestions to rephrase this
There was a problem hiding this comment.
Thanks for the clarification. Here's a suggested rephrasing.
Suggested change
| NOTE: It is an error if secure settings are inconsistent across the cluster nodes, yet this consistency is not enforced | |
| NOTE: {es} requires consistent secure settings across the cluster nodes, but this consistency is not enforced. |
Let me know if this is accurate. Also note that this removes the "whatsover." on the next line.
jrodewig
reviewed
Aug 1, 2019
| nodes, yet this consistency is not enforced whatsoever. Hence, reloading specific | ||
| nodes is not standard. It is only justifiable when retrying failed reload operations. | ||
| NOTE: It is an error if secure settings are inconsistent across the cluster nodes, yet this consistency is not enforced | ||
| whatsoever. Hence, reloading specific nodes is not standard.It is only justifiable when retrying failed reload operations. |
There was a problem hiding this comment.
Suggested change
| whatsoever. Hence, reloading specific nodes is not standard.It is only justifiable when retrying failed reload operations. | |
| Hence, reloading specific nodes is not standard. It is only justifiable when retrying failed reload operations. |
jrodewig
reviewed
Aug 1, 2019
| === Changing the password of the keystore | ||
|
|
||
| To change the password of the `elasticsearch.keystore`, use the `passwd` command. | ||
| If the elasticsearch keystore is password protected, you will be prompted to enter the current password and then enter the new one |
There was a problem hiding this comment.
Suggested change
| If the elasticsearch keystore is password protected, you will be prompted to enter the current password and then enter the new one | |
| If the {es} keystore is password protected, you will be prompted to enter the current password and then enter a new one. |
jrodewig
reviewed
Aug 1, 2019
| ---------------------------------------------------------------- | ||
|
|
||
| The file `elasticsearch.keystore` will be created alongside `elasticsearch.yml`. | ||
| You can use the `passwd` subcommand to set a password to a previously obfuscated only keystore, but also to remove the password from an encrypted keystore by setting it to an empty string. |
There was a problem hiding this comment.
Suggested change
| You can use the `passwd` subcommand to set a password to a previously obfuscated only keystore, but also to remove the password from an encrypted keystore by setting it to an empty string. | |
| You can use the `passwd` subcommand to set a password to a previously obfuscated-only keystore and the password from an encrypted keystore by setting it to an empty string. |
jrodewig
reviewed
Aug 1, 2019
|
|
||
| ==== Reload Password Protected Secure Settings | ||
|
|
||
| When the elasticsearch keystore is password protected and not simply obfuscated, the password for the keystore needs |
There was a problem hiding this comment.
Suggested change
| When the elasticsearch keystore is password protected and not simply obfuscated, the password for the keystore needs | |
| When the {es} keystore is password protected and not simply obfuscated, the password for the keystore needs |
jrodewig
reviewed
Aug 1, 2019
| -------------------------------------------------- | ||
| // NOTCONSOLE | ||
|
|
||
| <1> The common password that the elasticsearch keystore is encrypted with in every node of the cluster. |
There was a problem hiding this comment.
Suggested change
| <1> The common password that the elasticsearch keystore is encrypted with in every node of the cluster. | |
| <1> The common password that the {es} keystore is encrypted with in every node of the cluster. |
jrodewig
reviewed
Aug 1, 2019
| <1> The common password that the elasticsearch keystore is encrypted with in every node of the cluster. | ||
|
|
||
| Alternatively the secure settings can be reloaded on a per node basis, locally accessing the API and passing the | ||
| node-specific elasticsearch keystore password. |
There was a problem hiding this comment.
Suggested change
| node-specific elasticsearch keystore password. | |
| node-specific {es} keystore password. |
jrodewig
reviewed
Aug 1, 2019
| -------------------------------------------------- | ||
| // NOTCONSOLE | ||
|
|
||
| <1> The password that the elasticsearch keystore is encrypted with on the local node. |
There was a problem hiding this comment.
Suggested change
| <1> The password that the elasticsearch keystore is encrypted with on the local node. | |
| <1> The password that the {es} keystore is encrypted with on the local node. |
jrodewig
reviewed
Aug 1, 2019
|
|
||
| You will be prompted to enter the keystore password and the file `elasticsearch.keystore` will be created alongside `elasticsearch.yml`, protected with the password you specified. | ||
|
|
||
| NOTE: If you don't specify the `-p` flag or if you enter an empty password, the elasticsearch keystore will be obfuscated but not password protected. |
There was a problem hiding this comment.
Suggested change
| NOTE: If you don't specify the `-p` flag or if you enter an empty password, the elasticsearch keystore will be obfuscated but not password protected. | |
| NOTE: If you don't specify the `-p` flag or if you enter an empty password, the {es} keystore will be obfuscated but not password protected. |
jrodewig
reviewed
Aug 1, 2019
|
|
||
| [float] | ||
| [[list-settings]] | ||
| === Listing settings in the keystore | ||
|
|
||
| A list of the settings in the keystore is available with the `list` command: | ||
| A list of the settings in the keystore is available with the `list` command. | ||
| If the elasticsearch keystore is password protected, you will be prompted to enter the password: |
There was a problem hiding this comment.
Suggested change
| If the elasticsearch keystore is password protected, you will be prompted to enter the password: | |
| If the {es} keystore is password protected, you will be prompted to enter the password: |
jrodewig
reviewed
Aug 1, 2019
| Sensitive string settings, like authentication credentials for cloud | ||
| plugins, can be added using the `add` command: | ||
| Sensitive string settings, like authentication credentials for cloud plugins, can be added using the `add` command. | ||
| If the elasticsearch keystore is password protected, you will be prompted to enter the password: |
There was a problem hiding this comment.
Suggested change
| If the elasticsearch keystore is password protected, you will be prompted to enter the password: | |
| If the {es} keystore is password protected, you will be prompted to enter the password: |
jrodewig
reviewed
Aug 1, 2019
| [float] | ||
| [[add-file-to-keystore]] | ||
| === Adding file settings | ||
| You can add sensitive files, like authentication key files for cloud plugins, | ||
| using the `add-file` command. Be sure to include your file path as an argument | ||
| after the setting name. | ||
| If the elasticsearch keystore is password protected, you will be prompted to enter the password: |
There was a problem hiding this comment.
Suggested change
| If the elasticsearch keystore is password protected, you will be prompted to enter the password: | |
| If the {es} keystore is password protected, you will be prompted to enter a password: |
jrodewig
reviewed
Aug 1, 2019
| @@ -84,7 +107,8 @@ bin/elasticsearch-keystore add-file the.setting.name.to.set /path/example-file.j | |||
| [[remove-settings]] | |||
| === Removing settings | |||
|
|
|||
| To remove a setting from the keystore, use the `remove` command: | |||
| To remove a setting from the keystore, use the `remove` command. | |||
| If the elasticsearch keystore is password protected, you will be prompted to enter the password: | |||
There was a problem hiding this comment.
Suggested change
| If the elasticsearch keystore is password protected, you will be prompted to enter the password: | |
| If the {es} keystore is password protected, you will be prompted to enter a password: |
jrodewig
reviewed
Aug 1, 2019
| the reload has been completed, meaning that all internal datastructures dependent | ||
| // NOTCONSOLE | ||
|
|
||
| <1> The password that the elasticsearch keystore is encrypted with. |
There was a problem hiding this comment.
Suggested change
| <1> The password that the elasticsearch keystore is encrypted with. | |
| <1> The password that the {es} keystore is encrypted with. |
williamrandolph
pushed a commit
to williamrandolph/elasticsearch
that referenced
this pull request
Nov 18, 2019
This commit adds relevant parts in the elasticsearch-keystore sub-commands reference docs and in the reload secure settings API doc.
williamrandolph
added a commit
that referenced
this pull request
Dec 11, 2019
* 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. I will write some user-facing documentation for these changes in a follow-up commit. * 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. * Cleanup after feature branch reconstruction The feature branch for the password-protected keystore, due to an accident, contains a large number of unrelated commits. In order to get a cleaner merge, I've cherry-picked the main commits that went into the feature branch against a branch derived from master — essentially, a rebase onto master. We've ignored some tests that will addressed in follow-up PRs to the feature branch.
williamrandolph
added a commit
to williamrandolph/elasticsearch
that referenced
this pull request
Jan 16, 2020
) * Reload secure settings with password (elastic#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 (elastic#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: elastic#32691 Supersedes: elastic#37472 * Restore behavior for force parameter (elastic#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 (elastic#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 (elastic#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 (elastic#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. I will write some user-facing documentation for these changes in a follow-up commit. * Adjust docs for password protected keystore (elastic#45054) This commit adds relevant parts in the elasticsearch-keystore sub-commands reference docs and in the reload secure settings API doc. * Cleanup after feature branch reconstruction The feature branch for the password-protected keystore, due to an accident, contains a large number of unrelated commits. In order to get a cleaner merge, I've cherry-picked the main commits that went into the feature branch against a branch derived from master — essentially, a rebase onto master. We've ignored some tests that will addressed in follow-up PRs to the feature branch.
williamrandolph
added a commit
that referenced
this pull request
Jan 28, 2020
* 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>
williamrandolph
added a commit
that referenced
this pull request
Jan 28, 2020
* 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds relevant parts in the elasticsearch-keystore
sub-commands reference docs and in the reload secure settings API
doc.