release/src/router/xl2tpd/doc/xl2tpd.conf.5

   1 .TH "xl2tpd.conf" "5" "" "Jean-Francois Dive" ""
   2 .SH "NAME"
   3 xl2tpd.conf \- L2TPD configuration file
   4 .SH "DESCRIPTION"
   5 The xl2tpd.conf file contains configuration information for xl2tpd, the implementation of l2tp protocol.
   6
   7 The configuration file is composed of sections and parameters. Each section
   8 has a given name which will be used when using the configuration FIFO
   9 (normaly /var/run/l2tp\-control). See xl2tpd.8  for more details.
  10
  11 The specific given name
  12 .B default
  13 will specify parameters applicables for all the following sections.
  14 .SH "GLOBAL SECTION"
  15 .TP
  16 .B auth file
  17 Specify where to find the authentication file used to authenticate
  18 l2tp tunnels. The default is /etc/l2tpd/l2tp\-secrets.
  19
  20 .TP
  21 .B ipsec saref
  22 Use ipsec Security Association trackinng. When this is enabled, packets
  23 received by xl2tpd should have to extra fields (refme and refhim) which
  24 allows tracking of multiple clients using the same internal NATed IP
  25 address, and allows tracking of multiple clients behind the same
  26 NAT router. This neds to be supported by the kernel. Currently, this
  27 only works with Openswan KLIPS in "mast" mode. (see http://www.openswan.org/)
  28
  29 Set this to yes and the system will provide proper SAref values in the
  30 recvmsg() calls.
  31
  32 Values can be yes or no. The default is no.
  33
  34 .TP
  35 .B listen-addr
  36 The IP address of the interface on which the daemon listens.  By default,
  37 it listens on INADDR_ANY (0.0.0.0), meaning it listens on all interfaces.
  38
  39 .TP
  40 .B port
  41 Specify which UDP port xl2tpd should use. The default is 1701.
  42
  43 .TP
  44 .B access control
  45 If set to yes, the xl2tpd process will only accept connections from
  46 peers addresses specified in the following sections. The default is no.
  47
  48 .TP
  49 .B debug avp
  50 Set this to yes to enable syslog output of L2TP AVP debugging information.
  51
  52 .TP
  53 .B debug network
  54 Set this to yes to enable syslog output of network debugging information.
  55
  56 .TP
  57 .B debug packet
  58 Set this to yes to enable printing of L2TP packet debugging information.
  59 Note: Output goes to STDOUT, so use this only in conjunction with the
  60 .B -D
  61 command line option.
  62
  63 .TP
  64 .B debug state
  65 Set this to yes to enable syslog output of FSM debugging information.
  66
  67 .TP
  68 .B debug tunnel
  69 Set this to yes to enable syslog output of tunnel debugging information.
  70
  71 .SH "LNS SECTION"
  72 .TP
  73 .B exclusive
  74 If set to yes, only one control tunnel will be allowed to be built
  75 between 2 peers. CHECK
  76
  77 .TP
  78 .B (no) ip range
  79 Specify the range of ip addresses the LNS will assign to the connecting
  80 LAC PPP tunnels. Multiple ranges can be defined. Using the 'no'
  81 statement disallows the use of that particular range.  Ranges are defined
  82 using the format IP \- IP (example: 1.1.1.1 \- 1.1.1.10).  Note that either
  83 at least one
  84 .B ip range
  85 option must be given, or you must set
  86 .B assign ip
  87 to no.
  88
  89 .TP
  90 .B assign ip
  91 Set this to no if xl2tpd should not assign IP addresses out of the pool
  92 defined with the
  93 .B ip range
  94 option.  This can be useful if you have some other means to assign IP
  95 addresses, e. g. a pppd that supports RADIUS AAA.
  96
  97
  98 .TP
  99 .B (no) lac
 100 Specify the ip addresses of LAC's which are allowed to connect to xl2tpd
 101 acting as a LNS. The format is the same as the
 102 .B ip range
 103 option.
 104
 105 .TP
 106 .B hidden bit
 107 If set to yes, xl2tpd will use the AVP hiding feature of L2TP. To get
 108 more information about hidden AVP's and AVP in general, refer to rfc2661
 109 (add URL?)
 110
 111 .TP
 112 .B local ip
 113 Use the following IP as xl2tpd's own ip address.
 114
 115 .TP
 116 .B length bit
 117 If set to yes, the length bit present in the l2tp packet payload
 118 will be used.
 119
 120 .TP
 121 .B (refuse | require) chap
 122 Will require or refuse the remote peer to get authenticated via CHAP for the
 123 ppp authentication.
 124
 125 .TP
 126 .B (refuse | require) pap
 127 Will require or refuse the remote peer to get authenticated via PAP for the
 128 ppp authentication.
 129
 130 .TP
 131 .B (refuse | require) authentication
 132 Will require or refuse the remote peer to authenticate itself.
 133
 134 .TP
 135 .B unix authentication
 136 If set to yes, /etc/passwd will be used for remote peer ppp authentication.
 137
 138 .TP
 139 .B hostname
 140 Will report this as the xl2tpd hostname in negociation.
 141
 142 .TP
 143 .B ppp debug
 144 This will enable the debug for pppd.
 145
 146 .TP
 147 .B pppoptfile
 148 Specify the path for a file which contains pppd configuration parameters
 149 to be used.
 150
 151 .TP
 152 .B call rws
 153 This option is deprecated and no longer functions.  It used to be used
 154 to define the flow control window size for individual L2TP calls or
 155 sessions.  The L2TP standard (RFC2661) no longer defines flow control or
 156 window sizes on calls or sessions.
 157
 158 .TP
 159 .B tunnel rws
 160 This defines the window size of the control channel.  The window size is
 161 defined as the number of outstanding unacknowledged packets, not as a
 162 number of bytes.
 163
 164 .TP
 165 .B flow bits
 166 If set to yes, sequence numbers will be included in the communication.
 167 The feature to use sequence numbers in sessions is currently broken and
 168 does not function.
 169
 170 .TP
 171 .B challenge
 172 If set to yes, use challenge authentication to authenticate peer.
 173
 174 .TP
 175 .B rx bps
 176 If set, the receive bandwidth maximum will be set to this value
 177
 178 .TP
 179 .B tx bps
 180 If set, the transmit bandwidth maximum will be set to this value
 181
 182 .SH "LAC SECTION"
 183 The following are LAC specific configuration flags. Most of those
 184 described in the LNS section may be used in a LAC context, where
 185 it make common sense (essentially l2tp procotols tuning flags and
 186 authentication / ppp related ones).
 187
 188 .TP
 189 .B lns
 190 Set the dns name or ip address of the LNS to connect to.
 191
 192 .TP
 193 .B redial
 194 If set to yes, xl2tpd will attempts to redial if the call get disconected.
 195
 196 .TP
 197 .B redial timeout
 198 Wait X seconds before redial. The redial option must be set to yes
 199 to use this option.
 200
 201 .TP
 202 .B max redial
 203 Will give up redial tries after X attempts.
 204
 205 .SH "FILES"
 206
 207 \fB\fR/etc/xl2tpd/xl2tpd.conf \fB\fR/etc/xl2tpd/l2tp\-secrets
 208 \fB\fR/var/run/xl2tpd/l2tp\-control
 209 .SH "BUGS"
 210
 211 Please address bugs and comment to xl2tpd\-dev@xelerance.com
 212 .SH "SEE ALSO"
 213
 214 \fB\fRxl2tpd(8)
 215 .SH "AUTHORS"
 216 Forked from xl2tpd by Xelerance (http://www.xelerance.com/software/xl2tpd/
 217
 218 Michael Richardson <mcr@xelerance.com>
 219 Paul Wouters <paul@xelerance.com>
 220
 221 Many thanks to Jacco de Leeuw <jacco2@dds.nl> for maintaining l2tpd.
 222
 223
 224 Previous development was hosted at sourceforge
 225 (http://www.sourceforge.net/projects/l2tpd) by:
 226 .P
 227 Scott Balmos <sbalmos@iglou.com>
 228 .br
 229 David Stipp <dstipp@one.net>
 230 .br
 231 Jeff McAdams <jeffm@iglou.com>
 232
 233
 234 Based off of l2tpd version 0.60
 235 .br
 236 Copyright (C)1998 Adtran, Inc.
 237 .br
 238 Mark Spencer <markster@marko.net>