1 ######################################################################
3 # As of 2.0.0, FreeRADIUS supports virtual hosts using the
4 # "server" section, and configuration directives.
6 # Virtual hosts should be put into the "sites-available"
7 # directory. Soft links should be created in the "sites-enabled"
8 # directory to these files. This is done in a normal installation.
10 # If you are using 802.1X (EAP) authentication, please see also
11 # the "inner-tunnel" virtual server. You will likely have to edit
12 # that, too, for authentication to work.
16 ######################################################################
18 # Read "man radiusd" before editing this file. See the section
19 # titled DEBUGGING. It outlines a method where you can quickly
20 # obtain the configuration you want, without running into
21 # trouble. See also "man unlang", which documents the format
24 # This configuration is designed to work in the widest possible
25 # set of circumstances, with the widest possible number of
26 # authentication methods. This means that in general, you should
27 # need to make very few changes to this file.
29 # The best way to configure the server for your local system
30 # is to CAREFULLY edit this file. Most attempts to make large
31 # edits to this file will BREAK THE SERVER. Any edits should
32 # be small, and tested by running the server with "radiusd -X".
33 # Once the edits have been verified to work, save a copy of these
34 # configuration files somewhere. (e.g. as a "tar" file). Then,
35 # make more edits, and test, as above.
37 # There are many "commented out" references to modules such
38 # as ldap, sql, etc. These references serve as place-holders.
39 # If you need the functionality of that module, then configure
40 # it in radiusd.conf, and un-comment the references to it in
41 # this file. In most cases, those small changes will result
42 # in the server being able to connect to the DB, and to
45 ######################################################################
49 # If you want the server to listen on additional addresses, or on
50 # additional ports, you can use multiple "listen" sections.
52 # Each section make the server listen for only one type of packet,
53 # therefore authentication and accounting have to be configured in
56 # The server ignore all "listen" section if you are using '-i' and '-p'
57 # on the command line.
60 # Type of packets to listen for.
62 # auth listen for authentication packets
63 # acct listen for accounting packets
64 # proxy IP to use for sending proxied packets
65 # detail Read from the detail file. For examples, see
66 # raddb/sites-available/copy-acct-to-home-server
67 # status listen for Status-Server packets. For examples,
68 # see raddb/sites-available/status
69 # coa listen for CoA-Request and Disconnect-Request
70 # packets. For examples, see the file
71 # raddb/sites-available/coa
75 # Note: "type = proxy" lets you control the source IP used for
76 # proxying packets, with some limitations:
78 # * A proxy listener CANNOT be used in a virtual server section.
79 # * You should probably set "port = 0".
80 # * Any "clients" configuration will be ignored.
82 # See also proxy.conf, and the "src_ipaddr" configuration entry
83 # in the sample "home_server" section. When you specify the
84 # source IP address for packets sent to a home server, the
85 # proxy listeners are automatically created.
87 # ipaddr/ipv4addr/ipv6addr - IP address on which to listen.
88 # Out of several options the first one will be used.
91 # IPv4 address (e.g. 1.2.3.4, for ipv4addr/ipaddr)
92 # IPv6 address (e.g. 2001:db8::1, for ipv6addr/ipaddr)
93 # hostname (radius.example.com,
94 # A record for ipv4addr,
95 # AAAA record for ipv6addr,
96 # A or AAAA record for ipaddr)
103 # Port on which to listen.
104 # Allowed values are:
105 # integer port number (1812)
106 # 0 means "use /etc/services for the proper port"
109 # Some systems support binding to an interface, in addition
110 # to the IP address. This feature isn't strictly necessary,
111 # but for sites with many IP addresses on one interface,
112 # it's useful to say "listen on all addresses for eth0".
114 # If your system does not support this feature, you will
115 # get an error if you try to use it.
119 # Per-socket lists of clients. This is a very useful feature.
121 # The name here is a reference to a section elsewhere in
122 # radiusd.conf, or clients.conf. Having the name as
123 # a reference allows multiple sockets to use the same
126 # If this configuration is used, then the global list of clients
127 # is IGNORED for this "listen" section. Take care configuring
128 # this feature, to ensure you don't accidentally disable a
131 # See clients.conf for the configuration of "per_socket_clients".
133 # clients = per_socket_clients
136 # Connection limiting for sockets with "proto = tcp".
138 # This section is ignored for other kinds of sockets.
142 # Limit the number of simultaneous TCP connections to the socket
145 # Setting this to 0 means "no limit"
148 # The per-socket "max_requests" option does not exist.
151 # The lifetime, in seconds, of a TCP connection. After
152 # this lifetime, the connection will be closed.
154 # Setting this to 0 means "forever".
158 # The idle timeout, in seconds, of a TCP connection.
159 # If no packets have been received over the connection for
160 # this time, the connection will be closed.
162 # Setting this to 0 means "no timeout".
164 # We STRONGLY RECOMMEND that you set an idle timeout.
171 # This second "listen" section is for listening on the accounting
180 # clients = per_socket_clients
183 # The number of packets received can be rate limited via the
184 # "max_pps" configuration item. When it is set, the server
185 # tracks the total number of packets received in the previous
186 # second. If the count is greater than "max_pps", then the
187 # new packet is silently discarded. This helps the server
188 # deal with overload situations.
190 # The packets/s counter is tracked in a sliding window. This
191 # means that the pps calculation is done for the second
192 # before the current packet was received. NOT for the current
193 # wall-clock second, and NOT for the previous wall-clock second.
195 # Useful values are 0 (no limit), or 100 to 10000.
196 # Values lower than 100 will likely cause the server to ignore
197 # normal traffic. Few systems are capable of handling more than
200 # It is most useful for accounting systems. Set it to 50%
201 # more than the normal accounting load, and you can be sure that
202 # the server will never get overloaded
206 # Only for "proto = tcp". These are ignored for "udp" sockets.
210 # max_connections = 0
214 # IPv6 versions of the above - read their full config to understand options
217 ipv6addr = :: # any. ::1 == localhost
220 # clients = per_socket_clients
233 # clients = per_socket_clients
239 # max_connections = 0
243 # Authorization. First preprocess (hints and huntgroups files),
244 # then realms, and finally look in the "users" file.
246 # Any changes made here should also be made to the "inner-tunnel"
249 # The order of the realm modules will determine the order that
250 # we try to find a matching realm.
252 # Make *sure* that 'preprocess' comes before any realm if you
253 # need to setup hints for the remote radius server
256 # Take a User-Name, and perform some checks on it, for spaces and other
257 # invalid characters. If the User-Name appears invalid, reject the
260 # See policy.d/filter for the definition of the filter_username policy.
265 # Some broken equipment sends passwords with embedded zeros.
266 # i.e. the debug output will show
268 # User-Password = "password\000\000"
270 # This policy will fix it to just be "password".
275 # The preprocess module takes care of sanitizing some bizarre
276 # attributes in the request, and turning them into attributes
277 # which are more standard.
279 # It takes care of processing the 'raddb/mods-config/preprocess/hints'
280 # and the 'raddb/mods-config/preprocess/huntgroups' files.
283 # If you intend to use CUI and you require that the Operator-Name
284 # be set for CUI generation and you want to generate CUI also
285 # for your local clients then uncomment the operator-name
286 # below and set the operator-name for your clients in clients.conf
290 # If you want to generate CUI for some clients that do not
291 # send proper CUI requests, then uncomment the
292 # cui below and set "add_cui = yes" for these clients in clients.conf
296 # If you want to have a log of authentication requests,
297 # un-comment the following line.
301 # The chap module will set 'Auth-Type := CHAP' if we are
302 # handling a CHAP request and Auth-Type has not already been set
306 # If the users are logging in with an MS-CHAP-Challenge
307 # attribute for authentication, the mschap module will find
308 # the MS-CHAP-Challenge attribute, and add 'Auth-Type := MS-CHAP'
309 # to the request, which will cause the server to then use
310 # the mschap module for authentication.
314 # If you have a Cisco SIP server authenticating against
315 # FreeRADIUS, uncomment the following line, and the 'digest'
316 # line in the 'authenticate' section.
320 # The WiMAX specification says that the Calling-Station-Id
321 # is 6 octets of the MAC. This definition conflicts with
322 # RFC 3580, and all common RADIUS practices. Un-commenting
323 # the "wimax" module here means that it will fix the
324 # Calling-Station-Id attribute to the normal format as
325 # specified in RFC 3580 Section 3.21
329 # Look for IPASS style 'realm/', and if not found, look for
330 # '@realm', and decide whether or not to proxy, based on
335 # If you are using multiple kinds of realms, you probably
336 # want to set "ignore_null = yes" for all of them.
337 # Otherwise, when the first style of realm doesn't match,
338 # the other styles won't be checked.
344 # This module takes care of EAP-MD5, EAP-TLS, and EAP-LEAP
347 # It also sets the EAP-Type attribute in the request
348 # attribute list to the EAP type from the packet.
350 # The EAP module returns "ok" if it is not yet ready to
351 # authenticate the user. The configuration below checks for
352 # that code, and stops processing the "authorize" section if
355 # Any LDAP and/or SQL servers will not be queried for the
356 # initial set of packets that go back and forth to set up
364 # Pull crypt'd passwords from /etc/passwd or /etc/shadow,
365 # using the system API's to get the password. If you want
366 # to read /etc/passwd or /etc/shadow directly, see the
367 # mods-available/passwd module.
372 # Read the 'users' file. In v3, this is located in
373 # raddb/mods-config/files/authorize
377 # Look in an SQL database. The schema of the database
378 # is meant to mirror the "users" file.
380 # See "Authorization Queries" in mods-available/sql
384 # If you are using /etc/smbpasswd, and are also doing
385 # mschap authentication, the un-comment this line, and
386 # configure the 'smbpasswd' module.
390 # The ldap module reads passwords from the LDAP database.
394 # Enforce daily limits on time spent logged in.
402 # If no other module has claimed responsibility for
403 # authentication, then try to use PAP. This allows the
404 # other modules listed above to add a "known good" password
405 # to the request, and to do nothing else. The PAP module
406 # will then see that password, and use it to do PAP
409 # This module should be listed last, so that the other modules
410 # get a chance to set Auth-Type for themselves.
415 # If "status_server = yes", then Status-Server messages are passed
416 # through the following section, and ONLY the following section.
417 # This permits you to do DB queries, for example. If the modules
418 # listed here return "fail", then NO response is sent.
420 # Autz-Type Status-Server {
429 # This section lists which modules are available for authentication.
430 # Note that it does NOT mean 'try each module in order'. It means
431 # that a module from the 'authorize' section adds a configuration
432 # attribute 'Auth-Type := FOO'. That authentication type is then
433 # used to pick the appropriate module from the list below.
436 # In general, you SHOULD NOT set the Auth-Type attribute. The server
437 # will figure it out on its own, and will do the right thing. The
438 # most common side effect of erroneously setting the Auth-Type
439 # attribute is that one authentication method will work, but the
442 # The common reasons to set the Auth-Type attribute by hand
443 # is to either forcibly reject the user (Auth-Type := Reject),
444 # or to or forcibly accept the user (Auth-Type := Accept).
446 # Note that Auth-Type := Accept will NOT work with EAP.
448 # Please do not put "unlang" configurations into the "authenticate"
449 # section. Put them in the "post-auth" section instead. That's what
450 # the post-auth section is for.
454 # PAP authentication, when a back-end database listed
455 # in the 'authorize' section supplies a password. The
456 # password can be clear-text, or encrypted.
462 # Most people want CHAP authentication
463 # A back-end database listed in the 'authorize' section
464 # MUST supply a CLEAR TEXT password. Encrypted passwords
471 # MSCHAP authentication.
477 # If you have a Cisco SIP server authenticating against
478 # FreeRADIUS, uncomment the following line, and the 'digest'
479 # line in the 'authorize' section.
483 # Pluggable Authentication Modules.
486 # Uncomment it if you want to use ldap for authentication
488 # Note that this means "check plain-text password against
489 # the ldap database", which means that EAP won't work,
490 # as it does not supply a plain-text password.
492 # We do NOT recommend using this. LDAP servers are databases.
493 # They are NOT authentication servers. FreeRADIUS is an
494 # authentication server, and knows what to do with authentication.
495 # LDAP servers do not.
502 # Allow EAP authentication.
506 # The older configurations sent a number of attributes in
507 # Access-Challenge packets, which wasn't strictly correct.
508 # If you want to filter out these attributes, uncomment
509 # the following lines.
515 # if (handled && (Response-Packet-Type == Access-Challenge)) {
516 # attr_filter.access_challenge.post-auth
517 # handled # override the "updated" code from attr_filter
524 # Pre-accounting. Decide which accounting type to use.
530 # Merge Acct-[Input|Output]-Gigawords and Acct-[Input-Output]-Octets
531 # into a single 64bit counter Acct-[Input|Output]-Octets64.
536 # Session start times are *implied* in RADIUS.
537 # The NAS never sends a "start time". Instead, it sends
538 # a start packet, *possibly* with an Acct-Delay-Time.
539 # The server is supposed to conclude that the start time
540 # was "Acct-Delay-Time" seconds in the past.
542 # The code below creates an explicit start time, which can
543 # then be used in other modules. It will be *mostly* correct.
544 # Any errors are due to the 1-second resolution of RADIUS,
545 # and the possibility that the time on the NAS may be off.
547 # The start time is: NOW - delay - session_length
551 # FreeRADIUS-Acct-Session-Start-Time = "%{expr: %l - %{%{Acct-Session-Time}:-0} - %{%{Acct-Delay-Time}:-0}}"
556 # Ensure that we have a semi-unique identifier for every
557 # request, and many NAS boxes are broken.
561 # Look for IPASS-style 'realm/', and if not found, look for
562 # '@realm', and decide whether or not to proxy, based on
565 # Accounting requests are generally proxied to the same
566 # home server as authentication requests.
572 # Read the 'acct_users' file
577 # Accounting. Log the accounting data.
580 # Update accounting packet by adding the CUI attribute
581 # recorded from the corresponding Access-Accept
582 # use it only if your NAS boxes do not support CUI themselves
585 # Create a 'detail'ed log of the packets.
586 # Note that accounting requests which are proxied
587 # are also logged in the detail file.
591 # Update the wtmp file
593 # If you don't use "radlast", you can delete this line.
597 # For Simultaneous-Use tracking.
599 # Due to packet losses in the network, the data here
600 # may be incorrect. There is little we can do about it.
604 # Return an address to the IP Pool when we see a stop record.
608 # Log traffic to an SQL database.
610 # See "Accounting queries" in mods-available/sql
614 # If you receive stop packets with zero session length,
615 # they will NOT be logged in the database. The SQL module
616 # will print a message (only in debugging mode), and will
619 # You can ignore these packets by uncommenting the following
620 # three lines. Otherwise, the server will not respond to the
621 # accounting request, and the NAS will retransmit.
628 # Instead of sending the query to the SQL server,
629 # write it into a log file.
633 # Cisco VoIP specific bulk accounting
636 # For Exec-Program and Exec-Program-Wait
639 # Filter attributes from the accounting response.
640 attr_filter.accounting_response
643 # See "Autz-Type Status-Server" for how this works.
645 # Acct-Type Status-Server {
651 # Session database, used for checking Simultaneous-Use. Either the radutmp
652 # or rlm_sql module can handle this.
653 # The rlm_sql module is *much* faster
658 # See "Simultaneous Use Checking Queries" in mods-available/sql
663 # Post-Authentication
664 # Once we KNOW that the user has been authenticated, there are
665 # additional steps we can take.
668 # If you need to have a State attribute, you can
669 # add it here. e.g. for later CoA-Request with
670 # State, and Service-Type = Authorize-Only.
672 # if (!&reply:State) {
674 # State := "0x%{randstr:16h}"
679 # For EAP-TTLS and PEAP, add the cached attributes to the reply.
680 # The "session-state" attributes are automatically cached when
681 # an Access-Challenge is sent, and automatically retrieved
682 # when an Access-Request is received.
684 # The session-state attributes are automatically deleted after
685 # an Access-Reject or Access-Accept is sent.
688 &reply: += &session-state:
691 # Get an address from the IP Pool.
695 # Create the CUI value and add the attribute to Access-Accept.
696 # Uncomment the line below if *returning* the CUI.
700 # If you want to have a log of authentication replies,
701 # un-comment the following line, and enable the
702 # 'detail reply_log' module.
706 # After authenticating the user, do another SQL query.
708 # See "Authentication Logging Queries" in mods-available/sql
712 # Instead of sending the query to the SQL server,
713 # write it into a log file.
718 # Un-comment the following if you want to modify the user's object
719 # in LDAP after a successful login.
723 # For Exec-Program and Exec-Program-Wait
727 # Calculate the various WiMAX keys. In order for this to work,
728 # you will need to define the WiMAX NAI, usually via
731 # WiMAX-MN-NAI = "%{User-Name}"
734 # If you want various keys to be calculated, you will need to
735 # update the reply with "template" values. The module will see
736 # this, and replace the template values with the correct ones
737 # taken from the cryptographic calculations. e.g.
740 # WiMAX-FA-RK-Key = 0x00
741 # WiMAX-MSK = "%{EAP-MSK}"
744 # You may want to delete the MS-MPPE-*-Keys from the reply,
745 # as some WiMAX clients behave badly when those attributes
746 # are included. See "raddb/modules/wimax", configuration
747 # entry "delete_mppe_keys" for more information.
752 # If there is a client certificate (EAP-TLS, sometimes PEAP
753 # and TTLS), then some attributes are filled out after the
754 # certificate verification has been performed. These fields
755 # MAY be available during the authentication, or they may be
756 # available only in the "post-auth" section.
758 # The first set of attributes contains information about the
759 # issuing certificate which is being used. The second
760 # contains information about the client certificate (if
764 # Reply-Message += "%{TLS-Cert-Serial}"
765 # Reply-Message += "%{TLS-Cert-Expiration}"
766 # Reply-Message += "%{TLS-Cert-Subject}"
767 # Reply-Message += "%{TLS-Cert-Issuer}"
768 # Reply-Message += "%{TLS-Cert-Common-Name}"
769 # Reply-Message += "%{TLS-Cert-Subject-Alt-Name-Email}"
771 # Reply-Message += "%{TLS-Client-Cert-Serial}"
772 # Reply-Message += "%{TLS-Client-Cert-Expiration}"
773 # Reply-Message += "%{TLS-Client-Cert-Subject}"
774 # Reply-Message += "%{TLS-Client-Cert-Issuer}"
775 # Reply-Message += "%{TLS-Client-Cert-Common-Name}"
776 # Reply-Message += "%{TLS-Client-Cert-Subject-Alt-Name-Email}"
779 # Insert class attribute (with unique value) into response,
780 # aids matching auth and acct records, and protects against duplicate
781 # Acct-Session-Id. Note: Only works if the NAS has implemented
782 # RFC 2865 behaviour for the class attribute, AND if the NAS
783 # supports long Class attributes. Many older or cheap NASes
784 # only support 16-octet Class attributes.
787 # MacSEC requires the use of EAP-Key-Name. However, we don't
788 # want to send it for all EAP sessions. Therefore, the EAP
789 # modules put required data into the EAP-Session-Id attribute.
790 # This attribute is never put into a request or reply packet.
792 # Uncomment the next few lines to copy the required data into
793 # the EAP-Key-Name attribute
794 # if (&reply:EAP-Session-Id) {
796 # EAP-Key-Name := &reply:EAP-Session-Id
800 # Remove reply message if the response contains an EAP-Message
801 remove_reply_message_if_eap
804 # Access-Reject packets are sent through the REJECT sub-section of the
807 # Add the ldap module name (or instance) if you have set
808 # 'edir_account_policy_check = yes' in the ldap module configuration
810 # The "session-state" attributes are not available here.
812 Post-Auth-Type REJECT {
813 # log failed authentications in SQL, too.
815 attr_filter.access_reject
817 # Insert EAP-Failure message if the request was
818 # rejected by policy instead of because of an
819 # authentication failure
822 # Remove reply message if the response contains an EAP-Message
823 remove_reply_message_if_eap
828 # When the server decides to proxy a request to a home server,
829 # the proxied request is first passed through the pre-proxy
830 # stage. This stage can re-write the request, or decide to
833 # Only a few modules currently have this method.
836 # Before proxing the request add an Operator-Name attribute identifying
837 # if the operator-name is found for this client.
838 # No need to uncomment this if you have already enabled this in
839 # the authorize section.
842 # The client requests the CUI by sending a CUI attribute
843 # containing one zero byte.
844 # Uncomment the line below if *requesting* the CUI.
847 # Uncomment the following line if you want to change attributes
848 # as defined in the preproxy_users file.
851 # Uncomment the following line if you want to filter requests
852 # sent to remote servers based on the rules defined in the
853 # 'attrs.pre-proxy' file.
854 # attr_filter.pre-proxy
856 # If you want to have a log of packets proxied to a home
857 # server, un-comment the following line, and the
858 # 'detail pre_proxy_log' section, above.
863 # When the server receives a reply to a request it proxied
864 # to a home server, the request may be massaged here, in the
869 # If you want to have a log of replies from a home server,
870 # un-comment the following line, and the 'detail post_proxy_log'
874 # Uncomment the following line if you want to filter replies from
875 # remote proxies based on the rules defined in the 'attrs' file.
876 # attr_filter.post-proxy
879 # If you are proxying LEAP, you MUST configure the EAP
880 # module, and you MUST list it here, in the post-proxy
883 # You MUST also use the 'nostrip' option in the 'realm'
884 # configuration. Otherwise, the User-Name attribute
885 # in the proxied request will not match the user name
886 # hidden inside of the EAP packet, and the end server will
887 # reject the EAP request.
892 # If the server tries to proxy a request and fails, then the
893 # request is processed through the modules in this section.
895 # The main use of this section is to permit robust proxying
896 # of accounting packets. The server can be configured to
897 # proxy accounting packets as part of normal processing.
898 # Then, if the home server goes down, accounting packets can
899 # be logged to a local "detail" file, for processing with
900 # radrelay. When the home server comes back up, radrelay
901 # will read the detail file, and send the packets to the
904 # With this configuration, the server always responds to
905 # Accounting-Requests from the NAS, but only writes
906 # accounting packets to disk if the home server is down.
908 # Post-Proxy-Type Fail-Accounting {