[sr-dev] git:master: auth_identity README updates

Module: sip-router Branch: master Commit: c9497bf0653ffca09bd180ea01d7089a14f8f0e2 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=c9497bf… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Thu Dec 20 20:26:12 2012 +0100 auth_identity README updates --- modules/auth_identity/README | 42 +++++++++++++++++++- modules/auth_identity/doc/auth_identity.xml | 20 +++++---- .../{functions.xml => auth_identity_functions.xml} | 0 .../doc/{params.xml => auth_identity_params.xml} | 0 4 files changed, 52 insertions(+), 10 deletions(-) diff --git a/modules/auth_identity/README b/modules/auth_identity/README index 154a40e..ae19c24 100644 --- a/modules/auth_identity/README +++ b/modules/auth_identity/README @@ -22,7 +22,9 @@ Gergely Kovacs 1. Overview Auth Identity module provides functionalities for securely identifying - originators of SIP messages. This module has two basic service: + originators of SIP messages. It implements the SIP Identity standard + where a SIP proxy signs messages that is sent to other domains. This + module has two basic services: * authorizer - authorizes a message and adds Identity and Identity-Info headers * verifier - verifies an authorized message @@ -56,6 +58,16 @@ Gergely Kovacs 5. Parameters + 5.1. privatekey_path (string) + 5.2. certificate_path (string) + 5.3. certificate_url (string) + 5.4. msg_timeout (integer) + 5.5. auth_validity_time (integer) + 5.6. callid_cache_limit (integer) + 5.7. certificate_cache_limit (integer) + 5.8. cainfo_path (string) + 5.9. accept_pem_certs ([0|1]) + 5.1. privatekey_path (string) Note: this parameter is for authorizer service. @@ -191,6 +203,34 @@ modparam("auth_identity","accept_pem_certs",1) 6. Functions + 6.1. auth_date_proc() + + 6.1.1. Dependencies + + 6.2. auth_add_identity() + + 6.2.1. Dependencies + + 6.3. vrfy_check_date() + + 6.3.1. Dependencies + + 6.4. vrfy_get_certificate() + + 6.4.1. Dependencies + + 6.5. vrfy_check_certificate() + + 6.5.1. Dependencies + + 6.6. vrfy_check_msgvalidity() + + 6.6.1. Dependencies + + 6.7. vrfy_check_callid() + + 6.7.1. Dependencies + 6.1. auth_date_proc() Note: this function is for authorizer service. diff --git a/modules/auth_identity/doc/auth_identity.xml b/modules/auth_identity/doc/auth_identity.xml index e730afa..dcbd376 100644 --- a/modules/auth_identity/doc/auth_identity.xml +++ b/modules/auth_identity/doc/auth_identity.xml @@ -34,7 +34,9 @@ <title>Overview</title> <para> Auth Identity module provides functionalities for securely identifying - originators of SIP messages. This module has two basic service: + originators of SIP messages. It implements the SIP Identity standard where a + SIP proxy signs messages that is sent to other domains. + This module has two basic services: <itemizedlist> <listitem> <para> @@ -59,12 +61,12 @@ <emphasis>CANCEL</emphasis> and <emphasis>REGISTER</emphasis> </para> </listitem> - <listitem> - <para> - verifier does not support the subjectAltName extension of - certificates - </para> - </listitem> + <listitem> + <para> + verifier does not support the subjectAltName extension of + certificates + </para> + </listitem> </itemizedlist> </section> @@ -108,8 +110,8 @@ </section> - <xi:include href="params.xml"/> - <xi:include href="functions.xml"/> + <xi:include href="auth_identity_params.xml"/> + <xi:include href="auth_identity_functions.xml"/> <section> diff --git a/modules/auth_identity/doc/functions.xml b/modules/auth_identity/doc/auth_identity_functions.xml similarity index 100% rename from modules/auth_identity/doc/functions.xml rename to modules/auth_identity/doc/auth_identity_functions.xml diff --git a/modules/auth_identity/doc/params.xml b/modules/auth_identity/doc/auth_identity_params.xml similarity index 100% rename from modules/auth_identity/doc/params.xml rename to modules/auth_identity/doc/auth_identity_params.xml