summaryrefslogtreecommitdiff
path: root/interface-definitions/firewall.xml.in
blob: f38bcfd9cdeed093afbce611fbd69836f3e4a8c6 (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
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="firewall" owner="${vyos_conf_scripts_dir}/firewall.py">
    <properties>
      <priority>199</priority>
      <help>Firewall</help>
    </properties>
    <children>
      <leafNode name="all-ping">
        <properties>
          <help>Policy for handling of all IPv4 ICMP echo requests</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable processing of all IPv4 ICMP echo requests</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable processing of all IPv4 ICMP echo requests</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>enable</defaultValue>
      </leafNode>
      <leafNode name="broadcast-ping">
        <properties>
          <help>Policy for handling broadcast IPv4 ICMP echo and timestamp requests</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable processing of broadcast IPv4 ICMP echo/timestamp requests</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable processing of broadcast IPv4 ICMP echo/timestamp requests</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>disable</defaultValue>
      </leafNode>
      <leafNode name="config-trap">
        <properties>
          <help>SNMP trap generation on firewall configuration changes</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable sending SNMP trap on firewall configuration change</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable sending SNMP trap on firewall configuration change</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>disable</defaultValue>
      </leafNode>
      <node name="group">
        <properties>
          <help>Firewall group</help>
        </properties>
        <children>
          <tagNode name="address-group">
            <properties>
              <help>Firewall address-group</help>
            </properties>
            <children>
              <leafNode name="address">
                <properties>
                  <help>Address-group member</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>IPv4 address to match</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv4range</format>
                    <description>IPv4 range to match (e.g. 10.0.0.1-10.0.0.200)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                    <validator name="ipv4-range"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
              #include <include/generic-description.xml.i>
            </children>
          </tagNode>
          <tagNode name="ipv6-address-group">
            <properties>
              <help>Firewall ipv6-address-group</help>
            </properties>
            <children>
              <leafNode name="address">
                <properties>
                  <help>Address-group member</help>
                  <valueHelp>
                    <format>ipv6</format>
                    <description>IPv6 address to match</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv6range</format>
                    <description>IPv6 range to match (e.g. 2002::1-2002::ff)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv6-address"/>
                    <validator name="ipv6-range"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
              #include <include/generic-description.xml.i>
            </children>
          </tagNode>
          <tagNode name="ipv6-network-group">
            <properties>
              <help>Firewall ipv6-network-group</help>
            </properties>
            <children>
              #include <include/generic-description.xml.i>
              <leafNode name="network">
                <properties>
                  <help>Network-group member</help>
                  <valueHelp>
                    <format>ipv6net</format>
                    <description>IPv6 address to match</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv6-prefix"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
            </children>
          </tagNode>
          <tagNode name="mac-group">
            <properties>
              <help>Firewall mac-group</help>
            </properties>
            <children>
              #include <include/generic-description.xml.i>
              <leafNode name="mac-address">
                <properties>
                  <help>Mac-group member</help>
                  <valueHelp>
                    <format>&lt;MAC address&gt;</format>
                    <description>MAC address to match</description>
                  </valueHelp>
                  <constraint>
                    <validator name="mac-address"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
            </children>
          </tagNode>
          <tagNode name="network-group">
            <properties>
              <help>Firewall network-group</help>
            </properties>
            <children>
              #include <include/generic-description.xml.i>
              <leafNode name="network">
                <properties>
                  <help>Network-group member</help>
                  <valueHelp>
                    <format>ipv4net</format>
                    <description>IPv4 Subnet to match</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-prefix"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
            </children>
          </tagNode>
          <tagNode name="port-group">
            <properties>
              <help>Firewall port-group</help>
            </properties>
            <children>
              #include <include/generic-description.xml.i>
              <leafNode name="port">
                <properties>
                  <help>Port-group member</help>
                  <valueHelp>
                    <format>txt</format>
                    <description>Named port (any name in /etc/services, e.g., http)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>u32:1-65535</format>
                    <description>Numbered port</description>
                  </valueHelp>
                  <valueHelp>
                    <format>start-end</format>
                    <description>Numbered port range (e.g. 1001-1050)</description>
                  </valueHelp>
                  <multi/>
                  <constraint>
                    <validator name="port-range"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </node>
      <leafNode name="ip-src-route">
        <properties>
          <help>Policy for handling IPv4 packets with source route option</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable processing of IPv4 packets with source route option</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable processing of IPv4 packets with source route option</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>disable</defaultValue>
      </leafNode>
      <tagNode name="ipv6-name">
        <properties>
          <help>IPv6 firewall rule-set name</help>
        </properties>
        <children>
          #include <include/firewall/name-default-action.xml.i>
          #include <include/firewall/name-default-log.xml.i>
          #include <include/generic-description.xml.i>
          <tagNode name="rule">
            <properties>
              <help>Firewall rule number (IPv6)</help>
              <valueHelp>
                <format>u32:1-999999</format>
                <description>Number for this Firewall rule</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-999999"/>
              </constraint>
              <constraintErrorMessage>Firewall rule number must be between 1 and 999999</constraintErrorMessage>
            </properties>
            <children>
              #include <include/firewall/action.xml.i>
              #include <include/generic-description.xml.i>
              <node name="destination">
                <properties>
                  <help>Destination parameters</help>
                </properties>
                <children>
                  #include <include/firewall/address-ipv6.xml.i>
                  #include <include/firewall/source-destination-group-ipv6.xml.i>
                  #include <include/firewall/port.xml.i>
                </children>
              </node>
              <node name="source">
                <properties>
                  <help>Source parameters</help>
                </properties>
                <children>
                  #include <include/firewall/address-ipv6.xml.i>
                  #include <include/firewall/source-destination-group-ipv6.xml.i>
                  #include <include/firewall/port.xml.i>
                </children>
              </node>
              #include <include/firewall/common-rule.xml.i>
              <node name="hop-limit">
                <properties>
                  <help>Hop Limit</help>
                </properties>
                <children>
                  <leafNode name="eq">
                    <properties>
                      <help>Value to match a hop limit equal to it</help>
                      <valueHelp>
                        <format>u32:0-255</format>
                        <description>Hop limit equal to value</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-255"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="gt">
                    <properties>
                      <help>Value to match a hop limit greater than or equal to it</help>
                      <valueHelp>
                        <format>u32:0-255</format>
                        <description>Hop limit greater than value</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-255"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="lt">
                    <properties>
                      <help>Value to match a hop limit less than or equal to it</help>
                      <valueHelp>
                        <format>u32:0-255</format>
                        <description>Hop limit less than value</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-255"/>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="icmpv6">
                <properties>
                  <help>ICMPv6 type and code information</help>
                </properties>
                <children>
                  <leafNode name="code">
                    <properties>
                      <help>ICMPv6 code (0-255)</help>
                      <valueHelp>
                        <format>u32:0-255</format>
                        <description>ICMPv6 code (0-255)</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-255"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="type">
                    <properties>
                      <help>ICMPv6 type (0-255)</help>
                      <valueHelp>
                        <format>u32:0-255</format>
                        <description>ICMPv6 type (0-255)</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-255"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  #include <include/firewall/icmpv6-type-name.xml.i>
                </children>
              </node>
            </children>
          </tagNode>
        </children>
      </tagNode>
      <leafNode name="ipv6-receive-redirects">
        <properties>
          <help>Policy for handling received ICMPv6 redirect messages</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable processing of received ICMPv6 redirect messages</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable processing of received ICMPv6 redirect messages</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>disable</defaultValue>
      </leafNode>
      <leafNode name="ipv6-src-route">
        <properties>
          <help>Policy for handling IPv6 packets with routing extension header</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable processing of IPv6 packets with routing header type 2</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable processing of IPv6 packets with routing header</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>disable</defaultValue>
      </leafNode>
      <leafNode name="log-martians">
        <properties>
          <help>Policy for logging IPv4 packets with invalid addresses</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable logging of IPv4 packets with invalid addresses</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable logging of Ipv4 packets with invalid addresses</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>enable</defaultValue>
      </leafNode>
      <tagNode name="name">
        <properties>
          <help>IPv4 firewall rule-set name</help>
        </properties>
        <children>
          #include <include/firewall/name-default-action.xml.i>
          #include <include/firewall/name-default-log.xml.i>
          #include <include/generic-description.xml.i>
          <tagNode name="rule">
            <properties>
              <help>Firewall rule number (IPv4)</help>
              <valueHelp>
                <format>u32:1-999999</format>
                <description>Number for this Firewall rule</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-999999"/>
              </constraint>
              <constraintErrorMessage>Firewall rule number must be between 1 and 999999</constraintErrorMessage>
            </properties>
            <children>
              #include <include/firewall/action.xml.i>
              #include <include/generic-description.xml.i>
              <node name="destination">
                <properties>
                  <help>Destination parameters</help>
                </properties>
                <children>
                  #include <include/firewall/address.xml.i>
                  #include <include/firewall/source-destination-group.xml.i>
                  #include <include/firewall/port.xml.i>
                </children>
              </node>
              <node name="source">
                <properties>
                  <help>Source parameters</help>
                </properties>
                <children>
                  #include <include/firewall/address.xml.i>
                  #include <include/firewall/source-destination-group.xml.i>
                  #include <include/firewall/port.xml.i>
                </children>
              </node>
              #include <include/firewall/common-rule.xml.i>
              <node name="icmp">
                <properties>
                  <help>ICMP type and code information</help>
                </properties>
                <children>
                  <leafNode name="code">
                    <properties>
                      <help>ICMP code (0-255)</help>
                      <valueHelp>
                        <format>u32:0-255</format>
                        <description>ICMP code (0-255)</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-255"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="type">
                    <properties>
                      <help>ICMP type (0-255)</help>
                      <valueHelp>
                        <format>u32:0-255</format>
                        <description>ICMP type (0-255)</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-255"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  #include <include/firewall/icmp-type-name.xml.i>
                </children>
              </node>
            </children>
          </tagNode>
        </children>
      </tagNode>
      <leafNode name="receive-redirects">
        <properties>
          <help>Policy for handling received IPv4 ICMP redirect messages</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable processing of received IPv4 ICMP redirect messages</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable processing of received IPv4 ICMP redirect messages</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>disable</defaultValue>
      </leafNode>
      <leafNode name="send-redirects">
        <properties>
          <help>Policy for sending IPv4 ICMP redirect messages</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable sending IPv4 ICMP redirect messages</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable sending IPv4 ICMP redirect messages</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>enable</defaultValue>
      </leafNode>
      <leafNode name="source-validation">
        <properties>
          <help>Policy for source validation by reversed path, as specified in RFC3704</help>
          <completionHelp>
            <list>strict loose disable</list>
          </completionHelp>
          <valueHelp>
            <format>strict</format>
            <description>Enable Strict Reverse Path Forwarding as defined in RFC3704</description>
          </valueHelp>
          <valueHelp>
            <format>loose</format>
            <description>Enable Loose Reverse Path Forwarding as defined in RFC3704</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>No source validation</description>
          </valueHelp>
          <constraint>
            <regex>^(strict|loose|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>disable</defaultValue>
      </leafNode>
      <node name="state-policy">
        <properties>
          <help>Global firewall state-policy</help>
        </properties>
        <children>
          <node name="established">
            <properties>
              <help>Global firewall policy for packets part of an established connection</help>
            </properties>
            <children>
              #include <include/firewall/action-accept-drop-reject.xml.i>
              #include <include/firewall/log.xml.i>
            </children>
          </node>
          <node name="invalid">
            <properties>
              <help>Global firewall policy for packets part of an invalid connection</help>
            </properties>
            <children>
              #include <include/firewall/action-accept-drop-reject.xml.i>
              #include <include/firewall/log.xml.i>
            </children>
          </node>
          <node name="related">
            <properties>
              <help>Global firewall policy for packets part of a related connection</help>
            </properties>
            <children>
              #include <include/firewall/action-accept-drop-reject.xml.i>
              #include <include/firewall/log.xml.i>
            </children>
          </node>
        </children>
      </node>
      <leafNode name="syn-cookies">
        <properties>
          <help>Policy for using TCP SYN cookies with IPv4</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable use of TCP SYN cookies with IPv4</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable use of TCP SYN cookies with IPv4</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>enable</defaultValue>
      </leafNode>
      <leafNode name="twa-hazards-protection">
        <properties>
          <help>RFC1337 TCP TIME-WAIT assasination hazards protection</help>
          <completionHelp>
            <list>enable disable</list>
          </completionHelp>
          <valueHelp>
            <format>enable</format>
            <description>Enable RFC1337 TIME-WAIT hazards protection</description>
          </valueHelp>
          <valueHelp>
            <format>disable</format>
            <description>Disable RFC1337 TIME-WAIT hazards protection</description>
          </valueHelp>
          <constraint>
            <regex>^(enable|disable)$</regex>
          </constraint>
        </properties>
        <defaultValue>disable</defaultValue>
      </leafNode>
    </children>
  </node>
</interfaceDefinition>