client: Export Client Map

addOns/client/CHANGELOG.md

@@ -10,6 +10,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Changed
 - Updated Chrome and Firefox extensions to v0.0.11.
 
+### Added
+- A context menu allowing users to Export Client Map.
+
 ## [0.10.0] - 2025-01-10
 ### Changed
 - Update minimum ZAP version to 2.16.0.

addOns/client/src/main/java/org/zaproxy/addon/client/ExtensionClientIntegration.java

@@ -23,8 +23,11 @@
 import java.awt.event.InputEvent;
 import java.awt.event.KeyEvent;
 import java.io.File;
+import java.io.FileWriter;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.UncheckedIOException;
+import java.io.Writer;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
@@ -57,6 +60,7 @@
 import org.parosproxy.paros.view.View;
 import org.zaproxy.addon.client.impl.ClientZestRecorder;
 import org.zaproxy.addon.client.internal.ClientMap;
+import org.zaproxy.addon.client.internal.ClientMapWriter;
 import org.zaproxy.addon.client.internal.ClientNode;
 import org.zaproxy.addon.client.internal.ClientSideComponent;
 import org.zaproxy.addon.client.internal.ClientSideDetails;
@@ -82,6 +86,7 @@
 import org.zaproxy.addon.client.ui.PopupMenuClientHistoryCopy;
 import org.zaproxy.addon.client.ui.PopupMenuClientOpenInBrowser;
 import org.zaproxy.addon.client.ui.PopupMenuClientShowInSites;
+import org.zaproxy.addon.client.ui.PopupMenuExportClientMap;
 import org.zaproxy.addon.commonlib.ExtensionCommonlib;
 import org.zaproxy.addon.network.ExtensionNetwork;
 import org.zaproxy.zap.ZAP;
@@ -97,6 +102,7 @@
 import org.zaproxy.zap.model.Target;
 import org.zaproxy.zap.users.User;
 import org.zaproxy.zap.utils.DisplayUtils;
+import org.zaproxy.zap.utils.Stats;
 import org.zaproxy.zap.utils.ThreadUtils;
 import org.zaproxy.zap.view.ScanStatus;
 import org.zaproxy.zap.view.ZapMenuItem;
@@ -122,6 +128,7 @@ public class ExtensionClientIntegration extends ExtensionAdaptor {
                     ExtensionHistory.class,
                     ExtensionNetwork.class,
                     ExtensionSelenium.class);
+    private static final String STATS_EXPORT_CLIENTMAP = PREFIX + ".export.clientmap";
 
     private ClientMap clientTree;
     private ClientMapPanel clientMapPanel;
@@ -291,6 +298,13 @@ public void hook(ExtensionHook extensionHook) {
                     .getMainFrame()
                     .getMainFooterPanel()
                     .addFooterToolbarRightComponent(pscanStatus.getCountLabel());
+
+            extensionHook
+                    .getHookMenu()
+                    .addPopupMenuItem(
+                            new PopupMenuExportClientMap(
+                                    Constant.messages.getString("client.tree.popup.export.menu"),
+                                    this));
         }
     }
 
@@ -867,4 +881,23 @@ public void sessionModeChanged(Mode mode) {
             }
         }
     }
+
+    public void exportClientMap(String path) {
+        File file = new File(path);
+        try (Writer fileWriter = new FileWriter(file, false)) {
+            ClientMapWriter.exportClientMap(fileWriter, clientTree);
+        } catch (IOException | UncheckedIOException e) {
+            LOGGER.warn(
+                    "An error occurred while exporting the Client Map: {}",
+                    file.getAbsolutePath(),
+                    e);
+            if (hasView()) {
+                this.getView()
+                        .showWarningDialog(
+                                Constant.messages.getString(
+                                        "client.tree.export.error", file.getAbsolutePath()));
+            }
+        }
+        Stats.incCounter(STATS_EXPORT_CLIENTMAP);
+    }
 }

addOns/client/src/main/java/org/zaproxy/addon/client/internal/ClientMap.java

@@ -190,7 +190,7 @@ public ClientNode setRedirect(String originalUrl, String redirectedUrl) {
                                     originalUrl,
                                     redirectedUrl,
                                     ClientSideComponent.REDIRECT,
-                                    null,
+                                    ClientSideComponent.Type.REDIRECT,
                                     null,
                                     -1));
             return node;
@@ -225,7 +225,7 @@ public ClientNode setContentLoaded(String url) {
                                 null,
                                 null,
                                 ClientSideComponent.CONTENT_LOADED,
-                                null,
+                                ClientSideComponent.Type.CONTENT_LOADED,
                                 null,
                                 -1));
 

addOns/client/src/main/java/org/zaproxy/addon/client/internal/ClientMapWriter.java

@@ -0,0 +1,184 @@
+/*
+ * Zed Attack Proxy (ZAP) and its related class files.
+ *
+ * ZAP is an HTTP/HTTPS proxy for assessing web application security.
+ *
+ * Copyright 2025 The ZAP Development Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.zaproxy.addon.client.internal;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature;
+import java.io.BufferedWriter;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.io.Writer;
+import java.util.List;
+import java.util.Set;
+import java.util.SortedSet;
+import java.util.TreeSet;
+import org.zaproxy.addon.client.ExtensionClientIntegration;
+import org.zaproxy.zap.utils.Stats;
+
+public final class ClientMapWriter {
+
+    private static final String CHILDREN_KEY = "children";
+    private static final String COMPONENTS_KEY = "components";
+    private static final String FORM_ID_KEY = "formId";
+    private static final String HREF_KEY = "href";
+    private static final String ID_KEY = "id";
+    private static final String NODE_TYPE_KEY = "nodeType";
+    private static final String NODE_KEY = "node";
+    private static final String ROOT_NODE_NAME = "ClientMap";
+    private static final String STORAGE_EVENT_KEY = "storageEvent";
+    private static final String STORAGE_KEY = "storage";
+    private static final String TAG_NAME_KEY = "tagName";
+    private static final String TAG_TYPE_KEY = "tagType";
+    private static final String TEXT_KEY = "text";
+    private static final String VISITED_KEY = "visited";
+
+    private static final List<ClientSideComponent.Type> COMPONENT_TYPES_TO_SKIP =
+            List.of(ClientSideComponent.Type.REDIRECT, ClientSideComponent.Type.CONTENT_LOADED);
+
+    ClientMapWriter() {}
+
+    public static void exportClientMap(Writer fw, ClientMap clientMap) throws IOException {
+        try (BufferedWriter bw = new BufferedWriter(fw)) {
+            outputNode(bw, clientMap.getRoot(), 0);
+        }
+    }
+
+    private static boolean outputKV(
+            Writer fw, String indent, boolean first, String key, Object value) throws IOException {
+        if (value == null) {
+            return first;
+        }
+        fw.write(indent);
+        if (first) {
+            fw.write("- ");
+        } else {
+            fw.write("  ");
+        }
+        fw.write(key);
+        fw.write(": ");
+        ObjectMapper mapper =
+                new ObjectMapper(
+                        new YAMLFactory()
+                                .enable(Feature.LITERAL_BLOCK_STYLE)
+                                .disable(Feature.WRITE_DOC_START_MARKER));
+        // For some reason the disable start marker doesn't seem to work
+        String output = mapper.writeValueAsString(value).replace("--- ", "");
+        fw.write(output);
+        return false;
+    }
+
+    private static void outputNode(Writer fw, ClientNode node, int level) throws IOException {
+        if (node.isStorage()) {
+            // Skip storage nodes in the tree
+            // Those details are represented as components of their source
+            return;
+        }
+        // We could create a set of data structures and use jackson, but the format is very
+        // simple - it still uses jackson for value output
+        String indent = " ".repeat(level * 2);
+
+        outputKV(
+                fw,
+                indent,
+                true,
+                NODE_KEY,
+                level == 0 ? ROOT_NODE_NAME : node.getUserObject().getName());
+
+        if (node.getUserObject().isStorage()) {
+            outputKV(fw, indent, false, STORAGE_KEY, node.getUserObject().isStorage());
+        }
+        if (!node.getUserObject().isVisited()) {
+            outputKV(fw, indent, false, VISITED_KEY, node.getUserObject().isVisited());
+        }
+        if (node.getUserObject().getComponents() != null
+                && !node.getUserObject().getComponents().isEmpty()) {
+            for (ClientSideComponent component : node.getUserObject().getComponents()) {
+                if (component.getType() == ClientSideComponent.Type.REDIRECT) {
+                    outputKV(
+                            fw, indent, false, component.getType().getLabel(), component.getHref());
+                } else if (component.getType() == ClientSideComponent.Type.CONTENT_LOADED) {
+                    outputKV(fw, indent, false, component.getType().getLabel(), true);
+                }
+            }
+            synchronized (node.getUserObject().getComponents()) {
+                indent = outputComponents(fw, node.getUserObject().getComponents(), level, indent);
+            }
+        }
+
+        Stats.incCounter(ExtensionClientIntegration.PREFIX + ".export.clientmap.node");
+
+        if (node.getChildCount() > 0) {
+            fw.write(indent);
+            fw.write("  ");
+            fw.write(CHILDREN_KEY);
+            fw.write(":");
+            fw.write('\n');
+            node.children()
+                    .asIterator()
+                    .forEachRemaining(
+                            c -> {
+                                try {
+                                    outputNode(fw, (ClientNode) c, level + 1);
+                                } catch (IOException e) {
+                                    throw new UncheckedIOException(e);
+                                }
+                            });
+        }
+    }
+
+    private static String outputComponents(
+            Writer fw, Set<ClientSideComponent> components, int level, String indent)
+            throws IOException {
+        fw.write(indent);
+        fw.write("  ");
+        fw.write(COMPONENTS_KEY);
+        fw.write(":\n");
+
+        indent = " ".repeat((level + 1) * 2);
+
+        SortedSet<ClientSideComponent> sortedComponents = new TreeSet<>(components);
+
+        for (ClientSideComponent component : sortedComponents) {
+            boolean first = true;
+            if ((component.getType() != null
+                    && COMPONENT_TYPES_TO_SKIP.contains(component.getType()))) {
+                continue;
+            }
+            first = outputKV(fw, indent, first, NODE_TYPE_KEY, component.getType().getLabel());
+            String href =
+                    component.getHref() == null ? component.getParentUrl() : component.getHref();
+            first = outputKV(fw, indent, first, HREF_KEY, href);
+            if (!component.isStorageEvent()) {
+                first = outputKV(fw, indent, first, TEXT_KEY, component.getText());
+            }
+            first = outputKV(fw, indent, first, ID_KEY, component.getId());
+            first = outputKV(fw, indent, first, TAG_NAME_KEY, component.getTagName());
+            first = outputKV(fw, indent, first, TAG_TYPE_KEY, component.getTagType());
+            if (component.getFormId() != -1) {
+                first = outputKV(fw, indent, first, FORM_ID_KEY, component.getFormId());
+            }
+            if (component.isStorageEvent()) {
+                outputKV(fw, indent, first, STORAGE_EVENT_KEY, component.isStorageEvent());
+            }
+        }
+        return indent;
+    }
+}