idnits 2.17.1 draft-ietf-i2nsf-nsf-monitoring-data-model-17.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == There is 1 instance of lines with non-ascii characters in the document. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There is 1 instance of too long lines in the document, the longest one being 2 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 1343 has weird spacing: '...ty-time yan...' == Line 1421 has weird spacing: '...-number ine...' == Line 1461 has weird spacing: '...-number ine...' == Using lowercase 'not' together with uppercase 'MUST', 'SHALL', 'SHOULD', or 'RECOMMENDED' is not an accepted usage according to RFC 2119. Please use uppercase 'NOT' together with RFC 2119 keywords (if that is what you mean). Found 'not RECOMMENDED' in this paragraph: * cookies: The HTTP Cookie header field of the request from the user agent. The cookies information needs to be kept confidential and is not RECOMMENDED to be included in the monitoring data unless the information is absolutely necessary to help to enhance the security of the network. == Using lowercase 'not' together with uppercase 'MUST', 'SHALL', 'SHOULD', or 'RECOMMENDED' is not an accepted usage according to RFC 2119. Please use uppercase 'NOT' together with RFC 2119 keywords (if that is what you mean). Found 'not RECOMMENDED' in this paragraph: uses attack-rates; } } case i2nsf-nsf-detection-virus { if-feature "i2nsf-nsf-detection-virus"; container i2nsf-nsf-detection-virus { description "This notification is sent, when a virus is detected."; uses i2nsf-nsf-event-type-content-extend; leaf virus-name { type string; description "The name of the detected virus"; } leaf virus-type { type identityref { base virus-type; } description "The virus type of the detected virus"; } leaf host { type union { type string; type inet:ip-address-no-zone; } description "The name or IP address of the host/device. This is used to identify the host/device that is infected by the virus. If the given name is not an IP address, the name can be an arbitrary string including a FQDN (Fully Qualified Domain Name). The name MUST be unique in the scope of management domain for identifying the device that has been infected with a virus."; } leaf file-type { type string; description "The type of a file (indicated by the file's suffix, e.g., .exe) where virus code is found (if applicable)."; } leaf file-name { type string; description "The name of file virus code is found in (if applicable)."; } leaf os { type string; description "The operating system of the device."; } } } case i2nsf-nsf-detection-intrusion { if-feature "i2nsf-nsf-detection-intrusion"; container i2nsf-nsf-detection-intrusion { description "This notification is sent, when an intrusion event is detected."; uses i2nsf-nsf-event-type-content-extend; leaf protocol { type identityref { base transport-protocol; } description "The transport protocol type for nsf-detection-intrusion notification"; } leaf app { type identityref { base application-protocol; } description "The employed application layer protocol"; } leaf attack-type { type identityref { base intrusion-attack-type; } description "The sub attack type for intrusion attack"; } } } case i2nsf-nsf-detection-web-attack { if-feature "i2nsf-nsf-detection-web-attack"; container i2nsf-nsf-detection-web-attack { description "This notification is sent, when an attack event is detected."; uses i2nsf-nsf-event-type-content-extend; leaf attack-type { type identityref { base web-attack-type; } description "Concrete web attack type, e.g., SQL injection, command injection, XSS, and CSRF."; } leaf req-method { type identityref { base req-method; } description "The HTTP method of the request, e.g., PUT or GET."; reference "draft-ietf-httpbis-semantics-19: HTTP Semantics -Request Methods"; } leaf req-target { type string; description "The HTTP Request Target. This field can be filled in the format of origin-form, absolute-form, authority-form, or asterisk-form"; reference "draft-ietf-httpbis-messaging-19: HTTP/1.1 - Request Target"; } leaf-list filtering-type { type identityref { base filter-type; } description "URL filtering type, e.g., deny-list, allow-list, and Unknown"; } leaf cookies { type string; description "The HTTP Cookies header field of the request from the user agent. The cookie information needs to be kept confidential and is not RECOMMENDED to be included in the monitoring data unless the information is absolutely necessary to help to enhance the security of the network."; reference "RFC 6265: HTTP State Management Mechanism - Cookie"; } leaf req-host { type string; description "The HTTP Host header field of the request"; reference "draft-ietf-httpbis-semantics-19: HTTP Semantics - Host"; } leaf response-code { type string; description "The HTTP Response status code"; reference "IANA Website: Hypertext Transfer Protocol (HTTP) Status Code Registry"; } } } case i2nsf-nsf-detection-voip-vocn { if-feature "i2nsf-nsf-detection-voip-vocn"; container i2nsf-nsf-detection-voip-vocn { description "This notification is sent, when a VoIP/VoCN violation is detected."; uses i2nsf-nsf-event-type-content-extend; leaf-list source-voice-id { type string; description "The detected source voice ID for VoIP and VoCN that violates the security policy."; } leaf-list destination-voice-id { type string; description "The detected destination voice ID for VoIP and VoCN that violates the security policy."; } leaf-list user-agent { type string; description "The detected user-agent for VoIP and VoCN that violates the security policy."; } } } } } /* * Data nodes */ container i2nsf-counters { config false; description "The state data representing continuous value changes of information elements that occur very frequently. The value should be calculated from the start of the service of the NSF."; -- The document date (13 April 2022) is 716 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) ** Downref: Normative reference to an Informational RFC: RFC 8329 -- Possible downref: Normative reference to a draft: ref. 'I-D.ietf-httpbis-messaging' -- Possible downref: Normative reference to a draft: ref. 'I-D.ietf-httpbis-semantics' == Outdated reference: A later version (-32) exists of draft-ietf-i2nsf-capability-data-model-29 == Outdated reference: A later version (-29) exists of draft-ietf-i2nsf-nsf-facing-interface-dm-24 -- Possible downref: Normative reference to a draft: ref. 'I-D.ietf-tcpm-rfc793bis' == Outdated reference: A later version (-31) exists of draft-ietf-i2nsf-consumer-facing-interface-dm-17 Summary: 2 errors (**), 0 flaws (~~), 10 warnings (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group J. Jeong, Ed. 3 Internet-Draft P. Lingga 4 Intended status: Standards Track Sungkyunkwan University 5 Expires: 15 October 2022 S. Hares 6 L. Xia 7 Huawei 8 H. Birkholz 9 Fraunhofer SIT 10 13 April 2022 12 I2NSF NSF Monitoring Interface YANG Data Model 13 draft-ietf-i2nsf-nsf-monitoring-data-model-17 15 Abstract 17 This document proposes an information model and the corresponding 18 YANG data model of an interface for monitoring Network Security 19 Functions (NSFs) in the Interface to Network Security Functions 20 (I2NSF) framework. If the monitoring of NSFs is performed with the 21 NSF monitoring interface in a standard way, it is possible to detect 22 the indication of malicious activity, anomalous behavior, the 23 potential sign of denial-of-service attacks, or system overload in a 24 timely manner. This monitoring functionality is based on the 25 monitoring information that is generated by NSFs. Thus, this 26 document describes not only an information model for the NSF 27 monitoring interface along with a YANG tree diagram, but also the 28 corresponding YANG data model. 30 Status of This Memo 32 This Internet-Draft is submitted in full conformance with the 33 provisions of BCP 78 and BCP 79. 35 Internet-Drafts are working documents of the Internet Engineering 36 Task Force (IETF). Note that other groups may also distribute 37 working documents as Internet-Drafts. The list of current Internet- 38 Drafts is at https://datatracker.ietf.org/drafts/current/. 40 Internet-Drafts are draft documents valid for a maximum of six months 41 and may be updated, replaced, or obsoleted by other documents at any 42 time. It is inappropriate to use Internet-Drafts as reference 43 material or to cite them other than as "work in progress." 45 This Internet-Draft will expire on 15 October 2022. 47 Copyright Notice 49 Copyright (c) 2022 IETF Trust and the persons identified as the 50 document authors. All rights reserved. 52 This document is subject to BCP 78 and the IETF Trust's Legal 53 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 54 license-info) in effect on the date of publication of this document. 55 Please review these documents carefully, as they describe your rights 56 and restrictions with respect to this document. Code Components 57 extracted from this document must include Revised BSD License text as 58 described in Section 4.e of the Trust Legal Provisions and are 59 provided without warranty as described in the Revised BSD License. 61 Table of Contents 63 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 64 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4 65 3. Use Cases for NSF Monitoring Data . . . . . . . . . . . . . . 5 66 4. Classification of NSF Monitoring Data . . . . . . . . . . . . 5 67 4.1. Retention and Emission from NSFs . . . . . . . . . . . . 6 68 4.2. Notifications for Events and Records . . . . . . . . . . 8 69 4.3. Push and Pull for the retrieval of monitoring data from 70 NSFs . . . . . . . . . . . . . . . . . . . . . . . . . . 8 71 5. Basic Information Model for Monitoring Data . . . . . . . . . 9 72 6. Extended Information Model for Monitoring Data . . . . . . . 10 73 6.1. System Alarms . . . . . . . . . . . . . . . . . . . . . . 11 74 6.1.1. Memory Alarm . . . . . . . . . . . . . . . . . . . . 11 75 6.1.2. CPU Alarm . . . . . . . . . . . . . . . . . . . . . . 11 76 6.1.3. Disk (Storage) Alarm . . . . . . . . . . . . . . . . 12 77 6.1.4. Hardware Alarm . . . . . . . . . . . . . . . . . . . 12 78 6.1.5. Interface Alarm . . . . . . . . . . . . . . . . . . . 13 79 6.2. System Events . . . . . . . . . . . . . . . . . . . . . . 13 80 6.2.1. Access Violation . . . . . . . . . . . . . . . . . . 13 81 6.2.2. Configuration Change . . . . . . . . . . . . . . . . 14 82 6.2.3. Session Table Event . . . . . . . . . . . . . . . . . 15 83 6.2.4. Traffic Flows . . . . . . . . . . . . . . . . . . . . 15 84 6.3. NSF Events . . . . . . . . . . . . . . . . . . . . . . . 16 85 6.3.1. DDoS Detection . . . . . . . . . . . . . . . . . . . 17 86 6.3.2. Virus Event . . . . . . . . . . . . . . . . . . . . . 18 87 6.3.3. Intrusion Event . . . . . . . . . . . . . . . . . . . 19 88 6.3.4. Web Attack Event . . . . . . . . . . . . . . . . . . 19 89 6.3.5. VoIP/VoCN Event . . . . . . . . . . . . . . . . . . . 20 90 6.4. System Logs . . . . . . . . . . . . . . . . . . . . . . . 21 91 6.4.1. Access Log . . . . . . . . . . . . . . . . . . . . . 21 92 6.4.2. Resource Utilization Log . . . . . . . . . . . . . . 22 93 6.4.3. User Activity Log . . . . . . . . . . . . . . . . . . 23 94 6.5. NSF Logs . . . . . . . . . . . . . . . . . . . . . . . . 23 95 6.5.1. Deep Packet Inspection Log . . . . . . . . . . . . . 24 96 6.6. System Counter . . . . . . . . . . . . . . . . . . . . . 24 97 6.6.1. Interface Counter . . . . . . . . . . . . . . . . . . 24 98 6.7. NSF Counters . . . . . . . . . . . . . . . . . . . . . . 26 99 6.7.1. Firewall Counter . . . . . . . . . . . . . . . . . . 26 100 6.7.2. Policy Hit Counter . . . . . . . . . . . . . . . . . 27 101 7. YANG Tree Structure of NSF Monitoring YANG Module . . . . . . 28 102 8. YANG Data Model of NSF Monitoring YANG Module . . . . . . . . 34 103 9. I2NSF Event Stream . . . . . . . . . . . . . . . . . . . . . 85 104 10. XML Examples for I2NSF NSF Monitoring . . . . . . . . . . . . 86 105 10.1. I2NSF System Detection Alarm . . . . . . . . . . . . . . 86 106 10.2. I2NSF Interface Counters . . . . . . . . . . . . . . . . 87 107 11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 88 108 12. Security Considerations . . . . . . . . . . . . . . . . . . . 89 109 13. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 91 110 14. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 91 111 15. References . . . . . . . . . . . . . . . . . . . . . . . . . 91 112 15.1. Normative References . . . . . . . . . . . . . . . . . . 92 113 15.2. Informative References . . . . . . . . . . . . . . . . . 96 114 Appendix A. Changes from 115 draft-ietf-i2nsf-nsf-monitoring-data-model-16 . . . . . . 97 116 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 97 118 1. Introduction 120 According to [RFC8329], the interface provided by a Network Security 121 Function (NSF) (e.g., Firewall, IPS, or Anti-DDoS function) to enable 122 the collection of monitoring information is referred to as an I2NSF 123 Monitoring Interface. This interface enables the sharing of vital 124 data from the NSFs (e.g., events, records, and counters) to an NSF 125 data collector (e.g., Security Controller) through a variety of 126 mechanisms (e.g., queries and notifications). The monitoring of NSF 127 plays an important role in an overall security framework, if it is 128 done in a timely way. The monitoring information generated by an NSF 129 can be a good, early indication of anomalous behavior or malicious 130 activity, such as denial-of-service (DoS) attacks. 132 This document defines an information model of an NSF monitoring 133 interface that provides visibility into an NSF for the NSF data 134 collector (note that an NSF data collector is defined as an entity to 135 collect NSF monitoring data from an NSF, such as Security 136 Controller). It specifies the information and illustrates the 137 methods that enable an NSF to provide the information required in 138 order to be monitored in a scalable and efficient way via the NSF 139 Monitoring Interface. The information model for the NSF monitoring 140 interface presented in this document is complementary for the 141 security policy provisioning functionality of the NSF-Facing 142 Interface specified in [I-D.ietf-i2nsf-nsf-facing-interface-dm]. 144 This document also defines a YANG [RFC7950] data model for the NSF 145 monitoring interface, which is derived from the information model for 146 the NSF monitoring interface. 148 Note that this document covers a subset of monitoring data for 149 systems and NSFs, which are related to security. 151 2. Terminology 153 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 154 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 155 "OPTIONAL" in this document are to be interpreted as described in BCP 156 14 [RFC2119] [RFC8174] when, and only when, they appear in all 157 capitals, as shown here. 159 This document uses the terminology described in [RFC8329]. In 160 addition, the following terms are defined in this document: 162 * I2NSF User: An entity that delivers a high-level security policy 163 to the Security Controller and may request monitoring information 164 via the NSF data collector. 166 * Monitoring Information: Relevant data that can be processed to 167 know the status and performance of the network and the NSF. The 168 monitoring information in an I2NSF environment consists of I2NSF 169 Events, I2NSF Records, and I2NSF Counters (see Section 4.1 for the 170 detailed definition). This information is to be delivered to the 171 NSF data collector. 173 * Notification: Unsolicited transmission of monitoring information. 175 * NSF Data Collector: An entity that collects NSF monitoring 176 information from NSFs, such as Security Controller. 178 * Subscription: An agreement initialized by the NSF data collector 179 to receive monitoring information from an NSF. The method to 180 subscribe follows the method by either NETCONF or RESTCONF, 181 explained in [RFC5277] and [RFC8650], respectively. 183 This document follows the guidelines of [RFC8407], uses the common 184 YANG types defined in [RFC6991], and adopts the Network Management 185 Datastore Architecture (NMDA) [RFC8342]. The meaning of the symbols 186 in tree diagrams is defined in [RFC8340]. 188 3. Use Cases for NSF Monitoring Data 190 As mentioned earlier, monitoring plays a critical role in an overall 191 security framework. The monitoring of the NSF provides very valuable 192 information to an NSF data collector (e.g., Security Controller) in 193 maintaining the provisioned security posture. Besides this, there 194 are various other reasons to monitor the NSF as listed below: 196 * The I2NSF User that is the security administrator can configure a 197 policy that is triggered on a specific event occurring in the NSF 198 or the network [RFC8329] 199 [I-D.ietf-i2nsf-consumer-facing-interface-dm]. If an NSF data 200 collector (e.g., Security Controller) detects the specified event, 201 it can configure additional security functions as defined by 202 policies. 204 * The events triggered by an NSF as a result of security policy 205 violation can be used by Security Information and Event Management 206 (SIEM) to detect any suspicious activity in a larger correlation 207 context. 209 * The information (i.e., events, records, and counters) from an NSF 210 can be used to build advanced analytics, such as behavior and 211 predictive models to improve security posture in large 212 deployments. 214 * The NSF data collector can use events from the NSF for achieving 215 high availability. It can take corrective actions such as 216 restarting a failed NSF and horizontally scaling up the NSF. 218 * The information (i.e., events, records, and counters) from the NSF 219 can aid in the root cause analysis of an operational issue, so it 220 can improve debugging. 222 * The records from the NSF can be used to build historical data for 223 operation and business reasons. 225 4. Classification of NSF Monitoring Data 227 In order to maintain a strong security posture, it is not only 228 necessary to configure an NSF's security policies but also to 229 continuously monitor the NSF by checking acquirable and observable 230 data. This enables security administrators to assess the state of 231 the networks in a timely fashion. It is not possible to block all 232 the internal and external threats based on static security posture. 233 A more practical approach is supported by enabling dynamic security 234 measures, for which continuous visibility is required. This document 235 defines a set of monitoring elements and their scopes that can be 236 acquired from an NSF and can be used as NSF monitoring data. In 237 essence, this monitoring data can be leveraged to support constant 238 visibility on multiple levels of granularity and can be consumed by 239 the corresponding functions. 241 Three basic domains of monitoring data originating from a system 242 entity [RFC4949], i.e., an NSF, are discussed in this document. 244 * Retention and Emission from NSFs 246 * Notifications for Events and Records 248 * Push and Pull for the retrieval of monitoring data from NSFs 250 Every system entity creates information about some context with 251 defined I2NSF monitoring data, and so every system entity that 252 provides such information can be an I2NSF component. This 253 information is intended to be consumed by other I2NSF components, 254 which deals with NSF monitoring data in an automated fashion. 256 4.1. Retention and Emission from NSFs 258 A system entity (e.g., NSF) first retains I2NSF monitoring data 259 inside its own system before emitting the information to another 260 I2NSF component (e.g., NSF Data Collector). The I2NSF monitoring 261 information consist of I2NSF Events, I2NSF Records, and I2NSF 262 Counters as follows: 264 I2NSF Event: I2NSF Event is defined as an important occurrence at a 265 particular time, that is, a change in the system being managed or 266 a change in the environment of the system being managed. An I2NSF 267 Event requires immediate attention and should be notified as soon 268 as possible. When used in the context of an (imperative) I2NSF 269 Policy Rule, an I2NSF Event is used to determine whether the 270 Condition clause of that Policy Rule can be evaluated or not. The 271 Alarm Management Framework in [RFC3877] defines an event as 272 something that happens which may be of interest. Examples of an 273 event are a fault, a change in status, crossing a threshold, or an 274 external input to the system. In the I2NSF domain, I2NSF events 275 are created following the definition of an event in the Alarm 276 Management Framework. 278 I2NSF Record: A record is defined as an item of information that is 279 kept to be looked at and used in the future. Typically, records 280 are the information, which is based on operational and 281 informational data (i.e., various changes in system 282 characteristics). They are generated by a system entity (e.g., 283 NSF) at particular instants to be kept without any changes 284 afterward. A set of records has an ordering in time based on when 285 they are generated. Unlike I2NSF Events, records do not require 286 immediate attention but may be useful for visibility and 287 retroactive cyber forensics. Records are typically stored in log- 288 files or databases on a system entity or NSF. The examples of 289 records include user activities, device performance, and network 290 status. They are important for debugging, auditing, and security 291 forensic of a system entity or the network having the system 292 entity. 294 I2NSF Counter: An I2NSF Counter is defined as a specific 295 representation of an information element whose value changes very 296 frequently. Prominent examples are network interface counters for 297 protocol data unit (PDU) amount, byte amount, drop counters, and 298 error counters. Counters are useful in debugging and visibility 299 into operational behavior of a system entity (e.g., NSF). When an 300 NSF data collector asks for the value of a counter, a system 301 entity MUST update the counter information and emit the latest 302 information to the NSF data collector. 304 Retention is defined as the storing of monitoring data in NSFs. The 305 retention of I2NSF monitoring information may be affected by the 306 importance of the data. The importance of the data could be context- 307 dependent, where it may not just be based on the type of data, but 308 may also depend on where it is deployed, e.g., a test lab and 309 testbed. The local policy and configuration will dictate the 310 policies and procedures to review, archive, or purge the collected 311 monitoring data. 313 Emission is defined as the delivery of monitoring data in NSFs to an 314 NSF data collector. The I2NSF monitoring information retained on a 315 system entity (e.g., NSF) may be delivered to a corresponding I2NSF 316 User via an NSF data collector. The information consists of the 317 aggregated records, typically in the form of log-files or databases. 318 For the NSF Monitoring Interface to deliver the information to the 319 NSF data collector, the NSF needs to accommodate standardized 320 delivery protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. 321 The NSF data collector can forward the information to the I2NSF User 322 through standardized delivery protocols (e.g., RESTCONF and NETCONF). 323 The interface for the delivery of Monitoring Data from the NSF data 324 collector to the I2NSF User is out of the scope of this document. 326 4.2. Notifications for Events and Records 328 A specific task of an I2NSF User is to provide I2NSF Policy Rules. 329 The rules of a policy are composed of three clauses: Event, 330 Condition, and Action clauses. In consequence, an I2NSF Event is 331 specified to trigger the evaluation of the Condition clause of the 332 I2NSF Policy Rule. Such an I2NSF Event is defined as an important 333 occurrence at a particular time in the system being managed, and/or 334 in the environment of the system being managed whose concept aligns 335 well with the generic definition of Event from [RFC3877]. 337 Another role of the I2NSF Event is to trigger a notification for 338 monitoring the status of an NSF. A notification is defined in 339 [RFC3877] as an unsolicited transmission of management information. 340 System alarm (called alarm) is defined as a warning related to 341 service degradation in system hardware in Section 6.1. System event 342 (called alert) is defined as a warning about any changes of 343 configuration, any access violation, information about sessions and 344 traffic flows in Section 6.2. Both an alarm and an alert are I2NSF 345 Events that can be delivered as a notification. The model 346 illustrated in this document introduces a complementary type of 347 information that can be a conveyed notification. 349 In I2NSF monitoring, a notification is used to deliver either an 350 event or a record via the I2NSF Monitoring Interface. The difference 351 between the event and record is the timing by which the notifications 352 are emitted. An event is emitted as soon as it happens in order to 353 notify an NSF Data Collector of the problem that needs immediate 354 attention. A record is not emitted immediately to the NSF Data 355 Collector, and it can be emitted periodically to the NSF Data 356 Collector. 358 It is important to note that an NSF Data Collector as a consumer 359 (i.e., observer) of a notification assesses the importance of the 360 notification rather than an NSF as a producer. The producer can 361 include metadata in a notification that supports the observer in 362 assessing its importance (e.g., severity). 364 4.3. Push and Pull for the retrieval of monitoring data from NSFs 366 An important aspect of monitoring information is the freshness of the 367 information. From the perspective of security, it is important to 368 notice changes in the current status of the network. The I2NSF 369 Monitoring Interface provides the means of sending monitored 370 information from the NSFs to an NSF data collector in a timely 371 manner. Monitoring information can be acquired by a client (i.e., 372 NSF data collector) from a server (i.e., NSF) using push [RFC5277] 373 [RFC8641] or pull methods [RFC6241] [RFC8040]. 375 The pull is a query-based method to obtain information from the NSF. 376 In this method, the NSF will remain passive until the information is 377 requested from the NSF data collector. Once a request is accepted 378 (with proper authentication), the NSF MUST update the information 379 before sending it to the NSF data collector. 381 The push is a report-based method to obtain information from the NSF. 382 The report-based method ensures the information can be delivered 383 immediately without any requests. This method is used by the NSF to 384 actively provide information to the NSF data collector. To receive 385 the information, the NSF data collector subscribes to the NSF for the 386 information. 388 These acquisition methods are used for different types of monitoring 389 information. The information that has a high level of urgency (i.e., 390 I2NSF Event) should be provided with the push method, while 391 information that has a lower level of urgency (i.e., I2NSF Record and 392 I2NSF Counter) can be provided with either the pull method or push 393 method. 395 5. Basic Information Model for Monitoring Data 397 As explained in the above section, there is a wealth of data 398 available from NSFs that can be monitored. Firstly, there must be 399 some general information with each monitoring message sent from an 400 NSF that helps a consumer to identify metadata with that message, 401 which are listed as below: 403 * message: The extra detailed description of NSF monitoring data to 404 give an NSF data collector the context information as metadata. 406 * vendor-name: The vendor's name of the NSF that generates the 407 message. 409 * device-model: The model of the device, can be represented by the 410 device model name or serial number. This field is used to 411 identify the model of the device that provides the security 412 service. 414 * software-version: The version of the software used to provide the 415 security service. 417 * nsf-name: The name or IP address of the NSF generating the 418 message. If the given nsf-name is not an IP address, the name can 419 be an arbitrary string including a FQDN (Fully Qualified Domain 420 Name). The name MUST be unique in the scope of management domain 421 for a different NSF to identify the NSF that generates the 422 message. 424 * timestamp: The time when the message was generated. For the 425 notification operations (i.e., System Alarms, System Events, NSF 426 Events, System Logs, and NSF Logs), this is represented by the 427 eventTime of NETCONF event notification [RFC5277] For other 428 operations (i.e., System Counter and NSF Counter), the timestamp 429 MUST be provided separately. The time format used is following 430 the rules in Section 5.6 of [RFC3339]. 432 * language: describes the human language intended for the user, so 433 that it allows a user to verify the language that is used in the 434 notification (i.e., '../message', '/i2nsf-log/i2nsf-nsf-system- 435 access-log/output', and '/i2nsf-log/i2nsf-system-user-activity- 436 log/additional-info/cause'). The attribute is encoded following 437 the rules in Section 2.1 of [RFC5646]. The default language tag 438 is "en-US". 440 6. Extended Information Model for Monitoring Data 442 The extended information model is the specific monitoring data that 443 covers the additional information associated with the detailed 444 information of status and performance of the network and the NSF over 445 the basic information model. The extended information combined with 446 the basic information creates the monitoring information (i.e., I2NSF 447 Event, Record, and Counter). 449 The extended monitoring information has settable characteristics for 450 data collection as follows: 452 * Acquisition method: The method to obtain the message. It can be a 453 "query" or a "subscription". A "query" is a request-based method 454 to acquire the solicited information. A "subscription" is a 455 report-based method that pushes information to the subscriber. 457 * Emission type: The cause type for the message to be emitted. This 458 attribute is used only when the acquisition method is a 459 "subscription" method. The emission type can be either "on- 460 change" or "periodic". An "on-change" message is emitted when an 461 important event happens in the NSF. A "periodic" message is 462 emitted at a certain time interval. The time to periodically emit 463 the message is configurable. 465 * Dampening type: The type of message dampening to stop the rapid 466 transmission of messages. The dampening types are "on-repetition" 467 and "no-dampening". The "on-repetition" type limits the 468 transmitted "on-change" message to one message at a certain 469 interval (e.g., 100 centiseconds). This interval is defined as 470 dampening-period in [RFC8641]. The dampening-period is 471 configurable in the unit of centiseconds. The "no-dampening" type 472 does not limit the transmission for the messages of the same type. 473 In short, "on-repetition" means that the dampening is active and 474 "no-dampening" is inactive. Activating the dampening for an "on- 475 change" type of message is RECOMMENDED to reduce the number of 476 messages generated. 478 Note that the characteristic information is not mandatory to be 479 included in a monitoring message. The information is expected to be 480 stored and may or may not be useful in some ways in the future. In 481 any case, the inclusion of the characteristic information is up to 482 the implementation. 484 6.1. System Alarms 486 System alarms have the following characteristics: 488 * acquisition-method: subscription 490 * emission-type: on-change 492 * dampening-type: on-repetition or no-dampening 494 6.1.1. Memory Alarm 496 The memory is the hardware to store information temporarily or for a 497 short period, i.e., Random Access Memory (RAM). The memory-alarm is 498 emitted when the memory usage exceeds the threshold. The following 499 information should be included in a Memory Alarm: 501 * event-name: memory-alarm. 503 * usage: specifies the amount of memory used in percentage. 505 * threshold: The threshold triggering the alarm in percentage. 507 * severity: The severity level of the message. There are four 508 levels, i.e., critical, high, middle, and low. 510 * message: Simple information as a human readable text string such 511 as "The memory usage exceeded the threshold" or with extra 512 information. 514 6.1.2. CPU Alarm 516 CPU is the Central Processing Unit that executes basic operations of 517 the system. The cpu-alarm is emitted when the CPU usage exceeds the 518 threshold. The following information should be included in a CPU 519 Alarm: 521 * event-name: cpu-alarm. 523 * usage: Specifies the CPU utilization in percentage. 525 * threshold: The threshold triggering the event in percentage. 527 * severity: The severity level of the message. There are four 528 levels, i.e., critical, high, middle, and low. 530 * message: Simple information as a human readable text string such 531 as "The CPU usage exceeded the threshold" or with extra 532 information. 534 6.1.3. Disk (Storage) Alarm 536 Disk or storage is the hardware to store information for a long time, 537 i.e., Hard Disk or Solid-State Drive. The disk-alarm is emitted when 538 the Disk usage exceeds the threshold. The following information 539 should be included in a Disk Alarm: 541 * event-name: disk-alarm. 543 * usage: Specifies the ratio of the used disk space to the whole 544 disk space in terms of percentage. 546 * threshold: The threshold triggering the event in percentage. 548 * severity: The severity level of the message. There are four 549 levels, i.e., critical, high, middle, and low. 551 * message: Simple information as a human readable text string such 552 as "The disk usage exceeded the threshold" or with extra 553 information. 555 6.1.4. Hardware Alarm 557 The hardware-alarm is emitted when a hardware, e.g., CPU, memory, 558 disk, or interface, problem is detected. The following information 559 should be included in a Hardware Alarm: 561 * event-name: hardware-alarm. 563 * component-name: It indicates the hardware component responsible 564 for generating this alarm. 566 * severity: The severity level of the message. There are four 567 levels, i.e., critical, high, middle, and low. 569 * message: Simple information as a human readable text string such 570 as "The hardware component has failed or degraded" or with extra 571 information. 573 6.1.5. Interface Alarm 575 Interface is the network interface for connecting a device with the 576 network. The interface-alarm is emitted when the state of the 577 interface is changed. The following information should be included 578 in an Interface Alarm: 580 * event-name: interface-alarm. 582 * interface-name: The name of the interface. 584 * interface-state: The status of the interface, i.e., down, up (not 585 congested), congested (up but congested), testing, unknown, 586 dormant, not-present, and lower-layer-down. 588 * severity: The severity level of the message. There are four 589 levels, i.e., critical, high, middle, and low. 591 * message: Simple information as a human readable text string such 592 as "The interface is 'interface-state'" or with extra information. 594 6.2. System Events 596 System events (as alerts) have the following characteristics: 598 * acquisition-method: subscription 600 * emission-type: on-change 602 * dampening-type: on-repetition or no-dampening 604 6.2.1. Access Violation 606 The access-violation system event is an event when a user tries to 607 access (read, write, create, or delete) any information or execute 608 commands above their privilege. The following information should be 609 included in this event: 611 * event-name: access-violation. 613 * identity: The information to identify the attempted access 614 violation. The minimum information (extensible) that should be 615 included: 617 1. user: The unique username that attempted access violation. 619 2. group: Group(s) to which a user belongs. A user can belong to 620 multiple groups. 622 3. ip-address: The IP address of the user that triggered the 623 event. 625 4. l4-port-number: The transport layer port number used by the 626 user. 628 * authentication: The method to verify the valid user, i.e., pre- 629 configured-key and certificate-authority. 631 * message: The message as a human readable text string to give the 632 context of the event, such as "Access is denied". 634 6.2.2. Configuration Change 636 A configuration change is a system event when a new configuration is 637 added or an existing configuration is modified. The following 638 information should be included in this event: 640 * event-name: configuration-change. 642 * identity: The information to identify the user that updated the 643 configuration. The minimum information (extensible) that should 644 be included: 646 1. user: The unique username that changes the configuration. 648 2. group: Group(s) to which a user belongs. A user can belong to 649 multiple groups. 651 3. ip-address: The IP address of the user that triggered the 652 event. 654 4. l4-port-number: The transport layer port number used by the 655 user. 657 * authentication: The method to verify the valid user, i.e., pre- 658 configured-key and certificate-authority. 660 * message: The message as a human readable text string to give the 661 context of the event, such as "Configuration is modified", "New 662 configuration is added", or "A configuration has been removed". 664 * changes: Describes the modification that was made to the 665 configuration. The minimum information that must be provided is 666 the name of the policy that has been altered (added, modified, or 667 removed). Other detailed information about the configuration 668 changes is up to the implementation. 670 6.2.3. Session Table Event 672 A session is defined as a connection (i.e., traffic flow) of a data 673 plane (e.g., TCP, UDP, and SCTP). Session Table Event is the event 674 triggered by the session table of an NSF. A session table holds the 675 information of the currently active sessions. The following 676 information should be included in a Session Table Event: 678 * event-name: detection-session-table. 680 * current-session: The number of concurrent sessions. 682 * maximum-session: The maximum number of sessions that the session 683 table can support. 685 * threshold: The threshold (in terms of an allowed number of 686 sessions) triggering the event. 688 * message: The message as a human readable text string to give the 689 context of the event, such as "The number of sessions exceeded the 690 table threshold". 692 6.2.4. Traffic Flows 694 Traffic flows need to be monitored because they might be used for 695 security attacks to the network. The following information should be 696 included in this event: 698 * event-name: traffic-flows. 700 * interface-name: The mnemonic name of the network interface 702 * interface-type: The type of a network interface such as an ingress 703 or egress interface. 705 * src-mac: The source MAC address of the traffic flow. This 706 information may or may not be included depending on the type of 707 traffic flow. For example, the information will be useful and 708 should be included if the traffic flows are traffic flows of Link 709 Layer Discovery Protocol (LLDP) [IEEE-802.1AB], Address Resolution 710 Protocol (ARP) for IPv4 [RFC0826], and Neighbor Discovery Protocol 711 (ND) for IPv6 [RFC4861]. 713 * dst-mac: The destination MAC address of the traffic flow. This 714 information may or may not be included depending on the type of 715 traffic flow. For example, the information will be useful and 716 should be included if the traffic flows are LLDP, ARP for IPv4, or 717 ND for IPv6 traffic flows. 719 * src-ip: The source IPv4 or IPv6 address of the traffic flow. 721 * dst-ip: The destination IPv4 or IPv6 address of the traffic flow. 723 * src-port: The transport layer source port number of the traffic 724 flow. 726 * dst-port: The transport layer destination port number of the 727 traffic flow. 729 * protocol: The protocol of the traffic flow. 731 * measurement-time: The duration of the measurement in seconds for 732 the arrival rate and arrival throughput of packets of a traffic 733 flow. These two metrics (i.e., arrival rate and arrival 734 throughput) are measured over the past measurement duration before 735 now. 737 * arrival-rate: Arrival rate of packets of the traffic flow in 738 packets per second measured over the past "measurement-time". 740 * arrival-throughput: Arrival rate of packets of the traffic flow in 741 bytes per second measured over the past "measurement-time". 743 Note that the NSF Monitoring Interface data model is focused on a 744 generic method to collect the monitoring information of systems and 745 NSFs including traffic flows related to security attacks and system 746 resource usages. On the other hand, IPFIX [RFC7011] is a standard 747 method to collect general information on traffic flows rather than 748 security. 750 6.3. NSF Events 752 The NSF events provide the event that is detected by a specific NSF 753 that supported a certain capability. This section only discusses the 754 monitoring data for the advanced NSFs discussed in 755 [I-D.ietf-i2nsf-capability-data-model]. The NSF events information 756 can be extended to support other types of NSF. NSF events have the 757 following characteristics: 759 * acquisition-method: subscription 760 * emission-type: on-change 762 * dampening-type: on-repetition or no-dampening 764 6.3.1. DDoS Detection 766 The following information should be included in a Denial-of-Service 767 (DoS) or Distributed Denial-of-Service (DDoS) Event: 769 * event-name: detection-ddos. 771 * attack-type: The type of DoS or DDoS Attack, i.e., SYN flood, ACK 772 flood, SYN-ACK flood, FIN/RST flood, TCP Connection flood, UDP 773 flood, ICMP flood, HTTPS flood, HTTP flood, DNS query flood, DNS 774 reply flood, SIP flood, TLS flood, and NTP amplification flood. 775 This can be extended with additional types of DoS or DDoS attack. 777 * attack-src-ip: The IP addresses of the source of the DDoS attack. 778 Note that not all IP addresses should be included but only limited 779 IP addresses are included to conserve the server resources. The 780 listed attacking IP addresses can be an arbitrary sampling of the 781 "top talkers", i.e., the attackers that send the highest amount of 782 traffic. 784 * attack-dst-ip: The destination IPv4 or IPv6 addresses of attack 785 traffic. It can hold multiple IPv4 or IPv6 addresses. 787 * attack-src-port: The transport layer source port numbers of the 788 attack traffic. Note that not all ports will have been seen on 789 all the corresponding source IP addresses. 791 * attack-dst-port: The transport layer destination port numbers that 792 the attack traffic aims at. Note that not all ports will have 793 been seen on all the corresponding destination IP addresses. 795 * start-time: The time stamp indicating when the attack started. 796 The time format used is following the rules in Section 5.6 of 797 [RFC3339]. 799 * end-time: The time stamp indicating when the attack ended. If the 800 attack is still ongoing when sending out the notification, this 801 field can be empty. The time format used is following the rules 802 in Section 5.6 of [RFC3339]. 804 * attack-rate: The packets per second of attack traffic. 806 * attack-throughput: The bytes per second of attack traffic. 808 * rule-name: The name of the I2NSF Policy Rule being triggered. 809 Note that rule-name is used to match a detected NSF event with a 810 policy rule in [I-D.ietf-i2nsf-nsf-facing-interface-dm]. 812 6.3.2. Virus Event 814 This information is used when a virus is detected within a traffic 815 flow or inside a host. Note that "malware" is a more generic word 816 for malicious software, including virus and worm. In the document, 817 "virus" is used to represent "malware" such that they are 818 interchangeable. The following information should be included in a 819 Virus Event: 821 * event-name: detection-virus. 823 * virus-name: Name of the virus. 825 * virus-type: Type of the virus. e.g., trojan, worm, and macro 826 virus. 828 * The following information is used only when the virus is detected 829 within the traffic flow and not yet attacking the host: 831 - dst-ip: The destination IP address of the flow where the virus 832 is found. 834 - src-ip: The source IP address of the flow where the virus is 835 found. 837 - src-port: The source port of the flow where the virus is found. 839 - dst-port: The destination port of the flow where the virus is 840 found. 842 * The following information is used only when the virus is detected 843 within a host system: 845 - host: The name or IP address of the host/device that is 846 infected by the virus. If the given name is not an IP address, 847 the name can be an arbitrary string including a FQDN (Fully 848 Qualified Domain Name). The name MUST be unique in the scope 849 of management domain for identifying the device that has been 850 infected with a virus. 852 - os: The operating system of the host that has the virus. 854 - file-type: The type of file (indicated by the file's suffix, 855 e.g., .exe) virus code is found in (if applicable). 857 - file-name: The name of the file where the virus is hidden. 859 * rule-name: The name of the rule being triggered. 861 Note "host" is used only when the virus is detected within a host 862 itself. Thus, the traffic flow information such as the source and 863 destination IP addresses is not important, so the elements of the 864 traffic flow (i.e., dst-ip, src-ip, src-port, and dst-port) are not 865 specified above. On the other hand, when the virus is detected 866 within a traffic flow and not yet attacking a host, the element of 867 "host" is not specified above. 869 6.3.3. Intrusion Event 871 The following information should be included in an Intrusion Event: 873 * event-name: detection-intrusion. 875 * attack-type: Attack type, e.g., brutal force or buffer overflow. 877 * src-ip: The source IP address of the flow. 879 * dst-ip: The destination IP address of the flow. 881 * src-port: The source port number of the flow. 883 * dst-port: The destination port number of the flow 885 * protocol: The employed transport layer protocol. e.g., TCP or UDP. 886 Note that QUIC protocol [RFC9000] is excluded in the data model as 887 it is not considered in the initial I2NSF documents [RFC8329]. 888 The QUIC traffic should not be treated as UDP traffic and will be 889 considered in the future I2NSF documents. 891 * app: The employed application layer protocol. e.g., HTTP or FTP. 893 * rule-name: The name of the I2NSF Policy Rule being triggered. 895 6.3.4. Web Attack Event 897 The following information should be included in a Web Attack Alarm: 899 * event-name: detection-web-attack. 901 * attack-type: Concrete web attack type. e.g., SQL injection, 902 command injection, XSS, or CSRF. 904 * src-ip: The source IP address of the packet. 906 * dst-ip: The destination IP address of the packet. 908 * src-port: The source port number of the packet. 910 * dst-port: The destination port number of the packet. 912 * req-method: The HTTP method of the request. For instance, "PUT" 913 and "GET" in HTTP. 915 * req-target: The HTTP Request Target. 917 * response-code: The HTTP Response status code. 919 * cookies: The HTTP Cookie header field of the request from the user 920 agent. The cookies information needs to be kept confidential and 921 is not RECOMMENDED to be included in the monitoring data unless 922 the information is absolutely necessary to help to enhance the 923 security of the network. 925 * req-host: The HTTP Host header field of the request. 927 * filtering-type: URL filtering type. e.g., deny-list, allow-list, 928 and unknown. 930 * rule-name: The name of the I2NSF Policy Rule being triggered. 932 6.3.5. VoIP/VoCN Event 934 The following information should be included in a VoIP (Voice over 935 Internet Protocol) and VoCN (Voice over Cellular Network, such as 936 Voice over LTE or 5G) Event: 938 * event-name: detection-voip-vocn 940 * source-voice-id: The detected source voice Call ID for VoIP and 941 VoCN that violates the policy. 943 * destination-voice-id: The destination voice Call ID for VoIP and 944 VoCN that violates the policy. 946 * user-agent: The user agent for VoIP and VoCN that violates the 947 policy. 949 * src-ip: The source IP address of the VoIP/VoCN. 951 * dst-ip: The destination IP address of the VoIP/VoCN. 953 * src-port: The source port number of the VoIP/VoCN. 955 * dst-port: The destination port number of VoIP/VoCN. 957 * rule-name: The name of the I2NSF Policy Rule being triggered. 959 6.4. System Logs 961 System log is a record that is used to monitor the activity of the 962 user on the NSF and the status of the NSF. System logs have the 963 following characteristics: 965 * acquisition-method: subscription or query 967 * emission-type: on-change or periodic 969 * dampening-type: on-repetition or no-dampening 971 6.4.1. Access Log 973 Access logs record administrators' login, logout, and operations on a 974 device. By analyzing them, some security vulnerabilities can be 975 identified. The following information should be included in an 976 operation report: 978 * identity: The information to identify the user. The minimum 979 information (extensible) that should be included: 981 1. user: The unique username that attempted access violation. 983 2. group: Group(s) to which a user belongs. A user can belong to 984 multiple groups. 986 3. ip-address: The IP address of the user that triggered the 987 event. 989 4. l4-port-number: The transport layer port number used by the 990 user. 992 * authentication: The method to verify the valid user, i.e., pre- 993 configured-key and certificate-authority. 995 * operation-type: The operation type that the administrator 996 executed, e.g., login, logout, configuration, and other. 998 * input: The operation performed by a user after login. The 999 operation is a command given by a user. 1001 * output: The result after executing the input. 1003 6.4.2. Resource Utilization Log 1005 Running reports record the device system's running status, which is 1006 useful for device monitoring. The following information should be 1007 included in running report: 1009 * system-status: The current system's running status. 1011 * cpu-usage: Specifies the aggregated CPU usage in percentage. 1013 * memory-usage: Specifies the memory usage in percentage. 1015 * disk-id: Specifies the disk ID to identify the storage disk. 1017 * disk-usage: Specifies the disk usage of disk-id in percentage. 1019 * disk-space-left: Specifies the available disk space left of disk- 1020 id in percentage. 1022 * session-number: Specifies total concurrent sessions. 1024 * process-number: Specifies total number of systems processes. 1026 * interface-id: Specifies the interface ID to identify the network 1027 interface. 1029 * in-traffic-rate: The total inbound data plane traffic rate in 1030 packets per second. 1032 * out-traffic-rate: The total outbound data plane traffic rate in 1033 packets per second. 1035 * in-traffic-throughput: The total inbound data plane traffic 1036 throughput in bytes per second. 1038 * out-traffic-throughput: The total outbound data plane traffic 1039 throughput in bytes per second. 1041 Note that "traffic" includes only the data plane since the monitoring 1042 interface focuses on the monitoring of traffic flows for 1043 applications, rather than the control plane. In the document, 1044 "packet" includes a layer-2 frame, so "packet" and "frame" are 1045 interchangeable. Also, note that system resources (e.g., CPU, 1046 memory, disk, and interface) are monitored for the sake of security 1047 in NSFs even though they are common ones to be monitored by a generic 1048 Operations, Administration and Maintenance (OAM) protocol (or 1049 module). 1051 6.4.3. User Activity Log 1053 User activity logs provide visibility into users' online records 1054 (such as login time, online/lockout duration, and login IP addresses) 1055 and the actions that users perform. User activity reports are 1056 helpful to identify exceptions during a user's login and network 1057 access activities. This information should be included in a user's 1058 activity report: 1060 * identity: The information to identify the user. The minimum 1061 information (extensible) that should be included is as follows: 1063 1. user: The unique username that attempted access violation. 1065 2. group: Group(s) to which a user belongs. A user can belong to 1066 multiple groups. 1068 3. ip-address: The IP address of the user that triggered the 1069 event. 1071 4. l4-port-number: The transport layer port number used by the 1072 user. 1074 * authentication: The method to verify the valid user, i.e., pre- 1075 configured-key and certificate-authority. 1077 * online-duration: The duration of a user's activeness (stays in 1078 login) during a session. 1080 * logout-duration: The duration of a user's inactiveness (not in 1081 login) from the last session. 1083 * additional-info: Additional Information for login: 1085 1. type: User activities. e.g., Successful User Login, Failed 1086 Login attempts, User Logout, Successful User Password Change, 1087 Failed User Password Change, User Lockout, and User Unlocking. 1089 2. cause: Cause of a failed user activity. 1091 6.5. NSF Logs 1093 NSF logs have the folowing characteristics: 1095 * acquisition-method: subscription or query 1097 * emission-type: on-change 1098 * dampening-type: on-repetition or no-dampening 1100 6.5.1. Deep Packet Inspection Log 1102 Deep Packet Inspection (DPI) Logs provide statistics of transit 1103 traffic at an NSF such that the traffic includes uploaded and 1104 downloaded files/data, sent/received emails, and blocking/alert 1105 records on websites. It is helpful to learn risky user behaviors and 1106 why access to some URLs is blocked or allowed with an alert record. 1108 * attack-type: DPI action types. e.g., File Blocking, Data 1109 Filtering, and Application Behavior Control. 1111 * src-ip: The source IP address of the flow. 1113 * dst-ip: The destination IP address of the flow. 1115 * src-port: The source port number of the flow. 1117 * dst-port: The destination port number of the flow 1119 * rule-name: The name of the I2NSF Policy Rule being triggered. 1121 * action: Action defined in the file blocking rule, data filtering 1122 rule, or application behavior control rule that traffic matches. 1124 6.6. System Counter 1126 System counter has the following characteristics: 1128 * acquisition-method: subscription or query 1130 * emission-type: periodic 1132 * dampening-type: no-dampening 1134 6.6.1. Interface Counter 1136 Interface counters provide visibility into traffic into and out of an 1137 NSF, and bandwidth usage. 1139 * interface-name: Network interface name configured in NSF. 1141 * protocol: The type of network protocol (e.g., IPv4, IPv6, TCP, and 1142 UDP). If this field is empty, then the counter is used for all 1143 protocols. 1145 * measurement-time: The duration of the measurement in seconds for 1146 the calculation of statistics such as traffic rate and throughput. 1147 The statistic attributes are measured over the past measurement 1148 duration before now. 1150 * in-total-traffic-pkts: Total inbound packets. 1152 * out-total-traffic-pkts: Total outbound packets. 1154 * in-total-traffic-bytes: Total inbound bytes. 1156 * out-total-traffic-bytes: Total outbound bytes. 1158 * in-drop-traffic-pkts: Total inbound drop packets caused by a 1159 policy or hardware/resource error. 1161 * out-drop-traffic-pkts: Total outbound drop packets caused by a 1162 policy or hardware/resource error. 1164 * in-drop-traffic-bytes: Total inbound drop bytes caused by a policy 1165 or hardware/resource error. 1167 * out-drop-traffic-bytes: Total outbound drop bytes caused by a 1168 policy or hardware/resource error. 1170 * total-traffic: The total number of traffic packets (in and out) in 1171 the NSF. 1173 * in-traffic-average-rate: Inbound traffic average rate in packets 1174 per second. 1176 * in-traffic-peak-rate: Inbound traffic peak rate in packets per 1177 second. 1179 * in-traffic-average-throughput: Inbound traffic average throughput 1180 in bytes per second. 1182 * in-traffic-peak-throughput: Inbound traffic peak throughput in 1183 bytes per second. 1185 * out-traffic-average-rate: Outbound traffic average rate in packets 1186 per second. 1188 * out-traffic-peak-rate: Outbound traffic peak rate in packets per 1189 second. 1191 * out-traffic-average-throughput: Outbound traffic average 1192 throughput in bytes per second. 1194 * out-traffic-peak-throughput: Outbound traffic peak throughput in 1195 bytes per second. 1197 * discontinuity-time: The time of the most recent occasion at which 1198 any one or more of the counters suffered a discontinuity. If no 1199 such discontinuities have occurred since the last re- 1200 initialization of the local management subsystem, then this node 1201 contains the time the local management subsystem was re- 1202 initialized. The time format used is following the rules in 1203 Section 5.6 of [RFC3339]. 1205 6.7. NSF Counters 1207 NSF counters have the following characteristics: 1209 * acquisition-method: subscription or query 1211 * emission-type: periodic 1213 * dampening-type: no-dampening 1215 6.7.1. Firewall Counter 1217 Firewall counters provide visibility into traffic signatures and 1218 bandwidth usage that correspond to the policy that is configured in a 1219 firewall. 1221 * policy-name: Security policy name that traffic matches. 1223 * measurement-time: The duration of the measurement in seconds for 1224 the calculation of statistics such as traffic rate and throughput. 1225 The statistic attributes are measured over the past measurement 1226 duration before now. 1228 * in-interface: Inbound interface of traffic. 1230 * out-interface: Outbound interface of traffic. 1232 * total-traffic: The total number of traffic packets (in and out) in 1233 the firewall. 1235 * in-traffic-average-rate: Inbound traffic average rate in packets 1236 per second. 1238 * in-traffic-peak-rate: Inbound traffic peak rate in packets per 1239 second. 1241 * in-traffic-average-throughput: Inbound traffic average throughput 1242 in bytes per second. 1244 * in-traffic-peak-throughput: Inbound traffic peak throughput in 1245 bytes per second. 1247 * out-traffic-average-rate: Outbound traffic average rate in packets 1248 per second. 1250 * out-traffic-peak-rate: Outbound traffic peak rate in packets per 1251 second. 1253 * out-traffic-average-throughput: Outbound traffic average 1254 throughput in bytes per second. 1256 * out-traffic-peak-throughput: Outbound traffic peak throughput in 1257 bytes per second. 1259 * discontinuity-time: The time on the most recent occasion at which 1260 any one or more of the counters suffered a discontinuity. If no 1261 such discontinuities have occurred since the last re- 1262 initialization of the local management subsystem, then this node 1263 contains the time the local management subsystem was re- 1264 initialized. The time format used is following the rules in 1265 Section 5.6 of [RFC3339]. 1267 6.7.2. Policy Hit Counter 1269 Policy hit counters record the security policy that traffic matches 1270 and its hit count. That is, when a packet actually matches a policy, 1271 it should be added to the statistics of a "policy hit counter" of the 1272 policy. The "policy hit counter" provides the "policy-name" that 1273 matches the policy's name in the NSF-Facing Interface YANG data model 1274 [I-D.ietf-i2nsf-nsf-facing-interface-dm]. It can check if policy 1275 configurations are correct or not. 1277 * policy-name: Security policy name that traffic matches. 1279 * hit-times: The number of times that the security policy matches 1280 the specified traffic. 1282 * discontinuity-time: The time on the most recent occasion at which 1283 any one or more of the counters suffered a discontinuity. If no 1284 such discontinuities have occurred since the last re- 1285 initialization of the local management subsystem, then this node 1286 contains the time the local management subsystem was re- 1287 initialized. The time format used is following the rules in 1288 Section 5.6 of [RFC3339]. 1290 7. YANG Tree Structure of NSF Monitoring YANG Module 1292 The tree structure of the NSF monitoring YANG module is provided 1293 below: 1295 module: ietf-i2nsf-nsf-monitoring 1296 +--ro i2nsf-counters 1297 | +--ro vendor-name? string 1298 | +--ro device-model? string 1299 | +--ro software-version? string 1300 | +--ro nsf-name union 1301 | +--ro timestamp? yang:date-and-time 1302 | +--ro acquisition-method? identityref 1303 | +--ro emission-type? identityref 1304 | +--ro system-interface* [interface-name] 1305 | | +--ro interface-name if:interface-ref 1306 | | +--ro protocol? identityref 1307 | | +--ro in-total-traffic-pkts? yang:counter64 1308 | | +--ro out-total-traffic-pkts? yang:counter64 1309 | | +--ro in-total-traffic-bytes? uint64 1310 | | +--ro out-total-traffic-bytes? uint64 1311 | | +--ro in-drop-traffic-pkts? yang:counter64 1312 | | +--ro out-drop-traffic-pkts? yang:counter64 1313 | | +--ro in-drop-traffic-bytes? uint64 1314 | | +--ro out-drop-traffic-bytes? uint64 1315 | | +--ro discontinuity-time yang:date-and-time 1316 | | +--ro measurement-time? uint32 1317 | | +--ro total-traffic? yang:counter64 1318 | | +--ro in-traffic-average-rate? uint64 1319 | | +--ro in-traffic-peak-rate? uint64 1320 | | +--ro in-traffic-average-throughput? uint64 1321 | | +--ro in-traffic-peak-throughput? uint64 1322 | | +--ro out-traffic-average-rate? uint64 1323 | | +--ro out-traffic-peak-rate? uint64 1324 | | +--ro out-traffic-average-throughput? uint64 1325 | | +--ro out-traffic-peak-throughput? uint64 1326 | +--ro nsf-firewall* [policy-name] 1327 | | +--ro in-interface? if:interface-ref 1328 | | +--ro out-interface? if:interface-ref 1329 | | +--ro policy-name -> /nsfintf:i2nsf-security-policy/name 1330 | | +--ro discontinuity-time yang:date-and-time 1331 | | +--ro measurement-time? uint32 1332 | | +--ro total-traffic? yang:counter64 1333 | | +--ro in-traffic-average-rate? uint64 1334 | | +--ro in-traffic-peak-rate? uint64 1335 | | +--ro in-traffic-average-throughput? uint64 1336 | | +--ro in-traffic-peak-throughput? uint64 1337 | | +--ro out-traffic-average-rate? uint64 1338 | | +--ro out-traffic-peak-rate? uint64 1339 | | +--ro out-traffic-average-throughput? uint64 1340 | | +--ro out-traffic-peak-throughput? uint64 1341 | +--ro nsf-policy-hits* [policy-name] 1342 | +--ro policy-name -> /nsfintf:i2nsf-security-policy/name 1343 | +--ro discontinuity-time yang:date-and-time 1344 | +--ro hit-times? yang:counter64 1345 +--rw i2nsf-monitoring-configuration 1346 +--rw i2nsf-system-detection-alarm 1347 | +--rw enabled? boolean 1348 | +--rw system-alarm* [alarm-type] 1349 | +--rw alarm-type enumeration 1350 | +--rw threshold? uint8 1351 | +--rw dampening-period? centiseconds 1352 +--rw i2nsf-system-detection-event 1353 | +--rw enabled? boolean 1354 | +--rw dampening-period? centiseconds 1355 +--rw i2nsf-traffic-flows 1356 | +--rw dampening-period? centiseconds 1357 | +--rw enabled? boolean 1358 +--rw i2nsf-nsf-detection-ddos {i2nsf-nsf-detection-ddos}? 1359 | +--rw enabled? boolean 1360 | +--rw dampening-period? centiseconds 1361 +--rw i2nsf-nsf-detection-virus {i2nsf-nsf-detection-virus}? 1362 | +--rw enabled? boolean 1363 | +--rw dampening-period? centiseconds 1364 +--rw i2nsf-nsf-detection-session-table 1365 | +--rw enabled? boolean 1366 | +--rw dampening-period? centiseconds 1367 +--rw i2nsf-nsf-detection-intrusion 1368 {i2nsf-nsf-detection-intrusion}? 1369 | +--rw enabled? boolean 1370 | +--rw dampening-period? centiseconds 1371 +--rw i2nsf-nsf-detection-web-attack 1372 {i2nsf-nsf-detection-web-attack}? 1373 | +--rw enabled? boolean 1374 | +--rw dampening-period? centiseconds 1375 +--rw i2nsf-nsf-detection-voip-vocn 1376 {i2nsf-nsf-detection-voip-vocn}? 1377 | +--rw enabled? boolean 1378 | +--rw dampening-period? centiseconds 1379 +--rw i2nsf-nsf-system-access-log 1380 | +--rw enabled? boolean 1381 | +--rw dampening-period? centiseconds 1382 +--rw i2nsf-system-res-util-log 1383 | +--rw enabled? boolean 1384 | +--rw dampening-period? centiseconds 1385 +--rw i2nsf-system-user-activity-log 1386 | +--rw enabled? boolean 1387 | +--rw dampening-period? centiseconds 1388 +--rw i2nsf-nsf-log-dpi {i2nsf-nsf-log-dpi}? 1389 | +--rw enabled? boolean 1390 | +--rw dampening-period? centiseconds 1391 +--rw i2nsf-counter 1392 +--rw period? uint16 1394 notifications: 1395 +---n i2nsf-event 1396 | +--ro vendor-name? string 1397 | +--ro device-model? string 1398 | +--ro software-version? string 1399 | +--ro nsf-name union 1400 | +--ro message? string 1401 | +--ro language? string 1402 | +--ro acquisition-method? identityref 1403 | +--ro emission-type? identityref 1404 | +--ro dampening-type? identityref 1405 | +--ro (sub-event-type)? 1406 | +--:(i2nsf-system-detection-alarm) 1407 | | +--ro i2nsf-system-detection-alarm 1408 | | +--ro alarm-category? identityref 1409 | | +--ro component-name? string 1410 | | +--ro interface-name? if:interface-ref 1411 | | +--ro interface-state? enumeration 1412 | | +--ro severity? severity 1413 | | +--ro usage? uint8 1414 | | +--ro threshold? uint8 1415 | +--:(i2nsf-system-detection-event) 1416 | | +--ro i2nsf-system-detection-event 1417 | | +--ro event-category? identityref 1418 | | +--ro user string 1419 | | +--ro group* string 1420 | | +--ro ip-address inet:ip-address-no-zone 1421 | | +--ro l4-port-number inet:port-number 1422 | | +--ro authentication? identityref 1423 | | +--ro changes* [policy-name] 1424 | | +--ro policy-name 1425 -> /nsfintf:i2nsf-security-policy/name 1426 | +--:(i2nsf-traffic-flows) 1427 | | +--ro i2nsf-traffic-flows 1428 | | +--ro interface-name? if:interface-ref 1429 | | +--ro interface-type? enumeration 1430 | | +--ro src-mac? yang:mac-address 1431 | | +--ro dst-mac? yang:mac-address 1432 | | +--ro src-ip? inet:ip-address-no-zone 1433 | | +--ro dst-ip? inet:ip-address-no-zone 1434 | | +--ro protocol? identityref 1435 | | +--ro src-port? inet:port-number 1436 | | +--ro dst-port? inet:port-number 1437 | | +--ro measurement-time? uint32 1438 | | +--ro arrival-rate? uint64 1439 | | +--ro arrival-throughput? uint64 1440 | +--:(i2nsf-nsf-detection-session-table) 1441 | +--ro i2nsf-nsf-detection-session-table 1442 | +--ro current-session? uint32 1443 | +--ro maximum-session? uint32 1444 | +--ro threshold? uint32 1445 +---n i2nsf-log 1446 | +--ro vendor-name? string 1447 | +--ro device-model? string 1448 | +--ro software-version? string 1449 | +--ro nsf-name union 1450 | +--ro message? string 1451 | +--ro language? string 1452 | +--ro acquisition-method? identityref 1453 | +--ro emission-type? identityref 1454 | +--ro dampening-type? identityref 1455 | +--ro (sub-logs-type)? 1456 | +--:(i2nsf-nsf-system-access-log) 1457 | | +--ro i2nsf-nsf-system-access-log 1458 | | +--ro user string 1459 | | +--ro group* string 1460 | | +--ro ip-address inet:ip-address-no-zone 1461 | | +--ro l4-port-number inet:port-number 1462 | | +--ro authentication? identityref 1463 | | +--ro operation-type? operation-type 1464 | | +--ro input? string 1465 | | +--ro output? string 1466 | +--:(i2nsf-system-res-util-log) 1467 | | +--ro i2nsf-system-res-util-log 1468 | | +--ro system-status? enumeration 1469 | | +--ro cpu-usage? uint8 1470 | | +--ro memory-usage? uint8 1471 | | +--ro disks* [disk-id] 1472 | | | +--ro disk-id string 1473 | | | +--ro disk-usage? uint8 1474 | | | +--ro disk-space-left? uint8 1475 | | +--ro session-num? uint32 1476 | | +--ro process-num? uint32 1477 | | +--ro interface* [interface-id] 1478 | | +--ro interface-id string 1479 | | +--ro in-traffic-rate? uint64 1480 | | +--ro out-traffic-rate? uint64 1481 | | +--ro in-traffic-throughput? uint64 1482 | | +--ro out-traffic-throughput? uint64 1483 | +--:(i2nsf-system-user-activity-log) 1484 | | +--ro i2nsf-system-user-activity-log 1485 | | +--ro user string 1486 | | +--ro group* string 1487 | | +--ro ip-address inet:ip-address-no-zone 1488 | | +--ro l4-port-number inet:port-number 1489 | | +--ro authentication? identityref 1490 | | +--ro online-duration? uint32 1491 | | +--ro logout-duration? uint32 1492 | | +--ro additional-info 1493 | | +--ro type? enumeration 1494 | | +--ro cause? string 1495 | +--:(i2nsf-nsf-log-dpi) {i2nsf-nsf-log-dpi}? 1496 | +--ro i2nsf-nsf-log-dpi 1497 | +--ro attack-type? identityref 1498 | +--ro src-ip? inet:ip-address-no-zone 1499 | +--ro src-port? inet:port-number 1500 | +--ro dst-ip? inet:ip-address-no-zone 1501 | +--ro dst-port? inet:port-number 1502 | +--ro rule-name 1503 -> /nsfintf:i2nsf-security-policy/rules/name 1504 | +--ro action* identityref 1505 +---n i2nsf-nsf-event 1506 +--ro vendor-name? string 1507 +--ro device-model? string 1508 +--ro software-version? string 1509 +--ro nsf-name union 1510 +--ro message? string 1511 +--ro language? string 1512 +--ro acquisition-method? identityref 1513 +--ro emission-type? identityref 1514 +--ro dampening-type? identityref 1515 +--ro (sub-event-type)? 1516 +--:(i2nsf-nsf-detection-ddos) {i2nsf-nsf-detection-ddos}? 1517 | +--ro i2nsf-nsf-detection-ddos 1518 | +--ro attack-type? identityref 1519 | +--ro start-time yang:date-and-time 1520 | +--ro end-time? yang:date-and-time 1521 | +--ro attack-src-ip* inet:ip-address-no-zone 1522 | +--ro attack-dst-ip* inet:ip-address-no-zone 1523 | +--ro attack-src-port* inet:port-number 1524 | +--ro attack-dst-port* inet:port-number 1525 | +--ro rule-name 1526 -> /nsfintf:i2nsf-security-policy/rules/name 1527 | +--ro attack-rate? uint64 1528 | +--ro attack-throughput? uint64 1529 +--:(i2nsf-nsf-detection-virus) 1530 {i2nsf-nsf-detection-virus}? 1531 | +--ro i2nsf-nsf-detection-virus 1532 | +--ro src-ip? inet:ip-address-no-zone 1533 | +--ro src-port? inet:port-number 1534 | +--ro dst-ip? inet:ip-address-no-zone 1535 | +--ro dst-port? inet:port-number 1536 | +--ro rule-name 1537 -> /nsfintf:i2nsf-security-policy/rules/name 1538 | +--ro virus-name? string 1539 | +--ro virus-type? identityref 1540 | +--ro host? union 1541 | +--ro file-type? string 1542 | +--ro file-name? string 1543 | +--ro os? string 1544 +--:(i2nsf-nsf-detection-intrusion) 1545 {i2nsf-nsf-detection-intrusion}? 1546 | +--ro i2nsf-nsf-detection-intrusion 1547 | +--ro src-ip? inet:ip-address-no-zone 1548 | +--ro src-port? inet:port-number 1549 | +--ro dst-ip? inet:ip-address-no-zone 1550 | +--ro dst-port? inet:port-number 1551 | +--ro rule-name 1552 -> /nsfintf:i2nsf-security-policy/rules/name 1553 | +--ro protocol? identityref 1554 | +--ro app? identityref 1555 | +--ro attack-type? identityref 1556 +--:(i2nsf-nsf-detection-web-attack) 1557 {i2nsf-nsf-detection-web-attack}? 1558 | +--ro i2nsf-nsf-detection-web-attack 1559 | +--ro src-ip? inet:ip-address-no-zone 1560 | +--ro src-port? inet:port-number 1561 | +--ro dst-ip? inet:ip-address-no-zone 1562 | +--ro dst-port? inet:port-number 1563 | +--ro rule-name 1564 -> /nsfintf:i2nsf-security-policy/rules/name 1565 | +--ro attack-type? identityref 1566 | +--ro req-method? identityref 1567 | +--ro req-target? string 1568 | +--ro filtering-type* identityref 1569 | +--ro cookies? string 1570 | +--ro req-host? string 1571 | +--ro response-code? string 1572 +--:(i2nsf-nsf-detection-voip-vocn) 1573 {i2nsf-nsf-detection-voip-vocn}? 1574 +--ro i2nsf-nsf-detection-voip-vocn 1575 +--ro src-ip? inet:ip-address-no-zone 1576 +--ro src-port? inet:port-number 1577 +--ro dst-ip? inet:ip-address-no-zone 1578 +--ro dst-port? inet:port-number 1579 +--ro rule-name 1580 -> /nsfintf:i2nsf-security-policy/rules/name 1581 +--ro source-voice-id* string 1582 +--ro destination-voice-id* string 1583 +--ro user-agent* string 1585 Figure 1: NSF Monitoring YANG Module Tree 1587 8. YANG Data Model of NSF Monitoring YANG Module 1589 This section describes a YANG module of I2NSF NSF Monitoring. The 1590 data model provided in this document uses identities to be used to 1591 get information of the monitored of an NSF's monitoring data. Every 1592 identity used in the document gives information or status about the 1593 current situation of an NSF. This YANG module imports from 1594 [RFC6991], [RFC8343], and [I-D.ietf-i2nsf-nsf-facing-interface-dm], 1595 and makes references to [RFC0768] [RFC0791] [RFC0792] [RFC0826] 1596 [RFC0854] [RFC1939] [RFC0959] [RFC2595] [RFC4340] [RFC4443] [RFC4861] 1597 [RFC5321] [RFC5646] [RFC6242] [RFC6265] [RFC8200] [RFC8641] [RFC9051] 1598 [I-D.ietf-httpbis-http2bis] [I-D.ietf-httpbis-messaging] 1599 [I-D.ietf-httpbis-semantics] [I-D.ietf-tcpm-rfc793bis] 1600 [I-D.ietf-tsvwg-rfc4960-bis] [IANA-HTTP-Status-Code] [IEEE-802.1AB] 1602 file "ietf-i2nsf-nsf-monitoring@2022-04-13.yang" 1603 module ietf-i2nsf-nsf-monitoring { 1604 yang-version 1.1; 1605 namespace 1606 "urn:ietf:params:xml:ns:yang:ietf-i2nsf-nsf-monitoring"; 1607 prefix 1608 nsfmi; 1609 import ietf-inet-types { 1610 prefix inet; 1611 reference 1612 "Section 4 of RFC 6991"; 1613 } 1614 import ietf-yang-types { 1615 prefix yang; 1616 reference 1617 "Section 3 of RFC 6991"; 1618 } 1619 import ietf-i2nsf-policy-rule-for-nsf { 1620 prefix nsfintf; 1621 reference 1622 "Section 4.1 of draft-ietf-i2nsf-nsf-facing-interface-dm-17"; 1623 } 1624 import ietf-interfaces { 1625 prefix if; 1626 reference 1627 "Section 5 of RFC 8343"; 1628 } 1629 organization 1630 "IETF I2NSF (Interface to Network Security Functions) 1631 Working Group"; 1632 contact 1633 "WG Web: 1634 WG List: 1636 Editor: Jaehoon Paul Jeong 1637 1639 Editor: Patrick Lingga 1640 "; 1642 description 1643 "This module is a YANG module for I2NSF NSF Monitoring. 1645 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 1646 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 1647 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this 1648 document are to be interpreted as described in BCP 14 1649 (RFC 2119) (RFC 8174) when, and only when, they appear 1650 in all capitals, as shown here. 1652 Copyright (c) 2022 IETF Trust and the persons identified as 1653 authors of the code. All rights reserved. 1655 Redistribution and use in source and binary forms, with or 1656 without modification, is permitted pursuant to, and subject 1657 to the license terms contained in, the Revised BSD License 1658 set forth in Section 4.c of the IETF Trust's 1659 Legal Provisions Relating to IETF Documents 1660 (https://trustee.ietf.org/license-info). 1662 This version of this YANG module is part of RFC XXXX 1663 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself 1664 for full legal notices."; 1666 revision "2022-04-13" { 1667 description "Latest revision"; 1668 reference 1669 "RFC XXXX: I2NSF NSF Monitoring Interface YANG Data Model"; 1671 // RFC Ed.: replace XXXX with an actual RFC number and remove 1672 // this note. 1674 } 1676 /* 1677 * Typedefs 1678 */ 1680 typedef severity { 1681 type enumeration { 1682 enum critical { 1683 description 1684 "The 'critical' severity level indicates that 1685 an immediate corrective action is required. 1686 A 'critical' severity is reported when a service 1687 becomes totally out of service and must be restored."; 1688 } 1689 enum high { 1690 description 1691 "The 'high' severity level indicates that 1692 an urgent corrective action is required. 1693 A 'high' severity is reported when there is 1694 a severe degradation in the capability of the 1695 service and its full capability must be restored."; 1696 } 1697 enum middle { 1698 description 1699 "The 'middle' severity level indicates the 1700 existence of a non-service-affecting fault 1701 condition and corrective action should be done 1702 to prevent a more serious fault. The 'middle' 1703 severity is reported when the detected problem 1704 is not degrading the capability of the service, but 1705 some service degradation might happen if not 1706 prevented."; 1707 } 1708 enum low { 1709 description 1710 "The 'low' severity level indicates the detection 1711 of a potential fault before any effect is observed. 1712 The 'low' severity is reported when an action should 1713 be done before a fault happen."; 1714 } 1715 } 1716 description 1717 "An indicator representing severity levels. The severity 1718 levels starting from the highest are critical, high, middle, 1719 and low."; 1720 } 1721 typedef operation-type { 1722 type enumeration { 1723 enum login { 1724 description 1725 "The operation type is Login."; 1726 } 1727 enum logout { 1728 description 1729 "The operation type is Logout."; 1730 } 1731 enum configuration { 1732 description 1733 "The operation type is Configuration. The configuration 1734 operation includes the command for writing a new 1735 configuration and modifying an existing configuration."; 1736 } 1737 enum other { 1738 description 1739 "The operation type is Other operation. This other 1740 includes all operations done by a user except login, 1741 logout, and configuration."; 1742 } 1743 } 1744 description 1745 "The type of operation done by a user during a session. 1746 The user operation is not considering their privileges."; 1747 } 1749 typedef login-role { 1750 type enumeration { 1751 enum administrator { 1752 description 1753 "Administrator (i.e., Superuser)'s login role. 1754 Non-restricted role."; 1755 } 1756 enum user { 1757 description 1758 "User login role. Semi-restricted role, some data and 1759 configurations are available but confidential or important 1760 data and configuration are restricted."; 1761 } 1762 enum guest { 1763 description 1764 "Guest login role. Restricted role, only few read data are 1765 available and write configurations are restricted."; 1766 } 1767 } 1768 description 1769 "The privilege level of the user account."; 1770 } 1772 typedef centiseconds { 1773 type uint32; 1774 description 1775 "A period of time, measured in units of 0.01 seconds."; 1776 } 1778 /* 1779 * Identity 1780 */ 1782 identity characteristics { 1783 description 1784 "Base identity for monitoring information 1785 characteristics"; 1786 } 1787 identity acquisition-method { 1788 base characteristics; 1789 description 1790 "The type of acquisition-method. It can be multiple 1791 types at once."; 1792 } 1793 identity subscription { 1794 base acquisition-method; 1795 description 1796 "The acquisition-method type is subscription."; 1797 } 1798 identity query { 1799 base acquisition-method; 1800 description 1801 "The acquisition-method type is query."; 1802 } 1803 identity emission-type { 1804 base characteristics; 1805 description 1806 "The type of emission-type."; 1807 } 1808 identity periodic { 1809 base emission-type; 1810 description 1811 "The emission-type type is periodic."; 1812 } 1813 identity on-change { 1814 base emission-type; 1815 description 1816 "The emission-type type is on-change."; 1818 } 1819 identity dampening-type { 1820 base characteristics; 1821 description 1822 "The type of message dampening to stop the rapid transmission 1823 of messages, such as on-repetition and no-dampening."; 1824 } 1825 identity no-dampening { 1826 base dampening-type; 1827 description 1828 "The dampening-type is no-dampening. No-dampening type does 1829 not limit the transmission for the messages of the same 1830 type."; 1831 } 1832 identity on-repetition { 1833 base dampening-type; 1834 description 1835 "The dampening-type is on-repetition. On-repetition type limits 1836 the transmitted on-change message to one message at a certain 1837 interval."; 1838 } 1840 identity authentication-mode { 1841 description 1842 "The authentication mode for a user to connect to the NSF, 1843 e.g., pre-configured-key and certificate-authority"; 1844 } 1845 identity pre-configured-key { 1846 base authentication-mode; 1847 description 1848 "The pre-configured-key is an authentication using a key 1849 authentication."; 1850 } 1851 identity certificate-authority { 1852 base authentication-mode; 1853 description 1854 "The certificate-authority (CA) is an authentication using a 1855 digital certificate."; 1856 } 1858 identity event { 1859 description 1860 "Base identity for I2NSF events."; 1861 } 1863 identity system-event { 1864 base event; 1865 description 1866 "Identity for system event"; 1867 } 1869 identity system-alarm { 1870 base event; 1871 description 1872 "Base identity for detectable system alarm types"; 1873 } 1875 identity memory-alarm { 1876 base system-alarm; 1877 description 1878 "Memory is the hardware to store information temporarily or for 1879 a short period, i.e., Random Access Memory (RAM). A 1880 memory-alarm is emitted when the memory usage is exceeding 1881 the threshold."; 1882 } 1883 identity cpu-alarm { 1884 base system-alarm; 1885 description 1886 "CPU is the Central Processing Unit that executes basic 1887 operations of the system. A cpu-alarm is emitted when the CPU 1888 usage is exceeding a threshold."; 1889 } 1890 identity disk-alarm { 1891 base system-alarm; 1892 description 1893 "Disk or storage is the hardware to store information for a 1894 long period, i.e., Hard Disk and Solid-State Drive. A 1895 disk-alarm is emitted when the disk usage is exceeding a 1896 threshold."; 1897 } 1898 identity hardware-alarm { 1899 base system-alarm; 1900 description 1901 "A hardware alarm is emitted when a hardware failure (e.g., 1902 CPU, memory, disk, or interface) is detected. A hardware 1903 failure is a malfunction within the electronic circuits or 1904 electromechanical components of the hardware that makes it 1905 unusable."; 1906 } 1907 identity interface-alarm { 1908 base system-alarm; 1909 description 1910 "Interface is the network interface for connecting a device 1911 with the network. The interface-alarm is emitted when the 1912 state of the interface is changed."; 1913 } 1914 identity access-violation { 1915 base system-event; 1916 description 1917 "Access-violation system event is an event when a user tries 1918 to access (read, write, create, or delete) any information or 1919 execute commands above their privilege (i.e., not-conformant 1920 with the access profile)."; 1921 } 1922 identity configuration-change { 1923 base system-event; 1924 description 1925 "The configuration-change system event is an event when a user 1926 adds a new configuration or modify an existing configuration 1927 (write configuration)."; 1928 } 1930 identity attack-type { 1931 description 1932 "The root ID of attack-based notification 1933 in the notification taxonomy"; 1934 } 1935 identity nsf-attack-type { 1936 base attack-type; 1937 description 1938 "This ID is intended to be used 1939 in the context of NSF event."; 1940 } 1942 identity virus-type { 1943 base nsf-attack-type; 1944 description 1945 "The type of virus. It can be multiple types at once. 1946 This attack type is associated with a detected 1947 system-log virus-attack."; 1948 } 1949 identity trojan { 1950 base virus-type; 1951 description 1952 "The virus type is a trojan. Trojan is able to disguise the 1953 intent of the files or programs to misleads the users."; 1954 } 1955 identity worm { 1956 base virus-type; 1957 description 1958 "The virus type is a worm. Worm can self-replicate and 1959 spread through the network automatically."; 1960 } 1961 identity macro { 1962 base virus-type; 1963 description 1964 "The virus type is a macro virus. Macro causes a series of 1965 threats automatically after the program is executed."; 1966 } 1967 identity boot-sector { 1968 base virus-type; 1969 description 1970 "The virus type is a boot sector virus. Boot sector is a virus 1971 that infects the core of the computer, affecting the startup 1972 process."; 1973 } 1974 identity polymorphic { 1975 base virus-type; 1976 description 1977 "The virus type is a polymorphic virus. Polymorphic can 1978 modify its version when it replicates, making it hard to 1979 detect."; 1980 } 1981 identity overwrite { 1982 base virus-type; 1983 description 1984 "The virus type is an overwrite virus. Overwrite can remove 1985 existing software and replace it with malicious code by 1986 overwriting it."; 1987 } 1988 identity resident { 1989 base virus-type; 1990 description 1991 "The virus-type is a resident virus. Resident saves itself in 1992 the computer's memory and infects other files and software."; 1993 } 1994 identity non-resident { 1995 base virus-type; 1996 description 1997 "The virus-type is a non-resident virus. Non-resident attaches 1998 directly to an executable file and enters the device when 1999 executed."; 2000 } 2001 identity multipartite { 2002 base virus-type; 2003 description 2004 "The virus-type is a multipartite virus. Multipartite attacks 2005 both the boot sector and executables files of a computer."; 2006 } 2007 identity spacefiller { 2008 base virus-type; 2009 description 2010 "The virus-type is a spacefiller virus. Spacefiller fills empty 2011 spaces of a file or software with malicious code."; 2012 } 2014 identity intrusion-attack-type { 2015 base nsf-attack-type; 2016 description 2017 "The attack type is associated with a detected 2018 system-log intrusion."; 2019 } 2020 identity brute-force { 2021 base intrusion-attack-type; 2022 description 2023 "The intrusion type is brute-force."; 2024 } 2025 identity buffer-overflow { 2026 base intrusion-attack-type; 2027 description 2028 "The intrusion type is buffer-overflow."; 2029 } 2030 identity web-attack-type { 2031 base nsf-attack-type; 2032 description 2033 "The attack type is associated with a detected 2034 system-log web-attack."; 2035 } 2036 identity command-injection { 2037 base web-attack-type; 2038 description 2039 "The detected web attack type is command injection."; 2040 } 2041 identity xss { 2042 base web-attack-type; 2043 description 2044 "The detected web attack type is Cross Site Scripting (XSS)."; 2045 } 2046 identity csrf { 2047 base web-attack-type; 2048 description 2049 "The detected web attack type is Cross Site Request Forgery."; 2050 } 2052 identity ddos-type { 2053 base nsf-attack-type; 2054 description 2055 "Base identity for detectable flood types"; 2056 } 2057 identity syn-flood { 2058 base ddos-type; 2059 description 2060 "A SYN flood is detected."; 2061 } 2062 identity ack-flood { 2063 base ddos-type; 2064 description 2065 "An ACK flood is detected."; 2066 } 2067 identity syn-ack-flood { 2068 base ddos-type; 2069 description 2070 "A SYN-ACK flood is detected."; 2071 } 2072 identity fin-rst-flood { 2073 base ddos-type; 2074 description 2075 "A FIN-RST flood is detected."; 2076 } 2077 identity tcp-con-flood { 2078 base ddos-type; 2079 description 2080 "A TCP connection flood is detected."; 2081 } 2082 identity udp-flood { 2083 base ddos-type; 2084 description 2085 "A UDP flood is detected."; 2086 } 2087 identity icmpv4-flood { 2088 base ddos-type; 2089 description 2090 "An ICMPv4 flood is detected."; 2091 } 2092 identity icmpv6-flood { 2093 base ddos-type; 2094 description 2095 "An ICMPv6 flood is detected."; 2096 } 2097 identity http-flood { 2098 base ddos-type; 2099 description 2100 "An HTTP flood is detected."; 2101 } 2102 identity https-flood { 2103 base ddos-type; 2104 description 2105 "An HTTPS flood is detected."; 2107 } 2108 identity dns-query-flood { 2109 base ddos-type; 2110 description 2111 "A Domain Name System (DNS) query flood is detected."; 2112 } 2113 identity dns-reply-flood { 2114 base ddos-type; 2115 description 2116 "A Domain Name System (DNS) reply flood is detected."; 2117 } 2118 identity sip-flood { 2119 base ddos-type; 2120 description 2121 "A Session Initiation Protocol (SIP) flood is detected."; 2122 } 2123 identity tls-flood { 2124 base ddos-type; 2125 description 2126 "A Transport Layer Security (TLS) flood is detected"; 2127 } 2128 identity ntp-amp-flood { 2129 base ddos-type; 2130 description 2131 "A Network Time Protocol (NTP) amplification is detected"; 2132 } 2134 identity req-method { 2135 description 2136 "A set of request types in HTTP (if applicable)."; 2137 } 2138 identity put { 2139 base req-method; 2140 description 2141 "The detected request type is PUT."; 2142 reference 2143 "draft-ietf-httpbis-semantics-19: HTTP Semantics 2144 - Request Method PUT"; 2145 } 2146 identity post { 2147 base req-method; 2148 description 2149 "The detected request type is POST."; 2150 reference 2151 "draft-ietf-httpbis-semantics-19: HTTP Semantics 2152 - Request Method POST"; 2153 } 2154 identity get { 2155 base req-method; 2156 description 2157 "The detected request type is GET."; 2158 reference 2159 "draft-ietf-httpbis-semantics-19: HTTP Semantics 2160 - Request Method GET"; 2161 } 2162 identity head { 2163 base req-method; 2164 description 2165 "The detected request type is HEAD."; 2166 reference 2167 "draft-ietf-httpbis-semantics-19: HTTP Semantics 2168 - Request Method HEAD"; 2169 } 2170 identity delete { 2171 base req-method; 2172 description 2173 "The detected request type is DELETE."; 2174 reference 2175 "draft-ietf-httpbis-semantics-19: HTTP Semantics 2176 - Request Method DELETE"; 2177 } 2178 identity connect { 2179 base req-method; 2180 description 2181 "The detected request type is CONNECT."; 2182 reference 2183 "draft-ietf-httpbis-semantics-19: HTTP Semantics 2184 - Request Method CONNECT"; 2185 } 2186 identity options { 2187 base req-method; 2188 description 2189 "The detected request type is OPTIONS."; 2190 reference 2191 "draft-ietf-httpbis-semantics-19: HTTP Semantics 2192 - Request Method OPTIONS"; 2193 } 2194 identity trace { 2195 base req-method; 2196 description 2197 "The detected request type is TRACE."; 2198 reference 2199 "draft-ietf-httpbis-semantics-19: HTTP Semantics 2200 - Request Method TRACE"; 2201 } 2202 identity filter-type { 2203 description 2204 "The type of filter used to detect an attack, 2205 for example, a web-attack. It can be applicable to 2206 more than web-attacks."; 2207 } 2208 identity allow-list { 2209 base filter-type; 2210 description 2211 "The applied filter type is an allow list. This filter blocks 2212 all connection except the specified list."; 2213 } 2214 identity deny-list { 2215 base filter-type; 2216 description 2217 "The applied filter type is a deny list. This filter opens all 2218 connection except the specified list."; 2219 } 2220 identity unknown-filter { 2221 base filter-type; 2222 description 2223 "The applied filter is unknown."; 2224 } 2226 identity dpi-type { 2227 description 2228 "Base identity for the type of Deep Packet Inspection (DPI)."; 2229 } 2230 identity file-blocking { 2231 base dpi-type; 2232 description 2233 "DPI for preventing the specified file types from flowing 2234 in the network."; 2235 } 2236 identity data-filtering { 2237 base dpi-type; 2238 description 2239 "DPI for preventing sensitive information (e.g., Credit 2240 Card Number or Social Security Numbers) leaving a 2241 protected network."; 2242 } 2243 identity application-behavior-control { 2244 base dpi-type; 2245 description 2246 "DPI for filtering packet based on the application or 2247 network behavior analysis to identify malicious or 2248 unusual activity."; 2249 } 2250 identity protocol { 2251 description 2252 "An identity used to enable type choices in leaves 2253 and leaf-lists with respect to protocol metadata. This is used 2254 to identify the type of protocol that goes through the NSF."; 2255 } 2256 identity ip { 2257 base protocol; 2258 description 2259 "General IP protocol type."; 2260 reference 2261 "RFC 791: Internet Protocol 2262 RFC 8200: Internet Protocol, Version 6 (IPv6)"; 2263 } 2264 identity ipv4 { 2265 base ip; 2266 description 2267 "IPv4 protocol type."; 2268 reference 2269 "RFC 791: Internet Protocol"; 2270 } 2271 identity ipv6 { 2272 base ip; 2273 description 2274 "IPv6 protocol type."; 2275 reference 2276 "RFC 8200: Internet Protocol, Version 6 (IPv6)"; 2277 } 2278 identity icmp { 2279 base protocol; 2280 description 2281 "Base identity for ICMPv4 and ICMPv6 condition capability"; 2282 reference 2283 "RFC 792: Internet Control Message Protocol 2284 RFC 4443: Internet Control Message Protocol (ICMPv6) 2285 for the Internet Protocol Version 6 (IPv6) Specification 2286 - ICMPv6"; 2287 } 2288 identity icmpv4 { 2289 base icmp; 2290 description 2291 "ICMPv4 protocol type."; 2292 reference 2293 "RFC 791: Internet Protocol 2294 RFC 792: Internet Control Message Protocol"; 2295 } 2296 identity icmpv6 { 2297 base icmp; 2298 description 2299 "ICMPv6 protocol type."; 2300 reference 2301 "RFC 8200: Internet Protocol, Version 6 (IPv6) 2302 RFC 4443: Internet Control Message Protocol (ICMPv6) 2303 for the Internet Protocol Version 6 (IPv6) 2304 Specification"; 2305 } 2306 identity transport-protocol { 2307 base protocol; 2308 description 2309 "Base identity for Layer 4 protocol condition capabilities, 2310 e.g., TCP, UDP, SCTP, DCCP, and ICMP"; 2311 } 2312 identity tcp { 2313 base transport-protocol; 2314 description 2315 "TCP protocol type."; 2316 reference 2317 "draft-ietf-tcpm-rfc793bis-25: Transmission Control Protocol 2318 (TCP) Specification"; 2319 } 2320 identity udp { 2321 base transport-protocol; 2322 description 2323 "UDP protocol type."; 2324 reference 2325 "RFC 768: User Datagram Protocol"; 2326 } 2327 identity sctp { 2328 base transport-protocol; 2329 description 2330 "Identity for SCTP condition capabilities"; 2331 reference 2332 "draft-ietf-tsvwg-rfc4960-bis-18: Stream Control Transmission 2333 Protocol"; 2334 } 2335 identity dccp { 2336 base transport-protocol; 2337 description 2338 "Identity for DCCP condition capabilities"; 2339 reference 2340 "RFC 4340: Datagram Congestion Control Protocol"; 2341 } 2342 identity application-protocol { 2343 base protocol; 2344 description 2345 "Base identity for Application protocol. Note that a subset of 2346 application protocols (e.g., HTTP, HTTPS, FTP, POP3, and 2347 IMAP) are handled in this YANG module, rather than all 2348 the existing application protocols."; 2349 } 2350 identity http { 2351 base application-protocol; 2352 description 2353 "The identity for Hypertext Transfer Protocol version 1.1 2354 (HTTP/1.1)."; 2355 reference 2356 "draft-ietf-httpbis-semantics-19: HTTP Semantics 2357 draft-ietf-httpbis-messaging-19: HTTP/1.1"; 2358 } 2359 identity https { 2360 base application-protocol; 2361 description 2362 "The identity for Hypertext Transfer Protocol version 1.1 2363 (HTTP/1.1) over TLS."; 2364 reference 2365 "draft-ietf-httpbis-semantics-19: HTTP Semantics 2366 draft-ietf-httpbis-messaging-19: HTTP/1.1"; 2367 } 2368 identity http2 { 2369 base application-protocol; 2370 description 2371 "The identity for Hypertext Transfer Protocol version 2 2372 (HTTP/2)."; 2373 reference 2374 "draft-ietf-httpbis-http2bis-07: HTTP/2"; 2375 } 2376 identity https2 { 2377 base application-protocol; 2378 description 2379 "The identity for Hypertext Transfer Protocol version 2 2380 (HTTP/2) over TLS."; 2381 reference 2382 "draft-ietf-httpbis-http2bis-07: HTTP/2"; 2383 } 2384 identity ftp { 2385 base application-protocol; 2386 description 2387 "FTP protocol type."; 2388 reference 2389 "RFC 959: File Transfer Protocol"; 2390 } 2391 identity ssh { 2392 base application-protocol; 2393 description 2394 "SSH protocol type."; 2395 reference 2396 "RFC 6242: Using the NETCONF Protocol over Secure Shell (SSH)"; 2397 } 2398 identity telnet { 2399 base application-protocol; 2400 description 2401 "The identity for telnet."; 2402 reference 2403 "RFC 854: Telnet Protocol"; 2404 } 2405 identity smtp { 2406 base application-protocol; 2407 description 2408 "The identity for smtp."; 2409 reference 2410 "RFC 5321: Simple Mail Transfer Protocol (SMTP)"; 2411 } 2412 identity pop3 { 2413 base application-protocol; 2414 description 2415 "The identity for Post Office Protocol 3 (POP3)."; 2416 reference 2417 "RFC 1939: Post Office Protocol - Version 3 (POP3)"; 2418 } 2419 identity pop3s { 2420 base application-protocol; 2421 description 2422 "The identity for Post Office Protocol 3 (POP3) over TLS"; 2423 reference 2424 "RFC 1939: Post Office Protocol - Version 3 (POP3) 2425 RFC 2595: Using TLS with IMAP, POP3 and ACAP"; 2426 } 2427 identity imap { 2428 base application-protocol; 2429 description 2430 "The identity for Internet Message Access Protocol (IMAP)."; 2431 reference 2432 "RFC 9051: Internet Message Access Protocol (IMAP) - Version 2433 4rev2"; 2434 } 2435 identity imaps { 2436 base application-protocol; 2437 description 2438 "The identity for Internet Message Access Protocol (IMAP) over 2439 TLS"; 2440 reference 2441 "RFC 9051: Internet Message Access Protocol (IMAP) - Version 2442 4rev2 2443 RFC 2595: Using TLS with IMAP, POP3 and ACAP"; 2444 } 2446 /* 2447 * Grouping 2448 */ 2450 grouping timestamp { 2451 description 2452 "Grouping for identifying the time of the message."; 2453 leaf timestamp { 2454 type yang:date-and-time; 2455 description 2456 "Specify the time of a message being delivered."; 2457 } 2458 } 2460 grouping message { 2461 description 2462 "A set of common monitoring data that is needed 2463 as the basic information."; 2464 leaf message { 2465 type string; 2466 description 2467 "This is a freetext annotation for 2468 monitoring a notification's content."; 2469 } 2470 leaf language { 2471 type string { 2472 pattern '(([A-Za-z]{2,3}(-[A-Za-z]{3}(-[A-Za-z]{3})' 2473 + '{0,2})?|[A-Za-z]{4}|[A-Za-z]{5,8})(-[A-Za-z]{4})?' 2474 + '(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}' 2475 + '|([0-9][A-Za-z0-9]{3})))*(-[0-9A-WY-Za-wy-z]' 2476 + '(-([A-Za-z0-9]{2,8}))+)*(-[Xx](-([A-Za-z0-9]' 2477 + '{1,8}))+)?|[Xx](-([A-Za-z0-9]{1,8}))+|' 2478 + '(([Ee][Nn]-[Gg][Bb]-[Oo][Ee][Dd]|[Ii]-' 2479 + '[Aa][Mm][Ii]|[Ii]-[Bb][Nn][Nn]|[Ii]-' 2480 + '[Dd][Ee][Ff][Aa][Uu][Ll][Tt]|[Ii]-' 2481 + '[Ee][Nn][Oo][Cc][Hh][Ii][Aa][Nn]' 2482 + '|[Ii]-[Hh][Aa][Kk]|' 2483 + '[Ii]-[Kk][Ll][Ii][Nn][Gg][Oo][Nn]|' 2484 + '[Ii]-[Ll][Uu][Xx]|[Ii]-[Mm][Ii][Nn][Gg][Oo]|' 2485 + '[Ii]-[Nn][Aa][Vv][Aa][Jj][Oo]|[Ii]-[Pp][Ww][Nn]|' 2486 + '[Ii]-[Tt][Aa][Oo]|[Ii]-[Tt][Aa][Yy]|' 2487 + '[Ii]-[Tt][Ss][Uu]|[Ss][Gg][Nn]-[Bb][Ee]-[Ff][Rr]|' 2488 + '[Ss][Gg][Nn]-[Bb][Ee]-[Nn][Ll]|[Ss][Gg][Nn]-' 2489 + '[Cc][Hh]-[Dd][Ee])|([Aa][Rr][Tt]-' 2490 + '[Ll][Oo][Jj][Bb][Aa][Nn]|[Cc][Ee][Ll]-' 2491 + '[Gg][Aa][Uu][Ll][Ii][Ss][Hh]|' 2492 + '[Nn][Oo]-[Bb][Oo][Kk]|[Nn][Oo]-' 2493 + '[Nn][Yy][Nn]|[Zz][Hh]-[Gg][Uu][Oo][Yy][Uu]|' 2494 + '[Zz][Hh]-[Hh][Aa][Kk][Kk][Aa]|[Zz][Hh]-' 2495 + '[Mm][Ii][Nn]|[Zz][Hh]-[Mm][Ii][Nn]-' 2496 + '[Nn][Aa][Nn]|[Zz][Hh]-[Xx][Ii][Aa][Nn][Gg])))'; 2497 } 2498 default "en-US"; 2499 description 2500 "The value in this field indicates the language tag 2501 used for the human readable fields (i.e., '../message', 2502 '/i2nsf-log/i2nsf-nsf-system-access-log/output', and 2503 '/i2nsf-log/i2nsf-system-user-activity-log/additional-info 2504 /cause'). 2505 The attribute is encoded following the rules in Section 2.1 2506 in RFC 5646. The default language tag is 'en-US'"; 2507 reference 2508 "RFC 5646: Tags for Identifying Languages"; 2509 } 2510 } 2512 grouping common-monitoring-data { 2513 description 2514 "A set of common monitoring data that is needed 2515 as the basic information."; 2517 leaf vendor-name { 2518 type string; 2519 description 2520 "The name of the NSF vendor. The string is unrestricted to 2521 identify the provider or vendor of the NSF."; 2522 } 2523 leaf device-model { 2524 type string; 2525 description 2526 "The model of the device, can be represented by the 2527 device model name or serial number. This field is used to 2528 identify the model of the device that provides the security 2529 service."; 2530 } 2531 leaf software-version { 2532 type string; 2533 description 2534 "The version of the software used to provide the security 2535 service"; 2536 } 2537 leaf nsf-name { 2538 type union { 2539 type string; 2540 type inet:ip-address-no-zone; 2541 } 2542 mandatory true; 2543 description 2544 "The name or IP address of the NSF generating the message. 2545 If the given nsf-name is not an IP address, the name can be 2546 an arbitrary string including a FQDN (Fully Qualified Domain 2547 Name). The name MUST be unique in the scope of management 2548 domain for a different NSF to identify the NSF that 2549 generates the message."; 2550 } 2551 } 2552 grouping characteristics { 2553 description 2554 "A set of characteristics of a monitoring information."; 2555 leaf acquisition-method { 2556 type identityref { 2557 base acquisition-method; 2558 } 2559 description 2560 "The acquisition-method for characteristics"; 2561 } 2562 leaf emission-type { 2563 when "derived-from-or-self(../acquisition-method, " 2564 + "'nsfmi:subscription')"; 2565 type identityref { 2566 base emission-type; 2567 } 2568 description 2569 "The emission-type for characteristics. This attribute is 2570 used only when the acquisition-method is a 'subscription'"; 2571 } 2572 } 2573 grouping characteristics-extended { 2574 description 2575 "An extended characteristics for the monitoring information."; 2576 uses characteristics; 2577 leaf dampening-type { 2578 type identityref { 2579 base dampening-type; 2580 } 2581 description 2582 "The dampening-type for characteristics"; 2583 } 2584 } 2585 grouping i2nsf-system-alarm-type-content { 2586 description 2587 "A set of contents for alarm type notification."; 2588 leaf usage { 2589 type uint8 { 2590 range "0..100"; 2591 } 2592 units "percent"; 2593 description 2594 "Specifies the used percentage"; 2595 } 2596 leaf threshold { 2597 type uint8 { 2598 range "0..100"; 2599 } 2600 units "percent"; 2601 description 2602 "The threshold percentage triggering the alarm or 2603 the event"; 2604 } 2605 } 2606 grouping i2nsf-system-event-type-content { 2607 description 2608 "System event metadata associated with system events 2609 caused by user activity. This can be extended to provide 2610 additional information."; 2611 leaf user { 2612 type string; 2613 mandatory true; 2614 description 2615 "The name of a user"; 2616 } 2617 leaf-list group { 2618 type string; 2619 min-elements 1; 2620 description 2621 "The group(s) to which a user belongs."; 2622 } 2623 leaf ip-address { 2624 type inet:ip-address-no-zone; 2625 mandatory true; 2626 description 2627 "The IPv4 or IPv6 address of a user that trigger the 2628 event."; 2629 } 2630 leaf l4-port-number { 2631 type inet:port-number; 2632 mandatory true; 2633 description 2634 "The transport layer port number used by the user."; 2635 } 2636 leaf authentication { 2637 type identityref { 2638 base authentication-mode; 2639 } 2640 description 2641 "The authentication-mode of a user."; 2642 } 2643 } 2644 grouping i2nsf-nsf-event-type-content { 2645 description 2646 "A set of common IPv4 or IPv6-related NSF event 2647 content elements"; 2648 leaf dst-ip { 2649 type inet:ip-address-no-zone; 2650 description 2651 "The destination IPv4 or IPv6 address of the packet"; 2652 } 2653 leaf dst-port { 2654 type inet:port-number; 2655 description 2656 "The destination port of the packet"; 2657 } 2658 leaf rule-name { 2659 type leafref { 2660 path 2661 "/nsfintf:i2nsf-security-policy" 2662 +"/nsfintf:rules/nsfintf:name"; 2663 } 2664 mandatory true; 2665 description 2666 "The name of the I2NSF Policy Rule being triggered"; 2667 } 2668 } 2669 grouping i2nsf-nsf-event-type-content-extend { 2670 description 2671 "A set of extended common IPv4 or IPv6 related NSF 2672 event content elements"; 2673 leaf src-ip { 2674 type inet:ip-address-no-zone; 2675 description 2676 "The source IPv4 or IPv6 address of the packet or flow"; 2677 } 2678 leaf src-port { 2679 type inet:port-number; 2680 description 2681 "The source port of the packet or flow"; 2683 } 2684 uses i2nsf-nsf-event-type-content; 2685 } 2686 grouping action { 2687 description 2688 "A grouping for action."; 2689 leaf-list action { 2690 type identityref { 2691 base nsfintf:ingress-action; 2692 } 2693 description 2694 "Action type: pass, drop, reject, mirror, or rate limit"; 2695 } 2696 } 2697 grouping attack-rates { 2698 description 2699 "A set of traffic rates for monitoring attack traffic 2700 data"; 2701 leaf attack-rate { 2702 type uint64; 2703 units "pps"; 2704 description 2705 "The average packets per second (pps) rate of attack 2706 traffic"; 2707 } 2708 leaf attack-throughput { 2709 type uint64; 2710 units "Bps"; 2711 description 2712 "The average bytes per second (Bps) throughput of attack 2713 traffic"; 2714 } 2715 } 2716 grouping traffic-rates { 2717 description 2718 "A set of traffic rates for statistics data"; 2719 leaf discontinuity-time { 2720 type yang:date-and-time; 2721 mandatory true; 2722 description 2723 "The time on the most recent occasion at which any one or 2724 more of the counters suffered a discontinuity. 2725 If no such discontinuities have occurred since the last 2726 re-initialization of the local management subsystem, then 2727 this node contains the time the local management subsystem 2728 was re-initialized."; 2729 } 2730 leaf measurement-time { 2731 type uint32; 2732 units "seconds"; 2733 description 2734 "The time of the measurement in seconds for the 2735 calculation of statistics such as traffic rate and 2736 throughput. The statistic attributes are measured over 2737 the past measurement duration before now."; 2738 } 2739 leaf total-traffic { 2740 type yang:counter64; 2741 units "packets"; 2742 description 2743 "The total number of traffic packets (in and out) in the 2744 NSF."; 2745 } 2746 leaf in-traffic-average-rate { 2747 type uint64; 2748 units "pps"; 2749 description 2750 "Inbound traffic average rate in packets per second (pps). 2751 The average is calculated from the start of the NSF service 2752 until the generation of this record."; 2753 } 2754 leaf in-traffic-peak-rate { 2755 type uint64; 2756 units "pps"; 2757 description 2758 "Inbound traffic peak rate in packets per second (pps)."; 2759 } 2760 leaf in-traffic-average-throughput { 2761 type uint64; 2762 units "Bps"; 2763 description 2764 "Inbound traffic average throughput in bytes per second 2765 (Bps). The average is calculated from the start of the NSF 2766 service until the generation of this record."; 2767 } 2768 leaf in-traffic-peak-throughput { 2769 type uint64; 2770 units "Bps"; 2771 description 2772 "Inbound traffic peak throughput in bytes per second (Bps)."; 2773 } 2774 leaf out-traffic-average-rate { 2775 type uint64; 2776 units "pps"; 2777 description 2778 "Outbound traffic average rate in packets per second (pps). 2780 The average is calculated from the start of the NSF service 2781 until the generation of this record."; 2782 } 2783 leaf out-traffic-peak-rate { 2784 type uint64; 2785 units "pps"; 2786 description 2787 "Outbound traffic peak rate in packets per second (pps)."; 2788 } 2789 leaf out-traffic-average-throughput { 2790 type uint64; 2791 units "Bps"; 2792 description 2793 "Outbound traffic average throughput in bytes per second 2794 (Bps). The average is calculated from the start of the NSF 2795 service until the generation of this record."; 2796 } 2797 leaf out-traffic-peak-throughput { 2798 type uint64; 2799 units "Bps"; 2800 description 2801 "Outbound traffic peak throughput in bytes per second 2802 (Bps)."; 2803 } 2804 } 2805 grouping i2nsf-system-counter-type-content { 2806 description 2807 "A set of counters for an interface traffic data."; 2808 leaf interface-name { 2809 type if:interface-ref; 2810 description 2811 "Network interface name configured in an NSF"; 2812 reference 2813 "RFC 8343: A YANG Data Model for Interface Management"; 2814 } 2815 leaf protocol { 2816 type identityref { 2817 base protocol; 2818 } 2819 description 2820 "The type of network protocol for the interface counter. 2821 If this field is empty, then the counter includes all 2822 protocols (e.g., IPv4, IPv6, TCP, and UDP)"; 2823 } 2824 leaf in-total-traffic-pkts { 2825 type yang:counter64; 2826 description 2827 "Total inbound packets"; 2829 } 2830 leaf out-total-traffic-pkts { 2831 type yang:counter64; 2832 description 2833 "Total outbound packets"; 2834 } 2835 leaf in-total-traffic-bytes { 2836 type uint64; 2837 units "bytes"; 2838 description 2839 "Total inbound bytes"; 2840 } 2841 leaf out-total-traffic-bytes { 2842 type uint64; 2843 units "bytes"; 2844 description 2845 "Total outbound bytes"; 2846 } 2847 leaf in-drop-traffic-pkts { 2848 type yang:counter64; 2849 description 2850 "Total inbound drop packets"; 2851 } 2852 leaf out-drop-traffic-pkts { 2853 type yang:counter64; 2854 description 2855 "Total outbound drop packets"; 2856 } 2857 leaf in-drop-traffic-bytes { 2858 type uint64; 2859 units "bytes"; 2860 description 2861 "Total inbound drop bytes"; 2862 } 2863 leaf out-drop-traffic-bytes { 2864 type uint64; 2865 units "bytes"; 2866 description 2867 "Total outbound drop bytes"; 2868 } 2869 uses traffic-rates; 2870 } 2872 grouping i2nsf-nsf-counters-type-content { 2873 description 2874 "A set of contents of a policy in an NSF."; 2875 leaf policy-name { 2876 type leafref { 2877 path 2878 "/nsfintf:i2nsf-security-policy" 2879 +"/nsfintf:name"; 2880 } 2881 mandatory true; 2882 description 2883 "The name of the policy being triggered"; 2884 } 2885 } 2887 grouping enable-notification { 2888 description 2889 "A grouping for enabling or disabling notification"; 2890 leaf enabled { 2891 type boolean; 2892 default "true"; 2893 description 2894 "Enables or Disables the notification. 2895 If 'true', then the notification is enabled. 2896 If 'false, then the notification is disabled."; 2897 } 2898 } 2900 grouping dampening { 2901 description 2902 "A grouping for dampening period of notification."; 2903 leaf dampening-period { 2904 type centiseconds; 2905 default "0"; 2906 description 2907 "Specifies the minimum interval between the assembly of 2908 successive update records for a single receiver of a 2909 subscription. Whenever subscribed objects change and 2910 a dampening-period interval (which may be zero) has 2911 elapsed since the previous update record creation for 2912 a receiver, any subscribed objects and properties 2913 that have changed since the previous update record 2914 will have their current values marshalled and placed 2915 in a new update record. But if the subscribed objects change 2916 when the dampening-period is active, it should update the 2917 record without sending the notification until the dampening- 2918 period is finished. If multiple changes happen during the 2919 active dampening-period, it should update the record with 2920 the latest data. And at the end of the dampening-period, it 2921 should send the record as a notification with the latest 2922 updated record and restart the countdown."; 2923 reference 2924 "RFC 8641: Subscription to YANG Notifications for 2925 Datastore Updates - Section 5."; 2926 } 2927 } 2929 /* 2930 * Feature Nodes 2931 */ 2933 feature i2nsf-nsf-detection-ddos { 2934 description 2935 "This feature means it supports I2NSF nsf-detection-ddos 2936 notification"; 2937 } 2938 feature i2nsf-nsf-detection-virus { 2939 description 2940 "This feature means it supports I2NSF nsf-detection-virus 2941 notification"; 2942 } 2943 feature i2nsf-nsf-detection-intrusion { 2944 description 2945 "This feature means it supports I2NSF nsf-detection-intrusion 2946 notification"; 2947 } 2948 feature i2nsf-nsf-detection-web-attack { 2949 description 2950 "This feature means it supports I2NSF nsf-detection-web-attack 2951 notification"; 2952 } 2953 feature i2nsf-nsf-detection-voip-vocn { 2954 description 2955 "This feature means it supports I2NSF nsf-detection-voip-vocn 2956 notification"; 2957 } 2958 feature i2nsf-nsf-log-dpi { 2959 description 2960 "This feature means it supports I2NSF nsf-log-dpi 2961 notification"; 2962 } 2964 /* 2965 * Notification nodes 2966 */ 2968 notification i2nsf-event { 2969 description 2970 "Notification for I2NSF Event. This notification provides 2971 general information that can be supported by most types of 2972 NSFs."; 2974 uses common-monitoring-data; 2975 uses message; 2976 uses characteristics-extended; 2978 choice sub-event-type { 2979 description 2980 "This choice must be augmented with cases for each allowed 2981 sub-event. Only 1 sub-event will be instantiated in each 2982 i2nsf-event message. Each case is expected to define one 2983 container with all the sub-event fields."; 2984 case i2nsf-system-detection-alarm { 2985 container i2nsf-system-detection-alarm { 2986 description 2987 "This notification is sent, when a system alarm 2988 is detected."; 2989 leaf alarm-category { 2990 type identityref { 2991 base system-alarm; 2992 } 2993 description 2994 "The alarm category for 2995 system-detection-alarm notification"; 2996 } 2997 leaf component-name { 2998 type string; 2999 description 3000 "The hardware component responsible for generating 3001 the message. Applicable for Hardware Failure 3002 Alarm."; 3003 } 3004 leaf interface-name { 3005 when "derived-from-or-self(../alarm-category, " 3006 + "'nsfmi:interface-alarm')"; 3007 type if:interface-ref; 3008 description 3009 "The interface name responsible for generating 3010 the message. Applicable for Network Interface 3011 Failure Alarm."; 3012 reference 3013 "RFC 8343: A YANG Data Model for Interface Management"; 3014 } 3015 leaf interface-state { 3016 when "derived-from-or-self(../alarm-category, " 3017 + "'nsfmi:interface-alarm')"; 3018 type enumeration { 3019 enum up { 3020 value 1; 3021 description 3022 "The interface state is up and not congested. 3023 The interface is ready to pass packets."; 3024 } 3025 enum down { 3026 value 2; 3027 description 3028 "The interface state is down, i.e., does not pass 3029 any packets."; 3030 } 3031 enum congested { 3032 value 3; 3033 description 3034 "The interface state is up but congested."; 3035 } 3036 enum testing { 3037 value 4; 3038 description 3039 "In some test mode. No operational packets can 3040 be passed."; 3041 } 3042 enum unknown { 3043 value 5; 3044 description 3045 "Status cannot be determined for some reason."; 3046 } 3047 enum dormant { 3048 value 6; 3049 description 3050 "Waiting for some external event."; 3051 } 3052 enum not-present { 3053 value 7; 3054 description 3055 "Some component (typically hardware) is missing."; 3056 } 3057 enum lower-layer-down { 3058 value 8; 3059 description 3060 "Down due to state of lower-layer interface(s)."; 3061 } 3062 } 3063 description 3064 "The state of the interface. Applicable for Network 3065 Interface Failure Alarm."; 3066 reference 3067 "RFC 8343: A YANG Data Model for Interface Management - 3068 Operational States"; 3069 } 3070 leaf severity { 3071 type severity; 3072 description 3073 "The severity of the alarm such as critical, high, 3074 middle, and low."; 3075 } 3076 uses i2nsf-system-alarm-type-content; 3077 } 3078 } 3080 case i2nsf-system-detection-event { 3081 container i2nsf-system-detection-event { 3082 description 3083 "This notification is sent when an event in the system is 3084 detected, such as access violation and configuration 3085 change"; 3086 leaf event-category { 3087 type identityref { 3088 base system-event; 3089 } 3090 description 3091 "The event category for system-detection-event"; 3092 } 3093 uses i2nsf-system-event-type-content; 3094 list changes { 3095 when "derived-from-or-self(../event-category, " 3096 + "'nsfmi:configuration-change')"; 3097 key policy-name; 3098 description 3099 "Describes the modification that was made to the 3100 configuration. This list is only applicable when the 3101 event is 'configuration-change'. 3102 The minimum information that must be provided is the 3103 name of the policy that has been altered (added, 3104 modified, or removed). 3105 This list can be extended with the detailed 3106 information about the specific changes made to the 3107 configuration based on the implementation."; 3108 leaf policy-name { 3109 type leafref { 3110 path 3111 "/nsfintf:i2nsf-security-policy" 3112 +"/nsfintf:name"; 3113 } 3114 description 3115 "The name of the policy configuration that has been 3116 added, modified, or removed."; 3117 } 3119 } 3120 } 3121 } 3123 case i2nsf-traffic-flows { 3124 container i2nsf-traffic-flows { 3125 description 3126 "This notification is sent to inform about the traffic 3127 flows."; 3128 leaf interface-name { 3129 type if:interface-ref; 3130 description 3131 "The mnemonic name of the network interface"; 3132 } 3133 leaf interface-type { 3134 type enumeration { 3135 enum ingress { 3136 description 3137 "The corresponding interface-name indicates an 3138 ingress interface."; 3139 } 3140 enum egress { 3141 description 3142 "The corresponding interface-name indicates an 3143 egress interface."; 3144 } 3145 } 3146 description 3147 "The type of a network interface such as an ingress or 3148 egress interface."; 3149 } 3150 leaf src-mac { 3151 type yang:mac-address; 3152 description 3153 "The source MAC address of the traffic flow. This 3154 information may or may not be included depending on 3155 the type of traffic flow. For example, the information 3156 will be useful and should be included if the traffic 3157 flows are traffic flows of Link Layer Discovery 3158 Protocol (LLDP), Address Resolution Protocol (ARP) for 3159 IPv4, and Neighbor Discovery Protocol (ND) for IPv6."; 3160 reference 3161 "IEEE-802.1AB: IEEE Standard for Local and metropolitan 3162 area networks - Station and Media Access Control 3163 Connectivity Discovery - Link Layer Discovery Protocol 3164 (LLDP) 3165 RFC 826: An Ethernet Address Resolution Protocol - 3166 Address Resolution Protocol (ARP) 3167 RFC 4861: Neighbor Discovery for IP version 6 (IPv6) - 3168 Neighbor Discovery Protocol (ND)"; 3169 } 3170 leaf dst-mac { 3171 type yang:mac-address; 3172 description 3173 "The destination MAC address of the traffic flow. This 3174 information may or may not be included depending on 3175 the type of traffic flow. For example, the information 3176 will be useful and should be included if the traffic 3177 flows are traffic flows of Link Layer Discovery 3178 Protocol (LLDP), Address Resolution Protocol (ARP) for 3179 IPv4, and Neighbor Discovery Protocol (ND) for IPv6."; 3180 reference 3181 "IEEE-802.1AB: IEEE Standard for Local and metropolitan 3182 area networks - Station and Media Access Control 3183 Connectivity Discovery - Link Layer Discovery Protocol 3184 (LLDP) 3185 RFC 826: An Ethernet Address Resolution Protocol - 3186 Address Resolution Protocol (ARP) 3187 RFC 4861: Neighbor Discovery for IP version 6 (IPv6) - 3188 Neighbor Discovery Protocol (ND)"; 3189 } 3190 leaf src-ip { 3191 type inet:ip-address-no-zone; 3192 description 3193 "The source IPv4 or IPv6 address of the traffic flow"; 3194 } 3195 leaf dst-ip { 3196 type inet:ip-address-no-zone; 3197 description 3198 "The destination IPv4 or IPv6 address of the traffic 3199 flow"; 3200 } 3201 leaf protocol { 3202 type identityref { 3203 base protocol; 3204 } 3205 description 3206 "The protocol type of a traffic flow"; 3207 } 3208 leaf src-port { 3209 type inet:port-number; 3210 description 3211 "The transport layer source port number of the flow"; 3212 } 3213 leaf dst-port { 3214 type inet:port-number; 3215 description 3216 "The transport layer destination port number of the 3217 flow"; 3218 } 3219 leaf measurement-time { 3220 type uint32; 3221 units "seconds"; 3222 description 3223 "The duration of the measurement in seconds for the 3224 arrival rate and arrival throughput of packets of a 3225 traffic flow. These two metrics (i.e., arrival rate 3226 and arrival throughput) are measured over the past 3227 measurement duration before now."; 3228 } 3229 leaf arrival-rate { 3230 type uint64; 3231 units "pps"; 3232 description 3233 "The arrival rate of packets of the traffic flow in 3234 packets per second measured over the past 3235 'measurement-time'."; 3236 } 3237 leaf arrival-throughput { 3238 type uint64; 3239 units "Bps"; 3240 description 3241 "The arrival rate of packets of the traffic flow in 3242 bytes per second measured over the past 3243 'measurement-time'."; 3244 } 3245 } 3246 } 3248 case i2nsf-nsf-detection-session-table { 3249 container i2nsf-nsf-detection-session-table { 3250 description 3251 "This notification is sent, when a session table 3252 event is detected."; 3253 leaf current-session { 3254 type uint32; 3255 description 3256 "The number of concurrent sessions"; 3257 } 3258 leaf maximum-session { 3259 type uint32; 3260 description 3261 "The maximum number of sessions that the session 3262 table can support"; 3264 } 3265 leaf threshold { 3266 type uint32; 3267 description 3268 "The threshold triggering the event"; 3269 } 3270 } 3271 } 3272 } 3273 } 3275 notification i2nsf-log { 3276 description 3277 "Notification for I2NSF log. The notification is generated 3278 from the logs of the NSF."; 3280 uses common-monitoring-data; 3281 uses message; 3282 uses characteristics-extended; 3284 choice sub-logs-type { 3285 description 3286 "This choice must be augmented with cases for each allowed 3287 sub-logs. Only 1 sub-event will be instantiated in each 3288 i2nsf-logs message. Each case is expected to define one 3289 container with all the sub-logs fields."; 3290 case i2nsf-nsf-system-access-log { 3291 container i2nsf-nsf-system-access-log { 3292 description 3293 "The notification is sent, if there is a new system 3294 log entry about a system access event."; 3295 uses i2nsf-system-event-type-content; 3296 leaf operation-type { 3297 type operation-type; 3298 description 3299 "The operation type that the user executes"; 3300 } 3301 leaf input { 3302 type string; 3303 description 3304 "The operation performed by a user after login. The 3305 operation is a command given by a user."; 3306 } 3307 leaf output { 3308 type string; 3309 description 3310 "The result in text format after executing the 3311 input."; 3313 } 3314 } 3315 } 3317 case i2nsf-system-res-util-log { 3318 container i2nsf-system-res-util-log { 3319 description 3320 "This notification is sent, if there is a new log 3321 entry representing resource utilization updates."; 3322 leaf system-status { 3323 type enumeration { 3324 enum running { 3325 description 3326 "The system is active and running the security 3327 service."; 3328 } 3329 enum waiting { 3330 description 3331 "The system is active but waiting for an event to 3332 provide the security service."; 3333 } 3334 enum inactive { 3335 description 3336 "The system is inactive and not running the 3337 security service."; 3338 } 3339 } 3340 description 3341 "The current system's running status"; 3342 } 3343 leaf cpu-usage { 3344 type uint8; 3345 units "percent"; 3346 description 3347 "Specifies the relative percentage of CPU utilization 3348 with respect to platform resources"; 3349 } 3350 leaf memory-usage { 3351 type uint8; 3352 units "percent"; 3353 description 3354 "Specifies the percentage of memory usage."; 3355 } 3356 list disks { 3357 key disk-id; 3358 description 3359 "Disk is the hardware to store information for a 3360 long period, i.e., Hard Disk or Solid-State Drive."; 3362 leaf disk-id { 3363 type string; 3364 description 3365 "The ID of the storage disk. It is a free form 3366 identifier to identify the storage disk."; 3367 } 3368 leaf disk-usage { 3369 type uint8; 3370 units "percent"; 3371 description 3372 "Specifies the percentage of disk usage"; 3373 } 3374 leaf disk-space-left { 3375 type uint8; 3376 units "percent"; 3377 description 3378 "Specifies the percentage of disk space left"; 3379 } 3380 } 3381 leaf session-num { 3382 type uint32; 3383 description 3384 "The total number of sessions"; 3385 } 3386 leaf process-num { 3387 type uint32; 3388 description 3389 "The total number of processes"; 3390 } 3391 list interface { 3392 key interface-id; 3393 description 3394 "The network interface for connecting a device 3395 with the network."; 3396 leaf interface-id { 3397 type string; 3398 description 3399 "The ID of the network interface. It is a free form 3400 identifier to identify the network interface."; 3401 } 3402 leaf in-traffic-rate { 3403 type uint64; 3404 units "pps"; 3405 description 3406 "The total inbound traffic rate in packets per 3407 second"; 3408 } 3409 leaf out-traffic-rate { 3410 type uint64; 3411 units "pps"; 3412 description 3413 "The total outbound traffic rate in packets per 3414 second"; 3415 } 3416 leaf in-traffic-throughput { 3417 type uint64; 3418 units "Bps"; 3419 description 3420 "The total inbound traffic throughput in bytes per 3421 second"; 3422 } 3423 leaf out-traffic-throughput { 3424 type uint64; 3425 units "Bps"; 3426 description 3427 "The total outbound traffic throughput in bytes per 3428 second"; 3429 } 3430 } 3431 } 3432 } 3434 case i2nsf-system-user-activity-log { 3435 container i2nsf-system-user-activity-log { 3436 description 3437 "This notification is sent, if there is a new user 3438 activity log entry."; 3439 uses i2nsf-system-event-type-content; 3440 leaf online-duration { 3441 type uint32; 3442 units "seconds"; 3443 description 3444 "The duration of a user's activeness (stays in login) 3445 during a session."; 3446 } 3447 leaf logout-duration { 3448 type uint32; 3449 units "seconds"; 3450 description 3451 "The duration of a user's inactiveness (not in login) 3452 from the last session."; 3453 } 3454 container additional-info { 3455 leaf type { 3456 type enumeration { 3457 enum successful-login { 3458 description 3459 "The user has succeeded in login."; 3460 } 3461 enum failed-login { 3462 description 3463 "The user has failed in login (e.g., wrong 3464 password)"; 3465 } 3466 enum logout { 3467 description 3468 "The user has succeeded in logout"; 3469 } 3470 enum successful-password-changed { 3471 description 3472 "The password has been changed successfully"; 3473 } 3474 enum failed-password-changed { 3475 description 3476 "The attempt to change password has failed"; 3477 } 3478 enum lock { 3479 description 3480 "The user has been locked. A locked user cannot 3481 login."; 3482 } 3483 enum unlock { 3484 description 3485 "The user has been unlocked."; 3486 } 3487 } 3488 description 3489 "User activities, e.g., Successful User Login, 3490 Failed Login attempts, User Logout, Successful User 3491 Password Change, Failed User Password Change, User 3492 Lockout, User Unlocking, and Unknown."; 3493 } 3494 leaf cause { 3495 type string; 3496 description 3497 "The cause of a failed user activity related to the 3498 type of user activity. For example, when the 'type' 3499 is failed-login, the value of this attribute can be 3500 'Failed login attempt due to wrong password 3501 entry'."; 3502 } 3503 description 3504 "The additional information about user activity."; 3505 } 3507 } 3508 } 3509 case i2nsf-nsf-log-dpi { 3510 if-feature "i2nsf-nsf-log-dpi"; 3511 container i2nsf-nsf-log-dpi { 3512 description 3513 "This notification is sent, if there is a new DPI 3514 event in the NSF log."; 3515 leaf attack-type { 3516 type identityref { 3517 base dpi-type; 3518 } 3519 description 3520 "The type of the DPI"; 3521 } 3522 uses i2nsf-nsf-event-type-content-extend; 3523 uses action; 3524 } 3525 } 3526 } 3527 } 3529 notification i2nsf-nsf-event { 3530 description 3531 "Notification for I2NSF NSF Event. This notification provides 3532 specific information that can only be provided by an NSF 3533 that supports additional features (e.g., DDoS attack 3534 detection)."; 3536 uses common-monitoring-data; 3537 uses message; 3538 uses characteristics-extended; 3540 choice sub-event-type { 3541 description 3542 "This choice must be augmented with cases for each allowed 3543 sub-event. Only 1 sub-event will be instantiated in each 3544 i2nsf-event message. Each case is expected to define one 3545 container with all the sub-event fields."; 3546 case i2nsf-nsf-detection-ddos { 3547 if-feature "i2nsf-nsf-detection-ddos"; 3548 container i2nsf-nsf-detection-ddos { 3549 description 3550 "This notification is sent, when a specific flood type 3551 is detected."; 3552 leaf attack-type { 3553 type identityref { 3554 base ddos-type; 3556 } 3557 description 3558 "Any one of Syn flood, ACK flood, SYN-ACK flood, 3559 FIN/RST flood, TCP Connection flood, UDP flood, 3560 ICMP (i.e., ICMPv4 or ICMPv6) flood, HTTP flood, 3561 HTTPS flood, DNS query flood, DNS reply flood, SIP 3562 flood, etc."; 3563 } 3564 leaf start-time { 3565 type yang:date-and-time; 3566 mandatory true; 3567 description 3568 "The time stamp indicating when the attack started"; 3569 } 3570 leaf end-time { 3571 type yang:date-and-time; 3572 description 3573 "The time stamp indicating when the attack ended. If 3574 the attack is still undergoing when sending out the 3575 notification, this field can be omitted."; 3576 } 3577 leaf-list attack-src-ip { 3578 type inet:ip-address-no-zone; 3579 description 3580 "The source IPv4 or IPv6 addresses of attack 3581 traffic. It can hold multiple IPv4 or IPv6 3582 addresses. Note that all IP addresses should not be 3583 included, but only limited IP addresses are included 3584 to conserve the server resources. The listed attacking 3585 IP addresses can be an arbitrary sampling of the 3586 'top talkers', i.e., the attackers that send the 3587 highest amount of traffic."; 3588 } 3589 leaf-list attack-dst-ip { 3590 type inet:ip-address-no-zone; 3591 description 3592 "The destination IPv4 or IPv6 addresses of attack 3593 traffic. It can hold multiple IPv4 or IPv6 3594 addresses."; 3595 } 3596 leaf-list attack-src-port { 3597 type inet:port-number; 3598 description 3599 "The transport-layer source ports of the DDoS attack. 3600 Note that not all ports will have been seen on all the 3601 corresponding source IP addresses."; 3602 } 3603 leaf-list attack-dst-port { 3604 type inet:port-number; 3605 description 3606 "The transport-layer destination ports of the DDoS 3607 attack. Note that not all ports will have been seen 3608 on all the corresponding destination IP addresses."; 3609 } 3610 leaf rule-name { 3611 type leafref { 3612 path 3613 "/nsfintf:i2nsf-security-policy" 3614 +"/nsfintf:rules/nsfintf:name"; 3615 } 3616 mandatory true; 3617 description 3618 "The name of the I2NSF Policy Rule being triggered"; 3619 } 3621 uses attack-rates; 3622 } 3623 } 3624 case i2nsf-nsf-detection-virus { 3625 if-feature "i2nsf-nsf-detection-virus"; 3626 container i2nsf-nsf-detection-virus { 3627 description 3628 "This notification is sent, when a virus is detected."; 3629 uses i2nsf-nsf-event-type-content-extend; 3630 leaf virus-name { 3631 type string; 3632 description 3633 "The name of the detected virus"; 3634 } 3635 leaf virus-type { 3636 type identityref { 3637 base virus-type; 3638 } 3639 description 3640 "The virus type of the detected virus"; 3641 } 3642 leaf host { 3643 type union { 3644 type string; 3645 type inet:ip-address-no-zone; 3646 } 3647 description 3648 "The name or IP address of the host/device. This is 3649 used to identify the host/device that is infected by 3650 the virus. If the given name is not an IP address, the 3651 name can be an arbitrary string including a FQDN 3652 (Fully Qualified Domain Name). The name MUST be unique 3653 in the scope of management domain for identifying the 3654 device that has been infected with a virus."; 3655 } 3656 leaf file-type { 3657 type string; 3658 description 3659 "The type of a file (indicated by the file's suffix, 3660 e.g., .exe) where virus code is found (if 3661 applicable)."; 3662 } 3663 leaf file-name { 3664 type string; 3665 description 3666 "The name of file virus code is found in (if 3667 applicable)."; 3668 } 3669 leaf os { 3670 type string; 3671 description 3672 "The operating system of the device."; 3673 } 3674 } 3675 } 3676 case i2nsf-nsf-detection-intrusion { 3677 if-feature "i2nsf-nsf-detection-intrusion"; 3678 container i2nsf-nsf-detection-intrusion { 3679 description 3680 "This notification is sent, when an intrusion event 3681 is detected."; 3682 uses i2nsf-nsf-event-type-content-extend; 3683 leaf protocol { 3684 type identityref { 3685 base transport-protocol; 3686 } 3687 description 3688 "The transport protocol type for 3689 nsf-detection-intrusion notification"; 3690 } 3691 leaf app { 3692 type identityref { 3693 base application-protocol; 3694 } 3695 description 3696 "The employed application layer protocol"; 3697 } 3698 leaf attack-type { 3699 type identityref { 3700 base intrusion-attack-type; 3701 } 3702 description 3703 "The sub attack type for intrusion attack"; 3704 } 3705 } 3706 } 3707 case i2nsf-nsf-detection-web-attack { 3708 if-feature "i2nsf-nsf-detection-web-attack"; 3709 container i2nsf-nsf-detection-web-attack { 3710 description 3711 "This notification is sent, when an attack event is 3712 detected."; 3713 uses i2nsf-nsf-event-type-content-extend; 3714 leaf attack-type { 3715 type identityref { 3716 base web-attack-type; 3717 } 3718 description 3719 "Concrete web attack type, e.g., SQL injection, 3720 command injection, XSS, and CSRF."; 3721 } 3722 leaf req-method { 3723 type identityref { 3724 base req-method; 3725 } 3726 description 3727 "The HTTP method of the request, e.g., PUT or GET."; 3728 reference 3729 "draft-ietf-httpbis-semantics-19: HTTP Semantics - 3730 Request Methods"; 3731 } 3732 leaf req-target { 3733 type string; 3734 description 3735 "The HTTP Request Target. This field can be filled in 3736 the format of origin-form, absolute-form, 3737 authority-form, or asterisk-form"; 3738 reference 3739 "draft-ietf-httpbis-messaging-19: HTTP/1.1 - Request 3740 Target"; 3741 } 3742 leaf-list filtering-type { 3743 type identityref { 3744 base filter-type; 3745 } 3746 description 3747 "URL filtering type, e.g., deny-list, allow-list, 3748 and Unknown"; 3749 } 3750 leaf cookies { 3751 type string; 3752 description 3753 "The HTTP Cookies header field of the request from 3754 the user agent. The cookie information needs to be 3755 kept confidential and is not RECOMMENDED to be 3756 included in the monitoring data unless the information 3757 is absolutely necessary to help to enhance the 3758 security of the network."; 3759 reference 3760 "RFC 6265: HTTP State Management Mechanism - Cookie"; 3761 } 3762 leaf req-host { 3763 type string; 3764 description 3765 "The HTTP Host header field of the request"; 3766 reference 3767 "draft-ietf-httpbis-semantics-19: HTTP Semantics - Host"; 3768 } 3769 leaf response-code { 3770 type string; 3771 description 3772 "The HTTP Response status code"; 3773 reference 3774 "IANA Website: Hypertext Transfer Protocol (HTTP) 3775 Status Code Registry"; 3776 } 3777 } 3778 } 3779 case i2nsf-nsf-detection-voip-vocn { 3780 if-feature "i2nsf-nsf-detection-voip-vocn"; 3781 container i2nsf-nsf-detection-voip-vocn { 3782 description 3783 "This notification is sent, when a VoIP/VoCN violation 3784 is detected."; 3785 uses i2nsf-nsf-event-type-content-extend; 3786 leaf-list source-voice-id { 3787 type string; 3788 description 3789 "The detected source voice ID for VoIP and VoCN that 3790 violates the security policy."; 3791 } 3792 leaf-list destination-voice-id { 3793 type string; 3794 description 3795 "The detected destination voice ID for VoIP and VoCN 3796 that violates the security policy."; 3797 } 3798 leaf-list user-agent { 3799 type string; 3800 description 3801 "The detected user-agent for VoIP and VoCN that 3802 violates the security policy."; 3803 } 3804 } 3805 } 3806 } 3807 } 3808 /* 3809 * Data nodes 3810 */ 3811 container i2nsf-counters { 3812 config false; 3813 description 3814 "The state data representing continuous value changes of 3815 information elements that occur very frequently. The value 3816 should be calculated from the start of the service of the 3817 NSF."; 3819 uses common-monitoring-data; 3820 uses timestamp; 3821 uses characteristics; 3823 list system-interface { 3824 key interface-name; 3825 description 3826 "Interface counters provide the visibility of traffic into 3827 and out of an NSF, and bandwidth usage."; 3828 uses i2nsf-system-counter-type-content; 3829 } 3830 list nsf-firewall { 3831 key policy-name; 3832 description 3833 "Firewall counters provide visibility into traffic signatures 3834 and bandwidth usage that correspond to the policy that is 3835 configured in a firewall."; 3836 leaf in-interface { 3837 type if:interface-ref; 3838 description 3839 "Inbound interface of the traffic"; 3840 } 3841 leaf out-interface { 3842 type if:interface-ref; 3843 description 3844 "Outbound interface of the traffic"; 3845 } 3846 uses i2nsf-nsf-counters-type-content; 3847 uses traffic-rates; 3848 } 3849 list nsf-policy-hits { 3850 key policy-name; 3851 description 3852 "Policy hit counters record the number of hits that traffic 3853 packets match a security policy. It can check if policy 3854 configurations are correct or not."; 3855 uses i2nsf-nsf-counters-type-content; 3856 leaf discontinuity-time { 3857 type yang:date-and-time; 3858 mandatory true; 3859 description 3860 "The time on the most recent occasion at which any one or 3861 more of the counters suffered a discontinuity. If no such 3862 discontinuities have occurred since the last 3863 re-initialization of the local management subsystem, then 3864 this node contains the time the local management subsystem 3865 was re-initialized."; 3866 } 3867 leaf hit-times { 3868 type yang:counter64; 3869 description 3870 "The number of times that the security policy matches the 3871 specified traffic."; 3872 } 3873 } 3874 } 3876 container i2nsf-monitoring-configuration { 3877 description 3878 "The container for configuring I2NSF monitoring."; 3879 container i2nsf-system-detection-alarm { 3880 description 3881 "The container for configuring I2NSF system-detection-alarm 3882 notification"; 3883 uses enable-notification; 3884 list system-alarm { 3885 key alarm-type; 3886 description 3887 "Configuration for system alarm (i.e., CPU, Memory, and 3888 Disk Usage)"; 3889 leaf alarm-type { 3890 type enumeration { 3891 enum cpu { 3892 description 3893 "To configure the CPU usage threshold to trigger the 3894 cpu-alarm"; 3895 } 3896 enum memory { 3897 description 3898 "To configure the Memory usage threshold to trigger 3899 the memory-alarm"; 3900 } 3901 enum disk { 3902 description 3903 "To configure the Disk (storage) usage threshold to 3904 trigger the disk-alarm"; 3905 } 3906 } 3907 description 3908 "Type of alarm to be configured. The three alarm-types 3909 defined here are used to configure the threshold of the 3910 monitoring notification. The threshold is used to 3911 determine when the notification should be sent. 3912 The other two alarms defined in the module (i.e., 3913 hardware-alarm and interface-alarm) do not use any 3914 threshold value to create a notification. These alarms 3915 detect a failure or a change of state to create a 3916 notification."; 3917 } 3918 leaf threshold { 3919 type uint8 { 3920 range "1..100"; 3921 } 3922 units "percent"; 3923 description 3924 "The configuration for threshold percentage to trigger 3925 the alarm. The alarm will be triggered if the usage 3926 is exceeded the threshold."; 3927 } 3928 uses dampening; 3929 } 3930 } 3931 container i2nsf-system-detection-event { 3932 description 3933 "The container for configuring I2NSF system-detection-event 3934 notification"; 3935 uses enable-notification; 3936 uses dampening; 3937 } 3938 container i2nsf-traffic-flows { 3939 description 3940 "The container for configuring I2NSF traffic-flows 3941 notification"; 3942 uses dampening; 3943 uses enable-notification; 3944 } 3945 container i2nsf-nsf-detection-ddos { 3946 if-feature "i2nsf-nsf-detection-ddos"; 3947 description 3948 "The container for configuring I2NSF nsf-detection-ddos 3949 notification"; 3950 uses enable-notification; 3951 uses dampening; 3952 } 3953 container i2nsf-nsf-detection-virus { 3954 if-feature "i2nsf-nsf-detection-virus"; 3955 description 3956 "The container for configuring I2NSF nsf-detection-virus 3957 notification"; 3958 uses enable-notification; 3959 uses dampening; 3960 } 3961 container i2nsf-nsf-detection-session-table { 3962 description 3963 "The container for configuring I2NSF nsf-detection-session- 3964 table notification"; 3965 uses enable-notification; 3966 uses dampening; 3967 } 3968 container i2nsf-nsf-detection-intrusion { 3969 if-feature "i2nsf-nsf-detection-intrusion"; 3970 description 3971 "The container for configuring I2NSF nsf-detection-intrusion 3972 notification"; 3973 uses enable-notification; 3974 uses dampening; 3975 } 3976 container i2nsf-nsf-detection-web-attack { 3977 if-feature "i2nsf-nsf-detection-web-attack"; 3978 description 3979 "The container for configuring I2NSF nsf-detection-web-attack 3980 notification"; 3981 uses enable-notification; 3982 uses dampening; 3983 } 3984 container i2nsf-nsf-detection-voip-vocn { 3985 if-feature "i2nsf-nsf-detection-voip-vocn"; 3986 description 3987 "The container for configuring I2NSF nsf-detection-voip-vocn 3988 notification"; 3989 uses enable-notification; 3990 uses dampening; 3991 } 3992 container i2nsf-nsf-system-access-log { 3993 description 3994 "The container for configuring I2NSF system-access-log 3995 notification"; 3996 uses enable-notification; 3997 uses dampening; 3998 } 3999 container i2nsf-system-res-util-log { 4000 description 4001 "The container for configuring I2NSF system-res-util-log 4002 notification"; 4003 uses enable-notification; 4004 uses dampening; 4005 } 4006 container i2nsf-system-user-activity-log { 4007 description 4008 "The container for configuring I2NSF system-user-activity-log 4009 notification"; 4010 uses enable-notification; 4011 uses dampening; 4012 } 4013 container i2nsf-nsf-log-dpi { 4014 if-feature "i2nsf-nsf-log-dpi"; 4015 description 4016 "The container for configuring I2NSF nsf-log-dpi 4017 notification"; 4018 uses enable-notification; 4019 uses dampening; 4020 } 4021 container i2nsf-counter { 4022 description 4023 "This is used to configure the counters 4024 for monitoring an NSF"; 4025 leaf period { 4026 type uint16; 4027 units "minutes"; 4028 default 0; 4029 description 4030 "The configuration for the period interval of reporting 4031 the counter. If 0, then the counter period is disabled. 4032 If value is not 0, then the counter will be reported 4033 following the period value."; 4034 } 4035 } 4037 } 4038 } 4039 4041 Figure 2: Data Model of Monitoring 4043 9. I2NSF Event Stream 4045 This section discusses the NETCONF event stream for an I2NSF NSF 4046 Monitoring subscription. The YANG module in this document supports 4047 "ietf-subscribed-notifications" YANG module [RFC8639] for 4048 subscription. The reserved event stream name for this document is 4049 "I2NSF-Monitoring". The NETCONF Server (e.g., an NSF) MUST support 4050 "I2NSF-Monitoring" event stream for an NSF data collector (e.g., 4051 Security Controller). The "I2NSF-Monitoring" event stream contains 4052 all I2NSF events described in this document. 4054 The following XML example shows the capabilities of the event streams 4055 generated by an NSF (e.g., "NETCONF" and "I2NSF-Monitoring" event 4056 streams) for the subscription of an NSF data collector. Refer to 4057 [RFC5277] for more detailed explanation of Event Streams. The XML 4058 examples in this document follow the line breaks as per [RFC8792]. 4060 4061 4063 4064 4065 4066 4067 NETCONF 4068 Default NETCONF Event Stream 4069 false 4070 4071 4072 I2NSF-Monitoring 4073 I2NSF Monitoring Event Stream 4074 true 4075 4076 2021-04-29T09:37:39+00:00 4077 4078 4079 4080 4081 4082 4083 Figure 3: Example of NETCONF Server supporting I2NSF-Monitoring 4084 Event Stream 4086 10. XML Examples for I2NSF NSF Monitoring 4088 This section shows XML examples of I2NSF NSF Monitoring data 4089 delivered via Monitoring Interface from an NSF. The XML examples are 4090 following the guidelines from [RFC6241] [RFC7950]. 4092 10.1. I2NSF System Detection Alarm 4094 The following example shows an alarm triggered by Memory Usage on the 4095 server; this example XML file is delivered by an NSF to an NSF data 4096 collector: 4098 4099 4101 2021-04-29T07:43:52.181088+00:00 4102 4104 subscription 4105 on-change 4106 on-repetition 4107 en-US 4108 4109 memory-alarm 4110 91 4111 90 4112 Memory Usage Exceeded the Threshold 4113 time_based_firewall 4114 high 4115 4116 4117 4119 Figure 4: Example of I2NSF System Detection Alarm triggered by 4120 Memory Usage 4122 The XML data above shows: 4124 1. The NSF that sends the information is named 4125 "time_based_firewall". 4127 2. The memory usage of the NSF triggered the alarm. 4129 3. The monitoring information is received by subscription method. 4131 4. The monitoring information is emitted "on-change". 4133 5. The monitoring information is dampened "on-repetition". 4135 6. The memory usage of the NSF is 91 percent. 4137 7. The memory threshold to trigger the alarm is 90 percent. 4139 8. The severity level of the notification is high. 4141 10.2. I2NSF Interface Counters 4143 To get the I2NSF system interface counters information by query, 4144 NETCONF Client (e.g., NSF data collector) needs to initiate GET 4145 connection with NETCONF Server (e.g., NSF). The following XML file 4146 can be used to get the state data and filter the information. 4148 4149 4150 4151 4153 4154 4155 4156 4157 4158 4160 Figure 5: XML Example for NETCONF GET with System Interface Filter 4162 The following XML file shows the reply from the NETCONF Server (e.g., 4163 NSF): 4165 4166 4168 4169 4171 query 4172 4173 4174 2021-04-29T08:43:52.181088+00:00 4175 4176 ens3 4177 549050 4178 814956 4179 0 4180 5078 4181 time_based_firewall 4182 4183 4184 4185 2021-04-29T08:43:52.181088+00:00 4186 4187 lo 4188 48487 4189 48487 4190 0 4191 0 4192 time_based_firewall 4193 4194 4195 4196 4198 Figure 6: Example of I2NSF System Interface Counters XML Information 4200 11. IANA Considerations 4202 This document requests IANA to register the following URI in the 4203 "IETF XML Registry" [RFC3688]: 4205 URI: urn:ietf:params:xml:ns:yang:ietf-i2nsf-nsf-monitoring 4206 Registrant Contact: The IESG. 4207 XML: N/A; the requested URI is an XML namespace. 4209 This document requests IANA to register the following YANG module in 4210 the "YANG Module Names" registry [RFC7950][RFC8525]: 4212 name: ietf-i2nsf-nsf-monitoring 4213 namespace: urn:ietf:params:xml:ns:yang:ietf-i2nsf-nsf-monitoring 4214 prefix: nsfmi 4215 reference: RFC XXXX 4217 // RFC Ed.: replace XXXX with an actual RFC number and remove 4218 // this note. 4220 12. Security Considerations 4222 The YANG module described in this document defines a schema for data 4223 that is designed to be accessed via network management protocols such 4224 as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer 4225 is the secure transport layer, and the required secure transport is 4226 Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, 4227 and the required secure transport is TLS [RFC8446]. 4229 The NETCONF access control model [RFC8341] provides a means of 4230 restricting access by specific NETCONF or RESTCONF users to a 4231 preconfigured subset of all available NETCONF or RESTCONF protocol 4232 operations and content. 4234 All data nodes defined in the YANG module which can be created, 4235 modified and deleted (i.e., config true, which is the default) are 4236 considered sensitive as they all could potentially impact security 4237 monitoring and mitigation activities. Write operations (e.g., edit- 4238 config) applied to these data nodes without proper protection could 4239 result in missed alarms or incorrect alarms information being 4240 returned to the NSF data collector. The following are threats that 4241 need to be considered and mitigated: 4243 Compromised NSF with valid credentials: It can send falsified 4244 information to the NSF data collector to mislead detection or 4245 mitigation activities; and/or to hide activity. Currently, there 4246 is no in-framework mechanism to mitigate this and it is an issue 4247 for all monitoring infrastructures. It is important to keep 4248 confidential information from unauthorized persons to mitigate the 4249 possibility of compromising the NSF with this information. 4251 Compromised NSF data collector with valid credentials: It has 4252 visibility to all collected security alarms; the entire detection 4253 and mitigation infrastructure may be suspect. It is important to 4254 keep confidential information from unauthorized persons to 4255 mitigate the possibility of compromising the NSF with this 4256 information. 4258 Impersonating NSF: This involves a system trying to send false 4259 information while imitating an NSF; client authentication would 4260 help the NSF data collector to identify this invalid NSF in the 4261 "push" model (NSF-to-collector), while the "pull" model 4262 (collector-to-NSF) should already be addressed with the 4263 authentication. 4265 Impersonating NSF data collector: This is a rogue NSF data collector 4266 with which a legitimate NSF is tricked into communicating; for 4267 "push" model (NSF-to-collector), it is important to have valid 4268 credentials, without which it should not work; for "pull" model 4269 (collector-to-NSF), mutual authentication should be used to 4270 mitigate the threat. 4272 In addition, to defend against the DDoS attack caused by a lot of 4273 NSFs sending massive notifications to the NSF data collector, the 4274 rate limiting or similar mechanisms should be considered in both an 4275 NSF and NSF data collector, whether in advance or just in the process 4276 of DDoS attack. 4278 All of the readable data nodes in this YANG module may be considered 4279 sensitive in some network environments. These data nodes represent 4280 information consistent with the logging commonly performed in network 4281 and security operations. They may reveal the specific configuration 4282 of a network; vulnerabilities in specific systems; and the deployed 4283 security controls and their relative efficacy in detecting or 4284 mitigating an attack. To an attacker, this information could inform 4285 how to (further) compromise the network, evade detection, or confirm 4286 whether they have been observed by the network operator. 4288 Additionally, many of the data nodes in this YANG module such as 4289 containers "i2nsf-system-user-activity-log", "i2nsf-system-detection- 4290 event", and "i2nsf-nsf-detection-voip-vocn" are privacy sensitive. 4291 They may describe specific or aggregate user activity including 4292 associating user names with specific IP addresses; or users with 4293 specific network usage. They may also describe the specific commands 4294 that were run by users and the resulting output. Any sensitive 4295 information in that command input or output will be visible to the 4296 NSF data collector and potentially other entities, and care must be 4297 taken to protect the confidentiality of such data from unauthorized 4298 parties. 4300 13. Acknowledgments 4302 This document is a product by the I2NSF Working Group (WG) including 4303 WG Chairs (i.e., Linda Dunbar and Yoav Nir) and Diego Lopez. This 4304 document took advantage of the review and comments from the following 4305 people: Roman Danyliw, Tim Bray (IANA), Kyle Rose (TSV-ART), Dale R. 4306 Worley (Gen-ART), Melinda Shore (SecDir), Valery Smyslov (ART-ART), 4307 and Tom Petch. The authors sincerely appreciate their sincere 4308 efforts and kind help. 4310 This work was supported by Institute of Information & Communications 4311 Technology Planning & Evaluation (IITP) grant funded by the Korea 4312 MSIT (Ministry of Science and ICT) (R-20160222-002755, Cloud based 4313 Security Intelligence Technology Development for the Customized 4314 Security Service Provisioning). This work was supported in part by 4315 the IITP (2020-0-00395, Standard Development of Blockchain based 4316 Network Management Automation Technology). This work was supported 4317 in part by the MSIT under the Information Technology Research Center 4318 (ITRC) support program (IITP-2021-2017-0-01633) supervised by the 4319 IITP. 4321 14. Contributors 4323 The following are co-authors of this document: 4325 Chaehong Chung - Department of Electronic, Electrical and Computer 4326 Engineering, Sungkyunkwan University, 2066 Seobu-ro Jangan-gu, Suwon, 4327 Gyeonggi-do 16419, Republic of Korea, Email: darkhong@skku.edu 4329 Jinyong (Tim) Kim - Department of Electronic, Electrical and Computer 4330 Engineering, Sungkyunkwan University, 2066 Seobu-ro Jangan-gu, Suwon, 4331 Gyeonggi-do 16419, Republic of Korea, Email: timkim@skku.edu 4333 Dongjin Hong - Department of Electronic, Electrical and Computer 4334 Engineering, Sungkyunkwan University, 2066 Seobu-ro Jangan-gu, Suwon, 4335 Gyeonggi-do 16419, Republic of Korea, Email: dong.jin@skku.edu 4337 Dacheng Zhang - Huawei, Email: dacheng.zhang@huawei.com 4339 Yi Wu - Aliababa Group, Email: anren.wy@alibaba-inc.com 4341 Rakesh Kumar - Juniper Networks, 1133 Innovation Way, Sunnyvale, CA 4342 94089, USA, Email: rkkumar@juniper.net 4344 Anil Lohiya - Juniper Networks, Email: alohiya@juniper.net 4346 15. References 4347 15.1. Normative References 4349 [RFC0768] Postel, J., "User Datagram Protocol", STD 6, RFC 768, 4350 DOI 10.17487/RFC0768, August 1980, 4351 . 4353 [RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791, 4354 DOI 10.17487/RFC0791, September 1981, 4355 . 4357 [RFC0792] Postel, J., "Internet Control Message Protocol", STD 5, 4358 RFC 792, DOI 10.17487/RFC0792, September 1981, 4359 . 4361 [RFC0854] Postel, J. and J. Reynolds, "Telnet Protocol 4362 Specification", STD 8, RFC 854, DOI 10.17487/RFC0854, May 4363 1983, . 4365 [RFC0959] Postel, J. and J. Reynolds, "File Transfer Protocol", 4366 STD 9, RFC 959, DOI 10.17487/RFC0959, October 1985, 4367 . 4369 [RFC1939] Myers, J. and M. Rose, "Post Office Protocol - Version 3", 4370 STD 53, RFC 1939, DOI 10.17487/RFC1939, May 1996, 4371 . 4373 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 4374 Requirement Levels", BCP 14, RFC 2119, 4375 DOI 10.17487/RFC2119, March 1997, 4376 . 4378 [RFC2595] Newman, C., "Using TLS with IMAP, POP3 and ACAP", 4379 RFC 2595, DOI 10.17487/RFC2595, June 1999, 4380 . 4382 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 4383 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 4384 . 4386 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 4387 DOI 10.17487/RFC3688, January 2004, 4388 . 4390 [RFC3877] Chisholm, S. and D. Romascanu, "Alarm Management 4391 Information Base (MIB)", RFC 3877, DOI 10.17487/RFC3877, 4392 September 2004, . 4394 [RFC4340] Kohler, E., Handley, M., and S. Floyd, "Datagram 4395 Congestion Control Protocol (DCCP)", RFC 4340, 4396 DOI 10.17487/RFC4340, March 2006, 4397 . 4399 [RFC4443] Conta, A., Deering, S., and M. Gupta, Ed., "Internet 4400 Control Message Protocol (ICMPv6) for the Internet 4401 Protocol Version 6 (IPv6) Specification", STD 89, 4402 RFC 4443, DOI 10.17487/RFC4443, March 2006, 4403 . 4405 [RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event 4406 Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008, 4407 . 4409 [RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321, 4410 DOI 10.17487/RFC5321, October 2008, 4411 . 4413 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 4414 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 4415 September 2009, . 4417 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 4418 and A. Bierman, Ed., "Network Configuration Protocol 4419 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 4420 . 4422 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 4423 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 4424 . 4426 [RFC6265] Barth, A., "HTTP State Management Mechanism", RFC 6265, 4427 DOI 10.17487/RFC6265, April 2011, 4428 . 4430 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 4431 RFC 6991, DOI 10.17487/RFC6991, July 2013, 4432 . 4434 [RFC7011] Claise, B., Ed., Trammell, B., Ed., and P. Aitken, 4435 "Specification of the IP Flow Information Export (IPFIX) 4436 Protocol for the Exchange of Flow Information", STD 77, 4437 RFC 7011, DOI 10.17487/RFC7011, September 2013, 4438 . 4440 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 4441 RFC 7950, DOI 10.17487/RFC7950, August 2016, 4442 . 4444 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 4445 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 4446 . 4448 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 4449 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 4450 May 2017, . 4452 [RFC8200] Deering, S. and R. Hinden, "Internet Protocol, Version 6 4453 (IPv6) Specification", STD 86, RFC 8200, 4454 DOI 10.17487/RFC8200, July 2017, 4455 . 4457 [RFC8329] Lopez, D., Lopez, E., Dunbar, L., Strassner, J., and R. 4458 Kumar, "Framework for Interface to Network Security 4459 Functions", RFC 8329, DOI 10.17487/RFC8329, February 2018, 4460 . 4462 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 4463 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 4464 . 4466 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 4467 Access Control Model", STD 91, RFC 8341, 4468 DOI 10.17487/RFC8341, March 2018, 4469 . 4471 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 4472 and R. Wilton, "Network Management Datastore Architecture 4473 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 4474 . 4476 [RFC8343] Bjorklund, M., "A YANG Data Model for Interface 4477 Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, 4478 . 4480 [RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of 4481 Documents Containing YANG Data Models", BCP 216, RFC 8407, 4482 DOI 10.17487/RFC8407, October 2018, 4483 . 4485 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol 4486 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, 4487 . 4489 [RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K., 4490 and R. Wilton, "YANG Library", RFC 8525, 4491 DOI 10.17487/RFC8525, March 2019, 4492 . 4494 [RFC8639] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard, 4495 E., and A. Tripathy, "Subscription to YANG Notifications", 4496 RFC 8639, DOI 10.17487/RFC8639, September 2019, 4497 . 4499 [RFC8641] Clemm, A. and E. Voit, "Subscription to YANG Notifications 4500 for Datastore Updates", RFC 8641, DOI 10.17487/RFC8641, 4501 September 2019, . 4503 [RFC8650] Voit, E., Rahman, R., Nilsen-Nygaard, E., Clemm, A., and 4504 A. Bierman, "Dynamic Subscription to YANG Events and 4505 Datastores over RESTCONF", RFC 8650, DOI 10.17487/RFC8650, 4506 November 2019, . 4508 [RFC9000] Iyengar, J., Ed. and M. Thomson, Ed., "QUIC: A UDP-Based 4509 Multiplexed and Secure Transport", RFC 9000, 4510 DOI 10.17487/RFC9000, May 2021, 4511 . 4513 [RFC9051] Melnikov, A., Ed. and B. Leiba, Ed., "Internet Message 4514 Access Protocol (IMAP) - Version 4rev2", RFC 9051, 4515 DOI 10.17487/RFC9051, August 2021, 4516 . 4518 [I-D.ietf-httpbis-http2bis] 4519 Thomson, M. and C. Benfield, "HTTP/2", Work in Progress, 4520 Internet-Draft, draft-ietf-httpbis-http2bis-07, 24 January 4521 2022, . 4524 [I-D.ietf-httpbis-messaging] 4525 Fielding, R. T., Nottingham, M., and J. Reschke, 4526 "HTTP/1.1", Work in Progress, Internet-Draft, draft-ietf- 4527 httpbis-messaging-19, 12 September 2021, 4528 . 4531 [I-D.ietf-httpbis-semantics] 4532 Fielding, R. T., Nottingham, M., and J. Reschke, "HTTP 4533 Semantics", Work in Progress, Internet-Draft, draft-ietf- 4534 httpbis-semantics-19, 12 September 2021, 4535 . 4538 [I-D.ietf-i2nsf-capability-data-model] 4539 Hares, S., Jeong, J. (., Kim, J. (., Moskowitz, R., and Q. 4540 Lin, "I2NSF Capability YANG Data Model", Work in Progress, 4541 Internet-Draft, draft-ietf-i2nsf-capability-data-model-29, 4542 25 March 2022, . 4545 [I-D.ietf-i2nsf-nsf-facing-interface-dm] 4546 Kim, J. (., Jeong, J. (., Park, J., Hares, S., and Q. Lin, 4547 "I2NSF Network Security Function-Facing Interface YANG 4548 Data Model", Work in Progress, Internet-Draft, draft-ietf- 4549 i2nsf-nsf-facing-interface-dm-24, 6 April 2022, 4550 . 4553 [I-D.ietf-tcpm-rfc793bis] 4554 Eddy, W. M., "Transmission Control Protocol (TCP) 4555 Specification", Work in Progress, Internet-Draft, draft- 4556 ietf-tcpm-rfc793bis-28, 7 March 2022, 4557 . 4560 [I-D.ietf-tsvwg-rfc4960-bis] 4561 Stewart, R. R., Tüxen, M., and K. E. E. Nielsen, "Stream 4562 Control Transmission Protocol", Work in Progress, 4563 Internet-Draft, draft-ietf-tsvwg-rfc4960-bis-19, 5 4564 February 2022, . 4567 15.2. Informative References 4569 [RFC0826] Plummer, D., "An Ethernet Address Resolution Protocol: Or 4570 Converting Network Protocol Addresses to 48.bit Ethernet 4571 Address for Transmission on Ethernet Hardware", STD 37, 4572 RFC 826, DOI 10.17487/RFC0826, November 1982, 4573 . 4575 [RFC4861] Narten, T., Nordmark, E., Simpson, W., and H. Soliman, 4576 "Neighbor Discovery for IP version 6 (IPv6)", RFC 4861, 4577 DOI 10.17487/RFC4861, September 2007, 4578 . 4580 [RFC4949] Shirey, R., "Internet Security Glossary, Version 2", 4581 FYI 36, RFC 4949, DOI 10.17487/RFC4949, August 2007, 4582 . 4584 [RFC8792] Watsen, K., Auerswald, E., Farrel, A., and Q. Wu, 4585 "Handling Long Lines in Content of Internet-Drafts and 4586 RFCs", RFC 8792, DOI 10.17487/RFC8792, June 2020, 4587 . 4589 [I-D.ietf-i2nsf-consumer-facing-interface-dm] 4590 Jeong, J. (., Chung, C., Ahn, T., Kumar, R., and S. Hares, 4591 "I2NSF Consumer-Facing Interface YANG Data Model", Work in 4592 Progress, Internet-Draft, draft-ietf-i2nsf-consumer- 4593 facing-interface-dm-17, 23 March 2022, 4594 . 4597 [IANA-HTTP-Status-Code] 4598 Internet Assigned Numbers Authority (IANA), "Hypertext 4599 Transfer Protocol (HTTP) Status Code Registry", September 4600 2018, . 4603 [IEEE-802.1AB] 4604 Institute of Electrical and Electronics Engineers, "IEEE 4605 Standard for Local and metropolitan area networks - 4606 Station and Media Access Control Connectivity Discovery", 4607 March 2016, 4608 . 4610 Appendix A. Changes from draft-ietf-i2nsf-nsf-monitoring-data-model-16 4612 The following changes are made from draft-ietf-i2nsf-nsf-monitoring- 4613 data-model-16: 4615 * This version is added following Benjamin Kaduk, Francesca 4616 Palombini, and Robert Wilton's comments 4618 * This version updated the IETF Trust Copyright statement in the 4619 YANG data model. 4621 Authors' Addresses 4623 Jaehoon (Paul) Jeong (editor) 4624 Department of Computer Science and Engineering 4625 Sungkyunkwan University 4626 2066 Seobu-Ro, Jangan-Gu 4627 Suwon 4628 Gyeonggi-Do 4629 16419 4630 Republic of Korea 4631 Phone: +82 31 299 4957 4632 Email: pauljeong@skku.edu 4633 URI: http://iotlab.skku.edu/people-jaehoon-jeong.php 4635 Patrick Lingga 4636 Department of Electrical and Computer Engineering 4637 Sungkyunkwan University 4638 2066 Seobu-Ro, Jangan-Gu 4639 Suwon 4640 Gyeonggi-Do 4641 16419 4642 Republic of Korea 4643 Phone: +82 31 299 4957 4644 Email: patricklink@skku.edu 4646 Susan Hares 4647 Huawei 4648 7453 Hickory Hill 4649 Saline, MI 48176 4650 United States of America 4651 Phone: +1-734-604-0332 4652 Email: shares@ndzh.com 4654 Liang (Frank) Xia 4655 Huawei 4656 101 Software Avenue, Yuhuatai District 4657 Nanjing 4658 Jiangsu, 4659 China 4660 Email: Frank.xialiang@huawei.com 4662 Henk Birkholz 4663 Fraunhofer Institute for Secure Information Technology 4664 Rheinstrasse 75 4665 64295 Darmstadt 4666 Germany 4667 Email: henk.birkholz@sit.fraunhofer.de