3 ## proxy.conf -- proxy radius and realm configuration directives
7 #######################################################################
9 # Proxy server configuration
11 # This entry controls the servers behaviour towards ALL other servers
12 # to which it sends proxy requests.
16 # Note that as of 2.0, the "synchronous", "retry_delay",
17 # "retry_count", and "dead_time" have all been deprecated.
18 # For backwards compatibility, they are are still accepted
19 # by the server, but they ONLY apply to the old-style realm
20 # configuration. i.e. realms with "authhost" and/or "accthost"
23 # i.e. "retry_delay" and "retry_count" have been replaced
24 # with per-home-server configuration. See the "home_server"
25 # example below for details.
27 # i.e. "dead_time" has been replaced with a per-home-server
28 # "revive_interval". We strongly recommend that this not
29 # be used, however. The new method is much better.
32 # In 2.0, the server is always "synchronous", and setting
33 # "synchronous = no" is impossible. This simplifies the
34 # server and increases the stability of the network.
35 # However, it means that the server (i.e. proxy) NEVER
36 # originates packets. It proxies packets ONLY when it receives
37 # a packet or a re-transmission from the NAS. If the NAS never
38 # re-transmits, the proxy never re-transmits, either. This can
39 # affect fail-over, where a packet does *not* fail over to a
40 # second home server.. because the NAS never retransmits the
43 # If you need to set "synchronous = no", please send a
44 # message to the list <freeradius-users@lists.freeradius.org>
45 # explaining why this feature is vital for your network.
48 # If a realm exists, but there are no live home servers for
49 # it, we can fall back to using the "DEFAULT" realm. This is
50 # most useful for accounting, where the server can proxy
51 # accounting requests to home servers, but if they're down,
52 # use a DEFAULT realm that is LOCAL (i.e. accthost = LOCAL),
53 # and then store the packets in the "detail" file. That data
54 # can be later proxied to the home servers by radrelay, when
55 # those home servers come back up again.
57 # Setting this to "yes" may have issues for authentication.
58 # i.e. If you are proxying for two different ISP's, and then
59 # act as a general dial-up for Gric. If one of the first two
60 # ISP's has their RADIUS server go down, you do NOT want to
61 # proxy those requests to GRIC. Instead, you probably want
62 # to just drop the requests on the floor. In that case, set
65 # allowed values: {yes, no}
71 #######################################################################
73 # Configuration for the proxy realms.
75 # As of 2.0. the old-style "realms" file is deprecated, and is not
78 # As of 2.0, the "realm" configuration has changed. Instead of
79 # specifying "authhost" and "accthost" in a realm section, the home
80 # servers are specified seperately in a "home_server" section. For
81 # backwards compatibility, you can still use the "authhost" and
82 # "accthost" directives. If you only have one home server for a
83 # realm, it is easier to use the old-style configuration.
85 # However, if you have multiple servers for a realm, we STRONGLY
86 # suggest moving to the new-style configuration.
89 # Load-balancing and failover between home servers is handled via
90 # a "home_server_pool" section.
92 # Finally, The "realm" section defines the realm, some options, and
93 # indicates which server pool should be used for the realm.
95 # This change means that simple configurations now require multiple
96 # sections to define a realm. However, complex configurations
97 # are much simpler than before, as multiple realms can share the same
100 # That is, realms point to server pools, and server pools point to
101 # home servers. Multiple realms can point to one server pool. One
102 # server pool can point to multiple home servers. Each home server
103 # can appear in one or more pools.
106 ######################################################################
108 # This section defines a "Home Server" which is another RADIUS
109 # server that gets sent proxied requests. In earlier versions
110 # of FreeRADIUS, home servers were defined in "realm" sections,
111 # which was awkward. In 2.0, they have been made independent
112 # from realms, which is better for a number of reasons.
114 home_server localhost {
116 # Home servers can be sent Access-Request packets
117 # or Accounting-Request packets.
119 # Allowed values are:
120 # auth - Handles Access-Request packets
121 # acct - Handles Accounting-Request packets
122 # auth+acct - Handles Access-Request packets at "port",
123 # and Accounting-Request packets at "port + 1"
124 # coa - Handles CoA-Request and Disconnect-Request packets.
125 # See also raddb/sites-available/originate-coa
129 # Configure ONE OF the following entries:
139 # virtual_server = foo
141 # Note that while both ipaddr and ipv6addr will accept
142 # both addresses and host names, we do NOT recommend
143 # using host names. When you specify a host name, the
144 # server has to do a DNS lookup to find the IP address
145 # of the home server. If the DNS server is slow or
146 # unresponsive, it means that FreeRADIUS will NOT be
147 # able to determine the address, and will therefore NOT
150 # Also, the mapping of host name to address is done ONCE
151 # when the server starts. If DNS is later updated to
152 # change the address, FreeRADIUS will NOT discover that
153 # until after a re-start, or a HUP.
155 # If you specify a virtual_server here, then requests
156 # will be proxied internally to that virtual server.
157 # These requests CANNOT be proxied again, however. The
158 # intent is to have the local server handle packets
159 # when all home servers are dead.
161 # Requests proxied to a virtual server will be passed
162 # through the pre-proxy and post-proxy sections, just
163 # like any other request. See also the sample "realm"
164 # configuration, below.
166 # None of the rest of the home_server configuration is used
167 # for the "virtual_server" configuration.
170 # The port to which packets are sent.
172 # Usually 1812 for type "auth", and 1813 for type "acct".
173 # Older servers may use 1645 and 1646.
174 # Use 3799 for type "coa"
179 # The shared secret use to "encrypt" and "sign" packets between
180 # FreeRADIUS and the home server.
182 # The secret can be any string, up to 8k characters in length.
184 # Control codes can be entered vi octal encoding,
185 # e.g. "\101\102" == "AB"
186 # Quotation marks can be entered by escaping them,
188 # Spaces or other "special" characters can be entered
189 # by putting quotes around the string.
195 ############################################################
197 # The rest of the configuration items listed here are optional,
198 # and do not have to appear in every home server definition.
200 ############################################################
203 # You can optionally specify the source IP address used when
204 # proxying requests to this home server. When the src_ipaddr
205 # it set, the server will automatically create a proxy
206 # listener for that IP address.
208 # If you specify this field for one home server, you will
209 # likely need to specify it for ALL home servers.
211 # If you don't care about the source IP address, leave this
214 # src_ipaddr = 127.0.0.1
216 # RFC 5080 suggests that all clients SHOULD include it in an
217 # Access-Request. The configuration item below tells the
218 # proxying server (i.e. this one) whether or not the home
219 # server requires a Message-Authenticator attribute. If it
220 # is required (value set to "yes"), then all Access-Request
221 # packets sent to that home server will have a
222 # Message-Authenticator attribute.
224 # We STRONGLY recommend that this flag be set to "yes"
225 # for ALL home servers. Doing so will have no performance
226 # impact on the proxy or on the home servers. It will,
227 # however, allow administrators to detect problems earlier.
229 # allowed values: yes, no
230 require_message_authenticator = yes
233 # If the home server does not respond to a request within
234 # this time, this server will initiate "zombie_period".
236 # The response window is large because responses MAY be slow,
237 # especially when proxying across the Internet.
239 # Useful range of values: 5 to 60
243 # If you want the old behavior of the server rejecting
244 # proxied requests after "response_window" timeout, set
245 # the following configuration item to "yes".
247 # This configuration WILL be removed in a future release
248 # If you believe you need it, email the freeradius-users
249 # list, and explain why it should stay in the server.
251 # no_response_fail = no
254 # If the home server does not respond to ANY packets during
255 # the "zombie period", it will be considered to be dead.
257 # A home server that is marked "zombie" will be used for
258 # proxying as a low priority. If there are live servers,
259 # they will always be preferred to a zombie. Requests will
260 # be proxied to a zombie server ONLY when there are no
263 # Any request that is proxied to a home server will continue
264 # to be sent to that home server until the home server is
265 # marked dead. At that point, it will fail over to another
266 # server, if a live server is available. If none is available,
267 # then the "post-proxy-type fail" handler will be called.
269 # If "status_check" below is something other than "none", then
270 # the server will start sending status checks at the start of
271 # the zombie period. It will continue sending status checks
272 # until the home server is marked "alive".
274 # Useful range of values: 20 to 120
277 ############################################################
279 # As of 2.0, FreeRADIUS supports RADIUS layer "status
280 # checks". These are used by a proxy server to see if a home
283 # These status packets are sent ONLY if the proxying server
284 # believes that the home server is dead. They are NOT sent
285 # if the proxying server believes that the home server is
286 # alive. They are NOT sent if the proxying server is not
289 # If the home server responds to the status check packet,
290 # then it is marked alive again, and is returned to use.
292 ############################################################
295 # Some home servers do not support status checks via the
296 # Status-Server packet. Others may not have a "test" user
297 # configured that can be used to query the server, to see if
298 # it is alive. For those servers, we have NO WAY of knowing
299 # when it becomes alive again. Therefore, after the server
300 # has been marked dead, we wait a period of time, and mark
301 # it alive again, in the hope that it has come back to
304 # If it has NOT come back to life, then FreeRADIUS will wait
305 # for "zombie_period" before marking it dead again. During
306 # the "zombie_period", ALL AUTHENTICATIONS WILL FAIL, because
307 # the home server is still dead. There is NOTHING that can
308 # be done about this, other than to enable the status checks,
309 # as documented below.
311 # e.g. if "zombie_period" is 40 seconds, and "revive_interval"
312 # is 300 seconds, the for 40 seconds out of every 340, or about
313 # 10% of the time, all authentications will fail.
315 # If the "zombie_period" and "revive_interval" configurations
316 # are set smaller, than it is possible for up to 50% of
317 # authentications to fail.
319 # As a result, we recommend enabling status checks, and
320 # we do NOT recommend using "revive_interval".
322 # The "revive_interval" is used ONLY if the "status_check"
323 # entry below is "none". Otherwise, it will not be used,
324 # and should be deleted.
326 # Useful range of values: 60 to 3600
327 revive_interval = 120
330 # The proxying server (i.e. this one) can do periodic status
331 # checks to see if a dead home server has come back alive.
333 # If set to "none", then the other configuration items listed
334 # below are not used, and the "revive_interval" time is used
337 # If set to "status-server", the Status-Server packets are
338 # sent. Many RADIUS servers support Status-Server. If a
339 # server does not support it, please contact the server
340 # vendor and request that they add it.
342 # If set to "request", then Access-Request, or Accounting-Request
343 # packets are sent, depending on the "type" entry above (auth/acct).
345 # Allowed values: none, status-server, request
346 status_check = status-server
349 # If the home server does not support Status-Server packets,
350 # then the server can still send Access-Request or
351 # Accounting-Request packets, with a pre-defined user name.
353 # This practice is NOT recommended, as it may potentially let
354 # users gain network access by using these "test" accounts!
356 # If it is used, we recommend that the home server ALWAYS
357 # respond to these Access-Request status checks with
358 # Access-Reject. The status check just needs an answer, it
359 # does not need an Access-Accept.
361 # For Accounting-Request status checks, only the username
362 # needs to be set. The rest of the accounting attribute are
363 # set to default values. The home server that receives these
364 # accounting packets SHOULD NOT treat them like normal user
365 # accounting packets. i.e It should probably NOT log them to
368 # username = "test_user_please_reject_me"
369 # password = "this is really secret"
372 # Configure the interval between sending status check packets.
374 # Setting it too low increases the probability of spurious
375 # fail-over and fallback attempts.
377 # Useful range of values: 6 to 120
381 # Configure the number of status checks in a row that the
382 # home server needs to respond to before it is marked alive.
384 # If you want to mark a home server as alive after a short
385 # time period of being responsive, it is best to use a small
386 # "check_interval", and a large value for
387 # "num_answers_to_alive". Using a long "check_interval" and
388 # a small number for "num_answers_to_alive" increases the
389 # probability of spurious fail-over and fallback attempts.
391 # Useful range of values: 3 to 10
392 num_answers_to_alive = 3
395 # Limit the total number of outstanding packets to the home
398 # if ((#request sent) - (#requests received)) > max_outstanding
399 # then stop sending more packets to the home server
401 # This lets us gracefully fall over when the home server
403 max_outstanding = 65536
406 # The configuration items in the next sub-section are used ONLY
407 # when "type = coa". It is ignored for all other type of home
410 # See RFC 5080 for the definitions of the following terms.
411 # RAND is a function (internal to FreeRADIUS) returning
412 # random numbers between -0.1 and +0.1
414 # First Re-transmit occurs after:
416 # RT = IRT + RAND*IRT
418 # Subsequent Re-transmits occur after:
420 # RT = 2 * RTprev + RAND * RTprev
422 # Re-trasnmits are capped at:
424 # if (MRT && (RT > MRT)) RT = MRT + RAND * MRT
426 # For a maximum number of attempts: MRC
428 # For a maximum (total) period of time: MRD.
431 # Initial retransmit interval: 1..5
434 # Maximum Retransmit Timeout: 1..30 (0 == no maximum)
437 # Maximum Retransmit Count: 1..20 (0 == retransmit forever)
440 # Maximum Retransmit Duration: 5..60
445 # Sample virtual home server.
448 #home_server virtual.example.com {
449 # virtual_server = virtual.example.com
452 ######################################################################
454 # This section defines a pool of home servers that is used
455 # for fail-over and load-balancing. In earlier versions of
456 # FreeRADIUS, fail-over and load-balancing were defined per-realm.
457 # As a result, if a server had 5 home servers, each of which served
458 # the same 10 realms, you would need 50 "realm" entries.
460 # In version 2.0, you would need 5 "home_server" sections,
461 # 10 'realm" sections, and one "home_server_pool" section to tie the
464 home_server_pool my_auth_failover {
466 # The type of this pool controls how home servers are chosen.
468 # fail-over - the request is sent to the first live
469 # home server in the list. i.e. If the first home server
470 # is marked "dead", the second one is chosen, etc.
472 # load-balance - the least busy home server is chosen,
473 # where "least busy" is counted by taking the number of
474 # requests sent to that home server, and subtracting the
475 # number of responses received from that home server.
477 # If there are two or more servers with the same low
478 # load, then one of those servers is chosen at random.
479 # This configuration is most similar to the old
480 # "round-robin" method, though it is not exactly the same.
482 # Note that load balancing does not work well with EAP,
483 # as EAP requires packets for an EAP conversation to be
484 # sent to the same home server. The load balancing method
485 # does not keep state in between packets, meaning that
486 # EAP packets for the same conversation may be sent to
487 # different home servers. This will prevent EAP from
490 # For non-EAP authentication methods, and for accounting
491 # packets, we recommend using "load-balance". It will
492 # ensure the highest availability for your network.
494 # client-balance - the home server is chosen by hashing the
495 # source IP address of the packet. If that home server
496 # is down, the next one in the list is used, just as
499 # There is no way of predicting which source IP will map
500 # to which home server.
502 # This configuration is most useful to do simple load
503 # balancing for EAP sessions, as the EAP session will
504 # always be sent to the same home server.
506 # client-port-balance - the home server is chosen by hashing
507 # the source IP address and source port of the packet.
508 # If that home server is down, the next one in the list
509 # is used, just as with "fail-over".
511 # This method provides slightly better load balancing
512 # for EAP sessions than "client-balance". However, it
513 # also means that authentication and accounting packets
514 # for the same session MAY go to different home servers.
516 # keyed-balance - the home server is chosen by hashing (FNV)
517 # the contents of the Load-Balance-Key attribute from the
518 # control items. The request is then sent to home server
521 # server = (hash % num_servers_in_pool).
523 # If there is no Load-Balance-Key in the control items,
524 # the load balancing method is identical to "load-balance".
526 # For most non-EAP authentication methods, The User-Name
527 # attribute provides a good key. An "unlang" policy can
528 # be used to copy the User-Name to the Load-Balance-Key
529 # attribute. This method may not work for EAP sessions,
530 # as the User-Name outside of the TLS tunnel is often
531 # static, e.g. "anonymous@realm".
534 # The default type is fail-over.
538 # A virtual_server may be specified here. If so, the
539 # "pre-proxy" and "post-proxy" sections are called when
540 # the request is proxied, and when a response is received.
542 # This lets you have one policy for all requests that are proxied
543 # to a home server. This policy is completely independent of
544 # any policies used to receive, or process the request.
546 #virtual_server = pre_post_proxy_for_pool
549 # Next, a list of one or more home servers. The names
550 # of the home servers are NOT the hostnames, but the names
551 # of the sections. (e.g. home_server foo {...} has name "foo".
553 # Note that ALL home servers listed here have to be of the same
554 # type. i.e. they all have to be "auth", or they all have to
555 # be "acct", or the all have to be "auth+acct".
557 home_server = localhost
559 # Additional home servers can be listed.
560 # There is NO LIMIT to the number of home servers that can
561 # be listed, though using more than 10 or so will become
562 # difficult to manage.
564 # home_server = foo.example.com
565 # home_server = bar.example.com
566 # home_server = baz.example.com
571 # If ALL home servers are dead, then this "fallback" home server
572 # is used. If set, it takes precedence over any realm-based
573 # fallback, such as the DEFAULT realm.
575 # For reasons of stability, this home server SHOULD be a virtual
576 # server. Otherwise, the fallback may itself be dead!
578 #fallback = virtual.example.com
581 ######################################################################
584 # This section defines a new-style "realm". Note the in version 2.0,
585 # there are many fewer configuration items than in 1.x for a realm.
587 # Automatic proxying is done via the "realms" module (see "man
588 # rlm_realm"). To manually proxy the request put this entry in the
593 #DEFAULT Proxy-To-Realm := "realm_name"
598 # Realms point to pools of home servers.
600 # For authentication, the "auth_pool" configuration item
601 # should point to a "home_server_pool" that was previously
602 # defined. All of the home servers in the "auth_pool" must
605 # For accounting, the "acct_pool" configuration item
606 # should point to a "home_server_pool" that was previously
607 # defined. All of the home servers in the "acct_pool" must
610 # If you have a "home_server_pool" where all of the home servers
611 # are of type "auth+acct", you can just use the "pool"
612 # configuration item, instead of specifying both "auth_pool"
615 auth_pool = my_auth_failover
619 # Normally, when an incoming User-Name is matched against the
620 # realm, the realm name is "stripped" off, and the "stripped"
621 # user name is used to perform matches.
623 # e.g. User-Name = "bob@example.com" will result in two new
624 # attributes being created by the "realms" module:
626 # Stripped-User-Name = "bob"
627 # Realm = "example.com"
629 # The Stripped-User-Name is then used as a key in the "users"
632 # If you do not want this to happen, uncomment "nostrip" below.
636 # There are no more configuration entries for a realm.
641 # This is a sample entry for iPass.
642 # Note that you have to define "ipass_auth_pool" and
643 # "ipass_acct_pool", along with home_servers for them, too.
648 # auth_pool = ipass_auth_pool
649 # acct_pool = ipass_acct_pool
653 # This realm is used mainly to cancel proxying. You can have
654 # the "realm suffix" module configured to proxy all requests for
655 # a realm, and then later cancel the proxying, based on other
658 # For example, you want to terminate PEAP or EAP-TTLS locally,
659 # you can add the following to the "users" file:
661 # DEFAULT EAP-Type == PEAP, Proxy-To-Realm := LOCAL
664 # If we do not specify a server pool, the realm is LOCAL, and
665 # requests are not proxied to it.
669 # This realm is for requests which don't have an explicit realm
670 # prefix or suffix. User names like "bob" will match this one.
673 # authhost = radius.company.com:1600
674 # accthost = radius.company.com:1601
675 # secret = testing123
679 # This realm is for ALL OTHER requests.
682 # authhost = radius.company.com:1600
683 # accthost = radius.company.com:1601
684 # secret = testing123
688 # This realm "proxies" requests internally to a virtual server.
689 # The pre-proxy and post-proxy sections are run just as with any
690 # other kind of home server. The virtual server then receives
691 # the request, and replies, just as with any other packet.
693 # Once proxied internally like this, the request CANNOT be proxied
694 # internally or externally.
696 #realm virtual.example.com {
697 # virtual_server = virtual.example.com
702 # Regular expressions may also be used as realm names. If these are used,
703 # then the "find matching realm" process is as follows:
705 # 1) Look for a non-regex realm with an *exact* match for the name.
706 # If found, it is used in preference to any regex matching realm.
708 # 2) Look for a regex realm, in the order that they are listed
709 # in the configuration files. Any regex match is performed in
710 # a case-insensitive fashion.
712 # 3) If no realm is found, return the DEFAULT realm, if any.
714 # The order of the realms matters in step (2). For example, defining
715 # two realms ".*\.example.net$" and ".*\.test\.example\.net$" will result in
716 # the second realm NEVER matching. This is because all of the realms
717 # which match the second regex also match the first one. Since the
718 # first regex matches, it is returned.
720 # The solution is to list the realms in the opposite order,. e.g.
721 # ".*\.test\.example.net$", followed by ".*\.example\.net$".
724 # Some helpful rules:
726 # - always place a '~' character at the start of the realm name.
727 # This signifies that it is a regex match, and not an exact match
730 # - place the regex in double quotes. This helps the configuration
731 # file parser ignore any "special" characters in the regex.
732 # Yes, this rule is different than the normal "unlang" rules for
733 # regular expressions. That may be fixed in a future release.
735 # - use two back-slashes '\\' whenever you need one backslash in the
736 # regex. e.g. "~.*\\.example\\.net$", and not "~\.example\.net$".
737 # This is because the regex is in a double-quoted string, and normal
738 # rules apply for double-quoted strings.
740 # - If you are matching domain names, use two backslashes in front of
741 # every '.' (dot or period). This is because '.' has special meaning
742 # in a regular expression: match any character. If you do not do this,
743 # then "~.*.example.net$" will match "fooXexampleYnet", which is likely
746 # - If you are matching domain names, put a '$' at the end of the regex
747 # that matches the domain name. This tells the regex matching code
748 # that the realm ENDS with the domain name, so it does not match
749 # realms with the domain name in the middle. e.g. "~.*\\.example\\.net"
750 # will match "test.example.netFOO", which is likely not what you want.
751 # Using "~(.*\\.)example\\.net$" is better.
753 # The more regex realms that are defined, the more time it takes to
754 # process them. You should define as few regex realms as possible
755 # in order to maximize server performance.
757 #realm "~(.*\\.)*example\\.net$" {
758 # auth_pool = my_auth_failover