src/plugins/srtp/srtp_plugin.rst

   1 SRTP Protocol
   2 =============
   3
   4 This document describe the VPP SRTP (Secure Real-time Transport
   5 Protocol) implementation libsrtp2 based SRTP transport protocol
   6 implementation.
   7
   8 Maturity level
   9 --------------
  10
  11 Experimental
  12
  13 Quickstart
  14 ----------
  15
  16 1. Install libsrtp2-dev. On debian based OS:
  17
  18 ::
  19
  20    sudo apt get install libsrtp2-dev
  21
  22 2. Build vpp
  23
  24 ::
  25
  26    make build
  27
  28 3. Test protocol using vcl test server and client. On server side, start
  29    vpp and server app:
  30
  31 ::
  32
  33    export VT_PATH=$WS/build-root/build-vpp_debug-native/vpp/bin
  34    $VT_PATH/vcl_test_server 1234 -p srtp
  35
  36 On client side:
  37
  38 ::
  39
  40    export VT_PATH=$WS/build-root/build-vpp_debug-native/vpp/bin
  41    $VT_PATH/vcl_test_client <server-ip> 1234 -U -X -S -N 10000 -T 128 -p srtp
  42
  43 Custom libsrtp2 build
  44 ---------------------
  45
  46 1. Create ``build/external/packages/srtp.mk`` with following example
  47    contents:
  48
  49 ::
  50
  51    srtp_version := 2.3.0
  52    srtp_tarball := srtp_$(srtp_version).tar.gz
  53    srtp_tarball_md5sum := da38ee5d9c31be212a12964c22d7f795
  54    srtp_tarball_strip_dirs := 1
  55    srtp_url := https://github.com/cisco/libsrtp/archive/v$(srtp_version).tar.gz
  56
  57    define  srtp_build_cmds
  58        @cd $(srtp_build_dir) && \
  59            $(CMAKE) -DCMAKE_INSTALL_PREFIX:PATH=$(srtp_install_dir)    \
  60            -DCMAKE_C_FLAGS='-fPIC -fvisibility=hidden'  $(srtp_src_dir) > $(srtp_build_log)
  61        @$(MAKE) $(MAKE_ARGS) -C $(srtp_build_dir) > $(srtp_build_log)
  62    endef
  63
  64    define  srtp_config_cmds
  65        @true
  66    endef
  67
  68    define  srtp_install_cmds
  69        @$(MAKE) $(MAKE_ARGS) -C $(srtp_build_dir) install > $(srtp_install_log)
  70    endef
  71
  72
  73    $(eval $(call package,srtp))
  74
  75 2. Include ``srtp.mk`` in ``build/external/Makefile`` and add to install
  76    target.
  77
  78 3. Rebuild external dependencies:
  79
  80 ::
  81
  82    make install-ext-deps