.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "INN-RADIUS.CONF 5"
.TH INN-RADIUS.CONF 5 2024-05-19 "INN 2.7.4" "InterNetNews Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
inn\-radius.conf \- Configuration for nnrpd RADIUS authenticator
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This describes the format and attributes of the configuration file for
the \fBnnrpd\fR RADIUS authenticator.  See radius(8) for more information
about the authenticator program.  The default location for this file
is \fIinn\-radius.conf\fR in \fIpathetc\fR.
.PP
Blank lines and lines beginning with \f(CW\*(C`#\*(C'\fR are ignored, as is anything
after a \f(CW\*(C`#\*(C'\fR on a line.  All other lines should begin with a parameter
name followed by a colon and the value of that key, except that each
section of configuration for a particular server should be enclosed in:
.PP
.Vb 3
\&    server <name> {
\&        # parameters...
\&    }
.Ve
.PP
where <name> is just some convenient label for that server.
.SH "SERVER GROUP PARAMETERS"
.IX Header "SERVER GROUP PARAMETERS"
The available parameters are:
.IP \fIradhost\fR 4
.IX Item "radhost"
The hostname of the RADIUS server to use for authentication.  This
parameter must be set.
.IP \fIradport\fR 4
.IX Item "radport"
The port to query on the RADIUS server.  Defaults to 1645 if not set.
.IP \fIlochost\fR 4
.IX Item "lochost"
The hostname or IP address making the request.  The RADIUS server expects
an IP address; a hostname will be translated into an IP address with
gethostbyname().  If not given, this information isn't included in the
request (not all RADIUS setups require this information).
.IP \fIlocport\fR 4
.IX Item "locport"
The port the client being authenticated is connecting to.  If not given,
defaults to 119.  This doesn't need to be set unless readers are
connecting to a non-standard port.
.IP \fIsecret\fR 4
.IX Item "secret"
The shared secret with the RADIUS server.  If your secret includes spaces,
tabs, or \f(CW\*(C`#\*(C'\fR, be sure to include it in double quotes.  This parameter
must be set.
.IP \fIprefix\fR 4
.IX Item "prefix"
Prepend the value of this parameter to all usernames before passing them
to the RADIUS server.  Can be used to prepend something like \f(CW\*(C`news\-\*(C'\fR to
all usernames in order to put news users into a different namespace from
other accounts served by the same server.  If not set, nothing is
prepended.
.IP \fIsuffix\fR 4
.IX Item "suffix"
Append the value of this parameter to all usernames before passing them to
the RADIUS server.  This is often something like \f(CW\*(C`@example.com\*(C'\fR,
depending on how your RADIUS server is set up.  If not set, nothing is
appended.
.IP \fIignore-source\fR 4
.IX Item "ignore-source"
Can be set to \f(CW\*(C`true\*(C'\fR, \f(CW\*(C`yes\*(C'\fR, \f(CW\*(C`on\*(C'\fR, \f(CW\*(C`false\*(C'\fR, \f(CW\*(C`no\*(C'\fR or \f(CW\*(C`off\*(C'\fR.  If set
to false, the RADIUS authenticator will check to ensure that the response
it receives is from the same IP address as it sent the request to (for some
added security).  If set to true, it will skip this verification check (if
your RADIUS server has multiple IP addresses or if other odd things are going
on, it may be perfectly normal for the response to come from a different IP
address).
.SH EXAMPLE
.IX Header "EXAMPLE"
Here is a configuration for a news server named news.example.com,
authenticating users against radius.example.com and appending
\&\f(CW\*(C`@example.com\*(C'\fR to all client-supplied usernames before passing them to
the RADIUS server:
.PP
.Vb 6
\&    server example {
\&        radhost: radius.example.com
\&        lochost: news.example.com
\&        secret: IamARADIUSsecRET
\&        suffix: @example.com
\&    }
.Ve
.PP
The shared secret with the RADIUS server is \f(CW\*(C`IamARADIUSsecRET\*(C'\fR.
.SH HISTORY
.IX Header "HISTORY"
This documentation was written by Russ Allbery <eagle@eyrie.org> based on
the comments in the sample \fIinn\-radius.conf\fR file by Yury B.\ Razbegin.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
radius(8).