I2NSF NSF Monitoring YANG Data Model
Department of Computer Science and Engineering
Sungkyunkwan University2066 Seobu-Ro, Jangan-GuSuwonGyeonggi-Do16419Republic of Korea+82 31 299 4957+82 31 290 7996pauljeong@skku.eduhttp://iotlab.skku.edu/people-jaehoon-jeong.php
Department of Electronic, Electrical and Computer Engineering
Sungkyunkwan University2066 Seobu-Ro, Jangan-GuSuwonGyeonggi-Do16419Republic of Korea+82 10 8541 7158darkhong@skku.edu
Huawei
7453 Hickory HillSalineMI48176USA+1-734-604-0332shares@ndzh.com
Huawei
101 Software Avenue, Yuhuatai DistrictNanjingJiangsuChinaFrank.xialiang@huawei.com
Fraunhofer Institute for Secure Information Technology
Rheinstrasse 75Darmstadt64295Germanyhenk.birkholz@sit.fraunhofer.de
Security
I2NSF Working GroupInternet-Draft
This document describes an information model and the corresponding YANG data model
for monitoring Network Security Functions (NSFs) in the Interface to Network
Security Functions (I2NSF) framework.
If the monitoring of NSFs is performed in a comprehensive way, it is possible
to detect malicious activity, anomalous behavior, and the potential
sign of denial of service attacks in a timely manner. This monitoring functionality
is based on the monitoring information that is generated by NSFs. Thus, this document describes not only an information model for monitoring NSFs along with a YANG data diagram, but also the corresponding YANG data model for monitoring NSFs.
According to , the interface
provided by Network Security Functions (NSFs) (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 NSF-Facing 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, 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 NSF monitoring information model
that provides visibility for an NSF for 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-Facing Interface.
The information model for monitoring 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 .
This document also defines a YANG data model for monitoring
NSFs, which is derived from the information model for NSF monitoring.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in .
The terms, which are used in this document, are defined in the I2NSF terminology document .
This document follows the guidelines of , uses the common YANG types defined in , and adopts the Network Management Datastore Architecture (NMDA) . The meaning of the symbols in tree diagrams is defined in .
As mentioned earlier, monitoring plays a critical role in an
overall security framework. The monitoring of the NSF provides very
valuable information to the security controller in maintaining the
provisioned security posture. Besides this, there are various other
reasons to monitor the NSF as listed below:The security administrator with I2NSF User can configure a policy that is
triggered on a specific event occurring in the NSF or the network .
If a security controller detects the specified event, it
configures additional security functions as defined by policies.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.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 security controller 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.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 activity logs from the NSF can be used to build historical
data for operational and business reasons.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 or an NSF are highlighted in this document.Retention and EmissionNotifications and EventsUnsolicited Poll and Solicited PushThe Alarm Management Framework in defines an Event as
something that happens which may be 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.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 information
and in the scope of this document, which deals with NSF information monitoring in an automated
fashion.Typically, a system entity populates standardized interface, such as SNMP,
NETCONF, RESTCONF or CoMI to provide and emit created information directly via
NSF-Facing 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-Facing Interfaces.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., ) but also via interfaces complementary to the
standardized interfaces a generic system entity provides.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 or Syslog over TCP . But even
if records are conveyed, the result is the same kind of retention in form of a
bigger aggregate of records on another system entity.An I2NSF User is required to process fresh 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:a system entity that creates the informationa system entity that retains an aggregation of recordsan I2NSF Component that includes the capabilities of using standardized
interfaces provided by other system entities that are not I2NSF Componentsan I2NSF Component that creates the informationA 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 important occurrence over time in the system being managed, and/or in the environment of the
system being managed in , which aligns well with the
generic definition of Event from .The model illustrated in this document introduces a complementary type of
information that can be a conveyed 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.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 , a Notification is a
specific subset of events, because they convey information about something
that happens which may be 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.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.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 a monitor entity(e.g., Security Controller and I2NSF User) NSF timely. 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.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 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.
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.
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.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: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.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.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.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.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.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 and
NetFlow . The I2NSF does not
mandate any specific method for a given data set, so it is up to each
implementation.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.The mechanisms provided by YANG Push and YANG 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.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.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:message_version: It indicates the version of the data format and is a
two-digit decimal numeral starting from 01.message_type: Event, Alert, Alarm, Log, Counter, etc.time_stamp: It indicates the time when the message is generated.vendor_name: The name of the NSF vendor.NSF_name: The name (or IP) of the NSF generating the message.Module_name: The module name outputting the message.Severity: It indicates the level of the logs. There are total eight
levels, from 0 to 7. The smaller the numeral is, the higher the
severity is.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.Characteristics:acquisition_method: subscriptionemission_type: on-changedampening_type: no-dampeningThe following information should be included in a Memory
Alarm:event_name: MEM_USAGE_ALARMmodule_name: It indicates the NSF module responsible for
generating this alarm.usage: specifies the amount of memory used.threshold: The threshold triggering the alarmseverity: The severity of the alarm such as critical, high,
medium, lowmessage: The memory usage exceeded the thresholdThe following information should be included in a CPU Alarm:event_name: CPU_USAGE_ALARMusage: Specifies the amount of CPU used.threshold: The threshold triggering the eventseverity: The severity of the alarm such as critical, high,
medium, lowmessage: The CPU usage exceeded the threshold.The following information should be included in a Disk Alarm:event_name: DISK_USAGE_ALARMusage: Specifies the amount of disk space used.threshold: The threshold triggering the eventseverity: The severity of the alarm such as critical, high,
medium, lowmessage: The disk usage exceeded the threshold.The following information should be included in a Hardware
Alarm:event_name: HW_FAILURE_ALARMcomponent_name: It indicates the HW component responsible for
generating this alarm.threshold: The threshold triggering the alarmseverity: The severity of the alarm such as critical, high,
medium, lowmessage: The HW component has failed or degraded.The following information should be included in an Interface
Alarm:event_name: IFNET_STATE_ALARMinterface_Name: The name of interfaceinterface_state: UP, DOWN, CONGESTEDthreshold: The threshold triggering the eventseverity: The severity of the alarm such as critical, high,
medium, lowmessage: Current interface stateCharacteristics:acquisition_method: subscriptionemission_type: on-changedampening_type: on-repetitionThe following information should be included in this event:event_name: ACCESS_DENIEDuser: Name of a usergroup: Group to which a user belongslogin_ip_address: Login IP address of a userauthentication_mode: User authentication mode. e.g., Local
Authentication, Third-Party Server Authentication,
Authentication Exemption, Single Sign-On (SSO) Authenticationmessage: access is denied.The following information should be included in this event:event_name: CONFIG_CHANGEuser: Name of a usergroup: Group to which a user belongslogin_ip_address: Login IP address of a userauthentication_mode: User authentication mode. e.g., Local
Authentication, Third-Party Server Authentication,
Authentication Exemption, SSO Authenticationmessage: Configuration is modified.Characteristics:acquisition_method: subscriptionemission_type: on-changedampening_type: on-repetitionAccess 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:Administrator: Administrator that operates on the devicelogin_ip_address: IP address used by an administrator to log
inlogin_mode: Specifies the administrator logs in mode e.g.
root, useroperation_type: The operation type that the administrator
execute, e.g., login, logout, and configuration.result: Command execution resultcontent: Operation performed by an administrator after
login.Running reports record the device system's running status, which
is useful for device monitoring. The following information should be
included in running report:system_status: The current system's running statusCPU_usage: Specifies the CPU usage.memory_usage: Specifies the memory usage.disk_usage: Specifies the disk usage.disk_left: Specifies the available disk space left.session_number: Specifies total concurrent sessions.process_number: Specifies total number of systems
processes.in_traffic_rate: The total inbound traffic rate in ppsout_traffic_rate: The total outbound traffic rate in ppsin_traffic_speed: The total inbound traffic speed in bpsout_traffic_speed: The total outbound traffic speed in
bpsUser 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.user: Name of a usergroup: Group to which a user belongslogin_ip_address: Login IP address of a userauthentication_mode: User authentication mode. e.g., Local
Authentication, Third-Party Server Authentication,
Authentication Exemption, SSO Authenticationaccess_mode: User access mode. e.g., PPP, SVN, LOCALonline_duration: Online durationlockout_duration: Lockout durationtype: User activities. e.g., Successful User Login, Failed
Login attempts, User Logout, Successful User Password Change,
Failed User Password Change, User Lockout, User Unlocking,
Unknowncause: Cause of a failed user activityCharacteristics:acquisition_method: subscription or queryemission_type: periodicaldampening_type: noneInterface counters provide visibility into traffic into and out
of an NSF, and bandwidth usage.interface_name: Network interface name configured in NSFin_total_traffic_pkts: Total inbound packetsout_total_traffic_pkts: Total outbound packetsin_total_traffic_bytes: Total inbound bytesout_total_traffic_bytes: Total outbound bytesin_drop_traffic_pkts: Total inbound drop packetsout_drop_traffic_pkts: Total outbound drop packetsin_drop_traffic_bytes: Total inbound drop bytesout_drop_traffic_bytes: Total outbound drop bytesin_traffic_ave_rate: Inbound traffic average rate in ppsin_traffic_peak_rate: Inbound traffic peak rate in ppsin_traffic_ave_speed: Inbound traffic average speed in
bpsin_traffic_peak_speed: Inbound traffic peak speed in bpsout_traffic_ave_rate: Outbound traffic average rate in
ppsout_traffic_peak_rate: Outbound traffic peak rate in ppsout_traffic_ave_speed: Outbound traffic average speed in
bpsout_traffic_peak_speed: Outbound traffic peak speed in
bpsCharacteristics:acquisition_method: subscriptionemission_type: on-changedampening_type: noneThe following information should be included in a DDoS Event:event_name: SEC_EVENT_DDoSsub_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.dst_ip: The IP address of a victim under attackdst_port: The port number that the attack traffic aims
at.start_time: The time stamp indicating when the attack
startedend_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.attack_rate: The PPS of attack trafficattack_speed: the bps of attack trafficrule_id: The ID of the rule being triggeredrule_name: The name of the rule being triggeredprofile: Security profile that traffic matches.The following information should be included in a Session Table
Event:event_name: SESSION_USAGE_HIGHcurrent: The number of concurrent sessionsmax: The maximum number of sessions that the session table
can supportthreshold: The threshold triggering the eventmessage: The number of session table exceeded the threshold.The following information should be included in a Virus
Event:event_Name: SEC_EVENT_VIRUSvirus_type: Type of the virus. e.g., trojan, worm, macro
virus typevirus_name: Name of the virusdst_ip: The destination IP address of the packet where the
virus is foundsrc_ip: The source IP address of the packet where the virus
is foundsrc_port: The source port of the packet where the virus is
founddst_port: The destination port of the packet where the virus
is foundsrc_zone: The source security zone of the packet where the
virus is founddst_zone: The destination security zone of the packet where
the virus is foundfile_type: The type of the file where the virus is hided
withinfile_name: The name of the file where the virus is hided
withinvirus_info: The brief introduction of the virusraw_info: The information describing the packet triggering
the event.rule_id: The ID of the rule being triggeredrule_name: The name of the rule being triggeredprofile: Security profile that traffic matches.The following information should be included in an Intrusion
Event:event_name: The name of event. e.g., SEC_EVENT_Intrusionsub_attack_type: Attack type, e.g., brutal force and buffer
overflowsrc_ip: The source IP address of the packetdst_ip: The destination IP address of the packetsrc_port:The source port number of the packetdst_port: The destination port number of the packetsrc_zone: The source security zone of the packetdst_zone: The destination security zone of the packetprotocol: The employed transport layer protocol. e.g.,TCP and UDPapp: The employed application layer protocol. e.g.,HTTP and FTPrule_id: The ID of the rule being triggeredrule_name: The name of the rule being triggeredprofile: Security profile that traffic matchesintrusion_info: Simple description of intrusionraw_info: The information describing the packet triggering
the eventThe following information should be included in a Botnet
Event:event_name: The name of event. e.g., SEC_EVENT_Botnetbotnet_name: The name of the detected botnetsrc_ip: The source IP address of the packetdst_ip: The destination IP address of the packetsrc_port: The source port number of the packetdst_port: The destination port number of the packetsrc_zone: The source security zone of the packetdst_zone: The destination security zone of the packetprotocol: The employed transport layer protocol. e.g.,TCP and UDPapp: The employed application layer protocol. e.g.,HTTP and FTProle: The role of the communicating parties within the
botnet: The packet from the zombie host to the attackerThe packet from the attacker to the zombie hostThe packet from the IRC/WEB server to the zombie hostThe packet from the zombie host to the IRC/WEB serverThe packet from the attacker to the IRC/WEB serverThe packet from the IRC/WEB server to the attackerThe packet from the zombie host to the victimbotnet_info: Simple description of Botnetrule_id: The ID of the rule being triggeredrule_name: The name of the rule being triggeredprofile: Security profile that traffic matchesraw_info: The information describing the packet triggering
the event.The following information should be included in a Web Attack
Alarm:event_name: The name of event. e.g., SEC_EVENT_WebAttacksub_attack_type: Concrete web attack type. e.g., SQL
injection, command injection, XSS, CSRFsrc_ip: The source IP address of the packetdst_ip: The destination IP address of the packetsrc_port: The source port number of the packetdst_port: The destination port number of the packetsrc_zone: The source security zone of the packetdst_zone: The destination security zone of the packetreq_method: The method of requirement. For instance, "PUT" and
"GET" in HTTPreq_url: Requested URLurl_category: Matched URL categoryfiltering_type: URL filtering type. e.g., Blacklist,
Whitelist, User-Defined, Predefined, Malicious Category,
and Unknownrule_id: The ID of the rule being triggeredrule_name: The name of the rule being triggeredprofile: Security profile that traffic matchesCharacteristics:acquisition_method: subscriptionemission_type: on-changedampening_type: on_repetitionBesides the fields in a DDoS Alarm, the following information
should be included in a DDoS Logs:attack_type: DDoSattack_ave_rate: The average pps of the attack traffic within
the recorded timeattack_ave_speed: The average bps of the attack traffic
within the recorded timeattack_pkt_num: The number of attack packets within the recorded
timeattack_src_ip: The source IP addresses of attack traffics. If
there are a large number of IP addresses, then pick a certain
number of resources according to different rules.action: Actions against DDoS attacks. e.g., Allow, Alert,
Block, Discard, Declare, Block-ip, and Block-service.Besides the fields in a Virus Alarm, the following information
should be included in a Virus Logs:attack_type: Virusprotocol: The transport layer protocolapp: The name of the application layer protocoltimes: The time of detecting the virusaction: The actions dealing with the virus. e.g., alert and
blockos: The OS that the virus will affect. e.g., all, android,
ios, unix, and windowsBesides the fields in an Intrusion Alarm, the following
information should be included in an Intrusion Logs:attack_type: Intrusiontimes: The times of intrusions happened in the recorded
timeos: The OS that the intrusion will affect. e.g., all,
android, ios, unix, and windowsaction: The actions dealing with the intrusions. e.g.,
Allow, Alert, Block, Discard, Declare, Block-ip,
and Block-serviceattack_rate: NUM the pps of attack trafficattack_speed: NUM the bps of attack trafficBesides the fields in a Botnet Alarm, the following information
should be included in a Botnet Logs:attack_type: Botnetbotnet_pkt_num:The number of the packets sent to or from the
detected botnetaction: The actions dealing with the detected packets. e.g.,
Allow, Alert, Block, Discard, Declare, Block-ip, and Block-service.os: The OS that the attack aims at. e.g., all, android,
ios, unix, and windows.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.type: DPI action types. e.g., File Blocking, Data Filtering,
and Application Behavior Controlfile_name: The file namefile_type: The file typesrc_zone: Source security zone of trafficdst_zone: Destination security zone of trafficsrc_region: Source region of trafficdst_region: Destination region of trafficsrc_ip: Source IP address of trafficsrc_user: User who generates trafficdst_ip: Destination IP address of trafficsrc_port: Source port of trafficdst_port: Destination port of trafficprotocol: Protocol type of trafficapp: Application type of trafficpolicy_id: Security policy id that traffic matchespolicy_name: Security policy name that traffic matchesaction: Action defined in the file blocking rule, data
filtering rule, or application behavior control rule that
traffic matches.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:victim_ip: IP address of the victim host which has
vulnerabilitiesvulnerability_id: The vulnerability idvulnerability_level: The vulnerability level. e.g., high,
middle, and lowOS: The operating system of the victim hostservice: The service which has vulnerability in the victim
hostprotocol: The protocol type. e.g., TCP and UDPport: The port numbervulnerability_info: The information about the
vulnerabilityfix_suggestion: The fix suggestion to the vulnerability.Besides the fields in a Web Attack Alarm, the following
information should be included in a Web Attack Report:attack_type: Web Attackrsp_code: Response codereq_clientapp: The client applicationreq_cookies: Cookiesreq_host: The domain name of the requested hostraw_info: The information describing the packet triggering
the event.Characteristics:acquisition_method: subscription or queryemission_type: periodicaldampening_type: noneFirewall counters provide visibility into traffic signatures,
bandwidth usage, and how the configured security and bandwidth
policies have been applied.src_zone: Source security zone of trafficdst_zone: Destination security zone of trafficsrc_region: Source region of trafficdst_region: Destination region of trafficsrc_ip: Source IP address of trafficsrc_user: User who generates trafficdst_ip: Destination IP address of trafficsrc_port: Source port of trafficdst_port: Destination port of trafficprotocol: Protocol type of trafficapp: Application type of trafficpolicy_id: Security policy id that traffic matchespolicy_name: Security policy name that traffic matchesin_interface: Inbound interface of trafficout_interface: Outbound interface of traffictotal_traffic: Total traffic volumein_traffic_ave_rate: Inbound traffic average rate in ppsin_traffic_peak_rate: Inbound traffic peak rate in ppsin_traffic_ave_speed: Inbound traffic average speed in
bpsin_traffic_peak_speed: Inbound traffic peak speed in bpsout_traffic_ave_rate: Outbound traffic average rate in
ppsout_traffic_peak_rate: Outbound traffic peak rate in ppsout_traffic_ave_speed: Outbound traffic average speed in
bpsout_traffic_peak_speed: Outbound traffic peak speed in
bps.Policy Hit Counters record the security policy that traffic
matches and its hit count. It can check if policy configurations are
correct.src_zone: Source security zone of trafficdst_zone: Destination security zone of trafficsrc_region: Source region of the trafficdst_region: Destination region of the trafficsrc_ip: Source IP address of trafficsrc_user: User who generates trafficdst_ip: Destination IP address of trafficsrc_port: Source port of trafficdst_port: Destination port of trafficprotocol: Protocol type of trafficapp: Application type of trafficpolicy_id: Security policy id that traffic matchespolicy_name: Security policy name that traffic matcheshit_times: The hit times that the security policy matches the
specified traffic.
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 the security controller.
The security controller 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 requires the interfaces.
The three main interfaces in I2NSF framework are used for sending monitoring
data as follows:
I2NSF Consumer-Facing Interface :
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.
I2NSF Registration Interface :
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 Security Controller to the DMS via
Registration Interface. These data are delivered from the DMS to the VNF Manager
in the Management and Orchestration (MANO) in the NFV system
.
I2NSF NSF-Facing Interface :
After a high-level security policy from I2NSF User is translated by security policy
translator 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 specifies the list of events that
can trigger Event-Condition-Action (ECA) policies via NSF-Facing Interface.
The tree structure of the NSF monitoring YANG module is provided below:
This section introduces a YANG data model for the information model of
the NSF monitoring information model.
file "ietf-i2nsf-monitor@2019-07-23.yang"
module ietf-i2nsf-monitor {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-i2nsf-monitor";
prefix
iim;
import ietf-inet-types{
prefix inet;
reference
"Section 4 of RFC 6991";
}
import ietf-yang-types {
prefix yang;
reference
"Section 3 of RFC 6991";
}
organization
"IETF I2NSF (Interface to Network Security Functions)
Working Group";
contact
"WG Web:
WG List:
WG Chair: Linda Dunbar
Editor: Jaehoon Paul Jeong
Editor: Chaehong Chung
";
description
"This module is a YANG module for monitoring NSFs.
Copyright (c) 2018 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC 6087; see
the RFC itself for full legal notices.";
revision "2019-07-23" {
description "First revision";
reference
"RFC XXXX: I2NSF NSF Monitoring YANG Data Model";
}
typedef severity {
type enumeration {
enum high {
description
"high-level";
}
enum middle {
description
"middle-level";
}
enum low {
description
"low-level";
}
}
description
"An indicator representing severity";
}
typedef log-action {
type enumeration {
enum allow {
description
"If action is allowed";
}
enum alert {
description
"If action is alert";
}
enum block {
description
"If action is block";
}
enum discard {
description
"If action is discarded";
}
enum declare {
description
"If action is declared";
}
enum block-ip {
description
"If action is block-ip";
}
enum block-service{
description
"If action is block-service";
}
}
description
"This is used for protocol";
}
typedef dpi-type{
type enumeration {
enum file-blocking{
description
"DPI for blocking file";
}
enum data-filtering{
description
"DPI for filtering data";
}
enum application-behavior-control{
description
"DPI for controlling application behavior";
}
}
description
"This is used for dpi type";
}
typedef operation-type{
type enumeration {
enum login{
description
"Login operation";
}
enum logout{
description
"Logout operation";
}
enum configuration{
description
"Configuration operation";
}
}
description
"An indicator representing operation-type";
}
typedef login-mode{
type enumeration {
enum root{
description
"Root login-mode";
}
enum user{
description
"User login-mode";
}
enum guest{
description
"Guest login-mode";
}
}
description
"An indicator representing login-mode";
}
identity characteristics {
description
"Base identity for monitoring information
characteristics";
}
identity acquisition-method {
base characteristics;
description
"The type of acquisition-method. Can be multiple
types at once.";
}
identity subscription {
base acquisition-method;
description
"The acquisition-method type is subscription";
}
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 {
base emission-type;
description
"The emission-type type is periodical.";
}
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.";
}
identity no-dampening {
base dampening-type;
description
"The dampening-type is no-dampening.";
}
identity on-repetition {
base dampening-type;
description
"The dampening-type is on-repetition.";
}
identity none {
base dampening-type;
description
"The dampening-type is none.";
}
identity authentication-mode {
description
"User authentication mode types:
e.g., Local Authentication,
Third-Party Server Authentication,
Authentication Exemption, or Single Sign-On (SSO)
Authentication.";
}
identity local-authentication {
base authentication-mode;
description
"Authentication-mode : local authentication.";
}
identity third-party-server-authentication {
base authentication-mode;
description
"If authentication-mode is
third-part-server-authentication";
}
identity exemption-authentication {
base authentication-mode;
description
"If authentication-mode is
exemption-authentication";
}
identity sso-authentication {
base authentication-mode;
description
"If authentication-mode is
sso-authentication";
}
identity alarm-type {
description
"Base identity for detectable alarm types";
}
identity MEM-USAGE-ALARM {
base alarm-type;
description
"A memory alarm is alerted";
}
identity CPU-USAGE-ALARM {
base alarm-type;
description
"A CPU alarm is alerted";
}
identity DISK-USAGE-ALARM {
base alarm-type;
description
"A disk alarm is alerted";
}
identity HW-FAILURE-ALARM {
base alarm-type;
description
"A hardware alarm is alerted";
}
identity IFNET-STATE-ALARM {
base alarm-type;
description
"An interface alarm is alerted";
}
identity event-type {
description
"Base identity for detectable event types";
}
identity ACCESS-DENIED {
base event-type;
description
"The system event is access-denied.";
}
identity CONFIG-CHANGE {
base event-type;
description
"The system event is config-change.";
}
identity flood-type {
description
"Base identity for detectable flood types";
}
identity syn-flood {
base flood-type;
description
"A SYN flood is detected";
}
identity ack-flood {
base flood-type;
description
"An ACK flood is detected";
}
identity syn-ack-flood {
base flood-type;
description
"An SYN-ACK flood is detected";
}
identity fin-rst-flood {
base flood-type;
description
"A FIN-RST flood is detected";
}
identity tcp-con-flood {
base flood-type;
description
"A TCP connection flood is detected";
}
identity udp-flood {
base flood-type;
description
"A UDP flood is detected";
}
identity icmp-flood {
base flood-type;
description
"An ICMP flood is detected";
}
identity https-flood {
base flood-type;
description
"A HTTPS flood is detected";
}
identity http-flood {
base flood-type;
description
"A HTTP flood is detected";
}
identity dns-reply-flood {
base flood-type;
description
"A DNS reply flood is detected";
}
identity dns-query-flood {
base flood-type;
description
"A DNS query flood is detected";
}
identity sip-flood {
base flood-type;
description
"A SIP flood is detected";
}
identity nsf-event-name {
description
"Base identity for detectable nsf event types";
}
identity SEC-EVENT-DDOS {
base nsf-event-name;
description
"The nsf event is sec-event-ddos.";
}
identity SESSION-USAGE-HIGH {
base nsf-event-name;
description
"The nsf event is session-usage-high";
}
identity SEC-EVENT-VIRUS {
base nsf-event-name;
description
"The nsf event is sec-event-virus";
}
identity SEC-EVENT-INTRUSION {
base nsf-event-name;
description
"The nsf event is sec-event-intrusion";
}
identity SEC-EVENT-BOTNET {
base nsf-event-name;
description
"The nsf event is sec-event-botnet";
}
identity SEC-EVENT-WEBATTACK {
base nsf-event-name;
description
"The nsf event is sec-event-webattack";
}
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 is an ID stub limited to indicating
that this attack type is botnet.
The usual semantic and taxonomy is missing
and name is used.";
}
identity virus-type {
base nsf-attack-type;
description
"The type of virus. 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";
}
identity worm {
base virus-type;
description
"The detected virus type is worm";
}
identity macro {
base virus-type;
description
"The detected virus type is macro";
}
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
"The intrusion type is brute-force";
}
identity buffer-overflow {
base intrusion-attack-type;
description
"The intrusion type is buffer-overflow";
}
identity web-attack-type {
base nsf-attack-type;
description
"The attack type associated with
a detected system-log web-attack";
}
identity command-injection {
base web-attack-type;
description
"The detected web attack type is command injection";
}
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 ddos-attack-type {
base nsf-attack-type;
description
"The attack type is associated with a detected
nsf-log event";
}
identity req-method {
description
"A set of request types (if applicable).
For instance, PUT or GET in HTTP";
}
identity put-req {
base req-method;
description
"The detected request type is PUT";
}
identity get-req {
base req-method;
description
"The detected request type is GET";
}
identity filter-type {
description
"The type of filter used to detect, for example,
a web-attack. Can be applicable to more than
web-attacks. Can be more than one type.";
}
identity whitelist {
base filter-type;
description
"The applied filter type is whitelist";
}
identity blacklist {
base filter-type;
description
"The applied filter type is blacklist";
}
identity user-defined {
base filter-type;
description
"The applied filter type is user-defined";
}
identity balicious-category {
base filter-type;
description
"The applied filter is balicious category";
}
identity unknown-filter {
base filter-type;
description
"The applied filter is unknown";
}
identity access-mode {
description
"Base identity for detectable access mode.";
}
identity ppp {
base access-mode;
description
"Access-mode : ppp";
}
identity svn {
base access-mode;
description
"Access-mode : svn";
}
identity local {
base access-mode;
description
"Access-mode : local";
}
identity protocol-type {
description
"An identity used to enable type choices in leaves
and leaflists wrt protocol metadata.";
}
identity tcp {
base ipv4;
base ipv6;
description
"TCP protocol type.";
reference
"RFC 793: Transmission Control Protocol";
}
identity udp {
base ipv4;
base ipv6;
description
"UDP protocol type.";
reference
"RFC 768: User Datagram Protocol";
}
identity icmp {
base ipv4;
base ipv6;
description
"General ICMP protocol type.";
reference
"RFC 792: Internet Control Message Protocol";
}
identity icmpv4 {
base ipv4;
description
"ICMPv4 protocol type.";
}
identity icmpv6 {
base ipv6;
description
"ICMPv6 protocol type.";
}
identity ip {
base protocol-type;
description
"General IP protocol type.";
reference
"RFC 791: Internet Protocol
RFC 2460: Internet Protocol, Version 6 (IPv6)";
}
identity ipv4 {
base ip;
description
"IPv4 protocol type.";
reference
"RFC 791: Internet Protocol";
}
identity ipv6 {
base ip;
description
"IPv6 protocol type.";
reference
"RFC 2460: Internet Protocol, Version 6 (IPv6)";
}
identity http {
base tcp;
description
"HTPP protocol type.";
reference
"RFC 2616: Hypertext Transfer Protocol";
}
identity ftp {
base tcp;
description
"FTP protocol type.";
reference
"RFC 959: File Transfer Protocol";
}
grouping common-monitoring-data {
description
"The data set of common monitoring";
leaf message {
type string;
description
"This is a freetext annotation of
monitoring notification content";
}
leaf time-stamp {
type yang:date-and-time;
description
"Indicates the time of message generation";
}
leaf vendor-name {
type string;
description
"The name of the NSF vendor";
}
leaf nsf-name {
type string;
description
"The name (or IP) of the NSF
generating the message";
}
leaf module-name {
type string;
description
"The module name outputting the message";
}
leaf severity {
type severity;
description
"The severity of the alarm such
as critical, high, middle, low.";
}
}
grouping characteristics{
description
"A set of monitoring information characteristics";
leaf acquisition-method {
type identityref {
base acquisition-method;
}
description
"The acquisition-method for characteristics";
}
leaf emission-type {
type identityref {
base emission-type;
}
description
"The emission-type for characteristics";
}
leaf dampening-type {
type identityref {
base dampening-type;
}
description
"The dampening-type for characteristics";
}
}
grouping i2nsf-system-alarm-type-content {
description
"A set of system alarm type contents";
leaf usage {
type uint8;
description
"specifies the amount of usage";
}
leaf threshold {
type uint8;
description
"The threshold triggering the alarm or the event";
}
}
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
"Name of a user";
}
leaf group {
type string;
mandatory true;
description
"Group to which a user belongs.";
}
leaf login-ip-addr {
type inet:ipv4-address;
mandatory true;
description
"Login IP address of a user.";
}
leaf authentication {
type identityref {
base authentication-mode;
}
description
"The authentication-mode for authentication";
}
}
grouping i2nsf-nsf-event-type-content-extend {
description
"A set of common IPv4-related NSF event
content elements";
leaf src-ip {
type inet:ipv4-address;
description
"The source IP address of the packet";
}
leaf dst-ip {
type inet:ipv4-address;
description
"The destination IP address of the packet";
}
leaf src-port {
type inet:port-number;
description
"The source port of the packet";
}
leaf dst-port {
type inet:port-number;
description
"The destination port of the packet";
}
leaf src-zone {
type string;
description
"The source security zone of the packet";
}
leaf dst-zone {
type string;
description
"The destination security zone of the packet";
}
leaf rule-id {
type uint8;
mandatory true;
description
"The ID of the rule being triggered";
}
leaf rule-name {
type string;
mandatory true;
description
"The name of the rule being triggered";
}
leaf profile {
type string;
description
"Security profile that traffic matches.";
}
leaf raw-info {
type string;
description
"The information describing the packet
triggering the event.";
}
}
grouping i2nsf-nsf-event-type-content {
description
"A set of common IPv4-related NSF event
content elements";
leaf dst-ip {
type inet:ipv4-address;
description
"The destination IP address of the packet";
}
leaf dst-port {
type inet:port-number;
description
"The destination port of the packet";
}
leaf rule-id {
type uint8;
mandatory true;
description
"The ID of the rule being triggered";
}
leaf rule-name {
type string;
mandatory true;
description
"The name of the rule being triggered";
}
leaf profile {
type string;
description
"Security profile that traffic matches.";
}
leaf raw-info {
type string;
description
"The information describing the packet
triggering the event.";
}
}
grouping traffic-rates {
description
"A set of traffic rates
for statistics data";
leaf total-traffic {
type uint32;
description
"Total traffic";
}
leaf in-traffic-ave-rate {
type uint32;
description
"Inbound traffic average rate in pps";
}
leaf in-traffic-peak-rate {
type uint32;
description
"Inbound traffic peak rate in pps";
}
leaf in-traffic-ave-speed {
type uint32;
description
"Inbound traffic average speed in bps";
}
leaf in-traffic-peak-speed {
type uint32;
description
"Inbound traffic peak speed in bps";
}
leaf out-traffic-ave-rate {
type uint32;
description
"Outbound traffic average rate in pps";
}
leaf out-traffic-peak-rate {
type uint32;
description
"Outbound traffic peak rate in pps";
}
leaf out-traffic-ave-speed {
type uint32;
description
"Outbound traffic average speed in bps";
}
leaf out-traffic-peak-speed {
type uint32;
description
"Outbound traffic peak speed in bps";
}
}
grouping i2nsf-system-counter-type-content{
description
"A set of system counter type contents";
leaf interface-name {
type string;
description
"Network interface name configured in NSF";
}
leaf in-total-traffic-pkts {
type uint32;
description
"Total inbound packets";
}
leaf out-total-traffic-pkts {
type uint32;
description
"Total outbound packets";
}
leaf in-total-traffic-bytes {
type uint32;
description
"Total inbound bytes";
}
leaf out-total-traffic-bytes {
type uint32;
description
"Total outbound bytes";
}
leaf in-drop-traffic-pkts {
type uint32;
description
"Total inbound drop packets";
}
leaf out-drop-traffic-pkts {
type uint32;
description
"Total outbound drop packets";
}
leaf in-drop-traffic-bytes {
type uint32;
description
"Total inbound drop bytes";
}
leaf out-drop-traffic-bytes {
type uint32;
description
"Total outbound drop bytes";
}
uses traffic-rates;
}
grouping i2nsf-nsf-counters-type-content{
description
"A set of nsf counters type contents";
leaf src-ip {
type inet:ipv4-address;
description
"The source IP address of the packet";
}
leaf dst-ip {
type inet:ipv4-address;
description
"The destination IP address of the packet";
}
leaf src-port {
type inet:port-number;
description
"The source port of the packet";
}
leaf dst-port {
type inet:port-number;
description
"The destination port of the packet";
}
leaf src-zone {
type string;
description
"The source security zone of the packet";
}
leaf dst-zone {
type string;
description
"The destination security zone of the packet";
}
leaf src-region {
type string;
description
"Source region of the traffic";
}
leaf dst-region{
type string;
description
"Destination region of the traffic";
}
leaf policy-id {
type uint8;
description
"The ID of the policy being triggered";
}
leaf policy-name {
type string;
description
"The name of the policy being triggered";
}
leaf src-user{
type string;
description
"User who generates traffic";
}
leaf protocol {
type identityref {
base protocol-type;
}
description
"Protocol type of traffic";
}
leaf app {
type string;
description
"Application type of traffic";
}
}
notification system-detection-alarm {
description
"This notification is sent, when a system alarm
is detected.";
leaf alarm-category {
type identityref {
base alarm-type;
}
description
"The alarm category for
system-detection-alarm notification";
}
uses characteristics;
uses i2nsf-system-alarm-type-content;
uses common-monitoring-data;
}
notification system-detection-event {
description
"This notification is sent, when a security-sensitive
authentication action fails.";
leaf event-category {
type identityref {
base event-type;
}
description
"The event category for system-detection-event";
}
uses characteristics;
uses i2nsf-system-event-type-content;
uses common-monitoring-data;
}
notification nsf-detection-flood {
description
"This notification is sent,
when a specific flood type is detected";
leaf event-name {
type identityref {
base SEC-EVENT-DDOS;
}
description
"The event name for nsf-detection-flood";
}
uses i2nsf-nsf-event-type-content;
leaf sub-attack-type {
type identityref {
base flood-type;
}
description
"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, 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-rate {
type uint32;
description
"The PPS rate of attack traffic";
}
leaf attack-speed {
type uint32;
description
"The BPS speed of attack traffic";
}
uses common-monitoring-data;
}
notification nsf-detection-session-table {
description
"This notification is sent, when a session table
event is detected";
leaf current-session {
type uint8;
description
"The number of concurrent sessions";
}
leaf maximum-session {
type uint8;
description
"The maximum number of sessions that the session
table can support";
}
leaf threshold {
type uint8;
description
"The threshold triggering the event";
}
uses common-monitoring-data;
}
notification nsf-detection-virus {
description
"This notification is sent, when a virus is detected";
uses i2nsf-nsf-event-type-content-extend;
leaf virus {
type identityref {
base virus-type;
}
description
"The virus type for nsf-detection-virus notification";
}
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).";
}
leaf file-name {
type string;
description
"The name of file virus code
is found in (if applicable).";
}
uses common-monitoring-data;
}
notification 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;
}
description
"The protocol type for
nsf-detection-intrusion notification";
}
leaf app {
type string;
description
"The employed application layer protocol";
}
leaf sub-attack-type {
type identityref {
base intrusion-attack-type;
}
description
"The sub attack type for intrusion attack";
}
uses common-monitoring-data;
}
notification 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 common-monitoring-data;
}
notification nsf-detection-web-attack {
description
"This notification is sent, when an attack event is
detected";
uses i2nsf-nsf-event-type-content-extend;
leaf sub-attack-type {
type identityref {
base web-attack-type;
}
description
"Concrete web attack type, e.g., sql injection,
command injection, XSS, CSRF";
}
leaf request-method {
type identityref {
base req-method;
}
description
"The method of requirement. For instance, PUT or
GET in HTTP";
}
leaf req-uri {
type string;
description
"Requested URI";
}
leaf uri-category {
type string;
description
"Matched URI category";
}
leaf-list filtering-type {
type identityref {
base filter-type;
}
description
"URL filtering type, e.g., Blacklist, Whitelist,
User-Defined, Predefined, Malicious Category,
Unknown";
}
uses common-monitoring-data;
}
notification 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:ipv4-address;
mandatory true;
description
"Login IP address of a user";
}
leaf administrator {
type string;
description
"Administrator that maintains the device";
}
leaf login-mode {
type login-mode;
description
"Specifies the administrator log-in mode";
}
leaf operation-type {
type operation-type;
description
"The operation type that the administrator executes";
}
leaf result {
type string;
description
"Command execution result";
}
leaf content {
type string;
description
"The Operation performed by an administrator
after login";
}
uses characteristics;
}
notification 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;
description
"The current systems
running status";
}
leaf cpu-usage {
type uint8;
description
"Specifies the relative amount of
cpu usage wrt platform resources";
}
leaf memory-usage {
type uint8;
description
"Specifies the amount of memory usage";
}
leaf disk-usage {
type uint8;
description
"Specifies the amount of disk usage";
}
leaf disk-left {
type uint8;
description
"Specifies the amount of disk left";
}
leaf session-num {
type uint8;
description
"The total number of sessions";
}
leaf process-num {
type uint8;
description
"The total number of process";
}
leaf in-traffic-rate {
type uint32;
description
"The total inbound traffic rate in pps";
}
leaf out-traffic-rate {
type uint32;
description
"The total outbound traffic rate in pps";
}
leaf in-traffic-speed {
type uint32;
description
"The total inbound traffic speed in bps";
}
leaf out-traffic-speed {
type uint32;
description
"The total outbound traffic speed in bps";
}
uses characteristics;
}
notification 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;
leaf access {
type identityref {
base access-mode;
}
description
"The access type for
system-user-activity-log notification";
}
leaf online-duration {
type string;
description
"Online duration";
}
leaf logout-duration {
type string;
description
"Lockout duration";
}
leaf additional-info {
type string;
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, Unknown";
}
}
notification nsf-log-ddos {
description
"This notification is sent, if there is
a new DDoS event log entry in the nsf log";
leaf attack-type {
type identityref {
base ddos-attack-type;
}
description
"The ddos attack type for
nsf-log-ddos notification";
}
leaf attack-ave-rate {
type uint32;
description
"The ave PPS of attack traffic";
}
leaf attack-ave-speed {
type uint32;
description
"the ave bps of attack traffic";
}
leaf attack-pkt-num {
type uint32;
description
"the number of attack packets";
}
leaf attack-src-ip {
type inet:ipv4-address;
description
"The source IP addresses of attack
traffics. If there are a large
amount of IP addresses, then
pick a certain number of resources
according to different rules.";
}
leaf action {
type log-action;
description
"Action type: allow, alert,
block, discard, declare,
block-ip, block-service";
}
uses characteristics;
uses common-monitoring-data;
}
notification nsf-log-virus {
description
"This notification is sent, if there is
a new virus event log entry in the nsf log";
leaf attack-type {
type identityref {
base virus-type;
}
description
"The virus type for nsf-log-virus notification";
}
leaf action {
type log-action;
description
"Action type: allow, alert,
block, discard, declare,
block-ip, block-service";
}
leaf os{
type string;
description
"simple os information";
}
leaf time {
type yang:date-and-time;
mandatory true;
description
"Indicate the time when the message
is generated";
}
uses characteristics;
uses common-monitoring-data;
}
notification nsf-log-intrusion {
description
"This notification is sent, if there is
a new intrusion event log entry in the nsf log";
leaf attack-type {
type identityref {
base intrusion-attack-type;
}
description
"The intrusion attack type for
nsf-log-intrusion notification";
}
leaf action {
type log-action;
description
"Action type: allow, alert,
block, discard, declare,
block-ip, block-service";
}
leaf time {
type yang:date-and-time;
mandatory true;
description
"Indicate the time when the message
is generated";
}
leaf attack-rate {
type uint32;
description
"The PPS of attack traffic";
}
leaf attack-speed {
type uint32;
description
"The bps of attack traffic";
}
uses characteristics;
uses common-monitoring-data;
}
notification nsf-log-botnet {
description
"This notification is sent, if there is
a new botnet event log in the nsf log";
leaf attack-type {
type identityref {
base botnet-attack-type;
}
description
"The botnet attack type for
nsf-log-botnet notification";
}
leaf action {
type log-action;
description
"Action type: allow, alert,
block, discard, declare,
block-ip, block-service";
}
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;
}
notification 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;
description
"The type of the dpi";
}
uses characteristics;
uses i2nsf-nsf-counters-type-content;
uses common-monitoring-data;
}
notification 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:ipv4-address;
description
"IP 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;
description
"simple os information";
}
leaf vulnerability-info {
type string;
description
"The information about the vulnerability";
}
leaf fix-suggestion {
type string;
description
"The fix suggestion to the vulnerability";
}
leaf service {
type string;
description
"The service which has vulnerability in the victim host";
}
uses characteristics;
uses common-monitoring-data;
}
notification nsf-log-web-attack {
description
"This notification is sent, if there is
a new web-attack event in the nsf log";
leaf attack-type {
type identityref {
base web-attack-type;
}
description
"The web attack type for
nsf-log-web-attack notification";
}
leaf rsp-code {
type string;
description
"Response code";
}
leaf req-clientapp {
type string;
description
"The client application";
}
leaf req-cookies {
type string;
description
"Cookies";
}
leaf req-host {
type string;
description
"The domain name of the requested host";
}
leaf raw-info {
type string;
description
"The information describing
the packet triggering the event.";
}
uses characteristics;
uses common-monitoring-data;
}
container counters {
description
"This is probably better covered by an import
as this will not be notifications.
Counter are not very suitable as telemetry, maybe
via periodic subscriptions, which would still
violate principle of least surprise.";
container system-interface {
description
"The system counter type is interface counter";
uses characteristics;
uses i2nsf-system-counter-type-content;
uses common-monitoring-data;
}
container nsf-firewall {
description
"The nsf counter type is firewall counter";
uses characteristics;
uses i2nsf-nsf-counters-type-content;
uses traffic-rates;
}
container nsf-policy-hits {
description
"The counters of policy hit";
uses characteristics;
uses i2nsf-nsf-counters-type-content;
uses common-monitoring-data;
leaf hit-times {
type uint32;
description
"The hit times for policy";
}
}
}
}
]]>
This document requests IANA to register the following URI in the
"IETF XML Registry" : This document requests IANA to register the following YANG
module in the "YANG Module Names" registry .
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 or RESTCONF . The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) . The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS .
The NETCONF access control model 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 security controller 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
security controller). 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.
In addition, to defend against the DDoS attack caused by a lot of
NSFs sending massive notifications to the security controller,
the rate limiting or similar mechanisms should be considered in an NSF and
security controller, whether in advance or just in the process of DDoS
attack.
The following changes are made from draft-ietf-i2nsf-nsf-monitoring-data-model-00:
In , Requirements Notation is updated.
In , the reference is added.
In , the reference is added.
In , the reference is added.
Many editorial errors have been corrected.
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 MSIT, Korea,
under the ITRC (Information Technology Research Center) support program
(IITP-2019-2017-0-01633) supervised by the IITP.
This document is made by the group effort of I2NSF working group.
Many people actively contributed to this document.
The following are considered co-authors:
Jinyong Tim Kim (Sungkyunkwan University) Dongjin Hong (Sungkyunkwan University) Dacheng Zhang (Huawei) Yi Wu (Aliababa Group) Rakesh Kumar (Juniper Networks) Anil Lohiya (Juniper Networks)