kamailio/modules/topos

TOPOS Module

Daniel-Constantin Mierla

   <miconda@gmail.com>

Edited by

Daniel-Constantin Mierla

   <miconda@gmail.com>

   Copyright © 2016 FhG FOKUS
     __________________________________________________________________

   Table of Contents

   1. Admin Guide

        1. Overview
        2. Dependencies

              2.1. Kamailio Modules
              2.2. External Libraries or Applications

        3. Parameters

              3.1. db_url (str)
              3.2. mask_callid (int)
              3.3. sanity_checks (int)
              3.4. branch_expires (int)
              3.5. branch_dialog (int)
              3.6. clean_inteval (int)

   List of Examples

   1.1. Set db_url parameter
   1.2. Set mask_callid parameter
   1.3. Set sanity_checks parameter
   1.4. Set branch_expires parameter
   1.5. Set branch_dialog parameter
   1.6. Set clean_interval parameter

Chapter 1. Admin Guide

   Table of Contents

   1. Overview
   2. Dependencies

        2.1. Kamailio Modules
        2.2. External Libraries or Applications

   3. Parameters

        3.1. db_url (str)
        3.2. mask_callid (int)
        3.3. sanity_checks (int)
        3.4. branch_expires (int)
        3.5. branch_dialog (int)
        3.6. clean_inteval (int)

1. Overview

   This module offers topology hiding by stripping the SIP routing headers
   that show topology details. The script interpreter gets the SIP
   messages with full content, so all existing functionality is preserved.

   The module is transparent for the configuration writer. It only needs
   to be loaded (tune the parameters if needed).

   It works for SIP MESSAGE requests.

2. Dependencies

   2.1. Kamailio Modules
   2.2. External Libraries or Applications

2.1. Kamailio Modules

   The following modules must be loaded before this module:
     * rr module - server must perform record routing to ensure in-dialog
       requests are encoded/decoded.
     * database module - to store the data for topology stripping and
       restoring.

2.2. External Libraries or Applications

   The following libraries or applications must be installed before
   running Kamailio with this module loaded:
     * none.

3. Parameters

   3.1. db_url (str)
   3.2. mask_callid (int)
   3.3. sanity_checks (int)
   3.4. branch_expires (int)
   3.5. branch_dialog (int)
   3.6. clean_inteval (int)

3.1. db_url (str)

   Database URL.

   Default value is “mysql://kamailio:kamailiorw@localhost/kamailio”.

   Example 1.1. Set db_url parameter
...
modparam("topos", "db_url", "dbdriver://username:password@dbhost/dbname")
...

3.2. mask_callid (int)

   Note: this functionality is not implemented yet - the parameter is
   present in order to be in pair with topoh module.

   Whether to replace or not the Call-ID with another unique id generated
   by Kamailio.

   Default value is 0 (do not mask).

   Example 1.2. Set mask_callid parameter
...
modparam("topos", "mask_callid", 1)
...

3.3. sanity_checks (int)

   If set to 1, topoh module will bind to sanity module in order to
   perform sanity checks over received SIP request. Default sanity checks
   are done. It is useful to check if received request is well formated
   before proceeding to encoding/decoding.

   Default value is 0 (do not bind to sanity module).

   Example 1.3. Set sanity_checks parameter
...
modparam("topoh", "sanity_checks", 1)
...

3.4. branch_expires (int)

   Interval in seconds after which the branch records are deleted.

   Default value is 180 (3 min).

   Example 1.4. Set branch_expires parameter
...
modparam("topos", "branch_expires", 300)
...

3.5. branch_dialog (int)

   Interval in seconds after which the dialog records are deleted.

   Default value is 10800 (3 hours).

   Example 1.5. Set branch_dialog parameter
...
modparam("topos", "branch_dialog", 3600)
...

3.6. clean_inteval (int)

   Interval in seconds to run the clean up of stored records.

   Default value is 60 (1 min).

   Example 1.6. Set clean_interval parameter
...
modparam("topos", "clean_interval", 30)
...