3 ## radiusd.conf -- FreeRADIUS server configuration file.
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 run_dir = ${localstatedir}/run/${name}
71 # Should likely be ${localstatedir}/lib/radiusd
75 # libdir: Where to find the rlm_* modules.
77 # This should be automatically set at configuration time.
79 # If the server builds and installs, but fails at execution time
80 # with an 'undefined symbol' error, then you can use the libdir
81 # directive to work around the problem.
83 # The cause is usually that a library has been installed on your
84 # system in a place where the dynamic linker CANNOT find it. When
85 # executing as root (or another user), your personal environment MAY
86 # be set up to allow the dynamic linker to find the library. When
87 # executing as a daemon, FreeRADIUS MAY NOT have the same
88 # personalized configuration.
90 # To work around the problem, find out which library contains that symbol,
91 # and add the directory containing that library to the end of 'libdir',
92 # with a colon separating the directory names. NO spaces are allowed.
94 # e.g. libdir = /usr/local/lib:/opt/package/lib
96 # You can also try setting the LD_LIBRARY_PATH environment variable
97 # in a script which starts the server.
99 # If that does not work, then you can re-configure and re-build the
100 # server to NOT use shared libraries, via:
102 # ./configure --disable-shared
108 # pidfile: Where to place the PID of the RADIUS server.
110 # The server may be signalled while it's running by using this
113 # This file is written when ONLY running in daemon mode.
115 # e.g.: kill -HUP `cat /var/run/radiusd/radiusd.pid`
117 pidfile = ${run_dir}/${name}.pid
119 # chroot: directory where the server does "chroot".
121 # The chroot is done very early in the process of starting the server.
122 # After the chroot has been performed it switches to the "user" listed
123 # below (which MUST be specified). If "group" is specified, it switchs
124 # to that group, too. Any other groups listed for the specified "user"
125 # in "/etc/group" are also added as part of this process.
127 # The current working directory (chdir / cd) is left *outside* of the
128 # chroot until all of the modules have been initialized. This allows
129 # the "raddb" directory to be left outside of the chroot. Once the
130 # modules have been initialized, it does a "chdir" to ${logdir}. This
131 # means that it should be impossible to break out of the chroot.
133 # If you are worried about security issues related to this use of chdir,
134 # then simply ensure that the "raddb" directory is inside of the chroot,
135 # end be sure to do "cd raddb" BEFORE starting the server.
137 # If the server is statically linked, then the only files that have
138 # to exist in the chroot are ${run_dir} and ${logdir}. If you do the
139 # "cd raddb" as discussed above, then the "raddb" directory has to be
140 # inside of the chroot directory, too.
142 #chroot = /path/to/chroot/directory
144 # user/group: The name (or #number) of the user/group to run radiusd as.
146 # If these are commented out, the server will run as the user/group
147 # that started it. In order to change to a different user/group, you
148 # MUST be root ( or have root privleges ) to start the server.
150 # We STRONGLY recommend that you run the server with as few permissions
151 # as possible. That is, if you're not using shadow passwords, the
152 # user and group items below should be set to radius'.
154 # NOTE that some kernels refuse to setgid(group) when the value of
155 # (unsigned)group is above 60000; don't use group nobody on these systems!
157 # On systems with shadow passwords, you might have to set 'group = shadow'
158 # for the server to be able to read the shadow password file. If you can
159 # authenticate users while in debug mode, but not in daemon mode, it may be
160 # that the debugging mode server is running as a user that can read the
161 # shadow info, and the user listed below can not.
163 # The server will also try to use "initgroups" to read /etc/groups.
164 # It will join all groups where "user" is a member. This can allow
165 # for some finer-grained access controls.
170 # max_request_time: The maximum time (in seconds) to handle a request.
172 # Requests which take more time than this to process may be killed, and
173 # a REJECT message is returned.
175 # WARNING: If you notice that requests take a long time to be handled,
176 # then this MAY INDICATE a bug in the server, in one of the modules
177 # used to handle a request, OR in your local configuration.
179 # This problem is most often seen when using an SQL database. If it takes
180 # more than a second or two to receive an answer from the SQL database,
181 # then it probably means that you haven't indexed the database. See your
182 # SQL server documentation for more information.
184 # Useful range of values: 5 to 120
186 max_request_time = 30
188 # cleanup_delay: The time to wait (in seconds) before cleaning up
189 # a reply which was sent to the NAS.
191 # The RADIUS request is normally cached internally for a short period
192 # of time, after the reply is sent to the NAS. The reply packet may be
193 # lost in the network, and the NAS will not see it. The NAS will then
194 # re-send the request, and the server will respond quickly with the
197 # If this value is set too low, then duplicate requests from the NAS
198 # MAY NOT be detected, and will instead be handled as seperate requests.
200 # If this value is set too high, then the server will cache too many
201 # requests, and some new requests may get blocked. (See 'max_requests'.)
203 # Useful range of values: 2 to 10
207 # max_requests: The maximum number of requests which the server keeps
208 # track of. This should be 256 multiplied by the number of clients.
209 # e.g. With 4 clients, this number should be 1024.
211 # If this number is too low, then when the server becomes busy,
212 # it will not respond to any new requests, until the 'cleanup_delay'
213 # time has passed, and it has removed the old requests.
215 # If this number is set too high, then the server will use a bit more
216 # memory for no real benefit.
218 # If you aren't sure what it should be set to, it's better to set it
219 # too high than too low. Setting it to 1000 per client is probably
220 # the highest it should be.
222 # Useful range of values: 256 to infinity
226 # listen: Make the server listen on a particular IP address, and send
227 # replies out from that address. This directive is most useful for
228 # hosts with multiple IP addresses on one interface.
230 # If you want the server to listen on additional addresses, or on
231 # additionnal ports, you can use multiple "listen" sections.
233 # Each section make the server listen for only one type of packet,
234 # therefore authentication and accounting have to be configured in
235 # different sections.
237 # The server ignore all "listen" section if you are using '-i' and '-p'
238 # on the command line.
241 # Type of packets to listen for.
242 # Allowed values are:
243 # auth listen for authentication packets
244 # acct listen for accounting packets
245 # proxy IP to use for sending proxied packets
246 # detail Read from the detail file. For examples, see
247 # raddb/sites-available/copy-acct-to-home-server
248 # status listen for Status-Server packets. For examples,
249 # see raddb/sites-available/status
253 # Note: "type = proxy" lets you control the source IP used for
254 # proxying packets, with some limitations:
256 # * Only ONE proxy listener can be defined.
257 # * A proxy listener CANNOT be used in a virtual server section.
258 # * You should probably set "port = 0".
259 # * Any "clients" configuration will be ignored.
261 # IP address on which to listen.
262 # Allowed values are:
263 # dotted quad (1.2.3.4)
264 # hostname (radius.example.com)
268 # OR, you can use an IPv6 address, but not both
270 # ipv6addr = :: # any. ::1 == localhost
272 # Port on which to listen.
273 # Allowed values are:
274 # integer port number (1812)
275 # 0 means "use /etc/services for the proper port"
278 # Some systems support binding to an interface, in addition
279 # to the IP address. This feature isn't strictly necessary,
280 # but for sites with many IP addresses on one interface,
281 # it's useful to say "listen on all addresses for eth0".
283 # If your system does not support this feature, you will
284 # get an error if you try to use it.
288 # Per-socket lists of clients. This is a very useful feature.
290 # The name here is a reference to a section elsewhere in
291 # radiusd.conf, or clients.conf. Having the name as
292 # a reference allows multiple sockets to use the same
295 # If this configuration is used, then the global list of clients
296 # is IGNORED for this "listen" section. Take care configuring
297 # this feature, to ensure you don't accidentally disable a
300 # See clients.conf for the configuration of "per_socket_clients".
302 # clients = per_socket_clients
305 # This second "listen" section is for listening on the accounting
314 # clients = per_socket_clients
317 # hostname_lookups: Log the names of clients or just their IP addresses
318 # e.g., www.freeradius.org (on) or 206.47.27.232 (off).
320 # The default is 'off' because it would be overall better for the net
321 # if people had to knowingly turn this feature on, since enabling it
322 # means that each client request will result in AT LEAST one lookup
323 # request to the nameserver. Enabling hostname_lookups will also
324 # mean that your server may stop randomly for 30 seconds from time
325 # to time, if the DNS requests take too long.
327 # Turning hostname lookups off also means that the server won't block
328 # for 30 seconds, if it sees an IP address which has no name associated
331 # allowed values: {no, yes}
333 hostname_lookups = no
335 # Core dumps are a bad thing. This should only be set to 'yes'
336 # if you're debugging a problem with the server.
338 # allowed values: {no, yes}
340 allow_core_dumps = no
342 # Regular expressions
344 # These items are set at configure time. If they're set to "yes",
345 # then setting them to "no" turns off regular expression support.
347 # If they're set to "no" at configure time, then setting them to "yes"
348 # WILL NOT WORK. It will give you an error.
350 regular_expressions = @REGEX@
351 extended_expressions = @REGEX_EXTENDED@
354 # Logging section. The various "log_*" configuration items
355 # will eventually be moved here.
359 # Destination for log messages. This can be one of:
361 # files - log to "file", as defined below.
362 # syslog - to syslog (see also the "syslog_facility", below.
363 # stdout - standard output
364 # stderr - standard error.
366 # The command-line option "-X" over-rides this option, and forces
367 # logging to go to stdout.
372 # The logging messages for the server are appended to the
373 # tail of this file if destination == "files"
375 # If the server is running in debugging mode, this file is
378 file = ${logdir}/radius.log
381 # If this configuration parameter is set, then log messages for
382 # a *request* go to this file, rather than to radius.log.
384 # i.e. This is a log file per request, once the server has accepted
385 # the request as being from a valid client. Messages that are
386 # not associated with a request still go to radius.log.
388 # Not all log messages in the server core have been updated to use
389 # this new internal API. As a result, some messages will still
390 # go to radius.log. Please submit patches to fix this behavior.
392 # The file name is expanded dynamically. You should ONLY user
393 # server-side attributes for the filename (e.g. things you control).
394 # Using this feature MAY also slow down the server substantially,
395 # especially if you do thinks like SQL calls as part of the
396 # expansion of the filename.
398 # The name of the log file should use attributes that don't change
399 # over the lifetime of a request, such as User-Name,
400 # Virtual-Server or Packet-Src-IP-Address. Otherwise, the log
401 # messages will be distributed over multiple files.
403 # Logging can be enabled for an individual request by a special
404 # dynamic expansion macro: %{debug: 1}, where the debug level
405 # for this request is set to '1' (or 2, 3, etc.). e.g.
409 # Tmp-String-0 = "%{debug:1}"
413 # The attribute that the value is assigned to is unimportant,
414 # and should be a "throw-away" attribute with no side effects.
416 #requests = ${logdir}/radiusd-%{%{Virtual-Server}:-DEFAULT}-%Y%m%d.log
419 # Which syslog facility to use, if ${destination} == "syslog"
421 # The exact values permitted here are OS-dependent. You probably
422 # don't want to change this.
424 syslog_facility = daemon
426 # Log the full User-Name attribute, as it was found in the request.
428 # allowed values: {no, yes}
432 # Log authentication requests to the log file.
434 # allowed values: {no, yes}
438 # Log passwords with the authentication requests.
439 # auth_badpass - logs password if it's rejected
440 # auth_goodpass - logs password if it's correct
442 # allowed values: {no, yes}
448 # The program to execute to do concurrency checks.
449 checkrad = ${sbindir}/checkrad
451 # SECURITY CONFIGURATION
453 # There may be multiple methods of attacking on the server. This
454 # section holds the configuration items which minimize the impact
459 # max_attributes: The maximum number of attributes
460 # permitted in a RADIUS packet. Packets which have MORE
461 # than this number of attributes in them will be dropped.
463 # If this number is set too low, then no RADIUS packets
466 # If this number is set too high, then an attacker may be
467 # able to send a small number of packets which will cause
468 # the server to use all available memory on the machine.
470 # Setting this number to 0 means "allow any number of attributes"
474 # reject_delay: When sending an Access-Reject, it can be
475 # delayed for a few seconds. This may help slow down a DoS
476 # attack. It also helps to slow down people trying to brute-force
477 # crack a users password.
479 # Setting this number to 0 means "send rejects immediately"
481 # If this number is set higher than 'cleanup_delay', then the
482 # rejects will be sent at 'cleanup_delay' time, when the request
483 # is deleted from the internal cache of requests.
485 # Useful ranges: 1 to 5
489 # status_server: Whether or not the server will respond
490 # to Status-Server requests.
492 # When sent a Status-Server message, the server responds with
493 # an Access-Accept or Accounting-Response packet.
495 # This is mainly useful for administrators who want to "ping"
496 # the server, without adding test users, or creating fake
497 # accounting packets.
499 # It's also useful when a NAS marks a RADIUS server "dead".
500 # The NAS can periodically "ping" the server with a Status-Server
501 # packet. If the server responds, it must be alive, and the
502 # NAS can start using it for real requests.
504 # See also raddb/sites-available/status
509 # PROXY CONFIGURATION
511 # proxy_requests: Turns proxying of RADIUS requests on or off.
513 # The server has proxying turned on by default. If your system is NOT
514 # set up to proxy requests to another server, then you can turn proxying
515 # off here. This will save a small amount of resources on the server.
517 # If you have proxying turned off, and your configuration files say
518 # to proxy a request, then an error message will be logged.
520 # To disable proxying, change the "yes" to "no", and comment the
523 # allowed values: {no, yes}
529 # CLIENTS CONFIGURATION
531 # Client configuration is defined in "clients.conf".
534 # The 'clients.conf' file contains all of the information from the old
535 # 'clients' and 'naslist' configuration files. We recommend that you
536 # do NOT use 'client's or 'naslist', although they are still
539 # Anything listed in 'clients.conf' will take precedence over the
540 # information from the old-style configuration files.
542 $INCLUDE clients.conf
545 # THREAD POOL CONFIGURATION
547 # The thread pool is a long-lived group of threads which
548 # take turns (round-robin) handling any incoming requests.
550 # You probably want to have a few spare threads around,
551 # so that high-load situations can be handled immediately. If you
552 # don't have any spare threads, then the request handling will
553 # be delayed while a new thread is created, and added to the pool.
555 # You probably don't want too many spare threads around,
556 # otherwise they'll be sitting there taking up resources, and
557 # not doing anything productive.
559 # The numbers given below should be adequate for most situations.
562 # Number of servers to start initially --- should be a reasonable
566 # Limit on the total number of servers running.
568 # If this limit is ever reached, clients will be LOCKED OUT, so it
569 # should NOT BE SET TOO LOW. It is intended mainly as a brake to
570 # keep a runaway server from taking the system with it as it spirals
573 # You may find that the server is regularly reaching the
574 # 'max_servers' number of threads, and that increasing
575 # 'max_servers' doesn't seem to make much difference.
577 # If this is the case, then the problem is MOST LIKELY that
578 # your back-end databases are taking too long to respond, and
579 # are preventing the server from responding in a timely manner.
581 # The solution is NOT do keep increasing the 'max_servers'
582 # value, but instead to fix the underlying cause of the
583 # problem: slow database, or 'hostname_lookups=yes'.
585 # For more information, see 'max_request_time', above.
589 # Server-pool size regulation. Rather than making you guess
590 # how many servers you need, FreeRADIUS dynamically adapts to
591 # the load it sees, that is, it tries to maintain enough
592 # servers to handle the current load, plus a few spare
593 # servers to handle transient load spikes.
595 # It does this by periodically checking how many servers are
596 # waiting for a request. If there are fewer than
597 # min_spare_servers, it creates a new spare. If there are
598 # more than max_spare_servers, some of the spares die off.
599 # The default values are probably OK for most sites.
601 min_spare_servers = 3
602 max_spare_servers = 10
604 # There may be memory leaks or resource allocation problems with
605 # the server. If so, set this value to 300 or so, so that the
606 # resources will be cleaned up periodically.
608 # This should only be necessary if there are serious bugs in the
609 # server which have not yet been fixed.
611 # '0' is a special value meaning 'infinity', or 'the servers never
613 max_requests_per_server = 0
616 # MODULE CONFIGURATION
618 # The names and configuration of each module is located in this section.
620 # After the modules are defined here, they may be referred to by name,
621 # in other sections of this configuration file.
625 # Each module has a configuration as follows:
627 # name [ instance ] {
628 # config_item = value
632 # The 'name' is used to load the 'rlm_name' library
633 # which implements the functionality of the module.
635 # The 'instance' is optional. To have two different instances
636 # of a module, it first must be referred to by 'name'.
637 # The different copies of the module are then created by
638 # inventing two 'instance' names, e.g. 'instance1' and 'instance2'
640 # The instance names can then be used in later configuration
641 # INSTEAD of the original 'name'. See the 'radutmp' configuration
646 # As of 2.0.5, most of the module configurations are in a
647 # sub-directory. Files matching the regex /[a-zA-Z0-9_.]+/
648 # are loaded. The modules are initialized ONLY if they are
649 # referenced in a processing section, such as authorize,
650 # authenticate, accounting, pre/post-proxy, etc.
652 $INCLUDE ${confdir}/modules/
654 # Extensible Authentication Protocol
656 # For all EAP related authentications.
657 # Now in another file, because it is very large.
661 # Include another file that has the SQL-related configuration.
662 # This is another file only because it tends to be big.
667 # This module is an SQL enabled version of the counter module.
669 # Rather than maintaining seperate (GDBM) databases of
670 # accounting info for each counter, this module uses the data
671 # stored in the raddacct table by the sql modules. This
672 # module NEVER does any database INSERTs or UPDATEs. It is
673 # totally dependent on the SQL module to process Accounting
676 # $INCLUDE sql/mysql/counter.conf
679 # IP addresses managed in an SQL table.
681 # $INCLUDE sqlippool.conf
686 # This section orders the loading of the modules. Modules
687 # listed here will get loaded BEFORE the later sections like
688 # authorize, authenticate, etc. get examined.
690 # This section is not strictly needed. When a section like
691 # authorize refers to a module, it's automatically loaded and
692 # initialized. However, some modules may not be listed in any
693 # of the following sections, so they can be listed here.
695 # Also, listing modules here ensures that you have control over
696 # the order in which they are initalized. If one module needs
697 # something defined by another module, you can list them in order
698 # here, and ensure that the configuration will be OK.
702 # Allows the execution of external scripts.
703 # The entire command line (and output) must fit into 253 bytes.
705 # e.g. Framed-Pool = `%{exec:/bin/echo foo}`
709 # The expression module doesn't do authorization,
710 # authentication, or accounting. It only does dynamic
711 # translation, of the form:
713 # Session-Timeout = `%{expr:2 + 3}`
715 # So the module needs to be instantiated, but CANNOT be
716 # listed in any other section. See 'doc/rlm_expr' for
722 # We add the counter module here so that it registers
723 # the check-name attribute before any module which sets
729 # subsections here can be thought of as "virtual" modules.
731 # e.g. If you have two redundant SQL servers, and you want to
732 # use them in the authorize and accounting sections, you could
733 # place a "redundant" block in each section, containing the
734 # exact same text. Or, you could uncomment the following
735 # lines, and list "redundant_sql" in the authorize and
736 # accounting sections.
738 #redundant redundant_sql {
744 ######################################################################
746 # Policies that can be applied in multiple places are listed
747 # globally. That way, they can be defined once, and referred
750 ######################################################################
753 ######################################################################
755 # Load virtual servers.
757 # This next $INCLUDE line loads files in the directory that
758 # match the regular expression: /[a-zA-Z0-9_.]+/
760 # It allows you to define new virtual servers simply by placing
761 # a file into the raddb/sites-enabled/ directory.
763 $INCLUDE sites-enabled/
765 ######################################################################
767 # All of the other configuration sections like "authorize {}",
768 # "authenticate {}", "accounting {}", have been moved to the
771 # raddb/sites-available/default
773 # This is the "default" virtual server that has the same
774 # configuration as in version 1.0.x and 1.1.x. The default
775 # installation enables this virtual server. You should
776 # edit it to create policies for your local site.
778 # For more documentation on virtual servers, see:
780 # raddb/sites-available/README
782 ######################################################################