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: src/lib/libradius/radius.conf.5,v 1.4.2.3 2001/08/17 15:43:06 ru Exp $
  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 seven 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 .It
  61 Dead time
  62 .It
  63 Bind address
  64 .El
  65 .Pp
  66 The fields are separated by white space.
  67 The
  68 .Ql #
  69 character at the beginning of a field begins a comment, which extends
  70 to the end of the line.
  71 A field may be enclosed in double quotes,
  72 in which case it may contain white space and/or begin with the
  73 .Ql #
  74 character.
  75 Within a quoted string, the double quote character can
  76 be represented by
  77 .Ql \e\&" ,
  78 and the backslash can be represented by
  79 .Ql \e\e .
  80 No other escape sequences are supported.
  81 .Pp
  82 The first field gives the service type, either
  83 .Ql auth
  84 for RADIUS authentication or
  85 .Ql acct
  86 for RADIUS accounting.
  87 If a single server provides both services, two
  88 lines are required in the file.
  89 Earlier versions of this file did
  90 not include a service type.
  91 For backward compatibility, if the first
  92 field is not
  93 .Ql auth
  94 or
  95 .Ql acct
  96 the library behaves as if
  97 .Ql auth
  98 were specified, and interprets the fields in the line as if they
  99 were fields two through five.
 100 .Pp
 101 The second field specifies
 102 the server host, either as a fully qualified domain name or as a
 103 dotted-quad IP address.
 104 The host may optionally be followed by a
 105 .Ql \&:
 106 and a numeric port number, without intervening white space.
 107 If the
 108 port specification is omitted, it defaults to the
 109 .Ql radius
 110 or
 111 .Ql radacct
 112 service in the
 113 .Pa /etc/services
 114 file for service types
 115 .Ql auth
 116 and
 117 .Ql acct ,
 118 respectively.
 119 If no such entry is present, the standard ports 1812 and 1813 are
 120 used.
 121 .Pp
 122 The third field contains the shared secret, which should be known
 123 only to the client and server hosts.
 124 It is an arbitrary string of
 125 characters, though it must be enclosed in double quotes if it
 126 contains white space.
 127 The shared secret may be
 128 any length, but the RADIUS protocol uses only the first 128
 129 characters.
 130 N.B., some popular RADIUS servers have bugs which
 131 prevent them from working properly with secrets longer than 16
 132 characters.
 133 .Pp
 134 The fourth field contains a decimal integer specifying the timeout in
 135 seconds for receiving a valid reply from the server.
 136 If this field
 137 is omitted, it defaults to 3 seconds.
 138 .Pp
 139 The fifth field contains a decimal integer specifying the maximum
 140 number of attempts that will be made to authenticate with the server
 141 before giving up.
 142 If omitted, it defaults to 3 attempts.
 143 Note,
 144 this is the total number of attempts and not the number of retries.
 145 .Pp
 146 The sixth field contains a decimal integer specifying a time interval
 147 in seconds when the server will not requested if it was inaccessible
 148 on the last try. 0 means ask always.
 149 .Pp
 150 The seventh field contains an IP address on multihomed host. All
 151 requests will be binded to this IP.
 152 .Pp
 153 Up to 10 RADIUS servers may be specified for each service type.
 154 The servers are tried in
 155 round-robin fashion, until a valid response is received or the
 156 maximum number of tries has been reached for all servers.
 157 .Pp
 158 The standard location for this file is
 159 .Pa /etc/radius.conf .
 160 But an alternate pathname may be specified in the call to
 161 .Xr rad_config 3 .
 162 Since the file contains sensitive information in the form of the
 163 shared secrets, it should not be readable except by root.
 164 .Sh FILES
 165 .Pa /etc/radius.conf
 166 .Sh EXAMPLES
 167 .Bd -literal
 168 # A simple entry using all the defaults:
 169 acct  radius1.domain.com  OurLittleSecret
 170
 171 # A server still using the obsolete RADIUS port, with increased
 172 # timeout and maximum tries:
 173 auth  auth.domain.com:1645  "I can't see you"  5  4
 174
 175 # As above but set dead time and bind address
 176 auth  auth.domain.com:1645  "I can't see you"  5  4  60  192.168.1.8
 177
 178 # A server specified by its IP address:
 179 auth  192.168.27.81  $X*#..38947ax-+=
 180 .Ed
 181 .Sh SEE ALSO
 182 .Xr libradius 3
 183 .Rs
 184 .%A C. Rigney, et al
 185 .%T "Remote Authentication Dial In User Service (RADIUS)"
 186 .%O RFC 2138
 187 .Re
 188 .Rs
 189 .%A C. Rigney
 190 .%T RADIUS Accounting
 191 .%O RFC 2139
 192 .Re
 193 .Sh AUTHORS
 194 This documentation was written by
 195 .An John Polstra ,
 196 and donated to the
 197 .Fx
 198 project by Juniper Networks, Inc.