summaryrefslogtreecommitdiff
path: root/interface-definitions/vpn_l2tp.xml.in
blob: 6cb0d454459b90ad861c1799ab0b26f9781068be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="vpn">
    <children>
      <node name="l2tp" owner="${vyos_conf_scripts_dir}/vpn_l2tp.py">
        <properties>
          <help>L2TP Virtual Private Network (VPN)</help>
          <priority>902</priority>
        </properties>
        <children>
          <node name="remote-access">
            <properties>
              <help>Remote access L2TP VPN</help>
            </properties>
            <children>
              #include <include/accel-ppp/mtu-128-16384.xml.i>
              <leafNode name="outside-address">
                <properties>
                  <help>External IP address to which VPN clients will connect</help>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
              </leafNode>
              #include <include/accel-ppp/gateway-address.xml.i>
              #include <include/name-server-ipv4-ipv6.xml.i>
              <node name="lns">
                <properties>
                  <help>L2TP Network Server (LNS)</help>
                </properties>
                <children>
                  <leafNode name="shared-secret">
                    <properties>
                      <help>Tunnel password used to authenticate the client (LAC)</help>
                    </properties>
                  </leafNode>
                  <leafNode name="host-name">
                    <properties>
                      <help>Sent to the client (LAC) in the Host-Name attribute</help>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="ccp-disable">
                <properties>
                  <help>Disable Compression Control Protocol (CCP)</help>
                  <valueless />
                </properties>
              </leafNode>
              <node name="ipsec-settings">
                <properties>
                  <help>Internet Protocol Security (IPsec) for remote access L2TP VPN</help>
                </properties>
                <children>
                  <node name="authentication">
                    <properties>
                      <help>IPsec authentication settings</help>
                    </properties>
                    <children>
                      <leafNode name="mode">
                        <properties>
                          <help>Authentication mode for IPsec</help>
                          <valueHelp>
                            <format>pre-shared-secret</format>
                            <description>Use pre-shared secret for IPsec authentication</description>
                          </valueHelp>
                          <valueHelp>
                            <format>x509</format>
                            <description>Use X.509 certificate for IPsec authentication</description>
                          </valueHelp>
                          <constraint>
                            <regex>^(pre-shared-secret|x509)$</regex>
                          </constraint>
                          <completionHelp>
                            <list>pre-shared-secret x509</list>
                          </completionHelp>
                        </properties>
                      </leafNode>
                      #include <include/ipsec/authentication-pre-shared-secret.xml.i>
                      #include <include/ipsec/authentication-x509.xml.i>
                    </children>
                  </node>
                  <leafNode name="ike-lifetime">
                    <properties>
                      <help>IKE lifetime</help>
                      <valueHelp>
                        <format>u32:30-86400</format>
                        <description>IKE lifetime in seconds (default 3600)</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 30-86400"/>
                      </constraint>
                    </properties>
                    <defaultValue>3600</defaultValue>
                  </leafNode>
                   <leafNode name="lifetime">
                    <properties>
                      <help>ESP lifetime</help>
                      <valueHelp>
                        <format>u32:30-86400</format>
                        <description>IKE lifetime in seconds (default 3600)</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 30-86400"/>
                      </constraint>
                    </properties>
                    <defaultValue>3600</defaultValue>
                  </leafNode>
                  #include <include/ipsec/esp-group.xml.i>
                  #include <include/ipsec/ike-group.xml.i>
                </children>
              </node>
              #include <include/accel-ppp/wins-server.xml.i>
              <node name="client-ip-pool">
                <properties>
                  <help>Pool of client IP addresses (must be within a /24)</help>
                </properties>
                <children>
                  #include <include/accel-ppp/client-ip-pool-start-stop.xml.i>
                  #include <include/accel-ppp/client-ip-pool-subnet.xml.i>
                </children>
              </node>
              #include <include/accel-ppp/client-ipv6-pool.xml.i>
              <leafNode name="description">
                <properties>
                  <help>Description for L2TP remote-access settings</help>
                </properties>
              </leafNode>
              #include <include/dhcp-interface.xml.i>
              <leafNode name="idle">
                <properties>
                  <help>PPP idle timeout</help>
                  <valueHelp>
                    <format>u32:30-86400</format>
                    <description>PPP idle timeout in seconds (default 1800)</description>
                  </valueHelp>
                    <constraint>
                      <validator name="numeric" argument="--range 30-86400"/>
                    </constraint>
                </properties>
              </leafNode>
              <node name="authentication">
                <properties>
                  <help>Authentication for remote access L2TP VPN</help>
                </properties>
                <children>
                  <leafNode name="require">
                    <properties>
                      <help>Authentication protocol for remote access peer L2TP VPN</help>
                      <valueHelp>
                        <format>pap</format>
                        <description>Require the peer to authenticate itself using PAP [Password Authentication Protocol].</description>
                      </valueHelp>
                      <valueHelp>
                        <format>chap</format>
                        <description>Require the peer to authenticate itself using CHAP [Challenge Handshake Authentication Protocol].</description>
                      </valueHelp>
                      <valueHelp>
                        <format>mschap</format>
                        <description>Require the peer to authenticate itself using CHAP [Challenge Handshake Authentication Protocol].</description>
                      </valueHelp>
                      <valueHelp>
                        <format>mschap-v2</format>
                        <description>Require the peer to authenticate itself using MS-CHAPv2 [Microsoft Challenge Handshake Authentication Protocol, Version 2].</description>
                      </valueHelp>
                      <constraint>
                        <regex>^(pap|chap|mschap|mschap-v2)$</regex>
                      </constraint>
                      <completionHelp>
                        <list>pap chap mschap mschap-v2</list>
                      </completionHelp>
                      <multi />
                    </properties>
                  </leafNode>
                  #include <include/accel-ppp/ppp-mppe.xml.i>
                  #include <include/accel-ppp/auth-mode.xml.i>
                  #include <include/accel-ppp/auth-local-users.xml.i>
                  #include <include/radius-server-ipv4.xml.i>
                  <node name="radius">
                    <children>
                      <tagNode name="server">
                        <children>
                          #include <include/accel-ppp/radius-additions-disable-accounting.xml.i>
                          <leafNode name="fail-time">
                            <properties>
                              <help>Mark server unavailable for N seconds on failure</help>
                              <valueHelp>
                                <format>u32:0-600</format>
                                <description>Fail time penalty</description>
                              </valueHelp>
                              <constraint>
                                <validator name="numeric" argument="--range 0-600"/>
                              </constraint>
                              <constraintErrorMessage>Fail time must be between 0 and 600 seconds</constraintErrorMessage>
                            </properties>
                          </leafNode>
                        </children>
                      </tagNode>
                      <leafNode name="timeout">
                        <properties>
                          <help>Timeout to wait response from server (seconds)</help>
                        </properties>
                      </leafNode>
                      <leafNode name="acct-timeout">
                        <properties>
                          <help>Timeout to wait reply for Interim-Update packets. (default 3 seconds)</help>
                        </properties>
                      </leafNode>
                      <leafNode name="max-try">
                        <properties>
                          <help>Maximum number of tries to send Access-Request/Accounting-Request queries</help>
                        </properties>
                      </leafNode>
                      #include <include/radius-nas-identifier.xml.i>
                      <node name="dae-server">
                        <properties>
                          <help>IPv4 address and port to bind Dynamic Authorization Extension server (DM/CoA)</help>
                        </properties>
                        <children>
                          <leafNode name="ip-address">
                            <properties>
                              <help>IP address for Dynamic Authorization Extension server (DM/CoA)</help>
                            </properties>
                          </leafNode>
                          <leafNode name="port">
                            <properties>
                              <help>Port for Dynamic Authorization Extension server (DM/CoA)</help>
                            </properties>
                          </leafNode>
                          <leafNode name="secret">
                            <properties>
                              <help>Secret for Dynamic Authorization Extension server (DM/CoA)</help>
                            </properties>
                          </leafNode>
                        </children>
                      </node>
                      <node name="rate-limit">
                        <properties>
                          <help>Upload/Download speed limits</help>
                        </properties>
                        <children>
                          <leafNode name="attribute">
                            <properties>
                              <help>Specifies which radius attribute contains rate information. (default is Filter-Id)</help>
                            </properties>
                          </leafNode>
                          <leafNode name="vendor">
                            <properties>
                              <help>Specifies the vendor dictionary. (dictionary needs to be in /usr/share/accel-ppp/radius)</help>
                            </properties>
                          </leafNode>
                          <leafNode name="enable">
                            <properties>
                              <help>Enables Bandwidth shaping via RADIUS</help>
                              <valueless />
                            </properties>
                          </leafNode>
                        </children>
                      </node>
                    </children>
                  </node>
                </children>
              </node>
              <node name="ppp-options">
                <properties>
                  <help>Advanced protocol options</help>
                </properties>
                <children>
                  #include <include/accel-ppp/lcp-echo-interval-failure.xml.i>
                  #include <include/accel-ppp/ppp-options-ipv6.xml.i>
                </children>
              </node>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>