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.

License

MIT.

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.3.tar.gz (53.7 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.3-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sip_ladder-2026.5.25.3.tar.gz
  • Upload date:
  • Size: 53.7 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.3.tar.gz
Algorithm Hash digest
SHA256 06da23332d88cf034147a782efde84930f7f2015aff19b26b1b2edb60321ca06
MD5 ddfa0bafee0de883328bf150f4b62d23
BLAKE2b-256 6d3cf468c3170117da160bc55e560e39956e514abeb2d017cdfe0affadb0a202

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sip_ladder-2026.5.25.3-py3-none-any.whl
  • Upload date:
  • Size: 27.3 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6b2a7e17793368c89471243a2e1f2f6d7cbfc5d05b7b46ab61136ba2edde8cce
MD5 685cec2e02bf6cdcb28e454cc4ba393c
BLAKE2b-256 30f10d067829d8ab1d23c16dd2c637b68d7f180259d3d4eea48aa08f5f6ba758

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