Peering Module
     __________________________________________________________

   Table of Contents

   1. Admin Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. OpenSIPS Modules

        1.3. Exported Parameters

              1.3.1. aaa_url (string)
              1.3.2. verify_destination_service_type (integer)
              1.3.3. verify_source_service_type (integer)

        1.4. Exported Functions

              1.4.1. verify_destination()
              1.4.2. verify_source()

   2. Contributors

        2.1. By Commit Statistics
        2.2. By Commit Activity

   3. Documentation

        3.1. Contributors

   List of Tables

   2.1. Top contributors by DevScore^(1), authored commits^(2) and
          lines added/removed^(3)

   2.2. Most recently active contributors^(1) to this module

   List of Examples

   1.1. Set aaa_url parameter
   1.2. verify_destination_service_type parameter usage
   1.3. verify_source_service_type parameter usage
   1.4. verify_destination() usage
   1.5. verify_source() usage

Chapter 1. Admin Guide

1.1. Overview

   Peering module allows SIP providers (operators or
   organizations) to verify from a broker if source or destination
   of a SIP request is a trusted peer.

   In order to participate in the trust community provided by a
   broker, each SIP provider registers with the broker the domains
   (host parts of SIP URIs) that they serve. When a SIP proxy of a
   provider needs to send a SIP request to a non-local domain, it
   can find out from the broker using verify_destination()
   function if the non-local domain is served by a trusted peer.
   If so, the provider receives from the broker a hash of the SIP
   request and a timestamp that it includes in the request to the
   non-local domain. When a SIP proxy of the non-local domain
   receives the SIP request, it, in turn, can verify from the
   broker using verify_source() function if the request came from
   a trusted peer.

   Verification functions communicate with the broker using an AAA
   protocol.

   Comments and suggestions for improvements are welcome.

1.2. Dependencies

1.2.1. OpenSIPS Modules

   The module depends on the following modules (in the other words
   the listed modules must be loaded before this module):
     * an AAA implementing module

1.3. Exported Parameters

1.3.1. aaa_url (string)

   This is the url representing the AAA protocol used and the
   location of the configuration file of this protocol.

   If the parameter is set to empty string, the AAA accounting
   support will be disabled (even if compiled).

   Default value is “NULL”.

   Example 1.1. Set aaa_url parameter
...
modparam("peering", "aaa_url", "radius:/etc/radiusclient-ng/radiusclient
.conf")
...

1.3.2. verify_destination_service_type (integer)

   This is the value of the Service-Type AAA attribute to be used,
   when sender of SIP Request verifies request's destination using
   verify_destination() function.

   Default value is dictionary value of “Sip-Verify-Destination”
   Service-Type.

   Example 1.2. verify_destination_service_type parameter usage
...
modparam("peering", "verify_destination_service_type", 21)
...

1.3.3. verify_source_service_type (integer)

   This is the value of the Service-Type AAA attribute to be used,
   when receiver of SIP Request verifies request's source using
   verify_source() function.

   Default value is dictionary value of “Sip-Verify-Source”
   Service-Type.

   Example 1.3. verify_source_service_type parameter usage
...
modparam("peering", "verify_source_service_type", 22)
...

1.4. Exported Functions

1.4.1. verify_destination()

   Function verify_destination() queries from broker's AAA server
   if domain (host part) of Request URI is served by a trusted
   peer. AAA request contains the following attributes/values:
     * User-Name - Request-URI host
     * SIP-URI-User - Request-URI user
     * SIP-From-Tag - From tag
     * SIP-Call-Id - Call id
     * Service-Type - verify_destination_service_type

   Function returns value 1 if domain of Request URI is served by
   a trusted peer and -1 otherwise. In case of positive result,
   AAA server returns a set of SIP-AVP reply attributes. Value of
   each SIP-AVP is of form:

   [#]name(:|#)value

   Value of each SIP-AVP reply attribute is mapped to an OpenSIPS
   AVP. Prefix # in front of name or value indicates a string name
   or string value, respectively.

   One of the SIP-AVP reply attributes contains a string that the
   source peer must include "as is" in a P-Request-Hash header
   when it sends the SIP request to the destination peer. The
   string value may, for example, be of form hash@timestamp, where
   hash contains a hash calculated by the broker based on the
   attributes of the query and some local information and
   timestamp is the time when the calculation was done.

   AVP names used in reply attributes are assigned by the broker.

   This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.

   Example 1.4. verify_destination() usage
...
if (verify_destination()) {
   append_hf("P-Request-Hash: $avp(prh)\r\n");
}
...

1.4.2. verify_source()

   Function verify_source() queries from broker's AAA server if
   SIP request was received from a trusted peer. AAA request
   contains the following attributes/values:
     * User-Name - Request-URI host
     * SIP-URI-User - Request-URI user
     * SIP-From-Tag - From tag
     * SIP-Call-Id - Call id
     * SIP-Request-Hash - body of P-Request-Hash header
     * Service-Type - verify_source_service_type

   Function returns value 1 if SIP request was received from a
   trusted peer and -1 otherwise. In case of positive result, AAA
   server may return a set of SIP-AVP reply attributes. Value of
   each SIP-AVP is of form:

   [#]name(:|#)value

   Value of each SIP-AVP reply attribute is mapped to an OpenSIPS
   AVP. Prefix # in front of name or value indicates a string name
   or string value, respectively.

   AVP names used in reply attributes are assigned by the broker.

   This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.

   Example 1.5. verify_source() usage
...
if (is_present_hf("P-Request-Hash")) {
   if (verify_source()) {
      xlog("L_INFO", "Request came from trusted peer\n")
   }
}
...

Chapter 2. Contributors

2.1. By Commit Statistics

   Table 2.1. Top contributors by DevScore^(1), authored
   commits^(2) and lines added/removed^(3)
     Name DevScore Commits Lines ++ Lines --
   1. Bogdan-Andrei Iancu (@bogdan-iancu) 13 11 29 32
   2. Juha Heinanen (@juha-h) 13 4 909 5
   3. Liviu Chircu (@liviuchircu) 10 8 27 39
   4. Razvan Crainea (@razvancrainea) 9 7 13 9
   5. Irina-Maria Stanescu 9 2 125 254
   6. Vlad Patrascu (@rvlad-patrascu) 4 2 4 4
   7. Peter Lemenkov (@lemenkov) 3 1 1 1

   (1) DevScore = author_commits + author_lines_added /
   (project_lines_added / project_commits) + author_lines_deleted
   / (project_lines_deleted / project_commits)

   (2) including any documentation-related commits, excluding
   merge commits. Regarding imported patches/code, we do our best
   to count the work on behalf of the proper owner, as per the
   "fix_authors" and "mod_renames" arrays in
   opensips/doc/build-contrib.sh. If you identify any
   patches/commits which do not get properly attributed to you,
   please submit a pull request which extends "fix_authors" and/or
   "mod_renames".

   (3) ignoring whitespace edits, renamed files and auto-generated
   files

2.2. By Commit Activity

   Table 2.2. Most recently active contributors^(1) to this module
                     Name                   Commit Activity
   1. Razvan Crainea (@razvancrainea)     Apr 2013 - Sep 2019
   2. Bogdan-Andrei Iancu (@bogdan-iancu) Jun 2008 - Apr 2019
   3. Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
   4. Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
   5. Liviu Chircu (@liviuchircu)         Mar 2014 - Jun 2018
   6. Irina-Maria Stanescu                Aug 2009 - Aug 2009
   7. Juha Heinanen (@juha-h)             May 2008 - Jun 2008

   (1) including any documentation-related commits, excluding
   merge commits

Chapter 3. Documentation

3.1. Contributors

   Last edited by: Peter Lemenkov (@lemenkov), Liviu Chircu
   (@liviuchircu), Razvan Crainea (@razvancrainea), Bogdan-Andrei
   Iancu (@bogdan-iancu), Irina-Maria Stanescu, Juha Heinanen
   (@juha-h).

   Documentation Copyrights:

   Copyright © 2008 Juha Heinanen
