Refactor for JPMS Support

Signed-off-by: Prudhvi Godithi <[email protected]>
opensearch-project · Jan 28, 2025 · 9c20d11 · 9c20d11
1 parent b5234a5
commit 9c20d11
Show file tree

Hide file tree

Showing 50 changed files with 163 additions and 116 deletions.
diff --git a/distribution/src/bin/opensearch-keystore b/distribution/src/bin/opensearch-keystore
@@ -2,7 +2,7 @@
 
 set -e -o pipefail
 
-OPENSEARCH_MAIN_CLASS=org.opensearch.common.settings.KeyStoreCli \
+OPENSEARCH_MAIN_CLASS=org.opensearch.cli.keystore.KeyStoreCli \
   OPENSEARCH_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/keystore-cli \
   "`dirname "$0"`"/opensearch-cli \
   "$@"
diff --git a/distribution/src/bin/opensearch-keystore.bat b/distribution/src/bin/opensearch-keystore.bat
@@ -3,7 +3,7 @@
 setlocal enabledelayedexpansion
 setlocal enableextensions
 
-set OPENSEARCH_MAIN_CLASS=org.opensearch.common.settings.KeyStoreCli
+set OPENSEARCH_MAIN_CLASS=org.opensearch.cli.keystore.KeyStoreCli
 set OPENSEARCH_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/keystore-cli
 call "%~dp0opensearch-cli.bat" ^
   %%* ^

diff --git a/...mmon/settings/AddFileKeyStoreCommand.java → .../cli/keystore/AddFileKeyStoreCommand.java b/...mmon/settings/AddFileKeyStoreCommand.java → .../cli/keystore/AddFileKeyStoreCommand.java
@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import joptsimple.OptionSet;
 import joptsimple.OptionSpec;
@@ -39,6 +39,7 @@
 import org.opensearch.cli.UserException;
 import org.opensearch.common.SuppressForbidden;
 import org.opensearch.common.io.PathUtils;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.env.Environment;
 
 import java.nio.file.Files;

diff --git a/...on/settings/AddStringKeyStoreCommand.java → ...li/keystore/AddStringKeyStoreCommand.java b/...on/settings/AddStringKeyStoreCommand.java → ...li/keystore/AddStringKeyStoreCommand.java
@@ -30,14 +30,15 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import joptsimple.OptionSet;
 import joptsimple.OptionSpec;
 import org.opensearch.cli.ExitCodes;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
 import org.opensearch.common.CheckedFunction;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.env.Environment;
 
 import java.io.BufferedReader;

diff --git a/.../common/settings/BaseKeyStoreCommand.java → ...rch/cli/keystore/BaseKeyStoreCommand.java b/.../common/settings/BaseKeyStoreCommand.java → ...rch/cli/keystore/BaseKeyStoreCommand.java
@@ -30,14 +30,14 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import joptsimple.OptionSet;
 import joptsimple.OptionSpec;
 import org.opensearch.cli.ExitCodes;
-import org.opensearch.cli.KeyStoreAwareCommand;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.core.common.settings.SecureString;
 import org.opensearch.env.Environment;
 
@@ -53,7 +53,7 @@ public abstract class BaseKeyStoreCommand extends KeyStoreAwareCommand {
     private KeyStoreWrapper keyStore;
     private SecureString keyStorePassword;
     private final boolean keyStoreMustExist;
-    OptionSpec<Void> forceOption;
+    protected OptionSpec<Void> forceOption;
 
     public BaseKeyStoreCommand(String description, boolean keyStoreMustExist) {
         super(description);

diff --git a/...ttings/ChangeKeyStorePasswordCommand.java → ...ystore/ChangeKeyStorePasswordCommand.java b/...ttings/ChangeKeyStorePasswordCommand.java → ...ystore/ChangeKeyStorePasswordCommand.java
@@ -30,12 +30,13 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import joptsimple.OptionSet;
 import org.opensearch.cli.ExitCodes;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.core.common.settings.SecureString;
 import org.opensearch.env.Environment;
 
@@ -44,7 +45,7 @@
  *
  * @opensearch.internal
  */
-class ChangeKeyStorePasswordCommand extends BaseKeyStoreCommand {
+public class ChangeKeyStorePasswordCommand extends BaseKeyStoreCommand {
 
     ChangeKeyStorePasswordCommand() {
         super("Changes the password of a keystore", true);

diff --git a/...ommon/settings/CreateKeyStoreCommand.java → ...h/cli/keystore/CreateKeyStoreCommand.java b/...ommon/settings/CreateKeyStoreCommand.java → ...h/cli/keystore/CreateKeyStoreCommand.java
@@ -30,14 +30,14 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import joptsimple.OptionSet;
 import joptsimple.OptionSpec;
 import org.opensearch.cli.ExitCodes;
-import org.opensearch.cli.KeyStoreAwareCommand;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.core.common.settings.SecureString;
 import org.opensearch.env.Environment;
 

diff --git a/.../settings/HasPasswordKeyStoreCommand.java → .../keystore/HasPasswordKeyStoreCommand.java b/.../settings/HasPasswordKeyStoreCommand.java → .../keystore/HasPasswordKeyStoreCommand.java
@@ -30,12 +30,12 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import joptsimple.OptionSet;
-import org.opensearch.cli.KeyStoreAwareCommand;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.env.Environment;
 
 import java.nio.file.Path;
@@ -49,7 +49,7 @@ public class HasPasswordKeyStoreCommand extends KeyStoreAwareCommand {
 
     static final int NO_PASSWORD_EXIT_CODE = 1;
 
-    HasPasswordKeyStoreCommand() {
+    protected HasPasswordKeyStoreCommand() {
         super(
             "Succeeds if the keystore exists and is password-protected, " + "fails with exit code " + NO_PASSWORD_EXIT_CODE + " otherwise."
         );

diff --git a/.../opensearch/cli/KeyStoreAwareCommand.java → ...ch/cli/keystore/KeyStoreAwareCommand.java b/.../opensearch/cli/KeyStoreAwareCommand.java → ...ch/cli/keystore/KeyStoreAwareCommand.java
@@ -30,9 +30,14 @@
  * GitHub history for details.
  */
 
-package org.opensearch.cli;
+package org.opensearch.cli.keystore;
 
 import joptsimple.OptionSet;
+import org.opensearch.cli.ExitCodes;
+import org.opensearch.cli.KeystoreConstants;
+import org.opensearch.cli.Terminal;
+import org.opensearch.cli.UserException;
+import org.opensearch.common.cli.EnvironmentAwareCommand;
 import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.core.common.settings.SecureString;
 import org.opensearch.env.Environment;
@@ -42,7 +47,7 @@
 import java.util.Arrays;
 
 /**
- * An {@link org.opensearch.cli.EnvironmentAwareCommand} that needs to access the opensearch keystore, possibly
+ * An {@link EnvironmentAwareCommand} that needs to access the opensearch keystore, possibly
  * decrypting it if it is password protected.
  *
  * @opensearch.internal
@@ -52,9 +57,6 @@ public KeyStoreAwareCommand(String description) {
         super(description);
     }
 
-    /** Arbitrarily chosen maximum passphrase length */
-    public static final int MAX_PASSPHRASE_LENGTH = 128;
-
     /**
      * Reads the keystore password from the {@link Terminal}, prompting for verification where applicable and returns it as a
      * {@link SecureString}.
@@ -69,9 +71,9 @@ protected static SecureString readPassword(Terminal terminal, boolean withVerifi
         if (withVerification) {
             passwordArray = terminal.readSecret(
                 "Enter new password for the opensearch keystore (empty for no password): ",
-                MAX_PASSPHRASE_LENGTH
+                KeystoreConstants.MAX_PASSPHRASE_LENGTH
             );
-            char[] passwordVerification = terminal.readSecret("Enter same password again: ", MAX_PASSPHRASE_LENGTH);
+            char[] passwordVerification = terminal.readSecret("Enter same password again: ", KeystoreConstants.MAX_PASSPHRASE_LENGTH);
             if (Arrays.equals(passwordArray, passwordVerification) == false) {
                 throw new UserException(ExitCodes.DATA_ERROR, "Passwords are not equal, exiting.");
             }

diff --git a/...ensearch/common/settings/KeyStoreCli.java → .../opensearch/cli/keystore/KeyStoreCli.java b/...ensearch/common/settings/KeyStoreCli.java → .../opensearch/cli/keystore/KeyStoreCli.java
@@ -30,10 +30,10 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
-import org.opensearch.cli.LoggingAwareMultiCommand;
 import org.opensearch.cli.Terminal;
+import org.opensearch.common.cli.LoggingAwareMultiCommand;
 
 /**
  * A CLI tool for managing secrets in the OpenSearch keystore.

diff --git a/.../common/settings/ListKeyStoreCommand.java → ...rch/cli/keystore/ListKeyStoreCommand.java b/.../common/settings/ListKeyStoreCommand.java → ...rch/cli/keystore/ListKeyStoreCommand.java
@@ -30,10 +30,11 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import joptsimple.OptionSet;
 import org.opensearch.cli.Terminal;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.env.Environment;
 
 import java.util.ArrayList;

diff --git a/...ettings/RemoveSettingKeyStoreCommand.java → ...eystore/RemoveSettingKeyStoreCommand.java b/...ettings/RemoveSettingKeyStoreCommand.java → ...eystore/RemoveSettingKeyStoreCommand.java
@@ -30,13 +30,14 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import joptsimple.OptionSet;
 import joptsimple.OptionSpec;
 import org.opensearch.cli.ExitCodes;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.env.Environment;
 
 import java.util.List;

diff --git a/...mmon/settings/UpgradeKeyStoreCommand.java → .../cli/keystore/UpgradeKeyStoreCommand.java b/...mmon/settings/UpgradeKeyStoreCommand.java → .../cli/keystore/UpgradeKeyStoreCommand.java
@@ -30,10 +30,11 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import joptsimple.OptionSet;
 import org.opensearch.cli.Terminal;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.env.Environment;
 
 /**
@@ -43,7 +44,7 @@
  */
 public class UpgradeKeyStoreCommand extends BaseKeyStoreCommand {
 
-    UpgradeKeyStoreCommand() {
+    public UpgradeKeyStoreCommand() {
         super("Upgrade the keystore format", true);
     }
 

diff --git a/...nsearch/common/settings/package-info.java → ...opensearch/cli/keystore/package-info.java b/...nsearch/common/settings/package-info.java → ...opensearch/cli/keystore/package-info.java
@@ -9,4 +9,4 @@
 /**
  * Classes implementing a CLI tool for managing secrets in the OpenSearch keystore.
  */
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
diff --git a/distribution/tools/keystore-cli/src/test/java/org/opensearch/bootstrap/BootstrapTests.java b/distribution/tools/keystore-cli/src/test/java/org/opensearch/bootstrap/BootstrapTests.java
@@ -31,7 +31,7 @@
 
 package org.opensearch.bootstrap;
 
-import org.opensearch.common.settings.KeyStoreCommandTestCase;
+import org.opensearch.cli.keystore.KeyStoreCommandTestCase;
 import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.common.settings.SecureSettings;
 import org.opensearch.common.settings.Settings;

diff --git a/...settings/AddFileKeyStoreCommandTests.java → ...keystore/AddFileKeyStoreCommandTests.java b/...settings/AddFileKeyStoreCommandTests.java → ...keystore/AddFileKeyStoreCommandTests.java
@@ -30,12 +30,13 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import org.opensearch.cli.Command;
 import org.opensearch.cli.ExitCodes;
 import org.opensearch.cli.UserException;
 import org.opensearch.common.collect.Tuple;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.env.Environment;
 
 import java.io.IOException;

diff --git a/...ttings/AddStringKeyStoreCommandTests.java → ...ystore/AddStringKeyStoreCommandTests.java b/...ttings/AddStringKeyStoreCommandTests.java → ...ystore/AddStringKeyStoreCommandTests.java
@@ -30,11 +30,12 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import org.opensearch.cli.Command;
 import org.opensearch.cli.ExitCodes;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.env.Environment;
 
 import java.io.ByteArrayInputStream;

diff --git a/...s/ChangeKeyStorePasswordCommandTests.java → ...e/ChangeKeyStorePasswordCommandTests.java b/...s/ChangeKeyStorePasswordCommandTests.java → ...e/ChangeKeyStorePasswordCommandTests.java
@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import org.opensearch.cli.Command;
 import org.opensearch.cli.ExitCodes;

diff --git a/.../settings/CreateKeyStoreCommandTests.java → .../keystore/CreateKeyStoreCommandTests.java b/.../settings/CreateKeyStoreCommandTests.java → .../keystore/CreateKeyStoreCommandTests.java
@@ -30,11 +30,12 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import org.opensearch.cli.Command;
 import org.opensearch.cli.ExitCodes;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.env.Environment;
 
 import java.nio.charset.StandardCharsets;

diff --git a/...ings/HasPasswordKeyStoreCommandTests.java → ...tore/HasPasswordKeyStoreCommandTests.java b/...ings/HasPasswordKeyStoreCommandTests.java → ...tore/HasPasswordKeyStoreCommandTests.java
@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import org.opensearch.cli.Command;
 import org.opensearch.cli.UserException;

diff --git a/...mon/settings/KeyStoreCommandTestCase.java → ...cli/keystore/KeyStoreCommandTestCase.java b/...mon/settings/KeyStoreCommandTestCase.java → ...cli/keystore/KeyStoreCommandTestCase.java
@@ -30,13 +30,17 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import com.google.common.jimfs.Configuration;
 import com.google.common.jimfs.Jimfs;
 import org.apache.lucene.tests.util.LuceneTestCase;
 import org.opensearch.cli.CommandTestCase;
+import org.opensearch.cli.KeystoreConstants;
+import org.opensearch.cli.MockTerminal;
 import org.opensearch.common.io.PathUtilsForTesting;
+import org.opensearch.common.settings.KeyStoreWrapper;
+import org.opensearch.common.settings.Settings;
 import org.opensearch.common.util.io.IOUtils;
 import org.opensearch.env.Environment;
 import org.opensearch.env.TestEnvironment;
@@ -137,4 +141,13 @@ void assertSecureFile(KeyStoreWrapper keystore, String setting, Path file) throw
         }
 
     }
+
+    public void testPasswordVerificationExceedingLimit() {
+        String longPassword = randomAlphaOfLength(KeystoreConstants.MAX_PASSPHRASE_LENGTH + 1);
+        MockTerminal terminal = new MockTerminal();
+        terminal.addTextInput(longPassword + "\n");
+
+        Exception e = expectThrows(Exception.class, () -> KeyStoreAwareCommand.readPassword(terminal, true));
+        assertTrue(e.getMessage().contains("Input exceeded maximum length"));
+    }
 }
diff --git a/...common/settings/KeyStoreWrapperTests.java → ...ch/cli/keystore/KeyStoreWrapperTests.java b/...common/settings/KeyStoreWrapperTests.java → ...ch/cli/keystore/KeyStoreWrapperTests.java
@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import org.apache.lucene.backward_codecs.store.EndiannessReverserUtil;
 import org.apache.lucene.codecs.CodecUtil;
@@ -39,6 +39,7 @@
 import org.apache.lucene.store.IndexOutput;
 import org.apache.lucene.store.NIOFSDirectory;
 import org.opensearch.common.Randomness;
+import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.common.util.io.IOUtils;
 import org.opensearch.core.common.settings.SecureString;
 import org.opensearch.env.Environment;

diff --git a/...on/settings/ListKeyStoreCommandTests.java → ...li/keystore/ListKeyStoreCommandTests.java b/...on/settings/ListKeyStoreCommandTests.java → ...li/keystore/ListKeyStoreCommandTests.java
@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import org.opensearch.cli.Command;
 import org.opensearch.cli.ExitCodes;

diff --git a/...gs/RemoveSettingKeyStoreCommandTests.java → ...re/RemoveSettingKeyStoreCommandTests.java b/...gs/RemoveSettingKeyStoreCommandTests.java → ...re/RemoveSettingKeyStoreCommandTests.java
@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.settings;
+package org.opensearch.cli.keystore;
 
 import org.opensearch.cli.Command;
 import org.opensearch.cli.ExitCodes;