ims_ipsec_pcscf: fixed possible use of uninitialized value in ipsec_forward()
[sip-router] / src / modules / ims_ipsec_pcscf / README
index 0d354ee..06125e2 100644 (file)
@@ -24,11 +24,11 @@ Tsvetomir Dimitrov
 
    <tsv.dimitrov@gmail.com>
 
-   Copyright Â© 2007 FhG FOKUS
+   Copyright © 2007 FhG FOKUS
 
-   Copyright Â© 2012 Smile Communications
+   Copyright © 2012 Smile Communications
 
-   Copyright Â© 2015 ng-voice GmbH
+   Copyright © 2015 ng-voice GmbH
      __________________________________________________________________
 
    Table of Contents
@@ -44,10 +44,11 @@ Tsvetomir Dimitrov
         3. Parameters
 
               3.1. ipsec_listen_addr (string)
-              3.2. ipsec_client_port (int)
-              3.3. ipsec_server_port (int)
-              3.4. ipsec_spi_id_start (int)
-              3.5. ipsec_spi_id_range (int)
+              3.2. ipsec_listen_addr6 (string)
+              3.3. ipsec_client_port (int)
+              3.4. ipsec_server_port (int)
+              3.5. ipsec_spi_id_start (int)
+              3.6. ipsec_spi_id_range (int)
 
         4. Functions
 
@@ -58,13 +59,14 @@ Tsvetomir Dimitrov
    List of Examples
 
    1.1. ipsec_listen_addr parameter usage
-   1.2. ipsec_client_port parameter usage
-   1.3. ipsec_server_port parameter usage
-   1.4. ipsec_spi_id_start parameter usage
-   1.5. ipsec_spi_id_range parameter usage
-   1.6. ipsec_create
-   1.7. ipsec_forward
+   1.2. ipsec_listen_addr6 parameter usage
+   1.3. ipsec_client_port parameter usage
+   1.4. ipsec_server_port parameter usage
+   1.5. ipsec_spi_id_start parameter usage
+   1.6. ipsec_spi_id_range parameter usage
+   1.7. ipsec_create
    1.8. ipsec_forward
+   1.9. ipsec_forward
 
 Chapter 1. Admin Guide
 
@@ -79,10 +81,11 @@ Chapter 1. Admin Guide
    3. Parameters
 
         3.1. ipsec_listen_addr (string)
-        3.2. ipsec_client_port (int)
-        3.3. ipsec_server_port (int)
-        3.4. ipsec_spi_id_start (int)
-        3.5. ipsec_spi_id_range (int)
+        3.2. ipsec_listen_addr6 (string)
+        3.3. ipsec_client_port (int)
+        3.4. ipsec_server_port (int)
+        3.5. ipsec_spi_id_start (int)
+        3.6. ipsec_spi_id_range (int)
 
    4. Functions
 
@@ -114,46 +117,61 @@ Chapter 1. Admin Guide
 3. Parameters
 
    3.1. ipsec_listen_addr (string)
-   3.2. ipsec_client_port (int)
-   3.3. ipsec_server_port (int)
-   3.4. ipsec_spi_id_start (int)
-   3.5. ipsec_spi_id_range (int)
+   3.2. ipsec_listen_addr6 (string)
+   3.3. ipsec_client_port (int)
+   3.4. ipsec_server_port (int)
+   3.5. ipsec_spi_id_start (int)
+   3.6. ipsec_spi_id_range (int)
 
 3.1. ipsec_listen_addr (string)
 
    IP address which the Proxy-CSCF will use for incoming/outgoing SIP
    traffic over IPSec.
 
-   Default value is "127.0.0.1"
+   Default value is empty string (null) - IPv4 listen interface will not
+   be added
 
    Example 1.1. ipsec_listen_addr parameter usage
 ...
-modparam("ims_ipsec_pcscf", "ipsec_listen_addr", "127.0.0.1")
+modparam("ims_ipsec_pcscf", "ipsec_listen_addr", "")
 ...
 
-3.2. ipsec_client_port (int)
+3.2. ipsec_listen_addr6 (string)
+
+   IPv6 address which the Proxy-CSCF will use for incoming/outgoing SIP
+   traffic over IPSec.
+
+   Default value is empty string (null) - IPv6 listen interface will not
+   be added
+
+   Example 1.2. ipsec_listen_addr6 parameter usage
+...
+modparam("ims_ipsec_pcscf", "ipsec_listen_addr6", "")
+...
+
+3.3. ipsec_client_port (int)
 
    Port number which will be bound for incoming (server) IPSec traffic.
 
    Default value is 5963.
 
-   Example 1.2. ipsec_client_port parameter usage
+   Example 1.3. ipsec_client_port parameter usage
 ...
 modparam("ims_ipsec_pcscf", "ipsec_client_port", 5062)
 ...
 
-3.3. ipsec_server_port (int)
+3.4. ipsec_server_port (int)
 
    Port number which will be bound for incoming (server) IPSec traffic.
 
    Default value is 5063.
 
-   Example 1.3. ipsec_server_port parameter usage
+   Example 1.4. ipsec_server_port parameter usage
 ...
 modparam("ims_ipsec_pcscf", "ipsec_server_port", 5063)
 ...
 
-3.4. ipsec_spi_id_start (int)
+3.5. ipsec_spi_id_start (int)
 
    Each IPSec tunnel has a unique system-wide identifier. This and the
    following option allows to tune the SPIs used by Kamailio in order to
@@ -162,12 +180,12 @@ modparam("ims_ipsec_pcscf", "ipsec_server_port", 5063)
 
    Default value is 100.
 
-   Example 1.4. ipsec_spi_id_start parameter usage
+   Example 1.5. ipsec_spi_id_start parameter usage
 ...
 modparam("ims_ipsec_pcscf", "ipsec_spi_id_start", 100)
 ...
 
-3.5. ipsec_spi_id_range (int)
+3.6. ipsec_spi_id_range (int)
 
    How many SPIs to be allocated for the process. E.g. if
    ipsec_spi_id_start = 100 and ipsec_spi_id_range = 1000, SPIs between
@@ -175,7 +193,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_start", 100)
 
    Default value is 1000.
 
-   Example 1.5. ipsec_spi_id_range parameter usage
+   Example 1.6. ipsec_spi_id_range parameter usage
 ...
 modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
 ...
@@ -197,7 +215,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
      * domain - Logical domain within the registrar. If a database is used
        then this must be name of the table which stores the contacts.
 
-   Example 1.6. ipsec_create
+   Example 1.7. ipsec_create
 ...
 ipsec_create("location");
 ...
@@ -211,7 +229,7 @@ ipsec_create("location");
      * domain - Logical domain within the registrar. If a database is used
        then this must be name of the table which stores the contacts.
 
-   Example 1.7. ipsec_forward
+   Example 1.8. ipsec_forward
 ...
 ipsec_forward("location");
 ...
@@ -224,7 +242,7 @@ ipsec_forward("location");
      * domain - Logical domain within the registrar. If a database is used
        then this must be name of the table which stores the contacts.
 
-   Example 1.8. ipsec_forward
+   Example 1.9. ipsec_forward
 ...
 ipsec_destroy("location");
 ...