lib/libradius/radius.conf.5

   1 .\" Copyright 1998 Juniper Networks, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd October 30, 1999
  28 .Dt RADIUS.CONF 5
  29 .Os
  30 .Sh NAME
  31 .Nm radius.conf
  32 .Nd RADIUS client configuration file
  33 .Sh SYNOPSIS
  34 .Pa /etc/radius.conf
  35 .Sh DESCRIPTION
  36 .Nm
  37 contains the information necessary to configure the RADIUS client
  38 library.
  39 It is parsed by
  40 .Xr rad_config 3 .
  41 The file contains one or more lines of text, each describing a
  42 single RADIUS server which will be used by the library.
  43 Leading
  44 white space is ignored, as are empty lines and lines containing
  45 only comments.
  46 .Pp
  47 A RADIUS server is described by three to five fields on a line:
  48 .Pp
  49 .Bl -item -offset indent -compact
  50 .It
  51 Service type
  52 .It
  53 Server host
  54 .It
  55 Shared secret
  56 .It
  57 Timeout
  58 .It
  59 Retries
  60 .El
  61 .Pp
  62 The fields are separated by white space.
  63 The
  64 .Ql #
  65 character at the beginning of a field begins a comment, which extends
  66 to the end of the line.
  67 A field may be enclosed in double quotes,
  68 in which case it may contain white space and/or begin with the
  69 .Ql #
  70 character.
  71 Within a quoted string, the double quote character can
  72 be represented by
  73 .Ql \e\&" ,
  74 and the backslash can be represented by
  75 .Ql \e\e .
  76 No other escape sequences are supported.
  77 .Pp
  78 .Pp
  79 The first field gives the service type, either
  80 .Ql auth
  81 for RADIUS authentication or
  82 .Ql acct
  83 for RADIUS accounting.
  84 If a single server provides both services, two
  85 lines are required in the file.
  86 Earlier versions of this file did
  87 not include a service type.
  88 For backward compatibility, if the first
  89 field is not
  90 .Ql auth
  91 or
  92 .Ql acct
  93 the library behaves as if
  94 .Ql auth
  95 were specified, and interprets the fields in the line as if they
  96 were fields two through five.
  97 .Pp
  98 The second field specifies
  99 the server host, either as a fully qualified domain name or as a
 100 dotted-quad IP address.
 101 The host may optionally be followed by a
 102 .Ql \&:
 103 and a numeric port number, without intervening white space.
 104 If the
 105 port specification is omitted, it defaults to the
 106 .Ql radius
 107 or
 108 .Ql radacct
 109 service in the
 110 .Pa /etc/services
 111 file for service types
 112 .Ql auth
 113 and
 114 .Ql acct ,
 115 respectively.
 116 If no such entry is present, the standard ports 1812 and 1813 are
 117 used.
 118 .Pp
 119 The third field contains the shared secret, which should be known
 120 only to the client and server hosts.
 121 It is an arbitrary string of
 122 characters, though it must be enclosed in double quotes if it
 123 contains white space.
 124 The shared secret may be
 125 any length, but the RADIUS protocol uses only the first 128
 126 characters.
 127 N.B., some popular RADIUS servers have bugs which
 128 prevent them from working properly with secrets longer than 16
 129 characters.
 130 .Pp
 131 The fourth field contains a decimal integer specifying the timeout in
 132 seconds for receiving a valid reply from the server.
 133 If this field
 134 is omitted, it defaults to 3 seconds.
 135 .Pp
 136 The fifth field contains a decimal integer specifying the maximum
 137 number of attempts that will be made to authenticate with the server
 138 before giving up.
 139 If omitted, it defaults to 3 attempts.
 140 Note,
 141 this is the total number of attempts and not the number of retries.
 142 .Pp
 143 Up to 10 RADIUS servers may be specified for each service type.
 144 The servers are tried in
 145 round-robin fashion, until a valid response is received or the
 146 maximum number of tries has been reached for all servers.
 147 .Pp
 148 The standard location for this file is
 149 .Pa /etc/radius.conf .
 150 But an alternate pathname may be specified in the call to
 151 .Xr rad_config 3 .
 152 Since the file contains sensitive information in the form of the
 153 shared secrets, it should not be readable except by root.
 154 .Sh FILES
 155 .Pa /etc/radius.conf
 156 .Sh EXAMPLES
 157 .Bd -literal
 158 # A simple entry using all the defaults:
 159 acct  radius1.domain.com  OurLittleSecret
 160
 161 # A server still using the obsolete RADIUS port, with increased
 162 # timeout and maximum tries:
 163 auth  auth.domain.com:1645  "I can't see you"  5  4
 164
 165 # A server specified by its IP address:
 166 auth  192.168.27.81  $X*#..38947ax-+=
 167 .Ed
 168 .Sh SEE ALSO
 169 .Xr libradius 3
 170 .Rs
 171 .%A C. Rigney, et al
 172 .%T "Remote Authentication Dial In User Service (RADIUS)"
 173 .%O RFC 2138
 174 .Re
 175 .Rs
 176 .%A C. Rigney
 177 .%T RADIUS Accounting
 178 .%O RFC 2139
 179 .Re
 180 .Sh AUTHORS
 181 This documentation was written by
 182 .An John Polstra ,
 183 and donated to the
 184 .Fx
 185 project by Juniper Networks, Inc.