3 ## radiusd.conf -- FreeRADIUS server configuration file - @RADIUSD_VERSION_STRING@
5 ## http://www.freeradius.org/
9 ######################################################################
11 # Read "man radiusd" before editing this file. See the section
12 # titled DEBUGGING. It outlines a method where you can quickly
13 # obtain the configuration you want, without running into
16 # Run the server in debugging mode, and READ the output.
20 # We cannot emphasize this point strongly enough. The vast
21 # majority of problems can be solved by carefully reading the
22 # debugging output, which includes warnings about common issues,
23 # and suggestions for how they may be fixed.
25 # There may be a lot of output, but look carefully for words like:
26 # "warning", "error", "reject", or "failure". The messages there
27 # will usually be enough to guide you to a solution.
29 # If you are going to ask a question on the mailing list, then
30 # explain what you are trying to do, and include the output from
31 # debugging mode (radiusd -X). Failure to do so means that all
32 # of the responses to your question will be people telling you
33 # to "post the output of radiusd -X".
35 ######################################################################
37 # The location of other config files and logfiles are declared
40 # Also general configuration for modules can be done in this
41 # file, it is exported through the API to modules that ask for
44 # See "man radiusd.conf" for documentation on the format of this
45 # file. Note that the individual configuration items are NOT
46 # documented in that "man" page. They are only documented here,
49 # As of 2.0.0, FreeRADIUS supports a simple processing language
50 # in the "authorize", "authenticate", "accounting", etc. sections.
51 # See "man unlang" for details.
55 exec_prefix = @exec_prefix@
56 sysconfdir = @sysconfdir@
57 localstatedir = @localstatedir@
61 radacctdir = @radacctdir@
64 # name of the running server. See also the "-n" command-line option.
67 # Location of config and logfiles.
69 certdir = ${confdir}/certs
70 cadir = ${confdir}/certs
71 run_dir = ${localstatedir}/run/${name}
73 # Should likely be ${localstatedir}/lib/radiusd
77 # libdir: Where to find the rlm_* modules.
79 # This should be automatically set at configuration time.
81 # If the server builds and installs, but fails at execution time
82 # with an 'undefined symbol' error, then you can use the libdir
83 # directive to work around the problem.
85 # The cause is usually that a library has been installed on your
86 # system in a place where the dynamic linker CANNOT find it. When
87 # executing as root (or another user), your personal environment MAY
88 # be set up to allow the dynamic linker to find the library. When
89 # executing as a daemon, FreeRADIUS MAY NOT have the same
90 # personalized configuration.
92 # To work around the problem, find out which library contains that symbol,
93 # and add the directory containing that library to the end of 'libdir',
94 # with a colon separating the directory names. NO spaces are allowed.
96 # e.g. libdir = /usr/local/lib:/opt/package/lib
98 # You can also try setting the LD_LIBRARY_PATH environment variable
99 # in a script which starts the server.
101 # If that does not work, then you can re-configure and re-build the
102 # server to NOT use shared libraries, via:
104 # ./configure --disable-shared
110 # pidfile: Where to place the PID of the RADIUS server.
112 # The server may be signalled while it's running by using this
115 # This file is written when ONLY running in daemon mode.
117 # e.g.: kill -HUP `cat /var/run/radiusd/radiusd.pid`
119 pidfile = ${run_dir}/${name}.pid
121 # max_request_time: The maximum time (in seconds) to handle a request.
123 # Requests which take more time than this to process may be killed, and
124 # a REJECT message is returned.
126 # WARNING: If you notice that requests take a long time to be handled,
127 # then this MAY INDICATE a bug in the server, in one of the modules
128 # used to handle a request, OR in your local configuration.
130 # This problem is most often seen when using an SQL database. If it takes
131 # more than a second or two to receive an answer from the SQL database,
132 # then it probably means that you haven't indexed the database. See your
133 # SQL server documentation for more information.
135 # Useful range of values: 5 to 120
137 max_request_time = 30
139 # cleanup_delay: The time to wait (in seconds) before cleaning up
140 # a reply which was sent to the NAS.
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
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.
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'.)
154 # Useful range of values: 2 to 10
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.
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.
166 # If this number is set too high, then the server will use a bit more
167 # memory for no real benefit.
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.
173 # Useful range of values: 256 to infinity
177 # hostname_lookups: Log the names of clients or just their IP addresses
178 # e.g., www.freeradius.org (on) or 206.47.27.232 (off).
180 # The default is 'off' because it would be overall better for the net
181 # if people had to knowingly turn this feature on, since enabling it
182 # means that each client request will result in AT LEAST one lookup
183 # request to the nameserver. Enabling hostname_lookups will also
184 # mean that your server may stop randomly for 30 seconds from time
185 # to time, if the DNS requests take too long.
187 # Turning hostname lookups off also means that the server won't block
188 # for 30 seconds, if it sees an IP address which has no name associated
191 # allowed values: {no, yes}
193 hostname_lookups = no
196 # Logging section. The various "log_*" configuration items
197 # will eventually be moved here.
201 # Destination for log messages. This can be one of:
203 # files - log to "file", as defined below.
204 # syslog - to syslog (see also the "syslog_facility", below.
205 # stdout - standard output
206 # stderr - standard error.
208 # The command-line option "-X" over-rides this option, and forces
209 # logging to go to stdout.
214 # The logging messages for the server are appended to the
215 # tail of this file if destination == "files"
217 # If the server is running in debugging mode, this file is
220 file = ${logdir}/radius.log
223 # If this configuration parameter is set, then log messages for
224 # a *request* go to this file, rather than to radius.log.
226 # i.e. This is a log file per request, once the server has accepted
227 # the request as being from a valid client. Messages that are
228 # not associated with a request still go to radius.log.
230 # Not all log messages in the server core have been updated to use
231 # this new internal API. As a result, some messages will still
232 # go to radius.log. Please submit patches to fix this behavior.
234 # The file name is expanded dynamically. You should ONLY user
235 # server-side attributes for the filename (e.g. things you control).
236 # Using this feature MAY also slow down the server substantially,
237 # especially if you do thinks like SQL calls as part of the
238 # expansion of the filename.
240 # The name of the log file should use attributes that don't change
241 # over the lifetime of a request, such as User-Name,
242 # Virtual-Server or Packet-Src-IP-Address. Otherwise, the log
243 # messages will be distributed over multiple files.
245 # Logging can be enabled for an individual request by a special
246 # dynamic expansion macro: %{debug: 1}, where the debug level
247 # for this request is set to '1' (or 2, 3, etc.). e.g.
251 # Tmp-String-0 = "%{debug:1}"
255 # The attribute that the value is assigned to is unimportant,
256 # and should be a "throw-away" attribute with no side effects.
258 #requests = ${logdir}/radiusd-%{%{Virtual-Server}:-DEFAULT}-%Y%m%d.log
261 # Which syslog facility to use, if ${destination} == "syslog"
263 # The exact values permitted here are OS-dependent. You probably
264 # don't want to change this.
266 syslog_facility = daemon
268 # Log the full User-Name attribute, as it was found in the request.
270 # allowed values: {no, yes}
274 # Log authentication requests to the log file.
276 # allowed values: {no, yes}
280 # Log passwords with the authentication requests.
281 # auth_badpass - logs password if it's rejected
282 # auth_goodpass - logs password if it's correct
284 # allowed values: {no, yes}
289 # Log additional text at the end of the "Login OK" messages.
290 # for these to work, the "auth" and "auth_goopass" or "auth_badpass"
291 # configurations above have to be set to "yes".
293 # The strings below are dynamically expanded, which means that
294 # you can put anything you want in them. However, note that
295 # this expansion can be slow, and can negatively impact server
302 # The program to execute to do concurrency checks.
303 checkrad = ${sbindir}/checkrad
305 # SECURITY CONFIGURATION
307 # There may be multiple methods of attacking on the server. This
308 # section holds the configuration items which minimize the impact
312 # chroot: directory where the server does "chroot".
314 # The chroot is done very early in the process of starting
315 # the server. After the chroot has been performed it
316 # switches to the "user" listed below (which MUST be
317 # specified). If "group" is specified, it switches to that
318 # group, too. Any other groups listed for the specified
319 # "user" in "/etc/group" are also added as part of this
322 # The current working directory (chdir / cd) is left
323 # *outside* of the chroot until all of the modules have been
324 # initialized. This allows the "raddb" directory to be left
325 # outside of the chroot. Once the modules have been
326 # initialized, it does a "chdir" to ${logdir}. This means
327 # that it should be impossible to break out of the chroot.
329 # If you are worried about security issues related to this
330 # use of chdir, then simply ensure that the "raddb" directory
331 # is inside of the chroot, end be sure to do "cd raddb"
332 # BEFORE starting the server.
334 # If the server is statically linked, then the only files
335 # that have to exist in the chroot are ${run_dir} and
336 # ${logdir}. If you do the "cd raddb" as discussed above,
337 # then the "raddb" directory has to be inside of the chroot
340 # chroot = /path/to/chroot/directory
342 # user/group: The name (or #number) of the user/group to run radiusd as.
344 # If these are commented out, the server will run as the
345 # user/group that started it. In order to change to a
346 # different user/group, you MUST be root ( or have root
347 # privleges ) to start the server.
349 # We STRONGLY recommend that you run the server with as few
350 # permissions as possible. That is, if you're not using
351 # shadow passwords, the user and group items below should be
354 # NOTE that some kernels refuse to setgid(group) when the
355 # value of (unsigned)group is above 60000; don't use group
356 # "nobody" on these systems!
358 # On systems with shadow passwords, you might have to set
359 # 'group = shadow' for the server to be able to read the
360 # shadow password file. If you can authenticate users while
361 # in debug mode, but not in daemon mode, it may be that the
362 # debugging mode server is running as a user that can read
363 # the shadow info, and the user listed below can not.
365 # The server will also try to use "initgroups" to read
366 # /etc/groups. It will join all groups where "user" is a
367 # member. This can allow for some finer-grained access
373 # Core dumps are a bad thing. This should only be set to
374 # 'yes' if you're debugging a problem with the server.
376 # allowed values: {no, yes}
378 allow_core_dumps = no
381 # max_attributes: The maximum number of attributes
382 # permitted in a RADIUS packet. Packets which have MORE
383 # than this number of attributes in them will be dropped.
385 # If this number is set too low, then no RADIUS packets
388 # If this number is set too high, then an attacker may be
389 # able to send a small number of packets which will cause
390 # the server to use all available memory on the machine.
392 # Setting this number to 0 means "allow any number of attributes"
396 # reject_delay: When sending an Access-Reject, it can be
397 # delayed for a few seconds. This may help slow down a DoS
398 # attack. It also helps to slow down people trying to brute-force
399 # crack a users password.
401 # Setting this number to 0 means "send rejects immediately"
403 # If this number is set higher than 'cleanup_delay', then the
404 # rejects will be sent at 'cleanup_delay' time, when the request
405 # is deleted from the internal cache of requests.
407 # Useful ranges: 1 to 5
411 # status_server: Whether or not the server will respond
412 # to Status-Server requests.
414 # When sent a Status-Server message, the server responds with
415 # an Access-Accept or Accounting-Response packet.
417 # This is mainly useful for administrators who want to "ping"
418 # the server, without adding test users, or creating fake
419 # accounting packets.
421 # It's also useful when a NAS marks a RADIUS server "dead".
422 # The NAS can periodically "ping" the server with a Status-Server
423 # packet. If the server responds, it must be alive, and the
424 # NAS can start using it for real requests.
426 # See also raddb/sites-available/status
431 # PROXY CONFIGURATION
433 # proxy_requests: Turns proxying of RADIUS requests on or off.
435 # The server has proxying turned on by default. If your system is NOT
436 # set up to proxy requests to another server, then you can turn proxying
437 # off here. This will save a small amount of resources on the server.
439 # If you have proxying turned off, and your configuration files say
440 # to proxy a request, then an error message will be logged.
442 # To disable proxying, change the "yes" to "no", and comment the
445 # allowed values: {no, yes}
451 # CLIENTS CONFIGURATION
453 # Client configuration is defined in "clients.conf".
456 # The 'clients.conf' file contains all of the information from the old
457 # 'clients' and 'naslist' configuration files. We recommend that you
458 # do NOT use 'client's or 'naslist', although they are still
461 # Anything listed in 'clients.conf' will take precedence over the
462 # information from the old-style configuration files.
464 $INCLUDE clients.conf
467 # THREAD POOL CONFIGURATION
469 # The thread pool is a long-lived group of threads which
470 # take turns (round-robin) handling any incoming requests.
472 # You probably want to have a few spare threads around,
473 # so that high-load situations can be handled immediately. If you
474 # don't have any spare threads, then the request handling will
475 # be delayed while a new thread is created, and added to the pool.
477 # You probably don't want too many spare threads around,
478 # otherwise they'll be sitting there taking up resources, and
479 # not doing anything productive.
481 # The numbers given below should be adequate for most situations.
484 # Number of servers to start initially --- should be a reasonable
488 # Limit on the total number of servers running.
490 # If this limit is ever reached, clients will be LOCKED OUT, so it
491 # should NOT BE SET TOO LOW. It is intended mainly as a brake to
492 # keep a runaway server from taking the system with it as it spirals
495 # You may find that the server is regularly reaching the
496 # 'max_servers' number of threads, and that increasing
497 # 'max_servers' doesn't seem to make much difference.
499 # If this is the case, then the problem is MOST LIKELY that
500 # your back-end databases are taking too long to respond, and
501 # are preventing the server from responding in a timely manner.
503 # The solution is NOT do keep increasing the 'max_servers'
504 # value, but instead to fix the underlying cause of the
505 # problem: slow database, or 'hostname_lookups=yes'.
507 # For more information, see 'max_request_time', above.
511 # Server-pool size regulation. Rather than making you guess
512 # how many servers you need, FreeRADIUS dynamically adapts to
513 # the load it sees, that is, it tries to maintain enough
514 # servers to handle the current load, plus a few spare
515 # servers to handle transient load spikes.
517 # It does this by periodically checking how many servers are
518 # waiting for a request. If there are fewer than
519 # min_spare_servers, it creates a new spare. If there are
520 # more than max_spare_servers, some of the spares die off.
521 # The default values are probably OK for most sites.
523 min_spare_servers = 3
524 max_spare_servers = 10
526 # When the server receives a packet, it places it onto an
527 # internal queue, where the worker threads (configured above)
528 # pick it up for processing. The maximum size of that queue
531 # When the queue is full, any new packets will be silently
534 # The most common cause of the queue being full is that the
535 # server is dependent on a slow database, and it has received
536 # a large "spike" of traffic. When that happens, there is
537 # very little you can do other than make sure the server
538 # receives less traffic, or make sure that the database can
541 # max_queue_size = 65536
543 # There may be memory leaks or resource allocation problems with
544 # the server. If so, set this value to 300 or so, so that the
545 # resources will be cleaned up periodically.
547 # This should only be necessary if there are serious bugs in the
548 # server which have not yet been fixed.
550 # '0' is a special value meaning 'infinity', or 'the servers never
552 max_requests_per_server = 0
554 # Automatically limit the number of accounting requests.
555 # This configuration item tracks how many requests per second
556 # the server can handle. It does this by tracking the
557 # packets/s received by the server for processing, and
558 # comparing that to the packets/s handled by the child
561 # If the received PPS is larger than the processed PPS, *and*
562 # the queue is more than half full, then all new accounting
563 # requests are discarded. This lowers the received rate,
564 # and over time allows the server to "catch up" to the traffic.
569 # MODULE CONFIGURATION
571 # The names and configuration of each module is located in this section.
573 # After the modules are defined here, they may be referred to by name,
574 # in other sections of this configuration file.
578 # Each module has a configuration as follows:
580 # name [ instance ] {
581 # config_item = value
585 # The 'name' is used to load the 'rlm_name' library
586 # which implements the functionality of the module.
588 # The 'instance' is optional. To have two different instances
589 # of a module, it first must be referred to by 'name'.
590 # The different copies of the module are then created by
591 # inventing two 'instance' names, e.g. 'instance1' and 'instance2'
593 # The instance names can then be used in later configuration
594 # INSTEAD of the original 'name'. See the 'radutmp' configuration
599 # As of 3.0, modules are in mods-enabled/. Files matching
600 # the regex /[a-zA-Z0-9_.]+/ are loaded. The modules are
601 # initialized ONLY if they are referenced in a processing
602 # section, such as authorize, authenticate, accounting,
603 # pre/post-proxy, etc.
605 $INCLUDE ${confdir}/mods-enabled/
610 # This section orders the loading of the modules. Modules
611 # listed here will get loaded BEFORE the later sections like
612 # authorize, authenticate, etc. get examined.
614 # This section is not strictly needed. When a section like
615 # authorize refers to a module, it's automatically loaded and
616 # initialized. However, some modules may not be listed in any
617 # of the following sections, so they can be listed here.
619 # Also, listing modules here ensures that you have control over
620 # the order in which they are initalized. If one module needs
621 # something defined by another module, you can list them in order
622 # here, and ensure that the configuration will be OK.
626 # Allows the execution of external scripts.
627 # The entire command line (and output) must fit into 253 bytes.
629 # e.g. Framed-Pool = `%{exec:/bin/echo foo}`
633 # The expression module doesn't do authorization,
634 # authentication, or accounting. It only does dynamic
635 # translation, of the form:
637 # Session-Timeout = `%{expr:2 + 3}`
639 # So the module needs to be instantiated, but CANNOT be
640 # listed in any other section. See 'doc/rlm_expr' for
646 # The DHCP module currently just registers some DHCP related
647 # expansions, but will eventually contain all the code necessary
648 # for encoding and decoding DHCP packets.
654 # We add the counter module here so that it registers
655 # the check-name attribute before any module which sets
661 # subsections here can be thought of as "virtual" modules.
663 # e.g. If you have two redundant SQL servers, and you want to
664 # use them in the authorize and accounting sections, you could
665 # place a "redundant" block in each section, containing the
666 # exact same text. Or, you could uncomment the following
667 # lines, and list "redundant_sql" in the authorize and
668 # accounting sections.
670 #redundant redundant_sql {
676 ######################################################################
678 # Policies are virtual modules, similar to those defined in the
679 # "instantate" section above.
681 # Defining a policy in one of the policy.d files means that it can be
682 # referenced in multiple places as a *name*, rather than as a series of
683 # conditions to match, and actions to take.
685 # Policies are something like subroutines in a normal language, but
686 # they cannot be called recursively. They MUST be defined in order.
687 # If policy A calls policy B, then B MUST be defined before A.
689 ######################################################################
694 ######################################################################
696 # SNMP notificiations. Uncomment the following line to enable
697 # snmptraps. Note that you MUST also configure the full path
698 # to the "snmptrap" command in the "trigger.conf" file.
700 #$INCLUDE trigger.conf
702 ######################################################################
704 # Load virtual servers.
706 # This next $INCLUDE line loads files in the directory that
707 # match the regular expression: /[a-zA-Z0-9_.]+/
709 # It allows you to define new virtual servers simply by placing
710 # a file into the raddb/sites-enabled/ directory.
712 $INCLUDE sites-enabled/
714 ######################################################################
716 # All of the other configuration sections like "authorize {}",
717 # "authenticate {}", "accounting {}", have been moved to the
720 # raddb/sites-available/default
722 # This is the "default" virtual server that has the same
723 # configuration as in version 1.0.x and 1.1.x. The default
724 # installation enables this virtual server. You should
725 # edit it to create policies for your local site.
727 # For more documentation on virtual servers, see:
729 # raddb/sites-available/README
731 ######################################################################