path: root/radsecproxy.conf.5

.TH radsecproxy.conf 5 "2 October 2008"

.SH "NAME"
radsecproxy.conf - Radsec proxy configuration file

.SH "DESCRIPTION"

When the proxy server starts, it will first check the command line arguments,
and then read the configuration file. Normally radsecproxy will read the
configuration file \fB/etc/radsecproxy.conf\fR. The command line -c option can
be used to instead read an alternate file (see \fIradsecproxy(1)\fR for details).
.sp
If the configuration file can not be found, the proxy will exit with an error
message. Note that there is also an include facility so that any configuration
file may include other configuration files. The proxy will also exit on
configuration errors.

.SH "CONFIGURATION SYNTAX"
When the configuration file is processed, whitespace (spaces and tabs) are
generally ignored. For each line, leading and trailing whitespace are ignored.
A line is ignored if it is empty, only consists of whitespace, or if the first 
non-whitespace character is a \fB#\fR. The configuration is generally case 
insensitive, but in some cases the option values (see below) are not.
.sp
There are two types of configuration structures than can be used. The first
and simplest are lines of the format \fBoption value\fR. That is, an option name,
see below for a list of valid options, followed by whitespace (at least one
space or tab character), followed by a value. Note that if the value contains
whitespace, then it must be quoted using \fB""\fR or \fB''\fR. Any whitespace
in front of the option or after the value will be ignored.
.sp
The other type of structure is a block. A block spans at least two lines, and
has the format:
.sp
.IP
.nf
blocktype name {
    option value
    option value
    ...
}
.fi
.LP
That is, some blocktype, see below for a list of the different block types, and
then enclosed in braces you have zero or more lines that each have the previously
described \fBoption value\fR format. Different block types have different rules for
which options can be specified, they are listed below. The rules regarding white
space, comments and quotes are as above. Hence you may do things like:
.IP
.nf
blocktype name {
#    option value
    option "value with space"
    ...
}
.fi
.LP
.sp
Option value characters can also be written in hex. This is done by writing the
character \fB%\fR followed by two hexadecimal digits. If a \fB%\fR is used without
two following hexadecimal digits, the \fB%\fR and the following characters are used
as written. If you want to write a \fB%\fR and not use this decoding, you may of
course write \fB%\fR in hex; i.e., %25.
.sp
There is one special option that can be used both as a basic option and inside all
blocks. That is the option \fBinclude\fR where the value specifies files to be
included. The value can be a single file, or it can use normal shell globbing to
specify multiple files, e.g.:
.IP
.nf
include /etc/radsecproxy.conf.d/*.conf
.fi
.LP
The files are sorted alphabetically. Included files are read in the order they are
specified, when reaching the end of a file, the next file is read. When reaching
the end of the last included file, the proxy returns to read the next line
following the \fBinclude\fR option. Included files may again include other files.
.sp

.SH "BASIC OPTIONS"
The following basic options may be specified in the configuration file. Note that
blocktypes and options inside blocks are discussed later. Note that none of these
options are required, and indeed in many cases they are not needed. Note that you
should specify each at most once. The behaviour with multiple occurences is
undefined.
.sp
.TP
\fBlogLevel\fR
This option specifies the debug level. It must be set to 1, 2, 3 or 4, where 1
logs only serious errors, and 4 logs everything. The default is 3 which logs
errors, warnings and some informational messages. Note that the command line option
\fB-d\fR overrides this if present.
.sp
.TP
\fBlogDestination\fR
This specifies where the log messages should go. By default the messages go to
syslog with facility \fBLOG_DAEMON\fR. Using this option you can specify another
syslog facility, or you may specify that logging should be to a particular file,
not using syslog. The value must be either a \fBfile\fR or \fBsyslog\fR URL. The
file URL is the standard one, specifying a local file that should be used. For
syslog, you must use the syntax: \fBx-syslog:///FACILITY\fR where
\fBFACILITY\fR must be one of \fBLOG_DAEMON\fR, \fBLOG_MAIL\fR, \fBLOG_USER\fR,
\fBLOG_LOCAL0\fR, \fBLOG_LOCAL1\fR, \fBLOG_LOCAL2\fR, \fBLOG_LOCAL3\fR,
\fBLOG_LOCAL4\fR, \fBLOG_LOCAL5\fR, \fBLOG_LOCAL6\fR or \fBLOG_LOCAL7\fR. You may
omit the facility from the URL to specify logging to the default facility, but
this is not very useful since this is the default log destination. Note that this
option is ignored if \fB-f\fR is specified on the command line.
.sp
.TP
\fBlistenUDP\fR
Normally the proxy will listen to the standard RADIUS UDP port \fB1812\fR if
configured to handle UDP clients. On most systems it will do this for all of the
system's IP addresses (both IPv4 and IPv6). On some systems however, it may respond
to only IPv4 or only IPv6. To specify an alternate port you may use a value of
the form \fB*:port\fR where port is any valid port number. If you also want to
specify a specific address you can do e.g. \fB192.168.1.1:1812\fR or
\fB[2001:db8::1]:1812\fR. The port may be omitted if you want the default one
(like in these examples). These examples are equivalent to \fB192.168.1.1\fR and
\fB2001:db8::1\fR. Note that you must use brackets around the IPv6 address if
you specify port number.
.sp
.TP
\fBlistenTLS\fR
This is similar to the \fBlistenUDP\fR option, except that it used for receiving
connections from TLS clients. The default port number is \fB2083\fR. Note that
this option was previously called \fBlistenTCP\fR.
.sp
.TP
\fBlistenTCP\fR
This option is deprecated. \fBlistenTLS\fR should be used instead. In future
versions \fBlistenTCP\fR will be used for RADIUS over TCP (not TLS encrypted).
.sp
.TP
\fBlistenAccountingUDP\fR
This is similar to the \fBlistenUDP\fR option, except that it used for specifying
port and optionally the address to receive UDP Accounting messages on.
.sp
.TP
\fBsourceUDP\fR
This can be used to specify source address and/or source port that the proxy
will use for sending UDP client messages (e.g. Access Request).
.sp
.TP
\fBsourceTLS\fR
This can be used to specify source address and/or source port that the proxy will
use for TLS connections. Note that this option was previously called \fBsourceTCP\fR.
.sp
.TP
\fBsourceTCP\fR
This option is deprecated. \fBsourceTLS\fR should be used instead. In future
versions \fBsourceTCP\fR will be used for RADIUS over TCP (not TLS encrypted).
.sp
.TP
\fBloopPrevention\fR
This can be set to \fBon\fR or \fBoff\fR with \fBoff\fR being the default. When
this is enabled, a request will never be sent to a server named the same as the
client it was received from. I.e., the names of the client block and the server
block are compared. Note that this only gives limited protection against loops.
.sp
.TP
\fBinclude\fR
This is not a normal configuration option; it can be specified multiple times.
It can both be used as a basic option and inside blocks. For the full description,
see the configuration syntax section above.
.sp

.SH "BLOCKS"
There are five types of blocks, they are \fBclient\fR, \fBserver\fR, \fBrealm\fR,
\fBtls\fR and \fBrewrite\fR. At least one instance of each of \fBclient\fR and
\fBrealm\fR is required.
This is necessary for the proxy to do anything useful,
and it will exit if not. The \fBtls\fR block is required if at least one TLS
client or server is configured. Note that there can be multiple blocks for each
type. For each type, the block names should be unique. The behaviour with multiple
occurences of the same name for the same block type is undefined. Also note that
some block option values may reference a block by name, in which case the block
name must be previously defined. Hence the order of the blocks may be significant.
.sp

.SH "CLIENT BLOCK"
The client block is used to configure a client. That is, tell the proxy about a
client, and what parameters should be used for that client. The \fBname\fR of the
client block must (with one exception, see below) be either the IP address
(IPv4 or IPv6) of the client, an IP prefix (IPv4 or IPv6) of the form
IpAddress/PrefixLength, or a domain name (FQDN).
.sp
If a domain name is specified,
then this will be resolved immediately to all the addresses associated with the
name, and the proxy will not care about any possible DNS changes that might occur
later. Hence there is no dependency on DNS after startup.
.sp
When some client later
sends a request to the proxy, the proxy will look at the IP address the request
comes from, and then go through all the addresses of each of the configured
clients (in the order they are defined), to determine which (if any) of the
clients this is.
.sp
In the case of TLS, the name of the client must match the FQDN or IP address in
the client certificate. Note that this is not required when the client name is
an IP prefix.
.sp
Alternatively one may use the \fBhost\fR option inside a client block. In that
case, the value of the \fBhost\fR option is used as above, while the name of the
block is only used as a descriptive name for the administrator.
.sp
The allowed options in a client block are \fBhost\fR, \fBtype\fR, \fBsecret\fR,
\fBtls\fR, \fBcertificateNameCheck\fR, \fBmatchCertificateAttribute\fR,
\fBrewrite\fR, \fBrewriteIn\fR, \fBrewriteOut\fR and \fBrewriteAttribute\fR.
We already discussed the \fBhost\fR option.
The value of \fBtype\fR must be either \fBudp\fR or \fBtls\fR. The value of
\fBsecret\fR is the shared RADIUS key used with this client. If the secret
contains whitespace, the value must be quoted. This option is optional for TLS.
.sp
For a TLS client you may also specify the \fBtls\fR option. The option value must
be the name of a previously defined TLS block. If this option is not specified,
the TLS block with the name \fBdefaultClient\fR will be used if defined. If not
defined, it will try to use the TLS block named \fBdefault\fR. If the specified
TLS block name does not exist, or the option is not specified and none of the
defaults exist, the proxy will exit with an error.
.sp
For a TLS client, the option \fBcertificateNameCheck\fR can be set to \fBoff\fR,
to disable the default behaviour of matching CN or SubjectAltName against the
specified hostname or IP address.
.sp
Additional validation of certificate attributes can be done by use of the
\fBmatchCertificateAttribute\fR option. Currently one can only do some
matching of CN and SubjectAltName. For regexp matching on CN, one can use
the value \fBCN:/regexp/\fR. For SubjectAltName one can only do regexp
matching of the URI, this is specified as \fBSubjectAltName:URI:/regexp/\fR.
Note that currently this option can only be specified once in a client block.
.sp
The \fBrewrite\fR option is deprecated. Use \fBrewriteIn\fR instead.
.sp
The \fBrewriteIn\fR option can be used to refer to a rewrite block that
specifies certain rewrite operations that should be performed on incoming
messages from the client. The rewriting is done before other processing.
For details, see the rewrite block text below. Similarly to
\fBtls\fR discussed above, if this option is not used, there is a fallback to
using the \fBrewrite\fR block named \fBdefaultClient\fR if it exists; and
if not, a fallback to a block named \fBdefault\fR.
.sp
The \fBrewriteOut\fR option is used in the same way as \fBrewriteIn\fR,
except that it specifies rewrite operations that should be performed on
outgoing messages to the client. The rewriting is done after other processing.
Also, there is no rewrite fallback if this option is not used.
.sp
The \fBrewriteAttribute\fR option currently makes it possible to specify that
the User-Name attribute in a client request shall be rewritten in the request
sent by the proxy. The User-Name attribute is written back to the original
value if a matching response is later sent back to the client. The value must
be of the form User-Name:/regexpmatch/replacement/. Example usage:
.IP
.nf
rewriteAttribute User-Name:/^(.*)@local$/$1@example.com/
.fi
.LP

.SH "SERVER BLOCK"
The server block is used to configure a server. That is, tell the proxy about
a server, and what parameters should be used when communicating with that server.
The \fBname\fR of the server block must (with one exception, see below) be either
the IP address (IPv4 or IPv6)
of the server, or a domain name (FQDN). If a domain name is specified, then this
will be resolved immediately to all the addresses associated with the name, and
the proxy will not care about any possible DNS changes that might occur later.
Hence there is no dependency on DNS after startup. If the domain name resolves
to multiple addresses, then for UDP the first address is used. For TLS, the proxy
will loop through the addresses until it can connect to one of them. In the case
of TLS, the name of the server must match the FQDN or IP address in the server
certificate.
.sp
Alternatively one may use the \fBhost\fR option inside a server block. In that
case, the value of the \fBhost\fR option is used as above, while the name of the
block is only used as a descriptive name for the administrator.
.sp
The allowed options in a server block are \fBhost\fR, \fBport\fR, \fBtype\fR,
\fBsecret\fR, \fBtls\fR, \fBcertificateNameCheck\fR,
\fBmatchCertificateAttribute\fR, \fBrewrite\fR, \fBrewriteIn\fR, \fBrewriteOut\fR,
\fBstatusServer\fR, \fBretryCount\fR and \fBretryInterval\fR.
.sp
We already discussed the \fBhost\fR option.
The \fBport\fR option allows you to specify which port number the server uses.
The usage of \fBtype\fR, \fBsecret\fR, \fBtls\fR, \fBcertificateNameCheck\fR,
\fBmatchCertificateAttribute\fR, \fBrewrite\fR, \fBrewriteIn\fR and
\fBrewriteOut\fR are just as specified for the
\fBclient block\fR above, except that \fBdefaultServer\fR
(and not \fBdefaultClient\fR) is the fallback for the \fBtls\fR,
\fBrewrite\fR and \fBrewriteIn\fR options.
.sp
\fBstatusServer\fR can be specified to enable the use of status-server messages
for this server. The value must be either \fBon\fR or \fBoff\fR. The default
when not specified, is \fBoff\fR. If statusserver is enabled, the proxy will
during idle periods send regular status-server messages to the server to verify
that it is alive. This should only be enabled if the server supports it.
.sp
The options \fBretryCount\fR and \fBretryInterval\fR can be used to specify how
many times the proxy should retry sending a request and how long it should
wait between each retry. The defaults are 2 retries and an interval of 5s.

.SH "REALM BLOCK"
When the proxy receives an \fBAccess Request\fR it needs to figure out to which
server it should be forwarded. This is done by looking at the Username attribute
in the request, and matching that against the names of the defined realm blocks.
The proxy will match against the blocks in the order they are specified, using
the first match if any. If no realm matches, the proxy will simply ignore the
request. Each realm block specifies what the server should do when a match is
found. A realm block may contain none, one or multiple \fBserver\fR options,
and similarly \fBaccountingServer\fR options. There are also \fBreplyMessage\fR
and \fBaccountingResponse\fR options. We will discuss these later.
.sp

.TP
\fBRealm block names and matching\fR
.sp
In the general case the proxy will look for a @ in the username attribute, and
try to do an exact case insensitive match between what comes after the @ and
the name of the realm block. So if you get a request with the attribute value
\fBanonymous@example.com\fR, the proxy will go through the realm names in the
order they are specified, looking for a realm block named \fBexample.com\fR.
.sp
There are two exceptions to this, one is the realm name \fB*\fR which means
match everything. Hence if you have a realm block named \fB*\fR, then it will
always match. This should then be the last realm block defined, since any
blocks after this would never be checked. This is useful for having a default.
.sp
The other exception is regular expression matching. If the realm name starts
with a \fB/\fR, the name is treated as an regular expression. A case insensitive
regexp match will then be done using this regexp on the value of the entire
Username attribute. Optionally you may also have a trailing \fB/\fR after the
regexp. So as an example, if you want to use regexp matching the domain
\fBexample.com\fR you could have a realm block named \fB/@example\\.com$\fR.
Optinally this can also be written \fB/@example\\.com$/\fR. If you want to
match all domains under the \fB.com\fR top domain, you could do
\fB/@.*\\.com$\fR. Note that since the matching is done on the entire
attribute value, you can also use rules like \fB/^[a-k].*@example\\.com$/\fR
to get some of the users in this domain to use one server, while other users
could be matched by another realm block and use another server.
.sp 

.TP
\fBRealm block options\fR
.sp
A realm block may contain none, one or multiple \fBserver\fR options. If
defined, the values of the \fBserver\fR options must be the names of
previously defined server blocks. Normally requests will be forwarded to
the first server option defined. If there are multiple server options, the
proxy will do fail-over and use the second server if the first is down. If
the two first are down, it will try the third etc. If say the first server
comes back up, it will go back to using that one. Currently detection of
servers being up or down is based on the use of StatusServer (if enabled),
and that TLS connections are up.
.sp
A realm block may also contain none, one or multiple \fBaccountingServer\fR
options. This is used exactly like the \fBserver\fR options, except that
it is used for specifying where to send matching accounting requests. The
values must be the names of previously defined server blocks. When multiple
accounting servers are defined, there is a failover mechanism similar to
the one for \fBserver\fR options.
.sp
If there is no \fBserver\fR option, the proxy will if \fBreplyMessage\fR
is specified reply back to the client with an Access Reject message. The
message contains a replyMessage attribute with the value as specified by
the \fBreplyMessage\fR option.
Note that this is different from having no
match since then the request is simply ignored. You may wonder why this is
useful. One example is if you handle say all domains under say \fB.bv\fR.
Then you may have several realm blocks matching the domains that exists,
while for other domains under \fB.bv\fR you want to send a reject. At the
same time you might want to send all other requests to some default server.
After the realms for the subdomains, you would then have two realm
definitions. One with the name \fB/@.*\\.bv$\fR with no servers, followed
by one with the name \fB*\fR with the default server defined. This may also
be useful for blocking particular usernames.
.sp
If there is no \fBaccountingServer\fR option, the proxy will normally do
nothing, ignoring accounting requests. There is however an option called
\fBaccountingResponse\fR. If this is set to \fBon\fR, the proxy will log
some of the accounting information and send an Accounting-Response back.
This is useful if you do not care much about accounting, but want to stop
clients from retransmitting accounting requests. By default this option
is set to \fBoff\fR.
.sp

.SH "TLS BLOCK"
The tls block specifies TLS configuration options and you need at least one
of these if you have clients or servers using TLS. As discussed in the client
and server block descriptions, a client or server block may reference a
particular TLS block by name. There are also however the special tls block
names \fBdefault\fR, \fBdefaultClient\fR and \fBdefaultServer\fR which are
used as defaults if the client or server block does not reference a tls block.
Also note that a tls block must be defined before the client or server block
that would use it. If you want the same TLS configuration for all TLS clients
and servers, you need just a single tls block named \fBdefault\fR, and the client
and servers need not refer to it. If you want all TLS clients to use one
config, and all TLS servers to use another, then you would be fine only
defining two tls blocks named \fBdefaultClient\fR and \fBdefaultServer\fR.
If you want different clients (or different servers) to have different TLS
parameters, then you may need to create other tls blocks with other names,
and reference those from the client or server definitions. Note that you could
also have say a client block refer to a default, even \fBdefaultServer\fR
if you really want to.
.sp
The available tls block options are \fBCACertificateFile\fR,
\fBCACertificatePath\fR, \fBcertificateFile\fR, \fBcertificateKeyFile\fR,
\fBcertificateKeyPassword\fR, \fBcacheExpiry\fR and \fBCRLCheck\fR.
When doing RADIUS over TLS, both the
client and the server present certificates, and they are both verified
by the peer. Hence you must always specify \fBcertificateFile\fR and
\fBcertificateKeyFile\fR options, as well as \fBcertificateKeyPassword\fR
if a password is needed to decrypt the private key. Note that
\fBCACertificateFile\fR may be a certificate chain. In order to verify
certificates, or send a chain of certificates to a peer, you also always
need to specify \fBCACertificateFile\fR or \fBCACertificatePath\fR. Note
that you may specify both, in which case the certificates in
\fBCACertificateFile\fR are checked first. By default CRLs are not
checked. This can be changed by setting \fBCRLCheck\fR to \fBon\fR.
.sp
CA certificates and CRLs are normally cached permanently. That is, once a CA
or CRL has been read, the proxy will never attempt to re-read it. CRLs may
change relatively often and the proxy should ideally always use the latest
CRLs. Rather than restarting the proxy, there is an option \fBcacheExpiry\fR
that specifies how many seconds the CA and CRL information should be cached.
Reasonable values might be say 3600 (1 hour) or 86400 (24 hours), depending
on how frequently CRLs are updated and how critical it is to be up to date.
This option may be set to zero to disable caching.
.SH "REWRITE BLOCK"
The rewrite block specifies rules that may rewrite RADIUS messages. It
can be used to add, remove and modify specific attributes from messages
received from and sent to clients and servers. As discussed in the client and
server block descriptions, a client or server block may reference a particular
rewrite block by name. There are however also the special rewrite block
names \fBdefault\fR, \fBdefaultClient\fR and \fBdefaultServer\fR which are
used as defaults if the client or server block does not reference a block.
Also note that a rewrite block must be defined before the client or server
block that would use it. If you want the same rewrite rules for input from
all clients and servers, you need just a single rewrite block named
\fBdefault\fR, and the client and servers need not refer to it. If you want
all clients to use one config, and all servers to use another, then you would
be fine only defining two rewrite blocks named \fBdefaultClient\fR and
\fBdefaultServer\fR. Note that these defaults are only used for rewrite on
input. No rewriting is done on output unless explicitly specifed using the
\fBrewriteOut\fR option.
.sp
The available rewrite block options are \fBaddAttribute\fR,
\fBremoveAttribute\fR, \fBremoveVendorAttribute\fR and \fBmodifyAttribute\fR.
They can all be specified none, one or multiple times.
.sp
\fBaddAttribute\fR is used to add attributes to a message. The option value
must be of the form \fBattribute:value\fR where attribute is a numerical value
specifying the attribute.
.sp
The \fBremoveAttribute\fR option is used to specify an attribute that 
should be removed from received messages. The option value must be a numerical
value specifying which attribute is to be removed. Similarly,
\fBremoveVendorAttribute\fR is used to specify a vendor attribute that is to
be removed. The value can be a numerical value for removing all attributes
from a given vendor, or of the form \fBvendor:subattribute\fR, where vendor and
subattribute are numerical values, for removing a specific subattribute for a
specific vendor.
.sp
\fBmodifyAttribute\fR is used to specify modification of attributes. The
value must be of the form \fBattribute:/regexpmatch/replacement/\fR where
attribute is a numerical attribute type, regexpmatch is regexp matching rule
and replacement specifies how to replace the matching regexp. Example usage:
.IP
.nf
modifyAttribute 1:/^(.*)@local$/$1@example.com/
.fi
.LP

.SH "SEE ALSO"
radsecproxy(1), RadSec internet draft
http://tools.ietf.org/html/draft-ietf-radext-radsec