summaryrefslogtreecommitdiff
path: root/interface-definitions/system-conntrack.xml.in
blob: 88f96a0780cea0e92faf7a202428772c4c491ba4 (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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="system">
    <children>
      <node name="conntrack" owner="${vyos_conf_scripts_dir}/conntrack.py">
        <properties>
          <help>Connection Tracking Engine Options</help>
          <!-- Before NAT and conntrack-sync are configured -->
          <priority>218</priority>
        </properties>
        <children>
          <leafNode name="expect-table-size">
            <properties>
              <help>Size of connection tracking expect table</help>
              <valueHelp>
                <format>u32:1-50000000</format>
                <description>Number of entries allowed in connection tracking expect table</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-50000000"/>
              </constraint>
            </properties>
            <defaultValue>2048</defaultValue>
          </leafNode>
          <leafNode name="hash-size">
            <properties>
              <help>Hash size for connection tracking table</help>
              <valueHelp>
                <format>u32:1-50000000</format>
                <description>Size of hash to use for connection tracking table</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-50000000"/>
              </constraint>
            </properties>
            <defaultValue>32768</defaultValue>
          </leafNode>
          <node name="ignore">
            <properties>
              <help>Customized rules to ignore selective connection tracking</help>
            </properties>
            <children>
              <tagNode name="rule">
                <properties>
                  <help>Rule number</help>
                  <valueHelp>
                    <format>u32:1-999999</format>
                    <description>Number of conntrack ignore rule</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-999999"/>
                  </constraint>
                  <constraintErrorMessage>Ignore rule number must be between 1 and 999999</constraintErrorMessage>
                </properties>
                <children>
                  #include <include/generic-description.xml.i>
                  <node name="destination">
                    <properties>
                      <help>Destination parameters</help>
                    </properties>
                    <children>
                      #include <include/nat-address.xml.i>
                      #include <include/nat-port.xml.i>
                    </children>
                  </node>
                  <leafNode name="inbound-interface">
                    <properties>
                      <help>Interface to ignore connections tracking on</help>
                      <completionHelp>
                        <list>any</list>
                        <script>${vyos_completion_dir}/list_interfaces.py</script>
                      </completionHelp>
                    </properties>
                  </leafNode>
                  #include <include/ip-protocol.xml.i>
                  <leafNode name="protocol">
                    <properties>
                      <help>Protocol to match (protocol name, number, or "all")</help>
                      <completionHelp>
                        <script>${vyos_completion_dir}/list_protocols.sh</script>
                        <list>all tcp_udp</list>
                      </completionHelp>
                      <valueHelp>
                        <format>all</format>
                        <description>All IP protocols</description>
                      </valueHelp>
                      <valueHelp>
                        <format>tcp_udp</format>
                        <description>Both TCP and UDP</description>
                      </valueHelp>
                      <valueHelp>
                        <format>u32:0-255</format>
                        <description>IP protocol number</description>
                      </valueHelp>
                      <valueHelp>
                        <format>&lt;protocol&gt;</format>
                        <description>IP protocol name</description>
                      </valueHelp>
                      <valueHelp>
                        <format>!&lt;protocol&gt;</format>
                        <description>IP protocol name</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ip-protocol"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <node name="source">
                    <properties>
                      <help>Source parameters</help>
                    </properties>
                    <children>
                      #include <include/nat-address.xml.i>
                      #include <include/nat-port.xml.i>
                    </children>
                  </node>
                </children>
              </tagNode>
            </children>
          </node>
          <node name="log">
            <properties>
              <help>Log connection tracking events per protocol</help>
            </properties>
            <children>
              <node name="icmp">
                <properties>
                  <help>Log connection tracking events for ICMP</help>
                </properties>
                <children>
                  #include <include/conntrack/log-common.xml.i>
                </children>
              </node>
              <node name="other">
                <properties>
                  <help>Log connection tracking events for all protocols other than TCP, UDP and ICMP</help>
                </properties>
                <children>
                  #include <include/conntrack/log-common.xml.i>
                </children>
              </node>
              <node name="tcp">
                <properties>
                  <help>Log connection tracking events for TCP</help>
                </properties>
                <children>
                  #include <include/conntrack/log-common.xml.i>
                </children>
              </node>
              <node name="udp">
                <properties>
                  <help>Log connection tracking events for UDP</help>
                </properties>
                <children>
                  #include <include/conntrack/log-common.xml.i>
                </children>
              </node>
            </children>
          </node>
          <node name="modules">
            <properties>
              <help>Connection tracking modules</help>
            </properties>
            <children>
              <leafNode name="ftp">
                <properties>
                  <help>FTP connection tracking</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="h323">
                <properties>
                  <help>H.323 connection tracking</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="nfs">
                <properties>
                  <help>NFS connection tracking</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="pptp">
                <properties>
                  <help>PPTP connection tracking</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="sip">
                <properties>
                  <help>SIP connection tracking</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="sqlnet">
                <properties>
                  <help>SQLnet connection tracking</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="tftp">
                <properties>
                  <help>TFTP connection tracking</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </node>
          <leafNode name="table-size">
            <properties>
              <help>Size of connection tracking table</help>
              <valueHelp>
                <format>u32:1-50000000</format>
                <description>Number of entries allowed in connection tracking table</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-50000000"/>
              </constraint>
            </properties>
            <defaultValue>262144</defaultValue>
          </leafNode>
          <node name="tcp">
            <properties>
              <help>TCP options</help>
            </properties>
            <children>
              <leafNode name="half-open-connections">
                <properties>
                  <help>Maximum number of TCP half-open connections</help>
                  <valueHelp>
                    <format>u32:1-2147483647</format>
                    <description>Generic connection timeout in seconds</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-2147483647"/>
                  </constraint>
                </properties>
                <defaultValue>512</defaultValue>
              </leafNode>
              <leafNode name="loose">
                <properties>
                  <help>Policy to track previously established connections</help>
                  <completionHelp>
                    <list>enable disable</list>
                  </completionHelp>
                  <valueHelp>
                    <format>enable</format>
                    <description>Allow tracking of previously established connections</description>
                  </valueHelp>
                  <valueHelp>
                    <format>disable</format>
                    <description>Do not allow tracking of previously established connections</description>
                  </valueHelp>
                  <constraint>
                    <regex>^(enable|disable)$</regex>
                  </constraint>
                </properties>
                <defaultValue>enable</defaultValue>
              </leafNode>
              <leafNode name="max-retrans">
                <properties>
                  <help>TCP maximum retransmit attempts</help>
                  <valueHelp>
                    <format>u32:1-2147483647</format>
                    <description>Generic connection timeout in seconds</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-2147483647"/>
                  </constraint>
                </properties>
                <defaultValue>3</defaultValue>
              </leafNode>
            </children>
          </node>
          <node name="timeout">
            <properties>
              <help>Connection timeout options</help>
            </properties>
            <children>
              <node name="custom">
                <properties>
                  <help>Define custom timeouts per connection</help>
                </properties>
                <children>
                  <tagNode name="rule">
                    <properties>
                      <help>Rule number</help>
                      <valueHelp>
                        <format>u32:1-999999</format>
                        <description>Number of conntrack rule</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-999999"/>
                      </constraint>
                      <constraintErrorMessage>Ignore rule number must be between 1 and 999999</constraintErrorMessage>
                    </properties>
                    <children>
                      #include <include/generic-description.xml.i>
                      <node name="destination">
                        <properties>
                          <help>Destination parameters</help>
                        </properties>
                        <children>
                          #include <include/nat-address.xml.i>
                          #include <include/nat-port.xml.i>
                        </children>
                      </node>
                      <leafNode name="inbound-interface">
                        <properties>
                          <help>Interface to ignore connections tracking on</help>
                          <completionHelp>
                            <list>any</list>
                            <script>${vyos_completion_dir}/list_interfaces.py</script>
                          </completionHelp>
                        </properties>
                      </leafNode>
                      #include <include/ip-protocol.xml.i>
                      <leafNode name="protocol">
                        <properties>
                          <help>Protocol to match (protocol name, number, or "all")</help>
                          <completionHelp>
                            <script>${vyos_completion_dir}/list_protocols.sh</script>
                            <list>all tcp_udp</list>
                          </completionHelp>
                          <valueHelp>
                            <format>all</format>
                            <description>All IP protocols</description>
                          </valueHelp>
                          <valueHelp>
                            <format>tcp_udp</format>
                            <description>Both TCP and UDP</description>
                          </valueHelp>
                          <valueHelp>
                            <format>u32:0-255</format>
                            <description>IP protocol number</description>
                          </valueHelp>
                          <valueHelp>
                            <format>&lt;protocol&gt;</format>
                            <description>IP protocol name</description>
                          </valueHelp>
                          <valueHelp>
                            <format>!&lt;protocol&gt;</format>
                            <description>IP protocol name</description>
                          </valueHelp>
                          <constraint>
                            <validator name="ip-protocol"/>
                          </constraint>
                        </properties>
                      </leafNode>
                      <node name="source">
                        <properties>
                          <help>Source parameters</help>
                        </properties>
                        <children>
                          #include <include/nat-address.xml.i>
                          #include <include/nat-port.xml.i>
                        </children>
                      </node>
                    </children>
                  </tagNode>
                </children>
              </node>
              <leafNode name="icmp">
                <properties>
                  <help>ICMP timeout in seconds</help>
                  <valueHelp>
                    <format>u32:1-21474836</format>
                    <description>ICMP timeout in seconds</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-21474836"/>
                  </constraint>
                </properties>
                <defaultValue>30</defaultValue>
              </leafNode>
              <leafNode name="other">
                <properties>
                  <help>Generic connection timeout in seconds</help>
                  <valueHelp>
                    <format>u32:1-21474836</format>
                    <description>Generic connection timeout in seconds</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-21474836"/>
                  </constraint>
                </properties>
                <defaultValue>600</defaultValue>
              </leafNode>
              <node name="tcp">
                <properties>
                  <help>TCP connection timeout options</help>
                </properties>
                <children>
                  <leafNode name="close-wait">
                    <properties>
                      <help>TCP CLOSE-WAIT timeout in seconds</help>
                      <valueHelp>
                        <format>u32:1-21474836</format>
                        <description>TCP CLOSE-WAIT timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-21474836"/>
                      </constraint>
                    </properties>
                    <defaultValue>60</defaultValue>
                  </leafNode>
                  <leafNode name="close">
                    <properties>
                      <help>TCP CLOSE timeout in seconds</help>
                      <valueHelp>
                        <format>u32:1-21474836</format>
                        <description>TCP CLOSE timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-21474836"/>
                      </constraint>
                    </properties>
                    <defaultValue>10</defaultValue>
                  </leafNode>
                  <leafNode name="established">
                    <properties>
                      <help>TCP ESTABLISHED timeout in seconds</help>
                      <valueHelp>
                        <format>u32:1-21474836</format>
                        <description>TCP ESTABLISHED timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-21474836"/>
                      </constraint>
                    </properties>
                    <defaultValue>432000</defaultValue>
                  </leafNode>
                  <leafNode name="fin-wait">
                    <properties>
                      <help>TCP FIN-WAIT timeout in seconds</help>
                      <valueHelp>
                        <format>u32:1-21474836</format>
                        <description>TCP FIN-WAIT timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-21474836"/>
                      </constraint>
                    </properties>
                    <defaultValue>120</defaultValue>
                  </leafNode>
                  <leafNode name="last-ack">
                    <properties>
                      <help>TCP LAST-ACK timeout in seconds</help>
                      <valueHelp>
                        <format>u32:1-21474836</format>
                        <description>TCP LAST-ACK timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-21474836"/>
                      </constraint>
                    </properties>
                    <defaultValue>30</defaultValue>
                  </leafNode>
                  <leafNode name="syn-recv">
                    <properties>
                      <help>TCP SYN-RECEIVED timeout in seconds</help>
                      <valueHelp>
                        <format>u32:1-21474836</format>
                        <description>TCP SYN-RECEIVED timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-21474836"/>
                      </constraint>
                    </properties>
                    <defaultValue>60</defaultValue>
                  </leafNode>
                  <leafNode name="syn-sent">
                    <properties>
                      <help>TCP SYN-SENT timeout in seconds</help>
                      <valueHelp>
                        <format>u32:1-21474836</format>
                        <description>TCP SYN-SENT timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-21474836"/>
                      </constraint>
                    </properties>
                    <defaultValue>120</defaultValue>
                  </leafNode>
                  <leafNode name="time-wait">
                    <properties>
                      <help>TCP TIME-WAIT timeout in seconds</help>
                      <valueHelp>
                        <format>u32:1-21474836</format>
                        <description>TCP TIME-WAIT timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-21474836"/>
                      </constraint>
                    </properties>
                    <defaultValue>120</defaultValue>
                  </leafNode>
                </children>
              </node>
              <node name="udp">
                <properties>
                  <help>UDP timeout options</help>
                </properties>
                <children>
                  <leafNode name="other">
                    <properties>
                      <help>UDP generic timeout in seconds</help>
                      <valueHelp>
                        <format>u32:1-21474836</format>
                        <description>UDP generic timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-21474836"/>
                      </constraint>
                    </properties>
                    <defaultValue>30</defaultValue>
                  </leafNode>
                  <leafNode name="stream">
                    <properties>
                      <help>UDP stream timeout in seconds</help>
                      <valueHelp>
                        <format>u32:1-21474836</format>
                        <description>UDP stream timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-21474836"/>
                      </constraint>
                    </properties>
                    <defaultValue>180</defaultValue>
                  </leafNode>
                </children>
              </node>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>