man/man8/radiusd.8

   1 .TH RADIUSD 8 "27 Dec 2007" "" "FreeRADIUS Daemon"
   2 .SH NAME
   3 radiusd - Authentication, Authorization and Accounting server
   4 .SH SYNOPSIS
   5 .B radiusd
   6 .RB [ \-C ]
   7 .RB [ \-d
   8 .IR config_directory ]
   9 .RB [ \-f ]
  10 .RB [ \-i
  11 .IR ip-address ]
  12 .RB [ \-p
  13 .IR port ]
  14 .RB [ \-s ]
  15 .RB [ \-v ]
  16 .RB [ \-x ]
  17 .RB [ \-X ]
  18 .SH DESCRIPTION
  19 FreeRADIUS is a high-performance and highly configurable RADIUS
  20 server.  It supports many database back-ends such as flat-text files,
  21 SQL, LDAP, Perl, Python, etc.  It also supports many authentication
  22 protocols such as PAP, CHAP, MS-CHAP(v2), HTTP Digest, and EAP
  23 (EAP-MD5, EAP-TLS, PEAP, EAP-TTLS, EAP-SIM, etc.).
  24
  25 Version 2.0 has preliminary support for Cisco's VLAN Query Protocol,
  26 also known as VMPS.
  27 .SH OPTIONS
  28 The following command-line options are accepted by the server.
  29 .IP \-C
  30 Check the configuration and exit immediately.  If there is a problem
  31 reading the configuration, then the server will exit with a non-zero
  32 status code.  If the configuration appears to be acceptable, then the
  33 server will exit with a zero status code.
  34
  35 Note that there are many limitations to this check.  Due to the
  36 complexities involved in \fIalmost\fP starting a RADIUS server, these
  37 checks are necessarily incomplete.  The server can return a zero
  38 status code when run with -C, but may still exit with an error when
  39 run normally.
  40
  41 See the output of
  42 .B "radiusd -XC"
  43 for an informative list of which modules are checked for correct
  44 configuration, and which modules are skipped, and therefore not checked.
  45 .IP "\-d \fIconfig directory\fP"
  46 Defaults to \fI/etc/raddb\fP. \fBRadiusd\fP looks here for its configuration
  47 files such as the \fIdictionary\fP and the \fIusers\fP files.
  48 .IP "\-i \fIip-address\fP"
  49 Defines which IP address that the server uses for sending and
  50 receiving packets.
  51
  52 If this command-line option is given, then the "bind_address" and all
  53 "listen{}" entries in \fIradiusd.conf\fP are ignored.
  54
  55 This option MUST be used in conjunction with "-p".
  56 .IP \-f
  57 Do not fork, stay running as a foreground process.
  58 .IP "\-p \fIport\fP"
  59 Normally radiusd listens on the ports specified in \fI/etc/services\fP
  60 (radius and radacct). When this option is given, radiusd listens on
  61 the specified port for authentication requests and on the specified
  62 port +1 for accounting requests.
  63
  64 If this command-line option is given, then the "port" directive in
  65 \fIradiusd.conf\fP is ignored.
  66
  67 This option MUST be used in conjunction with "-i".
  68 .IP \-s
  69 Run in "single server" mode.  The server normally runs with multiple
  70 threads and/or processes, which can lower its response time to
  71 requests.  Some systems have issues with threading, however, so
  72 running in "single server" mode may help to address those issues.  In
  73 single server mode, the server will also not "daemonize"
  74 (auto-background) itself.
  75 .IP \-v
  76 Print server version information and exit.
  77 .IP \-X
  78 Debugging mode.  Equivalent to -sfxx -l stdout
  79 .IP \-x
  80 Finer-grained debug mode. In this mode the server will print details
  81 of every request on it's \fBstdout\fP output. You can specify this
  82 option multiple times (-x -x or -xx) to get more detailed output.
  83 .SH DEBUGGING
  84 The server can be difficult to configure correctly in systems with
  85 complex requirements.  We STRONGLY RECOMMEND proceeding via the
  86 following steps:
  87 .PP
  88 1) Always run the server in debugging mode (
  89 .B radiusd -X
  90 ).  We cannot emphasize this enough.  If you are not running the
  91 server in debugging mode, you \fIwill not\fP be able to see what is
  92 doing, and you \fIwill not\fP be able to correct any problems.
  93 .PP
  94 2) When editing the \fIradiusd.conf\fP file, change as little as
  95 possible, especially in the \fIauthorize{}\fP section.  The ordering
  96 of the modules is critical for the server to be able to
  97 "automatically" figure out how to handle the request.  Changing the
  98 order of the modules ensures that the server will not work.
  99 .PP
 100 3) When testing, start off by configuring a user and password in the
 101 \fIusers\fP file.  So long as the server knows about a user, and has a
 102 clear-text password for that user, \fBalmost all of the authentication
 103 methods will "just work"\fP.
 104 .PP
 105 4) Gradually add more complex configurations to the server, while
 106 testing them as you go.  If you start off by configuring the server in
 107 a complex configuration, you will never be able to debug it.
 108 .PP
 109 5) Ask questions on the mailing list
 110 (freeradius-users@lists.freeradius.org).  When asking questions,
 111 include the output from debugging mode (
 112 .B radiusd -X
 113 ).  This information will allow people to help you.  Without it, your
 114 message will get ignored.
 115 .SH BACKGROUND
 116 \fBRADIUS\fP is a protocol spoken between an access server, typically
 117 a device connected to several modems or ISDN lines, and a \fBradius\fP
 118 server. When a user connects to the access server, (s)he is asked for
 119 a loginname and a password. This information is then sent to the \fBradius\fP
 120 server. The server replies with "access denied", or "access OK". In the
 121 latter case login information is sent along, such as the IP address in
 122 the case of a PPP connection.
 123 .PP
 124 The access server also sends login and logout records to the \fBradius\fP
 125 server so accounting can be done. These records are kept for each terminal
 126 server seperately in a file called \fBdetail\fP, and in the \fIwtmp\fP
 127 compatible logfile \fB/var/log/radwtmp\fP.
 128 .SH CONFIGURATION
 129 \fBRadiusd\fP uses a number of configuration files. Each file has it's
 130 own manpage describing the format of the file. These files are:
 131 .IP radiusd.conf
 132 The main configuration file, which sets the administrator-controlled
 133 items.
 134 .IP dictionary
 135 This file is usually static. It defines all the possible RADIUS attributes
 136 used in the other configuration files.  You don't have to modify it.
 137 It includes other dictionary files in the same directory.
 138 .IP hints
 139 Defines certain hints to the radius server based on the users's loginname
 140 or other attributes sent by the access server. It also provides for
 141 mapping user names (such as Pusername -> username). This provides the
 142 functionality that the \fILivingston 2.0\fP server has as "Prefix" and
 143 "Suffix" support in the \fIusers\fP file, but is more general. Ofcourse
 144 the Livingston way of doing things is also supported, and you can even use
 145 both at the same time (within certain limits).
 146 .IP huntgroups
 147 Defines the huntgroups that you have, and makes it possible to restrict
 148 access to certain huntgroups to certain (groups of) users.
 149 .IP users
 150 Here the users are defined. On a typical setup, this file mainly contains
 151 DEFAULT entries to process the different types of logins, based on hints
 152 from the hints file. Authentication is then based on the contents of
 153 the UNIX \fI/etc/passwd\fP file. However it is also possible to define all
 154 users, and their passwords, in this file.
 155 .SH SEE ALSO
 156 radiusd.conf(5), users(5), huntgroups(5), hints(5),
 157 dictionary(5).
 158 .SH AUTHOR
 159 The FreeRADIUS Server Project (http://www.freeradius.org)
 160