allow for old-style names, too
[freeradius.git] / raddb / sites-available / default
index 9cd5062..0834075 100644 (file)
@@ -8,7 +8,7 @@
 #      directory to these files.  This is done in a normal installation.
 #
 #      If you are using 802.1X (EAP) authentication, please see also
-#      the "inner-tunnel" virtual server.  You wll likely have to edit
+#      the "inner-tunnel" virtual server.  You will likely have to edit
 #      that, too, for authentication to work.
 #
 #      $Id$
@@ -47,7 +47,7 @@
 server default {
 #
 #  If you want the server to listen on additional addresses, or on
-#  additionnal ports, you can use multiple "listen" sections.
+#  additional ports, you can use multiple "listen" sections.
 #
 #  Each section make the server listen for only one type of packet,
 #  therefore authentication and accounting have to be configured in
@@ -68,7 +68,7 @@ listen {
        #               see raddb/sites-available/status
        #       coa     listen for CoA-Request and Disconnect-Request
        #               packets.  For examples, see the file
-       #               raddb/sites-available/coa-server
+       #               raddb/sites-available/coa
        #
        type = auth
 
@@ -84,17 +84,22 @@ listen {
        #  source IP address for packets sent to a home server, the
        #  proxy listeners are automatically created.
 
-       #  IP address on which to listen.
+       #  ipaddr/ipv4addr/ipv6addr - IP address on which to listen.
+       #  Out of several options the first one will be used.
+       #
        #  Allowed values are:
-       #       dotted quad (1.2.3.4)
-       #       hostname    (radius.example.com)
-       #       wildcard    (*)
+       #       IPv4 address (e.g. 1.2.3.4, for ipv4addr/ipaddr)
+       #       IPv6 address (e.g. 2001:db8::1, for ipv6addr/ipaddr)
+       #       hostname     (radius.example.com,
+       #                       A record for ipv4addr,
+       #                       AAAA record for ipv6addr,
+       #                       A or AAAA record for ipaddr)
+       #       wildcard     (*)
+       #
+       # ipv4addr = *
+       # ipv6addr = *
        ipaddr = *
 
-       #  OR, you can use an IPv6 address, but not both
-       #  at the same time.
-#      ipv6addr = ::   # any.  ::1 == localhost
-
        #  Port on which to listen.
        #  Allowed values are:
        #       integer port number (1812)
@@ -206,6 +211,35 @@ listen {
        }
 }
 
+# IPv6 versions of the above - read their full config to understand options
+listen {
+       type = auth
+       ipv6addr = ::   # any.  ::1 == localhost
+       port = 0
+#      interface = eth0
+#      clients = per_socket_clients
+       limit {
+             max_connections = 16
+             lifetime = 0
+             idle_timeout = 30
+       }
+}
+
+listen {
+       ipv6addr = ::
+       port = 0
+       type = acct
+#      interface = eth0
+#      clients = per_socket_clients
+
+       limit {
+#              max_pps = 0
+#              idle_timeout = 0
+#              lifetime = 0
+#              max_connections = 0
+       }
+}
+
 #  Authorization. First preprocess (hints and huntgroups files),
 #  then realms, and finally look in the "users" file.
 #
@@ -215,12 +249,12 @@ listen {
 #  The order of the realm modules will determine the order that
 #  we try to find a matching realm.
 #
-#  Make *sure* that 'preprocess' comes before any realm if you 
+#  Make *sure* that 'preprocess' comes before any realm if you
 #  need to setup hints for the remote radius server
 authorize {
        #
        #  Take a User-Name, and perform some checks on it, for spaces and other
-       #  invalid characters.  If the User-Name appears invalid, reject the 
+       #  invalid characters.  If the User-Name appears invalid, reject the
        #  request.
        #
        #  See policy.d/filter for the definition of the filter_username policy.
@@ -228,30 +262,39 @@ authorize {
        filter_username
 
        #
+       #  Some broken equipment sends passwords with embedded zeros.
+       #  i.e. the debug output will show
+       #
+       #       User-Password = "password\000\000"
+       #
+       #  This policy will fix it to just be "password".
+       #
+#      filter_password
+
+       #
        #  The preprocess module takes care of sanitizing some bizarre
        #  attributes in the request, and turning them into attributes
        #  which are more standard.
        #
-       #  It takes care of processing the 'raddb/hints' and the
-       #  'raddb/huntgroups' files.
+       #  It takes care of processing the 'raddb/mods-config/preprocess/hints' 
+       #  and the 'raddb/mods-config/preprocess/huntgroups' files.
        preprocess
 
        #  If you intend to use CUI and you require that the Operator-Name
        #  be set for CUI generation and you want to generate CUI also
        #  for your local clients then uncomment the operator-name
        #  below and set the operator-name for your clients in clients.conf
-#       operator-name
+#      operator-name
 
        #
        #  If you want to generate CUI for some clients that do not
-       #  send proper CUI requiests, then uncomment the
-       #  cui below and set "add-cui = yes" for these clients in clients.conf
-#       cui
+       #  send proper CUI requests, then uncomment the
+       #  cui below and set "add_cui = yes" for these clients in clients.conf
+#      cui
 
        #
        #  If you want to have a log of authentication requests,
-       #  un-comment the following line, and the 'detail auth_log'
-       #  section, above.
+       #  un-comment the following line.
 #      auth_log
 
        #
@@ -304,15 +347,14 @@ authorize {
        #  It also sets the EAP-Type attribute in the request
        #  attribute list to the EAP type from the packet.
        #
-       #  As of 2.0, the EAP module returns "ok" in the authorize stage
-       #  for TTLS and PEAP.  In 1.x, it never returned "ok" here, so
-       #  this change is compatible with older configurations.
+       #  The EAP module returns "ok" if it is not yet ready to
+       #  authenticate the user.  The configuration below checks for
+       #  that code, and stops processing the "authorize" section if
+       #  so.
        #
-       #  The example below uses module failover to avoid querying all
-       #  of the following modules if the EAP module returns "ok".
-       #  Therefore, your LDAP and/or SQL servers will not be queried
-       #  for the many packets that go back and forth to set up TTLS
-       #  or PEAP.  The load on those servers will therefore be reduced.
+       #  Any LDAP and/or SQL servers will not be queried for the
+       #  initial set of packets that go back and forth to set up
+       #  TTLS or PEAP.
        #
        eap {
                ok = return
@@ -322,19 +364,20 @@ authorize {
        #  Pull crypt'd passwords from /etc/passwd or /etc/shadow,
        #  using the system API's to get the password.  If you want
        #  to read /etc/passwd or /etc/shadow directly, see the
-       #  passwd module in radiusd.conf.
+       #  mods-available/passwd module.
        #
 #      unix
 
        #
-       #  Read the 'users' file
+       #  Read the 'users' file.  In v3, this is located in
+       #  raddb/mods-config/files/authorize
        files
 
        #
        #  Look in an SQL database.  The schema of the database
        #  is meant to mirror the "users" file.
        #
-       #  See "Authorization Queries" in sql.conf
+       #  See "Authorization Queries" in mods-available/sql
        -sql
 
        #
@@ -387,7 +430,7 @@ authorize {
 #  Note that it does NOT mean 'try each module in order'.  It means
 #  that a module from the 'authorize' section adds a configuration
 #  attribute 'Auth-Type := FOO'.  That authentication type is then
-#  used to pick the apropriate module from the list below.
+#  used to pick the appropriate module from the list below.
 #
 
 #  In general, you SHOULD NOT set the Auth-Type attribute.  The server
@@ -431,6 +474,11 @@ authenticate {
        }
 
        #
+       #  For old names, too.
+       #
+       mschap
+
+       #
        #  If you have a Cisco SIP server authenticating against
        #  FreeRADIUS, uncomment the following line, and the 'digest'
        #  line in the 'authorize' section.
@@ -467,7 +515,7 @@ authenticate {
        #
 #      Auth-Type eap {
 #              eap {
-#                      handled = 1  
+#                      handled = 1
 #              }
 #              if (handled && (Response-Packet-Type == Access-Challenge)) {
 #                      attr_filter.access_challenge.post-auth
@@ -484,6 +532,12 @@ preacct {
        preprocess
 
        #
+       #  Merge Acct-[Input|Output]-Gigawords and Acct-[Input-Output]-Octets
+       #  into a single 64bit counter Acct-[Input|Output]-Octets64.
+       #
+#      acct_counters64
+
+       #
        #  Session start times are *implied* in RADIUS.
        #  The NAS never sends a "start time".  Instead, it sends
        #  a start packet, *possibly* with an Acct-Delay-Time.
@@ -531,7 +585,7 @@ accounting {
        #  Update accounting packet by adding the CUI attribute
        #  recorded from the corresponding Access-Accept
        #  use it only if your NAS boxes do not support CUI themselves
-#       cui
+#      cui
        #
        #  Create a 'detail'ed log of the packets.
        #  Note that accounting requests which are proxied
@@ -558,7 +612,7 @@ accounting {
        #
        #  Log traffic to an SQL database.
        #
-       #  See "Accounting queries" in sql.conf
+       #  See "Accounting queries" in mods-available/sql
        -sql
 
        #
@@ -599,14 +653,14 @@ accounting {
 }
 
 
-#  Session database, used for checking Simultaneous-Use. Either the radutmp 
+#  Session database, used for checking Simultaneous-Use. Either the radutmp
 #  or rlm_sql module can handle this.
 #  The rlm_sql module is *much* faster
 session {
 #      radutmp
 
        #
-       #  See "Simultaneous Use Checking Queries" in sql.conf
+       #  See "Simultaneous Use Checking Queries" in mods-available/sql
 #      sql
 }
 
@@ -615,13 +669,37 @@ session {
 #  Once we KNOW that the user has been authenticated, there are
 #  additional steps we can take.
 post-auth {
+       #
+       #  If you need to have a State attribute, you can
+       #  add it here.  e.g. for later CoA-Request with
+       #  State, and Service-Type = Authorize-Only.
+       #
+#      if (!&reply:State) {
+#              update reply {
+#                      State := "0x%{randstr:16h}"
+#              }
+#      }
+
+       #
+       #  For EAP-TTLS and PEAP, add the cached attributes to the reply.
+       #  The "session-state" attributes are automatically cached when
+       #  an Access-Challenge is sent, and automatically retrieved
+       #  when an Access-Request is received.
+       #
+       #  The session-state attributes are automatically deleted after
+       #  an Access-Reject or Access-Accept is sent.
+       #
+       update {
+               &reply: += &session-state:
+       }
+
        #  Get an address from the IP Pool.
 #      main_pool
 
 
        #  Create the CUI value and add the attribute to Access-Accept.
        #  Uncomment the line below if *returning* the CUI.
-#       cui
+#      cui
 
        #
        #  If you want to have a log of authentication replies,
@@ -632,7 +710,7 @@ post-auth {
        #
        #  After authenticating the user, do another SQL query.
        #
-       #  See "Authentication Logging Queries" in sql.conf
+       #  See "Authentication Logging Queries" in mods-available/sql
        -sql
 
        #
@@ -718,9 +796,9 @@ post-auth {
        #
        #  Uncomment the next few lines to copy the required data into
        #  the EAP-Key-Name attribute
-#      if (reply:EAP-Session-Id) {
+#      if (&reply:EAP-Session-Id) {
 #              update reply {
-#                      EAP-Key-Name := "%{reply:EAP-Session-Id}"
+#                      EAP-Key-Name := &reply:EAP-Session-Id
 #              }
 #      }
 
@@ -731,9 +809,11 @@ post-auth {
        #  Access-Reject packets are sent through the REJECT sub-section of the
        #  post-auth section.
        #
-       #  Add the ldap module name (or instance) if you have set 
+       #  Add the ldap module name (or instance) if you have set
        #  'edir_account_policy_check = yes' in the ldap module configuration
        #
+       #  The "session-state" attributes are not available here.
+       #
        Post-Auth-Type REJECT {
                # log failed authentications in SQL, too.
                -sql
@@ -762,12 +842,12 @@ pre-proxy {
        # if the operator-name is found for this client.
        # No need to uncomment this if you have already enabled this in
        # the authorize section.
-#       operator-name
+#      operator-name
 
        #  The client requests the CUI by sending a CUI attribute
        #  containing one zero byte.
        #  Uncomment the line below if *requesting* the CUI.
-#       cui
+#      cui
 
        #  Uncomment the following line if you want to change attributes
        #  as defined in the preproxy_users file.
@@ -830,7 +910,7 @@ post-proxy {
        #  Accounting-Requests from the NAS, but only writes
        #  accounting packets to disk if the home server is down.
        #
-#      Post-Proxy-Type Fail {
+#      Post-Proxy-Type Fail-Accounting {
 #                      detail
 #      }
 }