draft-ietf-netmod-syslog-model-21.txt   draft-ietf-netmod-syslog-model-22.txt 
NETMOD WG C. Wildes, Ed. NETMOD WG C. Wildes, Ed.
Internet-Draft Cisco Systems Inc. Internet-Draft Cisco Systems Inc.
Intended status: Standards Track K. Koushik, Ed. Intended status: Standards Track K. Koushik, Ed.
Expires: August 18, 2018 Verizon Wireless Expires: August 25, 2018 Verizon Wireless
February 14, 2018 February 21, 2018
A YANG Data Model for Syslog Configuration A YANG Data Model for Syslog Configuration
draft-ietf-netmod-syslog-model-21 draft-ietf-netmod-syslog-model-22
Abstract Abstract
This document defines a YANG data model for the configuration of a This document defines a YANG data model for the configuration of a
syslog process. It is intended this model be used by vendors who syslog process. It is intended this model be used by vendors who
implement syslog in their systems. implement syslog in their systems.
The YANG model in this document conforms to the Network Management The YANG model in this document conforms to the Network Management
Datastore Architecture defined in [I-D.ietf-netmod-revised- Datastore Architecture defined in [draft-ietf-netmod-revised-
datastores]. datastores].
Editorial Note (To be removed by RFC Editor)
This document 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.
Artwork in this document contains shorthand references to drafts in
progress. Please apply the following replacements:
o "I-D.ietf-netconf-keystore" --> the assigned RFC value for draft-
ietf-netconf-keystore
o "I-D.ietf-netconf-tls-client-server" --> the assigned RFC value
for draft-ietf-netconf-tls-client-server
o "zzzz" --> the assigned RFC value for this draft
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 August 18, 2018. This Internet-Draft will expire on August 25, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2018 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 . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.3. NDMA Compliance . . . . . . . . . . . . . . . . . . . . . 4 1.3. NDMA Compliance . . . . . . . . . . . . . . . . . . . . . 3
1.4. Editorial Note (To be removed by RFC) Editor) . . . . . . 3
2. Problem Statement . . . . . . . . . . . . . . . . . . . . . . 4 2. Problem Statement . . . . . . . . . . . . . . . . . . . . . . 4
3. Design of the Syslog Model . . . . . . . . . . . . . . . . . 4 3. Design of the Syslog Model . . . . . . . . . . . . . . . . . 4
3.1. Syslog Module . . . . . . . . . . . . . . . . . . . . . . 6 3.1. Syslog Module . . . . . . . . . . . . . . . . . . . . . . 6
4. Syslog YANG Module . . . . . . . . . . . . . . . . . . . . . 8 4. Syslog YANG Module . . . . . . . . . . . . . . . . . . . . . 8
4.1. The ietf-syslog Module . . . . . . . . . . . . . . . . . 8 4.1. The ietf-syslog Module . . . . . . . . . . . . . . . . . 8
5. Usage Examples . . . . . . . . . . . . . . . . . . . . . . . 27 5. Usage Examples . . . . . . . . . . . . . . . . . . . . . . . 27
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 27 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 27
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 28 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 28
7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 28 7.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 28
7.2. The YANG Module Names Registry . . . . . . . . . . . . . 28 7.2. The YANG Module Names Registry . . . . . . . . . . . . . 28
8. Security Considerations . . . . . . . . . . . . . . . . . . . 28 8. Security Considerations . . . . . . . . . . . . . . . . . . . 28
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 29 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 29
9.1. Normative References . . . . . . . . . . . . . . . . . . 29 9.1. Normative References . . . . . . . . . . . . . . . . . . 29
9.2. Informative References . . . . . . . . . . . . . . . . . 30 9.2. Informative References . . . . . . . . . . . . . . . . . 31
Appendix A. Implementor Guidelines . . . . . . . . . . . . . . . 32 Appendix A. Implementor Guidelines . . . . . . . . . . . . . . . 32
A.1. Extending Facilities . . . . . . . . . . . . . . . . . . 32 A.1. Extending Facilities . . . . . . . . . . . . . . . . . . 32
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 33 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 33
1. Introduction 1. Introduction
Operating systems, processes and applications generate messages Operating systems, processes and applications generate messages
indicating their own status or the occurrence of events. These indicating their own status or the occurrence of events. These
messages are useful for managing and/or debugging the network and its messages are useful for managing and/or debugging the network and its
services. The BSD syslog protocol is a widely adopted protocol that services. The BSD syslog protocol is a widely adopted protocol that
skipping to change at page 4, line 8 skipping to change at page 3, line 37
The term "collectors" is defined in [RFC5424]: a "collector" gathers The term "collectors" is defined in [RFC5424]: a "collector" gathers
syslog content for further analysis. syslog content for further analysis.
The term "action" refers to the processing that takes place for each The term "action" refers to the processing that takes place for each
syslog message received. syslog message received.
1.3. NDMA Compliance 1.3. NDMA Compliance
The YANG model in this document conforms to the Network Management The YANG model in this document conforms to the Network Management
Datastore Architecture defined in [I-D.ietf-netmod-revised- Datastore Architecture defined in I-D.ietf-netmod-revised-datastores
datastores]. [I-D.ietf-netmod-revised-datastores].
1.4. Editorial Note (To be removed by RFC) Editor)
This document 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.
Artwork in this document contains shorthand references to drafts in
progress. Please apply the following replacements:
o "I-D.ietf-netconf-keystore" --> the assigned RFC value for draft-
ietf-netconf-keystore
o "I-D.ietf-netconf-tls-client-server" --> the assigned RFC value
for draft-ietf-netconf-tls-client-server
o "zzzz" --> the assigned RFC value for this draft
o draft-ietf-netmod-revised-datastores --> the assigned RFC value
for I-D.ietf-netmod-revised-datastores
2. Problem Statement 2. Problem Statement
This document defines a YANG [RFC7950] configuration data model that This document defines a YANG [RFC7950] configuration data model that
may be used to configure the syslog feature running on a system. may be used to configure the syslog feature running on a system.
YANG models can be used with network management protocols such as YANG models can be used with network management protocols such as
NETCONF [RFC6241] to install, manipulate, and delete the NETCONF [RFC6241] to install, manipulate, and delete the
configuration of network devices. configuration of network devices.
The data model makes use of the YANG "feature" construct which allows The data model makes use of the YANG "feature" construct which allows
skipping to change at page 8, line 51 skipping to change at page 8, line 51
4. Syslog YANG Module 4. Syslog YANG Module
4.1. The ietf-syslog Module 4.1. The ietf-syslog Module
This module imports typedefs from [RFC7223], groupings from This module imports typedefs from [RFC7223], groupings from
[I-D.ietf-netconf-keystore], and [I-D.ietf-netconf-keystore], and
[I-D.ietf-netconf-tls-client-server], and it references [RFC5424], [I-D.ietf-netconf-tls-client-server], and it references [RFC5424],
[RFC5425], [RFC5426], and [RFC5848] and [Std-1003.1-2008]. [RFC5425], [RFC5426], and [RFC5848] and [Std-1003.1-2008].
<CODE BEGINS> file "ietf-syslog@2018-02-14.yang" <CODE BEGINS> file "ietf-syslog@2018-02-21.yang"
module ietf-syslog { module ietf-syslog {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-syslog"; namespace "urn:ietf:params:xml:ns:yang:ietf-syslog";
prefix syslog; prefix syslog;
import ietf-inet-types { import ietf-inet-types {
prefix inet; prefix inet;
reference reference
"RFC 6991: INET Types Model"; "RFC 6991: INET Types Model";
skipping to change at page 10, line 24 skipping to change at page 10, line 24
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
'OPTIONAL' in the module text are to be interpreted as 'OPTIONAL' in the module text are to be interpreted as
described in RFC 2119 (http://tools.ietf.org/html/rfc2119). described in RFC 2119 (http://tools.ietf.org/html/rfc2119).
This version of this YANG module is part of RFC zzzz This version of this YANG module is part of RFC zzzz
(http://tools.ietf.org/html/rfczzzz); see the RFC itself for (http://tools.ietf.org/html/rfczzzz); see the RFC itself for
full legal notices."; full legal notices.";
revision 2018-02-14 { revision 2018-02-21 {
description description
"Initial Revision"; "Initial Revision";
reference reference
"RFC zzzz: Syslog YANG Model"; "RFC zzzz: Syslog YANG Model";
} }
feature console-action { feature console-action {
description description
"This feature indicates that the local console action is "This feature indicates that the local console action is
supported."; supported.";
skipping to change at page 22, line 12 skipping to change at page 22, line 12
"This leaf specifies the length of time that log "This leaf specifies the length of time that log
events should be written to a specific log file. events should be written to a specific log file.
Log events that arrive after the rollover period Log events that arrive after the rollover period
cause the current log file to be closed and a new cause the current log file to be closed and a new
log file to be opened."; log file to be opened.";
} }
leaf retention { leaf retention {
if-feature file-limit-duration; if-feature file-limit-duration;
type uint32; type uint32;
units "hours"; units "minutes";
description description
"This leaf specifies the length of time that "This leaf specifies the length of time that
completed/closed log event files should be stored completed/closed log event files should be stored
in the file system before they are deleted."; in the file system before they are removed.";
} }
} }
} }
} }
container remote { container remote {
if-feature remote-action; if-feature remote-action;
description description
"This container describes the configuration parameters "This container describes the configuration parameters
for forwarding syslog messages to remote relays or for forwarding syslog messages to remote relays or
collectors."; collectors.";
skipping to change at page 24, line 13 skipping to change at page 24, line 13
"If specified, this leaf specifies the facility used "If specified, this leaf specifies the facility used
to override the facility in messages delivered to to override the facility in messages delivered to
the remote server."; the remote server.";
} }
leaf source-interface { leaf source-interface {
if-feature remote-source-interface; if-feature remote-source-interface;
type if:interface-ref; type if:interface-ref;
description description
"This leaf sets the source interface to be used to "This leaf sets the source interface to be used to
send messages to the remote syslog server. If not send messages to the remote syslog server. If not
set, messages sent to a remote syslog server will set, messages can be sent on any interface.";
contain the IP address of the interface the syslog
message uses to exit the network element";
} }
container signing { container signing {
if-feature signed-messages; if-feature signed-messages;
presence presence
"If present, syslog-signing options is activated."; "If present, syslog-signing options is activated.";
description description
"This container describes the configuration "This container describes the configuration
parameters for signed syslog messages."; parameters for signed syslog messages.";
reference reference
"RFC 5848: Signed Syslog Messages"; "RFC 5848: Signed Syslog Messages";
skipping to change at page 27, line 33 skipping to change at page 27, line 33
Enable remote logging of syslogs to udp destination Enable remote logging of syslogs to udp destination
2001:db8:a0b:12f0::1 for facility auth, severity error 2001:db8:a0b:12f0::1 for facility auth, severity error
<syslog xmlns="urn:ietf:params:xml:ns:yang:ietf-syslog"> <syslog xmlns="urn:ietf:params:xml:ns:yang:ietf-syslog">
<actions> <actions>
<remote> <remote>
<destination> <destination>
<name>remote1</name> <name>remote1</name>
<udp> <udp>
<address>foo.eample.com</address> <address>2001:db8:a0b:12f0::1</address>
</udp> </udp>
<facility-filter> <facility-filter>
<facility-list> <facility-list>
<facility>auth</facility> <facility>auth</facility>
<severity>error</severity> <severity>error</severity>
</facility-list> </facility-list>
</facility-filter> </facility-filter>
</destination> </destination>
</remote> </remote>
</actions> </actions>
skipping to change at page 28, line 8 skipping to change at page 28, line 8
Figure 4. ietf-syslog Examples Figure 4. ietf-syslog Examples
6. Acknowledgements 6. Acknowledgements
The authors wish to thank the following who commented on this The authors wish to thank the following who commented on this
proposal: proposal:
Andy Bierman, Martin Bjorklund, Alex Campbell, Alex Clemm, Jim Andy Bierman, Martin Bjorklund, Alex Campbell, Alex Clemm, Jim
Gibson, Jeffrey Haas, John Heasley, Giles Heron, Lisa Huang, Mahesh Gibson, Jeffrey Haas, John Heasley, Giles Heron, Lisa Huang, Mahesh
Jethanandani, Jeffrey K Lange, Jan Lindblad, Chris Lonvick, Tom Jethanandani, Jeffrey K Lange, Jan Lindblad, Chris Lonvick, Tom
Petch, Juergen Schoenwaelder, Phil Shafer, Jason Sterne, Peter Van Petch, Juergen Schoenwaelder, Phil Shafer, Yaron Sheffer, Jason
Horne, Kent Watsen, Bert Wijnen, Dale R Worley, Aleksandr Zhdankin Sterne, Peter Van Horne, Kent Watsen, Bert Wijnen, Dale R Worley,
Aleksandr Zhdankin
7. IANA Considerations 7. IANA Considerations
7.1. The IETF XML Registry 7.1. The IETF XML Registry
This document registers one URI in the IETF XML registry [RFC3688]. This document registers one URI in the IETF XML registry [RFC3688].
Following the format in [RFC3688], the following registration is Following the format in [RFC3688], the following registration is
requested: requested:
URI: urn:ietf:params:xml:ns:yang:ietf-syslog URI: urn:ietf:params:xml:ns:yang:ietf-syslog
skipping to change at page 28, line 42 skipping to change at page 28, line 43
reference: RFC zzzz reference: RFC zzzz
8. Security Considerations 8. Security Considerations
The YANG module defined in this document is designed to be accessed The YANG module defined in this document is designed to be accessed
via YANG based management protocols, such as NETCONF [RFC6241] and via YANG based management protocols, such as NETCONF [RFC6241] and
RESTCONF [RFC8040]. Both of these protocols have mandatory-to- RESTCONF [RFC8040]. Both of these protocols have mandatory-to-
implement secure transport layers (e.g., SSH, TLS) with mutual implement secure transport layers (e.g., SSH, TLS) with mutual
authentication. authentication.
The NETCONF access control model (NACM) [RFC6536] provides the means The NETCONF access control model (NACM) [RFC6536] provides the means
to restrict access for particular users to a pre-configured subset of to restrict access for particular users to a pre-configured subset of
all available protocol operations and content. all available protocol operations and content.
There are a number of data nodes defined in this YANG module that are There are a number of data nodes defined in this YANG module that are
writable/creatable/deletable (i.e., config true, which is the writable/creatable/deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable default). These data nodes should be considered sensitive or
in some network environments. Write operations (e.g., edit-config) vulnerable in all network environments. Write operations (e.g.,
to these data nodes without proper protection can have a negative edit-config) to these data nodes without proper protection can have a
effect on network operations. These are the subtrees and data nodes negative effect on network operations and on network security.
and their sensitivity/vulnerability:
In addition there are data nodes that require careful analysis and
review. These are the subtrees and data nodes and their sensitivity/
vulnerability:
facility-filter/pattern-match: When writing this node, facility-filter/pattern-match: When writing this node,
implementations MUST ensure that the regular expression pattern implementations MUST ensure that the regular expression pattern
match is not constructed to cause a regular expression denial match is not constructed to cause a regular expression denial
of service attack due to a pattern that causes the regular of service attack due to a pattern that causes the regular
expression implementation to work very slowly (exponentially expression implementation to work very slowly (exponentially
related to input size). related to input size).
remote/destination/signing/cert-signer: When writing this
subtree, implementations MUST NOT specify a private key that is
used for any other purpose.
Some of the readable data nodes in this YANG module may be considered Some of the readable data nodes 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 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. notification) to these data nodes. These are the subtrees and data
nodes and their sensitivity/vulnerability:
remote/destination/transport: This subtree contains information
about other hosts in the network, and the TLS transport
certificate properties if TLS is selected as the transport
protocol.
remote/destination/signing: This subtree contains information
about the syslog message signing properties including signing
certificate information.
There are no RPC operations defined in this YANG module. There are no RPC operations defined in this YANG module.
9. References 9. References
9.1. Normative References 9.1. Normative References
[I-D.ietf-netconf-keystore] [I-D.ietf-netconf-keystore]
Watsen, K., "YANG Data Model for a "Keystore" Mechanism", Watsen, K., "YANG Data Model for a "Keystore" Mechanism",
draft-ietf-netconf-keystore-04 (work in progress), October draft-ietf-netconf-keystore-04 (work in progress), October
skipping to change at page 30, line 41 skipping to change at page 31, line 15
9.2. Informative References 9.2. Informative References
[I-D.ietf-netmod-revised-datastores] [I-D.ietf-netmod-revised-datastores]
Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore and R. Wilton, "Network Management Datastore
Architecture", draft-ietf-netmod-revised-datastores-10 Architecture", draft-ietf-netmod-revised-datastores-10
(work in progress), January 2018. (work in progress), January 2018.
[I-D.ietf-netmod-yang-tree-diagrams] [I-D.ietf-netmod-yang-tree-diagrams]
Bjorklund, M. and L. Berger, "YANG Tree Diagrams", draft- Bjorklund, M. and L. Berger, "YANG Tree Diagrams", draft-
ietf-netmod-yang-tree-diagrams-05 (work in progress), ietf-netmod-yang-tree-diagrams-06 (work in progress),
January 2018. February 2018.
[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>.
[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>.
 End of changes. 21 change blocks. 
47 lines changed or deleted 67 lines changed or added

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