radsecproxy.conf.5.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   3 <refentry>
   4   <refentryinfo>
   5     <date>2008-11-06</date>
   6   </refentryinfo>
   7   <refmeta>
   8     <refentrytitle>
   9       <application>radsecproxy.conf</application>
  10     </refentrytitle>
  11     <manvolnum>5</manvolnum>
  12     <refmiscinfo>radsecproxy devel 2008-11-06</refmiscinfo>
  13   </refmeta>
  14   <refnamediv>
  15     <refname>
  16       <application>radsecproxy.conf</application>
  17     </refname>
  18     <refpurpose>
  19 Radsec proxy configuration file
  20     </refpurpose>
  21   </refnamediv>
  22   <refsect1>
  23     <title>Description</title>
  24     <para>
  25 When the proxy server starts, it will first check the command line arguments,
  26 and then read the configuration file. Normally radsecproxy will read the
  27 configuration file <filename>/etc/radsecproxy.conf</filename>. The command
  28 line <option>-c</option> option can be used to instead read an alternate
  29 file (see
  30       <citerefentry>
  31         <refentrytitle>radsecproxy</refentrytitle>
  32         <manvolnum>1</manvolnum>
  33       </citerefentry>
  34 for details).
  35     </para>
  36     <para>
  37     If the configuration file can not be found, the proxy will exit with an
  38     error message. Note that there is also an include facility so that any
  39     configuration file may include other configuration files. The proxy will
  40     also exit on configuration errors.
  41     </para>
  42   </refsect1>
  43   <refsect1>
  44     <title>Configuration Syntax</title>
  45     <para>
  46 When the configuration file is processed, whitespace (spaces and tabs) are
  47 generally ignored. For each line, leading and trailing whitespace are ignored.
  48 A line is ignored if it is empty, only consists of whitespace, or if the first
  49 non-whitespace character is a <literal>#</literal>. The configuration is
  50 generally case insensitive, but in some cases the option values (see below)
  51 are not.
  52     </para>
  53     <para>
  54 There are two types of configuration structures than can be used. The first
  55 and simplest are lines of the format <emphasis>option value</emphasis>. That
  56 is, an option name, see below for a list of valid options, followed by
  57 whitespace (at least one space or tab character), followed by a value. Note
  58 that if the value contains whitespace, then it must be quoted using
  59 <literal>""</literal> or <literal>''</literal>. Any whitespace
  60 in front of the option or after the value will be ignored.
  61     </para>
  62     <para>
  63 The other type of structure is a block. A block spans at least two lines, and
  64 has the format:
  65       <blockquote>
  66 <literallayout>
  67 blocktype name {
  68     option value
  69     option value
  70     ...
  71 }
  72 </literallayout>
  73       </blockquote>
  74 That is, some blocktype, see below for a list of the different block types, and
  75 then enclosed in braces you have zero or more lines that each have the
  76 previously described <emphasis>option value</emphasis> format. Different block
  77 types have different rules for which options can be specified, they are listed
  78 below. The rules regarding white space, comments and quotes are as above. Hence
  79 you may do things like:
  80       <blockquote>
  81         <para>
  82 <literallayout>
  83 blocktype name {
  84 #    option value
  85     option "value with space"
  86     ...
  87 }
  88 </literallayout>
  89         </para>
  90       </blockquote>
  91     </para>
  92     <para>
  93 Option value characters can also be written in hex. This is done by writing the
  94 character <literal>%</literal> followed by two hexadecimal digits. If a
  95 <literal>%</literal> is used without two following hexadecimal digits, the
  96 <literal>%</literal> and the following characters are used as written. If you
  97 want to write a <literal>%</literal> and not use this decoding, you may of
  98 course write <literal>%</literal> in hex; i.e., <literal>%25</literal>.
  99     </para>
 100     <para>
 101 There is one special option that can be used both as a basic option and inside
 102 all blocks. That is the option <literal>include</literal> where the value
 103 specifies files to be included. The value can be a single file, or it can use
 104 normal shell globbing to specify multiple files, e.g.:
 105       <blockquote>
 106         <para>
 107 include /etc/radsecproxy.conf.d/*.conf
 108         </para>
 109       </blockquote>
 110 The files are sorted alphabetically. Included files are read in the order they
 111 are specified, when reaching the end of a file, the next file is read. When
 112 reaching the end of the last included file, the proxy returns to read the next
 113 line following the <literal>include</literal> option. Included files may again
 114 include other files.
 115     </para>
 116   </refsect1>
 117   <refsect1>
 118     <title>Basic Options</title>
 119     <para>
 120 The following basic options may be specified in the configuration file. Note
 121 that blocktypes and options inside blocks are discussed later. Note that none
 122 of these options are required, and indeed in many cases they are not needed.
 123 Note that you should specify each at most once. The behaviour with multiple
 124 occurences is undefined.
 125     </para>
 126     <variablelist>
 127       <varlistentry>
 128         <term><literal>logLevel</literal></term>
 129         <listitem>
 130           <para>
 131 This option specifies the debug level. It must be set to 1, 2, 3 or 4, where 1
 132 logs only serious errors, and 4 logs everything. The default is 3 which logs
 133 errors, warnings and some informational messages. Note that the command line
 134 option <option>-d</option> overrides this.
 135           </para>
 136         </listitem>
 137       </varlistentry>
 138       <varlistentry>
 139         <term><literal>logDestination</literal></term>
 140         <listitem>
 141           <para>
 142 This specifies where the log messages should go. By default the messages go to
 143 syslog with facility <literal>LOG_DAEMON</literal>. Using this option you can
 144 specify another syslog facility, or you may specify that logging should be to
 145 a particular file, not using syslog. The value must be either a file or
 146 syslog URL. The file URL is the standard one, specifying a local file that
 147 should be used. For syslog, you must use the syntax:
 148 <literal>x-syslog:///FACILITY</literal> where <literal>FACILITY</literal> must
 149 be one of <literal>LOG_DAEMON</literal>, <literal>LOG_MAIL</literal>,
 150 <literal>LOG_USER</literal>, <literal>LOG_LOCAL0</literal>,
 151 <literal>LOG_LOCAL1</literal>, <literal>LOG_LOCAL2</literal>,
 152 <literal>LOG_LOCAL3</literal>, <literal>LOG_LOCAL4</literal>,
 153 <literal>LOG_LOCAL5</literal>, <literal>LOG_LOCAL6</literal> or
 154 <literal>LOG_LOCAL7</literal>. You may omit the facility from the URL to
 155 specify logging to the default facility, but this is not very useful since
 156 this is the default log destination. Note that this option is ignored if
 157 <option>-f</option> is specified on the command line.
 158           </para>
 159         </listitem>
 160       </varlistentry>
 161       <varlistentry>
 162         <term><literal>listenUDP</literal></term>
 163         <listitem>
 164           <para>
 165 Normally the proxy will listen to the standard RADIUS UDP port
 166 <literal>1812</literal> if configured to handle UDP clients. On most systems it
 167 will do this for all of the system's IP addresses (both IPv4 and IPv6). On some
 168 systems however, it may respond to only IPv4 or only IPv6. To specify an
 169 alternate port you may use a value of the form <literal>*:port</literal> where
 170 port is any valid port number. If you also want to specify a specific address
 171 you can do e.g. <literal>192.168.1.1:1812</literal> or
 172 <literal>[2001:db8::1]:1812</literal>. The port may be omitted if you want the
 173 default one (like in these examples). These examples are equivalent to
 174 <literal>192.168.1.1</literal> and <literal>2001:db8::1</literal>. Note that
 175 you must use brackets around the IPv6 address if you specify port number.
 176 This option may be specified multiple times to listen to multiple addresses
 177 and/or ports.
 178           </para>
 179         </listitem>
 180       </varlistentry>
 181       <varlistentry>
 182         <term><literal>listenTCP</literal></term>
 183         <listitem>
 184           <para>
 185 This option is similar to the <literal>listenUDP</literal> option, except
 186 that it is used for receiving connections from TCP clients. The default port
 187 number is <literal>1812</literal>.
 188           </para>
 189         </listitem>
 190       </varlistentry>
 191       <varlistentry>
 192         <term><literal>listenTLS</literal></term>
 193         <listitem>
 194           <para>
 195 This is similar to the <literal>listenUDP</literal> option, except that it is
 196 used for receiving connections from TLS clients. The default port number is
 197 <literal>2083</literal>. Note that this option was previously called
 198 <literal>listenTCP</literal>.
 199           </para>
 200         </listitem>
 201       </varlistentry>
 202       <varlistentry>
 203         <term><literal>listenDTLS</literal></term>
 204         <listitem>
 205           <para>
 206 This is similar to the <literal>listenUDP</literal> option, except that it is
 207 used for receiving connections from DTLS clients. The default port number is
 208 <literal>2083</literal>.
 209           </para>
 210         </listitem>
 211       </varlistentry>
 212       <varlistentry>
 213         <term><literal>listenAccountingUDP</literal></term>
 214         <listitem>
 215           <para>
 216 This is similar to the <literal>listenUDP</literal> option, except that it is
 217 used for specifying port and optionally the address to receive UDP Accounting
 218 messages on.
 219           </para>
 220         </listitem>
 221       </varlistentry>
 222       <varlistentry>
 223         <term><literal>sourceUDP</literal></term>
 224         <listitem>
 225           <para>
 226 This can be used to specify source address and/or source port that the proxy
 227 will use for sending UDP client messages (e.g. Access Request).
 228           </para>
 229         </listitem>
 230       </varlistentry>
 231       <varlistentry>
 232         <term><literal>sourceTCP</literal></term>
 233         <listitem>
 234           <para>
 235 This can be used to specify source address and/or source port that the proxy
 236 will use for TCP connections.
 237           </para>
 238         </listitem>
 239       </varlistentry>
 240       <varlistentry>
 241         <term><literal>sourceTLS</literal></term>
 242         <listitem>
 243           <para>
 244 This can be used to specify source address and/or source port that the proxy
 245 will use for TLS connections.
 246           </para>
 247         </listitem>
 248       </varlistentry>
 249       <varlistentry>
 250         <term><literal>sourceDTLS</literal></term>
 251         <listitem>
 252           <para>
 253 This can be used to specify source address and/or source port that the proxy
 254 will use for DTLS connections.
 255           </para>
 256         </listitem>
 257       </varlistentry>
 258       <varlistentry>
 259         <term><literal>TTLAttribute</literal></term>
 260         <listitem>
 261           <para>
 262 This can be used to change the default TTL attribute. Only change this if
 263 you know what you are doing. The syntax is either a numerical value
 264 denoting the TTL attribute, or two numerical values separated by column
 265 specifying a vendor attribute, i.e. <literal>vendorid:attribute</literal>.
 266           </para>
 267         </listitem>
 268       </varlistentry>
 269       <varlistentry>
 270         <term><literal>addTTL</literal></term>
 271         <listitem>
 272           <para>
 273 If a TTL attribute is present, the proxy will decrement the value and
 274 discard the message if zero. Normally the proxy does nothing if no TTL
 275 attribute is present. If you use the addTTL option with a value 1-255,
 276 the proxy will when forwarding a message with no TTL attribute, add one
 277 with the specified value. Note that this option can also be specified
 278 for a client/server. It will then override this setting when forwarding
 279 a message to that client/server.
 280           </para>
 281         </listitem>
 282       </varlistentry>
 283       <varlistentry>
 284         <term><literal>loopPrevention</literal></term>
 285         <listitem>
 286           <para>
 287 This can be set to <literal>on</literal> or <literal>off</literal> with
 288 <literal>off</literal> being the default. When this is enabled, a request
 289 will never be sent to a server named the same as the client it was received
 290 from. I.e., the names of the client block and the server block are compared.
 291 Note that this only gives limited protection against loops.
 292           </para>
 293         </listitem>
 294       </varlistentry>
 295       <varlistentry>
 296         <term><literal>include</literal></term>
 297         <listitem>
 298           <para>
 299 This is not a normal configuration option; it can be specified multiple times.
 300 It can both be used as a basic option and inside blocks. For the full
 301 description, see the configuration syntax section above.
 302           </para>
 303         </listitem>
 304       </varlistentry>
 305     </variablelist>
 306   </refsect1>
 307   <refsect1>
 308     <title>Blocks</title>
 309     <para>
 310 There are five types of blocks, they are <literal>client</literal>,
 311 <literal>server</literal>, <literal>realm</literal>, <literal>tls</literal>
 312 and <literal>rewrite</literal>. At least one instance of each of
 313 <literal>client</literal> and <literal>realm</literal> is required. This is
 314 necessary for the proxy to do anything useful, and it will exit if not. The
 315 <literal>tls</literal> block is required if at least one TLS/DTLS client or
 316 server is configured. Note that there can be multiple blocks for each type.
 317 For each type, the block names should be unique. The behaviour with multiple
 318 occurences of the same name for the same block type is undefined. Also note
 319 that some block option values may reference a block by name, in which case
 320 the block name must be previously defined. Hence the order of the blocks may
 321 be significant.
 322     </para>
 323   </refsect1>
 324   <refsect1>
 325     <title>Client Block</title>
 326     <para>
 327 The client block is used to configure a client. That is, tell the proxy about a
 328 client, and what parameters should be used for that client. The name of the
 329 client block must (with one exception, see below) be either the IP address
 330 (IPv4 or IPv6) of the client, an IP prefix (IPv4 or IPv6) of the form
 331 IpAddress/PrefixLength, or a domain name (FQDN).
 332     </para>
 333     <para>
 334 If a domain name is specified, then this will be resolved immediately to all
 335 the addresses associated with the name, and the proxy will not care about any
 336 possible DNS changes that might occur later. Hence there is no dependency on
 337 DNS after startup.
 338     </para>
 339     <para>
 340 When some client later sends a request to the proxy, the proxy will look at the
 341 IP address the request comes from, and then go through all the addresses of
 342 each of the configured clients (in the order they are defined), to determine
 343 which (if any) of the clients this is.
 344     </para>
 345     <para>
 346 In the case of TLS/DTLS, the name of the client must match the FQDN or IP
 347 address in the client certificate. Note that this is not required when the
 348 client name is an IP prefix.
 349     </para>
 350     <para>
 351 Alternatively one may use the <literal>host</literal> option inside a client
 352 block. In that case, the value of the <literal>host</literal> option is used as
 353 above, while the name of the block is only used as a descriptive name for the
 354 administrator.
 355     </para>
 356     <para>
 357 The allowed options in a client block are <literal>host</literal>,
 358 <literal>type</literal>, <literal>secret</literal>, <literal>tls</literal>,
 359 <literal>certificateNameCheck</literal>,
 360 <literal>matchCertificateAttribute</literal>,
 361 <literal>duplicateInterval</literal>, <literal>addTTL</literal>,
 362 <literal>rewrite</literal>, <literal>rewriteIn</literal>,
 363 <literal>rewriteOut</literal> and <literal>rewriteAttribute</literal>.
 364 We already discussed the
 365 <literal>host</literal> option. The value of <literal>type</literal> must be
 366 one of <literal>udp</literal>, <literal>tcp</literal>, <literal>tls</literal>
 367 or <literal>dtls</literal>. The value of <literal>secret</literal> is the
 368 shared RADIUS key used with this client. If the secret contains whitespace,
 369 the value must be quoted. This option is optional for TLS/DTLS.
 370     </para>
 371     <para>
 372 For a TLS/DTLS client you may also specify the <literal>tls</literal> option.
 373 The option value must be the name of a previously defined TLS block. If this
 374 option is not specified, the TLS block with the name
 375 <literal>defaultClient</literal> will be used if defined. If not defined, it
 376 will try to use the TLS block named <literal>default</literal>. If the
 377 specified TLS block name does not exist, or the option is not specified and
 378 none of the defaults exist, the proxy will exit with an error.
 379     </para>
 380     <para>
 381 For a TLS/DTLS client, the option <literal>certificateNameCheck</literal>
 382 can be set
 383 to <literal>off</literal>, to disable the default behaviour of matching CN or
 384 SubjectAltName against the specified hostname or IP address.
 385     </para>
 386     <para>
 387 Additional validation of certificate attributes can be done by use of the
 388 <literal>matchCertificateAttribute</literal> option. Currently one can only do
 389 some matching of CN and SubjectAltName. For regexp matching on CN, one can use
 390 the value <literal>CN:/regexp/</literal>. For SubjectAltName one can only do
 391 regexp matching of the URI, this is specified as
 392 <literal>SubjectAltName:URI:/regexp/</literal>. Note that currently this option
 393 can only be specified once in a client block.
 394     </para>
 395     <para>
 396 The <literal>duplicateInterval</literal> option can be used to specify for how
 397 many seconds duplicate checking should be done. If a proxy receives a new
 398 request within a few seconds of a previous one, it may be treated the same if
 399 from the same client, with the same authenticator etc. The proxy will then
 400 ignore the new request (if it is still processing the previous one), or
 401 returned a copy of the previous reply.
 402     </para>
 403     <para>
 404 The <literal>addTTL</literal> option is similar to the
 405 <literal>addTTL</literal> option used in the basic config. See that for
 406 details. Any value configured here overrides the basic one when sending
 407 messages to this client.
 408     </para>
 409     <para>
 410 The <literal>rewrite</literal> option is deprecated. Use
 411 <literal>rewriteIn</literal> instead.
 412     </para>
 413     <para>
 414 The <literal>rewriteIn</literal> option can be used to refer to a rewrite block
 415 that specifies certain rewrite operations that should be performed on incoming
 416 messages from the client. The rewriting is done before other processing.
 417 For details, see the rewrite block text below. Similarly to
 418 <literal>tls</literal> discussed above, if this option is not used, there is a
 419 fallback to using the <literal>rewrite</literal> block named
 420 <literal>defaultClient</literal> if it exists; and if not, a fallback to a
 421 block named <literal>default</literal>.
 422     </para>
 423     <para>
 424 The <literal>rewriteOut</literal> option is used in the same way as
 425 <literal>rewriteIn</literal>, except that it specifies rewrite operations that
 426 should be performed on outgoing messages to the client. The rewriting is done
 427 after other processing. Also, there is no rewrite fallback if this option is
 428 not used.
 429     </para>
 430     <para>
 431 The <literal>rewriteAttribute</literal> option currently makes it possible to
 432 specify that the User-Name attribute in a client request shall be rewritten in
 433 the request sent by the proxy. The User-Name attribute is written back to the
 434 original value if a matching response is later sent back to the client. The
 435 value must be of the form User-Name:/regexpmatch/replacement/. Example usage:
 436       <blockquote>
 437         <para>
 438 rewriteAttribute User-Name:/^(.*)@local$/$1@example.com/
 439         </para>
 440       </blockquote>
 441     </para>
 442   </refsect1>
 443   <refsect1>
 444     <title>Server Block</title>
 445     <para>
 446 The server block is used to configure a server. That is, tell the proxy about a
 447 server, and what parameters should be used when communicating with that server.
 448 The name of the server block must (with one exception, see below) be either the
 449 IP address (IPv4 or IPv6) of the server, or a domain name (FQDN). If a domain
 450 name is specified, then this will be resolved immediately to all the addresses
 451 associated with the name, and the proxy will not care about any possible DNS
 452 changes that might occur later. Hence there is no dependency on DNS after
 453 startup. If the domain name resolves to multiple addresses, then for UDP/DTLS
 454 the first address is used. For TCP/TLS, the proxy will loop through the
 455 addresses until it can connect to one of them. In the case of TLS/DTLS, the
 456 name of the server must match the FQDN or IP address in the server certificate.
 457     </para>
 458     <para>
 459 Alternatively one may use the <literal>host</literal> option inside a server
 460 block. In that case, the value of the <literal>host</literal> option is used as
 461 above, while the name of the block is only used as a descriptive name for the
 462 administrator.
 463     </para>
 464     <para>
 465 The allowed options in a server block are <literal>host</literal>,
 466 <literal>port</literal>, <literal>type</literal>, <literal>secret</literal>,
 467 <literal>tls</literal>, <literal>certificateNameCheck</literal>,
 468 <literal>matchCertificateAttribute</literal>, <literal>addTTL</literal>,
 469 <literal>rewrite</literal>,
 470 <literal>rewriteIn</literal>, <literal>rewriteOut</literal>,
 471 <literal>statusServer</literal>, <literal>retryCount</literal>,
 472 <literal>retryInterval</literal> and <literal>dynamicLookupCommand</literal>.
 473     </para>
 474     <para>
 475 We already discussed the <literal>host</literal> option. The
 476 <literal>port</literal> option allows you to specify which port number the
 477 server uses. The usage of <literal>type</literal>, <literal>secret</literal>,
 478 <literal>tls</literal>, <literal>certificateNameCheck</literal>,
 479 <literal>matchCertificateAttribute</literal>, <literal>addTTL</literal>,
 480 <literal>rewrite</literal>,
 481 <literal>rewriteIn</literal> and <literal>rewriteOut</literal> are just as
 482 specified for the <literal>client block</literal> above, except that
 483 <literal>defaultServer</literal> (and not <literal>defaultClient</literal>)
 484 is the fallback for the <literal>tls</literal>, <literal>rewrite</literal>
 485 and <literal>rewriteIn</literal> options.
 486     </para>
 487     <para>
 488 <literal>statusServer</literal> can be specified to enable the use of
 489 status-server messages for this server. The value must be either
 490 <literal>on</literal> or <literal>off</literal>. The default when not
 491 specified, is <literal>off</literal>. If statusserver is enabled, the proxy
 492 will during idle periods send regular status-server messages to the server
 493 to verify that it is alive. This should only be enabled if the server
 494 supports it.
 495     </para>
 496     <para>
 497 The options <literal>retryCount</literal> and
 498 <literal>retryInterval</literal> can be used to specify how many times the
 499 proxy should retry sending a request and how long it should wait between each
 500 retry. The defaults are 2 retries and an interval of 5s.
 501     </para>
 502     <para>
 503 The option <literal>dynamicLookupCommand</literal> can be used to specify a
 504 command that should be executed to dynamically configure and use a server.
 505 The use of this feature will be documented separately/later.
 506     </para>
 507   </refsect1>
 508   <refsect1>
 509     <title>Realm Block</title>
 510     <para>
 511 When the proxy receives an Access-Request it needs to figure out to which
 512 server it should be forwarded. This is done by looking at the Username attribute
 513 in the request, and matching that against the names of the defined realm blocks.
 514 The proxy will match against the blocks in the order they are specified, using
 515 the first match if any. If no realm matches, the proxy will simply ignore the
 516 request. Each realm block specifies what the server should do when a match is
 517 found. A realm block may contain none, one or multiple <literal>server</literal>
 518 options, and similarly <literal>accountingServer</literal> options. There are
 519 also <literal>replyMessage</literal> and <literal>accountingResponse</literal>
 520 options. We will discuss these later.
 521     </para>
 522     <refsect2>
 523       <title>Realm block names and matching</title>
 524       <para>
 525 In the general case the proxy will look for a <literal>@</literal> in the
 526 username attribute, and try to do an exact case insensitive match between what
 527 comes after the <literal>@</literal> and the name of the realm block. So if you
 528 get a request with the attribute value <literal>anonymous@example.com</literal>,
 529 the proxy will go through the realm names in the order they are specified,
 530 looking for a realm block named <literal>example.com</literal>.
 531       </para>
 532       <para>
 533 There are two exceptions to this, one is the realm name <literal>*</literal>
 534 which means match everything. Hence if you have a realm block named
 535 <literal>*</literal>, then it will always match. This should then be the last
 536 realm block defined, since any blocks after this would never be checked. This
 537 is useful for having a default.
 538       </para>
 539       <para>
 540 The other exception is regular expression matching. If the realm name starts
 541 with a <literal>/</literal>, the name is treated as an regular expression. A
 542 case insensitive regexp match will then be done using this regexp on the value
 543 of the entire Username attribute. Optionally you may also have a trailing
 544 <literal>/</literal> after the regexp. So as an example, if you want to use
 545 regexp matching the domain <literal>example.com</literal> you could have a
 546 realm block named <literal>/@example\\.com$</literal>. Optinally this can also
 547 be written <literal>/@example\\.com$/</literal>. If you want to match all
 548 domains under the <literal>.com</literal> top domain, you could do
 549 <literal>/@.*\\.com$</literal>. Note that since the matching is done on the
 550 entire attribute value, you can also use rules like
 551 <literal>/^[a-k].*@example\\.com$/</literal> to get some of the users in this
 552 domain to use one server, while other users could be matched by another realm
 553 block and use another server.
 554     </para>
 555     </refsect2>
 556     <refsect2>
 557       <title>Realm block options</title>
 558       <para>
 559 A realm block may contain none, one or multiple <literal>server</literal>
 560 options. If defined, the values of the <literal>server</literal> options must
 561 be the names of previously defined server blocks. Normally requests will be
 562 forwarded to the first server option defined. If there are multiple server
 563 options, the proxy will do fail-over and use the second server if the first
 564 is down. If the two first are down, it will try the third etc. If say the
 565 first server comes back up, it will go back to using that one. Currently
 566 detection of servers being up or down is based on the use of StatusServer (if
 567 enabled), and that TCP/TLS/DTLS connections are up.
 568       </para>
 569       <para>
 570 A realm block may also contain none, one or multiple
 571 <literal>accountingServer</literal> options. This is used exactly like the
 572 <literal>server</literal> option, except that it is used for specifying where
 573 to send matching accounting requests. The values must be the names of
 574 previously defined server blocks. When multiple accounting servers are
 575 defined, there is a failover mechanism similar to the one for the
 576 <literal>server</literal> option.
 577       </para>
 578       <para>
 579 If there is no <literal>server</literal> option, the proxy will if
 580 <literal>replyMessage</literal> is specified, reply back to the client with
 581 an Access Reject message. The message contains a replyMessage attribute with
 582 the value as specified by the <literal>replyMessage</literal> option. Note
 583 that this is different from having no match since then the request is simply
 584 ignored. You may wonder why this is useful. One example is if you handle say
 585 all domains under say <literal>.bv</literal>. Then you may have several realm
 586 blocks matching the domains that exists, while for other domains under
 587 <literal>.bv</literal> you want to send a reject. At the same time you might
 588 want to send all other requests to some default server. After the realms for
 589 the subdomains, you would then have two realm definitions. One with the name
 590 <literal>/@.*\\.bv$</literal> with no servers, followed by one with the name
 591 <literal>*</literal> with the default server defined. This may also be useful
 592 for blocking particular usernames.
 593       </para>
 594       <para>
 595 If there is no <literal>accountingServer</literal> option, the proxy will
 596 normally do nothing, ignoring accounting requests. There is however an option
 597 called <literal>accountingResponse</literal>. If this is set to
 598 <literal>on</literal>, the proxy will log some of the accounting information
 599 and send an Accounting-Response back. This is useful if you do not care much
 600 about accounting, but want to stop clients from retransmitting accounting
 601 requests. By default this option is set to <literal>off</literal>.
 602       </para>
 603     </refsect2>
 604   </refsect1>
 605   <refsect1>
 606     <title>TLS Block</title>
 607     <para>
 608 The TLS block specifies TLS configuration options and you need at least one
 609 of these if you have clients or servers using TLS/DTLS. As discussed in the
 610 client and server block descriptions, a client or server block may reference
 611 a particular TLS block by name. There are also however the special TLS block
 612 names <literal>default</literal>, <literal>defaultClient</literal> and
 613 <literal>defaultServer</literal> which are used as defaults if the client or
 614 server block does not reference a TLS block. Also note that a TLS block must
 615 be defined before the client or server block that would use it. If you want
 616 the same TLS configuration for all TLS/DTLS clients and servers, you need
 617 just a single tls block named <literal>default</literal>, and the client and
 618 servers need not refer to it. If you want all TLS/DTLS clients to use one
 619 config, and all TLS/DTLS servers to use another, then you would be fine only
 620 defining two TLS blocks named <literal>defaultClient</literal> and
 621 <literal>defaultServer</literal>. If you want different clients (or different
 622 servers) to have different TLS parameters, then you may need to create other
 623 TLS blocks with other names, and reference those from the client or server
 624 definitions. Note that you could also have say a client block refer to a
 625 default, even <literal>defaultServer</literal> if you really want to.
 626     </para>
 627     <para>
 628 The available TLS block options are <literal>CACertificateFile</literal>,
 629 <literal>CACertificatePath</literal>, <literal>certificateFile</literal>,
 630 <literal>certificateKeyFile</literal>,
 631 <literal>certificateKeyPassword</literal>, <literal>cacheExpiry</literal>,
 632 <literal>CRLCheck</literal> and <literal>policyOID</literal>.
 633 When doing RADIUS over TLS/DTLS, both the
 634 client and the server present certificates, and they are both verified by
 635 the peer. Hence you must always specify <literal>certificateFile</literal>
 636 and <literal>certificateKeyFile</literal> options, as well as
 637 <literal>certificateKeyPassword</literal> if a password is needed to decrypt
 638 the private key. Note that <literal>CACertificateFile</literal> may be a
 639 certificate chain. In order to verify certificates, or send a chain of
 640 certificates to a peer, you also always need to specify
 641 <literal>CACertificateFile</literal> or <literal>CACertificatePath</literal>.
 642 Note that you may specify both, in which case the certificates in
 643 <literal>CACertificateFile</literal> are checked first. By default CRLs are
 644 not checked. This can be changed by setting <literal>CRLCheck</literal> to
 645 <literal>on</literal>. One can require peer certificates to adhere to certain
 646 policies by specifying one or multiple policyOIDs using one or multiple
 647 <literal>policyOID</literal> options.
 648     </para>
 649     <para>
 650 CA certificates and CRLs are normally cached permanently. That is, once a CA
 651 or CRL has been read, the proxy will never attempt to re-read it. CRLs may
 652 change relatively often and the proxy should ideally always use the latest
 653 CRLs. Rather than restarting the proxy, there is an option
 654 <literal>cacheExpiry</literal> that specifies how many seconds the CA and
 655 CRL information should be cached. Reasonable values might be say 3600
 656 (1 hour) or 86400 (24 hours), depending on how frequently CRLs are updated
 657 and how critical it is to be up to date. This option may be set to zero to
 658 disable caching.
 659     </para>
 660   </refsect1>
 661   <refsect1>
 662     <title>Rewrite Block</title>
 663     <para>
 664 The rewrite block specifies rules that may rewrite RADIUS messages. It can be
 665 used to add, remove and modify specific attributes from messages received
 666 from and sent to clients and servers. As discussed in the client and server
 667 block descriptions, a client or server block may reference a particular
 668 rewrite block by name. There are however also the special rewrite block names
 669 <literal>default</literal>, <literal>defaultClient</literal> and
 670 <literal>defaultServer</literal> which are used as defaults if the client or
 671 server block does not reference a block. Also note that a rewrite block must
 672 be defined before the client or server block that would use it. If you want
 673 the same rewrite rules for input from all clients and servers, you need just
 674 a single rewrite block named <literal>default</literal>, and the client and
 675 servers need not refer to it. If you want all clients to use one config, and
 676 all servers to use another, then you would be fine only defining two rewrite
 677 blocks named <literal>defaultClient</literal> and
 678 <literal>defaultServer</literal>. Note that these defaults are only used for
 679 rewrite on input. No rewriting is done on output unless explicitly specifed
 680 using the <literal>rewriteOut</literal> option.
 681     </para>
 682     <para>
 683 The available rewrite block options are <literal>addAttribute</literal>,
 684 <literal>removeAttribute</literal>, <literal>removeVendorAttribute</literal>
 685 and <literal>modifyAttribute</literal>. They can all be specified none, one
 686 or multiple times.
 687     </para>
 688     <para>
 689 <literal>addAttribute</literal> is used to add attributes to a message. The
 690 option value must be of the form <literal>attribute:value</literal> where
 691 attribute is a numerical value specifying the attribute.
 692     </para>
 693     <para>
 694 The <literal>removeAttribute</literal> option is used to specify an
 695 attribute that  should be removed from received messages. The option value
 696 must be a numerical value specifying which attribute is to be removed.
 697 Similarly, <literal>removeVendorAttribute</literal> is used to specify a
 698 vendor attribute that is to be removed. The value can be a numerical value
 699 for removing all attributes from a given vendor, or of the form
 700 <literal>vendor:subattribute</literal>, where vendor and subattribute are
 701 numerical values, for removing a specific subattribute for a specific
 702 vendor.
 703     </para>
 704     <para>
 705 <literal>modifyAttribute</literal> is used to specify modification of
 706 attributes. The value must be of the form
 707 <literal>attribute:/regexpmatch/replacement/</literal> where attribute is
 708 a numerical attribute type, regexpmatch is regexp matching rule and
 709 replacement specifies how to replace the matching regexp. Example usage:
 710       <blockquote>
 711         <para>
 712 modifyAttribute 1:/^(.*)@local$/$1@example.com/
 713         </para>
 714       </blockquote>
 715     </para>
 716   </refsect1>
 717   <refsect1>
 718     <title>See Also</title>
 719     <para>
 720       <citerefentry>
 721         <refentrytitle>radsecproxy</refentrytitle>
 722         <manvolnum>1</manvolnum>
 723       </citerefentry>,
 724       <ulink url="http://tools.ietf.org/html/draft-ietf-radext-radsec">
 725         <citetitle>RadSec internet draft</citetitle>
 726       </ulink>
 727     </para>
 728   </refsect1>
 729 </refentry>