Added 'key' field, so that we can later get rid of the rfc_clean()

[freeradius.git] / man / man5 / rlm_attr_filter.5

diff --git a/man/man5/rlm_attr_filter.5 b/man/man5/rlm_attr_filter.5
index dde891a..6f79c07 100644 (file)
--- a/man/man5/rlm_attr_filter.5
+++ b/man/man5/rlm_attr_filter.5
@@ -3,23 +3,24 @@
 rlm_attr_filter \- FreeRADIUS Module
 .SH DESCRIPTION
 The \fIrlm_attr_filter\fP module exists for filtering certain
-attributes and values in received ( or transmitted ) radius packets
-from ( or to ) remote proxy servers.  It gives the proxier ( us ) a
-flexible framework to filter the attributes we send to or receive
-from these remote proxies.  This makes sense, for example, in an
-out-sourced dialup situation to various policy decisions, such as
-restricting a client to certain ranges of Idle-Timeout or
-Session-Timeout.
+attributes and values in received ( or transmitted ) radius packets.
+It gives the server a flexible framework to filter the attributes we
+send to or receive from home servers or NASes.  This makes sense, for
+example, in an out-sourced dialup situation to various policy
+decisions, such as restricting a client to certain ranges of
+Idle-Timeout or Session-Timeout.
 .PP
-Filter rules are defined and applied on a per-realm basis, where the
-realm is anything that is defined and matched based on the
-configuration of the \fIrlm_realm\fP module.
+Filter rules are normally defined and applied on a per-realm basis,
+where the realm is anything that is defined and matched based on the
+configuration of the \fIrlm_realm\fP module.  Filter rules can
+optionally be applied using another attribute, by editing the
+\fIkey\fP configuration for this module.
 .PP
 The file that defines the attribute filtering rules follows a similar
 syntax to the \fIusers\fP file.  There are a few differences however:
 .PP
 .DS
-    There are no check-items allowed other than the realm.
+    There are no check-items allowed other than the name of the key.
 .PP
     There can only be a single DEFAULT entry.
 .PP
@@ -58,7 +59,7 @@ Greater Than or Equal
 Less Than or Equal
 .TP
 .B    >   
-Greather Than
+Greater Than
 .TP
 .B    <   
 Less Than
@@ -79,9 +80,16 @@ See the default \fI/etc/raddb/attrs\fP for working examples of
 sample rule ordering and how to use the different operators.
 .DE
 .PP
-The main configuration item is:
+The configuration items are:
 .IP attrsfile
 This specifies the location of the file used to load the filter rules.
+This file is used to filter the accounting response, packet before it
+is proxied, proxy response from the home server, or our response to
+the NAS.
+.IP key
+Usually %{Realm} (the default).  Can also be %{User-Name}, or other
+attribute that exists in the request.  Note that the module always
+keys off of attributes in the request, and NOT in any other packet.
 .PP
 .SH SECTIONS
 .BR accounting,