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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
|
Internet Engineering Task Force (IETF) K. Watsen
Request for Comments: 9643 Watsen Networks
Category: Standards Track M. Scharf
ISSN: 2070-1721 Hochschule Esslingen
October 2024
YANG Groupings for TCP Clients and TCP Servers
Abstract
This document presents three YANG 1.1 modules to support the
configuration of TCP clients and TCP servers. The modules include
basic parameters of a TCP connection relevant for client or server
applications, as well as client configuration required for traversing
proxies. The data models defined by these modules may be used
directly (e.g., to define a specific TCP client or TCP server) or in
conjunction with the configuration defined for higher level protocols
that depend on TCP (e.g., SSH, TLS, etc.). Examples of higher level
protocol configuration designed to be used in conjunction with this
configuration are in RFCs 9644 and 9645.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in Section 2 of RFC 7841.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
https://www.rfc-editor.org/info/rfc9643.
Copyright Notice
Copyright (c) 2024 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Revised BSD License text as described in Section 4.e of the
Trust Legal Provisions and are provided without warranty as described
in the Revised BSD License.
Table of Contents
1. Introduction
1.1. Relation to Other RFCs
1.2. Specification Language
1.3. Adherence to the NMDA
1.4. Conventions
2. The "ietf-tcp-common" Module
2.1. Data Model Overview
2.2. Example Usage
2.3. YANG Module
3. The "ietf-tcp-client" Module
3.1. Data Model Overview
3.2. Example Usage
3.3. YANG Module
4. The "ietf-tcp-server" Module
4.1. Data Model Overview
4.2. Example Usage
4.3. YANG Module
5. Security Considerations
5.1. Considerations for the "ietf-tcp-common" YANG Module
5.2. Considerations for the "ietf-tcp-client" YANG Module
5.3. Considerations for the "ietf-tcp-server" YANG Module
6. IANA Considerations
6.1. The IETF XML Registry
6.2. The YANG Module Names Registry
7. References
7.1. Normative References
7.2. Informative References
Acknowledgements
Authors' Addresses
1. Introduction
This document defines three YANG 1.1 [RFC7950] modules to support the
configuration of TCP clients and TCP servers (TCP is defined in
[RFC9293]). The data models defined by these modules may be used
directly (e.g., to define a specific TCP client or TCP server) or in
conjunction with the configuration defined for higher level protocols
that depend on TCP (e.g., SSH, TLS, etc.). Examples of higher level
protocol configuration designed to be used in conjunction with this
configuration are in [RFC9644] and [RFC9645].
The modules focus on three different types of base TCP parameters
that matter for TCP-based applications: First, the modules cover
fundamental configuration of a TCP client or TCP server application,
such as addresses and port numbers. Second, a reusable grouping
enables modification of application-specific parameters for TCP
connections, such as use of TCP keepalives. And third, client
configuration for traversing proxies is included as well. In each
case, the modules have a very narrow scope and focus on a minimum set
of required parameters.
Please be advised that while this document presents support for some
TCP proxy techniques, there are other TCP proxy techniques that are
not part of this document but could be added by augmenting the YANG
module.
1.1. Relation to Other RFCs
This document presents three YANG modules [RFC7950] that are part of
a collection of RFCs that work together to ultimately support the
configuration of both the clients and servers of both the Network
Configuration Protocol (NETCONF) [RFC6241] and RESTCONF [RFC8040].
The dependency relationship between the primary YANG groupings
defined in the various RFCs is presented in the below diagram. In
some cases, a document may define secondary groupings that introduce
dependencies not illustrated in the diagram. The labels in the
diagram are shorthand names for the defining RFCs. The citation
references for shorthand names are provided below the diagram.
Please note that the arrows in the diagram point from referencer to
referenced. For example, the "crypto-types" RFC does not have any
dependencies, whilst the "keystore" RFC depends on the "crypto-types"
RFC.
crypto-types
^ ^
/ \
/ \
truststore keystore
^ ^ ^ ^
| +---------+ | |
| | | |
| +------------+ |
tcp-client-server | / | |
^ ^ ssh-client-server | |
| | ^ tls-client-server
| | | ^ ^ http-client-server
| | | | | ^
| | | +-----+ +---------+ |
| | | | | |
| +-----------|--------|--------------+ | |
| | | | | |
+-----------+ | | | | |
| | | | | |
| | | | | |
netconf-client-server restconf-client-server
+========================+==========================+
| Label in Diagram | Reference |
+========================+==========================+
| crypto-types | [RFC9640] |
+------------------------+--------------------------+
| truststore | [RFC9641] |
+------------------------+--------------------------+
| keystore | [RFC9642] |
+------------------------+--------------------------+
| tcp-client-server | RFC 9643 |
+------------------------+--------------------------+
| ssh-client-server | [RFC9644] |
+------------------------+--------------------------+
| tls-client-server | [RFC9645] |
+------------------------+--------------------------+
| http-client-server | [HTTP-CLIENT-SERVER] |
+------------------------+--------------------------+
| netconf-client-server | [NETCONF-CLIENT-SERVER] |
+------------------------+--------------------------+
| restconf-client-server | [RESTCONF-CLIENT-SERVER] |
+------------------------+--------------------------+
Table 1: Label in Diagram to RFC Mapping
1.2. Specification Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
1.3. Adherence to the NMDA
This document is compliant with the Network Management Datastore
Architecture (NMDA) [RFC8342]. It does not define any protocol
accessible nodes that are "config false".
1.4. Conventions
Various examples in this document use the XML [W3C.REC-xml-20081126]
encoding. Other encodings, such as JSON [RFC8259], could
alternatively be used.
2. The "ietf-tcp-common" Module
This section defines a YANG 1.1 module called "ietf-tcp-common". A
high-level overview of the module is provided in Section 2.1.
Examples illustrating the module's use are provided in Section 2.2
("Example Usage"). The YANG module itself is defined in Section 2.3.
2.1. Data Model Overview
This section provides an overview of the "ietf-tcp-common" module in
terms of its features and groupings.
2.1.1. Model Scope
This document presents a common "grouping" statement for basic TCP
connection parameters that matter to applications. It is "common" in
that this grouping is used by both the "ietf-tcp-client" and "ietf-
tcp-server" modules. In some TCP stacks, such parameters can also
directly be set by an application using system calls, such as the
sockets API. The base YANG data model in this document focuses on
modeling TCP keepalives. This base model can be extended as needed.
2.1.2. Features
The following diagram lists all the "feature" statements defined in
the "ietf-tcp-common" module:
Features:
+-- keepalives-supported
The diagram above uses syntax that is similar to but not defined in
[RFC8340].
2.1.3. Groupings
The "ietf-tcp-common" module defines the following "grouping"
statement:
* tcp-common-grouping
This grouping is presented in the following subsection.
2.1.3.1. The "tcp-common-grouping" Grouping
The following tree diagram [RFC8340] illustrates the "tcp-common-
grouping" grouping:
grouping tcp-common-grouping:
+-- keepalives! {keepalives-supported}?
+-- idle-time? uint16
+-- max-probes? uint16
+-- probe-interval? uint16
Comments:
* The "keepalives" node is a "presence" container so that the
mandatory descendant nodes do not imply that keepalives must be
configured.
* The "idle-time", "max-probes", and "probe-interval" nodes have the
common meanings. Please see the YANG module in Section 2.3 for
details.
2.1.4. Protocol-Accessible Nodes
The "ietf-tcp-common" module defines only "grouping" statements that
are used by other modules to instantiate protocol-accessible nodes.
Thus, this module, when implemented, does not itself define any
protocol-accessible nodes.
2.1.5. Guidelines for Configuring TCP Keepalives
Network stacks may include keepalives in their TCP implementations,
although this practice is not universally implemented. If keepalives
are included, [RFC9293] mandates that the application MUST be able to
turn them on or off for each TCP connection and that they MUST
default to off.
Keepalive mechanisms exist in many protocols. Depending on the
protocol stack, TCP keepalives may only be one out of several
alternatives. Which mechanism(s) to use depends on the use case and
application requirements. If keepalives are needed by an
application, it is RECOMMENDED that the liveness check happens only
at the protocol layers that are meaningful to the application.
A TCP keepalive mechanism SHOULD only be invoked in server
applications that might otherwise hang indefinitely and consume
resources unnecessarily if a client crashes or aborts a connection
during a network failure [RFC9293]. TCP keepalives may consume
significant resources both in the network and in endpoints (e.g.,
battery power). In addition, frequent keepalives risk network
congestion. The higher the frequency of keepalives, the higher the
overhead.
Given the cost of keepalives, parameters have to be configured
carefully:
* The default idle interval (leaf "idle-time") is two hours, i.e.,
7200 seconds [RFC9293]. A lower value MAY be configured, but idle
intervals SHOULD NOT be smaller than 15 seconds. Longer idle
intervals SHOULD be used when possible.
* The maximum number of sequential keepalive probes that can fail
(leaf "max-probes") trades off responsiveness and robustness
against packet loss. ACK segments that contain no data are not
reliably transmitted by TCP. Consequently, if a keepalive
mechanism is implemented, it MUST NOT interpret failure to respond
to any specific probe as a dead connection [RFC9293]. Typically,
a single-digit number should suffice.
* TCP implementations may include a parameter for the number of
seconds between TCP keepalive probes (leaf "probe-interval"). In
order to avoid congestion, the time interval between probes MUST
NOT be smaller than one second. Significantly longer intervals
SHOULD be used. It is important to note that keepalive probes (or
replies) can get dropped due to network congestion. Sending
further probe messages into a congested path after a short
interval, without backing off timers, could cause harm and result
in a congestion collapse. Therefore, it is essential to pick a
large, conservative value for this interval.
2.2. Example Usage
This section presents an example showing the "tcp-common-grouping"
grouping populated with some data.
<!-- The outermost element below doesn't exist in the data model. -->
<!-- It simulates if the "grouping" were a "container" instead. -->
<tcp-common xmlns="urn:ietf:params:xml:ns:yang:ietf-tcp-common">
<keepalives>
<idle-time>7200</idle-time>
<max-probes>9</max-probes>
<probe-interval>75</probe-interval>
</keepalives>
</tcp-common>
2.3. YANG Module
The "ietf-tcp-common" YANG module references [RFC6991] and [RFC9293].
<CODE BEGINS> file "ietf-tcp-common@2024-10-10.yang"
module ietf-tcp-common {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-tcp-common";
prefix tcpcmn;
organization
"IETF NETCONF (Network Configuration) Working Group and the
IETF TCP Maintenance and Minor Extensions (TCPM) Working Group";
contact
"WG Web: https://datatracker.ietf.org/wg/netconf
https://datatracker.ietf.org/wg/tcpm
WG List: NETCONF WG list <mailto:netconf@ietf.org>
TCPM WG list <mailto:tcpm@ietf.org>
Authors: Kent Watsen <mailto:kent+ietf@watsen.net>
Michael Scharf
<mailto:michael.scharf@hs-esslingen.de>";
description
"This module define a reusable 'grouping' that is common
to both TCP clients and TCP servers. This grouping statement
is used by both the 'ietf-tcp-client' and 'ietf-tcp-server'
modules.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.
Copyright (c) 2024 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Revised
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC 9643
(https://www.rfc-editor.org/info/rfc9643); see the RFC
itself for full legal notices.";
revision 2024-10-10 {
description
"Initial version.";
reference
"RFC 9643: YANG Groupings for TCP Clients and TCP Servers";
}
// Features
feature keepalives-supported {
description
"Indicates that keepalives are supported.";
}
// Groupings
grouping tcp-common-grouping {
description
"A reusable grouping for configuring TCP parameters common
to TCP connections as well as the operating system as a
whole.";
container keepalives {
if-feature "keepalives-supported";
presence "Indicates that keepalives are enabled, aligning to
the requirement in Section 3.8.4 of RFC 9293 that
states keepalives are off by default.";
description
"Configures the keepalive policy to proactively test the
aliveness of the TCP peer. An unresponsive TCP peer is
dropped after approximately (idle-time + max-probes *
probe-interval) seconds. Further guidance can be found
in Section 2.1.5 of RFC 9643.";
reference
"RFC 9293: Transmission Control Protocol (TCP)";
leaf idle-time {
type uint16 {
range "1..max";
}
units "seconds";
default "7200";
description
"Sets the amount of time after which a TCP-level probe
message will be sent to test the aliveness of the TCP
peer if no data has been received from the TCP peer.
Two hours (7200 seconds) is a safe value, per Section
3.8.4 of RFC 9293.";
reference
"RFC 9293: Transmission Control Protocol (TCP)";
}
leaf max-probes {
type uint16 {
range "1..max";
}
default "9";
description
"Sets the maximum number of sequential keepalive probes
that can fail to obtain a response from the TCP peer
before assuming the TCP peer is no longer alive.";
}
leaf probe-interval {
type uint16 {
range "1..max";
}
units "seconds";
default "75";
description
"Sets the time interval between failed probes. The
interval SHOULD be significantly longer than one second
in order to avoid harm on a congested link.";
}
} // container keepalives
} // grouping tcp-common-grouping
}
<CODE ENDS>
3. The "ietf-tcp-client" Module
This section defines a YANG 1.1 module called "ietf-tcp-client". A
high-level overview of the module is provided in Section 3.1.
Examples illustrating the module's use are provided in Section 3.2
("Example Usage"). The YANG module itself is defined in Section 3.3.
3.1. Data Model Overview
This section provides an overview of the "ietf-tcp-client" module in
terms of its features and groupings.
3.1.1. Features
The following diagram lists all the "feature" statements defined in
the "ietf-tcp-client" module:
Features:
+-- local-binding-supported
+-- tcp-client-keepalives
+-- proxy-connect
+-- socks4-supported {proxy-connect}?
+-- socks4a-supported {proxy-connect}?
+-- socks5-supported {proxy-connect}?
+-- socks5-gss-api {socks5-supported}?
+-- socks5-username-password {socks5-supported}?
Comments:
* The "local-binding-supported" feature indicates that the server
supports configuring local bindings (i.e., the local address and
local port) for TCP clients.
* The "tcp-client-keepalives" feature indicates that TCP keepalive
parameters are configurable for TCP clients on the server
implementing this feature.
* The "proxy-connect" feature indicates the TCP client supports
connecting through TCP proxies.
* The "socks4-supported" feature indicates the TCP client supports
Socks4-based proxies.
* The "socks4a-supported" feature indicates the TCP client supports
Socks4a-based proxies. The difference between Socks4 and Socks4a
is that Socks4a enables the "remote-address" to be specified using
a hostname, in addition to an IP address.
* The "socks5-supported" feature indicates the TCP client supports
Socks5-based proxies.
* The "socks5-gss-api" feature indicates that the server, when
acting as a TCP client, supports authenticating to a SOCKS Version
5 proxy server using Generic Security Service Application Program
Interface (GSS-API) credentials.
* The "socks5-username-password" feature indicates that the server,
when acting as a TCP client, supports authenticating to a SOCKS
Version 5 proxy server using "username" and "password"
credentials."
The diagram above uses syntax that is similar to but not defined in
[RFC8340].
3.1.2. Groupings
The "ietf-tcp-client" module defines the following "grouping"
statement:
* tcp-client-grouping
This grouping is presented in the following subsection.
3.1.2.1. The "tcp-client-grouping" Grouping
The following tree diagram [RFC8340] illustrates the "tcp-client-
grouping" grouping:
grouping tcp-client-grouping:
+-- remote-address inet:host
+-- remote-port? inet:port-number
+-- local-address? inet:ip-address
| {local-binding-supported}?
+-- local-port? inet:port-number
| {local-binding-supported}?
+-- proxy-server! {proxy-connect}?
| +-- (proxy-type)
| +--:(socks4) {socks4-supported}?
| | +-- socks4-parameters
| | +-- remote-address inet:ip-address
| | +-- remote-port? inet:port-number
| +--:(socks4a) {socks4a-supported}?
| | +-- socks4a-parameters
| | +-- remote-address inet:host
| | +-- remote-port? inet:port-number
| +--:(socks5) {socks5-supported}?
| +-- socks5-parameters
| +-- remote-address inet:host
| +-- remote-port? inet:port-number
| +-- authentication-parameters!
| +-- (auth-type)
| +--:(gss-api) {socks5-gss-api}?
| | +-- gss-api
| +--:(username-password)
| {socks5-username-password}?
| +-- username-password
| +-- username string
| +---u ct:password-grouping
+---u tcpcmn:tcp-common-grouping
Comments:
* The "remote-address" node, which is mandatory, may be configured
as an IPv4 address, an IPv6 address, or a hostname.
* The "remote-port" leaf is defined with neither a "default" nor a
"mandatory" statement. YANG modules using this grouping SHOULD
refine the grouping with a "default" statement, when the port
number is well-known (e.g., a port number allocated by IANA), or
with a "mandatory" statement, if a port number needs to always be
configured. The SHOULD can be ignored when the port number is
neither well-known nor mandatory to configure, such as might be
the case when this grouping is used by another grouping.
* The "local-address" node, which is enabled by the "local-binding-
supported" feature (Section 3.1.1), may be configured as an IPv4
address, an IPv6 address, or a wildcard value.
* The "local-port" node, which is enabled by the "local-binding-
supported" feature (Section 3.1.1), is not mandatory. Its default
value is "0", indicating that the operating system can pick an
arbitrary port number.
* The "proxy-server" node is enabled by a "feature" statement and,
for servers that enable it, is a "presence" container so that the
descendant "mandatory true" choice node does not imply that the
proxy-server node must be configured. The proxy-server node uses
a "choice" statement to allow one of several types of proxies to
be configured. The choices presented in this document include
Socks4, Socks4a, and Socks5, each enabled by a YANG feature (see
Section 3.1.1). Other proxy types may be added by future work.
* This grouping uses the "password-grouping" grouping discussed in
[RFC9640].
* This grouping uses the "tcp-common-grouping" grouping discussed in
Section 2.1.3.1.
3.1.3. Protocol-Accessible Nodes
The "ietf-tcp-client" module defines only "grouping" statements that
are used by other modules to instantiate protocol-accessible nodes.
Thus, this module, when implemented, does not itself define any
protocol-accessible nodes.
3.2. Example Usage
This section presents two examples showing the "tcp-client-grouping"
grouping populated with some data. This example shows a TCP client
configured to not connect via a proxy:
<!-- The outermost element below doesn't exist in the data model. -->
<!-- It simulates if the "grouping" were a "container" instead. -->
<tcp-client xmlns="urn:ietf:params:xml:ns:yang:ietf-tcp-client">
<remote-address>www.example.com</remote-address>
<remote-port>8443</remote-port>
<local-address>192.0.2.2</local-address>
<local-port>12345</local-port>
<keepalives>
<idle-time>7200</idle-time>
<max-probes>9</max-probes>
<probe-interval>75</probe-interval>
</keepalives>
</tcp-client>
This example shows a TCP client configured to connect via a proxy.
<!-- The outermost element below doesn't exist in the data model. -->
<!-- It simulates if the "grouping" were a "container" instead. -->
<tcp-client xmlns="urn:ietf:params:xml:ns:yang:ietf-tcp-client">
<remote-address>www.example.com</remote-address>
<remote-port>8443</remote-port>
<local-address>192.0.2.2</local-address>
<local-port>12345</local-port>
<proxy-server>
<socks5-parameters>
<remote-address>proxy.example.com</remote-address>
<remote-port>1080</remote-port>
<authentication-parameters>
<username-password>
<username>foobar</username>
<cleartext-password>secret</cleartext-password>
</username-password>
</authentication-parameters>
</socks5-parameters>
</proxy-server>
<keepalives>
<idle-time>7200</idle-time>
<max-probes>9</max-probes>
<probe-interval>75</probe-interval>
</keepalives>
</tcp-client>
3.3. YANG Module
The "ietf-tcp-client" YANG module references [SOCKS], [SOCKS_4A],
[RFC1928], [RFC1929], [RFC2743], [RFC6991], [RFC9293], and [RFC9640].
<CODE BEGINS> file "ietf-tcp-client@2024-10-10.yang"
module ietf-tcp-client {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-tcp-client";
prefix tcpc;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-crypto-types {
prefix ct;
reference
"RFC 9640: YANG Data Types and Groupings for Cryptography";
}
import ietf-tcp-common {
prefix tcpcmn;
reference
"RFC 9643: YANG Groupings for TCP Clients and TCP Servers";
}
organization
"IETF NETCONF (Network Configuration) Working Group and the
IETF TCP Maintenance and Minor Extensions (TCPM) Working Group";
contact
"WG Web: https://datatracker.ietf.org/wg/netconf
https://datatracker.ietf.org/wg/tcpm
WG List: NETCONF WG list <mailto:netconf@ietf.org>
TCPM WG list <mailto:tcpm@ietf.org>
Authors: Kent Watsen <mailto:kent+ietf@watsen.net>
Michael Scharf
<mailto:michael.scharf@hs-esslingen.de>";
description
"This module defines reusable groupings for TCP clients that
can be used as a basis for specific TCP client instances.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.
Copyright (c) 2024 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Revised
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC 9643
(https://www.rfc-editor.org/info/rfc9643); see the RFC
itself for full legal notices.";
revision 2024-10-10 {
description
"Initial version.";
reference
"RFC 9643: YANG Groupings for TCP Clients and TCP Servers";
}
// Features
feature local-binding-supported {
description
"Indicates that the server supports configuring local
bindings (i.e., the local address and local port) for
TCP clients.";
}
feature tcp-client-keepalives {
description
"TCP keepalive parameters are configurable for
TCP clients on the server implementing this feature.";
reference
"RFC 9293: Transmission Control Protocol (TCP)";
}
feature proxy-connect {
description
"Indicates the TCP client supports connecting through
TCP proxies.";
}
feature socks4-supported {
if-feature "proxy-connect";
description
"Indicates the TCP client supports Socks4-based proxies.";
reference
"SOCKS Proceedings: 1992 Usenix Security Symposium";
}
feature socks4a-supported {
if-feature "proxy-connect";
description
"Indicates the TCP client supports Socks4a-based proxies.";
reference
"OpenSSH message:
SOCKS 4A: A Simple Extension to SOCKS 4 Protocol
<https://www.openssh.com/txt/socks4a.protocol>";
}
feature socks5-supported {
if-feature "proxy-connect";
description
"Indicates the TCP client supports Socks5-based proxies.";
reference
"RFC 1928: SOCKS Protocol Version 5";
}
feature socks5-gss-api {
if-feature "socks5-supported";
description
"Indicates that the server, when acting as a TCP client,
supports authenticating to a SOCKS Version 5 proxy server
using GSS-API credentials.";
reference
"RFC 1928: SOCKS Protocol Version 5";
}
feature socks5-username-password {
if-feature "socks5-supported";
description
"Indicates that the server, when acting as a TCP client,
supports authenticating to a SOCKS Version 5 proxy server
using 'username' and 'password' credentials.";
reference
"RFC 1928: SOCKS Protocol Version 5";
}
// Groupings
grouping tcp-client-grouping {
description
"A reusable grouping for configuring a TCP client.
Note that this grouping uses fairly typical descendant
node names such that a stack of 'uses' statements will
have name conflicts. It is intended that the consuming
data model will resolve the issue (e.g., by wrapping
the 'uses' statement in a container called
'tcp-client-parameters'). This model purposely does
not do this itself so as to provide maximum flexibility
to consuming models.";
leaf remote-address {
type inet:host;
mandatory true;
description
"The IP address or hostname of the remote peer to
establish a connection with. If a domain name is
configured, then the DNS resolution should happen on
each connection attempt. If the DNS resolution
results in multiple IP addresses, the IP addresses
are tried according to local preference order until
a connection has been established or until all IP
addresses have failed.";
}
leaf remote-port {
type inet:port-number;
description
"The port number of the remote TCP server.";
}
leaf local-address {
if-feature "local-binding-supported";
type inet:ip-address;
description
"The local IP address/interface to bind to for when
connecting to the remote peer. INADDR_ANY ('0.0.0.0') or
INADDR6_ANY ('0:0:0:0:0:0:0:0' a.k.a. '::') MAY be used to
explicitly indicate the implicit default, which the server
can bind to any IPv4 or IPv6 address.";
}
leaf local-port {
if-feature "local-binding-supported";
type inet:port-number;
default "0";
description
"The local IP port number to bind to for when connecting
to the remote peer. The port number '0', which is the
default value, indicates that any available local port
number may be used.";
}
container proxy-server {
if-feature "proxy-connect";
presence "Indicates that a proxy connection has been
configured. Present so that the mandatory
descendant nodes do not imply that this node
must be configured.";
choice proxy-type {
mandatory true;
description
"Selects a proxy connection protocol.";
case socks4 {
if-feature "socks4-supported";
container socks4-parameters {
leaf remote-address {
type inet:ip-address;
mandatory true;
description
"The IP address of the proxy server.";
}
leaf remote-port {
type inet:port-number;
default "1080";
description
"The IP port number for the proxy server.";
}
description
"Parameters for connecting to a TCP-based proxy
server using the SOCKS4 protocol.";
reference
"SOCKS Proceedings: 1992 Usenix Security Symposium";
}
}
case socks4a {
if-feature "socks4a-supported";
container socks4a-parameters {
leaf remote-address {
type inet:host;
mandatory true;
description
"The IP address or hostname of the proxy server.";
}
leaf remote-port {
type inet:port-number;
default "1080";
description
"The IP port number for the proxy server.";
}
description
"Parameters for connecting to a TCP-based proxy
server using the SOCKS4a protocol.";
reference
"SOCKS Proceedings:
1992 Usenix Security Symposium
OpenSSH message:
SOCKS 4A: A Simple Extension to SOCKS 4 Protocol
<https://www.openssh.com/txt/socks4a.protocol>";
}
}
case socks5 {
if-feature "socks5-supported";
container socks5-parameters {
leaf remote-address {
type inet:host;
mandatory true;
description
"The IP address or hostname of the proxy server.";
}
leaf remote-port {
type inet:port-number;
default "1080";
description
"The IP port number for the proxy server.";
}
container authentication-parameters {
presence "Indicates that an authentication mechanism
has been configured. Present so that the
mandatory descendant nodes do not imply that
this node must be configured.";
description
"A container for SOCKS Version 5 authentication
mechanisms.
A complete list of methods is defined at:
<https://www.iana.org/assignments/socks-methods>.";
reference
"RFC 1928: SOCKS Protocol Version 5";
choice auth-type {
mandatory true;
description
"A choice amongst supported SOCKS Version 5
authentication mechanisms.";
case gss-api {
if-feature "socks5-gss-api";
container gss-api {
description
"Contains GSS-API configuration. Defines
as an empty container to enable specific
GSS-API configuration to be augmented in
by future modules.";
reference
"RFC 1928: SOCKS Protocol Version 5
RFC 2743: Generic Security Service
Application Program Interface
Version 2, Update 1";
}
}
case username-password {
if-feature "socks5-username-password";
container username-password {
leaf username {
type string;
mandatory true;
description
"The 'username' value to use for client
identification.";
}
uses ct:password-grouping {
description
"The password to be used for client
authentication.";
}
description
"Contains username/password configuration.";
reference
"RFC 1929: Username/Password Authentication
for SOCKS V5";
}
}
}
}
description
"Parameters for connecting to a TCP-based proxy server
using the SOCKS5 protocol.";
reference
"RFC 1928: SOCKS Protocol Version 5";
}
}
}
description
"Proxy server settings.";
}
uses tcpcmn:tcp-common-grouping {
refine "keepalives" {
if-feature "tcp-client-keepalives";
description
"An 'if-feature' statement so that implementations
can choose to support TCP client keepalives.";
}
}
}
}
<CODE ENDS>
4. The "ietf-tcp-server" Module
This section defines a YANG 1.1 module called "ietf-tcp-server". A
high-level overview of the module is provided in Section 4.1.
Examples illustrating the module's use are provided in Section 4.2
("Example Usage"). The YANG module itself is defined in Section 4.3.
4.1. Data Model Overview
This section provides an overview of the "ietf-tcp-server" module in
terms of its features and groupings.
4.1.1. Features
The following diagram lists all the "feature" statements defined in
the "ietf-tcp-server" module:
Features:
+-- tcp-server-keepalives
The diagram above uses syntax that is similar to but not defined in
[RFC8340].
4.1.2. Groupings
The "ietf-tcp-server" module defines the following "grouping"
statement:
* tcp-server-grouping
This grouping is presented in the following subsection.
4.1.2.1. The "tcp-server-grouping" Grouping
The following tree diagram [RFC8340] illustrates the "tcp-server-
grouping" grouping:
grouping tcp-server-grouping:
+-- local-bind* [local-address]
| +-- local-address inet:ip-address
| +-- local-port? inet:port-number
+---u tcpcmn:tcp-common-grouping
Comments:
* The "local-address" node, which is mandatory, may be configured as
an IPv4 address, an IPv6 address, or a wildcard value.
* The "local-port" leaf is defined with neither a "default" nor a
"mandatory" statement. YANG modules using this grouping SHOULD
refine the grouping with a "default" statement, when the port
number is well-known (e.g., a port number allocated by IANA), or
with a "mandatory" statement, if a port number needs to always be
configured. The SHOULD can be ignored when the port number is
neither well-known nor mandatory to configure, such as might be
the case when this grouping is used by another grouping.
* This grouping uses the "tcp-common-grouping" grouping discussed in
Section 2.1.3.1.
4.1.3. Protocol-Accessible Nodes
The "ietf-tcp-server" module defines only "grouping" statements that
are used by other modules to instantiate protocol-accessible nodes.
Thus, this module, when implemented, does not itself define any
protocol-accessible nodes.
4.2. Example Usage
This section presents an example showing the "tcp-server-grouping"
grouping populated with some data.
<!-- The outermost element below doesn't exist in the data model. -->
<!-- It simulates if the "grouping" were a "container" instead. -->
<tcp-server xmlns="urn:ietf:params:xml:ns:yang:ietf-tcp-server">
<local-bind>
<local-address>192.0.2.2</local-address>
<local-port>49152</local-port>
</local-bind>
<keepalives>
<idle-time>7200</idle-time>
<max-probes>9</max-probes>
<probe-interval>75</probe-interval>
</keepalives>
</tcp-server>
4.3. YANG Module
The "ietf-tcp-server" YANG module references [RFC6991] and [RFC9293].
<CODE BEGINS> file "ietf-tcp-server@2024-10-10.yang"
module ietf-tcp-server {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-tcp-server";
prefix tcps;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-tcp-common {
prefix tcpcmn;
reference
"RFC 9643: YANG Groupings for TCP Clients and TCP Servers";
}
organization
"IETF NETCONF (Network Configuration) Working Group and the
IETF TCP Maintenance and Minor Extensions (TCPM) Working Group";
contact
"WG Web: https://datatracker.ietf.org/wg/netconf
https://datatracker.ietf.org/wg/tcpm
WG List: NETCONF WG list <mailto:netconf@ietf.org>
TCPM WG list <mailto:tcpm@ietf.org>
Authors: Kent Watsen <mailto:kent+ietf@watsen.net>
Michael Scharf
<mailto:michael.scharf@hs-esslingen.de>";
description
"This module defines reusable groupings for TCP servers that
can be used as a basis for specific TCP server instances.
Copyright (c) 2024 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Revised
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC 9643
(https://www.rfc-editor.org/info/rfc9643); see the RFC
itself for full legal notices.";
revision 2024-10-10 {
description
"Initial version.";
reference
"RFC 9643: YANG Groupings for TCP Clients and TCP Servers";
}
// Features
feature tcp-server-keepalives {
description
"TCP keepalive parameters are configurable for
TCP servers on the server implementing this feature.";
reference
"RFC 9293: Transmission Control Protocol (TCP)";
}
// Groupings
grouping tcp-server-grouping {
description
"A reusable grouping for configuring a TCP server.
Note that this grouping uses fairly typical descendant
node names such that a stack of 'uses' statements will
have name conflicts. It is intended that the consuming
data model will resolve the issue (e.g., by wrapping
the 'uses' statement in a container called
'tcp-server-parameters'). This model purposely does
not do this itself so as to provide maximum flexibility
to consuming models.";
list local-bind {
key "local-address";
min-elements 1;
description
"A list of bind (listen) points for this server
instance. A server instance may have multiple
bind points to support, e.g., the same port in
different address families or different ports
in the same address family.";
leaf local-address {
type inet:ip-address;
description
"The local IP address to listen on for incoming
TCP client connections. To configure listening
on all IPv4 addresses, the value must be '0.0.0.0'
(INADDR_ANY). To configure listening on all IPv6
addresses, the value must be '::' (INADDR6_ANY).";
}
leaf local-port {
type inet:port-number;
description
"The local port number to listen on for incoming TCP
client connections.";
}
}
uses tcpcmn:tcp-common-grouping {
refine "keepalives" {
if-feature "tcp-server-keepalives";
description
"An 'if-feature' statement so that implementations
can choose to support TCP server keepalives.";
}
}
}
}
<CODE ENDS>
5. Security Considerations
The three YANG modules in this document define groupings and will not
be deployed as standalone modules. Their security implications may
be context-dependent based on their use in other modules. The
designers of modules that import these groupings must conduct their
own analysis of the security considerations.
5.1. Considerations for the "ietf-tcp-common" YANG Module
This section is modeled after the template defined in Section 3.7.1
of [RFC8407].
The "ietf-tcp-common" YANG module defines "grouping" statements that
are designed to be accessed via YANG-based management protocols, such
as NETCONF [RFC6241] and RESTCONF [RFC8040]. Both of these protocols
have mandatory-to-implement secure transport layers (e.g., Secure
Shell (SSH) [RFC4252], TLS [RFC8446], and QUIC [RFC9000]) and
mandatory-to-implement mutual authentication.
The Network Configuration Access Control Model (NACM) [RFC8341]
provides the means to restrict access for particular users to a
preconfigured subset of all available protocol operations and
content.
Please be aware that this YANG module uses groupings from other YANG
modules that define nodes that may be considered sensitive or
vulnerable in network environments. Please review the security
considerations for dependent YANG modules for information as to which
nodes may be considered sensitive or vulnerable in network
environments.
None of the readable data nodes defined in this YANG module are
considered sensitive or vulnerable in network environments. The NACM
"default-deny-all" extension has not been set for any data nodes
defined in this module.
None of the writable data nodes defined in this YANG module are
considered sensitive or vulnerable in network environments. The NACM
"default-deny-write" extension has not been set for any data nodes
defined in this module.
This module does not define any RPCs, actions, or notifications, and
thus, the security considerations for such are not provided here.
5.2. Considerations for the "ietf-tcp-client" YANG Module
This section is modeled after the template defined in Section 3.7.1
of [RFC8407].
The "ietf-tcp-client" YANG module defines "grouping" statements that
are designed to be accessed via YANG-based management protocols, such
as NETCONF [RFC6241] and RESTCONF [RFC8040]. Both of these protocols
have mandatory-to-implement secure transport layers (e.g., Secure
Shell (SSH) [RFC4252], TLS [RFC8446], and QUIC [RFC9000]) and
mandatory-to-implement mutual authentication.
The Network Configuration Access Control Model (NACM) [RFC8341]
provides the means to restrict access for particular users to a
preconfigured subset of all available protocol operations and
content.
Please be aware that this YANG module uses groupings from other YANG
modules that define nodes that may be considered sensitive or
vulnerable in network environments. Please review the security
considerations for dependent YANG modules for information as to which
nodes may be considered sensitive or vulnerable in network
environments.
One readable data node defined in this YANG module may be considered
sensitive or vulnerable in some network environments. This node is
as follows:
* The "proxy-server/socks5-parameters/authentication-parameters/
username-password/password" node:
The "password" node defined in the "tcp-client-grouping"
grouping is defined using the "password-grouping" grouping
presented in [RFC9640]. This grouping enables both cleartext
and encrypted passwords to be configured. As the referenced
document states, configuration of cleartext passwords is NOT
RECOMMENDED. However, in the case cleartext values are
configured, this node is additionally sensitive to read
operations such that, in normal use cases, it should never be
returned to a client. For this reason, the NACM "default-deny-
all" extension has been applied to it.
None of the writable data nodes defined in this YANG module are
considered sensitive or vulnerable in network environments. The NACM
"default-deny-write" extension has not been set for any data nodes
defined in this module.
This module does not define any RPCs, actions, or notifications, and
thus, the security considerations for such are not provided here.
Implementations are RECOMMENDED to implement the "local-binding-
supported" feature for cryptographically secure protocols so as to
enable more granular ingress/egress firewall rule bases. It is NOT
RECOMMENDED to implement this feature for unsecure protocols, as per
[RFC6056].
5.3. Considerations for the "ietf-tcp-server" YANG Module
This section is modeled after the template defined in Section 3.7.1
of [RFC8407].
The "ietf-tcp-server" YANG module defines "grouping" statements that
are designed to be accessed via YANG-based management protocols, such
as NETCONF [RFC6241] and RESTCONF [RFC8040]. Both of these protocols
have mandatory-to-implement secure transport layers (e.g., Secure
Shell (SSH) [RFC4252], TLS [RFC8446], and QUIC [RFC9000]) and
mandatory-to-implement mutual authentication.
The Network Configuration Access Control Model (NACM) [RFC8341]
provides the means to restrict access for particular users to a
preconfigured subset of all available protocol operations and
content.
Please be aware that this YANG module uses groupings from other YANG
modules that define nodes that may be considered sensitive or
vulnerable in network environments. Please review the security
considerations for dependent YANG modules for information as to which
nodes may be considered sensitive or vulnerable in network
environments.
None of the readable data nodes defined in this YANG module are
considered sensitive or vulnerable in network environments. The NACM
"default-deny-all" extension has not been set for any data nodes
defined in this module.
None of the writable data nodes defined in this YANG module are
considered sensitive or vulnerable in network environments. The NACM
"default-deny-write" extension has not been set for any data nodes
defined in this module.
This module does not define any RPCs, actions, or notifications, and
thus, the security considerations for such are not provided here.
6. IANA Considerations
6.1. The IETF XML Registry
IANA has registered the following URI in the "ns" registry of the
"IETF XML Registry" [RFC3688].
URI: urn:ietf:params:xml:ns:yang:ietf-tcp-common
Registrant Contact: The IESG
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-tcp-client
Registrant Contact: The IESG
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-tcp-server
Registrant Contact: The IESG
XML: N/A; the requested URI is an XML namespace.
6.2. The YANG Module Names Registry
IANA has registered the following three YANG modules in the "YANG
Module Names" registry [RFC6020].
Name: ietf-tcp-common
Namespace: urn:ietf:params:xml:ns:yang:ietf-tcp-common
Prefix: tcpcmn
Reference: RFC 9643
Name: ietf-tcp-client
Namespace: urn:ietf:params:xml:ns:yang:ietf-tcp-client
Prefix: tcpc
Reference: RFC 9643
Name: ietf-tcp-server
Namespace: urn:ietf:params:xml:ns:yang:ietf-tcp-server
Prefix: tcps
Reference: RFC 9643
7. References
7.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC4252] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH)
Authentication Protocol", RFC 4252, DOI 10.17487/RFC4252,
January 2006, <https://www.rfc-editor.org/info/rfc4252>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>.
[RFC9000] Iyengar, J., Ed. and M. Thomson, Ed., "QUIC: A UDP-Based
Multiplexed and Secure Transport", RFC 9000,
DOI 10.17487/RFC9000, May 2021,
<https://www.rfc-editor.org/info/rfc9000>.
[RFC9293] Eddy, W., Ed., "Transmission Control Protocol (TCP)",
STD 7, RFC 9293, DOI 10.17487/RFC9293, August 2022,
<https://www.rfc-editor.org/info/rfc9293>.
[RFC9640] Watsen, K., "YANG Data Types and Groupings for
Cryptography", RFC 9640, DOI 10.17487/RFC9640, October
2024, <https://www.rfc-editor.org/info/rfc9640>.
7.2. Informative References
[HTTP-CLIENT-SERVER]
Watsen, K., "YANG Groupings for HTTP Clients and HTTP
Servers", Work in Progress, Internet-Draft, draft-ietf-
netconf-http-client-server-23, 15 August 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-netconf-
http-client-server-23>.
[NETCONF-CLIENT-SERVER]
Watsen, K., "NETCONF Client and Server Models", Work in
Progress, Internet-Draft, draft-ietf-netconf-netconf-
client-server-37, 14 August 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-netconf-
netconf-client-server-37>.
[RESTCONF-CLIENT-SERVER]
Watsen, K., "RESTCONF Client and Server Models", Work in
Progress, Internet-Draft, draft-ietf-netconf-restconf-
client-server-38, 14 August 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-netconf-
restconf-client-server-38>.
[RFC1928] Leech, M., Ganis, M., Lee, Y., Kuris, R., Koblas, D., and
L. Jones, "SOCKS Protocol Version 5", RFC 1928,
DOI 10.17487/RFC1928, March 1996,
<https://www.rfc-editor.org/info/rfc1928>.
[RFC1929] Leech, M., "Username/Password Authentication for SOCKS
V5", RFC 1929, DOI 10.17487/RFC1929, March 1996,
<https://www.rfc-editor.org/info/rfc1929>.
[RFC2743] Linn, J., "Generic Security Service Application Program
Interface Version 2, Update 1", RFC 2743,
DOI 10.17487/RFC2743, January 2000,
<https://www.rfc-editor.org/info/rfc2743>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC6056] Larsen, M. and F. Gont, "Recommendations for Transport-
Protocol Port Randomization", BCP 156, RFC 6056,
DOI 10.17487/RFC6056, January 2011,
<https://www.rfc-editor.org/info/rfc6056>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data
Interchange Format", STD 90, RFC 8259,
DOI 10.17487/RFC8259, December 2017,
<https://www.rfc-editor.org/info/rfc8259>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>.
[RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of
Documents Containing YANG Data Models", BCP 216, RFC 8407,
DOI 10.17487/RFC8407, October 2018,
<https://www.rfc-editor.org/info/rfc8407>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
[RFC9641] Watsen, K., "A YANG Data Model for a Truststore",
RFC 9641, DOI 10.17487/RFC9641, October 2024,
<https://www.rfc-editor.org/info/rfc9641>.
[RFC9642] Watsen, K., "A YANG Data Model for a Keystore", RFC 9642,
DOI 10.17487/RFC9642, October 2024,
<https://www.rfc-editor.org/info/rfc9642>.
[RFC9644] Watsen, K., "YANG Groupings for SSH Clients and SSH
Servers", RFC 9644, DOI 10.17487/RFC9644, October 2024,
<https://www.rfc-editor.org/info/rfc9644>.
[RFC9645] Watsen, K., "YANG Groupings for TLS Clients and TLS
Servers", RFC 9645, DOI 10.17487/RFC9645, October 2024,
<https://www.rfc-editor.org/info/rfc9645>.
[SOCKS] Koblas, D. and M. Koblas, "SOCKS", USENIX UNIX Security
Symposium III, September 1992, <https://www.usenix.org/leg
acy/publications/library/proceedings/sec92/full_papers/
koblas.pdf>.
[SOCKS_4A] Lee, Y., "SOCKS 4A: A Simple Extension to SOCKS 4
Protocol", <https://www.openssh.com/txt/socks4a.protocol>.
[W3C.REC-xml-20081126]
Bray, T., Paoli, J., Sperberg-McQueen, C.M., Maler, E.,
and F. Yergeau, "Extensible Markup Language (XML) 1.0
(Fifth Edition)", World Wide Web Consortium
Recommendation REC-xml-20081126, November 2008,
<https://www.w3.org/TR/2008/REC-xml-20081126/>.
Acknowledgements
The authors would like to thank the following for lively discussions
on list and in the halls (ordered by first name): Éric Vyncke, Joe
Clarke, Jürgen Schönwälder, Ladislav Lhotka, Mallory Knodel, Martin
Duke, Michael Tüxen, Mohamed Boucadair, Nancy Cam-Winget, Nick
Hancock, Per Andersson, Rob Wilton, Roman Danyliw, Tom Petch, and Wim
Henderickx.
Authors' Addresses
Kent Watsen
Watsen Networks
Email: kent+ietf@watsen.net
Michael Scharf
Hochschule Esslingen
University of Applied Sciences
Kanalstr. 33
73728 Esslingen am Neckar
Germany
Email: michael.scharf@hs-esslingen.de
|