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