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