Fixed typo
[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         #  The WiMAX specification says that the Calling-Station-Id
101         #  is 6 octets of the MAC.  This definition conflicts with
102         #  RFC 3580, and all common RADIUS practices.  Un-commenting
103         #  the "wimax" module here means that it will fix the
104         #  Calling-Station-Id attribute to the normal format as
105         #  specified in RFC 3580 Section 3.21
106 #       wimax
107
108         #
109         #  Look for IPASS style 'realm/', and if not found, look for
110         #  '@realm', and decide whether or not to proxy, based on
111         #  that.
112 #       IPASS
113
114         #
115         #  If you are using multiple kinds of realms, you probably
116         #  want to set "ignore_null = yes" for all of them.
117         #  Otherwise, when the first style of realm doesn't match,
118         #  the other styles won't be checked.
119         #
120         suffix
121 #       ntdomain
122
123         #
124         #  This module takes care of EAP-MD5, EAP-TLS, and EAP-LEAP
125         #  authentication.
126         #
127         #  It also sets the EAP-Type attribute in the request
128         #  attribute list to the EAP type from the packet.
129         #
130         #  As of 2.0, the EAP module returns "ok" in the authorize stage
131         #  for TTLS and PEAP.  In 1.x, it never returned "ok" here, so
132         #  this change is compatible with older configurations.
133         #
134         #  The example below uses module failover to avoid querying all
135         #  of the following modules if the EAP module returns "ok".
136         #  Therefore, your LDAP and/or SQL servers will not be queried
137         #  for the many packets that go back and forth to set up TTLS
138         #  or PEAP.  The load on those servers will therefore be reduced.
139         #
140         eap {
141                 ok = return
142         }
143
144         #
145         #  Pull crypt'd passwords from /etc/passwd or /etc/shadow,
146         #  using the system API's to get the password.  If you want
147         #  to read /etc/passwd or /etc/shadow directly, see the
148         #  passwd module in radiusd.conf.
149         #
150         unix
151
152         #
153         #  Read the 'users' file
154         files
155
156         #
157         #  Look in an SQL database.  The schema of the database
158         #  is meant to mirror the "users" file.
159         #
160         #  See "Authorization Queries" in sql.conf
161 #       sql
162
163         #
164         #  If you are using /etc/smbpasswd, and are also doing
165         #  mschap authentication, the un-comment this line, and
166         #  configure the 'etc_smbpasswd' module, above.
167 #       etc_smbpasswd
168
169         #
170         #  The ldap module will set Auth-Type to LDAP if it has not
171         #  already been set
172 #       ldap
173
174         #
175         #  Enforce daily limits on time spent logged in.
176 #       daily
177
178         #
179         # Use the checkval module
180 #       checkval
181
182         expiration
183         logintime
184
185         #
186         #  If no other module has claimed responsibility for
187         #  authentication, then try to use PAP.  This allows the
188         #  other modules listed above to add a "known good" password
189         #  to the request, and to do nothing else.  The PAP module
190         #  will then see that password, and use it to do PAP
191         #  authentication.
192         #
193         #  This module should be listed last, so that the other modules
194         #  get a chance to set Auth-Type for themselves.
195         #
196         pap
197
198         #
199         #  If "status_server = yes", then Status-Server messages are passed
200         #  through the following section, and ONLY the following section.
201         #  This permits you to do DB queries, for example.  If the modules
202         #  listed here return "fail", then NO response is sent.
203         #
204 #       Autz-Type Status-Server {
205 #
206 #       }
207 }
208
209
210 #  Authentication.
211 #
212 #
213 #  This section lists which modules are available for authentication.
214 #  Note that it does NOT mean 'try each module in order'.  It means
215 #  that a module from the 'authorize' section adds a configuration
216 #  attribute 'Auth-Type := FOO'.  That authentication type is then
217 #  used to pick the apropriate module from the list below.
218 #
219
220 #  In general, you SHOULD NOT set the Auth-Type attribute.  The server
221 #  will figure it out on its own, and will do the right thing.  The
222 #  most common side effect of erroneously setting the Auth-Type
223 #  attribute is that one authentication method will work, but the
224 #  others will not.
225 #
226 #  The common reasons to set the Auth-Type attribute by hand
227 #  is to either forcibly reject the user (Auth-Type := Reject),
228 #  or to or forcibly accept the user (Auth-Type := Accept).
229 #
230 #  Note that Auth-Type := Accept will NOT work with EAP.
231 #
232 #  Please do not put "unlang" configurations into the "authenticate"
233 #  section.  Put them in the "post-auth" section instead.  That's what
234 #  the post-auth section is for.
235 #
236 authenticate {
237         #
238         #  PAP authentication, when a back-end database listed
239         #  in the 'authorize' section supplies a password.  The
240         #  password can be clear-text, or encrypted.
241         Auth-Type PAP {
242                 pap
243         }
244
245         #
246         #  Most people want CHAP authentication
247         #  A back-end database listed in the 'authorize' section
248         #  MUST supply a CLEAR TEXT password.  Encrypted passwords
249         #  won't work.
250         Auth-Type CHAP {
251                 chap
252         }
253
254         #
255         #  MSCHAP authentication.
256         Auth-Type MS-CHAP {
257                 mschap
258         }
259
260         #
261         #  If you have a Cisco SIP server authenticating against
262         #  FreeRADIUS, uncomment the following line, and the 'digest'
263         #  line in the 'authorize' section.
264 #       digest
265
266         #
267         #  Pluggable Authentication Modules.
268 #       pam
269
270         #
271         #  See 'man getpwent' for information on how the 'unix'
272         #  module checks the users password.  Note that packets
273         #  containing CHAP-Password attributes CANNOT be authenticated
274         #  against /etc/passwd!  See the FAQ for details.
275         #  
276         unix
277
278         # Uncomment it if you want to use ldap for authentication
279         #
280         # Note that this means "check plain-text password against
281         # the ldap database", which means that EAP won't work,
282         # as it does not supply a plain-text password.
283 #       Auth-Type LDAP {
284 #               ldap
285 #       }
286
287         #
288         #  Allow EAP authentication.
289         eap
290
291         #
292         #  The older configurations sent a number of attributes in
293         #  Access-Challenge packets, which wasn't strictly correct.
294         #  If you want to filter out these attributes, uncomment
295         #  the following lines.
296         #
297 #       Auth-Type eap {
298 #               eap {
299 #                       handled = 1  
300 #               }
301 #               if (handled && (Response-Packet-Type == Access-Challenge)) {
302 #                       attr_filter.access_challenge.post-auth
303 #                       handled  # override the "updated" code from attr_filter
304 #               }
305 #       }
306 }
307
308
309 #
310 #  Pre-accounting.  Decide which accounting type to use.
311 #
312 preacct {
313         preprocess
314
315         #
316         #  Ensure that we have a semi-unique identifier for every
317         #  request, and many NAS boxes are broken.
318         acct_unique
319
320         #
321         #  Look for IPASS-style 'realm/', and if not found, look for
322         #  '@realm', and decide whether or not to proxy, based on
323         #  that.
324         #
325         #  Accounting requests are generally proxied to the same
326         #  home server as authentication requests.
327 #       IPASS
328         suffix
329 #       ntdomain
330
331         #
332         #  Read the 'acct_users' file
333         files
334 }
335
336 #
337 #  Accounting.  Log the accounting data.
338 #
339 accounting {
340         #
341         #  Create a 'detail'ed log of the packets.
342         #  Note that accounting requests which are proxied
343         #  are also logged in the detail file.
344         detail
345 #       daily
346
347         #  Update the wtmp file
348         #
349         #  If you don't use "radlast", you can delete this line.
350         unix
351
352         #
353         #  For Simultaneous-Use tracking.
354         #
355         #  Due to packet losses in the network, the data here
356         #  may be incorrect.  There is little we can do about it.
357         radutmp
358 #       sradutmp
359
360         #  Return an address to the IP Pool when we see a stop record.
361 #       main_pool
362
363         #
364         #  Log traffic to an SQL database.
365         #
366         #  See "Accounting queries" in sql.conf
367 #       sql
368
369         #
370         #  Instead of sending the query to the SQL server,
371         #  write it into a log file.
372         #
373 #       sql_log
374
375         #  Cisco VoIP specific bulk accounting
376 #       pgsql-voip
377
378         #  Filter attributes from the accounting response.
379         attr_filter.accounting_response
380
381         #
382         #  See "Autz-Type Status-Server" for how this works.
383         #
384 #       Acct-Type Status-Server {
385 #
386 #       }
387 }
388
389
390 #  Session database, used for checking Simultaneous-Use. Either the radutmp 
391 #  or rlm_sql module can handle this.
392 #  The rlm_sql module is *much* faster
393 session {
394         radutmp
395
396         #
397         #  See "Simultaneous Use Checking Queries" in sql.conf
398 #       sql
399 }
400
401
402 #  Post-Authentication
403 #  Once we KNOW that the user has been authenticated, there are
404 #  additional steps we can take.
405 post-auth {
406         #  Get an address from the IP Pool.
407 #       main_pool
408
409         #
410         #  If you want to have a log of authentication replies,
411         #  un-comment the following line, and the 'detail reply_log'
412         #  section, above.
413 #       reply_log
414
415         #
416         #  After authenticating the user, do another SQL query.
417         #
418         #  See "Authentication Logging Queries" in sql.conf
419 #       sql
420
421         #
422         #  Instead of sending the query to the SQL server,
423         #  write it into a log file.
424         #
425 #       sql_log
426
427         #
428         #  Un-comment the following if you have set
429         #  'edir_account_policy_check = yes' in the ldap module sub-section of
430         #  the 'modules' section.
431         #
432 #       ldap
433
434         exec
435
436         #
437         #  Calculate the various WiMAX keys.  In order for this to work,
438         #  you will need to define the WiMAX NAI, usually via
439         #
440         #       update request {
441         #              WiMAX-MN-NAI = "%{User-Name}"
442         #       }
443         #
444         #  If you want various keys to be calculated, you will need to
445         #  update the reply with "template" values.  The module will see
446         #  this, and replace the template values with the correct ones
447         #  taken from the cryptographic calculations.  e.g.
448         #
449         #       update reply {
450         #               WiMAX-FA-RK-Key = 0x00
451         #               WiMAX-MSK = "%{EAP-MSK}"
452         #       }
453         #
454         #  You may want to delete the MS-MPPE-*-Keys from the reply,
455         #  as some WiMAX clients behave badly when those attributes
456         #  are included.  See "raddb/modules/wimax", configuration
457         #  entry "delete_mppe_keys" for more information.
458         #
459 #       wimax
460
461         #  If the WiMAX module did it's work, you may want to do more
462         #  things here, like delete the MS-MPPE-*-Key attributes.
463         #
464         #       if (updated) {
465         #               update reply {
466         #                       MS-MPPE-Recv-Key !* 0x00
467         #                       MS-MPPE-Send-Key !* 0x00
468         #               }
469         #       }
470
471         #
472         #  Access-Reject packets are sent through the REJECT sub-section of the
473         #  post-auth section.
474         #
475         #  Add the ldap module name (or instance) if you have set 
476         #  'edir_account_policy_check = yes' in the ldap module configuration
477         #
478         Post-Auth-Type REJECT {
479                 attr_filter.access_reject
480         }
481 }
482
483 #
484 #  When the server decides to proxy a request to a home server,
485 #  the proxied request is first passed through the pre-proxy
486 #  stage.  This stage can re-write the request, or decide to
487 #  cancel the proxy.
488 #
489 #  Only a few modules currently have this method.
490 #
491 pre-proxy {
492 #       attr_rewrite
493
494         #  Uncomment the following line if you want to change attributes
495         #  as defined in the preproxy_users file.
496 #       files
497
498         #  Uncomment the following line if you want to filter requests
499         #  sent to remote servers based on the rules defined in the
500         #  'attrs.pre-proxy' file.
501 #       attr_filter.pre-proxy
502
503         #  If you want to have a log of packets proxied to a home
504         #  server, un-comment the following line, and the
505         #  'detail pre_proxy_log' section, above.
506 #       pre_proxy_log
507 }
508
509 #
510 #  When the server receives a reply to a request it proxied
511 #  to a home server, the request may be massaged here, in the
512 #  post-proxy stage.
513 #
514 post-proxy {
515
516         #  If you want to have a log of replies from a home server,
517         #  un-comment the following line, and the 'detail post_proxy_log'
518         #  section, above.
519 #       post_proxy_log
520
521 #       attr_rewrite
522
523         #  Uncomment the following line if you want to filter replies from
524         #  remote proxies based on the rules defined in the 'attrs' file.
525 #       attr_filter.post-proxy
526
527         #
528         #  If you are proxying LEAP, you MUST configure the EAP
529         #  module, and you MUST list it here, in the post-proxy
530         #  stage.
531         #
532         #  You MUST also use the 'nostrip' option in the 'realm'
533         #  configuration.  Otherwise, the User-Name attribute
534         #  in the proxied request will not match the user name
535         #  hidden inside of the EAP packet, and the end server will
536         #  reject the EAP request.
537         #
538         eap
539
540         #
541         #  If the server tries to proxy a request and fails, then the
542         #  request is processed through the modules in this section.
543         #
544         #  The main use of this section is to permit robust proxying
545         #  of accounting packets.  The server can be configured to
546         #  proxy accounting packets as part of normal processing.
547         #  Then, if the home server goes down, accounting packets can
548         #  be logged to a local "detail" file, for processing with
549         #  radrelay.  When the home server comes back up, radrelay
550         #  will read the detail file, and send the packets to the
551         #  home server.
552         #
553         #  With this configuration, the server always responds to
554         #  Accounting-Requests from the NAS, but only writes
555         #  accounting packets to disk if the home server is down.
556         #
557 #       Post-Proxy-Type Fail {
558 #                       detail
559 #       }
560
561 }
562