For developer documentation and license templates, I suggest we decide
to use "sip-router" as a name always. In my personal eyes, Kamailio
and SER will be distributions of SIP-router, but the source will be
sip-router. User documentation needs the distribution name, but that
is something we need to fix after we branch out in all possible
distributions, including the hitherto secret Edvina Megaproxy and
Asipto 3S - SuperSipServer - distributions ;-)
Anyone against this policy in regards to all source code and doxygen?
/O
Module: sip-router
Branch: master
Commit: 0536bbc8739a46a5b67f37519e03881d5bf07684
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0536bbc…
Author: oej <oej(a)edvina.net>
Committer: oej <oej(a)edvina.net>
Date: Sat Oct 10 16:13:46 2009 +0200
Typos, formatting
---
modules/auth_identity/README | 47 ++++++++++++++-------------
modules/auth_identity/doc/auth_identity.xml | 22 ++++++------
2 files changed, 35 insertions(+), 34 deletions(-)
diff --git a/modules/auth_identity/README b/modules/auth_identity/README
index 70deb13..592f0aa 100644
--- a/modules/auth_identity/README
+++ b/modules/auth_identity/README
@@ -1,4 +1,4 @@
-1. Auth Identity Module
+1. SIP Authenticated Identity Module
Gergely Kovacs
@@ -70,7 +70,7 @@ Gergely Kovacs
* verifier - verifies an authorized message
Known limitations in this version:
- * authorizer and verifier support only SIP requests except for CANCEL
+ * authorizer and verifier support all SIP requests except for CANCEL
and REGISTER
* verifier does not support the subjectAltName extension of
certificates
@@ -83,17 +83,17 @@ Gergely Kovacs
This module needs the following headers and libraries:
* OpenSSL (version 0.9.8 or higher) for cryptographic functions
- * libcURL for HTTP, HTTPS functions
+ * libcurl for HTTP, HTTPS functions
If you'd like to use TLS module too then use the corresponding LIB line
in auth_identity's Makefile
1.4. Installation And Running
- Authorizer service needs an opportunity to make the public key, which
- conveyed in a certificate, available over HTTPS or HTTP for verifiers.
- The domain the authorizer is responsible for and the domain part of the
- URL of the certificate must be the same. This service needs its private
+ the Authorizer service needs to make the public key, which conveyed in
+ a certificate, available over HTTPS or HTTP for verifiers. The domain
+ the authorizer is responsible for and the domain part of the URL of the
+ certificate must be the same. This service needs access to the private
key too.
1.5. Authorizer service parameters
@@ -150,26 +150,27 @@ modparam("auth_identity","msg_timeout",600)
1.6. Authorizer service functions
-1.6.1. auth_date_proc()
+1.6.1. auth_date_proc()
If a message, the auth service should authorize, contains Date header
then this function checks whether it falls in message timeout (set by
- msg_timeout parameter). If there is not any Date header then adds one.
- This function also checks whether the certificate of auth service (set
- by certificate_path parameter) has not been expired.
+ msg_timeout parameter). If there is not any Date header then the module
+ adds one. This function also checks whether the certificate of the
+ authentication service (set by certificate_path parameter) has been
+ expired.
1.6.1.1. Dependencies
No dependencies
-1.6.2. auth_add_identity()
+1.6.2. auth_add_identity()
Assembles digest-string from the message, calculates its SHA1 hash,
- encrypt it with the private key (set by privatekey_path parameter) of
- authorizer service, base64 encodes it and adds to the outgoing message
- as the value of Identity header. This function also adds Identity-Info
- header which contains an URI (set by certificate_url parameter) from
- which the certificate of auth service can be acquired.
+ encrypts it with the private key (set by privatekey_path parameter) of
+ the authorizer service, base64 encodes it and adds to the outgoing
+ message as the value of Identity header. This function also adds
+ Identity-Info header which contains an URI (set by certificate_url
+ parameter) from which the certificate of auth service can be acquired.
Note: this function needs the final outgoing message for authorization,
so no module may modify any digest string related headers (From, To,
@@ -270,7 +271,7 @@ modparam("auth_identity","certificate_cache_limit",4096)
A file of trusted certificates. The file should contain multiple
certificates in PEM format concatenated together. It could be useful
- for verifying a certificate not signed by a trusted CA.
+ for verifying a certificate signed by a private CA.
This parameter is optional. It has not got default value.
@@ -292,7 +293,7 @@ modparam("auth_identity","accept_pem_certs",1)
1.9. Verifier service functions
-1.9.1. vrfy_check_date()
+1.9.1. vrfy_check_date()
Checks Date header of the incoming message whether falls in validity
time (set by auth_validity_time parameter)
@@ -301,7 +302,7 @@ modparam("auth_identity","accept_pem_certs",1)
No dependencies
-1.9.2. vrfy_get_certificate()
+1.9.2. vrfy_get_certificate()
Tries to get certificate defined by the value of Identity-info header
from certificate table (which size is set by certificate_cache_limit
@@ -312,7 +313,7 @@ modparam("auth_identity","accept_pem_certs",1)
No dependencies
-1.9.3. vrfy_check_certificate()
+1.9.3. vrfy_check_certificate()
Checks whether the downloaded certificate is valid (is not expired, its
subject and the domain part of the URL are the same) and adds it to
@@ -322,7 +323,7 @@ modparam("auth_identity","accept_pem_certs",1)
vrfy_get_certificate() must be called before
-1.9.4. vrfy_check_msgvalidity()
+1.9.4. vrfy_check_msgvalidity()
Assembles digest-string from the message, create SHA1 hash and compares
it with the decrypted value of Identity header.
@@ -332,7 +333,7 @@ modparam("auth_identity","accept_pem_certs",1)
vrfy_get_certificate() must be called before and
vrfy_check_certificate() should be called before
-1.9.5. vrfy_check_callid()
+1.9.5. vrfy_check_callid()
Checks whether the current call's been already processed in validity
time (set by auth_validity_time) to recognize call replay attacks. If
diff --git a/modules/auth_identity/doc/auth_identity.xml b/modules/auth_identity/doc/auth_identity.xml
index c473752..a47f5db 100644
--- a/modules/auth_identity/doc/auth_identity.xml
+++ b/modules/auth_identity/doc/auth_identity.xml
@@ -20,7 +20,7 @@
</copyright>
</sectioninfo>
- <title>Auth Identity Module</title>
+ <title>SIP Authenticated Identity Module</title>
<section>
<title>Overview</title>
@@ -47,7 +47,7 @@
<itemizedlist>
<listitem>
<para>
- authorizer and verifier support only SIP requests except for
+ authorizer and verifier support all SIP requests except for
<emphasis>CANCEL</emphasis> and <emphasis>REGISTER</emphasis>
</para>
</listitem>
@@ -79,7 +79,7 @@
</listitem>
<listitem>
<para>
- <emphasis>libcURL</emphasis> for HTTP, HTTPS functions
+ <emphasis>libcurl</emphasis> for HTTP, HTTPS functions
</para>
</listitem>
</itemizedlist>
@@ -91,11 +91,11 @@
<section id="auth_identity.install_and_run">
<title>Installation And Running</title>
<para>
- <emphasis>Authorizer</emphasis> service needs an opportunity to make the public key,
+ the <emphasis>Authorizer</emphasis> service needs to make the public key,
which conveyed in a certificate, available over HTTPS or HTTP for
verifiers. The domain the authorizer is responsible for and the
domain part of the URL of the certificate must be the same. This
- service needs its private key too.
+ service needs access to the private key too.
</para>
</section>
@@ -197,9 +197,9 @@ modparam("auth_identity","msg_timeout",600)
If a message, the auth service should authorize, contains Date header
then this function checks whether it falls in message timeout (set by
<emphasis>msg_timeout</emphasis> parameter). If there is not any Date
- header then adds one. This function also checks whether the certificate
- of auth service (set by <emphasis>certificate_path</emphasis> parameter)
- has not been expired.
+ header then the module adds one. This function also checks whether the certificate
+ of the authentication service (set by <emphasis>certificate_path</emphasis> parameter)
+ has been expired.
</para>
<section>
<title>Dependencies</title>
@@ -215,8 +215,8 @@ modparam("auth_identity","msg_timeout",600)
</title>
<para>
Assembles digest-string from the message, calculates its SHA1 hash,
- encrypt it with the private key (set by <emphasis>privatekey_path</emphasis>
- parameter) of authorizer service, base64 encodes it and adds to the
+ encrypts it with the private key (set by <emphasis>privatekey_path</emphasis>
+ parameter) of the authorizer service, base64 encodes it and adds to the
outgoing message as the value of <emphasis>Identity</emphasis> header.
This function also adds Identity-Info header which contains an URI
(set by <emphasis>certificate_url</emphasis> parameter) from which
@@ -362,7 +362,7 @@ modparam("auth_identity","certificate_cache_limit",4096)
<para>
A file of trusted certificates. The file should contain multiple
certificates in PEM format concatenated together. It could be useful
- for verifying a certificate not signed by a trusted CA.
+ for verifying a certificate signed by a private CA.
</para>
<para>
This parameter is optional. It has not got default value.
Module: sip-router
Branch: master
Commit: 7eb41a8e6f5e89c67dedb60903f0e6119f115851
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=7eb41a8…
Author: oej <oej(a)edvina.net>
Committer: oej <oej(a)edvina.net>
Date: Sat Oct 10 14:23:09 2009 +0200
Fixing typos, changing names
---
COPYING | 16 +++++++++-------
modules/topoh/README | 24 ++++++++++++------------
modules/topoh/doc/topoh_admin.xml | 22 +++++++++++-----------
3 files changed, 32 insertions(+), 30 deletions(-)
diff --git a/COPYING b/COPYING
index 21550e8..5d1f230 100644
--- a/COPYING
+++ b/COPYING
@@ -2,18 +2,19 @@
-------------------------------------------------------------------------
IMPORTANT NOTES
-1) The GPL applies to this copy of SIP Express Router software (ser).
+1) The GPL applies to this copy of SIP Router software (sip-router).
-2) ser software allows programmers to plug-in external modules to the
+2) SIP-router software allows programmers to plug-in external modules to the
core part. Note that GPL mandates all plug-ins developed for the
- ser software released under GPL license to be GPL-ed or use a GPL
- compatible free software license.
+ SIP-router software are to be released under GPL license to be GPL-ed or
+ use a GPL compatible free software license.
(see http://www.gnu.org/copyleft/gpl-faq.html#GPLAndPlugins
for a detailed explanation)
3) Note that the GPL bellow is copyrighted by the Free Software Foundation,
- but the ser software is copyrighted by FhG
+ but the SIP-router software is copyrighted by multiple individuals and
+ companies.
-------------------------------------------------------------------------
@@ -22,11 +23,12 @@ GNU Licence FAQ
This FAQ provides answers to most frequently asked questions. To fully
understand implications of the GNU license, read it.
-- you can run SER for any purpose
+- you can run SIP-router for any purpose
- you can redistribute it as long as you include source code and
license conditions with the distribution
-- you cannot release programs derived from SER without releasing
+- you cannot release programs derived from SIP-router without releasing
their source code
+- you can not change the copyright of any part of SIP-router
-------------------------------------------------------------------------
diff --git a/modules/topoh/README b/modules/topoh/README
index 7582106..f6bb788 100644
--- a/modules/topoh/README
+++ b/modules/topoh/README
@@ -71,17 +71,17 @@ Chapter 1. Admin Guide
1. Overview
This module hides the routing headers that show topology details. It it
- is not affected by the server being transaction statless or stateful.
+ is not affected by the server being transaction stateless or stateful.
The script interpretor gets the SIP messages decoded, so all
functionality existing so far is preserved.
- The module is transparent for config writer. It only needs to be loaded
- (tune the parameters if wanted). The SIP server can be restarted
- whitout affecting ongoing calls - once it is up, can encode/decode
- topology details, thus no call is lost.
+ 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 whitout 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
- examlple, applicable for servers behind load balancers.
+ example, applicable for servers behind load balancers.
2. Dependencies
@@ -123,10 +123,10 @@ modparam("topoh", "mask_key", "some secret here")
3.2. mask_callid (integer)
- Whether to encode or not the call-id. Some SIP extensions include the
- call-id in SIP message payload or header, so it is safe to not encode
- call-id in such cases. Well-known extensions such as call transfer or
- conference join will be added to work with encoded call-id.
+ 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 call
+ transfer or conference join will be added to work with encoded Call-id.
Default value is 0 (do not mask).
@@ -159,7 +159,7 @@ modparam("topoh", "uparam_prefix", "xyz")
3.5. vparam_name (str)
- Name of Via param where to store encoded value.
+ Name of Via: parameter where to store encoded value.
Default value is "branch".
@@ -170,7 +170,7 @@ modparam("topoh", "vparam_name", "myv")
3.6. vparam_prefix (str)
- Prefix to be added in encoded Via params.
+ Prefix to be added in encoded Via: parameters.
Default value is "z9hG4bKsr-".
diff --git a/modules/topoh/doc/topoh_admin.xml b/modules/topoh/doc/topoh_admin.xml
index 85648df..4da3862 100644
--- a/modules/topoh/doc/topoh_admin.xml
+++ b/modules/topoh/doc/topoh_admin.xml
@@ -17,19 +17,19 @@
<title>Overview</title>
<para>
This module hides the routing headers that show topology details.
- It it is not affected by the server being transaction statless or
+ It it is not affected by the server being transaction stateless or
stateful. The script interpretor gets the SIP messages decoded,
so all functionality existing so far is preserved.
</para>
<para>
- The module is transparent for config writer. It only needs to be
- loaded (tune the parameters if wanted). The SIP server can be restarted
+ 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
whitout affecting ongoing calls - once it is up, can encode/decode
- topology details, thus no call is lost.
+ topology details, thus no call will be lost.
</para>
<para>
By using same mask_key, many SIP servers can decode the message,
- for examlple, applicable for servers behind load balancers.
+ for example, applicable for servers behind load balancers.
</para>
</section>
<section>
@@ -88,11 +88,11 @@ modparam("topoh", "mask_key", "some secret here")
<section>
<title><varname>mask_callid</varname> (integer)</title>
<para>
- Whether to encode or not the call-id. Some SIP extensions include
- the call-id in SIP message payload or header, so it is safe to
- not encode call-id in such cases. Well-known extensions such as
+ 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
call transfer or conference join will be added to work with encoded
- call-id.
+ Call-id.
</para>
<para>
<emphasis>
@@ -149,7 +149,7 @@ modparam("topoh", "uparam_prefix", "xyz")
<section>
<title><varname>vparam_name</varname> (str)</title>
<para>
- Name of Via param where to store encoded value.
+ Name of Via: parameter where to store encoded value.
</para>
<para>
<emphasis>
@@ -168,7 +168,7 @@ modparam("topoh", "vparam_name", "myv")
<section>
<title><varname>vparam_prefix</varname> (str)</title>
<para>
- Prefix to be added in encoded Via params.
+ Prefix to be added in encoded Via: parameters.
</para>
<para>
<emphasis>