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 modconfdir = ${confdir}/mods-config
70 certdir = ${confdir}/certs
71 cadir = ${confdir}/certs
72 run_dir = ${localstatedir}/run/${name}
74 # Should likely be ${localstatedir}/lib/radiusd
78 # libdir: Where to find the rlm_* modules.
80 # This should be automatically set at configuration time.
82 # If the server builds and installs, but fails at execution time
83 # with an 'undefined symbol' error, then you can use the libdir
84 # directive to work around the problem.
86 # The cause is usually that a library has been installed on your
87 # system in a place where the dynamic linker CANNOT find it. When
88 # executing as root (or another user), your personal environment MAY
89 # be set up to allow the dynamic linker to find the library. When
90 # executing as a daemon, FreeRADIUS MAY NOT have the same
91 # personalized configuration.
93 # To work around the problem, find out which library contains that symbol,
94 # and add the directory containing that library to the end of 'libdir',
95 # with a colon separating the directory names. NO spaces are allowed.
97 # e.g. libdir = /usr/local/lib:/opt/package/lib
99 # You can also try setting the LD_LIBRARY_PATH environment variable
100 # in a script which starts the server.
102 # If that does not work, then you can re-configure and re-build the
103 # server to NOT use shared libraries, via:
105 # ./configure --disable-shared
111 # pidfile: Where to place the PID of the RADIUS server.
113 # The server may be signalled while it's running by using this
116 # This file is written when ONLY running in daemon mode.
118 # e.g.: kill -HUP `cat /var/run/radiusd/radiusd.pid`
120 pidfile = ${run_dir}/${name}.pid
122 # panic_action: Command to execute if the server dies unexpectedly.
124 # FOR PRODUCTION SYSTEMS, ACTIONS SHOULD ALWAYS EXIT.
125 # AN INTERACTIVE ACTION MEANS THE SERVER IS NOT RESPONDING TO REQUESTS.
126 # AN INTERACTICE ACTION MEANS THE SERVER WILL NOT RESTART.
128 # The panic action is a command which will be executed if the server
129 # receives a fatal, non user generated signal, i.e. SIGSEGV, SIGBUS,
132 # This can be used to start an interactive debugging session so
133 # that information regarding the current state of the server can
136 # The following string substitutions are available:
137 # - %e The currently executing program e.g. /sbin/radiusd
138 # - %p The PID of the currently executing program e.g. 12345
140 # Standard ${} substitutions are also allowed.
142 # An example panic action for opening an interactive session in GDB would be:
144 #panic_action = "gdb %e %p"
146 # Again, don't use that on a production system.
148 # An example panic action for opening an automated session in GDB would be:
150 #panic_action = "gdb -silent -x ${raddbdir}/panic.gdb %e %p 2>&1 | tee ${logdir}/gdb-${name}-%p.log"
152 # That command can be used on a production system.
155 # max_request_time: The maximum time (in seconds) to handle a request.
157 # Requests which take more time than this to process may be killed, and
158 # a REJECT message is returned.
160 # WARNING: If you notice that requests take a long time to be handled,
161 # then this MAY INDICATE a bug in the server, in one of the modules
162 # used to handle a request, OR in your local configuration.
164 # This problem is most often seen when using an SQL database. If it takes
165 # more than a second or two to receive an answer from the SQL database,
166 # then it probably means that you haven't indexed the database. See your
167 # SQL server documentation for more information.
169 # Useful range of values: 5 to 120
171 max_request_time = 30
173 # cleanup_delay: The time to wait (in seconds) before cleaning up
174 # a reply which was sent to the NAS.
176 # The RADIUS request is normally cached internally for a short period
177 # of time, after the reply is sent to the NAS. The reply packet may be
178 # lost in the network, and the NAS will not see it. The NAS will then
179 # re-send the request, and the server will respond quickly with the
182 # If this value is set too low, then duplicate requests from the NAS
183 # MAY NOT be detected, and will instead be handled as separate requests.
185 # If this value is set too high, then the server will cache too many
186 # requests, and some new requests may get blocked. (See 'max_requests'.)
188 # Useful range of values: 2 to 10
192 # max_requests: The maximum number of requests which the server keeps
193 # track of. This should be 256 multiplied by the number of clients.
194 # e.g. With 4 clients, this number should be 1024.
196 # If this number is too low, then when the server becomes busy,
197 # it will not respond to any new requests, until the 'cleanup_delay'
198 # time has passed, and it has removed the old requests.
200 # If this number is set too high, then the server will use a bit more
201 # memory for no real benefit.
203 # If you aren't sure what it should be set to, it's better to set it
204 # too high than too low. Setting it to 1000 per client is probably
205 # the highest it should be.
207 # Useful range of values: 256 to infinity
211 # hostname_lookups: Log the names of clients or just their IP addresses
212 # e.g., www.freeradius.org (on) or 206.47.27.232 (off).
214 # The default is 'off' because it would be overall better for the net
215 # if people had to knowingly turn this feature on, since enabling it
216 # means that each client request will result in AT LEAST one lookup
217 # request to the nameserver. Enabling hostname_lookups will also
218 # mean that your server may stop randomly for 30 seconds from time
219 # to time, if the DNS requests take too long.
221 # Turning hostname lookups off also means that the server won't block
222 # for 30 seconds, if it sees an IP address which has no name associated
225 # allowed values: {no, yes}
227 hostname_lookups = no
230 # Logging section. The various "log_*" configuration items
231 # will eventually be moved here.
235 # Destination for log messages. This can be one of:
237 # files - log to "file", as defined below.
238 # syslog - to syslog (see also the "syslog_facility", below.
239 # stdout - standard output
240 # stderr - standard error.
242 # The command-line option "-X" over-rides this option, and forces
243 # logging to go to stdout.
248 # Highlight important messages sent to stderr and stdout.
250 # Option will be ignored (disabled) if output if TERM is not
251 # an xterm or output is not to a TTY.
256 # The logging messages for the server are appended to the
257 # tail of this file if destination == "files"
259 # If the server is running in debugging mode, this file is
262 file = ${logdir}/radius.log
265 # If this configuration parameter is set, then log messages for
266 # a *request* go to this file, rather than to radius.log.
268 # i.e. This is a log file per request, once the server has accepted
269 # the request as being from a valid client. Messages that are
270 # not associated with a request still go to radius.log.
272 # Not all log messages in the server core have been updated to use
273 # this new internal API. As a result, some messages will still
274 # go to radius.log. Please submit patches to fix this behavior.
276 # The file name is expanded dynamically. You should ONLY user
277 # server-side attributes for the filename (e.g. things you control).
278 # Using this feature MAY also slow down the server substantially,
279 # especially if you do thinks like SQL calls as part of the
280 # expansion of the filename.
282 # The name of the log file should use attributes that don't change
283 # over the lifetime of a request, such as User-Name,
284 # Virtual-Server or Packet-Src-IP-Address. Otherwise, the log
285 # messages will be distributed over multiple files.
287 # Logging can be enabled for an individual request by a special
288 # dynamic expansion macro: %{debug: 1}, where the debug level
289 # for this request is set to '1' (or 2, 3, etc.). e.g.
293 # Tmp-String-0 = "%{debug:1}"
297 # The attribute that the value is assigned to is unimportant,
298 # and should be a "throw-away" attribute with no side effects.
300 #requests = ${logdir}/radiusd-%{%{Virtual-Server}:-DEFAULT}-%Y%m%d.log
303 # Which syslog facility to use, if ${destination} == "syslog"
305 # The exact values permitted here are OS-dependent. You probably
306 # don't want to change this.
308 syslog_facility = daemon
310 # Log the full User-Name attribute, as it was found in the request.
312 # allowed values: {no, yes}
316 # Log authentication requests to the log file.
318 # allowed values: {no, yes}
322 # Log passwords with the authentication requests.
323 # auth_badpass - logs password if it's rejected
324 # auth_goodpass - logs password if it's correct
326 # allowed values: {no, yes}
331 # Log additional text at the end of the "Login OK" messages.
332 # for these to work, the "auth" and "auth_goodpass" or "auth_badpass"
333 # configurations above have to be set to "yes".
335 # The strings below are dynamically expanded, which means that
336 # you can put anything you want in them. However, note that
337 # this expansion can be slow, and can negatively impact server
344 # The program to execute to do concurrency checks.
345 checkrad = ${sbindir}/checkrad
347 # SECURITY CONFIGURATION
349 # There may be multiple methods of attacking on the server. This
350 # section holds the configuration items which minimize the impact
354 # chroot: directory where the server does "chroot".
356 # The chroot is done very early in the process of starting
357 # the server. After the chroot has been performed it
358 # switches to the "user" listed below (which MUST be
359 # specified). If "group" is specified, it switches to that
360 # group, too. Any other groups listed for the specified
361 # "user" in "/etc/group" are also added as part of this
364 # The current working directory (chdir / cd) is left
365 # *outside* of the chroot until all of the modules have been
366 # initialized. This allows the "raddb" directory to be left
367 # outside of the chroot. Once the modules have been
368 # initialized, it does a "chdir" to ${logdir}. This means
369 # that it should be impossible to break out of the chroot.
371 # If you are worried about security issues related to this
372 # use of chdir, then simply ensure that the "raddb" directory
373 # is inside of the chroot, end be sure to do "cd raddb"
374 # BEFORE starting the server.
376 # If the server is statically linked, then the only files
377 # that have to exist in the chroot are ${run_dir} and
378 # ${logdir}. If you do the "cd raddb" as discussed above,
379 # then the "raddb" directory has to be inside of the chroot
382 # chroot = /path/to/chroot/directory
384 # user/group: The name (or #number) of the user/group to run radiusd as.
386 # If these are commented out, the server will run as the
387 # user/group that started it. In order to change to a
388 # different user/group, you MUST be root ( or have root
389 # privileges ) to start the server.
391 # We STRONGLY recommend that you run the server with as few
392 # permissions as possible. That is, if you're not using
393 # shadow passwords, the user and group items below should be
396 # NOTE that some kernels refuse to setgid(group) when the
397 # value of (unsigned)group is above 60000; don't use group
398 # "nobody" on these systems!
400 # On systems with shadow passwords, you might have to set
401 # 'group = shadow' for the server to be able to read the
402 # shadow password file. If you can authenticate users while
403 # in debug mode, but not in daemon mode, it may be that the
404 # debugging mode server is running as a user that can read
405 # the shadow info, and the user listed below can not.
407 # The server will also try to use "initgroups" to read
408 # /etc/groups. It will join all groups where "user" is a
409 # member. This can allow for some finer-grained access
415 # Core dumps are a bad thing. This should only be set to
416 # 'yes' if you're debugging a problem with the server.
418 # allowed values: {no, yes}
420 allow_core_dumps = no
423 # max_attributes: The maximum number of attributes
424 # permitted in a RADIUS packet. Packets which have MORE
425 # than this number of attributes in them will be dropped.
427 # If this number is set too low, then no RADIUS packets
430 # If this number is set too high, then an attacker may be
431 # able to send a small number of packets which will cause
432 # the server to use all available memory on the machine.
434 # Setting this number to 0 means "allow any number of attributes"
438 # reject_delay: When sending an Access-Reject, it can be
439 # delayed for a few seconds. This may help slow down a DoS
440 # attack. It also helps to slow down people trying to brute-force
441 # crack a users password.
443 # Setting this number to 0 means "send rejects immediately"
445 # If this number is set higher than 'cleanup_delay', then the
446 # rejects will be sent at 'cleanup_delay' time, when the request
447 # is deleted from the internal cache of requests.
449 # Useful ranges: 1 to 5
453 # status_server: Whether or not the server will respond
454 # to Status-Server requests.
456 # When sent a Status-Server message, the server responds with
457 # an Access-Accept or Accounting-Response packet.
459 # This is mainly useful for administrators who want to "ping"
460 # the server, without adding test users, or creating fake
461 # accounting packets.
463 # It's also useful when a NAS marks a RADIUS server "dead".
464 # The NAS can periodically "ping" the server with a Status-Server
465 # packet. If the server responds, it must be alive, and the
466 # NAS can start using it for real requests.
468 # See also raddb/sites-available/status
473 # PROXY CONFIGURATION
475 # proxy_requests: Turns proxying of RADIUS requests on or off.
477 # The server has proxying turned on by default. If your system is NOT
478 # set up to proxy requests to another server, then you can turn proxying
479 # off here. This will save a small amount of resources on the server.
481 # If you have proxying turned off, and your configuration files say
482 # to proxy a request, then an error message will be logged.
484 # To disable proxying, change the "yes" to "no", and comment the
487 # allowed values: {no, yes}
493 # CLIENTS CONFIGURATION
495 # Client configuration is defined in "clients.conf".
498 # The 'clients.conf' file contains all of the information from the old
499 # 'clients' and 'naslist' configuration files. We recommend that you
500 # do NOT use 'client's or 'naslist', although they are still
503 # Anything listed in 'clients.conf' will take precedence over the
504 # information from the old-style configuration files.
506 $INCLUDE clients.conf
509 # THREAD POOL CONFIGURATION
511 # The thread pool is a long-lived group of threads which
512 # take turns (round-robin) handling any incoming requests.
514 # You probably want to have a few spare threads around,
515 # so that high-load situations can be handled immediately. If you
516 # don't have any spare threads, then the request handling will
517 # be delayed while a new thread is created, and added to the pool.
519 # You probably don't want too many spare threads around,
520 # otherwise they'll be sitting there taking up resources, and
521 # not doing anything productive.
523 # The numbers given below should be adequate for most situations.
526 # Number of servers to start initially --- should be a reasonable
530 # Limit on the total number of servers running.
532 # If this limit is ever reached, clients will be LOCKED OUT, so it
533 # should NOT BE SET TOO LOW. It is intended mainly as a brake to
534 # keep a runaway server from taking the system with it as it spirals
537 # You may find that the server is regularly reaching the
538 # 'max_servers' number of threads, and that increasing
539 # 'max_servers' doesn't seem to make much difference.
541 # If this is the case, then the problem is MOST LIKELY that
542 # your back-end databases are taking too long to respond, and
543 # are preventing the server from responding in a timely manner.
545 # The solution is NOT do keep increasing the 'max_servers'
546 # value, but instead to fix the underlying cause of the
547 # problem: slow database, or 'hostname_lookups=yes'.
549 # For more information, see 'max_request_time', above.
553 # Server-pool size regulation. Rather than making you guess
554 # how many servers you need, FreeRADIUS dynamically adapts to
555 # the load it sees, that is, it tries to maintain enough
556 # servers to handle the current load, plus a few spare
557 # servers to handle transient load spikes.
559 # It does this by periodically checking how many servers are
560 # waiting for a request. If there are fewer than
561 # min_spare_servers, it creates a new spare. If there are
562 # more than max_spare_servers, some of the spares die off.
563 # The default values are probably OK for most sites.
565 min_spare_servers = 3
566 max_spare_servers = 10
568 # When the server receives a packet, it places it onto an
569 # internal queue, where the worker threads (configured above)
570 # pick it up for processing. The maximum size of that queue
573 # When the queue is full, any new packets will be silently
576 # The most common cause of the queue being full is that the
577 # server is dependent on a slow database, and it has received
578 # a large "spike" of traffic. When that happens, there is
579 # very little you can do other than make sure the server
580 # receives less traffic, or make sure that the database can
583 # max_queue_size = 65536
585 # There may be memory leaks or resource allocation problems with
586 # the server. If so, set this value to 300 or so, so that the
587 # resources will be cleaned up periodically.
589 # This should only be necessary if there are serious bugs in the
590 # server which have not yet been fixed.
592 # '0' is a special value meaning 'infinity', or 'the servers never
594 max_requests_per_server = 0
596 # Automatically limit the number of accounting requests.
597 # This configuration item tracks how many requests per second
598 # the server can handle. It does this by tracking the
599 # packets/s received by the server for processing, and
600 # comparing that to the packets/s handled by the child
604 # If the received PPS is larger than the processed PPS, *and*
605 # the queue is more than half full, then new accounting
606 # requests are probabilistically discarded. This lowers the
607 # number of packets that the server needs to process. Over
608 # time, the server will "catch up" with the traffic.
610 # Throwing away accounting packets is usually safe and low
611 # impact. The NAS will retransmit them in a few seconds, or
612 # even a few minutes. Vendors should read RFC 5080 Section 2.2.1
613 # to see how accounting packets should be retransmitted. Using
614 # any other method is likely to cause network meltdowns.
619 # MODULE CONFIGURATION
621 # The names and configuration of each module is located in this section.
623 # After the modules are defined here, they may be referred to by name,
624 # in other sections of this configuration file.
628 # Each module has a configuration as follows:
630 # name [ instance ] {
631 # config_item = value
635 # The 'name' is used to load the 'rlm_name' library
636 # which implements the functionality of the module.
638 # The 'instance' is optional. To have two different instances
639 # of a module, it first must be referred to by 'name'.
640 # The different copies of the module are then created by
641 # inventing two 'instance' names, e.g. 'instance1' and 'instance2'
643 # The instance names can then be used in later configuration
644 # INSTEAD of the original 'name'. See the 'radutmp' configuration
649 # As of 3.0, modules are in mods-enabled/. Files matching
650 # the regex /[a-zA-Z0-9_.]+/ are loaded. The modules are
651 # initialized ONLY if they are referenced in a processing
652 # section, such as authorize, authenticate, accounting,
653 # pre/post-proxy, etc.
655 $INCLUDE mods-enabled/
660 # This section orders the loading of the modules. Modules
661 # listed here will get loaded BEFORE the later sections like
662 # authorize, authenticate, etc. get examined.
664 # This section is not strictly needed. When a section like
665 # authorize refers to a module, it's automatically loaded and
666 # initialized. However, some modules may not be listed in any
667 # of the following sections, so they can be listed here.
669 # Also, listing modules here ensures that you have control over
670 # the order in which they are initialized. If one module needs
671 # something defined by another module, you can list them in order
672 # here, and ensure that the configuration will be OK.
674 # After the modules listed here have been loaded, all of the modules
675 # in the "mods-enabled" directory will be loaded. Loading the
676 # "mods-enabled" directory means that unlike Version 2, you usually
677 # don't need to list modules here.
681 # We list the counter module here so that it registers
682 # the check_name attribute before any module which sets
686 # subsections here can be thought of as "virtual" modules.
688 # e.g. If you have two redundant SQL servers, and you want to
689 # use them in the authorize and accounting sections, you could
690 # place a "redundant" block in each section, containing the
691 # exact same text. Or, you could uncomment the following
692 # lines, and list "redundant_sql" in the authorize and
693 # accounting sections.
695 #redundant redundant_sql {
701 ######################################################################
703 # Policies are virtual modules, similar to those defined in the
704 # "instantiate" section above.
706 # Defining a policy in one of the policy.d files means that it can be
707 # referenced in multiple places as a *name*, rather than as a series of
708 # conditions to match, and actions to take.
710 # Policies are something like subroutines in a normal language, but
711 # they cannot be called recursively. They MUST be defined in order.
712 # If policy A calls policy B, then B MUST be defined before A.
714 ######################################################################
719 ######################################################################
721 # SNMP notifications. Uncomment the following line to enable
722 # snmptraps. Note that you MUST also configure the full path
723 # to the "snmptrap" command in the "trigger.conf" file.
725 #$INCLUDE trigger.conf
727 ######################################################################
729 # Load virtual servers.
731 # This next $INCLUDE line loads files in the directory that
732 # match the regular expression: /[a-zA-Z0-9_.]+/
734 # It allows you to define new virtual servers simply by placing
735 # a file into the raddb/sites-enabled/ directory.
737 $INCLUDE sites-enabled/
739 ######################################################################
741 # All of the other configuration sections like "authorize {}",
742 # "authenticate {}", "accounting {}", have been moved to the
745 # raddb/sites-available/default
747 # This is the "default" virtual server that has the same
748 # configuration as in version 1.0.x and 1.1.x. The default
749 # installation enables this virtual server. You should
750 # edit it to create policies for your local site.
752 # For more documentation on virtual servers, see:
754 # raddb/sites-available/README
756 ######################################################################