rlm_otp import from 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         #  delayed_reject: 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         # passwd module allows to do authorization via any passwd-like
800         # file and to extract any attributes from these modules
801         #
802         # parameters are:
803         #   filename - path to filename
804         #   format - format for filename record. This parameters
805         #            correlates record in the passwd file and RADIUS
806         #            attributes.
807         #
808         #            Field marked as '*' is key field. That is, the parameter
809         #            with this name from the request is used to search for
810         #            the record from passwd file
811         #            Attribute marked as '=' is added to reply_itmes instead
812         #            of default configure_itmes
813         #            Attribute marked as '~' is added to request_items
814         #
815         #            Field marked as ',' may contain a comma separated list
816         #            of attributes.
817         #   authtype - if record found this Auth-Type is used to authenticate
818         #            user
819         #   hashsize - hashtable size. If 0 or not specified records are not
820         #            stored in memory and file is red on every request.
821         #   allowmultiplekeys - if few records for every key are allowed
822         #   ignorenislike - ignore NIS-related records
823         #   delimiter - symbol to use as a field separator in passwd file,
824         #            for format ':' symbol is always used. '\0', '\n' are
825         #            not allowed 
826         #
827
828         #  An example configuration for using /etc/smbpasswd.
829         #
830         #passwd etc_smbpasswd {
831         #       filename = /etc/smbpasswd
832         #       format = "*User-Name::LM-Password:NT-Password:SMB-Account-CTRL-TEXT::"
833         #       authtype = MS-CHAP
834         #       hashsize = 100
835         #       ignorenislike = no
836         #       allowmultiplekeys = no
837         #}
838
839         #  Similar configuration, for the /etc/group file. Adds a Group-Name
840         #  attribute for every group that the user is member of.
841         #
842         #passwd etc_group {
843         #       filename = /etc/group
844         #       format = "=Group-Name:::*,User-Name"
845         #       hashsize = 50
846         #       ignorenislike = yes
847         #       allowmultiplekeys = yes
848         #       delimiter = ":"
849         #}
850
851         # Realm module, for proxying.
852         #
853         #  You can have multiple instances of the realm module to
854         #  support multiple realm syntaxs at the same time.  The
855         #  search order is defined by the order in the authorize and
856         #  preacct sections.
857         #
858         #  Four config options:
859         #       format         -  must be 'prefix' or 'suffix'
860         #       delimiter      -  must be a single character
861         #       ignore_default -  set to 'yes' or 'no'
862         #       ignore_null    -  set to 'yes' or 'no'
863         #
864         #  ignore_default and ignore_null can be set to 'yes' to prevent
865         #  the module from matching against DEFAULT or NULL realms.  This
866         #  may be useful if you have have multiple instances of the
867         #  realm module.
868         #
869         #  They both default to 'no'.
870         #
871
872         #  'realm/username'
873         #
874         #  Using this entry, IPASS users have their realm set to "IPASS".
875         realm IPASS {
876                 format = prefix
877                 delimiter = "/"
878                 ignore_default = no
879                 ignore_null = no
880         }
881
882         #  'username@realm'
883         #
884         realm suffix {
885                 format = suffix
886                 delimiter = "@"
887                 ignore_default = no
888                 ignore_null = no
889         }
890
891         #  'username%realm'
892         #
893         realm realmpercent {
894                 format = suffix
895                 delimiter = "%"
896                 ignore_default = no
897                 ignore_null = no
898         }
899
900         #
901         #  'domain\user'
902         #
903         realm ntdomain {
904                 format = prefix
905                 delimiter = "\\"
906                 ignore_default = no
907                 ignore_null = no
908         }       
909
910         #  A simple value checking module
911         #
912         #  It can be used to check if an attribute value in the request
913         #  matches a (possibly multi valued) attribute in the check
914         #  items This can be used for example for caller-id
915         #  authentication.  For the module to run, both the request
916         #  attribute and the check items attribute must exist
917         #
918         #  i.e.
919         #  A user has an ldap entry with 2 radiusCallingStationId
920         #  attributes with values "12345678" and "12345679".  If we
921         #  enable rlm_checkval, then any request which contains a
922         #  Calling-Station-Id with one of those two values will be
923         #  accepted.  Requests with other values for
924         #  Calling-Station-Id will be rejected.
925         #
926         #  Regular expressions in the check attribute value are allowed
927         #  as long as the operator is '=~'
928         #
929         checkval {
930                 # The attribute to look for in the request
931                 item-name = Calling-Station-Id
932
933                 # The attribute to look for in check items. Can be multi valued
934                 check-name = Calling-Station-Id
935
936                 # The data type. Can be
937                 # string,integer,ipaddr,date,abinary,octets
938                 data-type = string
939
940                 # If set to yes and we dont find the item-name attribute in the
941                 # request then we send back a reject
942                 # DEFAULT is no
943                 #notfound-reject = no
944         }
945         
946         #  rewrite arbitrary packets.  Useful in accounting and authorization.
947         #
948         #
949         #  The module can also use the Rewrite-Rule attribute. If it
950         #  is set and matches the name of the module instance, then
951         #  that module instance will be the only one which runs.
952         #
953         #  Also if new_attribute is set to yes then a new attribute
954         #  will be created containing the value replacewith and it
955         #  will be added to searchin (packet, reply, proxy, proxy_reply or config).
956         # searchfor,ignore_case and max_matches will be ignored in that case.
957         #
958         # Backreferences are supported: %{0} will contain the string the whole match
959         # and %{1} to %{8} will contain the contents of the 1st to the 8th parentheses
960         #
961         # If max_matches is greater than one the backreferences will correspond to the
962         # first match
963
964         #
965         #attr_rewrite sanecallerid {
966         #       attribute = Called-Station-Id
967                 # may be "packet", "reply", "proxy", "proxy_reply" or "config"
968         #       searchin = packet
969         #       searchfor = "[+ ]"
970         #       replacewith = ""
971         #       ignore_case = no
972         #       new_attribute = no
973         #       max_matches = 10
974         #       ## If set to yes then the replace string will be appended to the original string
975         #       append = no
976         #}
977
978         # Preprocess the incoming RADIUS request, before handing it off
979         # to other modules.
980         #
981         #  This module processes the 'huntgroups' and 'hints' files.
982         #  In addition, it re-writes some weird attributes created
983         #  by some NASes, and converts the attributes into a form which
984         #  is a little more standard.
985         #
986         preprocess {
987                 huntgroups = ${confdir}/huntgroups
988                 hints = ${confdir}/hints
989
990                 # This hack changes Ascend's wierd port numberings
991                 # to standard 0-??? port numbers so that the "+" works
992                 # for IP address assignments.
993                 with_ascend_hack = no
994                 ascend_channels_per_line = 23
995
996                 # Windows NT machines often authenticate themselves as
997                 # NT_DOMAIN\username
998                 #
999                 # If this is set to 'yes', then the NT_DOMAIN portion
1000                 # of the user-name is silently discarded.
1001                 #
1002                 # This configuration entry SHOULD NOT be used.
1003                 # See the "realms" module for a better way to handle
1004                 # NT domains.
1005                 with_ntdomain_hack = no
1006
1007                 # Specialix Jetstream 8500 24 port access server.
1008                 #
1009                 # If the user name is 10 characters or longer, a "/"
1010                 # and the excess characters after the 10th are
1011                 # appended to the user name.
1012                 #
1013                 # If you're not running that NAS, you don't need
1014                 # this hack.
1015                 with_specialix_jetstream_hack = no
1016
1017                 # Cisco (and Quintum in Cisco mode) sends it's VSA attributes
1018                 # with the attribute name *again* in the string, like:
1019                 #
1020                 #   H323-Attribute = "h323-attribute=value".
1021                 #
1022                 # If this configuration item is set to 'yes', then
1023                 # the redundant data in the the attribute text is stripped
1024                 # out.  The result is:
1025                 #
1026                 #  H323-Attribute = "value"
1027                 #
1028                 # If you're not running a Cisco or Quintum NAS, you don't
1029                 # need this hack.
1030                 with_cisco_vsa_hack = no
1031         }
1032
1033         # Livingston-style 'users' file
1034         #
1035         files {
1036                 usersfile = ${confdir}/users
1037                 acctusersfile = ${confdir}/acct_users
1038                 preproxy_usersfile = ${confdir}/preproxy_users
1039
1040                 #  If you want to use the old Cistron 'users' file
1041                 #  with FreeRADIUS, you should change the next line
1042                 #  to 'compat = cistron'.  You can the copy your 'users'
1043                 #  file from Cistron.
1044                 compat = no
1045         }
1046
1047         # Write a detailed log of all accounting records received.
1048         #
1049         detail {
1050                 #  Note that we do NOT use NAS-IP-Address here, as
1051                 #  that attribute MAY BE from the originating NAS, and
1052                 #  NOT from the proxy which actually sent us the
1053                 #  request.  The Client-IP-Address attribute is ALWAYS
1054                 #  the address of the client which sent us the
1055                 #  request.
1056                 #
1057                 #  The following line creates a new detail file for
1058                 #  every radius client (by IP address or hostname).
1059                 #  In addition, a new detail file is created every
1060                 #  day, so that the detail file doesn't have to go
1061                 #  through a 'log rotation'
1062                 #
1063                 #  If your detail files are large, you may also want
1064                 #  to add a ':%H' (see doc/variables.txt) to the end
1065                 #  of it, to create a new detail file every hour, e.g.:
1066                 #
1067                 #   ..../detail-%Y%m%d:%H
1068                 #
1069                 #  This will create a new detail file for every hour.
1070                 #
1071                 detailfile = ${radacctdir}/%{Client-IP-Address}/detail-%Y%m%d
1072
1073                 #
1074                 #  The Unix-style permissions on the 'detail' file.
1075                 #
1076                 #  The detail file often contains secret or private
1077                 #  information about users.  So by keeping the file
1078                 #  permissions restrictive, we can prevent unwanted
1079                 #  people from seeing that information.
1080                 detailperm = 0600
1081         }
1082
1083         #
1084         #  Many people want to log authentication requests.
1085         #  Rather than modifying the server core to print out more
1086         #  messages, we can use a different instance of the 'detail'
1087         #  module, to log the authentication requests to a file.
1088         #
1089         #  You will also need to un-comment the 'auth_log' line
1090         #  in the 'authorize' section, below.
1091         #
1092         # detail auth_log {
1093                 # detailfile = ${radacctdir}/%{Client-IP-Address}/auth-detail-%Y%m%d
1094
1095                 #
1096                 #  This MUST be 0600, otherwise anyone can read
1097                 #  the users passwords!
1098                 # detailperm = 0600
1099         # }
1100
1101         #
1102         #  This module logs authentication reply packets sent
1103         #  to a NAS.  Both Access-Accept and Access-Reject packets
1104         #  are logged.
1105         #
1106         #  You will also need to un-comment the 'reply_log' line
1107         #  in the 'post-auth' section, below.
1108         #
1109         # detail reply_log {
1110                 # detailfile = ${radacctdir}/%{Client-IP-Address}/reply-detail-%Y%m%d
1111
1112                 #
1113                 #  This MUST be 0600, otherwise anyone can read
1114                 #  the users passwords!
1115                 # detailperm = 0600
1116         # }
1117
1118         #
1119         #  This module logs packets proxied to a home server.
1120         #
1121         #  You will also need to un-comment the 'pre_proxy_log' line
1122         #  in the 'pre-proxy' section, below.
1123         #
1124         # detail pre_proxy_log {
1125                 # detailfile = ${radacctdir}/%{Client-IP-Address}/pre-proxy-detail-%Y%m%d
1126
1127                 #
1128                 #  This MUST be 0600, otherwise anyone can read
1129                 #  the users passwords!
1130                 # detailperm = 0600
1131         # }
1132
1133         #
1134         #  This module logs response packets from a home server.
1135         #
1136         #  You will also need to un-comment the 'post_proxy_log' line
1137         #  in the 'post-proxy' section, below.
1138         #
1139         # detail post_proxy_log {
1140                 # detailfile = ${radacctdir}/%{Client-IP-Address}/post-proxy-detail-%Y%m%d
1141
1142                 #
1143                 #  This MUST be 0600, otherwise anyone can read
1144                 #  the users passwords!
1145                 # detailperm = 0600
1146         # }
1147
1148         # Create a unique accounting session Id.  Many NASes re-use or
1149         # repeat values for Acct-Session-Id, causing no end of
1150         # confusion.
1151         #
1152         #  This module will add a (probably) unique session id 
1153         #  to an accounting packet based on the attributes listed
1154         #  below found in the packet.  See doc/rlm_acct_unique for
1155         #  more information.
1156         #
1157         acct_unique {
1158                 key = "User-Name, Acct-Session-Id, NAS-IP-Address, Client-IP-Address, NAS-Port"
1159         }
1160
1161
1162         #  Include another file that has the SQL-related configuration.
1163         #  This is another file only because it tends to be big.
1164         #
1165         #  The following configuration file is for use with MySQL.
1166         #
1167         #  For Postgresql, use:         ${confdir}/postgresql.conf
1168         #  For MS-SQL, use:             ${confdir}/mssql.conf
1169         #  For Oracle, use:             ${confdir}/oraclesql.conf
1170         #
1171         $INCLUDE  ${confdir}/sql.conf
1172
1173
1174         #  For Cisco VoIP specific accounting with Postgresql,
1175         #  use:         ${confdir}/pgsql-voip.conf
1176         #
1177         #  You will also need the sql schema from:
1178         #        src/billing/cisco_h323_db_schema-postgres.sql
1179         #  Note: This config can be use AS WELL AS the standard sql
1180         #  config if you need SQL based Auth
1181         
1182
1183         #  Write a 'utmp' style file, of which users are currently
1184         #  logged in, and where they've logged in from.
1185         #
1186         #  This file is used mainly for Simultaneous-Use checking,
1187         #  and also 'radwho', to see who's currently logged in.
1188         #
1189         radutmp {
1190                 #  Where the file is stored.  It's not a log file,
1191                 #  so it doesn't need rotating.
1192                 #
1193                 filename = ${logdir}/radutmp
1194
1195                 #  The field in the packet to key on for the
1196                 #  'user' name,  If you have other fields which you want
1197                 #  to use to key on to control Simultaneous-Use,
1198                 #  then you can use them here.
1199                 #
1200                 #  Note, however, that the size of the field in the
1201                 #  'utmp' data structure is small, around 32
1202                 #  characters, so that will limit the possible choices
1203                 #  of keys.
1204                 #
1205                 #  You may want instead: %{Stripped-User-Name:-%{User-Name}}
1206                 username = %{User-Name}
1207
1208
1209                 #  Whether or not we want to treat "user" the same
1210                 #  as "USER", or "User".  Some systems have problems
1211                 #  with case sensitivity, so this should be set to
1212                 #  'no' to enable the comparisons of the key attribute
1213                 #  to be case insensitive.
1214                 #
1215                 case_sensitive = yes
1216
1217                 #  Accounting information may be lost, so the user MAY
1218                 #  have logged off of the NAS, but we haven't noticed.
1219                 #  If so, we can verify this information with the NAS,
1220                 #
1221                 #  If we want to believe the 'utmp' file, then this
1222                 #  configuration entry can be set to 'no'.
1223                 #
1224                 check_with_nas = yes            
1225
1226                 # Set the file permissions, as the contents of this file
1227                 # are usually private.
1228                 perm = 0600
1229
1230                 callerid = "yes"
1231         }
1232
1233         # "Safe" radutmp - does not contain caller ID, so it can be
1234         # world-readable, and radwho can work for normal users, without
1235         # exposing any information that isn't already exposed by who(1).
1236         #
1237         # This is another 'instance' of the radutmp module, but it is given
1238         # then name "sradutmp" to identify it later in the "accounting"
1239         # section.
1240         radutmp sradutmp {
1241                 filename = ${logdir}/sradutmp
1242                 perm = 0644
1243                 callerid = "no"
1244         }
1245
1246         # attr_filter - filters the attributes received in replies from
1247         # proxied servers, to make sure we send back to our RADIUS client
1248         # only allowed attributes.
1249         attr_filter {
1250                 attrsfile = ${confdir}/attrs
1251         }
1252
1253         #  counter module:
1254         #  This module takes an attribute (count-attribute).
1255         #  It also takes a key, and creates a counter for each unique
1256         #  key.  The count is incremented when accounting packets are
1257         #  received by the server.  The value of the increment depends
1258         #  on the attribute type.
1259         #  If the attribute is Acct-Session-Time or of an integer type we add the
1260         #  value of the attribute. If it is anything else we increase the
1261         #  counter by one.
1262         #
1263         #  The 'reset' parameter defines when the counters are all reset to
1264         #  zero.  It can be hourly, daily, weekly, monthly or never.
1265         #
1266         #  hourly: Reset on 00:00 of every hour
1267         #  daily: Reset on 00:00:00 every day
1268         #  weekly: Reset on 00:00:00 on sunday
1269         #  monthly: Reset on 00:00:00 of the first day of each month
1270         #
1271         #  It can also be user defined. It should be of the form:
1272         #  num[hdwm] where:
1273         #  h: hours, d: days, w: weeks, m: months
1274         #  If the letter is ommited days will be assumed. In example:
1275         #  reset = 10h (reset every 10 hours)
1276         #  reset = 12  (reset every 12 days)
1277         #
1278         #
1279         #  The check-name attribute defines an attribute which will be
1280         #  registered by the counter module and can be used to set the
1281         #  maximum allowed value for the counter after which the user
1282         #  is rejected.
1283         #  Something like:
1284         #
1285         #  DEFAULT Max-Daily-Session := 36000
1286         #          Fall-Through = 1
1287         #
1288         #  You should add the counter module in the instantiate
1289         #  section so that it registers check-name before the files
1290         #  module reads the users file.
1291         #
1292         #  If check-name is set and the user is to be rejected then we
1293         #  send back a Reply-Message and we log a Failure-Message in
1294         #  the radius.log
1295         #  If the count attribute is Acct-Session-Time then on each login
1296         #  we send back the remaining online time as a Session-Timeout attribute
1297         #
1298         #  The counter-name can also be used instead of using the check-name
1299         #  like below:
1300         #
1301         #  DEFAULT  Daily-Session-Time > 3600, Auth-Type = Reject
1302         #      Reply-Message = "You've used up more than one hour today"
1303         #
1304         #  The allowed-servicetype attribute can be used to only take
1305         #  into account specific sessions. For example if a user first
1306         #  logs in through a login menu and then selects ppp there will
1307         #  be two sessions. One for Login-User and one for Framed-User
1308         #  service type. We only need to take into account the second one.
1309         #
1310         #  The module should be added in the instantiate, authorize and
1311         #  accounting sections.  Make sure that in the authorize
1312         #  section it comes after any module which sets the
1313         #  'check-name' attribute.
1314         #
1315         counter daily {
1316                 filename = ${raddbdir}/db.daily
1317                 key = User-Name
1318                 count-attribute = Acct-Session-Time
1319                 reset = daily
1320                 counter-name = Daily-Session-Time
1321                 check-name = Max-Daily-Session
1322                 allowed-servicetype = Framed-User
1323                 cache-size = 5000
1324         }
1325
1326         # The "always" module is here for debugging purposes. Each
1327         # instance simply returns the same result, always, without
1328         # doing anything.
1329         always fail {
1330                 rcode = fail
1331         }
1332         always reject {
1333                 rcode = reject
1334         }
1335         always ok {
1336                 rcode = ok
1337                 simulcount = 0
1338                 mpp = no
1339         }
1340
1341         #
1342         #  The 'expression' module currently has no configuration.
1343         #
1344         #  This module is useful only for 'xlat'.  To use it,
1345         #  put 'exec' into the 'instantiate' section.  You can then
1346         #  do dynamic translation of attributes like:
1347         #
1348         #  Attribute-Name = `%{expr:2 + 3 + %{exec: uid -u}}`
1349         #
1350         #  The value of the attribute will be replaced with the output
1351         #  of the program which is executed.  Due to RADIUS protocol
1352         #  limitations, any output over 253 bytes will be ignored.
1353         expr {
1354         }
1355
1356         #
1357         #  The 'digest' module currently has no configuration.
1358         #
1359         #  "Digest" authentication against a Cisco SIP server.
1360         #  See 'doc/rfc/draft-sterman-aaa-sip-00.txt' for details
1361         #  on performing digest authentication for Cisco SIP servers.
1362         #
1363         digest {
1364         }
1365
1366         #
1367         #  Execute external programs
1368         #
1369         #  This module is useful only for 'xlat'.  To use it,
1370         #  put 'exec' into the 'instantiate' section.  You can then
1371         #  do dynamic translation of attributes like:
1372         #
1373         #  Attribute-Name = `%{exec:/path/to/program args}`
1374         #
1375         #  The value of the attribute will be replaced with the output
1376         #  of the program which is executed.  Due to RADIUS protocol
1377         #  limitations, any output over 253 bytes will be ignored.
1378         #
1379         #  The RADIUS attributes from the user request will be placed
1380         #  into environment variables of the executed program, as
1381         #  described in 'doc/variables.txt'
1382         #
1383         exec {
1384                 wait = yes
1385                 input_pairs = request
1386         }
1387
1388         #
1389         #  This is a more general example of the execute module.
1390         #
1391         #  This one is called "echo".
1392         #
1393         #  Attribute-Name = `%{echo:/path/to/program args}`
1394         #
1395         #  If you wish to execute an external program in more than
1396         #  one section (e.g. 'authorize', 'pre_proxy', etc), then it
1397         #  is probably best to define a different instance of the
1398         #  'exec' module for every section.     
1399         #       
1400         exec echo {
1401                 #
1402                 #  Wait for the program to finish.
1403                 #
1404                 #  If we do NOT wait, then the program is "fire and
1405                 #  forget", and any output attributes from it are ignored.
1406                 #
1407                 #  If we are looking for the program to output
1408                 #  attributes, and want to add those attributes to the
1409                 #  request, then we MUST wait for the program to
1410                 #  finish, and therefore set 'wait=yes'
1411                 #
1412                 # allowed values: {no, yes}
1413                 wait = yes
1414
1415                 #
1416                 #  The name of the program to execute, and it's
1417                 #  arguments.  Dynamic translation is done on this
1418                 #  field, so things like the following example will
1419                 #  work.
1420                 #
1421                 program = "/bin/echo %{User-Name}"
1422
1423                 #
1424                 #  The attributes which are placed into the
1425                 #  environment variables for the program.
1426                 #
1427                 #  Allowed values are:
1428                 #
1429                 #       request         attributes from the request
1430                 #       config          attributes from the configuration items list
1431                 #       reply           attributes from the reply
1432                 #       proxy-request   attributes from the proxy request
1433                 #       proxy-reply     attributes from the proxy reply
1434                 #
1435                 #  Note that some attributes may not exist at some
1436                 #  stages.  e.g. There may be no proxy-reply
1437                 #  attributes if this module is used in the
1438                 #  'authorize' section.
1439                 #
1440                 input_pairs = request
1441
1442                 #
1443                 #  Where to place the output attributes (if any) from
1444                 #  the executed program.  The values allowed, and the
1445                 #  restrictions as to availability, are the same as
1446                 #  for the input_pairs.
1447                 #
1448                 output_pairs = reply
1449
1450                 #
1451                 #  When to execute the program.  If the packet
1452                 #  type does NOT match what's listed here, then
1453                 #  the module does NOT execute the program.
1454                 #
1455                 #  For a list of allowed packet types, see
1456                 #  the 'dictionary' file, and look for VALUEs
1457                 #  of the Packet-Type attribute.
1458                 #
1459                 #  By default, the module executes on ANY packet.
1460                 #  Un-comment out the following line to tell the
1461                 #  module to execute only if an Access-Accept is
1462                 #  being sent to the NAS.
1463                 #
1464                 #packet_type = Access-Accept
1465         }
1466
1467         #  Do server side ip pool management. Should be added in post-auth and
1468         #  accounting sections.
1469         #
1470         #  The module also requires the existance of the Pool-Name
1471         #  attribute. That way the administrator can add the Pool-Name
1472         #  attribute in the user profiles and use different pools
1473         #  for different users. The Pool-Name attribute is a *check* item not
1474         #  a reply item.
1475         #
1476         # Example:
1477         # radiusd.conf: ippool students { [...] }
1478         # users file  : DEFAULT Group == students, Pool-Name := "students"
1479         #
1480         # ********* IF YOU CHANGE THE RANGE PARAMETERS YOU MUST *********
1481         # ********* THEN ERASE THE DB FILES                     *********
1482         #
1483         ippool main_pool {
1484
1485                 #  range-start,range-stop: The start and end ip
1486                 #  addresses for the ip pool
1487                 range-start = 192.168.1.1
1488                 range-stop = 192.168.3.254
1489
1490                 #  netmask: The network mask used for the ip's
1491                 netmask = 255.255.255.0
1492
1493                 #  cache-size: The gdbm cache size for the db
1494                 #  files. Should be equal to the number of ip's
1495                 #  available in the ip pool
1496                 cache-size = 800
1497
1498                 # session-db: The main db file used to allocate ip's to clients
1499                 session-db = ${raddbdir}/db.ippool
1500
1501                 # ip-index: Helper db index file used in multilink
1502                 ip-index = ${raddbdir}/db.ipindex
1503
1504                 # override: Will this ippool override a Framed-IP-Address already set
1505                 override = no
1506
1507                 # maximum-timeout: If not zero specifies the maximum time in seconds an
1508                 # entry may be active. Default: 0
1509                 maximum-timeout = 0
1510         }
1511
1512         # OTP token support.  Not included by default.
1513         # $INCLUDE  ${confdir}/otp.conf
1514
1515 }
1516
1517 # Instantiation
1518 #
1519 #  This section orders the loading of the modules.  Modules
1520 #  listed here will get loaded BEFORE the later sections like
1521 #  authorize, authenticate, etc. get examined.
1522 #
1523 #  This section is not strictly needed.  When a section like
1524 #  authorize refers to a module, it's automatically loaded and
1525 #  initialized.  However, some modules may not be listed in any
1526 #  of the following sections, so they can be listed here.
1527 #
1528 #  Also, listing modules here ensures that you have control over
1529 #  the order in which they are initalized.  If one module needs
1530 #  something defined by another module, you can list them in order
1531 #  here, and ensure that the configuration will be OK.
1532 #
1533 instantiate {
1534         #
1535         #  Allows the execution of external scripts.
1536         #  The entire command line (and output) must fit into 253 bytes.
1537         #
1538         #  e.g. Framed-Pool = `%{exec:/bin/echo foo}`
1539         exec
1540
1541         #
1542         #  The expression module doesn't do authorization,
1543         #  authentication, or accounting.  It only does dynamic
1544         #  translation, of the form:
1545         #
1546         #       Session-Timeout = `%{expr:2 + 3}`
1547         #
1548         #  So the module needs to be instantiated, but CANNOT be
1549         #  listed in any other section.  See 'doc/rlm_expr' for
1550         #  more information.
1551         #
1552         expr
1553
1554         #
1555         # We add the counter module here so that it registers
1556         # the check-name attribute before any module which sets
1557         # it
1558 #       daily
1559 }
1560
1561 #  Authorization. First preprocess (hints and huntgroups files),
1562 #  then realms, and finally look in the "users" file.
1563 #
1564 #  The order of the realm modules will determine the order that
1565 #  we try to find a matching realm.
1566 #
1567 #  Make *sure* that 'preprocess' comes before any realm if you 
1568 #  need to setup hints for the remote radius server
1569 authorize {
1570         #
1571         #  The preprocess module takes care of sanitizing some bizarre
1572         #  attributes in the request, and turning them into attributes
1573         #  which are more standard.
1574         #
1575         #  It takes care of processing the 'raddb/hints' and the
1576         #  'raddb/huntgroups' files.
1577         #
1578         #  It also adds the %{Client-IP-Address} attribute to the request.
1579         preprocess
1580
1581         #
1582         #  If you want to have a log of authentication requests,
1583         #  un-comment the following line, and the 'detail auth_log'
1584         #  section, above.
1585 #       auth_log
1586         
1587 #       attr_filter
1588
1589         #
1590         #  The chap module will set 'Auth-Type := CHAP' if we are
1591         #  handling a CHAP request and Auth-Type has not already been set
1592         chap
1593
1594         #
1595         #  If the users are logging in with an MS-CHAP-Challenge
1596         #  attribute for authentication, the mschap module will find
1597         #  the MS-CHAP-Challenge attribute, and add 'Auth-Type := MS-CHAP'
1598         #  to the request, which will cause the server to then use
1599         #  the mschap module for authentication.
1600         mschap
1601
1602         #
1603         #  If you have a Cisco SIP server authenticating against
1604         #  FreeRADIUS, uncomment the following line, and the 'digest'
1605         #  line in the 'authenticate' section.
1606 #       digest
1607
1608         #
1609         #  Look for IPASS style 'realm/', and if not found, look for
1610         #  '@realm', and decide whether or not to proxy, based on
1611         #  that.
1612 #       IPASS
1613
1614         #
1615         #  If you are using multiple kinds of realms, you probably
1616         #  want to set "ignore_null = yes" for all of them.
1617         #  Otherwise, when the first style of realm doesn't match,
1618         #  the other styles won't be checked.
1619         #
1620         suffix
1621 #       ntdomain
1622
1623         #
1624         #  This module takes care of EAP-MD5, EAP-TLS, and EAP-LEAP
1625         #  authentication.
1626         #
1627         #  It also sets the EAP-Type attribute in the request
1628         #  attribute list to the EAP type from the packet.
1629         eap
1630
1631         #
1632         #  Read the 'users' file
1633         files
1634
1635         #
1636         #  Look in an SQL database.  The schema of the database
1637         #  is meant to mirror the "users" file.
1638         #
1639         #  See "Authorization Queries" in sql.conf
1640 #       sql
1641
1642         #
1643         #  If you are using /etc/smbpasswd, and are also doing
1644         #  mschap authentication, the un-comment this line, and
1645         #  configure the 'etc_smbpasswd' module, above.
1646 #       etc_smbpasswd
1647
1648         #
1649         #  The ldap module will set Auth-Type to LDAP if it has not
1650         #  already been set
1651 #       ldap
1652
1653         #
1654         #  Enforce daily limits on time spent logged in.
1655 #       daily
1656
1657         #
1658         # Use the checkval module
1659 #       checkval
1660 }
1661
1662
1663 #  Authentication.
1664 #
1665 #
1666 #  This section lists which modules are available for authentication.
1667 #  Note that it does NOT mean 'try each module in order'.  It means
1668 #  that a module from the 'authorize' section adds a configuration
1669 #  attribute 'Auth-Type := FOO'.  That authentication type is then
1670 #  used to pick the apropriate module from the list below.
1671 #
1672
1673 #  In general, you SHOULD NOT set the Auth-Type attribute.  The server
1674 #  will figure it out on its own, and will do the right thing.  The
1675 #  most common side effect of erroneously setting the Auth-Type
1676 #  attribute is that one authentication method will work, but the
1677 #  others will not.
1678 #
1679 #  The common reasons to set the Auth-Type attribute by hand
1680 #  is to either forcibly reject the user, or forcibly accept him.
1681 #
1682 authenticate {
1683         #
1684         #  PAP authentication, when a back-end database listed
1685         #  in the 'authorize' section supplies a password.  The
1686         #  password can be clear-text, or encrypted.
1687         Auth-Type PAP {
1688                 pap
1689         }
1690
1691         #
1692         #  Most people want CHAP authentication
1693         #  A back-end database listed in the 'authorize' section
1694         #  MUST supply a CLEAR TEXT password.  Encrypted passwords
1695         #  won't work.
1696         Auth-Type CHAP {
1697                 chap
1698         }
1699
1700         #
1701         #  MSCHAP authentication.
1702         Auth-Type MS-CHAP {
1703                 mschap
1704         }
1705
1706         #
1707         #  If you have a Cisco SIP server authenticating against
1708         #  FreeRADIUS, uncomment the following line, and the 'digest'
1709         #  line in the 'authorize' section.
1710 #       digest
1711
1712         #
1713         #  Pluggable Authentication Modules.
1714 #       pam
1715
1716         #
1717         #  See 'man getpwent' for information on how the 'unix'
1718         #  module checks the users password.  Note that packets
1719         #  containing CHAP-Password attributes CANNOT be authenticated
1720         #  against /etc/passwd!  See the FAQ for details.
1721         #  
1722         unix
1723
1724         # Uncomment it if you want to use ldap for authentication
1725         #
1726         # Note that this means "check plain-text password against
1727         # the ldap database", which means that EAP won't work,
1728         # as it does not supply a plain-text password.
1729 #       Auth-Type LDAP {
1730 #               ldap
1731 #       }
1732
1733         #
1734         #  Allow EAP authentication.
1735         eap
1736 }
1737
1738
1739 #
1740 #  Pre-accounting.  Decide which accounting type to use.
1741 #
1742 preacct {
1743         preprocess
1744
1745         #
1746         #  Ensure that we have a semi-unique identifier for every
1747         #  request, and many NAS boxes are broken.
1748         acct_unique
1749
1750         #
1751         #  Look for IPASS-style 'realm/', and if not found, look for
1752         #  '@realm', and decide whether or not to proxy, based on
1753         #  that.
1754         #
1755         #  Accounting requests are generally proxied to the same
1756         #  home server as authentication requests.
1757 #       IPASS
1758         suffix
1759 #       ntdomain
1760
1761         #
1762         #  Read the 'acct_users' file
1763         files
1764 }
1765
1766 #
1767 #  Accounting.  Log the accounting data.
1768 #
1769 accounting {
1770         #
1771         #  Create a 'detail'ed log of the packets.
1772         #  Note that accounting requests which are proxied
1773         #  are also logged in the detail file.
1774         detail
1775 #       daily
1776
1777         #  Update the wtmp file
1778         #
1779         #  If you don't use "radlast", you can delete this line.
1780         unix
1781
1782         #
1783         #  For Simultaneous-Use tracking.
1784         #
1785         #  Due to packet losses in the network, the data here
1786         #  may be incorrect.  There is little we can do about it.
1787         radutmp
1788 #       sradutmp
1789
1790         #  Return an address to the IP Pool when we see a stop record.
1791 #       main_pool
1792
1793         #
1794         #  Log traffic to an SQL database.
1795         #
1796         #  See "Accounting queries" in sql.conf
1797 #       sql
1798
1799
1800         #  Cisco VoIP specific bulk accounting
1801 #       pgsql-voip
1802
1803 }
1804
1805
1806 #  Session database, used for checking Simultaneous-Use. Either the radutmp 
1807 #  or rlm_sql module can handle this.
1808 #  The rlm_sql module is *much* faster
1809 session {
1810         radutmp
1811
1812         #
1813         #  See "Simultaneous Use Checking Querie" in sql.conf
1814 #       sql
1815 }
1816
1817
1818 #  Post-Authentication
1819 #  Once we KNOW that the user has been authenticated, there are
1820 #  additional steps we can take.
1821 post-auth {
1822         #  Get an address from the IP Pool.
1823 #       main_pool
1824
1825         #
1826         #  If you want to have a log of authentication replies,
1827         #  un-comment the following line, and the 'detail reply_log'
1828         #  section, above.
1829 #       reply_log
1830
1831         #
1832         #  After authenticating the user, do another SQL qeury.
1833         #
1834         #  See "Authentication Logging Queries" in sql.conf
1835 #       sql
1836
1837         #
1838         #  Un-comment the following if you have set
1839         #  'edir_account_policy_check = yes' in the ldap module sub-section of
1840         #  the 'modules' section.
1841         #
1842 #       ldap
1843         #
1844         #  Access-Reject packets are sent through the REJECT sub-section of the
1845         #  post-auth section.
1846         #  Uncomment the following and set the module name to the ldap instance
1847         #  name if you have set 'edir_account_policy_check = yes' in the ldap
1848         #  module sub-section of the 'modules' section.
1849         #
1850 #       Post-Auth-Type REJECT {
1851 #               insert-module-name-here
1852 #       }
1853
1854 }
1855
1856 #
1857 #  When the server decides to proxy a request to a home server,
1858 #  the proxied request is first passed through the pre-proxy
1859 #  stage.  This stage can re-write the request, or decide to
1860 #  cancel the proxy.
1861 #
1862 #  Only a few modules currently have this method.
1863 #
1864 pre-proxy {
1865 #       attr_rewrite
1866
1867         #  Uncomment the following line if you want to change attributes
1868         #  as defined in the preproxy_users file.
1869 #       files
1870
1871         #  If you want to have a log of packets proxied to a home
1872         #  server, un-comment the following line, and the
1873         #  'detail pre_proxy_log' section, above.
1874 #       pre_proxy_log
1875 }
1876
1877 #
1878 #  When the server receives a reply to a request it proxied
1879 #  to a home server, the request may be massaged here, in the
1880 #  post-proxy stage.
1881 #
1882 post-proxy {
1883
1884         #  If you want to have a log of replies from a home server,
1885         #  un-comment the following line, and the 'detail post_proxy_log'
1886         #  section, above.
1887 #       post_proxy_log
1888
1889 #       attr_rewrite
1890
1891         #  Uncomment the following line if you want to filter replies from
1892         #  remote proxies based on the rules defined in the 'attrs' file.
1893
1894 #       attr_filter
1895
1896         #
1897         #  If you are proxying LEAP, you MUST configure the EAP
1898         #  module, and you MUST list it here, in the post-proxy
1899         #  stage.
1900         #
1901         #  You MUST also use the 'nostrip' option in the 'realm'
1902         #  configuration.  Otherwise, the User-Name attribute
1903         #  in the proxied request will not match the user name
1904         #  hidden inside of the EAP packet, and the end server will
1905         #  reject the EAP request.
1906         #
1907         eap
1908 }