summaryrefslogtreecommitdiff
path: root/interface-definitions/vpn_sstp.xml.in
blob: b026417b32c86ce44ea6b77849782ca51f36ff0c (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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="vpn">
    <children>
      <node name="sstp" owner="${vyos_conf_scripts_dir}/vpn_sstp.py">
        <properties>
          <help>Secure Socket Tunneling Protocol (SSTP) server</help>
          <priority>901</priority>
        </properties>
        <children>
          <node name="authentication">
            <properties>
              <help>Authentication for remote access SSTP Server</help>
            </properties>
            <children>
              <node name="local-users">
                <properties>
                  <help>Local user authentication for SSTP server</help>
                </properties>
                <children>
                  <tagNode name="username">
                    <properties>
                      <help>User name for authentication</help>
                    </properties>
                    <children>
                      <leafNode name="disable">
                        <properties>
                          <help>Option to disable a SSTP Server user</help>
                          <valueless />
                        </properties>
                      </leafNode>
                      <leafNode name="password">
                        <properties>
                          <help>Password for authentication</help>
                        </properties>
                      </leafNode>
                      <leafNode name="static-ip">
                        <properties>
                          <help>Static client IP address</help>
                        </properties>
                      </leafNode>
                      <node name="rate-limit">
                        <properties>
                          <help>Upload/Download speed limits</help>
                        </properties>
                        <children>
                          <leafNode name="upload">
                            <properties>
                              <help>Upload bandwidth limit in kbits/sec</help>
                              <constraint>
                                <validator name="numeric" argument="--range 1-65535"/>
                              </constraint>
                            </properties>
                          </leafNode>
                          <leafNode name="download">
                            <properties>
                              <help>Download bandwidth limit in kbits/sec</help>
                              <constraint>
                                <validator name="numeric" argument="--range 1-65535"/>
                              </constraint>
                            </properties>
                          </leafNode>
                        </children>
                      </node>
                    </children>
                  </tagNode>
                </children>
              </node>
              <leafNode name="mode">
                <properties>
                  <help>Authentication mode for SSTP Server</help>
                  <valueHelp>
                    <format>local</format>
                    <description>Use local username/password configuration</description>
                  </valueHelp>
                  <valueHelp>
                    <format>radius</format>
                    <description>Use a RADIUS server to autenticate users</description>
                  </valueHelp>
                  <constraint>
                    <regex>(local|radius)</regex>
                  </constraint>
                  <completionHelp>
                    <list>local radius</list>
                  </completionHelp>
                </properties>
              </leafNode>
              <leafNode name="protocols">
                <properties>
                  <help>Authentication protocol for remote access peer SSTP VPN</help>
                  <completionHelp>
                    <list>pap chap mschap mschap-v2</list>
                  </completionHelp>
                  <valueHelp>
                    <format>pap</format>
                    <description>Authentication via PAP (Password Authentication Protocol)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>chap</format>
                    <description>Authentication via CHAP (Challenge Handshake Authentication Protocol)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>mschap</format>
                    <description>Authentication via MS-CHAP (Microsoft Challenge Handshake Authentication Protocol)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>mschap-v2</format>
                    <description>Authentication via MS-CHAPv2 (Microsoft Challenge Handshake Authentication Protocol, version 2)</description>
                  </valueHelp>
                  <constraint>
                    <regex>(pap|chap|mschap|mschap-v2)</regex>
                  </constraint>
                    <multi />
                </properties>
              </leafNode>
              #include <include/radius-server.xml.i>
              <node name="radius">
                <children>
                  <tagNode name="server">
                    <children>
                      <leafNode name="fail-time">
                        <properties>
                          <help>Mark server unavailable for &lt;n&gt; seconds on failure</help>
                          <valueHelp>
                            <format>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 in seconds to wait response from RADIUS server</help>
                      <valueHelp>
                        <format>1-60</format>
                        <description>Timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-60"/>
                      </constraint>
                      <constraintErrorMessage>Timeout must be between 1 and 60 seconds</constraintErrorMessage>
                    </properties>
                  </leafNode>
                  <leafNode name="acct-timeout">
                    <properties>
                      <help>Timeout for Interim-Update packets, terminate session afterwards (default 3 seconds)</help>
                      <valueHelp>
                        <format>0-60</format>
                        <description>Timeout in seconds, 0 to keep active</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-60"/>
                      </constraint>
                      <constraintErrorMessage>Timeout must be between 0 and 60 seconds</constraintErrorMessage>
                    </properties>
                  </leafNode>
                  <leafNode name="max-try">
                    <properties>
                      <help>Number of tries to send Access-Request/Accounting-Request queries</help>
                      <valueHelp>
                        <format>1-20</format>
                        <description>Maximum tries</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-20"/>
                      </constraint>
                      <constraintErrorMessage>Maximum tries must be between 1 and 20</constraintErrorMessage>
                    </properties>
                  </leafNode>
                  <leafNode name="nas-identifier">
                    <properties>
                      <help>NAS-Identifier attribute sent to RADIUS</help>
                    </properties>
                  </leafNode>
                  <leafNode name="nas-ip-address">
                    <properties>
                      <help>NAS-IP-Address attribute sent to RADIUS</help>
                       <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>NAS-IP-Address attribute</description>
                      </valueHelp>
                     </properties>
                   </leafNode>
                  <node name="dynamic-author">
                    <properties>
                      <help>Dynamic Authorization Extension/Change of Authorization server</help>
                    </properties>
                    <children>
                      <leafNode name="server">
                        <properties>
                          <help>IP address for Dynamic Authorization Extension server (DM/CoA)</help>
                          <constraint>
                            <validator name="ipv4-address"/>
                          </constraint>
                          <valueHelp>
                            <format>ipv4</format>
                            <description>IPv4 address for aynamic authorization server</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                      <leafNode name="port">
                        <properties>
                          <help>Port for Dynamic Authorization Extension server (DM/CoA)</help>
                          <valueHelp>
                            <format>number</format>
                            <description>TCP port</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-65535"/>
                          </constraint>
                        </properties>
                      </leafNode>
                      <leafNode name="key">
                        <properties>
                          <help>Shared secret for Dynamic Authorization Extension server</help>
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                  <node name="rate-limit">
                    <properties>
                      <help>Upload/Download speed limits</help>
                    </properties>
                    <children>
                      <leafNode name="attribute">
                        <properties>
                          <help>Specifies RADIUS attribute containing rate information (default 'Filter-Id')</help>
                        </properties>
                      </leafNode>
                      <leafNode name="vendor">
                        <properties>
                          <help>Specifies vendor dictionary (needs to be in /usr/share/accel-ppp/radius)</help>
                        </properties>
                      </leafNode>
                      <leafNode name="enable">
                        <properties>
                          <help>Enable RADIUS bandwidth shaping</help>
                          <valueless />
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                </children>
              </node>
            </children>
          </node>
          <node name="ssl">
            <properties>
              <help>SSL Certificate, SSL Key and CA (/config/user-data/sstp)</help>
            </properties>
            <children>
              <leafNode name="ca-cert-file">
                <properties>
                  <help>Certificate Authority certificate</help>
                  <valueHelp>
                    <format>file</format>
                    <description>File in /config/auth directory</description>
                  </valueHelp>
                  <constraint>
                    <validator name="file-exists" argument="--directory /config/auth"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="cert-file">
                <properties>
                  <help>Server Certificate</help>
                  <completionHelp>
                    <script>ls /config</script>
                  </completionHelp>
                  <constraint>
                    <validator name="file-exists" argument="--directory /config/auth"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="key-file">
                <properties>
                  <help>Privat Key of the Server Certificate</help>
                  <valueHelp>
                    <format>file</format>
                    <description>File in /config/auth directory</description>
                  </valueHelp>
                  <constraint>
                    <validator name="file-exists" argument="--directory /config/auth"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </node>
          <node name="network-settings">
            <properties>
              <help>Network settings</help>
            </properties>
            <children>
              <node name="client-ip-settings">
                <properties>
                  <help>Client IP pools and gateway setting</help>
                </properties>
                <children>
                  <leafNode name="subnet">
                    <properties>
                      <help>Client IP subnet (CIDR notation)</help>
                      <valueHelp>
                        <format>ipv4net</format>
                        <description>IPv4 address and prefix length</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv4-prefix"/>
                      </constraint>
                      <constraintErrorMessage>Not a valid CIDR formatted prefix</constraintErrorMessage>
                      <multi />
                    </properties>
                  </leafNode>
                  <leafNode name="gateway-address">
                    <properties>
                      <help>Gateway IP address</help>
                      <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                      <constraintErrorMessage>invalid IPv4 address</constraintErrorMessage>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>Default Gateway send to the client</description>
                      </valueHelp>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="name-server">
                <properties>
                  <help>DNS servers propagated to clients</help>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>IPv4 address</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                      <multi/>
                </properties>
              </leafNode>
              #include <include/interface-mtu-68-1500.xml.i>
            </children>
          </node>
          <node name="ppp-settings">
            <properties>
              <help>PPP (Point-to-Point Protocol) settings</help>
            </properties>
            <children>
              <leafNode name="mppe">
                <properties>
                  <help>Specifies mppe negotiation preferences</help>
                  <completionHelp>
                    <list>require prefer deny</list>
                  </completionHelp>
                  <constraint>
                    <regex>(^require|prefer|deny)</regex>
                  </constraint>
                  <valueHelp>
                    <format>require</format>
                    <description>send mppe request, if client rejects, drop the connection</description>
                  </valueHelp>
                  <valueHelp>
                    <format>prefer</format>
                    <description>send mppe request, if client rejects continue</description>
                  </valueHelp>
                  <valueHelp>
                    <format>deny</format>
                    <description>drop all mppe</description>
                  </valueHelp>
                </properties>
              </leafNode>
              <leafNode name="lcp-echo-interval">
                <properties>
                  <help>LCP echo-requests/sec</help>
                  <constraint>
                    <validator name="numeric" argument="--positive"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="lcp-echo-failure">
                <properties>
                  <help>Maximum number of Echo-Requests may be sent without valid reply</help>
                  <constraint>
                    <validator name="numeric" argument="--positive"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="lcp-echo-timeout">
                <properties>
                  <help>Timeout in seconds to wait for any peer activity. If this option specified it turns on adaptive lcp echo functionality and "lcp-echo-failure" is not used.</help>
                  <constraint>
                    <validator name="numeric" argument="--positive"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </node>
      </children>
    </node>
  </children>
</node>
</interfaceDefinition>