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 # If multiple ones are listed, only the first one will
89 # be used, and the others will be ignored.
91 # The configuration options accept the following syntax:
93 # ipv4addr - IPv4 address (e.g.192.0.2.3)
95 # - hostname (radius.example.com)
96 # Only the A record for the host name is used.
97 # If there is no A record, an error is returned,
98 # and the server fails to start.
100 # ipv6addr - IPv6 address (e.g. 2001:db8::1)
101 # - wildcard (i.e. *)
102 # - hostname (radius.example.com)
103 # Only the AAAA record for the host name is used.
104 # If there is no AAAA record, an error is returned,
105 # and the server fails to start.
107 # ipaddr - IPv4 address as above
108 # - IPv6 address as above
109 # - wildcard (i.e. *), which means IPv4 wildcard.
111 # If there is only one A or AAAA record returned
112 # for the host name, it is used.
113 # If multiple A or AAAA records are returned
114 # for the host name, only the first one is used.
115 # If both A and AAAA records are returned
116 # for the host name, only the A record is used.
122 # Port on which to listen.
123 # Allowed values are:
124 # integer port number (1812)
125 # 0 means "use /etc/services for the proper port"
128 # Some systems support binding to an interface, in addition
129 # to the IP address. This feature isn't strictly necessary,
130 # but for sites with many IP addresses on one interface,
131 # it's useful to say "listen on all addresses for eth0".
133 # If your system does not support this feature, you will
134 # get an error if you try to use it.
138 # Per-socket lists of clients. This is a very useful feature.
140 # The name here is a reference to a section elsewhere in
141 # radiusd.conf, or clients.conf. Having the name as
142 # a reference allows multiple sockets to use the same
145 # If this configuration is used, then the global list of clients
146 # is IGNORED for this "listen" section. Take care configuring
147 # this feature, to ensure you don't accidentally disable a
150 # See clients.conf for the configuration of "per_socket_clients".
152 # clients = per_socket_clients
155 # Connection limiting for sockets with "proto = tcp".
157 # This section is ignored for other kinds of sockets.
161 # Limit the number of simultaneous TCP connections to the socket
164 # Setting this to 0 means "no limit"
167 # The per-socket "max_requests" option does not exist.
170 # The lifetime, in seconds, of a TCP connection. After
171 # this lifetime, the connection will be closed.
173 # Setting this to 0 means "forever".
177 # The idle timeout, in seconds, of a TCP connection.
178 # If no packets have been received over the connection for
179 # this time, the connection will be closed.
181 # Setting this to 0 means "no timeout".
183 # We STRONGLY RECOMMEND that you set an idle timeout.
190 # This second "listen" section is for listening on the accounting
199 # clients = per_socket_clients
202 # The number of packets received can be rate limited via the
203 # "max_pps" configuration item. When it is set, the server
204 # tracks the total number of packets received in the previous
205 # second. If the count is greater than "max_pps", then the
206 # new packet is silently discarded. This helps the server
207 # deal with overload situations.
209 # The packets/s counter is tracked in a sliding window. This
210 # means that the pps calculation is done for the second
211 # before the current packet was received. NOT for the current
212 # wall-clock second, and NOT for the previous wall-clock second.
214 # Useful values are 0 (no limit), or 100 to 10000.
215 # Values lower than 100 will likely cause the server to ignore
216 # normal traffic. Few systems are capable of handling more than
219 # It is most useful for accounting systems. Set it to 50%
220 # more than the normal accounting load, and you can be sure that
221 # the server will never get overloaded
225 # Only for "proto = tcp". These are ignored for "udp" sockets.
229 # max_connections = 0
233 # IPv6 versions of the above - read their full config to understand options
236 ipv6addr = :: # any. ::1 == localhost
239 # clients = per_socket_clients
252 # clients = per_socket_clients
258 # max_connections = 0
262 # Authorization. First preprocess (hints and huntgroups files),
263 # then realms, and finally look in the "users" file.
265 # Any changes made here should also be made to the "inner-tunnel"
268 # The order of the realm modules will determine the order that
269 # we try to find a matching realm.
271 # Make *sure* that 'preprocess' comes before any realm if you
272 # need to setup hints for the remote radius server
275 # Take a User-Name, and perform some checks on it, for spaces and other
276 # invalid characters. If the User-Name appears invalid, reject the
279 # See policy.d/filter for the definition of the filter_username policy.
284 # Some broken equipment sends passwords with embedded zeros.
285 # i.e. the debug output will show
287 # User-Password = "password\000\000"
289 # This policy will fix it to just be "password".
294 # The preprocess module takes care of sanitizing some bizarre
295 # attributes in the request, and turning them into attributes
296 # which are more standard.
298 # It takes care of processing the 'raddb/mods-config/preprocess/hints'
299 # and the 'raddb/mods-config/preprocess/huntgroups' files.
302 # If you intend to use CUI and you require that the Operator-Name
303 # be set for CUI generation and you want to generate CUI also
304 # for your local clients then uncomment the operator-name
305 # below and set the operator-name for your clients in clients.conf
309 # If you want to generate CUI for some clients that do not
310 # send proper CUI requests, then uncomment the
311 # cui below and set "add_cui = yes" for these clients in clients.conf
315 # If you want to have a log of authentication requests,
316 # un-comment the following line.
320 # The chap module will set 'Auth-Type := CHAP' if we are
321 # handling a CHAP request and Auth-Type has not already been set
325 # If the users are logging in with an MS-CHAP-Challenge
326 # attribute for authentication, the mschap module will find
327 # the MS-CHAP-Challenge attribute, and add 'Auth-Type := MS-CHAP'
328 # to the request, which will cause the server to then use
329 # the mschap module for authentication.
333 # If you have a Cisco SIP server authenticating against
334 # FreeRADIUS, uncomment the following line, and the 'digest'
335 # line in the 'authenticate' section.
339 # The WiMAX specification says that the Calling-Station-Id
340 # is 6 octets of the MAC. This definition conflicts with
341 # RFC 3580, and all common RADIUS practices. Un-commenting
342 # the "wimax" module here means that it will fix the
343 # Calling-Station-Id attribute to the normal format as
344 # specified in RFC 3580 Section 3.21
348 # Look for IPASS style 'realm/', and if not found, look for
349 # '@realm', and decide whether or not to proxy, based on
354 # If you are using multiple kinds of realms, you probably
355 # want to set "ignore_null = yes" for all of them.
356 # Otherwise, when the first style of realm doesn't match,
357 # the other styles won't be checked.
363 # This module takes care of EAP-MD5, EAP-TLS, and EAP-LEAP
366 # It also sets the EAP-Type attribute in the request
367 # attribute list to the EAP type from the packet.
369 # The EAP module returns "ok" or "updated" if it is not yet ready
370 # to authenticate the user. The configuration below checks for
371 # "ok", and stops processing the "authorize" section if so.
373 # Any LDAP and/or SQL servers will not be queried for the
374 # initial set of packets that go back and forth to set up
377 # The "updated" check is commented out for compatibility with
378 # previous versions of this configuration, but you may wish to
379 # uncomment it as well; this will further reduce the number of
380 # LDAP and/or SQL queries for TTLS or PEAP.
388 # Pull crypt'd passwords from /etc/passwd or /etc/shadow,
389 # using the system API's to get the password. If you want
390 # to read /etc/passwd or /etc/shadow directly, see the
391 # mods-available/passwd module.
396 # Read the 'users' file. In v3, this is located in
397 # raddb/mods-config/files/authorize
401 # Look in an SQL database. The schema of the database
402 # is meant to mirror the "users" file.
404 # See "Authorization Queries" in mods-available/sql
408 # If you are using /etc/smbpasswd, and are also doing
409 # mschap authentication, the un-comment this line, and
410 # configure the 'smbpasswd' module.
414 # The ldap module reads passwords from the LDAP database.
418 # Enforce daily limits on time spent logged in.
426 # If no other module has claimed responsibility for
427 # authentication, then try to use PAP. This allows the
428 # other modules listed above to add a "known good" password
429 # to the request, and to do nothing else. The PAP module
430 # will then see that password, and use it to do PAP
433 # This module should be listed last, so that the other modules
434 # get a chance to set Auth-Type for themselves.
439 # If "status_server = yes", then Status-Server messages are passed
440 # through the following section, and ONLY the following section.
441 # This permits you to do DB queries, for example. If the modules
442 # listed here return "fail", then NO response is sent.
444 # Autz-Type Status-Server {
453 # This section lists which modules are available for authentication.
454 # Note that it does NOT mean 'try each module in order'. It means
455 # that a module from the 'authorize' section adds a configuration
456 # attribute 'Auth-Type := FOO'. That authentication type is then
457 # used to pick the appropriate module from the list below.
460 # In general, you SHOULD NOT set the Auth-Type attribute. The server
461 # will figure it out on its own, and will do the right thing. The
462 # most common side effect of erroneously setting the Auth-Type
463 # attribute is that one authentication method will work, but the
466 # The common reasons to set the Auth-Type attribute by hand
467 # is to either forcibly reject the user (Auth-Type := Reject),
468 # or to or forcibly accept the user (Auth-Type := Accept).
470 # Note that Auth-Type := Accept will NOT work with EAP.
472 # Please do not put "unlang" configurations into the "authenticate"
473 # section. Put them in the "post-auth" section instead. That's what
474 # the post-auth section is for.
478 # PAP authentication, when a back-end database listed
479 # in the 'authorize' section supplies a password. The
480 # password can be clear-text, or encrypted.
486 # Most people want CHAP authentication
487 # A back-end database listed in the 'authorize' section
488 # MUST supply a CLEAR TEXT password. Encrypted passwords
495 # MSCHAP authentication.
501 # For old names, too.
506 # If you have a Cisco SIP server authenticating against
507 # FreeRADIUS, uncomment the following line, and the 'digest'
508 # line in the 'authorize' section.
512 # Pluggable Authentication Modules.
515 # Uncomment it if you want to use ldap for authentication
517 # Note that this means "check plain-text password against
518 # the ldap database", which means that EAP won't work,
519 # as it does not supply a plain-text password.
521 # We do NOT recommend using this. LDAP servers are databases.
522 # They are NOT authentication servers. FreeRADIUS is an
523 # authentication server, and knows what to do with authentication.
524 # LDAP servers do not.
531 # Allow EAP authentication.
535 # The older configurations sent a number of attributes in
536 # Access-Challenge packets, which wasn't strictly correct.
537 # If you want to filter out these attributes, uncomment
538 # the following lines.
544 # if (handled && (Response-Packet-Type == Access-Challenge)) {
545 # attr_filter.access_challenge.post-auth
546 # handled # override the "updated" code from attr_filter
553 # Pre-accounting. Decide which accounting type to use.
559 # Merge Acct-[Input|Output]-Gigawords and Acct-[Input-Output]-Octets
560 # into a single 64bit counter Acct-[Input|Output]-Octets64.
565 # Session start times are *implied* in RADIUS.
566 # The NAS never sends a "start time". Instead, it sends
567 # a start packet, *possibly* with an Acct-Delay-Time.
568 # The server is supposed to conclude that the start time
569 # was "Acct-Delay-Time" seconds in the past.
571 # The code below creates an explicit start time, which can
572 # then be used in other modules. It will be *mostly* correct.
573 # Any errors are due to the 1-second resolution of RADIUS,
574 # and the possibility that the time on the NAS may be off.
576 # The start time is: NOW - delay - session_length
580 # &FreeRADIUS-Acct-Session-Start-Time = "%{expr: %l - %{%{Acct-Session-Time}:-0} - %{%{Acct-Delay-Time}:-0}}"
585 # Ensure that we have a semi-unique identifier for every
586 # request, and many NAS boxes are broken.
590 # Look for IPASS-style 'realm/', and if not found, look for
591 # '@realm', and decide whether or not to proxy, based on
594 # Accounting requests are generally proxied to the same
595 # home server as authentication requests.
601 # Read the 'acct_users' file
606 # Accounting. Log the accounting data.
609 # Update accounting packet by adding the CUI attribute
610 # recorded from the corresponding Access-Accept
611 # use it only if your NAS boxes do not support CUI themselves
614 # Create a 'detail'ed log of the packets.
615 # Note that accounting requests which are proxied
616 # are also logged in the detail file.
620 # Update the wtmp file
622 # If you don't use "radlast", you can delete this line.
626 # For Simultaneous-Use tracking.
628 # Due to packet losses in the network, the data here
629 # may be incorrect. There is little we can do about it.
633 # Return an address to the IP Pool when we see a stop record.
637 # Log traffic to an SQL database.
639 # See "Accounting queries" in mods-available/sql
643 # If you receive stop packets with zero session length,
644 # they will NOT be logged in the database. The SQL module
645 # will print a message (only in debugging mode), and will
648 # You can ignore these packets by uncommenting the following
649 # three lines. Otherwise, the server will not respond to the
650 # accounting request, and the NAS will retransmit.
657 # Instead of sending the query to the SQL server,
658 # write it into a log file.
662 # Cisco VoIP specific bulk accounting
665 # For Exec-Program and Exec-Program-Wait
668 # Filter attributes from the accounting response.
669 attr_filter.accounting_response
672 # See "Autz-Type Status-Server" for how this works.
674 # Acct-Type Status-Server {
680 # Session database, used for checking Simultaneous-Use. Either the radutmp
681 # or rlm_sql module can handle this.
682 # The rlm_sql module is *much* faster
687 # See "Simultaneous Use Checking Queries" in mods-available/sql
692 # Post-Authentication
693 # Once we KNOW that the user has been authenticated, there are
694 # additional steps we can take.
697 # If you need to have a State attribute, you can
698 # add it here. e.g. for later CoA-Request with
699 # State, and Service-Type = Authorize-Only.
701 # if (!&reply:State) {
703 # State := "0x%{randstr:16h}"
708 # For EAP-TTLS and PEAP, add the cached attributes to the reply.
709 # The "session-state" attributes are automatically cached when
710 # an Access-Challenge is sent, and automatically retrieved
711 # when an Access-Request is received.
713 # The session-state attributes are automatically deleted after
714 # an Access-Reject or Access-Accept is sent.
717 &reply: += &session-state:
720 # Get an address from the IP Pool.
724 # Create the CUI value and add the attribute to Access-Accept.
725 # Uncomment the line below if *returning* the CUI.
729 # If you want to have a log of authentication replies,
730 # un-comment the following line, and enable the
731 # 'detail reply_log' module.
735 # After authenticating the user, do another SQL query.
737 # See "Authentication Logging Queries" in mods-available/sql
741 # Instead of sending the query to the SQL server,
742 # write it into a log file.
747 # Un-comment the following if you want to modify the user's object
748 # in LDAP after a successful login.
752 # For Exec-Program and Exec-Program-Wait
756 # Calculate the various WiMAX keys. In order for this to work,
757 # you will need to define the WiMAX NAI, usually via
760 # WiMAX-MN-NAI = "%{User-Name}"
763 # If you want various keys to be calculated, you will need to
764 # update the reply with "template" values. The module will see
765 # this, and replace the template values with the correct ones
766 # taken from the cryptographic calculations. e.g.
769 # WiMAX-FA-RK-Key = 0x00
770 # WiMAX-MSK = "%{EAP-MSK}"
773 # You may want to delete the MS-MPPE-*-Keys from the reply,
774 # as some WiMAX clients behave badly when those attributes
775 # are included. See "raddb/modules/wimax", configuration
776 # entry "delete_mppe_keys" for more information.
781 # If there is a client certificate (EAP-TLS, sometimes PEAP
782 # and TTLS), then some attributes are filled out after the
783 # certificate verification has been performed. These fields
784 # MAY be available during the authentication, or they may be
785 # available only in the "post-auth" section.
787 # The first set of attributes contains information about the
788 # issuing certificate which is being used. The second
789 # contains information about the client certificate (if
793 # Reply-Message += "%{TLS-Cert-Serial}"
794 # Reply-Message += "%{TLS-Cert-Expiration}"
795 # Reply-Message += "%{TLS-Cert-Subject}"
796 # Reply-Message += "%{TLS-Cert-Issuer}"
797 # Reply-Message += "%{TLS-Cert-Common-Name}"
798 # Reply-Message += "%{TLS-Cert-Subject-Alt-Name-Email}"
800 # Reply-Message += "%{TLS-Client-Cert-Serial}"
801 # Reply-Message += "%{TLS-Client-Cert-Expiration}"
802 # Reply-Message += "%{TLS-Client-Cert-Subject}"
803 # Reply-Message += "%{TLS-Client-Cert-Issuer}"
804 # Reply-Message += "%{TLS-Client-Cert-Common-Name}"
805 # Reply-Message += "%{TLS-Client-Cert-Subject-Alt-Name-Email}"
808 # Insert class attribute (with unique value) into response,
809 # aids matching auth and acct records, and protects against duplicate
810 # Acct-Session-Id. Note: Only works if the NAS has implemented
811 # RFC 2865 behaviour for the class attribute, AND if the NAS
812 # supports long Class attributes. Many older or cheap NASes
813 # only support 16-octet Class attributes.
816 # MacSEC requires the use of EAP-Key-Name. However, we don't
817 # want to send it for all EAP sessions. Therefore, the EAP
818 # modules put required data into the EAP-Session-Id attribute.
819 # This attribute is never put into a request or reply packet.
821 # Uncomment the next few lines to copy the required data into
822 # the EAP-Key-Name attribute
823 # if (&reply:EAP-Session-Id) {
825 # EAP-Key-Name := &reply:EAP-Session-Id
829 # Remove reply message if the response contains an EAP-Message
830 remove_reply_message_if_eap
833 # Access-Reject packets are sent through the REJECT sub-section of the
836 # Add the ldap module name (or instance) if you have set
837 # 'edir_account_policy_check = yes' in the ldap module configuration
839 # The "session-state" attributes are not available here.
841 Post-Auth-Type REJECT {
842 # log failed authentications in SQL, too.
844 attr_filter.access_reject
846 # Insert EAP-Failure message if the request was
847 # rejected by policy instead of because of an
848 # authentication failure
851 # Remove reply message if the response contains an EAP-Message
852 remove_reply_message_if_eap
856 # Filter access challenges.
858 Post-Auth-Type Challenge {
859 # remove_reply_message_if_eap
860 # attr_filter.access_challenge.post-auth
866 # When the server decides to proxy a request to a home server,
867 # the proxied request is first passed through the pre-proxy
868 # stage. This stage can re-write the request, or decide to
871 # Only a few modules currently have this method.
874 # Before proxing the request add an Operator-Name attribute identifying
875 # if the operator-name is found for this client.
876 # No need to uncomment this if you have already enabled this in
877 # the authorize section.
880 # The client requests the CUI by sending a CUI attribute
881 # containing one zero byte.
882 # Uncomment the line below if *requesting* the CUI.
885 # Uncomment the following line if you want to change attributes
886 # as defined in the preproxy_users file.
889 # Uncomment the following line if you want to filter requests
890 # sent to remote servers based on the rules defined in the
891 # 'attrs.pre-proxy' file.
892 # attr_filter.pre-proxy
894 # If you want to have a log of packets proxied to a home
895 # server, un-comment the following line, and the
896 # 'detail pre_proxy_log' section, above.
901 # When the server receives a reply to a request it proxied
902 # to a home server, the request may be massaged here, in the
907 # If you want to have a log of replies from a home server,
908 # un-comment the following line, and the 'detail post_proxy_log'
912 # Uncomment the following line if you want to filter replies from
913 # remote proxies based on the rules defined in the 'attrs' file.
914 # attr_filter.post-proxy
917 # If you are proxying LEAP, you MUST configure the EAP
918 # module, and you MUST list it here, in the post-proxy
921 # You MUST also use the 'nostrip' option in the 'realm'
922 # configuration. Otherwise, the User-Name attribute
923 # in the proxied request will not match the user name
924 # hidden inside of the EAP packet, and the end server will
925 # reject the EAP request.
930 # If the server tries to proxy a request and fails, then the
931 # request is processed through the modules in this section.
933 # The main use of this section is to permit robust proxying
934 # of accounting packets. The server can be configured to
935 # proxy accounting packets as part of normal processing.
936 # Then, if the home server goes down, accounting packets can
937 # be logged to a local "detail" file, for processing with
938 # radrelay. When the home server comes back up, radrelay
939 # will read the detail file, and send the packets to the
942 # With this configuration, the server always responds to
943 # Accounting-Requests from the NAS, but only writes
944 # accounting packets to disk if the home server is down.
946 # Post-Proxy-Type Fail-Accounting {