Documentation

What is sipnab?

sipnab is a network analysis tool for Voice over IP. It captures and decodes SIP signaling (the protocol that sets up, modifies, and tears down phone calls) alongside the RTP media streams that carry the actual audio. Whether you are debugging call quality problems, auditing a VoIP platform for security issues, or simply trying to understand what is happening on the wire, sipnab gives you one Rust binary that covers interactive TUI, CLI batch mode, REST API, and browser-based analysis.

Documentation Overview

• Troubleshooting – Real-world VoIP diagnostic workflows with exact commands
• Install – Build from source, binary downloads, Docker, feature flags
• CLI Reference – Complete flag reference organized by functional group
• Filter DSL – Query language for filtering calls and streams
• Configuration – TOML config file reference with all settings
• Keybindings – TUI keyboard shortcuts and navigation
• Theme – Color customization with preset themes
• REST API – HTTP API, Prometheus metrics, HEP integration
• MCP Server – Drive sipnab from an AI agent over stdio or HTTP
• Cookbook – Step-by-step recipes for triage, filtering, HEP wiring, TLS decryption, MCP, observability, security, and audio export

Quick Start

# Analyze a pcap file
sipnab -I capture.pcap

# Live capture on eth0
sudo sipnab -d eth0

# Find problematic calls
sipnab -N -I capture.pcap --problems --json