--- 1/draft-ietf-i2nsf-nsf-monitoring-data-model-08.txt 2021-08-24 07:13:34.227958996 -0700 +++ 2/draft-ietf-i2nsf-nsf-monitoring-data-model-09.txt 2021-08-24 07:13:34.391963113 -0700 @@ -1,23 +1,23 @@ Network Working Group J. Jeong, Ed. Internet-Draft P. Lingga Intended status: Standards Track Sungkyunkwan University -Expires: October 31, 2021 S. Hares +Expires: 25 February 2022 S. Hares L. Xia Huawei H. Birkholz Fraunhofer SIT - April 29, 2021 + 24 August 2021 I2NSF NSF Monitoring Interface YANG Data Model - draft-ietf-i2nsf-nsf-monitoring-data-model-08 + draft-ietf-i2nsf-nsf-monitoring-data-model-09 Abstract This document proposes an information model and the corresponding YANG data model of an interface for monitoring Network Security Functions (NSFs) in the Interface to Network Security Functions (I2NSF) framework. If the monitoring of NSFs is performed with the NSF monitoring interface in a comprehensive way, it is possible to detect the indication of malicious activity, anomalous behavior, the potential sign of denial of service attacks, or system overload in a @@ -35,1146 +35,1113 @@ Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." - This Internet-Draft will expire on October 31, 2021. + This Internet-Draft will expire on 25 February 2022. Copyright Notice Copyright (c) 2021 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal - Provisions Relating to IETF Documents - (https://trustee.ietf.org/license-info) in effect on the date of - publication of this document. Please review these documents - carefully, as they describe your rights and restrictions with respect - to this document. Code Components extracted from this document must - include Simplified BSD License text as described in Section 4.e of - the Trust Legal Provisions and are provided without warranty as - described in the Simplified BSD License. + Provisions Relating to IETF Documents (https://trustee.ietf.org/ + license-info) in effect on the date of publication of this document. + Please review these documents carefully, as they describe your rights + and restrictions with respect to this document. Code Components + extracted from this document must include Simplified BSD License text + as described in Section 4.e of the Trust Legal Provisions and are + provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4 3. Use Cases for NSF Monitoring Data . . . . . . . . . . . . . . 4 4. Classification of NSF Monitoring Data . . . . . . . . . . . . 5 4.1. Retention and Emission . . . . . . . . . . . . . . . . . 6 - 4.2. Notifications and Events . . . . . . . . . . . . . . . . 7 - 4.3. Unsolicited Poll and Solicited Push . . . . . . . . . . . 7 - 4.4. I2NSF Monitoring Terminology for Retained Information . . 8 - 5. Conveyance of NSF Monitoring Information . . . . . . . . . . 9 - 5.1. Information Types and Acquisition Methods . . . . . . . . 10 - 6. Basic Information Model for All Monitoring Data . . . . . . . 10 - 7. Extended Information Model for Monitoring Data . . . . . . . 11 - 7.1. System Alarms . . . . . . . . . . . . . . . . . . . . . . 11 - 7.1.1. Memory Alarm . . . . . . . . . . . . . . . . . . . . 11 - 7.1.2. CPU Alarm . . . . . . . . . . . . . . . . . . . . . . 11 - 7.1.3. Disk Alarm . . . . . . . . . . . . . . . . . . . . . 12 - 7.1.4. Hardware Alarm . . . . . . . . . . . . . . . . . . . 12 - 7.1.5. Interface Alarm . . . . . . . . . . . . . . . . . . . 12 - 7.2. System Events . . . . . . . . . . . . . . . . . . . . . . 13 - 7.2.1. Access Violation . . . . . . . . . . . . . . . . . . 13 - 7.2.2. Configuration Change . . . . . . . . . . . . . . . . 13 - 7.2.3. Traffic flows . . . . . . . . . . . . . . . . . . . . 14 - 7.3. NSF Events . . . . . . . . . . . . . . . . . . . . . . . 14 - 7.3.1. DDoS Detection . . . . . . . . . . . . . . . . . . . 14 - 7.3.2. Session Table Event . . . . . . . . . . . . . . . . . 15 - 7.3.3. Virus Event . . . . . . . . . . . . . . . . . . . . . 15 - 7.3.4. Intrusion Event . . . . . . . . . . . . . . . . . . . 16 - 7.3.5. Botnet Event . . . . . . . . . . . . . . . . . . . . 16 - 7.3.6. Web Attack Event . . . . . . . . . . . . . . . . . . 17 - 7.4. System Logs . . . . . . . . . . . . . . . . . . . . . . . 18 - 7.4.1. Access Log . . . . . . . . . . . . . . . . . . . . . 18 - 7.4.2. Resource Utilization Log . . . . . . . . . . . . . . 19 - 7.4.3. User Activity Log . . . . . . . . . . . . . . . . . . 19 - 7.5. NSF Logs . . . . . . . . . . . . . . . . . . . . . . . . 20 - 7.5.1. DPI Log . . . . . . . . . . . . . . . . . . . . . . . 20 - 7.5.2. Vulnerability Scanning Log . . . . . . . . . . . . . 21 - 7.6. System Counter . . . . . . . . . . . . . . . . . . . . . 21 - 7.6.1. Interface Counter . . . . . . . . . . . . . . . . . . 21 - 7.7. NSF Counters . . . . . . . . . . . . . . . . . . . . . . 22 - 7.7.1. Firewall Counter . . . . . . . . . . . . . . . . . . 22 - 7.7.2. Policy Hit Counter . . . . . . . . . . . . . . . . . 24 - 8. NSF Monitoring Management in I2NSF . . . . . . . . . . . . . 24 - 9. Tree Structure . . . . . . . . . . . . . . . . . . . . . . . 25 - 10. YANG Data Model . . . . . . . . . . . . . . . . . . . . . . . 33 - 11. I2NSF Event Stream . . . . . . . . . . . . . . . . . . . . . 74 - 12. XML Examples for I2NSF NSF Monitoring . . . . . . . . . . . . 75 - 12.1. I2NSF System Detection Alarm . . . . . . . . . . . . . . 75 - 12.2. I2NSF Interface Counters . . . . . . . . . . . . . . . . 77 - 13. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 78 - 14. Security Considerations . . . . . . . . . . . . . . . . . . . 79 - 15. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 80 - 16. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 80 - 17. References . . . . . . . . . . . . . . . . . . . . . . . . . 81 - 17.1. Normative References . . . . . . . . . . . . . . . . . . 81 - 17.2. Informative References . . . . . . . . . . . . . . . . . 84 - Appendix A. Changes from draft-ietf-i2nsf-nsf-monitoring-data- - model-07 . . . . . . . . . . . . . . . . . . . . . . 86 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 86 + 4.2. Notifications, Events, and Records . . . . . . . . . . . 8 + 4.3. Unsolicited Poll and Solicited Push . . . . . . . . . . . 8 + 5. Basic Information Model for Monitoring Data . . . . . . . . . 9 + 6. Extended Information Model for Monitoring Data . . . . . . . 9 + 6.1. System Alarms . . . . . . . . . . . . . . . . . . . . . . 10 + 6.1.1. Memory Alarm . . . . . . . . . . . . . . . . . . . . 10 + 6.1.2. CPU Alarm . . . . . . . . . . . . . . . . . . . . . . 11 + 6.1.3. Disk Alarm . . . . . . . . . . . . . . . . . . . . . 11 + 6.1.4. Hardware Alarm . . . . . . . . . . . . . . . . . . . 11 + 6.1.5. Interface Alarm . . . . . . . . . . . . . . . . . . . 12 + 6.2. System Events . . . . . . . . . . . . . . . . . . . . . . 12 + 6.2.1. Access Violation . . . . . . . . . . . . . . . . . . 12 + 6.2.2. Configuration Change . . . . . . . . . . . . . . . . 13 + 6.2.3. Session Table Event . . . . . . . . . . . . . . . . . 13 + 6.2.4. Traffic Flows . . . . . . . . . . . . . . . . . . . . 14 + 6.3. NSF Events . . . . . . . . . . . . . . . . . . . . . . . 14 + 6.3.1. DDoS Detection . . . . . . . . . . . . . . . . . . . 14 + 6.3.2. Virus Event . . . . . . . . . . . . . . . . . . . . . 15 + 6.3.3. Intrusion Event . . . . . . . . . . . . . . . . . . . 16 + 6.3.4. Web Attack Event . . . . . . . . . . . . . . . . . . 16 + 6.3.5. VoIP/VoLTE Event . . . . . . . . . . . . . . . . . . 17 + 6.4. System Logs . . . . . . . . . . . . . . . . . . . . . . . 18 + 6.4.1. Access Log . . . . . . . . . . . . . . . . . . . . . 18 + 6.4.2. Resource Utilization Log . . . . . . . . . . . . . . 18 + 6.4.3. User Activity Log . . . . . . . . . . . . . . . . . . 19 + 6.5. NSF Logs . . . . . . . . . . . . . . . . . . . . . . . . 20 + 6.5.1. Deep Packet Inspection Log . . . . . . . . . . . . . 20 + + 6.6. System Counter . . . . . . . . . . . . . . . . . . . . . 20 + 6.6.1. Interface Counter . . . . . . . . . . . . . . . . . . 21 + 6.7. NSF Counters . . . . . . . . . . . . . . . . . . . . . . 22 + 6.7.1. Firewall Counter . . . . . . . . . . . . . . . . . . 22 + 6.7.2. Policy Hit Counter . . . . . . . . . . . . . . . . . 23 + 7. NSF Monitoring Management in I2NSF . . . . . . . . . . . . . 24 + 8. Tree Structure . . . . . . . . . . . . . . . . . . . . . . . 25 + 9. YANG Data Model . . . . . . . . . . . . . . . . . . . . . . . 32 + 10. I2NSF Event Stream . . . . . . . . . . . . . . . . . . . . . 76 + 11. XML Examples for I2NSF NSF Monitoring . . . . . . . . . . . . 77 + 11.1. I2NSF System Detection Alarm . . . . . . . . . . . . . . 77 + 11.2. I2NSF Interface Counters . . . . . . . . . . . . . . . . 79 + 12. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 80 + 13. Security Considerations . . . . . . . . . . . . . . . . . . . 81 + 14. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 82 + 15. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 83 + 16. References . . . . . . . . . . . . . . . . . . . . . . . . . 83 + 16.1. Normative References . . . . . . . . . . . . . . . . . . 83 + 16.2. Informative References . . . . . . . . . . . . . . . . . 85 + Appendix A. Changes from + draft-ietf-i2nsf-nsf-monitoring-data-model-08 . . . . . . 87 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 87 1. Introduction According to [RFC8329], the interface provided by a Network Security - Function (NSF) (e.g., Firewall, IPS, Anti-DDoS, or Anti-Virus - function) to administrative entities (e.g., Security Controller) to - enable remote management (i.e., configuring and monitoring) is - referred to as an I2NSF Monitoring Interface. Monitoring procedures - intent to acquire vital types of data with respect to NSFs, (e.g., - alarms, records, and counters) via data in motion (e.g., queries, + Function (NSF) (e.g., Firewall, IPS, or Anti-DDoS function) to + administrative entities (e.g., Security Controller) to enable remote + management (i.e., configuring and monitoring) is referred to as an + I2NSF Monitoring Interface. This interface enables the sharing of + vital data from the NSFs (e.g., alarms, records, and counters) to the + Security Controller through a variety of mechanisms (e.g., queries, notifications, and events). The monitoring of NSF plays an important role in an overall security framework, if it is done in a timely and comprehensive way. The monitoring information generated by an NSF can be a good, early indication of anomalous behavior or malicious activity, such as denial of service attacks (DoS). This document defines a comprehensive information model of an NSF - monitoring interface that provides visibility for an NSF for an NSF - data collector (e.g., Security Controller and NSF Data Analyzer). - Note that an NSF data collector is defined as an entity to collect - NSF monitoring data from an NSF, such as Security Controller and NSF - Data Analyzer. It specifies the information and illustrates the - methods that enable an NSF to provide the information required in - order to be monitored in a scalable and efficient way via the NSF - Monitoring Interface. The information model for the NSF monitoring - interface presented in this document is a complementary information - model to the information model for the security policy provisioning - functionality of the NSF-Facing Interface specified in + monitoring interface that provides visibility into an NSF for the NSF + data collector (e.g., Security Controller). Note that an NSF data + collector is defined as an entity to collect NSF monitoring data from + an NSF, such as Security Controller. It specifies the information + and illustrates the methods that enable an NSF to provide the + information required in order to be monitored in a scalable and + efficient way via the NSF Monitoring Interface. The information + model for the NSF monitoring interface presented in this document is + complementary for the security policy provisioning functionality of + the NSF-Facing Interface specified in [I-D.ietf-i2nsf-nsf-facing-interface-dm]. This document also defines a YANG [RFC7950] data model for the NSF monitoring interface, which is derived from the information model for the NSF monitoring interface. 2. Terminology + The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", + "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and + "OPTIONAL" in this document are to be interpreted as described in BCP + 14 [RFC2119] [RFC8174] when, and only when, they appear in all + capitals, as shown here. + This document uses the terminology described in [RFC8329]. This document follows the guidelines of [RFC8407], uses the common YANG types defined in [RFC6991], and adopts the Network Management Datastore Architecture (NMDA) [RFC8342]. The meaning of the symbols in tree diagrams is defined in [RFC8340]. 3. Use Cases for NSF Monitoring Data As mentioned earlier, monitoring plays a critical role in an overall security framework. The monitoring of the NSF provides very valuable - information to an NSF data collector (e.g., Security Controller and - NSF data analyzer) in maintaining the provisioned security posture. - Besides this, there are various other reasons to monitor the NSF as - listed below: + information to an NSF data collector (e.g., Security Controller) in + maintaining the provisioned security posture. Besides this, there + are various other reasons to monitor the NSF as listed below: - o The security administrator with I2NSF User can configure a policy + * The security administrator with I2NSF User can configure a policy that is triggered on a specific event occurring in the NSF or the network [RFC8329] [I-D.ietf-i2nsf-consumer-facing-interface-dm]. If an NSF data collector detects the specified event, it configures additional security functions as defined by policies. - o The events triggered by an NSF as a result of security policy + * The events triggered by an NSF as a result of security policy violation can be used by Security Information and Event Management (SIEM) to detect any suspicious activity in a larger correlation context. - o The events and activity logs from an NSF can be used to build - advanced analytics, such as behavior and predictive models to - improve security posture in large deployments. + * The information (i.e., events, records, and counters) from an NSF + can be used to build advanced analytics, such as behavior and + predictive models to improve security posture in large + deployments. - o The NSF data collector can use events from the NSF for achieving + * The NSF data collector can use events from the NSF for achieving high availability. It can take corrective actions such as restarting a failed NSF and horizontally scaling up the NSF. - o The events and activity logs from the NSF can aid in the root - cause analysis of an operational issue, so it can improve - debugging. + * The information (i.e., events, records, and counters) from the NSF + can aid in the root cause analysis of an operational issue, so it + can improve debugging. - o The activity logs from the NSF can be used to build historical - data for operational and business reasons. + * The records from the NSF can be used to build historical data for + operation and business reasons. 4. Classification of NSF Monitoring Data In order to maintain a strong security posture, it is not only - necessary not only to configure an NSF's security policies but also - to continuously monitor the NSF by consuming acquirable and - observable information. This enables security administrators to - assess the state of the network topology in a timely fashion. It is - not possible to block all the internal and external threats based on - static security posture. A more practical approach is supported by - enabling dynamic security measures, for which continuous visibility - is required. This document defines a set of information elements - (and their scope) that can be acquired from an NSF and can be used as - NSF monitoring information. In essence, these types of monitoring - information can be leveraged to support constant visibility on - multiple levels of granularity and can be consumed by the - corresponding functions. - - Three basic domains about the monitoring information originating from - a system entity [RFC4949] or an NSF are highlighted in this document. - - o Retention and Emission + necessary to configure an NSF's security policies but also to + continuously monitor the NSF by consuming acquirable and observable + data. This enables security administrators to assess the state of + the networks and in a timely fashion. It is not possible to block + all the internal and external threats based on static security + posture. A more practical approach is supported by enabling dynamic + security measures, for which continuous visibility is required. This + document defines a set of monitoring elements and their scopes that + can be acquired from an NSF and can be used as NSF monitoring data. + In essence, these types of monitoring data can be leveraged to + support constant visibility on multiple levels of granularity and can + be consumed by the corresponding functions. - o Notifications and Events + Three basic domains about the monitoring data originating from a + system entity [RFC4949], i.e., an NSF, are highlighted in this + document. - o Unsolicited Poll and Solicited Push + * Retention and Emission - The Alarm Management Framework in [RFC3877] defines an Event as - something that happens as a thing of of interest. It defines a fault - as a change in status, crossing a threshold, or an external input to - the system. In the I2NSF domain, I2NSF events are created and the - scope of the Alarm Management Framework's Events is still applicable - due to its broad definition. The model presented in this document - elaborates on the workflow of creating I2NSF events in the context of - NSF monitoring and on the way initial I2NSF events are created. + * Notifications, Events, and Records + * Unsolicited Poll and Solicited Push As with I2NSF components, every generic system entity can include a - set of capabilities that creates information about the context, - composition, configuration, state or behavior of that system entity. - This information is intended to be provided to other consumers of + set of capabilities that creates information about some context with + monitoring data (i.e., monitoring information), composition, + configuration, state or behavior of that system entity. This + information is intended to be provided to other consumers of information and in the scope of this document, which deals with NSF - information monitoring in an automated fashion. + monitoring data in an automated fashion. 4.1. Retention and Emission - Typically, a system entity populates standardized interface, such as - SNMP, NETCONF, RESTCONF or CoMI to provide and emit created - information directly via NSF Monitoring Interface. Alternatively, - the created information is retained inside the system entity (or a - hierarchy of system entities in a composite device) via records or - counters that are not exposed directly via NSF Monistoring Interface. + A system entity (e.g., NSF) first retains I2NSF monitoring data + inside its own system before emitting the information another I2NSF + component (e.g., NSF Data Collector). The I2NSF monitoring + information consist of I2NSF Event, I2NSF Record, and I2NSF Counter + as follows: - Information emitted via standardized interfaces can be consumed by an - I2NSF User that includes the capability to consume information not - only via an I2NSF Interface (e.g., Consumer-Facing Interface - [I-D.ietf-i2nsf-consumer-facing-interface-dm]), but also via - interfaces complementary to the standardized interfaces a generic - system entity provides. + I2NSF Event: I2NSF Event is defined as an important occurrence over + time, that is, a change in the system being managed or a change in + the environment of the system being managed. An I2NSF Event + requires immediate attention and should be notified as soon as + possible. When used in the context of an (imperative) I2NSF + Policy Rule, an I2NSF Event is used to determine whether the + Condition clause of that Policy Rule can be evaluated or not. The + Alarm Management Framework in [RFC3877] defines an event as + something that happens which may be of interest. Examples for an + event are a fault, a change in status, crossing a threshold, or an + external input to the system. In the I2NSF domain, I2NSF events + are created following the definition of an event in the Alarm + Management Framework. - Information retained on a system entity requires a corresponding - I2NSF User to access aggregated records of information, typically in - the form of log-files or databases. There are ways to aggregate - records originating from different system entities over a network, - for examples via Syslog Protocol [RFC5424] or Syslog over TCP - [RFC6587]. But even if records are conveyed, the result is the same - kind of retention in form of a bigger aggregate of records on another + I2NSF Record: A record is defined as an item of information that is + kept to be looked at and used in the future. Unlike I2NSF Event, + records do not require immediate attention but may be useful for + visibility and retroactive cyber forensic. Depending on the + record format, there are different qualities in regard to + structure and detail. Records are typically stored in log-files + or databases on a system entity or NSF. Records in the form of + log-files usually include less structures but potentially more + detailed information in regard to the changes of a system entity's + characteristics. In contrast, databases often use more strict + schemas or data models, therefore enforcing a better structure. + However, they inhibit storing information that does not match + those models ("closed world assumption"). Records can be + continuously processed by a system entity as an I2NSF Producer and + emitted with a format tailored to a certain type of record. + Typically, records are information generated by a system entity + (e.g., NSF) that is based on operational and informational data, + that is, various changes in system characteristics. The examples + of records include as user activities, network/traffic status, and + network activity. They are important for debugging, auditing and + security forensic of a system entity or the network having the system entity. - An I2NSF User is required to process fresh [RFC4949] records created - by I2NSF Functions in order to provide them to other I2NSF Components - via the corresponding I2NSF Interfaces in a timely manner. This - process is effectively based on homogenizing functions, which can - access and convert specific kinds of records into information that - can be provided and emitted via I2NSF interfaces. - - When retained or emitted, the information required to support - monitoring processes has to be processed by an I2NSF User at some - point in the workflow. Typical locations of these I2NSF Users are: + I2NSF Counter: An I2NSF Counter is defined as a specific + representation of continuous value changes of information elements + that potentially occur in high frequency. Prominent examples are + network interface counters for protocol data unit (PDU) amount, + byte amount, drop counters, and error counters. Counters are + useful in debugging and visibility into operational behavior of a + system entity (e.g., NSF). When an NSF data collector asks for + the value of a counter to it, a system entity emits - o a system entity that creates the information + For the utilization of the storage space for accumulated NSF + monitoring data, all of the information MUST provide the general + information (e.g., timestamp) for purging existing records, which is + discussed in Section 5. This document provides a YANG data model in + Section 9 for the important I2NSF monitoring information that should + be retained. All of the information in the data model is considered + important and should be kept permanently as the information might be + useful in many circumstances in the future. The allowed cases for + removing some monitoring information include the following: - o a system entity that retains an aggregation of records + * When the system storage is full to create a fresh record + [RFC4949], the oldest record can be removed. - o an I2NSF Component that includes the capabilities of using - standardized interfaces provided by other system entities that are - not I2NSF Components + * The administrator deletes existing records manually after + analyzing the information in them. - o an I2NSF Component that creates the information + The I2NSF monitoring information retained on a system entity (e.g., + NSF) may be delivered to a corresponding I2NSF User via an NSF data + collector. The information consists of the aggregated records, + typically in the form of log-files or databases. For the NSF + Monitoring Interface to deliver the information to the NSF data + collector, the NSF needs to accommodate standardized delivery + protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. The NSF + data collector can forward the information to the I2NSF User through + one of standardized delivery protocols. The interface for this + delivery is out of the scope of this document. -4.2. Notifications and Events +4.2. Notifications, Events, and Records A specific task of I2NSF User is to process I2NSF Policy Rules. The - rules of a policy are composed of three clauses: Events, Conditions, - and Actions. In consequence, an I2NSF Event is specified to trigger - an I2NSF Policy Rule. Such an I2NSF Event is defined as any + rules of a policy are composed of three clauses: Event, Condition, + and Action clauses. In consequence, an I2NSF Event is specified to + trigger an I2NSF Policy Rule. Such an I2NSF Event is defined as any important occurrence over time in the system being managed, and/or in the environment of the system being managed, which aligns well with the generic definition of Event from [RFC3877]. - The model illustrated in this document introduces a complementary - type of information that can be a conveyed notification. - - Notification: An occurrence of a change of context, composition, - configuration, state or behavior of a system entity that can be - directly or indirectly observed by an I2NSF User and can be used - as input for an event-clause in I2NSF Policy Rules. + Another role of the I2NSF Event is to trigger a notification for + monitoring the status of an NSF. A notification is defined in + [RFC3877] as an unsolicited transmission of management information. + System alarm (called alarm) is defined as a warning related to + service degradation in system hardware in Section 6.1. System event + (called alert) is defined as a warning about any changes of + configuration, any access violation, the information of sessions and + traffic flows in Section 6.2. Both an alarm and an alert are I2NSF + Events that can be delivered as a notification. The model + illustrated in this document introduces a complementary type of + information that can be a conveyed notification. - A notification is similar to an I2NSF Event with the exception - that it is created by a system entity that is not an I2NSF - Component and that its importance is yet to be assessed. - Semantically, a notification is not an I2NSF Event in the context - of I2NSF, although they can potentially use the exact same - information or data model. In respect to [RFC3877], a - Notification is a specific subset of events, because they convey - information about something that happens as a thing of of - interest. In consequence, Notifications may contain information - with very low expressiveness or relevance. Hence, additional - post-processing functions, such as aggregation, correlation or - simple anomaly detection, might have to be employed to satisfy a - level of expressiveness that is required for an event-clause of an - I2NSF Policy Rule. + In I2NSF monitoring, a notification is used to deliver either an + event and a record via the I2NSF Monitoring Interface. The + difference between the event and record is the timing by which the + notifications are emitted. An event is emitted as soon as it happens + in order to notify an NSF Data Collector of the problem that needs + immediate attention. A record is not emitted immediately to the NSF + Data Collector, and it can be emitted periodically to the NSF Data + Collector every certain time interval. - It is important to note that the consumer of a notification (the - observer) assesses the importance of a notification and not the - producer. The producer can include metadata in a notification that - supports the observer in assessing the importance (even metadata - about severity), but the deciding entity is an I2NSF User. + It is important to note that an NSF Data Collector as a consumer + (i.e., observer) of a notification assesses the importance of the + notification rather than an NSF as a producer. The producer can + include metadata in a notification that supports the observer in + assessing its importance (e.g., severity). 4.3. Unsolicited Poll and Solicited Push The freshness of the monitored information depends on the acquisition method. Ideally, an I2NSF User is accessing every relevant information about the I2NSF Component and is emitting I2NSF Events to - an NSF data collector (e.g., Security Controller and NSF data - analyzer) in a timely manner. Publication of events via a pubsub/ - broker model, peer-2-peer meshes, or static defined channels are only - a few examples on how a solicited push of I2NSF Events can be - facilitated. The actual mechanic implemented by an I2NSF Component - is out of the scope of this document. + an NSF data collector (e.g., Security Controller) in a timely manner. + Publication of events via a pubsub/broker model, peer-2-peer meshes, + or static defined channels are only a few examples on how a solicited + push of I2NSF Events can be facilitated. The actual mechanism + implemented by an I2NSF Component is out of the scope of this + document. Often, the corresponding management interfaces have to be queried in - intervals or on-demand if required by an I2NSF Policy rule. In some - cases, a collection of information has to be conducted via login - mechanics provided by a system entity. Accessing records of + intervals or on demand if required by an I2NSF Policy rule. In some + cases, the collection of information has to be conducted via a login + mechanism provided by a system entity. Accessing records of information via this kind of unsolicited polls can introduce a significant latency in regard to the freshness of the monitored information. The actual definition of intervals implemented by an I2NSF Component is also out of scope of this document. -4.4. I2NSF Monitoring Terminology for Retained Information - - Records: Unlike information emitted via notifications and events, - records do not require immediate attention from an analyst but may - be useful for visibility and retroactive cyber forensic. - Depending on the record format, there are different qualities in - regard to structure and detail. Records are typically stored in - log-files or databases on a system entity or NSF. Records in the - form of log-files usually include less structures but potentially - more detailed information in regard to the changes of a system - entity's characteristics. In contrast, databases often use more - strict schemas or data models, therefore enforcing a better - structure. However, they inhibit storing information that do not - match those models ("closed world assumption"). Records can be - continuously processed by I2NSF Agents that act as I2NSF Producer - and emit events via functions specifically tailored to a certain - type of record. Typically, records are information generated - either by an NSF or a system entity about operational and - informational data, or various changes in system characteristics, - such as user activities, network/traffic status, and network - activity. They are important for debugging, auditing and security - forensic. - - Counters: A specific representation of continuous value changes of - information elements that potentially occur in high frequency. - Prominent example are network interface counters, e.g., PDU amount - or byte amount, drop counters, and error counters. Counters are - useful in debugging and visibility into operational behavior of an - NSF. An I2NSF Agent that observes the progression of counters can - act as an I2NSF Producer and emit events in respect to I2NSF - Policy Rules. - -5. Conveyance of NSF Monitoring Information - - As per the use cases of NSF monitoring data, information needs to be - conveyed to various I2NSF Consumers based on requirements imposed by - I2NSF Capabilities and workflows. There are multiple aspects to be - considered in regard to the emission of monitoring information to - requesting parties as listed below: +5. Basic Information Model for Monitoring Data - o Pull-Push Model: A set of data can be pushed by an NSF to a - requesting party or pulled by a requesting party from an NSF. - Specific types of information might need both the models at the - same time if there are multiple I2NSF Consumers with varying - requirements. In general, any I2NSF Event including a high - severity assessment is considered to be of great importance and - should be processed as soon as possible (push-model). Records, in - contrast, are typically not as critical (pull-model). The I2NSF - Architecture does not mandate a specific scheme for each type of - information and is therefore out of scope of this document. + As explained in the above section, there is a wealth of data + available from the NSF that can be monitored. Firstly, there must be + some general information with each monitoring message sent from an + NSF that helps a consumer to identify meta data with that message, + which are listed as below: - o Pub-Sub Model: In order for an I2NSF Provider to push monitoring - information to multiple appropriate I2NSF Consumers, a - subscription can be maintained by both I2NSF Components. - Discovery of available monitoring information can be supported by - an I2NSF Controller that takes the role of a broker and therefore - includes I2NSF Capabilities that support registration. + * message: The extra detail to give the context of the information. - o Export Frequency: Monitoring information can be emitted - immediately upon generation by an NSF to requesting I2NSF - Consumers or can be pushed periodically. The frequency of - exporting the data depends upon its size and timely usefulness. - It is out of the scope of I2NSF and left to each NSF - implementation. + * vendor-name: The name of the NSF vendor. - o Authentication: There may be a need for authentication between an - I2NSF Producer of monitoring information and its corresponding - I2NSF Consumer to ensure that critical information remains - confidential. Authentication in the scope of I2NSF can also - require its corresponding content authorization. This may be - necessary, for example, if an NSF emits monitoring information to - an I2NSF Consumer outside its administrative domain. The I2NSF - Architecture does not mandate when and how specific authentication - has to be implemented. + * nsf-name: The name or IP address of the NSF generating the + message. If the given nsf-name is not an IP address, the name can + be an arbitrary string including FQDN (Fully Qualified Domain + Name). The name MUST be unique for different NSFs to identify the + NSF that generates the message. - o Data-Transfer Model: Monitoring information can be pushed by an - NSF using a connection-less model that does require a persistent - connection or streamed over a persistent connection. An - appropriate model depends on the I2NSF Consumer requirements and - the semantics of the information to be conveyed. + * severity: It indicates the severity level. There are total four + levels, i.e., critical, high, middle, and low. - o Data Model and Interaction Model for Data in Motion: There are a - lot of transport mechanisms such as IP, UDP, and TCP. There are - also open source implementations for specific set of data such as - systems counter, e.g. IPFIX [RFC7011] and NetFlow [RFC3954]. The - I2NSF does not mandate any specific method for a given data set, - so it is up to each implementation. + * timestamp: Indicates the time when the message is generated. For + the notification operations (i.e., System Alarms, System Events, + NSF Events, System Logs, and NSF Logs), this is represented by the + eventTime of NETCONF event notification [RFC5277] For other + operations (i.e., System Counter and NSF Counter), the timestamp + MUST be provided separately. -5.1. Information Types and Acquisition Methods +6. Extended Information Model for Monitoring Data - In this document, most defined information types defined benefit from - high visibility with respect to value changes, e.g., alarms and - records. In contrast, values that change monotonically in a - continuous way do not benefit from this high visibility. On the - contrary, emitting each change would result in a useless amount of - value updates. Hence, values, such as counter, are best acquired in - periodic intervals. + This section covers the additional information associated with the + system messages. The extended information model is only for the + structured data such as events, record, and counters. Any + unstructured data is specified with the basic information model only. - The mechanisms provided by YANG Push [I-D.ietf-netconf-yang-push] and - YANG Subscribed Notifications - [I-D.ietf-netconf-subscribed-notifications] address exactly these set - of requirements. YANG also enables semantically well-structured - information, as well as subscriptions to datastores or event streams - - by changes or periodically. + Each information has characteristics as follows: - In consequence, this information model in this document is intended - to support data models used in solicited or unsolicited event streams - that potentially are facilitated by a subscription mechanism. A - subset of information elements defined in the information model - address this domain of application. + * Acquisition method: The method to obtain the message. It can be a + "query" or a "subscription". A "query" is a request-based method + to acquire the solicited information. A "subscription" is a + subscribe-based method to acquire the unsolicited information. -6. Basic Information Model for All Monitoring Data + * Emission type: The cause type for the message to be emitted. It + can be "on-change" or "periodic". An "on-change" message is + emitted when an important event happens in the NSF. A "periodic" + message is emitted at a certain time interval. The time to + periodically emit the message is configurable. - As explained in the above section, there is a wealth of data - available from the NSF that can be monitored. Firstly, there must be - some general information with each monitoring message sent from an - NSF that helps a consumer to identify meta data with that message, - which are listed as below: + * Dampening type: The type of message dampening to stop the rapid + transmission of messages. The dampening types are "on-repetition" + and "no-dampening". The "on-repetition" type limits the + transmitted "on-change" message to one message at a certain + interval. This interval is defined as dampening-period in + [RFC8641]. The dampening-period is configurable. The "no- + dampening" type does not limit the transmission for the messages + of the same type. In short, "on-repetition" means that the + dampening is active and "no-dampening" is inactive. It is + recommended to activate the dampening for an "on-change" type of + message to reduce the number of messages generated. - o message: Event, Alert, Alarm, Log, Counter, etc. +6.1. System Alarms - o vendor-name: The name of the NSF vendor. + System alarms have the following characteristics: - o nsf-name: The name (or IP) of the NSF generating the message. + * acquisition-method: subscription - o severity: It indicates the severity level. There are total four - levels, from 0 to 3. The smaller the numeral is, the higher the - severity is. + * emission-type: on-change -7. Extended Information Model for Monitoring Data + * dampening-type: on-repetition - This section covers the additional information associated with the - system messages. The extended information model is only for the - structured data such as alarm. Any unstructured data is specified - with basic information model only. +6.1.1. Memory Alarm -7.1. System Alarms + The memory is the hardware to store information temporarily or for a + short period, i.e., Random Access Memory (RAM). The memory-alarm is + emitted when the RAM usage exceeds the threshold. The following + information should be included in a Memory Alarm: - Characteristics: + * event-name: memory-alarm. - o acquisition-method: subscription + * usage: specifies the size of memory used. - o emission-type: on-change + * threshold: The threshold triggering the alarm - o dampening-type: on-repetition + * severity: The severity of the alarm such as critical, high, + medium, and low. -7.1.1. Memory Alarm + * message: Simple information such as "The memory usage exceeded the + threshold" or with extra information. - The following information should be included in a Memory Alarm: +6.1.2. CPU Alarm - o event-name: mem-usage-alarm + CPU is the Central Processing Unit that executes basic operations of + the system. The cpu-alarm is emitted when the CPU usage exceeds the + threshold. The following information should be included in a CPU + Alarm: - o usage: specifies the size of memory used. + * event-name: cpu-alarm. - o threshold: The threshold triggering the alarm + * usage: Specifies the size of CPU used. - o severity: The severity of the alarm such as critical, high, - medium, low + * threshold: The threshold triggering the event. - o message: The memory usage exceeded the threshold + * severity: The severity of the alarm such as critical, high, + medium, and low. -7.1.2. CPU Alarm + * message: Simple information such as "The CPU usage exceeded the + threshold" or with extra information. - The following information should be included in a CPU Alarm: +6.1.3. Disk Alarm - o event-name: cpu-usage-alarm + Disk is the hardware to store information for a long period, i.e., + Hard Disk or Solid-State Drive. The disk-alarm is emitted when the + Disk usage exceeds the threshold. The following information should + be included in a Disk Alarm: - o usage: Specifies the size of CPU used. + * event-name: disk-alarm. - o threshold: The threshold triggering the event + * usage: Specifies the size of disk space used. - o severity: The severity of the alarm such as critical, high, - medium, low + * threshold: The threshold triggering the event. - o message: The CPU usage exceeded the threshold. + * severity: The severity of the alarm such as critical, high, + medium, and low. -7.1.3. Disk Alarm + * message: Simple information such as "The disk usage exceeded the + threshold" or with extra information. - The following information should be included in a Disk Alarm: +6.1.4. Hardware Alarm - o event-name: disk-usage-alarm + The hardware-alarm is emitted when a hardware, e.g., CPU, memory, + disk, or interface, problem is detected. The following information + should be included in a Hardware Alarm: - o usage: Specifies the size of disk space used. + * event-name: hardware-alarm. - o threshold: The threshold triggering the event + * component-name: It indicates the hardware component responsible + for generating this alarm. - o severity: The severity of the alarm such as critical, high, - medium, low + * severity: The severity of the alarm such as critical, high, + medium, and low. - o message: The disk usage exceeded the threshold. + * message: Simple information such as "The hardware component has + failed or degraded" or with extra information. -7.1.4. Hardware Alarm +6.1.5. Interface Alarm - The following information should be included in a Hardware Alarm: + Interface is the network interface for connecting a device with the + network. The interface-alarm is emitted when the state of the + interface is changed. The following information should be included + in an Interface Alarm: - o event-name: hw-failure-alarm + * event-name: interface-alarm. - o component-name: It indicates the HW component responsible for - generating this alarm. + * interface-name: The name of the interface. - o severity: The severity of the alarm such as critical, high, - medium, low + * interface-state: down, up (not congested), congested (up but + congested). - o message: The HW component has failed or degraded. + * severity: The severity of the alarm such as critical, high, + medium, and low. -7.1.5. Interface Alarm + * message: Simple information such as "The interface is 'interface- + state'" or with extra information. - The following information should be included in an Interface Alarm: +6.2. System Events - o event-name: ifnet-state-alarm + System events (as alerts) have the following characteristics: - o interface-name: The name of interface + * acquisition-method: subscription - o interface-state: up, down, congested + * emission-type: on-change - o threshold: The threshold triggering the event + * dampening-type: on-repetition - o severity: The severity of the alarm such as critical, high, - medium, low +6.2.1. Access Violation - o message: Current interface state + The access-violation system event is an event when a user tries to + access (read or write) any information above their privilege. The + following information should be included in this event: -7.2. System Events + * event-name: access-denied. - Characteristics: + * user: Name of a user. - o acquisition-method: subscription + * group: Group(s) to which a user belongs. A user can belong to + multiple groups. - o emission-type: on-change + * ip-address: The IP address of the user that triggered the event. - o dampening-type: on-repetition + * authentication: The method to verify the valid user, i.e., pre- + configured-key and certificate-authority. -7.2.1. Access Violation + * message: The message to give the context of the event, such as + "Access is denied". - The following information should be included in this event: +6.2.2. Configuration Change - o event-name: access-denied + A configuration change is a system event when a new configuration is + added or an existing configuration is modified. The following + information should be included in this event: - o user: Name of a user + * event-name: config-change. - o group: Group to which a user belongs + * user: Name of a user. - o login-ip-address: Login IP address of a user + * group: Group(s) to which a user belongs. A user can belong to + multiple groups. - o authentication: User authentication mode. e.g., Local - Authentication, Third-Party Server Authentication, Authentication - Exemption, Single Sign-On (SSO) Authentication + * ip-address: The IP address of the user that triggered the event. - o message: access is denied. + * authentication: The method to verify the valid user, i.e., pre- + configured-key and certificate-authority. -7.2.2. Configuration Change + * message: The message to give the context of the event, such as + "Configuration is modified" or "New configuration is added". - The following information should be included in this event: +6.2.3. Session Table Event - o event-name: config-change + The following information should be included in a Session + Table Event: - o user: Name of a user + * event-name: session-table. - o group: Group to which a user belongs + * current-session: The number of concurrent sessions. - o login-ip-address: Login IP address of a user + * maximum-session: The maximum number of sessions that the session + table can support. - o authentication: User authentication mode. e.g., Local - Authentication, Third-Party Server Authentication, Authentication - Exemption, SSO Authentication + * threshold: The threshold triggering the event. - o message: Configuration is modified. + * message: The message to give the context of the event, such as + "The number of session table exceeded the threshold". -7.2.3. Traffic flows +6.2.4. Traffic Flows - The following information should be included in this event: + Traffic flows need to be monitored because they might be used for + security attacks to the network. The following information should be + included in this event: - o src-ip: The source IPv4 or IPv6 address of the flows + * src-ip: The source IPv4 or IPv6 address of the traffic flow. - o dst-ip: The destination IPv4 or IPv6 address of the flows + * dst-ip: The destination IPv4 or IPv6 address of the traffic flow. - o src-port: The source port of the flows + * src-port: The source port of the traffic flow. - o dst-port: The destination port of the flows + * dst-port: The destination port of the traffic flow. - o protocol: The protocol of the packet flows. + * protocol: The protocol of the traffic flow. - o arrival-rate: Arrival rate of the same flow. + * arrival-rate: Arrival rate of packets of the traffic flow. -7.3. NSF Events +6.3. NSF Events - Characteristics: + NSF events have the following characteristics: - o acquisition-method: subscription + * acquisition-method: subscription - o emission-type: on-change + * emission-type: on-change - o dampening-type: on-repetition + * dampening-type: on-repetition -7.3.1. DDoS Detection +6.3.1. DDoS Detection The following information should be included in a DDoS Event: - o event-name: detection-ddos + * event-name: detection-ddos. - o attack-type: Any one of SYN flood, ACK flood, SYN-ACK flood, FIN/ + * attack-type: Any one of SYN flood, ACK flood, SYN-ACK flood, FIN/ RST flood, TCP Connection flood, UDP flood, ICMP flood, HTTPS flood, HTTP flood, DNS query flood, DNS reply flood, SIP flood, - and etc. + SSL flood, and NTP amplification flood. - o dst-ip: The IP address of a victim under attack + * attack-src-ip: The IP address of the source of the DDoS attack. - o dst-port: The port number that the attack traffic aims at. + * attack-dst-ip: The network prefix with a network mask (for IPv4) + or prefix length (for IPv6) of a victim under DDoS attack. - o start-time: The time stamp indicating when the attack started + * dst-port: The port number that the attack traffic aims at. - o end-time: The time stamp indicating when the attack ended. If the + * start-time: The time stamp indicating when the attack started. + + * end-time: The time stamp indicating when the attack ended. If the attack is still undergoing when sending out the alarm, this field can be empty. - o attack-rate: The PPS of attack traffic - o attack-speed: the bps of attack traffic - - o rule-name: The name of the rule being triggered - - o profile: Security profile that traffic matches. - -7.3.2. Session Table Event - - The following information should be included in a Session - Table Event: - - o event-name: session-table - - o current-session: The number of concurrent sessions - - o maximum-session: The maximum number of sessions that the session - table can support + * attack-rate: The packets per second of attack traffic. - o threshold: The threshold triggering the event + * attack-speed: the bits per second of attack traffic. - o message: The number of session table exceeded the threshold. + * rule-name: The name of the I2NSF Policy Rule being triggered. + Note that rule-name is used to match a detected NSF event with a + policy rule in [I-D.ietf-i2nsf-nsf-facing-interface-dm], and also + that there is no rule-name in a system event. -7.3.3. Virus Event +6.3.2. Virus Event The following information should be included in a Virus Event: - o event-name: detection-virus + * event-name: detection-virus. - o virus: Type of the virus. e.g., trojan, worm, macro virus type + * virus: Type of the virus. e.g., trojan, worm, macro virus type. - o virus-name: Name of the virus + * virus-name: Name of the virus. - o dst-ip: The destination IP address of the packet where the virus - is found + * dst-ip: The destination IP address of the packet where the virus + is found. - o src-ip: The source IP address of the packet where the virus is - found + * src-ip: The source IP address of the packet where the virus is + found. - o src-port: The source port of the packet where the virus is found + * src-port: The source port of the packet where the virus is found. - o dst-port: The destination port of the packet where the virus is - found + * dst-port: The destination port of the packet where the virus is + found. - o src-zone: The source security zone of the packet where the virus - is found + * src-zone: The source geographical location (e.g., country and + city) of the virus. - o dst-zone: The destination security zone of the packet where the - virus is found + * dst-zone: The destination geographical location (e.g., country and + city) of the virus. - o file-type: The type of the file where the virus is hided within + * file-type: The type of the file where the virus is hided within. - o file-name: The name of the file where the virus is hided within + * file-name: The name of the file where the virus is hided within. - o raw_info: The information describing the packet triggering the + * raw-info: The information describing the packet triggering the event. - o rule_name: The name of the rule being triggered + * rule-name: The name of the rule being triggered. -7.3.4. Intrusion Event +6.3.3. Intrusion Event The following information should be included in an Intrusion Event: - o event-name: The name of event. e.g., detection-intrusion - - o attack-type: Attack type, e.g., brutal force and buffer overflow - - o src-ip: The source IP address of the packet - - o dst-ip: The destination IP address of the packet - - o src-port:The source port number of the packet - - o dst-port: The destination port number of the packet - - o src-zone: The source security zone of the packet - - o dst-zone: The destination security zone of the packet - - o protocol: The employed transport layer protocol. e.g.,TCP and UDP + * event-name: The name of the event. e.g., detection-intrusion. - o app: The employed application layer protocol. e.g.,HTTP and FTP + * attack-type: Attack type, e.g., brutal force and buffer overflow. - o rule-name: The name of the rule being triggered + * src-ip: The source IP address of the flow. - o raw-info: The information describing the packet triggering the - event + * dst-ip: The destination IP address of the flow. -7.3.5. Botnet Event + * src-port:The source port number of the flow. - The following information should be included in a Botnet Event: + * dst-port: The destination port number of the flow - o event-name: The name of event. e.g., detection-botnet + * src-zone: The source geographical location (e.g., country and + city) of the flow. - o botnet-name: The name of the detected botnet + * dst-zone: The destination geographical location (e.g., country and + city) of the flow. - o src-ip: The source IP address of the packet - o dst-ip: The destination IP address of the packet + * protocol: The employed transport layer protocol. e.g., TCP and + UDP. - o src-port: The source port number of the packet + * app: The employed application layer protocol. e.g., HTTP and FTP. - o dst-port: The destination port number of the packet + * rule-name: The name of the I2NSF Policy Rule being triggered. - o src-zone: The source security zone of the packet + * raw-info: The information describing the flow triggering the + event. - o dst-zone: The destination security zone of the packet +6.3.4. Web Attack Event - o protocol: The employed transport layer protocol. e.g.,TCP and UDP + The following information should be included in a Web Attack Alarm: - o role: The role of the communicating parties within the botnet: + * event-name: The name of event. e.g., detection-web-attack. - 1. The packet from the zombie host to the attacker + * attack-type: Concrete web attack type. e.g., SQL injection, + command injection, XSS, CSRF. - 2. The packet from the attacker to the zombie host + * src-ip: The source IP address of the packet. - 3. The packet from the IRC/WEB server to the zombie host + * dst-ip: The destination IP address of the packet. - 4. The packet from the zombie host to the IRC/WEB server + * src-port: The source port number of the packet. - 5. The packet from the attacker to the IRC/WEB server + * dst-port: The destination port number of the packet. - 6. The packet from the IRC/WEB server to the attacker + * src-zone: The source geographical location (e.g., country and + city) of the packet. - 7. The packet from the zombie host to the victim + * dst-zone: The destination geographical location (e.g., country and + city) of the packet. - o rule-name: The name of the rule being triggered + * request-method: The method of requirement. For instance, "PUT" + and "GET" in HTTP. - o raw-info: The information describing the packet triggering the - event. + * req-uri: Requested URI. -7.3.6. Web Attack Event + * response-code: The HTTP Response code. - The following information should be included in a Web Attack Alarm: + * req-user-agent: The HTTP request user agent header field. - o event-name: The name of event. e.g., detection-web-attack + * req-cookies: The HTTP Cookie previously sent by the server with + Set-Cookie. - o attack-type: Concrete web attack type. e.g., SQL injection, - command injection, XSS, CSRF + * req-host: The domain name of the requested host. - o src-ip: The source IP address of the packet + * uri-category: Matched URI category. - o dst-ip: The destination IP address of the packet + * filtering-type: URL filtering type. e.g., deny-list, allow-list, + and unknown. - o src-port: The source port number of the packet - o dst-port: The destination port number of the packet + * rule-name: The name of the I2NSF Policy Rule being triggered. - o src-zone: The source security zone of the packet +6.3.5. VoIP/VoLTE Event - o dst-zone: The destination security zone of the packet + The following information should be included in a VoIP/VoLTE Event: - o request-method: The method of requirement. For instance, "PUT" - and "GET" in HTTP + * source-voice-id: The detected source voice Call ID for VoIP and + VoLTE that violates the policy. - o req-uri: Requested URI + * destination-voice-id: The destination voice Call ID for VoIP and + VoLTE that violates the policy. - o rsp-code: Response code + * user-agent: The user agent for VoIP and VoLTE that violates the + policy. - o req-clientapp: The client application + * src-ip: The source IP address of the VoIP/VoLTE. - o req-cookies: Cookies + * dst-ip: The destination IP address of the VoIP/VoLTE. - o req-host: The domain name of the requested host + * src-port: The source port number of the VoIP/VoLTE. - o uri-category: Matched URI category + * dst-port: The destination port number of VoIP/VoLTE. - o filtering-type: URL filtering type. e.g., Blacklist, Whitelist, - User-Defined, Predefined, Malicious Category, and Unknown + * src-zone: The source geographical location (e.g., country and + city) of the VoIP/VoLTE. - o rule-name: The name of the rule being triggered + * dst-zone: The destination geographical location (e.g., country and + city) of the VoIP/VoLTE. - o profile: Security profile that traffic matches + * rule-name: The name of the I2NSF Policy Rule being triggered. -7.4. System Logs +6.4. System Logs - Characteristics: + System log is a record that is used to monitor the activity of the + user on the NSF and the status of the NSF. System logs have the + following characteristics: - o acquisition-method: subscription + * acquisition-method: subscription - o emission-type: on-change + * emission-type: on-change or periodic - o dampening-type: on-repetition + * dampening-type: on-repetition -7.4.1. Access Log +6.4.1. Access Log Access logs record administrators' login, logout, and operations on a device. By analyzing them, security vulnerabilities can be identified. The following information should be included in an operation report: - o Administrator: Administrator that operates on the device + * username: The username that operates on the device. - o login-ip-address: IP address used by an administrator to log in - o login-mode: Specifies the administrator logs in mode e.g. root, - user + * login-ip: IP address used by an administrator to log in. - o operation-type: The operation type that the administrator execute, - e.g., login, logout, and configuration. + * login-mode: Specifies the administrator logs in mode e.g. + administrator, user, and guest. - o result: Command execution result + * operation-type: The operation type that the administrator execute, + e.g., login, logout, configuration, and other. - o content: Operation performed by an administrator after login. + * input: The operation performed by a user after login. The + operation is a command given by a user. -7.4.2. Resource Utilization Log + * output: The result after executing the input. + +6.4.2. Resource Utilization Log Running reports record the device system's running status, which is useful for device monitoring. The following information should be included in running report: - o system-status: The current system's running status + * system-status: The current system's running status. - o cpu-usage: Specifies the CPU usage. + * cpu-usage: Specifies the aggregated CPU usage. - o memory-usage: Specifies the memory usage. + * memory-usage: Specifies the memory usage. - o disk-usage: Specifies the disk usage. + * disk-id: Specifies the disk ID to identify the storage disk. - o disk-left: Specifies the available disk space left. + * disk-usage: Specifies the disk usage of disk-id. - o session-number: Specifies total concurrent sessions. + * disk-left: Specifies the available disk space left of disk-id. - o process-number: Specifies total number of systems processes. + * session-number: Specifies total concurrent sessions. - o in-traffic-rate: The total inbound traffic rate in pps + * process-number: Specifies total number of systems processes. - o out-traffic-rate: The total outbound traffic rate in pps + * interface-id: Specifies the interface ID to identify the network + interface. - o in-traffic-speed: The total inbound traffic speed in bps + * in-traffic-rate: The total inbound traffic rate in packets per + second. - o out-traffic-speed: The total outbound traffic speed in bps + * out-traffic-rate: The total outbound traffic rate in packets per + second. -7.4.3. User Activity Log + * in-traffic-speed: The total inbound traffic speed in bits per + second. + + * out-traffic-speed: The total outbound traffic speed in bits per + second. + +6.4.3. User Activity Log User activity logs provide visibility into users' online records (such as login time, online/lockout duration, and login IP addresses) and the actions that users perform. User activity reports are helpful to identify exceptions during a user's login and network access activities. - o user: Name of a user - o group: Group to which a user belongs + * user: Name of a user. - o login-ip-addr: Login IP address of a user + * group: Group to which a user belongs. - o authentication: User authentication mode. e.g., Local - Authentication, Third-Party Server Authentication, Authentication - Exemption, SSO Authentication + * login-ip-addr: Login IP address of a user. - o access: User access mode. e.g., PPP, SVN, LOCAL + * authentication: The method to verify the valid user, i.e., pre- + configured-key and certificate-authority. - o online-duration: Online duration + * online-duration: The duration of a user's activeness (stays in + login) during a session. - o logout-duration: Logout duration + * logout-duration: The duration of a user's inactiveness (not in + login) from the last session. - o additional-info: Additional Information for login: + * additional-info: Additional Information for login: 1. type: User activities. e.g., Successful User Login, Failed Login attempts, User Logout, Successful User Password Change, - Failed User Password Change, User Lockout, User Unlocking, - Unknown - - 2. cause: Cause of a failed user activity - -7.5. NSF Logs - - Characteristics: - - o acquisition-method: subscription - - o emission-type: on-change - - o dampening-type: on-repetition - -7.5.1. DPI Log - - DPI Logs provide statistics on uploaded and downloaded files and - data, sent and received emails, and alert and block records on - websites. It is helpful to learn risky user behaviors and why access - to some URLs is blocked or allowed with an alert record. - - o attack-type: DPI action types. e.g., File Blocking, Data - Filtering, and Application Behavior Control - - o src-user: User source who generates the policy - - o policy-name: Security policy name that traffic matches - o action: Action defined in the file blocking rule, data filtering - rule, or application behavior control rule that traffic matches. + Failed User Password Change, User Lockout, and User Unlocking. -7.5.2. Vulnerability Scanning Log + 2. cause: Cause of a failed user activity. - Vulnerability scanning logs record the victim host and its related - vulnerability information that should to be fixed. The following - information should be included in the report: +6.5. NSF Logs - o victim-ip: IP address of the victim host which has vulnerabilities + NSF logs have the folowing characteristics: - o vulnerability-id: The vulnerability id + * acquisition-method: subscription - o level: The vulnerability level. e.g., high, middle, and low + * emission-type: on-change - o OS: The operating system of the victim host + * dampening-type: on-repetition - o service: The service which has vulnerability in the victim host +6.5.1. Deep Packet Inspection Log - o protocol: The protocol type. e.g., TCP and UDP + Deep Packet Inspection (DPI) Logs provide statistics on uploaded and + downloaded files and data, sent and received emails, and alert and + blocking records on websites. It is helpful to learn risky user + behaviors and why access to some URLs is blocked or allowed with an + alert record. - o port-num: The port number + * attack-type: DPI action types. e.g., File Blocking, Data + Filtering, and Application Behavior Control. - o vulnerability-info: The information about the vulnerability + * src-user: User source who generates the policy. - o fix-suggestion: The fix suggestion to the vulnerability. + * policy-name: Security policy name that traffic matches. -7.6. System Counter + * action: Action defined in the file blocking rule, data filtering + rule, or application behavior control rule that traffic matches. - Characteristics: +6.6. System Counter - o acquisition-method: subscription or query + System counter has the following characteristics: - o emission-type: periodical + * acquisition-method: subscription or query + * emission-type: periodic - o dampening-type: none + * dampening-type: none -7.6.1. Interface Counter +6.6.1. Interface Counter Interface counters provide visibility into traffic into and out of an - NSF, and bandwidth usage. + NSF, and bandwidth usage. The statistics of the interface counters + should be computed from the start of the service. When the service + is reset, the computation of statistics per counter should restart + from 0. - o interface-name: Network interface name configured in NSF + * interface-name: Network interface name configured in NSF. - o in-total-traffic-pkts: Total inbound packets + * in-total-traffic-pkts: Total inbound packets. - o out-total-traffic-pkts: Total outbound packets - o in-total-traffic-bytes: Total inbound bytes + * out-total-traffic-pkts: Total outbound packets. - o out-total-traffic-bytes: Total outbound bytes + * in-total-traffic-bytes: Total inbound bytes. - o in-drop-traffic-pkts: Total inbound drop packets + * out-total-traffic-bytes: Total outbound bytes. - o out-drop-traffic-pkts: Total outbound drop packets + * in-drop-traffic-pkts: Total inbound drop packets. - o in-drop-traffic-bytes: Total inbound drop bytes + * out-drop-traffic-pkts: Total outbound drop packets. - o out-drop-traffic-bytes: Total outbound drop bytes + * in-drop-traffic-bytes: Total inbound drop bytes. - o in-traffic-average-rate: Inbound traffic average rate in pps + * out-drop-traffic-bytes: Total outbound drop bytes. - o in-traffic-peak-rate: Inbound traffic peak rate in pps + * in-traffic-average-rate: Inbound traffic average rate in packets + per second. - o in-traffic-average-speed: Inbound traffic average speed in bps + * in-traffic-peak-rate: Inbound traffic peak rate in packets per + second. - o in-traffic-peak-speed: Inbound traffic peak speed in bps + * in-traffic-average-speed: Inbound traffic average speed in bits + per second. - o out-traffic-average-rate: Outbound traffic average rate in pps + * in-traffic-peak-speed: Inbound traffic peak speed in bits per + second. - o out-traffic-peak-rate: Outbound traffic peak rate in pps + * out-traffic-average-rate: Outbound traffic average rate in packets + per second. - o out-traffic-average-speed: Outbound traffic average speed in bps + * out-traffic-peak-rate: Outbound traffic peak rate in packets per + second. - o out-traffic-peak-speed: Outbound traffic peak speed in bps + * out-traffic-average-speed: Outbound traffic average speed in bits + per second. -7.7. NSF Counters + * out-traffic-peak-speed: Outbound traffic peak speed in bits per + second. - Characteristics: +6.7. NSF Counters - o acquisition-method: subscription or query + NSF counters have the following characteristics: - o emission-type: periodical + * acquisition-method: subscription or query - o dampening-type: none + * emission-type: periodic -7.7.1. Firewall Counter + * dampening-type: none + +6.7.1. Firewall Counter Firewall counters provide visibility into traffic signatures, bandwidth usage, and how the configured security and bandwidth policies have been applied. - o src-zone: Source security zone of traffic - - o dst-zone: Destination security zone of traffic - o src-region: Source region of traffic - - o dst-region: Destination region of traffic - - o src-ip: Source IP address of traffic + * src-ip: Source IP address of traffic. - o src-user: User who generates traffic + * src-user: User who generates the policy. - o dst-ip: Destination IP address of traffic + * dst-ip: Destination IP address of traffic. - o src-port: Source port of traffic + * src-port: Source port of traffic. - o dst-port: Destination port of traffic + * dst-port: Destination port of traffic. - o protocol: Protocol type of traffic + * protocol: Protocol type of traffic. - o app: Application type of traffic + * app: Application type of traffic. - o policy-id: Security policy id that traffic matches + * policy-id: Security policy id that traffic matches. - o policy-name: Security policy name that traffic matches + * policy-name: Security policy name that traffic matches. - o in-interface: Inbound interface of traffic + * in-interface: Inbound interface of traffic. - o out-interface: Outbound interface of traffic + * out-interface: Outbound interface of traffic. - o total-traffic: Total traffic volume + * total-traffic: Total traffic volume. - o in-traffic-average-rate: Inbound traffic average rate in pps + * in-traffic-average-rate: Inbound traffic average rate in packets + per second. - o in-traffic-peak-rate: Inbound traffic peak rate in pps + * in-traffic-peak-rate: Inbound traffic peak rate in packets per + second. - o in-traffic-average-speed: Inbound traffic average speed in bps + * in-traffic-average-speed: Inbound traffic average speed in bits + per second. - o in-traffic-peak-speed: Inbound traffic peak speed in bps + * in-traffic-peak-speed: Inbound traffic peak speed in bits per + second. - o out-traffic-average-rate: Outbound traffic average rate in pps + * out-traffic-average-rate: Outbound traffic average rate in packets + per second. - o out-traffic-peak-rate: Outbound traffic peak rate in pps + * out-traffic-peak-rate: Outbound traffic peak rate in packets per + second. - o out-traffic-average-speed: Outbound traffic average speed in bps + * out-traffic-average-speed: Outbound traffic average speed in bits + per second. - o out-traffic-peak-speed: Outbound traffic peak speed in bps. + * out-traffic-peak-speed: Outbound traffic peak speed in bits per + second. -7.7.2. Policy Hit Counter +6.7.2. Policy Hit Counter Policy Hit Counters record the security policy that traffic matches and its hit count. It can check if policy configurations are correct. - o src-zone: Source security zone of traffic - - o dst-zone: Destination security zone of traffic - - o src-region: Source region of the traffic - - o dst-region: Destination region of the traffic - - o src-ip: Source IP address of traffic + * src-ip: Source IP address of traffic. - o src-user: User who generates traffic + * src-user: User who generates the policy. - o dst-ip: Destination IP address of traffic + * dst-ip: Destination IP address of traffic. - o src-port: Source port of traffic + * src-port: Source port of traffic. - o dst-port: Destination port of traffic + * dst-port: Destination port of traffic. - o protocol: Protocol type of traffic + * protocol: Protocol type of traffic. - o app: Application type of traffic + * app: Application type of traffic. - o policy-id: Security policy id that traffic matches + * policy-id: Security policy id that traffic matches. - o policy-name: Security policy name that traffic matches + * policy-name: Security policy name that traffic matches. - o hit-times: The hit times that the security policy matches the + * hit-times: The hit times that the security policy matches the specified traffic. -8. NSF Monitoring Management in I2NSF +7. NSF Monitoring Management in I2NSF A standard model for monitoring data is required for an administrator to check the monitoring data generated by an NSF. The administrator can check the monitoring data through the following process. When the NSF monitoring data that is under the standard format is generated, the NSF forwards it to an NSF data collector via the I2NSF NSF Monitoring Interface. The NSF data collector delivers it to I2NSF Consumer or Developer's Management System (DMS) so that the administrator can know the state of the I2NSF framework. In order to communicate with other components, an I2NSF framework [RFC8329] requires the interfaces. The three main interfaces in I2NSF framework are used for sending monitoring data as follows: - o I2NSF Consumer-Facing Interface + * I2NSF Consumer-Facing Interface [I-D.ietf-i2nsf-consumer-facing-interface-dm]: When an I2NSF User makes a security policy and forwards it to the Security Controller via Consumer-Facing Interface, it can specify the threat-feed for threat prevention, the custom list, the malicious code scan group, and the event map group. They can be used as an event to be monitored by an NSF. - o I2NSF Registration Interface + * I2NSF Registration Interface [I-D.ietf-i2nsf-registration-interface-dm]: The Network Functions Virtualization (NFV) architecture provides the lifecycle management of a Virtual Network Function (VNF) via the Ve-Vnfm interface. The role of Ve-Vnfm is to request VNF lifecycle management (e.g., the instantiation and de-instantiation of an NSF, and load balancing among NSFs), exchange configuration information, and exchange status information for a network service. In the I2NSF framework, the DMS manages data about resource states and network traffic for the lifecycle management of an NSF. Therefore, the generated monitoring data from NSFs are delivered from the NSF data collector to the DMS via either Registration Interface or a new interface (e.g., NSF Monitoring Interface). These data are delivered from the DMS to the VNF Manager in the Management and Orchestration (MANO) in the NFV system [I-D.ietf-i2nsf-applicability]. - o I2NSF NSF Monitoring Interface [RFC8329]: After a high-level + * I2NSF NSF Monitoring Interface [RFC8329]: After a high-level security policy from I2NSF User is translated by security policy translator [I-D.yang-i2nsf-security-policy-translation] in the Security Controller, the translated security policy (i.e., low- level policy) is applied to an NSF via NSF-Facing Interface. The - monitoring data model for an NSF specifies the list of events that - can trigger Event-Condition-Action (ECA) policies via NSF - Monitoring Interface. + monitoring interface data model for an NSF specifies the list of + events that can trigger Event-Condition-Action (ECA) policies via + NSF Monitoring Interface. -9. Tree Structure +8. Tree Structure The tree structure of the NSF monitoring YANG module is provided below: module: ietf-i2nsf-nsf-monitoring +--ro i2nsf-counters | +--ro system-interface* [interface-name] | | +--ro acquisition-method? identityref | | +--ro emission-type? identityref | | +--ro dampening-type? identityref @@ -1191,386 +1158,357 @@ | | +--ro in-traffic-average-rate? uint32 | | +--ro in-traffic-peak-rate? uint32 | | +--ro in-traffic-average-speed? uint32 | | +--ro in-traffic-peak-speed? uint32 | | +--ro out-traffic-average-rate? uint32 | | +--ro out-traffic-peak-rate? uint32 | | +--ro out-traffic-average-speed? uint32 | | +--ro out-traffic-peak-speed? uint32 | | +--ro message? string | | +--ro vendor-name? string - | | +--ro nsf-name? string + | | +--ro nsf-name? union | | +--ro severity? severity + | | +--ro timestamp? yang:date-and-time | +--ro nsf-firewall* [policy-name] | | +--ro acquisition-method? identityref | | +--ro emission-type? identityref | | +--ro dampening-type? identityref | | +--ro policy-name - -> /nsfi:i2nsf-security-policy/system-policy/system-policy-name + -> /nsfi:i2nsf-security-policy/system-policy-name | | +--ro src-user? string | | +--ro total-traffic? yang:counter32 | | +--ro in-traffic-average-rate? uint32 | | +--ro in-traffic-peak-rate? uint32 | | +--ro in-traffic-average-speed? uint32 | | +--ro in-traffic-peak-speed? uint32 | | +--ro out-traffic-average-rate? uint32 | | +--ro out-traffic-peak-rate? uint32 | | +--ro out-traffic-average-speed? uint32 | | +--ro out-traffic-peak-speed? uint32 | | +--ro message? string | | +--ro vendor-name? string - | | +--ro nsf-name? string + | | +--ro nsf-name? union | | +--ro severity? severity + | | +--ro timestamp? yang:date-and-time | +--ro nsf-policy-hits* [policy-name] | +--ro acquisition-method? identityref | +--ro emission-type? identityref | +--ro dampening-type? identityref | +--ro policy-name - -> /nsfi:i2nsf-security-policy/system-policy/system-policy-name + -> /nsfi:i2nsf-security-policy/system-policy-name | +--ro src-user? string | +--ro message? string | +--ro vendor-name? string - | +--ro nsf-name? string + | +--ro nsf-name? union | +--ro severity? severity | +--ro hit-times? yang:counter32 + | +--ro timestamp? yang:date-and-time +--rw i2nsf-monitoring-configuration +--rw i2nsf-system-detection-alarm | +--rw enabled? boolean | +--rw system-alarm* [alarm-type] | +--rw alarm-type enumeration | +--rw threshold? uint8 | +--rw dampening-period? uint32 +--rw i2nsf-system-detection-event | +--rw enabled? boolean | +--rw dampening-period? uint32 +--rw i2nsf-traffic-flows | +--rw dampening-period? uint32 | +--rw enabled? boolean +--rw i2nsf-nsf-detection-ddos {i2nsf-nsf-detection-ddos}? | +--rw enabled? boolean | +--rw dampening-period? uint32 +--rw i2nsf-nsf-detection-session-table-configuration | +--rw enabled? boolean | +--rw dampening-period? uint32 - +--rw i2nsf-nsf-detection-virus {i2nsf-nsf-detection-virus}? - | +--rw enabled? boolean - | +--rw dampening-period? uint32 +--rw i2nsf-nsf-detection-intrusion {i2nsf-nsf-detection-intrusion}? | +--rw enabled? boolean | +--rw dampening-period? uint32 - +--rw i2nsf-nsf-detection-botnet {i2nsf-nsf-detection-botnet}? - | +--rw enabled? boolean - | +--rw dampening-period? uint32 +--rw i2nsf-nsf-detection-web-attack {i2nsf-nsf-detection-web-attack}? | +--rw enabled? boolean | +--rw dampening-period? uint32 +--rw i2nsf-nsf-system-access-log | +--rw enabled? boolean | +--rw dampening-period? uint32 +--rw i2nsf-system-res-util-log | +--rw enabled? boolean | +--rw dampening-period? uint32 +--rw i2nsf-system-user-activity-log | +--rw enabled? boolean | +--rw dampening-period? uint32 +--rw i2nsf-nsf-log-dpi {i2nsf-nsf-log-dpi}? | +--rw enabled? boolean | +--rw dampening-period? uint32 - +--rw i2nsf-nsf-log-vuln-scan {i2nsf-nsf-log-vuln-scan}? - | +--rw enabled? boolean - | +--rw dampening-period? uint32 +--rw i2nsf-counter +--rw period? uint16 notifications: +---n i2nsf-event | +--ro (sub-event-type)? | +--:(i2nsf-system-detection-alarm) | | +--ro i2nsf-system-detection-alarm | | +--ro alarm-category? identityref | | +--ro component-name? string | | +--ro interface-name? string | | +--ro interface-state? enumeration | | +--ro acquisition-method? identityref | | +--ro emission-type? identityref | | +--ro dampening-type? identityref | | +--ro usage? uint8 | | +--ro threshold? uint8 | | +--ro message? string | | +--ro vendor-name? string - | | +--ro nsf-name? string + | | +--ro nsf-name? union | | +--ro severity? severity | +--:(i2nsf-system-detection-event) | | +--ro i2nsf-system-detection-event | | +--ro event-category? identityref | | +--ro acquisition-method? identityref | | +--ro emission-type? identityref | | +--ro dampening-type? identityref | | +--ro user string - | | +--ro group string - | | +--ro login-ip-addr inet:ip-address + | | +--ro group* string + | | +--ro ip-address inet:ip-address | | +--ro authentication? identityref | | +--ro message? string | | +--ro vendor-name? string - | | +--ro nsf-name? string + | | +--ro nsf-name? union | | +--ro severity? severity | +--:(i2nsf-traffic-flows) | | +--ro i2nsf-traffic-flows | | +--ro src-ip? inet:ip-address | | +--ro dst-ip? inet:ip-address | | +--ro protocol? identityref | | +--ro src-port? inet:port-number | | +--ro dst-port? inet:port-number | | +--ro arrival-rate? uint32 | | +--ro acquisition-method? identityref | | +--ro emission-type? identityref | | +--ro dampening-type? identityref | | +--ro message? string | | +--ro vendor-name? string - | | +--ro nsf-name? string + | | +--ro nsf-name? union | | +--ro severity? severity | +--:(i2nsf-nsf-detection-session-table) | +--ro i2nsf-nsf-detection-session-table | +--ro current-session? uint32 | +--ro maximum-session? uint32 | +--ro threshold? uint32 | +--ro message? string | +--ro vendor-name? string - | +--ro nsf-name? string + | +--ro nsf-name? union | +--ro severity? severity +---n i2nsf-log | +--ro (sub-logs-type)? | +--:(i2nsf-nsf-system-access-log) | | +--ro i2nsf-nsf-system-access-log | | +--ro login-ip inet:ip-address - | | +--ro administrator? string - | | +--ro login-mode? login-mode + | | +--ro username? string + | | +--ro login-role? login-role | | +--ro operation-type? operation-type - | | +--ro result? string - | | +--ro content? string + | | +--ro input? string + | | +--ro output? string | | +--ro acquisition-method? identityref | | +--ro emission-type? identityref | | +--ro dampening-type? identityref | | +--ro message? string | | +--ro vendor-name? string - | | +--ro nsf-name? string + | | +--ro nsf-name? union | | +--ro severity? severity | +--:(i2nsf-system-res-util-log) | | +--ro i2nsf-system-res-util-log - | | +--ro system-status? string + | | +--ro system-status? enumeration | | +--ro cpu-usage? uint8 | | +--ro memory-usage? uint8 - | | +--ro disk-usage? uint8 - | | +--ro disk-left? uint8 - | | +--ro session-num? uint8 - | | +--ro process-num? uint8 - | | +--ro in-traffic-rate? uint32 - | | +--ro out-traffic-rate? uint32 - | | +--ro in-traffic-speed? uint32 - | | +--ro out-traffic-speed? uint32 + | | +--ro disk* [disk-id] + | | | +--ro disk-id string + | | | +--ro disk-usage? uint8 + | | | +--ro disk-left? uint8 + | | +--ro session-num? uint32 + | | +--ro process-num? uint32 + | | +--ro interface* [interface-id] + | | | +--ro interface-id string + | | | +--ro in-traffic-rate? uint32 + | | | +--ro out-traffic-rate? uint32 + | | | +--ro in-traffic-speed? uint32 + | | | +--ro out-traffic-speed? uint32 | | +--ro acquisition-method? identityref | | +--ro emission-type? identityref | | +--ro dampening-type? identityref | | +--ro message? string | | +--ro vendor-name? string - | | +--ro nsf-name? string + | | +--ro nsf-name? union | | +--ro severity? severity | +--:(i2nsf-system-user-activity-log) | +--ro i2nsf-system-user-activity-log | +--ro acquisition-method? identityref | +--ro emission-type? identityref | +--ro dampening-type? identityref | +--ro user string - | +--ro group string - | +--ro login-ip-addr inet:ip-address + | +--ro group* string + | +--ro ip-address inet:ip-address | +--ro authentication? identityref | +--ro message? string | +--ro vendor-name? string - | +--ro nsf-name? string + | +--ro nsf-name? union | +--ro severity? severity - | +--ro access? identityref - | +--ro online-duration? string - | +--ro logout-duration? string - | +--ro additional-info? string + | +--ro online-duration? uint32 + | +--ro logout-duration? uint32 + | +--ro additional-info? enumeration +---n i2nsf-nsf-event +--ro (sub-event-type)? +--:(i2nsf-nsf-detection-ddos) {i2nsf-nsf-detection-ddos}? | +--ro i2nsf-nsf-detection-ddos - | +--ro dst-ip? inet:ip-address - | +--ro dst-port? inet:port-number - | +--ro rule-name - -> /nsfi:i2nsf-security-policy/system-policy/rules/rule-name - | +--ro raw-info? string | +--ro attack-type? identityref | +--ro start-time yang:date-and-time | +--ro end-time yang:date-and-time - | +--ro attack-src-ip? inet:ip-address - | +--ro attack-dst-ip? inet:ip-address + | +--ro attack-src-ip* inet:ip-address + | +--ro attack-dst-ip* inet:ip-prefix + | +--ro attack-src-port* inet:port-number + | +--ro attack-dst-port* inet:port-number + | +--ro rule-name + -> /nsfi:i2nsf-security-policy/rules/rule-name + | +--ro raw-info? string | +--ro attack-rate? uint32 | +--ro attack-speed? uint32 - | +--ro action? log-action + | +--ro action* log-action | +--ro acquisition-method? identityref | +--ro emission-type? identityref | +--ro dampening-type? identityref | +--ro message? string | +--ro vendor-name? string - | +--ro nsf-name? string + | +--ro nsf-name? union | +--ro severity? severity - +--:(i2nsf-nsf-detection-virus) {i2nsf-nsf-detection-virus}? + +--:(i2nsf-nsf-detection-virus) + {i2nsf-nsf-detection-virus}? | +--ro i2nsf-nsf-detection-virus | +--ro dst-ip? inet:ip-address | +--ro dst-port? inet:port-number | +--ro rule-name - -> /nsfi:i2nsf-security-policy/system-policy/rules/rule-name + -> /nsfi:i2nsf-security-policy/rules/rule-name | +--ro raw-info? string | +--ro src-ip? inet:ip-address | +--ro src-port? inet:port-number | +--ro src-zone? string | +--ro dst-zone? string | +--ro virus? identityref | +--ro virus-name? string | +--ro file-type? string | +--ro file-name? string | +--ro os? string - | +--ro action? log-action + | +--ro action* log-action | +--ro acquisition-method? identityref | +--ro emission-type? identityref | +--ro dampening-type? identityref | +--ro message? string | +--ro vendor-name? string - | +--ro nsf-name? string + | +--ro nsf-name? union | +--ro severity? severity +--:(i2nsf-nsf-detection-intrusion) {i2nsf-nsf-detection-intrusion}? | +--ro i2nsf-nsf-detection-intrusion | +--ro dst-ip? inet:ip-address | +--ro dst-port? inet:port-number | +--ro rule-name - -> /nsfi:i2nsf-security-policy/system-policy/rules/rule-name + -> /nsfi:i2nsf-security-policy/rules/rule-name | +--ro raw-info? string | +--ro src-ip? inet:ip-address | +--ro src-port? inet:port-number | +--ro src-zone? string | +--ro dst-zone? string | +--ro protocol? identityref - | +--ro app? string + | +--ro app? identityref | +--ro attack-type? identityref - | +--ro action? log-action + | +--ro action* log-action | +--ro attack-rate? uint32 | +--ro attack-speed? uint32 | +--ro acquisition-method? identityref | +--ro emission-type? identityref | +--ro dampening-type? identityref | +--ro message? string | +--ro vendor-name? string - | +--ro nsf-name? string + | +--ro nsf-name? union | +--ro severity? severity - +--:(i2nsf-nsf-detection-botnet) - {i2nsf-nsf-detection-botnet}? - | +--ro i2nsf-nsf-detection-botnet + +--:(i2nsf-nsf-detection-web-attack) + {i2nsf-nsf-detection-web-attack}? + | +--ro i2nsf-nsf-detection-web-attack | +--ro dst-ip? inet:ip-address | +--ro dst-port? inet:port-number | +--ro rule-name - -> /nsfi:i2nsf-security-policy/system-policy/rules/rule-name + -> /nsfi:i2nsf-security-policy/rules/rule-name | +--ro raw-info? string | +--ro src-ip? inet:ip-address | +--ro src-port? inet:port-number | +--ro src-zone? string | +--ro dst-zone? string | +--ro attack-type? identityref - | +--ro protocol? identityref - | +--ro botnet-name? string - | +--ro role? string - | +--ro action? log-action - | +--ro botnet-pkt-num? uint8 - | +--ro os? string + | +--ro request-method? identityref + | +--ro req-uri? string + | +--ro filtering-type* identityref + | +--ro req-user-agent? string + | +--ro req-cookie? string + | +--ro req-host? string + | +--ro response-code? string | +--ro acquisition-method? identityref | +--ro emission-type? identityref | +--ro dampening-type? identityref + | +--ro action* log-action | +--ro message? string | +--ro vendor-name? string - | +--ro nsf-name? string + | +--ro nsf-name? union | +--ro severity? severity - +--:(i2nsf-nsf-detection-web-attack) - {i2nsf-nsf-detection-web-attack}? - | +--ro i2nsf-nsf-detection-web-attack + +--:(i2nsf-nsf-detection-voip-volte) + {i2nsf-nsf-detection-voip-volte}? + | +--ro i2nsf-nsf-detection-voip-volte | +--ro dst-ip? inet:ip-address | +--ro dst-port? inet:port-number | +--ro rule-name - -> /nsfi:i2nsf-security-policy/system-policy/rules/rule-name + -> /nsfi:i2nsf-security-policy/rules/rule-name | +--ro raw-info? string | +--ro src-ip? inet:ip-address | +--ro src-port? inet:port-number | +--ro src-zone? string | +--ro dst-zone? string - | +--ro attack-type? identityref - | +--ro request-method? identityref - | +--ro req-uri? string - | +--ro uri-category? string - | +--ro filtering-type* identityref - | +--ro rsp-code? string - | +--ro req-clientapp? string - | +--ro req-cookies? string - | +--ro req-host? string - | +--ro acquisition-method? identityref - | +--ro emission-type? identityref - | +--ro dampening-type? identityref - | +--ro action? log-action - | +--ro message? string - | +--ro vendor-name? string - | +--ro nsf-name? string - | +--ro severity? severity - +--:(i2nsf-nsf-log-vuln-scan) {i2nsf-nsf-log-vuln-scan}? - | +--ro i2nsf-nsf-log-vuln-scan - | +--ro vulnerability-id? uint8 - | +--ro victim-ip? inet:ip-address - | +--ro protocol? identityref - | +--ro port-num? inet:port-number - | +--ro level? severity - | +--ro os? string - | +--ro vulnerability-info? string - | +--ro fix-suggestion? string - | +--ro service? string - | +--ro acquisition-method? identityref - | +--ro emission-type? identityref - | +--ro dampening-type? identityref - | +--ro message? string - | +--ro vendor-name? string - | +--ro nsf-name? string - | +--ro severity? severity + | +--ro source-voice-id* string + | +--ro destination-voice-id* string + | +--ro user-agent* string +--:(i2nsf-nsf-log-dpi) {i2nsf-nsf-log-dpi}? +--ro i2nsf-nsf-log-dpi +--ro attack-type? dpi-type +--ro acquisition-method? identityref +--ro emission-type? identityref +--ro dampening-type? identityref +--ro policy-name - -> /nsfi:i2nsf-security-policy/system-policy/system-policy-name + -> /nsfi:i2nsf-security-policy/system-policy-name +--ro src-user? string +--ro message? string +--ro vendor-name? string - +--ro nsf-name? string + +--ro nsf-name? union +--ro severity? severity Figure 1: Information Model for NSF Monitoring -10. YANG Data Model - - This section describes a YANG module of I2NSF NSF Monitoring. This - YANG module imports from [RFC6991], and makes references to - [RFC0768][RFC0791] [RFC0792][RFC0793][RFC0956] - [RFC0959][RFC2616][RFC4443] [RFC8200][RFC8632][RFC8641]. +9. YANG Data Model - file "ietf-i2nsf-nsf-monitoring@2021-04-29.yang" + This section describes a YANG module of I2NSF NSF Monitoring. The + data model provided in this document uses identities to be used to + get information of the monitored of an NSF's monitoring data. Every + identity used in the document gives information or status about the + current situation of an NSF. This YANG module imports from + [RFC6991], and makes references to [RFC0768][RFC0791] + [RFC0792][RFC0793] [RFC0959][RFC4443] [RFC8200][RFC8641] + [IANA-HTTP-Status-Code] [IANA-Media-Types]. + file "ietf-i2nsf-nsf-monitoring@2021-08-24.yang" module ietf-i2nsf-nsf-monitoring { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-i2nsf-nsf-monitoring"; prefix nsfmi; import ietf-inet-types{ prefix inet; reference "Section 4 of RFC 6991"; @@ -1572,57 +1510,65 @@ nsfmi; import ietf-inet-types{ prefix inet; reference "Section 4 of RFC 6991"; } import ietf-yang-types { prefix yang; reference "Section 3 of RFC 6991"; + } import ietf-i2nsf-policy-rule-for-nsf { prefix nsfi; reference - "Section 4.1 of draft-ietf-i2nsf-nsf-facing-interface-dm-12"; + "Section 4.1 of draft-ietf-i2nsf-nsf-facing-interface-dm-13"; } organization "IETF I2NSF (Interface to Network Security Functions) Working Group"; contact "WG Web: WG List: Editor: Jaehoon Paul Jeong Editor: Patrick Lingga "; description "This module is a YANG module for I2NSF NSF Monitoring. + The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', + 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', + 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this + document are to be interpreted as described in BCP 14 + (RFC 2119) (RFC 8174) when, and only when, they appear + in all capitals, as shown here. + Copyright (c) 2021 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices."; - revision "2021-04-29" { + revision "2021-08-24" { description "Latest revision"; reference "RFC XXXX: I2NSF NSF Monitoring Interface YANG Data Model"; // RFC Ed.: replace XXXX with an actual RFC number and remove // this note. } /* * Typedefs @@ -1645,39 +1591,37 @@ a severe degradation in the capability of the service and its full capability must be restored."; } enum middle { description "The 'middle' severity level indicates the existence of a non-service-affecting fault condition and corrective action should be done to prevent a more serious fault. The 'middle' severity is reported when the detected problem - is not degrading the capability of the service but - might happen if not prevented."; + is not degrading the capability of the service, but + some service degradation might happen if not + prevented."; } enum low { description "The 'low' severity level indicates the detection - of a potential fault before any effect is felt. - + of a potential fault before any effect is observed. The 'low' severity is reported when an action should be done before a fault happen."; } } description - "An indicator representing severity level. The severity level - starting from the highest are critical, high, middle, and - low."; - reference - "RFC 8632: A YANG Data Model for Alarm Management - - The severity levels are defined."; + "An indicator representing severity levels. The severity + levels starting from the highest are critical, high, middle, + and low."; + } typedef log-action { type enumeration { enum allow { description "If action is allowed"; } enum alert { description @@ -1700,77 +1644,97 @@ "If action is block-ip"; } enum block-service{ description "If action is block-service"; } } description "The type representing action for logging."; } + typedef dpi-type{ type enumeration { enum file-blocking{ description - "DPI for blocking file"; + "DPI for preventing the specified file types from flowing + in the network."; } enum data-filtering{ description - "DPI for filtering data"; + "DPI for preventing sensitive information (e.g., Credit + Card Number or Social Security Numbers) leaving a + protected network."; } enum application-behavior-control{ description - "DPI for controlling application behavior"; + "DPI for filtering packet based on the application or + network behavior analysis to identify malicious or + unusual activity."; } } description - "The type of deep packet inspection."; + "The type of Deep Packet Inspection (DPI). + The defined types are file-blocking, data-filtering, and + application-behavior-control."; } typedef operation-type{ type enumeration { enum login{ description - "Login operation"; + "The operation type is Login."; } enum logout{ description - "Logout operation"; + "The operation type is Logout."; } enum configuration{ description - "Configuration operation"; + "The operation type is Configuration. The configuration + operation includes the command for writing a new + configuration and modifying an existing configuration."; + } + enum other { + description + "The operation type is Other operation. This other + includes all operations done by a user except login, + logout, and configuration."; } } description - "The type of operation done by a user - during a session."; + "The type of operation done by a user during a session. + The user operation is not considering their privileges."; } - typedef login-mode{ + typedef login-role { type enumeration { - enum root{ + enum administrator { description - "Root login-mode"; + "Administrator (i.e., Super User) login role. + + Non-restricted role."; } enum user{ description - "User login-mode"; - + "User login role. Semi-restricted role, some data and + configurations are available but confidential or important + data and configuration are restricted."; } enum guest{ description - "Guest login-mode"; + "Guest login role. Restricted role, only few read data are + available and write configurations are restricted."; } } description - "The authorization login-mode done by a user."; + "The role of a user after login."; } /* * Identity */ identity characteristics { description "Base identity for monitoring information characteristics"; @@ -1789,169 +1753,212 @@ identity query { base acquisition-method; description "The acquisition-method type is query."; } identity emission-type { base characteristics; description "The type of emission-type."; } - identity periodical { + identity periodic { base emission-type; description - "The emission-type type is periodical."; + "The emission-type type is periodic."; } identity on-change { base emission-type; description "The emission-type type is on-change."; } identity dampening-type { base characteristics; description - "The type of dampening-type."; + "The type of message dampening to stop the rapid transmission + of messages. The dampening types are on-repetition and + no-dampening"; } identity no-dampening { base dampening-type; description - "The dampening-type is no-dampening."; + "The dampening-type is no-dampening. No-dampening type does + not limit the transmission for the messages of the same + type."; } identity on-repetition { base dampening-type; description - "The dampening-type is on-repetition."; - } - identity none { - base dampening-type; - description - "The dampening-type is none."; + "The dampening-type is on-repetition. On-repetition type limits + the transmitted on-change message to one message at a certain + interval."; } + identity authentication-mode { description - "User authentication mode types: - e.g., Local Authentication, - Third-Party Server Authentication, - Authentication Exemption, or Single Sign-On (SSO) - Authentication."; + "The authentication mode for a user to connect to the NSF, + e.g., pre-configured-key and certificate-authority"; } - identity local-authentication { + identity pre-configured-key { base authentication-mode; description - "Authentication-mode : local authentication."; + "The pre-configured-key is an authentication using a key + authentication."; } - identity third-party-server-authentication { + identity certificate-authority { base authentication-mode; description - "If authentication-mode is - third-party-server-authentication"; + "The certificate-authority (CA) is an authentication using a + digital certificate."; + } - identity exemption-authentication { - base authentication-mode; + + identity event { description - "If authentication-mode is - exemption-authentication"; + "Base identity for I2NSF events."; } - identity sso-authentication { - base authentication-mode; + + identity system-event { + base event; description - "If authentication-mode is - sso-authentication"; + "Identity for system event"; } - identity alarm-type { + + identity system-alarm { + base event; description - "Base identity for detectable alarm types"; + "Base identity for detectable system alarm types"; } - identity mem-usage-alarm { - base alarm-type; + + identity memory-alarm { + base system-alarm; description "A memory alarm is alerted."; } - identity cpu-usage-alarm { - base alarm-type; + identity cpu-alarm { + base system-alarm; description "A CPU alarm is alerted."; } - identity disk-usage-alarm { - base alarm-type; + identity disk-alarm { + base system-alarm; description "A disk alarm is alerted."; } - identity hw-failure-alarm { - base alarm-type; + identity hardware-alarm { + base system-alarm; description - "A hardware alarm is alerted."; + "A hardware alarm (i.e., hardware failure) is alerted."; } - identity ifnet-state-alarm { - base alarm-type; + identity interface-alarm { + base system-alarm; description "An interface alarm is alerted."; } - identity event-type { - description - "Base identity for detectable event types"; - } - identity access-denied { - base event-type; + + identity access-violation { + base system-event; description - "The system event is access-denied."; + "The access-violation system event is an event when a user + tries to access (read or write) any information above their + privilege."; } - identity config-change { - base event-type; + identity configuration-change { + base system-event; description - "The system event is config-change."; + "The configuration-change system event is an event when a user + adds a new configuration or modify an existing configuration + (write configuration)."; } + identity attack-type { description "The root ID of attack-based notification in the notification taxonomy"; } - identity system-attack-type { - base attack-type; - description - "This ID is intended to be used - in the context of system events."; - } identity nsf-attack-type { base attack-type; description "This ID is intended to be used in the context of NSF event."; } - identity botnet-attack-type { - base nsf-attack-type; - description - "This indicates that this attack type is botnet. - The usual semantic and taxonomy is missing - and a name is used."; - } + identity virus-type { base nsf-attack-type; description - "The type of virus. It caan be multiple types at once. + "The type of virus. It can be multiple types at once. This attack type is associated with a detected system-log virus-attack."; } identity trojan { base virus-type; description - "The detected virus type is trojan."; + "The virus type is a trojan. Trojan is able to disguise the + intent of the files or programs to misleads the users."; } identity worm { base virus-type; description - "The detected virus type is worm."; + "The virus type is a worm. Worm can self-replicate and + spread through the network automatically."; } identity macro { base virus-type; description - "The detected virus type is macro."; + "The virus type is a macro virus. Macro causes a series of + threats automatically after the program is executed."; + + } + identity boot-sector { + base virus-type; + description + "The virus type is a boot sector virus. Boot sector is a virus + that infects the core of the computer, affecting the startup + process."; + } + identity polymorphic { + base virus-type; + description + "The virus type is a polymorphic virus. Polymorphic can + modify its version when it replicates, making it hard to + detect."; + } + identity overwrite { + base virus-type; + description + "The virus type is an overwrite virus. Overwrite can remove + existing software and replace it with malicious code by + overwriting it."; + } + identity resident { + base virus-type; + description + "The virus-type is a resident virus. Resident saves itself in + the computer's memory and infects other files and software."; + } + identity non-resident { + base virus-type; + description + "The virus-type is a non-resident virus. Non-resident attaches + directly to an executable file and enters the device when + executed."; + } + identity multipartite { + base virus-type; + description + "The virus-type is a multipartite virus. Multipartite attacks + both the boot sector and executables files of a computer."; + } + identity spacefiller { + base virus-type; + description + "The virus-type is a spacefiller virus. Spacefiller fills empty + spaces of a file or software with malicious code."; } identity intrusion-attack-type { base nsf-attack-type; description "The attack type is associated with a detected system-log intrusion."; } identity brute-force { base intrusion-attack-type; description @@ -1976,281 +1983,399 @@ identity xss { base web-attack-type; description "The detected web attack type is XSS."; } identity csrf { base web-attack-type; description "The detected web attack type is CSRF."; } - identity flood-type { + + identity ddos-type { base nsf-attack-type; description "Base identity for detectable flood types"; } identity syn-flood { - base flood-type; + base ddos-type; description "A SYN flood is detected."; } identity ack-flood { - base flood-type; + base ddos-type; description "An ACK flood is detected."; } identity syn-ack-flood { - base flood-type; + base ddos-type; description "A SYN-ACK flood is detected."; } identity fin-rst-flood { - base flood-type; + base ddos-type; description "A FIN-RST flood is detected."; } identity tcp-con-flood { - base flood-type; + base ddos-type; description "A TCP connection flood is detected."; } identity udp-flood { - base flood-type; + base ddos-type; description "A UDP flood is detected."; } - identity icmp-flood { - base flood-type; - description - "Either an ICMPv4 or ICMPv6 flood is detected."; - } identity icmpv4-flood { - base flood-type; + base ddos-type; description "An ICMPv4 flood is detected."; } identity icmpv6-flood { - base flood-type; + base ddos-type; description "An ICMPv6 flood is detected."; } identity http-flood { - base flood-type; + base ddos-type; description "An HTTP flood is detected."; } identity https-flood { - base flood-type; + base ddos-type; description "An HTTPS flood is detected."; } identity dns-query-flood { - base flood-type; + base ddos-type; description - "A DNS query flood is detected."; + "A Domain Name System (DNS) query flood is detected."; } identity dns-reply-flood { - base flood-type; + base ddos-type; description - "A DNS reply flood is detected."; + "A Domain Name System (DNS) reply flood is detected."; } identity sip-flood { - base flood-type; + base ddos-type; description - "An SIP flood is detected."; + "A Session Initiation Protocol (SIP) flood is detected."; + } + identity ssl-flood { + base ddos-type; + description + "An Secure Sockets Layer (SSL) flood is detected"; + } + identity ntp-amp-flood { + base ddos-type; + description + "A Network Time Protocol (NTP) amplification is detected"; } - identity req-method { + identity request-method { description - "A set of request types (if applicable). - For instance, PUT or GET in HTTP."; + "A set of request types in HTTP (if applicable)."; } - identity put-req { - base req-method; + identity put { + base request-method; description "The detected request type is PUT."; + reference + "RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics + and Content - Request Method PUT"; } - identity get-req { - base req-method; + identity post { + base request-method; description - "The detected request type is GET."; + "The detected request type is POST."; + reference + "RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics + and Content - Request Method POST"; } - identity filter-type { + identity get { + base request-method; description - "The type of filter used to detect an attack, - for example, a web-attack. It can be applicable to - more than web-attacks. It can be more than one type."; + "The detected request type is GET."; + reference + "RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics + and Content - Request Method GET"; } - identity whitelist { - base filter-type; + identity head { + base request-method; description - "The applied filter type is whitelist."; + "The detected request type is HEAD."; + reference + "RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics + and Content - Request Method HEAD"; } - identity blacklist { - base filter-type; + identity delete { + base request-method; description - "The applied filter type is blacklist."; + "The detected request type is DELETE."; + reference + "RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics + and Content - Request Method DELETE"; } - identity user-defined { - base filter-type; + identity connect { + base request-method; description - "The applied filter type is user-defined."; + "The detected request type is CONNECT."; + reference + "RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics + and Content - Request Method CONNECT"; } - identity malicious-category { - base filter-type; + identity options { + base request-method; description - "The applied filter is malicious category."; + "The detected request type is OPTIONS."; + reference + "RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics + and Content - Request Method OPTIONS"; } - identity unknown-filter { - base filter-type; + identity trace { + base request-method; description - "The applied filter is unknown."; + "The detected request type is TRACE."; + reference + "RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics + and Content - Request Method TRACE"; } - identity access-mode { + identity filter-type { description - "Base identity for detectable access mode."; + "The type of filter used to detect an attack, + for example, a web-attack. It can be applicable to + more than web-attacks."; } - identity ppp { - base access-mode; + identity allow-list { + base filter-type; description - "Access-mode: ppp"; + "The applied filter type is an allow list. This filter blocks + all connection except the specified list."; } - identity svn { - base access-mode; + identity deny-list { + base filter-type; description - "Access-mode: svn"; + "The applied filter type is a deny list. This filter opens all + connection except the specified list."; } - identity local { - base access-mode; + identity unknown-filter { + base filter-type; description - "Access-mode: local"; + "The applied filter is unknown."; } - identity protocol-type { + identity protocol { description "An identity used to enable type choices in leaves - and leaflists with respect to protocol metadata."; + and leaflists with respect to protocol metadata. This is used + to identify the type of protocol that goes through the NSF."; } - identity tcp { - base ipv4; - base ipv6; + identity ip { + base protocol; description - "TCP protocol type."; + "General IP protocol type."; reference - "RFC 793: Transmission Control Protocol"; + "RFC 791: Internet Protocol + RFC 8200: Internet Protocol, Version 6 (IPv6)"; } - identity udp { - base ipv4; - base ipv6; + identity ipv4 { + base ip; description - "UDP protocol type."; + "IPv4 protocol type."; reference - "RFC 768: User Datagram Protocol"; + "RFC 791: Internet Protocol"; + } + identity ipv6 { + base ip; + description + "IPv6 protocol type."; + reference + "RFC 8200: Internet Protocol, Version 6 (IPv6)"; } identity icmp { - base ipv4; - base ipv6; + base protocol; description - "General ICMP protocol type."; + "Base identity for ICMPv4 and ICMPv6 condition capability"; reference "RFC 792: Internet Control Message Protocol - RFC 4443: Internet Control Message Protocol - (ICMPv6) for the Internet Protocol Version 6 - (IPv6) Specification"; + RFC 4443: Internet Control Message Protocol (ICMPv6) + for the Internet Protocol Version 6 (IPv6) Specification + - ICMPv6"; } identity icmpv4 { - base ipv4; + base icmp; description "ICMPv4 protocol type."; reference "RFC 791: Internet Protocol RFC 792: Internet Control Message Protocol"; } identity icmpv6 { - base ipv6; + base icmp; description "ICMPv6 protocol type."; reference "RFC 8200: Internet Protocol, Version 6 (IPv6) RFC 4443: Internet Control Message Protocol (ICMPv6) for the Internet Protocol Version 6 (IPv6) Specification"; } - identity ip { - base protocol-type; + identity transport-protocol { + base protocol; description - "General IP protocol type."; + "Base identity for Layer 4 protocol condition capabilities, + e.g., TCP, UDP, SCTP, DCCP, and ICMP"; + } + identity tcp { + base transport-protocol; + description + "TCP protocol type."; reference - "RFC 791: Internet Protocol - RFC 8200: Internet Protocol, Version 6 (IPv6)"; + "RFC 793: Transmission Control Protocol"; } - identity ipv4 { - base ip; + identity udp { + base transport-protocol; description - "IPv4 protocol type."; - + "UDP protocol type."; reference - "RFC 791: Internet Protocol"; + "RFC 768: User Datagram Protocol"; } - identity ipv6 { - base ip; + identity sctp { + base transport-protocol; description - "IPv6 protocol type."; + "Identity for SCTP condition capabilities"; reference - "RFC 8200: Internet Protocol, Version 6 (IPv6)"; + "RFC 4960: Stream Control Transmission Protocol"; + } + identity dccp { + base transport-protocol; + description + "Identity for DCCP condition capabilities"; + reference + "RFC 4340: Datagram Congestion Control Protocol"; + } + identity application-protocol { + base protocol; + description + "Base identity for Application protocol, e.g., HTTP, FTP"; } identity http { - base tcp; + base application-protocol; description - "HTPP protocol type."; + "HTTP protocol type."; reference - "RFC 2616: Hypertext Transfer Protocol"; + "RFC7230: Hypertext Transfer Protocol (HTTP/1.1): Message + Syntax and Routing + RFC7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics + and Content"; + } + identity https { + base application-protocol; + description + "HTTPS protocol type."; + reference + "RFC7230: Hypertext Transfer Protocol (HTTP/1.1): Message + Syntax and Routing + RFC7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics + and Content"; } identity ftp { - base tcp; + base application-protocol; description "FTP protocol type."; reference "RFC 959: File Transfer Protocol"; } + identity ssh { + base application-protocol; + description + "SSH protocol type."; + reference + "RFC 959: File Transfer Protocol"; + } + identity telnet { + base application-protocol; + description + "The identity for telnet."; + reference + "RFC 854: Telnet Protocol"; + } + identity smtp { + base application-protocol; + description + "The identity for smtp."; + reference + "RFC 5321: Simple Mail Transfer Protocol (SMTP)"; + } + identity sftp { + base application-protocol; + description + "The identity for sftp."; + reference + "RFC 913: Simple File Transfer Protocol (SFTP)"; + } + identity pop3 { + base application-protocol; + description + "The identity for pop3."; + reference + "RFC 1081: Post Office Protocol -Version 3 (POP3)"; + } /* * Grouping */ + grouping timestamp { + description + "Grouping for identifying the time of the message."; + leaf timestamp { + type yang:date-and-time; + description + "Specify the time of a message being delivered."; + } + } grouping common-monitoring-data { description "A set of common monitoring data that is needed as the basic information."; leaf message { type string; description "This is a freetext annotation for monitoring a notification's content."; } leaf vendor-name { type string; description - "The name of the NSF vendor"; + "The name of the NSF vendor. The string is unrestricted to + identify the provider or vendor of the NSF."; } leaf nsf-name { + type union { type string; + type inet:ip-address; + } description - "The name (or IP) of the NSF generating the message."; - + "The name or IP address of the NSF generating the message. + If the given nsf-name is not IP address, the name can be an + arbitrary string including FQDN (Fully Qualified Domain + Name). The name MUST be unique for different NSF to + identify the NSF that generates the message."; } leaf severity { type severity; description "The severity of the alarm such as critical, high, - middle, low."; + middle, and low."; } } grouping characteristics { description "A set of characteristics of a notification."; leaf acquisition-method { type identityref { base acquisition-method; } description @@ -2295,63 +2421,63 @@ grouping i2nsf-system-event-type-content { description "System event metadata associated with system events caused by user activity."; leaf user { type string; mandatory true; description "The name of a user"; } - leaf group { + leaf-list group { type string; - mandatory true; description - "The group to which a user belongs."; + "The group(s) to which a user belongs."; } - leaf login-ip-addr { + leaf ip-address { type inet:ip-address; mandatory true; description - "The login IPv4 (or IPv6) address of a user."; + "The IPv4 (or IPv6) address of a user that trigger the + event."; } leaf authentication { type identityref { base authentication-mode; } description - "The authentication-mode for authentication"; + "The authentication-mode of a user."; } } grouping i2nsf-nsf-event-type-content { description "A set of common IPv4 (or IPv6)-related NSF event content elements"; leaf dst-ip { type inet:ip-address; description "The destination IPv4 (IPv6) address of the packet"; } leaf dst-port { type inet:port-number; description "The destination port of the packet"; } leaf rule-name { type leafref { path - "/nsfi:i2nsf-security-policy/nsfi:system-policy" + "/nsfi:i2nsf-security-policy" +"/nsfi:rules/nsfi:rule-name"; } mandatory true; description - "The name of the rule being triggered"; + "The name of the I2NSF Policy Rule being triggered"; } leaf raw-info { type string; description "The information describing the packet triggering the event."; } } grouping i2nsf-nsf-event-type-content-extend { description @@ -2367,113 +2493,126 @@ type inet:port-number; description "The source port of the packet"; } leaf src-zone { type string { length "1..100"; pattern "[0-9a-zA-Z ]*"; } description - "The source security zone of the packet"; + "The source geographical location (e.g., country and city) of + the packet."; } leaf dst-zone { type string { length "1..100"; pattern "[0-9a-zA-Z ]*"; } description - "The destination security zone of the packet"; + "The destination geographical location (e.g., country and + city) of the packet."; } } grouping log-action { description "A grouping for logging action."; - leaf action { + leaf-list action { type log-action; description "Action type: allow, alert, block, discard, declare, block-ip, block-service"; } } grouping attack-rates { description "A set of traffic rates for monitoring attack traffic data"; leaf attack-rate { type uint32; units "pps"; description - "The PPS rate of attack traffic"; + "The average packets per second (pps) rate of attack + traffic"; } leaf attack-speed { type uint32; units "bps"; description - "The BPS speed of attack traffic"; + "The average bits per second (bps) speed of attack traffic"; } } grouping traffic-rates { description "A set of traffic rates for statistics data"; leaf total-traffic { type yang:counter32; + units "packets"; description - "Total traffic"; + "The total number of traffic packets (in and out) in the + NSF."; } leaf in-traffic-average-rate { type uint32; units "pps"; description - "Inbound traffic average rate in packets per second (pps)"; + "Inbound traffic average rate in packets per second (pps). + The average is calculated from the start of the NSF service + until the generation of this record."; } leaf in-traffic-peak-rate { type uint32; units "pps"; description - "Inbound traffic peak rate in packets per second (pps)"; + "Inbound traffic peak rate in packets per second (pps)."; } leaf in-traffic-average-speed { type uint32; units "bps"; description - "Inbound traffic average speed in bits per second (bps)"; + "Inbound traffic average speed in bits per second (bps). + The average is calculated from the start of the NSF service + until the generation of this record."; } leaf in-traffic-peak-speed { type uint32; units "bps"; description - "Inbound traffic peak speed in bits per second (bps)"; + "Inbound traffic peak speed in bits per second (bps)."; } leaf out-traffic-average-rate { type uint32; units "pps"; description - "Outbound traffic average rate in packets per second (pps)"; + "Outbound traffic average rate in packets per second (pps). + The average is calculated from the start of the NSF service + until the generation of this record."; } leaf out-traffic-peak-rate { type uint32; units "pps"; description - "Outbound traffic peak rate in packets per Second (pps)"; + "Outbound traffic peak rate in packets per Second (pps)."; } leaf out-traffic-average-speed { type uint32; units "bps"; description - "Outbound traffic average speed in bits per second (bps)"; + "Outbound traffic average speed in bits per second (bps). + The average is calculated from the start of the NSF service + until the generation of this record."; } leaf out-traffic-peak-speed { type uint32; units "bps"; description - "Outbound traffic peak speed in bits per second (bps)"; + "Outbound traffic peak speed in bits per second (bps)."; } } grouping i2nsf-system-counter-type-content{ description "A set of counters for an interface traffic data."; leaf interface-name { type string; description "Network interface name configured in an NSF"; } @@ -2516,38 +2656,38 @@ "Total inbound drop bytes"; } leaf out-drop-traffic-bytes { type uint64; units "bytes"; description "Total outbound drop bytes"; } uses traffic-rates; } + grouping i2nsf-nsf-counters-type-content{ description "A set of contents of a policy in an NSF."; - leaf policy-name { type leafref { path - "/nsfi:i2nsf-security-policy/nsfi:system-policy" + "/nsfi:i2nsf-security-policy" +"/nsfi:system-policy-name"; } mandatory true; description "The name of the policy being triggered"; } leaf src-user{ type string; description - "User who generates the policy"; + "The I2NSF User's name who generates the policy."; } } grouping enable-notification { description "A grouping for enabling or disabling notification"; leaf enabled { type boolean; default "true"; description @@ -2570,24 +2710,24 @@ subscription. Whenever subscribed objects change and a dampening-period interval (which may be zero) has elapsed since the previous update record creation for a receiver, any subscribed objects and properties that have changed since the previous update record will have their current values marshalled and placed in a new update record. But if the subscribed objects change when the dampening-period is active, it should update the record without sending the notification until the dampening- period is finished. If multiple changes happen during the - active dampening-period, it should update the record with the - latest data. And at the end of the dampening-period, it should - send the record as a notification with the latest updated - record and restart the countdown."; + active dampening-period, it should update the record with + the latest data. And at the end of the dampening-period, it + should send the record as a notification with the latest + updated record and restart the countdown."; reference "RFC 8641: Subscription to YANG Notifications for Datastore Updates - Section 5."; } } /* * Feature Nodes */ @@ -2599,38 +2739,33 @@ feature i2nsf-nsf-detection-virus { description "This feature means it supports I2NSF nsf-detection-virus notification"; } feature i2nsf-nsf-detection-intrusion { description "This feature means it supports I2NSF nsf-detection-intrusion notification"; } - feature i2nsf-nsf-detection-botnet { - description - "This feature means it supports I2NSF nsf-detection-botnet - notification"; - } feature i2nsf-nsf-detection-web-attack { description "This feature means it supports I2NSF nsf-detection-web-attack notification"; } - feature i2nsf-nsf-log-dpi { + feature i2nsf-nsf-detection-voip-volte { description - "This feature means it supports I2NSF nsf-log-dpi + "This feature means it supports I2NSF nsf-detection-voip-volte notification"; } - feature i2nsf-nsf-log-vuln-scan { + feature i2nsf-nsf-log-dpi { description - "This feature means it supports I2NSF nsf-log-vuln-scan + "This feature means it supports I2NSF nsf-log-dpi notification"; } /* * Notification nodes */ notification i2nsf-event { description "Notification for I2NSF Event."; @@ -2640,21 +2775,21 @@ sub-event. Only 1 sub-event will be instantiated in each i2nsf-event message. Each case is expected to define one container with all the sub-event fields."; case i2nsf-system-detection-alarm { container i2nsf-system-detection-alarm{ description "This notification is sent, when a system alarm is detected."; leaf alarm-category { type identityref { - base alarm-type; + base system-alarm; } description "The alarm category for system-detection-alarm notification"; } leaf component-name { type string; description "The hardware component responsible for generating the message. Applicable for Hardware Failure @@ -2668,94 +2803,97 @@ Failure Alarm."; } leaf interface-state { type enumeration { enum down { description "The interface state is down."; } enum up { description - "The interface state is up."; + "The interface state is up and not congested."; } enum congested { description - "The interface state is congested."; + "The interface state is up but congested."; } } description - "The state of the interface (i.e., up, down, congested). - Applicable for Network Interface Failure Alarm."; + "The state of the interface (i.e., up, down, + congested). Applicable for Network Interface Failure + Alarm."; } uses characteristics; uses i2nsf-system-alarm-type-content; uses common-monitoring-data; } } case i2nsf-system-detection-event { container i2nsf-system-detection-event { description "This notification is sent when a security-sensitive authentication action fails."; leaf event-category { type identityref { - base event-type; + base system-event; } description "The event category for system-detection-event"; } uses characteristics; uses i2nsf-system-event-type-content; uses common-monitoring-data; } } case i2nsf-traffic-flows { container i2nsf-traffic-flows { description "This notification is sent to inform about the traffic flows."; leaf src-ip { type inet:ip-address; description - "The source IPv4 (or IPv6) address of the packet"; + "The source IPv4 (or IPv6) address of the flow"; } leaf dst-ip { type inet:ip-address; description - "The destination IPv4 (or IPv6) address of the packet"; + "The destination IPv4 (or IPv6) address of the flow"; } leaf protocol { type identityref { - base protocol-type; + base protocol; } description "The protocol type for nsf-detection-intrusion notification"; } leaf src-port { type inet:port-number; description - "The source port of the packet"; + "The source port of the flow"; } leaf dst-port { type inet:port-number; description - "The destination port of the packet"; + "The destination port of the flow"; } leaf arrival-rate { type uint32; units "pps"; description - "The arrival rate of the packet in packets - per second"; + "The average arrival rate of the flow in packets per + second. The average is calculated from the start of + the NSF service until the generation of this + record."; } uses characteristics; uses common-monitoring-data; } } case i2nsf-nsf-detection-session-table { container i2nsf-nsf-detection-session-table { description "This notification is sent, when a session table @@ -2796,115 +2934,165 @@ container i2nsf-nsf-system-access-log { description "The notification is sent, if there is a new system log entry about a system access event."; leaf login-ip { type inet:ip-address; mandatory true; description "Login IP address of a user"; } - leaf administrator { + leaf username { type string; description - "Administrator that maintains the device"; + "The login username that maintains the device"; } - leaf login-mode { - type login-mode; + leaf login-role { + type login-role; description - "Specifies the administrator log-in mode"; + "Specifies the user log-in role, i.e., administrator, + user, or guest."; } leaf operation-type { type operation-type; description - "The operation type that the administrator executes"; + "The operation type that the user executes"; } - leaf result { + leaf input { type string; description - "Command execution result"; + "The operation performed by a user after login. The + operation is a command given by a user."; + } - leaf content { + leaf output { type string; description - "The Operation performed by an administrator after - login"; + "The result in text format after executing the + input."; } uses characteristics; uses common-monitoring-data; } } case i2nsf-system-res-util-log { container i2nsf-system-res-util-log { description "This notification is sent, if there is a new log entry representing resource utilization updates."; leaf system-status { - type string; + type enumeration { + enum running { description - "The current systems running status"; + "The system is active and running the security + service."; + } + enum waiting { + description + "The system is active but waiting for an event to + provide the security service."; + } + enum inactive { + description + "The system is inactive and not running the + security service."; + } + } + description + "The current system's running status"; } leaf cpu-usage { type uint8; + units "percent"; description - "Specifies the relative size of CPU usage with + "Specifies the relative percentage of CPU usage with respect to platform resources"; } leaf memory-usage { type uint8; + units "percent"; description - "Specifies the size of memory usage."; + "Specifies the percentage of memory usage."; + } + list disk { + key disk-id; + description + "Disk is the hardware to store information for a + long period, i.e., Hard Disk or Solid-State Drive."; + leaf disk-id { + type string; + description + "The ID of the storage disk. It is a free form + identifier to identify the storage disk."; } leaf disk-usage { type uint8; + units "percent"; description - "Specifies the size of disk usage"; + "Specifies the percentage of disk usage"; } leaf disk-left { type uint8; + units "percent"; description - "Specifies the size of disk left"; + "Specifies the percentage of disk left"; + } } leaf session-num { - type uint8; + type uint32; description "The total number of sessions"; } leaf process-num { - type uint8; + type uint32; description - "The total number of process"; + "The total number of processes"; + } + list interface { + key interface-id; + description + "The network interface for connecting a device + with the network."; + leaf interface-id { + type string; + description + "The ID of the network interface. It is a free form + identifier to identify the network interface."; } leaf in-traffic-rate { type uint32; units "pps"; description - "The total inbound traffic rate in pps"; + "The total inbound traffic rate in packets per + second"; } leaf out-traffic-rate { type uint32; units "pps"; description - "The total outbound traffic rate in pps"; + "The total outbound traffic rate in packets per + second"; } leaf in-traffic-speed { type uint32; units "bps"; description - "The total inbound traffic speed in bps"; + "The total inbound traffic speed in bits per second"; } leaf out-traffic-speed { type uint32; units "bps"; description - "The total outbound traffic speed in bps"; + "The total outbound traffic speed in bits per + second"; + } } uses characteristics; uses common-monitoring-data; } } case i2nsf-system-user-activity-log { container i2nsf-system-user-activity-log { description "This notification is sent, if there is a new user @@ -2902,51 +3090,79 @@ uses characteristics; uses common-monitoring-data; } } case i2nsf-system-user-activity-log { container i2nsf-system-user-activity-log { description "This notification is sent, if there is a new user activity log entry."; - uses characteristics; uses i2nsf-system-event-type-content; uses common-monitoring-data; - leaf access { - type identityref { - base access-mode; - } - description - "The access type for system-user-activity-log - notification"; - } leaf online-duration { - type string; + type uint32; + units "seconds"; description - "Online duration"; + "The duration of a user's activeness (stays in login) + during a session."; + } leaf logout-duration { - type string; + type uint32; + units "seconds"; description - "Lockout duration"; + "The duration of a user's inactiveness (not in login) + from the last session."; } leaf additional-info { - type string; + type enumeration { + enum successful-login { + description + "The user has succeeded in login."; + } + enum failed-login { + description + "The user has failed in login (e.g., wrong + password)"; + } + enum logout { + description + "The user has succeeded in logout"; + } + enum successful-password-changed { + description + "The password has been changed successfully"; + } + enum failed-password-changed{ + description + "The attempt to change password has failed"; + } + enum lock { + description + "The user has been locked. A locked user cannot + login."; + } + enum unlock { + description + "The user has been unlocked."; + } + } description "User activities, e.g., Successful User Login, Failed Login attempts, User Logout, Successful User Password Change, Failed User Password Change, User Lockout, User Unlocking, and Unknown."; } } + } } } notification i2nsf-nsf-event { description "Notification for I2NSF NSF Event. This notification is used for a specific NSF that supported such feature."; choice sub-event-type { description @@ -2953,59 +3169,82 @@ "This choice must be augmented with cases for each allowed sub-event. Only 1 sub-event will be instantiated in each i2nsf-event message. Each case is expected to define one container with all the sub-event fields."; case i2nsf-nsf-detection-ddos { if-feature "i2nsf-nsf-detection-ddos"; container i2nsf-nsf-detection-ddos { description "This notification is sent, when a specific flood type is detected."; - uses i2nsf-nsf-event-type-content; leaf attack-type { type identityref { - base flood-type; + base ddos-type; } description "Any one of Syn flood, ACK flood, SYN-ACK flood, FIN/RST flood, TCP Connection flood, UDP flood, ICMP (i.e., ICMPv4 or ICMPv6) flood, HTTP flood, HTTPS flood, DNS query flood, DNS reply flood, SIP flood, etc."; } leaf start-time { type yang:date-and-time; mandatory true; description "The time stamp indicating when the attack started"; } leaf end-time { type yang:date-and-time; mandatory true; description "The time stamp indicating when the attack ended"; } - leaf attack-src-ip { + leaf-list attack-src-ip { type inet:ip-address; description "The source IPv4 (or IPv6) addresses of attack - traffic. If there are a large number of IPv4 - (or IPv6) addresses, then pick a certain number - of resources according to different rules."; + traffic. It can hold multiple IPv4 (or IPv6) + addresses."; } - leaf attack-dst-ip { - type inet:ip-address; + leaf-list attack-dst-ip { + type inet:ip-prefix; description "The destination IPv4 (or IPv6) addresses of attack - traffic. If there are a large number of IPv4 - (or IPv6) addresses, then pick a certain number - of resources according to different rules."; + traffic. It can hold multiple IPv4 (or IPv6) + addresses."; + } + leaf-list attack-src-port { + type inet:port-number; + description + "The source ports of the DDoS attack"; + } + leaf-list attack-dst-port { + type inet:port-number; + description + "The destination ports of the DDoS attack"; + } + leaf rule-name { + type leafref { + path + "/nsfi:i2nsf-security-policy" + +"/nsfi:rules/nsfi:rule-name"; + } + mandatory true; + description + "The name of the I2NSF Policy Rule being triggered"; + } + leaf raw-info { + type string; + description + "The information describing the packet + triggering the event."; } uses attack-rates; uses log-action; uses characteristics; uses common-monitoring-data; } } case i2nsf-nsf-detection-virus { if-feature "i2nsf-nsf-detection-virus"; container i2nsf-nsf-detection-virus { @@ -3022,245 +3261,166 @@ leaf virus-name { type string; description "The name of the detected virus"; } leaf file-type { type string; description "The type of file virus code is found in (if applicable)."; + reference + "IANA Website: Media Types"; } leaf file-name { type string; description "The name of file virus code is found in (if applicable)."; } leaf os { type string; description - "Simple OS information"; + "The operating system of the device."; } uses log-action; uses characteristics; uses common-monitoring-data; } } 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 protocol-type; + base transport-protocol; } description - "The protocol type for nsf-detection-intrusion - notification"; + "The transport protocol type for + nsf-detection-intrusion notification"; } leaf app { - type string; + 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"; } uses log-action; uses attack-rates; uses characteristics; uses common-monitoring-data; } } - case i2nsf-nsf-detection-botnet { - if-feature "i2nsf-nsf-detection-botnet"; - container i2nsf-nsf-detection-botnet { - description - "This notification is sent, when a botnet event is - detected."; - uses i2nsf-nsf-event-type-content-extend; - leaf attack-type { - type identityref { - base botnet-attack-type; - } - description - "The attack type for botnet attack"; - } - leaf protocol { - type identityref { - base protocol-type; - } - description - "The protocol type for nsf-detection-botnet - notification"; - } - leaf botnet-name { - type string; - description - "The name of the detected botnet"; - } - leaf role { - type string; - description - "The role of the communicating - parties within the botnet"; - } - uses log-action; - leaf botnet-pkt-num{ - type uint8; - description - "The number of the packets sent to or from the detected - botnet"; - } - leaf os{ - type string; - description - "Simple OS information"; - } - uses characteristics; - uses common-monitoring-data; - } - } 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 request-method { type identityref { - base req-method; + base request-method; } description - "The method of requirement. For instance, PUT or - GET in HTTP."; - + "The HTTP request method, e.g., PUT or GET."; + reference + "RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): + Semantics and Content - Request Methods"; } leaf req-uri { type string; description - "Requested URI"; - } - leaf uri-category { - type string; - description - "Matched URI category"; + "The Requested URI"; } leaf-list filtering-type { type identityref { base filter-type; } description - "URL filtering type, e.g., Blacklist, Whitelist, - User-Defined, Predefined, Malicious Category, + "URL filtering type, e.g., deny-list, allow-list, and Unknown"; } - leaf rsp-code { + leaf req-user-agent { type string; description - "Response code"; + "The request user agent"; } - leaf req-clientapp { + leaf req-cookie { type string; description - "The client application"; + "The HTTP Cookie previously sent by the server with + Set-Cookie"; } - leaf req-cookies { + leaf req-host { type string; description - "Cookies"; + "The domain name of the requested host"; } - leaf req-host { + leaf response-code { type string; description - "The domain name of the requested host"; + "The HTTP Response code"; + reference + "IANA Website: Hypertext Transfer Protocol (HTTP) + Status Code Registry"; } uses characteristics; uses log-action; uses common-monitoring-data; } } - case i2nsf-nsf-log-vuln-scan { - if-feature "i2nsf-nsf-log-vuln-scan"; - container i2nsf-nsf-log-vuln-scan { - description - "This notification is sent, if there is a new - vulnerability-scan report in the NSF log."; - leaf vulnerability-id { - type uint8; - description - "The vulnerability ID"; - } - leaf victim-ip { - type inet:ip-address; - description - "IPv4 (or IPv6) address of the victim host which - has vulnerabilities"; - } - leaf protocol { - type identityref { - base protocol-type; - } - description - "The protocol type for nsf-log-vuln-scan - notification"; - } - leaf port-num { - type inet:port-number; - description - "The port number"; - } - leaf level { - type severity; - description - "The vulnerability severity"; - } - leaf os { - type string; + case i2nsf-nsf-detection-voip-volte{ + if-feature "i2nsf-nsf-detection-voip-volte"; + container i2nsf-nsf-detection-voip-volte { description - "simple OS information"; - } - leaf vulnerability-info { + "This notification is sent, when a VoIP/VoLTE violation + is detected."; + uses i2nsf-nsf-event-type-content-extend; + leaf-list source-voice-id { type string; description - "The information about the vulnerability"; + "The detected source voice ID for VoIP and VoLTE that + violates the security policy."; } - leaf fix-suggestion { + leaf-list destination-voice-id { type string; description - "The fix suggestion to the vulnerability"; + "The detected destination voice ID for VoIP and VoLTE + that violates the security policy."; } - leaf service { + leaf-list user-agent { type string; description - "The service which has vulnerability in the victim - host"; + "The detected user-agent for VoIP and VoLTE that violates + the security policy."; } - uses characteristics; - uses common-monitoring-data; } } case i2nsf-nsf-log-dpi { if-feature "i2nsf-nsf-log-dpi"; container i2nsf-nsf-log-dpi { description "This notification is sent, if there is a new DPI event in the NSF log."; leaf attack-type { type dpi-type; @@ -3281,51 +3441,54 @@ config false; description "This is probably better covered by an import as this will not be notifications. Counters are not very suitable as telemetry, maybe via periodic subscriptions, which would still violate the principle of least surprise."; list system-interface { key interface-name; description - "Interface counters provide the visibility of traffic into and - out of an NSF, and bandwidth usage."; + "Interface counters provide the visibility of traffic into + and out of an NSF, and bandwidth usage."; uses characteristics; uses i2nsf-system-counter-type-content; uses common-monitoring-data; + uses timestamp; } list nsf-firewall { key policy-name; description "Firewall counters provide the visibility of traffic signatures, bandwidth usage, and how the configured security and bandwidth policies have been applied."; uses characteristics; uses i2nsf-nsf-counters-type-content; uses traffic-rates; uses common-monitoring-data; + uses timestamp; } list nsf-policy-hits { key policy-name; description "Policy Hit Counters record the number of hits that traffic packets match a security policy. It can check if policy configurations are correct or not."; uses characteristics; uses i2nsf-nsf-counters-type-content; uses common-monitoring-data; leaf hit-times { type yang:counter32; description "The number of times a policy is hit"; } + uses timestamp; } } container i2nsf-monitoring-configuration { description "The container for configuring I2NSF monitoring."; container i2nsf-system-detection-alarm { description "The container for configuring I2NSF system-detection-alarm notification"; @@ -3337,22 +3501,22 @@ and Disk Usage)"; leaf alarm-type { type enumeration { enum CPU { description "To configure the CPU usage threshold to trigger the CPU-USAGE-ALARM"; } enum Memory { description - "To configure the Memory usage threshold to trigger the - MEM-USAGE-ALARM"; + "To configure the Memory usage threshold to trigger + the MEM-USAGE-ALARM"; } enum Disk { description "To configure the Disk (storage) usage threshold to trigger the DISK-USAGE-ALARM"; } } description "Type of alarm to be configured"; } @@ -3391,44 +3555,28 @@ uses enable-notification; uses dampening; } container i2nsf-nsf-detection-session-table-configuration { description "The container for configuring I2NSF nsf-detection-session- table notification"; uses enable-notification; uses dampening; } - container i2nsf-nsf-detection-virus { - if-feature "i2nsf-nsf-detection-virus"; - description - "The container for configuring I2NSF nsf-detection-virus - notification"; - uses enable-notification; - uses dampening; - } container i2nsf-nsf-detection-intrusion { if-feature "i2nsf-nsf-detection-intrusion"; description "The container for configuring I2NSF nsf-detection-intrusion notification"; uses enable-notification; uses dampening; } - container i2nsf-nsf-detection-botnet { - if-feature "i2nsf-nsf-detection-botnet"; - description - "The container for configuring I2NSF nsf-detection-botnet - notification"; - uses enable-notification; - uses dampening; - } container i2nsf-nsf-detection-web-attack { if-feature "i2nsf-nsf-detection-web-attack"; description "The container for configuring I2NSF nsf-detection-web-attack notification"; uses enable-notification; uses dampening; } container i2nsf-nsf-system-access-log { description @@ -3452,28 +3601,20 @@ uses dampening; } container i2nsf-nsf-log-dpi { if-feature "i2nsf-nsf-log-dpi"; description "The container for configuring I2NSF nsf-log-dpi notification"; uses enable-notification; uses dampening; } - container i2nsf-nsf-log-vuln-scan { - if-feature "i2nsf-nsf-log-vuln-scan"; - description - "The container for configuring I2NSF nsf-log-vuln-scan - notification"; - uses enable-notification; - uses dampening; - } container i2nsf-counter { description "This is used to configure the counters for monitoring an NSF"; leaf period { type uint16; units "minutes"; default 0; description "The configuration for the period interval of reporting @@ -3481,34 +3622,34 @@ If value is not 0, then the counter will be reported following the period value."; } } } } Figure 2: Data Model of Monitoring -11. I2NSF Event Stream +10. I2NSF Event Stream This section discusses the NETCONF event stream for I2NSF NSF Monitoring subscription. The YANG module in this document supports "ietf-subscribed-notifications" YANG module [RFC8639] for subscription. The reserved event stream name for this document is "I2NSF-Monitoring". The NETCONF Server (e.g., an NSF) MUST support "I2NSF-Monitoring" event stream for an NSF data collector (e.g., - Security Controller and NSF data analyzer). The "I2NSF-Monitoring" - event stream contains all I2NSF events described in this document. - The following example shows the capabilities of the event streams of - an NSF (e.g., "NETCONF" and "I2NSF-Monitoring" event streams) by the - subscription of an NSF data collector; note that this example XML - file is delivered by an NSF to an NSF data collector: + Security Controller). The "I2NSF-Monitoring" event stream contains + all I2NSF events described in this document. The following example + shows the capabilities of the event streams of an NSF (e.g., + "NETCONF" and "I2NSF-Monitoring" event streams) by the subscription + of an NSF data collector; note that this example XML file is + delivered by an NSF to an NSF data collector: NETCONF Default NETCONF Event Stream @@ -3520,44 +3661,45 @@ true 2021-04-29T09:37:39+00:00 - Figure 3: Example of NETCONF Server supporting I2NSF-Monitoring Event - Stream + Figure 3: Example of NETCONF Server supporting I2NSF-Monitoring + Event Stream -12. XML Examples for I2NSF NSF Monitoring +11. XML Examples for I2NSF NSF Monitoring This section shows the XML examples of I2NSF NSF Monitoring data delivered via Monitoring Interface from an NSF. -12.1. I2NSF System Detection Alarm +11.1. I2NSF System Detection Alarm The following example shows an alarm triggered by Memory Usage of the server; note that this example XML file is delivered by an NSF to an NSF data collector: - + 2021-04-29T07:43:52.181088+00:00 - nsfmi:mem-usage-alarm + nsfmi:memory-alarm nsfmi:subscription nsfmi:on-change @@ -3569,43 +3711,43 @@ 91 90 Memory Usage Exceeded the Threshold time_based_firewall high - Figure 4: Example of I2NSF System Detection Alarm triggered by Memory - Usage + Figure 4: Example of I2NSF System Detection Alarm triggered by + Memory Usage The XML data above shows: 1. The NSF that sends the information is named "time_based_firewall". 2. The memory usage of the NSF triggered the alarm. 3. The monitoring information is received by subscription method. 4. The monitoring information is emitted "on-change". 5. The monitoring information is dampened "on-repetition". 6. The memory usage of the NSF is 91 percent. 7. The memory threshold to trigger the alarm is 90 percent. 8. The severity level of the notification is high. -12.2. I2NSF Interface Counters +11.2. I2NSF Interface Counters To get the I2NSF system interface counters information by query, NETCONF Client (e.g., NSF data collector) needs to initiate GET connection with NETCONF Server (e.g., NSF). The following XML file can be used to get the state data and filter the information. 0 0 time_based_firewall Figure 6: Example of I2NSF System Interface Counters XML Information -13. IANA Considerations +12. IANA Considerations This document requests IANA to register the following URI in the "IETF XML Registry" [RFC3688]: URI: urn:ietf:params:xml:ns:yang:ietf-i2nsf-nsf-monitoring Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace. This document requests IANA to register the following YANG module in the "YANG Module Names" registry [RFC7950][RFC8525]: name: ietf-i2nsf-nsf-monitoring namespace: urn:ietf:params:xml:ns:yang:ietf-i2nsf-nsf-monitoring prefix: nsfmi reference: RFC XXXX // RFC Ed.: replace XXXX with an actual RFC number and remove // this note. -14. Security Considerations +13. Security Considerations - The YANG module described in this document defines a schema for data - that is designed to be accessed via network management protocols such - as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer - is the secure transport layer, and the mandatory-to-implement secure + YANG module described in this document defines a schema for data that + is designed to be accessed via network management protocols such as + NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is + the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS [RFC8446]. The NETCONF access control model [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. All data nodes defined in the YANG module which can be created, modified and deleted (i.e., config true, which is the default) are - considered sensitive. Write operations (e.g., edit-config) applied - to these data nodes without proper protection can negatively affect - framework operations. The monitoring YANG module should be protected - by the secure communication channel, to ensure its confidentiality - and integrity. In another side, the NSF and NSF data collector can - all be faked, which lead to undesirable results (i.e., leakage of an - NSF's important operational information, and faked NSF sending false - information to mislead the NSF data collector). The mutual - authentication is essential to protected against this kind of attack. - The current mainstream security technologies (i.e., TLS, DTLS, IPsec, - and X.509 PKI) can be employed appropriately to provide the above - security functions. + considered sensitive as they all could potentially impact security + monitoring and mitigation activities. Write operations (e.g., edit- + config) applied to these data nodes without proper protection could + result in missed alarms or incorrect alarms information being + returned to the NSF data collector. There are threats that need to + be considered and mitigated: + + Compromised NSF with valid credentials: It can send falsified + information to the NSF data collector to mislead detection or + mitigation activities; and/or to hide activity. Currently, there + is no in-framework mechanism to mitigate this and an issue for all + monitoring infrastructures. It is important to keep the enclosure + of confidential information to unauthorized persons to mitigate + the possibility of compromising the NSF with this information. + + Compromised NSF data collector with valid credentials: It has + visibility to all collected security alarms; entire detection and + mitigation infrastructure may be suspect. It is important to keep + the enclosure of confidential information to unauthorized persons + to mitigate the possibility of compromising the NSF with this + information. + + Impersonating NSF: It is a system trying to send false information + while imitating an NSF; client authentication would help the NSF + data collector to identify this invalid NSF in the "push" model + (NSF-to-collector), while the "pull" model (collector-to-NSF) + should already be addressed with the authentication. + + Impersonating NSF data collector: It is a rogue NSF data collector + with which a legitimate NSF is tricked into communicating; for + "push" model (NSF-to-collector), it is important to have valid + credentials, without it it should not work; for "pull" model + (collector-to-NSF), mutual authentication should be used to + mitigate the threat. In addition, to defend against the DDoS attack caused by a lot of NSFs sending massive notifications to the NSF data collector, the rate limiting or similar mechanisms should be considered in both an NSF and NSF data collector, whether in advance or just in the process of DDoS attack. -15. Acknowledgments + All of the readable data nodes in this YANG module may be considered + vulnerable in some network environments. Some data also may contain + private information that is highly sensitive to the user, such as the + IP address of a user in the container "i2nsf-system-user-activity- + log" and the container "i2nsf-system-detection-event". It is + important to control read access (e.g., via get, get-config, or + notification) to the data nodes. If access control is not properly + configured, it can expose system internals to those who should not + have access to this information. + +14. Acknowledgments This work was supported by Institute of Information & Communications Technology Planning & Evaluation (IITP) grant funded by the Korea MSIT (Ministry of Science and ICT) (R-20160222-002755, Cloud based Security Intelligence Technology Development for the Customized Security Service Provisioning). This work was supported in part by the IITP (2020-0-00395, Standard Development of Blockchain based Network Management Automation Technology). This work was supported in part by the MSIT under the Information Technology Research Center (ITRC) support program (IITP-2021-2017-0-01633) supervised by the IITP. -16. Contributors +15. Contributors This document is made by the group effort of I2NSF working group. Many people actively contributed to this document. The authors sincerely appreciate their contributions. The following are co-authors of this document: - Chaehong Chung - Department of Electronic, Electrical and Computer Engineering - Sungkyunkwan University - 2066 Seo-ro Jangan-gu - Suwon, Gyeonggi-do 16419 - Republic of Korea - - EMail: darkhong@skku.edu - - Jinyong (Tim) Kim - Department of Electronic, Electrical and Computer Engineering - Sungkyunkwan University - 2066 Seo-ro Jangan-gu - Suwon, Gyeonggi-do 16419 - Republic of Korea - - EMail: timkim@skku.edu - - Dongjin Hong - Department of Electronic, Electrical and Computer Engineering - Sungkyunkwan University - 2066 Seo-ro Jangan-gu - Suwon, Gyeonggi-do 16419 - Republic of Korea - EMail: dong.jin@skku.edu - - Dacheng Zhang - Huawei - - EMail: dacheng.zhang@huawei.com + Chaehong Chung Department of Electronic, Electrical and Computer + Engineering Sungkyunkwan University 2066 Seo-ro Jangan-gu Suwon, + Gyeonggi-do 16419 Republic of Korea EMail: darkhong@skku.edu - Yi Wu - Aliababa Group + Jinyong (Tim) Kim Department of Electronic, Electrical and Computer + Engineering Sungkyunkwan University 2066 Seo-ro Jangan-gu Suwon, + Gyeonggi-do 16419 Republic of Korea EMail: timkim@skku.edu - EMail: anren.wy@alibaba-inc.com + Dongjin Hong Department of Electronic, Electrical and Computer + Engineering Sungkyunkwan University 2066 Seo-ro Jangan-gu Suwon, + Gyeonggi-do 16419 Republic of Korea EMail: dong.jin@skku.edu - Rakesh Kumar - Juniper Networks - 1133 Innovation Way - Sunnyvale, CA 94089 - USA + Dacheng Zhang Huawei EMail: dacheng.zhang@huawei.com - EMail: rkkumar@juniper.net + Yi Wu Aliababa Group EMail: anren.wy@alibaba-inc.com - Anil Lohiya - Juniper Networks + Rakesh Kumar Juniper Networks 1133 Innovation Way Sunnyvale, CA 94089 + USA EMail: rkkumar@juniper.net - EMail: alohiya@juniper.net + Anil Lohiya Juniper Networks EMail: alohiya@juniper.net -17. References +16. References -17.1. Normative References +16.1. Normative References [RFC0768] Postel, J., "User Datagram Protocol", STD 6, RFC 768, DOI 10.17487/RFC0768, August 1980, . [RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791, DOI 10.17487/RFC0791, September 1981, . [RFC0792] Postel, J., "Internet Control Message Protocol", STD 5, RFC 792, DOI 10.17487/RFC0792, September 1981, . [RFC0793] Postel, J., "Transmission Control Protocol", STD 7, RFC 793, DOI 10.17487/RFC0793, September 1981, . - [RFC0956] Mills, D., "Algorithms for synchronizing network clocks", - RFC 956, DOI 10.17487/RFC0956, September 1985, - . - [RFC0959] Postel, J. and J. Reynolds, "File Transfer Protocol", STD 9, RFC 959, DOI 10.17487/RFC0959, October 1985, . [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . - [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., - Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext - Transfer Protocol -- HTTP/1.1", RFC 2616, - DOI 10.17487/RFC2616, June 1999, - . - [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC3877] Chisholm, S. and D. Romascanu, "Alarm Management Information Base (MIB)", RFC 3877, DOI 10.17487/RFC3877, September 2004, . - [RFC3954] Claise, B., Ed., "Cisco Systems NetFlow Services Export - Version 9", RFC 3954, DOI 10.17487/RFC3954, October 2004, - . - [RFC4443] Conta, A., Deering, S., and M. Gupta, Ed., "Internet Control Message Protocol (ICMPv6) for the Internet Protocol Version 6 (IPv6) Specification", STD 89, RFC 4443, DOI 10.17487/RFC4443, March 2006, . - [RFC4949] Shirey, R., "Internet Security Glossary, Version 2", - FYI 36, RFC 4949, DOI 10.17487/RFC4949, August 2007, - . - - [RFC5424] Gerhards, R., "The Syslog Protocol", RFC 5424, - DOI 10.17487/RFC5424, March 2009, - . + [RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event + Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008, + . [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, . [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, . - [RFC6587] Gerhards, R. and C. Lonvick, "Transmission of Syslog - Messages over TCP", RFC 6587, DOI 10.17487/RFC6587, April - 2012, . - [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, . - [RFC7011] Claise, B., Ed., Trammell, B., Ed., and P. Aitken, - "Specification of the IP Flow Information Export (IPFIX) - Protocol for the Exchange of Flow Information", STD 77, - RFC 7011, DOI 10.17487/RFC7011, September 2013, - . - [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016, . [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, . + [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC + 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, + May 2017, . + [RFC8200] Deering, S. and R. Hinden, "Internet Protocol, Version 6 (IPv6) Specification", STD 86, RFC 8200, DOI 10.17487/RFC8200, July 2017, . - [RFC8329] Lopez, D., Lopez, E., Dunbar, L., Strassner, J., and R. - Kumar, "Framework for Interface to Network Security - Functions", RFC 8329, DOI 10.17487/RFC8329, February 2018, - . - [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, . [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, . [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., @@ -3913,126 +4030,142 @@ [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, . [RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K., and R. Wilton, "YANG Library", RFC 8525, DOI 10.17487/RFC8525, March 2019, . - [RFC8632] Vallin, S. and M. Bjorklund, "A YANG Data Model for Alarm - Management", RFC 8632, DOI 10.17487/RFC8632, September - 2019, . - [RFC8639] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard, E., and A. Tripathy, "Subscription to YANG Notifications", RFC 8639, DOI 10.17487/RFC8639, September 2019, . [RFC8641] Clemm, A. and E. Voit, "Subscription to YANG Notifications for Datastore Updates", RFC 8641, DOI 10.17487/RFC8641, September 2019, . -17.2. Informative References +16.2. Informative References - [I-D.ietf-i2nsf-applicability] - Jeong, J., Hyun, S., Ahn, T., Hares, S., and D. Lopez, - "Applicability of Interfaces to Network Security Functions - to Network-Based Security Services", draft-ietf-i2nsf- - applicability-18 (work in progress), September 2019. + [RFC4949] Shirey, R., "Internet Security Glossary, Version 2", + FYI 36, RFC 4949, DOI 10.17487/RFC4949, August 2007, + . - [I-D.ietf-i2nsf-capability] - Xia, L., Strassner, J., Basile, C., and D. Lopez, - "Information Model of NSFs Capabilities", draft-ietf- - i2nsf-capability-05 (work in progress), April 2019. + [RFC8329] Lopez, D., Lopez, E., Dunbar, L., Strassner, J., and R. + Kumar, "Framework for Interface to Network Security + Functions", RFC 8329, DOI 10.17487/RFC8329, February 2018, + . [I-D.ietf-i2nsf-consumer-facing-interface-dm] - Jeong, J., Chung, C., Ahn, T., Kumar, R., and S. Hares, - "I2NSF Consumer-Facing Interface YANG Data Model", draft- - ietf-i2nsf-consumer-facing-interface-dm-13 (work in - progress), March 2021. + Jeong, J. (., Chung, C., Ahn, T., Kumar, R., and S. Hares, + "I2NSF Consumer-Facing Interface YANG Data Model", Work in + Progress, Internet-Draft, draft-ietf-i2nsf-consumer- + facing-interface-dm-13, 8 March 2021, + . [I-D.ietf-i2nsf-nsf-facing-interface-dm] - Kim, J., Jeong, J., J., J., PARK, P., Hares, S., and Q. - Lin, "I2NSF Network Security Function-Facing Interface - YANG Data Model", draft-ietf-i2nsf-nsf-facing-interface- - dm-12 (work in progress), March 2021. + Kim, J. (., Jeong, J. (., Park, J., Hares, S., and Q. Lin, + "I2NSF Network Security Function-Facing Interface YANG + Data Model", Work in Progress, Internet-Draft, draft-ietf- + i2nsf-nsf-facing-interface-dm-12, 8 March 2021, + . [I-D.ietf-i2nsf-registration-interface-dm] - Hyun, S., Jeong, J., Roh, T., Wi, S., J., J., and P. PARK, - "I2NSF Registration Interface YANG Data Model", draft- - ietf-i2nsf-registration-interface-dm-10 (work in - progress), February 2021. - - [I-D.ietf-netconf-subscribed-notifications] - Voit, E., Clemm, A., Prieto, A., Nilsen-Nygaard, E., and - A. Tripathy, "Subscription to YANG Event Notifications", - draft-ietf-netconf-subscribed-notifications-26 (work in - progress), May 2019. + Hyun, S., Jeong, J. P., Roh, T., Wi, S., and J. Park, + "I2NSF Registration Interface YANG Data Model", Work in + Progress, Internet-Draft, draft-ietf-i2nsf-registration- + interface-dm-10, 21 February 2021, + . - [I-D.ietf-netconf-yang-push] - Clemm, A. and E. Voit, "Subscription to YANG Datastores", - draft-ietf-netconf-yang-push-25 (work in progress), May - 2019. + [I-D.ietf-i2nsf-applicability] + Jeong, J. P., Hyun, S., Ahn, T., Hares, S., and D. R. + Lopez, "Applicability of Interfaces to Network Security + Functions to Network-Based Security Services", Work in + Progress, Internet-Draft, draft-ietf-i2nsf-applicability- + 18, 16 September 2019, . [I-D.yang-i2nsf-security-policy-translation] - Jeong, J., Lingga, P., Yang, J., and C. Chung, "Security - Policy Translation in Interface to Network Security - Functions", draft-yang-i2nsf-security-policy- - translation-08 (work in progress), February 2021. + Jeong, J. (., Lingga, P., Yang, J., and C. Chung, + "Security Policy Translation in Interface to Network + Security Functions", Work in Progress, Internet-Draft, + draft-yang-i2nsf-security-policy-translation-08, 22 + February 2021, . -Appendix A. Changes from draft-ietf-i2nsf-nsf-monitoring-data-model-07 + [IANA-HTTP-Status-Code] + Internet Assigned Numbers Authority (IANA), "Hypertext + Transfer Protocol (HTTP) Status Code Registry", September + 2018, . + + [IANA-Media-Types] + Internet Assigned Numbers Authority (IANA), "Media Types", + August 2021, . + +Appendix A. Changes from draft-ietf-i2nsf-nsf-monitoring-data-model-08 The following changes are made from draft-ietf-i2nsf-nsf-monitoring- - data-model-07: + data-model-08: - o This version is revised according to the comments from both Tom - Petch and Andy Bierman. + * This version is revised following Tom Petch's, Martin Bjorklund's, + and Roman Danyliw's Comments. + + * This version is revised to synchronize with other I2NSF documents. Authors' Addresses Jaehoon (Paul) Jeong (editor) Department of Computer Science and Engineering Sungkyunkwan University 2066 Seobu-Ro, Jangan-Gu - Suwon, Gyeonggi-Do 16419 + Suwon + Gyeonggi-Do + 16419 Republic of Korea Phone: +82 31 299 4957 - Fax: +82 31 290 7996 - EMail: pauljeong@skku.edu + Email: pauljeong@skku.edu URI: http://iotlab.skku.edu/people-jaehoon-jeong.php Patrick Lingga - Department of Electronic, Electrical and Computer Engineering + Department of Electrical and Computer Engineering Sungkyunkwan University 2066 Seobu-Ro, Jangan-Gu - Suwon, Gyeonggi-Do 16419 + Suwon + Gyeonggi-Do + 16419 Republic of Korea Phone: +82 31 299 4957 - EMail: patricklink@skku.edu - + Email: patricklink@skku.edu Susan Hares Huawei 7453 Hickory Hill Saline, MI 48176 - USA + United States of America Phone: +1-734-604-0332 - EMail: shares@ndzh.com + Email: shares@ndzh.com + Liang (Frank) Xia Huawei 101 Software Avenue, Yuhuatai District - Nanjing, Jiangsu + Nanjing + Jiangsu, China - EMail: Frank.xialiang@huawei.com + Email: Frank.xialiang@huawei.com Henk Birkholz Fraunhofer Institute for Secure Information Technology Rheinstrasse 75 - Darmstadt 64295 + 64295 Darmstadt Germany - EMail: henk.birkholz@sit.fraunhofer.de + Email: henk.birkholz@sit.fraunhofer.de