sngrep/README.md

76 lines
2.7 KiB
Markdown
Raw Normal View History

2014-12-04 14:19:53 -05:00
# sngrep [![Build Status](https://travis-ci.org/irontec/sngrep.svg)](https://travis-ci.org/irontec/sngrep)
2013-06-20 13:11:33 -04:00
sngrep is a tool for displaying SIP calls message flows.
2013-06-20 13:11:33 -04:00
It supports live capture to display realtime SIP packets and can also be used
as PCAP viewer.
2013-06-20 13:11:33 -04:00
2014-12-10 05:26:25 -05:00
[Some screenshots of sngrep](https://github.com/irontec/sngrep/wiki/Screenshots)
2013-06-20 13:11:33 -04:00
## Prerequisites
- libncurse5 - for UI , windows, panels.
- libpcap - for capturing packets.
- libssl - (optional) for tls decrypt
2013-06-20 13:11:33 -04:00
## Installing
On most systems the commands to build will be the standard atotools procedure:
2015-02-06 08:31:47 -05:00
./bootstrap.sh
2013-06-20 13:11:33 -04:00
./configure
make
make install (as root)
If you dont want to use libpcap (because is not available in your system or
don't want to install more development libraries), you can use release 0.0.0
available at https://github.com/irontec/sngrep/releases
You can find [detailed instructions for some distributions] (https://github.com/irontec/sngrep/wiki/Building) on wiki.
2013-06-24 11:36:22 -04:00
## Usage
sngrep can be used to view SIP packets from a pcap file
2013-06-24 11:36:22 -04:00
sngrep file.pcap
or live capturing
2013-07-03 07:53:30 -04:00
sngrep port 5060 and udp
You can configure some options using a sngreprc file
2013-07-03 07:53:30 -04:00
2013-06-20 13:11:33 -04:00
## Frequent Asked Questions
2014-12-10 05:26:25 -05:00
See FAQ on [Github Wiki](https://github.com/irontec/sngrep/wiki#frequent-asked-questions)
2013-06-20 13:11:33 -04:00
## License
2014-10-21 11:53:25 -04:00
sngrep - SIP Messages flow viewer
Copyright (C) 2013,2014 Irontec S.L.
2013-06-20 13:11:33 -04:00
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.
2014-12-05 08:26:30 -05:00
In addition, as a special exception, the copyright holders give
permission to link the code of portions of this program with the
OpenSSL library under certain conditions as described in each
individual source file, and distribute linked combinations
including the two.
You must obey the GNU General Public License in all respects
for all of the code used other than OpenSSL. If you modify
file(s) with this exception, you may extend this exception to your
version of the file(s), but you are not obligated to do so. If you
do not wish to do so, delete this exception statement from your
version. If you delete this exception statement from all source
files in the program, then also delete it here.
2013-06-20 13:11:33 -04:00
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://www.gnu.org/licenses/>.