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

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.2.tar.gz (45.3 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.2-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sip_ladder-2026.5.25.2.tar.gz
  • Upload date:
  • Size: 45.3 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.2.tar.gz
Algorithm Hash digest
SHA256 b2ea942c29199047c30eaea57088a88785d393dbbd50273451617a0d14dd32da
MD5 4abf0b8e40cbbef9ddbc2f7f04dbe05d
BLAKE2b-256 46ec3312dca97c6fb74b2114ae053146007040c9ee157714645ce2c8ca4b27ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sip_ladder-2026.5.25.2-py3-none-any.whl
  • Upload date:
  • Size: 26.9 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2f21573224ef39a0b56fee2f01b98d352aedbc95b3e7c32195cbb632dabaf2d5
MD5 ee8f8e03cd0d5950e692b402145cc913
BLAKE2b-256 8d23a32aa0561a07fa34210c9c9f70ecc6f199817c87158a87accbd99e6b8542

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