Replacer: Support automation framework

Signed-off-by: Simon Bennetts <[email protected]>
zaproxy · Sep 6, 2023 · 912ab82 · 912ab82
1 parent ed8f046
commit 912ab82
Show file tree

Hide file tree

Showing 25 changed files with 1,645 additions and 40 deletions.
diff --git a/addOns/automation/CHANGELOG.md b/addOns/automation/CHANGELOG.md
@@ -17,6 +17,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Fixed
 - Address error logged when using the Active Scan job.
 - Do not fail to load plans without jobs.
+- Support converting Lists to arrays when updating objects.
 
 ## [0.30.0] - 2023-07-11
 ### Changed

diff --git a/addOns/automation/src/main/java/org/zaproxy/addon/automation/AutomationJob.java b/addOns/automation/src/main/java/org/zaproxy/addon/automation/AutomationJob.java
@@ -226,18 +226,16 @@ public void reset() {
     }
 
     public void applyParameters(AutomationProgress progress) {
-        verifyOrApplyParameters(
-                this.getParamMethodObject(), this.getParamMethodName(), progress, false);
+        verifyOrApplyParameters(this.getParamMethodName(), progress, false);
     }
 
     public void verifyParameters(AutomationProgress progress) {
-        verifyOrApplyParameters(
-                this.getParamMethodObject(), this.getParamMethodName(), progress, true);
+        verifyOrApplyParameters(this.getParamMethodName(), progress, true);
     }
 
     @SuppressWarnings({"unchecked", "rawtypes"})
     void verifyOrApplyParameters(
-            Object obj, String optionsGetterName, AutomationProgress progress, boolean verify) {
+            String optionsGetterName, AutomationProgress progress, boolean verify) {
         if (this.jobData == null) {
             return;
         }
@@ -270,7 +268,7 @@ void verifyOrApplyParameters(
                 progress.error(
                         Constant.messages.getString(
                                 "automation.error.options.methods",
-                                obj.getClass().getCanonicalName(),
+                                options.getClass().getCanonicalName(),
                                 optionsGetterName,
                                 e1.getMessage()));
                 return;
@@ -353,15 +351,15 @@ void verifyOrApplyParameters(
                                     progress.error(
                                             Constant.messages.getString(
                                                     "automation.error.options.badcall",
-                                                    obj.getClass().getCanonicalName(),
+                                                    options.getClass().getCanonicalName(),
                                                     paramMethodName,
                                                     e.getMessage()));
                                 }
                             } else {
                                 progress.error(
                                         Constant.messages.getString(
                                                 "automation.error.options.badtype",
-                                                obj.getClass().getCanonicalName(),
+                                                options.getClass().getCanonicalName(),
                                                 paramMethodName,
                                                 optMethod.getParameterTypes()[0]
                                                         .getCanonicalName()));

diff --git a/addOns/automation/src/main/java/org/zaproxy/addon/automation/jobs/JobUtils.java b/addOns/automation/src/main/java/org/zaproxy/addon/automation/jobs/JobUtils.java
@@ -21,6 +21,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.lang.reflect.Array;
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 import java.nio.file.Files;
@@ -442,7 +443,7 @@ private static Class<?> toBaseClass(Class<?> origClass) {
     }
 
     @SuppressWarnings({"unchecked", "rawtypes"})
-    static <T> T objectToType(Object obj, T t) {
+    static <T> T objectToType(Object obj, Class<?> t) {
         if (String.class.equals(t)) {
             return (T) obj.toString();
         } else if (Integer.class.equals(t) || int.class.equals(t)) {
@@ -469,7 +470,7 @@ static <T> T objectToType(Object obj, T t) {
 
         } else if (List.class.equals(t)) {
             if (obj instanceof List) {
-                List<String> list = new ArrayList<>();
+                List<T> list = new ArrayList<>();
                 list.addAll((ArrayList) obj);
                 return (T) list;
             } else {
@@ -483,8 +484,29 @@ static <T> T objectToType(Object obj, T t) {
             }
             throw new IllegalArgumentException(
                     "Enum value must be one of " + EnumUtils.getEnumList((Class<Enum>) t));
+        } else if (t.isArray()) {
+            if (obj instanceof List) {
+                List objList = (List) obj;
+                try {
+                    // This is nasty, but it works ;)
+                    String arrayClassName = t.getCanonicalName();
+                    String arrayBaseClassName =
+                            arrayClassName.substring(0, arrayClassName.length() - 2);
+                    T[] array =
+                            (T[])
+                                    Array.newInstance(
+                                            Class.forName(arrayBaseClassName), objList.size());
+                    objList.toArray(array);
+                    return (T) array;
+                } catch (Exception e) {
+                    LOGGER.error("Unable to map to an array from a list", e);
+                    return null;
+                }
+            } else {
+                LOGGER.error(
+                        "Unable to map to an array from {}", obj.getClass().getCanonicalName());
+            }
         }
-
         return null;
     }
 

diff --git a/addOns/automation/src/test/java/org/zaproxy/addon/automation/AutomationJobUnitTest.java b/addOns/automation/src/test/java/org/zaproxy/addon/automation/AutomationJobUnitTest.java
@@ -990,22 +990,21 @@ void shouldIgnoreUnsetParams() {
         assertThat(progress.hasWarnings(), is(equalTo(false)));
     }
 
-    @SuppressWarnings({"unchecked", "rawtypes"})
     @Test
     void shouldFailOnBadOptionsGetterName() {
         // Given
         TestParamContainer tpc = new TestParamContainer();
         AutomationJob job = new AutomationJobImpl(tpc, "getBadTestParam");
         AutomationProgress progress = new AutomationProgress();
 
-        Map map = new HashMap();
-        LinkedHashMap<?, ?> params = new LinkedHashMap(map);
-        LinkedHashMap<String, Object> jobData = new LinkedHashMap();
+        Map<?, ?> map = new HashMap<>();
+        LinkedHashMap<?, ?> params = new LinkedHashMap<>(map);
+        LinkedHashMap<String, Object> jobData = new LinkedHashMap<>();
         jobData.put("parameters", params);
 
         // When
         job.setJobData(jobData);
-        job.verifyOrApplyParameters(tpc, "getBadTestParam", progress, false);
+        job.verifyOrApplyParameters("getBadTestParam", progress, false);
 
         // Then
         assertThat(progress.hasErrors(), is(equalTo(true)));
@@ -1014,6 +1013,26 @@ void shouldFailOnBadOptionsGetterName() {
         assertThat(progress.getErrors().get(0), is(equalTo("!automation.error.options.method!")));
     }
 
+    @Test
+    void shouldNotFailToVerifyIfNoObject() {
+        // Given
+        AutomationJob job = new AutomationJobImpl(null, "getNullParam");
+        AutomationProgress progress = new AutomationProgress();
+
+        Map<?, ?> map = new HashMap<>();
+        LinkedHashMap<?, ?> params = new LinkedHashMap<>(map);
+        LinkedHashMap<String, Object> jobData = new LinkedHashMap<>();
+        jobData.put("parameters", params);
+
+        // When
+        job.setJobData(jobData);
+        job.verifyOrApplyParameters("getBadTestParam", progress, false);
+
+        // Then
+        assertThat(progress.hasErrors(), is(equalTo(false)));
+        assertThat(progress.hasWarnings(), is(equalTo(false)));
+    }
+
     @Test
     void shouldReturnDefaultConfigFileData() {
         // Given

diff --git a/addOns/automation/src/test/java/org/zaproxy/addon/automation/jobs/JobUtilsUnitTest.java b/addOns/automation/src/test/java/org/zaproxy/addon/automation/jobs/JobUtilsUnitTest.java
@@ -33,8 +33,10 @@
 
 import java.io.File;
 import java.nio.file.Paths;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import org.junit.jupiter.api.BeforeAll;
@@ -198,6 +200,17 @@ void shouldApplyObjectToType() {
         Object enumBBB = JobUtils.objectToType("bbB", enumeration.class);
         Object map = JobUtils.objectToType(hmap, Map.class);
 
+        Class<String[]> stringArrayClass = String[].class;
+        List<String> strList = new ArrayList<>();
+        strList.add("str");
+        Object strArray = JobUtils.objectToType(strList, stringArrayClass);
+
+        Class<Integer[]> intArrayClass = Integer[].class;
+        List<Integer> intList = new ArrayList<>();
+        intList.add(3);
+        intList.add(9);
+        Object intArray = JobUtils.objectToType(intList, intArrayClass);
+
         // Then
         assertThat(string, is(equalTo("string")));
         assertThat(integer5, is(equalTo(5)));
@@ -212,6 +225,13 @@ void shouldApplyObjectToType() {
         assertThat(enumBBB, is(equalTo(enumeration.bbb)));
         assertThat(map.getClass(), is(equalTo(HashMap.class)));
         assertThat(((Map<?, ?>) map).size(), is(equalTo(2)));
+        assertThat(strArray.getClass(), is(equalTo(stringArrayClass)));
+        assertThat(((String[]) strArray).length, is(equalTo(1)));
+        assertThat(((String[]) strArray)[0], is(equalTo("str")));
+        assertThat(intArray.getClass(), is(equalTo(intArrayClass)));
+        assertThat(((Integer[]) intArray).length, is(equalTo(2)));
+        assertThat(((Integer[]) intArray)[0], is(equalTo(3)));
+        assertThat(((Integer[]) intArray)[1], is(equalTo(9)));
     }
 
     @Test

diff --git a/addOns/replacer/CHANGELOG.md b/addOns/replacer/CHANGELOG.md
@@ -4,6 +4,9 @@ All notable changes to this add-on will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased
+### Added
+- Support for the Automation Framework (Issue 7686).
+
 ### Changed
 - Document that Token Processing applies just to string match types and disable the field in
 the dialogue when other match types are selected.

diff --git a/addOns/replacer/replacer.gradle.kts b/addOns/replacer/replacer.gradle.kts
@@ -9,6 +9,21 @@ zapAddOn {
     manifest {
         author.set("ZAP Dev Team")
         url.set("https://www.zaproxy.org/docs/desktop/addons/replacer/")
+        extensions {
+            register("org.zaproxy.zap.extension.replacer.automation.ExtensionReplacerAutomation") {
+                classnames {
+                    allowed.set(listOf("org.zaproxy.zap.extension.replacer.automation"))
+                }
+                dependencies {
+                    addOns {
+                        register("automation") {
+                            version.set(">=0.31.0")
+                        }
+                        register("commonlib")
+                    }
+                }
+            }
+        }
     }
 
     apiClientGen {
@@ -18,5 +33,7 @@ zapAddOn {
 }
 
 dependencies {
+    zapAddOn("automation")
+    zapAddOn("commonlib")
     testImplementation(project(":testutils"))
 }
diff --git a/addOns/replacer/src/main/java/org/zaproxy/zap/extension/replacer/OptionsReplacerPanel.java b/addOns/replacer/src/main/java/org/zaproxy/zap/extension/replacer/OptionsReplacerPanel.java
@@ -140,7 +140,6 @@ public ReplacerParamRule showAddDialogue() {
                         new ReplaceRuleAddDialog(
                                 (Window) View.getSingleton().getOptionsDialog(null),
                                 "replacer.add.title",
-                                replacerParam,
                                 (OptionsReplacerTableModel) model);
                 addDialog.pack();
             }
@@ -157,7 +156,6 @@ public ReplacerParamRule showModifyDialogue(ReplacerParamRule r) {
                         new ReplaceRuleModifyDialog(
                                 (Window) View.getSingleton().getOptionsDialog(null),
                                 "replacer.modify.title",
-                                replacerParam,
                                 (OptionsReplacerTableModel) model);
                 modifyDialog.pack();
             }

diff --git a/addOns/replacer/src/main/java/org/zaproxy/zap/extension/replacer/ReplaceRuleAddDialog.java b/addOns/replacer/src/main/java/org/zaproxy/zap/extension/replacer/ReplaceRuleAddDialog.java
@@ -25,6 +25,7 @@
 import java.util.List;
 import java.util.regex.Pattern;
 import java.util.regex.PatternSyntaxException;
+import javax.swing.JCheckBox;
 import org.parosproxy.paros.Constant;
 import org.parosproxy.paros.network.HttpSender;
 import org.zaproxy.zap.extension.replacer.ReplacerParamRule.MatchType;
@@ -63,17 +64,12 @@ public class ReplaceRuleAddDialog extends StandardFieldsDialog {
     protected static final String INIT_TYPE_USER_FIELD = "replacer.label.init.user";
     protected static final String INIT_TYPE_TOKEN_GEN_FIELD = "replacer.label.init.tokengen";
 
-    private ReplacerParam replacerParam;
     private ReplacerParamRule rule;
     private OptionsReplacerTableModel replacerModel;
 
     public ReplaceRuleAddDialog(
-            Window owner,
-            String title,
-            ReplacerParam replacerParam,
-            OptionsReplacerTableModel replacerModel) {
+            Window owner, String title, OptionsReplacerTableModel replacerModel) {
         super(owner, title, DisplayUtils.getScaledDimension(500, 350), ADV_TAB_LABELS, true);
-        this.replacerParam = replacerParam;
         this.replacerModel = replacerModel;
         initFields();
     }
@@ -175,14 +171,6 @@ public OptionsReplacerTableModel getReplacerModel() {
         return this.replacerModel;
     }
 
-    public ReplacerParam getReplacerParam() {
-        return replacerParam;
-    }
-
-    public void setReplacerParam(ReplacerParam replacerParam) {
-        this.replacerParam = replacerParam;
-    }
-
     private void setRule(ReplacerParamRule rule, MatchType selectedMatchType) {
         this.rule = rule;
         if (rule != null) {
@@ -299,7 +287,10 @@ public void saveImpl() {
     }
 
     protected String checkIfUnique() {
-        if (this.replacerModel.containsRule(this.getStringValue(DESC_FIELD))) {
+        // this.replacerModel will be null when used with the AF - plans may be run on other systems
+        // or delete all existing rules
+        if (this.replacerModel != null
+                && this.replacerModel.containsRule(this.getStringValue(DESC_FIELD))) {
             return Constant.messages.getString("replacer.add.warning.existdesc");
         }
         return null;
@@ -492,12 +483,31 @@ private ReplacerParamRule.MatchType getSelectedMatchType() {
         }
     }
 
+    /**
+     * Allows callers to specify that rules added will always be enabled.
+     *
+     * @param enableEnabled
+     */
+    public void setEnableEnabled(boolean enableEnabled) {
+        JCheckBox enabledField = (JCheckBox) this.getField(ENABLE_FIELD);
+        if (!enableEnabled) {
+            enabledField.setSelected(true);
+        }
+        enabledField.setEnabled(enableEnabled);
+    }
+
     public void clear() {
         this.rule = null;
+        setEnableEnabled(true);
         this.setFieldValue(DESC_FIELD, "");
         this.setFieldValue(MATCH_STR_FIELD, "");
         this.setFieldValue(REPLACEMENT_FIELD, "");
         this.setFieldValue(ENABLE_FIELD, false);
         this.setFieldValue(ENABLE_TOKEN_PROCESSING, false);
     }
+
+    @Override
+    public String getHelpIndex() {
+        return "replacer";
+    }
 }
diff --git a/...ns/replacer/src/main/java/org/zaproxy/zap/extension/replacer/ReplaceRuleModifyDialog.java b/...ns/replacer/src/main/java/org/zaproxy/zap/extension/replacer/ReplaceRuleModifyDialog.java
@@ -29,11 +29,8 @@ public class ReplaceRuleModifyDialog extends ReplaceRuleAddDialog {
     private String originalDesc;
 
     public ReplaceRuleModifyDialog(
-            Window owner,
-            String title,
-            ReplacerParam replacerParam,
-            OptionsReplacerTableModel replacerModel) {
-        super(owner, title, replacerParam, replacerModel);
+            Window owner, String title, OptionsReplacerTableModel replacerModel) {
+        super(owner, title, replacerModel);
     }
 
     @Override

diff --git a/addOns/replacer/src/main/java/org/zaproxy/zap/extension/replacer/ReplacerParam.java b/addOns/replacer/src/main/java/org/zaproxy/zap/extension/replacer/ReplacerParam.java
@@ -184,6 +184,11 @@ public void setRules(List<ReplacerParamRule> rules) {
         saveRules();
     }
 
+    public void clearRules() {
+        this.rules = new ArrayList<>();
+        saveRules();
+    }
+
     private void saveRules() {
 
         ((HierarchicalConfiguration) getConfig()).clearTree(ALL_RULES_KEY);

diff --git a/addOns/replacer/src/main/java/org/zaproxy/zap/extension/replacer/ReplacerParamRule.java b/addOns/replacer/src/main/java/org/zaproxy/zap/extension/replacer/ReplacerParamRule.java
@@ -120,7 +120,9 @@ public ReplacerParamRule(
         this.matchType = matchType;
         this.matchString = matchString;
         this.matchRegex = matchRegex;
-        this.escapedReplacement = HexString.compile(replacement);
+        if (replacement != null) {
+            this.escapedReplacement = HexString.compile(replacement);
+        }
         this.replacement = replacement;
         this.initiators = initiators;
         this.tokenProcessingEnabled = tokenProcessingEnabled;