diff --git a/docs/README.md b/docs/README.md index 7b40b951c..bc2d414aa 100644 --- a/docs/README.md +++ b/docs/README.md @@ -72,6 +72,9 @@ Unified error response format across all GNS3 API endpoints. Documents HTTP stat ### Web Wireshark (`features/web-wireshark-business-process.md`) Web-based packet capture analysis using Docker + xpra HTML5 client. Zero-install Wireshark experience directly in the browser, integrated with GNS3 topologies. +### Marker (Traffic Insight) (`features/marker-traffic-insight.md`) +Real-time traffic insight via per-link BPF markers and project-level inherited definitions. A marker taps a link in uBridge, emitting match notifications and pcap capture on BPF hit; definitions fan out to every capable link automatically. + --- ## GNS3 AI Copilot (`gns3-copilot/`) diff --git a/docs/features/marker-traffic-insight.md b/docs/features/marker-traffic-insight.md new file mode 100644 index 000000000..84ded58e1 --- /dev/null +++ b/docs/features/marker-traffic-insight.md @@ -0,0 +1,258 @@ + + +> This documentation is organized by AI with reference to actual code. AI can make mistakes — please verify against the source code when in doubt. + +# Marker (Traffic Insight) + +## Overview + +A **marker** is a passive traffic-insight tap attached to a link. It runs a libpcap BPF +expression inside uBridge; on every match uBridge emits a real-time `MARK` signal and +appends the matching packet to a per-marker pcap file. Markers exist at two layers that +coexist on the same link: **per-link private markers** and **project-level definitions** +that are inherited by every capable link. + +## Architecture + +```mermaid +graph TB + UI["Web UI"] + + subgraph Controller["Controller"] + DEF["Project definitions
(inheritance templates)"] + LNK["Per-link markers"] + end + + Compute["Compute Node"] + UB["uBridge
mark filter"] + PCAP[("pcap file")] + LSTN["Marker listener
(UDP, per compute)"] + + UI -->|"REST + notifications ws"| Controller + DEF -.->|"fan-out: global-{name}"| LNK + LNK -->|"node.post /markers"| Compute + Compute --> UB + UB -->|"BPF match"| PCAP + UB -->|"UDP MARK signal"| LSTN + LSTN -->|"marker.match"| UI +``` + +Inheritance is a controller-only fan-out: a definition CRUD loops over links and reuses the +existing per-link marker operations, so the compute side sees an ordinary marker and is +unchanged. Each compute process runs one UDP listener serving every uBridge on that host; the +`node` and `link` fields in each signal together identify the source link (see +[Per-link attribution](#per-link-attribution)). + +## Business Process + +```mermaid +sequenceDiagram + participant UI as Web UI + participant C as Controller + participant L as Capable Link + participant N as Compute / uBridge + + UI->>C: POST /marker-definitions {name, bpf, ...} + C->>C: store definition + loop every capable link + C->>L: start_marker("global-{name}") + L->>N: install mark filter (BPF + pcap) + end + C-->>UI: 201 + link_ids + + Note over N: later: a packet matches the BPF + N->>N: emit MARK signal + append pcap + N-->>UI: marker.match notification (per-project ws) +``` + +Updating a definition syncs `bpf / tag / color / highlight_duration` to every inherited +copy; deleting a definition removes every inherited copy. A newly created link inherits all +existing definitions automatically. + +## Per-link attribution + +A uBridge `MARK` signal carries `node`, `filter`, `link`, `tag`, and `len` — but no bridge +name. When one node is the capture side for several links — the common case for a project-level +`global-{name}` marker on a multi-interface router — `node` + `filter` alone are identical +across those links, so they cannot tell the signals (or pcap files) apart. The `link` field +resolves this: + +1. At install time the controller stamps each filter with its link id + (`mark [tag ] link [pcap ]`). +2. uBridge treats `link` as opaque and echoes it verbatim in the signal (`link=`). +3. The listener takes the signal's `link=` as the **authoritative** `link_id` of the + `marker.match` event, falling back to its registry only for legacy signals that carry no + `link=`. + +This is also why the pcap path is keyed on link — +`/markers/__.pcap`, not on `bridge`+`filter`: a single +uBridge bridge can serve several links, and only the link id keeps their captures distinct. + +### IOU: one bridge, many interfaces + +IOU runs a single `IOL-BRIDGE` per node shared by every interface, so `bridge`+`filter` are +identical across that node's links. uBridge keeps a separate filter list **per port +(bay/unit)** within the bridge, so each interface gets its own `global-{name}` filter, its own +pcap file, and its own `link=`. The shared bridge name is irrelevant to attribution. Other +capable node types (`qemu`, `docker`, `vpcs`, `cloud`) already use one bridge per link; `link` +applies uniformly to all of them. + +## API Endpoints + +All endpoints require a JWT bearer token (`POST /v3/access/users/authenticate`). The +`Auth` column lists the required privilege. + +### Per-link markers + +| Method | Path | Description | Auth | +|--------|------|-------------|------| +| GET | `/v3/projects/{pid}/links/{lid}/markers` | List markers on a link | Link.Audit | +| POST | `/v3/projects/{pid}/links/{lid}/markers` | Attach a marker | Link.Modify | +| PUT | `/v3/projects/{pid}/links/{lid}/markers/{name}` | Update a marker | Link.Modify | +| DELETE | `/v3/projects/{pid}/links/{lid}/markers/{name}` | Remove a marker | Link.Modify | + +### Project-level definitions + +| Method | Path | Description | Auth | +|--------|------|-------------|------| +| GET | `/v3/projects/{pid}/marker-definitions` | List definitions + bound `link_ids` | Project.Audit | +| POST | `/v3/projects/{pid}/marker-definitions` | Create definition (fans out to every link) | Project.Modify | +| PUT | `/v3/projects/{pid}/marker-definitions/{name}` | Update definition (syncs all copies) | Project.Modify | +| DELETE | `/v3/projects/{pid}/marker-definitions/{name}` | Delete definition (clears all copies) | Project.Modify | + +### Aggregation + +| Method | Path | Description | Auth | +|--------|------|-------------|------| +| GET | `/v3/projects/{pid}/markers` | All markers across links, flat | Project.Audit | + +The link object returned by `GET /v3/projects/{pid}/links[/{lid}]` also carries a `markers` +field (including inherited markers), so the Web UI can render a link's markers without an +extra request. + +## Request / Response + +**Marker create body** (`MarkerCreate`, shared by per-link POST and PUT): + +```json +{ + "name": "icmp", + "bpf": "icmp", + "tag": 1, + "color": "#ff5722", + "highlight_duration": 800, + "enabled": true +} +``` + +**Definition create body** (`MarkerDefinitionCreate`, shared by POST and PUT): + +```json +{ + "name": "arp", + "bpf": "arp", + "tag": 5, + "color": "#ff5722", + "highlight_duration": 1200 +} +``` + +**Marker entry** (returned by GET/POST/PUT, and the value of each link's `markers[name]`): + +```json +{ + "bpf": "icmp", + "tag": 1, + "enabled": true, + "color": "#ff5722", + "highlight_duration": 800, + "capture_node_id": "a37e2235-e21f-46c9-a2ab-ba0f8c5465e6", + "inherited_from": null +} +``` + +**Definition GET response** (adds `link_ids`): + +```json +{ + "arp": { + "bpf": "arp", + "tag": 5, + "color": null, + "highlight_duration": 1200, + "link_ids": ["656ed826-...", "6bd9d156-..."] + } +} +``` + +## Field Reference + +### Marker entry + +| Field | Type | Description | +|-------|------|-------------| +| `bpf` | string | libpcap BPF expression (required) | +| `tag` | int \| null | Correlation id echoed in `MARK` signals | +| `enabled` | bool | Whether the marker is active | +| `color` | string \| null | Hex color render hint, e.g. `#ff5722` | +| `highlight_duration` | int \| null | UI highlight duration in ms after a match; `null` = UI default | +| `capture_node_id` | string | Server-chosen node whose uBridge hosts the marker | +| `inherited_from` | string | Source definition name — present on inherited markers only | + +### Definition + +| Field | Type | Description | +|-------|------|-------------| +| `bpf` | string | libpcap BPF expression (required) | +| `tag` | int \| null | Correlation id | +| `color` | string \| null | Hex color render hint | +| `highlight_duration` | int \| null | UI highlight duration in ms; `null` = UI default | +| `link_ids` | string[] | Links currently carrying an inherited copy (GET only) | + +### Notifications + +| Event | Payload | Delivered to | +|-------|---------|--------------| +| `link.updated` | Link object (its `markers` field is the source of truth) | Project notification ws | +| `marker.match` | `project_id`, `node_id`, `link_id`, `filter`, `tag`, `ts`, `len` | Project notification ws only | + +The `marker.match` `link_id` is taken from the signal's `link=` field (authoritative); see +[Per-link attribution](#per-link-attribution). + +## Error Responses + +| Status | Description | +|--------|-------------| +| 401 | Not authenticated | +| 404 | Link / marker / definition not found | +| 409 | Per-link edit or delete of an inherited marker; reserved (`global`) name or duplicate name on create | +| 422 | Validation failure (name format, `highlight_duration < 1`, missing `bpf`) | + +## Notes + +- **Marker name is immutable.** It is the identifier across the controller, the uBridge + filter, the pcap filename, and `MARK` signal routing — so rename is a delete + recreate, + not a field update. PUT ignores the body `name`; the `{name}` path parameter identifies + the target, and only `bpf / tag / color / enabled / highlight_duration` are changeable. +- **`global` prefix reserved.** User-chosen names may not start with `global`; inherited + markers are stored as `global-{definition_name}` so the two namespaces cannot collide. + Omitting `name` on create yields an auto-generated, prefix-free name. +- **Inherited markers are read-only per-link.** PUT/DELETE on an inherited marker returns + 409 — edit them through the definitions API. +- **Render hints are not enforced.** `color` and `highlight_duration` (milliseconds, `>= 1`) + are stored on the link and never sent to uBridge; `null` lets the UI apply its own + default. A partial PUT (e.g. changing only `bpf`) leaves them untouched. +- **Supported node types.** A marker needs a uBridge bridge: `vpcs`, `qemu`, `docker`, + `iou`, `dynamips`, `cloud` (one capable endpoint suffices). Types without a uBridge are + silently skipped by the inheritance fan-out. IOU uses one shared `IOL-BRIDGE` per node but + keeps filters, pcap files, and `link=` ids per port, so multi-interface nodes are handled + (see [Per-link attribution](#per-link-attribution)). +- **Shared capture-side node.** When one node hosts markers for several links (typical for + `global-*` definitions on a router), each filter is stamped with its `link_id` so signals + and pcap files stay link-distinct; the controller never collapses them to a single link. +- **Persistence.** Definitions and private markers persist in the topology; inherited + markers are re-created from definitions on project load, so reopening a project restores + the same configuration and stale inherited copies cannot survive on disk. diff --git a/gns3server/api/routes/compute/cloud_nodes.py b/gns3server/api/routes/compute/cloud_nodes.py index 8453ba0d8..42e691235 100644 --- a/gns3server/api/routes/compute/cloud_nodes.py +++ b/gns3server/api/routes/compute/cloud_nodes.py @@ -184,6 +184,8 @@ async def update_cloud_nio( nio.filters.clear() if nio_data.filters: nio.filters = nio_data.filters + # NIO type is a Union (Ethernet/TAP/UDP); only UDPNIO carries markers. + nio.markers = getattr(nio_data, "markers", None) or {} await node.update_nio(port_number, nio) return nio.asdict() diff --git a/gns3server/api/routes/compute/docker_nodes.py b/gns3server/api/routes/compute/docker_nodes.py index 3e30628a2..f08f9a497 100644 --- a/gns3server/api/routes/compute/docker_nodes.py +++ b/gns3server/api/routes/compute/docker_nodes.py @@ -29,7 +29,6 @@ from typing import Union from gns3server import schemas from gns3server.compute.docker import Docker from gns3server.compute.docker.docker_vm import DockerVM - from .dependencies.authentication import compute_authentication, ws_compute_authentication responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or Docker node"}} @@ -293,6 +292,7 @@ async def update_docker_node_nio( nio.filters.clear() if nio_data.filters: nio.filters = nio_data.filters + nio.markers = nio_data.markers or {} await node.adapter_update_nio_binding(adapter_number, nio) return nio.asdict() diff --git a/gns3server/api/routes/compute/dynamips_nodes.py b/gns3server/api/routes/compute/dynamips_nodes.py index 08eebb0d7..70d2b10c6 100644 --- a/gns3server/api/routes/compute/dynamips_nodes.py +++ b/gns3server/api/routes/compute/dynamips_nodes.py @@ -235,6 +235,7 @@ async def update_nio( nio.filters.clear() if nio_data.filters: nio.filters = nio_data.filters + nio.markers = nio_data.markers or {} await node.slot_update_nio_binding(adapter_number, port_number, nio) return nio.asdict() diff --git a/gns3server/api/routes/compute/iou_nodes.py b/gns3server/api/routes/compute/iou_nodes.py index 5be4fdd23..99544043d 100644 --- a/gns3server/api/routes/compute/iou_nodes.py +++ b/gns3server/api/routes/compute/iou_nodes.py @@ -254,6 +254,8 @@ async def update_iou_node_nio( nio.filters.clear() if nio_data.filters: nio.filters = nio_data.filters + # NIO type is a Union (Ethernet/TAP/UDP); only UDPNIO carries markers. + nio.markers = getattr(nio_data, "markers", None) or {} await node.adapter_update_nio_binding(adapter_number, port_number, nio) return nio.asdict() diff --git a/gns3server/api/routes/compute/qemu_nodes.py b/gns3server/api/routes/compute/qemu_nodes.py index 623ae8dae..6582dc731 100644 --- a/gns3server/api/routes/compute/qemu_nodes.py +++ b/gns3server/api/routes/compute/qemu_nodes.py @@ -30,7 +30,6 @@ from gns3server import schemas from gns3server.compute import qemu from gns3server.compute.qemu import Qemu from gns3server.compute.qemu.qemu_vm import QemuVM - from .dependencies.authentication import compute_authentication, ws_compute_authentication import logging @@ -321,6 +320,7 @@ async def update_qemu_node_nio( if nio_data.filters: nio.filters = nio_data.filters nio.suspend = nio_data.suspend + nio.markers = nio_data.markers or {} await node.adapter_update_nio_binding(adapter_number, nio) return nio.asdict() diff --git a/gns3server/api/routes/compute/vpcs_nodes.py b/gns3server/api/routes/compute/vpcs_nodes.py index c51f0254d..07c439972 100644 --- a/gns3server/api/routes/compute/vpcs_nodes.py +++ b/gns3server/api/routes/compute/vpcs_nodes.py @@ -29,7 +29,6 @@ from uuid import UUID from gns3server import schemas from gns3server.compute.vpcs import VPCS from gns3server.compute.vpcs.vpcs_vm import VPCSVM - from .dependencies.authentication import compute_authentication, ws_compute_authentication responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or VMware node"}} @@ -240,6 +239,7 @@ async def update_vpcs_node_nio( nio.filters.clear() if nio_data.filters: nio.filters = nio_data.filters + nio.markers = nio_data.markers or {} await node.port_update_nio_binding(port_number, nio) return nio.asdict() @@ -303,6 +303,7 @@ async def stop_vpcs_node_capture( await node.stop_capture(port_number) + @router.get( "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream", dependencies=[Depends(compute_authentication)] diff --git a/gns3server/api/routes/controller/links.py b/gns3server/api/routes/controller/links.py index ce9caf450..9e33b7ba3 100644 --- a/gns3server/api/routes/controller/links.py +++ b/gns3server/api/routes/controller/links.py @@ -27,7 +27,7 @@ from fastapi import APIRouter, Depends, Request, status, WebSocket from fastapi.responses import FileResponse, StreamingResponse from fastapi.encoders import jsonable_encoder from typing import List, Union -from uuid import UUID +from uuid import UUID, uuid4 from gns3server.controller import Controller from gns3server.controller.controller_error import ControllerError @@ -424,6 +424,97 @@ async def web_wireshark_websocket( pass +@router.get( + "/{link_id}/markers", + dependencies=[Depends(has_privilege("Link.Audit"))] +) +async def get_markers(link: Link = Depends(dep_link)) -> dict: + """ + Return all traffic-insight markers configured on this link. + + Required privilege: Link.Audit + """ + + return link.markers + + +@router.post( + "/{link_id}/markers", + status_code=status.HTTP_201_CREATED, + dependencies=[Depends(has_privilege("Link.Modify"))] +) +async def create_marker( + marker_data: schemas.MarkerCreate, + link: Link = Depends(dep_link) +) -> dict: + """ + Attach a traffic-insight marker to the link. + On BPF match uBridge emits MARK signals and appends packets to a pcap. + + Required privilege: Link.Modify + """ + + # Auto-generate a link-unique name when the caller omits one. The short + # uuid suffix avoids the collision that `marker-{link.id[:8]}` alone would + # cause on the second anonymous marker on the same link (start_marker + # rejects duplicate names). + if marker_data.name and marker_data.name.lower().startswith("global"): + raise ControllerError('Names starting with "global" are reserved for inherited markers') + name = marker_data.name or f"marker-{link.id[:8]}-{uuid4().hex[:4]}" + await link.start_marker( + name=name, + bpf=marker_data.bpf, + tag=marker_data.tag, + color=marker_data.color, + highlight_duration=marker_data.highlight_duration, + ) + return link.markers.get(name, {}) + + +@router.delete( + "/{link_id}/markers/{marker_name}", + status_code=status.HTTP_204_NO_CONTENT, + dependencies=[Depends(has_privilege("Link.Modify"))] +) +async def delete_marker( + marker_name: str, + link: Link = Depends(dep_link) +) -> None: + """ + Remove a traffic-insight marker from the link. + + Required privilege: Link.Modify + """ + + await link.stop_marker(marker_name) + + +@router.put( + "/{link_id}/markers/{marker_name}", + dependencies=[Depends(has_privilege("Link.Modify"))] +) +async def update_marker( + marker_name: str, + marker_data: schemas.MarkerCreate, + link: Link = Depends(dep_link) +) -> dict: + """ + Update a traffic-insight marker (change BPF, tag, or enabled). + + Required privilege: Link.Modify + """ + + await link.update_marker( + name=marker_name, + bpf=marker_data.bpf if marker_data.bpf else None, + tag=marker_data.tag, + color=marker_data.color, + enabled=marker_data.enabled, + highlight_duration=marker_data.highlight_duration, + ) + return link.markers.get(marker_name, {}) + + @router.get( "/{link_id}/iface", response_model=Union[schemas.UDPPortInfo, schemas.EthernetPortInfo], diff --git a/gns3server/api/routes/controller/projects.py b/gns3server/api/routes/controller/projects.py index 333053e3b..5e6f1c6de 100644 --- a/gns3server/api/routes/controller/projects.py +++ b/gns3server/api/routes/controller/projects.py @@ -203,6 +203,119 @@ def get_project_stats(project: Project = Depends(dep_project)) -> dict: return project.stats() +@router.get("/{project_id}/markers", dependencies=[Depends(has_privilege("Project.Audit"))]) +def get_project_markers(project: Project = Depends(dep_project)) -> dict: + """ + Return all traffic-insight markers across every link in the project. + + Each entry is keyed ``"{link_id}/{marker_name}"`` and carries the + marker's BPF, tag, color, enabled flag, plus its parent ``link_id`` + and capture-side ``node_id`` for frontend filtering / grouping. + + Required privilege: Project.Audit + """ + + return project.markers + + +# --------------------------------------------------------------------------- +# Project-level marker definitions (global rules inherited by every link) +# --------------------------------------------------------------------------- + +@router.get( + "/{project_id}/marker-definitions", + dependencies=[Depends(has_privilege("Project.Audit"))] +) +def get_marker_definitions(project: Project = Depends(dep_project)) -> dict: + """ + Return all project-level marker definitions with their bound link IDs. + + Required privilege: Project.Audit + """ + + result = {} + for name, d in project.marker_definitions.items(): + # Collect which links currently carry an inherited copy. + bound = [ + lid for lid, link in project.links.items() + if f"global-{name}" in link.markers + and link.markers[f"global-{name}"].get("inherited_from") == name + ] + result[name] = {**d, "link_ids": bound} + return result + + +@router.post( + "/{project_id}/marker-definitions", + status_code=status.HTTP_201_CREATED, + dependencies=[Depends(has_privilege("Project.Modify"))] +) +async def create_marker_definition( + def_data: schemas.MarkerDefinitionCreate, + project: Project = Depends(dep_project) +) -> dict: + """ + Create a project-level marker definition and fan out to every link. + + Required privilege: Project.Modify + """ + + if def_data.name and def_data.name.lower().startswith("global"): + raise ControllerError('Names starting with "global" are reserved for inherited markers') + name = def_data.name or f"def-{project.id[:8]}" + await project.create_marker_definition( + name=name, + bpf=def_data.bpf, + tag=def_data.tag, + color=def_data.color, + highlight_duration=def_data.highlight_duration, + ) + return project.marker_definitions.get(name, {}) + + +@router.put( + "/{project_id}/marker-definitions/{def_name}", + dependencies=[Depends(has_privilege("Project.Modify"))] +) +async def update_marker_definition( + def_name: str, + def_data: schemas.MarkerDefinitionCreate, + project: Project = Depends(dep_project) +) -> dict: + """ + Update a marker definition and sync all inherited copies on every link. + + Required privilege: Project.Modify + """ + + await project.update_marker_definition( + name=def_name, + bpf=def_data.bpf if def_data.bpf else None, + tag=def_data.tag, + color=def_data.color, + highlight_duration=def_data.highlight_duration, + ) + return project.marker_definitions.get(def_name, {}) + + +@router.delete( + "/{project_id}/marker-definitions/{def_name}", + status_code=status.HTTP_204_NO_CONTENT, + dependencies=[Depends(has_privilege("Project.Modify"))] +) +async def delete_marker_definition( + def_name: str, + project: Project = Depends(dep_project) +) -> None: + """ + Delete a marker definition and remove all inherited copies from every link. + + Required privilege: Project.Modify + """ + + await project.delete_marker_definition(def_name) + + @router.post( "/{project_id}/close", status_code=status.HTTP_204_NO_CONTENT, diff --git a/gns3server/compute/base_manager.py b/gns3server/compute/base_manager.py index 076b802d1..8ef27265c 100644 --- a/gns3server/compute/base_manager.py +++ b/gns3server/compute/base_manager.py @@ -356,6 +356,7 @@ class BaseManager: raise ComputeError(f"Could not create an UDP connection to {rhost}:{rport}: {e}") nio = NIOUDP(lport, rhost, rport) nio.filters = nio_settings.get("filters", {}) + nio.markers = nio_settings.get("markers", {}) nio.suspend = nio_settings.get("suspend", False) elif nio_settings["type"] == "nio_tap": tap_device = nio_settings["tap_device"] diff --git a/gns3server/compute/base_node.py b/gns3server/compute/base_node.py index 8e7681d9e..df92de0aa 100644 --- a/gns3server/compute/base_node.py +++ b/gns3server/compute/base_node.py @@ -935,9 +935,46 @@ class BaseNode: f"Hypervisor {self._ubridge_hypervisor.host}:{self._ubridge_hypervisor.port} has successfully started" ) await self._ubridge_hypervisor.connect() + # Tell this uBridge where to send MARK signals and which node id to + # tag them with. Marker is opt-in and inert until a `mark` filter is + # added, so this never disturbs the data plane. + await self._ubridge_configure_marker_sink() # save if privileged are required in case uBridge needs to be restarted in self._ubridge_send() self._ubridge_require_privileged_access = require_privileged_access + async def _ubridge_configure_marker_sink(self): + """ + Point this node's uBridge at the compute's marker UDP sink and tag its + signals with this node's id. Safe to call before any marker filter + exists — uBridge stays inert until a ``mark`` filter is configured. + + Old uBridge builds without the marker module are tolerated: the failure + is downgraded to a warning so node start is not blocked by an opt-in + observability feature. + """ + + from gns3server.compute.marker.marker_manager import MarkerManager + + manager = MarkerManager.instance() + if not manager.running or not manager.host or not manager.port: + return + if self._ubridge_hypervisor is None: + return + try: + # Talk to the hypervisor directly, NOT via _ubridge_send: this runs + # inside _start_ubridge, which is reached THROUGH _ubridge_send when + # uBridge starts lazily (e.g. linking a stopped node). _ubridge_send's + # lock is non-reentrant, so calling it again here would deadlock on + # the held ___ubridge_send_lock. uBridge is already running and + # connected at this point, so the raw hypervisor send is safe. + await self._ubridge_hypervisor.send(f"marker sink {manager.host} {manager.port}") + await self._ubridge_hypervisor.send(f"marker node {self._id}") + except UbridgeError: + log.warning( + "uBridge does not support the marker module; traffic insight disabled for node %r", + self.name, + ) + async def _stop_ubridge(self): """ Stops uBridge. @@ -983,10 +1020,12 @@ class BaseNode: await self._ubridge_send(f"bridge start {bridge_name}") await self._ubridge_apply_filters(bridge_name, destination_nio.filters) + await self._ubridge_apply_markers(bridge_name, destination_nio) async def update_ubridge_udp_connection(self, bridge_name, source_nio, destination_nio): if destination_nio: await self._ubridge_apply_filters(bridge_name, destination_nio.filters) + await self._ubridge_apply_markers(bridge_name, destination_nio) async def ubridge_delete_bridge(self, name): """ @@ -1042,6 +1081,86 @@ class BaseNode: ) i += 1 + async def _ubridge_add_marker_filter(self, bridge_name, name, bpf, pcap_path, tag=None, link_id=None): + """ + Attach a `mark` packet filter to a uBridge bridge for traffic insight. + + On BPF match uBridge (a) emits a UDP MARK signal to the configured sink + and (b) appends the packet to ``pcap_path``. Unlike the impairment + filters, this is an observability tap: it never drops or alters traffic, + and it is added/removed on its own (not via reset_packet_filters) so the + pcap is not closed/reopened on unrelated filter changes. + + :param bridge_name: uBridge bridge carrying the link's traffic + :param name: stable, gns3server-chosen filter name (pcap identity + echoed in signals) + :param bpf: libpcap BPF expression + :param pcap_path: absolute path ubridge appends matched packets to + :param tag: optional correlation id echoed in MARK signals + """ + + # mark [tag ] [pcap ] — tag/pcap keyword pairs, any order. + # name travels from the controller REST layer (MarkerCreate schema) but is + # validated here too as defense-in-depth against hand-edited topology files. + # Note: "global-*" names are legitimate here — they come from project-level + # marker definitions (inherit_marker). The prefix is only forbidden at the + # user-facing schema layer, not at the uBridge boundary. + _MARKER_NAME_RE = re.compile(r"^[A-Za-z0-9][A-Za-z0-9_.-]*$") + if not _MARKER_NAME_RE.match(name): + raise UbridgeError(f"Invalid marker name: {name!r}") + cmd = 'bridge add_packet_filter {bridge} {name} mark "{bpf}"'.format( + bridge=bridge_name, name=name, bpf=bpf + ) + if tag is not None: + cmd += f" tag {tag}" + # Per-link attribution (contract §3.2): when one ubridge bridge serves + # several GNS3 links (e.g. IOU's per-node bridge), bridge+filter collide, + # so the link id is the only way to tell signals — and pcap files — apart. + if link_id: + cmd += f" link {link_id}" + cmd += ' pcap "{path}"'.format(path=pcap_path) + # Let BPF compile errors propagate — the marker is the user's intent, so a + # bad expression must surface instead of being silently dropped. + await self._ubridge_send(cmd) + + async def _ubridge_apply_markers(self, bridge_name, nio): + """ + (Re-)apply every traffic-insight marker carried by *nio* to the uBridge + bridge *bridge_name*. Called from ``add_ubridge_udp_connection`` (bridge + creation / node restart) and ``update_ubridge_udp_connection`` (NIO update + — the preceding ``_ubridge_apply_filters`` has already issued + ``reset_packet_filters``, so we must re-add markers to survive the reset). + """ + from gns3server.compute.marker.marker_manager import MarkerManager + + markers = nio.markers if hasattr(nio, 'markers') else {} + if not markers: + return + + manager = MarkerManager.instance() + markers_dir = self.project.markers_working_directory() + for name, spec in markers.items(): + bpf = spec.get("bpf", "") + tag = spec.get("tag") + link_id = spec.get("link_id", "") + pcap_path = os.path.join( + markers_dir, f"{self._id}_{link_id}_{name}.pcap" + ) + try: + await self._ubridge_add_marker_filter(bridge_name, name, bpf, pcap_path, tag, link_id) + except UbridgeError as e: + # Swallow BPF compile errors (warn + skip) so a single bad + # expression can't break link creation / node restart — mirrors + # _ubridge_apply_filters, which does the same for packet filters. + if "syntax error" in str(e).lower() or "compile filter" in str(e).lower(): + message = f"Warning: ignoring marker '{name}' due to BPF syntax error: {e}" + log.warning(message) + self.project.emit("log.warning", {"message": message}) + continue + raise + manager.register( + str(self.project.id), self._id, name, link_id, tag + ) + async def _add_ubridge_ethernet_connection(self, bridge_name, ethernet_interface, block_host_traffic=False): """ Creates a connection with an Ethernet interface in uBridge. diff --git a/gns3server/compute/builtin/nodes/cloud.py b/gns3server/compute/builtin/nodes/cloud.py index 50bf11084..d71669198 100644 --- a/gns3server/compute/builtin/nodes/cloud.py +++ b/gns3server/compute/builtin/nodes/cloud.py @@ -312,6 +312,7 @@ class Cloud(BaseNode): ) await self._ubridge_apply_filters(bridge_name, nio.filters) + await self._ubridge_apply_markers(bridge_name, nio) if port_info["type"] in ("ethernet", "tap"): if not self.manager.has_privileged_access(self.ubridge_path): @@ -452,6 +453,7 @@ class Cloud(BaseNode): bridge_name = f"{self._id}-{port_number}" if self._ubridge_hypervisor and self._ubridge_hypervisor.is_running(): await self._ubridge_apply_filters(bridge_name, nio.filters) + await self._ubridge_apply_markers(bridge_name, nio) async def _delete_ubridge_connection(self, port_number): """ diff --git a/gns3server/compute/docker/docker_vm.py b/gns3server/compute/docker/docker_vm.py index 8c139cdfd..7315dad0d 100644 --- a/gns3server/compute/docker/docker_vm.py +++ b/gns3server/compute/docker/docker_vm.py @@ -1228,6 +1228,7 @@ class DockerVM(BaseNode): ) await self._ubridge_send(f"bridge start {bridge_name}") await self._ubridge_apply_filters(bridge_name, nio.filters) + await self._ubridge_apply_markers(bridge_name, nio) async def adapter_add_nio_binding(self, adapter_number, nio): """ @@ -1268,7 +1269,7 @@ class DockerVM(BaseNode): bridge_name = f"bridge{adapter_number}" if bridge_name in self._bridges: await self._ubridge_apply_filters(bridge_name, nio.filters) - + await self._ubridge_apply_markers(bridge_name, nio) async def adapter_remove_nio_binding(self, adapter_number): """ Removes an adapter NIO binding. diff --git a/gns3server/compute/dynamips/__init__.py b/gns3server/compute/dynamips/__init__.py index 3d620b6a2..eeb4ed91f 100644 --- a/gns3server/compute/dynamips/__init__.py +++ b/gns3server/compute/dynamips/__init__.py @@ -376,6 +376,7 @@ class Dynamips(BaseManager): raise DynamipsError(f"Could not create an UDP connection to {rhost}:{rport}: {e}") nio = NIOUDP(node, lport, rhost, rport) nio.filters = nio_settings.get("filters", {}) + nio.markers = nio_settings.get("markers", {}) nio.suspend = nio_settings.get("suspend", False) elif nio_settings["type"] == "nio_generic_ethernet": ethernet_device = nio_settings["ethernet_device"] diff --git a/gns3server/compute/dynamips/nios/nio.py b/gns3server/compute/dynamips/nios/nio.py index 2872b89eb..5c5c9ec6d 100644 --- a/gns3server/compute/dynamips/nios/nio.py +++ b/gns3server/compute/dynamips/nios/nio.py @@ -40,6 +40,7 @@ class NIO: self._hypervisor = hypervisor self._name = name self._filters = {} + self._markers = {} self._suspended = False self._capturing = False self._pcap_output_file = "" @@ -303,6 +304,26 @@ class NIO: assert isinstance(new_filters, dict) self._filters = new_filters + @property + def markers(self): + """ + Returns the list of traffic-insight markers for this NIO. + + :returns: markers (dictionary) + """ + + return self._markers + + @markers.setter + def markers(self, new_markers): + """ + Set markers for this NIO. + + :param new_markers: markers (dictionary) + """ + + self._markers = new_markers + @property def capturing(self): """ diff --git a/gns3server/compute/dynamips/nios/nio_udp.py b/gns3server/compute/dynamips/nios/nio_udp.py index 47faacc43..d849a37bf 100644 --- a/gns3server/compute/dynamips/nios/nio_udp.py +++ b/gns3server/compute/dynamips/nios/nio_udp.py @@ -82,10 +82,12 @@ class NIOUDP(NIO): self._source_nio = nio_udp.NIOUDP(self._local_tunnel_rport, "127.0.0.1", self._local_tunnel_lport) self._destination_nio = nio_udp.NIOUDP(self._lport, self._rhost, self._rport) self._destination_nio.filters = self._filters + self._destination_nio.markers = self._markers await self._node.add_ubridge_udp_connection(self._bridge_name, self._source_nio, self._destination_nio) async def update(self): self._destination_nio.filters = self._filters + self._destination_nio.markers = self._markers await self._node.update_ubridge_udp_connection(self._bridge_name, self._source_nio, self._destination_nio) async def close(self): diff --git a/gns3server/compute/iou/iou_vm.py b/gns3server/compute/iou/iou_vm.py index 506bff3d7..11bffb69a 100644 --- a/gns3server/compute/iou/iou_vm.py +++ b/gns3server/compute/iou/iou_vm.py @@ -746,6 +746,7 @@ class IOUVM(BaseNode): ) await self._ubridge_apply_filters(bay_id, unit_id, nio.filters) + await self._ubridge_apply_markers(bay_id, unit_id, nio) unit_id += 1 bay_id += 1 @@ -1067,6 +1068,7 @@ class IOUVM(BaseNode): ) ) await self._ubridge_apply_filters(adapter_number, port_number, nio.filters) + await self._ubridge_apply_markers(adapter_number, port_number, nio) async def adapter_update_nio_binding(self, adapter_number, port_number, nio): """ @@ -1079,6 +1081,7 @@ class IOUVM(BaseNode): if self.ubridge: await self._ubridge_apply_filters(adapter_number, port_number, nio.filters) + await self._ubridge_apply_markers(adapter_number, port_number, nio) async def _ubridge_apply_filters(self, adapter_number, port_number, filters): """ @@ -1095,6 +1098,64 @@ class IOUVM(BaseNode): cmd = "iol_bridge add_packet_filter {} {}".format(location, filter) await self._ubridge_send(cmd) + async def _ubridge_apply_markers(self, adapter_number, port_number, nio): + """ + (Re-)apply traffic-insight markers to the IOL bridge. + + IOU uses ``iol_bridge`` (not ``bridge``) and the ``add_packet_filter`` + command carries extra ``{bay} {unit}`` positional arguments between the + bridge name and the filter name — this override mirrors the pattern in + ``_ubridge_apply_filters`` above. + + :param adapter_number: bay id + :param port_number: unit id + :param nio: NIO instance carrying ``nio.markers`` + """ + from gns3server.compute.marker.marker_manager import MarkerManager + + markers = nio.markers if hasattr(nio, 'markers') else {} + if not markers: + return + + manager = MarkerManager.instance() + markers_dir = self.project.markers_working_directory() + bridge_name = f"IOL-BRIDGE-{self.application_id + 512}" + location = "{bridge_name} {bay} {unit}".format( + bridge_name=bridge_name, bay=adapter_number, unit=port_number + ) + for name, spec in markers.items(): + bpf = spec.get("bpf", "") + tag = spec.get("tag") + link_id = spec.get("link_id", "") + pcap_path = os.path.join( + markers_dir, f"{self._id}_{link_id}_{name}.pcap" + ) + # Build the iol_bridge marker filter command: + # iol_bridge add_packet_filter {br} {bay} {unit} {name} mark "{bpf}" [tag {id}] pcap "{path}" + cmd = 'iol_bridge add_packet_filter {loc} {name} mark "{bpf}"'.format( + loc=location, name=name, bpf=bpf + ) + if tag is not None: + cmd += f" tag {tag}" + # IOU uses one per-node IOL-BRIDGE for every link, so bridge+filter + # are identical across this node's links — `link` is the only way the + # controller can tell their signals apart (contract §3.2). + if link_id: + cmd += f" link {link_id}" + cmd += ' pcap "{path}"'.format(path=pcap_path) + try: + await self._ubridge_send(cmd) + except UbridgeError as e: + if "syntax error" in str(e).lower() or "compile filter" in str(e).lower(): + message = f"Warning: ignoring marker '{name}' due to BPF syntax error: {e}" + log.warning(message) + self.project.emit("log.warning", {"message": message}) + continue + raise + manager.register( + str(self.project.id), self._id, name, link_id, tag + ) + async def adapter_remove_nio_binding(self, adapter_number, port_number): """ Removes an adapter NIO binding. diff --git a/gns3server/compute/marker/__init__.py b/gns3server/compute/marker/__init__.py new file mode 100644 index 000000000..8fdb2b775 --- /dev/null +++ b/gns3server/compute/marker/__init__.py @@ -0,0 +1,24 @@ +#!/usr/bin/env python +# +# Copyright (C) 2024 GNS3 Technologies Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +# +# Traffic-insight marker subsystem (compute side). +# +# ubridge's ``marker`` module is a passive tap: on a BPF match it emits a UDP +# ``MARK`` signal to a configured sink and/or appends the packet to a pcap. +# This package owns the compute-side UDP sink: one listener per compute process +# serves every ubridge on that host, disambiguated by ``node=``. diff --git a/gns3server/compute/marker/marker_listener.py b/gns3server/compute/marker/marker_listener.py new file mode 100644 index 000000000..f22f59bff --- /dev/null +++ b/gns3server/compute/marker/marker_listener.py @@ -0,0 +1,109 @@ +#!/usr/bin/env python +# +# Copyright (C) 2024 GNS3 Technologies Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import asyncio +import logging + +log = logging.getLogger(__name__) + + +class MarkerListener(asyncio.DatagramProtocol): + """ + Receives ubridge ``MARK`` signal datagrams and turns each into a + ``marker.match`` notification. + + Signal format (one datagram per match, ASCII):: + + MARK node= filter= tag= len=\\n + + The signal carries metadata only (no packet bytes). The compute-side + :class:`~gns3server.compute.marker.marker_manager.MarkerManager` registry + resolves ``(node_id, filter_name)`` to ``(project_id, link_id, tag)`` so the + event can be emitted on the right project-scoped notification stream. + """ + + def __init__(self, manager): + # MarkerManager owns this listener and the registry. + self._manager = manager + self.transport = None + + def connection_made(self, transport): + self.transport = transport + + def datagram_received(self, data, addr): + try: + self._handle(data) + except Exception: + # Never let a malformed datagram kill the listener. + log.exception("Failed to process MARK datagram from %s: %r", addr, data) + + def _handle(self, data): + line = data.decode("utf-8", errors="replace").strip() + if not line.startswith("MARK"): + return + + parts = line.split() + # parts[0] == "MARK"; parts[1] == "" + if len(parts) < 2: + return + + try: + ts = float(parts[1]) + except ValueError: + log.warning("Ignoring MARK signal with bad timestamp: %r", line) + return + + kv = {} + for token in parts[2:]: + if "=" in token: + key, value = token.split("=", 1) + kv[key] = value + + node_id = kv.get("node") + filter_name = kv.get("filter") + if not node_id or not filter_name: + return + + # "-" means the field was unset on the ubridge side (see contract §3.3). + link = kv.get("link") + tag = kv.get("tag") + length = kv.get("len") + + project_id, link_id, registered_tag = self._manager.lookup(node_id, filter_name) + if project_id is None: + log.warning( + "MARK signal for unregistered node=%s filter=%s, dropping", node_id, filter_name + ) + return + + # `link=` is the authoritative per-link id (opaque, set by gns3server at + # filter install time). It disambiguates signals that share a node+filter + # across several links; fall back to the registry's link only for legacy + # signals that carry no `link=`. + signal_link = link if link and link != "-" else None + + event = { + "project_id": project_id, + "node_id": node_id, + "link_id": signal_link or link_id, + "filter": filter_name, + # Prefer the value carried in the signal; fall back to the one we registered. + "tag": tag if tag and tag != "-" else registered_tag, + "ts": ts, + "len": int(length) if length and length.isdigit() else 0, + } + self._manager.emit_match(project_id, event) diff --git a/gns3server/compute/marker/marker_manager.py b/gns3server/compute/marker/marker_manager.py new file mode 100644 index 000000000..6ec128158 --- /dev/null +++ b/gns3server/compute/marker/marker_manager.py @@ -0,0 +1,185 @@ +#!/usr/bin/env python +# +# Copyright (C) 2024 GNS3 Technologies Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import asyncio +import logging + +from gns3server.compute.marker.marker_listener import MarkerListener +from gns3server.compute.notification_manager import NotificationManager + +log = logging.getLogger(__name__) + + +class MarkerManager: + """ + Singleton owning the compute-side UDP sink for ubridge ``MARK`` signals and + the registry that maps each ``(node_id, filter_name)`` back to its + ``(project_id, link_id, tag)``. + + The registry is populated when a marker is created on a link (the compute + endpoint has project_id + node_id from its route path and link_id/name/tag + from the request body) and cleared when the marker is deleted or the project + closed. At signal time it is an O(1) lookup — no node-table scan, and the + signal payload is untouched. + + One listener per compute process serves every ubridge on that host; source + ubridges are disambiguated by ``node=`` (UUID, globally unique). + """ + + def __init__(self): + + self._listener = None + self._transport = None + self._host = None + self._port = None + # Flat lookup: (node_id, filter_name) -> {"project_id", "link_id", "tag"} + self._entries = {} + # Reverse index for O(1) per-project teardown: project_id -> set of keys + self._by_project = {} + + @property + def host(self): + """The host the UDP sink is reachable on (for ``marker sink``).""" + return self._host + + @property + def port(self): + """The UDP port the sink is bound on (for ``marker sink``).""" + return self._port + + @property + def running(self): + return self._transport is not None + + async def start(self, host="127.0.0.1", port=0): + """ + Bind the UDP sink. ``port=0`` lets the OS choose a free port, which is + then read back and exposed via :attr:`port` for ``marker sink`` commands. + """ + + if self.running: + return + loop = asyncio.get_running_loop() + self._listener = MarkerListener(self) + try: + self._transport, _ = await loop.create_datagram_endpoint( + lambda: self._listener, local_addr=(host, port) + ) + except OSError: + if port != 0: + log.warning( + "Marker listener: port %s unavailable, falling back to OS-assigned port", port + ) + try: + self._transport, _ = await loop.create_datagram_endpoint( + lambda: self._listener, local_addr=(host, 0) + ) + except OSError as e: + log.error( + "Marker listener startup failed: %s. Traffic insight signals are unavailable.", e + ) + self._listener = None + return + else: + log.error( + "Marker listener startup failed on OS-assigned port. Traffic insight signals are unavailable." + ) + self._listener = None + return + sock = self._transport.get_extra_info("socket") + self._host = host + self._port = sock.getsockname()[1] if sock else port + log.info("Marker signal sink listening on %s:%s", self._host, self._port) + + async def stop(self): + """Close the UDP sink and drop the whole registry.""" + + if self._transport: + self._transport.close() + self._transport = None + self._listener = None + self._entries.clear() + self._by_project.clear() + self._host = None + self._port = None + + def register(self, project_id, node_id, filter_name, link_id, tag=None): + """ + Record that ``filter_name`` on ``node_id`` belongs to ``project_id`` / + ``link_id``. Called from the compute marker-start endpoint. + + Re-registering the same key updates the stored tag (e.g. on re-add). + """ + + key = (node_id, filter_name) + self._entries[key] = {"project_id": project_id, "link_id": link_id, "tag": tag} + self._by_project.setdefault(project_id, set()).add(key) + + def unregister(self, node_id, filter_name): + """Forget a single marker. Returns True if something was removed.""" + + key = (node_id, filter_name) + entry = self._entries.pop(key, None) + if entry is None: + return False + project_entries = self._by_project.get(entry["project_id"]) + if project_entries is not None: + project_entries.discard(key) + if not project_entries: + self._by_project.pop(entry["project_id"], None) + return True + + def unregister_project(self, project_id): + """Drop every marker belonging to ``project_id`` (project close).""" + + keys = self._by_project.pop(project_id, None) + if not keys: + return + for key in keys: + self._entries.pop(key, None) + + def lookup(self, node_id, filter_name): + """ + O(1) resolution of an incoming signal to its project/link/tag. + + :returns: (project_id, link_id, tag) or (None, None, None) on miss. + """ + + entry = self._entries.get((node_id, filter_name)) + if entry is None: + return None, None, None + return entry["project_id"], entry["link_id"], entry["tag"] + + def emit_match(self, project_id, event): + """ + Forward a parsed match as a project-scoped ``marker.match`` notification. + Flows compute -> controller dispatch -> project_emit -> web UI WS. + """ + + NotificationManager.instance().emit("marker.match", event, project_id=project_id) + + _instance = None + + @staticmethod + def instance(): + if MarkerManager._instance is None: + MarkerManager._instance = MarkerManager() + return MarkerManager._instance + + @staticmethod + def reset(): + MarkerManager._instance = None diff --git a/gns3server/compute/nios/nio.py b/gns3server/compute/nios/nio.py index 8ad5bd870..6fe57a130 100644 --- a/gns3server/compute/nios/nio.py +++ b/gns3server/compute/nios/nio.py @@ -30,6 +30,7 @@ class NIO: self._capturing = False self._suspended = False self._filters = {} + self._markers = {} self._pcap_output_file = "" self._pcap_data_link_type = "" @@ -118,3 +119,24 @@ class NIO: assert isinstance(new_filters, dict) self._filters = new_filters + + @property + def markers(self): + """ + Returns the traffic-insight markers for this NIO. + + :returns: markers (dictionary: name -> {bpf, tag, link_id}) + """ + + return self._markers + + @markers.setter + def markers(self, new_markers): + """ + Set the traffic-insight markers for this NIO. + + :param new_markers: markers (dictionary: name -> {bpf, tag, link_id}) + """ + + assert isinstance(new_markers, dict) + self._markers = new_markers diff --git a/gns3server/compute/nios/nio_udp.py b/gns3server/compute/nios/nio_udp.py index b7736a39e..e6f1bd8bc 100644 --- a/gns3server/compute/nios/nio_udp.py +++ b/gns3server/compute/nios/nio_udp.py @@ -80,5 +80,6 @@ class NIOUDP(NIO): "rport": self._rport, "rhost": self._rhost, "suspend": self._suspended, - "filters": self._filters + "filters": self._filters, + "markers": self._markers } diff --git a/gns3server/compute/project.py b/gns3server/compute/project.py index eebb65ca1..ae3b5c8d1 100644 --- a/gns3server/compute/project.py +++ b/gns3server/compute/project.py @@ -246,6 +246,22 @@ class Project: raise ComputeError(f"Could not create the capture working directory: {e}") return workdir + def markers_working_directory(self): + """ + Returns the working directory where uBridge writes per-link marker pcaps + (matched packets, kept for later replay). + + :returns: path to the directory + """ + + workdir = os.path.join(self._path, "project-files", "markers") + if not self._deleted: + try: + os.makedirs(workdir, exist_ok=True) + except OSError as e: + raise ComputeError(f"Could not create the markers working directory: {e}") + return workdir + def add_node(self, node): """ Adds a node to the project. diff --git a/gns3server/config_samples/gns3_server.conf b/gns3server/config_samples/gns3_server.conf index 276987c45..ca672891d 100644 --- a/gns3server/config_samples/gns3_server.conf +++ b/gns3server/config_samples/gns3_server.conf @@ -92,6 +92,13 @@ udp_end_port_range = 30000 ; uBridge executable location, default: search in PATH ;ubridge_path = ubridge +; Marker (traffic-insight) UDP sink: one listener per compute process that +; receives uBridge MARK signals from every uBridge on this host. +; marker_listen_host defaults to 127.0.0.1 because uBridge runs locally. +; marker_listen_port defaults to 3070 (set to 0 for OS-chosen). +;marker_listen_host = 127.0.0.1 +;marker_listen_port = 3070 + ; Option to enable or disable compute HTTP authentication enable_http_auth = True diff --git a/gns3server/controller/__init__.py b/gns3server/controller/__init__.py index 9cfe2bcd7..edf654ec3 100644 --- a/gns3server/controller/__init__.py +++ b/gns3server/controller/__init__.py @@ -741,6 +741,9 @@ class Controller: topo_data.pop("version") topo_data.pop("revision") topo_data.pop("type") + # marker_definitions is restored by Project.open() from the topology + # file; it must not be passed to Project.__init__. + topo_data.pop("marker_definitions", None) if topo_data["project_id"] in self._projects: project = self._projects[topo_data["project_id"]] diff --git a/gns3server/controller/link.py b/gns3server/controller/link.py index 556f5ba5f..008deda4d 100644 --- a/gns3server/controller/link.py +++ b/gns3server/controller/link.py @@ -88,6 +88,7 @@ class Link: self._link_type = "ethernet" self._suspended = False self._filters = {} + self._markers = {} self._link_style = {} self._wireshark = False self._show_filters_icon = True @@ -99,6 +100,40 @@ class Link: """ return self._filters + @property + def markers(self): + """ + Get the traffic insight markers dict: name → {bpf, tag, enabled} + """ + return self._markers + + async def inherit_marker(self, def_name, marker_def): + """ + Apply a project-level marker definition to this link. + + The marker is stored under ``global-{def_name}`` so it cannot collide + with a per-link private marker of the same name. It carries an + ``inherited_from`` back-reference that (a) guards against per-link + edits and (b) lets the project sync changes to every copy at once. + """ + + await self.start_marker( + name=f"global-{def_name}", + bpf=marker_def["bpf"], + tag=marker_def.get("tag"), + color=marker_def.get("color"), + highlight_duration=marker_def.get("highlight_duration"), + inherited_from=def_name, + ) + + def _persist_markers(self): + """ + Return only the per-link (non-inherited) markers suitable for + persistence in a topology dump. Inherited markers are re-created from + ``project._marker_definitions`` on load so they do not need to be saved. + """ + return {k: v for k, v in self._markers.items() if not v.get("inherited_from")} + @property def show_filters_icon(self): """ @@ -298,6 +333,27 @@ class Link: raise NotImplementedError + async def start_marker(self, name, bpf, tag=None): + """ + Attach a traffic-insight marker to this link (base — UDPLink overrides). + """ + raise NotImplementedError + + async def stop_marker(self, name): + """ + Remove a traffic-insight marker from this link (base — UDPLink overrides). + """ + raise NotImplementedError + + async def update_marker(self, name, bpf=None, tag=None, enabled=None): + """ + Update an existing marker's BPF, tag, or enabled flag. + + A BPF change is a delete+re-add on the ubridge side so the pcap is + flushed and the new filter takes effect. + """ + raise NotImplementedError + async def start_capture(self, data_link_type="DLT_EN10MB", capture_file_name=None, wireshark=False, jwt_token=None): """ Start capture on the link @@ -571,6 +627,7 @@ class Link: "nodes": res, "link_id": self._id, "filters": self._filters, + "markers": self._persist_markers(), "link_style": self._link_style, "suspend": self._suspended, "show_filters_icon": getattr(self, '_show_filters_icon', True), @@ -585,6 +642,7 @@ class Link: "capture_compute_id": self.capture_compute_id, "link_type": self._link_type, "filters": self._filters, + "markers": self._markers, "suspend": self._suspended, "link_style": self._link_style, "wireshark": self._wireshark, diff --git a/gns3server/controller/project.py b/gns3server/controller/project.py index 989619940..9ada6506a 100644 --- a/gns3server/controller/project.py +++ b/gns3server/controller/project.py @@ -41,6 +41,7 @@ from ..config import Config from ..utils.path import check_path_allowed, get_default_project_directory from ..utils.application_id import get_next_application_id from ..utils.asyncio.pool import Pool +from ..utils.packet_filter_validation import validate_bpf_syntax from ..utils.asyncio import locking from ..utils.asyncio import aiozipstream from ..utils.asyncio import wait_run_in_executor @@ -211,6 +212,7 @@ class Project: self._allocated_node_names = set() self._nodes = {} self._links = {} + self._marker_definitions = {} # name → {bpf, tag, color, highlight_duration} self._drawings = {} self._snapshots = {} self._computes = [] @@ -765,6 +767,31 @@ class Project: "Dropping invalid filters on link %s: %s", link_data.get("link_id"), e ) + # Restore traffic-insight markers directly into link state (mirrors how + # filters are restored via update_filters). The capture_node_id persisted + # last time is reused for NIO routing; no side resolution is possible here + # because the link's nodes are added later. The marker is applied to + # uBridge by _ubridge_apply_markers when create() runs. Invalid BPF is + # dropped (like invalid filters). + for name, marker in (link_data.get("markers") or {}).items(): + bpf = marker.get("bpf") + if not bpf: + log.warning("Dropping marker %s on link %s: missing bpf", name, link_data.get("link_id")) + continue + result = validate_bpf_syntax(bpf) + if not result.get("valid"): + log.warning( + "Dropping marker %s on link %s: invalid BPF (%s)", + name, link_data.get("link_id"), result.get("error") + ) + continue + link._markers[name] = { + "bpf": bpf, + "tag": marker.get("tag"), + "enabled": marker.get("enabled", True), + "color": marker.get("color"), + "capture_node_id": marker.get("capture_node_id"), + } if "link_style" in link_data: await link.update_link_style(link_data["link_style"]) if "show_filters_icon" in link_data: @@ -872,6 +899,146 @@ class Project: return self._get_closed_data("links", "link_id") return self._links + @property + def markers(self): + """ + Project-level read-only aggregation of all markers across every link. + + Each entry is keyed ``"{link_id}/{marker_name}"`` so the flat dict is + globally unique within the project. The value is a clone of the link's + per-marker dict plus ``link_id`` and ``node_id`` (the capture-side node) + for convenience — the frontend can filter/group by link or node without + extra round-trips. + + :returns: dict[str, dict] — keyed by "{link_id}/{marker_name}" + """ + result = {} + for link_id, link in self._links.items(): + for name, info in link.markers.items(): + key = f"{link_id}/{name}" + result[key] = { + **info, + "link_id": link_id, + "node_id": info.get("capture_node_id"), + } + return result + + @property + def marker_definitions(self): + """ + :returns: dict of project-level marker definitions (name → {bpf, tag, color, highlight_duration}) + """ + return self._marker_definitions + + async def create_marker_definition(self, name, bpf, tag=None, color=None, highlight_duration=None): + """ + Create a project-level marker definition and fan out to every existing + link that has a capable node. Links without a capable node are silently + skipped. + """ + + if name in self._marker_definitions: + raise ControllerError( + f"Marker definition '{name}' already exists in this project" + ) + + self._marker_definitions[name] = {"bpf": bpf, "tag": tag, "color": color, "highlight_duration": highlight_duration} + await self._apply_def_to_all_links(name) + self.dump() + self.emit_notification("project.updated", self.asdict()) + + async def update_marker_definition(self, name, bpf=None, tag=None, color=None, highlight_duration=None): + """ + Update a marker definition and sync every inherited copy on every link. + """ + + if name not in self._marker_definitions: + raise ControllerNotFoundError( + f"Marker definition '{name}' not found in this project" + ) + + d = self._marker_definitions[name] + if bpf is not None: + d["bpf"] = bpf + if tag is not None: + d["tag"] = tag + if color is not None: + d["color"] = color + if highlight_duration is not None: + d["highlight_duration"] = highlight_duration + + # Sync: update every inherited copy across all links. + for link in list(self._links.values()): + marker_name = f"global-{name}" + if marker_name in link.markers and link.markers[marker_name].get("inherited_from") == name: + await link.update_marker( + marker_name, bpf=d["bpf"], tag=d.get("tag"), color=d.get("color"), + highlight_duration=d.get("highlight_duration"), inherited=True + ) + self.dump() + self.emit_notification("project.updated", self.asdict()) + + async def delete_marker_definition(self, name): + """ + Delete a marker definition and remove every inherited copy from every link. + """ + + if name not in self._marker_definitions: + raise ControllerNotFoundError( + f"Marker definition '{name}' not found in this project" + ) + + del self._marker_definitions[name] + + for link in list(self._links.values()): + marker_name = f"global-{name}" + if marker_name in link.markers and link.markers[marker_name].get("inherited_from") == name: + try: + await link.stop_marker(marker_name, inherited=True) + except ControllerError: + # A missing compute or broken link shouldn't block the delete. + log.warning( + "Failed to remove inherited marker %s from link %s", + marker_name, link.id + ) + + self.dump() + self.emit_notification("project.updated", self.asdict()) + + async def _apply_def_to_all_links(self, def_name): + """ + Fan out a single marker definition to every existing link in the project. + Links that have no capable node (``_MARKER_CAPABLE_TYPES``) are silently + skipped — the marker can only live on a uBridge bridge. + """ + + d = self._marker_definitions[def_name] + for link in list(self._links.values()): + try: + await link.inherit_marker(def_name, d) + except ControllerError as e: + # Per-link failures (e.g. no capable node) shouldn't block the + # definition from serving the rest. + log.warning( + "Marker definition '%s' could not be applied to link %s: %s", + def_name, link.id, e + ) + + async def apply_defs_to_new_link(self, link): + """ + Apply every active marker definition to a newly created link so it + inherits project-level rules automatically. + """ + + for def_name, d in self._marker_definitions.items(): + try: + await link.inherit_marker(def_name, d) + except ControllerError as e: + log.warning( + "Marker definition '%s' could not be applied to new link %s: %s", + def_name, link.id, e + ) + @property def snapshots(self): """ @@ -1262,6 +1429,12 @@ class Project: if val is not None: setattr(self, key, val) + # marker_definitions is loaded separately (it is not a __init__ kwarg + # nor a simple attribute — it backs a read-only property). + defs = project_data.get("marker_definitions") + if isinstance(defs, dict): + self._marker_definitions = defs + topology = project_data["topology"] for compute in topology.get("computes", []): compute_id = compute.get("compute_id") @@ -1328,6 +1501,10 @@ class Project: for drawing_data in topology.get("drawings", []): await self.add_drawing(dump=False, **drawing_data) + # Note: project-level marker definitions are applied to each link + # inside UDPLink.create() (the inheritance hook), so they are + # already present once links are loaded — no separate fan-out here. + self.dump() # We catch all error to be able to roll back the .gns3 to the previous state except Exception as e: @@ -1684,6 +1861,7 @@ class Project: "links": len(self._links), "drawings": len(self._drawings), "snapshots": len(self._snapshots), + "markers": sum(len(link.markers) for link in self._links.values()), } def asdict(self): @@ -1708,6 +1886,7 @@ class Project: "supplier": self._supplier, "variables": self._variables, "created_by": self._created_by, + "marker_definitions": self._marker_definitions, } def __repr__(self): diff --git a/gns3server/controller/topology.py b/gns3server/controller/topology.py index 150283c39..a71b88dd6 100644 --- a/gns3server/controller/topology.py +++ b/gns3server/controller/topology.py @@ -88,6 +88,7 @@ def project_to_topology(project): "variables": project.variables, "supplier": project.supplier, "created_by": project.created_by, + "marker_definitions": project.marker_definitions, "topology": {"nodes": [], "links": [], "computes": [], "drawings": []}, "type": "topology", "revision": GNS3_FILE_FORMAT_REVISION, diff --git a/gns3server/controller/udp_link.py b/gns3server/controller/udp_link.py index 7c2e6f187..609c17495 100644 --- a/gns3server/controller/udp_link.py +++ b/gns3server/controller/udp_link.py @@ -19,6 +19,15 @@ from .controller_error import ControllerError, ControllerNotFoundError from .link import Link from .node_types import BUILTIN_NODE_TYPES +from gns3server.utils.packet_filter_validation import validate_bpf_syntax, FilterValidationError + +# Node types without a uBridge bridge — a marker filter has nothing to attach to. +# Node types that can host a marker (have a uBridge bridge to attach the +# `mark` filter to). Mirrors _get_filter_node in link.py, minus "nat" +# (which has no uBridge). +_MARKER_CAPABLE_TYPES = frozenset({ + "vpcs", "qemu", "docker", "iou", "dynamips", "cloud", +}) class UDPLink(Link): @@ -37,7 +46,7 @@ class UDPLink(Link): def _get_node_filters(self, node1, node2): """ Determine which node gets the active filters applied. - + :returns: Tuple of (node1_filters, node2_filters) """ filter_node = self._get_filter_node() @@ -46,6 +55,26 @@ class UDPLink(Link): self.get_active_filters() if filter_node == node2 else {}, ) + def _markers_for_node(self, node): + """ + Marker specs (name -> {bpf, tag, link_id}) for the markers whose capture + side is ``node`` and that are enabled. Routed by capture_node_id so a + marker only rides the NIO of the node whose uBridge will host it. + """ + return { + name: {"bpf": m["bpf"], "tag": m.get("tag"), "link_id": self._id} + for name, m in self._markers.items() + if m.get("enabled", True) and m.get("capture_node_id") == node.id + } + + def _get_node_markers(self, node1, node2): + """ + Determine which node gets which markers applied. + + :returns: Tuple of (node1_markers, node2_markers) + """ + return self._markers_for_node(node1), self._markers_for_node(node2) + async def create(self): """ Create the link on the nodes @@ -80,6 +109,7 @@ class UDPLink(Link): self._node2_port = response.json["udp_port"] node1_filters, node2_filters = self._get_node_filters(node1, node2) + node1_markers, node2_markers = self._get_node_markers(node1, node2) # Create the tunnel on both side self._link_data.append( @@ -89,6 +119,7 @@ class UDPLink(Link): "rport": self._node2_port, "type": "nio_udp", "filters": node1_filters, + "markers": node1_markers, "suspend": self._suspended, } ) @@ -101,6 +132,7 @@ class UDPLink(Link): "rport": self._node1_port, "type": "nio_udp", "filters": node2_filters, + "markers": node2_markers, "suspend": self._suspended, } ) @@ -113,6 +145,9 @@ class UDPLink(Link): await node1.delete(f"/adapters/{adapter_number1}/ports/{port_number1}/nio", timeout=120) raise e self._created = True + # New links automatically inherit every active project-level marker + # definition so the user doesn't have to reconfigure. + await self._project.apply_defs_to_new_link(self) async def update(self): """ @@ -125,10 +160,12 @@ class UDPLink(Link): node2 = self._nodes[1]["node"] node1_filters, node2_filters = self._get_node_filters(node1, node2) + node1_markers, node2_markers = self._get_node_markers(node1, node2) adapter_number1 = self._nodes[0]["adapter_number"] port_number1 = self._nodes[0]["port_number"] self._link_data[0]["filters"] = node1_filters + self._link_data[0]["markers"] = node1_markers self._link_data[0]["suspend"] = self._suspended if node1.node_type not in ("ethernet_switch", "ethernet_hub"): await node1.put( @@ -138,6 +175,7 @@ class UDPLink(Link): adapter_number2 = self._nodes[1]["adapter_number"] port_number2 = self._nodes[1]["port_number"] self._link_data[1]["filters"] = node2_filters + self._link_data[1]["markers"] = node2_markers self._link_data[1]["suspend"] = self._suspended if node2.node_type not in ("ethernet_switch", "ethernet_hub"): await node2.put( @@ -245,9 +283,161 @@ class UDPLink(Link): raise ControllerError("Cannot capture because there is no running device on this link") + def _choose_marker_side(self): + """ + Pick the node that will host the marker, mirroring ``_get_filter_node`` + in link.py. Only types with a uBridge bridge (``_MARKER_CAPABLE_TYPES``) + are eligible. A running node is preferred, but a stopped one is + accepted — like packet filters, the marker is stored on the NIO and + applied when the node starts. + """ + + # Prefer started. + for node in self._nodes: + if ( + node["node"].node_type in _MARKER_CAPABLE_TYPES + and node["node"].status == "started" + ): + return node + + # Accept stopped but capable (marker rides NIO, applied at start). + for node in self._nodes: + if node["node"].node_type in _MARKER_CAPABLE_TYPES: + return node + + raise ControllerError( + "Cannot add marker because no device on this link supports " + "traffic insight" + ) + async def node_updated(self, node): """ Called when a node member of the link is updated """ if self._capture_node and node == self._capture_node["node"] and node.status != "started": await self.stop_capture() + # Marker clean-up is *not* done on node stop — markers are a persistent + # link-scoped feature that recovers via NIO on restart (see + # _ubridge_apply_markers in add_ubridge_udp_connection). The user + # explicitly deletes a marker via the REST API, and a marker is torn + # down automatically only when its link is deleted. + + async def start_marker(self, name, bpf, tag=None, color=None, highlight_duration=None, inherited_from=None): + """ + Attach a traffic-insight marker to this link. + + State-only model (mirrors ``update_filters``): record the marker in + ``_markers`` (with its capture-side node id for NIO routing), then push + via ``self.update()`` so it rides the NIO and is applied by + ``_ubridge_apply_markers``. No dedicated uBridge round-trip — exactly + how packet filters are applied. + + :param name: stable filter name — echoed in MARK signals + pcap identity + :param bpf: libpcap BPF expression + :param tag: optional correlation id + :param color: optional hex color for the Web UI (e.g. '#ff5722'); stored + with the link and persisted in the topology, never sent to uBridge + :param highlight_duration: optional UI-only hint (milliseconds) for how + long a match keeps the marker highlighted; stored, never sent to uBridge + :param inherited_from: def name when this marker is a project-level + inheritance copy; set automatically, never exposed to REST callers + """ + + if name in self._markers: + raise ControllerError(f"Marker '{name}' already exists on link {self._id}") + + result = validate_bpf_syntax(bpf) + if not result.get("valid"): + raise ControllerError(f"Invalid BPF expression: {result.get('error', 'unknown error')}") + + marker_side = self._choose_marker_side() + marker_entry = { + "bpf": bpf, + "tag": tag, + "enabled": True, + "color": color, + "highlight_duration": highlight_duration, + "capture_node_id": marker_side["node"].id, + } + if inherited_from: + marker_entry["inherited_from"] = inherited_from + self._markers[name] = marker_entry + if self._created: + await self.update() + self._project.emit_notification("link.updated", self.asdict()) + self._project.dump() + + async def stop_marker(self, name, inherited=False): + """ + Remove a traffic-insight marker from this link. + + Drop it from ``_markers`` and push via ``self.update()``: the NIO + reset+reapply in ``_ubridge_apply_filters``/``_ubridge_apply_markers`` + drops it from uBridge. Mirrors how deleting a packet filter works. + + :param name: filter name to remove + :param inherited: set by project-level def-delete to bypass the + inheritance guard (the project layer is the legitimate remover) + """ + + if name not in self._markers: + raise ControllerNotFoundError(f"Marker '{name}' not found on link {self._id}") + + if self._markers[name].get("inherited_from") and not inherited: + raise ControllerError( + f"Marker '{name}' is inherited from the project-level " + f"definition '{self._markers[name]['inherited_from']}'. " + "Delete or update it via the marker-definitions API instead." + ) + + del self._markers[name] + if self._created: + await self.update() + self._project.emit_notification("link.updated", self.asdict()) + self._project.dump() + + async def update_marker(self, name, bpf=None, tag=None, enabled=None, color=None, highlight_duration=None, inherited=False): + """ + Update an existing marker's BPF/tag/enabled/color. Any change pushes via + ``self.update()``; uBridge picks up the new params on the next NIO + reset+reapply (same as packet filters). + + :param name: filter name to update + :param bpf: new BPF expression (None = keep existing) + :param tag: new tag id (None = keep existing) + :param enabled: toggle (None = keep existing) + :param color: new hex color (None = keep existing) + :param highlight_duration: new UI highlight duration in ms (None = keep existing) + :param inherited: set by project-level sync to bypass the inheritance + guard (the project layer is the legitimate editor) + """ + + marker_info = self._markers.get(name) + if not marker_info: + raise ControllerNotFoundError(f"Marker '{name}' not found on link {self._id}") + + if marker_info.get("inherited_from") and not inherited: + raise ControllerError( + f"Marker '{name}' is inherited from the project-level " + f"definition '{marker_info['inherited_from']}'. " + "Update it via the marker-definitions API instead." + ) + + if bpf is not None and bpf != marker_info["bpf"]: + result = validate_bpf_syntax(bpf) + if not result.get("valid"): + raise ControllerError(f"Invalid BPF expression: {result.get('error', 'unknown error')}") + marker_info["bpf"] = bpf + if tag is not None: + marker_info["tag"] = tag + if enabled is not None: + marker_info["enabled"] = enabled + if color is not None: + marker_info["color"] = color + if highlight_duration is not None: + marker_info["highlight_duration"] = highlight_duration + + if self._created: + await self.update() + self._project.emit_notification("link.updated", self.asdict()) + self._project.dump() diff --git a/gns3server/core/tasks.py b/gns3server/core/tasks.py index d4968d8f5..9fc911d55 100644 --- a/gns3server/core/tasks.py +++ b/gns3server/core/tasks.py @@ -24,6 +24,7 @@ from gns3server.controller import Controller from gns3server.config import Config from gns3server.compute import MODULES from gns3server.compute.port_manager import PortManager +from gns3server.compute.marker.marker_manager import MarkerManager from gns3server.utils.http_client import HTTPClient from gns3server.db.tasks import connect_to_db, get_computes, disconnect_from_db, discover_images_on_filesystem @@ -84,6 +85,14 @@ async def startup(app: FastAPI) -> None: m = module.instance() m.port_manager = PortManager.instance() + # Start the marker (traffic-insight) UDP sink. One listener per compute + # process receives ubridge MARK signals; ubridges are told its host/port at + # startup (see BaseNode._start_ubridge). + server_settings = Config.instance().settings.Server + await MarkerManager.instance().start( + host=server_settings.marker_listen_host, port=server_settings.marker_listen_port + ) + # Mark MCP server as ready to accept connections (if MCP is available) from gns3server.agent import MCP_AVAILABLE @@ -101,6 +110,7 @@ async def shutdown(app: FastAPI) -> None: if auto_discover_images_task_handle is not None and not auto_discover_images_task_handle.cancelled(): auto_discover_images_task_handle.cancel() await HTTPClient.close_session() + await MarkerManager.instance().stop() await Controller.instance().stop() for module in MODULES: diff --git a/gns3server/schemas/__init__.py b/gns3server/schemas/__init__.py index d228f4b84..7519639bc 100644 --- a/gns3server/schemas/__init__.py +++ b/gns3server/schemas/__init__.py @@ -20,7 +20,7 @@ from .common import ErrorMessage from .version import Version # Controller schemas -from .controller.links import LinkCreate, LinkUpdate, Link, UDPPortInfo, EthernetPortInfo, LinkCapture +from .controller.links import LinkCreate, LinkUpdate, Link, UDPPortInfo, EthernetPortInfo, LinkCapture, MarkerCreate, MarkerDefinitionCreate from .controller.computes import ComputeCreate, ComputeUpdate, ComputeVirtualBoxVM, ComputeVMwareVM, ComputeDockerImage, AutoIdlePC, Compute from .controller.templates import TemplateCreate, TemplateUpdate, TemplateUsage, Template from .controller.images import Image, ImageType diff --git a/gns3server/schemas/compute/nios.py b/gns3server/schemas/compute/nios.py index cf69f9e30..f5cf5f073 100644 --- a/gns3server/schemas/compute/nios.py +++ b/gns3server/schemas/compute/nios.py @@ -36,6 +36,7 @@ class UDPNIO(BaseModel): rport: int = Field(..., gt=0, le=65535, description="Remote port") suspend: Optional[bool] = Field(None, description="Suspend the NIO") filters: Optional[dict] = Field(None, description="Packet filters") + markers: Optional[dict] = Field(None, description="Traffic-insight markers") class EthernetNIOType(str, Enum): diff --git a/gns3server/schemas/config.py b/gns3server/schemas/config.py index 294ea4cf6..12e57b7a2 100644 --- a/gns3server/schemas/config.py +++ b/gns3server/schemas/config.py @@ -153,6 +153,12 @@ class ServerSettings(BaseModel): udp_start_port_range: int = Field(10000, gt=0, le=65535) udp_end_port_range: int = Field(30000, gt=0, le=65535) ubridge_path: str = "ubridge" + # Marker (traffic-insight) UDP sink: one listener per compute process that + # receives ubridge MARK signals from every ubridge on this host. The host + # defaults to loopback because ubridge runs on the same host as the compute. + # port=0 lets the OS choose a free port (read back and handed to ubridge). + marker_listen_host: str = "127.0.0.1" + marker_listen_port: int = Field(3070, ge=0, le=65535) compute_username: str = "gns3" compute_password: SecretStr = SecretStr("") allowed_interfaces: List[str] = Field(default_factory=list) diff --git a/gns3server/schemas/controller/links.py b/gns3server/schemas/controller/links.py index be6846bb8..23a0cd18a 100644 --- a/gns3server/schemas/controller/links.py +++ b/gns3server/schemas/controller/links.py @@ -62,6 +62,10 @@ class LinkBase(BaseModel): suspend: Optional[bool] = None link_style: Optional[LinkStyle] = None filters: Optional[dict] = None + markers: Optional[dict] = Field( + None, + description="Traffic-insight markers on this link: name → {bpf, tag, enabled}" + ) show_filters_icon: Optional[bool] = Field( True, description="Show filters icon in Web UI" @@ -135,3 +139,73 @@ class LinkCapture(BaseModel): data_link_type: str = "DLT_EN10MB" capture_file_name: Optional[str] = None wireshark: bool = False + + +class MarkerCreate(BaseModel): + """ + Body for attaching a traffic-insight marker to a link. + + ``name`` is optional at the controller REST layer (auto-generated when + absent) but always set when the controller forwards to the compute. + """ + + name: Optional[str] = Field( + None, + pattern=r"^[A-Za-z0-9][A-Za-z0-9_.-]*$", + max_length=128, + description='Unique marker name on the link. Auto-generated when absent.', + ) + bpf: str + tag: Optional[int] = None + link_id: Optional[str] = None + color: Optional[str] = Field( + None, + description="User-chosen hex color for this marker in the Web UI, e.g. '#ff5722'", + ) + highlight_duration: Optional[int] = Field( + None, + ge=1, + description=( + "How long (milliseconds) the Web UI keeps this marker highlighted " + "after a match. Omitted = use the UI default. Pure render hint — " + "stored on the link, never sent to uBridge." + ), + ) + enabled: Optional[bool] = Field( + None, + description="Whether the marker is active. Defaults to true on creation.", + ) + + +class MarkerDefinitionCreate(BaseModel): + """ + Body for creating / updating a project-level marker definition. + + The definition is a template — when applied to a link the marker name is + prefixed with ``global-`` (e.g. ``arp`` → ``global-arp``) so it can never + collide with a per-link private marker. + """ + + name: Optional[str] = Field( + None, + pattern=r"^[A-Za-z0-9][A-Za-z0-9_.-]*$", + max_length=128, + description="Unique definition name. Auto-generated when absent.", + ) + bpf: str + tag: Optional[int] = None + color: Optional[str] = Field( + None, + description="User-chosen hex color for the marker in the Web UI, e.g. '#ff5722'", + ) + highlight_duration: Optional[int] = Field( + None, + ge=1, + description=( + "How long (milliseconds) the Web UI keeps this marker highlighted " + "after a match. Omitted = use the UI default. Pure render hint — " + "stored with the definition, never sent to uBridge." + ), + ) + + diff --git a/scripts/gns3_server.conf b/scripts/gns3_server.conf index 196ad472d..b8b367e7f 100644 --- a/scripts/gns3_server.conf +++ b/scripts/gns3_server.conf @@ -4,3 +4,7 @@ compute_password = gns3 skills_repo_url = https://github.com/yueguobin/GNS3-Skills.git skills_repo_branch = main skills_auto_update = false + +; Marker (traffic-insight) UDP sink port for uBridge MARK signals +; Set to 0 for OS-chosen port +marker_listen_port = 3070 diff --git a/tests/api/routes/controller/test_markers.py b/tests/api/routes/controller/test_markers.py new file mode 100644 index 000000000..d9fc27b3b --- /dev/null +++ b/tests/api/routes/controller/test_markers.py @@ -0,0 +1,256 @@ +# -*- coding: utf-8 -*- +# +# Copyright (C) 2025 GNS3 Technologies Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +""" +HTTP-route tests for the traffic-insight marker endpoints: per-link markers, +project-level definitions, and the project-wide aggregation view. +""" + +import pytest +from fastapi import FastAPI, status +from httpx import AsyncClient + +from tests.utils import asyncio_patch + +from gns3server.controller.project import Project +from gns3server.controller.udp_link import UDPLink + +pytestmark = pytest.mark.asyncio + + +def _inherited(link, name="arp"): + """Inject an inherited marker so the controller's inheritance guard can fire.""" + link._markers[f"global-{name}"] = { + "bpf": name, "tag": None, "enabled": True, "color": None, + "highlight_duration": None, "capture_node_id": "node-id", + "inherited_from": name, + } + + +class TestMarkerRoutes: + + # ----------------------------------------------------------------------- + # Per-link markers + # ----------------------------------------------------------------------- + + async def test_create_marker(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + link = UDPLink(project) + project._links = {link.id: link} + + with asyncio_patch("gns3server.controller.udp_link.UDPLink.start_marker") as mock: + response = await client.post( + app.url_path_for("create_marker", project_id=project.id, link_id=link.id), + json={"bpf": "icmp", "tag": 3, "color": "#ff5722", "highlight_duration": 800}, + ) + + assert response.status_code == status.HTTP_201_CREATED + mock.assert_called_once() + _, kwargs = mock.call_args + assert kwargs["bpf"] == "icmp" + assert kwargs["tag"] == 3 + assert kwargs["color"] == "#ff5722" + assert kwargs["highlight_duration"] == 800 + assert kwargs["name"].startswith("marker-") + + async def test_create_marker_with_explicit_name(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + link = UDPLink(project) + project._links = {link.id: link} + + with asyncio_patch("gns3server.controller.udp_link.UDPLink.start_marker") as mock: + response = await client.post( + app.url_path_for("create_marker", project_id=project.id, link_id=link.id), + json={"name": "web", "bpf": "tcp port 80"}, + ) + assert response.status_code == status.HTTP_201_CREATED + _, kwargs = mock.call_args + assert kwargs["name"] == "web" + + async def test_create_marker_global_prefix_rejected(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + link = UDPLink(project) + project._links = {link.id: link} + + with asyncio_patch("gns3server.controller.udp_link.UDPLink.start_marker") as mock: + response = await client.post( + app.url_path_for("create_marker", project_id=project.id, link_id=link.id), + json={"name": "global-x", "bpf": "icmp"}, + ) + assert response.status_code == status.HTTP_409_CONFLICT + assert not mock.called # rejected before reaching the controller + + async def test_create_marker_bad_format_rejected(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + link = UDPLink(project) + project._links = {link.id: link} + + response = await client.post( + app.url_path_for("create_marker", project_id=project.id, link_id=link.id), + json={"name": "bad name!", "bpf": "icmp"}, + ) + assert response.status_code == status.HTTP_422_UNPROCESSABLE_ENTITY + + async def test_get_markers(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + link = UDPLink(project) + link._markers["web"] = {"bpf": "tcp port 80", "tag": None, "enabled": True, + "color": None, "highlight_duration": 800, "capture_node_id": "n1"} + project._links = {link.id: link} + + response = await client.get( + app.url_path_for("get_markers", project_id=project.id, link_id=link.id) + ) + assert response.status_code == status.HTTP_200_OK + assert response.json()["web"]["highlight_duration"] == 800 + + async def test_update_marker(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + link = UDPLink(project) + project._links = {link.id: link} + + with asyncio_patch("gns3server.controller.udp_link.UDPLink.update_marker") as mock: + response = await client.put( + app.url_path_for("update_marker", project_id=project.id, link_id=link.id, marker_name="web"), + json={"bpf": "udp port 53", "highlight_duration": 1500}, + ) + assert response.status_code == status.HTTP_200_OK + _, kwargs = mock.call_args + assert kwargs["bpf"] == "udp port 53" + assert kwargs["highlight_duration"] == 1500 + + async def test_update_inherited_marker_rejected(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + link = UDPLink(project) + _inherited(link, "arp") + project._links = {link.id: link} + + response = await client.put( + app.url_path_for("update_marker", project_id=project.id, link_id=link.id, marker_name="global-arp"), + json={"name": "global-arp", "bpf": "arp"}, + ) + assert response.status_code == status.HTTP_409_CONFLICT + assert "inherited" in response.json()["message"] + + async def test_delete_marker(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + link = UDPLink(project) + project._links = {link.id: link} + + with asyncio_patch("gns3server.controller.udp_link.UDPLink.stop_marker") as mock: + response = await client.delete( + app.url_path_for("delete_marker", project_id=project.id, link_id=link.id, marker_name="web") + ) + assert response.status_code == status.HTTP_204_NO_CONTENT + mock.assert_called_once_with("web") + + async def test_delete_inherited_marker_rejected(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + link = UDPLink(project) + _inherited(link, "arp") + project._links = {link.id: link} + + response = await client.delete( + app.url_path_for("delete_marker", project_id=project.id, link_id=link.id, marker_name="global-arp") + ) + assert response.status_code == status.HTTP_409_CONFLICT + + # ----------------------------------------------------------------------- + # Project-level marker definitions + # ----------------------------------------------------------------------- + + async def test_create_marker_definition(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + with asyncio_patch("gns3server.controller.project.Project.create_marker_definition") as mock: + response = await client.post( + app.url_path_for("create_marker_definition", project_id=project.id), + json={"name": "arp", "bpf": "arp", "highlight_duration": 1200}, + ) + assert response.status_code == status.HTTP_201_CREATED + _, kwargs = mock.call_args + assert kwargs["name"] == "arp" + assert kwargs["bpf"] == "arp" + assert kwargs["highlight_duration"] == 1200 + + async def test_create_marker_definition_global_prefix_rejected(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + with asyncio_patch("gns3server.controller.project.Project.create_marker_definition") as mock: + response = await client.post( + app.url_path_for("create_marker_definition", project_id=project.id), + json={"name": "global-x", "bpf": "arp"}, + ) + assert response.status_code == status.HTTP_409_CONFLICT + assert not mock.called + + async def test_update_marker_definition(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + with asyncio_patch("gns3server.controller.project.Project.update_marker_definition") as mock: + response = await client.put( + app.url_path_for("update_marker_definition", project_id=project.id, def_name="arp"), + json={"bpf": "arp or rarp", "highlight_duration": 900}, + ) + assert response.status_code == status.HTTP_200_OK + _, kwargs = mock.call_args + assert kwargs["bpf"] == "arp or rarp" + assert kwargs["highlight_duration"] == 900 + + async def test_delete_marker_definition(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + with asyncio_patch("gns3server.controller.project.Project.delete_marker_definition") as mock: + response = await client.delete( + app.url_path_for("delete_marker_definition", project_id=project.id, def_name="arp") + ) + assert response.status_code == status.HTTP_204_NO_CONTENT + mock.assert_called_once_with("arp") + + async def test_get_marker_definitions(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + project._marker_definitions = { + "arp": {"bpf": "arp", "tag": 5, "color": None, "highlight_duration": 1200}, + } + project._links = {} + + response = await client.get( + app.url_path_for("get_marker_definitions", project_id=project.id) + ) + assert response.status_code == status.HTTP_200_OK + body = response.json() + assert body["arp"]["bpf"] == "arp" + assert body["arp"]["highlight_duration"] == 1200 + assert body["arp"]["link_ids"] == [] + + # ----------------------------------------------------------------------- + # Aggregation + # ----------------------------------------------------------------------- + + async def test_get_project_markers(self, app: FastAPI, client: AsyncClient, project: Project) -> None: + + link = UDPLink(project) + link._markers["icmp"] = {"bpf": "icmp", "tag": 1, "enabled": True, "color": "#ff5722", + "highlight_duration": 800, "capture_node_id": "node-1"} + project._links = {link.id: link} + + response = await client.get( + app.url_path_for("get_project_markers", project_id=project.id) + ) + assert response.status_code == status.HTTP_200_OK + body = response.json() + key = f"{link.id}/icmp" + assert key in body + assert body[key]["highlight_duration"] == 800 + assert body[key]["link_id"] == link.id + assert body[key]["node_id"] == "node-1" diff --git a/tests/compute/marker/__init__.py b/tests/compute/marker/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/compute/marker/test_marker_manager.py b/tests/compute/marker/test_marker_manager.py new file mode 100644 index 000000000..4a2796002 --- /dev/null +++ b/tests/compute/marker/test_marker_manager.py @@ -0,0 +1,240 @@ +#!/usr/bin/env python +# +# Copyright (C) 2024 GNS3 Technologies Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import asyncio +import pytest + +from gns3server.compute.marker.marker_manager import MarkerManager +from gns3server.compute.marker.marker_listener import MarkerListener + + +# --------------------------------------------------------------------------- +# Registry +# --------------------------------------------------------------------------- + +class TestMarkerRegistry: + + def test_register_and_lookup(self): + MarkerManager.reset() + mgr = MarkerManager.instance() + mgr.register("proj1", "node1", "filter1", "link1", tag=5) + pid, lid, tag = mgr.lookup("node1", "filter1") + assert pid == "proj1" + assert lid == "link1" + assert tag == 5 + + def test_miss_returns_none(self): + MarkerManager.reset() + mgr = MarkerManager.instance() + pid, lid, tag = mgr.lookup("no-such-node", "no-such-filter") + assert pid is None + + def test_reregister_updates(self): + MarkerManager.reset() + mgr = MarkerManager.instance() + mgr.register("p", "n", "f", "l", tag=1) + mgr.register("p", "n", "f", "l", tag=99) + _, _, tag = mgr.lookup("n", "f") + assert tag == 99 + + def test_unregister(self): + MarkerManager.reset() + mgr = MarkerManager.instance() + mgr.register("p", "n", "f", "l") + assert mgr.unregister("n", "f") is True + pid, _, _ = mgr.lookup("n", "f") + assert pid is None + assert mgr.unregister("n", "f") is False + + def test_unregister_project(self): + MarkerManager.reset() + mgr = MarkerManager.instance() + mgr.register("p1", "n1", "f1", "l1") + mgr.register("p1", "n2", "f2", "l2") + mgr.register("p2", "n3", "f3", "l3") + mgr.unregister_project("p1") + assert mgr.lookup("n1", "f1") == (None, None, None) + assert mgr.lookup("n2", "f2") == (None, None, None) + assert mgr.lookup("n3", "f3")[0] == "p2" + + def test_re_add_after_project_clear(self): + MarkerManager.reset() + mgr = MarkerManager.instance() + mgr.register("p", "n", "f", "l") + mgr.unregister_project("p") + mgr.register("p", "n", "f", "l2", tag=42) + pid, lid, tag = mgr.lookup("n", "f") + assert pid == "p" and lid == "l2" and tag == 42 + + +# --------------------------------------------------------------------------- +# MarkerListener parsing +# --------------------------------------------------------------------------- + +class FakeMarkerManager: + def __init__(self): + self.events = [] + self._entries = {} + + def lookup(self, node_id, filter_name): + e = self._entries.get((node_id, filter_name)) + if e is None: + return None, None, None + return e["project_id"], e["link_id"], e["tag"] + + def emit_match(self, project_id, event): + self.events.append((project_id, event)) + + def register(self, project_id, node_id, filter_name, link_id, tag): + self._entries[(node_id, filter_name)] = { + "project_id": project_id, "link_id": link_id, "tag": tag + } + + +class TestMarkerListener: + + def test_parses_valid_mark_datagram(self): + fmgr = FakeMarkerManager() + fmgr.register("p1", "n1", "f1", "l1", tag=7) + lis = MarkerListener(fmgr) + lis.connection_made(None) + lis.datagram_received( + b"MARK 1700000000.123456 node=n1 filter=f1 tag=7 len=98\n", + ("127.0.0.1", 9999), + ) + assert len(fmgr.events) == 1 + _, ev = fmgr.events[0] + assert ev["node_id"] == "n1" + assert ev["link_id"] == "l1" + assert ev["filter"] == "f1" + assert ev["tag"] == "7" + assert ev["ts"] == pytest.approx(1700000000.123456) + assert ev["len"] == 98 + + def test_unknown_node_dropped(self): + fmgr = FakeMarkerManager() + lis = MarkerListener(fmgr) + lis.connection_made(None) + lis.datagram_received(b"MARK 1.0 node=bad filter=bad len=10\n", None) + assert fmgr.events == [] + + def test_bad_timestamp_ignored(self): + fmgr = FakeMarkerManager() + lis = MarkerListener(fmgr) + lis.connection_made(None) + lis.datagram_received(b"MARK badts node=n filter=f len=1\n", None) + assert fmgr.events == [] + + def test_not_mark_line_ignored(self): + fmgr = FakeMarkerManager() + lis = MarkerListener(fmgr) + lis.connection_made(None) + lis.datagram_received(b"HELLO world\n", None) + assert fmgr.events == [] + + def test_missing_node_ignored(self): + fmgr = FakeMarkerManager() + lis = MarkerListener(fmgr) + lis.connection_made(None) + lis.datagram_received(b"MARK 1.0 filter=f len=1\n", None) + assert fmgr.events == [] + + def test_tag_dash_falls_back_to_registered(self): + fmgr = FakeMarkerManager() + fmgr.register("p", "n", "f", "l", tag=42) + lis = MarkerListener(fmgr) + lis.connection_made(None) + lis.datagram_received(b"MARK 2.0 node=n filter=f tag=- len=20\n", None) + assert fmgr.events[0][1]["tag"] == 42 + + def test_link_in_signal_overrides_registry_link(self): + # Per-link attribution (contract §3.2/§3.3): the signal's `link=` is + # authoritative and must disambiguate links sharing a node+filter — + # e.g. several links on one IOU node under the same global marker name. + fmgr = FakeMarkerManager() + fmgr.register("p", "n", "f", "registry-link", tag=1) + lis = MarkerListener(fmgr) + lis.connection_made(None) + lis.datagram_received( + b"MARK 3.0 node=n filter=f link=signal-link tag=1 len=42\n", None + ) + assert fmgr.events[0][1]["link_id"] == "signal-link" + + def test_link_dash_falls_back_to_registry_link(self): + # Legacy signals that carry no link fall back to the registry's link_id. + fmgr = FakeMarkerManager() + fmgr.register("p", "n", "f", "registry-link", tag=1) + lis = MarkerListener(fmgr) + lis.connection_made(None) + lis.datagram_received(b"MARK 3.0 node=n filter=f link=- tag=1 len=42\n", None) + assert fmgr.events[0][1]["link_id"] == "registry-link" + + def test_exception_does_not_kill_listener(self): + fmgr = FakeMarkerManager() + lis = MarkerListener(fmgr) + lis.connection_made(None) + # Non-decodable bytes + lis.datagram_received(b"\xff\xfe\xfd", None) + # The listener swallows exceptions; reaching here proves it survived. + assert True + + +# --------------------------------------------------------------------------- +# UDP round-trip +# --------------------------------------------------------------------------- + +@pytest.mark.asyncio +class TestMarkerManagerUDP: + + async def test_listener_receives_and_dispatches(self): + MarkerManager.reset() + mgr = MarkerManager.instance() + + captured = [] + original_emit = mgr.emit_match + mgr.emit_match = lambda pid, ev: captured.append((pid, ev)) + + await mgr.start("127.0.0.1", 0) + assert mgr.running + assert mgr.port is not None + + mgr.register("proj-rt", "node-rt", "filt-rt", "link-rt", tag=10) + + loop = asyncio.get_running_loop() + + class SendProto(asyncio.DatagramProtocol): + def connection_made(self, transport): + self.transport = transport + + sp = SendProto() + transport, _ = await loop.create_datagram_endpoint( + lambda: sp, remote_addr=("127.0.0.1", mgr.port) + ) + transport.sendto( + b"MARK 123.456 node=node-rt filter=filt-rt tag=10 len=88\n" + ) + await asyncio.sleep(0.15) + transport.close() + + mgr.emit_match = original_emit + await mgr.stop() + + assert len(captured) == 1 + pid, ev = captured[0] + assert pid == "proj-rt" + assert ev["link_id"] == "link-rt" + assert ev["len"] == 88 diff --git a/tests/controller/test_link.py b/tests/controller/test_link.py index 239682948..54d1db5ba 100644 --- a/tests/controller/test_link.py +++ b/tests/controller/test_link.py @@ -221,6 +221,7 @@ async def test_json(project, compute): } ], "filters": {}, + "markers": {}, "show_filters_icon": True, "link_style": {}, "suspend": False, @@ -255,6 +256,7 @@ async def test_json(project, compute): ], "link_style": {}, "filters": {}, + "markers": {}, "show_filters_icon": True, "suspend": False } diff --git a/tests/controller/test_marker.py b/tests/controller/test_marker.py new file mode 100644 index 000000000..7dc0ebe13 --- /dev/null +++ b/tests/controller/test_marker.py @@ -0,0 +1,346 @@ +#!/usr/bin/env python +# +# Copyright (C) 2025 GNS3 Technologies Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +""" +Controller-layer tests for the traffic-insight marker feature: + +* UDPLink.start_marker / stop_marker / update_marker — storage, guards, + inheritance bypass, and partial-update preservation of render hints. +* Project.create/update/delete_marker_definition — fan-out, sync, cleanup. +* Project.apply_defs_to_new_link and the markers aggregation property. +""" + +import pytest +from unittest.mock import MagicMock, patch + +from tests.utils import AsyncioMagicMock + +from gns3server.controller.udp_link import UDPLink +from gns3server.controller.ports.ethernet_port import EthernetPort +from gns3server.controller.node import Node +from gns3server.controller.controller_error import ControllerError, ControllerNotFoundError + + +def _valid_bpf(): + """Bypass tcpdump-based BPF validation so tests don't depend on tcpdump.""" + return patch( + "gns3server.controller.udp_link.validate_bpf_syntax", + return_value={"valid": True, "error": None}, + ) + + +async def _make_link(project): + """Build a created UDPLink between two VPCS nodes on a mocked compute.""" + + compute = MagicMock() + compute.id = "local" + compute.host = "example.com" + + node1 = Node(project, compute, "n1", node_type="vpcs") + node1._ports = [EthernetPort("E0", 0, 0, 0)] + node2 = Node(project, compute, "n2", node_type="vpcs") + node2._ports = [EthernetPort("E0", 0, 0, 1)] + + async def subnet(_other): + return ("192.168.1.1", "192.168.1.2") + + async def udp_cb(path, data={}, **kwargs): + response = MagicMock() + response.json = {"udp_port": 1234} + return response + + compute.get_ip_on_same_subnet.side_effect = subnet + compute.post.side_effect = udp_cb + # start_marker / update_marker push via node.put -> compute.put; make it awaitable. + compute.put = AsyncioMagicMock() + compute.delete = AsyncioMagicMock() + + link = UDPLink(project) + await link.add_node(node1, 0, 0) + await link.add_node(node2, 0, 1) + # Register with the project so definition fan-out (which iterates _links) reaches it. + project._links[link.id] = link + return link + + +# --------------------------------------------------------------------------- +# UDPLink.start_marker +# --------------------------------------------------------------------------- + +@pytest.mark.asyncio +async def test_start_marker_stores_entry(project): + + with _valid_bpf(): + link = await _make_link(project) + await link.start_marker("icmp", "icmp", tag=7, color="#ff5722", highlight_duration=800) + + entry = link.markers["icmp"] + assert entry["bpf"] == "icmp" + assert entry["tag"] == 7 + assert entry["color"] == "#ff5722" + assert entry["highlight_duration"] == 800 + assert entry["enabled"] is True + assert entry["capture_node_id"] in {n["node"].id for n in link._nodes} + assert "inherited_from" not in entry + + +@pytest.mark.asyncio +async def test_start_marker_rejects_duplicate(project): + + with _valid_bpf(): + link = await _make_link(project) + await link.start_marker("icmp", "icmp") + with pytest.raises(ControllerError): + await link.start_marker("icmp", "tcp") + + +@pytest.mark.asyncio +async def test_start_marker_rejects_invalid_bpf(project): + + link = await _make_link(project) + with patch("gns3server.controller.udp_link.validate_bpf_syntax", + return_value={"valid": False, "error": "bad expression"}): + with pytest.raises(ControllerError): + await link.start_marker("bad", "not a real bpf") + + +# --------------------------------------------------------------------------- +# UDPLink.stop_marker +# --------------------------------------------------------------------------- + +@pytest.mark.asyncio +async def test_stop_marker_removes(project): + + with _valid_bpf(): + link = await _make_link(project) + await link.start_marker("icmp", "icmp") + assert "icmp" in link.markers + await link.stop_marker("icmp") + assert "icmp" not in link.markers + + +@pytest.mark.asyncio +async def test_stop_marker_rejects_inherited(project): + + with _valid_bpf(): + link = await _make_link(project) + await link.inherit_marker("arp", {"bpf": "arp"}) + # Per-link delete of an inherited marker must be refused (use the def API). + with pytest.raises(ControllerError): + await link.stop_marker("global-arp") + assert "global-arp" in link.markers # still present + + +@pytest.mark.asyncio +async def test_stop_marker_inherited_bypass(project): + """The def-delete path passes inherited=True to remove inherited copies.""" + + with _valid_bpf(): + link = await _make_link(project) + await link.inherit_marker("arp", {"bpf": "arp"}) + await link.stop_marker("global-arp", inherited=True) + assert "global-arp" not in link.markers + + +@pytest.mark.asyncio +async def test_stop_marker_unknown_raises(project): + + link = await _make_link(project) + with pytest.raises(ControllerNotFoundError): + await link.stop_marker("nope") + + +# --------------------------------------------------------------------------- +# UDPLink.update_marker +# --------------------------------------------------------------------------- + +@pytest.mark.asyncio +async def test_update_marker_preserves_render_hints(project): + """A partial update (bpf only) must not reset color/highlight_duration/tag.""" + + with _valid_bpf(): + link = await _make_link(project) + await link.start_marker("m", "icmp", tag=1, color="#ff5722", highlight_duration=800) + await link.update_marker("m", bpf="tcp port 80") + + entry = link.markers["m"] + assert entry["bpf"] == "tcp port 80" + assert entry["color"] == "#ff5722" # preserved + assert entry["highlight_duration"] == 800 # preserved + assert entry["tag"] == 1 # preserved + + +@pytest.mark.asyncio +async def test_update_marker_changes_fields(project): + + with _valid_bpf(): + link = await _make_link(project) + await link.start_marker("m", "icmp", highlight_duration=800) + await link.update_marker("m", highlight_duration=1500, enabled=False, tag=9) + + entry = link.markers["m"] + assert entry["highlight_duration"] == 1500 + assert entry["enabled"] is False + assert entry["tag"] == 9 + + +@pytest.mark.asyncio +async def test_update_marker_rejects_inherited(project): + + with _valid_bpf(): + link = await _make_link(project) + await link.inherit_marker("arp", {"bpf": "arp"}) + with pytest.raises(ControllerError): + await link.update_marker("global-arp", bpf="tcp") + + +@pytest.mark.asyncio +async def test_update_marker_inherited_bypass(project): + """The def-sync path passes inherited=True to update inherited copies.""" + + with _valid_bpf(): + link = await _make_link(project) + await link.inherit_marker("arp", {"bpf": "arp", "highlight_duration": 500}) + await link.update_marker("global-arp", highlight_duration=1200, inherited=True) + assert link.markers["global-arp"]["highlight_duration"] == 1200 + + +# --------------------------------------------------------------------------- +# Link.inherit_marker + persistence +# --------------------------------------------------------------------------- + +@pytest.mark.asyncio +async def test_inherit_marker_creates_global_copy(project): + + with _valid_bpf(): + link = await _make_link(project) + await link.inherit_marker("arp", {"bpf": "arp", "tag": 3, "color": "#111", "highlight_duration": 400}) + + entry = link.markers["global-arp"] + assert entry["bpf"] == "arp" + assert entry["tag"] == 3 + assert entry["color"] == "#111" + assert entry["highlight_duration"] == 400 + assert entry["inherited_from"] == "arp" + + +@pytest.mark.asyncio +async def test_persist_markers_excludes_inherited(project): + """Inherited markers are re-created from definitions on load, never persisted.""" + + with _valid_bpf(): + link = await _make_link(project) + await link.start_marker("private", "icmp", highlight_duration=800) + await link.inherit_marker("arp", {"bpf": "arp"}) + + persisted = link._persist_markers() + assert set(persisted.keys()) == {"private"} + assert "global-arp" not in persisted + + +@pytest.mark.asyncio +async def test_asdict_markers_runtime_vs_dump(project): + """Runtime asdict exposes all markers; topology dump drops inherited ones.""" + + with _valid_bpf(): + link = await _make_link(project) + await link.start_marker("private", "icmp") + await link.inherit_marker("arp", {"bpf": "arp"}) + + runtime = link.asdict() + assert set(runtime["markers"].keys()) == {"private", "global-arp"} + dumped = link.asdict(topology_dump=True) + assert set(dumped["markers"].keys()) == {"private"} + + +# --------------------------------------------------------------------------- +# Project-level marker definitions +# --------------------------------------------------------------------------- + +@pytest.mark.asyncio +async def test_create_marker_definition_fans_out(project): + + with _valid_bpf(): + link1 = await _make_link(project) + link2 = await _make_link(project) + await project.create_marker_definition("arp", "arp", tag=5, highlight_duration=1200) + + for link in (link1, link2): + entry = link.markers["global-arp"] + assert entry["inherited_from"] == "arp" + assert entry["bpf"] == "arp" + assert entry["highlight_duration"] == 1200 + assert project.marker_definitions["arp"]["highlight_duration"] == 1200 + + +@pytest.mark.asyncio +async def test_update_marker_definition_syncs(project): + + with _valid_bpf(): + link1 = await _make_link(project) + link2 = await _make_link(project) + await project.create_marker_definition("arp", "arp", highlight_duration=500) + await project.update_marker_definition("arp", highlight_duration=1500, bpf="arp or rarp") + + for link in (link1, link2): + assert link.markers["global-arp"]["highlight_duration"] == 1500 + assert link.markers["global-arp"]["bpf"] == "arp or rarp" + assert project.marker_definitions["arp"]["highlight_duration"] == 1500 + + +@pytest.mark.asyncio +async def test_delete_marker_definition_clears(project): + """Regression: deleting a def must remove inherited copies from every link.""" + + with _valid_bpf(): + link1 = await _make_link(project) + link2 = await _make_link(project) + await project.create_marker_definition("arp", "arp") + assert "global-arp" in link1.markers + await project.delete_marker_definition("arp") + + assert "global-arp" not in link1.markers + assert "global-arp" not in link2.markers + assert "arp" not in project.marker_definitions + + +@pytest.mark.asyncio +async def test_apply_defs_to_new_link(project): + """A link created after a definition exists inherits it automatically.""" + + with _valid_bpf(): + await project.create_marker_definition("arp", "arp") + new_link = await _make_link(project) + + assert "global-arp" in new_link.markers + assert new_link.markers["global-arp"]["inherited_from"] == "arp" + + +@pytest.mark.asyncio +async def test_markers_aggregation(project): + + with _valid_bpf(): + link = await _make_link(project) + await link.start_marker("icmp", "icmp", highlight_duration=800) + + agg = project.markers + key = f"{link.id}/icmp" + assert key in agg + assert agg[key]["bpf"] == "icmp" + assert agg[key]["highlight_duration"] == 800 + assert agg[key]["link_id"] == link.id + assert agg[key]["node_id"] == agg[key]["capture_node_id"] diff --git a/tests/controller/test_project.py b/tests/controller/test_project.py index 24f9314ce..b0202c01f 100644 --- a/tests/controller/test_project.py +++ b/tests/controller/test_project.py @@ -82,6 +82,7 @@ async def test_json(): "drawing_grid_size": 25, "supplier": None, "variables": None, + "marker_definitions": {}, "created_by": None } diff --git a/tests/controller/test_topology.py b/tests/controller/test_topology.py index 85492596c..bc87c1ee3 100644 --- a/tests/controller/test_topology.py +++ b/tests/controller/test_topology.py @@ -60,6 +60,7 @@ async def test_project_to_topology_empty(tmpdir): "supplier": None, "variables": None, "version": __version__, + "marker_definitions": {}, "created_by": None } diff --git a/tests/controller/test_udp_link.py b/tests/controller/test_udp_link.py index fb03947c9..e322627a0 100644 --- a/tests/controller/test_udp_link.py +++ b/tests/controller/test_udp_link.py @@ -78,6 +78,7 @@ async def test_create(project): "rport": 2048, "type": "nio_udp", "filters": {"delay": [10, 0]}, + "markers": {}, "suspend": False, }, timeout=120) @@ -87,6 +88,7 @@ async def test_create(project): "rport": 1024, "type": "nio_udp", "filters": {}, + "markers": {}, "suspend": False, }, timeout=120) @@ -146,6 +148,7 @@ async def test_create_one_side_failure(project): "rport": 2048, "type": "nio_udp", "filters": {}, + "markers": {}, "suspend": False, }, timeout=120) @@ -155,6 +158,7 @@ async def test_create_one_side_failure(project): "rport": 1024, "type": "nio_udp", "filters": {}, + "markers": {}, "suspend": False, }, timeout=120) # The link creation has failed we rollback the nio @@ -345,6 +349,7 @@ async def test_update(project): "rport": 2048, "type": "nio_udp", "suspend": False, + "markers": {}, "filters": {"delay": [10, 0]} }, timeout=120) @@ -354,6 +359,7 @@ async def test_update(project): "rport": 1024, "type": "nio_udp", "suspend": False, + "markers": {}, "filters": {} }, timeout=120) @@ -365,6 +371,7 @@ async def test_update(project): "rport": 2048, "type": "nio_udp", "suspend": False, + "markers": {}, "filters": { "frequency_drop": [5], "bpf": ["icmp[icmptype] == 8"] @@ -425,6 +432,7 @@ async def test_update_suspend(project): "rport": 2048, "type": "nio_udp", "filters": {"frequency_drop": [-1]}, + "markers": {}, "suspend": True }, timeout=120) @@ -434,5 +442,6 @@ async def test_update_suspend(project): "rport": 1024, "type": "nio_udp", "filters": {}, + "markers": {}, "suspend": True }, timeout=120)