SIPp - a SIP protocol test tool Copyright (C) 2003-2020 - The Authors

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.

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/.

Documentation

See the docs/ directory. It should also be available in html format at: https://sipp.readthedocs.io/en/latest/

Build a local copy using: sphinx-build docs _build

Building

This is the SIPp package. Please refer to the webpage for details and documentation.

Normally, you should be able to build SIPp by using CMake:

cmake .
make

The SIPp master branch (3.7.x) requires a modern C++17 compiler.

There are several optional flags to enable features (SIP-over-TLS, SIP-over-SCTP, media playback from PCAP files and the GNU Scientific Libraries for random distributions):

cmake . -DUSE_SSL=1 -DUSE_SCTP=1 -DUSE_PCAP=1 -DUSE_GSL=1

To enable TLS key logging pass -DUSE_SSL=KL to cmake.

TLS key logging records the TLS Session Keys to a key log file when the SSLKEYLOGFILE environment variable is set. It allows to decrypt SIPS traffic generated or received by SIPp using Wireshark. For more details see: https://wiki.wireshark.org/TLS

You need to compile with OpenSSL>=1.1.1 in order to use TLS key logging.

The TLS key log file format is described here: https://datatracker.ietf.org/doc/draft-ietf-tls-keylogfile/

Please note the security considerations ("3. Security Considerations")!

Static builds

SIPp can be built into a single static binary, removing the need for libraries to exist on the target system and maximising portability.

This is a fairly complicated process, and for now, it only works on Alpine Linux.

To build a static binary, pass -DBUILD_STATIC=1 to cmake.

An Alpine-based Dockerfile is provided, which can be used as a build-environment. Build with the following commands:

git submodule update --init
docker build -t sipp -f docker/Dockerfile --output=. --target=bin .

Special arguments can be passed with --build-arg: * FULL=1 - build all optional components. * DEBUG=1 - build with debug symbols.

Debian-based docker build

SIPp can be built in a Debian-based docker container. Unlike the Alpine build, this build is not static, and it supports wolfSSL.

To build a Debian-based docker container, run:

git submodule update --init
docker build -t sipp -f docker/Dockerfile.debian .

Special arguments can be passed with --build-arg: * FULL=1 - build all optional components, including OpenSSL. * WOLFSSL=1 - build with wolfSSL (only works without FULL). * DEBUG=1 - build with debug symbols.

Support

I try and be responsive to issues raised on Github, and there's a reasonably active mailing list.

Making a release

• Update CHANGES.md. Tag release. Do a build.
• Make sipp.1 by calling: help2man --output=sipp.1 -v -v --no-info \ --name='SIP testing tool and traffic generator' ./sipp
• Then: git ls-files -z | grep -zv '^\.\|gtest\|gmock\|version.h' | \ tar --transform "s:^version.h:include/version.h:" \ --transform "s:^:sipp-$VERSION/:" \ --sort=name --mtime="@$(git log -1 --format=%ct)" \ --owner=0 --group=0 --null --files-from=- \ --numeric-owner -zcf sipp-$VERSION.tar.gz \ sipp.1 version.h
• Upload to github as "binary". Note that github replaces tilde sign (for ~rcX) with a period.
• Create a static binary and upload this to github as well: docker build -t sipp -f docker/Dockerfile --output=. --target=bin .

Contributing

SIPp is free software, under the terms of the GPL licence (see the LICENCE.txt file for details). You can contribute to the development of SIPp and use the standard Github fork/pull request method to integrate your changes integrate your changes. If you make changes in SIPp, PLEASE follow a few coding rules:

• Please stay conformant with the current indentation style (4 spaces indent, standard Emacs-like indentation). Examples:

  if (condition) { /* "{" even if only one instruction */ f(); /* 4 space indents */ } else { char* p = ptr; /* C++-style pointer declaration placement */ g(p); }

• If possible, check that your changes can be compiled on:

  • Linux,
  • Cygwin,
  • Mac OS X,
  • FreeBSD.

Thanks,

Rob Day rkd@rkd.me.uk