radsecproxy.1

   1 .TH radsecproxy 1 "1 Jun 2010"
   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 .HP 12
   8 radsecproxy [\-c configfile] [\-d debuglevel] [\-f] [\-i pidfile] [\-p] [\-v]
   9 .sp
  10
  11 .SH "DESCRIPTION"
  12 radsecproxy is a \fBgeneric RADIUS proxy\fR that in addition to to
  13 usual \fBRADIUS UDP\fR transport, also supports \fBTLS (RadSec)\fR. The
  14 aim is for the proxy to have sufficient features to be flexible,
  15 while at the same time to be small, efficient and easy to configure.
  16 Currently the executable on Linux is only about \fI48 KB\fR, and it uses
  17 about \fI64 KB\fR (depending on the number of peers) while running.
  18 .sp
  19 The proxy was initially made to be able to deploy \fBRadSec\fR (RADIUS
  20 over TLS) so that all RADIUS communication across network links
  21 could be done using TLS, without modifying existing RADIUS software.
  22 This can be done by running this proxy on the same host as an existing
  23 RADIUS server or client, and configure the existing client/server to
  24 talk to localhost (the proxy) rather than other clients and servers
  25 directly.
  26 .sp
  27 There are however other situations where a RADIUS proxy might be
  28 useful. Some people deploy RADIUS topologies where they want to
  29 route RADIUS messages to the right server. The nodes that do purely
  30 routing could be using a proxy. Some people may also wish to deploy
  31 a proxy on a site boundary. Since the proxy \fBsupports both IPv4
  32 and IPv6\fR, it could also be used to allow communication in cases
  33 where some RADIUS nodes use only IPv4 and some only IPv6.
  34
  35 .SH "OPTIONS"
  36 .TP
  37 .B \-f
  38 .sp
  39 \fIRun in foreground\fR
  40 .sp
  41 By specifying this option, the proxy will run in foreground mode. That
  42 is, it won't detach. Also all logging will be done to stderr.
  43
  44 .TP
  45 .B \-d <debug level>
  46 .sp
  47 \fIDebug level\fR
  48 .sp
  49 This specifies the debug level. It must be set to 1, 2, 3, 4 or 5, where
  50 1 logs only serious errors, and 5 logs everything. The default is 2 which
  51 logs errors, warnings and a few informational messages.
  52
  53 .TP
  54 .B \-p
  55 .sp
  56 \fIPretend\fR
  57 .sp
  58 The proxy reads configuration files and performs initialisation as
  59 usual, but exits prior to creating any sockets. It will return different
  60 exit codes depending on whether the configuration files are okay. This
  61 may be used to verify configuration files, and can be done while another
  62 instance is running.
  63
  64 .TP
  65 .B \-v
  66 .sp
  67 \fIPrint version\fR
  68 .sp
  69 When this option is specified, the proxy will simply print version
  70 information and exit.
  71
  72 .TP
  73 .B \-c <config file path>
  74 .sp
  75 \fIConfig file path\fR
  76 .sp
  77 This option allows you to specify which config file to use. This is useful
  78 if you want to use a config file that is not in any of the default locations.
  79
  80 .TP
  81 .B \-i <pid file path>
  82 .sp
  83 \fIPID file path\fR
  84 .sp
  85 This option tells the proxy to create a PID file with the specified path.
  86
  87 .SH "SIGNALS"
  88 The proxy generally exits on all signals. The exceptions are listed below.
  89
  90 .TP
  91 .B SIGHUP
  92 .sp
  93 When logging to a file, this signal forces a reopen of the log file.
  94
  95 .TP
  96 .B SIGPIPE
  97 .sp
  98 This signal is ignored.
  99
 100 .SH "FILES"
 101 .TP
 102 .B /etc/radsecproxy.conf
 103 .sp
 104 The default configuration file.
 105
 106 .SH "SEE ALSO"
 107 radsecproxy.conf(5), RadSec internet draft
 108 http://tools.ietf.org/html/draft-ietf-radext-radsec