Pull from CVS head:
[freeradius.git] / raddb / radiusd.conf.in
1 ##
2 ## radiusd.conf -- FreeRADIUS server configuration file.
3 ##
4 ##      http://www.freeradius.org/
5 ##      $Id$
6 ##
7
8 #       The location of other config files and
9 #       logfiles are declared in this file
10 #
11 #       Also general configuration for modules can be done
12 #       in this file, it is exported through the API to
13 #       modules that ask for it.
14 #
15 #       The configuration variables defined here are of the form ${foo}
16 #       They are local to this file, and do not change from request to
17 #       request.
18 #
19 #       The per-request variables are of the form %{Attribute-Name}, and
20 #       are taken from the values of the attribute in the incoming
21 #       request.  See 'doc/variables.txt' for more information.
22
23 prefix = @prefix@
24 exec_prefix = @exec_prefix@
25 sysconfdir = @sysconfdir@
26 localstatedir = @localstatedir@
27 sbindir = @sbindir@
28 logdir = @logdir@
29 raddbdir = @raddbdir@
30 radacctdir = @radacctdir@
31
32 #  Location of config and logfiles.
33 confdir = ${raddbdir}
34 run_dir = ${localstatedir}/run/radiusd
35
36 #
37 #  The logging messages for the server are appended to the
38 #  tail of this file.
39 #
40 log_file = ${logdir}/radius.log
41
42 #
43 # libdir: Where to find the rlm_* modules.
44 #
45 #   This should be automatically set at configuration time.
46 #
47 #   If the server builds and installs, but fails at execution time
48 #   with an 'undefined symbol' error, then you can use the libdir
49 #   directive to work around the problem.
50 #
51 #   The cause is usually that a library has been installed on your
52 #   system in a place where the dynamic linker CANNOT find it.  When
53 #   executing as root (or another user), your personal environment MAY
54 #   be set up to allow the dynamic linker to find the library.  When
55 #   executing as a daemon, FreeRADIUS MAY NOT have the same
56 #   personalized configuration.
57 #
58 #   To work around the problem, find out which library contains that symbol,
59 #   and add the directory containing that library to the end of 'libdir',
60 #   with a colon separating the directory names.  NO spaces are allowed.
61 #
62 #   e.g. libdir = /usr/local/lib:/opt/package/lib
63 #
64 #   You can also try setting the LD_LIBRARY_PATH environment variable
65 #   in a script which starts the server.
66 #
67 #   If that does not work, then you can re-configure and re-build the
68 #   server to NOT use shared libraries, via:
69 #
70 #       ./configure --disable-shared
71 #       make
72 #       make install
73 #
74 libdir = @libdir@
75
76 #  pidfile: Where to place the PID of the RADIUS server.
77 #
78 #  The server may be signalled while it's running by using this
79 #  file.
80 #
81 #  This file is written when ONLY running in daemon mode.
82 #
83 #  e.g.:  kill -HUP `cat /var/run/radiusd/radiusd.pid`
84 #
85 pidfile = ${run_dir}/radiusd.pid
86
87
88 # user/group: The name (or #number) of the user/group to run radiusd as.
89 #
90 #   If these are commented out, the server will run as the user/group
91 #   that started it.  In order to change to a different user/group, you
92 #   MUST be root ( or have root privleges ) to start the server.
93 #
94 #   We STRONGLY recommend that you run the server with as few permissions
95 #   as possible.  That is, if you're not using shadow passwords, the
96 #   user and group items below should be set to 'nobody'.
97 #
98 #    On SCO (ODT 3) use "user = nouser" and "group = nogroup".
99 #
100 #  NOTE that some kernels refuse to setgid(group) when the value of
101 #  (unsigned)group is above 60000; don't use group nobody on these systems!
102 #
103 #  On systems with shadow passwords, you might have to set 'group = shadow'
104 #  for the server to be able to read the shadow password file.  If you can
105 #  authenticate users while in debug mode, but not in daemon mode, it may be
106 #  that the debugging mode server is running as a user that can read the
107 #  shadow info, and the user listed below can not.
108 #
109 #user = nobody
110 #group = nobody
111
112 #  max_request_time: The maximum time (in seconds) to handle a request.
113 #
114 #  Requests which take more time than this to process may be killed, and
115 #  a REJECT message is returned.
116 #
117 #  WARNING: If you notice that requests take a long time to be handled,
118 #  then this MAY INDICATE a bug in the server, in one of the modules
119 #  used to handle a request, OR in your local configuration.
120 #
121 #  This problem is most often seen when using an SQL database.  If it takes
122 #  more than a second or two to receive an answer from the SQL database,
123 #  then it probably means that you haven't indexed the database.  See your
124 #  SQL server documentation for more information.
125 #
126 #  Useful range of values: 5 to 120
127 #
128 max_request_time = 30
129
130 #  delete_blocked_requests: If the request takes MORE THAN 'max_request_time'
131 #  to be handled, then maybe the server should delete it.
132 #
133 #  If you're running in threaded, or thread pool mode, this setting
134 #  should probably be 'no'.  Setting it to 'yes' when using a threaded
135 #  server MAY cause the server to crash!
136 #
137 delete_blocked_requests = no
138
139 #  cleanup_delay: The time to wait (in seconds) before cleaning up
140 #  a reply which was sent to the NAS.
141 #
142 #  The RADIUS request is normally cached internally for a short period
143 #  of time, after the reply is sent to the NAS.  The reply packet may be
144 #  lost in the network, and the NAS will not see it.  The NAS will then
145 #  re-send the request, and the server will respond quickly with the
146 #  cached reply.
147 #
148 #  If this value is set too low, then duplicate requests from the NAS
149 #  MAY NOT be detected, and will instead be handled as seperate requests.
150 #
151 #  If this value is set too high, then the server will cache too many
152 #  requests, and some new requests may get blocked.  (See 'max_requests'.)
153 #
154 #  Useful range of values: 2 to 10
155 #
156 cleanup_delay = 5
157
158 #  max_requests: The maximum number of requests which the server keeps
159 #  track of.  This should be 256 multiplied by the number of clients.
160 #  e.g. With 4 clients, this number should be 1024.
161 #
162 #  If this number is too low, then when the server becomes busy,
163 #  it will not respond to any new requests, until the 'cleanup_delay'
164 #  time has passed, and it has removed the old requests.
165 #
166 #  If this number is set too high, then the server will use a bit more
167 #  memory for no real benefit.
168 #
169 #  If you aren't sure what it should be set to, it's better to set it
170 #  too high than too low.  Setting it to 1000 per client is probably
171 #  the highest it should be.
172 #
173 #  Useful range of values: 256 to infinity
174 #
175 max_requests = 1024
176
177 #  bind_address:  Make the server listen on a particular IP address, and
178 #  send replies out from that address.  This directive is most useful
179 #  for machines with multiple IP addresses on one interface.
180 #
181 #  It can either contain "*", or an IP address, or a fully qualified
182 #  Internet domain name.  The default is "*"
183 #
184 #  As of 1.0, you can also use the "listen" directive.  See below for
185 #  more information.
186 #
187 bind_address = *
188
189 #  port: Allows you to bind FreeRADIUS to a specific port.
190 #
191 #  The default port that most NAS boxes use is 1645, which is historical.
192 #  RFC 2138 defines 1812 to be the new port.  Many new servers and
193 #  NAS boxes use 1812, which can create interoperability problems.
194 #
195 #  The port is defined here to be 0 so that the server will pick up
196 #  the machine's local configuration for the radius port, as defined
197 #  in /etc/services.
198 #
199 #  If you want to use the default RADIUS port as defined on your server,
200 #  (usually through 'grep radius /etc/services') set this to 0 (zero).
201 #
202 #  A port given on the command-line via '-p' over-rides this one.
203 #
204 #  As of 1.0, you can also use the "listen" directive.  See below for
205 #  more information.
206 #
207 port = 0
208
209 #
210 #  By default, the server uses "bind_address" to listen to all IP's
211 #  on a machine, or just one IP.  The "port" configuration is used
212 #  to select the authentication port used when listening on those
213 #  addresses.
214 #
215 #  If you want the server to listen on additional addresses, you can
216 #  use the "listen" section.  A sample section (commented out) is included
217 #  below.  This "listen" section duplicates the functionality of the
218 #  "bind_address" and "port" configuration entries, but it only listens
219 #  for authentication packets.
220 #
221 #  If you comment out the "bind_address" and "port" configuration entries,
222 #  then it becomes possible to make the server accept only accounting,
223 #  or authentication packets.  Previously, it always listened for both
224 #  types of packets, and it was impossible to make it listen for only
225 #  one type of packet.
226 #
227 #listen {
228         #  IP address on which to listen.
229         #  Allowed values are:
230         #       dotted quad (1.2.3.4)
231         #       hostname    (radius.example.com)
232         #       wildcard    (*)
233 #       ipaddr = *
234
235         #  Port on which to listen.
236         #  Allowed values are:
237         #       integer port number (1812)
238         #       0 means "use /etc/services for the proper port"
239 #       port = 0
240
241         #  Type of packets to listen for.
242         #  Allowed values are:
243         #       auth    listen for authentication packets
244         #       acct    listen for accounting packets
245         #
246 #       type = auth
247 #}
248
249
250 #  hostname_lookups: Log the names of clients or just their IP addresses
251 #  e.g., www.freeradius.org (on) or 206.47.27.232 (off).
252 #
253 #  The default is 'off' because it would be overall better for the net
254 #  if people had to knowingly turn this feature on, since enabling it
255 #  means that each client request will result in AT LEAST one lookup
256 #  request to the nameserver.   Enabling hostname_lookups will also
257 #  mean that your server may stop randomly for 30 seconds from time
258 #  to time, if the DNS requests take too long.
259 #
260 #  Turning hostname lookups off also means that the server won't block
261 #  for 30 seconds, if it sees an IP address which has no name associated
262 #  with it.
263 #
264 #  allowed values: {no, yes}
265 #
266 hostname_lookups = no
267
268 #  Core dumps are a bad thing.  This should only be set to 'yes'
269 #  if you're debugging a problem with the server.
270 #
271 #  allowed values: {no, yes}
272 #
273 allow_core_dumps = no
274
275 #  Regular expressions
276 #
277 #  These items are set at configure time.  If they're set to "yes",
278 #  then setting them to "no" turns off regular expression support.
279 #
280 #  If they're set to "no" at configure time, then setting them to "yes"
281 #  WILL NOT WORK.  It will give you an error.
282 #
283 regular_expressions     = @REGEX@
284 extended_expressions    = @REGEX_EXTENDED@
285
286 #  Log the full User-Name attribute, as it was found in the request.
287 #
288 # allowed values: {no, yes}
289 #
290 log_stripped_names = no
291
292 #  Log authentication requests to the log file.
293 #
294 #  allowed values: {no, yes}
295 #
296 log_auth = no
297
298 #  Log passwords with the authentication requests.
299 #  log_auth_badpass  - logs password if it's rejected
300 #  log_auth_goodpass - logs password if it's correct
301 #
302 #  allowed values: {no, yes}
303 #
304 log_auth_badpass = no
305 log_auth_goodpass = no
306
307 # usercollide:  Turn "username collision" code on and off.  See the
308 # "doc/duplicate-users" file
309 #
310 #  WARNING
311 #  !!!!!!!  Setting this to "yes" may result in the server behaving
312 #  !!!!!!!  strangely.  The "username collision" code will ONLY work
313 #  !!!!!!!  with clear-text passwords.  Even then, it may not do what
314 #  !!!!!!!  you want, or what you expect.
315 #  !!!!!!!
316 #  !!!!!!!  We STRONGLY RECOMMEND that you do not use this feature,
317 #  !!!!!!!  and that you find another way of acheiving the same goal.
318 #  !!!!!!!
319 #  !!!!!!!  e,g. module fail-over.  See 'doc/configurable_failover'
320 #  WARNING
321 #
322 usercollide = no
323
324 # lower_user / lower_pass:  
325 # Lower case the username/password "before" or "after"
326 # attempting to authenticate.  
327 #
328 #  If "before", the server will first modify the request and then try
329 #  to auth the user.  If "after", the server will first auth using the
330 #  values provided by the user.  If that fails it will reprocess the
331 #  request after modifying it as you specify below.
332 #
333 #  This is as close as we can get to case insensitivity.  It is the
334 #  admin's job to ensure that the username on the auth db side is
335 #  *also* lowercase to make this work
336 #
337 # Default is 'no' (don't lowercase values)
338 # Valid values = "before" / "after" / "no"
339 #
340 lower_user = no
341 lower_pass = no
342
343 # nospace_user / nospace_pass:
344 #
345 #  Some users like to enter spaces in their username or password
346 #  incorrectly.  To save yourself the tech support call, you can
347 #  eliminate those spaces here:
348 #
349 # Default is 'no' (don't remove spaces)
350 # Valid values = "before" / "after" / "no" (explanation above)
351 #
352 nospace_user = no
353 nospace_pass = no
354
355 #  The program to execute to do concurrency checks.
356 checkrad = ${sbindir}/checkrad
357
358 # SECURITY CONFIGURATION
359 #
360 #  There may be multiple methods of attacking on the server.  This
361 #  section holds the configuration items which minimize the impact
362 #  of those attacks
363 #
364 security {
365         #
366         #  max_attributes: The maximum number of attributes
367         #  permitted in a RADIUS packet.  Packets which have MORE
368         #  than this number of attributes in them will be dropped.
369         #
370         #  If this number is set too low, then no RADIUS packets
371         #  will be accepted.
372         #
373         #  If this number is set too high, then an attacker may be
374         #  able to send a small number of packets which will cause
375         #  the server to use all available memory on the machine.
376         #
377         #  Setting this number to 0 means "allow any number of attributes"
378         max_attributes = 200
379
380         #
381         #  reject_delay: When sending an Access-Reject, it can be
382         #  delayed for a few seconds.  This may help slow down a DoS
383         #  attack.  It also helps to slow down people trying to brute-force
384         #  crack a users password.
385         #
386         #  Setting this number to 0 means "send rejects immediately"
387         #
388         #  If this number is set higher than 'cleanup_delay', then the
389         #  rejects will be sent at 'cleanup_delay' time, when the request
390         #  is deleted from the internal cache of requests.
391         #
392         #  Useful ranges: 1 to 5
393         reject_delay = 1
394
395         #
396         #  status_server: Whether or not the server will respond
397         #  to Status-Server requests.
398         #
399         #  Normally this should be set to "no", because they're useless.
400         #  See: http://www.freeradius.org/rfc/rfc2865.html#Keep-Alives
401         #
402         #  However, certain NAS boxes may require them. 
403         #
404         #  When sent a Status-Server message, the server responds with
405         #  an Access-Accept packet, containing a Reply-Message attribute,
406         #  which is a string describing how long the server has been
407         #  running.
408         #
409         status_server = no
410 }
411
412 # PROXY CONFIGURATION
413 #
414 #  proxy_requests: Turns proxying of RADIUS requests on or off.
415 #
416 #  The server has proxying turned on by default.  If your system is NOT
417 #  set up to proxy requests to another server, then you can turn proxying
418 #  off here.  This will save a small amount of resources on the server.
419 #
420 #  If you have proxying turned off, and your configuration files say
421 #  to proxy a request, then an error message will be logged.
422 #
423 #  To disable proxying, change the "yes" to "no", and comment the
424 #  $INCLUDE line.
425 #
426 #  allowed values: {no, yes}
427 #
428 proxy_requests  = yes
429 $INCLUDE  ${confdir}/proxy.conf
430
431
432 # CLIENTS CONFIGURATION
433 #
434 #  Client configuration is defined in "clients.conf".  
435 #
436
437 #  The 'clients.conf' file contains all of the information from the old
438 #  'clients' and 'naslist' configuration files.  We recommend that you
439 #  do NOT use 'client's or 'naslist', although they are still
440 #  supported.
441 #
442 #  Anything listed in 'clients.conf' will take precedence over the
443 #  information from the old-style configuration files.
444 #
445 $INCLUDE  ${confdir}/clients.conf
446
447
448 # SNMP CONFIGURATION
449 #
450 #  Snmp configuration is only valid if SNMP support was enabled
451 #  at compile time.
452 #
453 #  To enable SNMP querying of the server, set the value of the
454 #  'snmp' attribute to 'yes'
455 #
456 snmp    = no
457 $INCLUDE  ${confdir}/snmp.conf
458
459
460 # THREAD POOL CONFIGURATION
461 #
462 #  The thread pool is a long-lived group of threads which
463 #  take turns (round-robin) handling any incoming requests.
464 #
465 #  You probably want to have a few spare threads around,
466 #  so that high-load situations can be handled immediately.  If you
467 #  don't have any spare threads, then the request handling will
468 #  be delayed while a new thread is created, and added to the pool.
469 #
470 #  You probably don't want too many spare threads around,
471 #  otherwise they'll be sitting there taking up resources, and
472 #  not doing anything productive.
473 #
474 #  The numbers given below should be adequate for most situations.
475 #
476 thread pool {
477         #  Number of servers to start initially --- should be a reasonable
478         #  ballpark figure.
479         start_servers = 5
480
481         #  Limit on the total number of servers running.
482         #
483         #  If this limit is ever reached, clients will be LOCKED OUT, so it
484         #  should NOT BE SET TOO LOW.  It is intended mainly as a brake to
485         #  keep a runaway server from taking the system with it as it spirals
486         #  down...
487         #
488         #  You may find that the server is regularly reaching the
489         #  'max_servers' number of threads, and that increasing
490         #  'max_servers' doesn't seem to make much difference.
491         #
492         #  If this is the case, then the problem is MOST LIKELY that
493         #  your back-end databases are taking too long to respond, and
494         #  are preventing the server from responding in a timely manner.
495         #
496         #  The solution is NOT do keep increasing the 'max_servers'
497         #  value, but instead to fix the underlying cause of the
498         #  problem: slow database, or 'hostname_lookups=yes'.
499         #
500         #  For more information, see 'max_request_time', above.
501         #
502         max_servers = 32
503
504         #  Server-pool size regulation.  Rather than making you guess
505         #  how many servers you need, FreeRADIUS dynamically adapts to
506         #  the load it sees, that is, it tries to maintain enough
507         #  servers to handle the current load, plus a few spare
508         #  servers to handle transient load spikes.
509         #
510         #  It does this by periodically checking how many servers are
511         #  waiting for a request.  If there are fewer than
512         #  min_spare_servers, it creates a new spare.  If there are
513         #  more than max_spare_servers, some of the spares die off.
514         #  The default values are probably OK for most sites.
515         #
516         min_spare_servers = 3
517         max_spare_servers = 10
518
519         #  There may be memory leaks or resource allocation problems with
520         #  the server.  If so, set this value to 300 or so, so that the
521         #  resources will be cleaned up periodically.
522         #
523         #  This should only be necessary if there are serious bugs in the
524         #  server which have not yet been fixed.
525         #
526         #  '0' is a special value meaning 'infinity', or 'the servers never
527         #  exit'
528         max_requests_per_server = 0
529 }
530
531 # MODULE CONFIGURATION
532 #
533 #  The names and configuration of each module is located in this section.
534 #
535 #  After the modules are defined here, they may be referred to by name,
536 #  in other sections of this configuration file.
537 #
538 modules {
539         #
540         #  Each module has a configuration as follows:
541         #
542         #       name [ instance ] {
543         #               config_item = value
544         #               ...
545         #       }
546         #
547         #  The 'name' is used to load the 'rlm_name' library
548         #  which implements the functionality of the module.
549         #
550         #  The 'instance' is optional.  To have two different instances
551         #  of a module, it first must be referred to by 'name'.
552         #  The different copies of the module are then created by
553         #  inventing two 'instance' names, e.g. 'instance1' and 'instance2'
554         #
555         #  The instance names can then be used in later configuration
556         #  INSTEAD of the original 'name'.  See the 'radutmp' configuration
557         #  below for an example.
558         #
559
560         # PAP module to authenticate users based on their stored password
561         #
562         #  Supports multiple encryption schemes
563         #  clear: Clear text
564         #  crypt: Unix crypt
565         #    md5: MD5 ecnryption
566         #   sha1: SHA1 encryption.
567         #  DEFAULT: crypt
568         pap {
569                 encryption_scheme = crypt
570         }
571
572         # CHAP module
573         #
574         #  To authenticate requests containing a CHAP-Password attribute.
575         #
576         chap {
577                 authtype = CHAP
578         }
579
580         # Pluggable Authentication Modules
581         #
582         #  For Linux, see:
583         #       http://www.kernel.org/pub/linux/libs/pam/index.html
584         #
585         #  WARNING: On many systems, the system PAM libraries have
586         #           memory leaks!  We STRONGLY SUGGEST that you do not
587         #           use PAM for authentication, due to those memory leaks.
588         #
589         pam {
590                 #
591                 #  The name to use for PAM authentication.
592                 #  PAM looks in /etc/pam.d/${pam_auth_name}
593                 #  for it's configuration.  See 'redhat/radiusd-pam'
594                 #  for a sample PAM configuration file.
595                 #
596                 #  Note that any Pam-Auth attribute set in the 'authorize'
597                 #  section will over-ride this one.
598                 #
599                 pam_auth = radiusd
600         }
601
602         # Unix /etc/passwd style authentication
603         #
604         unix {
605                 #
606                 #  Cache /etc/passwd, /etc/shadow, and /etc/group
607                 #
608                 #  The default is to NOT cache them.
609                 #
610                 #  For FreeBSD and NetBSD, you do NOT want to enable
611                 #  the cache, as it's password lookups are done via a
612                 #  database, so set this value to 'no'.
613                 #
614                 #  Some systems (e.g. RedHat Linux with pam_pwbd) can
615                 #  take *seconds* to check a password, when th passwd
616                 #  file containing 1000's of entries.  For those systems,
617                 #  you should set the cache value to 'yes', and set
618                 #  the locations of the 'passwd', 'shadow', and 'group'
619                 #  files, below.
620                 #
621                 # allowed values: {no, yes}
622                 cache = no
623
624                 # Reload the cache every 600 seconds (10mins). 0 to disable.
625                 cache_reload = 600
626
627                 #
628                 #  Define the locations of the normal passwd, shadow, and
629                 #  group files.
630                 #
631                 #  'shadow' is commented out by default, because not all
632                 #  systems have shadow passwords.
633                 #
634                 #  To force the module to use the system password functions,
635                 #  instead of reading the files, leave the following entries
636                 #  commented out.
637                 #
638                 #  This is required for some systems, like FreeBSD,
639                 #  and Mac OSX.
640                 #
641                 #       passwd = /etc/passwd
642                 #       shadow = /etc/shadow
643                 #       group = /etc/group
644
645                 #
646                 #  The location of the "wtmp" file.
647                 #  This should be moved to it's own module soon.
648                 #
649                 #  The only use for 'radlast'.  If you don't use
650                 #  'radlast', then you can comment out this item.
651                 #
652                 radwtmp = ${logdir}/radwtmp
653         }
654
655         #  Extensible Authentication Protocol
656         #
657         #  For all EAP related authentications.
658         #  Now in another file, because it is very large.
659         #
660 $INCLUDE ${confdir}/eap.conf
661
662         # Microsoft CHAP authentication
663         #
664         #  This module supports MS-CHAP and MS-CHAPv2 authentication.
665         #  It also enforces the SMB-Account-Ctrl attribute.
666         #
667         mschap {
668                 #
669                 #  As of 0.9, the mschap module does NOT support
670                 #  reading from /etc/smbpasswd.
671                 #
672                 #  If you are using /etc/smbpasswd, see the 'passwd'
673                 #  module for an example of how to use /etc/smbpasswd
674
675                 # authtype value, if present, will be used
676                 # to overwrite (or add) Auth-Type during
677                 # authorization. Normally should be MS-CHAP
678                 authtype = MS-CHAP
679                 
680                 # if use_mppe is not set to no mschap will
681                 # add MS-CHAP-MPPE-Keys for MS-CHAPv1 and
682                 # MS-MPPE-Recv-Key/MS-MPPE-Send-Key for MS-CHAPv2
683                 #
684                 #use_mppe = no
685
686                 # if mppe is enabled require_encryption makes
687                 # encryption moderate
688                 #
689                 #require_encryption = yes
690
691                 # require_strong always requires 128 bit key
692                 # encryption
693                 #
694                 #require_strong = yes
695
696                 # Windows sends us a username in the form of
697                 # DOMAIN\user, but sends the challenge response
698                 # based on only the user portion.  This hack
699                 # corrects for that incorrect behavior.
700                 #
701                 #with_ntdomain_hack = no
702
703                 # The module can perform authentication itself, OR
704                 # use a Windows Domain Controller.  This configuration
705                 # directive tells the module to call the ntlm_auth
706                 # program, which will do the authentication, and return
707                 # the NT-Key.  Note that you MUST have "winbindd" and
708                 # "nmbd" running on the local machine for ntlm_auth
709                 # to work.  See the ntlm_auth program documentation
710                 # for details.
711                 #
712                 # Be VERY careful when editing the following line!
713                 #
714                 #ntlm_auth = "/path/to/ntlm_auth --request-nt-key --username=%{Stripped-User-Name:-%{User-Name:-None}} --challenge=%{mschap:Challenge:-00} --nt-response=%{mschap:NT-Response:-00}"
715         }
716
717         # Lightweight Directory Access Protocol (LDAP)
718         #
719         #  This module definition allows you to use LDAP for
720         #  authorization and authentication (Auth-Type := LDAP)
721         #
722         #  See doc/rlm_ldap for description of configuration options 
723         #  and sample authorize{} and authenticate{} blocks 
724         ldap {
725                 server = "ldap.your.domain"
726                 # identity = "cn=admin,o=My Org,c=UA"
727                 # password = mypass
728                 basedn = "o=My Org,c=UA"
729                 filter = "(uid=%{Stripped-User-Name:-%{User-Name}})"
730                 # base_filter = "(objectclass=radiusprofile)"
731
732                 # set this to 'yes' to use TLS encrypted connections
733                 # to the LDAP database by using the StartTLS extended
734                 # operation.
735                 # The StartTLS operation is supposed to be used with normal
736                 # ldap connections instead of using ldaps (port 689) connections
737                 start_tls = no
738
739                 # tls_cacertfile        = /path/to/cacert.pem
740                 # tls_cacertdir         = /path/to/ca/dir/
741                 # tls_certfile          = /path/to/radius.crt
742                 # tls_keyfile           = /path/to/radius.key
743                 # tls_randfile          = /path/to/rnd
744                 # tls_require_cert      = "demand"
745
746                 # default_profile = "cn=radprofile,ou=dialup,o=My Org,c=UA"
747                 # profile_attribute = "radiusProfileDn"
748                 access_attr = "dialupAccess"
749
750                 # Mapping of RADIUS dictionary attributes to LDAP
751                 # directory attributes.
752                 dictionary_mapping = ${raddbdir}/ldap.attrmap
753
754                 ldap_connections_number = 5
755
756                 #
757                 # NOTICE: The password_header directive is NOT case insensitive
758                 #
759                 # password_header = "{clear}"
760                 #
761                 # Set:
762                 #       password_attribute = nspmPassword
763                 #
764                 # to get the user's password from a Novell eDirectory
765                 # backend. This will work *only if* freeRADIUS is
766                 # configured to build with --with-edir option.
767                 #
768                 #
769                 #  The server can usually figure this out on its own, and pull
770                 #  the correct User-Password or NT-Password from the database.
771                 #
772                 #  Note that NT-Passwords MUST be stored as a 32-digit hex
773                 #  string, and MUST start off with "0x", such as:
774                 #
775                 #       0x000102030405060708090a0b0c0d0e0f
776                 #
777                 #  Without the leading "0x", NT-Passwords will not work.
778                 #  This goes for NT-Passwords stored in SQL, too.
779                 #
780                 # password_attribute = userPassword
781                 #
782                 # Un-comment the following to disable Novell eDirectory account
783                 # policy check and intruder detection. This will work *only if*
784                 # FreeRADIUS is configured to build with --with-edir option.
785                 #
786                 # edir_account_policy_check=no
787                 #
788                 # groupname_attribute = cn
789                 # groupmembership_filter = "(|(&(objectClass=GroupOfNames)(member=%{Ldap-UserDn}))(&(objectClass=GroupOfUniqueNames)(uniquemember=%{Ldap-UserDn})))"
790                 # groupmembership_attribute = radiusGroupName
791                 timeout = 4
792                 timelimit = 3
793                 net_timeout = 1
794                 # compare_check_items = yes
795                 # do_xlat = yes
796                 # access_attr_used_for_allow = yes
797
798                 #
799                 #  By default, if the packet contains a User-Password,
800                 #  and no other module is configured to handle the
801                 #  authentication, the LDAP module sets itself to do
802                 #  LDAP bind for authentication.
803                 #
804                 #  You can disable this behavior by setting the following
805                 #  configuration entry to "no".
806                 #
807                 #  allowed values: {no, yes}
808                 # set_auth_type = yes
809         }
810
811         # passwd module allows to do authorization via any passwd-like
812         # file and to extract any attributes from these modules
813         #
814         # parameters are:
815         #   filename - path to filename
816         #   format - format for filename record. This parameters
817         #            correlates record in the passwd file and RADIUS
818         #            attributes.
819         #
820         #            Field marked as '*' is key field. That is, the parameter
821         #            with this name from the request is used to search for
822         #            the record from passwd file
823         #            Attribute marked as '=' is added to reply_itmes instead
824         #            of default configure_itmes
825         #            Attribute marked as '~' is added to request_items
826         #
827         #            Field marked as ',' may contain a comma separated list
828         #            of attributes.
829         #   authtype - if record found this Auth-Type is used to authenticate
830         #            user
831         #   hashsize - hashtable size. If 0 or not specified records are not
832         #            stored in memory and file is red on every request.
833         #   allowmultiplekeys - if few records for every key are allowed
834         #   ignorenislike - ignore NIS-related records
835         #   delimiter - symbol to use as a field separator in passwd file,
836         #            for format ':' symbol is always used. '\0', '\n' are
837         #            not allowed 
838         #
839
840         #  An example configuration for using /etc/smbpasswd.
841         #
842         #passwd etc_smbpasswd {
843         #       filename = /etc/smbpasswd
844         #       format = "*User-Name::LM-Password:NT-Password:SMB-Account-CTRL-TEXT::"
845         #       authtype = MS-CHAP
846         #       hashsize = 100
847         #       ignorenislike = no
848         #       allowmultiplekeys = no
849         #}
850
851         #  Similar configuration, for the /etc/group file. Adds a Group-Name
852         #  attribute for every group that the user is member of.
853         #
854         #passwd etc_group {
855         #       filename = /etc/group
856         #       format = "=Group-Name:::*,User-Name"
857         #       hashsize = 50
858         #       ignorenislike = yes
859         #       allowmultiplekeys = yes
860         #       delimiter = ":"
861         #}
862
863         # Realm module, for proxying.
864         #
865         #  You can have multiple instances of the realm module to
866         #  support multiple realm syntaxs at the same time.  The
867         #  search order is defined by the order in the authorize and
868         #  preacct sections.
869         #
870         #  Four config options:
871         #       format         -  must be 'prefix' or 'suffix'
872         #       delimiter      -  must be a single character
873         #       ignore_default -  set to 'yes' or 'no'
874         #       ignore_null    -  set to 'yes' or 'no'
875         #
876         #  ignore_default and ignore_null can be set to 'yes' to prevent
877         #  the module from matching against DEFAULT or NULL realms.  This
878         #  may be useful if you have have multiple instances of the
879         #  realm module.
880         #
881         #  They both default to 'no'.
882         #
883
884         #  'realm/username'
885         #
886         #  Using this entry, IPASS users have their realm set to "IPASS".
887         realm IPASS {
888                 format = prefix
889                 delimiter = "/"
890                 ignore_default = no
891                 ignore_null = no
892         }
893
894         #  'username@realm'
895         #
896         realm suffix {
897                 format = suffix
898                 delimiter = "@"
899                 ignore_default = no
900                 ignore_null = no
901         }
902
903         #  'username%realm'
904         #
905         realm realmpercent {
906                 format = suffix
907                 delimiter = "%"
908                 ignore_default = no
909                 ignore_null = no
910         }
911
912         #
913         #  'domain\user'
914         #
915         realm ntdomain {
916                 format = prefix
917                 delimiter = "\\"
918                 ignore_default = no
919                 ignore_null = no
920         }       
921
922         #  A simple value checking module
923         #
924         #  It can be used to check if an attribute value in the request
925         #  matches a (possibly multi valued) attribute in the check
926         #  items This can be used for example for caller-id
927         #  authentication.  For the module to run, both the request
928         #  attribute and the check items attribute must exist
929         #
930         #  i.e.
931         #  A user has an ldap entry with 2 radiusCallingStationId
932         #  attributes with values "12345678" and "12345679".  If we
933         #  enable rlm_checkval, then any request which contains a
934         #  Calling-Station-Id with one of those two values will be
935         #  accepted.  Requests with other values for
936         #  Calling-Station-Id will be rejected.
937         #
938         #  Regular expressions in the check attribute value are allowed
939         #  as long as the operator is '=~'
940         #
941         checkval {
942                 # The attribute to look for in the request
943                 item-name = Calling-Station-Id
944
945                 # The attribute to look for in check items. Can be multi valued
946                 check-name = Calling-Station-Id
947
948                 # The data type. Can be
949                 # string,integer,ipaddr,date,abinary,octets
950                 data-type = string
951
952                 # If set to yes and we dont find the item-name attribute in the
953                 # request then we send back a reject
954                 # DEFAULT is no
955                 #notfound-reject = no
956         }
957         
958         #  rewrite arbitrary packets.  Useful in accounting and authorization.
959         #
960         #
961         #  The module can also use the Rewrite-Rule attribute. If it
962         #  is set and matches the name of the module instance, then
963         #  that module instance will be the only one which runs.
964         #
965         #  Also if new_attribute is set to yes then a new attribute
966         #  will be created containing the value replacewith and it
967         #  will be added to searchin (packet, reply, proxy, proxy_reply or config).
968         # searchfor,ignore_case and max_matches will be ignored in that case.
969         #
970         # Backreferences are supported: %{0} will contain the string the whole match
971         # and %{1} to %{8} will contain the contents of the 1st to the 8th parentheses
972         #
973         # If max_matches is greater than one the backreferences will correspond to the
974         # first match
975
976         #
977         #attr_rewrite sanecallerid {
978         #       attribute = Called-Station-Id
979                 # may be "packet", "reply", "proxy", "proxy_reply" or "config"
980         #       searchin = packet
981         #       searchfor = "[+ ]"
982         #       replacewith = ""
983         #       ignore_case = no
984         #       new_attribute = no
985         #       max_matches = 10
986         #       ## If set to yes then the replace string will be appended to the original string
987         #       append = no
988         #}
989
990         # Preprocess the incoming RADIUS request, before handing it off
991         # to other modules.
992         #
993         #  This module processes the 'huntgroups' and 'hints' files.
994         #  In addition, it re-writes some weird attributes created
995         #  by some NASes, and converts the attributes into a form which
996         #  is a little more standard.
997         #
998         preprocess {
999                 huntgroups = ${confdir}/huntgroups
1000                 hints = ${confdir}/hints
1001
1002                 # This hack changes Ascend's wierd port numberings
1003                 # to standard 0-??? port numbers so that the "+" works
1004                 # for IP address assignments.
1005                 with_ascend_hack = no
1006                 ascend_channels_per_line = 23
1007
1008                 # Windows NT machines often authenticate themselves as
1009                 # NT_DOMAIN\username
1010                 #
1011                 # If this is set to 'yes', then the NT_DOMAIN portion
1012                 # of the user-name is silently discarded.
1013                 #
1014                 # This configuration entry SHOULD NOT be used.
1015                 # See the "realms" module for a better way to handle
1016                 # NT domains.
1017                 with_ntdomain_hack = no
1018
1019                 # Specialix Jetstream 8500 24 port access server.
1020                 #
1021                 # If the user name is 10 characters or longer, a "/"
1022                 # and the excess characters after the 10th are
1023                 # appended to the user name.
1024                 #
1025                 # If you're not running that NAS, you don't need
1026                 # this hack.
1027                 with_specialix_jetstream_hack = no
1028
1029                 # Cisco (and Quintum in Cisco mode) sends it's VSA attributes
1030                 # with the attribute name *again* in the string, like:
1031                 #
1032                 #   H323-Attribute = "h323-attribute=value".
1033                 #
1034                 # If this configuration item is set to 'yes', then
1035                 # the redundant data in the the attribute text is stripped
1036                 # out.  The result is:
1037                 #
1038                 #  H323-Attribute = "value"
1039                 #
1040                 # If you're not running a Cisco or Quintum NAS, you don't
1041                 # need this hack.
1042                 with_cisco_vsa_hack = no
1043         }
1044
1045         # Livingston-style 'users' file
1046         #
1047         files {
1048                 usersfile = ${confdir}/users
1049                 acctusersfile = ${confdir}/acct_users
1050                 preproxy_usersfile = ${confdir}/preproxy_users
1051
1052                 #  If you want to use the old Cistron 'users' file
1053                 #  with FreeRADIUS, you should change the next line
1054                 #  to 'compat = cistron'.  You can the copy your 'users'
1055                 #  file from Cistron.
1056                 compat = no
1057         }
1058
1059         # Write a detailed log of all accounting records received.
1060         #
1061         detail {
1062                 #  Note that we do NOT use NAS-IP-Address here, as
1063                 #  that attribute MAY BE from the originating NAS, and
1064                 #  NOT from the proxy which actually sent us the
1065                 #  request.  The Client-IP-Address attribute is ALWAYS
1066                 #  the address of the client which sent us the
1067                 #  request.
1068                 #
1069                 #  The following line creates a new detail file for
1070                 #  every radius client (by IP address or hostname).
1071                 #  In addition, a new detail file is created every
1072                 #  day, so that the detail file doesn't have to go
1073                 #  through a 'log rotation'
1074                 #
1075                 #  If your detail files are large, you may also want
1076                 #  to add a ':%H' (see doc/variables.txt) to the end
1077                 #  of it, to create a new detail file every hour, e.g.:
1078                 #
1079                 #   ..../detail-%Y%m%d:%H
1080                 #
1081                 #  This will create a new detail file for every hour.
1082                 #
1083                 detailfile = ${radacctdir}/%{Client-IP-Address}/detail-%Y%m%d
1084
1085                 #
1086                 #  The Unix-style permissions on the 'detail' file.
1087                 #
1088                 #  The detail file often contains secret or private
1089                 #  information about users.  So by keeping the file
1090                 #  permissions restrictive, we can prevent unwanted
1091                 #  people from seeing that information.
1092                 detailperm = 0600
1093         }
1094
1095         #
1096         #  Many people want to log authentication requests.
1097         #  Rather than modifying the server core to print out more
1098         #  messages, we can use a different instance of the 'detail'
1099         #  module, to log the authentication requests to a file.
1100         #
1101         #  You will also need to un-comment the 'auth_log' line
1102         #  in the 'authorize' section, below.
1103         #
1104         # detail auth_log {
1105                 # detailfile = ${radacctdir}/%{Client-IP-Address}/auth-detail-%Y%m%d
1106
1107                 #
1108                 #  This MUST be 0600, otherwise anyone can read
1109                 #  the users passwords!
1110                 # detailperm = 0600
1111         # }
1112
1113         #
1114         #  This module logs authentication reply packets sent
1115         #  to a NAS.  Both Access-Accept and Access-Reject packets
1116         #  are logged.
1117         #
1118         #  You will also need to un-comment the 'reply_log' line
1119         #  in the 'post-auth' section, below.
1120         #
1121         # detail reply_log {
1122                 # detailfile = ${radacctdir}/%{Client-IP-Address}/reply-detail-%Y%m%d
1123
1124                 #
1125                 #  This MUST be 0600, otherwise anyone can read
1126                 #  the users passwords!
1127                 # detailperm = 0600
1128         # }
1129
1130         #
1131         #  This module logs packets proxied to a home server.
1132         #
1133         #  You will also need to un-comment the 'pre_proxy_log' line
1134         #  in the 'pre-proxy' section, below.
1135         #
1136         # detail pre_proxy_log {
1137                 # detailfile = ${radacctdir}/%{Client-IP-Address}/pre-proxy-detail-%Y%m%d
1138
1139                 #
1140                 #  This MUST be 0600, otherwise anyone can read
1141                 #  the users passwords!
1142                 # detailperm = 0600
1143         # }
1144
1145         #
1146         #  This module logs response packets from a home server.
1147         #
1148         #  You will also need to un-comment the 'post_proxy_log' line
1149         #  in the 'post-proxy' section, below.
1150         #
1151         # detail post_proxy_log {
1152                 # detailfile = ${radacctdir}/%{Client-IP-Address}/post-proxy-detail-%Y%m%d
1153
1154                 #
1155                 #  This MUST be 0600, otherwise anyone can read
1156                 #  the users passwords!
1157                 # detailperm = 0600
1158         # }
1159
1160         #
1161         #  The rlm_sql_log module appends the SQL queries in a log
1162         #  file which is read later by the radsqlrelay program.
1163         #
1164         #  This module only performs the dynamic expansion of the
1165         #  variables found in the SQL statements. No operation is
1166         #  executed on the database server. (this could be done
1167         #  later by an external program) That means the module is
1168         #  useful only with non-"SELECT" statements.
1169         #
1170         #  See rlm_sql_log(5) manpage.
1171         #
1172 #       sql_log {
1173 #               path = ${radacctdir}/sql-relay
1174 #               acct_table = "radacct"
1175 #               postauth_table = "radpostauth"
1176 #
1177 #               Start = "INSERT INTO ${acct_table} (AcctSessionId, UserName, \
1178 #                NASIPAddress, FramedIPAddress, AcctStartTime, AcctStopTime, \
1179 #                AcctSessionTime, AcctTerminateCause) VALUES                 \
1180 #                ('%{Acct-Session-Id}', '%{User-Name}', '%{NAS-IP-Address}', \
1181 #                '%{Framed-IP-Address}', '%S', '0', '0', '');"
1182 #               Stop = "INSERT INTO ${acct_table} (AcctSessionId, UserName,  \
1183 #                NASIPAddress, FramedIPAddress, AcctStartTime, AcctStopTime, \
1184 #                AcctSessionTime, AcctTerminateCause) VALUES                 \
1185 #                ('%{Acct-Session-Id}', '%{User-Name}', '%{NAS-IP-Address}', \
1186 #                '%{Framed-IP-Address}', '0', '%S', '%{Acct-Session-Time}',  \
1187 #                '%{Acct-Terminate-Cause}');"
1188 #               Alive = "INSERT INTO ${acct_table} (AcctSessionId, UserName, \
1189 #                NASIPAddress, FramedIPAddress, AcctStartTime, AcctStopTime, \
1190 #                AcctSessionTime, AcctTerminateCause) VALUES                 \
1191 #                ('%{Acct-Session-Id}', '%{User-Name}', '%{NAS-IP-Address}', \
1192 #                '%{Framed-IP-Address}', '0', '0', '%{Acct-Session-Time}','');"
1193 #
1194 #               Post-Auth = "INSERT INTO ${postauth_table}                   \
1195 #                (user, pass, reply, date) VALUES                            \
1196 #                ('%{User-Name}', '%{User-Password:-Chap-Password}',         \
1197 #                '%{reply:Packet-Type}', '%S');"
1198 #       }
1199
1200         #
1201         #  Create a unique accounting session Id.  Many NASes re-use
1202         #  or repeat values for Acct-Session-Id, causing no end of
1203         #  confusion.
1204         #
1205         #  This module will add a (probably) unique session id 
1206         #  to an accounting packet based on the attributes listed
1207         #  below found in the packet.  See doc/rlm_acct_unique for
1208         #  more information.
1209         #
1210         acct_unique {
1211                 key = "User-Name, Acct-Session-Id, NAS-IP-Address, Client-IP-Address, NAS-Port"
1212         }
1213
1214
1215         #  Include another file that has the SQL-related configuration.
1216         #  This is another file only because it tends to be big.
1217         #
1218         #  The following configuration file is for use with MySQL.
1219         #
1220         #  For Postgresql, use:         ${confdir}/postgresql.conf
1221         #  For MS-SQL, use:             ${confdir}/mssql.conf
1222         #  For Oracle, use:             ${confdir}/oraclesql.conf
1223         #
1224         $INCLUDE  ${confdir}/sql.conf
1225
1226
1227         #  For Cisco VoIP specific accounting with Postgresql,
1228         #  use:         ${confdir}/pgsql-voip.conf
1229         #
1230         #  You will also need the sql schema from:
1231         #        src/billing/cisco_h323_db_schema-postgres.sql
1232         #  Note: This config can be use AS WELL AS the standard sql
1233         #  config if you need SQL based Auth
1234         
1235
1236         #  Write a 'utmp' style file, of which users are currently
1237         #  logged in, and where they've logged in from.
1238         #
1239         #  This file is used mainly for Simultaneous-Use checking,
1240         #  and also 'radwho', to see who's currently logged in.
1241         #
1242         radutmp {
1243                 #  Where the file is stored.  It's not a log file,
1244                 #  so it doesn't need rotating.
1245                 #
1246                 filename = ${logdir}/radutmp
1247
1248                 #  The field in the packet to key on for the
1249                 #  'user' name,  If you have other fields which you want
1250                 #  to use to key on to control Simultaneous-Use,
1251                 #  then you can use them here.
1252                 #
1253                 #  Note, however, that the size of the field in the
1254                 #  'utmp' data structure is small, around 32
1255                 #  characters, so that will limit the possible choices
1256                 #  of keys.
1257                 #
1258                 #  You may want instead: %{Stripped-User-Name:-%{User-Name}}
1259                 username = %{User-Name}
1260
1261
1262                 #  Whether or not we want to treat "user" the same
1263                 #  as "USER", or "User".  Some systems have problems
1264                 #  with case sensitivity, so this should be set to
1265                 #  'no' to enable the comparisons of the key attribute
1266                 #  to be case insensitive.
1267                 #
1268                 case_sensitive = yes
1269
1270                 #  Accounting information may be lost, so the user MAY
1271                 #  have logged off of the NAS, but we haven't noticed.
1272                 #  If so, we can verify this information with the NAS,
1273                 #
1274                 #  If we want to believe the 'utmp' file, then this
1275                 #  configuration entry can be set to 'no'.
1276                 #
1277                 check_with_nas = yes            
1278
1279                 # Set the file permissions, as the contents of this file
1280                 # are usually private.
1281                 perm = 0600
1282
1283                 callerid = "yes"
1284         }
1285
1286         # "Safe" radutmp - does not contain caller ID, so it can be
1287         # world-readable, and radwho can work for normal users, without
1288         # exposing any information that isn't already exposed by who(1).
1289         #
1290         # This is another 'instance' of the radutmp module, but it is given
1291         # then name "sradutmp" to identify it later in the "accounting"
1292         # section.
1293         radutmp sradutmp {
1294                 filename = ${logdir}/sradutmp
1295                 perm = 0644
1296                 callerid = "no"
1297         }
1298
1299         # attr_filter - filters the attributes received in replies from
1300         # proxied servers, to make sure we send back to our RADIUS client
1301         # only allowed attributes.
1302         attr_filter {
1303                 attrsfile = ${confdir}/attrs
1304         }
1305
1306         #  counter module:
1307         #  This module takes an attribute (count-attribute).
1308         #  It also takes a key, and creates a counter for each unique
1309         #  key.  The count is incremented when accounting packets are
1310         #  received by the server.  The value of the increment depends
1311         #  on the attribute type.
1312         #  If the attribute is Acct-Session-Time or of an integer type we add the
1313         #  value of the attribute. If it is anything else we increase the
1314         #  counter by one.
1315         #
1316         #  The 'reset' parameter defines when the counters are all reset to
1317         #  zero.  It can be hourly, daily, weekly, monthly or never.
1318         #
1319         #  hourly: Reset on 00:00 of every hour
1320         #  daily: Reset on 00:00:00 every day
1321         #  weekly: Reset on 00:00:00 on sunday
1322         #  monthly: Reset on 00:00:00 of the first day of each month
1323         #
1324         #  It can also be user defined. It should be of the form:
1325         #  num[hdwm] where:
1326         #  h: hours, d: days, w: weeks, m: months
1327         #  If the letter is ommited days will be assumed. In example:
1328         #  reset = 10h (reset every 10 hours)
1329         #  reset = 12  (reset every 12 days)
1330         #
1331         #
1332         #  The check-name attribute defines an attribute which will be
1333         #  registered by the counter module and can be used to set the
1334         #  maximum allowed value for the counter after which the user
1335         #  is rejected.
1336         #  Something like:
1337         #
1338         #  DEFAULT Max-Daily-Session := 36000
1339         #          Fall-Through = 1
1340         #
1341         #  You should add the counter module in the instantiate
1342         #  section so that it registers check-name before the files
1343         #  module reads the users file.
1344         #
1345         #  If check-name is set and the user is to be rejected then we
1346         #  send back a Reply-Message and we log a Failure-Message in
1347         #  the radius.log
1348         #  If the count attribute is Acct-Session-Time then on each login
1349         #  we send back the remaining online time as a Session-Timeout attribute
1350         #
1351         #  The counter-name can also be used instead of using the check-name
1352         #  like below:
1353         #
1354         #  DEFAULT  Daily-Session-Time > 3600, Auth-Type = Reject
1355         #      Reply-Message = "You've used up more than one hour today"
1356         #
1357         #  The allowed-servicetype attribute can be used to only take
1358         #  into account specific sessions. For example if a user first
1359         #  logs in through a login menu and then selects ppp there will
1360         #  be two sessions. One for Login-User and one for Framed-User
1361         #  service type. We only need to take into account the second one.
1362         #
1363         #  The module should be added in the instantiate, authorize and
1364         #  accounting sections.  Make sure that in the authorize
1365         #  section it comes after any module which sets the
1366         #  'check-name' attribute.
1367         #
1368         counter daily {
1369                 filename = ${raddbdir}/db.daily
1370                 key = User-Name
1371                 count-attribute = Acct-Session-Time
1372                 reset = daily
1373                 counter-name = Daily-Session-Time
1374                 check-name = Max-Daily-Session
1375                 allowed-servicetype = Framed-User
1376                 cache-size = 5000
1377         }
1378
1379         #
1380         #  This module is an SQL enabled version of the counter module.
1381         #
1382         #  Rather than maintaining seperate (GDBM) databases of
1383         #  accounting info for each counter, this module uses the data
1384         #  stored in the raddacct table by the sql modules. This
1385         #  module NEVER does any database INSERTs or UPDATEs.  It is
1386         #  totally dependent on the SQL module to process Accounting
1387         #  packets.
1388         #
1389         #  The 'sqlmod_inst' parameter holds the instance of the sql
1390         #  module to use when querying the SQL database. Normally it
1391         #  is just "sql".  If you define more and one SQL module
1392         #  instance (usually for failover situations), you can
1393         #  specify which module has access to the Accounting Data
1394         #  (radacct table).
1395         #
1396         #  The 'reset' parameter defines when the counters are all
1397         #  reset to zero.  It can be hourly, daily, weekly, monthly or
1398         #  never.  It can also be user defined. It should be of the
1399         #  form:
1400         #       num[hdwm] where:
1401         #       h: hours, d: days, w: weeks, m: months
1402         #       If the letter is ommited days will be assumed. In example:
1403         #       reset = 10h (reset every 10 hours)
1404         #       reset = 12  (reset every 12 days)
1405         #
1406         #  The 'key' parameter specifies the unique identifier for the
1407         #  counter records (usually 'User-Name').
1408         #
1409         #  The 'query' parameter specifies the SQL query used to get
1410         #  the current Counter value from the database. There are 3
1411         #  parameters that can be used in the query:
1412         #               %k      'key' parameter
1413         #               %b      unix time value of beginning of reset period
1414         #               %e      unix time value of end of reset period
1415         #
1416         #  The 'check-name' parameter is the name of the 'check'
1417         #  attribute to use to access the counter in the 'users' file
1418         #  or SQL radcheck or radcheckgroup tables.
1419         #
1420         #  DEFAULT  Max-Daily-Session > 3600, Auth-Type = Reject
1421         #      Reply-Message = "You've used up more than one hour today"
1422         #
1423         sqlcounter dailycounter {
1424                 counter-name = Daily-Session-Time
1425                 check-name = Max-Daily-Session
1426                 sqlmod-inst = sql
1427                 key = User-Name
1428                 reset = daily
1429
1430                 # This query properly handles calls that span from the
1431                 # previous reset period into the current period but
1432                 # involves more work for the SQL server than those
1433                 # below
1434                 query = "SELECT SUM(AcctSessionTime - \
1435                  GREATEST((%b - UNIX_TIMESTAMP(AcctStartTime)), 0)) \
1436                  FROM radacct WHERE UserName='%{%k}' AND \
1437                  UNIX_TIMESTAMP(AcctStartTime) + AcctSessionTime > '%b'"
1438
1439                 # This query ignores calls that started in a previous
1440                 # reset period and continue into into this one. But it
1441                 # is a little easier on the SQL server
1442 #               query = "SELECT SUM(AcctSessionTime) FROM radacct WHERE \
1443 #                UserName='%{%k}' AND AcctStartTime > FROM_UNIXTIME('%b')"
1444
1445                 # This query is the same as above, but demonstrates an
1446                 # additional counter parameter '%e' which is the
1447                 # timestamp for the end of the period
1448 #               query = "SELECT SUM(AcctSessionTime) FROM radacct \
1449 #                WHERE UserName='%{%k}' AND AcctStartTime BETWEEN \
1450 #                FROM_UNIXTIME('%b') AND FROM_UNIXTIME('%e')"
1451         }
1452
1453         sqlcounter monthlycounter {
1454                 counter-name = Monthly-Session-Time
1455                 check-name = Max-Monthly-Session
1456                 sqlmod-inst = sql
1457                 key = User-Name
1458                 reset = monthly
1459
1460                 # This query properly handles calls that span from the
1461                 # previous reset period into the current period but
1462                 # involves more work for the SQL server than those
1463                 # below
1464                 query = "SELECT SUM(AcctSessionTime - \
1465                  GREATEST((%b - UNIX_TIMESTAMP(AcctStartTime)), 0)) \
1466                  FROM radacct WHERE UserName='%{%k}' AND \
1467                  UNIX_TIMESTAMP(AcctStartTime) + AcctSessionTime > '%b'"
1468
1469                 # This query ignores calls that started in a previous
1470                 # reset period and continue into into this one. But it
1471                 # is a little easier on the SQL server
1472 #               query = "SELECT SUM(AcctSessionTime) FROM radacct WHERE \
1473 #                UserName='%{%k}' AND AcctStartTime > FROM_UNIXTIME('%b')"
1474
1475                 # This query is the same as above, but demonstrates an
1476                 # additional counter parameter '%e' which is the
1477                 # timestamp for the end of the period
1478 #               query = "SELECT SUM(AcctSessionTime) FROM radacct \
1479 #                WHERE UserName='%{%k}' AND AcctStartTime BETWEEN \
1480 #                FROM_UNIXTIME('%b') AND FROM_UNIXTIME('%e')"
1481         }
1482
1483         #
1484         # The "always" module is here for debugging purposes. Each
1485         # instance simply returns the same result, always, without
1486         # doing anything.
1487         always fail {
1488                 rcode = fail
1489         }
1490         always reject {
1491                 rcode = reject
1492         }
1493         always ok {
1494                 rcode = ok
1495                 simulcount = 0
1496                 mpp = no
1497         }
1498
1499         #
1500         #  The 'expression' module currently has no configuration.
1501         #
1502         #  This module is useful only for 'xlat'.  To use it,
1503         #  put 'exec' into the 'instantiate' section.  You can then
1504         #  do dynamic translation of attributes like:
1505         #
1506         #  Attribute-Name = `%{expr:2 + 3 + %{exec: uid -u}}`
1507         #
1508         #  The value of the attribute will be replaced with the output
1509         #  of the program which is executed.  Due to RADIUS protocol
1510         #  limitations, any output over 253 bytes will be ignored.
1511         expr {
1512         }
1513
1514         #
1515         #  The 'digest' module currently has no configuration.
1516         #
1517         #  "Digest" authentication against a Cisco SIP server.
1518         #  See 'doc/rfc/draft-sterman-aaa-sip-00.txt' for details
1519         #  on performing digest authentication for Cisco SIP servers.
1520         #
1521         digest {
1522         }
1523
1524         #
1525         #  Execute external programs
1526         #
1527         #  This module is useful only for 'xlat'.  To use it,
1528         #  put 'exec' into the 'instantiate' section.  You can then
1529         #  do dynamic translation of attributes like:
1530         #
1531         #  Attribute-Name = `%{exec:/path/to/program args}`
1532         #
1533         #  The value of the attribute will be replaced with the output
1534         #  of the program which is executed.  Due to RADIUS protocol
1535         #  limitations, any output over 253 bytes will be ignored.
1536         #
1537         #  The RADIUS attributes from the user request will be placed
1538         #  into environment variables of the executed program, as
1539         #  described in 'doc/variables.txt'
1540         #
1541         exec {
1542                 wait = yes
1543                 input_pairs = request
1544         }
1545
1546         #
1547         #  This is a more general example of the execute module.
1548         #
1549         #  This one is called "echo".
1550         #
1551         #  Attribute-Name = `%{echo:/path/to/program args}`
1552         #
1553         #  If you wish to execute an external program in more than
1554         #  one section (e.g. 'authorize', 'pre_proxy', etc), then it
1555         #  is probably best to define a different instance of the
1556         #  'exec' module for every section.     
1557         #       
1558         exec echo {
1559                 #
1560                 #  Wait for the program to finish.
1561                 #
1562                 #  If we do NOT wait, then the program is "fire and
1563                 #  forget", and any output attributes from it are ignored.
1564                 #
1565                 #  If we are looking for the program to output
1566                 #  attributes, and want to add those attributes to the
1567                 #  request, then we MUST wait for the program to
1568                 #  finish, and therefore set 'wait=yes'
1569                 #
1570                 # allowed values: {no, yes}
1571                 wait = yes
1572
1573                 #
1574                 #  The name of the program to execute, and it's
1575                 #  arguments.  Dynamic translation is done on this
1576                 #  field, so things like the following example will
1577                 #  work.
1578                 #
1579                 program = "/bin/echo %{User-Name}"
1580
1581                 #
1582                 #  The attributes which are placed into the
1583                 #  environment variables for the program.
1584                 #
1585                 #  Allowed values are:
1586                 #
1587                 #       request         attributes from the request
1588                 #       config          attributes from the configuration items list
1589                 #       reply           attributes from the reply
1590                 #       proxy-request   attributes from the proxy request
1591                 #       proxy-reply     attributes from the proxy reply
1592                 #
1593                 #  Note that some attributes may not exist at some
1594                 #  stages.  e.g. There may be no proxy-reply
1595                 #  attributes if this module is used in the
1596                 #  'authorize' section.
1597                 #
1598                 input_pairs = request
1599
1600                 #
1601                 #  Where to place the output attributes (if any) from
1602                 #  the executed program.  The values allowed, and the
1603                 #  restrictions as to availability, are the same as
1604                 #  for the input_pairs.
1605                 #
1606                 output_pairs = reply
1607
1608                 #
1609                 #  When to execute the program.  If the packet
1610                 #  type does NOT match what's listed here, then
1611                 #  the module does NOT execute the program.
1612                 #
1613                 #  For a list of allowed packet types, see
1614                 #  the 'dictionary' file, and look for VALUEs
1615                 #  of the Packet-Type attribute.
1616                 #
1617                 #  By default, the module executes on ANY packet.
1618                 #  Un-comment out the following line to tell the
1619                 #  module to execute only if an Access-Accept is
1620                 #  being sent to the NAS.
1621                 #
1622                 #packet_type = Access-Accept
1623         }
1624
1625         #  Do server side ip pool management. Should be added in post-auth and
1626         #  accounting sections.
1627         #
1628         #  The module also requires the existance of the Pool-Name
1629         #  attribute. That way the administrator can add the Pool-Name
1630         #  attribute in the user profiles and use different pools
1631         #  for different users. The Pool-Name attribute is a *check* item not
1632         #  a reply item.
1633         #
1634         # Example:
1635         # radiusd.conf: ippool students { [...] }
1636         # users file  : DEFAULT Group == students, Pool-Name := "students"
1637         #
1638         # ********* IF YOU CHANGE THE RANGE PARAMETERS YOU MUST *********
1639         # ********* THEN ERASE THE DB FILES                     *********
1640         #
1641         ippool main_pool {
1642
1643                 #  range-start,range-stop: The start and end ip
1644                 #  addresses for the ip pool
1645                 range-start = 192.168.1.1
1646                 range-stop = 192.168.3.254
1647
1648                 #  netmask: The network mask used for the ip's
1649                 netmask = 255.255.255.0
1650
1651                 #  cache-size: The gdbm cache size for the db
1652                 #  files. Should be equal to the number of ip's
1653                 #  available in the ip pool
1654                 cache-size = 800
1655
1656                 # session-db: The main db file used to allocate ip's to clients
1657                 session-db = ${raddbdir}/db.ippool
1658
1659                 # ip-index: Helper db index file used in multilink
1660                 ip-index = ${raddbdir}/db.ipindex
1661
1662                 # override: Will this ippool override a Framed-IP-Address already set
1663                 override = no
1664
1665                 # maximum-timeout: If not zero specifies the maximum time in seconds an
1666                 # entry may be active. Default: 0
1667                 maximum-timeout = 0
1668         }
1669
1670         # OTP token support.  Not included by default.
1671         # $INCLUDE  ${confdir}/otp.conf
1672
1673 }
1674
1675 # Instantiation
1676 #
1677 #  This section orders the loading of the modules.  Modules
1678 #  listed here will get loaded BEFORE the later sections like
1679 #  authorize, authenticate, etc. get examined.
1680 #
1681 #  This section is not strictly needed.  When a section like
1682 #  authorize refers to a module, it's automatically loaded and
1683 #  initialized.  However, some modules may not be listed in any
1684 #  of the following sections, so they can be listed here.
1685 #
1686 #  Also, listing modules here ensures that you have control over
1687 #  the order in which they are initalized.  If one module needs
1688 #  something defined by another module, you can list them in order
1689 #  here, and ensure that the configuration will be OK.
1690 #
1691 instantiate {
1692         #
1693         #  Allows the execution of external scripts.
1694         #  The entire command line (and output) must fit into 253 bytes.
1695         #
1696         #  e.g. Framed-Pool = `%{exec:/bin/echo foo}`
1697         exec
1698
1699         #
1700         #  The expression module doesn't do authorization,
1701         #  authentication, or accounting.  It only does dynamic
1702         #  translation, of the form:
1703         #
1704         #       Session-Timeout = `%{expr:2 + 3}`
1705         #
1706         #  So the module needs to be instantiated, but CANNOT be
1707         #  listed in any other section.  See 'doc/rlm_expr' for
1708         #  more information.
1709         #
1710         expr
1711
1712         #
1713         # We add the counter module here so that it registers
1714         # the check-name attribute before any module which sets
1715         # it
1716 #       daily
1717 }
1718
1719 #  Authorization. First preprocess (hints and huntgroups files),
1720 #  then realms, and finally look in the "users" file.
1721 #
1722 #  The order of the realm modules will determine the order that
1723 #  we try to find a matching realm.
1724 #
1725 #  Make *sure* that 'preprocess' comes before any realm if you 
1726 #  need to setup hints for the remote radius server
1727 authorize {
1728         #
1729         #  The preprocess module takes care of sanitizing some bizarre
1730         #  attributes in the request, and turning them into attributes
1731         #  which are more standard.
1732         #
1733         #  It takes care of processing the 'raddb/hints' and the
1734         #  'raddb/huntgroups' files.
1735         #
1736         #  It also adds the %{Client-IP-Address} attribute to the request.
1737         preprocess
1738
1739         #
1740         #  If you want to have a log of authentication requests,
1741         #  un-comment the following line, and the 'detail auth_log'
1742         #  section, above.
1743 #       auth_log
1744         
1745 #       attr_filter
1746
1747         #
1748         #  The chap module will set 'Auth-Type := CHAP' if we are
1749         #  handling a CHAP request and Auth-Type has not already been set
1750         chap
1751
1752         #
1753         #  If the users are logging in with an MS-CHAP-Challenge
1754         #  attribute for authentication, the mschap module will find
1755         #  the MS-CHAP-Challenge attribute, and add 'Auth-Type := MS-CHAP'
1756         #  to the request, which will cause the server to then use
1757         #  the mschap module for authentication.
1758         mschap
1759
1760         #
1761         #  If you have a Cisco SIP server authenticating against
1762         #  FreeRADIUS, uncomment the following line, and the 'digest'
1763         #  line in the 'authenticate' section.
1764 #       digest
1765
1766         #
1767         #  Look for IPASS style 'realm/', and if not found, look for
1768         #  '@realm', and decide whether or not to proxy, based on
1769         #  that.
1770 #       IPASS
1771
1772         #
1773         #  If you are using multiple kinds of realms, you probably
1774         #  want to set "ignore_null = yes" for all of them.
1775         #  Otherwise, when the first style of realm doesn't match,
1776         #  the other styles won't be checked.
1777         #
1778         suffix
1779 #       ntdomain
1780
1781         #
1782         #  This module takes care of EAP-MD5, EAP-TLS, and EAP-LEAP
1783         #  authentication.
1784         #
1785         #  It also sets the EAP-Type attribute in the request
1786         #  attribute list to the EAP type from the packet.
1787         eap
1788
1789         #
1790         #  Read the 'users' file
1791         files
1792
1793         #
1794         #  Look in an SQL database.  The schema of the database
1795         #  is meant to mirror the "users" file.
1796         #
1797         #  See "Authorization Queries" in sql.conf
1798 #       sql
1799
1800         #
1801         #  If you are using /etc/smbpasswd, and are also doing
1802         #  mschap authentication, the un-comment this line, and
1803         #  configure the 'etc_smbpasswd' module, above.
1804 #       etc_smbpasswd
1805
1806         #
1807         #  The ldap module will set Auth-Type to LDAP if it has not
1808         #  already been set
1809 #       ldap
1810
1811         #
1812         #  Enforce daily limits on time spent logged in.
1813 #       daily
1814
1815         #
1816         # Use the checkval module
1817 #       checkval
1818 }
1819
1820
1821 #  Authentication.
1822 #
1823 #
1824 #  This section lists which modules are available for authentication.
1825 #  Note that it does NOT mean 'try each module in order'.  It means
1826 #  that a module from the 'authorize' section adds a configuration
1827 #  attribute 'Auth-Type := FOO'.  That authentication type is then
1828 #  used to pick the apropriate module from the list below.
1829 #
1830
1831 #  In general, you SHOULD NOT set the Auth-Type attribute.  The server
1832 #  will figure it out on its own, and will do the right thing.  The
1833 #  most common side effect of erroneously setting the Auth-Type
1834 #  attribute is that one authentication method will work, but the
1835 #  others will not.
1836 #
1837 #  The common reasons to set the Auth-Type attribute by hand
1838 #  is to either forcibly reject the user, or forcibly accept him.
1839 #
1840 authenticate {
1841         #
1842         #  PAP authentication, when a back-end database listed
1843         #  in the 'authorize' section supplies a password.  The
1844         #  password can be clear-text, or encrypted.
1845         Auth-Type PAP {
1846                 pap
1847         }
1848
1849         #
1850         #  Most people want CHAP authentication
1851         #  A back-end database listed in the 'authorize' section
1852         #  MUST supply a CLEAR TEXT password.  Encrypted passwords
1853         #  won't work.
1854         Auth-Type CHAP {
1855                 chap
1856         }
1857
1858         #
1859         #  MSCHAP authentication.
1860         Auth-Type MS-CHAP {
1861                 mschap
1862         }
1863
1864         #
1865         #  If you have a Cisco SIP server authenticating against
1866         #  FreeRADIUS, uncomment the following line, and the 'digest'
1867         #  line in the 'authorize' section.
1868 #       digest
1869
1870         #
1871         #  Pluggable Authentication Modules.
1872 #       pam
1873
1874         #
1875         #  See 'man getpwent' for information on how the 'unix'
1876         #  module checks the users password.  Note that packets
1877         #  containing CHAP-Password attributes CANNOT be authenticated
1878         #  against /etc/passwd!  See the FAQ for details.
1879         #  
1880         unix
1881
1882         # Uncomment it if you want to use ldap for authentication
1883         #
1884         # Note that this means "check plain-text password against
1885         # the ldap database", which means that EAP won't work,
1886         # as it does not supply a plain-text password.
1887 #       Auth-Type LDAP {
1888 #               ldap
1889 #       }
1890
1891         #
1892         #  Allow EAP authentication.
1893         eap
1894 }
1895
1896
1897 #
1898 #  Pre-accounting.  Decide which accounting type to use.
1899 #
1900 preacct {
1901         preprocess
1902
1903         #
1904         #  Ensure that we have a semi-unique identifier for every
1905         #  request, and many NAS boxes are broken.
1906         acct_unique
1907
1908         #
1909         #  Look for IPASS-style 'realm/', and if not found, look for
1910         #  '@realm', and decide whether or not to proxy, based on
1911         #  that.
1912         #
1913         #  Accounting requests are generally proxied to the same
1914         #  home server as authentication requests.
1915 #       IPASS
1916         suffix
1917 #       ntdomain
1918
1919         #
1920         #  Read the 'acct_users' file
1921         files
1922 }
1923
1924 #
1925 #  Accounting.  Log the accounting data.
1926 #
1927 accounting {
1928         #
1929         #  Create a 'detail'ed log of the packets.
1930         #  Note that accounting requests which are proxied
1931         #  are also logged in the detail file.
1932         detail
1933 #       daily
1934
1935         #  Update the wtmp file
1936         #
1937         #  If you don't use "radlast", you can delete this line.
1938         unix
1939
1940         #
1941         #  For Simultaneous-Use tracking.
1942         #
1943         #  Due to packet losses in the network, the data here
1944         #  may be incorrect.  There is little we can do about it.
1945         radutmp
1946 #       sradutmp
1947
1948         #  Return an address to the IP Pool when we see a stop record.
1949 #       main_pool
1950
1951         #
1952         #  Log traffic to an SQL database.
1953         #
1954         #  See "Accounting queries" in sql.conf
1955 #       sql
1956
1957         #
1958         #  Instead of sending the query to the SQL server,
1959         #  write it into a log file.
1960         #
1961 #       sql_log
1962
1963         #  Cisco VoIP specific bulk accounting
1964 #       pgsql-voip
1965
1966 }
1967
1968
1969 #  Session database, used for checking Simultaneous-Use. Either the radutmp 
1970 #  or rlm_sql module can handle this.
1971 #  The rlm_sql module is *much* faster
1972 session {
1973         radutmp
1974
1975         #
1976         #  See "Simultaneous Use Checking Querie" in sql.conf
1977 #       sql
1978 }
1979
1980
1981 #  Post-Authentication
1982 #  Once we KNOW that the user has been authenticated, there are
1983 #  additional steps we can take.
1984 post-auth {
1985         #  Get an address from the IP Pool.
1986 #       main_pool
1987
1988         #
1989         #  If you want to have a log of authentication replies,
1990         #  un-comment the following line, and the 'detail reply_log'
1991         #  section, above.
1992 #       reply_log
1993
1994         #
1995         #  After authenticating the user, do another SQL query.
1996         #
1997         #  See "Authentication Logging Queries" in sql.conf
1998 #       sql
1999
2000         #
2001         #  Instead of sending the query to the SQL server,
2002         #  write it into a log file.
2003         #
2004 #       sql_log
2005
2006         #
2007         #  Un-comment the following if you have set
2008         #  'edir_account_policy_check = yes' in the ldap module sub-section of
2009         #  the 'modules' section.
2010         #
2011 #       ldap
2012         #
2013         #  Access-Reject packets are sent through the REJECT sub-section of the
2014         #  post-auth section.
2015         #  Uncomment the following and set the module name to the ldap instance
2016         #  name if you have set 'edir_account_policy_check = yes' in the ldap
2017         #  module sub-section of the 'modules' section.
2018         #
2019 #       Post-Auth-Type REJECT {
2020 #               insert-module-name-here
2021 #       }
2022
2023 }
2024
2025 #
2026 #  When the server decides to proxy a request to a home server,
2027 #  the proxied request is first passed through the pre-proxy
2028 #  stage.  This stage can re-write the request, or decide to
2029 #  cancel the proxy.
2030 #
2031 #  Only a few modules currently have this method.
2032 #
2033 pre-proxy {
2034 #       attr_rewrite
2035
2036         #  Uncomment the following line if you want to change attributes
2037         #  as defined in the preproxy_users file.
2038 #       files
2039
2040         #  If you want to have a log of packets proxied to a home
2041         #  server, un-comment the following line, and the
2042         #  'detail pre_proxy_log' section, above.
2043 #       pre_proxy_log
2044 }
2045
2046 #
2047 #  When the server receives a reply to a request it proxied
2048 #  to a home server, the request may be massaged here, in the
2049 #  post-proxy stage.
2050 #
2051 post-proxy {
2052
2053         #  If you want to have a log of replies from a home server,
2054         #  un-comment the following line, and the 'detail post_proxy_log'
2055         #  section, above.
2056 #       post_proxy_log
2057
2058 #       attr_rewrite
2059
2060         #  Uncomment the following line if you want to filter replies from
2061         #  remote proxies based on the rules defined in the 'attrs' file.
2062
2063 #       attr_filter
2064
2065         #
2066         #  If you are proxying LEAP, you MUST configure the EAP
2067         #  module, and you MUST list it here, in the post-proxy
2068         #  stage.
2069         #
2070         #  You MUST also use the 'nostrip' option in the 'realm'
2071         #  configuration.  Otherwise, the User-Name attribute
2072         #  in the proxied request will not match the user name
2073         #  hidden inside of the EAP packet, and the end server will
2074         #  reject the EAP request.
2075         #
2076         eap
2077 }