Skip to content

Use Terminal.readSecret in add string keystore command #126966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 18, 2025
Merged

Use Terminal.readSecret in add string keystore command #126966

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d33c3a6
Use Terminal.readSecret in add string keystore command
rjernst Apr 16, 2025
2a44edc
[CI] Auto commit changes from spotless
Apr 16, 2025
6a4457b
Merge branch 'main' into keystore/use_terminal_for_adding
rjernst Apr 18, 2025
43d9fa8
address feedback
rjernst Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 17 additions & 36 deletions ...s/keystore-cli/src/main/java/org/elasticsearch/cli/keystore/AddStringKeyStoreCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@
import org.elasticsearch.core.CheckedFunction;
import org.elasticsearch.env.Environment;

import java.io.CharArrayWriter;
import java.io.Closeable;
import java.io.IOException;
import java.io.Reader;
import java.util.Arrays;
import java.util.List;

Expand Down Expand Up @@ -53,42 +50,26 @@ protected void executeCommand(Terminal terminal, OptionSet options, Environment

final KeyStoreWrapper keyStore = getKeyStore();

final Closeable closeable;
final CheckedFunction<String, char[], IOException> valueSupplier;
if (options.has(stdinOption)) {
final Reader stdinReader = terminal.getReader();
valueSupplier = s -> {
try (CharArrayWriter writer = new CharArrayWriter()) {
int c;
while ((c = stdinReader.read()) != -1) {
if ((char) c == '\r' || (char) c == '\n') {
break;
}
writer.write((char) c);
}
return writer.toCharArray();
}
};
closeable = stdinReader;
} else {
valueSupplier = s -> terminal.readSecret("Enter value for " + s + ": ");
closeable = () -> {};
}
final CheckedFunction<String, char[], IOException> valueSupplier = s -> {
String prompt = "";
if (options.has(stdinOption) == false) {
prompt = "Enter value for " + s + ": ";
}
Copy link
Contributor

@prdoyle prdoyle Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This style of supplying a default that is sometimes overridden later defeats Java's error detection for paths where the value is not set.

Suggested change
String prompt = "";
if (options.has(stdinOption) == false) {
prompt = "Enter value for " + s + ": ";
}
String prompt;
if (options.has(stdinOption)) {
prompt = "";
} else {
prompt = "Enter value for " + s + ": ";
}

Copy link
Member Author

@rjernst rjernst Apr 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I applied your suggestion.

return terminal.readSecret(prompt);
};

try (closeable) {
for (final String setting : settings) {
if (keyStore.getSettingNames().contains(setting) && options.has(forceOption) == false) {
if (terminal.promptYesNo("Setting " + setting + " already exists. Overwrite?", false) == false) {
terminal.println("Exiting without modifying keystore.");
return;
}
for (final String setting : settings) {
if (keyStore.getSettingNames().contains(setting) && options.has(forceOption) == false) {
if (terminal.promptYesNo("Setting " + setting + " already exists. Overwrite?", false) == false) {
terminal.println("Exiting without modifying keystore.");
return;
}
}

try {
keyStore.setString(setting, valueSupplier.apply(setting));
} catch (final IllegalArgumentException e) {
throw new UserException(ExitCodes.DATA_ERROR, e.getMessage());
}
try {
keyStore.setString(setting, valueSupplier.apply(setting));
} catch (final IllegalArgumentException e) {
throw new UserException(ExitCodes.DATA_ERROR, e.getMessage());
}
}

Expand Down