</OL>
<H2 ID="Overview">Overview</H2>
-l2tpns is half of a complete L2TP implementation. It supports only the
-LNS side of the connection.<P>
+l2tpns a complete L2TP implementation. It supports the LAC, LNS, PPPOE and DHCPv6 server.<P>
-L2TP (Layer 2 Tunneling Protocol) is designed to allow any layer 2
-protocol (e.g. Ethernet, PPP) to be tunneled over an IP connection. l2tpns
-implements PPP over L2TP only.<P>
+L2TP (Layer 2 Tunneling Protocol) is designed to allow any layer 2 protocol (e.g. Ethernet, PPP) to be tunneled over an IP connection. l2tpns implements PPP over L2TP only.<P>
-There are a couple of other L2TP implementations, of which <A
-HREF="http://sourceforge.net/projects/l2tpd">l2tpd</A> is probably the
-most popular. l2tpd also will handle being either end of a tunnel, and
-is a lot more configurable than l2tpns. However, due to the way it works,
-it is nowhere near as scalable.<P>
+There are a couple of other L2TP implementations, of which <A HREF="http://sourceforge.net/projects/l2tpd">l2tpd</A> is probably the most popular. l2tpd also will handle being either end of a tunnel, and is a lot more configurable than l2tpns. However, due to the way it works, it is nowhere near as scalable.<P>
-l2tpns uses the TUN/TAP interface provided by the Linux kernel to receive
-and send packets. Using some packet manipulation it doesn't require a
-single interface per connection, as l2tpd does.<P>
+l2tpns uses the TUN/TAP interface provided by the Linux kernel to receive and send packets. Using some packet manipulation it doesn't require a single interface per connection, as l2tpd does.<P>
-This allows it to scale extremely well to very high loads and very high
-numbers of connections.<P>
+This allows it to scale extremely well to very high loads and very high numbers of connections.<P>
-It also has a plugin architecture which allows custom code to be run
-during processing. An example of this is in the walled garden module
-included.<P>
+It also has a plugin architecture which allows custom code to be run during processing. An example of this is in the walled garden module included.<P>
<BR>
<EM>Documentation is not my best skill. If you find any problems
</LI>
<LI><B>log_file</B> (string)<BR>
-This will be where all logging and debugging information is written
-to. This may be either a filename, such as <EM>/var/log/l2tpns</EM>, or
-the special magic string <EM>syslog:facility</EM>, where <EM>facility</EM>
-is any one of the syslog logging facilities, such as local5.
+This will be where all logging and debugging information is written to. This may be either a filename, such as <EM>/var/log/l2tpns</EM>, or the special magic string <EM>syslog:facility</EM>, where <EM>facility</EM> is any one of the syslog logging facilities, such as local5.
</LI>
<LI><B>pid_file</B> (string)<BR>
-If set, the process id will be written to the specified file. The
-value must be an absolute path.
+If set, the process id will be written to the specified file. The value must be an absolute path.
+</LI>
+
+<LI><B>random_device</B>B> (string)<BR>
+Path to random data source (default /dev/urandom). Use "" to use the rand() library function.
</LI>
<LI><B>l2tp_secret</B> (string)<BR>
</LI>
<LI><B>l2tp_mtu</B> (int)<BR>
-MTU of interface for L2TP traffic (default: 1500). Used to set link
-MRU and adjust TCP MSS.
+MTU of interface for L2TP traffic (default: 1500). Used to set link MRU and adjust TCP MSS.
</LI>
<LI><B>ppp_restart_time</B> (int)<BR>
</LI>
<LI><B>radius_secret</B> (string)<BR>
-This secret will be used in all RADIUS queries. If this is not set then
-RADIUS queries will fail.
+This secret will be used in all RADIUS queries. If this is not set then RADIUS queries will fail.
</LI>
<LI><B>radius_authtypes</B> (string)</BR>
</LI>
<LI><B>bind_address</B> (ip address)<BR>
-It's the listen address of the l2tp udp protocol sent and received
-to LAC. This address is also assigned to the tun interface if no
-iftun_address is specified. Packets containing user traffic should be
-routed via this address if given, otherwise the primary address of the
-machine.
+It's the listen address of the l2tp udp protocol sent and received to LAC. This address is also assigned to the tun interface if no iftun_address is specified. Packets containing user traffic should be routed via this address if given, otherwise the primary address of the machine.
</LI>
<LI><B>iftun_address</B> (ip address)<BR>
If no address is given to iftun_address and bind_address, 1.1.1.1 is used.
</LI>
+<LI><B>bind_multi_address</B> (ip address)<BR>
+This parameter permit to listen several addresss of the l2tp udp protocol
+(and set several address to the tun interface).
+<BR>
+WHEN this parameter is set, It OVERWRITE the parameters "bind_address"
+and "iftun_address".
+<BR>
+these can be interesting when you want do load-balancing in cluster mode
+of the uploaded from the LAC. For example you can set a bgp.prepend(MY_AS)
+for Address1 on LNS1 and a bgp.prepend(MY_AS) for Address2 on LNS2
+(see BGP AS-path prepending).
+<BR>
+example of use with 2 address:
+<BR>
+set bind_multi_address "64.14.13.41, 64.14.13.42"
+</LI>
+
+<LI><B>tundevicename</B> (string)<BR>
+Name of the tun interface (default: "tun0").
+</LI>
+
<LI><B>peer_address</B> (ip address)<BR>
Address to send to clients as the default gateway.
</LI>
file dumped begins with a header, where each line is prefixed by #.
Following the header is a single line for every connected user, fields
separated by a space.<BR> The fields are username, ip, qos,
-uptxoctets, downrxoctets. The qos field is 1 if a standard user, and
-2 if the user is throttled.
+uptxoctets, downrxoctets, origin (optional). The qos field is 1 if a standard user, and
+2 if the user is throttled. The origin field is dump if account_all_origin is set to true
+(origin value: L=LAC data, R=Remote LNS data, P=PPPOE data).
</LI>
-<LI><B>setuid</B> (int)<BR>
-After starting up and binding the interface, change UID to this. This
-doesn't work properly.
+<LI><B>account_all_origin</B> (boolean)<BR>
+If set to true, all origin of the usage is dumped to the accounting file (LAC+Remote LNS+PPPOE)(default false).
</LI>
<LI><B>dump_speed</B> (boolean)<BR>
(default: 240 (seconds))
</LI>
+<LI><B>ppp_keepalive</B> (int)<BR>
+Change this value to no to force generation of LCP ECHO every
+echo_timeout seconds, even there are activity on the link.
+(default: yes)
+</LI>
+
+<LI><B>auth_tunnel_change_addr_src</B> (boolean)<BR>
+This parameter authorize to change the source IP of the tunnels l2tp.
+This parameter can be used when the remotes BAS/LAC are l2tpns server
+configured in cluster mode, but that the interface to remote LNS are
+not clustered (the tunnel can be coming from different source IP)
+(default: no).
+</LI>
+
+<LI><B>disable_sending_hello</B> (boolean)<BR>
+Disable l2tp sending HELLO message for Apple compatibility.
+Some OS X implementation of l2tp no manage the L2TP "HELLO message".
+(default: no).
+</LI>
+
+</UL>
+
+<P><U><B>LAC configuration</B></U></P>
+<UL>
<LI><B>bind_address_remotelns</B> (ip address)<BR>
Address of the interface to listen the remote LNS tunnels.
If no address is given, all interfaces are listened (Any Address).
</UL>
-<P>The REMOTES LNS configuration is entered by the command:
+<P>A static REMOTES LNS configuration can be entered by the command:</P>
<DL> <DD><B>setforward</B> <I>MASK</I> <I>IP</I> <I>PORT</I> <I>SECRET</I> </DL>
where <I>MASK</I> specifies the mask of users who have forwarded to
-remote LNS (ex: /myISP@company.com).</BR>
-where <I>IP</I> specifies the IP of the remote LNS (ex: 66.66.66.55).</BR>
+remote LNS (ex: "/friendISP@company.com").</BR>
+where <I>IP</I> specifies the IP of the remote LNS (ex: "66.66.66.55").</BR>
where <I>PORT</I> specifies the L2TP Port of the remote LNS
(Normally should be 1701) (ex: 1701).</BR>
where <I>SECRET</I> specifies the secret password the remote LNS (ex: mysecret).</BR>
+</BR>
+The static Remote LNS configuration can be used when the friend ISP not
+have a proxied Radius.</BR>
+If the proxied Radius is used, It will return the RADIUS attributes:</BR>
+ Tunnel-Type: 1 = L2TP</BR>
+ Tunnel-Medium-Type: 1 = IPv4</BR>
+ Tunnel-Password: 1 = "LESECRETL2TP"</BR>
+ Tunnel-Server-Endpoint: 1 = "88.xx.xx.x1"</BR>
+ Tunnel-Assignment-Id: 1 = "friendisp_lns1"</BR>
+ Tunnel-Type: 2 = L2TP</BR>
+ Tunnel-Medium-Type: 2 = IPv4</BR>
+ Tunnel-Password: 2 = "LESECRETL2TP"</BR>
+ Tunnel-Server-Endpoint: 2 = "88.xx.xx.x2"</BR>
+ Tunnel-Assignment-Id: 2 = "friendisp_lns2"</BR>
+
+<P><U><B>PPPOE configuration</B></U></P>
+
+<UL>
+<LI><B>pppoe_if_to_bind</B> (string)<BR>
+PPPOE server interface to bind (ex: "eth0.12"), If not specified the server PPPOE is not enabled.
+For the pppoe clustering, all the interfaces PPPOE of the clusters must use the same HW address (MAC address).
+</LI>
+
+<LI><B>pppoe_service_name</B> (string)<BR>
+PPPOE service name (default: NULL).
+</LI>
+
+<LI><B>pppoe_ac_name</B> (string)<BR>
+PPPOE access concentrator name (default: "l2tpns-pppoe").
+</LI>
+
+<LI><B>pppoe_only_equal_svc_name</B> (boolean)<BR>
+If set to yes, the PPPOE server only accepts clients with a "service-name"
+different from NULL and a "service-name" equal to server "service-name" (default: no).
+</LI>
+
+</UL>
+
+<P><U><B>BGP configuration</B></U></P>
<P>BGP routing configuration is entered by the command:
The routing configuration section is entered by the command
projects / l2tpns.git / blobdiff