summaryrefslogtreecommitdiff
path: root/interface-definitions/vpn-openconnect.xml.in
blob: 75c64a99a30da15724d0bb4fb0bf4da8b7603cdc (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="vpn">
    <children>
      <node name="openconnect" owner="${vyos_conf_scripts_dir}/vpn_openconnect.py">
        <properties>
          <help>SSL VPN OpenConnect, AnyConnect compatible server</help>
          <priority>901</priority>
        </properties>
        <children>
          <node name="accounting">
            <properties>
              <help>Accounting for users OpenConnect VPN Sessions</help>
            </properties>
            <children>
              <node name="mode">
                <properties>
                  <help>Accounting mode used by this server</help>
                </properties>
                <children>
                  <leafNode name="radius">
                    <properties>
                      <help>Use RADIUS server for accounting</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              #include <include/radius-acct-server-ipv4.xml.i>
            </children>
          </node>
          <node name="authentication">
            <properties>
              <help>Authentication for remote access SSL VPN Server</help>
            </properties>
            <children>
              <node name="mode">
                <properties>
                  <help>Authentication mode used by this server</help>
                </properties>
                <children>
                  <leafNode name="local">
                    <properties>
                      <help>Use local username/password configuration (OTP supported)</help>
                      <valueHelp>
                        <format>password</format>
                        <description>Password-only local authentication</description>
                      </valueHelp>
                      <valueHelp>
                        <format>otp</format>
                        <description>OTP-only local authentication</description>
                      </valueHelp>
                      <valueHelp>
                        <format>password-otp</format>
                        <description>Password (first) + OTP local authentication</description>
                      </valueHelp>
                      <constraint>
                        <regex>(password|otp|password-otp)</regex>
                      </constraint>
                      <constraintErrorMessage>Invalid authentication mode. Must be one of: password, otp or password-otp </constraintErrorMessage>
                      <completionHelp>
                        <list>otp password password-otp</list>
                      </completionHelp>
                    </properties>
                  </leafNode>
                  <leafNode name="radius">
                    <properties>
                      <help>Use RADIUS server for user autentication</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="identity-based-config">
                <properties>
                  <help>Include configuration file by username or RADIUS group attribute</help>
                </properties>
                <children>
                  #include <include/generic-disable-node.xml.i>
                  <leafNode name="mode">
                    <properties>
                      <help>Select per user or per group configuration file - ignored if authentication group is configured</help>
                      <completionHelp>
                        <list>user group</list>
                      </completionHelp>
                      <valueHelp>
                        <format>user</format>
                        <description>Match configuration file on username</description>
                      </valueHelp>
                      <valueHelp>
                        <format>group</format>
                        <description>Match RADIUS response class attribute as file name</description>
                      </valueHelp>
                      <constraint>
                        <regex>(user|group)</regex>
                      </constraint>
                      <constraintErrorMessage>Invalid mode, must be either user or group</constraintErrorMessage>
                    </properties>
                  </leafNode>
                  <leafNode name="directory">
                    <properties>
                      <help>Directory to containing configuration files</help>
                      <valueHelp>
                        <format>path</format>
                        <description>Path to configuration directory, must be under /config/auth</description>
                      </valueHelp>
                      <constraint>
                        <validator name="file-path" argument="--directory --parent-dir /config/auth --strict"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="default-config">
                    <properties>
                      <help>Default configuration if discrete config could not be found</help>
                      <valueHelp>
                        <format>filename</format>
                        <description>Default configuration filename, must be under /config/auth</description>
                      </valueHelp>
                      <constraint>
                        <validator name="file-path" argument="--file --parent-dir /config/auth --strict"/>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="group">
                <properties>
                  <help>Group that a client is allowed to select (from a list). Maps to RADIUS Class attribute.</help>
                  <valueHelp>
                    <format>txt</format>
                    <description>Group string. The group may be followed by a user-friendly name in brackets: group1[First Group]</description>
                  </valueHelp>
                  <multi/>
                </properties>
              </leafNode>
              #include <include/auth-local-users.xml.i>
              <node name="local-users">
                <children>
                  <tagNode name="username">
                    <children>
                        <node name="otp">
                          <properties>
                            <help>2FA OTP authentication parameters</help>
                          </properties>
                          <children>
                            <leafNode name="key">
                              <properties>
                                <help>Token Key Secret key for the token algorithm (see RFC 4226)</help>
                                <valueHelp>
                                  <format>txt</format>
                                  <description>OTP key in hex-encoded format</description>
                                </valueHelp>
                                <constraint>
                                  <regex>[a-fA-F0-9]{20,10000}</regex>
                                </constraint>
                                <constraintErrorMessage>Key name must only include hex characters and be at least 20 characters long</constraintErrorMessage>
                              </properties>
                            </leafNode>
                            <leafNode name="otp-length">
                              <properties>
                                <help>Number of digits in OTP code</help>
                                <valueHelp>
                                  <format>u32:6-8</format>
                                  <description>Number of digits in OTP code</description>
                                </valueHelp>
                                <constraint>
                                  <validator name="numeric" argument="--range 6-8"/>
                                </constraint>
                                <constraintErrorMessage>Number of digits in OTP code must be between 6 and 8</constraintErrorMessage>
                              </properties>
                              <defaultValue>6</defaultValue>
                            </leafNode>
                            <leafNode name="interval">
                              <properties>
                                <help>Time tokens interval in seconds</help>
                                <valueHelp>
                                  <format>u32:5-86400</format>
                                  <description>Time tokens interval in seconds.</description>
                                </valueHelp>
                                <constraint>
                                  <validator name="numeric" argument="--range 5-86400"/>
                                </constraint>
                                <constraintErrorMessage>Time token interval must be between 5 and 86400 seconds</constraintErrorMessage>
                              </properties>
                              <defaultValue>30</defaultValue>
                            </leafNode>
                            <leafNode name="token-type">
                              <properties>
                                <help>Token type</help>
                                <valueHelp>
                                  <format>hotp-time</format>
                                  <description>Time-based OTP algorithm</description>
                                </valueHelp>
                                <valueHelp>
                                  <format>hotp-event</format>
                                  <description>Event-based OTP algorithm</description>
                                </valueHelp>
                                <constraint>
                                  <regex>(hotp-time|hotp-event)</regex>
                                </constraint>
                                <completionHelp>
                                  <list>hotp-time hotp-event</list>
                                </completionHelp>
                              </properties>
                              <defaultValue>hotp-time</defaultValue>
                            </leafNode>
                          </children>
                        </node>
                    </children>
                  </tagNode>
                </children>
              </node>
              #include <include/radius-auth-server-ipv4.xml.i>
              <node name="radius">
                <children>
                  #include <include/radius-timeout.xml.i>
                  <leafNode name="groupconfig">
                    <properties>
                      <help>If the groupconfig option is set, then config-per-user will be overriden, and all configuration will be read from RADIUS.</help>
                    </properties>
                  </leafNode>
                </children>
              </node>
            </children>
          </node>
          #include <include/listen-address-ipv4-single.xml.i>
          <leafNode name="listen-address">
            <defaultValue>0.0.0.0</defaultValue>
          </leafNode>
          <node name="listen-ports">
            <properties>
              <help>Specify custom ports to use for client connections</help>
            </properties>
            <children>
              <leafNode name="tcp">
                <properties>
                  <help>tcp port number to accept connections</help>
                  <valueHelp>
                    <format>u32:1-65535</format>
                    <description>Numeric IP port</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-65535"/>
                  </constraint>
                </properties>
                <defaultValue>443</defaultValue>
              </leafNode>
              <leafNode name="udp">
                <properties>
                  <help>udp port number to accept connections</help>
                  <valueHelp>
                    <format>u32:1-65535</format>
                    <description>Numeric IP port</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-65535"/>
                  </constraint>
                </properties>
                <defaultValue>443</defaultValue>
              </leafNode>
            </children>
          </node>
          <node name="ssl">
            <properties>
              <help>SSL Certificate, SSL Key and CA</help>
            </properties>
            <children>
              #include <include/pki/ca-certificate.xml.i>
              #include <include/pki/certificate-key.xml.i>
            </children>
          </node>
          <node name="network-settings">
            <properties>
              <help>Network settings</help>
            </properties>
            <children>
              <leafNode name="push-route">
                <properties>
                  <help>Route to be pushed to the client</help>
                  <valueHelp>
                    <format>ipv4net</format>
                    <description>IPv4 network and prefix length</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv6net</format>
                    <description>IPv6 network and prefix length</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ip-prefix"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
              <node name="client-ip-settings">
                <properties>
                  <help>Client IP pools settings</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>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="client-ipv6-pool">
                <properties>
                  <help>Pool of client IPv6 addresses</help>
                </properties>
                <children>
                  <leafNode name="prefix">
                    <properties>
                      <help>Pool of addresses used to assign to clients</help>
                      <valueHelp>
                        <format>ipv6net</format>
                        <description>IPv6 address and prefix length</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv6-prefix"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="mask">
                    <properties>
                      <help>Prefix length used for individual client</help>
                      <valueHelp>
                        <format>u32:48-128</format>
                        <description>Client prefix length</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 48-128"/>
                      </constraint>
                    </properties>
                    <defaultValue>64</defaultValue>
                  </leafNode>
                </children>
              </node>
              #include <include/name-server-ipv4-ipv6.xml.i>
              <leafNode name="split-dns">
                <properties>
                  <help>Domains over which the provided DNS should be used</help>
                  <valueHelp>
                    <format>txt</format>
                    <description>Client prefix length</description>
                  </valueHelp>
                  <constraint>
                    <validator name="fqdn"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
              <leafNode name="tunnel-all-dns">
                <properties>
                  <help>If the tunnel-all-dns option is set to yes, tunnel all DNS queries via the VPN. This is the default when a default route is set.</help>
                  <completionHelp>
                    <list>yes no</list>
                  </completionHelp>
                  <valueHelp>
                    <format>yes</format>
                    <description>Enable tunneling of all DNS traffic</description>
                  </valueHelp>
                  <valueHelp>
                    <format>no</format>
                    <description>Disable tunneling of all DNS traffic</description>
                  </valueHelp>
                  <constraint>
                    <regex>(yes|no)</regex>
                  </constraint>
                </properties>
                <defaultValue>no</defaultValue>
              </leafNode>
            </children>
          </node>
      </children>
    </node>
  </children>
</node>
</interfaceDefinition>