plugins/radius: Handle bindaddr keyword in radiusclient.conf
[ppp.git] / pppd / plugins / radius / pppd-radius.8
1 .\" manual page [] for RADIUS plugin for pppd 2.4
2 .\" $Id: pppd-radius.8,v 1.5 2004/03/26 13:27:17 kad Exp $
3 .\" SH section heading
4 .\" SS subsection heading
5 .\" LP paragraph
6 .\" IP indented paragraph
7 .\" TP hanging label
8 .TH PPPD-RADIUS 8
9 .SH NAME
10 radius.so \- RADIUS authentication plugin for
11 .BR pppd (8)
12 .SH SYNOPSIS
13 .B pppd
14 [
15 .I options
16 ]
17 plugin radius.so
18 .SH DESCRIPTION
19 .LP
20 The RADIUS plugin for pppd permits pppd to perform PAP, CHAP, MS-CHAP and
21 MS-CHAPv2 authentication against a RADIUS server instead of the usual
22 .I /etc/ppp/pap-secrets
23 and
24 .I /etc/ppp/chap-secrets
25 files.
26 .LP
27 The RADIUS plugin is built on a library called
28 .B radiusclient
29 which has its own configuration files (usually in \fI/etc/radiusclient\fR),
30 consult those files for more information on configuring the RADIUS
31 plugin
32
33 .SH OPTIONS
34 The RADIUS plugin introduces one additional pppd option:
35 .TP
36 .BI "radius-config-file " filename
37 The file
38 .I filename
39 is taken as the radiusclient configuration file.  If this option is not
40 used, then the plugin uses
41 .I /etc/radiusclient/radiusclient.conf
42 as the configuration file.
43 .TP
44 .BI "avpair " attribute=value
45 Adds an Attribute-Value pair to be passed on to the RADIUS server on each request.
46 .TP
47 .BI map-to-ifname
48 Sets Radius NAS-Port attribute to number equal to interface name (Default)
49 .TP
50 .BI map-to-ttyname
51 Sets Radius NAS-Port attribute value via libradiusclient library
52
53 .SH USAGE
54 To use the plugin, simply supply the
55 .B plugin radius.so
56 option to pppd, and edit
57 .I /etc/radiusclient/radiusclient.conf
58 appropriately.  If you use the RADIUS plugin, the normal pppd authentication
59 schemes (login, checking the /etc/ppp/*-secrets files) are skipped.  The
60 RADIUS server should assign an IP address to the peer using the RADIUS
61 Framed-IP-Address attribute.
62
63 .SH SEE ALSO
64 .BR pppd (8) " pppd-radattr" (8)
65
66 .SH AUTHOR
67 David F. Skoll <dfs@roaringpenguin.com>