-
Notifications
You must be signed in to change notification settings - Fork 4
/
netgate-vpf.yang
1381 lines (1147 loc) · 26.2 KB
/
netgate-vpf.yang
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
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
module netgate-vpf {
yang-version 1.1;
namespace "urn:netgate:xml:yang:netgate-vpf";
prefix "ngvpf";
import ietf-inet-types {
prefix "inet";
}
import netgate-cli-extensions {
prefix "ngcliext";
}
import netgate-common {
prefix "ngcom";
}
import netgate-route-table {
prefix "ngrttab";
}
organization "Netgate";
contact "Web: <http://www.netgate.com>";
description
"This YANG module provides a Netgate-defined data-model
for Netbsd Packet Filters.
Copyright 2024 Rubicon Communications, LLC.";
revision 2024-10-04 {
description
"TNSR Release 24.10.";
}
typedef vpf-nat-direction {
type enumeration {
enum in {
value 1;
description "Inbound destination translation on packet receive.";
}
enum out {
value 2;
description "Outbound source translation on packet transmit.";
}
}
}
typedef vpf-filter-direction {
type enumeration {
enum in {
value 1;
description "Inbound filter on packet receive.";
}
enum out {
value 2;
description "Outbound filter on packet transmit.";
}
enum both {
value 3;
description "Filter applied to packets in both directions.";
}
}
}
typedef vpf-nat-algorithm {
type enumeration {
enum one-to-one {
description
"Use static 1:1 mapping.";
}
enum netmap {
description
"Network address mapping from one segment to another,
leaving the host part as-is. The new address is
computed as following:
addr = net-addr | (orig-addr & ~mask).";
}
enum "ip-hash" {
description
"The translation address for a new connection is
selected based on a hash of the original source
and destination addresses. This algorithms
attempts to keep all connections of particular
client associated with the same translation address.
This is the default algorithm.";
}
enum "round-robin" {
description
"The translation address for each new connection is
selected on a round-robin basis.";
}
enum "npt66" {
description
"IPv6-to-IPv6 network prefix translation (NPTv6).";
}
}
}
grouping vpf-endpoint {
description
"VPF source or destination endpoint";
leaf inverted {
type boolean;
description
"If true, endpoint matching is inverted.";
ngcliext:node-op "bool";
ngcliext:node-fmt "|$< $%$n";
}
choice type {
description
"VPF source or destination endpoint IP addresses";
case ipv4-prefix {
leaf ipv4-prefix {
type inet:ipv4-prefix;
ngcliext:node-fmt "$< $% @@$n";
}
}
case ipv6-prefix {
leaf ipv6-prefix {
type inet:ipv6-prefix;
ngcliext:node-fmt "$< $% @@$n";
}
}
case table-name {
leaf table-name {
type leafref {
path "/ngvpf:vpf-config"
+ "/ngvpf:prefix-tables"
+ "/ngvpf:table"
+ "/ngvpf:name";
}
ngcliext:node-fmt "$< table @@$n";
}
}
case if-name {
leaf if-name {
type ngcom:if-identifier-63;
ngcliext:node-fmt "$< ifaddrs @@$n";
}
}
}
leaf port-min {
type uint16;
description
"The first source port in a range.";
ngcliext:node-fmt "$< port @@%{port-max}$n";
}
leaf port-max {
type uint16;
description
"The last source port in a range.";
ngcliext:sibling-fmt " @@";
}
}
grouping vpf-match-base {
description
"The packet attributes to match in an VPF rule.";
container from {
description
"The source pattern to match in an VPF rule.";
ngcliext:parent-fmt "^from";
uses vpf-endpoint;
}
container to {
description
"The destination pattern to match in an VPF rule.";
ngcliext:parent-fmt "^to";
uses vpf-endpoint;
}
leaf protocol-set {
type ngcom:ip-protocol-name-or-number-set;
description
"A set of IP protocol names or numbers.";
ngcliext:node-fmt "^protocol @@$n";
}
leaf tcp-flags-mask {
type ngcom:tcp-flags;
description
"The TCP flags mask as a set of names.";
ngcliext:node-fmt "^tcp flags mask $q@@$q$n";
}
leaf tcp-flags-value {
type ngcom:tcp-flags;
description
"The TCP flags value as a set of flags names.";
ngcliext:node-fmt "^tcp flags value $q@@$q$n";
}
leaf icmp-type {
type uint8;
description
"The ICMP type.";
ngcliext:node-fmt "^icmp type @@$n";
}
leaf icmp-code {
type uint8;
description
"The ICMP code.";
ngcliext:node-fmt "^icmp code @@$n";
}
}
grouping vpf-match-config {
uses vpf-match-base;
leaf dest-route-table {
type leafref {
path "/ngrttab:route-table-config" +
"/ngrttab:static-routes" +
"/ngrttab:route-table/ngrttab:name";
}
description
"Name of destination VRF for 'in' filter and NAT rules. " +
"Allows input filter rule flow to match return traffic. " +
"Allows input NAT rule to direct packets to specific VRF.";
ngcliext:node-fmt "^$% @@$n";
}
}
grouping vpf-match-state {
uses vpf-match-base;
leaf dest-route-table {
type ngcom:rt-identifier-15;
description
"Name of destination VRF for 'in' filter and NAT rules. " +
"Allows input filter rule flow to match return traffic. " +
"Allows input NAT rule to direct packets to specific VRF.";
}
}
container "vpf-config" {
description
"VPP Packet Filter (VPF) data needed to support VPP.
It consists of a set of named tables containing IP prefixes,
a set of named filtering rules, and a set of named NAT rules.";
ngcliext:parent-fmt "vpf";
container prefix-tables {
description
"Tables of named IP prefix lists.";
ngcliext:parent-fmt "$< table";
ngcliext:post-node-fmt "$n";
list table {
key "name";
ngcliext:node-fmt "$< @{name}$n";
ngcliext:pre-children-op "push";
leaf name {
type ngcom:identifier-63;
description
"The name of an IP prefix table.";
}
leaf description {
type ngcom:description-63;
description
"A text description of the VPF prefix table.";
ngcliext:node-fmt "^description @@$n";
}
container prefixes {
description
"Each table is a named set of IP prefixes.";
leaf-list prefix {
type inet:ip-prefix;
description
"Either an IPv4 or IPv6 prefix.";
ngcliext:node-fmt "^prefix @@$n";
}
}
}
}
container filter-rulesets {
description
"A list of named VPF filter rulesets.";
ngcliext:parent-fmt "$< filter";
ngcliext:post-node-fmt "$n";
list ruleset {
key name;
ngcliext:node-fmt "$< $% @{name}$n";
ngcliext:pre-children-op "push";
leaf name {
type ngcom:identifier-63;
description
"The name of the filter ruleset.";
}
leaf description {
type ngcom:description-63;
description
"A user description of the VPF filter ruleset.";
ngcliext:node-fmt "^$% @@$n";
}
container rules {
description
"A list of filter rules within a ruleset
ordered by sequence number.";
list rule {
key sequence;
ngcliext:node-fmt "^$% @{sequence}$n";
ngcliext:pre-children-op "push";
leaf sequence {
type uint32;
description
"The VPF filter rule sequence number.";
}
leaf description {
type ngcom:description-63;
description
"A user description of the VPF filter rule.";
ngcliext:node-fmt "^$% @@$n";
}
container filter {
uses vpf-match-config;
must 'not(child::node()/ipv4-prefix and child::node()/ipv6-prefix)' {
error-message
"Address family must be identical for " +
"source and destination prefix on " +
"filter rules.";
}
}
leaf ip-version {
type ngcom:ip-address-family;
description
"Indicates the IP version (ipv4 or ipv6)
applicable to this VPF rule";
ngcliext:node-fmt "^$% @@$n";
}
leaf pass {
type boolean;
description
"If true, the packet is passed, else blocked.";
ngcliext:node-op "bool";
ngcliext:node-fmt "|^$%$n";
}
leaf tentative {
type boolean;
description
"If this rule is matched, ruleset examination
continues and this rule is applied only if
there is no other rule to apply. If there
is one, then this rule’s match is ignored
and the other rule takes preference.";
ngcliext:node-op "bool";
ngcliext:node-fmt "|^$%$n";
}
leaf stateful {
type boolean;
description
"Create a stateful connection entry upon
match.";
ngcliext:node-op "bool";
ngcliext:node-fmt "|^$%$n";
}
leaf return-rst {
type boolean;
description
"Return a TCP reset on match.";
ngcliext:node-op "bool";
ngcliext:node-fmt "|^$%$n";
}
leaf return-icmp {
type boolean;
description
"Return an ICMP error on match (Destination
Unreachable/Administratively Prohibited).";
ngcliext:node-op "bool";
ngcliext:node-fmt "|^$%$n";
}
leaf direction {
type vpf-filter-direction;
default both;
description
"One of 'in', 'out', or 'both'.";
ngcliext:node-fmt "^$% @@$n";
}
}
}
}
}
container nat-rulesets {
description
"A list of VPF NAT rulesets.";
ngcliext:parent-fmt "$< nat";
ngcliext:post-node-fmt "$n";
list ruleset {
key name;
ngcliext:node-fmt "$< $% @{name}$n";
ngcliext:pre-children-op "push";
leaf name {
type ngcom:identifier-63;
description
"The name of the NAT ruleset.";
}
leaf description {
type ngcom:description-63;
description
"A user description of the VPF NAT ruleset.";
ngcliext:node-fmt "^$% @@$n";
}
container rules {
description
"A list of NAT rules within a ruleset
ordered by sequence number.";
list rule {
key sequence;
ngcliext:node-fmt "^$% @{sequence}$n";
ngcliext:pre-children-op "push";
leaf sequence {
type uint32;
description
"The VPF NAT rule sequence number.";
}
leaf description {
type ngcom:description-63;
description
"A user description of the VPF NAT rule.";
ngcliext:node-fmt "^$% @@$n";
}
container match {
uses vpf-match-config;
must 'not(child::node()/ipv4-prefix and child::node()/ipv6-prefix)' {
error-message
"Address family must be identical for " +
"source and destination prefix on NAT " +
"rules.";
}
}
leaf dynamic {
type boolean;
description
"Dynamic mapping.";
ngcliext:node-op "bool";
ngcliext:node-fmt "|^$%$n";
}
leaf no-port-translation {
type boolean;
description
"No port translation.";
ngcliext:node-op "bool";
ngcliext:node-fmt "|^$%$n";
}
leaf algorithm {
type vpf-nat-algorithm;
default ip-hash;
description
"One of one-to-one, netmap, ip hash, round robin,
or npt66.";
ngcliext:node-fmt "^$% @@$n";
}
leaf direction {
type vpf-nat-direction;
description
"One of 'in' or 'out'.";
ngcliext:node-fmt "^$% @@$n";
}
container translation {
description
"NAT translation information.";
leaf port {
type uint16;
description
"Port to use for translation.
0 means no port.";
ngcliext:node-fmt "^nat-port @@$n";
}
choice translation-type {
case interface {
leaf if-name {
type ngcom:if-identifier-63;
description
"Use IF addresses for
translation.";
ngcliext:node-fmt "^nat-interface @@$n";
}
}
case prefix {
leaf prefix {
type inet:ip-prefix;
description
"Translation prefix.";
ngcliext:node-fmt "^nat-prefix @@$n";
}
}
case table-name {
leaf table-name {
type leafref {
path "/ngvpf:vpf-config/ngvpf:prefix-tables/ngvpf:table/ngvpf:name";
}
description
"Translation table name.";
ngcliext:node-fmt "^nat-table @@$n";
}
}
}
}
leaf dest-route-table {
type leafref {
path "/ngrttab:route-table-config" +
"/ngrttab:static-routes" +
"/ngrttab:route-table/ngrttab:name";
}
description
"Name of destination VRF for 'in' NAT rule.";
ngcliext:node-fmt "^$% @@$n";
}
}
}
}
}
container options {
description
"VPF interface configuration and enablement options.";
ngcliext:node-fmt "$< $%$n";
ngcliext:pre-children-op "push";
ngcliext:post-node-fmt "$n";
container startup {
description
"Startup options.";
container max-connections-per-thread {
description
"Maximum connections per thread.";
ngcliext:parent-fmt "^$^ $%";
leaf ip4 {
type uint32;
default 131072;
description
"Maximum IPv4 connections per thread.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf ip6 {
type uint32;
default 32768;
description
"Maximum IPv6 connections per thread.";
ngcliext:node-fmt "$< $% @@$n";
}
}
container port-mapping {
description
"Port mapping.";
ngcliext:parent-fmt "^$^ $%";
leaf min-port {
type uint16 {
range "1024..65535";
}
default 1024;
description
"Lowest port used for port mapping.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf max-port {
type uint16 {
range "1024..65535";
}
must ". >= ../min-port" {
description
"This value MUST be greater or equal to
min-port.";
}
default 49151;
description
"Highest port used for port mapping.";
ngcliext:node-fmt "$< $% @@$n";
}
}
}
container runtime {
description
"Runtime options.";
container drop-options {
description
"Drop packets having IP options.";
ngcliext:parent-fmt "^$^ $%";
leaf ip4 {
type boolean;
default false;
description
"Drop IPv4 packets having IP options.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf ip6 {
type boolean;
default false;
description
"Drop IPv6 packets having IP options.";
ngcliext:node-fmt "$< $% @@$n";
}
}
container timeouts {
description
"Timeouts.";
ngcliext:parent-fmt "^$^ $%";
container generic {
description
"Generic timeouts.";
ngcliext:parent-fmt "$< $%";
leaf closed {
type uint32;
units "seconds";
default 0;
description
"Closed state.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf new {
type uint32;
units "seconds";
default 30;
description
"New state.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf established {
type uint32;
units "seconds";
default 60;
description
"Established state.";
ngcliext:node-fmt "$< $% @@$n";
}
}
container tcp {
description
"TCP timeouts.";
ngcliext:parent-fmt "$< $%";
leaf closed {
type uint32;
units "seconds";
default 10;
description
"Closed state.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf new {
type uint32;
units "seconds";
default 30;
description
"New state.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf established {
type uint32;
units "seconds";
default 86400;
description
"Established state.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf half-closed {
type uint32;
units "seconds";
default 21600;
description
"Half-closed state.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf time-wait {
type uint32;
units "seconds";
default 240;
description
"Time-wait state.";
ngcliext:node-fmt "$< $% @@$n";
}
}
}
container tcp {
description
"TCP.";
ngcliext:parent-fmt "^$^ $%";
leaf strict-rst-order {
type boolean;
default true;
description
"Enforce strict TCP RST order.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf max-ack-win {
type uint32;
default 66000;
description
"Maximum TCP ACK window.";
ngcliext:node-fmt "$< $% @@$n";
}
}
}
container interfaces {
description
"The names of filtering and NAT rulesets applied
to interfaces.";
list interface {
key "if-name";
ngcliext:parent-fmt "^$% @{if-name}";
leaf if-name {
type ngcom:if-identifier-63;
description
"The name of an interface.";
}
leaf filter-ruleset {
type leafref {
path "/ngvpf:vpf-config"
+ "/ngvpf:filter-rulesets"
+ "/ngvpf:ruleset"
+ "/ngvpf:name";
}
description
"The name of the filter ruleset on this
interface.";
ngcliext:node-fmt "$< $% @@$n";
}
leaf nat-ruleset {
type leafref {
path "/ngvpf:vpf-config"
+ "/ngvpf:nat-rulesets"
+ "/ngvpf:ruleset"
+ "/ngvpf:name";
}
description
"The name of the NAT ruleset on this interface.";
ngcliext:node-fmt "$< $% @@$n";
}
}
}
}
container ipfix {
description
"IPFIX exporting options.";
ngcliext:node-fmt "$< $%$n";
ngcliext:pre-children-op "push";
leaf enable {
type empty;
description
"If present, IPFIX exporting is enabled.";
ngcliext:node-fmt "^$%$n";
}
leaf domain {
type uint32;
default 1;
description
"Domain ID.";
ngcliext:node-fmt "^$% @@$n";
}
leaf src-port {
type uint16;
default 4739;
description
"Source port number.";
ngcliext:node-fmt "^$% @@$n";
}
}
leaf enable {
type empty;
description
"If present, the feature is enabled.";
ngcliext:node-fmt "$< $%$n";
}
}
container "vpf-state" {
config "false";
description
"Netbsd Packet Filter (VPF) state data. It consists of a set of
named tables containing IP prefixes, a set of named filtering
rules, a set of named NAT rules, and params.";
container prefix-tables {
description
"Tables of named IP prefix lists.";
list table {
key "name";
leaf name {
type ngcom:identifier-63;
description
"The name of an IP prefix table.";
}
leaf description {
type ngcom:description-63;
description
"A text description of the VPF prefix table.";
}
container hash-buckets {
description
"Hash buckets.";
leaf ip4 {
type uint32;
description
"IPv4 hash buckets.";
}
leaf ip6 {
type uint32;
description
"IPv6 hash buckets.";
}
}
container prefixes {
description
"Each table is a named set of IP prefixes.";
leaf-list prefix {
type inet:ip-prefix;
description
"Either an IPv4 or IPv6 prefix.";
}
}
}
}
container filter-rulesets {
description
"A list of named VPF filter rulesets.";
list ruleset {
key name;
leaf name {
type ngcom:identifier-63;
description
"The name of the filter ruleset.";
}
leaf description {
type ngcom:description-63;
description
"A user description of the VPF filter ruleset.";
}
container rules {
description
"A list of filter rules within a ruleset
ordered by sequence number.";
list rule {
key sequence;
leaf sequence {
type uint32;
description
"The VPF filter rule sequence number.";
}
leaf description {
type ngcom:description-63;
description
"A user description of the VPF filter rule.";
}
container filter {
uses vpf-match-state;
}
leaf ip-version {
type ngcom:ip-address-family;
description
"Indicates the IP version (ipv4 or ipv6)
applicable to this VPF rule";
}
leaf pass {
type boolean;
description