1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
2 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5 <date>2012-12-12</date>
9 <application>radsecproxy.conf</application>
11 <manvolnum>5</manvolnum>
12 <refmiscinfo>radsecproxy 1.6-dev</refmiscinfo>
16 <application>radsecproxy.conf</application>
18 <refpurpose>Radsec proxy configuration file</refpurpose>
21 <title>Description</title>
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
30 <refentrytitle>radsecproxy</refentrytitle><manvolnum>1</manvolnum>
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.
42 <title>Configuration Syntax</title>
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
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
64 The other type of structure is a block. A block spans at least
65 two lines, and has the format:
66 <blockquote><literallayout>
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>
83 option "value with space"
86 </literallayout></blockquote>
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>.
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.:
106 include /etc/radsecproxy.conf.d/*.conf
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
118 <title>Basic Options</title>
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.
129 <term><literal>LogLevel</literal></term>
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.
141 <term><literal>LogDestination</literal></term>
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.
173 <term><literal>FTicksReporting</literal></term>
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.
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.
195 <term><literal>FTicksMAC</literal></term>
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>.
208 The default value for FTicksMAC is
209 <literal>VendorKeyHashed</literal>. This means that
210 FTicksKey has to be set.
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?
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.
229 <term><literal>FTicksKey</literal></term>
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
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.
246 <term><literal>FTicksSyslogFacility</literal></term>
249 The FTicksSyslogFacility option is used to specify a
250 dedicated syslog facility for F-Ticks messages. This
251 allows for easier filtering of F-Ticks messages. If no
252 FTicksSyslogFacility option is given, F-Ticks messages are
253 written to what the LogDestination option specifies.
256 F-Ticks messages are always logged using the log level
257 LOG_DEBUG. Note that specifying a file in
258 FTicksSyslogFacility (using the file:/// prefix) is
265 <term><literal>ListenUDP</literal></term>
268 Normally the proxy will listen to the standard RADIUS UDP
269 port <literal>1812</literal> if configured to handle UDP
270 clients. On most systems it will do this for all of the
271 system's IP addresses (both IPv4 and IPv6). On some
272 systems however, it may respond to only IPv4 or only
273 IPv6. To specify an alternate port you may use a value on
274 the form <literal>*:port</literal> where port is any valid
275 port number. If you also want to specify a specific
277 e.g. <literal>192.168.1.1:1812</literal> or
278 <literal>[2001:db8::1]:1812</literal>. The port may be
279 omitted if you want the default one (like in these
280 examples). These examples are equivalent to
281 <literal>192.168.1.1</literal> and
282 <literal>2001:db8::1</literal>. Note that you must use
283 brackets around the IPv6 address. This option may be
284 specified multiple times to listen to multiple addresses
290 <term><literal>ListenTCP</literal></term>
293 This option is similar to the <literal>ListenUDP</literal>
294 option, except that it is used for receiving connections
295 from TCP clients. The default port number is
296 <literal>1812</literal>.
301 <term><literal>ListenTLS</literal></term>
304 This is similar to the <literal>ListenUDP</literal>
305 option, except that it is used for receiving connections
306 from TLS clients. The default port number is
307 <literal>2083</literal>. Note that this option was
308 previously called <literal>ListenTCP</literal>.
313 <term><literal>ListenDTLS</literal></term>
316 This is similar to the <literal>ListenUDP</literal>
317 option, except that it is used for receiving connections
318 from DTLS clients. The default port number is
319 <literal>2083</literal>.
324 <term><literal>SourceUDP</literal></term>
327 This can be used to specify source address and/or source
328 port that the proxy will use for sending UDP client
329 messages (e.g. Access Request).
334 <term><literal>SourceTCP</literal></term>
337 This can be used to specify source address and/or source
338 port that the proxy will use for TCP connections.
343 <term><literal>SourceTLS</literal></term>
346 This can be used to specify source address and/or source
347 port that the proxy will use for TLS connections.
352 <term><literal>SourceDTLS</literal></term>
355 This can be used to specify source address and/or source
356 port that the proxy will use for DTLS connections.
361 <term><literal>TTLAttribute</literal></term>
364 This can be used to change the default TTL attribute. Only
365 change this if you know what you are doing. The syntax is
366 either a numerical value denoting the TTL attribute, or
367 two numerical values separated by column specifying a
369 i.e. <literal>vendorid:attribute</literal>.
374 <term><literal>AddTTL</literal></term>
377 If a TTL attribute is present, the proxy will decrement
378 the value and discard the message if zero. Normally the
379 proxy does nothing if no TTL attribute is present. If you
380 use the AddTTL option with a value 1-255, the proxy will
381 when forwarding a message with no TTL attribute, add one
382 with the specified value. Note that this option can also
383 be specified for a client/server. It will then override
384 this setting when forwarding a message to that
390 <term><literal>LoopPrevention</literal></term>
393 This can be set to <literal>on</literal> or
394 <literal>off</literal> with <literal>off</literal> being
395 the default. When this is enabled, a request will never be
396 sent to a server named the same as the client it was
397 received from. I.e., the names of the client block and the
398 server block are compared. Note that this only gives
399 limited protection against loops. It can be used as a
400 basic option and inside server blocks where it overrides
406 <term><literal>Include</literal></term>
409 This is not a normal configuration option; it can be
410 specified multiple times. It can both be used as a basic
411 option and inside blocks. For the full description, see
412 the configuration syntax section above.
419 <title>Blocks</title>
421 There are five types of blocks, they are
422 <literal>client</literal>, <literal>server</literal>,
423 <literal>realm</literal>, <literal>tls</literal> and
424 <literal>rewrite</literal>. At least one instance of each of
425 <literal>client</literal> and <literal>realm</literal> is
426 required. This is necessary for the proxy to do anything useful,
427 and it will exit if not. The <literal>tls</literal> block is
428 required if at least one TLS/DTLS client or server is
429 configured. Note that there can be multiple blocks for each
430 type. For each type, the block names should be unique. The
431 behaviour with multiple occurences of the same name for the same
432 block type is undefined. Also note that some block option values
433 may reference a block by name, in which case the block name must
434 be previously defined. Hence the order of the blocks may be
439 <title>Client Block</title>
441 The client block is used to configure a client. That is, tell
442 the proxy about a client, and what parameters should be used for
443 that client. The name of the client block must (with one
444 exception, see below) be either the IP address (IPv4 or IPv6) of
445 the client, an IP prefix (IPv4 or IPv6) on the form
446 IpAddress/PrefixLength, or a domain name (FQDN). Note that
447 literal IPv6 addresses must be enclosed in brackets.
450 If a domain name is specified, then this will be resolved
451 immediately to all the addresses associated with the name, and
452 the proxy will not care about any possible DNS changes that
453 might occur later. Hence there is no dependency on DNS after
457 When some client later sends a request to the proxy, the proxy
458 will look at the IP address the request comes from, and then go
459 through all the addresses of each of the configured clients (in
460 the order they are defined), to determine which (if any) of the
464 In the case of TLS/DTLS, the name of the client must match the
465 FQDN or IP address in the client certificate. Note that this is
466 not required when the client name is an IP prefix.
469 Alternatively one may use the <literal>host</literal> option
470 inside a client block. In that case, the value of the
471 <literal>host</literal> option is used as above, while the name
472 of the block is only used as a descriptive name for the
473 administrator. The host option may be used multiple times, and
474 can be a mix of addresses, FQDNs and prefixes.
477 The allowed options in a client block are
478 <literal>host</literal>, <literal>type</literal>,
479 <literal>secret</literal>, <literal>tls</literal>,
480 <literal>certificateNameCheck</literal>,
481 <literal>matchCertificateAttribute</literal>,
482 <literal>duplicateInterval</literal>, <literal>AddTTL</literal>,
483 <literal>fticksVISCOUNTRY</literal>, <literal>fticksVISINST</literal>,
484 <literal>rewrite</literal>, <literal>rewriteIn</literal>,
485 <literal>rewriteOut</literal>, and <literal>rewriteAttribute</literal>.
487 We already discussed the <literal>host</literal> option. The
488 value of <literal>type</literal> must be one of
489 <literal>udp</literal>, <literal>tcp</literal>,
490 <literal>tls</literal> or <literal>dtls</literal>. The value of
491 <literal>secret</literal> is the shared RADIUS key used with
492 this client. If the secret contains whitespace, the value must
493 be quoted. This option is optional for TLS/DTLS and if omitted
494 will default to "mysecret". Note that the default value of
495 <literal>secret</literal> will change in an upcoming release.
498 For a TLS/DTLS client you may also specify the
499 <literal>tls</literal> option. The option value must be the
500 name of a previously defined TLS block. If this option is not
501 specified, the TLS block with the name
502 <literal>defaultClient</literal> will be used if defined. If not
503 defined, it will try to use the TLS block named
504 <literal>default</literal>. If the specified TLS block name does
505 not exist, or the option is not specified and none of the
506 defaults exist, the proxy will exit with an error.
509 For a TLS/DTLS client, the option
510 <literal>certificateNameCheck</literal> can be set to
511 <literal>off</literal>, to disable the default behaviour of
512 matching CN or SubjectAltName against the specified hostname or
516 Additional validation of certificate attributes can be done by
517 use of the <literal>matchCertificateAttribute</literal>
518 option. Currently one can only do some matching of CN and
519 SubjectAltName. For regexp matching on CN, one can use the value
520 <literal>CN:/regexp/</literal>. For SubjectAltName one can only
521 do regexp matching of the URI, this is specified as
522 <literal>SubjectAltName:URI:/regexp/</literal>. Note that
523 currently this option can only be specified once in a client
527 The <literal>duplicateInterval</literal> option can be used to
528 specify for how many seconds duplicate checking should be
529 done. If a proxy receives a new request within a few seconds of
530 a previous one, it may be treated the same if from the same
531 client, with the same authenticator etc. The proxy will then
532 ignore the new request (if it is still processing the previous
533 one), or returned a copy of the previous reply.
536 The <literal>AddTTL</literal> option is similar to the
537 <literal>AddTTL</literal> option used in the basic config. See
538 that for details. Any value configured here overrides the basic
539 one when sending messages to this client.
542 The <literal>fticksVISCOUNTRY</literal> option configures
543 clients eligible to F-Ticks logging as defined by the
544 <literal>FTicksReporting</literal> basic option.
547 The <literal>fticksVISINST</literal> option overwrites
548 the default <literal>VISINST</literal> value taken from the client
552 The <literal>rewrite</literal> option is deprecated. Use
553 <literal>rewriteIn</literal> instead.
556 The <literal>rewriteIn</literal> option can be used to refer to
557 a rewrite block that specifies certain rewrite operations that
558 should be performed on incoming messages from the client. The
559 rewriting is done before other processing. For details, see the
560 rewrite block text below. Similarly to <literal>tls</literal>
561 discussed above, if this option is not used, there is a fallback
562 to using the <literal>rewrite</literal> block named
563 <literal>defaultClient</literal> if it exists; and if not, a
564 fallback to a block named <literal>default</literal>.
567 The <literal>rewriteOut</literal> option is used in the same way
568 as <literal>rewriteIn</literal>, except that it specifies
569 rewrite operations that should be performed on outgoing messages
570 to the client. The rewriting is done after other
571 processing. Also, there is no rewrite fallback if this option is
575 The <literal>rewriteAttribute</literal> option currently makes
576 it possible to specify that the User-Name attribute in a client
577 request shall be rewritten in the request sent by the proxy. The
578 User-Name attribute is written back to the original value if a
579 matching response is later sent back to the client. The value
580 must be on the form User-Name:/regexpmatch/replacement/. Example
584 rewriteAttribute User-Name:/^(.*)@local$/\1@example.com/
590 <title>Server Block</title>
592 The server block is used to configure a server. That is, tell
593 the proxy about a server, and what parameters should be used
594 when communicating with that server. The name of the server
595 block must (with one exception, see below) be either the IP
596 address (IPv4 or IPv6) of the server, or a domain name
597 (FQDN). If a domain name is specified, then this will be
598 resolved immediately to all the addresses associated with the
599 name, and the proxy will not care about any possible DNS changes
600 that might occur later. Hence there is no dependency on DNS
601 after startup. If the domain name resolves to multiple
602 addresses, then for UDP/DTLS the first address is used. For
603 TCP/TLS, the proxy will loop through the addresses until it can
604 connect to one of them. In the case of TLS/DTLS, the name of the
605 server must match the FQDN or IP address in the server
609 Alternatively one may use the <literal>host</literal> option
610 inside a server block. In that case, the value of the
611 <literal>host</literal> option is used as above, while the name
612 of the block is only used as a descriptive name for the
613 administrator. Note that multiple host options may be used. This
614 will then be treated as multiple names/addresses for the same
615 server. When initiating a TCP/TLS connection, all addresses of
616 all names may be attempted, but there is no failover between the
617 different host values. For failover one must use separate server
621 Note that the name of the block, or values of host options may
622 include a port number (separated with a column). This port
623 number will then override the default port or a port option in
624 the server block. Also note that literal IPv6 addresses must be
625 enclosed in brackets.
628 The allowed options in a server block are
629 <literal>host</literal>, <literal>port</literal>,
630 <literal>type</literal>, <literal>secret</literal>,
631 <literal>tls</literal>, <literal>certificateNameCheck</literal>,
632 <literal>matchCertificateAttribute</literal>,
633 <literal>AddTTL</literal>, <literal>rewrite</literal>,
634 <literal>rewriteIn</literal>, <literal>rewriteOut</literal>,
635 <literal>statusServer</literal>, <literal>retryCount</literal>,
636 <literal>retryInterval</literal>,
637 <literal>dynamicLookupCommand</literal> and
638 <literal>LoopPrevention</literal>.
641 We already discussed the <literal>host</literal> option. The
642 <literal>port</literal> option allows you to specify which port
643 number the server uses. The usage of <literal>type</literal>,
644 <literal>secret</literal>, <literal>tls</literal>,
645 <literal>certificateNameCheck</literal>,
646 <literal>matchCertificateAttribute</literal>,
647 <literal>AddTTL</literal>, <literal>rewrite</literal>,
648 <literal>rewriteIn</literal> and <literal>rewriteOut</literal>
649 are just as specified for the <literal>client block</literal>
650 above, except that <literal>defaultServer</literal> (and not
651 <literal>defaultClient</literal>) is the fallback for the
652 <literal>tls</literal>, <literal>rewrite</literal> and
653 <literal>rewriteIn</literal> options.
656 <literal>statusServer</literal> can be specified to enable the
657 use of status-server messages for this server. The value must be
658 either <literal>on</literal> or <literal>off</literal>. The
659 default when not specified, is <literal>off</literal>. If
660 statusserver is enabled, the proxy will during idle periods send
661 regular status-server messages to the server to verify that it
662 is alive. This should only be enabled if the server supports it.
665 The options <literal>retryCount</literal> and
666 <literal>retryInterval</literal> can be used to specify how many
667 times the proxy should retry sending a request and how long it
668 should wait between each retry. The defaults are 2 retries and
672 The option <literal>dynamicLookupCommand</literal> can be used
673 to specify a command that should be executed to dynamically
674 configure and use a server. The use of this feature will be
675 documented separately/later.
678 Using the <literal>LoopPrevention</literal> option here
679 overrides any basic setting of this option. See section
680 <literal>BASIC OPTIONS</literal> for details on this option.
684 <title>Realm Block</title>
686 When the proxy receives an Access-Request it needs to figure out
687 to which server it should be forwarded. This is done by looking
688 at the Username attribute in the request, and matching that
689 against the names of the defined realm blocks. The proxy will
690 match against the blocks in the order they are specified, using
691 the first match if any. If no realm matches, the proxy will
692 simply ignore the request. Each realm block specifies what the
693 server should do when a match is found. A realm block may
694 contain none, one or multiple <literal>server</literal> options,
695 and similarly <literal>accountingServer</literal> options. There
696 are also <literal>replyMessage</literal> and
697 <literal>accountingResponse</literal> options. We will discuss
701 <title>Realm block names and matching</title>
703 In the general case the proxy will look for a
704 <literal>@</literal> in the username attribute, and try to do
705 an exact case insensitive match between what comes after the
706 <literal>@</literal> and the name of the realm block. So if
707 you get a request with the attribute value
708 <literal>anonymous@example.com</literal>, the proxy will go
709 through the realm names in the order they are specified,
710 looking for a realm block named
711 <literal>example.com</literal>.
714 There are two exceptions to this, one is the realm name
715 <literal>*</literal> which means match everything. Hence if
716 you have a realm block named <literal>*</literal>, then it
717 will always match. This should then be the last realm block
718 defined, since any blocks after this would never be
719 checked. This is useful for having a default.
722 The other exception is regular expression matching. If the
723 realm name starts with a <literal>/</literal>, the name is
724 treated as an regular expression. A case insensitive regexp
725 match will then be done using this regexp on the value of the
726 entire Username attribute. Optionally you may also have a
727 trailing <literal>/</literal> after the regexp. So as an
728 example, if you want to use regexp matching the domain
729 <literal>example.com</literal> you could have a realm block
730 named <literal>/@example\\.com$</literal>. Optinally this can
731 also be written <literal>/@example\\.com$/</literal>. If you
732 want to match all domains under the <literal>.com</literal>
733 top domain, you could do <literal>/@.*\\.com$</literal>. Note
734 that since the matching is done on the entire attribute value,
735 you can also use rules like
736 <literal>/^[a-k].*@example\\.com$/</literal> to get some of
737 the users in this domain to use one server, while other users
738 could be matched by another realm block and use another
743 <title>Realm block options</title>
745 A realm block may contain none, one or multiple
746 <literal>server</literal> options. If defined, the values of
747 the <literal>server</literal> options must be the names of
748 previously defined server blocks. Normally requests will be
749 forwarded to the first server option defined. If there are
750 multiple server options, the proxy will do fail-over and use
751 the second server if the first is down. If the two first are
752 down, it will try the third etc. If say the first server comes
753 back up, it will go back to using that one. Currently
754 detection of servers being up or down is based on the use of
755 StatusServer (if enabled), and that TCP/TLS/DTLS connections
759 A realm block may also contain none, one or multiple
760 <literal>accountingServer</literal> options. This is used
761 exactly like the <literal>server</literal> option, except that
762 it is used for specifying where to send matching accounting
763 requests. The values must be the names of previously defined
764 server blocks. When multiple accounting servers are defined,
765 there is a failover mechanism similar to the one for the
766 <literal>server</literal> option.
769 If there is no <literal>server</literal> option, the proxy
770 will if <literal>replyMessage</literal> is specified, reply
771 back to the client with an Access Reject message. The message
772 contains a replyMessage attribute with the value as specified
773 by the <literal>replyMessage</literal> option. Note that this
774 is different from having no match since then the request is
775 simply ignored. You may wonder why this is useful. One example
776 is if you handle say all domains under say
777 <literal>.bv</literal>. Then you may have several realm blocks
778 matching the domains that exists, while for other domains
779 under <literal>.bv</literal> you want to send a reject. At the
780 same time you might want to send all other requests to some
781 default server. After the realms for the subdomains, you would
782 then have two realm definitions. One with the name
783 <literal>/@.*\\.bv$</literal> with no servers, followed by one
784 with the name <literal>*</literal> with the default server
785 defined. This may also be useful for blocking particular
789 If there is no <literal>accountingServer</literal> option, the
790 proxy will normally do nothing, ignoring accounting
791 requests. There is however an option called
792 <literal>accountingResponse</literal>. If this is set to
793 <literal>on</literal>, the proxy will log some of the
794 accounting information and send an Accounting-Response
795 back. This is useful if you do not care much about accounting,
796 but want to stop clients from retransmitting accounting
797 requests. By default this option is set to
798 <literal>off</literal>.
803 <title>TLS Block</title>
805 The TLS block specifies TLS configuration options and you need
806 at least one of these if you have clients or servers using
807 TLS/DTLS. As discussed in the client and server block
808 descriptions, a client or server block may reference a
809 particular TLS block by name. There are also however the special
810 TLS block names <literal>default</literal>,
811 <literal>defaultClient</literal> and
812 <literal>defaultServer</literal> which are used as defaults if
813 the client or server block does not reference a TLS block. Also
814 note that a TLS block must be defined before the client or
815 server block that would use it. If you want the same TLS
816 configuration for all TLS/DTLS clients and servers, you need
817 just a single tls block named <literal>default</literal>, and
818 the client and servers need not refer to it. If you want all
819 TLS/DTLS clients to use one config, and all TLS/DTLS servers to
820 use another, then you would be fine only defining two TLS blocks
821 named <literal>defaultClient</literal> and
822 <literal>defaultServer</literal>. If you want different clients
823 (or different servers) to have different TLS parameters, then
824 you may need to create other TLS blocks with other names, and
825 reference those from the client or server definitions. Note that
826 you could also have say a client block refer to a default, even
827 <literal>defaultServer</literal> if you really want to.
830 The available TLS block options are
831 <literal>CACertificateFile</literal>,
832 <literal>CACertificatePath</literal>,
833 <literal>certificateFile</literal>,
834 <literal>certificateKeyFile</literal>,
835 <literal>certificateKeyPassword</literal>,
836 <literal>cacheExpiry</literal>, <literal>CRLCheck</literal> and
837 <literal>policyOID</literal>. When doing RADIUS over TLS/DTLS,
838 both the client and the server present certificates, and they
839 are both verified by the peer. Hence you must always specify
840 <literal>certificateFile</literal> and
841 <literal>certificateKeyFile</literal> options, as well as
842 <literal>certificateKeyPassword</literal> if a password is
843 needed to decrypt the private key. Note that
844 <literal>CACertificateFile</literal> may be a certificate
845 chain. In order to verify certificates, or send a chain of
846 certificates to a peer, you also always need to specify
847 <literal>CACertificateFile</literal> or
848 <literal>CACertificatePath</literal>. Note that you may specify
849 both, in which case the certificates in
850 <literal>CACertificateFile</literal> are checked first. By
851 default CRLs are not checked. This can be changed by setting
852 <literal>CRLCheck</literal> to <literal>on</literal>. One can
853 require peer certificates to adhere to certain policies by
854 specifying one or multiple policyOIDs using one or multiple
855 <literal>policyOID</literal> options.
858 CA certificates and CRLs are normally cached permanently. That
859 is, once a CA or CRL has been read, the proxy will never attempt
860 to re-read it. CRLs may change relatively often and the proxy
861 should ideally always use the latest CRLs. Rather than
862 restarting the proxy, there is an option
863 <literal>cacheExpiry</literal> that specifies how many seconds
864 the CA and CRL information should be cached. Reasonable values
865 might be say 3600 (1 hour) or 86400 (24 hours), depending on how
866 frequently CRLs are updated and how critical it is to be up to
867 date. This option may be set to zero to disable caching.
871 <title>Rewrite Block</title>
873 The rewrite block specifies rules that may rewrite RADIUS
874 messages. It can be used to add, remove and modify specific
875 attributes from messages received from and sent to clients and
876 servers. As discussed in the client and server block
877 descriptions, a client or server block may reference a
878 particular rewrite block by name. There are however also the
879 special rewrite block names <literal>default</literal>,
880 <literal>defaultClient</literal> and
881 <literal>defaultServer</literal> which are used as defaults if
882 the client or server block does not reference a block. Also note
883 that a rewrite block must be defined before the client or server
884 block that would use it. If you want the same rewrite rules for
885 input from all clients and servers, you need just a single
886 rewrite block named <literal>default</literal>, and the client
887 and servers need not refer to it. If you want all clients to use
888 one config, and all servers to use another, then you would be
889 fine only defining two rewrite blocks named
890 <literal>defaultClient</literal> and
891 <literal>defaultServer</literal>. Note that these defaults are
892 only used for rewrite on input. No rewriting is done on output
893 unless explicitly specifed using the
894 <literal>rewriteOut</literal> option.
897 The available rewrite block options are
898 <literal>addAttribute</literal>,
899 <literal>addVendorAttribute</literal>,
900 <literal>removeAttribute</literal>,
901 <literal>removeVendorAttribute</literal> and
902 <literal>modifyAttribute</literal>. They can all be specified
903 none, one or multiple times.
906 <literal>addAttribute</literal> is used to add attributes to a
907 message. The option value must be on the form
908 <literal>attribute:value</literal> where attribute is a
909 numerical value specifying the attribute. Simliarly, the
910 <literal>addVendorAttribute</literal> is used to specify a
911 vendor attribute to be added. The option value must be on the
912 form <literal>vendor:subattribute:value</literal>, where vendor
913 and subattribute are numerical values.
916 The <literal>removeAttribute</literal> option is used to specify
917 an attribute that should be removed from received messages. The
918 option value must be a numerical value specifying which
919 attribute is to be removed. Similarly,
920 <literal>removeVendorAttribute</literal> is used to specify a
921 vendor attribute that is to be removed. The value can be a
922 numerical value for removing all attributes from a given vendor,
923 or on the form <literal>vendor:subattribute</literal>, where
924 vendor and subattribute are numerical values, for removing a
925 specific subattribute for a specific vendor.
928 <literal>modifyAttribute</literal> is used to specify
929 modification of attributes. The value must be on the form
930 <literal>attribute:/regexpmatch/replacement/</literal> where
931 attribute is a numerical attribute type, regexpmatch is regexp
932 matching rule and replacement specifies how to replace the
933 matching regexp. Example usage:
936 modifyAttribute 1:/^(.*)@local$/\1@example.com/
942 <title>See Also</title>
945 <refentrytitle>radsecproxy</refentrytitle><manvolnum>1</manvolnum>
947 <ulink url="http://tools.ietf.org/html/draft-ietf-radext-radsec">
948 <citetitle>RadSec internet draft</citetitle>
projects / libradsec.git / blob