-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdraft-ietf-netconf-udp-notif-09.xml
1424 lines (1204 loc) · 57.2 KB
/
draft-ietf-netconf-udp-notif-09.xml
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
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
<?rfc toc="yes"?>
<?rfc tocompact="yes"?>
<?rfc tocdepth="3"?>
<?rfc tocindent="yes"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<rfc category="std" docName="draft-ietf-netconf-udp-notif-09"
ipr="trust200902">
<front>
<title abbrev="unyte-udp-notif">UDP-based Transport for Configured
Subscriptions</title>
<author fullname="Guangying Zheng" initials="G." surname="Zheng">
<organization>Huawei</organization>
<address>
<postal>
<street>101 Yu-Hua-Tai Software Road</street>
<city>Nanjing</city>
<code/>
<region>Jiangsu</region>
<country>China</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
</address>
</author>
<author fullname="Tianran Zhou" initials="T." surname="Zhou">
<organization>Huawei</organization>
<address>
<postal>
<street>156 Beiqing Rd., Haidian District</street>
<city>Beijing</city>
<region/>
<code/>
<country>China</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<author fullname="Thomas Graf" initials="T." surname="Graf">
<organization>Swisscom</organization>
<address>
<postal>
<street>Binzring 17</street>
<city>Zuerich 8045</city>
<region/>
<code/>
<country>Switzerland</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<author fullname="Pierre Francois" initials="P." surname="Francois">
<organization>INSA-Lyon</organization>
<address>
<postal>
<street/>
<city>Lyon</city>
<region/>
<code/>
<country>France</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<author fullname="Alex Huang Feng" initials="A." surname="Huang Feng">
<organization>INSA-Lyon</organization>
<address>
<postal>
<street/>
<city>Lyon</city>
<region/>
<code/>
<country>France</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<author fullname="Paolo Lucente" initials="P." surname="Lucente">
<organization>NTT</organization>
<address>
<postal>
<street>Siriusdreef 70-72</street>
<city>Hoofddorp, WT 2132</city>
<region/>
<code/>
<country>NL</country>
</postal>
<phone/>
<facsimile/>
<email>[email protected]</email>
<uri/>
</address>
</author>
<date day="10" month="March" year="2023"/>
<workgroup>NETCONF</workgroup>
<abstract>
<t>This document describes an UDP-based notification mechanism to
collect data from networking devices. A shim header is proposed to
facilitate the data streaming directly from the publishing process on
network processor of line cards to receivers. The objective is to
provide a lightweight approach to enable higher frequency and less
performance impact on publisher and receiver processes compared to
already established notification mechanisms.</t>
</abstract>
<note title="Requirements Language">
<t>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 <xref target="RFC2119"/> <xref target="RFC8174"/>
when, and only when, they appear in all capitals, as shown here.</t>
</note>
</front>
<middle>
<section title="Introduction">
<t><xref target="RFC8639">Sub-Notif</xref> defines a mechanism that lets
a receiver subscribe to the publication of YANG-defined data maintained
in a <xref target="RFC7950">YANG</xref> datastore. The mechanism
separates the management and control of subscriptions from the transport
used to deliver the data. Three transport mechanisms, namely <xref
target="RFC8640">NETCONF transport</xref>, <xref
target="RFC8650">RESTCONF transport</xref>, and <xref
target="I-D.ietf-netconf-https-notif">HTTPS transport</xref> have been
defined so far for such notification messages.</t>
<t>While powerful in their features and general in their architecture,
the currently available transport mechanisms need to be complemented to
support data publications at high velocity from devices that feature a
distributed architecture. The currently available transports are based
on TCP and lack the efficiency needed to continuously send notifications
at high velocity.</t>
<t>This document specifies a transport option for Sub-Notif that
leverages UDP. Specifically, it facilitates the distributed data
collection mechanism described in <xref
target="I-D.ietf-netconf-distributed-notif"/>. In the case of publishing
from multiple network processors on multiple line cards, centralized
designs require data to be internally forwarded from those network
processors to the push server, presumably on a route processor, which
then combines the individual data items into a single consolidated
stream. The centralized data collection mechanism can result in a
performance bottleneck, especially when large amounts of data are
involved.</t>
<t>What is needed is a mechanism that allows for directly publishing
from multiple network processors on line cards, without passing them
through an additional processing stage for internal consolidation. The
proposed UDP-based transport allows for such a distributed data
publishing approach.</t>
<t><list style="symbols">
<t>Firstly, a UDP approach reduces the burden of maintaining a large
amount of active TCP connections at the receiver, notably in cases
where it collects data from network processors on line cards from a
large amount of networking devices.</t>
<t>Secondly, as no connection state needs to be maintained, UDP
encapsulation can be easily implemented by the hardware of the
publication streamer, which will further improve performance.</t>
<t>Ultimately, such advantages allow for a larger data analysis
feature set, as more voluminous, finer grained data sets can be
streamed to the receiver.</t>
</list></t>
<t>The transport described in this document can be used for transmitting
notification messages over both IPv4 and IPv6.</t>
<t>This document describes the notification mechanism. It is intended to
be used in conjunction with <xref target="RFC8639"/>, extended by <xref
target="I-D.ietf-netconf-distributed-notif"/>.</t>
<t><xref target="sec_transport"/> describes the control of the proposed
transport mechanism. <xref target="sec_ups_transport"/> details the
notification mechanism and message format. <xref target="sec_options"/>
describes the use of options in the notification message header. <xref
target="sec_applicability"/> covers the applicability of the proposed
mechanism. <xref target="sec_dtls_udp_notif"/> describes a mechanism to
secure the protocol in open networks.</t>
</section>
<section anchor="sec_transport"
title="Configured Subscription to UDP-Notif">
<t>This section describes how the proposed mechanism can be controlled
using subscription channels based on NETCONF or RESTCONF.</t>
<t>Following the usual approach of Sub-Notif, configured subscriptions
contain the location information of all the receivers, including the IP
address and the port number, so that the publisher can actively send
UDP-Notif messages to the corresponding receivers.</t>
<t>Note that receivers MAY NOT be already up and running when the
configuration of the subscription takes effect on the monitored device.
The first message MUST be a separate subscription-started notification
to indicate the Receiver that the stream has started flowing. Then, the
notifications can be sent immediately without delay. All the
subscription state notifications, as defined in <xref
target="RFC8639"/>, MUST be encapsulated in separate notification
messages.</t>
</section>
<section anchor="sec_ups_transport" title="UDP-Based Transport">
<t>In this section, we specify the UDP-Notif Transport behavior. <xref
target="sec_design"/> describes the general design of the solution.
<xref target="sec_ups_format"/> specifies the UDP-Notif message format.
<xref target="sec_options"/> describes a generic optional sub TLV
format. <xref target="sec_fragmentation"/> uses such options to provide
a segmentation solution for large UDP-Notif message payloads. <xref
target="sec_encoding"/> describes the encoding of the message
payload.</t>
<section anchor="sec_design" title="Design Overview">
<t>As specified in Sub-Notif, the telemetry data is encapsulated in
the NETCONF/RESTCONF notification message, which is then encapsulated
and carried using transport protocols such as TLS or HTTP2. This
document defines a UDP based transport. <xref
target="fig_ups_message"/> illustrates the structure of an UDP-Notif
message.</t>
<t><list style="symbols">
<t>The Message Header contains information that facilitate the
message transmission before deserializing the notification
message.</t>
<t>Notification Message is the encoded content that the
publication stream transports. The common encoding methods
are listed in <xref target="sec_ups_format"/>. The structure of
the Notification Message is defined in Section 2.6 of
<xref target="RFC8639"/>. <xref target="I-D.ietf-netconf-notification-messages"/> proposes a
structure to send bundled notifications in a single message.</t>
</list></t>
<t><figure anchor="fig_ups_message" title="UDP-Notif Message Overview">
<artwork align="center"><![CDATA[
+-------+ +--------------+ +--------------+
| UDP | | Message | | Notification |
| | | Header | | Message |
+-------+ +--------------+ +--------------+
]]></artwork>
</figure></t>
<t/>
</section>
<section anchor="sec_ups_format"
title="Format of the UDP-Notif Message Header">
<t>The UDP-Notif Message Header contains information that facilitate
the message transmission before deserializing the notification
message. The data format is shown in <xref
target="fig_ups_header"/>.</t>
<figure anchor="fig_ups_header"
title="UDP-Notif Message Header Format">
<artwork align="center"><![CDATA[
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-----+-+-------+---------------+-------------------------------+
| Ver |S| MT | Header Len | Message Length |
+-----+-+-------+---------------+-------------------------------+
| Observation-Domain-ID |
+---------------------------------------------------------------+
| Message-ID |
+---------------------------------------------------------------+
~ Options ~
+---------------------------------------------------------------+
]]></artwork>
</figure>
<t/>
<t>The Message Header contains the following field:</t>
<t><list style="symbols">
<t>Ver represents the PDU (Protocol Data Unit) encoding version.
The current version value is 1.</t>
<t>S represents the space of media type specified in the MT field.
When S is unset, MT represents the standard media types as defined
in this document. When S is set, MT represents a private space to
be freely used for non standard encodings.</t>
<t>MT is a 4 bit identifier to indicate the media type used for
the Notification Message. 16 types of encoding can be expressed.
When the S bit is unset, the following values apply:<list
style="symbols">
<t>0: Reserved;</t>
<t>1: application/yang-data+json <xref target="RFC8040"/></t>
<t>2: application/yang-data+xml <xref target="RFC8040"/></t>
<t>3: application/yang-data+cbor <xref target="RFC9254"/></t>
</list></t>
<t>Header Len is the length of the message header in octets,
including both the fixed header and the options.</t>
<t>Message Length is the total length of the message within one
UDP datagram, measured in octets, including the message
header.</t>
<t>Observation-Domain-ID is a 32-bit identifier of the Observation
Domain that led to the production of the notification message, as defined in
<xref target="I-D.ietf-netconf-distributed-notif"/>. This allows
disambiguation of an information source, such as the identification of
different line cards sending the notification messages. Message unicity is
obtained from the conjonction of the Observation-Domain-ID and the
Message-ID field described below.
<!-- If Observation-Domain-ID unicity is preserved through the collection domain, it SHOULD be used
to identify the information source, notably to reconstruct segmented messages using the segmentation option.-->
If Observation-Domain-ID unicity is not preserved through the collection
domain, the source IP address of the UDP datagram SHOULD be used
in addition to the Observation-Domain-ID to identify the information source.
If a transport layer relay is used, Observation-Domain-ID unicity must
be preserved through the collection domain.</t>
<!--The source IP address of the UDP datagrams SHOULD NOT be
interpreted as the identifier for the host that originated the
UDP-Notif message. Indeed, the streamer sending the UDP-Notif
message could be a relay for the actual source of data carried
within UDP-Notif messages. Note that if a relay is used,
Observation-Domain-ID unicity MUST be preserved in order to ensure
unicity of the Message-ID field described below.</t>-->
<t>The Message-ID is generated continuously by the publisher of
UDP-Notif messages. A publisher MUST use different Message-ID
values for different messages generated with the same Observation-Domain-ID.
Note that the main purpose of the Message-ID is to reconstruct
messages which were segmented using the segmentation option described
in section <xref target="sec_fragmentation"/>. The Message-ID values
SHOULD be incremented by one for each successive message originated with
the same Observation-Domain-ID, so that message loss can be detected.
Furthermore, incrementing the Message-ID by one allows for a large amount
of time to happen before the Message-ID's are reused due to wrapping around.
Different subscribers MAY share the same Message-ID sequence.</t>
<t>Options is a variable-length field in the TLV format. When the
Header Length is larger than 12 octets, which is the length of the
fixed header, Options TLVs follow directly after the fixed message
header (i.e., Message-ID). The details of the options are
described in <xref target="sec_options"/>.</t>
</list></t>
<t/>
</section>
<section anchor="sec_encoding" title="Data Encoding">
<t>UDP-Notif message data can be encoded in CBOR, XML or JSON format.
It is conceivable that additional encodings may be supported in the
future. This can be accomplished by augmenting the subscription data
model with additional identity statements used to refer to requested
encodings.</t>
<t>Private encodings can be supported through the use of the S bit of
the header. When the S bit is set, the value of the MT field is left
to be defined and agreed upon by the users of the private encoding. An
option is defined in <xref target="sec_enc_opt"/> for more verbose
encoding descriptions than what can be described with the MT
field.</t>
<t>Implementation MAY support multiple encoding methods per
subscription. When bundled notifications are supported between the
publisher and the receiver, only subscribed notifications with the
same encoding can be bundled in a given message.</t>
</section>
</section>
<section anchor="sec_options" title="Options">
<t>All the options are defined with the following format, illustrated in
<xref target="fig_ups_message_options"/>.</t>
<t><figure anchor="fig_ups_message_options"
title="Generic Option Format">
<artwork align="center"><![CDATA[
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+---------------+---------------+--------------------------------
| Type | Length | Variable-length data
+---------------+---------------+--------------------------------]]></artwork>
</figure></t>
<t><list style="symbols">
<t>Type: 1 octet describing the option type;</t>
<t>Length: 1 octet representing the total number of octets in the
TLV, including the Type and Length fields;</t>
<t>Variable-length data: 0 or more octets of TLV Value.</t>
</list></t>
<t>When more than one option are used in the UDP-notif header, options
MUST be ordered by the Type value. Messages with unordered options MAY
be dropped by the Receiver.</t>
<section anchor="sec_fragmentation" title="Segmentation Option">
<t>The UDP payload length is limited to 65535. Application level
headers will make the actual payload shorter. Even though binary
encodings such as CBOR may not require more space than what is left,
more voluminous encodings such as JSON and XML may suffer from this
size limitation. Although IPv4 and IPv6 publishers can fragment
outgoing packets exceeding their Maximum Transmission Unit(MTU),
fragmented IP packets may not be desired for operational and
performance reasons.</t>
<t>Consequently, implementations of the mechanism SHOULD provide a
configurable max-segment-size option to control the maximum size of a
payload.</t>
<figure anchor="fig_frag_option" title="Segmentation Option Format">
<artwork align="center"><![CDATA[
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+---------------+---------------+-----------------------------+-+
| Type | Length | Segment Number |L|
+---------------+---------------+-----------------------------+-+
]]></artwork>
</figure>
<t>The Segmentation Option is to be included when the message content
is segmented into multiple pieces. Different segments of one message
share the same Message-ID. An illustration is provided in <xref
target="fig_frag_option"/>. The fields of this TLV are:</t>
<t><list style="symbols">
<t>Type: Generic option field which indicates a Segmentation
Option. The Type value is to be assigned TBD1.</t>
<t>Length: Generic option field which indicates the length of this
option. It is a fixed value of 4 octets for the Segmentation
Option.</t>
<t>Segment Number: 15-bit value indicating the sequence number of
the current segment. The first segment of a segmented message has
a Segment Number value of 0.</t>
<t>L: is a flag to indicate whether the current segment is the
last one of the message. When 0 is set, the current segment is not
the last one. When 1 is set, the current segment is the last one,
meaning that the total number of segments used to transport this
message is the value of the current Segment Number + 1.</t>
</list></t>
<t>An implementation of this specification MUST NOT rely on IP
fragmentation by default to carry large messages. An implementation of
this specification MUST either restrict the size of individual
messages carried over this protocol, or support the segmentation
option.</t>
<t>When a message has multiple options and is segmented using the
described mechanism, all the options MUST be present on the first
segment ordered by the options Type. The rest of segmented messages
MAY include all the options ordered by options type.</t>
</section>
<section anchor="sec_enc_opt" title="Private Encoding Option">
<t>The space to describe private encodings in the MT field of the
UDP-Notif header being limited, an option is provided to describe
custom encodings. The fields of this option are as follows.</t>
<figure anchor="fig_enc_option" title="Private Encoding Option Format">
<artwork align="center"><![CDATA[
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+---------------+---------------+--------------------------------
| Type | Length | Variable length enc. descr.
+---------------+---------------+--------------------------------
]]></artwork>
</figure>
<t><list style="symbols">
<t>Type: Generic option field which indicates a Private Encoding
Option. The Type value is to be assigned TBD2.</t>
<t>Length: Generic option field which indicates the length of this
option. It is a variable value.</t>
<t>Enc. Descr: The description of the private encoding used for
this message. The values to be used for such private encodings is
left to be defined by the users of private encodings.</t>
</list></t>
<t>This option SHOULD only be used when the S bit of the header is
set, as providing a private encoding description for standard
encodings is meaningless.</t>
</section>
</section>
<section anchor="sec_applicability" title="Applicability">
<t>In this section, we provide an applicability statement for the
proposed mechanism, following the recommendations of <xref
target="RFC8085"/>.</t>
<t>The proposed mechanism falls in the category of UDP applications
"designed for use within the network of a single network operator or on
networks of an adjacent set of cooperating network operators, to be
deployed in controlled environments", as defined in <xref
target="RFC8085"/>. Implementations of the proposed
mechanism SHOULD thus follow the recommendations in place for such
specific applications. In the following, we discuss recommendations on
congestion control, message size guidelines, reliability considerations
and security considerations.</t>
<section anchor="sec_congestion_control" title="Congestion Control">
<t>The proposed application falls into the category of applications
performing transfer of large amounts of data. It is expected that the
operator using the solution configures QoS on its related flows. As
per <xref target="RFC8085"/>, such applications MAY choose not to
implement any form of congestion control, but follow the following
principles.</t>
<t>It is NOT RECOMMENDED to use the proposed mechanism over
congestion-sensitive network paths. The only environments where
UDP-Notif is expected to be used are managed networks. The deployments
require that the network path has been explicitly provisioned to
handle the traffic through traffic engineering mechanisms, such as
rate limiting or capacity reservations.</t>
<t>Implementation of the proposal SHOULD NOT push unlimited amounts of
traffic by default, and SHOULD require the users to explicitly
configure such a mode of operation.</t>
<t>Burst mitigation through packet pacing is RECOMMENDED. Disabling
burst mitigation SHOULD require the users to explicitly configure such
a mode of operation.</t>
<t>Applications SHOULD monitor packet losses and provide means to the
user for retrieving information on such losses. The UDP-Notif Message
ID can be used to deduce congestion based on packet loss detection.
Hence the receiver can notify the device to use a lower streaming
rate. The interaction to control the streaming rate on the device is
out of the scope of this document.</t>
</section>
<section anchor="sec_message_size" title="Message Size">
<t><xref target="RFC8085"/> recommends not to rely on IP fragmentation
for messages whose size result in IP packets exceeding the MTU along
the path. The segmentation option of the current specification permits
segmentation of the UDP Notif message content without relying on IP
fragmentation. Implementation of the current specification SHOULD
allow for the configuration of the MTU.</t>
</section>
<section anchor="sec_reliability" title="Reliability">
<t>The target application for UDP-Notif is the collection of
data-plane information. The lack of reliability of the data streaming
mechanism is thus considered acceptable as the mechanism is to be used
in controlled environments, mitigating the risk of information loss,
while allowing for publication of very large amounts of data.
Moreover, in this context, sporadic events when incomplete data
collection is provided is not critical for the proper management of
the network, as information collected for the devices through the
means of the proposed mechanism is to be often refreshed.</t>
<t>A receiver implementation for this protocol SHOULD deal with
potential loss of packets carrying a part of segmented payload, by
discarding packets that were received, but cannot be re-assembled as a
complete message within a given amount of time. This time SHOULD be
configurable.</t>
</section>
</section>
<section anchor="sec_dtls_udp_notif" title="Secured layer for UDP-notif">
<t>In open or unsecured networks, UDP-notif messages MUST be secured
or encrypted. In this section, a mechanism using DTLS 1.3 to secure
UDP-notif protocol is presented. The following sections defines the
requirements for the implementation of the secured layer of DTLS for
UDP-notif. No DTLS 1.3 extensions are defined nor needed.</t>
<t>The DTLS 1.3 protocol <xref target="RFC9147"/> is
designed to meet the requirements of applications that need to secure
datagram transport. Implementations using DTLS to secure UDP-notif
messages MUST use DTLS 1.3 protocol as defined in <xref target="RFC9147"/>
without any new extensions.</t>
<t>When this security layer is used, the Publisher MUST always be a
DTLS client, and the Receiver MUST always be a DTLS server. The
Receivers MUST support accepting UDP-notif Messages on the specified
UDP port, but MAY be configurable to listen on a different port. The
Publisher MUST support sending UDP-notif messages to the specified UDP
port, but MAY be configurable to send messages to a different port.
The Publisher MAY use any source UDP port for transmitting
messages.</t>
<section anchor="sec_session_lifecycle" title="Session lifecycle">
<section title="DTLS Session Initiation">
<t>The Publisher initiates a DTLS connection by sending a DTLS
ClientHello to the Receiver. Implementations MAY support the denial
of service countermeasures defined by DTLS 1.3. When these
countermeasures are used, the Receiver responds with a DTLS
HelloRetryRequest containing a stateless cookie. The Publisher MUST
send a new DTLS ClientHello message containing the received cookie,
which initiates the DTLS handshake.</t>
<t>When DTLS is implemented, the Publisher MUST NOT send any
UDP-notif messages before the DTLS handshake has successfully
completed. Early data mechanism (also known as 0-RTT data) as defined in
<xref target="RFC9147"/> MUST NOT be used.</t>
<t>Implementations of this security layer MUST support DTLS 1.3
<xref target="RFC9147"/> and MUST support the
mandatory to implement cipher suite TLS_AES_128_GCM_SHA256 and
SHOULD implement TLS_AES_256_GCM_SHA384 and
TLS_CHACHA20_POLY1305_SHA256 cipher suites, as specified in TLS 1.3
<xref target="RFC8446"/>. If additional cipher suites are supported,
then implementations MUST NOT negotiate a cipher suite that employs
NULL integrity or authentication algorithms.</t>
<t>Where privacy is REQUIRED, then implementations must either
negotiate a cipher suite that employs a non-NULL encryption
algorithm or otherwise achieve privacy by other means, such as a
physically secured network.</t>
</section>
<section title="Publish Data">
<t>When DTLS is used, all UDP-notif messages MUST be published as
DTLS "application_data". It is possible that multiple UDP-notif
messages are contained in one DTLS record, or that a publication
message is transferred in multiple DTLS records. The application
data is defined with the following ABNF <xref target="RFC5234"/>
expression:</t>
<t>APPLICATION-DATA = 1*UDP-NOTIF-FRAME</t>
<t>UDP-NOTIF-FRAME = MSG-LEN SP UDP-NOTIF-MSG</t>
<t>MSG-LEN = NONZERO-DIGIT *DIGIT</t>
<t>SP = %d32</t>
<t>NONZERO-DIGIT = %d49-57</t>
<t>DIGIT = %d48 / NONZERO-DIGIT</t>
<t>UDP-NOTIF-MSG is defined in <xref
target="sec_ups_transport"/>.</t>
<t>The Publisher SHOULD attempt to avoid IP fragmentation by using
the Segmentation Option in the UDP-notif message.</t>
</section>
<section title="Session termination">
<t>A Publisher MUST close the associated DTLS connection if the
connection is not expected to deliver any UDP-notif Messages later.
It MUST send a DTLS close_notify alert before closing the
connection. A Publisher (DTLS client) MAY choose to not wait for the
Receiver's close_notify alert and simply close the DTLS connection.
Once the Receiver gets a close_notify from the Publisher, it MUST
reply with a close_notify.</t>
<t>When no data is received from a DTLS connection for a long time,
the Receiver MAY close the connection. Implementations SHOULD set
the timeout value to 10 minutes but application specific profiles
MAY recommend shorter or longer values. The Receiver (DTLS server)
MUST attempt to initiate an exchange of close_notify alerts with the
Publisher before closing the connection. Receivers that are
unprepared to receive any more data MAY close the connection after
sending the close_notify alert.</t>
<t>Although closure alerts are a component of TLS and so of DTLS,
they, like all alerts, are not retransmitted by DTLS and so may be
lost over an unreliable network.</t>
</section>
</section>
</section>
<section title="A YANG Data Model for Management of UDP-Notif">
<t>The YANG model described in <xref target="sec_yang_model"/> defines
a new receiver instance for UDP-notif transport. When this transport is
used, four new leaves and a dtls container allow configuring UDP-notif
receiver parameters.</t>
<t><figure>
<artwork><![CDATA[
module: ietf-udp-notif-transport
augment /sn:subscriptions/snr:receiver-instances
/snr:receiver-instance/snr:transport-type:
+--:(udp-notif)
+--rw udp-notif-receiver
+--rw address inet:ip-address-no-zone
+--rw port inet:port-number
+--rw enable-segmentation? boolean {segmentation}?
+--rw max-segment-size? uint32 {segmentation}?
+--rw dtls! {dtls-supported}?
+--rw client-identity!
| +--rw (auth-type)
| +--:(certificate) {client-ident-x509-cert}?
| | ...
| +--:(raw-public-key) {client-ident-raw-public-key}?
| | ...
| +--:(tls13-epsk) {client-ident-tls13-epsk}?
| ...
+--rw server-authentication
| +--rw ca-certs! {server-auth-x509-cert}?
| | +--rw (local-or-truststore)
| | ...
| +--rw ee-certs! {server-auth-x509-cert}?
| | +--rw (local-or-truststore)
| | ...
| +--rw raw-public-keys! {server-auth-raw-public-key}?
| | +--rw (local-or-truststore)
| | ...
| +--rw tls13-epsks? empty
| {server-auth-tls13-epsk}?
+--rw hello-params {tlscmn:hello-params}?
| +--rw tls-versions
| | +--rw tls-version* identityref
| +--rw cipher-suites
| +--rw cipher-suite* identityref
+--rw keepalives {tls-client-keepalives}?
+--rw peer-allowed-to-send? empty
+--rw test-peer-aliveness!
+--rw max-wait? uint16
+--rw max-attempts? uint8
]]></artwork>
</figure></t>
</section>
<section anchor="sec_yang_model" title="YANG Module">
<t>This YANG module is used to configure, on a publisher, a receiver
willing to consume notification messages. This module augments
the "ietf-subscribed-notif-receivers" module to define a UDP-notif
transport receiver. The grouping "udp-notif-receiver-grouping"
defines the necessary parameters to configure this transport.
The grouping uses tls-client-grouping defined in <xref
target="I-D.ietf-netconf-tls-client-server"/> to add DTLS 1.3
parameters.
</t>
<t><figure>
<artwork><![CDATA[
<CODE BEGINS> file "[email protected]"
module ietf-udp-notif-transport {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-udp-notif-transport";
prefix unt;
import ietf-subscribed-notifications {
prefix sn;
reference
"RFC 8639: Subscription to YANG Notifications";
}
import ietf-subscribed-notif-receivers {
prefix snr;
reference
"RFC YYYY: An HTTPS-based Transport for
Configured Subscriptions";
}
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-tls-client {
prefix tlsc;
reference
"RFC TTTT: YANG Groupings for TLS Clients and TLS Servers";
}
organization "IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http:/tools.ietf.org/wg/netconf/>
WG List: <mailto:[email protected]>
Authors: Guangying Zheng
<mailto:[email protected]>
Tianran Zhou
<mailto:[email protected]>
Thomas Graf
<mailto:[email protected]>
Pierre Francois
<mailto:[email protected]>
Alex Huang Feng
<mailto:[email protected]>
Paolo Lucente
<mailto:[email protected]>";
description
"Defines UDP-Notif as a supported transport for subscribed
event notifications.
Copyright (c) 2022 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 XXXX; see the RFC
itself for full legal notices.";
revision 2023-03-10 {
description
"Initial revision";
reference
"RFC XXXX: UDP-based Transport for Configured Subscriptions";
}
/*
* FEATURES
*/
feature encode-cbor {
description
"This feature indicates that CBOR encoding of notification
messages is supported.";
}
feature dtls-supported {
description
"This feature indicates that DTLS encryption of notification
messages is supported.";
}
feature segmentation {
description
"This feature indicates segmentation of notification messages
is supported.";
}
/*
* IDENTITIES
*/
identity udp-notif {
base sn:transport;
description
"UDP-Notif is used as transport for notification messages
and state change notifications.";
}
identity encode-cbor {
base sn:encoding;
description
"Encode data using CBOR as described in RFC 9254.";
reference
"RFC 9254: CBOR Encoding of Data Modeled with YANG";
}
grouping udp-notif-receiver-grouping {
description
"Provides a reusable description of a UDP-Notif target
receiver.";
leaf address {
type inet:ip-address-no-zone;
mandatory true;
description
"IP address of target UDP-Notif receiver, which can be an
IPv4 address or an IPV6 address.";
}
leaf port {
type inet:port-number;
mandatory true;
description
"Port number of target UDP-Notif receiver.";
}
leaf enable-segmentation {
if-feature segmentation;
type boolean;
default false;
description
"The switch for the segmentation feature. When disabled, the
publisher will not allow fragment for a very large data";
}
leaf max-segment-size {
when "../enable-segmentation = 'true'";
if-feature segmentation;
type uint32;
description
"UDP-Notif provides a configurable max-segment-size to
control the size of each segment (UDP-Notif header, with
options, included).";
}
container dtls {
if-feature dtls-supported;
presence dtls;
uses tlsc:tls-client-grouping {
// Using tls-client-grouping without TLS1.2 parameters
// allowing only DTLS 1.3
refine "client-identity/auth-type/tls12-psk" {
// create the logical impossibility of enabling TLS1.2
if-feature "not tlsc:client-ident-tls12-psk";
}
refine "server-authentication/tls12-psks" {
// create the logical impossibility of enabling TLS1.2
if-feature "not tlsc:server-auth-tls12-psk";
}
}
description
"Container for configuring DTLS 1.3 parameters if DTLS is enabled.";
}
}
augment "/sn:subscriptions/snr:receiver-instances/" +
"snr:receiver-instance/snr:transport-type" {
case udp-notif {
container udp-notif-receiver {
description
"The UDP-notif receiver to send notifications to.";
uses udp-notif-receiver-grouping;
}
}
description
"Augment the transport-type choice to include the 'udp-notif'
transport.";
}
}
<CODE ENDS>]]></artwork>
</figure></t>
</section>