client: Export Client Map

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

@@ -23,8 +23,10 @@
 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.Writer;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
@@ -57,6 +59,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 +85,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;
@@ -291,6 +295,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));
         }
     }
 
@@ -863,4 +874,19 @@ public void sessionModeChanged(Mode mode) {
             }
         }
     }
+
+    public void exportClientMap(File file) {
+        try (Writer fileWriter = new FileWriter(file, false)) {
+            ClientMapWriter.exportClientMap(fileWriter, clientTree);
+        } catch (IOException e) {
+            LOGGER.warn(
+                    "Failed to create file writer for: {}, while exporting Client Map",
+                    file.getAbsolutePath(),
+                    e);
+        }
+    }
+
+    public void exportClientMap(String path) {
+        this.exportClientMap(new File(path));
+    }
 }

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

@@ -185,11 +185,11 @@ public ClientNode setRedirect(String originalUrl, String redirectedUrl) {
                     .addComponent(
                             new ClientSideComponent(
                                     Map.of(),
-                                    ClientSideComponent.REDIRECT,
+                                    ClientSideComponent.Type.REDIRECT.getName(),
                                     null,
                                     originalUrl,
                                     redirectedUrl,
-                                    ClientSideComponent.REDIRECT,
+                                    ClientSideComponent.Type.REDIRECT.getName(),
                                     null,
                                     null,
                                     -1));
@@ -220,11 +220,11 @@ public ClientNode setContentLoaded(String url) {
                 .addComponent(
                         new ClientSideComponent(
                                 Map.of(),
-                                ClientSideComponent.CONTENT_LOADED,
+                                ClientSideComponent.Type.CONTENTLOADED.getName(),
                                 null,
                                 null,
                                 null,
-                                ClientSideComponent.CONTENT_LOADED,
+                                ClientSideComponent.Type.CONTENTLOADED.getName(),
                                 null,
                                 null,
                                 -1));

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

@@ -0,0 +1,182 @@
+/*
+ * 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.File;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.io.Writer;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+import org.parosproxy.paros.control.Control;
+import org.zaproxy.addon.client.ExtensionClientIntegration;
+import org.zaproxy.zap.utils.Stats;
+
+public final class ClientMapWriter {
+
+    private static final String NODE_KEY = "node";
+    private static final String ROOT_NODE_NAME = "ClientMap";
+    private static final String CHILDREN_KEY = "children";
+    private static final String STORAGE_KEY = "storage";
+    private static final String VISITED_KEY = "visited";
+
+    private static final List<ClientSideComponent.Type> COMPONENT_TYPES_TO_SKIP =
+            List.of(ClientSideComponent.Type.REDIRECT, ClientSideComponent.Type.CONTENTLOADED);
+
+    ClientMapWriter() {}
+
+    public static void exportClientMap(File file) throws IOException {
+        Control.getSingleton()
+                .getExtensionLoader()
+                .getExtension(ExtensionClientIntegration.class)
+                .exportClientMap(file);
+    }
+
+    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() != null
+                        && component.getType().equals(ClientSideComponent.Type.REDIRECT)) {
+                    outputKV(
+                            fw, indent, false, component.getType().getLabel(), component.getHref());
+                } else if (component.getType() != null
+                        && component.getType().equals(ClientSideComponent.Type.CONTENTLOADED)) {
+                    outputKV(fw, indent, false, component.getType().getLabel(), true);
+                }
+            }
+            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:\n");
+        indent = " ".repeat((level + 1) * 2);
+
+        LinkedHashSet<ClientSideComponent> sortedComponents =
+                components.stream().sorted().collect(Collectors.toCollection(LinkedHashSet::new));
+        for (ClientSideComponent component : sortedComponents) {
+            boolean first = true;
+            if ((component.getType() != null
+                    && COMPONENT_TYPES_TO_SKIP.contains(component.getType()))) {
+                continue;
+            }
+            first = outputKV(fw, indent, first, "nodeType", component.getType().getLabel());
+            String href =
+                    component.getHref() == null ? component.getParentUrl() : component.getHref();
+            first = outputKV(fw, indent, first, "href", href);
+            if (!component.isStorageEvent()) {
+                first = outputKV(fw, indent, first, "text", component.getText());
+            }
+            first = outputKV(fw, indent, first, "id", component.getId());
+            first = outputKV(fw, indent, first, "tagName", component.getTagName());
+            first = outputKV(fw, indent, first, "tagType", component.getTagType());
+            if (component.getFormId() != -1) {
+                first = outputKV(fw, indent, first, "formId", component.getFormId());
+            }
+            if (component.isStorageEvent()) {
+                outputKV(fw, indent, first, "storageEvent", component.isStorageEvent());
+            }
+        }
+        return indent;
+    }
+}