draft-ietf-netconf-https-notif-01.txt   draft-ietf-netconf-https-notif-02.txt 
NETCONF M. Jethanandani NETCONF M. Jethanandani
Internet-Draft VMware Internet-Draft VMware
Intended status: Standards Track K. Watsen Intended status: Standards Track K. Watsen
Expires: May 2, 2020 Watsen Networks Expires: September 10, 2020 Watsen Networks
October 30, 2019 March 9, 2020
An HTTPS-based Transport for Configured Subscriptions An HTTPS-based Transport for Configured Subscriptions
draft-ietf-netconf-https-notif-01 draft-ietf-netconf-https-notif-02
Abstract Abstract
This document defines a YANG data module for configuring HTTPS based This document defines a YANG data module for configuring HTTPS based
configured subscription, as defined in Subscribed Notifications configured subscription, as defined in RFC 8639. The use of HTTPS
(RFC8639). The use of HTTPS maximizes transport-level maximizes transport-level interoperability, while allowing for
interoperability, while allowing for encoding selection from text, encoding selection from text, e.g. XML or JSON, to binary.
e.g. XML or JSON, to binary.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 2, 2020. This Internet-Draft will expire on September 10, 2020.
Copyright Notice Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Note to RFC Editor . . . . . . . . . . . . . . . . . . . 3 1.1. Applicability Statement . . . . . . . . . . . . . . . . . 3
1.2. Abbreviations . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Note to RFC Editor . . . . . . . . . . . . . . . . . . . 3
1.3. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.3. Abbreviations . . . . . . . . . . . . . . . . . . . . . . 3
1.3.1. Subscribed Notifications . . . . . . . . . . . . . . 3 1.4. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.4. Receiver and Publisher Interaction . . . . . . . . . . . 3 1.4.1. Subscribed Notifications . . . . . . . . . . . . . . 3
1.4.1. Pipelining of messages . . . . . . . . . . . . . . . 4 2. Learning Receiver Capabilities . . . . . . . . . . . . . . . 4
2. YANG module . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1. Introduction . . . . . . . . . . . . . . . . . . . . . . 4
2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . 6 2.2. Example . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.2. YANG module . . . . . . . . . . . . . . . . . . . . . . . 7 3. YANG module . . . . . . . . . . . . . . . . . . . . . . . . . 5
3. Security Considerations . . . . . . . . . . . . . . . . . . . 11 3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . 5
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11 3.2. YANG module . . . . . . . . . . . . . . . . . . . . . . . 6
4.1. URI Registration . . . . . . . . . . . . . . . . . . . . 11 4. Security Considerations . . . . . . . . . . . . . . . . . . . 10
4.2. YANG Module Name Registration . . . . . . . . . . . . . . 12 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
5. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 12 5.1. URI Registration . . . . . . . . . . . . . . . . . . . . 11
5.1. HTTPS Configured Subscription . . . . . . . . . . . . . . 12 5.2. YANG Module Name Registration . . . . . . . . . . . . . . 11
6. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 14 5.3. Media Types . . . . . . . . . . . . . . . . . . . . . . . 11
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 14 5.3.1. Media Type "application/ietf-https-notif-cap+xml . . 11
8. Normative references . . . . . . . . . . . . . . . . . . . . 14 5.3.2. Media Type "application/ietf-https-notif-cap+json . . 12
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 15 6. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 14
6.1. HTTPS Configured Subscription . . . . . . . . . . . . . . 14
6.2. Bundled Message . . . . . . . . . . . . . . . . . . . . . 16
7. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 17
8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 17
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 17
9.1. Normative references . . . . . . . . . . . . . . . . . . 17
9.2. Informative references . . . . . . . . . . . . . . . . . 19
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 19
1. Introduction 1. Introduction
Subscribed Notifications [RFC8639] defines a YANG data module for Subscription to YANG Notifications [RFC8639] defines a YANG data
configuring subscribed notifications. It even defines a module for configuring subscribed notifications. It defines a
subscriptions container that contains a list of receivers. But it "subscriptions" container that contains a list of receivers, but it
defers the configuration and management of those receivers to other defers the configuration and management of those receivers to other
documents. This document defines a YANG [RFC7950] data module for documents. This document defines a YANG 1.1 [RFC7950] data module
configuring and managing HTTPS based receivers for the notifications. for configuring and managing HTTPS based receivers for the
Such a configured receiver can be a third party collector, collecting notifications. Configured subscriptions enable a server, acting as a
events on behalf of receivers that want to correlate events from publisher of notifications, to proactively push notifications to
different publishers. Configured subscriptions enable a server, external receivers without the receivers needing to first connect to
acting as a publisher of notifications, to proactively push the server, as is the case with dynamic subscriptions.
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 This document describes how to enable the transmission of YANG
modeled notifications, in the configured encoding (i.e., XML, JSON) modeled notifications, in the configured encoding (i.e., XML, JSON)
over HTTPS. It comes in the form of a HTTPS POST. The use of HTTPS over HTTPS. Notifications are delivered in the form of a HTTPS POST.
maximizes transport-level interoperability, while the encoding The use of HTTPS maximizes transport-level interoperability, while
selection pivots between implementation simplicity (XML, JSON) and the encoding selection pivots between implementation simplicity (XML,
throughput (text versus binary). JSON) and throughput (text versus binary).
1.1. Note to RFC Editor 1.1. Applicability Statement
While the YANG module has been defined as an augmentation of
Subscription to YANG Notifications [RFC8639], the notification method
defined in this document MAY be used outside of Subscription to YANG
Notifications [RFC8639] by using the grouping defined in the model.
1.2. Note to RFC Editor
This document uses several placeholder values throughout the This document uses several placeholder values throughout the
document. Please replace them as follows and remove this section document. Please replace them as follows and remove this section
before publication. before publication.
RFC XXXX, where XXXX is the number assigned to this document at the RFC XXXX, where XXXX is the number assigned to this document at the
time of publication. time of publication.
2019-10-30 with the actual date of the publication of this document. 2020-03-09 with the actual date of the publication of this document.
1.2. Abbreviations 1.3. Abbreviations
+---------+-------------------------------+ +---------+--------------------------------------+
| Acronym | Expansion | | Acronym | Expansion |
+---------+-------------------------------+ +---------+--------------------------------------+
| HTTP | Hyper Text Transport Protocol | | HTTP | Hyper Text Transport Protocol |
| | | | | |
| TCP | Transmission Control Protocol | | HTTPS | Hyper Text Transport Protocol Secure |
| | | | | |
| TLS | Transport Layer Security | | TCP | Transmission Control Protocol |
+---------+-------------------------------+ | | |
| TLS | Transport Layer Security |
+---------+--------------------------------------+
1.3. Terminology 1.4. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP "OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
1.3.1. Subscribed Notifications 1.4.1. Subscribed Notifications
The following terms are defined in Subscribed Notifications The following terms are defined in Subscription to YANG Notifications
[RFC8639]. [RFC8639].
o Subscribed Notifications o Subscribed Notifications
1.4. Receiver and Publisher Interaction 2. Learning Receiver Capabilities
The interaction between the receiver and the publisher can be of type
"pipelining" or send multiple notifications as part of a "bundled-
message", as defined in Notification Message Headers and Bundles
[I-D.ietf-netconf-notification-messages]
1.4.1. Pipelining of messages
In the case of "pipelining", the flow of messages would look
something like this.
------------- --------------
| Publisher | | Receiver |
------------- --------------
Establish TCP ------>
Establish TLS ------>
Send HTTPS POST message
with YANG defined ------>
notification #1
Send HTTPS POST message
with YANG defined ------>
notification #2
Send 204 (No Content)
<------ for notification #1
Send 204 (No Content)
<------ for notification #2
Send HTTPS POST message
with YANG defined ------->
notification #3
Send 204 (No Content)
<------ for notification #3
The content of the exchange would look something like this.
Request:
POST /some/path HTTP/1.1 2.1. Introduction
Host: my-receiver.my-domain.com
Content-Type: application/yang-data+xml
<notification To learn the capabilities of the receiver, the publisher can issue a
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> HTTPS GET request with Accept-Type set to application/ietf-https-
<eventTime>2019-03-22T12:35:00Z</eventTime> notif-cap+xml or application/ietf-https-notif-cap+json, with latter
<foo xmlns="https://example.com/my-foobar-module"> as the mandatory to implement, and the default in case the type is
... not specified. If the receiver supports capabilities such as binary
</foo> encoding of data, it can return that as a capability in a response.
</notification> Please note that, when used in conjunction with Subscription to YANG
Notifications [RFC8639], dynamic discovery of the receiver's
supported encoding is considered only when the
"/subscriptions/subscription/encoding" leaf is not configured, per
the "encoding" leaf's description statement.
<notification 2.2. Example
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2019-03-22T12:35:00Z</eventTime>
<bar xmlns="https://example.com/my-foobar-module">
...
</bar>
</notification>
<notification The publisher can send the following request to learn the receiver
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> capabilities. The Accept-Type states its preferred order for
<eventTime>2019-03-22T12:35:01Z</eventTime> Content-Type that it wants to receive starting with XML, and if not
<baz xmlns="https://example.com/my-foobar-module"> supported, to use JSON encoding. Currently, there is only one
... capability of binary encoding defined.
</baz>
</notification>
Response: GET / HTTP/1.1
Host: example.com
Accept-Type: application/ietf-https-notif-cap+xml, application/ietf-https-notif-cap+json
HTTP/1.1 204 No Content In case the receiver supports the first Accept-Type, its response
Date: Fri, 03 Mar 2019 12:35:00 GMT should look like this:
Server: my-receiver.my-domain.com
HTTP/1.1 204 No Content HTTP/1.1 200 OK
Date: Fri, 03 Mar 2019 12:35:00 GMT Date: Wed, 26 Feb 2020 20:33:30 GMT
Server: my-receiver.my-domain.com Server: example-server
Cache-Control: no-cache
Content-Type: application/ietf-https-notif-cap+xml
Content-Length: nnn
HTTP/1.1 204 No Content <receiver-capabilities>
Date: Fri, 03 Mar 2019 12:35:01 GMT <receiver-capability>
Server: my-receiver.my-domain.com <urn:ietf:params:https-config:capability:binary-encoding:1.0>
</receiver-capability>
</receiver-capabilities>
2. YANG module 3. YANG module
2.1. Overview 3.1. Overview
The YANG module is a definition of a set of receivers that are The YANG module is a definition of a set of receivers that are
interested in the notifications published by the publisher. The interested in the notifications published by the publisher. The
module contains the TCP, TLS and HTTPS parameters that are needed to module contains the TCP, TLS and HTTPS parameters that are needed to
communicate with the receiver. The module augments the Subscribed communicate with the receiver. The module augments the Subscription
Notifications [RFC8639] receiver container to create a reference to a to YANG Notifications [RFC8639] receiver container to create a
receiver defined by the YANG module. As mentioned earlier, it uses reference to a receiver defined by the YANG module. As mentioned
POST method to deliver the notification. The attribute 'path' earlier, it uses POST method to deliver the notification. The
defines the absolute path for the resource on the receiver, as attribute 'path' defines the absolute path for the resource on the
defined by 'path-absolute' in URI Generic Syntax [RFC3986]. The receiver, as defined by 'path-absolute' in URI Generic Syntax
user-id used by Network Configuration Access Control Model [RFC8341], [RFC3986]. The user-id used by Network Configuration Access Control
is that of the receiver and is derived from the certificate presented Model [RFC8341], is that of the receiver and is derived from the
by the receiver. certificate presented by the receiver.
An abridged tree diagram representing the module is shown below. An abridged tree diagram representing the module is shown below.
module: ietf-https-notif module: ietf-https-notif
+--rw receivers augment /sn:subscriptions:
+--rw receiver* [name] +--rw https-receivers
+--rw name string +--rw https-receiver* [name]
+--rw tcp-params +--rw name string
| +--rw remote-address inet:host +--rw tcp-params
| +--rw remote-port? inet:port-number | +--rw remote-address inet:host
| +--rw local-address? inet:ip-address | +--rw remote-port? inet:port-number
| +--rw local-port? inet:port-number | +--rw local-address? inet:ip-address
| +--rw keepalives! | +--rw local-port? inet:port-number
| ... | +--rw keepalives!
+--rw tls-params | ...
| +--rw client-identity +--rw tls-params
| | ... | +--rw client-identity
| +--rw server-authentication | | ...
| | ... | +--rw server-authentication
| +--rw hello-params {tls-client-hello-params-config}? | | ...
| | ... | +--rw hello-params {tls-client-hello-params-config}?
| +--rw keepalives! {tls-client-keepalives}? | | ...
| ... | +--rw keepalives! {tls-client-keepalives}?
+--rw http-params | ...
| +--rw protocol-version? enumeration +--rw http-params
| +--rw client-identity | +--rw protocol-version? enumeration
| | ... | +--rw client-identity
| +--rw proxy-server! {proxy-connect}? | | ...
| | ... | +--rw proxy-server! {proxy-connect}?
| +--rw path? inet:uri | | ...
+--rw receiver-identity | +--rw path? inet:uri
+--rw cert-maps +--rw receiver-identity
... +--rw cert-maps
...
augment /sn:subscriptions/sn:subscription/sn:receivers/sn:receiver: augment /sn:subscriptions/sn:subscription/sn:receivers/sn:receiver:
+--rw receiver-ref? -> /receivers/receiver/name +--rw receiver-ref? leafref
2.2. YANG module 3.2. YANG module
The YANG module imports Common YANG Data Types [RFC6991], A YANG Data The YANG module imports Common YANG Data Types [RFC6991], A YANG Data
Model for SNMP Configuration [RFC7407], and Subscription to YANG Model for SNMP Configuration [RFC7407], and Subscription to YANG
Notifcations [RFC8639]. Notifications [RFC8639].
<CODE BEGINS> file "ietf-https-notif@2019-10-30.yang" The YANG module is shown below.
<CODE BEGINS> file "ietf-https-notif@2020-03-09.yang"
module ietf-https-notif { module ietf-https-notif {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-https-notif"; namespace "urn:ietf:params:xml:ns:yang:ietf-https-notif";
prefix "hsn"; prefix "hn";
import ietf-inet-types { import ietf-inet-types {
prefix inet; prefix inet;
reference reference
"RFC 6991: Common YANG Data Types."; "RFC 6991: Common YANG Data Types.";
} }
import ietf-subscribed-notifications { import ietf-subscribed-notifications {
prefix sn; prefix sn;
reference reference
"I-D.ietf-netconf-subscribed-notifications"; "I-D.ietf-netconf-subscribed-notifications";
skipping to change at page 9, line 7 skipping to change at page 8, line 8
Copyright (c) 2018 IETF Trust and the persons identified as Copyright (c) 2018 IETF Trust and the persons identified as
the document authors. All rights reserved. the document authors. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD to the license terms contained in, the Simplified BSD
License set forth in Section 4.c of the IETF Trust's Legal License set forth in Section 4.c of the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.
revision "2019-10-30" { 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.";
revision "2020-03-09" {
description description
"Initial Version."; "Initial Version.";
reference reference
"RFC XXXX, YANG Data Module for HTTPS Notifications."; "RFC XXXX, YANG Data Module for HTTPS Notifications.";
} }
identity https { identity https {
base sn:transport; base sn:transport;
description description
"HTTPS transport for notifications."; "HTTPS transport for notifications.";
} }
container receivers { grouping https-receivers {
list receiver { description
key "name"; "Grouping for HTTPS based receivers such that it can be
implemented outside the constructs of a Subscription to YANG
leaf name { Notification [RFC8639] module.";
type string; container https-receivers {
description description
"A name that uniquely identifies this receiver."; "HTTPS based notifications.";
}
container tcp-params { list https-receiver {
uses tcpc:tcp-client-grouping; key "name";
description
"TCP client parameters.";
}
container tls-params { leaf name {
description type string;
"TLS client parameters."; description
"A name that uniquely identifies this receiver.";
}
uses tlsc:tls-client-grouping; 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 { container http-params {
description description
"HTTP client parameters."; "HTTP client parameters.";
uses httpc:http-client-grouping; uses httpc:http-client-grouping;
leaf path { leaf path {
type inet:uri; type inet:uri;
description description
"The absolute path for the resource on the remote "The absolute path for the resource on the remote
HTTPS server. The absolute path as specified in HTTPS server. The absolute path as specified in
RFC 3986 as 'path-absolute'."; RFC 3986 as 'path-absolute'.";
reference reference
"RFC 3986: URI Generic Syntax."; "RFC 3986: URI Generic Syntax.";
}
} }
}
container receiver-identity {
description
"Specifies mechanism for identifying the receiver. The
publisher MUST NOT include any content in a notification
that the user is not authorized to view.";
container cert-maps { container receiver-identity {
uses x509c2n:cert-to-name;
description description
"The cert-maps container is used by a TLS-based HTTP "Specifies mechanism for identifying the receiver. The
server to map the HTTPS client's presented X.509 publisher MUST NOT include any content in a notification
certificate to a 'local' username. If no matching and that the user is not authorized to view.";
valid cert-to-name list entry is found, the publisher
MUST close the connection, and MUST NOT container cert-maps {
not send any notifications over it."; uses x509c2n:cert-to-name;
reference description
"RFC 7407: A YANG Data Model for SNMP Configuration."; "The cert-maps container is used by a TLS-based HTTP
server to map the HTTPS client's presented X.509
certificate to a 'local' username. If no matching and
valid cert-to-name list entry is found, the publisher
MUST close the connection, and MUST NOT
not send any notifications over it.";
reference
"RFC 7407: A YANG Data Model for SNMP Configuration.";
}
} }
description
"All receivers interested in this notification.";
} }
description
"All receivers interested in this notification.";
} }
}
augment "/sn:subscriptions" {
description description
"HTTPS based notifications."; "Augment the subscirbed notification module to add in the
receivers container.";
uses https-receivers;
} }
augment "/sn:subscriptions/sn:subscription/sn:receivers/sn:receiver" { augment "/sn:subscriptions/sn:subscription/sn:receivers/sn:receiver" {
leaf receiver-ref { leaf receiver-ref {
type leafref { type leafref {
path "/receivers/receiver/name"; path "/sn:subscriptions/hn:https-receivers/hn:https-receiver/" +
"hn:name";
} }
description description
"Reference to a receiver."; "Reference to a receiver.";
} }
description description
"Augment the subscriptions container to define the receiver."; "Augment the subscriptions container to define the receiver.";
} }
} }
<CODE ENDS> <CODE ENDS>
3. Security Considerations 4. Security Considerations
The YANG module specified in this document defines a schema for data The YANG module specified in this document defines a schema for data
that is designed to be accessed via network management protocols such that is designed to be accessed via network management protocols such
as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer
is the secure transport layer, and the mandatory-to-implement secure is the secure transport layer, and the mandatory-to-implement secure
transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer
is HTTPS, and the mandatory-to-implement secure transport is TLS is HTTPS, and the mandatory-to-implement secure transport is TLS
[RFC8446]. The NETCONF Access Control Model (NACM) [RFC8341] [RFC8446]. The NETCONF Access Control Model (NACM) [RFC8341]
provides the means to restrict access for particular NETCONF or provides the means to restrict access for particular NETCONF or
RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or
skipping to change at page 11, line 38 skipping to change at page 11, line 12
sensitive or vulnerable in some network environments. It is thus sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or important to control read access (e.g., via get, get-config, or
notification) to these data nodes. These are the subtrees and data notification) to these data nodes. These are the subtrees and data
nodes and their sensitivity/vulnerability: nodes and their sensitivity/vulnerability:
Some of the RPC operations in this YANG module may be considered Some of the RPC operations in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus sensitive or vulnerable in some network environments. It is thus
important to control access to these operations. These are the important to control access to these operations. These are the
operations and their sensitivity/vulnerability: operations and their sensitivity/vulnerability:
4. IANA Considerations 5. IANA Considerations
This document registers one URI and one YANG module. This document registers one URI, one YANG module and two Media Types.
4.1. URI Registration 5.1. URI Registration
in the IETF XML registry [RFC3688] [RFC3688]. Following the format in the IETF XML registry [RFC3688]. Following the format in RFC
in RFC 3688, the following registration is requested to be made: 3688, the following registration is requested to be made:
URI: urn:ietf:params:xml:ns:yang:ietf-http-notif URI: urn:ietf:params:xml:ns:yang:ietf-http-notif
Registrant Contact: The IESG. XML: N/A, the requested URI is an XML Registrant Contact: The IESG. XML: N/A, the requested URI is an XML
namespace. namespace.
4.2. YANG Module Name Registration 5.2. YANG Module Name Registration
This document registers one YANG module in the YANG Module Names This document registers one YANG module in the YANG Module Names
registry YANG [RFC6020]. registry YANG [RFC6020].
name: ietf-https-notif name: ietf-https-notif
namespace: urn:ietf:params:xml:ns:yang:ietf-https-notif namespace: urn:ietf:params:xml:ns:yang:ietf-https-notif
prefix: hn prefix: hn
reference: RFC XXXX reference: RFC XXXX
5. Examples 5.3. Media Types
5.3.1. Media Type "application/ietf-https-notif-cap+xml
Type name: application
Subtype name: ietf-https-notif-cap+xml
Required parameters: None
Optional parameters: None
Encoding considerations:
8-bit Each conceptual YANG data node is encoded according to the XML
Encoding Rules and Canonical Format for the specific YANG data node
type defined in YANG 1.1 [RFC7950].
Security considerations:
Security considerations related to the generation and consumption of
RESTCONF messages are discussed in Section NN of RFC XXXX.
Additional security considerations are specific to the semantics of
particular YANG data models. Each YANG module is expected to specify
security considerations for the YANG data defined in that module.
Interoperability considerations: N/A
Published specification: RFC XXXX
Applications that use this media type:
Instance document data parsers used within a protocol or automation
tool that utilize YANG-defined data structures.
Fragment identifier considerations:
Fragment identifiers for this type are not defined. All YANG data
nodes are accessible as resources using the path in the request URI.
Additional information:
Deprecated alias names for this type: N/A
Magic number(s): N/A
File extension(s): None
Macintosh file type code(s): "TEXT"
Person & email address to contact for further information:
See Author's Address section of RFC XXXX.
Intended usage: COMMON
Restrictions on usage: N/A
Author: See Author's Address section of RFC XXXX
Change controller:
Internet Engineering Task Force (mailto:iesg@ietf.org)
Provisional registration? (standards tree only): no
5.3.2. Media Type "application/ietf-https-notif-cap+json
Type name: application
Subtype name: ietf-https-notif-cap+json
Required parameters: None
Optional parameters: None
Encoding considerations:
8-bit Each conceptual YANG data node is encoded according to the XML
Encoding Rules and Canonical Format for the specific YANG data node
type defined in JSON Encoding of Data Modeled with YANG [RFC7951].
Security considerations:
Security considerations related to the generation and consumption of
RESTCONF messages are discussed in Section NN of RFC XXXX.
Additional security considerations are specific to the semantics of
particular YANG data models. Each YANG module is expected to specify
security considerations for the YANG data defined in that module.
Interoperability considerations: N/A
Published specification: RFC XXXX
Applications that use this media type:
Instance document data parsers used within a protocol or automation
tool that utilize YANG-defined data structures.
Fragment identifier considerations:
Fragment identifiers for this type are not defined. All YANG data
nodes are accessible as resources using the path in the request URI.
Additional information:
Deprecated alias names for this type: N/A
Magic number(s): N/A
File extension(s): None
Macintosh file type code(s): "TEXT"
Person & email address to contact for further information:
See Author's Address section of RFC XXXX.
Intended usage: COMMON
Restrictions on usage: N/A
Author: See Author's Address section of RFC XXXX
Change controller:
Internet Engineering Task Force (mailto:iesg@ietf.org)
Provisional registration? (standards tree only): no
6. Examples
This section tries to show some examples in how the model can be This section tries to show some examples in how the model can be
used. used.
5.1. HTTPS Configured Subscription 6.1. HTTPS Configured Subscription
This example shows how a HTTPS client can be configured to send This example shows how a HTTPS client can be configured to send
notifications to a receiver at address 192.0.2.1, port 443, a 'path', notifications to a receiver at address 192.0.2.1, port 443 with
with server certificates, and the corresponding trust store that is server certificates, and the corresponding trust store that is used
used to authenticate a connection. to authenticate a connection.
[note: '\' line wrapping for formatting only] [note: '\' line wrapping for formatting only]
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<receivers <subscriptions
xmlns="urn:ietf:params:xml:ns:yang:ietf-https-notif" xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notificatio\
xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-n\ ns">
ame"> <https-receivers
<receiver> xmlns="urn:ietf:params:xml:ns:yang:ietf-https-notif"
xmlns:x509c2n="urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name">\
<https-receiver>
<name>foo</name> <name>foo</name>
<tcp-params> <tcp-params>
<remote-address>my-receiver.my-domain.com</remote-address> <remote-address>my-receiver.my-domain.com</remote-address>
<remote-port>443</remote-port> <remote-port>443</remote-port>
</tcp-params> </tcp-params>
<tls-params> <tls-params>
<server-authentication> <server-authentication>
<ca-certs>explicitly-trusted-server-ca-certs</ca-certs> <ca-certs>explicitly-trusted-server-ca-certs</ca-certs>
<server-certs>explicitly-trusted-server-certs</server-ce\ <server-certs>explicitly-trusted-server-certs</server-certs>
rts>
</server-authentication> </server-authentication>
</tls-params> </tls-params>
<http-params> <http-params>
<client-identity> <client-identity>
<basic> <basic>
<user-id>my-name</user-id> <user-id>my-name</user-id>
<password>my-password</password> <password>my-password</password>
</basic> </basic>
</client-identity> </client-identity>
<path>/some/path</path> <path>/some/path</path>
</http-params> </http-params>
<receiver-identity> <receiver-identity>
<cert-maps> <cert-maps>
<cert-to-name> <cert-to-name>
<id>1</id> <id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint> <fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type> <map-type>x509c2n:san-any</map-type>
skipping to change at page 13, line 18 skipping to change at page 15, line 9
</http-params> </http-params>
<receiver-identity> <receiver-identity>
<cert-maps> <cert-maps>
<cert-to-name> <cert-to-name>
<id>1</id> <id>1</id>
<fingerprint>11:0A:05:11:00</fingerprint> <fingerprint>11:0A:05:11:00</fingerprint>
<map-type>x509c2n:san-any</map-type> <map-type>x509c2n:san-any</map-type>
</cert-to-name> </cert-to-name>
</cert-maps> </cert-maps>
</receiver-identity> </receiver-identity>
</receiver> </https-receiver>
</receivers> </https-receivers>
<subscriptions
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notificatio\
ns">
<subscription> <subscription>
<id>6666</id> <id>6666</id>
<stream-subtree-filter>foo</stream-subtree-filter> <stream-subtree-filter>foo</stream-subtree-filter>
<stream>some-stream</stream> <stream>some-stream</stream>
<receivers> <receivers>
<receiver> <receiver>
<name>my-receiver</name> <name>my-receiver</name>
<receiver-ref <receiver-ref
xmlns="urn:ietf:params:xml:ns:yang:ietf-https-notif">foo</receiver\ xmlns="urn:ietf:params:xml:ns:yang:ietf-https-notif">foo</rec\
-ref> eiver-ref>
</receiver> </receiver>
</receivers> </receivers>
</subscription> </subscription>
</subscriptions> </subscriptions>
<truststore xmlns="urn:ietf:params:xml:ns:yang:ietf-truststore"> <truststore xmlns="urn:ietf:params:xml:ns:yang:ietf-truststore">
<certificates> <certificates>
<name>explicitly-trusted-server-certs</name> <name>explicitly-trusted-server-certs</name>
<description> <description>
Specific server authentication certificates for explicitly Specific server authentication certificates for explicitly
trusted servers. These are needed for server certificates trusted servers. These are needed for server certificates
that are not signed by a pinned CA. that are not signed by a pinned CA.
</description> </description>
<certificate> <certificate>
<name>Fred Flintstone</name> <name>Fred Flintstone</name>
<cert>base64encodedvalue==</cert> <cert>base64encodedvalue==</cert>
</certificate> </certificate>
</certificates> </certificates>
<certificates> <certificates>
<name>explicitly-trusted-server-ca-certs</name> <name>explicitly-trusted-server-ca-certs</name>
<description> <description>
Trust anchors (i.e. CA certs) that are used to authenticate\ 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.
</description>
<certificate>
<name>ca.example.com</name>
<cert>base64encodedvalue==</cert>
</certificate>
</certificates>
server connections. Servers are authenticated if their
certificate has a chain of trust to one of these CA
certificates.
</description>
<certificate>
<name>ca.example.com</name>
<cert>base64encodedvalue==</cert>
</certificate>
</certificates>
</truststore> </truststore>
</config> </config>
6. Contributors 6.2. Bundled Message
7. Acknowledgements In the case of "bundled-message" as defined in Notification Message
Headers and Bundles [I-D.ietf-netconf-notification-messages],
something that this module supports, the flow of messages would look
something like this.
8. Normative references ------------- --------------
| Publisher | | Receiver |
------------- --------------
Establish TCP ------>
Establish TLS ------>
Send HTTPS POST message
with YANG defined ------>
notification #1
Send HTTPS POST message
with YANG defined ------>
notification #2
Send 204 (No Content)
<------ for notification #1
Send 204 (No Content)
<------ for notification #2
Send HTTPS POST message
with YANG defined ------->
notification #3
Send 204 (No Content)
<------ for notification #3
The content of the exchange would look something like this.
Request:
POST /some/path HTTP/1.1
Host: my-receiver.my-domain.com
Content-Type: application/yang-data+xml
<notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2019-03-22T12:35:00Z</eventTime>
<foo xmlns="https://example.com/my-foobar-module">
...
</foo>
</notification>
<notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2019-03-22T12:35:00Z</eventTime>
<bar xmlns="https://example.com/my-foobar-module">
...
</bar>
</notification>
<notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2019-03-22T12:35:01Z</eventTime>
<baz xmlns="https://example.com/my-foobar-module">
...
</baz>
</notification>
Response:
HTTP/1.1 204 No Content
Date: Fri, 03 Mar 2019 12:35:00 GMT
Server: my-receiver.my-domain.com
HTTP/1.1 204 No Content
Date: Fri, 03 Mar 2019 12:35:00 GMT
Server: my-receiver.my-domain.com
HTTP/1.1 204 No Content
Date: Fri, 03 Mar 2019 12:35:01 GMT
Server: my-receiver.my-domain.com
7. Contributors
8. Acknowledgements
9. References
9.1. Normative references
[I-D.ietf-netconf-notification-messages] [I-D.ietf-netconf-notification-messages]
Voit, E., Birkholz, H., Bierman, A., Clemm, A., and T. Voit, E., Jenkins, T., Birkholz, H., Bierman, A., and A.
Jenkins, "Notification Message Headers and Bundles", Clemm, "Notification Message Headers and Bundles", draft-
draft-ietf-netconf-notification-messages-07 (work in ietf-netconf-notification-messages-08 (work in progress),
progress), August 2019. November 2019.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>. <https://www.rfc-editor.org/info/rfc3688>.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005,
<https://www.rfc-editor.org/info/rfc3986>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020, the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010, DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>. <https://www.rfc-editor.org/info/rfc6020>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>. <https://www.rfc-editor.org/info/rfc6241>.
skipping to change at page 15, line 26 skipping to change at page 18, line 46
<https://www.rfc-editor.org/info/rfc6991>. <https://www.rfc-editor.org/info/rfc6991>.
[RFC7407] Bjorklund, M. and J. Schoenwaelder, "A YANG Data Model for [RFC7407] Bjorklund, M. and J. Schoenwaelder, "A YANG Data Model for
SNMP Configuration", RFC 7407, DOI 10.17487/RFC7407, SNMP Configuration", RFC 7407, DOI 10.17487/RFC7407,
December 2014, <https://www.rfc-editor.org/info/rfc7407>. December 2014, <https://www.rfc-editor.org/info/rfc7407>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016, RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>. <https://www.rfc-editor.org/info/rfc7950>.
[RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG",
RFC 7951, DOI 10.17487/RFC7951, August 2016,
<https://www.rfc-editor.org/info/rfc7951>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>. <https://www.rfc-editor.org/info/rfc8040>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341, Access Control Model", STD 91, RFC 8341,
skipping to change at page 15, line 48 skipping to change at page 19, line 23
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>. <https://www.rfc-editor.org/info/rfc8446>.
[RFC8639] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard, [RFC8639] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard,
E., and A. Tripathy, "Subscription to YANG Notifications", E., and A. Tripathy, "Subscription to YANG Notifications",
RFC 8639, DOI 10.17487/RFC8639, September 2019, RFC 8639, DOI 10.17487/RFC8639, September 2019,
<https://www.rfc-editor.org/info/rfc8639>. <https://www.rfc-editor.org/info/rfc8639>.
9.2. Informative references
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005,
<https://www.rfc-editor.org/info/rfc3986>.
Authors' Addresses Authors' Addresses
Mahesh Jethanandani Mahesh Jethanandani
VMware VMware
Email: mjethanandani@gmail.com Email: mjethanandani@gmail.com
Kent Watsen Kent Watsen
Watsen Networks Watsen Networks
USA USA
Email: kent+ietf@watsen.net Email: kent+ietf@watsen.net
 End of changes. 75 change blocks. 
308 lines changed or deleted 483 lines changed or added

This html diff was produced by rfcdiff 1.47. The latest version is available from http://tools.ietf.org/tools/rfcdiff/