Skip to main content

Generate SIP call-flow (ladder) diagrams from pcap files. Mermaid + SVG output.

Project description

sip-ladder

Generate SIP call-flow (ladder) diagrams from pcap files.

Reads a pcap, parses SIP messages, groups them into calls by Call-ID, and renders the resulting message flow as either a Mermaid sequence diagram (text, embeddable in Markdown) or a standalone SVG.

The diagram algorithm is ported from sngrep's ncurses "Call Flow" view (src/curses/ui_call_flow.c), with one improvement: sngrep treats every distinct IP:port as a separate actor column, so a proxy listening on :5060 and originating on :5061 shows up twice. sip-ladder uses Via and Contact headers to merge those into a single logical actor.

Install

uv tool install sip-ladder
# or, ad-hoc:
uvx sip-ladder trace.pcap -o flow.mmd

Example output

Given a pcap containing a basic INVITE flow, sip-ladder produces:

---
title: demo-1-simple@atlanta.example INVITE → 200
---
sequenceDiagram
    autonumber
    participant A as alice@192.0.2.10
    participant B as 192.0.2.20:5060
    A->>B: INVITE
    B-->>A: 100 Trying
    B-->>A: 180 Ringing
    B-->>A: 200 OK (INVITE)
    A->>B: ACK
    A->>B: BYE

The pcap that produced this — plus a redirect call and a REFER-based transfer — lives in examples/build_demo_pcap.py. Run it locally to regenerate:

uv run python examples/build_demo_pcap.py
# Produces examples/demo-call-flow.{pcap,mmd,svg}

GitHub, GitLab, Obsidian, and most modern Markdown viewers render the Mermaid block above as a sequence diagram. On platforms that don't (PyPI's README renderer, plain-text consumers), the fenced code block remains readable as-is.

CLI

sip-ladder trace.pcap                   # render all calls as Mermaid to stdout
sip-ladder trace.pcap -o flow.mmd       # write Mermaid to file
sip-ladder trace.pcap -o flow.svg       # extension drives format
sip-ladder trace.pcap --list            # list calls without rendering
sip-ladder trace.pcap --call-id abc...  # render just one call

Library

from sip_ladder import read_pcap, render_mermaid, render_svg

for call in read_pcap("trace.pcap"):
    print(f"{call.call_id}  {call.from_uri} -> {call.to_uri}  ({call.final_response})")
    open(f"{call.call_id}.mmd", "w").write(render_mermaid(call))
    render_svg(call, f"{call.call_id}.svg")

Scope

In-scope for the initial release:

  • Offline pcap analysis (UDP and best-effort TCP)
  • SIP message parsing (RFC 3261 — common cases)
  • Mermaid + SVG renderers
  • Via-aware actor reconciliation
  • Retransmit detection via CSeq match

Out-of-scope (deferred):

  • Live capture (libpcap, HEP/EEP listener, sngrep subprocess streaming)
  • RTP / MOS analysis
  • TLS decryption
  • SIP-over-WebSocket
  • Interactive HTML

The architecture leaves clean seams to add these later without restructuring.

Source and contributions

The repo also includes an docs/agent-threads/ directory with the full audit trail of cross-project design conversations — these are intentionally excluded from the PyPI sdist (per a deliberate "link, don't ship" policy) but are visible in git for anyone curious about why specific design choices were made.

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sip_ladder-2026.5.25.6.tar.gz (64.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sip_ladder-2026.5.25.6-py3-none-any.whl (32.5 kB view details)

Uploaded Python 3

File details

Details for the file sip_ladder-2026.5.25.6.tar.gz.

File metadata

  • Download URL: sip_ladder-2026.5.25.6.tar.gz
  • Upload date:
  • Size: 64.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"EndeavourOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for sip_ladder-2026.5.25.6.tar.gz
Algorithm Hash digest
SHA256 0bc1fc2ca7e035052744f02669d920950c06e661784f88cdfc105db8f57e664f
MD5 65596cb5ed254b148b6c4604966f6c88
BLAKE2b-256 dcbcdb5bbd590a232c9c6771cb3c3ed2d80e21927271a81ed35d2947fb2c0dc3

See more details on using hashes here.

File details

Details for the file sip_ladder-2026.5.25.6-py3-none-any.whl.

File metadata

  • Download URL: sip_ladder-2026.5.25.6-py3-none-any.whl
  • Upload date:
  • Size: 32.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"EndeavourOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for sip_ladder-2026.5.25.6-py3-none-any.whl
Algorithm Hash digest
SHA256 68a86ea1fe6a9f067cf238b6dc419edcc77573b7e120342aaabf1c284fec30e9
MD5 a56f87c682c7bd63d9482014514fa3e6
BLAKE2b-256 253b6645bdb8d3fbd406cb7bebb64f3b08a81d063c4f065663c9a1d9cfe4c318

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page