radsecproxy.conf.5.xml 44.5 KB
Newer Older
1
2
3
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry>
  <refentryinfo>
Linus Nordberg's avatar
Linus Nordberg committed
5
    <date>2012-05-23</date>
6
7
8
9
10
11
  </refentryinfo>
  <refmeta>
    <refentrytitle>
      <application>radsecproxy.conf</application>
    </refentrytitle>
    <manvolnum>5</manvolnum>
Linus Nordberg's avatar
Linus Nordberg committed
12
    <refmiscinfo>radsecproxy 1.6.1-dev</refmiscinfo>
13
14
15
16
17
  </refmeta>
  <refnamediv>
    <refname>
      <application>radsecproxy.conf</application>
    </refname>
18
    <refpurpose>Radsec proxy configuration file</refpurpose>
19
20
21
22
  </refnamediv>
  <refsect1>
    <title>Description</title>
    <para>
23
24
25
      When the proxy server starts, it will first check the command
      line arguments, and then read the configuration file. Normally
      radsecproxy will read the configuration file
26
      <filename>/usr/local/etc/radsecproxy.conf</filename>. The command line
27
28
      <option>-c</option> option can be used to instead read an
      alternate file (see
29
      <citerefentry>
30
        <refentrytitle>radsecproxy</refentrytitle><manvolnum>1</manvolnum>
31
      </citerefentry>
32
      for details).
33
34
    </para>
    <para>
Linus Nordberg's avatar
Linus Nordberg committed
35
36
37
38
      If the configuration file can not be found, the proxy will exit
      with an error message. Note that there is also an include facility
      so that any configuration file may include other configuration
      files. The proxy will also exit on configuration errors.
39
40
41
42
43
    </para>
  </refsect1>
  <refsect1>
    <title>Configuration Syntax</title>
    <para>
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
      When the configuration file is processed, whitespace (spaces and
      tabs) are generally ignored. For each line, leading and trailing
      whitespace are ignored.  A line is ignored if it is empty, only
      consists of whitespace, or if the first non-whitespace character
      is a <literal>#</literal>. The configuration is generally case
      insensitive, but in some cases the option values (see below) are
      not.
    </para>
    <para>
      There are two types of configuration structures than can be
      used. The first and simplest are lines on the format
      <emphasis>option value</emphasis>. That is, an option name, see
      below for a list of valid options, followed by whitespace (at
      least one space or tab character), followed by a value. Note
      that if the value contains whitespace, then it must be quoted
      using <literal>""</literal> or <literal>''</literal>. Any
      whitespace in front of the option or after the value will be
      ignored.
    </para>
    <para>
      The other type of structure is a block. A block spans at least
      two lines, and has the format:
      <blockquote><literallayout>
67
68
69
70
71
blocktype name {
    option value
    option value
    ...
}
72
73
74
75
76
77
78
79
80
      </literallayout></blockquote>
      That is, some blocktype, see below for a list of the different
      block types, and then enclosed in braces you have zero or more
      lines that each have the previously described <emphasis>option
      value</emphasis> format. Different block types have different
      rules for which options can be specified, they are listed
      below. The rules regarding white space, comments and quotes are
      as above. Hence you may do things like:
      <blockquote><literallayout>
81
82
83
84
85
blocktype name {
#    option value
    option "value with space"
    ...
}
86
      </literallayout></blockquote>
87
88
    </para>
    <para>
89
90
91
92
93
94
95
96
      Option value characters can also be written in hex. This is done
      by writing the character <literal>%</literal> followed by two
      hexadecimal digits. If a <literal>%</literal> is used without
      two following hexadecimal digits, the <literal>%</literal> and
      the following characters are used as written. If you want to
      write a <literal>%</literal> and not use this decoding, you may
      of course write <literal>%</literal> in hex; i.e.,
      <literal>%25</literal>.
97
98
    </para>
    <para>
99
100
      There is one special option that can be used both as a basic
      option and inside all blocks. That is the option
Linus Nordberg's avatar
Linus Nordberg committed
101
      <literal>Include</literal> where the value specifies files to be
102
103
      included. The value can be a single file, or it can use normal
      shell globbing to specify multiple files, e.g.:
104
105
      <blockquote>
        <para>
106
	  include /usr/local/etc/radsecproxy.conf.d/*.conf
107
108
        </para>
      </blockquote>
109
110
111
112
      The files are sorted alphabetically. Included files are read in
      the order they are specified, when reaching the end of a file,
      the next file is read. When reaching the end of the last
      included file, the proxy returns to read the next line following
Linus Nordberg's avatar
Linus Nordberg committed
113
      the <literal>Include</literal> option. Included files may again
114
      include other files.
115
116
117
118
119
    </para>
  </refsect1>
  <refsect1>
    <title>Basic Options</title>
    <para>
120
121
122
123
124
125
      The following basic options may be specified in the
      configuration file. Note that blocktypes and options inside
      blocks are discussed later. Note that none of these options are
      required, and indeed in many cases they are not needed.  Note
      that you should specify each at most once. The behaviour with
      multiple occurences is undefined.
126
127
    </para>
    <variablelist>
Linus Nordberg's avatar
Linus Nordberg committed
128
129
130
131
132
133
134
135
136
137
138
      <varlistentry>
        <term><literal>PidFile</literal></term>
        <listitem>
	  <para>
            The PidFile option specifies the name of a file to which
            the process id (PID) will be written.  This is overridden
            by the <option>-i</option> command line option.  There is
            no default value for the PidFile option.
	  </para>
        </listitem>
      </varlistentry>
139
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
140
        <term><literal>LogLevel</literal></term>
141
142
        <listitem>
	  <para>
143
144
145
146
147
	    This option specifies the debug level. It must be set to
	    1, 2, 3, 4 or 5, where 1 logs only serious errors, and 5
	    logs everything. The default is 2 which logs errors,
	    warnings and a few informational messages. Note that the
	    command line option <option>-d</option> overrides this.
148
149
150
151
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
152
        <term><literal>LogDestination</literal></term>
153
154
        <listitem>
	  <para>
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
	    This specifies where the log messages should go. By
	    default the messages go to syslog with facility
	    <literal>LOG_DAEMON</literal>. Using this option you can
	    specify another syslog facility, or you may specify that
	    logging should be to a particular file, not using
	    syslog. The value must be either a file or syslog URL. The
	    file URL is the standard one, specifying a local file that
	    should be used. For syslog, you must use the syntax:
	    <literal>x-syslog:///FACILITY</literal> where
	    <literal>FACILITY</literal> must be one of
	    <literal>LOG_DAEMON</literal>,
	    <literal>LOG_MAIL</literal>, <literal>LOG_USER</literal>,
	    <literal>LOG_LOCAL0</literal>,
	    <literal>LOG_LOCAL1</literal>,
	    <literal>LOG_LOCAL2</literal>,
	    <literal>LOG_LOCAL3</literal>,
	    <literal>LOG_LOCAL4</literal>,
	    <literal>LOG_LOCAL5</literal>,
	    <literal>LOG_LOCAL6</literal> or
	    <literal>LOG_LOCAL7</literal>. You may omit the facility
	    from the URL to specify logging to the default facility,
	    but this is not very useful since this is the default log
	    destination. Note that this option is ignored if
	    <option>-f</option> is specified on the command line.
179
180
181
	  </para>
        </listitem>
      </varlistentry>
182
183
184
185
186

      <varlistentry>
        <term><literal>FTicksReporting</literal></term>
        <listitem>
	  <para>
187
188
189
	    The FTicksReporting option is used to enable F-Ticks
	    logging and can be set to <literal>None</literal>,
	    <literal>Basic</literal> or <literal>Full</literal>.  Its
190
191
192
193
194
	    default value is <literal>None</literal>.  If
	    FTicksReporting is set to anything other than
	    <literal>None</literal>, note that the default value for
	    FTicksMAC is <literal>VendorKeyHashed</literal> which
	    needs FTicksKey to be set.
195
196
	  </para>
	  <para>
197
198
	    See <literal>radsecproxy.conf-example</literal> for
	    details.  Note that radsecproxy has to be configured with
199
200
	    F-Ticks support (<literal>--enable-fticks</literal>) for
	    this option to have any effect.
201
202
203
204
205
206
207
208
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term><literal>FTicksMAC</literal></term>
        <listitem>
	  <para>
209
	    The FTicksMAC option can be used to control if and how
210
211
212
	    Calling-Station-Id (the users Ethernet MAC address) is
	    being logged.  It can be set to one of
	    <literal>Static</literal>, <literal>Original</literal>,
213
214
215
216
	    <literal>VendorHashed</literal>,
	    <literal>VendorKeyHashed</literal>,
	    <literal>FullyHashed</literal> or
	    <literal>FullyKeyHashed</literal>.
217
218
	  </para>
	  <para>
219
220
221
222
223
224
225
226
227
228
	    The default value for FTicksMAC is
	    <literal>VendorKeyHashed</literal>.  This means that
	    FTicksKey has to be set.
	  <para>
	    Before chosing any of <literal>Original</literal>,
	    <literal>FullyHashed</literal> or
	    <literal>VendorHashed</literal>, consider the implications
	    for user privacy when MAC addresses are collected.  How
	    will the logs be stored, transferred and accessed?
	  </para>
229
230
	  </para>
	  <para>
231
232
	    See <literal>radsecproxy.conf-example</literal> for
	    details.  Note that radsecproxy has to be configured with
233
234
	    F-Ticks support (<literal>--enable-fticks</literal>) for
	    this option to have any effect.
235
236
237
238
239
240
241
242
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term><literal>FTicksKey</literal></term>
        <listitem>
	  <para>
243
244
245
246
	    The FTicksKey option is used to specify the key to use
	    when producing HMAC's as an effect of specifying
	    VendorKeyHashed or FullyKeyHashed for the FTicksMAC
	    option.
247
248
	  </para>
	  <para>
249
250
	    Note that radsecproxy has to be configured with F-Ticks
	    support (<literal>--enable-fticks</literal>) for this
251
	    option to have any effect.
252
253
254
255
	  </para>
	</listitem>
      </varlistentry>

256
257
258
259
      <varlistentry>
        <term><literal>FTicksSyslogFacility</literal></term>
        <listitem>
	  <para>
260
261
262
263
264
	    The FTicksSyslogFacility option is used to specify a
	    dedicated syslog facility for F-Ticks messages.  This
	    allows for easier filtering of F-Ticks messages.  If no
	    FTicksSyslogFacility option is given, F-Ticks messages are
	    written to what the LogDestination option specifies.
265
266
	  </para>
	  <para>
267
268
269
270
	    F-Ticks messages are always logged using the log level
	    LOG_DEBUG.  Note that specifying a file in
	    FTicksSyslogFacility (using the file:/// prefix) is
	    not supported.
271
272
273
274
	  </para>
	</listitem>
      </varlistentry>

275
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
276
        <term><literal>ListenUDP</literal></term>
277
278
        <listitem>
	  <para>
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
	    Normally the proxy will listen to the standard RADIUS UDP
	    port <literal>1812</literal> if configured to handle UDP
	    clients. On most systems it will do this for all of the
	    system's IP addresses (both IPv4 and IPv6). On some
	    systems however, it may respond to only IPv4 or only
	    IPv6. To specify an alternate port you may use a value on
	    the form <literal>*:port</literal> where port is any valid
	    port number. If you also want to specify a specific
	    address you can do
	    e.g. <literal>192.168.1.1:1812</literal> or
	    <literal>[2001:db8::1]:1812</literal>. The port may be
	    omitted if you want the default one (like in these
	    examples). These examples are equivalent to
	    <literal>192.168.1.1</literal> and
	    <literal>2001:db8::1</literal>. Note that you must use
	    brackets around the IPv6 address.  This option may be
	    specified multiple times to listen to multiple addresses
	    and/or ports.
297
298
299
300
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
301
        <term><literal>ListenTCP</literal></term>
302
303
        <listitem>
	  <para>
Linus Nordberg's avatar
Linus Nordberg committed
304
	    This option is similar to the <literal>ListenUDP</literal>
305
306
307
	    option, except that it is used for receiving connections
	    from TCP clients. The default port number is
	    <literal>1812</literal>.
308
309
310
311
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
312
        <term><literal>ListenTLS</literal></term>
313
314
        <listitem>
	  <para>
Linus Nordberg's avatar
Linus Nordberg committed
315
	    This is similar to the <literal>ListenUDP</literal>
316
317
318
	    option, except that it is used for receiving connections
	    from TLS clients. The default port number is
	    <literal>2083</literal>. Note that this option was
Linus Nordberg's avatar
Linus Nordberg committed
319
	    previously called <literal>ListenTCP</literal>.
320
321
322
323
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
324
        <term><literal>ListenDTLS</literal></term>
325
326
        <listitem>
	  <para>
Linus Nordberg's avatar
Linus Nordberg committed
327
	    This is similar to the <literal>ListenUDP</literal>
328
329
330
	    option, except that it is used for receiving connections
	    from DTLS clients. The default port number is
	    <literal>2083</literal>.
331
332
333
334
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
335
        <term><literal>SourceUDP</literal></term>
336
337
        <listitem>
	  <para>
338
339
340
	    This can be used to specify source address and/or source
	    port that the proxy will use for sending UDP client
	    messages (e.g. Access Request).
341
342
343
344
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
345
        <term><literal>SourceTCP</literal></term>
346
347
        <listitem>
	  <para>
348
349
	    This can be used to specify source address and/or source
	    port that the proxy will use for TCP connections.
350
351
352
353
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
354
        <term><literal>SourceTLS</literal></term>
355
356
        <listitem>
	  <para>
357
358
	    This can be used to specify source address and/or source
	    port that the proxy will use for TLS connections.
359
360
361
362
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
363
        <term><literal>SourceDTLS</literal></term>
364
365
        <listitem>
	  <para>
366
367
	    This can be used to specify source address and/or source
	    port that the proxy will use for DTLS connections.
368
369
370
	  </para>
        </listitem>
      </varlistentry>
venaas's avatar
venaas committed
371
372
373
374
      <varlistentry>
        <term><literal>TTLAttribute</literal></term>
        <listitem>
	  <para>
375
376
377
378
379
380
	    This can be used to change the default TTL attribute. Only
	    change this if you know what you are doing. The syntax is
	    either a numerical value denoting the TTL attribute, or
	    two numerical values separated by column specifying a
	    vendor attribute,
	    i.e. <literal>vendorid:attribute</literal>.
venaas's avatar
venaas committed
381
382
383
384
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
385
        <term><literal>AddTTL</literal></term>
venaas's avatar
venaas committed
386
387
        <listitem>
	  <para>
388
389
390
	    If a TTL attribute is present, the proxy will decrement
	    the value and discard the message if zero. Normally the
	    proxy does nothing if no TTL attribute is present. If you
Linus Nordberg's avatar
Linus Nordberg committed
391
	    use the AddTTL option with a value 1-255, the proxy will
392
393
394
395
396
	    when forwarding a message with no TTL attribute, add one
	    with the specified value. Note that this option can also
	    be specified for a client/server. It will then override
	    this setting when forwarding a message to that
	    client/server.
venaas's avatar
venaas committed
397
398
399
	  </para>
        </listitem>
      </varlistentry>
400
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
401
        <term><literal>LoopPrevention</literal></term>
402
403
        <listitem>
	  <para>
404
405
406
407
408
409
410
411
412
	    This can be set to <literal>on</literal> or
	    <literal>off</literal> with <literal>off</literal> being
	    the default. When this is enabled, a request will never be
	    sent to a server named the same as the client it was
	    received from. I.e., the names of the client block and the
	    server block are compared.  Note that this only gives
	    limited protection against loops.  It can be used as a
	    basic option and inside server blocks where it overrides
	    the basic setting.
413
414
415
	  </para>
        </listitem>
      </varlistentry>
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
      <varlistentry>
        <term><literal>IPv4Only and IPv6Only</literal></term>
        <listitem>
	  <para>
            These can be set to <literal>on</literal> or
            <literal>off</literal> with <literal>off</literal> being
            the default.  At most one of <literal>IPv4Only</literal>
            and <literal>IPv6Only</literal> can be enabled.  Enabling
            <literal>IPv4Only</literal> or <literal>IPv6Only</literal>
            makes radsecproxy resolve DNS names to the corresponding
            address family only, and not the other.  This is done for
            both clients and servers.  Note that this can be
            overridden in <literal>client</literal> and
            <literal>server</literal> blocks, see below.
	  </para>
        </listitem>
      </varlistentry>
433
      <varlistentry>
Linus Nordberg's avatar
Linus Nordberg committed
434
        <term><literal>Include</literal></term>
435
436
        <listitem>
	  <para>
437
438
439
440
	    This is not a normal configuration option; it can be
	    specified multiple times.  It can both be used as a basic
	    option and inside blocks. For the full description, see
	    the configuration syntax section above.
441
442
443
444
445
446
447
448
	  </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>Blocks</title>
    <para>
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
      There are five types of blocks, they are
      <literal>client</literal>, <literal>server</literal>,
      <literal>realm</literal>, <literal>tls</literal> and
      <literal>rewrite</literal>. At least one instance of each of
      <literal>client</literal> and <literal>realm</literal> is
      required. This is necessary for the proxy to do anything useful,
      and it will exit if not. The <literal>tls</literal> block is
      required if at least one TLS/DTLS client or server is
      configured. Note that there can be multiple blocks for each
      type.  For each type, the block names should be unique. The
      behaviour with multiple occurences of the same name for the same
      block type is undefined. Also note that some block option values
      may reference a block by name, in which case the block name must
      be previously defined. Hence the order of the blocks may be
      significant.
464
465
466
467
468
    </para>
  </refsect1>
  <refsect1>
    <title>Client Block</title>
    <para>
469
470
471
472
473
      The client block is used to configure a client. That is, tell
      the proxy about a client, and what parameters should be used for
      that client. The name of the client block must (with one
      exception, see below) be either the IP address (IPv4 or IPv6) of
      the client, an IP prefix (IPv4 or IPv6) on the form
474
475
476
477
478
      IpAddress/PrefixLength, or a domain name (FQDN).  The way an
      FQDN is resolved into an IP address may be influenced by the use
      of the <literal>IPv4Only</literal> and
      <literal>IPv6Only</literal> options.  Note that literal IPv6
      addresses must be enclosed in brackets.
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
    </para>
    <para>
      If a domain name is specified, then this will be resolved
      immediately to all the addresses associated with the name, and
      the proxy will not care about any possible DNS changes that
      might occur later. Hence there is no dependency on DNS after
      startup.
    </para>
    <para>
      When some client later sends a request to the proxy, the proxy
      will look at the IP address the request comes from, and then go
      through all the addresses of each of the configured clients (in
      the order they are defined), to determine which (if any) of the
      clients this is.
    </para>
    <para>
      In the case of TLS/DTLS, the name of the client must match the
      FQDN or IP address in the client certificate. Note that this is
      not required when the client name is an IP prefix.
    </para>
    <para>
      Alternatively one may use the <literal>host</literal> option
      inside a client block. In that case, the value of the
      <literal>host</literal> option is used as above, while the name
      of the block is only used as a descriptive name for the
      administrator. The host option may be used multiple times, and
      can be a mix of addresses, FQDNs and prefixes.
    </para>
    <para>
      The allowed options in a client block are
509
510
      <literal>host</literal>, <literal>IPv4Only</literal>,
      <literal>IPv6Only</literal>, <literal>type</literal>,
511
512
513
      <literal>secret</literal>, <literal>tls</literal>,
      <literal>certificateNameCheck</literal>,
      <literal>matchCertificateAttribute</literal>,
Linus Nordberg's avatar
Linus Nordberg committed
514
      <literal>duplicateInterval</literal>, <literal>AddTTL</literal>,
515
516
517
518
519
520
521
522
523
524
525
526
      <literal>fticksVISCOUNTRY</literal>,
      <literal>fticksVISINST</literal>, <literal>rewrite</literal>,
      <literal>rewriteIn</literal>, <literal>rewriteOut</literal>, and
      <literal>rewriteAttribute</literal>.

      We already discussed the <literal>host</literal> option.  To
      specify how radsecproxy should resolve a <literal>host</literal>
      given as a DNS name, the <literal>IPv4Only</literal> or the
      <literal>IPv6Only</literal> can be set to <literal>on</literal>.
      At most one of these options can be enabled.  Enabling
      <literal>IPv4Only</literal> or <literal>IPv6Only</literal> here
      overrides any basic settings set at the top level.
527

528
      The value of <literal>type</literal> must be one of
529
530
531
532
      <literal>udp</literal>, <literal>tcp</literal>,
      <literal>tls</literal> or <literal>dtls</literal>. The value of
      <literal>secret</literal> is the shared RADIUS key used with
      this client. If the secret contains whitespace, the value must
533
534
535
      be quoted. This option is optional for TLS/DTLS and if omitted
      will default to "mysecret".  Note that the default value of
      <literal>secret</literal> will change in an upcoming release.
536
537
538
539
540
541
542
543
544
545
546
    </para>
    <para>
      For a TLS/DTLS client you may also specify the
      <literal>tls</literal> option.  The option value must be the
      name of a previously defined TLS block. If this option is not
      specified, the TLS block with the name
      <literal>defaultClient</literal> will be used if defined. If not
      defined, it will try to use the TLS block named
      <literal>default</literal>. If the specified TLS block name does
      not exist, or the option is not specified and none of the
      defaults exist, the proxy will exit with an error.
547
548
549
550
551
552
553
554
555

      NOTE: All versions of radsecproxy up to and including 1.6
      erroneously verify client certificate chains using the CA in the
      very first matching client block regardless of which block is
      used for the final decision. This was changed in version 1.6.1
      so that a client block with a different <literal>tls</literal>
      option than the first matching client block is no longer
      considered for verification of clients.

556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
    </para>
    <para>
      For a TLS/DTLS client, the option
      <literal>certificateNameCheck</literal> can be set to
      <literal>off</literal>, to disable the default behaviour of
      matching CN or SubjectAltName against the specified hostname or
      IP address.
    </para>
    <para>
      Additional validation of certificate attributes can be done by
      use of the <literal>matchCertificateAttribute</literal>
      option. Currently one can only do some matching of CN and
      SubjectAltName. For regexp matching on CN, one can use the value
      <literal>CN:/regexp/</literal>. For SubjectAltName one can only
      do regexp matching of the URI, this is specified as
      <literal>SubjectAltName:URI:/regexp/</literal>. Note that
      currently this option can only be specified once in a client
      block.
    </para>
    <para>
      The <literal>duplicateInterval</literal> option can be used to
      specify for how many seconds duplicate checking should be
      done. If a proxy receives a new request within a few seconds of
      a previous one, it may be treated the same if from the same
      client, with the same authenticator etc. The proxy will then
      ignore the new request (if it is still processing the previous
      one), or returned a copy of the previous reply.
    </para>
    <para>
Linus Nordberg's avatar
Linus Nordberg committed
585
586
      The <literal>AddTTL</literal> option is similar to the
      <literal>AddTTL</literal> option used in the basic config. See
587
588
589
      that for details. Any value configured here overrides the basic
      one when sending messages to this client.
    </para>
Linus Nordberg's avatar
Linus Nordberg committed
590
591
592
593
594
    <para>
      The <literal>fticksVISCOUNTRY</literal> option configures
      clients eligible to F-Ticks logging as defined by the
      <literal>FTicksReporting</literal> basic option.
    </para>
595
596
597
598
599
    <para>
      The <literal>fticksVISINST</literal> option overwrites
      the default <literal>VISINST</literal> value taken from the client
      block name.
    </para>
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
    <para>
      The <literal>rewrite</literal> option is deprecated. Use
      <literal>rewriteIn</literal> instead.
    </para>
    <para>
      The <literal>rewriteIn</literal> option can be used to refer to
      a rewrite block that specifies certain rewrite operations that
      should be performed on incoming messages from the client. The
      rewriting is done before other processing.  For details, see the
      rewrite block text below. Similarly to <literal>tls</literal>
      discussed above, if this option is not used, there is a fallback
      to using the <literal>rewrite</literal> block named
      <literal>defaultClient</literal> if it exists; and if not, a
      fallback to a block named <literal>default</literal>.
    </para>
    <para>
      The <literal>rewriteOut</literal> option is used in the same way
      as <literal>rewriteIn</literal>, except that it specifies
      rewrite operations that should be performed on outgoing messages
      to the client. The rewriting is done after other
      processing. Also, there is no rewrite fallback if this option is
      not used.
    </para>
    <para>
      The <literal>rewriteAttribute</literal> option currently makes
      it possible to specify that the User-Name attribute in a client
      request shall be rewritten in the request sent by the proxy. The
      User-Name attribute is written back to the original value if a
      matching response is later sent back to the client. The value
      must be on the form User-Name:/regexpmatch/replacement/. Example
      usage:
631
632
      <blockquote>
        <para>
633
	  rewriteAttribute User-Name:/^(.*)@local$/\1@example.com/
634
635
636
637
638
639
640
        </para>
      </blockquote>
    </para>
  </refsect1>
  <refsect1>
    <title>Server Block</title>
    <para>
641
642
643
644
645
646
647
648
649
650
651
652
      The server block is used to configure a server. That is, tell
      the proxy about a server, and what parameters should be used
      when communicating with that server.  The name of the server
      block must (with one exception, see below) be either the IP
      address (IPv4 or IPv6) of the server, or a domain name
      (FQDN). If a domain name is specified, then this will be
      resolved immediately to all the addresses associated with the
      name, and the proxy will not care about any possible DNS changes
      that might occur later. Hence there is no dependency on DNS
      after startup. If the domain name resolves to multiple
      addresses, then for UDP/DTLS the first address is used. For
      TCP/TLS, the proxy will loop through the addresses until it can
653
654
655
656
657
      connect to one of them. The way an FQDN is resolved into an IP
      address may be influenced by the use of the
      <literal>IPv4Only</literal> and <literal>IPv6Only</literal>
      options. In the case of TLS/DTLS, the name of the server must
      match the FQDN or IP address in the server certificate.
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
    </para>
    <para>
      Alternatively one may use the <literal>host</literal> option
      inside a server block. In that case, the value of the
      <literal>host</literal> option is used as above, while the name
      of the block is only used as a descriptive name for the
      administrator. Note that multiple host options may be used. This
      will then be treated as multiple names/addresses for the same
      server. When initiating a TCP/TLS connection, all addresses of
      all names may be attempted, but there is no failover between the
      different host values. For failover one must use separate server
      blocks.
    </para>
    <para>
      Note that the name of the block, or values of host options may
      include a port number (separated with a column). This port
      number will then override the default port or a port option in
      the server block. Also note that literal IPv6 addresses must be
      enclosed in brackets.
    </para>
    <para>
      The allowed options in a server block are
      <literal>host</literal>, <literal>port</literal>,
681
      <literal>IPv4Only</literal>, <literal>IPv6Only</literal>,
682
683
684
      <literal>type</literal>, <literal>secret</literal>,
      <literal>tls</literal>, <literal>certificateNameCheck</literal>,
      <literal>matchCertificateAttribute</literal>,
Linus Nordberg's avatar
Linus Nordberg committed
685
      <literal>AddTTL</literal>, <literal>rewrite</literal>,
686
687
      <literal>rewriteIn</literal>, <literal>rewriteOut</literal>,
      <literal>statusServer</literal>, <literal>retryCount</literal>,
688
      <literal>dynamicLookupCommand</literal> and
689
      <literal>retryInterval</literal> and
Linus Nordberg's avatar
Linus Nordberg committed
690
      <literal>LoopPrevention</literal>.
691
692
    </para>
    <para>
693
694
695
696
697
698
699
700
701
702
703
704
705

      We already discussed the <literal>host</literal> option.  To
      specify how radsecproxy should resolve a <literal>host</literal>
      given as a DNS name, the <literal>IPv4Only</literal> or the
      <literal>IPv6Only</literal> can be set to <literal>on</literal>.
      At most one of these options can be enabled.  Enabling
      <literal>IPv4Only</literal> or <literal>IPv6Only</literal> here
      overrides any basic settings set at the top level.

      The <literal>port</literal> option allows you to specify which
      port number the server uses. The usage of
      <literal>type</literal>, <literal>secret</literal>,
      <literal>tls</literal>, <literal>certificateNameCheck</literal>,
706
      <literal>matchCertificateAttribute</literal>,
Linus Nordberg's avatar
Linus Nordberg committed
707
      <literal>AddTTL</literal>, <literal>rewrite</literal>,
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
      <literal>rewriteIn</literal> and <literal>rewriteOut</literal>
      are just as specified for the <literal>client block</literal>
      above, except that <literal>defaultServer</literal> (and not
      <literal>defaultClient</literal>) is the fallback for the
      <literal>tls</literal>, <literal>rewrite</literal> and
      <literal>rewriteIn</literal> options.
    </para>
    <para>
      <literal>statusServer</literal> can be specified to enable the
      use of status-server messages for this server. The value must be
      either <literal>on</literal> or <literal>off</literal>. The
      default when not specified, is <literal>off</literal>. If
      statusserver is enabled, the proxy will during idle periods send
      regular status-server messages to the server to verify that it
      is alive. This should only be enabled if the server supports it.
    </para>
    <para>
      The options <literal>retryCount</literal> and
      <literal>retryInterval</literal> can be used to specify how many
      times the proxy should retry sending a request and how long it
      should wait between each retry. The defaults are 2 retries and
      an interval of 5s.
    </para>
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
    <para>
      The option <literal>dynamicLookupCommand</literal> can be used
      to specify a command that should be executed to dynamically
      configure a server.  The executable file should be given with
      full path and will be invoked with the name of the realm as its
      first and only argument.  It should either print a valid
      <literal>server</literal> option on stdout and exit with a code
      of 0 or print nothing and exit with a non-zero exit code.  An
      example of a shell script resolving the DNS NAPTR records for
      the realm and then the SRV records for each NAPTR matching
      'x-eduroam:radius.tls' is provided in
      <literal>tools/naptr-eduroam.sh</literal>.  This option was
      added in radsecproxy-1.3 but tends to crash radsecproxy versions
      earlier than 1.6.
    </para>
746
    <para>
Linus Nordberg's avatar
Linus Nordberg committed
747
      Using the <literal>LoopPrevention</literal> option here
748
749
      overrides any basic setting of this option.  See section
      <literal>BASIC OPTIONS</literal> for details on this option.
750
    </para>
751
752
753
754
  </refsect1>
  <refsect1>
    <title>Realm Block</title>
    <para>
755
756
757
758
759
760
761
762
763
764
765
766
767
      When the proxy receives an Access-Request it needs to figure out
      to which server it should be forwarded. This is done by looking
      at the Username attribute in the request, and matching that
      against the names of the defined realm blocks.  The proxy will
      match against the blocks in the order they are specified, using
      the first match if any. If no realm matches, the proxy will
      simply ignore the request. Each realm block specifies what the
      server should do when a match is found. A realm block may
      contain none, one or multiple <literal>server</literal> options,
      and similarly <literal>accountingServer</literal> options. There
      are also <literal>replyMessage</literal> and
      <literal>accountingResponse</literal> options. We will discuss
      these later.
768
769
770
771
    </para>
    <refsect2>
      <title>Realm block names and matching</title>
      <para>
772
773
774
775
776
777
778
779
780
	In the general case the proxy will look for a
	<literal>@</literal> in the username attribute, and try to do
	an exact case insensitive match between what comes after the
	<literal>@</literal> and the name of the realm block. So if
	you get a request with the attribute value
	<literal>anonymous@example.com</literal>, the proxy will go
	through the realm names in the order they are specified,
	looking for a realm block named
	<literal>example.com</literal>.
781
782
      </para>
      <para>
783
784
785
786
787
788
	There are two exceptions to this, one is the realm name
	<literal>*</literal> which means match everything. Hence if
	you have a realm block named <literal>*</literal>, then it
	will always match. This should then be the last realm block
	defined, since any blocks after this would never be
	checked. This is useful for having a default.
789
790
      </para>
      <para>
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
	The other exception is regular expression matching. If the
	realm name starts with a <literal>/</literal>, the name is
	treated as an regular expression. A case insensitive regexp
	match will then be done using this regexp on the value of the
	entire Username attribute. Optionally you may also have a
	trailing <literal>/</literal> after the regexp. So as an
	example, if you want to use regexp matching the domain
	<literal>example.com</literal> you could have a realm block
	named <literal>/@example\\.com$</literal>. Optinally this can
	also be written <literal>/@example\\.com$/</literal>. If you
	want to match all domains under the <literal>.com</literal>
	top domain, you could do <literal>/@.*\\.com$</literal>. Note
	that since the matching is done on the entire attribute value,
	you can also use rules like
	<literal>/^[a-k].*@example\\.com$/</literal> to get some of
	the users in this domain to use one server, while other users
	could be matched by another realm block and use another
	server.
Linus Nordberg's avatar
Linus Nordberg committed
809
      </para>
810
811
812
813
    </refsect2>
    <refsect2>
      <title>Realm block options</title>
      <para>
814
815
816
817
818
819
820
821
822
823
824
825
	A realm block may contain none, one or multiple
	<literal>server</literal> options. If defined, the values of
	the <literal>server</literal> options must be the names of
	previously defined server blocks. Normally requests will be
	forwarded to the first server option defined. If there are
	multiple server options, the proxy will do fail-over and use
	the second server if the first is down. If the two first are
	down, it will try the third etc. If say the first server comes
	back up, it will go back to using that one. Currently
	detection of servers being up or down is based on the use of
	StatusServer (if enabled), and that TCP/TLS/DTLS connections
	are up.
826
827
      </para>
      <para>
828
829
830
831
832
833
834
835
	A realm block may also contain none, one or multiple
	<literal>accountingServer</literal> options. This is used
	exactly like the <literal>server</literal> option, except that
	it is used for specifying where to send matching accounting
	requests. The values must be the names of previously defined
	server blocks. When multiple accounting servers are defined,
	there is a failover mechanism similar to the one for the
	<literal>server</literal> option.
836
837
      </para>
      <para>
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
	If there is no <literal>server</literal> option, the proxy
	will if <literal>replyMessage</literal> is specified, reply
	back to the client with an Access Reject message. The message
	contains a replyMessage attribute with the value as specified
	by the <literal>replyMessage</literal> option. Note that this
	is different from having no match since then the request is
	simply ignored. You may wonder why this is useful. One example
	is if you handle say all domains under say
	<literal>.bv</literal>. Then you may have several realm blocks
	matching the domains that exists, while for other domains
	under <literal>.bv</literal> you want to send a reject. At the
	same time you might want to send all other requests to some
	default server. After the realms for the subdomains, you would
	then have two realm definitions. One with the name
	<literal>/@.*\\.bv$</literal> with no servers, followed by one
	with the name <literal>*</literal> with the default server
	defined. This may also be useful for blocking particular
	usernames.
856
857
      </para>
      <para>
858
859
860
861
862
863
864
865
866
867
	If there is no <literal>accountingServer</literal> option, the
	proxy will normally do nothing, ignoring accounting
	requests. There is however an option called
	<literal>accountingResponse</literal>. If this is set to
	<literal>on</literal>, the proxy will log some of the
	accounting information and send an Accounting-Response
	back. This is useful if you do not care much about accounting,
	but want to stop clients from retransmitting accounting
	requests. By default this option is set to
	<literal>off</literal>.
868
869
870
871
872
873
      </para>
    </refsect2>
  </refsect1>
  <refsect1>
    <title>TLS Block</title>
    <para>
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
      The TLS block specifies TLS configuration options and you need
      at least one of these if you have clients or servers using
      TLS/DTLS. As discussed in the client and server block
      descriptions, a client or server block may reference a
      particular TLS block by name. There are also however the special
      TLS block names <literal>default</literal>,
      <literal>defaultClient</literal> and
      <literal>defaultServer</literal> which are used as defaults if
      the client or server block does not reference a TLS block. Also
      note that a TLS block must be defined before the client or
      server block that would use it. If you want the same TLS
      configuration for all TLS/DTLS clients and servers, you need
      just a single tls block named <literal>default</literal>, and
      the client and servers need not refer to it. If you want all
      TLS/DTLS clients to use one config, and all TLS/DTLS servers to
      use another, then you would be fine only defining two TLS blocks
      named <literal>defaultClient</literal> and
      <literal>defaultServer</literal>. If you want different clients
      (or different servers) to have different TLS parameters, then
      you may need to create other TLS blocks with other names, and
      reference those from the client or server definitions. Note that
      you could also have say a client block refer to a default, even
      <literal>defaultServer</literal> if you really want to.
    </para>
    <para>
      The available TLS block options are
      <literal>CACertificateFile</literal>,
      <literal>CACertificatePath</literal>,
      <literal>certificateFile</literal>,
      <literal>certificateKeyFile</literal>,
      <literal>certificateKeyPassword</literal>,
      <literal>cacheExpiry</literal>, <literal>CRLCheck</literal> and
      <literal>policyOID</literal>.  When doing RADIUS over TLS/DTLS,
      both the client and the server present certificates, and they
      are both verified by the peer. Hence you must always specify
      <literal>certificateFile</literal> and
      <literal>certificateKeyFile</literal> options, as well as
      <literal>certificateKeyPassword</literal> if a password is
      needed to decrypt the private key. Note that
      <literal>CACertificateFile</literal> may be a certificate
      chain. In order to verify certificates, or send a chain of
      certificates to a peer, you also always need to specify
      <literal>CACertificateFile</literal> or
      <literal>CACertificatePath</literal>.  Note that you may specify
      both, in which case the certificates in
      <literal>CACertificateFile</literal> are checked first. By
      default CRLs are not checked. This can be changed by setting
      <literal>CRLCheck</literal> to <literal>on</literal>. One can
      require peer certificates to adhere to certain policies by
      specifying one or multiple policyOIDs using one or multiple
      <literal>policyOID</literal> options.
    </para>
    <para>
      CA certificates and CRLs are normally cached permanently. That
      is, once a CA or CRL has been read, the proxy will never attempt
      to re-read it. CRLs may change relatively often and the proxy
      should ideally always use the latest CRLs. Rather than
      restarting the proxy, there is an option
      <literal>cacheExpiry</literal> that specifies how many seconds
      the CA and CRL information should be cached. Reasonable values
      might be say 3600 (1 hour) or 86400 (24 hours), depending on how
      frequently CRLs are updated and how critical it is to be up to
      date. This option may be set to zero to disable caching.
937
938
939
940
941
    </para>
  </refsect1>
  <refsect1>
    <title>Rewrite Block</title>
    <para>
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
      The rewrite block specifies rules that may rewrite RADIUS
      messages. It can be used to add, remove and modify specific
      attributes from messages received from and sent to clients and
      servers. As discussed in the client and server block
      descriptions, a client or server block may reference a
      particular rewrite block by name. There are however also the
      special rewrite block names <literal>default</literal>,
      <literal>defaultClient</literal> and
      <literal>defaultServer</literal> which are used as defaults if
      the client or server block does not reference a block. Also note
      that a rewrite block must be defined before the client or server
      block that would use it. If you want the same rewrite rules for
      input from all clients and servers, you need just a single
      rewrite block named <literal>default</literal>, and the client
      and servers need not refer to it. If you want all clients to use
      one config, and all servers to use another, then you would be
      fine only defining two rewrite blocks named
      <literal>defaultClient</literal> and
      <literal>defaultServer</literal>. Note that these defaults are
      only used for rewrite on input. No rewriting is done on output
962
      unless explicitly specified using the
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
      <literal>rewriteOut</literal> option.
    </para>
    <para>
      The available rewrite block options are
      <literal>addAttribute</literal>,
      <literal>addVendorAttribute</literal>,
      <literal>removeAttribute</literal>,
      <literal>removeVendorAttribute</literal> and
      <literal>modifyAttribute</literal>. They can all be specified
      none, one or multiple times.
    </para>
    <para>
      <literal>addAttribute</literal> is used to add attributes to a
      message. The option value must be on the form
      <literal>attribute:value</literal> where attribute is a
      numerical value specifying the attribute.  Simliarly, the
      <literal>addVendorAttribute</literal> is used to specify a
      vendor attribute to be added.  The option value must be on the
      form <literal>vendor:subattribute:value</literal>, where vendor
      and subattribute are numerical values.
    </para>
    <para>
      The <literal>removeAttribute</literal> option is used to specify
      an attribute that should be removed from received messages. The
      option value must be a numerical value specifying which
      attribute is to be removed.  Similarly,
      <literal>removeVendorAttribute</literal> is used to specify a
      vendor attribute that is to be removed. The value can be a
      numerical value for removing all attributes from a given vendor,
      or on the form <literal>vendor:subattribute</literal>, where
      vendor and subattribute are numerical values, for removing a
      specific subattribute for a specific vendor.
    </para>
    <para>
      <literal>modifyAttribute</literal> is used to specify
      modification of attributes. The value must be on the form
      <literal>attribute:/regexpmatch/replacement/</literal> where
      attribute is a numerical attribute type, regexpmatch is regexp
      matching rule and replacement specifies how to replace the
      matching regexp. Example usage:
1003
1004
      <blockquote>
        <para>
1005
	  modifyAttribute 1:/^(.*)@local$/\1@example.com/
1006
1007
1008
1009
1010
1011
1012
1013
        </para>
      </blockquote>
    </para>
  </refsect1>
  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry>
1014
        <refentrytitle>radsecproxy</refentrytitle><manvolnum>1</manvolnum>
Linus Nordberg's avatar
Linus Nordberg committed
1015
1016
1017
1018
	</citerefentry>,
	<ulink url="http://tools.ietf.org/html/draft-ietf-radext-radsec">
	  <citetitle>RadSec internet draft</citetitle>
	</ulink>
1019
1020
1021
    </para>
  </refsect1>
</refentry>