dsrtp 0.1.1

Frontend for decrypting captured SRTP packets.

=====
dsrtp
=====

.. image:: https://travis-ci.org/mayfieldrobotics/dsrtp.svg
:target: https://travis-ci.org/mayfieldrobotics/dsrtp

Simple front-end for decrypting captured `SRTP and SRTCP <https://www.ietf.org/rfc/rfc3711.txt>`_ packets using:

- `libsrtp <https://github.com/cisco/libsrtp>`_ and
- `dpkt <https://github.com/kbandla/dpkt>`_

install
-------

.. code:: bash

pip install dsrtp

dev
---

Create a `venv <https://virtualenv.pypa.io/en/latest/>`_:

.. code:: bash

mkvirtualenv dsrtp
pip install Cython

then install devel `libsrtp <https://github.com/the-tcpdump-group/libpcap>`_ and `libsrtp <https://github.com/cisco/libsrtp>`_ if you need to, e.g.:

.. code:: bash

sudo apt-get install libpcap-dev libsrtp0-dev

and then get it:

.. code:: bash

git clone [e-mail]:mayfieldrobotics/dsrtp.git
cd dsrtp
workon dsrtp
pip install -e .[test]

and test it:

.. code:: bash

py.test test/ --cov dsrtp --cov-report term-missing --pep8

usage
-----

code
~~~~

To e.g. decrypt captured packets and write then back to a capture file:

.. code:: python

import dsrtp

material = 'hex-encoding-of-dtls-keying-material'.decode('hex')

with dsrtp.SRTP(material) as ctx, \
open('/path/to/srtp.pcap', 'rb') as srtp_pcap, \
open('/path/to/rtp.pcap', 'rb') as rtp_pcap:
pkts = dsrtp.read_packets(srtp_pcap)
decrypted_pkts = decrypt_srtp_packet(ctx, pkts)
dsrtp.write_packets(decrypted_pkts)

cli
~~~

To do the same as a command:

.. code:: bash

dsrtp /path/to/srtp.pcap /path/to/rtp.pcap -ld -k/path/to/keying/material.hex

release
-------

Tests pass:

.. code:: bash

py.test test/ --cov dsrtp --cov-report term-missing --pep8

so update ``__version__`` in:

- ``dsrtp/__init__.py``

commit and tag it:

.. code:: bash

git commit -am "release v{version}"
git tag -a v{version} -m "release v{version}"
git push --tags

and `travis <https://travis-ci.org/mayfieldrobotics/dsrtp>`_ will publish it to `pypi <https://pypi.python.org/pypi/dsrtp/>`_.