3 ## eap.conf -- Configuration for EAP types (PEAP, TTLS, etc.)
7 #######################################################################
9 # Whatever you do, do NOT set 'Auth-Type := EAP'. The server
10 # is smart enough to figure this out on its own. The most
11 # common side effect of setting 'Auth-Type := EAP' is that the
12 # users then cannot use ANY other authentication method.
14 # EAP types NOT listed here may be supported via the "eap2" module.
15 # See experimental.conf for documentation.
18 # Invoke the default supported EAP type when
19 # EAP-Identity response is received.
21 # The incoming EAP messages DO NOT specify which EAP
22 # type they will be using, so it MUST be set here.
24 # For now, only one default EAP type may be used at a time.
26 # If the EAP-Type attribute is set by another module,
27 # then that EAP type takes precedence over the
28 # default type configured here.
30 default_eap_type = md5
32 # A list is maintained to correlate EAP-Response
33 # packets with EAP-Request packets. After a
34 # configurable length of time, entries in the list
35 # expire, and are deleted.
39 # There are many EAP types, but the server has support
40 # for only a limited subset. If the server receives
41 # a request for an EAP type it does not support, then
42 # it normally rejects the request. By setting this
43 # configuration to "yes", you can tell the server to
44 # instead keep processing the request. Another module
45 # MUST then be configured to proxy the request to
46 # another RADIUS server which supports that EAP type.
48 # If another module is NOT configured to handle the
49 # request, then the request will still end up being
51 ignore_unknown_eap_types = no
53 # Cisco AP1230B firmware 12.2(13)JA1 has a bug. When given
54 # a User-Name attribute in an Access-Accept, it copies one
55 # more byte than it should.
57 # We can work around it by configurably adding an extra
59 cisco_accounting_username_bug = no
62 # Help prevent DoS attacks by limiting the number of
63 # sessions that the server is tracking. For simplicity,
64 # this is taken from the "max_requests" directive in
66 max_sessions = ${max_requests}
71 # We do NOT recommend using EAP-MD5 authentication
72 # for wireless connections. It is insecure, and does
73 # not provide for dynamic WEP keys.
79 # EAP-pwd -- secure password-based authentication
85 # server_id = theserver@example.com
87 # This has the same meaning as for TLS.
88 # fragment_size = 1020
90 # The virtual server which determines the
91 # "known good" password for the user.
92 # Note that unlike TLS, only the "authorize"
93 # section is processed. EAP-PWD requests can be
94 # distinguished by having a User-Name, but
95 # no User-Password, CHAP-Password, EAP-Message, etc.
96 # virtual_server = "inner-tunnel"
101 # We do not recommend using LEAP in new deployments. See:
102 # http://www.securiteam.com/tools/5TP012ACKE.html
104 # Cisco LEAP uses the MS-CHAP algorithm (but not
105 # the MS-CHAP attributes) to perform it's authentication.
107 # As a result, LEAP *requires* access to the plain-text
108 # User-Password, or the NT-Password attributes.
109 # 'System' authentication is impossible with LEAP.
114 # Generic Token Card.
116 # Currently, this is only permitted inside of EAP-TTLS,
117 # or EAP-PEAP. The module "challenges" the user with
118 # text, and the response from the user is taken to be
121 # Proxying the tunneled EAP-GTC session is a bad idea,
122 # the users password will go over the wire in plain-text,
126 # The default challenge, which many clients
128 #challenge = "Password: "
130 # The plain-text response which comes back
131 # is put into a User-Password attribute,
132 # and passed to another module for
133 # authentication. This allows the EAP-GTC
134 # response to be checked against plain-text,
135 # or crypt'd passwords.
137 # If you say "Local" instead of "PAP", then
138 # the module will look for a User-Password
139 # configured for the request, and do the
140 # authentication itself.
145 ## Common TLS configuration for TLS-based EAP types
147 # See raddb/certs/README for additional comments
150 # If OpenSSL was not found at the time the server was
151 # built, the "tls", "ttls", and "peap" sections will
154 # If you do not currently have certificates signed by
155 # a trusted CA you may use the 'snakeoil' certificates.
156 # Included with the server in raddb/certs.
158 # If these certificates have not been auto-generated:
162 # These test certificates SHOULD NOT be used in a normal
163 # deployment. They are created only to make it easier
164 # to install the server, and to perform some simple
165 # tests with EAP-TLS, TTLS, or PEAP.
169 # http://www.dslreports.com/forum/remark,9286052~mode=flat
171 # Note that you should NOT use a globally known CA here!
172 # e.g. using a Verisign cert as a "known CA" means that
173 # ANYONE who has a certificate signed by them can
174 # authenticate via EAP-TLS! This is likely not what you want.
175 tls-config tls-common {
176 private_key_password = whatever
177 private_key_file = ${certdir}/server.pem
179 # If Private key & Certificate are located in
180 # the same file, then private_key_file &
181 # certificate_file must contain the same file
184 # If ca_file (below) is not used, then the
185 # certificate_file below MUST include not
186 # only the server certificate, but ALSO all
187 # of the CA certificates used to sign the
188 # server certificate.
189 certificate_file = ${certdir}/server.pem
191 # Trusted Root CA list
193 # ALL of the CA's in this list will be trusted
194 # to issue client certificates for authentication.
196 # In general, you should use self-signed
197 # certificates for 802.1x (EAP) authentication.
198 # In that case, this CA file should contain
199 # *one* CA certificate.
201 ca_file = ${cadir}/ca.pem
204 # If OpenSSL supports TLS-PSK, then we can use
205 # a PSK identity and (hex) password. When the
206 # following two configuration items are specified,
207 # then certificate-based configuration items are
210 # private_key_password
216 # For now, the identity is fixed, and must be the
217 # same on the client. The passphrase must be a hex
218 # value, and can be up to 256 hex digits.
220 # Future versions of the server may be able to
221 # look up the shared key (hexphrase) based on the
224 # psk_identity = "test"
225 # psk_hexphrase = "036363823"
228 # For DH cipher suites to work, you have to
229 # run OpenSSL to create the DH file first:
231 # openssl dhparam -out certs/dh 1024
233 dh_file = ${certdir}/dh
236 # If your system doesn't have /dev/urandom,
237 # you will need to create this file, and
238 # periodically change its contents.
240 # For security reasons, FreeRADIUS doesn't
241 # write to files in its configuration
244 # random_file = ${certdir}/random
247 # This can never exceed the size of a RADIUS
248 # packet (4096 bytes), and is preferably half
249 # that, to accommodate other attributes in
250 # RADIUS packet. On most APs the MAX packet
251 # length is configured between 1500 - 1600
252 # In these cases, fragment size should be
255 # fragment_size = 1024
257 # include_length is a flag which is
258 # by default set to yes If set to
259 # yes, Total Length of the message is
260 # included in EVERY packet we send.
261 # If set to no, Total Length of the
262 # message is included ONLY in the
263 # First packet of a fragment series.
265 # include_length = yes
267 # Check the Certificate Revocation List
269 # 1) Copy CA certificates and CRLs to same directory.
270 # 2) Execute 'c_rehash <CA certs&CRLs Directory>'.
271 # 'c_rehash' is OpenSSL's command.
272 # 3) uncomment the line below.
278 # If check_cert_issuer is set, the value will
279 # be checked against the DN of the issuer in
280 # the client certificate. If the values do not
281 # match, the certificate verification will fail,
282 # rejecting the user.
284 # In 2.1.10 and later, this check can be done
285 # more generally by checking the value of the
286 # TLS-Client-Cert-Issuer attribute. This check
287 # can be done via any mechanism you choose.
289 # check_cert_issuer = "/C=GB/ST=Berkshire/L=Newbury/O=My Company Ltd"
292 # If check_cert_cn is set, the value will
293 # be xlat'ed and checked against the CN
294 # in the client certificate. If the values
295 # do not match, the certificate verification
296 # will fail rejecting the user.
298 # This check is done only if the previous
299 # "check_cert_issuer" is not set, or if
300 # the check succeeds.
302 # In 2.1.10 and later, this check can be done
303 # more generally by checking the value of the
304 # TLS-Client-Cert-CN attribute. This check
305 # can be done via any mechanism you choose.
307 # check_cert_cn = %{User-Name}
309 # Set this option to specify the allowed
310 # TLS cipher suites. The format is listed
311 # in "man 1 ciphers".
312 cipher_list = "DEFAULT"
317 # Elliptical cryptography configuration
319 # Only for OpenSSL >= 0.9.8.f
321 ecdh_curve = "prime256v1"
324 # Session resumption / fast reauthentication
327 # The cache contains the following information:
329 # session Id - unique identifier, managed by SSL
330 # User-Name - from the Access-Accept
331 # Stripped-User-Name - from the Access-Request
332 # Cached-Session-Policy - from the Access-Accept
334 # The "Cached-Session-Policy" is the name of a
335 # policy which should be applied to the cached
336 # session. This policy can be used to assign
337 # VLANs, IP addresses, etc. It serves as a useful
338 # way to re-apply the policy from the original
339 # Access-Accept to the subsequent Access-Accept
340 # for the cached session.
342 # On session resumption, these attributes are
343 # copied from the cache, and placed into the
346 # You probably also want "use_tunneled_reply = yes"
347 # when using fast session resumption.
351 # Enable it. The default is "no".
352 # Deleting the entire "cache" subsection
353 # also disables caching.
355 # You can disallow resumption for a
356 # particular user by adding the following
357 # attribute to the control item list:
359 # Allow-Session-Resumption = No
361 # If "enable = no" below, you CANNOT
362 # enable resumption for just one user
363 # by setting the above attribute to "yes".
368 # Lifetime of the cached entries, in hours.
369 # The sessions will be deleted after this
372 lifetime = 24 # hours
375 # The maximum number of entries in the
376 # cache. Set to "0" for "infinite".
378 # This could be set to the number of users
379 # who are logged in... which can be a LOT.
384 # Internal "name" of the session cache.
385 # Used to distinguish which TLS context
386 # sessions belong to.
388 # The server will generate a random value
389 # if unset. This will change across server
390 # restart so you MUST set the "name" if you
391 # want to persist sessions (see below).
396 # Simple directory-based storage of sessions.
397 # Two files per session will be written, the SSL
398 # state and the cached VPs. This will persist session
399 # across server restarts.
401 # The server will need write perms, and the directory
402 # should be secured from anyone else. You might want
403 # a script to remove old files from here periodically:
405 # find ${logdir}/tlscache -mtime +2 -exec rm -f {} \;
407 # This feature REQUIRES "name" option be set above.
409 #persist_dir = "${logdir}/tlscache"
413 # As of version 2.1.10, client certificates can be
414 # validated via an external command. This allows
415 # dynamic CRLs or OCSP to be used.
417 # This configuration is commented out in the
418 # default configuration. Uncomment it, and configure
419 # the correct paths below to enable it.
422 # A temporary directory where the client
423 # certificates are stored. This directory
424 # MUST be owned by the UID of the server,
425 # and MUST not be accessible by any other
426 # users. When the server starts, it will do
427 # "chmod go-rwx" on the directory, for
428 # security reasons. The directory MUST
429 # exist when the server starts.
431 # You should also delete all of the files
432 # in the directory when the server starts.
433 # tmpdir = /tmp/radiusd
435 # The command used to verify the client cert.
436 # We recommend using the OpenSSL command-line
439 # The ${..ca_path} text is a reference to
440 # the ca_path variable defined above.
442 # The %{TLS-Client-Cert-Filename} is the name
443 # of the temporary file containing the cert
444 # in PEM format. This file is automatically
445 # deleted by the server when the command
447 # client = "/path/to/openssl verify -CApath ${..ca_path} %{TLS-Client-Cert-Filename}"
452 # Certificates can be verified against an OCSP
453 # Responder. This makes it possible to immediately
454 # revoke certificates without the distribution of
455 # new Certificate Revocation Lists (CRLs).
459 # Enable it. The default is "no".
460 # Deleting the entire "ocsp" subsection
461 # also disables ocsp checking
466 # The OCSP Responder URL can be automatically
467 # extracted from the certificate in question.
468 # To override the OCSP Responder URL set
469 # "override_cert_url = yes".
471 override_cert_url = yes
474 # If the OCSP Responder address is not extracted from
475 # the certificate, the URL can be defined here.
477 url = "http://127.0.0.1/ocsp/"
480 # If the OCSP Responder can not cope with nonce
481 # in the request, then it can be disabled here.
483 # For security reasons, disabling this option
484 # is not recommended as nonce protects against
487 # Note that Microsoft AD Certificate Services OCSP
488 # Responder does not enable nonce by default. It is
489 # more secure to enable nonce on the responder than
490 # to disable it in the query here.
491 # See http://technet.microsoft.com/en-us/library/cc770413%28WS.10%29.aspx
496 # Number of seconds before giving up waiting
497 # for OCSP response. 0 uses system default.
502 # Normally an error in querying the OCSP
503 # responder (no response from server, server did
504 # not understand the request, etc) will result in
505 # a validation failure.
507 # To treat these errors as 'soft' failures and
508 # still accept the certificate, enable this
511 # Warning: this may enable clients with revoked
512 # certificates to connect if the OCSP responder
513 # is not available. Use with caution.
521 # As of Version 3.0, the TLS configuration for TLS-based
522 # EAP types is above in the "tls-config" section.
525 # Point to the common TLS configuration
529 # As part of checking a client certificate, the EAP-TLS
530 # sets some attributes such as TLS-Client-Cert-CN. This
531 # virtual server has access to these attributes, and can
532 # be used to accept or reject the request.
534 # virtual_server = check-eap-tls
540 # The TTLS module implements the EAP-TTLS protocol,
541 # which can be described as EAP inside of Diameter,
542 # inside of TLS, inside of EAP, inside of RADIUS...
544 # Surprisingly, it works quite well.
547 # Which tls-config section the TLS negotiation parameters
548 # are in - see EAP-TLS above for an explanation.
550 # In the case that an old configuration from FreeRADIUS
551 # v2.x is being used, all the options of the tls-config
552 # section may also appear instead in the 'tls' section
553 # above. If that is done, the tls= option here (and in
554 # tls above) MUST be commented out.
558 # The tunneled EAP session needs a default EAP type
559 # which is separate from the one for the non-tunneled
560 # EAP module. Inside of the TTLS tunnel, we recommend
561 # using EAP-MD5. If the request does not contain an
562 # EAP conversation, then this configuration entry is
565 default_eap_type = md5
567 # The tunneled authentication request does not usually
568 # contain useful attributes like 'Calling-Station-Id',
569 # etc. These attributes are outside of the tunnel,
570 # and normally unavailable to the tunneled
571 # authentication request.
573 # By setting this configuration entry to 'yes',
574 # any attribute which is NOT in the tunneled
575 # authentication request, but which IS available
576 # outside of the tunnel, is copied to the tunneled
579 # allowed values: {no, yes}
581 copy_request_to_tunnel = no
584 # As of version 3.0.5, this configuration item
585 # is deprecated. Instead, you should use
587 # update outer.session-state {
592 # This will cache attributes for the final Access-Accept.
594 # The reply attributes sent to the NAS are usually
595 # based on the name of the user 'outside' of the
596 # tunnel (usually 'anonymous'). If you want to send
597 # the reply attributes based on the user name inside
598 # of the tunnel, then set this configuration entry to
599 # 'yes', and the reply to the NAS will be taken from
600 # the reply to the tunneled request.
602 # allowed values: {no, yes}
604 use_tunneled_reply = no
607 # The inner tunneled request can be sent
608 # through a virtual server constructed
609 # specifically for this purpose.
611 # If this entry is commented out, the inner
612 # tunneled request will be sent through
613 # the virtual server that processed the
616 virtual_server = "inner-tunnel"
618 # This has the same meaning, and overwrites, the
619 # same field in the "tls" configuration, above.
620 # The default value here is "yes".
622 # include_length = yes
625 # Unlike EAP-TLS, EAP-TTLS does not require a client
626 # certificate. However, you can require one by setting the
627 # following option. You can also override this option by
630 # EAP-TLS-Require-Client-Cert = Yes
632 # in the control items for a request.
634 # require_client_cert = yes
641 ##################################################
643 # !!!!! WARNINGS for Windows compatibility !!!!!
645 ##################################################
647 # If you see the server send an Access-Challenge,
648 # and the client never sends another Access-Request,
653 # The server certificate has to have special OID's
654 # in it, or else the Microsoft clients will silently
655 # fail. See the "scripts/xpextensions" file for
656 # details, and the following page:
658 # http://support.microsoft.com/kb/814394/en-us
660 # For additional Windows XP SP2 issues, see:
662 # http://support.microsoft.com/kb/885453/en-us
665 # If is still doesn't work, and you're using Samba,
666 # you may be encountering a Samba bug. See:
668 # https://bugzilla.samba.org/show_bug.cgi?id=6563
670 # Note that we do not necessarily agree with their
671 # explanation... but the fix does appear to work.
673 ##################################################
676 # The tunneled EAP session needs a default EAP type
677 # which is separate from the one for the non-tunneled
678 # EAP module. Inside of the TLS/PEAP tunnel, we
679 # recommend using EAP-MS-CHAPv2.
682 # Which tls-config section the TLS negotiation parameters
683 # are in - see EAP-TLS above for an explanation.
685 # In the case that an old configuration from FreeRADIUS
686 # v2.x is being used, all the options of the tls-config
687 # section may also appear instead in the 'tls' section
688 # above. If that is done, the tls= option here (and in
689 # tls above) MUST be commented out.
693 # The tunneled EAP session needs a default
694 # EAP type which is separate from the one for
695 # the non-tunneled EAP module. Inside of the
696 # PEAP tunnel, we recommend using MS-CHAPv2,
697 # as that is the default type supported by
700 default_eap_type = mschapv2
702 # The PEAP module also has these configuration
703 # items, which are the same as for TTLS.
705 copy_request_to_tunnel = no
708 # As of version 3.0.5, this configuration item
709 # is deprecated. Instead, you should use
711 # update outer.session-state {
716 # This will cache attributes for the final Access-Accept.
718 use_tunneled_reply = no
720 # When the tunneled session is proxied, the
721 # home server may not understand EAP-MSCHAP-V2.
722 # Set this entry to "no" to proxy the tunneled
723 # EAP-MSCHAP-V2 as normal MSCHAPv2.
725 # proxy_tunneled_request_as_eap = yes
728 # The inner tunneled request can be sent
729 # through a virtual server constructed
730 # specifically for this purpose.
732 # If this entry is commented out, the inner
733 # tunneled request will be sent through
734 # the virtual server that processed the
737 virtual_server = "inner-tunnel"
739 # This option enables support for MS-SoH
740 # see doc/SoH.txt for more info.
741 # It is disabled by default.
746 # The SoH reply will be turned into a request which
747 # can be sent to a specific virtual server:
749 # soh_virtual_server = "soh-server"
752 # Unlike EAP-TLS, PEAP does not require a client certificate.
753 # However, you can require one by setting the following
754 # option. You can also override this option by setting
756 # EAP-TLS-Require-Client-Cert = Yes
758 # in the control items for a request.
760 # require_client_cert = yes
764 # This takes no configuration.
766 # Note that it is the EAP MS-CHAPv2 sub-module, not
767 # the main 'mschap' module.
769 # Note also that in order for this sub-module to work,
770 # the main 'mschap' module MUST ALSO be configured.
772 # This module is the *Microsoft* implementation of MS-CHAPv2
773 # in EAP. There is another (incompatible) implementation
774 # of MS-CHAPv2 in EAP by Cisco, which FreeRADIUS does not
778 # Prior to version 2.1.11, the module never
779 # sent the MS-CHAP-Error message to the
780 # client. This worked, but it had issues
781 # when the cached password was wrong. The
782 # server *should* send "E=691 R=0" to the
783 # client, which tells it to prompt the user
784 # for a new password.
786 # The default is to behave as in 2.1.10 and
787 # earlier, which is known to work. If you
788 # set "send_error = yes", then the error
789 # message will be sent back to the client.
790 # This *may* help some clients work better,
791 # but *may* also cause other clients to stop