RESTCONF Client and Server ModelsWatsen Networkskent+ietf@watsen.net
Operations
NETCONF Working GroupThis document defines two YANG modules,
one module to configure a RESTCONF client and the other module to
configure a RESTCONF server. Both modules support the TLS transport
protocol with both standard RESTCONF and RESTCONF Call Home connections.This draft contains many placeholder values that need to be replaced
with finalized values at the time of publication. This note summarizes
all of the substitutions that are needed. No other RFC Editor
instructions are specified elsewhere in this document.This document contains references to other drafts in progress, both in
the Normative References section, as well as in body text throughout.
Please update the following references to reflect their final RFC assignments:
I-D.ietf-netconf-keystoreI-D.ietf-netconf-tls-client-serverArtwork in this document contains shorthand references to drafts in
progress. Please apply the following replacements:
XXXX --> the assigned RFC value for this draftAAAA --> the assigned RFC value for I-D.ietf-netconf-tcp-client-serverCCCC --> the assigned RFC value for I-D.ietf-netconf-tls-client-serverBBBB --> the assigned RFC value for I-D.ietf-netconf-http-client-serverArtwork in this document contains placeholder values for the date of publication of this
draft. Please apply the following replacement:
2019-03-09 --> the publication date of this draftThe following Appendix section is to be removed prior to publication:
Appendix A. Change LogThis document defines two YANG modules,
one module to configure a RESTCONF client and the other module to
configure a RESTCONF server .
Both modules support the TLS transport
protocol with both standard RESTCONF and RESTCONF Call Home connections
.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.The RESTCONF client model presented in this section supports both clients
initiating connections to servers, as well as clients listening
for connections from servers calling home.This model, like that presented in ,
is designed to support any number of possible transports. RESTCONF only supports the TLS
transport currently, thus this model only supports the TLS transport.All private keys and trusted certificates are held in the
keystore model defined in .YANG feature statements are used to enable implementations to advertise
which parts of the model the RESTCONF client supports.The following tree diagram
provides an overview of the data model for the "ietf-restconf-client" module.
Just the container is displayed below, but there is also a reusable grouping
called "restconf-client-grouping" that the container is using.The following example illustrates configuring a RESTCONF
client to initiate connections, as well as listening for call-home
connections.This example is consistent with the examples presented in
Section 3.2 of .corp-fw1corp-fw1.example.comcorp-fw1.example.com15330ct:rsa2048base64encodedvalue==base64encodedvalue==base64encodedvalue==explicitly-trusted-server-ca-certs
explicitly-trusted-server-certs
303bobsecret303corp-fw2.example.comcorp-fw2.example.com15330ct:rsa2048base64encodedvalue==base64encodedvalue==base64encodedvalue==explicitly-trusted-server-ca-certs
explicitly-trusted-server-certs
303bobsecret303Intranet-facing listener11.22.33.44ct:rsa2048base64encodedvalue==base64encodedvalue==base64encodedvalue==explicitly-trusted-server-ca-certs
explicitly-trusted-server-certs
]]>This YANG module has normative references to ,
, and ,
,
, and
. file "ietf-restconf-client@2019-03-09.yang"
module ietf-restconf-client {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-client";
prefix "rcc";
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-tcp-client {
prefix tcpc;
reference
"RFC AAAA: YANG Groupings for TCP Clients and TCP Servers";
}
import ietf-tcp-server {
prefix tcps;
reference
"RFC AAAA: YANG Groupings for TCP Clients and TCP Servers";
}
import ietf-tls-client {
prefix tlsc;
reference
"RFC BBBB: YANG Groupings for TLS Clients and TLS Servers";
}
import ietf-http-client {
prefix httpc;
reference
"RFC CCCC: YANG Groupings for HTTP Clients and HTTP Servers";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web:
WG List:
Author: Kent Watsen
Author: Gary Wu ";
description
"This module contains a collection of YANG definitions for
configuring RESTCONF clients.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 [RFC2119]
[RFC8174] when, and only when, they appear in all
capitals, as shown here.
Copyright (c) 2019 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 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-03-09" {
description
"Initial version";
reference
"RFC XXXX: RESTCONF Client and Server Models";
}
// Features
feature initiate {
description
"The 'initiate' feature indicates that the RESTCONF client
supports initiating RESTCONF connections to RESTCONF servers
using at least one transport (e.g., HTTPS, etc.).";
}
feature https-initiate {
if-feature initiate;
description
"The ‘https-initiate’ feature indicates that the RESTCONF client
supports initiating HTTPS connections to RESTCONF servers. This
feature exists as HTTPS might not be a mandatory to implement
transport in the future.";
reference
"RFC 8040: RESTCONF Protocol";
}
feature listen {
description
"The 'listen' feature indicates that the RESTCONF client
supports opening a port to accept RESTCONF server call
home connections using at least one transport (e.g.,
HTTPS, etc.).";
}
feature https-listen {
if-feature listen;
description
"The ‘https-listen’ feature indicates that the RESTCONF client
supports opening a port to listen for incoming RESTCONF
server call-home connections. This feature exists as not
all RESTCONF clients may support RESTCONF call home.";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
// Groupings
grouping restconf-client-grouping {
description
"Top-level grouping for RESTCONF client configuration.";
container initiate {
if-feature initiate;
presence "Enables client to initiate TCP connections";
description
"Configures client initiating underlying TCP connections.";
list restconf-server {
key name;
min-elements 1;
description
"List of RESTCONF servers the RESTCONF client is to
initiate connections to in parallel.";
leaf name {
type string;
description
"An arbitrary name for the RESTCONF server.";
}
container endpoints {
description
"Container for the list of endpoints.";
list endpoint {
key name;
min-elements 1;
ordered-by user;
description
"A non-empty user-ordered list of endpoints for this
RESTCONF client to try to connect to in sequence.
Defining more than one enables high-availability.";
leaf name {
type string;
description
"An arbitrary name for this endpoint.";
}
choice transport {
mandatory true;
description
"Selects between available transports. This is a
'choice' statement so as to support additional
transport options to be augmented in.";
case https {
if-feature https-initiate;
container https {
description
"Specifies HTTPS-specific transport
configuration.";
uses tcpc:tcp-client-grouping {
refine "remote-port" {
default 443;
description
"The RESTCONF client will attepmt to connect
to the IANA-assigned well-known port value
for 'https' (443) if no value is specified.";
}
}
uses tlsc:tls-client-grouping {
refine "tls-client-identity/auth-type" {
mandatory true;
description
"RESTCONF clients MUST pass some
authentication credentials.";
}
}
uses httpc:http-client-grouping;
}
} // https
} // transport
container connection-type {
description
"Indicates the RESTCONF client's preference for how
the RESTCONF connection is maintained.";
choice connection-type {
mandatory true;
description
"Selects between available connection types.";
case persistent-connection {
container persistent {
presence
"Indicates that a persistent connection is
to be maintained.";
description
"Maintain a persistent connection to the
RESTCONF server. If the connection goes down,
immediately start trying to reconnect to it,
using the reconnection strategy. This
connection type minimizes any RESTCONF server
to RESTCONF client data-transfer delay, albeit
at the expense of holding resources longer.";
}
}
case periodic-connection {
container periodic {
presence
"Indicates that a periodic connection is to be
maintained.";
description
"Periodically connect to the RESTCONF server.
The RESTCONF server should close the underlying
TCP connection upon completing planned
activities.
This connection type increases resource
utilization, albeit with increased delay in
RESTCONF server to RESTCONF client
interactions.";
leaf period {
type uint16;
units "minutes";
default 60;
description
"Duration of time between periodic
connections.";
}
leaf anchor-time {
type yang:date-and-time {
// constrained to minute-level granularity
pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}'
+ '(Z|[\+\-]\d{2}:\d{2})';
}
description
"Designates a timestamp before or after which
a series of periodic connections are
determined. The periodic connections occur
at a whole multiple interval from the anchor
time. For example, for an anchor time is 15
minutes past midnight and a period interval
of 24 hours, then a periodic connection will
occur 15 minutes past midnight everyday.";
}
leaf idle-timeout {
type uint16;
units "seconds";
default 120; // two minutes
description
"Specifies the maximum number of seconds
that the underlying TCP session may remain
idle. A TCP session will be dropped if it
is idle for an interval longer than this
number of seconds If set to zero, then the
RESTCONF client will never drop a session
because it is idle.";
}
}
} // periodic-connection
} // connection-type
} // connection-type
container reconnect-strategy {
description
"The reconnection strategy directs how a RESTCONF
client reconnects to a RESTCONF server, after
discovering its connection to the server has
dropped, even if due to a reboot. The RESTCONF
client starts with the specified endpoint and
tries to connect to it max-attempts times before
trying the next endpoint in the list (round
robin).";
leaf start-with {
type enumeration {
enum first-listed {
description
"Indicates that reconnections should start
with the first endpoint listed.";
}
enum last-connected {
description
"Indicates that reconnections should start
with the endpoint last connected to. If
no previous connection has ever been
established, then the first endpoint
configured is used. RESTCONF clients
SHOULD be able to remember the last
endpoint connected to across reboots.";
}
enum random-selection {
description
"Indicates that reconnections should start with
a random endpoint.";
}
}
default first-listed;
description
"Specifies which of the RESTCONF server's
endpoints the RESTCONF client should start
with when trying to connect to the RESTCONF
server.";
}
leaf max-attempts {
type uint8 {
range "1..max";
}
default 3;
description
"Specifies the number times the RESTCONF client
tries to connect to a specific endpoint before
moving on to the next endpoint in the list
(round robin).";
}
} // reconnect-strategy
} // endpoint
} // endpoints
} // restconf-server
} // initiate
container listen {
if-feature listen;
presence "Enables client to accept call-home connections";
description
"Configures client accepting call-home TCP connections.";
leaf idle-timeout {
type uint16;
units "seconds";
default 3600; // one hour
description
"Specifies the maximum number of seconds that an
underlying TCP session may remain idle. A TCP session
will be dropped if it is idle for an interval longer
than this number of seconds. If set to zero, then
the server will never drop a session because it is
idle. Sessions that have a notification subscription
active are never dropped.";
}
list endpoint {
key name;
min-elements 1;
description
"List of endpoints to listen for RESTCONF connections.";
leaf name {
type string;
description
"An arbitrary name for the RESTCONF listen endpoint.";
}
choice transport {
mandatory true;
description
"Selects between available transports. This is a
'choice' statement so as to support additional
transport options to be augmented in.";
case https {
if-feature https-listen;
container https {
description
"HTTPS-specific listening configuration for inbound
connections.";
uses tcps:tcp-server-grouping {
refine "local-port" {
default 4336;
description
"The RESTCONF client will listen on the IANA-
assigned well-known port for 'restconf-ch-tls'
(4336) if no value is specified.";
}
}
uses tlsc:tls-client-grouping {
refine "tls-client-identity/auth-type" {
mandatory true;
description
"RESTCONF clients MUST pass some authentication
credentials.";
}
}
uses httpc:http-client-grouping;
}
} // case https
} // transport
} // endpoint
} // listen
} // restconf-client
// Protocol accessible node, for servers that implement this
// module.
container restconf-client {
uses restconf-client-grouping;
description
"Top-level container for RESTCONF client configuration.";
}
}
]]>The RESTCONF server model presented in this section supports servers
both listening for connections as well as initiating call-home
connections.All private keys and trusted certificates are held in the
keystore model defined in .YANG feature statements are used to enable implementations to advertise
which parts of the model the RESTCONF server supports.The following tree diagram
provides an overview of the data model for the "ietf-restconf-server" module.
Just the container is displayed below, but there is also a reusable grouping
called "restconf-server-grouping" that the container is using.The following example illustrates configuring a RESTCONF server
to listen for RESTCONF client connections, as well as configuring
call-home to one RESTCONF client.This example is consistent with the examples presented in
Section 3.2 of .netconf/tls11.22.33.44ct:rsa2048base64encodedvalue==base64encodedvalue==base64encodedvalue==explicitly-trusted-client-ca-certs
explicitly-trusted-client-certs
111:0A:05:11:00x509c2n:san-any2B3:4F:A1:8C:54x509c2n:specifiedscooby-dooconfig-managereast-data-centereast.example.comct:rsa2048base64encodedvalue==base64encodedvalue==base64encodedvalue==explicitly-trusted-client-ca-certs
explicitly-trusted-client-certs
111:0A:05:11:00x509c2n:san-any2B3:4F:A1:8C:54x509c2n:specifiedscooby-doowest-data-centerwest.example.com15330ct:rsa2048base64encodedvalue==base64encodedvalue==base64encodedvalue==explicitly-trusted-client-ca-certs
explicitly-trusted-client-certs
111:0A:05:11:00x509c2n:san-any2B3:4F:A1:8C:54x509c2n:specifiedscooby-doo30330060last-connected3
]]>This YANG module has normative references to ,
, , ,
,
, and
. file "ietf-restconf-server@2019-03-09.yang"
module ietf-restconf-server {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-server";
prefix "rcs";
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-x509-cert-to-name {
prefix x509c2n;
reference
"RFC 7407: A YANG Data Model for SNMP Configuration";
}
import ietf-tcp-client {
prefix tcpc;
reference
"RFC AAAA: YANG Groupings for TCP Clients and TCP Servers";
}
import ietf-tcp-server {
prefix tcps;
reference
"RFC AAAA: YANG Groupings for TCP Clients and TCP Servers";
}
import ietf-tls-server {
prefix tlss;
reference
"RFC BBBB: YANG Groupings for TLS Clients and TLS Servers";
}
import ietf-http-server {
prefix https;
reference
"RFC CCCC: YANG Groupings for HTTP Clients and HTTP Servers";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web:
WG List:
Author: Kent Watsen
Author: Gary Wu
Author: Juergen Schoenwaelder
";
description
"This module contains a collection of YANG definitions for
configuring RESTCONF servers.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 [RFC2119]
[RFC8174] when, and only when, they appear in all
capitals, as shown here.
Copyright (c) 2019 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 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-03-09" {
description
"Initial version";
reference
"RFC XXXX: RESTCONF Client and Server Models";
}
// Features
feature listen {
description
"The 'listen' feature indicates that the RESTCONF server
supports opening a port to accept RESTCONF client connections
using at least one transport (e.g., HTTPS, etc.).";
}
feature https-listen {
if-feature listen;
description
"The 'https-listen' feature indicates that the RESTCONF server
supports opening a port to listen for incoming RESTCONF
client connections. This feature exists as HTTPS might not
be a mandatory to implement transport in the future.";
reference
"RFC 8040: RESTCONF Protocol";
}
feature call-home {
description
"The 'call-home' feature indicates that the RESTCONF
server supports initiating RESTCONF call home connections
to RESTCONF clients using at least one transport (e.g.,
HTTPS, etc.).";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
feature https-call-home {
if-feature call-home;
description
"The 'https-call-home' feature indicates that the RESTCONF
server supports initiating connections to RESTCONF clients.
This feature exists as not all RESTCONF servers may
support RESTCONF call home.";
reference
"RFC 8071: NETCONF Call Home and RESTCONF Call Home";
}
// Groupings
grouping restconf-server-grouping {
description
"Top-level grouping for RESTCONF server configuration.";
container listen {
if-feature listen;
presence "Enables server to listen for TCP connections";
description "Configures listen behavior";
list endpoint {
key name;
min-elements 1;
description
"List of endpoints to listen for RESTCONF connections.";
leaf name {
type string;
description
"An arbitrary name for the RESTCONF listen endpoint.";
}
choice transport {
mandatory true;
description
"Selects between available transports. This is a
'choice' statement so as to support additional
transport options to be augmented in.";
case https {
if-feature https-listen;
container https {
description
"HTTPS-specific listening configuration for inbound
connections.";
uses tcps:tcp-server-grouping {
refine "local-port" {
default 443;
description
"The RESTCONF server will listen on the IANA-
assigned well-known port value for 'https'
(443) if no value is specified.";
}
}
uses tlss:tls-server-grouping {
refine "tls-client-auth" {
must 'pinned-ca-certs or pinned-client-certs';
description
"RESTCONF servers MUST be able to validate
clients.";
}
augment "tls-client-auth" {
description
"Augments in the cert-to-name structure,
so the RESTCONF server can map TLS-layer
client certificates to RESTCONF usernames.";
container cert-maps {
uses x509c2n:cert-to-name;
description
"The cert-maps container is used by a TLS-
based RESTCONF server to map the RESTCONF
client's presented X.509 certificate to
a RESTCONF username. If no matching and
valid cert-to-name list entry can be found,
then the RESTCONF server MUST close the
connection, and MUST NOT accept RESTCONF
messages over it.";
reference
"RFC 7407: A YANG Data Model for SNMP
Configuration.";
}
}
}
uses https:http-server-grouping;
} // https container
} // tls case
} // transport
} // endpoint
} // listen
container call-home {
if-feature call-home;
presence "Enables server to initiate TCP connections";
description "Configures call-home behavior";
list restconf-client {
key name;
min-elements 1;
description
"List of RESTCONF clients the RESTCONF server is to
initiate call-home connections to in parallel.";
leaf name {
type string;
description
"An arbitrary name for the remote RESTCONF client.";
}
container endpoints {
description
"Container for the list of endpoints.";
list endpoint {
key name;
min-elements 1;
ordered-by user;
description
"User-ordered list of endpoints for this RESTCONF
client. Defining more than one enables high-
availability.";
leaf name {
type string;
description
"An arbitrary name for this endpoint.";
}
choice transport {
mandatory true;
description
"Selects between available transports. This is a
'choice' statement so as to support additional
transport options to be augmented in.";
case https {
if-feature https-call-home;
container https {
description
"Specifies HTTPS-specific call-home transport
configuration.";
uses tcpc:tcp-client-grouping {
refine "remote-port" {
default 4336;
description
"The RESTCONF server will attempt to connect
to the IANA-assigned well-known port for
'restconf-ch-tls' (4336) if no value is
specified.";
}
}
uses tlss:tls-server-grouping {
refine "tls-client-auth" {
must 'pinned-ca-certs or pinned-client-certs';
description
"RESTCONF servers MUST be able to validate
clients.";
}
augment "tls-client-auth" {
description
"Augments in the cert-to-name structure,
so the RESTCONF server can map TLS-layer
client certificates to RESTCONF usernames.";
container cert-maps {
uses x509c2n:cert-to-name;
description
"The cert-maps container is used by a
TLS-based RESTCONF server to map the
RESTCONF client's presented X.509
certificate to a RESTCONF username. If
no matching and valid cert-to-name list
entry can be found, then the RESTCONF
server MUST close the connection, and
MUST NOT accept RESTCONF messages over
it.";
reference
"RFC 7407: A YANG Data Model for SNMP
Configuration.";
}
}
}
uses https:http-server-grouping;
}
}
} // transport
} // endpoint
} // endpoints
container connection-type {
description
"Indicates the RESTCONF server's preference for how the
RESTCONF connection is maintained.";
choice connection-type {
mandatory true;
description
"Selects between available connection types.";
case persistent-connection {
container persistent {
presence
"Indicates that a persistent connection is to be
maintained.";
description
"Maintain a persistent connection to the RESTCONF
client. If the connection goes down, immediately
start trying to reconnect to it, using the
reconnection strategy.
This connection type minimizes any RESTCONF
client to RESTCONF server data-transfer delay,
albeit at the expense of holding resources
longer.";
}
}
case periodic-connection {
container periodic {
presence
"Indicates that a periodic connection is to be
maintained.";
description
"Periodically connect to the RESTCONF client. The
RESTCONF client should close the underlying TCP
connection upon completing planned activities.
This connection type increases resource
utilization, albeit with increased delay in
RESTCONF client to RESTCONF client interactions.";
leaf period {
type uint16;
units "minutes";
default 60;
description
"Duration of time between periodic connections.";
}
leaf anchor-time {
type yang:date-and-time {
// constrained to minute-level granularity
pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}'
+ '(Z|[\+\-]\d{2}:\d{2})';
}
description
"Designates a timestamp before or after which a
series of periodic connections are determined.
The periodic connections occur at a whole
multiple interval from the anchor time. For
example, for an anchor time is 15 minutes past
midnight and a period interval of 24 hours, then
a periodic connection will occur 15 minutes past
midnight everyday.";
}
leaf idle-timeout {
type uint16;
units "seconds";
default 120; // two minutes
description
"Specifies the maximum number of seconds that
the underlying TCP session may remain idle.
A TCP session will be dropped if it is idle
for an interval longer than this number of
seconds. If set to zero, then the server
will never drop a session because it is idle.";
}
}
}
}
}
container reconnect-strategy {
description
"The reconnection strategy directs how a RESTCONF server
reconnects to a RESTCONF client after discovering its
connection to the client has dropped, even if due to a
reboot. The RESTCONF server starts with the specified
endpoint and tries to connect to it max-attempts times
before trying the next endpoint in the list (round
robin).";
leaf start-with {
type enumeration {
enum first-listed {
description
"Indicates that reconnections should start with
the first endpoint listed.";
}
enum last-connected {
description
"Indicates that reconnections should start with
the endpoint last connected to. If no previous
connection has ever been established, then the
first endpoint configured is used. RESTCONF
servers SHOULD be able to remember the last
endpoint connected to across reboots.";
}
enum random-selection {
description
"Indicates that reconnections should start with
a random endpoint.";
}
}
default first-listed;
description
"Specifies which of the RESTCONF client's endpoints
the RESTCONF server should start with when trying
to connect to the RESTCONF client.";
}
leaf max-attempts {
type uint8 {
range "1..max";
}
default 3;
description
"Specifies the number times the RESTCONF server tries
to connect to a specific endpoint before moving on to
the next endpoint in the list (round robin).";
}
}
} // restconf-client
} // call-home
} // restconf-server-grouping
// Protocol accessible node, for servers that implement this
// module.
container restconf-server {
uses restconf-server-grouping;
description
"Top-level container for RESTCONF server configuration.";
}
}
]]>The YANG module defined in this document uses a grouping defined in
. Please see the Security Considerations
section in that document for concerns related that grouping.The YANG module defined in this document is designed to be accessed via YANG
based management protocols, such as NETCONF and
RESTCONF . Both of these protocols have mandatory-to-implement
secure transport layers (e.g., SSH, TLS) with mutual authentication.The NETCONF access control model (NACM) provides the means
to restrict access for particular users to a pre-configured subset of all available
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:
The entire data trees defined by the modules defined in
this draft are sensitive to write operations. For instance, the addition or
removal of references to keys, certificates, trusted anchors, etc., can
dramatically alter the implemented security policy. However, no NACM
annotations are applied as the data SHOULD be editable by users other than
a designated 'recovery session'.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 two URIs in the "ns" subregistry of the IETF XML
Registry . Following the format in
, the following registrations are
requested:This document registers two YANG modules in the
YANG Module Names registry .
Following the format in , the
the following registrations are requested:Renamed "keychain" to "keystore".Filled in previously missing 'ietf-restconf-client' module.Updated the ietf-restconf-server module to accomodate new
grouping 'ietf-tls-server-grouping'.Refined use of tls-client-grouping to add a must statement
indicating that the TLS client must specify a client-certificate.Changed restconf-client??? to be a grouping (not a container).Added RFC 8174 to Requirements Language Section.Replaced refine statement in ietf-restconf-client
to add a mandatory true.Added refine statement in ietf-restconf-server
to add a must statement.Now there are containers and groupings, for both the
client and server models.Now tree diagrams reference ietf-netmod-yang-tree-diagramsUpdated examples to inline key and certificates (no longer
a leafref to keystore)Now tree diagrams reference ietf-netmod-yang-tree-diagramsUpdated examples to inline key and certificates (no longer
a leafref to keystore)Fixed change log missing section issue.Updated examples to match latest updates to the crypto-types,
trust-anchors, and keystore drafts.Reduced line length of the YANG modules to fit within 69 columns.removed "idle-timeout" from "persistent" connection config.Added "random-selection" for reconnection-strategy's "starts-with" enum.Replaced "connection-type" choice default (persistent) with "mandatory true".Reduced the periodic-connection's "idle-timeout" from 5 to 2 minutes.Replaced reconnect-timeout with period/anchor-time combo.Modified examples to be compatible with new crypto-types algsCorrected use of "mandatory true" for "address" leafs.Updated examples to reflect update to groupings defined in the keystore draft.Updated to use groupings defined in new TCP and HTTP drafts.Updated copyright date, boilerplate template, affiliation, and folding algorithm.The authors would like to thank for following for
lively discussions on list and in the halls (ordered
by last name): Andy Bierman, Martin Bjorklund, Benoit Claise, Ramkumar Dhanapal,
Mehmet Ersue, Balázs Kovács, David Lamparter, Alan Luchuk, Ladislav Lhotka,
Radek Krejci, Tom Petch, Juergen Schoenwaelder, Phil Shafer, Sean Turner, and
Bert Wijnen.