chiark / gitweb /
debugging for thing that crashed
[innduct.git] / doc / pod / radius.pod
1 =head1 NAME
2
3 radius - nnrpd RADIUS password authenticator
4
5 =head1 SYNOPSIS
6
7 B<radius> [B<-h>] [B<-f> I<config>]
8
9 =head1 DESCRIPTION
10
11 B<radius> is an nnrpd authenticator, accepting a username and password
12 from nnrpd (given to nnrpd by a reader connection) and attempting to
13 authenticate that username and password against a RADIUS server.  See
14 readers.conf(5) for more information on how to configure an nnrpd
15 authenticator.  It is useful for a site that already does user
16 authentication via RADIUS and wants to authenticate news reading
17 connections as well.
18
19 By default, B<radius> reads I<pathetc>/radius.conf for configuration
20 information, but a different configuration file can be specified with
21 B<-f>.  See radius.conf(5) for a description of the configuration file.
22
23 =head1 OPTIONS
24
25 =over 4
26
27 =item B<-f> I<config>
28
29 Read I<config> instead of I<pathetc>/radius.conf for configuration
30 information.
31
32 =item B<-h>
33
34 Print out a usage message and exit.
35
36 =back
37
38 =head1 EXAMPLE
39
40 The following readers.conf(5) fragment tells nnrpd to authenticate all
41 connections using this authenticator:
42
43     auth radius {
44         auth: radius
45         default: <FAIL>
46         default-domain: example.com
47     }
48
49 C<@example.com> will be appended to the user-supplied identity, and if
50 RADIUS authentication failes, the user will be assigned an identity of
51 C<E<lt>FAILE<gt>@example.com>.
52
53 =head1 BUGS
54
55 It has been reported that this authenticator doesn't work with Ascend
56 RADIUS servers, but does work with Cistron RADIUS servers.  It's also
57 believed to work with Livingston's RADIUS server.  Contributions to make
58 it work better with different types of RADIUS servers would be gratefully
59 accepted.
60
61 This code has not been audited against the RADIUS protocol and may not
62 implement it correctly.
63
64 =head1 HISTORY
65
66 The RADIUS authenticator was originally written by Aidan Cully.  This
67 documentation was written by Russ Allbery <rra@stanford.edu>.
68
69 $Id: radius.pod 5894 2002-12-01 19:44:18Z rra $
70
71 =head1 SEE ALSO
72
73 nnrpd(8), radius.conf(5), readers.conf(5)
74
75 RFC 2865, Remote Authentication Dial In User Service.
76
77 =cut