Merge pull request #33124 from jacobwdv/JD_invalidArg

fixing invalid argument bug

Author: jacobwdv

dev/com.ibm.ws.security.utility/resources/com/ibm/ws/security/utility/resources/UtilityMessages.nlsprops

@@ -154,7 +154,7 @@ to your server.xml file:\n\
 \t<include location=\"{0}\" />
 generateaeskey.failFileExists=\
 The {0} file exists and will not be overwritten. Either specify a \n\
-different file name, or remove the existing file before you try again.\n\
+different file name, or remove the existing file before you try again.
 generateaeskey.failFileIsDirectory=\
 The {0} value specified for the file name is a directory. Specify the \n\
 full file name and try again.

dev/com.ibm.ws.security.utility/src/com/ibm/ws/security/utility/tasks/GenerateAesKeyTask.java

@@ -41,7 +41,7 @@ public class GenerateAesKeyTask extends BaseCommandTask {
     private static final List<String> VALID_ARGUMENTS = Collections.unmodifiableList(
                                                                                      Arrays.asList(BaseCommandTask.ARG_KEY, ARG_FILE));
 
-    private static final String TASK_NAME = "generateAESKey";
+    protected static final String TASK_NAME = "generateAESKey";
     private final IFileUtility fileUtil;
 
     /**
@@ -125,9 +125,10 @@ private CommandArguments parseArgs(String[] args, IFileUtility fileUtil) {
         String keyPhrase = null;
         String filePath = null;
 
-        for (String arg : args) {
+        for (int i = 1; i < args.length; i++) {
+            String arg = args[i];
             if (!arg.startsWith("--")) {
-                continue;
+                throw new IllegalArgumentException(getMessage("invalidArg", arg));
             }
 
             int index = arg.indexOf('=');

dev/com.ibm.ws.security.utility/test/com/ibm/ws/security/utility/tasks/GenerateAesKeyTest.java

@@ -58,7 +58,7 @@ public void testNoKeySpecifiedConfigFileSpecified() throws Exception {
 
         try (MockedStatic<PasswordEncryptionConfigBuilder> xmlBuilder = Mockito.mockStatic(PasswordEncryptionConfigBuilder.class, Mockito.CALLS_REAL_METHODS)) {
             String outfile = "/path/keys.xml";
-            generate.handleTask(stdin, stdout, stderr, new String[] { "--createConfigFile=" + outfile });
+            generate.handleTask(stdin, stdout, stderr, new String[] { GenerateAesKeyTask.TASK_NAME, "--createConfigFile=" + outfile });
             xmlBuilder.verify(() -> PasswordEncryptionConfigBuilder.generateRandomAes256Key(), times(1));
             xmlBuilder.verifyNoMoreInteractions();
             verify(fileUtil, times(1)).writeToFile(any(), anyString(), any());
@@ -77,7 +77,7 @@ public void testKeySpecifiedConfigFileSpecified() throws Exception {
         xml.append("    <variable name=\"").append(AESKeyManager.NAME_WLP_BASE64_AES_ENCRYPTION_KEY).append("\" value=\"").append(expectedKey).append("\" />\n");
         xml.append("</server>");
         try (MockedStatic<PasswordEncryptionConfigBuilder> xmlBuilder = Mockito.mockStatic(PasswordEncryptionConfigBuilder.class, Mockito.CALLS_REAL_METHODS)) {
-            generate.handleTask(stdin, stdout, stderr, new String[] { "--key=" + pass, "--createConfigFile=/path/keys.xml" });
+            generate.handleTask(stdin, stdout, stderr, new String[] { GenerateAesKeyTask.TASK_NAME, "--key=" + pass, "--createConfigFile=/path/keys.xml" });
             xmlBuilder.verify(() -> PasswordEncryptionConfigBuilder.generateAes256KeyWithPBKDF2(pass), times(1));
             xmlBuilder.verifyNoMoreInteractions();
             verify(fileUtil, times(1)).writeToFile(stderr, xml.toString(), new File(outFile));
@@ -90,7 +90,7 @@ public void testKeySpecifiedNoConfigFile() throws Exception {
         String pass = "passw0rd";
         String expectedKey = "lcJWjIt38ZjBBvYfNWLEgp/I0DQFTbFmA5zFl6zCU30=";
         try (MockedStatic<PasswordEncryptionConfigBuilder> xmlBuilder = Mockito.mockStatic(PasswordEncryptionConfigBuilder.class, Mockito.CALLS_REAL_METHODS)) {
-            generate.handleTask(stdin, stdout, stderr, new String[] { "--key=" + pass });
+            generate.handleTask(stdin, stdout, stderr, new String[] { GenerateAesKeyTask.TASK_NAME, "--key=" + pass });
             xmlBuilder.verify(() -> PasswordEncryptionConfigBuilder.generateAes256KeyWithPBKDF2(pass), times(1));
             xmlBuilder.verifyNoMoreInteractions();
             verify(stdout, times(1)).println(expectedKey);
@@ -101,7 +101,7 @@ public void testKeySpecifiedNoConfigFile() throws Exception {
     public void testNoKeyNoConfigFile() throws Exception {
 
         try (MockedStatic<PasswordEncryptionConfigBuilder> xmlBuilder = Mockito.mockStatic(PasswordEncryptionConfigBuilder.class, Mockito.CALLS_REAL_METHODS)) {
-            generate.handleTask(stdin, stdout, stderr, new String[] {});
+            generate.handleTask(stdin, stdout, stderr, new String[] { GenerateAesKeyTask.TASK_NAME, });
             xmlBuilder.verify(() -> PasswordEncryptionConfigBuilder.generateRandomAes256Key(), times(1));
             xmlBuilder.verifyNoMoreInteractions();
             verify(stdout, times(1)).println(anyString());
@@ -112,11 +112,40 @@ public void testNoKeyNoConfigFile() throws Exception {
     public void testEmptyKey() throws Exception {
 
         try (MockedStatic<PasswordEncryptionConfigBuilder> xmlBuilder = Mockito.mockStatic(PasswordEncryptionConfigBuilder.class, Mockito.CALLS_REAL_METHODS)) {
-            generate.handleTask(stdin, stdout, stderr, new String[] { "--key=" });
+            generate.handleTask(stdin, stdout, stderr, new String[] { GenerateAesKeyTask.TASK_NAME, "--key=" });
             fail("task should throw an exception if key isn't specified");
         } catch (IllegalArgumentException iae) {
             assertEquals("Wrong message returned when specifying an empty key.", BaseCommandTask.getMessage("missingValue", "--key"), iae.getMessage());
         }
     }
 
+    @Test
+    public void testUnknownArg() {
+        String unknownArg = "testarg=abc";
+
+        try {
+            generate.handleTask(stdin, stdout, stderr, new String[] { GenerateAesKeyTask.TASK_NAME, unknownArg });
+            fail("task should output invalidArg message");
+        } catch (Exception e) {
+            System.out.println(e.getMessage());
+            assertEquals("Wrong message returned when specifying an empty key.", BaseCommandTask.getMessage("invalidArg", unknownArg), e.getMessage());
+
+        }
+    }
+
+    @Test
+    public void testUnknownParam() {
+        String badParam = "--testarg";
+        String unknownArg = badParam + "=abc";
+
+        try {
+            generate.handleTask(stdin, stdout, stderr, new String[] { GenerateAesKeyTask.TASK_NAME, unknownArg });
+            fail("task should output invalidArg message");
+        } catch (Exception e) {
+            System.out.println(e.getMessage());
+            assertEquals("Wrong message returned when specifying an empty key.", BaseCommandTask.getMessage("invalidArg", badParam), e.getMessage());
+
+        }
+    }
+
 }