-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-ietf-netconf-udp-client-server-03.txt
672 lines (440 loc) · 21.4 KB
/
draft-ietf-netconf-udp-client-server-03.txt
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
Network Working Group A. Huang Feng
Internet-Draft P. Francois
Intended status: Standards Track INSA-Lyon
Expires: 5 January 2025 K. Watsen
Watsen Networks
4 July 2024
YANG Groupings for UDP Clients and UDP Servers
draft-ietf-netconf-udp-client-server-03
Abstract
This document defines two YANG 1.1 modules to support the
configuration of UDP clients and UDP servers.
Requirements 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.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 5 January 2025.
Copyright Notice
Copyright (c) 2024 IETF Trust and the persons identified as the
document authors. All rights reserved.
Huang Feng, et al. Expires 5 January 2025 [Page 1]
Internet-Draft udp-client-server-grouping July 2024
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 . . . . . . . . . . . . . . . . . . . . . . . . 2
2. The "ietf-udp-client" Module . . . . . . . . . . . . . . . . 2
2.1. The "udp-client-grouping" Grouping . . . . . . . . . . . 2
2.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 3
2.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 3
3. The "ietf-udp-server" Module . . . . . . . . . . . . . . . . 5
3.1. The "udp-server-grouping" Grouping . . . . . . . . . . . 5
3.2. Example Usage . . . . . . . . . . . . . . . . . . . . . . 6
3.3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 6
4. Security Considerations . . . . . . . . . . . . . . . . . . . 8
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
5.1. URI . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.2. YANG module name . . . . . . . . . . . . . . . . . . . . 10
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 10
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 10
7.1. Normative References . . . . . . . . . . . . . . . . . . 10
7.2. Informative References . . . . . . . . . . . . . . . . . 11
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 12
1. Introduction
This document defines two YANG 1.1 [RFC7950] modules to support the
configuration of UDP clients and UDP servers [RFC768], either as
standalone or in conjunction with configuration of other layers.
2. The "ietf-udp-client" Module
The "ietf-udp-client" YANG module defines the "udp-client-grouping"
grouping for configuring UDP clients with remote server information.
2.1. The "udp-client-grouping" Grouping
The following tree diagram [RFC8340] illustrates the tree structure
of the "udp-client-grouping" grouping:
Huang Feng, et al. Expires 5 January 2025 [Page 2]
Internet-Draft udp-client-server-grouping July 2024
module: ietf-udp-client
grouping udp-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}?
2.2. Example Usage
This section presents an example of usage of the "udp-client-
grouping" grouping.
<!-- The outermost element below doesn't exist in the data model. -->
<!-- It simulates if the "grouping" were a "container" instead. -->
<udp-client xmlns="urn:ietf:params:xml:ns:yang:ietf-udp-client">
<remote-address>www.example.com</remote-address>
<remote-port>10000</remote-port>
<local-address>192.0.2.2</local-address>
<local-port>12345</local-port>
</udp-client>
2.3. YANG Module
This module imports types defined in [RFC6991].
<CODE BEGINS> file "[email protected]"
module ietf-udp-client {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-udp-client";
prefix udpc;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
organization "IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http:/tools.ietf.org/wg/netconf/>
WG List: <mailto:[email protected]>
Authors: Alex Huang Feng
<mailto:[email protected]>
Pierre Francois
<mailto:[email protected]>";
Huang Feng, et al. Expires 5 January 2025 [Page 3]
Internet-Draft udp-client-server-grouping July 2024
description
"Defines a generic grouping for UDP-based client applications.
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-to-be; see the RFC
itself for full legal notices.";
revision 2024-06-27 {
description
"Initial revision";
reference
"RFC-to-be: YANG Groupings for UDP Clients and UDP Servers";
}
feature local-binding-supported {
description
"Indicates that the UDP client supports configuring local
bindings (i.e., the local address and local port) for
UDP clients.";
}
grouping udp-client-grouping {
description
"A reusable grouping for configuring a UDP 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
'udp-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 UDP server.
If a domain name is configured, then the DNS resolution should
Huang Feng, et al. Expires 5 January 2025 [Page 4]
Internet-Draft udp-client-server-grouping July 2024
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 UDP server.";
}
leaf local-address {
if-feature "local-binding-supported";
type inet:ip-address;
description
"The local IP address to bind to when sending UDP
messages to the remote server. INADDR_ANY ('0.0.0.0') or
INADDR6_ANY ('0:0:0:0:0:0:0:0' a.k.a. '::') may be used
so that the server can bind to any IPv4 or IPv6 address.";
}
leaf local-port {
if-feature "local-binding-supported";
type inet:port-number;
description
"The local port number to bind to when sending UDP
messages to the remote server.";
}
}
}
<CODE ENDS>
3. The "ietf-udp-server" Module
The "ietf-udp-server" YANG module defines the "udp-server-grouping"
grouping for configuring UDP servers.
3.1. The "udp-server-grouping" Grouping
The following tree diagram [RFC8340] illustrates the structure of
"udp-server-grouping" grouping:
Huang Feng, et al. Expires 5 January 2025 [Page 5]
Internet-Draft udp-client-server-grouping July 2024
module: ietf-udp-server
grouping udp-server-grouping:
+-- local-bind* [local-address]
+-- local-address inet:ip-address
+-- local-port? inet:port-number
3.2. Example Usage
This section presents two examples of usage of the "udp-server-
grouping" grouping. This example shows an example of a server
configured for listening to a IPv4 address:
<!-- The outermost element below doesn't exist in the data model. -->
<!-- It simulates if the "grouping" were a "container" instead. -->
<udp-server xmlns="urn:ietf:params:xml:ns:yang:ietf-udp-server">
<local-bind>
<local-address>192.0.2.2</local-address>
<local-port>49152</local-port>
</local-bind>
</udp-server>
This example shows an example of a server configured to listen to an
IPv4 and IPv6 together:
<!-- The outermost element below doesn't exist in the data model. -->
<!-- It simulates if the "grouping" were a "container" instead. -->
<udp-server xmlns="urn:ietf:params:xml:ns:yang:ietf-udp-server">
<local-bind>
<local-address>192.0.2.2</local-address>
<local-port>49152</local-port>
</local-bind>
<local-bind>
<local-address>2001:db8::0</local-address>
<local-port>49153</local-port>
</local-bind>
</udp-server>
3.3. YANG Module
The "ietf-udp-server" imports types defined in [RFC6991].
Huang Feng, et al. Expires 5 January 2025 [Page 6]
Internet-Draft udp-client-server-grouping July 2024
<CODE BEGINS> file "[email protected]"
module ietf-udp-server {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-udp-server";
prefix udps;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
organization "IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http:/tools.ietf.org/wg/netconf/>
WG List: <mailto:[email protected]>
Authors: Alex Huang Feng
<mailto:[email protected]>
Pierre Francois
<mailto:[email protected]>";
description
"Defines a generic grouping for UDP-based server applications.
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-to-be; see the RFC
itself for full legal notices.";
revision 2024-06-27 {
description
"Initial revision";
reference
"RFC-to-be: YANG Groupings for UDP Clients and UDP Servers";
}
grouping udp-server-grouping {
description
"Provides a reusable grouping for configuring a UDP server.
Huang Feng, et al. Expires 5 January 2025 [Page 7]
Internet-Draft udp-client-server-grouping July 2024
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
'udp-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;
mandatory true;
description
"The local IP address to listen on for incoming
UDP messages. 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 UDP
messages.";
}
}
}
}
<CODE ENDS>
4. Security Considerations
This section uses the template described in Section 3.7 of
[I-D.ietf-netmod-rfc8407bis].
Huang Feng, et al. Expires 5 January 2025 [Page 8]
Internet-Draft udp-client-server-grouping July 2024
The YANG module specified in this document defines a schema for data
that is designed to be accessed via network management protocols such
as NETCONF [RFC6241] or RESTCONF [RFC8040]. These network management
protocols are required to use a secure transport layer and mutual
authentication, e.g., SSH [RFC6242] without the "none" authentication
option, Transport Layer Security (TLS) [RFC8446] with mutual X.509
authentication, and HTTPS with HTTP authentication (Section 11 of
[RFC9110]).
The Network Configuration Access Control Model (NACM) [RFC8341]
provides the means to restrict access for particular NETCONF or
RESTCONF users to a preconfigured subset of all available NETCONF or
RESTCONF protocol operations and content.
The YANG module defines a set of identities, types, and groupings.
These nodes are intended to be reused by other YANG modules. The
module by itself does not expose any data nodes that are writable,
data nodes that contain read-only state, or RPCs. As such, there are
no additional security issues related to the YANG module that need to
be considered.
Modules that use the groupings that are defined in this document
should identify the corresponding security considerations. For
example, reusing some of these groupings will expose privacy-related
information (e.g., 'node-example').
5. IANA Considerations
This document describes the URIs from IETF XML Registry and the
registration of a two new YANG module names
5.1. URI
IANA is requested to assign two new URIs from the IETF XML Registry
[RFC3688]. The following two URIs are suggested:
URI: urn:ietf:params:xml:ns:yang:ietf-udp-client
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-udp-server
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
Huang Feng, et al. Expires 5 January 2025 [Page 9]
Internet-Draft udp-client-server-grouping July 2024
5.2. YANG module name
This document also requests IANA to register the following YANG
modules in the YANG Module Names registry [RFC6020] within the "YANG
Parameters" registry group:
name: ietf-udp-client
namespace: urn:ietf:params:xml:ns:yang:ietf-udp-client
prefix: udpc
maintained by IANA? N
reference: RFC-to-be
name: ietf-udp-server
namespace: urn:ietf:params:xml:ns:yang:ietf-udp-server
prefix: udps
maintained by IANA? N
reference: RFC-to-be
6. Acknowledgements
The authors would like to thank Mohamed Boucadair, Benoit Claise,
Qiufang Ma and Qin Wu for their review and valuable comments.
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>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[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>.
[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>.
Huang Feng, et al. Expires 5 January 2025 [Page 10]
Internet-Draft udp-client-server-grouping July 2024
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>.
[RFC768] Postel, J., "User Datagram Protocol", STD 6, RFC 768,
DOI 10.17487/RFC0768, August 1980,
<https://www.rfc-editor.org/info/rfc768>.
[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>.
[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>.
[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>.
[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>.
[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>.
[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>.
[RFC9110] Fielding, R., Ed., Nottingham, M., Ed., and J. Reschke,
Ed., "HTTP Semantics", STD 97, RFC 9110,
DOI 10.17487/RFC9110, June 2022,
<https://www.rfc-editor.org/info/rfc9110>.
7.2. Informative References
[I-D.ietf-netmod-rfc8407bis]
Bierman, A., Boucadair, M., and Q. Wu, "Guidelines for
Authors and Reviewers of Documents Containing YANG Data
Models", Work in Progress, Internet-Draft, draft-ietf-
Huang Feng, et al. Expires 5 January 2025 [Page 11]
Internet-Draft udp-client-server-grouping July 2024
netmod-rfc8407bis-12, 21 June 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-netmod-
rfc8407bis-12>.
Authors' Addresses
Alex Huang Feng
INSA-Lyon
Lyon
France
Email: [email protected]
Pierre Francois
INSA-Lyon
Lyon
France
Email: [email protected]
Kent Watsen
Watsen Networks
Email: [email protected]
Huang Feng, et al. Expires 5 January 2025 [Page 12]