radsecproxy.1

   1 .TH radsecproxy 1 "14 May 2008"
   2
   3 .SH "NAME"
   4 radsecproxy - a generic RADIUS proxy that provides both RADIUS UDP and TCP/TLS (RadSec) transport.
   5
   6 .SH "SYNOPSIS"
   7 radsecproxy [ -c configfile ] [ -d debuglevel ] [ -f ] [ -p ] [ -v ]
   8 .sp
   9
  10 .SH "DESCRIPTION"
  11 radsecproxy is a \fBgeneric RADIUS proxy\fR that in addition to to
  12 usual \fBRADIUS UDP\fR transport, also supports \fBTLS (RadSec)\fR. The
  13 aim is for the proxy to have sufficient features to be flexible,
  14 while at the same time to be small, efficient and easy to configure.
  15 Currently the executable on Linux is only about \fI48 KB\fR, and it uses
  16 about \fI64 KB\fR (depending on the number of peers) while running.
  17 .sp
  18 The proxy was initially made to be able to deploy \fBRadSec\fR (RADIUS
  19 over TLS) so that all RADIUS communication across network links
  20 could be done using TLS, without modifying existing RADIUS software.
  21 This can be done by running this proxy on the same host as an existing
  22 RADIUS server or client, and configure the existing client/server to
  23 talk to localhost (the proxy) rather than other clients and servers
  24 directly.
  25 .sp
  26 There are however other situations where a RADIUS proxy might be
  27 useful. Some people deploy RADIUS topologies where they want to
  28 route RADIUS messages to the right server. The nodes that do purely
  29 routing could be using a proxy. Some people may also wish to deploy
  30 a proxy on a site boundary. Since the proxy \fBsupports both IPv4
  31 and IPv6\fR, it could also be used to allow communication in cases
  32 where some RADIUS nodes use only IPv4 and some only IPv6.
  33
  34 .TP
  35 .B -f
  36 .sp
  37 \fIRun in foreground\fR
  38 .sp
  39 By specifying this option, the proxy will run in foreground mode. That
  40 is, it won't detach. Also all logging will be done to stderr.
  41
  42 .TP
  43 .B -d <debug level>
  44 .sp
  45 \fIDebug level\fR
  46 .sp
  47 This specifies the debug level. It must be set to 1, 2, 3 or 4, where 1
  48 logs only serious errors, and 4 logs everything. The default is 3 which
  49 logs errors, warnings and some informational messages.
  50
  51 .TP
  52 .B -p
  53 .sp
  54 \fIPretend\fR
  55 .sp
  56 The proxy reads configuration files and performs initialisation as
  57 usual, but exits prior to creating any sockets. It will return different
  58 exit codes depending on whether the configuration files are okay. This
  59 may be used to verify configuration files, and can be done while another
  60 instance is running.
  61
  62 .TP
  63 .B -v
  64 .sp
  65 \fIPrint version\fR
  66 .sp
  67 When this option is specified, the proxy will simply print version
  68 information and exit.
  69
  70 .TP
  71 .B -c <config file path>
  72 .sp
  73 \fIConfig file path\fR
  74 .sp
  75 This option allows you to specify which config file to use. This is useful
  76 if you want to use a config file that is not in any of the default locations.
  77
  78 .SH "SEE ALSO"
  79 radsecproxy.conf(5), RadSec draft paper.