YANG Grouping for UDP
Clients and UDP ServersINSA-LyonLyonFrancealex.huang-feng@insa-lyon.frINSA-LyonLyonFrancepierre.francois@insa-lyon.frWatsen Networkskent+ietf@watsen.netThis document defines two YANG 1.1 modules to
support the configuration of UDP clients and UDP servers. The modules include
basic parameters for configuring UDP based clients and servers and a DTLS
container when encryption needs to be enabled.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
when, and only when,
they appear in all capitals, as shown here.This documents defines two YANG 1.1 modules to support
the configuration of UDP clients and UDP servers, either as standalone or in
conjunction with configuration of other protocol layers.The "ietf-udp-client" YANG module defines two groupings for configuring UDP clients:
the "udp-client-grouping" for UDP clients and the "udp-dtls-client-grouping" for UDP
clients with DTLS 1.3 enryption.The following tree diagram illustrates the
"udp-client-grouping" grouping:The following tree diagram illustrates the
"udp-dtls-client-grouping" grouping:The "ietf-udp-client" YANG module uses the groupings defined in
for configuring the
DTLS 1.3 encryption. file "ietf-udp-client@2023-10-16.yang"
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";
}
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:
WG List:
Authors: Alex Huang Feng
Pierre Francois
";
description
"Defines a generic grouping for UDP-based client applications.
Supports groupings for UDP clients and UDP clients with DTLS encryption.
Copyright (c) 2023 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 2023-10-16 {
description
"Initial revision";
reference
"RFC-to-be: YANG Grouping for UDP Clients and UDP Servers";
}
/*
* FEATURES
*/
feature dtls13 {
description
"This feature indicates that DTLS 1.3 encryption of UDP
packets is supported.";
}
grouping udp-client-grouping {
description
"Provides a reusable grouping for configuring a UDP client.";
leaf remote-address {
type inet:ip-address-no-zone;
mandatory true;
description
"IP address of the UDP client, which can be an
IPv4 address or an IPV6 address.";
}
leaf remote-port {
type inet:port-number;
mandatory true;
description
"Port number of the UDP client.";
}
}
grouping udp-dtls-client-grouping {
description
"Provides a reusable grouping for configuring a UDP client with
DTLS encryption.";
uses udp-client-grouping;
container dtls {
if-feature dtls13;
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.";
}
}
}
]]>The "ietf-udp-server" YANG module defines two groupings for configuring UDP servers:
the "udp-server-grouping" for UDP servers and the "udp-dtls-server-grouping" for UDP
servers with DTLS 1.3 enryption.The following tree diagram illustrates the
"udp-server-grouping" grouping:The following tree diagram illustrates the
"udp-dtls-server-grouping" grouping:The "ietf-udp-server" YANG module uses the groupings defined in
for configuring the
DTLS 1.3 encryption. file "ietf-udp-server@2023-10-16.yang"
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";
}
import ietf-tls-server {
prefix tlss;
reference
"RFC FFFF: YANG Groupings for TLS Clients and TLS Servers";
}
organization "IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web:
WG List:
Authors: Alex Huang Feng
Pierre Francois
";
description
"Defines a generic grouping for UDP-based server applications.
Supports groupings for UDP servers and UDP servers with DTLS encryption.
Copyright (c) 2023 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 2023-10-16 {
description
"Initial revision";
reference
"RFC-to-be: YANG Grouping for UDP Clients and UDP Servers";
}
/*
* FEATURES
*/
feature dtls13 {
description
"This feature indicates that DTLS 1.3 encryption of UDP
packets is supported.";
}
grouping udp-server-grouping {
description
"Provides a reusable grouping for configuring a UDP servers.";
leaf local-address {
type inet:ip-address-no-zone;
mandatory true;
description
"IP address of the UDP server, which can be an
IPv4 address or an IPV6 address.";
}
leaf local-port {
type inet:port-number;
mandatory true;
description
"Port number of the UDP server.";
}
}
grouping udp-dtls-server-grouping {
description
"Provides a reusable grouping for configuring a UDP server with
DTLS encryption.";
uses udp-server-grouping;
container dtls {
if-feature dtls13;
presence dtls;
uses tlss:tls-server-grouping {
// Using tls-server-grouping without TLS1.2 parameters
// allowing only DTLS 1.3
refine "server-identity/auth-type/tls12-psk" {
// create the logical impossibility of enabling TLS1.2
if-feature "not tlss:server-ident-tls12-psk";
}
refine "client-authentication/tls12-psks" {
// create the logical impossibility of enabling TLS1.2
if-feature "not tlss:client-auth-tls12-psk";
}
}
description
"Container for configuring DTLS 1.3 parameters.";
}
}
}
]]>TODO:This document describes the URIs from IETF
XML Registry and the registration of a two new YANG module namesIANA is requested to assign two new URI from the IETF XML Registry. The following two URIs are
suggested:This document also requests two new YANG module names in the
YANG Module Names registry with the
following suggestions:The authors would like to thank xxx for their review and valuable
comments.