Browse code

permissions: README regenerated

Emmanuel Schmidbauer authored on 17/06/2015 14:18:00
Showing 1 changed files
... ...
@@ -14,6 +14,10 @@ Edited by
14 14
 
15 15
 Juha Heinanen
16 16
 
17
+Edited by
18
+
19
+Emmanuel Schmidbauer
20
+
17 21
    Copyright � 2003 Miklos Tirpak
18 22
 
19 23
    Copyright � 2006-2008 Juha Heinanen
... ...
@@ -54,9 +58,11 @@ Juha Heinanen
54 54
               3.14. source_col (string)
55 55
               3.15. proto_col (string)
56 56
               3.16. from_col (string)
57
-              3.17. tag_col (string)
58
-              3.18. peer_tag_avp (AVP string)
59
-              3.19. peer_tag_mode (integer)
57
+              3.17. ruri_col (string)
58
+              3.18. tag_col (string)
59
+              3.19. priority_col (integer)
60
+              3.20. peer_tag_avp (AVP string)
61
+              3.21. peer_tag_mode (integer)
60 62
 
61 63
         4. Functions
62 64
 
... ...
@@ -108,20 +114,22 @@ Juha Heinanen
108 108
    1.14. Set source_col parameter
109 109
    1.15. Set proto_col parameter
110 110
    1.16. Set from_col parameter
111
-   1.17. Set tag_col parameter
112
-   1.18. Set peer_tag_avp parameter
113
-   1.19. Set peer_tag_mode parameter
114
-   1.20. allow_routing usage
115
-   1.21. allow_routing(basename) usage
116
-   1.22. allow_routing(allow_file, deny_file) usage
117
-   1.23. allow_register(basename) usage
118
-   1.24. allow_register(allow_file, deny_file) usage
119
-   1.25. allow_uri(basename, pvar) usage
120
-   1.26. allow_address() usage
121
-   1.27. allow_source_address(group_id) usage
122
-   1.28. allow_source_address_group() usage
123
-   1.29. allow_source_address_group() usage
124
-   1.30. allow_trusted() usage
111
+   1.17. Set ruri_col parameter
112
+   1.18. Set tag_col parameter
113
+   1.19. Set priority_col parameter
114
+   1.20. Set peer_tag_avp parameter
115
+   1.21. Set peer_tag_mode parameter
116
+   1.22. allow_routing usage
117
+   1.23. allow_routing(basename) usage
118
+   1.24. allow_routing(allow_file, deny_file) usage
119
+   1.25. allow_register(basename) usage
120
+   1.26. allow_register(allow_file, deny_file) usage
121
+   1.27. allow_uri(basename, pvar) usage
122
+   1.28. allow_address() usage
123
+   1.29. allow_source_address(group_id) usage
124
+   1.30. allow_source_address_group() usage
125
+   1.31. allow_source_address_group() usage
126
+   1.32. allow_trusted() usage
125 127
 
126 128
 Chapter 1. Admin Guide
127 129
 
... ...
@@ -158,9 +166,11 @@ Chapter 1. Admin Guide
158 158
         3.14. source_col (string)
159 159
         3.15. proto_col (string)
160 160
         3.16. from_col (string)
161
-        3.17. tag_col (string)
162
-        3.18. peer_tag_avp (AVP string)
163
-        3.19. peer_tag_mode (integer)
161
+        3.17. ruri_col (string)
162
+        3.18. tag_col (string)
163
+        3.19. priority_col (integer)
164
+        3.20. peer_tag_avp (AVP string)
165
+        3.21. peer_tag_mode (integer)
164 166
 
165 167
    4. Functions
166 168
 
... ...
@@ -388,9 +398,11 @@ Chapter 1. Admin Guide
388 388
    3.14. source_col (string)
389 389
    3.15. proto_col (string)
390 390
    3.16. from_col (string)
391
-   3.17. tag_col (string)
392
-   3.18. peer_tag_avp (AVP string)
393
-   3.19. peer_tag_mode (integer)
391
+   3.17. ruri_col (string)
392
+   3.18. tag_col (string)
393
+   3.19. priority_col (integer)
394
+   3.20. peer_tag_avp (AVP string)
395
+   3.21. peer_tag_mode (integer)
394 396
 
395 397
 3.1. default_allow_file (string)
396 398
 
... ...
@@ -605,7 +617,19 @@ modparam("permissions", "proto_col", "transport")
605 605
 modparam("permissions", "from_col", "regexp")
606 606
 ...
607 607
 
608
-3.17. tag_col (string)
608
+3.17. ruri_col (string)
609
+
610
+   Name of the column trusted table containing a regular expression that
611
+   is matched against the Request URI.
612
+
613
+   Default value is "ruri_pattern".
614
+
615
+   Example 1.17. Set ruri_col parameter
616
+...
617
+modparam("permissions", "ruri_col", "regexp")
618
+...
619
+
620
+3.18. tag_col (string)
609 621
 
610 622
    Name of the column in the "address" or "trusted" table containing a
611 623
    string that is added as value to peer_tag AVP if peer_tag AVP has been
... ...
@@ -613,24 +637,36 @@ modparam("permissions", "from_col", "regexp")
613 613
 
614 614
    Default value is "tag".
615 615
 
616
-   Example 1.17. Set tag_col parameter
616
+   Example 1.18. Set tag_col parameter
617 617
 ...
618 618
 modparam("permissions", "tag_col", "peer_tag")
619 619
 ...
620 620
 
621
-3.18. peer_tag_avp (AVP string)
621
+3.19. priority_col (integer)
622
+
623
+   The column name used to store the priority of the corresponding rule
624
+   from the database row.
625
+
626
+   Default value is "priority".
627
+
628
+   Example 1.19. Set priority_col parameter
629
+...
630
+modparam("permissions", "priority_col", "column_name")
631
+...
632
+
633
+3.20. peer_tag_avp (AVP string)
622 634
 
623 635
    If defined, the AVP will be set as a side effect of allow_trusted call
624 636
    to not NULL tag column value of the matching peer.
625 637
 
626 638
    Default value is "undefined".
627 639
 
628
-   Example 1.18. Set peer_tag_avp parameter
640
+   Example 1.20. Set peer_tag_avp parameter
629 641
 ...
630 642
 modparam("permissions", "peer_tag_avp", "$avp(i:707)")
631 643
 ...
632 644
 
633
-3.19. peer_tag_mode (integer)
645
+3.21. peer_tag_mode (integer)
634 646
 
635 647
    Tag mode for allow_trusted. "0" sets only the tag of the first match.
636 648
    "1" adds the tags of all matches to the avp. In addition the return
... ...
@@ -639,7 +675,7 @@ modparam("permissions", "peer_tag_avp", "$avp(i:707)")
639 639
 
640 640
    Default value is "0".
641 641
 
642
-   Example 1.19. Set peer_tag_mode parameter
642
+   Example 1.21. Set peer_tag_mode parameter
643 643
 ...
644 644
 modparam("permissions", "peer_tag_mode", 1)
645 645
 ...
... ...
@@ -667,7 +703,7 @@ modparam("permissions", "peer_tag_mode", 1)
667 667
 
668 668
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
669 669
 
670
-   Example 1.20. allow_routing usage
670
+   Example 1.22. allow_routing usage
671 671
 ...
672 672
 if (allow_routing()) {
673 673
         t_relay();
... ...
@@ -690,7 +726,7 @@ if (allow_routing()) {
690 690
 
691 691
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
692 692
 
693
-   Example 1.21. allow_routing(basename) usage
693
+   Example 1.23. allow_routing(basename) usage
694 694
 ...
695 695
 if (allow_routing("basename")) {
696 696
         t_relay();
... ...
@@ -715,7 +751,7 @@ if (allow_routing("basename")) {
715 715
 
716 716
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
717 717
 
718
-   Example 1.22. allow_routing(allow_file, deny_file) usage
718
+   Example 1.24. allow_routing(allow_file, deny_file) usage
719 719
 ...
720 720
 if (allow_routing("rules.allow", "rules.deny")) {
721 721
         t_relay();
... ...
@@ -738,7 +774,7 @@ if (allow_routing("rules.allow", "rules.deny")) {
738 738
 
739 739
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
740 740
 
741
-   Example 1.23. allow_register(basename) usage
741
+   Example 1.25. allow_register(basename) usage
742 742
 ...
743 743
 if (method=="REGISTER") {
744 744
         if (allow_register("register")) {
... ...
@@ -768,7 +804,7 @@ if (method=="REGISTER") {
768 768
 
769 769
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
770 770
 
771
-   Example 1.24. allow_register(allow_file, deny_file) usage
771
+   Example 1.26. allow_register(allow_file, deny_file) usage
772 772
 ...
773 773
 if (method=="REGISTER") {
774 774
         if (allow_register("register.allow", "register.deny")) {
... ...
@@ -797,7 +833,7 @@ if (method=="REGISTER") {
797 797
 
798 798
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
799 799
 
800
-   Example 1.25. allow_uri(basename, pvar) usage
800
+   Example 1.27. allow_uri(basename, pvar) usage
801 801
 ...
802 802
 if (allow_uri("basename", "$rt")) {  // Check Refer-To URI
803 803
         t_relay();
... ...
@@ -823,7 +859,7 @@ if (allow_uri("basename", "$avp(i:705)") {  // Check URI stored in $avp(i:705)
823 823
 
824 824
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
825 825
 
826
-   Example 1.26. allow_address() usage
826
+   Example 1.28. allow_address() usage
827 827
 ...
828 828
 
829 829
 // Check if source address/port is in group 1
... ...
@@ -845,7 +881,7 @@ if (!allow_address("2", "$avp(dst_adr)", "$avp(dst_port)") {
845 845
 
846 846
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
847 847
 
848
-   Example 1.27. allow_source_address(group_id) usage
848
+   Example 1.29. allow_source_address(group_id) usage
849 849
 ...
850 850
 
851 851
 // Check source address/port of request
... ...
@@ -862,7 +898,7 @@ if (!allow_source_address("1")) {
862 862
 
863 863
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
864 864
 
865
-   Example 1.28. allow_source_address_group() usage
865
+   Example 1.30. allow_source_address_group() usage
866 866
 ...
867 867
 
868 868
 $var(group) = allow_source_address_group();
... ...
@@ -880,7 +916,7 @@ if ($var(group) != -1) {
880 880
 
881 881
    This function can be used from ANY_ROUTE.
882 882
 
883
-   Example 1.29. allow_source_address_group() usage
883
+   Example 1.31. allow_source_address_group() usage
884 884
 ...
885 885
 
886 886
 $var(group) = allow_address_group("1.2.3.4", "5060");
... ...
@@ -905,7 +941,7 @@ if ($var(group) != -1) {
905 905
 
906 906
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
907 907
 
908
-   Example 1.30. allow_trusted() usage
908
+   Example 1.32. allow_trusted() usage
909 909
 ...
910 910
 if (allow_trusted()) {
911 911
         t_relay();