Add more rants for people who think that destroying the default
[freeradius.git] / raddb / sites-available / default
1 ######################################################################
2 #
3 #       As of 2.0.0, FreeRADIUS supports virtual hosts using the
4 #       "server" section, and configuration directives.
5 #
6 #       Virtual hosts should be put into the "sites-available"
7 #       directory.  Soft links should be created in the "sites-enabled"
8 #       directory to these files.  This is done in a normal installation.
9 #
10 #       $Id$
11 #
12 ######################################################################
13 #
14 #       Read "man radiusd" before editing this file.  See the section
15 #       titled DEBUGGING.  It outlines a method where you can quickly
16 #       obtain the configuration you want, without running into
17 #       trouble.  See also "man unlang", which documents the format
18 #       of this file.
19 #
20 #       This configuration is designed to work in the widest possible
21 #       set of circumstances, with the widest possible number of
22 #       authentication methods.  This means that in general, you should
23 #       need to make very few changes to this file.
24 #
25 #       The best way to configure the server for your local system
26 #       is to CAREFULLY edit this file.  Most attempts to make large
27 #       edits to this file will BREAK THE SERVER.  Any edits should
28 #       be small, and tested by running the server with "radiusd -X".
29 #       Once the edits have been verified to work, save a copy of these
30 #       configuration files somewhere.  (e.g. as a "tar" file).  Then,
31 #       make more edits, and test, as above.
32 #
33 #       There are many "commented out" references to modules such
34 #       as ldap, sql, etc.  These references serve as place-holders.
35 #       If you need the functionality of that module, then configure
36 #       it in radiusd.conf, and un-comment the references to it in
37 #       this file.  In most cases, those small changes will result
38 #       in the server being able to connect to the DB, and to
39 #       authenticate users.
40 #
41 ######################################################################
42
43 #
44 #       In 1.x, the "authorize", etc. sections were global in
45 #       radiusd.conf.  As of 2.0, they SHOULD be in a server section.
46 #
47 #       The server section with no virtual server name is the "default"
48 #       section.  It is used when no server name is specified.
49 #
50 #       We don't indent the rest of this file, because doing so
51 #       would make it harder to read.
52 #
53
54 #  Authorization. First preprocess (hints and huntgroups files),
55 #  then realms, and finally look in the "users" file.
56 #
57 #  The order of the realm modules will determine the order that
58 #  we try to find a matching realm.
59 #
60 #  Make *sure* that 'preprocess' comes before any realm if you 
61 #  need to setup hints for the remote radius server
62 authorize {
63         #
64         #  The preprocess module takes care of sanitizing some bizarre
65         #  attributes in the request, and turning them into attributes
66         #  which are more standard.
67         #
68         #  It takes care of processing the 'raddb/hints' and the
69         #  'raddb/huntgroups' files.
70         #
71         #  It also adds the %{Client-IP-Address} attribute to the request.
72         preprocess
73
74         #
75         #  If you want to have a log of authentication requests,
76         #  un-comment the following line, and the 'detail auth_log'
77         #  section, above.
78 #       auth_log
79
80         #
81         #  The chap module will set 'Auth-Type := CHAP' if we are
82         #  handling a CHAP request and Auth-Type has not already been set
83         chap
84
85         #
86         #  If the users are logging in with an MS-CHAP-Challenge
87         #  attribute for authentication, the mschap module will find
88         #  the MS-CHAP-Challenge attribute, and add 'Auth-Type := MS-CHAP'
89         #  to the request, which will cause the server to then use
90         #  the mschap module for authentication.
91         mschap
92
93         #
94         #  If you have a Cisco SIP server authenticating against
95         #  FreeRADIUS, uncomment the following line, and the 'digest'
96         #  line in the 'authenticate' section.
97 #       digest
98
99         #
100         #  Look for IPASS style 'realm/', and if not found, look for
101         #  '@realm', and decide whether or not to proxy, based on
102         #  that.
103 #       IPASS
104
105         #
106         #  If you are using multiple kinds of realms, you probably
107         #  want to set "ignore_null = yes" for all of them.
108         #  Otherwise, when the first style of realm doesn't match,
109         #  the other styles won't be checked.
110         #
111         suffix
112 #       ntdomain
113
114         #
115         #  This module takes care of EAP-MD5, EAP-TLS, and EAP-LEAP
116         #  authentication.
117         #
118         #  It also sets the EAP-Type attribute in the request
119         #  attribute list to the EAP type from the packet.
120         #
121         #  As of 2.0, the EAP module returns "ok" in the authorize stage
122         #  for TTLS and PEAP.  In 1.x, it never returned "ok" here, so
123         #  this change is compatible with older configurations.
124         #
125         #  The example below uses module failover to avoid querying all
126         #  of the following modules if the EAP module returns "ok".
127         #  Therefore, your LDAP and/or SQL servers will not be queried
128         #  for the many packets that go back and forth to set up TTLS
129         #  or PEAP.  The load on those servers will therefore be reduced.
130         #
131         eap {
132                 ok = return
133         }
134
135         #
136         #  Pull crypt'd passwords from /etc/passwd or /etc/shadow,
137         #  using the system API's to get the password.  If you want
138         #  to read /etc/passwd or /etc/shadow directly, see the
139         #  passwd module in radiusd.conf.
140         #
141         unix
142
143         #
144         #  Read the 'users' file
145         files
146
147         #
148         #  Look in an SQL database.  The schema of the database
149         #  is meant to mirror the "users" file.
150         #
151         #  See "Authorization Queries" in sql.conf
152 #       sql
153
154         #
155         #  If you are using /etc/smbpasswd, and are also doing
156         #  mschap authentication, the un-comment this line, and
157         #  configure the 'etc_smbpasswd' module, above.
158 #       etc_smbpasswd
159
160         #
161         #  The ldap module will set Auth-Type to LDAP if it has not
162         #  already been set
163 #       ldap
164
165         #
166         #  Enforce daily limits on time spent logged in.
167 #       daily
168
169         #
170         # Use the checkval module
171 #       checkval
172
173         expiration
174         logintime
175
176         #
177         #  If no other module has claimed responsibility for
178         #  authentication, then try to use PAP.  This allows the
179         #  other modules listed above to add a "known good" password
180         #  to the request, and to do nothing else.  The PAP module
181         #  will then see that password, and use it to do PAP
182         #  authentication.
183         #
184         #  This module should be listed last, so that the other modules
185         #  get a chance to set Auth-Type for themselves.
186         #
187         pap
188
189         #
190         #  If "status_server = yes", then Status-Server messages are passed
191         #  through the following section, and ONLY the following section.
192         #  This permits you to do DB queries, for example.  If the modules
193         #  listed here return "fail", then NO response is sent.
194         #
195 #       Autz-Type Status-Server {
196 #
197 #       }
198 }
199
200
201 #  Authentication.
202 #
203 #
204 #  This section lists which modules are available for authentication.
205 #  Note that it does NOT mean 'try each module in order'.  It means
206 #  that a module from the 'authorize' section adds a configuration
207 #  attribute 'Auth-Type := FOO'.  That authentication type is then
208 #  used to pick the apropriate module from the list below.
209 #
210
211 #  In general, you SHOULD NOT set the Auth-Type attribute.  The server
212 #  will figure it out on its own, and will do the right thing.  The
213 #  most common side effect of erroneously setting the Auth-Type
214 #  attribute is that one authentication method will work, but the
215 #  others will not.
216 #
217 #  The common reasons to set the Auth-Type attribute by hand
218 #  is to either forcibly reject the user (Auth-Type := Reject),
219 #  or to or forcibly accept the user (Auth-Type := Accept).
220 #
221 #  Note that Auth-Type := Accept will NOT work with EAP.
222 #
223 #  Please do not put "unlang" configurations into the "authenticate"
224 #  section.  Put them in the "post-auth" section instead.  That's what
225 #  the post-auth section is for.
226 #
227 authenticate {
228         #
229         #  PAP authentication, when a back-end database listed
230         #  in the 'authorize' section supplies a password.  The
231         #  password can be clear-text, or encrypted.
232         Auth-Type PAP {
233                 pap
234         }
235
236         #
237         #  Most people want CHAP authentication
238         #  A back-end database listed in the 'authorize' section
239         #  MUST supply a CLEAR TEXT password.  Encrypted passwords
240         #  won't work.
241         Auth-Type CHAP {
242                 chap
243         }
244
245         #
246         #  MSCHAP authentication.
247         Auth-Type MS-CHAP {
248                 mschap
249         }
250
251         #
252         #  If you have a Cisco SIP server authenticating against
253         #  FreeRADIUS, uncomment the following line, and the 'digest'
254         #  line in the 'authorize' section.
255 #       digest
256
257         #
258         #  Pluggable Authentication Modules.
259 #       pam
260
261         #
262         #  See 'man getpwent' for information on how the 'unix'
263         #  module checks the users password.  Note that packets
264         #  containing CHAP-Password attributes CANNOT be authenticated
265         #  against /etc/passwd!  See the FAQ for details.
266         #  
267         unix
268
269         # Uncomment it if you want to use ldap for authentication
270         #
271         # Note that this means "check plain-text password against
272         # the ldap database", which means that EAP won't work,
273         # as it does not supply a plain-text password.
274 #       Auth-Type LDAP {
275 #               ldap
276 #       }
277
278         #
279         #  Allow EAP authentication.
280         eap
281 }
282
283
284 #
285 #  Pre-accounting.  Decide which accounting type to use.
286 #
287 preacct {
288         preprocess
289
290         #
291         #  Ensure that we have a semi-unique identifier for every
292         #  request, and many NAS boxes are broken.
293         acct_unique
294
295         #
296         #  Look for IPASS-style 'realm/', and if not found, look for
297         #  '@realm', and decide whether or not to proxy, based on
298         #  that.
299         #
300         #  Accounting requests are generally proxied to the same
301         #  home server as authentication requests.
302 #       IPASS
303         suffix
304 #       ntdomain
305
306         #
307         #  Read the 'acct_users' file
308         files
309 }
310
311 #
312 #  Accounting.  Log the accounting data.
313 #
314 accounting {
315         #
316         #  Create a 'detail'ed log of the packets.
317         #  Note that accounting requests which are proxied
318         #  are also logged in the detail file.
319         detail
320 #       daily
321
322         #  Update the wtmp file
323         #
324         #  If you don't use "radlast", you can delete this line.
325         unix
326
327         #
328         #  For Simultaneous-Use tracking.
329         #
330         #  Due to packet losses in the network, the data here
331         #  may be incorrect.  There is little we can do about it.
332         radutmp
333 #       sradutmp
334
335         #  Return an address to the IP Pool when we see a stop record.
336 #       main_pool
337
338         #
339         #  Log traffic to an SQL database.
340         #
341         #  See "Accounting queries" in sql.conf
342 #       sql
343
344         #
345         #  Instead of sending the query to the SQL server,
346         #  write it into a log file.
347         #
348 #       sql_log
349
350         #  Cisco VoIP specific bulk accounting
351 #       pgsql-voip
352
353         #  Filter attributes from the accounting response.
354         attr_filter.accounting_response
355
356         #
357         #  See "Autz-Type Status-Server" for how this works.
358         #
359 #       Acct-Type Status-Server {
360 #
361 #       }
362 }
363
364
365 #  Session database, used for checking Simultaneous-Use. Either the radutmp 
366 #  or rlm_sql module can handle this.
367 #  The rlm_sql module is *much* faster
368 session {
369         radutmp
370
371         #
372         #  See "Simultaneous Use Checking Queries" in sql.conf
373 #       sql
374 }
375
376
377 #  Post-Authentication
378 #  Once we KNOW that the user has been authenticated, there are
379 #  additional steps we can take.
380 post-auth {
381         #  Get an address from the IP Pool.
382 #       main_pool
383
384         #
385         #  If you want to have a log of authentication replies,
386         #  un-comment the following line, and the 'detail reply_log'
387         #  section, above.
388 #       reply_log
389
390         #
391         #  After authenticating the user, do another SQL query.
392         #
393         #  See "Authentication Logging Queries" in sql.conf
394 #       sql
395
396         #
397         #  Instead of sending the query to the SQL server,
398         #  write it into a log file.
399         #
400 #       sql_log
401
402         #
403         #  Un-comment the following if you have set
404         #  'edir_account_policy_check = yes' in the ldap module sub-section of
405         #  the 'modules' section.
406         #
407 #       ldap
408
409         exec
410
411         #
412         #  Access-Reject packets are sent through the REJECT sub-section of the
413         #  post-auth section.
414         #
415         #  Add the ldap module name (or instance) if you have set 
416         #  'edir_account_policy_check = yes' in the ldap module configuration
417         #
418         Post-Auth-Type REJECT {
419                 attr_filter.access_reject
420         }
421 }
422
423 #
424 #  When the server decides to proxy a request to a home server,
425 #  the proxied request is first passed through the pre-proxy
426 #  stage.  This stage can re-write the request, or decide to
427 #  cancel the proxy.
428 #
429 #  Only a few modules currently have this method.
430 #
431 pre-proxy {
432 #       attr_rewrite
433
434         #  Uncomment the following line if you want to change attributes
435         #  as defined in the preproxy_users file.
436 #       files
437
438         #  Uncomment the following line if you want to filter requests
439         #  sent to remote servers based on the rules defined in the
440         #  'attrs.pre-proxy' file.
441 #       attr_filter.pre-proxy
442
443         #  If you want to have a log of packets proxied to a home
444         #  server, un-comment the following line, and the
445         #  'detail pre_proxy_log' section, above.
446 #       pre_proxy_log
447 }
448
449 #
450 #  When the server receives a reply to a request it proxied
451 #  to a home server, the request may be massaged here, in the
452 #  post-proxy stage.
453 #
454 post-proxy {
455
456         #  If you want to have a log of replies from a home server,
457         #  un-comment the following line, and the 'detail post_proxy_log'
458         #  section, above.
459 #       post_proxy_log
460
461 #       attr_rewrite
462
463         #  Uncomment the following line if you want to filter replies from
464         #  remote proxies based on the rules defined in the 'attrs' file.
465 #       attr_filter.post-proxy
466
467         #
468         #  If you are proxying LEAP, you MUST configure the EAP
469         #  module, and you MUST list it here, in the post-proxy
470         #  stage.
471         #
472         #  You MUST also use the 'nostrip' option in the 'realm'
473         #  configuration.  Otherwise, the User-Name attribute
474         #  in the proxied request will not match the user name
475         #  hidden inside of the EAP packet, and the end server will
476         #  reject the EAP request.
477         #
478         eap
479
480         #
481         #  If the server tries to proxy a request and fails, then the
482         #  request is processed through the modules in this section.
483         #
484         #  The main use of this section is to permit robust proxying
485         #  of accounting packets.  The server can be configured to
486         #  proxy accounting packets as part of normal processing.
487         #  Then, if the home server goes down, accounting packets can
488         #  be logged to a local "detail" file, for processing with
489         #  radrelay.  When the home server comes back up, radrelay
490         #  will read the detail file, and send the packets to the
491         #  home server.
492         #
493         #  With this configuration, the server always responds to
494         #  Accounting-Requests from the NAS, but only writes
495         #  accounting packets to disk if the home server is down.
496         #
497 #       Post-Proxy-Type Fail {
498 #                       detail
499 #       }
500
501 }
502