Commit graph

11 commits

Author SHA1 Message Date
Brad White
318dacc2f5
Remove mention of (secure) settings qualifier from docs (#201900)
## Summary

Removes mentioning `(Secure)` settings from the keystore docs because
Kibana does not have any settings which use this qualifier.
2024-11-27 13:35:39 -08:00
Jon
8b015ebedd
[keystore] Add password support (#180414)
This adds support a password protected keystore. The UX should match
other stack products.

Closes https://github.com/elastic/kibana/issues/21756.

```
[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% bin/kibana-keystore create --password
A Kibana keystore already exists. Overwrite? [y/N] y
Enter new password for the kibana keystore (empty for no password): ********
Created Kibana keystore in /tmp/kibana-8.15.0-SNAPSHOT/config/kibana.keystore

[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% bin/kibana-keystore add elasticsearch.username
Enter password for the kibana keystore: ********
Enter value for elasticsearch.username: *************

[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% bin/kibana-keystore add elasticsearch.password
Enter password for the kibana keystore: ********
Enter value for elasticsearch.password: ********

[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% bin/kibana
...
Enter password for the kibana keystore: ********
[2024-04-30T09:47:03.560-05:00][INFO ][root] Kibana is starting

[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% bin/kibana-keystore has-passwd
Keystore is password-protected

[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% ./bin/kibana-keystore show elasticsearch.username
Enter password for the kibana keystore: ********
kibana_system

[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% ./bin/kibana-keystore remove elasticsearch.username
Enter password for the kibana keystore: ********

[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% ./bin/kibana-keystore show elasticsearch.username
Enter password for the kibana keystore: ********
ERROR: Kibana keystore doesn't have requested key.

[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% bin/kibana-keystore passwd
Enter password for the kibana keystore: ********
Enter new password for the kibana keystore (empty for no password):
[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% ./bin/kibana-keystore has-passwd
Error: Keystore is not password protected

[jon@mbpkbn1]/tmp/kibana-8.15.0-SNAPSHOT% ./bin/kibana
...
[2024-04-30T09:49:03.220-05:00][INFO ][root] Kibana is starting
```

## Password input

Environment variable usage is not consistent across stack products. I
implemented `KBN_KEYSTORE_PASSWORD_FILE` and `KBN_KEYSTORE_PASSWORD` to
be used to avoid prompts. @elastic/kibana-security do you have any
thoughts?


- `LOGSTASH_KEYSTORE_PASS` -
https://www.elastic.co/guide/en/logstash/current/keystore.html#keystore-password
- `KEYSTORE_PASSWORD` -
https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-keystore-bind-mount
- `ES_KEYSTORE_PASSPHRASE_FILE` -
https://www.elastic.co/guide/en/elasticsearch/reference/current/rpm.html#rpm-running-systemd
- Beats discussion, unresolved:
https://github.com/elastic/beats/issues/5737


## Release note
Adds password support to the Kibana keystore.
2024-05-06 10:23:29 -05:00
Alex Szabo
6ebfb8aa3e
Improve keystore CLI (#157359)
## Summary

Relates to: #113217

- Add extra documentation to highlight behaviour of the kibana keystore
(for #113217)
- Fix/Tidy-up commands (`create`, `list`) where the extra unused
arguments were preventing the `options` from being passed to the
functions. Also remove unnecessary `async` keyword from the `remove`
command.
- Added new `show` command
```
Usage: bin/kibana-keystore show [options] <key>

Displays the value of a single setting in the keystore. Pass the -o (or --output) parameter to write the setting to a file.

Options:
  -s, --silent         prevent all logging
  -o, --output <file>  output value to a file
  -h, --help           output usage information
```

### Checklist

Delete any items that are not applicable to this PR.

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2023-05-16 16:21:25 +02:00
Alex Szabo
58650c5545
Adds documentation to clarify kibana-keystore behaviour (#157146)
## Summary
Addresses #155474 

We've discussed with the team, and decided that we'd retain current
behaviour, and adjust the docs and notes around the behaviour.

fix(keystore): add warning note to explain that input is being JSON
parsed
docs(keystore): add documentation to clarify behavior

### Checklist

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
2023-05-09 18:02:45 +02:00
Jonathan Budzenski
96bfe341c4
[docs] Update keystore location (#111994)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-09-27 16:12:45 -05:00
PavithraCP
180827cfe1
Add acnchors to Kibana docs-settings (#78115)
* Add acnchors to Kibana docs-settings

* Address PR comments
2020-09-23 08:01:05 -07:00
gchaps
56ed61e303
[DOCS] Edits titles in Setup section for consistency (#68451)
* [DOCS] Fixes titles in Setup section for consistency

* [DOCS] Fixes to titles and orders of docs in Set up
2020-06-08 14:46:26 -07:00
Lisa Cawley
f05f0e18d4
[DOCS] Removes X-Pack settings section (#30554) 2019-02-11 08:17:25 -08:00
Glen Smith
66160e6447 Clarify how settings are applied once in keystore (#16902) 2018-03-12 16:39:30 -05:00
Tyler Smalley
359ce96105
Fixes issue with Keystore's stdin option (#15221)
Fixes issue preventing stdin option from being used
Using create to overwrite should reset keystore
2017-11-29 15:59:17 -08:00
Tyler Smalley
fb4a381514
Adds keystore for securely storing settings (#14714)
Introduces bin/kibana-keystore providing create, list, add, and remove actions.

Settings stored within the keystore will be loaded at runtime.

Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
2017-11-13 10:25:10 -08:00