modules/policy: doc update, compat with 1.0 api

diff --git a/modules/daf/README.rst b/modules/daf/README.rst
index 61c5f90e6219de1c9fc3a36b847ca75bd2c162fe..d654aabda646e994fd2a480517c558b26fcddc97 100644 (file)
--- a/modules/daf/README.rst
+++ b/modules/daf/README.rst
@@ -8,64 +8,67 @@ This module is a high-level interface for other powerful filtering modules and D
 Example configuration
 ^^^^^^^^^^^^^^^^^^^^^
 
+Firewall rules are declarative and consist of filters and actions. Filters have ``field operator operand`` notation (e.g. ``qname = example.com``), and may be chained using AND/OR keywords. Actions may or may not have parameters after the action name.
+
 .. code-block:: lua
 
-       modules = { 'http', 'daf' }
-
-       -- Let's write some daft rules!
-       
-       -- Block all queries with QNAME = example.com
-       daf.add 'qname = example.com deny'
-
-       -- Filters can be combined using AND/OR...
-       -- Block all queries with QNAME match regex and coming from given subnet
-       daf.add 'qname ~ %w+.example.com AND src = 192.0.2.0/24 deny'
-
-       -- We also can reroute addresses in response to alternate target
-       -- This reroutes 1.2.3.4 to localhost
-       daf.add 'src = 127.0.0.0/8 reroute 192.0.2.1-127.0.0.1'
-
-       -- Subnets work too, this reroutes a whole subnet
-       -- e.g. 192.0.2.55 to 127.0.0.55
-       daf.add 'src = 127.0.0.0/8 reroute 192.0.2.0/24-127.0.0.0'
-
-       -- This rewrites all A answers for 'example.com' from
-       -- whatever the original address was to 127.0.0.2
-       daf.add 'src = 127.0.0.0/8 rewrite example.com A 127.0.0.2'
-
-       -- Mirror queries matching given name to DNS logger
-       daf.add 'qname ~ %w+.example.com MIRROR 127.0.0.2'
-
-       -- Truncate queries based on destination IPs
-       daf.add 'dst = 192.0.2.51 truncate'
-
-       -- Show active rules
-       daf.rules
-       [1] => {
-           [rule] => {
-               [count] => 42
-               [id] => 1
-               [cb] => function: 0x1a3eda38
-           }
-           [info] => qname = example.com AND src = 127.0.0.1/8 deny
-           [policy] => function: 0x1a3eda38
-       }
-       [2] => {
-           [rule] => {
-               [suspended] => true
-               [count] => 123522
-               [id] => 2
-               [cb] => function: 0x1a3ede88
-           }
-           [info] => qname ~ %w+.facebook.com AND src = 127.0.0.1/8 deny...
-           [policy] => function: 0x1a3ede88
-       }
-       ...
-
-       -- Disable a rule
-       daf.disable 2
-       -- Enable a rule
-       daf.enable 2
-       -- Delete a rule
-       daf.del 2
+    -- Let's write some daft rules!
+    modules = { 'daf' }
+
+    -- Block all queries with QNAME = example.com
+    daf.add 'qname = example.com deny'
+
+    -- Filters can be combined using AND/OR...
+    -- Block all queries with QNAME match regex and coming from given subnet
+    daf.add 'qname ~ %w+.example.com AND src = 192.0.2.0/24 deny'
+
+    -- We also can reroute addresses in response to alternate target
+    -- This reroutes 1.2.3.4 to localhost
+    daf.add 'src = 127.0.0.0/8 reroute 192.0.2.1-127.0.0.1'
+
+    -- Subnets work too, this reroutes a whole subnet
+    -- e.g. 192.0.2.55 to 127.0.0.55
+    daf.add 'src = 127.0.0.0/8 reroute 192.0.2.0/24-127.0.0.0'
+
+    -- This rewrites all A answers for 'example.com' from
+    -- whatever the original address was to 127.0.0.2
+    daf.add 'src = 127.0.0.0/8 rewrite example.com A 127.0.0.2'
+
+    -- Mirror queries matching given name to DNS logger
+    daf.add 'qname ~ %w+.example.com MIRROR 127.0.0.2'
+
+    -- Truncate queries based on destination IPs
+    daf.add 'dst = 192.0.2.51 truncate'
+
+    -- Disable a rule
+    daf.disable 2
+    -- Enable a rule
+    daf.enable 2
+    -- Delete a rule
+    daf.del 2
+
+If you're not sure what firewall rules are in effect, see ``daf.rules``:
+
+.. code-block:: text
 
+    -- Show active rules
+    > daf.rules
+    [1] => {
+        [rule] => {
+            [count] => 42
+            [id] => 1
+            [cb] => function: 0x1a3eda38
+        }
+        [info] => qname = example.com AND src = 127.0.0.1/8 deny
+        [policy] => function: 0x1a3eda38
+    }
+    [2] => {
+        [rule] => {
+            [suspended] => true
+            [count] => 123522
+            [id] => 2
+            [cb] => function: 0x1a3ede88
+        }
+        [info] => qname ~ %w+.facebook.com AND src = 127.0.0.1/8 deny...
+        [policy] => function: 0x1a3ede88
+    }

diff --git a/modules/policy/policy.lua b/modules/policy/policy.lua
index 3e75005f542da510d87226b3fb27830fb11c04cf..b7207ac95160016f67c54bdcfb9e78ef1818e209 100644 (file)
--- a/modules/policy/policy.lua
+++ b/modules/policy/policy.lua
@@ -243,6 +243,13 @@ policy.layer = {
 
 -- Add rule to policy list
 function policy.add(rule, postrule)
+       -- Compatibility with 1.0.0 API
+       -- it will be dropped in 1.2.0
+       if rule == policy then
+               rule = postrule
+               postrule = nil
+       end
+       -- End of compatibility shim
        local desc = {id=getruleid(), cb=rule, count=0}
        table.insert(postrule and policy.postrules or policy.rules, desc)
        return desc