An HTTPS-based Transport for
Configured SubscriptionsVMwaremjethanandani@gmail.comWatsen NetworksUSAkent+ietf@watsen.net
Routing
NETCONFhttpyangnotificationThis document defines a YANG data module for configuring HTTPS based
configured subscription, as defined
I-D.ietf-netconf-subscribed-notifications. The use of HTTPS maximizes
transport-level interoperability, while allowing for encoding selection
from text, e.g. XML or JSON, to binary.Subscribed
Notifications defines a YANG data module for configuring
subscribed notifications. It even defines a subscriptions container that
contains a list of receivers. But it defers the configuration and
management of those receivers to other documents. This document defines
a YANG data module for configuring and
managing HTTPS based receivers for the notifications. Such a configured
receiver can be a third party collector, collecting events on behalf of
receivers that want to co-relate events from different publishers.
Configured subscriptions enable a server, acting as a publisher of
notifications, to proactively push notifications to external receivers
without the receivers needing to first connect to the server, as is the
case with dynamic subscriptions.This document describes how to enable the transmission of YANG
modeled notifications, in the configured encoding (i.e., XML, JSON) over
HTTPS. The use of HTTPS maximizes transport-level interoperability,
while the encoding selection pivots between implementation simplicity
(XML, JSON) and throughput (text versus binary).This document uses several placeholder values throughout the
document. Please replace them as follows and remove this section
before publication.RFC XXXX, where XXXX is the number assigned to this document at the
time of publication.2019-09-17 with the actual date of the publication of this
document.AcronymExpansionHTTPHyper Text Transport ProtocolTCPTransmission Control ProtocolTLSTransport Layer SecurityThe 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 RFC2119RFC8174 when, and only when, they appear in
all capitals, as shown here.The following terms are defined in Subscribed
Notifications.Subscribed NotificationsThe YANG module is a definition of a set of receivers that are
interested in the notifications published by the publisher. The module
contains the TCP, TLS and HTTPS parameters that are needed to
communicate with the receiver. The module augments the Subscribed
Notifications receiver container to create a reference to a
receiver defined by the YANG module.An abridged tree diagram representing the module is shown
below. /receivers/receiver/name
]]>The YANG module is shown below. file "ietf-https-notif@2019-09-17.yang"
module ietf-https-notif {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-https-notif";
prefix "hsn";
import ietf-subscribed-notifications {
prefix sn;
reference
"I-D.ietf-netconf-subscribed-notifications";
}
import ietf-tcp-client {
prefix tcpc;
}
import ietf-tls-client {
prefix tlsc;
}
import ietf-http-client {
prefix httpc;
}
organization
"IETF NETCONF Working Group";
contact
"WG Web:
WG List:
Authors: Mahesh Jethanandani (mjethanandani at gmail dot com)
Kent Watsen (kent plus ietf at watsen dot net)";
description
"YANG module for configuring HTTPS base configuration.
Copyright (c) 2018 IETF Trust and the persons identified as
the document authors. 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 Simplified BSD
License set forth in Section 4.c of the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://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 "2019-09-17" {
description
"Initial Version.";
reference
"RFC XXXX, YANG Data Module for HTTPS Notifications.";
}
identity https {
base sn:transport;
description
"HTTPS transport for notifications.";
}
container receivers {
list receiver {
key "name";
leaf name {
type string;
description
"A name that uniquely identifies this receiver.";
}
container tcp-params {
uses tcpc:tcp-client-grouping;
description
"TCP client parameters.";
}
container tls-params {
uses tlsc:tls-client-grouping;
description
"TLS client parameters.";
}
container http-params {
uses httpc:http-client-grouping;
description
"HTTP client parameters.";
}
description
"All receivers interested in this notification.";
}
description
"HTTPS based notifications.";
}
augment "/sn:subscriptions/sn:subscription/sn:receivers/sn:receiver" {
leaf receiver-ref {
type leafref {
path "/receivers/receiver/name";
}
description
"Reference to a receiver.";
}
description
"Augment the subscriptions container to define the receiver.";
}
}
]]>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 or RESTCONF. The lowest NETCONF layer is the secure
transport layer, and the mandatory-to-implement secure transport is
Secure Shell (SSH). The lowest RESTCONF
layer is HTTPS, and the mandatory-to-implement secure transport is TLS. The NETCONF Access
Control Model (NACM) 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.There are a number of data nodes defined in this YANG module that are
writable/creatable/deletable (i.e., config true, which is the default).
These data nodes may be considered sensitive or vulnerable in some
network environments. Write operations (e.g., edit-config) to these data
nodes without proper protection can have a negative effect on network
operations. These are the subtrees and data nodes and their
sensitivity/vulnerability:Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or
notification) to these data nodes. These are the subtrees and data nodes
and their sensitivity/vulnerability:Some of the RPC operations in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control access to these operations. These are the
operations and their sensitivity/vulnerability:This document registers one URI and one YANG module.in the IETF XML registry [RFC3688].
Following the format in RFC 3688, the following registration is
requested to be made: Registrant Contact: The IESG. XML: N/A, the requested URI is an XML
namespace.This document registers three YANG module in the YANG Module Names
registry YANG.This section tries to show some examples in how the model can be
used.This example shows how a HTTPS client can be configured to send
notifications to a receiver at address 192.0.2.1, port 443 with server
certificates, and the corresponding trust store that is used to
authenticate a connection.foo192.0.2.1443192.0.3.163001explicitly-trusted-server-ca-certsexplicitly-trusted-server-certs
6666foosome-streammy-receiverfoo
explicitly-trusted-server-certs
Specific server authentication certificates for explicitly
trusted servers. These are needed for server certificates
that are not signed by a pinned CA.
Fred Flintstonebase64encodedvalue==explicitly-trusted-server-ca-certs
Trust anchors (i.e. CA certs) that are used to authenticate\
server connections. Servers are authenticated if their
certificate has a chain of trust to one of these CA
certificates.
ca.example.combase64encodedvalue==
]]>