This module hides the SIP routing headers that show topology details. It is not affected by the server being transaction stateless or stateful. The script interpreter gets the SIP messages decoded, 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). The SIP server can be restarted without affecting ongoing calls - once it is up, can encode/decode topology details, thus no call will be lost. By using same mask_key, many SIP servers can decode the message, for example, applicable for servers behind load balancers.
| Parámetro | Tipo | Descripción |
|---|---|---|
| mask_key | str | 3.2. mask_ip (str) 3.3. mask_callid (integer) 3.4. mask_mode (integer) 3.5. uparam_name (str) 3.6. uparam_prefix (str) 3.7. vparam_name (str) 3.8. vparam_prefix (str) 3.9. callid_prefix (str) 3.10. sa |
| mask_ip | str | 3.3. mask_callid (integer) 3.4. mask_mode (integer) 3.5. uparam_name (str) 3.6. uparam_prefix (str) 3.7. vparam_name (str) 3.8. vparam_prefix (str) 3.9. callid_prefix (str) 3.10. sanity_checks (intege |
| mask_callid | integer | 3.4. mask_mode (integer) 3.5. uparam_name (str) 3.6. uparam_prefix (str) 3.7. vparam_name (str) 3.8. vparam_prefix (str) 3.9. callid_prefix (str) 3.10. sanity_checks (integer) 3.11. uri_prefix_checks |
| mask_mode | integer | 3.5. uparam_name (str) 3.6. uparam_prefix (str) 3.7. vparam_name (str) 3.8. vparam_prefix (str) 3.9. callid_prefix (str) 3.10. sanity_checks (integer) 3.11. uri_prefix_checks (integer) 3.12. event_cal |
| uparam_name | str | 3.6. uparam_prefix (str) 3.7. vparam_name (str) 3.8. vparam_prefix (str) 3.9. callid_prefix (str) 3.10. sanity_checks (integer) 3.11. uri_prefix_checks (integer) 3.12. event_callback (str) 3.13. event |
| uparam_prefix | str | 3.7. vparam_name (str) 3.8. vparam_prefix (str) 3.9. callid_prefix (str) 3.10. sanity_checks (integer) 3.11. uri_prefix_checks (integer) 3.12. event_callback (str) 3.13. event_mode (int) 3.14. use_mod |
| vparam_name | str | 3.8. vparam_prefix (str) 3.9. callid_prefix (str) 3.10. sanity_checks (integer) 3.11. uri_prefix_checks (integer) 3.12. event_callback (str) 3.13. event_mode (int) 3.14. use_mode (int) |
| vparam_prefix | str | 3.9. callid_prefix (str) 3.10. sanity_checks (integer) 3.11. uri_prefix_checks (integer) 3.12. event_callback (str) 3.13. event_mode (int) 3.14. use_mode (int) |
| callid_prefix | str | 3.10. sanity_checks (integer) 3.11. uri_prefix_checks (integer) 3.12. event_callback (str) 3.13. event_mode (int) 3.14. use_mode (int) |
| sanity_checks | integer | 3.11. uri_prefix_checks (integer) 3.12. event_callback (str) 3.13. event_mode (int) 3.14. use_mode (int) |
| uri_prefix_checks | integer | 3.12. event_callback (str) 3.13. event_mode (int) 3.14. use_mode (int) |
| event_callback | str | 3.13. event_mode (int) 3.14. use_mode (int) |
| event_mode | int | 3.14. use_mode (int) |
| use_mode | int | 3.1. mask_key (str) |
| mask_key | str | Keyword to mask the headers. |
| mask_ip | str | IP address to be used in masked headers to build valid SIP URIs. Can be any IP address, even a private-space or non-existing IP address (e.g., 192.168.1.1, 127.0.0.2), including the SIP server address |
| mask_callid | integer | Whether to encode the Call-id: header. Some SIP extensions include the Call-id in the SIP message payload or header, so it is safe to not encode Call-id in such cases. Well-known extensions such as ca |
| mask_mode | integer | Control when and what parts of SIP message are masked. |
| uparam_name | str | Name of URI parameter where to store encoded value. |
| uparam_prefix | str | Prefix to be added in encoded URI parameters. |
| vparam_name | str | Name of Via: parameter used to store encoded value. |
| vparam_prefix | str | Prefix to be added in encoded Via: parameters. |
| callid_prefix | str | Prefix to be added in encoded Call-ID: headers. |
| sanity_checks | integer | 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 form |
| uri_prefix_checks | integer | If set to 1, topoh module will check if URIs to be decoded match the expected prefix composed from mask IP and parameter name prefix. It can make the topoh processing safer by avoiding to try decoding |
| event_callback | str | The name of the function in the KEMI configuration file (embedded scripting language such as Lua, Python, ...) to be executed instead of event_route[...] blocks. |
| event_mode | int | Control what event_route blocks to be executed. It is a bitmask of: 1 - execute event_route[topoh:msg-outgoing]; 2 - execute event_route[topoh:msg-sending]. |
| use_mode | int | Control how the module is initialized. If set to 1, the module is only initialized to be used as a library via inter-module API functions. If set to 0, the module is initialized for SIP messages proce |
Copyright © 2009 FhG FOKUS
