Browse code

- change module docs FAQ link to a common one in the doc dir - remove module specific FAQ content from the file in doc, this way no FAQ content will be created - credits for the patch/ the change scripts goes to Edson Gellert Schubert, 4lists at gmail dot com - update all READMEs, for most module docs the FAQ and devel information were now removed

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@3839 689a6050-402a-0410-94f2-e92a70836424

Henning Westerholt authored on 04/03/2008 13:15:47
Showing 263 changed files
... ...
@@ -1,4 +1,3 @@
1
-
2 1
 Acc Module
3 2
 
4 3
 Jiri Kuthan
... ...
@@ -20,7 +19,7 @@ Bogdan-Andrei Iancu
20 19
    Copyright � 2002, 2003 FhG FOKUS
21 20
 
22 21
    Copyright � 2004, 2006 voice-system.ro
23
-     _________________________________________________________
22
+     __________________________________________________________
24 23
 
25 24
    Table of Contents
26 25
    1. User's Guide
... ...
@@ -90,8 +89,7 @@ Bogdan-Andrei Iancu
90 89
               1.6.3. acc_rad_request(comment)
91 90
               1.6.4. acc_diam_request(comment)
92 91
 
93
-   2. Developer's Guide
94
-   3. Frequently Asked Questions
92
+   2. Frequently Asked Questions
95 93
 
96 94
    List of Examples
97 95
    1-1. early_media example
... ...
@@ -132,7 +130,7 @@ Bogdan-Andrei Iancu
132 130
    1-36. acc_db_request usage
133 131
    1-37. acc_rad_request usage
134 132
    1-38. acc_diam_request usage
135
-     _________________________________________________________
133
+     __________________________________________________________
136 134
 
137 135
 Chapter 1. User's Guide
138 136
 
... ...
@@ -142,22 +140,22 @@ Chapter 1. User's Guide
142 140
    different backends like syslog, SQL, RADIUS and DIAMETER (beta
143 141
    version).
144 142
 
145
-   To account a transaction and to choose which set of backends
146
-   to be used, the script writer just has to set some flags (see
147
-   the module parameters section for flag definitions Section
148
-   1.5). If the accouting flag for a specific backend is set, the
149
-   acc module will then report on completed transaction. A
150
-   typical usage of the module takes no acc-specific script
151
-   command -- the functionality binds invisibly through
152
-   transaction processing. Script writers just need to mark the
153
-   transaction for accounting with proper setflag. Even so, the
154
-   module allows the script writter to force accouting in special
155
-   cases via some script functions.
143
+   To account a transaction and to choose which set of backends to
144
+   be used, the script writer just has to set some flags (see the
145
+   module parameters section for flag definitions Section 1.5). If
146
+   the accouting flag for a specific backend is set, the acc
147
+   module will then report on completed transaction. A typical
148
+   usage of the module takes no acc-specific script command -- the
149
+   functionality binds invisibly through transaction processing.
150
+   Script writers just need to mark the transaction for accounting
151
+   with proper setflag. Even so, the module allows the script
152
+   writter to force accouting in special cases via some script
153
+   functions.
156 154
 
157 155
    The accouting module will log by default a fixed set of
158
-   attributes for the transaction - if you customize you
159
-   accouting by adding more information to be logged, please see
160
-   the next chapter about extra accouting - Section 1.2.
156
+   attributes for the transaction - if you customize you accouting
157
+   by adding more information to be logged, please see the next
158
+   chapter about extra accouting - Section 1.2.
161 159
 
162 160
    The fixed minimal accouting information is:
163 161
 
... ...
@@ -184,11 +182,11 @@ Chapter 1. User's Guide
184 182
        with BYEs for generating proper CDRs for example for
185 183
        purpose of billing, then it is better done in the entity
186 184
        which collects accounting information.
187
-     * If a UA fails in middle of conversation, a proxy will
188
-       never learn it. In general, a better practice is to
189
-       account from an end-device (such as PSTN gateway), which
190
-       best knows about call status (including media status and
191
-       PSTN status in case of the gateway).
185
+     * If a UA fails in middle of conversation, a proxy will never
186
+       learn it. In general, a better practice is to account from
187
+       an end-device (such as PSTN gateway), which best knows
188
+       about call status (including media status and PSTN status
189
+       in case of the gateway).
192 190
 
193 191
    The SQL backend support is compiled in the moduls. For RADIUS
194 192
    and DIAMETER you need to enable it by recompiling the module
... ...
@@ -200,20 +198,20 @@ Chapter 1. User's Guide
200 198
    radius client needs to be configured properly. To do so, use
201 199
    the template at etc/radiusclient.conf and make sure that
202 200
    module's radius_config parameter points to its location. In
203
-   particular, accounting secret must match that one configured
204
-   in server and proper dictionary is used (one is available at
201
+   particular, accounting secret must match that one configured in
202
+   server and proper dictionary is used (one is available at
205 203
    etc/sip_dictionary). Uses along with FreeRadius (
206 204
    http://www.freeradius.org/) and Radiator (
207
-   http://www.open.com.au/radiator/) servers have been reported
208
-   to us.
205
+   http://www.open.com.au/radiator/) servers have been reported to
206
+   us.
209 207
 
210 208
    NOTE: diameter support was developed for DISC (DIameter Server
211 209
    Client project at http://developer.berlios.de/projects/disc/).
212 210
    This project seems to be no longer maintained and DIAMETER
213
-   specifications were updated in the meantime. Thus, the
214
-   DIAMETER part in the module is obsolete and needs rework to be
215
-   usable with opendiameter or other DIAMETER servers.
216
-     _________________________________________________________
211
+   specifications were updated in the meantime. Thus, the DIAMETER
212
+   part in the module is obsolete and needs rework to be usable
213
+   with opendiameter or other DIAMETER servers.
214
+     __________________________________________________________
217 215
 
218 216
 1.1.1. General Example
219 217
 
... ...
@@ -224,8 +222,8 @@ modparam("acc", "log_flag", 1)
224 222
 if (uri=~"sip:+40") /* calls to Romania */ {
225 223
     if (!proxy_authorize("sip_domain.net" /* realm */,
226 224
     "subscriber" /* table name */))  {
227
-        proxy_challenge("sip_domain.net" /* realm */, "0" /* no qop */
228
-);
225
+        proxy_challenge("sip_domain.net" /* realm */, "0" /* no qop */ )
226
+;
229 227
         exit;
230 228
     }
231 229
 
... ...
@@ -237,7 +235,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
237 235
     setflag(1); /* set for accounting (the same value as in log_flag!)
238 236
     t_relay();  /* enter stateful mode now */
239 237
 };
240
-     _________________________________________________________
238
+     __________________________________________________________
241 239
 
242 240
 1.2. Extra accounting
243 241
 
... ...
@@ -247,19 +245,18 @@ if (uri=~"sip:+40") /* calls to Romania */ {
247 245
    dynamical selection of extra information to be logged. This
248 246
    allows you to log any pseudo-variable (AVPs, parts of the
249 247
    request, etc).
250
-     _________________________________________________________
248
+     __________________________________________________________
251 249
 
252 250
 1.2.2. Definitions and syntax
253 251
 
254
-   Selection of extra information is done via xxx_extra
255
-   parameters by specifying the names of additional information
256
-   you want to log. This information is defined via
257
-   pseudo-variables and may include headers or AVPs values or
258
-   other message or system values. The syntax of the parameter
259
-   is: 
252
+   Selection of extra information is done via xxx_extra parameters
253
+   by specifying the names of additional information you want to
254
+   log. This information is defined via pseudo-variables and may
255
+   include headers or AVPs values or other message or system
256
+   values. The syntax of the parameter is:
260 257
 
261
-     * xxx_extra = extra_definition (';'extra_definition)* 
262
-     * extra_definition = log_name '=' pseudo_variable 
258
+     * xxx_extra = extra_definition (';'extra_definition)*
259
+     * extra_definition = log_name '=' pseudo_variable
263 260
 
264 261
    The full list of supported pseudo-variables in OpenSER is
265 262
    availabe at:
... ...
@@ -272,24 +269,23 @@ if (uri=~"sip:+40") /* calls to Romania */ {
272 269
        the data in log_name=data format;
273 270
      * DB accounting - log_name will be the name of the DB column
274 271
        where the data will be stored.IMPORTANT: add in db acc
275
-       table the columns corresponding to each extra data; 
272
+       table the columns corresponding to each extra data;
276 273
      * RADIUS accounting - log_name will be the AVP name used for
277 274
        packing the data into RADIUS message. The log_name will be
278
-       translated to AVP number via the dictionary. IMPORTANT:
279
-       add in RADIUS dictionary the log_name attribute. 
275
+       translated to AVP number via the dictionary. IMPORTANT: add
276
+       in RADIUS dictionary the log_name attribute.
280 277
      * DIAMETER accounting - log_name will be the AVP code used
281
-       for packing the data into DIAMETER message. The AVP code
282
-       is given directly as integer, since DIAMETER has no
283
-       dictionary support yet. IMPORTANT: log_name must be a
284
-       number.
285
-     _________________________________________________________
278
+       for packing the data into DIAMETER message. The AVP code is
279
+       given directly as integer, since DIAMETER has no dictionary
280
+       support yet. IMPORTANT: log_name must be a number.
281
+     __________________________________________________________
286 282
 
287 283
 1.2.3. How it works
288 284
 
289 285
    Some pseudo variables may return more than one value (like
290 286
    headers or AVPs). In this case, the returned values are
291 287
    embedded in a single string in a comma-separated format.
292
-     _________________________________________________________
288
+     __________________________________________________________
293 289
 
294 290
 1.3. Multi Call-Legs accounting
295 291
 
... ...
@@ -303,9 +299,9 @@ if (uri=~"sip:+40") /* calls to Romania */ {
303 299
    billed, user B must pay for the call - as last party modifing
304 300
    the call destination-, and not A - as initiator of the call.
305 301
    Call forwarding on server is only one example which shows the
306
-   necessity of the having an accounting engine with multiple
307
-   legs support.
308
-     _________________________________________________________
302
+   necessity of the having an accounting engine with multiple legs
303
+   support.
304
+     __________________________________________________________
309 305
 
310 306
 1.3.2. Configuration
311 307
 
... ...
@@ -313,8 +309,8 @@ if (uri=~"sip:+40") /* calls to Romania */ {
313 309
    each call leg to store another set of values of the AVPs. The
314 310
    meaning the AVP content is stricly decided by the script
315 311
    writter - it can be the origin and source of the leg, its
316
-   status or any other related imformation. If you have a set of
317
-   4 AVPS (AVP1, AVP2, AVP3, AVP4), then, for the A call B and B
312
+   status or any other related imformation. If you have a set of 4
313
+   AVPS (AVP1, AVP2, AVP3, AVP4), then, for the A call B and B
318 314
    forwards to C example, the for each leg ([A,B] and [B,C]) you
319 315
    need to set a different set of values for the AVPs. The script
320 316
    writer must take care and properly insert all these AVP from
... ...
@@ -327,7 +323,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
327 323
    By default, the multiple call-legs support is disabled - it can
328 324
    be enabled just be setting the per-leg set of AVPs via the
329 325
    multi_leg_info module parameter.
330
-     _________________________________________________________
326
+     __________________________________________________________
331 327
 
332 328
 1.3.3. Logged data
333 329
 
... ...
@@ -342,33 +338,33 @@ if (uri=~"sip:+40") /* calls to Romania */ {
342 338
        written, the difference between them being only the fields
343 339
        corresponding to the call-leg info.
344 340
 
345
-       Note
341
+      Note
346 342
 
347
-   You will need to add in your DB (all acc related tables) the
348
-   colums for call-leg info (a column for each AVP for the set).
343
+           You will need to add in your DB (all acc related tables) the
344
+           colums for call-leg info (a column for each AVP for the set).
349 345
      * Radius -- all sets will be added to same Radius accounting
350 346
        message as RADIUS AVPs - for each call-leg a set of RADIUS
351 347
        AVPs will be added (corresponding to the per-leg AVP set)
352 348
 
353
-       Note
349
+    Note
354 350
 
355
-   You will need to add in your dictionaty the RADIUS AVPs used
356
-   in call-leg AVP set definition.
351
+         You will need to add in your dictionaty the RADIUS AVPs used in
352
+         call-leg AVP set definition.
357 353
      * Diameter same as for RADIUS.
358
-     _________________________________________________________
354
+     __________________________________________________________
359 355
 
360 356
 1.4. Dependencies
361 357
 
362 358
 1.4.1. OpenSER Modules
363 359
 
364
-   The module depends on the following modules (in the other
365
-   words the listed modules must be loaded before this module):
360
+   The module depends on the following modules (in the other words
361
+   the listed modules must be loaded before this module):
366 362
 
367 363
      * tm -- Transaction Manager
368 364
      * a database module -- If SQL support is used.
369 365
      * rr -- Record Route, if "detect_direction" module parameter
370 366
        is enabled.
371
-     _________________________________________________________
367
+     __________________________________________________________
372 368
 
373 369
 1.4.2. External Libraries or Applications
374 370
 
... ...
@@ -378,7 +374,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
378 374
      * radiusclient-ng 0.5.0 or higher -- if compiled with RADIUS
379 375
        support. See
380 376
        http://developer.berlios.de/projects/radiusclient-ng/.
381
-     _________________________________________________________
377
+     __________________________________________________________
382 378
 
383 379
 1.5. Exported Parameters
384 380
 
... ...
@@ -390,7 +386,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
390 386
 
391 387
    Example 1-1. early_media example
392 388
 modparam("acc", "early_media", 1)
393
-     _________________________________________________________
389
+     __________________________________________________________
394 390
 
395 391
 1.5.2. failed_transaction_flag (integer)
396 392
 
... ...
@@ -401,7 +397,7 @@ modparam("acc", "early_media", 1)
401 397
 
402 398
    Example 1-2. failed_transaction_flag example
403 399
 modparam("acc", "failed_transaction_flag", 4)
404
-     _________________________________________________________
400
+     __________________________________________________________
405 401
 
406 402
 1.5.3. report_ack (integer)
407 403
 
... ...
@@ -414,7 +410,7 @@ modparam("acc", "failed_transaction_flag", 4)
414 410
 
415 411
    Example 1-3. report_ack example
416 412
 modparam("acc", "report_ack", 1)
417
-     _________________________________________________________
413
+     __________________________________________________________
418 414
 
419 415
 1.5.4. report_cancels (integer)
420 416
 
... ...
@@ -426,15 +422,15 @@ modparam("acc", "report_ack", 1)
426 422
 
427 423
    Example 1-4. report_cancels example
428 424
 modparam("acc", "report_cancels", 1)
429
-     _________________________________________________________
425
+     __________________________________________________________
430 426
 
431 427
 1.5.5. detect_direction (integer)
432 428
 
433 429
    Controlles the direction detection for sequential requests. If
434
-   enabled (non zero value), for sequential requests with
435
-   upstream direction (from callee to caller), the FROM and TO
436
-   will be swapped (the direction will be preserved as in the
437
-   original request).
430
+   enabled (non zero value), for sequential requests with upstream
431
+   direction (from callee to caller), the FROM and TO will be
432
+   swapped (the direction will be preserved as in the original
433
+   request).
438 434
 
439 435
    It affects all values related to TO and FROM headers (body,
440 436
    URI, username, domain, TAG).
... ...
@@ -443,7 +439,7 @@ modparam("acc", "report_cancels", 1)
443 439
 
444 440
    Example 1-5. detect_direction example
445 441
 modparam("acc", "detect_direction", 1)
446
-     _________________________________________________________
442
+     __________________________________________________________
447 443
 
448 444
 1.5.6. multi_leg_info (string)
449 445
 
... ...
@@ -468,18 +464,18 @@ modparam("acc", "multi_leg_info",
468 464
 # for DIAMETER-based accouting, use the DIAMETER AVP ID (as integer)
469 465
 modparam("acc", "multi_leg_info",
470 466
     "2345=$avp(src);2346=$avp(dst)")
471
-     _________________________________________________________
467
+     __________________________________________________________
472 468
 
473 469
 1.5.7. log_flag (integer)
474 470
 
475
-   Request flag which needs to be set to account a transaction
476
-   via syslog.
471
+   Request flag which needs to be set to account a transaction via
472
+   syslog.
477 473
 
478 474
    Default value is not-set (no flag).
479 475
 
480 476
    Example 1-7. log_flag example
481 477
 modparam("acc", "log_flag", 2)
482
-     _________________________________________________________
478
+     __________________________________________________________
483 479
 
484 480
 1.5.8. log_missed_flag (integer)
485 481
 
... ...
@@ -490,7 +486,7 @@ modparam("acc", "log_flag", 2)
490 486
 
491 487
    Example 1-8. log_missed_flag example
492 488
 modparam("acc", "log_missed_flag", 3)
493
-     _________________________________________________________
489
+     __________________________________________________________
494 490
 
495 491
 1.5.9. log_level (integer)
496 492
 
... ...
@@ -500,19 +496,19 @@ modparam("acc", "log_missed_flag", 3)
500 496
 
501 497
    Example 1-9. log_level example
502 498
 modparam("acc", "log_level", 2)   # Set log_level to 2
503
-     _________________________________________________________
499
+     __________________________________________________________
504 500
 
505 501
 1.5.10. log_facility (string)
506 502
 
507
-   Log facility to which accounting messages are issued to
508
-   syslog. This allows to easily seperate the accounting specific
509
-   logging from the other log messages.
503
+   Log facility to which accounting messages are issued to syslog.
504
+   This allows to easily seperate the accounting specific logging
505
+   from the other log messages.
510 506
 
511 507
    Default value is LOG_DAEMON.
512 508
 
513 509
    Example 1-10. log_facility example
514 510
 modparam("acc", "log_facility", "LOG_DAEMON")
515
-     _________________________________________________________
511
+     __________________________________________________________
516 512
 
517 513
 1.5.11. log_extra (string)
518 514
 
... ...
@@ -522,7 +518,7 @@ modparam("acc", "log_facility", "LOG_DAEMON")
522 518
 
523 519
    Example 1-11. log_extra example
524 520
 modparam("acc", "log_extra", "ua=$hdr(User-Agent);uuid=$avp(i:123)")
525
-     _________________________________________________________
521
+     __________________________________________________________
526 522
 
527 523
 1.5.12. radius_config (string)
528 524
 
... ...
@@ -536,12 +532,12 @@ modparam("acc", "log_extra", "ua=$hdr(User-Agent);uuid=$avp(i:123)")
536 532
    If the parameter is set to empty string, the RADIUS accouting
537 533
    support will be disabled (even if compiled).
538 534
 
539
-   Default value is
540
-   "/usr/local/etc/radiusclient/radiusclient.conf ".
535
+   Default value is "/usr/local/etc/radiusclient/radiusclient.conf
536
+   ".
541 537
 
542 538
    Example 1-12. radius_config example
543 539
 modparam("acc", "radius_config", "/etc/radiusclient/radiusclient.conf")
544
-     _________________________________________________________
540
+     __________________________________________________________
545 541
 
546 542
 1.5.13. radius_flag (integer)
547 543
 
... ...
@@ -552,7 +548,7 @@ modparam("acc", "radius_config", "/etc/radiusclient/radiusclient.conf")
552 548
 
553 549
    Example 1-13. radius_flag example
554 550
 modparam("acc", "radius_flag", 2)
555
-     _________________________________________________________
551
+     __________________________________________________________
556 552
 
557 553
 1.5.14. radius_missed_flag (integer)
558 554
 
... ...
@@ -563,7 +559,7 @@ modparam("acc", "radius_flag", 2)
563 559
 
564 560
    Example 1-14. radius_missed_flag example
565 561
 modparam("acc", "radius_missed_flag", 3)
566
-     _________________________________________________________
562
+     __________________________________________________________
567 563
 
568 564
 1.5.15. service_type (integer)
569 565
 
... ...
@@ -573,7 +569,7 @@ modparam("acc", "radius_missed_flag", 3)
573 569
 
574 570
    Example 1-15. service_type example
575 571
 modparam("acc", "service_type", 16)
576
-     _________________________________________________________
572
+     __________________________________________________________
577 573
 
578 574
 1.5.16. radius_extra (string)
579 575
 
... ...
@@ -582,9 +578,8 @@ modparam("acc", "service_type", 16)
582 578
    Default value is NULL.
583 579
 
584 580
    Example 1-16. radius_extra example
585
-modparam("acc", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)"
586
-)
587
-     _________________________________________________________
581
+modparam("acc", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)")
582
+     __________________________________________________________
588 583
 
589 584
 1.5.17. db_flag (integer)
590 585
 
... ...
@@ -595,7 +590,7 @@ modparam("acc", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)"
595 590
 
596 591
    Example 1-17. db_flag example
597 592
 modparam("acc", "db_flag", 2)
598
-     _________________________________________________________
593
+     __________________________________________________________
599 594
 
600 595
 1.5.18. db_missed_flag (integer)
601 596
 
... ...
@@ -606,7 +601,7 @@ modparam("acc", "db_flag", 2)
606 601
 
607 602
    Example 1-18. db_missed_flag example
608 603
 modparam("acc", "db_missed_flag", 3)
609
-     _________________________________________________________
604
+     __________________________________________________________
610 605
 
611 606
 1.5.19. db_table_acc (string)
612 607
 
... ...
@@ -617,7 +612,7 @@ modparam("acc", "db_missed_flag", 3)
617 612
 
618 613
    Example 1-19. db_table_acc example
619 614
 modparam("acc", "db_table_acc", "myacc_table")
620
-     _________________________________________________________
615
+     __________________________________________________________
621 616
 
622 617
 1.5.20. db_table_missed_calls (string)
623 618
 
... ...
@@ -627,7 +622,7 @@ modparam("acc", "db_table_acc", "myacc_table")
627 622
 
628 623
    Example 1-20. db_table_missed_calls example
629 624
 modparam("acc", "db_table_missed_calls", "myMC_table")
630
-     _________________________________________________________
625
+     __________________________________________________________
631 626
 
632 627
 1.5.21. db_url (string)
633 628
 
... ...
@@ -638,7 +633,7 @@ modparam("acc", "db_table_missed_calls", "myMC_table")
638 633
 
639 634
    Example 1-21. db_url example
640 635
 modparam("acc", "db_url", "mysql://user:password@localhost/openser")
641
-     _________________________________________________________
636
+     __________________________________________________________
642 637
 
643 638
 1.5.22. acc_method_column (string)
644 639
 
... ...
@@ -649,7 +644,7 @@ modparam("acc", "db_url", "mysql://user:password@localhost/openser")
649 644
 
650 645
    Example 1-22. acc_method_column example
651 646
 modparam("acc", "acc_method_column", "method")
652
-     _________________________________________________________
647
+     __________________________________________________________
653 648
 
654 649
 1.5.23. acc_from_tag_column (string)
655 650
 
... ...
@@ -660,7 +655,7 @@ modparam("acc", "acc_method_column", "method")
660 655
 
661 656
    Example 1-23. acc_from_tag_column example
662 657
 modparam("acc", "acc_from_tag_column", "from_tag")
663
-     _________________________________________________________
658
+     __________________________________________________________
664 659
 
665 660
 1.5.24. acc_to_tag_column (string)
666 661
 
... ...
@@ -671,7 +666,7 @@ modparam("acc", "acc_from_tag_column", "from_tag")
671 666
 
672 667
    Example 1-24. acc_to_tag_column example
673 668
 modparam("acc", "acc_to_tag_column", "to_tag")
674
-     _________________________________________________________
669
+     __________________________________________________________
675 670
 
676 671
 1.5.25. acc_callid_column (string)
677 672
 
... ...
@@ -682,7 +677,7 @@ modparam("acc", "acc_to_tag_column", "to_tag")
682 677
 
683 678
    Example 1-25. acc_callid_column example
684 679
 modparam("acc", "acc_callid_column", "callid")
685
-     _________________________________________________________
680
+     __________________________________________________________
686 681
 
687 682
 1.5.26. acc_sip_code_column (string)
688 683
 
... ...
@@ -693,7 +688,7 @@ modparam("acc", "acc_callid_column", "callid")
693 688
 
694 689
    Example 1-26. acc_sip_code_column example
695 690
 modparam("acc", "acc_sip_code_column", "sip_code")
696
-     _________________________________________________________
691
+     __________________________________________________________
697 692
 
698 693
 1.5.27. acc_sip_reason_column (string)
699 694
 
... ...
@@ -704,7 +699,7 @@ modparam("acc", "acc_sip_code_column", "sip_code")
704 699
 
705 700
    Example 1-27. acc_sip_reason_column example
706 701
 modparam("acc", "acc_sip_reason_column", "sip_reason")
707
-     _________________________________________________________
702
+     __________________________________________________________
708 703
 
709 704
 1.5.28. acc_time_column (string)
710 705
 
... ...
@@ -715,7 +710,7 @@ modparam("acc", "acc_sip_reason_column", "sip_reason")
715 710
 
716 711
    Example 1-28. acc_time_column example
717 712
 modparam("acc", "acc_time_column", "time")
718
-     _________________________________________________________
713
+     __________________________________________________________
719 714
 
720 715
 1.5.29. db_extra (string)
721 716
 
... ...
@@ -724,9 +719,9 @@ modparam("acc", "acc_time_column", "time")
724 719
    Default value is NULL.
725 720
 
726 721
    Example 1-29. db_extra example
727
-modparam("acc", "db_extra", "ct=$hdr(Content-type); email=$avp(s:email)
728
-")
729
-     _________________________________________________________
722
+modparam("acc", "db_extra", "ct=$hdr(Content-type); email=$avp(s:email)"
723
+)
724
+     __________________________________________________________
730 725
 
731 726
 1.5.30. diameter_flag (integer)
732 727
 
... ...
@@ -737,7 +732,7 @@ modparam("acc", "db_extra", "ct=$hdr(Content-type); email=$avp(s:email)
737 732
 
738 733
    Example 1-30. diameter_flag example
739 734
 modparam("acc", "diameter_flag", 2)
740
-     _________________________________________________________
735
+     __________________________________________________________
741 736
 
742 737
 1.5.31. diameter_missed_flag (integer)
743 738
 
... ...
@@ -748,18 +743,18 @@ modparam("acc", "diameter_flag", 2)
748 743
 
749 744
    Example 1-31. diameter_missed_flag example
750 745
 modparam("acc", "diameter_missed_flag", 3)
751
-     _________________________________________________________
746
+     __________________________________________________________
752 747
 
753 748
 1.5.32. diameter_client_host (string)
754 749
 
755
-   Hostname of the machine where the DIAMETER Client is running
756
-   -- DIAMETER specific.
750
+   Hostname of the machine where the DIAMETER Client is running --
751
+   DIAMETER specific.
757 752
 
758 753
    Default value is "localhost".
759 754
 
760 755
    Example 1-32. diameter_client_host example
761 756
 modparam("acc", "diameter_client_host", "3a_server.net")
762
-     _________________________________________________________
757
+     __________________________________________________________
763 758
 
764 759
 1.5.33. diameter_client_port (int)
765 760
 
... ...
@@ -770,7 +765,7 @@ modparam("acc", "diameter_client_host", "3a_server.net")
770 765
 
771 766
    Example 1-33. diameter_client_host example
772 767
 modparam("acc", "diameter_client_port", 3000)
773
-     _________________________________________________________
768
+     __________________________________________________________
774 769
 
775 770
 1.5.34. diameter_extra (string)
776 771
 
... ...
@@ -779,17 +774,17 @@ modparam("acc", "diameter_client_port", 3000)
779 774
    Default value is NULL.
780 775
 
781 776
    Example 1-34. diameter_extra example
782
-modparam("acc", "diameter_extra", "7846=$hdr(Content-type);7847=$avp(s:
783
-email)")
784
-     _________________________________________________________
777
+modparam("acc", "diameter_extra", "7846=$hdr(Content-type);7847=$avp(s:e
778
+mail)")
779
+     __________________________________________________________
785 780
 
786 781
 1.6. Exported Functions
787 782
 
788 783
 1.6.1. acc_log_request(comment)
789 784
 
790 785
    acc_request reports on a request, for example, it can be used
791
-   to report on missed calls to off-line users who are replied
792
-   404 - Not Found. To avoid multiple reports on UDP request
786
+   to report on missed calls to off-line users who are replied 404
787
+   - Not Found. To avoid multiple reports on UDP request
793 788
    retransmission, you would need to embed the action in stateful
794 789
    processing.
795 790
 
... ...
@@ -803,7 +798,7 @@ email)")
803 798
 ...
804 799
 acc_log_request("Some comment");
805 800
 ...
806
-     _________________________________________________________
801
+     __________________________________________________________
807 802
 
808 803
 1.6.2. acc_db_request(comment, table)
809 804
 
... ...
@@ -822,7 +817,7 @@ acc_log_request("Some comment");
822 817
 ...
823 818
 acc_log_request("Some comment", "Some table");
824 819
 ...
825
-     _________________________________________________________
820
+     __________________________________________________________
826 821
 
827 822
 1.6.3. acc_rad_request(comment)
828 823
 
... ...
@@ -839,12 +834,12 @@ acc_log_request("Some comment", "Some table");
839 834
 ...
840 835
 acc_rad_request("Some comment");
841 836
 ...
842
-     _________________________________________________________
837
+     __________________________________________________________
843 838
 
844 839
 1.6.4. acc_diam_request(comment)
845 840
 
846
-   Like acc_log_request, acc_diam_request reports on a request.
847
-   It reports to the configured Diameter server.
841
+   Like acc_log_request, acc_diam_request reports on a request. It
842
+   reports to the configured Diameter server.
848 843
 
849 844
    Meaning of the parameters is as follows:
850 845
 
... ...
@@ -856,53 +851,47 @@ acc_rad_request("Some comment");
856 851
 ...
857 852
 acc_diam_request("Some comment");
858 853
 ...
859
-     _________________________________________________________
860
-
861
-Chapter 2. Developer's Guide
862
-
863
-   The module does not provide any API to use in other OpenSER
864
-   modules.
865
-     _________________________________________________________
854
+     __________________________________________________________
866 855
 
867
-Chapter 3. Frequently Asked Questions
856
+Chapter 2. Frequently Asked Questions
868 857
 
869
-   3.1. What happend with old log_fmt parameter
870
-   3.2. What happend with old multi_leg_enabled parameter
871
-   3.3. What happend with old src_leg_avp_id & dst_leg_avp_id
858
+   2.1. What happend with old log_fmt parameter
859
+   2.2. What happend with old multi_leg_enabled parameter
860
+   2.3. What happend with old src_leg_avp_id & dst_leg_avp_id
872 861
           parameters
873 862
 
874
-   3.4. Where can I find more about OpenSER?
875
-   3.5. Where can I post a question about this module?
876
-   3.6. How can I report a bug?
863
+   2.4. Where can I find more about OpenSER?
864
+   2.5. Where can I post a question about this module?
865
+   2.6. How can I report a bug?
877 866
 
878
-   3.1. What happend with old log_fmt parameter
867
+   2.1. What happend with old log_fmt parameter
879 868
 
880 869
    The parameter became obsolete with the restructure of the data
881 870
    logged by ACC module (refer to the Overview chapter). For
882 871
    similar behaviour you can use the extra accouting (see the
883 872
    coresponding chapter).
884 873
 
885
-   3.2. What happend with old multi_leg_enabled parameter
874
+   2.2. What happend with old multi_leg_enabled parameter
886 875
 
887 876
    The parameter becaome obsolete by the addition of the new
888 877
    multi_leg_info parameter. The multi-leg accouting is
889 878
    automatically enabled when multi_leg_info is defined.
890 879
 
891
-   3.3. What happend with old src_leg_avp_id & dst_leg_avp_id
880
+   2.3. What happend with old src_leg_avp_id & dst_leg_avp_id
892 881
    parameters
893 882
 
894 883
    The parameter was replaced by the more generic new parameter
895 884
    multi_leg_info. This allows logging (per-leg) of more
896 885
    information than just dst and src.
897 886
 
898
-   3.4. Where can I find more about OpenSER?
887
+   2.4. Where can I find more about OpenSER?
899 888
 
900 889
    Take a look at http://openser.org/.
901 890
 
902
-   3.5. Where can I post a question about this module?
891
+   2.5. Where can I post a question about this module?
903 892
 
904
-   First at all check if your question was already answered on
905
-   one of our mailing lists:
893
+   First at all check if your question was already answered on one
894
+   of our mailing lists:
906 895
 
907 896
      * User Mailing List -
908 897
        http://openser.org/cgi-bin/mailman/listinfo/users
... ...
@@ -916,7 +905,7 @@ Chapter 3. Frequently Asked Questions
916 905
    If you want to keep the mail private, send it to
917 906
    <team@openser.org>.
918 907
 
919
-   3.6. How can I report a bug?
908
+   2.6. How can I report a bug?
920 909
 
921 910
    Please follow the guidelines provided at:
922 911
    http://sourceforge.net/tracker/?group_id=139143.
... ...
@@ -1,7 +1,6 @@
1 1
 <!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
2 2
 
3 3
 <!ENTITY user SYSTEM "acc_user.sgml">
4
-<!ENTITY devel SYSTEM "acc_devel.sgml">
5 4
 <!ENTITY faq SYSTEM "acc_faq.sgml">
6 5
 
7 6
 <!-- Include general documentation entities -->
... ...
@@ -60,7 +59,6 @@
60 59
 	<toc></toc>
61 60
 	
62 61
 	&user;
63
-	&devel;
64 62
 	&faq;
65 63
 
66 64
 </book>
... ...
@@ -1,8 +1,7 @@
1 1
 <!-- Module FAQ -->
2 2
 
3 3
 <chapter>
4
-	<chapterinfo>
5
-	</chapterinfo>
4
+	
6 5
 	<title>Frequently Asked Questions</title>
7 6
 	<qandaset defaultlabel="number">
8 7
 
... ...
@@ -1,8 +1,7 @@
1 1
 <!-- Acc Module User's Guide -->
2 2
 
3 3
 <chapter>
4
-	<chapterinfo>
5
-	</chapterinfo>
4
+	
6 5
 	<title>User's Guide</title>
7 6
 	
8 7
 	<section>
... ...
@@ -34,9 +34,6 @@ Daniel-Constantin Mierla
34 34
 
35 35
               1.4.1. alias_db_lookup(table_name)
36 36
 
37
-   2. Developer's Guide
38
-   3. Frequently Asked Questions
39
-
40 37
    List of Examples
41 38
    1-1. Set db_url parameter
42 39
    1-2. Set user_column parameter
... ...
@@ -191,42 +188,3 @@ modparam("alias_db", "domain_prefix", "sip.")
191 188
 ...
192 189
 alias_db_lookup("dbaliases");
193 190
 ...
194
-     __________________________________________________________
195
-
196
-Chapter 2. Developer's Guide
197
-
198
-   The module does not provide any API to use in other OpenSER
199
-   modules.
200
-     __________________________________________________________
201
-
202
-Chapter 3. Frequently Asked Questions
203
-
204
-   3.1. Where can I find more about OpenSER?
205
-   3.2. Where can I post a question about this module?
206
-   3.3. How can I report a bug?
207
-
208
-   3.1. Where can I find more about OpenSER?
209
-
210
-   Take a look at http://openser.org/.
211
-
212
-   3.2. Where can I post a question about this module?
213
-
214
-   First at all check if your question was already answered on one
215
-   of our mailing lists:
216
-
217
-     * User Mailing List -
218
-       http://openser.org/cgi-bin/mailman/listinfo/users
219
-     * Developer Mailing List -
220
-       http://openser.org/cgi-bin/mailman/listinfo/devel
221
-
222
-   E-mails regarding any stable OpenSER release should be sent to
223
-   <users@openser.org> and e-mails regarding development versions
224
-   should be sent to <devel@openser.org>.
225
-
226
-   If you want to keep the mail private, send it to
227
-   <team@openser.org>.
228
-
229
-   3.3. How can I report a bug?
230
-
231
-   Please follow the guidelines provided at:
232
-   http://sourceforge.net/tracker/?group_id=139143.
... ...
@@ -1,8 +1,7 @@
1 1
 <!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
2 2
 
3 3
 <!ENTITY user SYSTEM "alias_db_user.sgml">
4
-<!ENTITY devel SYSTEM "alias_db_devel.sgml">
5
-<!ENTITY faq SYSTEM "alias_db_faq.sgml">
4
+<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
6 5
 
7 6
 <!ENTITY aliasdbsql SYSTEM "alias_db.sql">
8 7
 
... ...
@@ -49,7 +48,6 @@
49 48
     <toc></toc>
50 49
     
51 50
     &user;
52
-    &devel;
53 51
     &faq;
54 52
 
55 53
 </book>
... ...
@@ -1,8 +1,7 @@
1 1
 <!-- Module User's Guide -->
2 2
 
3 3
 <chapter>
4
-	<chapterinfo>
5
-	</chapterinfo>
4
+	
6 5
 	<title>User's Guide</title>
7 6
 	
8 7
 	<section>
... ...
@@ -53,9 +53,6 @@ Jan Janak
53 53
               1.4.7. pv_www_authorize(realm)
54 54
               1.4.8. pv_proxy_authorize(realm)
55 55
 
56
-   2. Developer's Guide
57
-   3. Frequently Asked Questions
58
-
59 56
    List of Examples
60 57
    1-1. secret parameter example
61 58
    1-2. nonce_expire parameter example
... ...
@@ -490,42 +487,3 @@ if (!pv_proxy_authorize("")) {
490 487
         proxy_challenge("", "1");  # Realm will be autogenerated
491 488
 };
492 489
 ...
493
-     __________________________________________________________
494
-
495
-Chapter 2. Developer's Guide
496
-
497
-   The module does not provide any API to use in other OpenSER
498
-   modules.
499
-     __________________________________________________________
500
-
501
-Chapter 3. Frequently Asked Questions
502
-
503
-   3.1. Where can I find more about OpenSER?
504
-   3.2. Where can I post a question about this module?
505
-   3.3. How can I report a bug?
506
-
507
-   3.1. Where can I find more about OpenSER?
508
-
509
-   Take a look at http://openser.org/.
510
-
511
-   3.2. Where can I post a question about this module?
512
-
513
-   First at all check if your question was already answered on one
514
-   of our mailing lists:
515
-
516
-     * User Mailing List -
517
-       http://openser.org/cgi-bin/mailman/listinfo/users
518
-     * Developer Mailing List -
519
-       http://openser.org/cgi-bin/mailman/listinfo/devel
520
-
521
-   E-mails regarding any stable OpenSER release should be sent to
522
-   <users@openser.org> and e-mails regarding development versions
523
-   should be sent to <devel@openser.org>.
524
-
525
-   If you want to keep the mail private, send it to
526
-   <team@openser.org>.
527
-
528
-   3.3. How can I report a bug?
529
-
530
-   Please follow the guidelines provided at:
531
-   http://sourceforge.net/tracker/?group_id=139143.
... ...
@@ -1,8 +1,7 @@
1 1
 <!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
2 2
 
3 3
 <!ENTITY user SYSTEM "auth_user.sgml">
4
-<!ENTITY devel SYSTEM "auth_devel.sgml">
5
-<!ENTITY faq SYSTEM "auth_faq.sgml">
4
+<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
6 5
 
7 6
 <!-- Include general documentation entities -->
8 7
 <!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
... ...
@@ -58,7 +57,6 @@
58 57
 	<toc></toc>
59 58
 
60 59
     &user;
61
-    &devel;
62 60
     &faq;
63 61
 
64 62
 </book>
... ...
@@ -1,8 +1,7 @@
1 1
 <!-- Auth Module User's Guide -->
2 2
 
3 3
 <chapter>
4
-	<chapterinfo>
5
-	</chapterinfo>
4
+	
6 5
 	<title>User's Guide</title>
7 6
 
8 7
 	<section>
... ...
@@ -44,9 +44,6 @@ Jan Janak
44 44
               1.4.1. www_authorize(realm, table)
45 45
               1.4.2. proxy_authorize(realm, table)
46 46
 
47
-   2. Developer's Guide
48
-   3. Frequently Asked Questions
49
-
50 47
    List of Examples
51 48
    1-1. db_url parameter usage
52 49
    1-2. user_column parameter usage
... ...
@@ -326,42 +323,3 @@ if (!proxy_authorize("", "subscriber)) {
326 323
         proxy_challenge("", "1");  # Realm will be autogenerated
327 324
 };
328 325
 ...
329
-     __________________________________________________________
330
-
331
-Chapter 2. Developer's Guide
332
-
333
-   The module does not provide any API to use in other OpenSER
334
-   modules.
335
-     __________________________________________________________
336
-
337
-Chapter 3. Frequently Asked Questions
338
-
339
-   3.1. Where can I find more about OpenSER?
340
-   3.2. Where can I post a question about this module?
341
-   3.3. How can I report a bug?
342
-
343
-   3.1. Where can I find more about OpenSER?
344
-
345
-   Take a look at http://openser.org/.
346
-
347
-   3.2. Where can I post a question about this module?
348
-
349
-   First at all check if your question was already answered on one
350
-   of our mailing lists:
351
-
352
-     * User Mailing List -
353
-       http://openser.org/cgi-bin/mailman/listinfo/users
354
-     * Developer Mailing List -
355
-       http://openser.org/cgi-bin/mailman/listinfo/devel
356
-
357
-   E-mails regarding any stable OpenSER release should be sent to
358
-   <users@openser.org> and e-mails regarding development versions
359
-   should be sent to <devel@openser.org>.
360
-
361
-   If you want to keep the mail private, send it to
362
-   <team@openser.org>.
363
-
364
-   3.3. How can I report a bug?
365
-
366
-   Please follow the guidelines provided at:
367
-   http://sourceforge.net/tracker/?group_id=139143.
... ...
@@ -1,8 +1,7 @@
1 1
 <!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
2 2
 
3 3
 <!ENTITY user SYSTEM "auth_db_user.sgml">
4
-<!ENTITY devel SYSTEM "auth_db_devel.sgml">
5
-<!ENTITY faq SYSTEM "auth_db_faq.sgml">
4
+<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
6 5
 
7 6
 <!-- Include general documentation entities -->
8 7
 <!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
... ...
@@ -56,7 +55,6 @@
56 55
 	<toc></toc>
57 56
 	
58 57
 	&user;
59
-	&devel;
60 58
 	&faq;
61 59
 
62 60
 </book>
... ...
@@ -1,8 +1,7 @@
1 1
 <!-- Auth_db Module User's Guide -->
2 2
 
3 3
 <chapter>
4
-	<chapterinfo>
5
-	</chapterinfo>
4
+	
6 5
 	<title>User's Guide</title>
7 6
 	
8 7
 	<section>
... ...
@@ -1,4 +1,3 @@
1
-
2 1
 AUTH_DIAMETER Module
3 2
 
4 3
 Elena-Ramona Modroiu
... ...
@@ -10,7 +9,7 @@ Edited by
10 9
 Elena-Ramona Modroiu
11 10
 
12 11
    Copyright � 2003, 2004 FhG FOKUS
13
-     _________________________________________________________
12
+     __________________________________________________________
14 13
 
15 14
    Table of Contents
16 15
    1. User's Guide
... ...
@@ -35,9 +34,6 @@ Elena-Ramona Modroiu
35 34
 
36 35
         1.5. Installation & Running
37 36
 
38
-   2. Developer's Guide
39
-   3. Frequently Asked Questions
40
-
41 37
    List of Examples
42 38
    1-1. Digest Authentication
43 39
    1-2. Set diameter_client_host parameter
... ...
@@ -46,7 +42,7 @@ Elena-Ramona Modroiu
46 42
    1-5. diameter_www_authorize usage
47 43
    1-6. diameter_proxy_authorize usage
48 44
    1-7. diameter_is_user_in usage
49
-     _________________________________________________________
45
+     __________________________________________________________
50 46
 
51 47
 Chapter 1. User's Guide
52 48
 
... ...
@@ -93,7 +89,7 @@ Chapter 1. User's Guide
93 89
                                   Result-Code=2001
94 90
 
95 91
 ...
96
-     _________________________________________________________
92
+     __________________________________________________________
97 93
 
98 94
 1.2. Dependencies
99 95
 
... ...
@@ -102,7 +98,7 @@ Chapter 1. User's Guide
102 98
    The following modules must be loaded before this module:
103 99
 
104 100
      * sl - used to send stateless replies.
105
-     _________________________________________________________
101
+     __________________________________________________________
106 102
 
107 103
 1.2.2. External Libraries or Applications
108 104
 
... ...
@@ -110,7 +106,7 @@ Chapter 1. User's Guide
110 106
    before running OpenSER with this module loaded:
111 107
 
112 108
      * None.
113
-     _________________________________________________________
109
+     __________________________________________________________
114 110
 
115 111
 1.3. Exported Parameters
116 112
 
... ...
@@ -118,48 +114,48 @@ Chapter 1. User's Guide
118 114
 
119 115
    Hostname of the machine where the DIAMETER Client is running.
120 116
 
121
-   Default value is "localhost". 
117
+   Default value is "localhost".
122 118
 
123 119
    Example 1-2. Set diameter_client_host parameter
124 120
 ...
125 121
 modparam("auth_diameter", "diameter_client_host", "10.10.10.10")
126 122
 ...
127
-     _________________________________________________________
123
+     __________________________________________________________
128 124
 
129 125
 1.3.2. diameter_client_port (int)
130 126
 
131 127
    Port number where the DIAMETER Client is listening.
132 128
 
133
-   Default value is "3000". 
129
+   Default value is "3000".
134 130
 
135 131
    Example 1-3. Set diameter_client_port parameter
136 132
 ...
137 133
 modparam("auth_diameter", "diameter_client_port", 3000)
138 134
 ...
139
-     _________________________________________________________
135
+     __________________________________________________________
140 136
 
141 137
 1.3.3. use_domain (int)
142 138
 
143 139
    Specifies whether the domain name part of URI is used when
144 140
    checking the user's privileges.
145 141
 
146
-   Default value is "0 (0==false and 1==true )". 
142
+   Default value is "0 (0==false and 1==true )".
147 143
 
148 144
    Example 1-4. Set use_domain parameter
149 145
 ...
150 146
 modparam("auth_diameter", "use_domain", 1)
151 147
 ...
152
-     _________________________________________________________
148
+     __________________________________________________________
153 149
 
154 150
 1.4. Exported Functions
155 151
 
156 152
 1.4.1. diameter_www_authorize(realm)
157 153
 
158
-   SIP Server checks for authorization having a DIAMETER server
159
-   in backend. If no credentials are provided inside the SIP
160
-   request then a challenge is sent back to UAC. If the
161
-   credentials don't match the ones computed by DISC then "403
162
-   Forbidden" is sent back.
154
+   SIP Server checks for authorization having a DIAMETER server in
155
+   backend. If no credentials are provided inside the SIP request
156
+   then a challenge is sent back to UAC. If the credentials don't
157
+   match the ones computed by DISC then "403 Forbidden" is sent
158
+   back.
163 159
 
164 160
    Negative codes may be interpreted as follows:
165 161
 
... ...
@@ -181,7 +177,7 @@ if(!diameter_www_authorize("siphub.net"))
181 177
         exit;
182 178
 };
183 179
 ...
184
-     _________________________________________________________
180
+     __________________________________________________________
185 181
 
186 182
 1.4.2. diameter_proxy_authorize(realm)
187 183
 
... ...
@@ -206,7 +202,7 @@ if(!diameter_proxy_authorize("siphub.net"))
206 202
         exit;
207 203
 };
208 204
 ...
209
-     _________________________________________________________
205
+     __________________________________________________________
210 206
 
211 207
 1.4.3. diameter_is_user_in(who, group)
212 208
 
... ...
@@ -229,47 +225,8 @@ if(!diameter_is_user_in("From", "voicemail"))
229 225
         exit;
230 226
 };
231 227
 ...
232
-     _________________________________________________________
228
+     __________________________________________________________
233 229
 
234 230
 1.5. Installation & Running
235 231
 
236 232
    Notes about installation and running.
237
-     _________________________________________________________
238
-
239
-Chapter 2. Developer's Guide
240
-
241
-   The module does not provide any API to use in other OpenSER
242
-   modules.
243
-     _________________________________________________________
244
-
245
-Chapter 3. Frequently Asked Questions
246
-
247
-   3.1. Where can I find more about OpenSER?
248
-   3.2. Where can I post a question about this module?
249
-   3.3. How can I report a bug?
250
-
251
-   3.1. Where can I find more about OpenSER?
252
-
253
-   Take a look at http://openser.org/.
254
-
255
-   3.2. Where can I post a question about this module?
256
-
257
-   First at all check if your question was already answered on
258
-   one of our mailing lists:
259
-
260
-     * User Mailing List -
261
-       http://openser.org/cgi-bin/mailman/listinfo/users
262
-     * Developer Mailing List -
263
-       http://openser.org/cgi-bin/mailman/listinfo/devel
264
-
265
-   E-mails regarding any stable OpenSER release should be sent to
266
-   <users@openser.org> and e-mails regarding development versions
267
-   should be sent to <devel@openser.org>.
268
-
269
-   If you want to keep the mail private, send it to
270
-   <team@openser.org>.
271
-
272
-   3.3. How can I report a bug?
273
-
274
-   Please follow the guidelines provided at:
275
-   http://sourceforge.net/tracker/?group_id=139143.
... ...
@@ -2,8 +2,7 @@
2 2
 
3 3
 
4 4
 <!ENTITY user SYSTEM "auth_diameter_user.sgml">
5
-<!ENTITY devel SYSTEM "auth_diameter_devel.sgml">
6
-<!ENTITY faq SYSTEM "auth_diameter_faq.sgml">
5
+<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
7 6
 
8 7
 <!-- Include general documentation entities -->
9 8
 <!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
... ...
@@ -47,7 +46,6 @@
47 46
     <toc></toc>
48 47
     
49 48
     &user;
50
-    &devel;
51 49
     &faq;
52 50
     
53 51
 </book>
... ...
@@ -1,8 +1,7 @@
1 1
 <!-- Module User's Guide -->
2 2
 
3 3
 <chapter>
4
-	<chapterinfo>
5
-	</chapterinfo>
4
+	
6 5
 	<title>User's Guide</title>
7 6
 	
8 7
 	<section>
... ...
@@ -37,21 +37,20 @@ Jan Janak
37 37
 
38 38
               1.4.1. radius_config (string)
39 39
               1.4.2. service_type (integer)
40
+              1.4.3. use_ruri_flag (integer)
40 41
 
41 42
         1.5. Exported Functions
42 43
 
43 44
               1.5.1. radius_www_authorize(realm)
44 45
               1.5.2. radius_proxy_authorize(realm [, uri_user])
45 46
 
46
-   2. Developer's Guide
47
-   3. Frequently Asked Questions
48
-
49 47
    List of Examples
50 48
    1-1. "SIP-AVP" RADIUS AVP exmaples
51 49
    1-2. radius_config parameter usage
52 50
    1-3. service_type parameter usage
53
-   1-4. radius_www_authorize usage
54
-   1-5. proxy_authorize usage
51
+   1-4. use_ruri_flag parameter usage
52
+   1-5. radius_www_authorize usage
53
+   1-6. proxy_authorize usage
55 54
      __________________________________________________________
56 55
 
57 56
 Chapter 1. User's Guide
... ...
@@ -151,6 +150,24 @@ modparam("auth_radius", "radius_config", "/etc/radiusclient.conf")
151 150
 modparam("auth_radius", "service_type", 15)
152 151
      __________________________________________________________
153 152
 
153
+1.4.3. use_ruri_flag (integer)
154
+
155
+   When this parameter is set to the value other than "-1" and the
156
+   request being authenticated has flag with matching number set
157
+   via setflag() function, use Request URI instead of uri
158
+   parameter value from the Authorization / Proxy-Authorization
159
+   header field to perform RADIUS authentication. This is intended
160
+   to provide workaround for misbehaving NAT / routers / ALGs that
161
+   alter request in the transit, breaking authentication. At the
162
+   time of this writing, certain versions of Linksys WRT54GL are
163
+   known to do that.
164
+
165
+   Default value is "-1".
166
+
167
+   Example 1-4. use_ruri_flag parameter usage
168
+modparam("auth_radius", "use_ruri_flag", 22)
169
+     __________________________________________________________
170
+
154 171
 1.5. Exported Functions
155 172
 
156 173
 1.5.1. radius_www_authorize(realm)
... ...
@@ -191,7 +208,7 @@ modparam("auth_radius", "service_type", 15)
191 208
 
192 209
    This function can be used from REQUEST_ROUTE.
193 210
 
194
-   Example 1-4. radius_www_authorize usage
211
+   Example 1-5. radius_www_authorize usage
195 212
 ...
196 213
 if (!radius_www_authorize("siphub.net")) {
197 214
         www_challenge("siphub.net", "1");
... ...
@@ -233,7 +250,7 @@ if (!radius_www_authorize("siphub.net")) {
233 250
 
234 251
    This function can be used from REQUEST_ROUTE.
235 252
 
236
-   Example 1-5. proxy_authorize usage
253
+   Example 1-6. proxy_authorize usage
237 254
 ...
238 255
 if (!radius_proxy_authorize("")) {   # Realm and URI user will be autoge
239 256
 nerated
... ...
@@ -245,42 +262,3 @@ ken
245 262
         proxy_challenge("$pd", "1");         # from P-Preferred-Identity
246 263
 };                                           # header field
247 264
 ...
248
-     __________________________________________________________
249
-
250
-Chapter 2. Developer's Guide
251
-
252
-   The module does not provide any API to use in other OpenSER
253
-   modules.
254
-     __________________________________________________________
255
-
256
-Chapter 3. Frequently Asked Questions
257
-
258
-   3.1. Where can I find more about OpenSER?
259
-   3.2. Where can I post a question about this module?
260
-   3.3. How can I report a bug?
261
-
262
-   3.1. Where can I find more about OpenSER?
263
-
264
-   Take a look at http://openser.org/.
265
-
266
-   3.2. Where can I post a question about this module?
267
-
268
-   First at all check if your question was already answered on one
269
-   of our mailing lists:
270
-
271
-     * User Mailing List -
272
-       http://openser.org/cgi-bin/mailman/listinfo/users
273
-     * Developer Mailing List -
274
-       http://openser.org/cgi-bin/mailman/listinfo/devel
275
-
276
-   E-mails regarding any stable OpenSER release should be sent to
277
-   <users@openser.org> and e-mails regarding development versions
278
-   should be sent to <devel@openser.org>.
279
-
280
-   If you want to keep the mail private, send it to
281
-   <team@openser.org>.
282
-
283
-   3.3. How can I report a bug?
284
-
285
-   Please follow the guidelines provided at:
286
-   http://sourceforge.net/tracker/?group_id=139143.
...