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 .\" $DragonFly: src/lib/libradius/radius.conf.5,v 1.2 2003/06/17 04:26:51 dillon Exp $
  27 .\"
  28 .Dd October 30, 1999
  29 .Dt RADIUS.CONF 5
  30 .Os
  31 .Sh NAME
  32 .Nm radius.conf
  33 .Nd RADIUS client configuration file
  34 .Sh SYNOPSIS
  35 .Pa /etc/radius.conf
  36 .Sh DESCRIPTION
  37 .Nm
  38 contains the information necessary to configure the RADIUS client
  39 library.  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.  Leading
  43 white space is ignored, as are empty lines and lines containing
  44 only comments.
  45 .Pp
  46 A RADIUS server is described by three to five fields on a line:
  47 .Pp
  48 .Bl -item -offset indent -compact
  49 .It
  50 Service type
  51 .It
  52 Server host
  53 .It
  54 Shared secret
  55 .It
  56 Timeout
  57 .It
  58 Retries
  59 .El
  60 .Pp
  61 The fields are separated by white space.  The
  62 .Ql #
  63 character at the beginning of a field begins a comment, which extends
  64 to the end of the line.  A field may be enclosed in double quotes,
  65 in which case it may contain white space and/or begin with the
  66 .Ql #
  67 character.  Within a quoted string, the double quote character can
  68 be represented by
  69 .Ql \e\&" ,
  70 and the backslash can be represented by
  71 .Ql \e\e .
  72 No other escape sequences are supported.
  73 .Pp
  74 .Pp
  75 The first field gives the service type, either
  76 .Ql auth
  77 for RADIUS authentication or
  78 .Ql acct
  79 for RADIUS accounting.  If a single server provides both services, two
  80 lines are required in the file.  Earlier versions of this file did
  81 not include a service type.  For backward compatibility, if the first
  82 field is not
  83 .Ql auth
  84 or
  85 .Ql acct
  86 the library behaves as if
  87 .Ql auth
  88 were specified, and interprets the fields in the line as if they
  89 were fields two through five.
  90 .Pp
  91 The second field specifies
  92 the server host, either as a fully qualified domain name or as a
  93 dotted-quad IP address.  The host may optionally be followed by a
  94 .Ql \&:
  95 and a numeric port number, without intervening white space.  If the
  96 port specification is omitted, it defaults to the
  97 .Ql radius
  98 or
  99 .Ql radacct
 100 service in the
 101 .Pa /etc/services
 102 file for service types
 103 .Ql auth
 104 and
 105 .Ql acct ,
 106 respectively.
 107 If no such entry is present, the standard ports 1812 and 1813 are
 108 used.
 109 .Pp
 110 The third field contains the shared secret, which should be known
 111 only to the client and server hosts.  It is an arbitrary string of
 112 characters, though it must be enclosed in double quotes if it
 113 contains white space.  The shared secret may be
 114 any length, but the RADIUS protocol uses only the first 128
 115 characters.  N.B., some popular RADIUS servers have bugs which
 116 prevent them from working properly with secrets longer than 16
 117 characters.
 118 .Pp
 119 The fourth field contains a decimal integer specifying the timeout in
 120 seconds for receiving a valid reply from the server.  If this field
 121 is omitted, it defaults to 3 seconds.
 122 .Pp
 123 The fifth field contains a decimal integer specifying the maximum
 124 number of attempts that will be made to authenticate with the server
 125 before giving up.  If omitted, it defaults to 3 attempts.  Note,
 126 this is the total number of attempts and not the number of retries.
 127 .Pp
 128 Up to 10 RADIUS servers may be specified for each service type.
 129 The servers are tried in
 130 round-robin fashion, until a valid response is received or the
 131 maximum number of tries has been reached for all servers.
 132 .Pp
 133 The standard location for this file is
 134 .Pa /etc/radius.conf .
 135 But an alternate pathname may be specified in the call to
 136 .Xr rad_config 3 .
 137 Since the file contains sensitive information in the form of the
 138 shared secrets, it should not be readable except by root.
 139 .Sh FILES
 140 .Pa /etc/radius.conf
 141 .Sh EXAMPLES
 142 .Bd -literal
 143 # A simple entry using all the defaults:
 144 acct  radius1.domain.com  OurLittleSecret
 145
 146 # A server still using the obsolete RADIUS port, with increased
 147 # timeout and maximum tries:
 148 auth  auth.domain.com:1645  "I can't see you"  5  4
 149
 150 # A server specified by its IP address:
 151 auth  192.168.27.81  $X*#..38947ax-+=
 152 .Ed
 153 .Sh SEE ALSO
 154 .Xr libradius 3
 155 .Rs
 156 .%A C. Rigney, et al
 157 .%T "Remote Authentication Dial In User Service (RADIUS)"
 158 .%O RFC 2138
 159 .Re
 160 .Rs
 161 .%A C. Rigney
 162 .%T RADIUS Accounting
 163 .%O RFC 2139
 164 .Re
 165 .Sh AUTHORS
 166 This documentation was written by
 167 .An John Polstra ,
 168 and donated to the
 169 .Fx
 170 project by Juniper Networks, Inc.