doc/man/radius.conf.5

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "RADIUS.CONF 5"
 132 .TH RADIUS.CONF 5 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
 133 .SH "NAME"
 134 radius.conf \- Configuration for nnrpd RADIUS authenticator
 135 .SH "DESCRIPTION"
 136 .IX Header "DESCRIPTION"
 137 This describes the format and attributes of the configuration file for the
 138 nnrpd \s-1RADIUS\s0 authenticator.  See \fIradius\fR\|(1) for more information about the
 139 authenticator program.  The default location for this file is
 140 \&\fIradius.conf\fR in \fIpathetc\fR.
 141 .PP
 142 Blank lines and lines beginning with \f(CW\*(C`#\*(C'\fR are ignored, as is anything
 143 after a \f(CW\*(C`#\*(C'\fR on a line.  All other lines should begin with a parameter
 144 name followed by a colon and the value of that key, except that each
 145 section of configuration for a particular server should be enclosed in:
 146 .PP
 147 .Vb 3
 148 \&    server <name> {
 149 \&        # parameters...
 150 \&    }
 151 .Ve
 152 .PP
 153 where <name> is just some convenient label for that server.
 154 .PP
 155 The available parameters are:
 156 .IP "\fIradhost\fR" 4
 157 .IX Item "radhost"
 158 The hostname of the \s-1RADIUS\s0 server to use for authentication.  This
 159 parameter must be set.
 160 .IP "\fIradport\fR" 4
 161 .IX Item "radport"
 162 The port to query on the \s-1RADIUS\s0 server.  Defaults to 1645 if not set.
 163 .IP "\fIlochost\fR" 4
 164 .IX Item "lochost"
 165 The hostname or \s-1IP\s0 address making the request.  The \s-1RADIUS\s0 server expects
 166 an \s-1IP\s0 address; a hostname will be translated into an \s-1IP\s0 address with
 167 \&\fIgethostbyname()\fR.  If not given, this information isn't included in the
 168 request (not all \s-1RADIUS\s0 setups require this information).
 169 .IP "\fIlocport\fR" 4
 170 .IX Item "locport"
 171 The port the client being authenticated is connecting to.  If not given,
 172 defaults to 119.  This doesn't need to be set unless readers are
 173 connecting to a non-standard port.
 174 .IP "\fIsecret\fR" 4
 175 .IX Item "secret"
 176 The shared secret with the \s-1RADIUS\s0 server.  If your secret includes spaces,
 177 tabs, or \f(CW\*(C`#\*(C'\fR, be sure to include it in double quotes.  This parameter
 178 must be set.
 179 .IP "\fIprefix\fR" 4
 180 .IX Item "prefix"
 181 Prepend the value of this parameter to all usernames before passing them
 182 to the \s-1RADIUS\s0 server.  Can be used to prepend something like \f(CW\*(C`news\-\*(C'\fR to
 183 all usernames in order to put news users into a different namespace from
 184 other accounts served by the same server.  If not set, nothing is
 185 prepended.
 186 .IP "\fIsuffix\fR" 4
 187 .IX Item "suffix"
 188 Append the value of this parameter to all usernames before passing them to
 189 the \s-1RADIUS\s0 server.  This is often something like \f(CW\*(C`@example.com\*(C'\fR,
 190 depending on how your \s-1RADIUS\s0 server is set up.  If not set, nothing is
 191 appended.
 192 .IP "\fIignore-source\fR" 4
 193 .IX Item "ignore-source"
 194 Can be set to \f(CW\*(C`true\*(C'\fR or \f(CW\*(C`false\*(C'\fR.  If set to false, the \s-1RADIUS\s0
 195 authenticator will check to ensure that the response it receives is from
 196 the same \s-1IP\s0 address as it sent the request to (for some added security).
 197 If set to true, it will skip this verification check (if your \s-1RADIUS\s0
 198 server has multiple \s-1IP\s0 addresses or if other odd things are going on, it
 199 may be perfectly normal for the response to come from a different \s-1IP\s0
 200 address).
 201 .SH "EXAMPLE"
 202 .IX Header "EXAMPLE"
 203 Here is a configuration for a news server named news.example.com,
 204 authenticating users against radius.example.com and appending
 205 \&\f(CW\*(C`@example.com\*(C'\fR to all client-supplied usernames before passing them to
 206 the \s-1RADIUS\s0 server:
 207 .PP
 208 .Vb 6
 209 \&    server example {
 210 \&        radhost: radius.example.com
 211 \&        lochost: news.example.com
 212 \&        secret: IamARADIUSsecRET
 213 \&        suffix: @example.com
 214 \&    }
 215 .Ve
 216 .PP
 217 The shared secret with the \s-1RADIUS\s0 server is \f(CW\*(C`IamARADIUSsecRET\*(C'\fR.
 218 .SH "HISTORY"
 219 .IX Header "HISTORY"
 220 This documentation was written by Russ Allbery <rra@stanford.edu> based on
 221 the comments in the sample radius.conf file by Yury B. Razbegin.
 222 .PP
 223 $Id: radius.conf.5 7880 2008-06-16 20:37:13Z iulius $
 224 .SH "SEE ALSO"
 225 .IX Header "SEE ALSO"
 226 \&\fIradius\fR\|(1)