Browse code

modules: refreshed the readme files for many modules

Daniel-Constantin Mierla authored on 18/12/2015 11:16:08
Showing 61 changed files
... ...
@@ -16,7 +16,7 @@ Daniel-Constantin Mierla
16 16
    asipto.com
17 17
    <miconda@gmail.com>
18 18
 
19
-   Copyright © 2002, 2003 FhG FOKUS
19
+   Copyright � 2002, 2003 FhG FOKUS
20 20
      __________________________________________________________________
21 21
 
22 22
    Table of Contents
... ...
@@ -119,7 +119,7 @@ Chapter 1. Admin Guide
119 119
    If the parameter is set to empty string, the RADIUS accounting support
120 120
    will be disabled (even if compiled).
121 121
 
122
-   Default value is “NULL”.
122
+   Default value is "NULL".
123 123
 
124 124
    Example 1.1. radius_config example
125 125
 ...
... ...
@@ -176,11 +176,11 @@ modparam("acc_radius", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)")
176 176
 
177 177
    4.1. acc_rad_request(comment)
178 178
 
179
-4.1.  acc_rad_request(comment)
179
+4.1. acc_rad_request(comment)
180 180
 
181 181
    Like acc_log_request of acc module, acc_rad_request reports on a SIP
182 182
    request event. It reports to radius server as configured in
183
-   “radius_config”.
183
+   "radius_config".
184 184
 
185 185
    Meaning of the parameters is as follows:
186 186
      * comment - Comment to be appended.
... ...
@@ -126,7 +126,7 @@ Chapter 1. Admin Guide
126 126
 
127 127
    Database URL.
128 128
 
129
-   Default value is "mysql://openserro:openserro@localhost/openser".
129
+   Default value is "mysql://kamailioro:kamailioro@localhost/kamailio".
130 130
 
131 131
    Example 1.1. Set db_url parameter
132 132
 ...
... ...
@@ -6,7 +6,7 @@ Edited by
6 6
 
7 7
 Maxim Sobolev
8 8
 
9
-   Copyright © 2010 Maxim Sobolev
9
+   Copyright � 2010 Maxim Sobolev
10 10
      __________________________________________________________________
11 11
 
12 12
    Table of Contents
... ...
@@ -27,7 +27,7 @@ Maxim Sobolev
27 27
 
28 28
         4. Functions
29 29
 
30
-              4.1. python_exec(method [, mystr])
30
+              4.1. python_exec(method [, args])
31 31
 
32 32
    List of Examples
33 33
 
... ...
@@ -54,13 +54,17 @@ Chapter 1. Admin Guide
54 54
 
55 55
    4. Functions
56 56
 
57
-        4.1. python_exec(method [, mystr])
57
+        4.1. python_exec(method [, args])
58 58
 
59 59
 1. Overview
60 60
 
61 61
    This module allows executing Python scripts from config file, exporting
62 62
    functions to access the SIP message from Python.
63 63
 
64
+   For some basic examples of Python scripts that can be used with this
65
+   module, look at the files inside source tree located at
66
+   'modules/app_python/python_examples/'.
67
+
64 68
 2. Dependencies
65 69
 
66 70
    2.1. Kamailio Modules
... ...
@@ -85,20 +89,22 @@ Chapter 1. Admin Guide
85 89
 
86 90
 3.1. script_name (string)
87 91
 
88
-   TBD.
92
+   The path to the fiel with Python code to be executed from configuration
93
+   file.
89 94
 
90
-   Default value is “/usr/local/etc/sip-router/handler.py”.
95
+   Default value is "/usr/local/etc/kamailio/handler.py".
91 96
 
92 97
    Example 1.1. Set script_name parameter
93 98
 ...
94
-modparam("app_python", "script_name", "/usr/local/etc/sip-router/myscript.py")
99
+modparam("app_python", "script_name", "/usr/local/etc/kamailio/myscript.py")
95 100
 ...
96 101
 
97 102
 3.2. mod_init_function (string)
98 103
 
99
-   TBD.
104
+   The Python function to be executed by this module when it is initialied
105
+   by Kamailio.
100 106
 
101
-   Default value is “mod_init”.
107
+   Default value is "mod_init".
102 108
 
103 109
    Example 1.2. Set mod_init_function parameter
104 110
 ...
... ...
@@ -107,9 +113,10 @@ modparam("app_python", "mod_init_function", "my_mod_init")
107 113
 
108 114
 3.3. child_init_method (string)
109 115
 
110
-   TBD.
116
+   The Python function to be executed by this module when a new worker
117
+   process (child) is initialied by Kamailio.
111 118
 
112
-   Default value is “child_init”.
119
+   Default value is "child_init".
113 120
 
114 121
    Example 1.3. Set child_init_method parameter
115 122
 ...
... ...
@@ -118,14 +125,16 @@ modparam("app_python", "child_init_method", "my_child_init")
118 125
 
119 126
 4. Functions
120 127
 
121
-   4.1. python_exec(method [, mystr])
128
+   4.1. python_exec(method [, args])
122 129
 
123
-4.1.  python_exec(method [, mystr])
130
+4.1. python_exec(method [, args])
124 131
 
125
-   TBD.
132
+   Execute the Python function with the name given by the parameter
133
+   'method'. Optionally can be provided a second string with parameters to
134
+   be passed to the Python function.
126 135
 
127 136
    Example 1.4. python_exec usage
128 137
 ...
129
-python_exec("...");
130
-python_exec("...", "...");
138
+python_exec("my_python_function");
139
+python_exec("my_python_function", "my_params");
131 140
 ...
... ...
@@ -5,7 +5,7 @@ Peter Dunkley
5 5
    Crocodile RCS Ltd
6 6
    <peter.dunkley@crocodile-rcs.com>
7 7
 
8
-   Copyright © 2013 Crocodile RCS Ltd
8
+   Copyright � 2013 Crocodile RCS Ltd
9 9
      __________________________________________________________________
10 10
 
11 11
    Table of Contents
... ...
@@ -221,7 +221,7 @@ modparam("auth_ephemeral", "username_format", 0)
221 221
    4.6. autheph_check_to([username])
222 222
    4.7. autheph_check_timestamp(username)
223 223
 
224
-4.1.  autheph_proxy(realm)
224
+4.1. autheph_proxy(realm)
225 225
 
226 226
    This function performs proxy authentication.
227 227
 
... ...
@@ -235,7 +235,7 @@ Note
235 235
        present to the user so that he can decide what username and
236 236
        password to use. Usually this is domain of the host the server is
237 237
        running on.
238
-       It must not be an empty string “”. Apart from a static string, a
238
+       It must not be an empty string "". Apart from a static string, a
239 239
        typical value is the From-URI domain (i.e., $fd).
240 240
        The string may contain pseudo variables.
241 241
 
... ...
@@ -249,7 +249,7 @@ if (!autheph_proxy("$fd")) {
249 249
 }
250 250
 ...
251 251
 
252
-4.2.  autheph_www(realm[, method])
252
+4.2. autheph_www(realm[, method])
253 253
 
254 254
    This function performs WWW digest authentication.
255 255
 
... ...
@@ -263,7 +263,7 @@ Note
263 263
        present to the user so that he can decide what username and
264 264
        password to use. Usually this is domain of the host the server is
265 265
        running on.
266
-       It must not be an empty string “”. Apart from a static string, a
266
+       It must not be an empty string "". Apart from a static string, a
267 267
        typical value is the From-URI domain (i.e., $fd).
268 268
        The string may contain pseudo variables.
269 269
      * method - the method to be used for authentication. This parameter
... ...
@@ -280,7 +280,7 @@ if (!autheph_www("$fd")) {
280 280
 }
281 281
 ...
282 282
 
283
-4.3.  autheph_check(realm)
283
+4.3. autheph_check(realm)
284 284
 
285 285
    This function combines the functionalities of autheph_www and
286 286
    autheph_proxy, the first being exectuted if the SIP request is a
... ...
@@ -296,7 +296,7 @@ Note
296 296
        present to the user so that he can decide what username and
297 297
        password to use. Usually this is domain of the host the server is
298 298
        running on.
299
-       It must not be an empty string “”. Apart from a static string, a
299
+       It must not be an empty string "". Apart from a static string, a
300 300
        typical value is the From-URI domain (i.e., $fd).
301 301
        The string may contain pseudo variables.
302 302
 
... ...
@@ -310,7 +310,7 @@ if (!autheph_check("$fd")) {
310 310
 }
311 311
 ...
312 312
 
313
-4.4.  autheph_authenticate(username, password)
313
+4.4. autheph_authenticate(username, password)
314 314
 
315 315
    This function performs non-digest ephemeral authentication. This may be
316 316
    used when digest authentication cannot. For example, during WebSocket
... ...
@@ -337,7 +337,7 @@ if (!autheph_authenticate("$var(username)", "$var(password)")) {
337 337
 }
338 338
 ...
339 339
 
340
-4.5.  autheph_check_from([username])
340
+4.5. autheph_check_from([username])
341 341
 
342 342
    This function checks that the username (or username and domain) in the
343 343
    From: URI matches the credentials.
... ...
@@ -371,7 +371,7 @@ if (!autheph_check_from()) {
371 371
 }
372 372
 ...
373 373
 
374
-4.6.  autheph_check_to([username])
374
+4.6. autheph_check_to([username])
375 375
 
376 376
    This function checks that the username (or username and domain) in the
377 377
    To: URI matches the credentials.
... ...
@@ -405,7 +405,7 @@ if (!autheph_check_to()) {
405 405
 }
406 406
 ...
407 407
 
408
-4.7.  autheph_check_timestamp(username)
408
+4.7. autheph_check_timestamp(username)
409 409
 
410 410
    This function checks that the timestamp in the username parameter has
411 411
    not expired. The autheph_(check|proxy|www) functions all do this
... ...
@@ -1,4 +1,3 @@
1
-
2 1
 SIP Authenticated Identity Module
3 2
 
4 3
 Gergely Kovacs
... ...
@@ -6,7 +5,7 @@ Gergely Kovacs
6 5
    Iptel.org
7 6
 
8 7
    Copyright � 2007 Iptel.org
9
-     _________________________________________________________________
8
+     __________________________________________________________________
10 9
 
11 10
    Table of Contents
12 11
 
... ...
@@ -30,31 +29,31 @@ Gergely Kovacs
30 29
 
31 30
         6. Functions
32 31
 
33
-              6.1. auth_date_proc() 
32
+              6.1. auth_date_proc()
34 33
 
35 34
                     6.1.1. Dependencies
36 35
 
37
-              6.2. auth_add_identity() 
36
+              6.2. auth_add_identity()
38 37
 
39 38
                     6.2.1. Dependencies
40 39
 
41
-              6.3. vrfy_check_date() 
40
+              6.3. vrfy_check_date()
42 41
 
43 42
                     6.3.1. Dependencies
44 43
 
45
-              6.4. vrfy_get_certificate() 
44
+              6.4. vrfy_get_certificate()
46 45
 
47 46
                     6.4.1. Dependencies
48 47
 
49
-              6.5. vrfy_check_certificate() 
48
+              6.5. vrfy_check_certificate()
50 49
 
51 50
                     6.5.1. Dependencies
52 51
 
53
-              6.6. vrfy_check_msgvalidity() 
52
+              6.6. vrfy_check_msgvalidity()
54 53
 
55 54
                     6.6.1. Dependencies
56 55
 
57
-              6.7. vrfy_check_callid() 
56
+              6.7. vrfy_check_callid()
58 57
 
59 58
                     6.7.1. Dependencies
60 59
 
... ...
@@ -64,14 +63,14 @@ Gergely Kovacs
64 63
    List of Examples
65 64
 
66 65
    1.1. Set privatekey_path parameter
67
-   1.2. Set certificate_path parameter 
68
-   1.3. Set certificate_url parameter 
69
-   1.4. Set msg_timeout parameter 
70
-   1.5. Set auth_validity_time parameter 
71
-   1.6. Set auth_validity_time parameter 
72
-   1.7. Set certificate_cache_limit parameter 
73
-   1.8. Set cainfo_path parameter 
74
-   1.9. Set accept_pem_certs parameter 
66
+   1.2. Set certificate_path parameter
67
+   1.3. Set certificate_url parameter
68
+   1.4. Set msg_timeout parameter
69
+   1.5. Set auth_validity_time parameter
70
+   1.6. Set auth_validity_time parameter
71
+   1.7. Set certificate_cache_limit parameter
72
+   1.8. Set cainfo_path parameter
73
+   1.9. Set accept_pem_certs parameter
75 74
 
76 75
 Chapter 1. Admin Guide
77 76
 
... ...
@@ -95,31 +94,31 @@ Chapter 1. Admin Guide
95 94
 
96 95
    6. Functions
97 96
 
98
-        6.1. auth_date_proc() 
97
+        6.1. auth_date_proc()
99 98
 
100 99
               6.1.1. Dependencies
101 100
 
102
-        6.2. auth_add_identity() 
101
+        6.2. auth_add_identity()
103 102
 
104 103
               6.2.1. Dependencies
105 104
 
106
-        6.3. vrfy_check_date() 
105
+        6.3. vrfy_check_date()
107 106
 
108 107
               6.3.1. Dependencies
109 108
 
110
-        6.4. vrfy_get_certificate() 
109
+        6.4. vrfy_get_certificate()
111 110
 
112 111
               6.4.1. Dependencies
113 112
 
114
-        6.5. vrfy_check_certificate() 
113
+        6.5. vrfy_check_certificate()
115 114
 
116 115
               6.5.1. Dependencies
117 116
 
118
-        6.6. vrfy_check_msgvalidity() 
117
+        6.6. vrfy_check_msgvalidity()
119 118
 
120 119
               6.6.1. Dependencies
121 120
 
122
-        6.7. vrfy_check_callid() 
121
+        6.7. vrfy_check_callid()
123 122
 
124 123
               6.7.1. Dependencies
125 124
 
... ...
@@ -129,17 +128,17 @@ Chapter 1. Admin Guide
129 128
 1. Overview
130 129
 
131 130
    Auth Identity module provides functionalities for securely identifying
132
-   originators  of  SIP messages. It implements the SIP Identity standard
133
-   where  a  SIP proxy signs messages that is sent to other domains. This
131
+   originators of SIP messages. It implements the SIP Identity standard
132
+   where a SIP proxy signs messages that is sent to other domains. This
134 133
    module has two basic services:
135
-     * authorizer   -   authorizes   a  message  and  adds  Identity  and
134
+     * authorizer - authorizes a message and adds Identity and
136 135
        Identity-Info headers
137 136
      * verifier - verifies an authorized message
138 137
 
139 138
    Known limitations in this version:
140 139
      * authorizer and verifier support all SIP requests except for CANCEL
141 140
        and REGISTER
142
-     * verifier   does   not  support  the  subjectAltName  extension  of
141
+     * verifier does not support the subjectAltName extension of
143 142
        certificates
144 143
 
145 144
 2. Dependencies
... ...
@@ -152,16 +151,16 @@ Chapter 1. Admin Guide
152 151
      * OpenSSL (version 0.9.8 or higher) for cryptographic functions
153 152
      * libcurl for HTTP, HTTPS functions
154 153
 
155
-   If  you'd  like  to  use TLS module too then use the corresponding LIB
156
-   line in auth_identity's Makefile
154
+   If you'd like to use TLS module too then use the corresponding LIB line
155
+   in auth_identity's Makefile
157 156
 
158 157
 4. Installation And Running
159 158
 
160 159
    the Authorizer service needs to make the public key, which conveyed in
161
-   a  certificate, available over HTTPS or HTTP for verifiers. The domain
162
-   the  authorizer  is  responsible for and the domain part of the URL of
163
-   the  certificate  must  be  the same. This service needs access to the
164
-   private key too.
160
+   a certificate, available over HTTPS or HTTP for verifiers. The domain
161
+   the authorizer is responsible for and the domain part of the URL of the
162
+   certificate must be the same. This service needs access to the private
163
+   key too.
165 164
 
166 165
 5. Parameters
167 166
 
... ...
@@ -198,7 +197,7 @@ modparam("auth_identity","privatekey_path","/etc/ssl/private/key.pem")
198 197
 
199 198
    This parameter is required by authentication service.
200 199
 
201
-   Example 1.2. Set certificate_path parameter 
200
+   Example 1.2. Set certificate_path parameter
202 201
 ...
203 202
 modparam("auth_identity","certificate_path","/var/www/ssl/mycert.pem")
204 203
 ...
... ...
@@ -207,13 +206,13 @@ modparam("auth_identity","certificate_path","/var/www/ssl/mycert.pem")
207 206
 
208 207
    Note: this parameter is for authorizer service.
209 208
 
210
-   The  url  where  certificate is available for other verifier services.
211
-   (value  of  Identity-info  header)  The  certificate  should be in DER
209
+   The url where certificate is available for other verifier services.
210
+   (value of Identity-info header) The certificate should be in DER
212 211
    format.
213 212
 
214 213
    This parameter is required by authentication service.
215 214
 
216
-   Example 1.3. Set certificate_url parameter 
215
+   Example 1.3. Set certificate_url parameter
217 216
 ...
218 217
 modparam("auth_identity","certificate_url","https://foo.bar/mycert.der")
219 218
 ...
... ...
@@ -222,13 +221,13 @@ modparam("auth_identity","certificate_url","https://foo.bar/mycert.der")
222 221
 
223 222
    Note: this parameter is for authorizer service.
224 223
 
225
-   If  the  Date  header  of  message which is needed to be authenticated
226
-   contains  a  time different by more than this seconds from the current
224
+   If the Date header of message which is needed to be authenticated
225
+   contains a time different by more than this seconds from the current
227 226
    time noted by the authentication service then it rejects the message.
228 227
 
229 228
    This parameter is optional. The default value is "600".
230 229
 
231
-   Example 1.4. Set msg_timeout parameter 
230
+   Example 1.4. Set msg_timeout parameter
232 231
 ...
233 232
 modparam("auth_identity","msg_timeout",600)
234 233
 ...
... ...
@@ -237,13 +236,13 @@ modparam("auth_identity","msg_timeout",600)
237 236
 
238 237
    Note: this parameter is for verifier service.
239 238
 
240
-   The  validity  time  of  an authenticated message. The message will be
239
+   The validity time of an authenticated message. The message will be
241 240
    refused if it contains a time different by more than this seconds from
242 241
    the current time noted by the verification service.
243 242
 
244 243
    This parameter is optional. The default value is "3600".
245 244
 
246
-   Example 1.5. Set auth_validity_time parameter 
245
+   Example 1.5. Set auth_validity_time parameter
247 246
 ...
248 247
 modparam("auth_identity","auth_validity_time",3600)
249 248
 ...
... ...
@@ -252,15 +251,15 @@ modparam("auth_identity","auth_validity_time",3600)
252 251
 
253 252
    Note: this parameter is for verifier service.
254 253
 
255
-   The  number  of  Call-IDs  stored  in  order  to recognize call replay
256
-   attacks.   A  Call-ID  is  stored  auth_validity_time  long  and  uses
254
+   The number of Call-IDs stored in order to recognize call replay
255
+   attacks. A Call-ID is stored auth_validity_time long and uses
257 256
    approximately 100 bytes memory.
258 257
 
259
-   This  parameter is optional. The default value is "32768". (you should
260
-   increase  the size of shared memory with -m command line switch if you
258
+   This parameter is optional. The default value is "32768". (you should
259
+   increase the size of shared memory with -m command line switch if you
261 260
    liked to store more callid than 10000)
262 261
 
263
-   Example 1.6. Set auth_validity_time parameter 
262
+   Example 1.6. Set auth_validity_time parameter
264 263
 ...
265 264
 modparam("auth_identity","callid_cache_limit",32768)
266 265
 ...
... ...
@@ -270,12 +269,12 @@ modparam("auth_identity","callid_cache_limit",32768)
270 269
    Note: this parameter is for verifier service.
271 270
 
272 271
    The number of certificates stored in order to avoid needless download.
273
-   A   certificate   is   stored  until  its  expiration  date  and  uses
272
+   A certificate is stored until its expiration date and uses
274 273
    approximately 600 bytes memory.
275 274
 
276 275
    This parameter is optional. The default value is "4096".
277 276
 
278
-   Example 1.7. Set certificate_cache_limit parameter 
277
+   Example 1.7. Set certificate_cache_limit parameter
279 278
 ...
280 279
 modparam("auth_identity","certificate_cache_limit",4096)
281 280
 ...
... ...
@@ -284,13 +283,13 @@ modparam("auth_identity","certificate_cache_limit",4096)
284 283
 
285 284
    Note: this parameter is for verifier service.
286 285
 
287
-   A  file  of  trusted  certificates.  The  file should contain multiple
288
-   certificates  in  PEM format concatenated together. It could be useful
286
+   A file of trusted certificates. The file should contain multiple
287
+   certificates in PEM format concatenated together. It could be useful
289 288
    for verifying a certificate signed by a private CA.
290 289
 
291 290
    This parameter is optional. It has not got default value.
292 291
 
293
-   Example 1.8. Set cainfo_path parameter 
292
+   Example 1.8. Set cainfo_path parameter
294 293
 ...
295 294
 modparam("auth_identity","cainfo_path","/etc/ssl/certs/ca-certificates.crt")
296 295
 ...
... ...
@@ -303,132 +302,132 @@ modparam("auth_identity","cainfo_path","/etc/ssl/certs/ca-certificates.crt")
303 302
 
304 303
    This parameter is optional. The default value is "0".
305 304
 
306
-   Example 1.9. Set accept_pem_certs parameter 
305
+   Example 1.9. Set accept_pem_certs parameter
307 306
 ...
308 307
 modparam("auth_identity","accept_pem_certs",1)
309 308
 ...
310 309
 
311 310
 6. Functions
312 311
 
313
-   6.1. auth_date_proc() 
312
+   6.1. auth_date_proc()
314 313
 
315 314
         6.1.1. Dependencies
316 315
 
317
-   6.2. auth_add_identity() 
316
+   6.2. auth_add_identity()
318 317
 
319 318
         6.2.1. Dependencies
320 319
 
321
-   6.3. vrfy_check_date() 
320
+   6.3. vrfy_check_date()
322 321
 
323 322
         6.3.1. Dependencies
324 323
 
325
-   6.4. vrfy_get_certificate() 
324
+   6.4. vrfy_get_certificate()
326 325
 
327 326
         6.4.1. Dependencies
328 327
 
329
-   6.5. vrfy_check_certificate() 
328
+   6.5. vrfy_check_certificate()
330 329
 
331 330
         6.5.1. Dependencies
332 331
 
333
-   6.6. vrfy_check_msgvalidity() 
332
+   6.6. vrfy_check_msgvalidity()
334 333
 
335 334
         6.6.1. Dependencies
336 335
 
337
-   6.7. vrfy_check_callid() 
336
+   6.7. vrfy_check_callid()
338 337
 
339 338
         6.7.1. Dependencies
340 339
 
341
-6.1.  auth_date_proc()
340
+6.1. auth_date_proc()
342 341
 
343 342
    Note: this function is for authorizer service.
344 343
 
345
-   If  a message, the auth service should authorize, contains Date header
346
-   then  this function checks whether it falls in message timeout (set by
347
-   msg_timeout  parameter).  If  there  is  not  any Date header then the
348
-   module  adds one. This function also checks whether the certificate of
349
-   the  authentication  service  (set  by certificate_path parameter) has
350
-   been expired.
344
+   If a message, the auth service should authorize, contains Date header
345
+   then this function checks whether it falls in message timeout (set by
346
+   msg_timeout parameter). If there is not any Date header then the module
347
+   adds one. This function also checks whether the certificate of the
348
+   authentication service (set by certificate_path parameter) has been
349
+   expired.
351 350
 
352 351
 6.1.1. Dependencies
353 352
 
354 353
    No dependencies
355 354
 
356
-6.2.  auth_add_identity()
355
+6.2. auth_add_identity()
357 356
 
358 357
    Note: this function is for authorizer service.
359 358
 
360
-   Assembles  digest-string  from  the message, calculates its SHA1 hash,
359
+   Assembles digest-string from the message, calculates its SHA1 hash,
361 360
    encrypts it with the private key (set by privatekey_path parameter) of
362
-   the  authorizer  service,  base64  encodes it and adds to the outgoing
363
-   message  as  the  value  of  Identity  header. This function also adds
364
-   Identity-Info  header  which  contains  an URI (set by certificate_url
361
+   the authorizer service, base64 encodes it and adds to the outgoing
362
+   message as the value of Identity header. This function also adds
363
+   Identity-Info header which contains an URI (set by certificate_url
365 364
    parameter) from which the certificate of auth service can be acquired.
366 365
 
367
-   Note:   this   function   needs   the   final   outgoing  message  for
368
-   authorization,  so  no  module  may  modify  any digest string related
369
-   headers  (From,  To,  Call-ID,  CSeq,  Date,  Contact)  and body after
370
-   auth_add_identity()'s been called
366
+   Note: this function needs the final outgoing message for authorization,
367
+   so no module may modify any digest string related headers (From, To,
368
+   Call-ID, CSeq, Date, Contact) and body after auth_add_identity()'s been
369
+   called
371 370
 
372 371
 6.2.1. Dependencies
373 372
 
374 373
    auth_date_proc() must be called before
375 374
 
376
-6.3.  vrfy_check_date()
375
+6.3. vrfy_check_date()
377 376
 
378 377
    Note: this function is for verifier service.
379 378
 
380
-   Checks  Date  header of the incoming message whether falls in validity
379
+   Checks Date header of the incoming message whether falls in validity
381 380
    time (set by auth_validity_time parameter)
382 381
 
383 382
 6.3.1. Dependencies
384 383
 
385 384
    No dependencies
386 385
 
387
-6.4.  vrfy_get_certificate()
386
+6.4. vrfy_get_certificate()
388 387
 
389 388
    Note: this function is for verifier service.
390 389
 
391
-   Tries  to get certificate defined by the value of Identity-info header
392
-   from  certificate  table (which size is set by certificate_cache_limit
393
-   parameter).  If  the required certificate is not found there then this
390
+   Tries to get certificate defined by the value of Identity-info header
391
+   from certificate table (which size is set by certificate_cache_limit
392
+   parameter). If the required certificate is not found there then this
394 393
    function downloads it.
395 394
 
396 395
 6.4.1. Dependencies
397 396
 
398 397
    No dependencies
399 398
 
400
-6.5.  vrfy_check_certificate()
399
+6.5. vrfy_check_certificate()
401 400
 
402 401
    Note: this function is for verifier service.
403 402
 
404
-   Checks  whether  the  downloaded certificate is valid (is not expired,
405
-   its  subject  and the domain part of the URL are the same) and adds it
406
-   to certificate table.
403
+   Checks whether the downloaded certificate is valid (is not expired, its
404
+   subject and the domain part of the URL are the same) and adds it to
405
+   certificate table.
407 406
 
408 407
 6.5.1. Dependencies
409 408
 
410 409
    vrfy_get_certificate() must be called before
411 410
 
412
-6.6.  vrfy_check_msgvalidity()
411
+6.6. vrfy_check_msgvalidity()
413 412
 
414 413
    Note: this function is for verifier service.
415 414
 
416
-   Assembles  digest-string  from  the  message,  create  SHA1  hash  and
417
-   compares it with the decrypted value of Identity header.
415
+   Assembles digest-string from the message, create SHA1 hash and compares
416
+   it with the decrypted value of Identity header.
418 417
 
419 418
 6.6.1. Dependencies
420 419
 
421
-   vrfy_get_certificate()      must      be     called     before     and
420
+   vrfy_get_certificate() must be called before and
422 421
    vrfy_check_certificate() should be called before
423 422
 
424
-6.7.  vrfy_check_callid()
423
+6.7. vrfy_check_callid()
425 424
 
426 425
    Note: this function is for verifier service.
427 426
 
428
-   Checks  whether  the current call's been already processed in validity
429
-   time  (set by auth_validity_time) to recognize call replay attacks. If
427
+   Checks whether the current call's been already processed in validity
428
+   time (set by auth_validity_time) to recognize call replay attacks. If
430 429
    this call (identified by Call-id, Cseq, and tag of From header triple)
431
-   has  not been replayed then adds it to callid table (which size is set
430
+   has not been replayed then adds it to callid table (which size is set
432 431
    by callid_cache_limit parameter).
433 432
 
434 433
 6.7.1. Dependencies
... ...
@@ -1,4 +1,3 @@
1
-
2 1
 Blst Module - Blacklist Management
3 2
 
4 3
 Andrei Pelinescu-Onciul
... ...
@@ -6,7 +5,7 @@ Andrei Pelinescu-Onciul
6 5
    iptelorg GmbH
7 6
 
8 7
    Copyright � 2007 iptelorg GmbH
9
-     _________________________________________________________________
8
+     __________________________________________________________________
10 9
 
11 10
    Table of Contents
12 11
 
... ...
@@ -15,14 +14,14 @@ Andrei Pelinescu-Onciul
15 14
         1. Overview
16 15
         2. Functions
17 16
 
18
-              2.1. blst_add([timeout]) 
19
-              2.2. blst_add_retry_after(min, max) 
20
-              2.3. blst_del() 
21
-              2.4. blst_is_blacklisted() 
22
-              2.5. blst_set_ignore([flags]) 
23
-              2.6. blst_rpl_set_ignore([flags]) 
24
-              2.7. blst_clear_ignore([flags]) 
25
-              2.8. blst_rpl_clear_ignore([flags]) 
17
+              2.1. blst_add([timeout])
18
+              2.2. blst_add_retry_after(min, max)
19
+              2.3. blst_del()
20
+              2.4. blst_is_blacklisted()
21
+              2.5. blst_set_ignore([flags])
22
+              2.6. blst_rpl_set_ignore([flags])
23
+              2.7. blst_clear_ignore([flags])
24
+              2.8. blst_rpl_clear_ignore([flags])
26 25
 
27 26
    List of Examples
28 27
 
... ...
@@ -40,14 +39,14 @@ Chapter 1. Admin Guide
40 39
    1. Overview
41 40
    2. Functions
42 41
 
43
-        2.1. blst_add([timeout]) 
44
-        2.2. blst_add_retry_after(min, max) 
45
-        2.3. blst_del() 
46
-        2.4. blst_is_blacklisted() 
47
-        2.5. blst_set_ignore([flags]) 
48
-        2.6. blst_rpl_set_ignore([flags]) 
49
-        2.7. blst_clear_ignore([flags]) 
50
-        2.8. blst_rpl_clear_ignore([flags]) 
42
+        2.1. blst_add([timeout])
43
+        2.2. blst_add_retry_after(min, max)
44
+        2.3. blst_del()
45
+        2.4. blst_is_blacklisted()
46
+        2.5. blst_set_ignore([flags])
47
+        2.6. blst_rpl_set_ignore([flags])
48
+        2.7. blst_clear_ignore([flags])
49
+        2.8. blst_rpl_clear_ignore([flags])
51 50
 
52 51
 1. Overview
53 52
 
... ...
@@ -55,19 +54,19 @@ Chapter 1. Admin Guide
55 54
 
56 55
 2. Functions
57 56
 
58
-   2.1. blst_add([timeout]) 
59
-   2.2. blst_add_retry_after(min, max) 
60
-   2.3. blst_del() 
61
-   2.4. blst_is_blacklisted() 
62
-   2.5. blst_set_ignore([flags]) 
63
-   2.6. blst_rpl_set_ignore([flags]) 
64
-   2.7. blst_clear_ignore([flags]) 
65
-   2.8. blst_rpl_clear_ignore([flags]) 
57
+   2.1. blst_add([timeout])
58
+   2.2. blst_add_retry_after(min, max)
59
+   2.3. blst_del()
60
+   2.4. blst_is_blacklisted()
61
+   2.5. blst_set_ignore([flags])
62
+   2.6. blst_rpl_set_ignore([flags])
63
+   2.7. blst_clear_ignore([flags])
64
+   2.8. blst_rpl_clear_ignore([flags])
66 65
 
67
-2.1.  blst_add([timeout])
66
+2.1. blst_add([timeout])
68 67
 
69
-   Adds  the  source  of the current message to the blacklist for timeout
70
-   seconds.  If  timeout  is  missing  or 0 it uses the default blacklist
68
+   Adds the source of the current message to the blacklist for timeout
69
+   seconds. If timeout is missing or 0 it uses the default blacklist
71 70
    timeout (dst_blacklist_expire).
72 71
 
73 72
    Example 1.1. blst_add usage
... ...
@@ -78,13 +77,13 @@ else
78 77
     blst_add();  # use default blacklist timeout
79 78
 ...
80 79
 
81
-2.2.  blst_add_retry_after(min, max)
80
+2.2. blst_add_retry_after(min, max)
82 81
 
83
-   Adds  the  source of the current message to the blacklist for the time
84
-   interval  specified  in  the  Retry-After  header.  If the Retry-After
85
-   header  is  missing,  it will fail (returns false). If the Retry-After
86
-   value  is less than min, then min seconds will be used instead. If the
87
-   Retry-After  value  is greater than max, then max seconds will be used
82
+   Adds the source of the current message to the blacklist for the time
83
+   interval specified in the Retry-After header. If the Retry-After header
84
+   is missing, it will fail (returns false). If the Retry-After value is
85
+   less than min, then min seconds will be used instead. If the
86
+   Retry-After value is greater than max, then max seconds will be used
88 87
    instead.
89 88
 
90 89
    Example 1.2. blst_add_retry_after usage
... ...
@@ -96,10 +95,10 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
96 95
 }
97 96
 ...
98 97
 
99
-2.3.  blst_del()
98
+2.3. blst_del()
100 99
 
101
-   Removes  the  source of the current message from the blacklist. If the
102
-   address  is  not  present  in the blacklist at the time of the call it
100
+   Removes the source of the current message from the blacklist. If the
101
+   address is not present in the blacklist at the time of the call it
103 102
    returns false.
104 103
 
105 104
    Example 1.3. blst_del usage
... ...
@@ -107,7 +106,7 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
107 106
     blst_del();
108 107
 ...
109 108
 
110
-2.4.  blst_is_blacklisted()
109
+2.4. blst_is_blacklisted()
111 110
 
112 111
    Returns true if the source of the current message is blacklisted.
113 112
 
... ...
@@ -119,26 +118,26 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
119 118
    }
120 119
 ...
121 120
 
122
-2.5.  blst_set_ignore([flags])
121
+2.5. blst_set_ignore([flags])
123 122
 
124
-   Set  errors  that will not be taken into account when deciding whether
125
-   to blacklist a destination for the current message or a local reply to
126
-   the current message.
123
+   Set errors that will not be taken into account when deciding whether to
124
+   blacklist a destination for the current message or a local reply to the
125
+   current message.
127 126
 
128
-   blst_set_ignore(..)  works  for  forwarding  the  current  message and
129
-   blst_rpl_set_ignore(...)  works  for  local  replies  to  the  current
127
+   blst_set_ignore(..) works for forwarding the current message and
128
+   blst_rpl_set_ignore(...) works for local replies to the current
130 129
    message.
131 130
 
132
-   The  variants  of  these  functions  with  no  parameters  will ignore
131
+   The variants of these functions with no parameters will ignore
133 132
    everything (equivalent to passing 0xff).
134 133
 
135
-   The  flags  are  stored  internally  as  a bitmask, and are applied by
134
+   The flags are stored internally as a bitmask, and are applied by
136 135
    bitwise ANDing them together. The following flags are available:
137 136
      * 0x02 - generic send error (send denied/ failed).
138 137
      * 0x04 - connect failed (TCP, TLS or SCTP).
139 138
      * 0x08 - ICMP error (not currently used).
140 139
      * 0x10 - SIP transaction timeout.
141
-     * 0x20  -  503  reply  (statefull  mode  only). For more details see
140
+     * 0x20 - 503 reply (statefull mode only). For more details see
142 141
        tmblst_503.
143 142
 
144 143
 Note
... ...
@@ -150,13 +149,13 @@ Note
150 149
    Example 1.5. blst_set_ignore usage
151 150
     blst_set_ignore(6); # ignore send and connect errors
152 151
 
153
-2.6.  blst_rpl_set_ignore([flags])
152
+2.6. blst_rpl_set_ignore([flags])
154 153
 
155 154
    See function blst_set_ignore([flags]).
156 155
 
157
-2.7.  blst_clear_ignore([flags])
156
+2.7. blst_clear_ignore([flags])
158 157
 
159
-   Clears  blacklist  ignore  flags  previously  set by the corresponding
158
+   Clears blacklist ignore flags previously set by the corresponding
160 159
    blst_set_ignore(...) or blst_rpl_set_ignore(...) functions.
161 160
 
162 161
    See also blst_set_ignore.
... ...
@@ -164,6 +163,6 @@ Note
164 163
    Example 1.6. blst_clear_ignore usage
165 164
     blst_clear_ignore(4); # ignore connect errors
166 165
 
167
-2.8.  blst_rpl_clear_ignore([flags])
166
+2.8. blst_rpl_clear_ignore([flags])
168 167
 
169 168
    See function blst_clear_ignore([flags]).
... ...
@@ -1,4 +1,3 @@
1
-
2 1
 Counters Module
3 2
 
4 3
 Andrei Pelinescu-Onciul
... ...
@@ -6,7 +5,7 @@ Andrei Pelinescu-Onciul
6 5
    iptelorg GmbH
7 6
 
8 7
    Copyright � 2010 iptelorg GmbH
9
-     _________________________________________________________________
8
+     __________________________________________________________________
10 9
 
11 10
    Table of Contents
12 11
 
... ...
@@ -20,9 +19,9 @@ Andrei Pelinescu-Onciul
20 19
 
21 20
         3. Functions
22 21
 
23
-              3.1. cnt_inc([group.]name) 
24
-              3.2. cnt_add([group.]name, number) 
25
-              3.3. cnt_reset([group.]name) 
22
+              3.1. cnt_inc([group.]name)
23
+              3.2. cnt_add([group.]name, number)
24
+              3.3. cnt_reset([group.]name)
26 25
 
27 26
         4. counters RPC Functions
28 27
 
... ...
@@ -35,8 +34,8 @@ Andrei Pelinescu-Onciul
35 34
 
36 35
    List of Examples
37 36
 
38
-   1.1. Create a new script_counter 
39
-   1.2. Set script_cnt_grp_name in the config file 
37
+   1.1. Create a new script_counter
38
+   1.2. Set script_cnt_grp_name in the config file
40 39
    1.3. cnt_inc usage
41 40
    1.4. cnt_add usage
42 41
    1.5. cnt_reset usage
... ...
@@ -59,9 +58,9 @@ Chapter 1. Admin Guide
59 58
 
60 59
    3. Functions
61 60
 
62
-        3.1. cnt_inc([group.]name) 
63
-        3.2. cnt_add([group.]name, number) 
64
-        3.3. cnt_reset([group.]name) 
61
+        3.1. cnt_inc([group.]name)
62
+        3.2. cnt_add([group.]name, number)
63
+        3.3. cnt_reset([group.]name)
65 64
 
66 65
    4. counters RPC Functions
67 66
 
... ...
@@ -74,7 +73,7 @@ Chapter 1. Admin Guide
74 73
 
75 74
 1. Overview
76 75
 
77
-   This  module exports counters/statistics manipulating script functions
76
+   This module exports counters/statistics manipulating script functions
78 77
    and RPCs.
79 78
 
80 79
 2. Parameters
... ...
@@ -85,15 +84,15 @@ Chapter 1. Admin Guide
85 84
 2.1. script_counter
86 85
 
87 86
    Define a new counter that can be used from the script. The declaration
88
-   might  include  a  group  in front of the counter name, separated with
89
-   '.'.  It  might  also  include  a  counter  description  string  (help
90
-   message),  separated  from the name with a ' ' or ':'. If the group is
91
-   missing, the group defined in the script_cnt_grp_name module parameter
92
-   will be used (the default is "script"). If the description is missing,
93
-   the  default is "custom script counter". The format of the declaration
94
-   is: [group.]name[( |:)description].
95
-
96
-   Example 1.1.  Create a new script_counter 
87
+   might include a group in front of the counter name, separated with '.'.
88
+   It might also include a counter description string (help message),
89
+   separated from the name with a ' ' or ':'. If the group is missing, the
90
+   group defined in the script_cnt_grp_name module parameter will be used
91
+   (the default is "script"). If the description is missing, the default
92
+   is "custom script counter". The format of the declaration is:
93
+   [group.]name[( |:)description].
94
+
95
+   Example 1.1. Create a new script_counter
97 96
 modparam("counters", "script_counter", "foo")  # script.foo
98 97
 modparam("counters", "script_counter", "test.bar")  # test.bar
99 98
 modparam("counters", "script_counter", "baz example counter")  # script.baz
... ...
@@ -101,23 +100,23 @@ modparam("counters", "script_counter", "test.x:another example") # test.x
101 100
 
102 101
 2.2. script_cnt_grp_name
103 102
 
104
-   Group  name  that  will  be  used  for  the  counters  defined via the
103
+   Group name that will be used for the counters defined via the
105 104
    script_counter module parameter which do not have a specified group.
106 105
 
107 106
    Default: "script".
108 107
 
109
-   Example 1.2.  Set script_cnt_grp_name in the config file 
108
+   Example 1.2. Set script_cnt_grp_name in the config file
110 109
 modparam("counters", "script_cnt_grp_name", "my_counters")
111 110
 
112 111
 3. Functions
113 112
 
114
-   3.1. cnt_inc([group.]name) 
115
-   3.2. cnt_add([group.]name, number) 
116
-   3.3. cnt_reset([group.]name) 
113
+   3.1. cnt_inc([group.]name)
114
+   3.2. cnt_add([group.]name, number)
115
+   3.3. cnt_reset([group.]name)
117 116
 
118
-3.1.  cnt_inc([group.]name)
117
+3.1. cnt_inc([group.]name)
119 118
 
120
-   Increments  the  counter group.name. The counter must be defined using
119
+   Increments the counter group.name. The counter must be defined using
121 120
    the script_counter module parameter. If the group name is missing, the
122 121
    group specified by the script_cnt_grp_name modparam will be used.
123 122
 
... ...
@@ -133,9 +132,9 @@ route {
133 132
 ...
134 133
 }
135 134
 
136
-3.2.  cnt_add([group.]name, number)
135
+3.2. cnt_add([group.]name, number)
137 136
 
138
-   Adds  number the counter group.name. The counter must be defined using
137
+   Adds number the counter group.name. The counter must be defined using
139 138
    the script_counter module parameter. If the group name is missing, the
140 139
    group specified by the script_cnt_grp_name modparam will be used.
141 140
 
... ...
@@ -148,10 +147,10 @@ route {
148 147
 ...
149 148
 }
150 149
 
151
-3.3.  cnt_reset([group.]name)
150
+3.3. cnt_reset([group.]name)
152 151
 
153
-   Resets  the  counter group.name. The counter must be defined using the
154
-   script_counter  module  parameter.  If  the group name is missing, the
152
+   Resets the counter group.name. The counter must be defined using the
153
+   script_counter module parameter. If the group name is missing, the
155 154
    group specified by the script_cnt_grp_name modparam will be used.
156 155
 
157 156
    Example 1.5. cnt_reset usage
... ...
@@ -196,7 +195,7 @@ route {
196 195
 
197 196
 4.4.  cnt.var_list group
198 197
 
199
-   Lists  all  the  names  of all the counters belonging to the specified
198
+   Lists all the names of all the counters belonging to the specified
200 199
    group.
201 200
 
202 201
    Example 1.9. cnt.var_list group usage
... ...
@@ -1,4 +1,3 @@
1
-
2 1
 db2_ldap module
3 2
 
4 3
 Jan Janak
... ...
@@ -6,7 +5,7 @@ Jan Janak
6 5
    Iptel.org
7 6
 
8 7
    Copyright � 2008 Iptel.org GmBH
9
-     _________________________________________________________________
8
+     __________________________________________________________________
10 9
 
11 10
    Table of Contents
12 11
 
... ...
@@ -43,56 +42,56 @@ Chapter 1. Admin Guide
43 42
 
44 43
 1. Overview
45 44
 
46
-   The  LDAP  module  is  database  driver,  i.e.  it implements DBv2 API
47
-   functions.  The  goal is map database query defined by table, matching
48
-   fields  and  result fields to LDAP search in sub-tree defined by root,
49
-   object   class,   attributes   and  pass  it  to  the  OpenLDAP  which
50
-   communicates with the LDAP server.
45
+   The LDAP module is database driver, i.e. it implements DBv2 API
46
+   functions. The goal is map database query defined by table, matching
47
+   fields and result fields to LDAP search in sub-tree defined by root,
48
+   object class, attributes and pass it to the OpenLDAP which communicates
49
+   with the LDAP server.
51 50
 
52
-   This  procedure  is sometimes tricky because the LDAP does not support
53
-   all  database  features  or supports them in different manner. Here we
51
+   This procedure is sometimes tricky because the LDAP does not support
52
+   all database features or supports them in different manner. Here we
54 53
    must express especially filtering and multi-values. The multi-value is
55
-   de  facto array of single values. If the LDAP module get a multi-value
56
-   field  then  generates record for every single value, respectively for
54
+   de facto array of single values. If the LDAP module get a multi-value
55
+   field then generates record for every single value, respectively for
57 56
    every combination in case the more fields contain multi-value.
58 57
 
59
-   The  LDAP  supports  natively "AND", "OR", "NOT" logical operators and
60
-   "equal",    "non-equal",    "less-or-equal"   and   "greater-or-equal"
61
-   comparison  operators.  Therefore  "less"  and "greater" operators are
62
-   mapped   as   "less/greater-or-equal-AND-not-equal".   It's  important
63
-   realize  it  when  the  attribute which will be used for filtering may
64
-   contain  multi-value. The LDAP server evaluates comparison operator on
65
-   multi-value  so that the result for record is true if the condition is
66
-   satisfied  for  any  single  value.  The  single values not satisfying
67
-   condition  are  not  truncated.  It  implies  two  cases  for positive
68
-   comparison,  e.g.  "equal",  the result contains values not satisfying
69
-   the  condition,  the  case  may be handled by additional filter in the
70
-   LDAP  module,  the  negative  comparison,  e.g.  "non-equal", does not
71
-   return  record at all. Because the LDAP module cannot know if the LDAP
72
-   attribute  may logically contain multi-value so there is introduced DB
73
-   API option client_side_filtering which forces filtering such fields in
74
-   the  LDAP  module,  i.e.  the  LDAP  server  returns larger result set
75
-   because the filtering condition is not passed there.
76
-
77
-   The  syntax of client_side_filtering value is comma delimited of field
78
-   names  which  won't  be  used  for  server-side filter if such a field
79
-   appears  in a match condition. Instead records will be filtered out in
58
+   The LDAP supports natively "AND", "OR", "NOT" logical operators and
59
+   "equal", "non-equal", "less-or-equal" and "greater-or-equal" comparison
60
+   operators. Therefore "less" and "greater" operators are mapped as
61
+   "less/greater-or-equal-AND-not-equal". It's important realize it when
62
+   the attribute which will be used for filtering may contain multi-value.
63
+   The LDAP server evaluates comparison operator on multi-value so that
64
+   the result for record is true if the condition is satisfied for any
65
+   single value. The single values not satisfying condition are not
66
+   truncated. It implies two cases for positive comparison, e.g. "equal",
67
+   the result contains values not satisfying the condition, the case may
68
+   be handled by additional filter in the LDAP module, the negative
69
+   comparison, e.g. "non-equal", does not return record at all. Because
70
+   the LDAP module cannot know if the LDAP attribute may logically contain
71
+   multi-value so there is introduced DB API option client_side_filtering
72
+   which forces filtering such fields in the LDAP module, i.e. the LDAP
73
+   server returns larger result set because the filtering condition is not
74
+   passed there.
75
+
76
+   The syntax of client_side_filtering value is comma delimited of field
77
+   names which won't be used for server-side filter if such a field
78
+   appears in a match condition. Instead records will be filtered out in
80 79
    module. It implies such fields MUST exist in result field list.
81 80
 
82
-   The   necessary   condition  of  successful  filtering  of  particular
83
-   attribute  at  the  LDAP  server  is correct attribute definition. The
84
-   "equal"/"non-equal"  operator  requires  equality  matching  rule, the
81
+   The necessary condition of successful filtering of particular attribute
82
+   at the LDAP server is correct attribute definition. The
83
+   "equal"/"non-equal" operator requires equality matching rule, the
85 84
    "greater"/"less" operator requires ordering matching rule. If required
86 85
    matching rule is missing the LDAP server silently returns empty result
87
-   set.  In case of double filtering both at the LDAP servar and the LDAP
88
-   module,  e.g.  multi-value and equal comparison, check the LDAP server
89
-   matching  rule  satisfies  your  needs  or  use  client_side_filtering
86
+   set. In case of double filtering both at the LDAP servar and the LDAP
87
+   module, e.g. multi-value and equal comparison, check the LDAP server
88
+   matching rule satisfies your needs or use client_side_filtering
90 89
    feature.
91 90
 
92
-   The  LDAP  server  may  be identified either complete specification of
93
-   host,   user,  password  in  URI  or  is  specification  reference  to
94
-   connection  section  of  config file. Note in the second case there is
95
-   only one slash.
91
+   The LDAP server may be identified either complete specification of
92
+   host, user, password in URI or is specification reference to connection
93
+   section of config file. Note in the second case there is only one
94
+   slash.
96 95
 
97 96
    Example 1.1. URI example
98 97
         ...
... ...
@@ -122,10 +121,10 @@ Chapter 1. Admin Guide
122 121
 
123 122
    Default value is ldap.cfg.
124 123
 
125
-   The  filename  (relatively  to ser config file) of mapping database to
124
+   The filename (relatively to ser config file) of mapping database to
126 125
    LDAP definition. It is the main configuration file for the LDAP module
127
-   in  SER.  The configuration file maps database table names used in SER
128
-   to  LDAP  directory  sub-trees to be searched. In addition to that the
126
+   in SER. The configuration file maps database table names used in SER to
127
+   LDAP directory sub-trees to be searched. In addition to that the
129 128
    configuration file also allows to configure the LDAP search filter and
130 129
    maps database field names to LDAP attribute names and vice versa.
131 130
 
... ...
@@ -244,7 +243,7 @@ field_map = flags : (BitString) serFlags
244 243
 
245 244
    Default value is 3.
246 245
 
247
-   Number  of  reconnect  attempts  when connection to the LDAP server is
246
+   Number of reconnect attempts when connection to the LDAP server is
248 247
    lost.
249 248
 
250 249
    Example 1.4. Example reconnect_attempt
... ...
@@ -1,4 +1,3 @@
1
-
2 1
 db2_ops module
3 2
 
4 3
 Tomas Mandys
... ...
@@ -6,7 +5,7 @@ Tomas Mandys
6 5
    Iptel.org
7 6
 
8 7
    Copyright � 2007 Tomas Mandys
9
-     _________________________________________________________________
8
+     __________________________________________________________________
10 9
 
11 10
    Table of Contents
12 11
 
... ...
@@ -23,21 +22,21 @@ Tomas Mandys
23 22
 
24 23
         5. Functions
25 24
 
26
-              5.1. db_query(query | query_id [,handle] ) 
27
-              5.2. db_close(handle) 
28
-              5.3. db_first(handle) 
29
-              5.4. db_next(handle) 
30
-              5.5. db_seek(handle, row_no) 
31
-              5.6. db_foreach(handle, route) 
32
-              5.7. db_proper() 
33
-              5.8. @db.query.query_id 
34
-              5.9. @db.query.query_id.count 
35
-              5.10. @db.query.query_id.is_empty 
36
-              5.11. @db.query.query_id.field[m] 
37
-              5.12. @db.query.query_id.row[n] 
38
-              5.13. @db.query.query_id.row[n].field[m] 
39
-              5.14. @db.fetch.handle 
40
-              5.15. @db.fetch.handle.row_no 
25
+              5.1. db_query(query | query_id [,handle] )
26
+              5.2. db_close(handle)
27
+              5.3. db_first(handle)
28
+              5.4. db_next(handle)
29
+              5.5. db_seek(handle, row_no)
30
+              5.6. db_foreach(handle, route)
31
+              5.7. db_proper()
32
+              5.8. @db.query.query_id
33
+              5.9. @db.query.query_id.count
34
+              5.10. @db.query.query_id.is_empty
35
+              5.11. @db.query.query_id.field[m]
36
+              5.12. @db.query.query_id.row[n]
37
+              5.13. @db.query.query_id.row[n].field[m]
38
+              5.14. @db.fetch.handle
39
+              5.15. @db.fetch.handle.row_no
41 40
 
42 41
         6. Examples
43 42
 
... ...
@@ -78,21 +77,21 @@ Chapter 1. Admin Guide
78 77
 
79 78
    5. Functions
80 79
 
81
-        5.1. db_query(query | query_id [,handle] ) 
82
-        5.2. db_close(handle) 
83
-        5.3. db_first(handle) 
84
-        5.4. db_next(handle) 
85
-        5.5. db_seek(handle, row_no) 
86
-        5.6. db_foreach(handle, route) 
87
-        5.7. db_proper() 
88
-        5.8. @db.query.query_id 
89
-        5.9. @db.query.query_id.count 
90
-        5.10. @db.query.query_id.is_empty 
91
-        5.11. @db.query.query_id.field[m] 
92
-        5.12. @db.query.query_id.row[n] 
93
-        5.13. @db.query.query_id.row[n].field[m] 
94
-        5.14. @db.fetch.handle 
95
-        5.15. @db.fetch.handle.row_no 
80
+        5.1. db_query(query | query_id [,handle] )
81
+        5.2. db_close(handle)
82
+        5.3. db_first(handle)
83
+        5.4. db_next(handle)
84
+        5.5. db_seek(handle, row_no)
85
+        5.6. db_foreach(handle, route)
86
+        5.7. db_proper()
87
+        5.8. @db.query.query_id
88
+        5.9. @db.query.query_id.count
89
+        5.10. @db.query.query_id.is_empty
90
+        5.11. @db.query.query_id.field[m]
91
+        5.12. @db.query.query_id.row[n]
92
+        5.13. @db.query.query_id.row[n].field[m]
93
+        5.14. @db.fetch.handle
94
+        5.15. @db.fetch.handle.row_no
96 95
 
97 96
    6. Examples
98 97
 
... ...
@@ -114,26 +113,26 @@ Chapter 1. Admin Guide
114 113
         where = fields
115 114
         ops = op [ "," op ... ]
116 115
         order = field
117
-        type = "s" | "i" | "d" | "f" | "t" ; enables to force particular type w
118
-hen writing to db driver (string/int/double/float/datetime), valueable especial
119
-ly for datetime
116
+        type = "s" | "i" | "d" | "f" | "t" ; enables to force particular type wh
117
+en writing to db driver (string/int/double/float/datetime), valueable especially
118
+ for datetime
120 119
         value = [type ":"] xltext
121 120
         values = value [ "," value ...]
122 121
         extra_op = name "=" [type ":"] text
123 122
         extra_ops = extra_op [ "," extra_op]
124 123
 
125
-        select = [database "/"] "select/" table "/" fields "/" where "/" ops "/
126
-" order "/" values [ "/" extra_ops ]
127
-        insert = [database "/"] "insert/" table "/" fields "/" values [ "/" ext
128
-ra_ops ]
129
-        update = [database "/"] "update/" table "/" fields "/" where "/" ops "/
130
-" values [ "/" extra_ops ]
131
-        replace = [database "/"] "replace/" table "/" fields "/" values [ "/" e
132
-xtra_ops ]
133
-        delete = [database "/"] "delete/" table "/" where "/" ops "/" values [
134
-"/" extra_ops ]
124
+        select = [database "/"] "select/" table "/" fields "/" where "/" ops "/"
125
+ order "/" values [ "/" extra_ops ]
126
+        insert = [database "/"] "insert/" table "/" fields "/" values [ "/" extr
127
+a_ops ]
128
+        update = [database "/"] "update/" table "/" fields "/" where "/" ops "/"
129
+ values [ "/" extra_ops ]
130
+        replace = [database "/"] "replace/" table "/" fields "/" values [ "/" ex
131
+tra_ops ]
132
+        delete = [database "/"] "delete/" table "/" where "/" ops "/" values [ "
133
+/" extra_ops ]
135 134
         raw_query = [database "/"] "select ...." | "insert ..." [[ / "values" [
136
- "/" extra_ops ]]  # not delimited by "/"
135
+"/" extra_ops ]]  # not delimited by "/"
137 136
         query = (select | insert | update | replace | delete | raw_query)
138 137
         query_id = alphanum
139 138
         handle = alphanum  (plain text possible but alphanum recommended)
... ...
@@ -161,7 +160,7 @@ xtra_ops ]
161 160
 4.2. declare_query (string)
162 161
 
163 162
    Declare query_id for @db.query_id (see select syntax) or for reference
164
-   from  db_query(query_id).  Queries are pre-compiled therefore volatile
163
+   from db_query(query_id). Queries are pre-compiled therefore volatile
165 164
    stuff must be passed via parameters (AVP or so).
166 165
 
167 166
    The format is:
... ...
@@ -169,8 +168,8 @@ xtra_ops ]
169 168
 
170 169
    Example 1.2. Example declare_query
171 170
         ...
172
-        modparam("db_ops", "declare_query", "sel1=select/location/received/uid/
173
-//%$f.uid");
171
+        modparam("db_ops", "declare_query", "sel1=select/location/received/uid//
172
+/%$f.uid");
174 173
         ...
175 174
 
176 175
 4.3. declare_handle (string)
... ...
@@ -187,27 +186,27 @@ xtra_ops ]
187 186
 
188 187
 5. Functions
189 188
 
190
-   5.1. db_query(query | query_id [,handle] ) 
191
-   5.2. db_close(handle) 
192
-   5.3. db_first(handle) 
193
-   5.4. db_next(handle) 
194
-   5.5. db_seek(handle, row_no) 
195
-   5.6. db_foreach(handle, route) 
196
-   5.7. db_proper() 
197
-   5.8. @db.query.query_id 
198
-   5.9. @db.query.query_id.count 
199
-   5.10. @db.query.query_id.is_empty 
200
-   5.11. @db.query.query_id.field[m] 
201
-   5.12. @db.query.query_id.row[n] 
202
-   5.13. @db.query.query_id.row[n].field[m] 
203
-   5.14. @db.fetch.handle 
204
-   5.15. @db.fetch.handle.row_no 
205
-
206
-5.1.  db_query(query | query_id [,handle] )
207
-
208
-   Executes  query and in case of SELECT returns result via handle, seeks
189
+   5.1. db_query(query | query_id [,handle] )
190
+   5.2. db_close(handle)
191
+   5.3. db_first(handle)
192
+   5.4. db_next(handle)
193
+   5.5. db_seek(handle, row_no)
194
+   5.6. db_foreach(handle, route)
195
+   5.7. db_proper()
196
+   5.8. @db.query.query_id
197
+   5.9. @db.query.query_id.count
198
+   5.10. @db.query.query_id.is_empty
199
+   5.11. @db.query.query_id.field[m]
200
+   5.12. @db.query.query_id.row[n]
201
+   5.13. @db.query.query_id.row[n].field[m]
202
+   5.14. @db.fetch.handle
203
+   5.15. @db.fetch.handle.row_no
204
+
205
+5.1. db_query(query | query_id [,handle] )
206
+
207
+   Executes query and in case of SELECT returns result via handle, seeks
209 208
    the first record and returns TRUE if table is not empty. The result is
210
-   accesible  using  @db.fetch  select. See also declare_handle. Query_id
209
+   accesible using @db.fetch select. See also declare_handle. Query_id
211 210
    references to query declared using declare_query, handle references to
212 211
    query declared using declare_handle.
213 212
 
... ...
@@ -222,9 +221,9 @@ xtra_ops ]
222 221
 
223 222
         }
224 223
 
225
-5.2.  db_close(handle)
224
+5.2. db_close(handle)
226 225
 
227
-   Close  table that has been opened using db_query. Note all close after
226
+   Close table that has been opened using db_query. Note all close after
228 227
    script processing automatically.
229 228
 
230 229
    Example 1.5. db_close usage
... ...
@@ -232,9 +231,9 @@ xtra_ops ]
232 231
         db_close(my_handle);
233 232
         ...
234 233
 
235
-5.3.  db_first(handle)
234
+5.3. db_first(handle)
236 235
 
237
-   Returns  TRUE  if  table  is  not empty. Note that rewind might not be
236
+   Returns TRUE if table is not empty. Note that rewind might not be
238 237
    supported by particular db driver.
239 238
 
240 239
    Example 1.6. db_first usage
... ...
@@ -244,7 +243,7 @@ xtra_ops ]
244 243
         }
245 244
         ...
246 245
 
247
-5.4.  db_next(handle)
246
+5.4. db_next(handle)
248 247
 
249 248
    Moves to the next record and returns TRUE if not EOF.
250 249
 
... ...
@@ -255,9 +254,9 @@ xtra_ops ]
255 254
         }
256 255
         ...
257 256
 
258
-5.5.  db_seek(handle, row_no)
257
+5.5. db_seek(handle, row_no)
259 258
 
260
-   Seeks  at  the  row  no  (origin  is zero) and Returns TRUE in case of
259
+   Seeks at the row no (origin is zero) and Returns TRUE in case of
261 260
    success. Backward seek might not be supported by db driver.
262 261
 
263 262
    Example 1.8. db_seek usage
... ...
@@ -267,7 +266,7 @@ xtra_ops ]
267 266
         }
268 267
         ...
269 268
 
270
-5.6.  db_foreach(handle, route)
269
+5.6. db_foreach(handle, route)
271 270
 
272 271
    Call specific route for each row, loop is interrupted if route returns
273 272
    code <= 0. Return code of the last route call is returned as result of
... ...
@@ -284,9 +283,9 @@ xtra_ops ]
284 283
         }
285