[sr-dev] git:master: UAC: Documentation updates and typo fixes

Module: sip-router Branch: master Commit: 18220b91255f9a563ce56f1d05fe97905e7fe2d9 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=18220b9… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Mon Oct 29 21:57:32 2012 +0100 UAC: Documentation updates and typo fixes --- modules_k/uac/README | 30 ++++++++++++++++-------------- modules_k/uac/doc/uac_admin.xml | 25 +++++++++++++------------ modules_k/uac/uac_reg.c | 2 +- 3 files changed, 30 insertions(+), 27 deletions(-) diff --git a/modules_k/uac/README b/modules_k/uac/README index 7c115c3..d803f7e 100644 --- a/modules_k/uac/README +++ b/modules_k/uac/README @@ -137,20 +137,20 @@ Chapter 1. Admin Guide The UAC (User Agent Client) module provides some basic UAC functionalities like sending SIP requests, registering with a remote - service and FROM header manipulation (anonymization) or client + service, FROM header manipulation (anonymization) and client authentication. From version 1.5.0 it has function to send SIP message from configuration file. See variable $uac_req(name) and the function uac_req_send(). - Version 3.1.0 adds user registration functionality. See + Version 3.1.0 adds database-driven SIP registration functionality. See uac_reg_lookup() function and dedicated section for remote registration configuration. Known limitations in this version: - * authentication does not support qop auth-int, just qop auth; - * CSeq not increased during authentication - the response may be + * Authentication does not support qop auth-int, just qop auth; + * CSeq is not increased during authentication - the response may be rejected. 2. Dependencies @@ -193,8 +193,8 @@ Chapter 1. Admin Guide 3.1. rr_from_store_param (string) - Name of Record-Route header parameter that will be used to store - (encoded) the original FROM URI. + Name of Record-Route header parameter that will be used to store an + encoded version of the original FROM URI. This parameter is optional, it's default value being "vsf". @@ -217,8 +217,8 @@ modparam("uac","rr_to_store_param","my_param") 3.3. restore_mode (string) - There are 3 mode of restoring the original FROM URI and the original TO - URI: + There are 3 modes of restoring the original FROM URI and the original + TO URI: * "none" - no information about original URI is stored; restoration is not possible. * "manual" - all following replies will be restored, but not also the @@ -237,8 +237,8 @@ modparam("uac","restore_mode","auto") 3.4. restore_dlg (int) If set to 1, the module uses dialog variables to store initial and new - values for From/To headers. Dialog module has to be loaded and all - calls that involve chages to From/To headers must be tracked. + values for From/To headers. The Dialog module has to be loaded and all + calls that involve changes to From/To headers must be tracked. Default value of this parameter is 0. @@ -281,8 +281,8 @@ modparam("uac","restore_from_avp","$avp(original_uri_from)") 3.7. restore_to_avp (string) If defined and restore_mode is manual or auto, the avp is used to save - the original to uri in order to be able to restore it in replies. That - makes sense, if the original-uri can not be extracted from the original + the original To URI in order to be able to restore it in replies. That + makes sense if the original-uri can not be extracted from the original request, e.g. if msg_apply_changes() was used after calling uac_replace_to() @@ -353,7 +353,7 @@ modparam("uac","auth_password_avp","$avp(i:12)") 3.12. reg_db_url (string) - DB URL to fetch user profiles for registration. + DB URL to fetch account profiles for registration. Example 1.12. Set reg_db_url parameter ... @@ -376,7 +376,9 @@ modparam("uac", "reg_timer_interval", 60) 3.14. reg_contact_addr (string) Address to be used to build contact address. Must be at least host - part, can have port and parameters. Must not include 'sip:'. + part, can have port and parameters. Must not include 'sip:'. The + username part of the Contact: URI will be the L_UUID field in the + database. Example 1.14. Set reg_contact_addr parameter ... diff --git a/modules_k/uac/doc/uac_admin.xml b/modules_k/uac/doc/uac_admin.xml index f663688..5e3b70a 100644 --- a/modules_k/uac/doc/uac_admin.xml +++ b/modules_k/uac/doc/uac_admin.xml @@ -18,8 +18,8 @@ <title>Overview</title> <para> The <acronym>UAC</acronym> (User Agent Client) module provides some basic UAC - functionalities like sending SIP requests, registering with a remote service - and FROM header manipulation (anonymization) or client authentication. + functionalities like sending SIP requests, registering with a remote service, + FROM header manipulation (anonymization) and client authentication. </para> <para> From version 1.5.0 it has function to send SIP message from @@ -27,7 +27,7 @@ uac_req_send(). </para> <para> - Version 3.1.0 adds user registration functionality. See + Version 3.1.0 adds database-driven SIP registration functionality. See uac_reg_lookup() function and dedicated section for remote registration configuration. </para> @@ -37,12 +37,12 @@ <itemizedlist> <listitem> <para> - authentication does not support qop auth-int, just qop auth; + Authentication does not support qop auth-int, just qop auth; </para> </listitem> <listitem> <para> - CSeq not increased during authentication - the response + CSeq is not increased during authentication - the response may be rejected. </para> </listitem> @@ -100,7 +100,7 @@ <title><varname>rr_from_store_param</varname> (string)</title> <para> Name of Record-Route header parameter that will be used to store - (encoded) the original FROM URI. + an encoded version of the original FROM URI. </para> <para> <emphasis> @@ -141,7 +141,7 @@ modparam("uac","rr_to_store_param","my_param") <section> <title><varname>restore_mode</varname> (string)</title> <para> - There are 3 mode of restoring the original FROM URI and the original TO URI: + There are 3 modes of restoring the original FROM URI and the original TO URI: <itemizedlist> <listitem> <para> @@ -184,8 +184,8 @@ modparam("uac","restore_mode","auto") <title><varname>restore_dlg</varname> (int)</title> <para> If set to 1, the module uses dialog variables to store initial and - new values for From/To headers. Dialog module has to be loaded and - all calls that involve chages to From/To headers must be tracked. + new values for From/To headers. The Dialog module has to be loaded and + all calls that involve changes to From/To headers must be tracked. </para> <para> <emphasis> @@ -251,8 +251,8 @@ modparam("uac","restore_from_avp","$avp(original_uri_from)") <title><varname>restore_to_avp</varname> (string)</title> <para> If defined and restore_mode is manual or auto, the avp is used to save - the original to uri in order to be able to restore it in replies. - That makes sense, if the original-uri can not be extracted from the original + the original To URI in order to be able to restore it in replies. + That makes sense if the original-uri can not be extracted from the original request, e.g. if msg_apply_changes() was used after calling uac_replace_to() </para> <para> @@ -361,7 +361,7 @@ modparam("uac","auth_password_avp","$avp(i:12)") <section id="reg-db-url-id"> <title><varname>reg_db_url</varname> (string)</title> <para> - DB URL to fetch user profiles for registration. + DB URL to fetch account profiles for registration. </para> <example> <title>Set <varname>reg_db_url</varname> parameter</title> @@ -402,6 +402,7 @@ modparam("uac", "reg_timer_interval", 60) <para> Address to be used to build contact address. Must be at least host part, can have port and parameters. Must not include 'sip:'. + The username part of the Contact: URI will be the L_UUID field in the database. </para> <example> <title>Set <varname>reg_contact_addr</varname> parameter</title> diff --git a/modules_k/uac/uac_reg.c b/modules_k/uac/uac_reg.c index 67deb46..645686f 100644 --- a/modules_k/uac/uac_reg.c +++ b/modules_k/uac/uac_reg.c @@ -557,7 +557,7 @@ void uac_reg_tm_callback( struct cell *t, int type, struct tmcb_params *ps) if(auth.realm.len!=ri->realm.len || strncmp(auth.realm.s, ri->realm.s, ri->realm.len)!=0) { - LM_ERR("realms are different - ignire?!?!\n"); + LM_ERR("realms are different - ignore?!?!\n"); } cred.realm = auth.realm; cred.user = ri->auth_username;