Noted new, sane, method to create certificates
[freeradius.git] / raddb / eap.conf
1 # -*- text -*-
2 #
3 #  Whatever you do, do NOT set 'Auth-Type := EAP'.  The server
4 #  is smart enough to figure this out on its own.  The most
5 #  common side effect of setting 'Auth-Type := EAP' is that the
6 #  users then cannot use ANY other authentication method.
7 #
8 #       $Id$
9 #
10         eap {
11                 #  Invoke the default supported EAP type when
12                 #  EAP-Identity response is received.
13                 #
14                 #  The incoming EAP messages DO NOT specify which EAP
15                 #  type they will be using, so it MUST be set here.
16                 #
17                 #  For now, only one default EAP type may be used at a time.
18                 #
19                 #  If the EAP-Type attribute is set by another module,
20                 #  then that EAP type takes precedence over the
21                 #  default type configured here.
22                 #
23                 default_eap_type = md5
24
25                 #  A list is maintained to correlate EAP-Response
26                 #  packets with EAP-Request packets.  After a
27                 #  configurable length of time, entries in the list
28                 #  expire, and are deleted.
29                 #
30                 timer_expire     = 60
31
32                 #  There are many EAP types, but the server has support
33                 #  for only a limited subset.  If the server receives
34                 #  a request for an EAP type it does not support, then
35                 #  it normally rejects the request.  By setting this
36                 #  configuration to "yes", you can tell the server to
37                 #  instead keep processing the request.  Another module
38                 #  MUST then be configured to proxy the request to
39                 #  another RADIUS server which supports that EAP type.
40                 #
41                 #  If another module is NOT configured to handle the
42                 #  request, then the request will still end up being
43                 #  rejected.
44                 ignore_unknown_eap_types = no
45
46                 # Cisco AP1230B firmware 12.2(13)JA1 has a bug.  When given
47                 # a User-Name attribute in an Access-Accept, it copies one
48                 # more byte than it should.
49                 #
50                 # We can work around it by configurably adding an extra
51                 # zero byte.
52                 cisco_accounting_username_bug = no
53
54                 # Supported EAP-types
55
56                 #
57                 #  We do NOT recommend using EAP-MD5 authentication
58                 #  for wireless connections.  It is insecure, and does
59                 #  not provide for dynamic WEP keys.
60                 #
61                 md5 {
62                 }
63
64                 # Cisco LEAP
65                 #
66                 #  We do not recommend using LEAP in new deployments.  See:
67                 #  http://www.securiteam.com/tools/5TP012ACKE.html
68                 #
69                 #  Cisco LEAP uses the MS-CHAP algorithm (but not
70                 #  the MS-CHAP attributes) to perform it's authentication.
71                 #
72                 #  As a result, LEAP *requires* access to the plain-text
73                 #  User-Password, or the NT-Password attributes.
74                 #  'System' authentication is impossible with LEAP.
75                 #
76                 leap {
77                 }
78
79                 #  Generic Token Card.
80                 #
81                 #  Currently, this is only permitted inside of EAP-TTLS,
82                 #  or EAP-PEAP.  The module "challenges" the user with
83                 #  text, and the response from the user is taken to be
84                 #  the User-Password.
85                 #
86                 #  Proxying the tunneled EAP-GTC session is a bad idea,
87                 #  the users password will go over the wire in plain-text,
88                 #  for anyone to see.
89                 #
90                 gtc {
91                         #  The default challenge, which many clients
92                         #  ignore..
93                         #challenge = "Password: "
94
95                         #  The plain-text response which comes back
96                         #  is put into a User-Password attribute,
97                         #  and passed to another module for
98                         #  authentication.  This allows the EAP-GTC
99                         #  response to be checked against plain-text,
100                         #  or crypt'd passwords.
101                         #
102                         #  If you say "Local" instead of "PAP", then
103                         #  the module will look for a User-Password
104                         #  configured for the request, and do the
105                         #  authentication itself.
106                         #
107                         auth_type = PAP
108                 }
109
110                 ## EAP-TLS
111                 #
112                 #  To generate test certificates, do:
113                 #
114                 #       $ cd ./certs
115                 #       $ make
116                 #
117                 #  See also the "README" file in that directory.
118                 #
119                 #  The documents on http://www.freeradius.org/doc
120                 #  are old, but may be helpful.
121                 #
122                 #  See also:
123                 #
124                 #  http://www.dslreports.com/forum/remark,9286052~mode=flat
125                 #
126                 #tls {
127                 #       private_key_password = whatever
128                 #       private_key_file = ${raddbdir}/certs/server.pem
129
130                         #  If Private key & Certificate are located in
131                         #  the same file, then private_key_file &
132                         #  certificate_file must contain the same file
133                         #  name.
134                 #       certificate_file = ${raddbdir}/certs/server.pem
135
136                         #  Trusted Root CA list
137                 #       CA_file = ${raddbdir}/certs/ca.pem
138
139                         #
140                         #  For DH cipher suites to work, you have to
141                         #  run OpenSSL to create the DH file first:
142                         #
143                         #       openssl dhparam -out certs/dh 1024
144                         #
145                 #       dh_file = ${raddbdir}/certs/dh
146                 #       random_file = ${raddbdir}/certs/random
147
148                         #
149                         #  This can never exceed the size of a RADIUS
150                         #  packet (4096 bytes), and is preferably half
151                         #  that, to accomodate other attributes in
152                         #  RADIUS packet.  On most APs the MAX packet
153                         #  length is configured between 1500 - 1600
154                         #  In these cases, fragment size should be
155                         #  1024 or less.
156                         #
157                 #       fragment_size = 1024
158
159                         #  include_length is a flag which is
160                         #  by default set to yes If set to
161                         #  yes, Total Length of the message is
162                         #  included in EVERY packet we send.
163                         #  If set to no, Total Length of the
164                         #  message is included ONLY in the
165                         #  First packet of a fragment series.
166                         #
167                 #       include_length = yes
168
169                         #  Check the Certificate Revocation List
170                         #
171                         #  1) Copy CA certificates and CRLs to same directory.
172                         #  2) Execute 'c_rehash <CA certs&CRLs Directory>'.
173                         #    'c_rehash' is OpenSSL's command.
174                         #  3) Add 'CA_path=<CA certs&CRLs directory>'
175                         #      to radiusd.conf's tls section.
176                         #  4) uncomment the line below.
177                         #  5) Restart radiusd
178                 #       check_crl = yes
179
180                        #
181                        #  If check_cert_issuer is set, the value will
182                        #  be checked against the DN of the issuer in
183                        #  the client certificate.  If the values do not
184                        #  match, the cerficate verification will fail,
185                        #  rejecting the user.
186                        #
187                 #       check_cert_issuer = "/C=GB/ST=Berkshire/L=Newbury/O=My Company Ltd"
188
189                        #
190                        #  If check_cert_cn is set, the value will
191                        #  be xlat'ed and checked against the CN
192                        #  in the client certificate.  If the values
193                        #  do not match, the certificate verification
194                        #  will fail rejecting the user.
195                        #
196                        #  This check is done only if the previous
197                        #  "check_cert_issuer" is not set, or if
198                        #  the check succeeds.
199                        #
200                 #       check_cert_cn = %{User-Name}
201                 #
202                         # Set this option to specify the allowed
203                         # TLS cipher suites.  The format is listed
204                         # in "man 1 ciphers".
205                 #       cipher_list = "DEFAULT"
206                 #}
207
208                 #  The TTLS module implements the EAP-TTLS protocol,
209                 #  which can be described as EAP inside of Diameter,
210                 #  inside of TLS, inside of EAP, inside of RADIUS...
211                 #
212                 #  Surprisingly, it works quite well.
213                 #
214                 #  The TTLS module needs the TLS module to be installed
215                 #  and configured, in order to use the TLS tunnel
216                 #  inside of the EAP packet.  You will still need to
217                 #  configure the TLS module, even if you do not want
218                 #  to deploy EAP-TLS in your network.  Users will not
219                 #  be able to request EAP-TLS, as it requires them to
220                 #  have a client certificate.  EAP-TTLS does not
221                 #  require a client certificate.
222                 #
223                 #ttls {
224                         #  The tunneled EAP session needs a default
225                         #  EAP type which is separate from the one for
226                         #  the non-tunneled EAP module.  Inside of the
227                         #  TTLS tunnel, we recommend using EAP-MD5.
228                         #  If the request does not contain an EAP
229                         #  conversation, then this configuration entry
230                         #  is ignored.
231                 #       default_eap_type = md5
232
233                         #  The tunneled authentication request does
234                         #  not usually contain useful attributes
235                         #  like 'Calling-Station-Id', etc.  These
236                         #  attributes are outside of the tunnel,
237                         #  and normally unavailable to the tunneled
238                         #  authentication request.
239                         #
240                         #  By setting this configuration entry to
241                         #  'yes', any attribute which NOT in the
242                         #  tunneled authentication request, but
243                         #  which IS available outside of the tunnel,
244                         #  is copied to the tunneled request.
245                         #
246                         # allowed values: {no, yes}
247                 #       copy_request_to_tunnel = no
248
249                         #  The reply attributes sent to the NAS are
250                         #  usually based on the name of the user
251                         #  'outside' of the tunnel (usually
252                         #  'anonymous').  If you want to send the
253                         #  reply attributes based on the user name
254                         #  inside of the tunnel, then set this
255                         #  configuration entry to 'yes', and the reply
256                         #  to the NAS will be taken from the reply to
257                         #  the tunneled request.
258                         #
259                         # allowed values: {no, yes}
260                 #       use_tunneled_reply = no
261                 #}
262
263                 ##################################################
264                 #
265                 #  !!!!! WARNINGS for Windows compatibility  !!!!!
266                 #
267                 ##################################################
268                 #
269                 #  If you see the server send an Access-Challenge,
270                 #  and the client never sends another Access-Request,
271                 #  then
272                 #
273                 #               STOP!
274                 #
275                 #  The server certificate has to have special OID's
276                 #  in it, or else the Microsoft clients will silently
277                 #  fail.  See the "scripts/xpextensions" file for
278                 #  details, and the following page:
279                 #
280                 #       http://support.microsoft.com/kb/814394/en-us
281                 #
282                 #  For additional Windows XP SP2 issues, see:
283                 #
284                 #       http://support.microsoft.com/kb/885453/en-us
285                 #
286                 #  Note that we do not necessarily agree with their
287                 #  explanation... but the fix does appear to work.
288                 #
289                 ##################################################
290
291                 #
292                 #  The tunneled EAP session needs a default EAP type
293                 #  which is separate from the one for the non-tunneled
294                 #  EAP module.  Inside of the TLS/PEAP tunnel, we
295                 #  recommend using EAP-MS-CHAPv2.
296                 #
297                 #  The PEAP module needs the TLS module to be installed
298                 #  and configured, in order to use the TLS tunnel
299                 #  inside of the EAP packet.  You will still need to
300                 #  configure the TLS module, even if you do not want
301                 #  to deploy EAP-TLS in your network.  Users will not
302                 #  be able to request EAP-TLS, as it requires them to
303                 #  have a client certificate.  EAP-PEAP does not
304                 #  require a client certificate.
305                 #
306                 # peap {
307                         #  The tunneled EAP session needs a default
308                         #  EAP type which is separate from the one for
309                         #  the non-tunneled EAP module.  Inside of the
310                         #  PEAP tunnel, we recommend using MS-CHAPv2,
311                         #  as that is the default type supported by
312                         #  Windows clients.
313                 #       default_eap_type = mschapv2
314
315                         #  the PEAP module also has these configuration
316                         #  items, which are the same as for TTLS.
317                 #       copy_request_to_tunnel = no
318                 #       use_tunneled_reply = no
319
320                         #  When the tunneled session is proxied, the
321                         #  home server may not understand EAP-MSCHAP-V2.
322                         #  Set this entry to "no" to proxy the tunneled
323                         #  EAP-MSCHAP-V2 as normal MSCHAPv2.
324                 #       proxy_tunneled_request_as_eap = yes
325                 #}
326
327                 #
328                 #  This takes no configuration.
329                 #
330                 #  Note that it is the EAP MS-CHAPv2 sub-module, not
331                 #  the main 'mschap' module.
332                 #
333                 #  Note also that in order for this sub-module to work,
334                 #  the main 'mschap' module MUST ALSO be configured.
335                 #
336                 #  This module is the *Microsoft* implementation of MS-CHAPv2
337                 #  in EAP.  There is another (incompatible) implementation
338                 #  of MS-CHAPv2 in EAP by Cisco, which FreeRADIUS does not
339                 #  currently support.
340                 #
341                 mschapv2 {
342                 }
343         }
344