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