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